Cipta Respons

Hasilkan output model dengan API Respons yang serasi dengan OpenAI.

Gunakan bentuk API Respons untuk input model teks atau berstruktur dan objek output yang bersatu.

POST/openai/v1/responses

Badan Permintaan

MedanJenisDiperlukanPenerangan
modelrentetanYaPengenal model yang dihala oleh AnyInt.
inputrentetan atau tatasusunanYaItem input teks atau berstruktur.
streambooleanTidakPulangkan acara yang dihantar pelayan apabila disokong.
reasoning.effortstringNoUsaha bergantung kepada model, dimajukan tanpa pengurangan senyap.
toolsarrayNoPengisytiharan alat, termasuk alat tersuai.

Respons

Permintaan yang lengkap mengembalikan objek respons dengan pengecam, status dan output yang dijana.

Sejarah dan Pengesahan Alat

Panggilan alat tersuai dan output alat berbilang bahagian mengekalkan susunan dan teks Unicode masing-masing. Tatasusunan annotations dan logprobs kosong dibekalkan untuk bahagian output_text pembantu apabila ditinggalkan atau batal, supaya geganti tidak membina semula sebagai metadata batal tidak sah. Mesej keep-alive pembekal dikecualikan daripada sejarah perbualan.

Sokongan usaha penaakulan bergantung pada model dan huluan yang dipilih. Penolakan berstruktur mengenal pasti medan, contohnya error.code: "invalid_value" dan error.param: "reasoning.effort". Penolakan format yang tidak dapat dikesan atau dijana oleh geganti mengembalikan ralat huluan dan bukannya menganggap sejarah klien yang sah sebagai tidak sah.

Penstriman dan Pemulihan

Strim yang berjaya berakhir dengan response.completed; had output boleh berakhir dengan response.incomplete. Kegagalan huluan, tamat masa atau EOF awal menghasilkan response.failed. Strim yang gagal tidak menerima penamat kejayaan rekaan atau penanda legasi [DONE]. Semak peristiwa terminal walaupun status HTTP adalah 200. Kegagalan strim terminal tidak memberi kuasa untuk memainkan semula kerja yang telah dihantar secara automatik.

Degupan jantung menggunakan ulasan SSE. Peristiwa response.metadata pembekal dan item kawalan SSE-Keep-Alive ditapis. Nilai sequence_number peristiwa meningkat secara monotonik.

Pengepala pilihan x-client-message-id dan x-resume-message-id memilih pemulihan ofset peristiwa. x-anyint-resume-offset-unit: sse-event menerangkan ofset tersebut; x-anyint-stream-replayed: true mengenal pasti main semula. Klien yang tidak memilih masuk boleh mengabaikan pengepala sambungan ini.

Alias Keserasian

Klien sedia ada boleh terus menggunakan /v1/responses. Integrasi baharu harus menggunakan /openai/v1/responses.