Создание ответа
Генерируйте выходные данные модели с помощью API ответов, совместимого с OpenAI.
Используйте формат API ответов для текстового или структурированного ввода модели и унифицированного выходного объекта.
/openai/v1/responsesТело запроса
| Поле | Тип | Обязательно | Описание |
|---|---|---|---|
model | string | Да | Идентификатор модели, маршрутизируемый AnyInt. |
input | string or array | Да | Элементы текстового или структурированного ввода. |
stream | boolean | Нет | Возвращать события, отправляемые сервером, когда это поддерживается. |
reasoning.effort | string | Нет | Зависит от модели, передается без скрытого снижения. |
tools | array | Нет | Объявления инструментов, включая пользовательские инструменты. |
Ответ
Завершенный запрос возвращает объект ответа с идентификатором, статусом и сгенерированным выводом.
История инструментов и валидация
Пользовательские вызовы инструментов и составные выводы инструментов сохраняют свой порядок и текст 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. Терминальный сбой потока не разрешает автоматический повтор отправленной работы.
Heartbeat-сообщения используют комментарии 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.