Tạo phản hồi
Tạo đầu ra mô hình bằng API Phản hồi tương thích OpenAI.
Sử dụng định dạng API Phản hồi cho đầu vào mô hình dạng văn bản hoặc có cấu trúc và một đối tượng đầu ra thống nhất.
/openai/v1/responsesPhần thân yêu cầu
| Trường | Kiểu | Bắt buộc | Mô tả |
|---|---|---|---|
model | chuỗi | Có | Định danh mô hình được định tuyến bởi AnyInt. |
input | chuỗi hoặc mảng | Có | Văn bản hoặc các mục đầu vào có cấu trúc. |
stream | boolean | Không | Trả về các sự kiện do máy chủ gửi khi được hỗ trợ. |
reasoning.effort | chuỗi | Không | Nỗ lực suy luận phụ thuộc vào mô hình, được chuyển tiếp mà không tự động giảm bớt. |
tools | mảng | Không | Khai báo công cụ, bao gồm các công cụ tùy chỉnh. |
Phản hồi
Yêu cầu hoàn chỉnh trả về một đối tượng phản hồi với mã định danh, trạng thái và đầu ra được tạo.
Lịch sử và xác thực công cụ
Các lệnh gọi công cụ tùy chỉnh và đầu ra công cụ nhiều phần giữ nguyên thứ tự và văn bản Unicode. Mảng annotations và logprobs trống được cung cấp cho các phần output_text của trợ lý khi bị bỏ qua hoặc là null, để bộ chuyển tiếp không thể tái cấu trúc chúng thành siêu dữ liệu null không hợp lệ. Các tin nhắn keep-alive của nhà cung cấp bị loại trừ khỏi lịch sử cuộc trò chuyện.
Hỗ trợ nỗ lực suy luận tùy thuộc vào mô hình và upstream đã chọn. Lời từ chối có cấu trúc sẽ xác định trường này, ví dụ: error.code: "invalid_value" và error.param: "reasoning.effort". Các lỗi định dạng không thể định vị hoặc do bộ chuyển tiếp tạo ra sẽ trả về lỗi upstream thay vì xác định lịch sử hợp lệ của máy khách là bị lỗi định dạng.
Phát trực tuyến và phục hồi
Các luồng thành công kết thúc bằng response.completed; giới hạn đầu ra có thể kết thúc bằng response.incomplete. Lỗi upstream, hết thời gian chờ hoặc EOF sớm sẽ tạo ra response.failed. Các luồng bị lỗi không nhận được sự kết thúc thành công giả mạo hoặc điểm đánh dấu [DONE] cũ. Kiểm tra sự kiện kết thúc ngay cả khi trạng thái HTTP là 200. Lỗi luồng kết thúc không cho phép tự động phát lại công việc đã điều phối.
Nhịp tim (Heartbeat) sử dụng nhận xét SSE. Các sự kiện response.metadata của nhà cung cấp và các mục đầu ra SSE-Keep-Alive được lọc. Các giá trị sequence_number của sự kiện tăng đơn điệu.
Các tiêu đề tùy chọn x-client-message-id and x-resume-message-id cho phép khôi phục độ lệch sự kiện. x-anyint-resume-offset-unit: sse-event mô tả độ lệch đó; x-anyint-stream-replayed: true xác định việc phát lại. Các máy khách không chọn tham gia có thể bỏ qua các tiêu đề mở rộng này.
Bí danh tương thích
Các máy khách hiện có có thể tiếp tục sử dụng /v1/responses. Các tích hợp mới nên sử dụng /openai/v1/responses.