خروجی ساخت‌یافته

خواندن سند (OCR)

متن یک سند PDF یا تصویر را صفحه‌به‌صفحه و به‌صورت Markdown بخوانید؛ هزینه فقط برای صفحه‌هایی است که واقعاً خوانده شده‌اند.

POST/v1/ocr

document یا یک PDF (document_url) است یا یک تصویر (image_url). مقدار هر دو نشانی http(s) یا data URL است. بدنه‌ی JSON با data URL حداکثر ۲۵ مگابایت است؛ برای فایل بزرگ‌تر نشانی فایل را بدهید. تعداد صفحه‌های سند پیش از خواندن معلوم نیست، پس پیش از اجرا برای مجموعه‌ی مشخصی از صفحه‌ها اعتبار رزرو می‌شود: اگر pages بدهید (شماره‌ی صفحه‌ها از صفر)، همان‌ها؛ وگرنه صفحه‌های اول سند تا سقف هر درخواست، و تا جایی که موجودی اجازه دهد. در پایان فقط صفحه‌هایی که خوانده شده‌اند حساب می‌شوند و صفحه‌هایی که از پایان سند جلوتر بودند هزینه‌ای ندارند. پاسخ truncated: true دارد وقتی سند ممکن است ادامه داشته باشد: یا pages نداده‌اید و همه‌ی صفحه‌های درخواست‌شده خوانده شده‌اند، یا فهرست شما به اندازه‌ی موجودی کوتاه شده است. در این حالت صفحه‌های بعدی را با pages می‌خواهید. هر صفحه‌ی پاسخ index ، markdown ، images و در صورت وجود dimensions دارد. خواندن سند بلند می‌تواند چند دقیقه طول بکشد.

نمونه‌ها

curl https://1ai.ir/v1/ocr \
  -H "Authorization: Bearer $ONEAI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "model": "mistralai/mistral-ocr-4",
  "document": {
    "type": "document_url",
    "document_url": "https://example.com/invoice.pdf"
  },
  "pages": [
    0,
    1
  ]
}'

200پاسخ

{
  "object": "ocr",
  "model": "mistralai/mistral-ocr-4",
  "pages": [
    {
      "index": 0,
      "markdown": "# Sales invoice\n\nInvoice no: 2291 ...",
      "dimensions": {
        "dpi": 200,
        "height": 2339,
        "width": 1654
      },
      "images": []
    },
    {
      "index": 1,
      "markdown": "| Item | Qty | Price |\n| --- | --- | --- |\n| Pallet | 4 | 250 |",
      "dimensions": {
        "dpi": 200,
        "height": 2339,
        "width": 1654
      },
      "images": []
    }
  ],
  "usage": {
    "pages": 2
  }
}

بدنه‌ی درخواست

modelstringالزامی
$شناسه‌ی مدل OCR.$
documentobjectالزامی
$سند. یکی از دو شکل: { type: "document_url", document_url } یا { type: "image_url", image_url }.$
ویژگی‌های داخلی
- typestringالزامی
  $نوع سند.$
  مقادیر مجاز:document_urlimage_url
- document_urlstring
  $برای type: document_url : نشانی http(s) یا data URL سند.$
- image_urlstring
  $برای type: image_url : نشانی http(s) یا data URL تصویر.$
pagesinteger[]
$شماره‌ی صفحه‌هایی که خوانده شوند، از صفر، بین ۱ تا ۱۰۰۰ مورد. بدون آن صفحه‌های اول سند تا سقف هر درخواست خوانده می‌شود.$
include_image_base64boolean
$اگر true باشد تصویرهای داخل صفحه همراه base64 برمی‌گردند.$
streamboolean
$فقط false پذیرفته می‌شود.$

خطاها

invalid_request400
بدنه معتبر نیست؛ مثلاً فیلد ناشناخته یا نشانی‌ای که http(s) یا data نیست.
too_many_pages400
تعداد صفحه‌های pages از سقف هر درخواست بیشتر است.
model_kind_mismatch400
مدل از دسته‌ی OCR نیست.
insufficient_credits402
اعتبار برای این درخواست کافی نیست.
model_not_found404
مدل وجود ندارد یا به آن دسترسی ندارید.

خواندن سند (OCR)

نمونه‌ها

بدنه‌ی درخواست

خطاها

صفحه‌های مرتبط