एक प्रतिक्रिया बनाएँ
OpenAI-संगत प्रतिक्रिया API के साथ मॉडल आउटपुट उत्पन्न करें।
टेक्स्ट या संरचित मॉडल इनपुट के लिए प्रतिक्रिया API आकार और एक एकीकृत आउटपुट ऑब्जेक्ट का उपयोग करें।
/openai/v1/responsesअनुरोध बॉडी
| फ़ील्ड | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
model | स्ट्रिंग | हाँ | AnyInt द्वारा रूट किया गया मॉडल पहचानकर्ता। |
input | स्ट्रिंग या ऐरे | हाँ | टेक्स्ट या संरचित इनपुट आइटम। |
stream | बूलियन | नहीं | समर्थित होने पर सर्वर-भेजे गए ईवेंट लौटाएँ। |
reasoning.effort | string | No | मॉडल-निर्भर प्रयास, बिना किसी छिपे हुए समझौते के अग्रेषित। |
tools | array | No | कस्टम टूल्स सहित टूल घोषणाएँ। |
प्रतिक्रिया
एक पूर्ण अनुरोध पहचानकर्ता, स्थिति और उत्पन्न आउटपुट के साथ एक प्रतिक्रिया ऑब्जेक्ट लौटाता है।
टूल इतिहास और सत्यापन
कस्टम टूल कॉल और मल्टीपार्ट टूल आउटपुट अपने क्रम और यूनिकोड टेक्स्ट को बनाए रखते हैं। जब असिस्टेंट output_text भागों के लिए annotations और logprobs खाली या नल होते हैं, तो उनके लिए खाली सरणियाँ प्रदान की जाती हैं ताकि रिले उन्हें अमान्य नल मेटाडेटा के रूप में पुनर्निर्मित न कर सके। प्रदाता की कीप-अलाइव संदेशों को बातचीत के इतिहास से बाहर रखा जाता है।
रीजनिंग प्रयास समर्थन चयनित मॉडल और अपस्ट्रीम पर निर्भर करता है। एक संरचित अस्वीकृति फ़ील्ड की पहचान करती है, उदाहरण के लिए 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 का उपयोग करना चाहिए।