إنشاء استجابة

قم بإنشاء مخرجات النموذج باستخدام واجهة برمجة تطبيقات الاستجابات المتوافقة مع OpenAI.

استخدم شكل واجهة برمجة تطبيقات الاستجابات لإدخال النص أو النموذج المنظم وكائن إخراج موحد.

POST/openai/v1/responses

نص الطلب

الحقلالنوعمطلوبالوصف
modelstringنعممعرف النموذج الذي تم توجيهه بواسطة AnyInt.
inputstring أو arrayنعمعناصر الإدخال النصية أو المنظمة.
streambooleanلاإرجاع أحداث مرسلة من الخادم عند دعمها.
reasoning.effortstringلاجهد التفكير المعتمد على النموذج، يتم توجيهه دون تقليل ضمني.
toolsarrayلاتصريحات الأدوات، بما في ذلك الأدوات المخصصة.

الاستجابة

يعيد الطلب المكتمل كائن استجابة بمعرف وحالة ومخرجات تم إنشاؤها.

سجل الأدوات والتحقق من صحتها

تحتفظ استدعاءات الأدوات المخصصة ومخرجات الأدوات متعددة الأجزاء بترتيبها ونصوص Unicode الخاصة بها. يتم توفير مصفوفات annotations وlogprobs فارغة لأجزاء output_text الخاصة بالمساعد عند حذفها أو إذا كانت فارغة (null)، حتى لا يتمكن الترحيل من إعادة بنائها كبيانات وصفية null غير صالحة. يتم استبعاد رسائل keep-alive الخاصة بمزود الخدمة من سجل المحادثة.

يعتمد دعم جهد التفكير على النموذج المحدد ومزود الخدمة الأصلي. يحدد الرفض المنظم الحقل، على سبيل المثال 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.