بیچ ٹاسک کا انتظام

غیر مطابقت پذیر بلک درخواستیں جمع کرائیں اور بیچ کے نفاذ کی حالت کا معائنہ کریں۔

OpenAI سے مطابقت رکھنے والے Batch API کا استعمال کرتے ہوئے معاونت یافتہ ماڈل اینڈ پوائنٹس پر غیر مطابقت پذیر بلک درخواستیں جمع کرائیں۔

POST/openai/v1/batches

درخواست کا متن

فیلڈقسملازمیتفصیل
input_file_idstringہاںاپ لوڈ کردہ فائل کا منفرد شناخت کنندہ جس کا مقصد batch پر سیٹ ہو۔
endpointstringہاںہدف اینڈ پوائنٹ (/v1/chat/completions، /v1/completions، /v1/responses یا /v1/embeddings)۔
completion_windowstringہاںتکمیل کی ونڈو، فی الحال 24h پر طے شدہ۔
metadataobjectنہیںٹریکنگ اور آڈٹ کے لیے اختیاری کلیدی قدر کے جوڑے۔

ان پٹ فائلیں زیادہ سے زیادہ 50,000 آئٹمز اور 200 MiB فائل سائز کی حد کے ساتھ UTF-8 انکوڈ شدہ JSONL ہونی چاہئیں۔ ہر JSONL لائن ایک درست JSON آبجیکٹ ہونی چاہیے جس میں منفرد غیر خالی custom_id، method: "POST"، بیچ کے endpoint سے مماثل url، اور آبجیکٹ body (سخت پری پیڈ بیچز کے لیے لازمی model فیلڈ کے ساتھ) شامل ہو۔ مقامی پری پیڈ بیچز کے لیے، گیٹ وے فنڈنگ سے پہلے فائل کے چیک سم اور پالیسیوں کی تصدیق کرتا ہے؛ پرووائیڈر کو بھیجنے سے پہلے تمام آئٹم ریزرویشنز جوہری طور پر مکمل ہوتی ہیں۔ کل فنڈز ناکافی ہونے پر جزوی جمع کرائے بغیر HTTP 402 واپس کیا جاتا ہے۔ غیر موافق پرووائیڈر کنفیگریشنز کو ایک ہی بیچ میں تقسیم نہیں کیا جا سکتا، اور آئٹم کی سطح پر کراس پرووائیڈر فیل اوور نہیں کیا جاتا۔

بیچ کا لائف سائیکل

GET/openai/v1/batches/{batch_id}
POST/openai/v1/batches/{batch_id}/cancel
  • validating: ان پٹ فائل فارمیٹ، JSONL نحو اور آئٹم اسکیما کی مطابقت کی توثیق کرتا ہے۔
  • in_progress: تفویض کردہ فراہم کنندہ کی اسناد کے ساتھ بیچ انفرینس انجام دیتا ہے۔
  • finalizing: پیداواری نتائج کو یکجا کرتا ہے اور استعمال کی تصفیہ ریکارڈ کرتا ہے۔
  • completed: پروسیسنگ کامیابی سے مکمل ہوئی، output_file_id اور اختیاری error_file_id تیار کرتا ہے۔
  • failed: اگر فائل کی توثیق یا بیچ کوآرڈینیشن مکمل طور پر ناکام ہو جائے تو ٹرمینل خرابی کی حالت۔
  • cancelling: درخواست پر پروسیسنگ کو محفوظ طریقے سے روکتا ہے اور منسوخ شدہ حالت میں منتقل کرتا ہے۔
  • cancelled: حتمی تکمیل سے پہلے بیچ پروسیسنگ رک جانے کی نشاندہی کرتا ہے۔ ناکام، منسوخ یا غائب آئٹم کے نتائج صفر فراہم کنندہ لاگت کو ثابت نہیں کرتے؛ تصفیہ فراہم کنندہ کے ریکارڈ سے تصدیق کے لیے فنڈز کو برقرار رکھتا ہے۔ AnyInt میں معیاری حیثیت cancelled ہے۔
  • expired: جب پروسیسنگ 24 گھنٹے کی تکمیل ونڈو سے تجاوز کر جائے تو متحرک ہوتا ہے؛ غیر مصدقہ کارروائیوں کے لیے فراہم کنندہ کے ریکارڈز کے ساتھ مفاہمت درکار ہوتی ہے اور یہ صفر لاگت کی ضمانت نہیں دیتا۔

بیچ کی فہرست اور نتائج ڈاؤن لوڈ کرنا

GET/openai/v1/batches
  • بیچ کی فہرست: GET /openai/v1/batches مجاز تنظیم یا پروجیکٹ کے فعال اور تاریخی بیچ کے کاموں کی فہرست بناتا ہے۔
  • آبجیکٹ اسٹوریج اور ڈاؤن لوڈ: purpose: "batch" والی فائلوں کو قبول کرنے اور بیچ آپریشنز چلانے کے لیے مشترکہ آبجیکٹ اسٹوریج (OBJECT_STORE_MODE) درکار ہے۔ مکمل ہونے پر، آؤٹ پٹ اور ایرر JSONL فائلیں فائلز API GET /openai/v1/files/{file_id}/content کے ذریعے حاصل کی جا سکتی ہیں۔

مطابقت کے متبادل راستے

  • گیٹ وے پسماندہ مطابقت کے لیے /v1/batches قبول کرتا ہے؛ نئے انضمام کے لیے /openai/v1/batches استعمال کرنے کی سفارش کی جاتی ہے۔