رسپانس بنائیں
OpenAI کے مطابق رسپانس API کے ساتھ ماڈل آؤٹ پٹ تیار کریں۔
ٹیکسٹ یا منظم ماڈل ان پٹ کے لیے رسپانس API کی شکل اور ایک متحد آؤٹ پٹ آبجیکٹ استعمال کریں۔
/openai/v1/responsesدرخواست کا باڈی
| فیلڈ | قسم | درکار | تفصیل |
|---|---|---|---|
model | string | ہاں | AnyInt کے ذریعے روٹ کیا گیا ماڈل شناخت کنندہ۔ |
input | string یا array | ہاں | ٹیکسٹ یا منظم ان پٹ آئٹمز۔ |
stream | boolean | نہیں | اگر تعاون کیا گیا ہو تو سرور سے بھیجے گئے ایونٹس واپس کریں۔ |
reasoning.effort | string | No | ماڈل پر منحصر کوشش، بغیر کسی پوشیدہ کمی کے آگے بھیجی گئی۔ |
tools | array | No | ٹول ڈیکلریشنز، بشمول کسٹم ٹولز۔ |
رسپانس
ایک مکمل درخواست شناخت کنندہ، حیثیت، اور تیار کردہ آؤٹ پٹ کے ساتھ ایک رسپانس آبجیکٹ واپس کرتی ہے۔
ٹول ہسٹری اور توثیق
کسٹم ٹول کالز اور ملٹی پارٹ ٹول آؤٹ پٹس اپنی ترتیب اور یونیکوڈ ٹیکسٹ کو برقرار رکھتے ہیں۔ اسسٹنٹ output_text حصوں کے لیے خالی annotations اور logprobs ارے فراہم کیے جاتے ہیں جب وہ غائب یا null ہوں، تاکہ ریلے انہیں غلط null میٹا ڈیٹا کے طور پر دوبارہ تشکیل نہ دے سکے۔ فراہم کنندہ کے کیپ الائیو پیغامات گفتگو کی تاریخ سے خارج کر دیے جاتے ہیں۔
استدلال کی کوشش کی سپورٹ منتخب کردہ ماڈل اور اپ اسٹریم پر منحصر ہوتی ہے۔ ایک منظم مستردگی فیلڈ کی نشاندہی کرتی ہے، مثال کے طور پر error.code: "invalid_value" اور error.param: "reasoning.effort"۔ ناقابل شناخت یا ریلے سے تیار کردہ فارمیٹ مستردگیاں کلائنٹ کی درست تاریخ کو خراب قرار دینے کے بجائے اپ اسٹریم خرابی لوٹاتی ہیں۔
اسٹریمنگ اور بحالی
کامیاب اسٹریمز response.completed پر ختم ہوتے ہیں؛ آؤٹ پٹ کی حدود response.incomplete پر ختم ہو سکتی ہیں۔ اپ اسٹریم ناکامی، ٹائم آؤٹ یا قبل از وقت EOF سے response.failed پیدا ہوتا ہے۔ ناکام اسٹریمز کو کوئی مصنوعی کامیاب ٹرمینل یا پرانا [DONE] مارکر نہیں ملتا ہے۔ ٹرمینل ایونٹ کو چیک کریں چاہے HTTP اسٹیٹس 200 ہی کیوں نہ ہو۔ ٹرمینل اسٹریم کی ناکامی بھیجے گئے کام کو خودکار طور پر دوبارہ چلانے کی اجازت نہیں دیتی۔
ہارٹ بیٹس SSE تبصروں کا استعمال کرتے ہیں۔ فراہم کنندہ کے response.metadata ایونٹس اور SSE-Keep-Alive آؤٹ پٹ آئٹمز کو فلٹر کیا جاتا ہے۔ ایونٹ sequence_number کی قدریں یکساں طور پر بڑھتی ہیں۔
اختیاری x-client-message-id اور x-resume-message-id ہیڈرز ایونٹ آفسیٹ ریکوری کا انتخاب کرتے ہیں۔ x-anyint-resume-offset-unit: sse-event اس آفسیٹ کی وضاحت کرتا ہے؛ x-anyint-stream-replayed: true ری پلے کی شناخت کرتا ہے۔ جو کلائنٹس آپٹ ان نہیں کرتے وہ ان توسیعی ہیڈرز کو نظر انداز کر سکتے ہیں۔
مطابقت کا عرفی نام
موجودہ کلائنٹس /v1/responses کا استعمال جاری رکھ سکتے ہیں۔ نئی انٹیگریشنز کو /openai/v1/responses کا استعمال کرنا چاہیے۔