Azure OpenAI responses

Версия API: версия 1

Server:{endpoint}/openai/v1 — Azure AI Foundry API моделей

Переменные сервера:

Variable	По умолчанию	Description
endpoint		Поддерживаемый Azure AI Foundry моделирует конечную точку API, включая протокол и имя хоста. Рассмотрим пример. https://westus.api.cognitive.microsoft.com).

Authentication

ApiKeyAuth (ключ API)

Передайте свой API в api-key заголовок.

ApiKeyAuth_ (Ключ API)

Передайте свой API в authorization заголовок.

OAuth2Auth (OAuth 2.0)

Поток: неявный

URL-адрес авторизации:https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Области:

https://cognitiveservices.azure.com/.default

Требования к безопасности

Конечные точки принимают любой из следующих методов аутентификации:

ApiKeyAuth
ApiKeyAuth_
OAuth2Auth (прицелы: https://cognitiveservices.azure.com/.default)

Создание ответа

POST {endpoint}/openai/v1/responses

Создает модельный ответ.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	server	Да	строка	Поддерживаемый Azure AI Foundry моделирует конечную точку API, включая протокол и имя хоста. Рассмотрим пример. https://westus.api.cognitive.microsoft.com).
версия API	query	Нет	строка Возможные значения: `v1`, `preview`	Явная версия API Azure AI Foundry Models, используемая для этого запроса. `v1`, если не указано иначе.

Тело запроса

Тип содержания: application/json

Name	Type	Description	Обязательный
фон	логический или null		Нет
разговор	OpenAI.ConversationParam или null		Нет
Включают	массив OpenAI.IncludeEnum или null		Нет
input	OpenAI.InputParam	Входные данные, такие как текст, изображения или файлы, в модель, используемые для генерации ответа. Подробнее: - Текстовые входные и выходные данные - Входные данные изображения - Входные данные файлов - Состояние беседы - Вызов функции	Нет
instructions	строка или null		Нет
max_output_tokens	целое число или null		Нет
max_tool_calls	целое число или null		Нет
metadata	OpenAI.Metadata или NULL		Нет
модель	строка	Идентификатор модели, используемый для создания ответа, например `gpt-4o` или `o3`. OpenAI предлагает широкий спектр моделей с разными возможностями, производительностью характеристики и цены. См. руководство по модели для просмотра и сравнения доступных моделей.	Нет
вызовы инструмента в параллельном режиме	логический или null		Нет
previous_response_id	строка или null		Нет
prompt	OpenAI.Prompt	Ссылка на шаблон запроса и его переменные. Подробнее.	Нет
prompt_cache_key	строка	Используется OpenAI для кэширования ответов для аналогичных запросов для оптимизации частоты попаданий кэша. Заменяет `user` поле. Подробнее.	Нет
prompt_cache_retention	строка или null		Нет
reasoning	OpenAI.Reasoning или NULL		Нет
safety_identifier	строка	Стабильный идентификатор, используемый для обнаружения пользователей приложения, которые могут нарушать политики использования OpenAI. Идентификаторы должны быть строкой, которая однозначно идентифицирует каждого пользователя. Мы рекомендуем хэшировать имя пользователя или адрес электронной почты, чтобы избежать отправки нам каких-либо сведений об идентификации. Подробнее.	Нет
store	логический или null		Нет
stream	логический или null		Нет
stream_options	OpenAI.ResponseStreamOptions или null		Нет
Температура	число или null		Нет
text	OpenAI.ResponseTextParam	Параметры конфигурации для текстового ответа модели. Может быть простым текстовые или структурированные данные JSON. Подробнее: - Текстовые входные и выходные данные - Структурированные выходные данные	Нет
выбор инструмента	OpenAI.ToolChoiceParam	Как модель должна выбрать инструмент (или средства), которые следует использовать при создании ответ. См. `tools` параметр, чтобы узнать, как указать инструменты Модель может звонить.	Нет
tools	OpenAI.ToolsArray	Массив инструментов, которые модель может вызывать при создании ответа. Вы может указать, какое средство следует использовать, задав `tool_choice` параметр. Ниже приведены две категории инструментов, которые можно предоставить модели: - Встроенные инструменты: инструменты, предоставляемые OpenAI для расширения Возможности модели, такие как поиск файлов. - Вызовы функций (пользовательские средства): функции, определенные вами, позволяет модели вызывать собственный код.	Нет
top_logprobs	целое число или null		Нет
top_p	число или null		Нет
truncation	строка или null		Нет
user	string (не рекомендуется)	Это поле заменяется `safety_identifier` и `prompt_cache_key`. Вместо этого используйте `prompt_cache_key` для поддержания оптимизации кэширования. Стабильный идентификатор для конечных пользователей. Используется для повышения скорости попадания кэша в более эффективное сегментирование аналогичных запросов и помогает OpenAI обнаруживать и предотвращать злоупотребление. Подробнее.	Нет

Responses

Код состояния: 200

Описание: запрос выполнен успешно.

Тип содержимого	Type	Description
application/json	object
text/event-stream	object

Name	Type	Description	Обязательный	По умолчанию
фон	логический или null		Нет
завершено_в	строка или null		Нет
content_filters	массив AzureContentFilterForResponsesAPI	Фильтр содержимого приводит к результату RAI.	Да
разговор	OpenAI.ConversationReference или null		Нет
создано_в	целое число (UnixTime)	Метка времени в формате Unix (в секундах), когда был создан этот ответ.	Да
error	OpenAI.ResponseError или null		Да
id	строка	Уникальный идентификатор для этого ответа.	Да
incomplete_details	OpenAI.ResponseIncompleteDetails или null		Да
instructions	строка или массив OpenAI.InputItem или null		Да
max_output_tokens	целое число или null		Нет
max_tool_calls	целое число или null		Нет
metadata	OpenAI.Metadata или NULL		Нет
модель	строка	Идентификатор модели, используемый для создания ответа, например `gpt-4o` или `o3`. OpenAI предлагает широкий спектр моделей с разными возможностями, производительностью характеристики и цены. См. руководство по модели для просмотра и сравнения доступных моделей.	Нет
object	enum	Тип объекта этого ресурса — всегда установлено `response`. Возможные значения: `response`	Да
output	массив OpenAI.OutputItem	Массив элементов контента, созданных моделью. — Длина и порядок элементов в массиве `output` зависят в ответе модели. — Вместо доступа к первому элементу массива `output` и Предположим, что это `assistant` сообщение с содержанием, созданным Вы можете рассмотреть возможность использования свойства `output_text` модели, если поддерживается в пакетах SDK.	Да
output_text	строка или null		Нет
вызовы инструмента в параллельном режиме	boolean	Следует ли разрешить модели запускать вызовы инструментов параллельно.	Да	True
previous_response_id	строка или null		Нет
prompt	OpenAI.Prompt	Ссылка на шаблон запроса и его переменные. Подробнее.	Нет
prompt_cache_key	строка	Используется OpenAI для кэширования ответов для аналогичных запросов для оптимизации частоты попаданий кэша. Заменяет `user` поле. Подробнее.	Нет
prompt_cache_retention	строка или null		Нет
reasoning	OpenAI.Reasoning или NULL		Нет
safety_identifier	строка	Стабильный идентификатор, используемый для обнаружения пользователей приложения, которые могут нарушать политики использования OpenAI. Идентификаторы должны быть строкой, которая однозначно идентифицирует каждого пользователя. Мы рекомендуем хэшировать имя пользователя или адрес электронной почты, чтобы избежать отправки нам каких-либо сведений об идентификации. Подробнее.	Нет
Статус	enum	Статус формирования ответа. Один из `completed`, `failed` `in_progress`, `cancelled`, `queued` или `incomplete`. Возможные значения: `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete`	Нет
Температура	число или null		Нет
text	OpenAI.ResponseTextParam	Параметры конфигурации для текстового ответа модели. Может быть простым текстовые или структурированные данные JSON. Подробнее: - Текстовые входные и выходные данные - Структурированные выходные данные	Нет
выбор инструмента	OpenAI.ToolChoiceParam	Как модель должна выбрать инструмент (или средства), которые следует использовать при создании ответ. См. `tools` параметр, чтобы узнать, как указать инструменты Модель может звонить.	Нет
tools	OpenAI.ToolsArray	Массив инструментов, которые модель может вызывать при создании ответа. Вы может указать, какое средство следует использовать, задав `tool_choice` параметр. Мы поддерживаем следующие категории инструментов: - Встроенные инструменты: инструменты, предоставляемые OpenAI для расширения Возможности модели, такие как поиск в Интернете или поиск по файлам. Дополнительные сведения встроенные средства. - Инструменты MCP: интеграция с сторонними системами с помощью пользовательских серверов MCP или предопределенные соединители, такие как Google Drive и SharePoint. Дополнительные сведения Инструменты MCP. - Вызовы функций (пользовательские средства): функции, определенные вами, включение модели для вызова собственного кода с строго типизированными аргументами и выходные данные. Дополнительные сведения вызов функции. Вы также можете использовать пользовательские средства для вызова собственного кода.	Нет
top_logprobs	целое число или null		Нет
top_p	число или null		Нет
truncation	строка или null		Нет
использование	OpenAI.ResponseUsage	Представляет сведения об использовании маркеров, включая входные маркеры, выходные маркеры, разбивка выходных маркеров и общих используемых маркеров.	Нет
user	string (не рекомендуется)	Это поле заменяется `safety_identifier` и `prompt_cache_key`. Вместо этого используйте `prompt_cache_key` для поддержания оптимизации кэширования. Стабильный идентификатор для конечных пользователей. Используется для повышения скорости попадания кэша в более эффективное сегментирование аналогичных запросов и помогает OpenAI обнаруживать и предотвращать злоупотребление. Подробнее.	Нет

Заголовки ответа:

Заголовка	Type	Description
apim-request-id	строка	Идентификатор запроса, используемый для устранения неполадок.

Код состояния: по умолчанию

Описание: непредвиденная ошибка.

Тип содержимого	Type	Description
application/json	object

Name	Type	Обязательный
code	строка или null	Да
внутренняя ошибка		Нет
message	строка	Да
параметр	строка или null	Да
type	строка	Да

Заголовки ответа:

Заголовка	Type	Description
apim-request-id	строка	Идентификатор запроса, используемый для устранения неполадок.

Примеры

Пример

Создать примерный ответ

POST {endpoint}/openai/v1/responses?api-version=v1

Получение ответа

GET {endpoint}/openai/v1/responses/{response_id}

Извлекает ответ модели с заданным идентификатором.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	server	Да	строка	Поддерживаемый Azure AI Foundry моделирует конечную точку API, включая протокол и имя хоста. Рассмотрим пример. https://westus.api.cognitive.microsoft.com).
версия API	query	Нет	строка Возможные значения: `v1`, `preview`	Явная версия API Azure AI Foundry Models, используемая для этого запроса. `v1`, если не указано иначе.
response_id	path	Да	строка
include[]	query	Нет	массив	Дополнительные поля для включения в ответ. Дополнительные сведения см. в параметре include для создания ответа выше.
stream	query	Нет	boolean	Если задано значение true, данные ответа модели будут передаваться клиенту по мере его создания с помощью событий, отправляемых сервером. Сериализация: взрыв: ложь
starting_after	query	Нет	целое число (int32)	Порядковый номер события, после которого необходимо начать потоковую передачу. Сериализация: взрыв: ложь
include_obfuscation	query	Нет	boolean	Если задано значение true, будет включена обфускация потока. Потоковая обфускация добавляет случайные символы в `obfuscation` поле потоковых дельта-событий, чтобы нормализовать размеры полезных нагрузок как меру защиты от определенных атак по побочным каналам. Эти поля маскирования включаются по умолчанию, но добавляют небольшое количество накладных расходов в поток данных. Вы можете установить значение `include_obfuscation` в false для оптимизации пропускной способности, если вы доверяете сетевым подключениям между вашим приложением и API OpenAI. Сериализация: взрыв: ложь

Responses

Код состояния: 200

Описание: запрос выполнен успешно.

Тип содержимого	Type	Description
application/json	object

Name	Type	Description	Обязательный	По умолчанию
фон	логический или null		Нет
завершено_в	строка или null		Нет
content_filters	массив AzureContentFilterForResponsesAPI	Фильтр содержимого приводит к результату RAI.	Да
разговор	OpenAI.ConversationReference или null		Нет
создано_в	целое число (UnixTime)	Метка времени в формате Unix (в секундах), когда был создан этот ответ.	Да
error	OpenAI.ResponseError или null		Да
id	строка	Уникальный идентификатор для этого ответа.	Да
incomplete_details	OpenAI.ResponseIncompleteDetails или null		Да
instructions	строка или массив OpenAI.InputItem или null		Да
max_output_tokens	целое число или null		Нет
max_tool_calls	целое число или null		Нет
metadata	OpenAI.Metadata или NULL		Нет
модель	строка	Идентификатор модели, используемый для создания ответа, например `gpt-4o` или `o3`. OpenAI предлагает широкий спектр моделей с разными возможностями, производительностью характеристики и цены. См. руководство по модели для просмотра и сравнения доступных моделей.	Нет
object	enum	Тип объекта этого ресурса — всегда установлено `response`. Возможные значения: `response`	Да
output	массив OpenAI.OutputItem	Массив элементов контента, созданных моделью. — Длина и порядок элементов в массиве `output` зависят в ответе модели. — Вместо доступа к первому элементу массива `output` и Предположим, что это `assistant` сообщение с содержанием, созданным Вы можете рассмотреть возможность использования свойства `output_text` модели, если поддерживается в пакетах SDK.	Да
output_text	строка или null		Нет
вызовы инструмента в параллельном режиме	boolean	Следует ли разрешить модели запускать вызовы инструментов параллельно.	Да	True
previous_response_id	строка или null		Нет
prompt	OpenAI.Prompt	Ссылка на шаблон запроса и его переменные. Подробнее.	Нет
prompt_cache_key	строка	Используется OpenAI для кэширования ответов для аналогичных запросов для оптимизации частоты попаданий кэша. Заменяет `user` поле. Подробнее.	Нет
prompt_cache_retention	строка или null		Нет
reasoning	OpenAI.Reasoning или NULL		Нет
safety_identifier	строка	Стабильный идентификатор, используемый для обнаружения пользователей приложения, которые могут нарушать политики использования OpenAI. Идентификаторы должны быть строкой, которая однозначно идентифицирует каждого пользователя. Мы рекомендуем хэшировать имя пользователя или адрес электронной почты, чтобы избежать отправки нам каких-либо сведений об идентификации. Подробнее.	Нет
Статус	enum	Статус формирования ответа. Один из `completed`, `failed` `in_progress`, `cancelled`, `queued` или `incomplete`. Возможные значения: `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete`	Нет
Температура	число или null		Нет
text	OpenAI.ResponseTextParam	Параметры конфигурации для текстового ответа модели. Может быть простым текстовые или структурированные данные JSON. Подробнее: - Текстовые входные и выходные данные - Структурированные выходные данные	Нет
выбор инструмента	OpenAI.ToolChoiceParam	Как модель должна выбрать инструмент (или средства), которые следует использовать при создании ответ. См. `tools` параметр, чтобы узнать, как указать инструменты Модель может звонить.	Нет
tools	OpenAI.ToolsArray	Массив инструментов, которые модель может вызывать при создании ответа. Вы может указать, какое средство следует использовать, задав `tool_choice` параметр. Мы поддерживаем следующие категории инструментов: - Встроенные инструменты: инструменты, предоставляемые OpenAI для расширения Возможности модели, такие как поиск в Интернете или поиск по файлам. Дополнительные сведения встроенные средства. - Инструменты MCP: интеграция с сторонними системами с помощью пользовательских серверов MCP или предопределенные соединители, такие как Google Drive и SharePoint. Дополнительные сведения Инструменты MCP. - Вызовы функций (пользовательские средства): функции, определенные вами, включение модели для вызова собственного кода с строго типизированными аргументами и выходные данные. Дополнительные сведения вызов функции. Вы также можете использовать пользовательские средства для вызова собственного кода.	Нет
top_logprobs	целое число или null		Нет
top_p	число или null		Нет
truncation	строка или null		Нет
использование	OpenAI.ResponseUsage	Представляет сведения об использовании маркеров, включая входные маркеры, выходные маркеры, разбивка выходных маркеров и общих используемых маркеров.	Нет
user	string (не рекомендуется)	Это поле заменяется `safety_identifier` и `prompt_cache_key`. Вместо этого используйте `prompt_cache_key` для поддержания оптимизации кэширования. Стабильный идентификатор для конечных пользователей. Используется для повышения скорости попадания кэша в более эффективное сегментирование аналогичных запросов и помогает OpenAI обнаруживать и предотвращать злоупотребление. Подробнее.	Нет

Заголовки ответа:

Заголовка	Type	Description
apim-request-id	строка	Идентификатор запроса, используемый для устранения неполадок.

Код состояния: по умолчанию

Описание: непредвиденная ошибка.

Тип содержимого	Type	Description
application/json	object

Name	Type	Обязательный
code	строка или null	Да
внутренняя ошибка		Нет
message	строка	Да
параметр	строка или null	Да
type	строка	Да

Заголовки ответа:

Заголовка	Type	Description
apim-request-id	строка	Идентификатор запроса, используемый для устранения неполадок.

Удаление ответа

DELETE {endpoint}/openai/v1/responses/{response_id}

Удаляет ответ по идентификатору.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	server	Да	строка	Поддерживаемый Azure AI Foundry моделирует конечную точку API, включая протокол и имя хоста. Рассмотрим пример. https://westus.api.cognitive.microsoft.com).
версия API	query	Нет	строка Возможные значения: `v1`, `preview`	Явная версия API Azure AI Foundry Models, используемая для этого запроса. `v1`, если не указано иначе.
response_id	path	Да	строка

Responses

Код состояния: 200

Описание: запрос выполнен успешно.

Тип содержимого	Type	Description
application/json	object

Name	Type	Description	Обязательный
удалено	enum	Возможные значения: `True`	Да
id	строка		Да
object	enum	Возможные значения: `response.deleted`	Да

Заголовки ответа:

Заголовка	Type	Description
apim-request-id	строка	Идентификатор запроса, используемый для устранения неполадок.

Код состояния: по умолчанию

Описание: непредвиденная ошибка.

Тип содержимого	Type	Description
application/json	object

Name	Type	Обязательный
code	строка или null	Да
внутренняя ошибка		Нет
message	строка	Да
параметр	строка или null	Да
type	строка	Да

Заголовки ответа:

Заголовка	Type	Description
apim-request-id	строка	Идентификатор запроса, используемый для устранения неполадок.

Отмена ответа

POST {endpoint}/openai/v1/responses/{response_id}/cancel

Отменяет ответ модели с заданным идентификатором. Можно отменить только ответы, созданные с параметром фонового параметра true.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	server	Да	строка	Поддерживаемый Azure AI Foundry моделирует конечную точку API, включая протокол и имя хоста. Рассмотрим пример. https://westus.api.cognitive.microsoft.com).
версия API	query	Нет	строка Возможные значения: `v1`, `preview`	Явная версия API Azure AI Foundry Models, используемая для этого запроса. `v1`, если не указано иначе.
response_id	path	Да	строка

Responses

Код состояния: 200

Описание: запрос выполнен успешно.

Тип содержимого	Type	Description
application/json	object

Name	Type	Description	Обязательный	По умолчанию
фон	логический или null		Нет
завершено_в	строка или null		Нет
content_filters	массив AzureContentFilterForResponsesAPI	Фильтр содержимого приводит к результату RAI.	Да
разговор	OpenAI.ConversationReference или null		Нет
создано_в	целое число (UnixTime)	Метка времени в формате Unix (в секундах), когда был создан этот ответ.	Да
error	OpenAI.ResponseError или null		Да
id	строка	Уникальный идентификатор для этого ответа.	Да
incomplete_details	OpenAI.ResponseIncompleteDetails или null		Да
instructions	строка или массив OpenAI.InputItem или null		Да
max_output_tokens	целое число или null		Нет
max_tool_calls	целое число или null		Нет
metadata	OpenAI.Metadata или NULL		Нет
модель	строка	Идентификатор модели, используемый для создания ответа, например `gpt-4o` или `o3`. OpenAI предлагает широкий спектр моделей с разными возможностями, производительностью характеристики и цены. См. руководство по модели для просмотра и сравнения доступных моделей.	Нет
object	enum	Тип объекта этого ресурса — всегда установлено `response`. Возможные значения: `response`	Да
output	массив OpenAI.OutputItem	Массив элементов контента, созданных моделью. — Длина и порядок элементов в массиве `output` зависят в ответе модели. — Вместо доступа к первому элементу массива `output` и Предположим, что это `assistant` сообщение с содержанием, созданным Вы можете рассмотреть возможность использования свойства `output_text` модели, если поддерживается в пакетах SDK.	Да
output_text	строка или null		Нет
вызовы инструмента в параллельном режиме	boolean	Следует ли разрешить модели запускать вызовы инструментов параллельно.	Да	True
previous_response_id	строка или null		Нет
prompt	OpenAI.Prompt	Ссылка на шаблон запроса и его переменные. Подробнее.	Нет
prompt_cache_key	строка	Используется OpenAI для кэширования ответов для аналогичных запросов для оптимизации частоты попаданий кэша. Заменяет `user` поле. Подробнее.	Нет
prompt_cache_retention	строка или null		Нет
reasoning	OpenAI.Reasoning или NULL		Нет
safety_identifier	строка	Стабильный идентификатор, используемый для обнаружения пользователей приложения, которые могут нарушать политики использования OpenAI. Идентификаторы должны быть строкой, которая однозначно идентифицирует каждого пользователя. Мы рекомендуем хэшировать имя пользователя или адрес электронной почты, чтобы избежать отправки нам каких-либо сведений об идентификации. Подробнее.	Нет
Статус	enum	Статус формирования ответа. Один из `completed`, `failed` `in_progress`, `cancelled`, `queued` или `incomplete`. Возможные значения: `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete`	Нет
Температура	число или null		Нет
text	OpenAI.ResponseTextParam	Параметры конфигурации для текстового ответа модели. Может быть простым текстовые или структурированные данные JSON. Подробнее: - Текстовые входные и выходные данные - Структурированные выходные данные	Нет
выбор инструмента	OpenAI.ToolChoiceParam	Как модель должна выбрать инструмент (или средства), которые следует использовать при создании ответ. См. `tools` параметр, чтобы узнать, как указать инструменты Модель может звонить.	Нет
tools	OpenAI.ToolsArray	Массив инструментов, которые модель может вызывать при создании ответа. Вы может указать, какое средство следует использовать, задав `tool_choice` параметр. Мы поддерживаем следующие категории инструментов: - Встроенные инструменты: инструменты, предоставляемые OpenAI для расширения Возможности модели, такие как поиск в Интернете или поиск по файлам. Дополнительные сведения встроенные средства. - Инструменты MCP: интеграция с сторонними системами с помощью пользовательских серверов MCP или предопределенные соединители, такие как Google Drive и SharePoint. Дополнительные сведения Инструменты MCP. - Вызовы функций (пользовательские средства): функции, определенные вами, включение модели для вызова собственного кода с строго типизированными аргументами и выходные данные. Дополнительные сведения вызов функции. Вы также можете использовать пользовательские средства для вызова собственного кода.	Нет
top_logprobs	целое число или null		Нет
top_p	число или null		Нет
truncation	строка или null		Нет
использование	OpenAI.ResponseUsage	Представляет сведения об использовании маркеров, включая входные маркеры, выходные маркеры, разбивка выходных маркеров и общих используемых маркеров.	Нет
user	string (не рекомендуется)	Это поле заменяется `safety_identifier` и `prompt_cache_key`. Вместо этого используйте `prompt_cache_key` для поддержания оптимизации кэширования. Стабильный идентификатор для конечных пользователей. Используется для повышения скорости попадания кэша в более эффективное сегментирование аналогичных запросов и помогает OpenAI обнаруживать и предотвращать злоупотребление. Подробнее.	Нет

Заголовки ответа:

Заголовка	Type	Description
apim-request-id	строка	Идентификатор запроса, используемый для устранения неполадок.

Код состояния: по умолчанию

Описание: непредвиденная ошибка.

Тип содержимого	Type	Description
application/json	object

Name	Type	Обязательный
code	строка или null	Да
внутренняя ошибка		Нет
message	строка	Да
параметр	строка или null	Да
type	строка	Да

Заголовки ответа:

Заголовка	Type	Description
apim-request-id	строка	Идентификатор запроса, используемый для устранения неполадок.

Список входных элементов

GET {endpoint}/openai/v1/responses/{response_id}/input_items

Возвращает список входных элементов для заданного ответа.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	server	Да	строка	Поддерживаемый Azure AI Foundry моделирует конечную точку API, включая протокол и имя хоста. Рассмотрим пример. https://westus.api.cognitive.microsoft.com).
версия API	query	Нет	строка Возможные значения: `v1`, `preview`	Явная версия API Azure AI Foundry Models, используемая для этого запроса. `v1`, если не указано иначе.
response_id	path	Да	строка
limit	query	Нет	целое число (int32)	Ограничение количества возвращаемых объектов. Ограничение может варьироваться от 1 до 100, и значение по умолчанию — 20. Сериализация: взрыв: ложь
order	query	Нет	строка Возможные значения: `asc`, `desc`	Сортировка объектов по их метке времени `created_at`. `asc` для порядка возрастания и`desc` для сортировки по убыванию Сериализация: взрыв: ложь
После	query	Нет	строка	Курсор для использования в разбиении на страницы. `after` — это идентификатор объекта, определяющий место в списке. Например, если вы делаете запрос списка и получаете 100 объектов, список заканчивается на obj_foo. последующий вызов может включать after=obj_foo, чтобы получить следующую страницу списка. Сериализация: взрыв: ложь
before	query	Нет	строка	Курсор для использования в разбиении на страницы. `before` — это идентификатор объекта, определяющий место в списке. Например, если вы делаете запрос списка и получаете 100 объектов, список заканчивается на obj_foo. последующий вызов может содержать параметр before=obj_foo, чтобы получить предыдущую страницу списка. Сериализация: взрыв: ложь

Responses

Код состояния: 200

Описание: запрос выполнен успешно.

Тип содержимого	Type	Description
application/json	OpenAI.ResponseItemList

Заголовки ответа:

Заголовка	Type	Description
apim-request-id	строка	Идентификатор запроса, используемый для устранения неполадок.

Код состояния: по умолчанию

Описание: непредвиденная ошибка.

Тип содержимого	Type	Description
application/json	object

Name	Type	Обязательный
code	строка или null	Да
внутренняя ошибка		Нет
message	строка	Да
параметр	строка или null	Да
type	строка	Да

Заголовки ответа:

Заголовка	Type	Description
apim-request-id	строка	Идентификатор запроса, используемый для устранения неполадок.

Components

AzureAIFoundryModelsApiVersion

Property	Ценность
Type	строка
Значения	`v1` `preview`

AzureContentFilterBlocklistResult

Коллекция результатов фильтрации true/false для настроенных настраиваемых списков блокировок.

Name	Type	Description	Обязательный	По умолчанию
details	массив объекта	Пары отдельных идентификаторов черных списков и привели ли они к действию фильтрации.	Нет
Отфильтрованный	boolean	Значение, указывающее, приводит ли любой из подробных списков блокировок к действию фильтрации.	Да

AzureContentFilterCompletionTextSpan

Представление текста завершённого сегмента, используемого результатами фильтрации содержимого Azure OpenAI.

Name	Type	Description	Обязательный	По умолчанию
completion_end_offset	целое число (int32)	Смещение первой кодовой точки UTF32, исключаемой из диапазона. Это поле всегда равно completion_start_offset в случае пустых диапазонов. Это поле всегда больше completion_start_offset для непустых диапазонов.	Да
completion_start_offset	целое число (int32)	Смещение кодовой точки UTF32, с которой начинается диапазон.	Да

AzureContentFilterCompletionTextSpanDetectionResult

Name	Type	Description	Обязательный
details	массив AzureContentFilterCompletionTextSpan	Подробные сведения об обнаруженных диапазонах текста завершения.	Да
Обнаружено	boolean	Обнаружена ли в содержимом категория отмеченного контента.	Да
Отфильтрованный	boolean	Приведет ли обнаружение содержимого к действию фильтрации содержимого.	Да

РезультатНастраиваемойТемыФильтраКонтентаAzure

Коллекция результатов фильтрации true/false для настроенных пользовательских разделов.

Name	Type	Description	Обязательный	По умолчанию
details	массив объекта	Пары идентификаторов отдельных тем и информация об их обнаружении.	Нет
Отфильтрованный	boolean	Значение, указывающее, приводит ли любой из подробных разделов к действию фильтрации.	Да

AzureContentFilterDetectionResult

Элемент результата фильтра содержимого с метками, указывающий, был ли обнаружен контент и был ли отфильтрован содержимое.

Name	Type	Description	Обязательный	По умолчанию
Обнаружено	boolean	Обнаружена ли в содержимом категория отмеченного контента.	Да
Отфильтрованный	boolean	Приведет ли обнаружение содержимого к действию фильтрации содержимого.	Да

AzureContentFilterForResponsesAPI

Name	Type	Description	Обязательный
Заблокирован	boolean	Укажите, заблокирован ли ответ.	Да
content_filter_offsets	AzureContentFilterResultOffsets		Да
результаты фильтрации контента	AzureContentFilterResultsForResponsesAPI		Да
└─ настраиваемые черные списки	AzureContentFilterBlocklistResult	Коллекция результатов двоичной фильтрации для настроенных настраиваемых списков блокировок.	Нет
└темы_настроек	AzureContentFilterCustomTopicResult	Коллекция результатов двоичной фильтрации для настроенных пользовательских разделов.	Нет
└─ Ошибка	object	Если имеются, подробные сведения об ошибке, которая помешала завершить оценку фильтрации содержимого.	Нет
└─ Код	целое число (int32)	Отдельный удобочитаемый компьютером код, связанный с ошибкой.	Да
Сообщение └️	строка	Сообщение, доступное для чтения человеком, связанное с ошибкой.	Да
└️ ненависть	AzureContentFilterSeverityResult	Категория фильтра содержимого, которая может ссылаться на любое содержимое, которое атакует или использует дискриминационный или дискриминационный характер. язык с ссылкой на группу удостоверений или человека на основе определенных атрибутов разных групп включая, но не ограничивается расой, этнической принадлежностью, национальностью, гендерной идентификацией и выражением, сексуальной ориентацией, религия, иммиграционный статус, статус способности, личный вид и размер тела.	Нет
└─ косвенная_атака	AzureContentFilterDetectionResult	Результат обнаружения, описывающий атаки на системы на основе моделей генерированного искусственного интеллекта, которые могут происходить каждый раз приложение обрабатывает сведения, которые не были непосредственно созданы разработчиком приложения или пользователь.	Нет
└️ джейл-брейк	AzureContentFilterDetectionResult	Результат обнаружения, описывающий атаки на внедрение запросов пользователей, где злоумышленники намеренно эксплуатируют уязвимости системы для получения несанкционированного поведения от LLM. Это может привести к несоответствующем содержимому создание или нарушение установленных системой ограничений.	Да
└personally_identifiable_information personally_identifiable_information	AzureContentFilterPersonallyIdentifiableInformationResult	Результат обнаружения, описывающий совпадения с персональными идентифицируемыми сведениями с настраиваемыми подкатегориями.	Нет
└️ ненормативная лексика	AzureContentFilterDetectionResult	Результат обнаружения, определяющий, присутствует ли в языке возражений сырая, вульгарная или в противном случае Содержимого.	Нет
└️ protected_material_code	object	Результат обнаружения, описывающий совпадение с лицензированным кодом или другим защищенным исходным материалом.	Нет
└─ цитирование	object	Если возможно, детали цитирования, описывающие связанную лицензию и место их расположения.	Нет
URL-адрес	string (URI)	URL-адрес, связанный с лицензией.	Нет
Лицензия	строка	Имя или идентификатор лицензии, связанной с обнаружением.	Нет
└─ Обнаружено	boolean	Обнаружена ли в содержимом категория отмеченного контента.	Да
└️ отфильтрован	boolean	Приведет ли обнаружение содержимого к действию фильтрации содержимого.	Да
└️ protected_material_text	AzureContentFilterDetectionResult	Результат обнаружения, описывающий совпадение с текстом, защищенным авторским правом или другим статусом.	Нет
└─ членовредительство	AzureContentFilterSeverityResult	Категория фильтра содержимого, описывающая язык, связанный с физическими действиями, предназначенными для намеренной травмы, повредить тело или убить себя.	Нет
└️ сексуальный	AzureContentFilterSeverityResult	Категория фильтра содержимого для языка, связанного с анатомическими органами и гениталиями, романтическими отношениями, действует изображается в эротических или ласковых терминах, беременности, физических сексуальных актах, в том числе изображаемых как нападение или принудительное сексуальное насилие против воли, проституции, порнографии и злоупотреблений.	Нет
└task_adherence	AzureContentFilterDetectionResult	Результат обнаружения, указывающий, остается ли поток выполнения придерживаться плана.	Да
└️ ungrounded_material	AzureContentFilterCompletionTextSpanDetectionResult		Нет
└️ насилие	AzureContentFilterSeverityResult	Категория фильтра содержимого для языка, связанного с физическими действиями, предназначенными для повреждения, травмы, повреждения или убийства кто-то или что-то; описывает оружие, оружие и связанные сущности, такие как производство, ассоциации, законодательство и т. д.	Нет
source_type	строка	Имя исходного типа сообщения.	Да

Azure Фильтр контента: Результат для Личной Идентифицируемой Информации

Результат обнаружения фильтра контента для персонально идентифицируемой информации, включая расширения, связанные с потенциальным вредом.

Name	Type	Description	Обязательный
Обнаружено	boolean	Обнаружена ли в содержимом категория отмеченного контента.	Да
Отфильтрованный	boolean	Приведет ли обнаружение содержимого к действию фильтрации содержимого.	Да
redacted_text	строка	Отредактированные тексты с информацией piI удалены или маскированы.	Нет
подкатегории	массив AzurePiiSubCategoryResult	Подробные результаты для отдельных PIIHarmSubCategory.	Нет

AzureContentFilterResultOffsets

Name	Type	Обязательный
check_offset	целое число (int32)	Да
end_offset	целое число (int32)	Да
start_offset	целое число (int32)	Да

AzureContentFilterResultsForResponsesAPI

Name	Type	Description	Обязательный
custom_blocklists	AzureContentFilterBlocklistResult	Коллекция результатов фильтрации true/false для настроенных настраиваемых списков блокировок.	Нет
└️ подробности	массив объекта	Пары отдельных идентификаторов черных списков и привели ли они к действию фильтрации.	Нет
└️ отфильтрован	boolean	Значение, указывающее, был ли блок-список создан действие фильтрации.	Да
Идентификатор └️	строка	Идентификатор настраиваемого списка блоков, вычисляемого.	Да
└️ отфильтрован	boolean	Значение, указывающее, приводит ли любой из подробных списков блокировок к действию фильтрации.	Да
пользовательские_темы	AzureContentFilterCustomTopicResult	Коллекция результатов фильтрации true/false для настроенных пользовательских разделов.	Нет
└️ подробности	массив объекта	Пары идентификаторов отдельных тем и информация об их обнаружении.	Нет
└─ Обнаружено	boolean	Значение, указывающее, обнаружен ли раздел.	Да
Идентификатор └️	строка	Идентификатор вычисляемого пользовательского раздела.	Да
└️ отфильтрован	boolean	Значение, указывающее, приводит ли любой из подробных разделов к действию фильтрации.	Да
error	object	Если имеются, подробные сведения об ошибке, которая помешала завершить оценку фильтрации содержимого.	Нет
└─ Код	целое число (int32)	Отдельный удобочитаемый компьютером код, связанный с ошибкой.	Да
Сообщение └️	строка	Сообщение, доступное для чтения человеком, связанное с ошибкой.	Да
Ненавижу	AzureContentFilterSeverityResult	Результат фильтрации содержимого с обозначениями, указывающий, было ли отфильтровано содержимое и каково его качественное состояние. Уровень серьезности содержимого был оценен по конфигурации фильтра содержимого для категории.	Нет
└️ отфильтрован	boolean	Является ли серьезность содержимого результатом действия фильтрации содержимого.	Да
└─ серьезность	enum	Заданный уровень серьезности содержимого. Возможные значения: `safe`, , `lowmediumhigh`	Да
indirect_attack	AzureContentFilterDetectionResult	Элемент результата фильтра содержимого с меткой, указывающий, было ли содержимое обнаружено и было ли оно выявлено. отфильтрованный.	Нет
└─ Обнаружено	boolean	Обнаружена ли в содержимом категория отмеченного контента.	Да
└️ отфильтрован	boolean	Приведет ли обнаружение содержимого к действию фильтрации содержимого.	Да
Джейлбрейк	AzureContentFilterDetectionResult	Элемент результата фильтра содержимого с меткой, указывающий, было ли содержимое обнаружено и было ли оно выявлено. отфильтрованный.	Да
└─ Обнаружено	boolean	Обнаружена ли в содержимом категория отмеченного контента.	Да
└️ отфильтрован	boolean	Приведет ли обнаружение содержимого к действию фильтрации содержимого.	Да
персонально идентифицируемая информация	AzureContentFilterPersonallyIdentifiableInformationResult	Результат обнаружения фильтра контента для персонально идентифицируемой информации, включая расширения, связанные с потенциальным вредом.	Нет
└️ redacted_text	строка	Отредактированные тексты с информацией piI удалены или маскированы.	Нет
└─ подкатегории	массив AzurePiiSubCategoryResult	Подробные результаты для отдельных PIIHarmSubCategory.	Нет
Ненормативной лексики	AzureContentFilterDetectionResult	Элемент результата фильтра содержимого с меткой, указывающий, было ли содержимое обнаружено и было ли оно выявлено. отфильтрованный.	Нет
└─ Обнаружено	boolean	Обнаружена ли в содержимом категория отмеченного контента.	Да
└️ отфильтрован	boolean	Приведет ли обнаружение содержимого к действию фильтрации содержимого.	Да
код_защищённого_материала	object	Результат обнаружения, описывающий совпадение с лицензированным кодом или другим защищенным исходным материалом.	Нет
└─ цитирование	object	Если возможно, детали цитирования, описывающие связанную лицензию и место их расположения.	Нет
URL-адрес	string (URI)	URL-адрес, связанный с лицензией.	Нет
Лицензия	строка	Имя или идентификатор лицензии, связанной с обнаружением.	Нет
└─ Обнаружено	boolean	Обнаружена ли в содержимом категория отмеченного контента.	Да
└️ отфильтрован	boolean	Приведет ли обнаружение содержимого к действию фильтрации содержимого.	Да
защищённый_текст_материала	AzureContentFilterDetectionResult	Элемент результата фильтра содержимого с меткой, указывающий, было ли содержимое обнаружено и было ли оно выявлено. отфильтрованный.	Нет
└─ Обнаружено	boolean	Обнаружена ли в содержимом категория отмеченного контента.	Да
└️ отфильтрован	boolean	Приведет ли обнаружение содержимого к действию фильтрации содержимого.	Да
самоповреждение	AzureContentFilterSeverityResult	Результат фильтрации содержимого с обозначениями, указывающий, было ли отфильтровано содержимое и каково его качественное состояние. Уровень серьезности содержимого был оценен по конфигурации фильтра содержимого для категории.	Нет
└️ отфильтрован	boolean	Является ли серьезность содержимого результатом действия фильтрации содержимого.	Да
└─ серьезность	enum	Заданный уровень серьезности содержимого. Возможные значения: `safe`, , `lowmediumhigh`	Да
Сексуальной	AzureContentFilterSeverityResult	Результат фильтрации содержимого с обозначениями, указывающий, было ли отфильтровано содержимое и каково его качественное состояние. Уровень серьезности содержимого был оценен по конфигурации фильтра содержимого для категории.	Нет
└️ отфильтрован	boolean	Является ли серьезность содержимого результатом действия фильтрации содержимого.	Да
└─ серьезность	enum	Заданный уровень серьезности содержимого. Возможные значения: `safe`, , `lowmediumhigh`	Да
task_adherence	AzureContentFilterDetectionResult	Элемент результата фильтра содержимого с меткой, указывающий, было ли содержимое обнаружено и было ли оно выявлено. отфильтрованный.	Да
└─ Обнаружено	boolean	Обнаружена ли в содержимом категория отмеченного контента.	Да
└️ отфильтрован	boolean	Приведет ли обнаружение содержимого к действию фильтрации содержимого.	Да
ungrounded_material	AzureContentFilterCompletionTextSpanDetectionResult		Нет
Насилия	AzureContentFilterSeverityResult	Результат фильтрации содержимого с обозначениями, указывающий, было ли отфильтровано содержимое и каково его качественное состояние. Уровень серьезности содержимого был оценен по конфигурации фильтра содержимого для категории.	Нет
└️ отфильтрован	boolean	Является ли серьезность содержимого результатом действия фильтрации содержимого.	Да
└─ серьезность	enum	Заданный уровень серьезности содержимого. Возможные значения: `safe`, , `lowmediumhigh`	Да

AzureContentFilterSeverityResult

Элемент результата фильтра содержимого с метками, указывающий, был ли отфильтрован контент и какой уровень серьезности содержимого был оценен по конфигурации фильтра содержимого для категории.

Name	Type	Description	Обязательный	По умолчанию
Отфильтрованный	boolean	Является ли серьезность содержимого результатом действия фильтрации содержимого.	Да
Тяжести	enum	Заданный уровень серьезности содержимого. Возможные значения: `safe`, , `lowmediumhigh`	Да

AzurePiiSubCategoryResult

Сведения о результатах для отдельных категорий PIIHarmSubCategory.

Name	Type	Description	Обязательный
Обнаружено	boolean	Обнаружена ли в содержимом подкатегория помеченного содержимого.	Да
Отфильтрованный	boolean	Является ли обнаружение контента результатом действия фильтрации содержимого для этой подкатегории.	Да
отредактировано	boolean	Редактируется ли содержимое для этой подкатегории.	Да
подкатегория	строка	Была оценена PIIHarmSubCategory.	Да

OpenAI.Annotation

Заметка, которая применяется к диапазону выходного текста.

Дискриминатор для OpenAI.Annotation

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа	Schema
`file_citation`	OpenAI.FileCitationBody
`url_citation`	OpenAI.UrlCitationBody
`container_file_citation`	OpenAI.ContainerFileCitationBody
`file_path`	OpenAI.FilePath

Name	Type	Description	Обязательный	По умолчанию
type	OpenAI.AnnotationType		Да

OpenAI.AnnotationType

Property	Ценность
Type	строка
Значения	`file_citation` `url_citation` `container_file_citation` `file_path`

OpenAI.ApplyPatchCallOutputStatus

Property	Ценность
Type	строка
Значения	`completed` `failed`

OpenAI.ApplyPatchCallStatus

Property	Ценность
Type	строка
Значения	`in_progress` `completed`

OpenAI.ApplyPatchCreateFileOperation

Применить патч — создать файл

Инструкция, описывающая создание файла с помощью средства apply_patch.

Name	Type	Description	Обязательный	По умолчанию
Diff	строка	Дифф для применения.	Да
path	строка	Путь к создаваемому файлу.	Да
type	enum	Создайте файл с предоставленным диффом. Возможные значения: `create_file`	Да	create_file

OpenAI.ApplyPatchDeleteFileOperation

Применить операцию удаления файла патча

Инструкция, описывающая удаление файла с помощью средства apply_patch.

Name	Type	Description	Обязательный	По умолчанию
path	строка	Путь к удаленному файлу.	Да
type	enum	Удалите указанный файл. Возможные значения: `delete_file`	Да	delete_file

OpenAI.ApplyPatchFileOperation

Применить патч-операцию

Одна из операций create_file, delete_file или update_file, применяемых через apply_patch.

Дискриминация для OpenAI.ApplyPatchFileOperation

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа	Schema
`create_file`	OpenAI.ApplyPatchCreateFileOperation
`delete_file`	OpenAI.ApplyPatchDeleteFileOperation
`update_file`	OpenAI.ApplyPatchUpdateFileOperation

Name	Type	Description	Обязательный	По умолчанию
type	OpenAI.ApplyPatchFileOperationType		Да

OpenAI.ApplyPatchFileOperationType

Property	Ценность
Type	строка
Значения	`create_file` `delete_file` `update_file`

OpenAI.ApplyPatchToolParam

Инструмент применения патча

Позволяет помощнику создавать, удалять или обновлять файлы с помощью унифицированных диффов.

Name	Type	Description	Обязательный	По умолчанию
type	enum	Тип средства. Всегда `apply_patch`. Возможные значения: `apply_patch`	Да	apply_patch

OpenAI.ApplyPatchUpdateFileOperation

Применить операцию обновления файла патча

Инструкция, описывающая обновление файла с помощью средства apply_patch.

Name	Type	Description	Обязательный	По умолчанию
Diff	строка	Дифф для применения.	Да
path	строка	Путь к файлу для обновления.	Да
type	enum	Обновите существующий файл с предоставленным диффом. Возможные значения: `update_file`	Да	update_file

OpenAI.ПримерноеМестоположение

Name	Type	Description	Обязательный	По умолчанию
Города	строка или null		Нет
страна	строка или null		Нет
region	строка или null		Нет
timezone	строка или null		Нет
type	enum	Тип приближения расположения. Всегда `approximate`. Возможные значения: `approximate`	Да	Приблизительное

OpenAI.ClickButtonType

Property	Ценность
Type	строка
Значения	`left` `right` `wheel` `back` `forward`

OpenAI.ClickParam

Click

Действие щелчка.

Name	Type	Description	Обязательный	По умолчанию
button	OpenAI.ClickButtonType		Да
type	enum	Указывает тип события. Для действия щелчка это свойство всегда `click`. Возможные значения: `click`	Да	click
x	целое число	Координата x, в которой произошло нажатие.	Да
и	целое число	Координата y, в которой произошло нажатие.	Да

OpenAI.CodeInterpreterContainerAuto

CodeInterpreterToolAuto

Настройка контейнера интерпретатора кода. При необходимости укажите идентификаторы файлов для запуска кода.

Name	Type	Description	Обязательный	По умолчанию
идентификаторы_файлов	массив строк	Необязательный список загруженных файлов для использования в вашем коде. Ограничения: максимумТовары: 50	Нет
предел памяти	OpenAI.ContainerMemoryLimit или null		Нет
type	enum	Всегда `auto`. Возможные значения: `auto`	Да	авто

OpenAI.CodeInterpreterOutputImage

Выходное изображение интерпретатора кода

Изображение, полученное с интерпретатора кода.

Name	Type	Description	Обязательный	По умолчанию
type	enum	Тип выходных данных. Всегда `image`. Возможные значения: `image`	Да	image
url	string (URI)	URL-адрес выходного изображения из интерпретатора кода.	Да

OpenAI.CodeInterpreterOutputLogs

Логи вывода интерпретатора кода

Выходные журналы интерпретатора кода.

Name	Type	Description	Обязательный	По умолчанию
logs	строка	Выходные журналы интерпретатора кода.	Да
type	enum	Тип выходных данных. Всегда `logs`. Возможные значения: `logs`	Да	logs

OpenAI.CodeInterpreterTool

Интерпретатор кода

Средство, которое запускает код Python для создания ответа на запрос.

Name	Type	Description	Обязательный	По умолчанию
container	string или OpenAI.CodeInterpreterContainerAuto	Контейнер интерпретатора кода. Может быть идентификатором контейнера или объектом, который указывает идентификаторы отправленных файлов, чтобы предоставить доступ к коду, а также необязательный `memory_limit` параметр.	Да
type	enum	Тип средства интерпретатора кода. Всегда `code_interpreter`. Возможные значения: `code_interpreter`	Да

OpenAI.ComparisonFilter (фильтр сравнения)

Фильтр сравнения

Фильтр, используемый для сравнения указанного ключа атрибута с заданным значением с помощью определенной операции сравнения.

Name	Type	Description	Обязательный	По умолчанию
key	строка	Ключ для сопоставления со значением.	Да
type	enum	Указывает оператор сравнения: `eq`, `negt`, `gte`, `lt`, , `lte`, `in`. `nin` - `eq`: Равно - `ne`: не равно - `gt`: больше чем - `gte`: больше или равно - `lt`:Менее - `lte`: меньше или равно - `in`:В - `nin`: не в Возможные значения: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`	Да	eq
value	строка или число или логическое значение или массив OpenAI.ComparisonFilterValueItems	Значение для сравнения с ключом атрибута; поддерживает типы строк, чисел или логических типов.	Да

OpenAI.ComparisonFilterValueItems

Эта схема принимает один из следующих типов:

string
число

OpenAI.CompoundFilter

Составный фильтр

Объединение нескольких фильтров с помощью and или or.

Name	Type	Description	Обязательный	По умолчанию
Фильтры	массив OpenAI.ComparisonFilter или object	Массив фильтров для объединения. Элементы могут быть `ComparisonFilter` или `CompoundFilter`.	Да
type	enum	Тип операции: `and` или `or`. Возможные значения: `and`, `or`	Да

OpenAI.ComputerAction

Дискриминатор для OpenAI.ComputerAction

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа	Schema
`click`	OpenAI.ClickParam
`double_click`	OpenAI.DoubleClickAction
`drag`	OpenAI.Drag
`keypress`	OpenAI.KeyPressAction
`move`	OpenAI.Move
`screenshot`	OpenAI.Screenshot
`scroll`	OpenAI.Scroll
`type`	OpenAI.Type
`wait`	OpenAI.Wait

Name	Type	Description	Обязательный	По умолчанию
type	OpenAI.ComputerActionType		Да

OpenAI.ComputerActionType

Property	Ценность
Type	строка
Значения	`click` `double_click` `drag` `keypress` `move` `screenshot` `scroll` `type` `wait`

OpenAI.ComputerCallSafetyCheckParam

Ожидается проверка безопасности для компьютерного вызова.

Name	Type	Description	Обязательный
code	строка или null		Нет
id	строка	Идентификатор ожидающей проверки безопасности.	Да
message	строка или null		Нет

OpenAI.ComputerEnvironment

Property	Ценность
Type	строка
Значения	`windows` `mac` `linux` `ubuntu` `browser`

OpenAI.ComputerScreenshotImage

Снимок экрана компьютера, используемый с помощью инструмента для использования компьютера.

Name	Type	Description	Обязательный	По умолчанию
идентификатор_файла	строка	Идентификатор отправленного файла, содержащего снимок экрана.	Нет
ссылка_на_изображение	string (URI)	URL-адрес изображения снимка экрана.	Нет
type	enum	Указывает тип события. Снимок экрана компьютера: это свойство всегда задано значение `computer_screenshot`. Возможные значения: `computer_screenshot`	Да	computer_screenshot

OpenAI.ИнструментПредварительногоПросмотраИспользованияКомпьютера

Предварительный просмотр использования компьютера

Средство управления виртуальным компьютером.

Name	Type	Description	Обязательный	По умолчанию
высота дисплея	целое число	Высота дисплея компьютера.	Да
ширина дисплея	целое число	Ширина дисплея компьютера.	Да
environment	OpenAI.ComputerEnvironment		Да
type	enum	Тип средства использования компьютера. Всегда `computer_use_preview`. Возможные значения: `computer_use_preview`	Да	computer_use_preview

OpenAI.ContainerFileCitationBody

Ссылка на контейнерный файл

Ссылка на файл контейнера, используемый для создания ответа модели.

Name	Type	Description	Обязательный	По умолчанию
container_id	строка	Идентификатор файла контейнера.	Да
end_index	целое число	Индекс последнего символа ссылки на файл контейнера в сообщении.	Да
идентификатор_файла	строка	Идентификатор файла.	Да
filename	строка	Имя файла контейнера.	Да
start_index	целое число	Индекс первого символа ссылки на файл контейнера в сообщении.	Да
type	enum	Тип ссылки на файл контейнера. Всегда `container_file_citation`. Возможные значения: `container_file_citation`	Да	container_file_citation

OpenAI.ContainerMemoryLimit

Property	Ценность
Type	строка
Значения	`1g` `4g` `16g` `64g`

OpenAI.ConversationParam

Беседа, к которой относится этот ответ. Элементы из этой беседы предопределяются input_items для этого запроса ответа. Входные элементы и выходные элементы из этого ответа автоматически добавляются в эту беседу после завершения этого ответа.

Тип: string или OpenAI.ConversationParam-2

OpenAI.ConversationParam-2

Объект разговора

Беседа, к которой относится этот ответ.

Name	Type	Description	Обязательный	По умолчанию
id	строка	Уникальный идентификатор беседы.	Да

OpenAI.ConversationReference

Разговор

Беседа, к которой относится этот ответ. Входные элементы и выходные элементы из этого ответа были автоматически добавлены в эту беседу.

Name	Type	Description	Обязательный	По умолчанию
id	строка	Уникальный идентификатор беседы, с которым связан этот ответ.	Да

OpenAI.CreateResponse

Name	Type	Description	Обязательный
фон	логический или null		Нет
разговор	OpenAI.ConversationParam или null		Нет
Включают	массив OpenAI.IncludeEnum или null		Нет
input	OpenAI.InputParam	Входные данные, такие как текст, изображения или файлы, в модель, используемые для генерации ответа. Подробнее: - Текстовые входные и выходные данные - Входные данные изображения - Входные данные файлов - Состояние беседы - Вызов функции	Нет
instructions	строка или null		Нет
max_output_tokens	целое число или null		Нет
max_tool_calls	целое число или null		Нет
metadata	OpenAI.Metadata или NULL		Нет
модель	строка	Идентификатор модели, используемый для создания ответа, например `gpt-4o` или `o3`. OpenAI предлагает широкий спектр моделей с разными возможностями, производительностью характеристики и цены. См. руководство по модели для просмотра и сравнения доступных моделей.	Нет
вызовы инструмента в параллельном режиме	логический или null		Нет
previous_response_id	строка или null		Нет
prompt	OpenAI.Prompt	Ссылка на шаблон запроса и его переменные. Подробнее.	Нет
prompt_cache_key	строка	Используется OpenAI для кэширования ответов для аналогичных запросов для оптимизации частоты попаданий кэша. Заменяет `user` поле. Подробнее.	Нет
prompt_cache_retention	строка или null		Нет
reasoning	OpenAI.Reasoning или NULL		Нет
safety_identifier	строка	Стабильный идентификатор, используемый для обнаружения пользователей приложения, которые могут нарушать политики использования OpenAI. Идентификаторы должны быть строкой, которая однозначно идентифицирует каждого пользователя. Мы рекомендуем хэшировать имя пользователя или адрес электронной почты, чтобы избежать отправки нам каких-либо сведений об идентификации. Подробнее.	Нет
store	логический или null		Нет
stream	логический или null		Нет
stream_options	OpenAI.ResponseStreamOptions или null		Нет
Температура	число или null		Нет
text	OpenAI.ResponseTextParam	Параметры конфигурации для текстового ответа модели. Может быть простым текстовые или структурированные данные JSON. Подробнее: - Текстовые входные и выходные данные - Структурированные выходные данные	Нет
выбор инструмента	OpenAI.ToolChoiceParam	Как модель должна выбрать инструмент (или средства), которые следует использовать при создании ответ. См. `tools` параметр, чтобы узнать, как указать инструменты Модель может звонить.	Нет
tools	OpenAI.ToolsArray	Массив инструментов, которые модель может вызывать при создании ответа. Вы может указать, какое средство следует использовать, задав `tool_choice` параметр. Ниже приведены две категории инструментов, которые можно предоставить модели: - Встроенные инструменты: инструменты, предоставляемые OpenAI для расширения Возможности модели, такие как поиск файлов. - Вызовы функций (пользовательские средства): функции, определенные вами, позволяет модели вызывать собственный код.	Нет
top_logprobs	целое число или null		Нет
top_p	число или null		Нет
truncation	строка или null		Нет
user	string (не рекомендуется)	Это поле заменяется `safety_identifier` и `prompt_cache_key`. Вместо этого используйте `prompt_cache_key` для поддержания оптимизации кэширования. Стабильный идентификатор для конечных пользователей. Используется для повышения скорости попадания кэша в более эффективное сегментирование аналогичных запросов и помогает OpenAI обнаруживать и предотвращать злоупотребление. Подробнее.	Нет

OpenAI.CustomGrammarFormatParam

Грамматический формат

Грамматика, определяемая пользователем.

Name	Type	Description	Обязательный	По умолчанию
Определение	строка	Определение грамматики.	Да
Синтаксис	OpenAI.GrammarSyntax1		Да
type	enum	Формат грамматики. Всегда `grammar`. Возможные значения: `grammar`	Да	Грамматики

OpenAI.CustomTextFormatParam

Текстовый формат

Без ограничений текст свободной формы.

Name	Type	Description	Обязательный	По умолчанию
type	enum	Неограниченный текстовый формат. Всегда `text`. Возможные значения: `text`	Да	text

OpenAI.CustomToolParam

Пользовательский инструмент

Пользовательское средство, обрабатывающее входные данные с помощью указанного формата. Дополнительные сведения о пользовательских средствах

Name	Type	Description	Обязательный	По умолчанию
описание	строка	Необязательное описание пользовательского инструмента, используемого для предоставления дополнительного контекста.	Нет
format	OpenAI.CustomToolParamFormat	Формат входных данных для пользовательского средства. Значение по умолчанию не ограничено текстом.	Нет
└─ Тип	OpenAI.CustomToolParamFormatType		Да
имя	строка	Имя настраиваемого средства, используемого для идентификации его в вызовах инструментов.	Да
type	enum	Тип пользовательского средства. Всегда `custom`. Возможные значения: `custom`	Да	Пользовательские

OpenAI.CustomToolParamFormat

Формат входных данных для пользовательского средства. Значение по умолчанию не ограничено текстом.

Дискриминация для OpenAI.CustomToolParamFormat

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа	Schema
`text`	OpenAI.CustomTextFormatParam
`grammar`	OpenAI.CustomGrammarFormatParam

Name	Type	Description	Обязательный	По умолчанию
type	OpenAI.CustomToolParamFormatType		Да

OpenAI.CustomToolParamFormatType

Property	Ценность
Type	строка
Значения	`text` `grammar`

OpenAI.DoubleClickAction

DoubleClick

Действие двойного щелчка.

Name	Type	Description	Обязательный	По умолчанию
type	enum	Указывает тип события. Для действия двойного щелчка это свойство всегда имеет значение `double_click`. Возможные значения: `double_click`	Да	double_click
x	целое число	Координата x, в которой произошло двойное щелчко.	Да
и	целое число	Координата y, в которой произошло двойное щелчко.	Да

OpenAI.Drag

Drag

Действие перетаскивания.

Name	Type	Description	Обязательный	По умолчанию
path	массив OpenAI.DragPoint	Массив координат, представляющий путь действия перетаскивания. Координаты будут отображаться как массив объектов, например `<br> [<br> { x: 100, y: 200 },<br> { x: 200, y: 300 }<br> ]<br>`	Да
type	enum	Указывает тип события. Для действия перетаскивания это свойство имеет значение всегда задано значение `drag`. Возможные значения: `drag`	Да	драг

OpenAI.DragPoint

Coordinate

Пара координат x/y, например { x: 100, y: 200 }.

Name	Type	Description	Обязательный	По умолчанию
x	целое число	Координата x.	Да
и	целое число	Координата y.	Да

OpenAI.EasyInputMessage

Вводное сообщение

Входное сообщение модели с ролью, указывающей на следование иерархии инструкций. Инструкции с ролью developer или system имеют приоритет над инструкциями с ролью user. Предполагается, что сообщения с assistant ролью были созданы моделью в предыдущих взаимодействиях.

Name	Type	Description	Обязательный
содержимое	string или OpenAI.InputMessageContentList	Текст, изображение или звуковой вход в модель, используемый для создания ответа. Также может содержать предыдущие ответы помощника.	Да
role	enum	Роль входных данных сообщения. Одно из `user`, `assistant`или `system` `developer`. Возможные значения: `user`, , `assistantsystemdeveloper`	Да
type	enum	Тип входных данных сообщения. Всегда `message`. Возможные значения: `message`	Да

OpenAI.FileCitationBody

Ссылка на файл

Ссылка на файл.

Name	Type	Description	Обязательный	По умолчанию
идентификатор_файла	строка	Идентификатор файла.	Да
filename	строка	Имя цитируемого файла.	Да
index	целое число	Индекс файла в списке файлов.	Да
type	enum	Тип ссылки на файл. Всегда `file_citation`. Возможные значения: `file_citation`	Да	file_citation

OpenAI.FilePath

Путь к файлу

Путь к файлу.

Name	Type	Description	Обязательный
идентификатор_файла	строка	Идентификатор файла.	Да
index	целое число	Индекс файла в списке файлов.	Да
type	enum	Тип пути к файлу. Всегда `file_path`. Возможные значения: `file_path`	Да

OpenAI.FileSearchTool

Поиск по файлам

Средство, которое ищет соответствующее содержимое из отправленных файлов.

Name	Type	Description	Обязательный	По умолчанию
Фильтры	OpenAI.Filters или NULL		Нет
максимальное_количество_результатов	целое число	Максимальное количество отображаемых результатов. Это число должно быть от 1 до 50 включительно.	Нет
опции рейтинга	OpenAI.RankingOptions		Нет
└️ hybrid_search	OpenAI.HybridSearchOptions	Весы, которые управляют тем, как взаимное слияние рангов балансирует семантику внедрения совпадений и разреженных ключевых слов при включенном гибридном поиске.	Нет
Рангер └️	OpenAI.RankerVersionType	Рангер, используемый для поиска файлов.	Нет
└─ порог оценки	number	Пороговое значение оценки для поиска файлов — от 0 до 1. Числа ближе к 1 будут пытаться вернуть только наиболее релевантные результаты, но могут возвращать меньше результатов.	Нет
type	enum	Тип средства поиска файлов. Всегда `file_search`. Возможные значения: `file_search`	Да	file_search
vector_store_ids	массив строк	Идентификаторы векторных хранилищ для поиска.	Да

OpenAI.FileSearchToolCallResults

Name	Type	Обязательный
attributes	OpenAI.VectorStoreFileAttributes или null	Нет
идентификатор_файла	строка	Нет
filename	строка	Нет
Оценка	Число (float)	Нет
text	строка	Нет

OpenAI.Фильтры

Тип: OpenAI.ComparisonFilter или OpenAI.CompoundFilter

OpenAI.FunctionAndCustomToolCallOutput

Дискриминация для OpenAI.FunctionAndCustomToolCallOutput

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа	Schema
`input_text`	OpenAI.FunctionAndCustomToolCallOutputInputTextContent
`input_image`	OpenAI.FunctionAndCustomToolCallOutputInputImageContent
`input_file`	OpenAI.FunctionAndCustomToolCallOutputInputFileContent

Name	Type	Description	Обязательный	По умолчанию
type	OpenAI.FunctionAndCustomToolCallOutputType		Да

OpenAI.FunctionAndCustomToolCallOutputInputFileContent

Входной файл

Файл в качестве входных данных для модели.

Name	Type	Description	Обязательный	По умолчанию
file_data	строка	Содержимое файла, отправляемого в модель.	Нет
идентификатор_файла	строка или null		Нет
file_url	string (URI)	URL-адрес файла, отправляемого в модель.	Нет
filename	строка	Имя файла, отправляемого в модель.	Нет
type	enum	Тип входного элемента. Всегда `input_file`. Возможные значения: `input_file`	Да	input_file

OpenAI.FunctionAndCustomToolCallOutputInputImageContent

Входное изображение

Изображение в качестве входных данных для модели. Узнайте о входных данных изображения.

Name	Type	Description	Обязательный	По умолчанию
detail	OpenAI.ImageDetail		Да
идентификатор_файла	строка или null		Нет
ссылка_на_изображение	строка или null		Нет
type	enum	Тип входного элемента. Всегда `input_image`. Возможные значения: `input_image`	Да	input_image

OpenAI.FunctionAndCustomToolCallOutputInputTextContent

Входной текст

Текстовые входные данные модели.

Name	Type	Description	Обязательный	По умолчанию
text	строка	Текстовые входные данные модели.	Да
type	enum	Тип входного элемента. Всегда `input_text`. Возможные значения: `input_text`	Да	input_text

OpenAI.FunctionAndCustomToolCallOutputType

Property	Ценность
Type	строка
Значения	`input_text` `input_image` `input_file`

OpenAI.FunctionShellAction

Исполнительное действие shell

Выполните команду оболочки.

Name	Type	Обязательный
commands	массив строк	Да
max_output_length	целое число или null	Да
таймаут_мс	целое число или null	Да

OpenAI.FunctionShellCallOutputContent

Содержимое вывода вызова оболочки

Содержимое выходных данных вызова средства оболочки, которое было создано.

Name	Type	Description	Обязательный
создано пользователем	строка	Идентификатор субъекта, создавшего элемент.	Нет
результат	OpenAI.FunctionShellCallOutputOutcome	Представляет результат выхода (с кодом выхода) или результат ожидания для блока вывода вызова оболочки.	Да
└─ Тип	OpenAI.FunctionShellCallOutputOutcomeType		Да
Stderr	строка	Стандартные выходные данные ошибок, которые были записаны.	Да
stdout	строка	Стандартные выходные данные, которые были записаны.	Да

OpenAI.FunctionShellCallOutputExitOutcome

Исходный результат shell-колла

Указывает, что команды оболочки завершены и возвращен код выхода.

Name	Type	Description	Обязательный	По умолчанию
exit_code	целое число	Выход из процесса оболочки.	Да
type	enum	Тип результата. Всегда `exit`. Возможные значения: `exit`	Да	exit

OpenAI.FunctionShellCallOutputOutcome

Результат вызова в оболочке

Представляет результат выхода (с кодом выхода) или результат ожидания для блока вывода вызова оболочки.

Дискриминация для OpenAI.FunctionShellCallOutputOutcome

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа	Schema
`timeout`	OpenAI.FunctionShellCallOutputTimeoutOutcome
`exit`	OpenAI.FunctionShellCallOutputExitOutcome

Name	Type	Description	Обязательный	По умолчанию
type	OpenAI.FunctionShellCallOutputOutcomeType		Да

OpenAI.FunctionShellCallOutputOutcomeType

Property	Ценность
Type	строка
Значения	`timeout` `exit`

OpenAI.FunctionShellCallOutputTimeoutOutcome

Результат тайм-аута Shell

Указывает, что вызов оболочки превысил настроенное ограничение времени.

Name	Type	Description	Обязательный	По умолчанию
type	enum	Тип результата. Всегда `timeout`. Возможные значения: `timeout`	Да	timeout

OpenAI.FunctionShellToolParam

Инструмент-оболочка

Средство, позволяющее модели выполнять команды оболочки.

Name	Type	Description	Обязательный	По умолчанию
type	enum	Тип средства оболочки. Всегда `shell`. Возможные значения: `shell`	Да	оболочка

OpenAI.FunctionTool

Функция

Определяет функцию в собственном коде, которую модель может вызвать.

Name	Type	Description	Обязательный	По умолчанию
описание	строка или null		Нет
имя	строка	Имя вызываемой функции.	Да
parameters	объект или null		Да
строгий	логический или null		Да
type	enum	Тип средства функции. Всегда `function`. Возможные значения: `function`	Да	function

OpenAI.GrammarSyntax1

Property	Ценность
Type	строка
Значения	`lark` `regex`

OpenAI.HybridSearchOptions

Name	Type	Description	Обязательный	По умолчанию
embedding_weight	number	Вес внедрения в взаимное ранжирование слияние.	Да
text_weight	number	Вес текста в взаимном ранжировании слиянием.	Да

OpenAI.ImageDetail

Property	Ценность
Type	строка
Значения	`low` `high` `auto`

OpenAI.ImageGenTool

Инструмент генерации изображений

Средство, которое создает изображения с помощью моделей изображений GPT.

Допустимые модели:

gpt-image-1
gpt-image-1-mini

Name	Type	Description	Обязательный	По умолчанию
фон	enum	Тип фона для созданного изображения. Один из `transparent`, `opaque` или `auto`. По умолчанию: `auto`. Возможные значения: `transparent`, `opaqueauto`	Нет	авто
Входная точность	OpenAI.InputFidelity или null		Нет
входная маска изображения	OpenAI.ImageGenToolInputImageMask		Нет
└ file_id	строка		Нет
└image_url	строка		Нет
модель	строка (см. допустимые модели ниже)		Нет
Умеренности	enum	Уровень модерации для созданного образа. По умолчанию: `auto`. Возможные значения: `auto`, `low`	Нет	авто
сжатие вывода	целое число	Уровень сжатия для выходного изображения. Значение по умолчанию: 100. Ограничения: min: 0, max: 100	Нет	100
формат_выходных_данных	enum	Формат выходных данных созданного изображения. Один из `png`, `webp`или `jpeg`. По умолчанию: `png`. Возможные значения: `png`, `webpjpeg`	Нет	png
частичные_изображения	целое число	Количество частичных образов для создания в режиме потоковой передачи от 0 (значение по умолчанию) до 3. Ограничения: min: 0, max: 3	Нет
качество	enum	Качество созданного изображения. Один из `low`, `mediumhigh` или `auto`. По умолчанию: `auto`. Возможные значения: `low`, , `mediumhighauto`	Нет	авто
size	enum	Размер созданного изображения. Один из `1024x1024`, `1024x1536` `1536x1024` или `auto`. По умолчанию: `auto`. Возможные значения: `1024x1024`, , `1024x15361536x1024auto`	Нет	авто
type	enum	Тип средства создания изображений. Всегда `image_generation`. Возможные значения: `image_generation`	Да	image_generation

OpenAI.ImageGenToolInputImageMask

Name	Type	Description	Обязательный	По умолчанию
идентификатор_файла	строка		Нет
ссылка_на_изображение	строка		Нет

OpenAI.IncludeEnum

Укажите дополнительные выходные данные для включения в ответ модели. В настоящее время поддерживаются следующие значения:

web_search_call.action.sources: включите источники вызова средства поиска в Интернете.
code_interpreter_call.outputs: включает выходные данные выполнения кода Python в элементах вызова средства интерпретации кода.
computer_call_output.output.image_url: добавьте URL-адреса изображения из результата выполнения команды на компьютере.
file_search_call.results: включите результаты поиска запроса средства поиска файлов.
message.input_image.image_url: включите URL-адреса изображения из входного сообщения.
message.output_text.logprobs: включите журналы с сообщениями помощника.
reasoning.encrypted_content: включает зашифрованную версию токенов рассуждения в выходных данных элемента. Это позволяет использовать элементы рассуждений в многоэтапных беседах при статическом использовании API ответов (например, если store параметр задан false, или когда организация зарегистрирована в программе нулевого хранения данных).

Property	Ценность
Description	Укажите дополнительные выходные данные для включения в ответ модели. В настоящее время поддерживаются следующие значения: - `web_search_call.action.sources`: Укажите источники вызова инструмента поиска в интернете. - `code_interpreter_call.outputs`: включает выходные данные выполнения кода Python в элементах вызова средства интерпретатора. - `computer_call_output.output.image_url`: добавьте URL-адреса изображений из выходных данных компьютерного вызова. - `file_search_call.results`: включите результаты поиска вызова средства поиска файлов. - `message.input_image.image_url`: включите URL-адреса изображения из входного сообщения. - `message.output_text.logprobs`: включите журналы с сообщениями помощника. - `reasoning.encrypted_content`: включает зашифрованную версию токенов в элементах рассуждения на выходе. Это позволяет использовать элементы рассуждений в многоэтапных беседах при статическом использовании API ответов (например, если `store` параметр задан `false`, или когда организация зарегистрирована в программе нулевого хранения данных).
Type	строка
Значения	`file_search_call.results` `web_search_call.results` `web_search_call.action.sources` `message.input_image.image_url` `computer_call_output.output.image_url` `code_interpreter_call.outputs` `reasoning.encrypted_content` `message.output_text.logprobs`

OpenAI.InputContent

Дискриминация для OpenAI.InputContent

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа	Schema
`input_text`	OpenAI.InputContentInputTextContent
`input_image`	OpenAI.InputContentInputImageContent
`input_file`	OpenAI.InputContentInputFileContent

Name	Type	Description	Обязательный	По умолчанию
type	OpenAI.InputContentType		Да

OpenAI.InputContentInputFileContent

Входной файл

Файл в качестве входных данных для модели.

Name	Type	Description	Обязательный	По умолчанию
file_data	строка	Содержимое файла, отправляемого в модель.	Нет
идентификатор_файла	строка или null		Нет
file_url	string (URI)	URL-адрес файла, отправляемого в модель.	Нет
filename	строка	Имя файла, отправляемого в модель.	Нет
type	enum	Тип входного элемента. Всегда `input_file`. Возможные значения: `input_file`	Да	input_file

OpenAI.InputContentInputImageContent

Входное изображение

Изображение в качестве входных данных для модели. Узнайте о входных данных изображения.

Name	Type	Description	Обязательный	По умолчанию
detail	OpenAI.ImageDetail		Да
идентификатор_файла	строка или null		Нет
ссылка_на_изображение	строка или null		Нет
type	enum	Тип входного элемента. Всегда `input_image`. Возможные значения: `input_image`	Да	input_image

OpenAI.InputContentInputTextContent

Входной текст

Текстовые входные данные модели.

Name	Type	Description	Обязательный	По умолчанию
text	строка	Текстовые входные данные модели.	Да
type	enum	Тип входного элемента. Всегда `input_text`. Возможные значения: `input_text`	Да	input_text

OpenAI.InputContentType

Property	Ценность
Type	строка
Значения	`input_text` `input_image` `input_file`

OpenAI.InputFidelity

Контролируйте усилия модели для соответствия стилю и особенностям, в частности, чертам лица, на входных изображениях. Этот параметр поддерживается только для gpt-image-1. Неподдерживаемый для gpt-image-1-mini. Поддерживает high и low. По умолчанию — low.

Property	Ценность
Type	строка
Значения	`high` `low`

OpenAI.InputFileContent

Входной файл

Файл в качестве входных данных для модели.

Name	Type	Description	Обязательный	По умолчанию
file_data	строка	Содержимое файла, отправляемого в модель.	Нет
идентификатор_файла	строка или null		Нет
file_url	string (URI)	URL-адрес файла, отправляемого в модель.	Нет
filename	строка	Имя файла, отправляемого в модель.	Нет
type	enum	Тип входного элемента. Всегда `input_file`. Возможные значения: `input_file`	Да	input_file

OpenAI.InputImageContent

Входное изображение

Изображение в качестве входных данных для модели. Узнайте о входных данных изображения.

Name	Type	Description	Обязательный	По умолчанию
detail	OpenAI.ImageDetail		Да
идентификатор_файла	строка или null		Нет
ссылка_на_изображение	строка или null		Нет
type	enum	Тип входного элемента. Всегда `input_image`. Возможные значения: `input_image`	Да	input_image

OpenAI.InputItem

Дискриминация для OpenAI.InputItem

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа	Schema
`message`	OpenAI.EasyInputMessage
`item_reference`	OpenAI.ItemReferenceParam

Name	Type	Description	Обязательный	По умолчанию
type	OpenAI.InputItemType		Да

OpenAI.InputItemType

Property	Ценность
Type	строка
Значения	`message` `item_reference`

OpenAI.InputMessageContentList

Список содержимого входных элементов

Список одного или нескольких входных элементов модели, содержащий различные типы контента.

Массив: OpenAI.InputContent

OpenAI.InputMessageResource

Name	Type	Description	Обязательный
содержимое	OpenAI.InputMessageContentList	Список одного или нескольких входных элементов модели, содержащий другое содержимое. types.	Да
id	строка	Уникальный идентификатор входных данных сообщения.	Да
role	enum	Роль входных данных сообщения. Один из `user`, `system`или `developer`. Возможные значения: `user`, `systemdeveloper`	Да
Статус	enum	Состояние элемента. Один из `in_progress`, `completed`или `incomplete`. Заполняется, когда элементы возвращаются через API. Возможные значения: `in_progress`, `completedincomplete`	Нет
type	enum	Тип входных данных сообщения. Всегда задано значение `message`. Возможные значения: `message`	Да

OpenAI.InputParam

Входные данные, такие как текст, изображения или файлы, в модель, используемые для генерации ответа. Подробнее:

Тип: строка или массив OpenAI.InputItem

OpenAI.InputTextContent

Входной текст

Текстовые входные данные модели.

Name	Type	Description	Обязательный	По умолчанию
text	строка	Текстовые входные данные модели.	Да
type	enum	Тип входного элемента. Всегда `input_text`. Возможные значения: `input_text`	Да	input_text

OpenAI.ItemReferenceParam

Справочник по элементам

Внутренний идентификатор для ссылки на элемент.

Name	Type	Description	Обязательный	По умолчанию
id	строка	Идентификатор элемента для ссылки.	Да
type	enum	Тип элемента для ссылки. Всегда `item_reference`. Возможные значения: `item_reference`	Да	item_reference

OpenAI.ItemResource

Элемент содержимого, используемый для создания ответа.

Дискриминатор для OpenAI.ItemResource

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа	Schema
`message`	OpenAI.InputMessageResource
`output_message`	OpenAI.ItemResourceOutputMessage
`file_search_call`	OpenAI.ItemResourceFileSearchToolCall
`computer_call`	OpenAI.ItemResourceComputerToolCall
`computer_call_output`	OpenAI.ItemResourceComputerToolCallOutputResource
`web_search_call`	OpenAI.ItemResourceWebSearchToolCall
`function_call`	OpenAI.ItemResourceFunctionToolCallResource
`function_call_output`	OpenAI.ItemResourceFunctionToolCallOutputResource
`image_generation_call`	OpenAI.ItemResourceImageGenToolCall
`code_interpreter_call`	OpenAI.ItemResourceCodeInterpreterToolCall
`local_shell_call`	OpenAI.ItemResourceLocalShellToolCall
`local_shell_call_output`	OpenAI.ItemResourceLocalShellToolCallOutput
`shell_call`	OpenAI.ItemResourceFunctionShellCall
`shell_call_output`	OpenAI.ItemResourceFunctionShellCallOutput
`apply_patch_call`	OpenAI.ItemResourceApplyPatchToolCall
`apply_patch_call_output`	OpenAI.ItemResourceApplyPatchToolCallOutput
`mcp_list_tools`	OpenAI.ItemResourceMcpListTools
`mcp_approval_request`	OpenAI.ItemResourceMcpApprovalRequest
`mcp_approval_response`	OpenAI.ItemResourceMcpApprovalResponseResource
`mcp_call`	OpenAI.ItemResourceMcpToolCall

Name	Type	Description	Обязательный	По умолчанию
type	OpenAI.ItemResourceType		Да

OpenAI.ItemResourceApplyPatchToolCall

Применить вызов инструмента patch

Вызов средства, который применяет диффы файлов, создавая, удаляя или обновляя файлы.

Name	Type	Description	Обязательный	По умолчанию
call_id	строка	Уникальный идентификатор вызова средства исправления, созданного моделью.	Да
создано пользователем	строка	Идентификатор сущности, созданной этим средством.	Нет
id	строка	Уникальный идентификатор вызова средства исправления. Заполняется, когда этот элемент возвращается через API.	Да
Операция	OpenAI.ApplyPatchFileOperation	Одна из операций create_file, delete_file или update_file, применяемых через apply_patch.	Да
└─ Тип	OpenAI.ApplyPatchFileOperationType		Да
Статус	OpenAI.ApplyPatchCallStatus		Да
type	enum	Тип элемента. Всегда `apply_patch_call`. Возможные значения: `apply_patch_call`	Да	apply_patch_call

OpenAI.ItemResourceApplyPatchToolCallOutput

Применить вывод вызова патч-инструмента

Выходные данные, создаваемые вызовом средства исправления.

Name	Type	Description	Обязательный	По умолчанию
call_id	строка	Уникальный идентификатор вызова средства исправления, созданного моделью.	Да
создано пользователем	строка	Идентификатор сущности, создающей выходные данные вызова этого средства.	Нет
id	строка	Уникальный идентификатор выходных данных вызова средства исправления. Заполняется, когда этот элемент возвращается через API.	Да
output	строка или null		Нет
Статус	OpenAI.ApplyPatchCallOutputStatus		Да
type	enum	Тип элемента. Всегда `apply_patch_call_output`. Возможные значения: `apply_patch_call_output`	Да	apply_patch_call_output

OpenAI.ItemResourceCodeInterpreterToolCall

Вызов инструмента интерпретатора кода

Вызов инструмента для выполнения кода.

Name	Type	Description	Обязательный	По умолчанию
code	строка или null		Да
container_id	строка	Идентификатор контейнера, используемого для запуска кода.	Да
id	строка	Уникальный идентификатор вызова средства интерпретатора кода.	Да
outputs	массив OpenAI.CodeInterpreterOutputLogs или OpenAI.CodeInterpreterOutputImage или null		Да
Статус	enum	Состояние вызова средства интерпретатора кода. Допустимые значения: `in_progress`, `completed`, `incomplete`, `interpreting`, и `failed`. Возможные значения: `in_progress`, `completed`, `incomplete`, `interpreting`, `failed`	Да
type	enum	Тип вызова средства интерпретатора кода. Всегда `code_interpreter_call`. Возможные значения: `code_interpreter_call`	Да	code_interpreter_call

OpenAI.ItemResourceComputerToolCall

Вызов компьютерного инструмента

Вызов инструмента для работы с компьютером. Дополнительные сведения см. в руководстве по использованию компьютера .

Name	Type	Description	Обязательный	По умолчанию
action	OpenAI.ComputerAction		Да
call_id	строка	Идентификатор, используемый при реагировании на вызов инструмента с выходными данными.	Да
id	строка	Уникальный идентификатор вызова компьютера.	Да
pending_safety_checks	массив OpenAI.ComputerCallSafetyCheckParam	Ожидающие проверки безопасности для компьютеризированного процесса.	Да
Статус	enum	Состояние элемента. Один из `in_progress`, `completed`или `incomplete`. Заполняется, когда элементы возвращаются через API. Возможные значения: `in_progress`, `completedincomplete`	Да
type	enum	Тип компьютерного вызова. Всегда `computer_call`. Возможные значения: `computer_call`	Да	computer_call

OpenAI.ItemResourceComputerToolCallOutputResource

Name	Type	Description	Обязательный	По умолчанию
acknowledged_safety_checks	массив OpenAI.ComputerCallSafetyCheckParam	Проверки безопасности, сообщаемые API, которые были подтверждены разработчик.	Нет
call_id	строка	Идентификатор вызова средства компьютера, создающего выходные данные.	Да
id	строка	Идентификатор данных, полученных в результате вызова компьютерного инструмента.	Нет
output	OpenAI.ComputerScreenshotImage	Снимок экрана компьютера, используемый с помощью инструмента для использования компьютера.	Да
Статус	enum	Состояние входных данных сообщения. Один из `in_progress`, `completed`или `incomplete`. Заполняется при возврате входных элементов через API. Возможные значения: `in_progress`, `completedincomplete`	Нет
type	enum	Тип выходных данных компьютерного средства вызова. Всегда `computer_call_output`. Возможные значения: `computer_call_output`	Да	computer_call_output

OpenAI.ItemResourceFileSearchToolCall

Вызов инструмента поиска файлов

Результаты вызова средства поиска файлов. Дополнительные сведения см. в руководстве по поиску файлов .

Name	Type	Description	Обязательный
id	строка	Уникальный идентификатор вызова средства поиска файлов.	Да
queries	массив строк	Запросы, используемые для поиска файлов.	Да
results	массив OpenAI.FileSearchToolCallResults или null		Нет
Статус	enum	Состояние вызова средства поиска файлов. Один из `in_progress`, `searching`, `incomplete` или `failed`, Возможные значения: `in_progress`, `searching`, `completed`, `incomplete`, `failed`	Да
type	enum	Тип вызова средства поиска файлов. Всегда `file_search_call`. Возможные значения: `file_search_call`	Да

OpenAI.ItemResourceFunctionShellCall

Вызов инструмента shell

Вызов средства, выполняющий одну или несколько команд оболочки в управляемой среде.

Name	Type	Description	Обязательный	По умолчанию
action	OpenAI.FunctionShellAction	Выполните команду оболочки.	Да
Команды └️	массив строк		Да
└max_output_length	целое число или null		Да
└️ timeout_ms	целое число или null		Да
call_id	строка	Уникальный идентификатор вызова средства оболочки, созданного моделью.	Да
создано пользователем	строка	Идентификатор сущности, созданной этим средством.	Нет
id	строка	Уникальный идентификатор вызова средства оболочки. Заполняется, когда этот элемент возвращается через API.	Да
Статус	OpenAI.LocalShellCallStatus		Да
type	enum	Тип элемента. Всегда `shell_call`. Возможные значения: `shell_call`	Да	shell_call

OpenAI.ItemResourceFunctionShellCallOutput

Вывод вызова через оболочку

Выходные данные вызова средства оболочки, который был создан.

Name	Type	Description	Обязательный	По умолчанию
call_id	строка	Уникальный идентификатор вызова средства оболочки, созданного моделью.	Да
создано пользователем	строка	Идентификатор субъекта, создавшего элемент.	Нет
id	строка	Уникальный идентификатор выходных данных вызова оболочки. Заполняется, когда этот элемент возвращается через API.	Да
max_output_length	целое число или null		Да
output	массив OpenAI.FunctionShellCallOutputContent	Массив содержимого вывода вызова оболочки	Да
type	enum	Тип выходных данных вызова оболочки. Всегда `shell_call_output`. Возможные значения: `shell_call_output`	Да	shell_call_output

OpenAI.ItemResourceFunctionToolCallOutputResource

Name	Type	Description	Обязательный
call_id	строка	Уникальный идентификатор вызова функции, созданного моделью.	Да
id	строка	Уникальный идентификатор выходных данных вызова средства функции. Заполнено, когда этот элемент возвращается через API.	Нет
output	строка или массив OpenAI.FunctionAndCustomToolCallOutput	Выходные данные вызова функции, созданного кодом. Может быть строкой или списком выходного содержимого.	Да
Статус	enum	Состояние элемента. Один из `in_progress`, `completed`или `incomplete`. Заполняется, когда элементы возвращаются через API. Возможные значения: `in_progress`, `completedincomplete`	Нет
type	enum	Тип выходных данных вызова функции. Всегда `function_call_output`. Возможные значения: `function_call_output`	Да

OpenAI.ItemResourceFunctionToolCallResource

Name	Type	Description	Обязательный
arguments	строка	Строка JSON аргументов для передачи функции.	Да
call_id	строка	Уникальный идентификатор вызова функции, созданного моделью.	Да
id	строка	Уникальный идентификатор вызова средства функции.	Нет
имя	строка	Имя выполняемой функции.	Да
Статус	enum	Состояние элемента. Один из `in_progress`, `completed`или `incomplete`. Заполняется, когда элементы возвращаются через API. Возможные значения: `in_progress`, `completedincomplete`	Нет
type	enum	Тип вызова инструмента функции. Всегда `function_call`. Возможные значения: `function_call`	Да

OpenAI.ItemResourceImageGenToolCall

Вызов генерации изображений

Запрос на создание изображения, сделанный моделью.

Name	Type	Description	Обязательный
id	строка	Уникальный идентификатор вызова создания образа.	Да
result	строка или null		Да
Статус	enum	Состояние вызова создания образа. Возможные значения: `in_progress`, , `completedgeneratingfailed`	Да
type	enum	Тип вызова создания изображения. Всегда `image_generation_call`. Возможные значения: `image_generation_call`	Да

OpenAI.ItemResourceLocalShellToolCall

Локальный вызов shell

Вызов инструмента для выполнения команды в локальной оболочке.

Name	Type	Description	Обязательный
action	OpenAI.LocalShellExecAction	Выполните команду оболочки на сервере.	Да
call_id	строка	Уникальный идентификатор вызова локального утилита оболочки, сгенерированного моделью.	Да
id	строка	Уникальный идентификатор вызова локальной оболочки.	Да
Статус	enum	Состояние вызова локальной оболочки. Возможные значения: `in_progress`, `completedincomplete`	Да
type	enum	Тип вызова локальной оболочки. Всегда `local_shell_call`. Возможные значения: `local_shell_call`	Да

OpenAI.ItemResourceLocalShellToolCallOutput

Вывод локального вызова shell

Выходные данные вызова локального оболочечного инструмента.

Name	Type	Description	Обязательный
id	строка	Уникальный идентификатор вызова локального утилита оболочки, сгенерированного моделью.	Да
output	строка	Строка JSON, представляющая результаты вызова локального инструмента оболочки.	Да
Статус	строка или null		Нет
type	enum	Тип выходных данных вызова средства локальной оболочки. Всегда `local_shell_call_output`. Возможные значения: `local_shell_call_output`	Да

OpenAI.ItemResourceMcpApprovalRequest

Запрос на одобрение MCP

Запрос на одобрение человеком вызова инструмента.

Name	Type	Description	Обязательный
arguments	строка	Строка JSON с аргументами для средства.	Да
id	строка	Уникальный идентификатор запроса на утверждение.	Да
имя	строка	Имя запускаемого инструмента.	Да
метка сервера	строка	Метка сервера MCP, выполняющего запрос.	Да
type	enum	Тип элемента. Всегда `mcp_approval_request`. Возможные значения: `mcp_approval_request`	Да

OpenAI.ItemResourceMcpApprovalResponseResource

Ответ на одобрение MCP

Ответ на запрос на утверждение MCP.

Name	Type	Description	Обязательный
approval_request_id	строка	Идентификатор запроса на утверждение, на который даётся ответ.	Да
Утвердить	boolean	Будет ли утвержден запрос.	Да
id	строка	Уникальный идентификатор ответа на утверждение	Да
причина	строка или null		Нет
type	enum	Тип элемента. Всегда `mcp_approval_response`. Возможные значения: `mcp_approval_response`	Да

OpenAI.ItemResourceMcpListTools

Инструменты списка MCP

Список средств, доступных на сервере MCP.

Name	Type	Description	Обязательный
error	строка или null		Нет
id	строка	Уникальный идентификатор списка.	Да
метка сервера	строка	Метка сервера MCP.	Да
tools	массив OpenAI.MCPListToolsTools	Средства, доступные на сервере.	Да
type	enum	Тип элемента. Всегда `mcp_list_tools`. Возможные значения: `mcp_list_tools`	Да

OpenAI.ItemResourceMcpToolCall

Вызов инструмента MCP

Вызов инструмента на сервере MCP.

Name	Type	Description	Обязательный
approval_request_id	строка или null		Нет
arguments	строка	Строка JSON аргументов, переданных средству.	Да
error	строка или null		Нет
id	строка	Уникальный идентификатор вызова средства.	Да
имя	строка	Имя запущенного инструмента.	Да
output	строка или null		Нет
метка сервера	строка	Метка сервера MCP, на котором работает инструмент.	Да
Статус	OpenAI.MCPToolCallStatus		Нет
type	enum	Тип элемента. Всегда `mcp_call`. Возможные значения: `mcp_call`	Да

OpenAI.ItemResourceOutputMessage

Выходное сообщение

Выходное сообщение из модели.

Name	Type	Description	Обязательный
содержимое	массив OpenAI.OutputMessageContent	Содержимое выходного сообщения.	Да
id	строка	Уникальный идентификатор выходного сообщения.	Да
role	enum	Роль выходного сообщения. Всегда `assistant`. Возможные значения: `assistant`	Да
Статус	enum	Состояние входных данных сообщения. Один из `in_progress`, `completed`или `incomplete`. Заполняется при возврате входных элементов через API. Возможные значения: `in_progress`, `completedincomplete`	Да
type	enum	Тип выходного сообщения. Всегда `message`. Возможные значения: `output_message`	Да

OpenAI.ItemResourceType

Property	Ценность
Type	строка
Значения	`message` `output_message` `file_search_call` `computer_call` `computer_call_output` `web_search_call` `function_call` `function_call_output` `image_generation_call` `code_interpreter_call` `local_shell_call` `local_shell_call_output` `shell_call` `shell_call_output` `apply_patch_call` `apply_patch_call_output` `mcp_list_tools` `mcp_approval_request` `mcp_approval_response` `mcp_call`

OpenAI.ItemResourceWebSearchToolCall

Вызов инструмента веб-поиска

Результаты вызова средства поиска в Интернете. Дополнительные сведения см. в руководстве по поиску в Интернете .

Name	Type	Description	Обязательный
action	OpenAI.WebSearchActionSearch или OpenAI.WebSearchActionOpenPage или OpenAI.WebSearchActionFind	Объект, описывающий конкретные действия, выполненные в этом вызове поиска в Интернете. Содержит сведения об использовании модели в Интернете (поиск, open_page, поиск).	Да
id	строка	Уникальный идентификатор вызова средства поиска в Интернете.	Да
Статус	enum	Состояние вызова функции средства поиска в Интернете. Возможные значения: `in_progress`, , `searchingcompletedfailed`	Да
type	enum	Тип вызова средства поиска в Интернете. Всегда `web_search_call`. Возможные значения: `web_search_call`	Да

OpenAI.KeyPressAction

KeyPress

Коллекция нажатий клавиш, которые модель хотела бы выполнить.

Name	Type	Description	Обязательный	По умолчанию
keys	массив строк	Сочетание клавиш, которые модель просит нажать. Это массив строк, каждый из которых представляет ключ.	Да
type	enum	Указывает тип события. Для действия keypress это свойство всегда имеет значение `keypress`. Возможные значения: `keypress`	Да	Нажатие клавиши

OpenAI.LocalShellCallStatus

Property	Ценность
Type	строка
Значения	`in_progress` `completed` `incomplete`

OpenAI.LocalShellExecAction

Локальное действие shell exec

Выполните команду оболочки на сервере.

Name	Type	Description	Обязательный	По умолчанию
command	массив строк	Команда для выполнения	Да
окружение	object	Переменные среды, заданные для команды.	Да
таймаут_мс	целое число или null		Нет
type	enum	Тип операции локального интерфейса оболочки. Всегда `exec`. Возможные значения: `exec`	Да	exec
user	строка или null		Нет
рабочий каталог	строка или null		Нет

OpenAI.LocalShellToolParam

Инструмент с локальной оболочкой

Средство, позволяющее модели выполнять команды оболочки в локальной среде.

Name	Type	Description	Обязательный	По умолчанию
type	enum	Тип локального инструмента оболочки. Всегда `local_shell`. Возможные значения: `local_shell`	Да	local_shell

OpenAI.LogProb

Логарифмическая вероятность

Логарифмическая вероятность токена.

Name	Type	Обязательный
байт	массив целых чисел	Да
logprob	number	Да
token	строка	Да
top_logprobs	массив OpenAI.TopLogProb	Да

OpenAI.MCPListToolsTool

Инструмент для списка MCP

Средство, доступное на сервере MCP.

Name	Type	Description	Обязательный
annotations	OpenAI.MCPListToolsToolAnnotations или NULL		Нет
описание	строка или null		Нет
input_schema	OpenAI.MCPListToolsToolInputSchema		Да
имя	строка	Имя средства.	Да

OpenAI.MCPListToolsToolAnnotations

Тип: объект

OpenAI.MCPListToolsToolInputSchema

Тип: объект

OpenAI.MCPTool

Средство MCP

Предоставьте модели доступ к дополнительным инструментам через удаленные серверы протокола контекста модели (MCP). Дополнительные сведения о MCP.

Name	Type	Description	Обязательный
разрешённые_инструменты	массив строк или OpenAI.MCPToolFilter или NULL		Нет
authorization	строка	Маркер доступа OAuth, который можно использовать с удаленным сервером MCP, либо с настраиваемым URL-адресом сервера MCP или соединителем службы. Ваше приложение должен обработать поток авторизации OAuth и указать здесь маркер.	Нет
connector_id	enum	Идентификатор соединителей служб, например тех, которые доступны в ChatGPT. Один из `server_url` или `connector_id` должно быть предоставлено. Дополнительные сведения о службе соединители здесь. В настоящее время поддерживаются `connector_id` следующие значения: -Dropbox: `connector_dropbox` -Gmail: `connector_gmail` — Google Calendar: `connector_googlecalendar` — Google Drive: `connector_googledrive` — Microsoft Teams: `connector_microsoftteams` - Календарь Outlook: `connector_outlookcalendar` — Электронная почта Outlook: `connector_outlookemail` -Sharepoint: `connector_sharepoint` Возможные значения: `connector_dropbox`, `connector_gmail`, `connector_googlecalendar`, `connector_googledrive`, `connector_microsoftteams`, `connector_outlookcalendar`, `connector_outlookemail`, `connector_sharepoint`	Нет
headers	объект или null		Нет
требовать_одобрение	OpenAI.MCPToolRequireApproval или string или null		Нет
server_description	строка	Необязательное описание сервера MCP, используемого для предоставления дополнительного контекста.	Нет
метка сервера	строка	Метка для этого сервера MCP, используемая для идентификации его в вызовах инструментов.	Да
URL сервера	string (URI)	URL-адрес сервера MCP. Одно из `server_url` или `connector_id` должно быть Предоставляются.	Нет
type	enum	Тип средства MCP. Всегда `mcp`. Возможные значения: `mcp`	Да

OpenAI.MCPToolCallStatus

Property	Ценность
Type	строка
Значения	`in_progress` `completed` `incomplete` `calling` `failed`

OpenAI.MCPToolFilter

Фильтр инструментов MCP

Объект фильтра, указывающий, какие средства разрешены.

Name	Type	Description	Обязательный	По умолчанию
read_only	boolean	Указывает, изменяет ли средство данные или доступно только для чтения. Если Сервер MCP аннотирован с помощью < a0/&a0>. он будет соответствовать этому фильтру.	Нет
tool_names	массив строк	Список разрешенных имен инструментов.	Нет

OpenAI.MCPToolRequireApproval

Name	Type	Description	Обязательный	По умолчанию
Всегда	OpenAI.MCPToolFilter	Объект фильтра, указывающий, какие средства разрешены.	Нет
никогда	OpenAI.MCPToolFilter	Объект фильтра, указывающий, какие средства разрешены.	Нет

OpenAI.Metadata

Набор из 16 пар "ключ-значение", которые можно прикрепить к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате и запроса на объекты через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — это строки с максимальной длиной 512 символов.

Тип: объект

OpenAI.Move

Move

Операция перемещения мыши.

Name	Type	Description	Обязательный	По умолчанию
type	enum	Указывает тип события. Для действия перемещения это свойство имеет значение всегда задано значение `move`. Возможные значения: `move`	Да	move
x	целое число	Координата x, к которой происходит движение.	Да
и	целое число	Координата y, куда необходимо переместиться.	Да

OpenAI.OutputContent

Дискриминация для OpenAI.OutputContent

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа	Schema
`output_text`	OpenAI.OutputContentOutputTextContent
`refusal`	OpenAI.OutputContentRefusalContent

Name	Type	Description	Обязательный	По умолчанию
type	OpenAI.OutputContentType		Да

OpenAI.OutputContentOutputTextContent

Выходной текст

Текстовые выходные данные модели.

Name	Type	Description	Обязательный	По умолчанию
annotations	массив OpenAI.Annotation	Заметки к выходным данным текста.	Да
logprobs	массив OpenAI.LogProb		Нет
text	строка	Текстовые выходные данные модели.	Да
type	enum	Тип выходного текста. Всегда `output_text`. Возможные значения: `output_text`	Да	output_text

OpenAI.OutputContentRefusalContent

Refusal

Отказ модели.

Name	Type	Description	Обязательный	По умолчанию
отказ	строка	Объяснение отказа модели.	Да
type	enum	Тип отказа. Всегда `refusal`. Возможные значения: `refusal`	Да	отказ

OpenAI.OutputContentType

Property	Ценность
Type	строка
Значения	`output_text` `refusal` `reasoning_text`

OpenAI.OutputItem

Дискриминация для OpenAI.OutputItem

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа	Schema
`output_message`	OpenAI.OutputItemOutputMessage
`file_search_call`	OpenAI.OutputItemFileSearchToolCall
`function_call`	OpenAI.OutputItemFunctionToolCall
`web_search_call`	OpenAI.OutputItemWebSearchToolCall
`computer_call`	OpenAI.OutputItemComputerToolCall
`reasoning`	OpenAI.OutputItemReasoningItem
`compaction`	OpenAI.OutputItemCompactionBody
`image_generation_call`	OpenAI.OutputItemImageGenToolCall
`code_interpreter_call`	OpenAI.OutputItemCodeInterpreterToolCall
`local_shell_call`	OpenAI.OutputItemLocalShellToolCall
`shell_call`	OpenAI.OutputItemFunctionShellCall
`shell_call_output`	OpenAI.OutputItemFunctionShellCallOutput
`apply_patch_call`	OpenAI.OutputItemApplyPatchToolCall
`apply_patch_call_output`	OpenAI.OutputItemApplyPatchToolCallOutput
`mcp_call`	OpenAI.OutputItemMcpToolCall
`mcp_list_tools`	OpenAI.OutputItemMcpListTools
`mcp_approval_request`	OpenAI.OutputItemMcpApprovalRequest
`custom_tool_call`	OpenAI.OutputItemCustomToolCall

Name	Type	Description	Обязательный	По умолчанию
type	OpenAI.OutputItemType		Да

OpenAI.OutputItemApplyPatchToolCall

Применить вызов инструмента patch

Вызов средства, который применяет диффы файлов, создавая, удаляя или обновляя файлы.

Name	Type	Description	Обязательный	По умолчанию
call_id	строка	Уникальный идентификатор вызова средства исправления, созданного моделью.	Да
создано пользователем	строка	Идентификатор сущности, созданной этим средством.	Нет
id	строка	Уникальный идентификатор вызова средства исправления. Заполняется, когда этот элемент возвращается через API.	Да
Операция	OpenAI.ApplyPatchFileOperation	Одна из операций create_file, delete_file или update_file, применяемых через apply_patch.	Да
└─ Тип	OpenAI.ApplyPatchFileOperationType		Да
Статус	OpenAI.ApplyPatchCallStatus		Да
type	enum	Тип элемента. Всегда `apply_patch_call`. Возможные значения: `apply_patch_call`	Да	apply_patch_call

OpenAI.OutputItemApplyPatchToolCallOutput

Применить вывод вызова патч-инструмента

Выходные данные, создаваемые вызовом средства исправления.

Name	Type	Description	Обязательный	По умолчанию
call_id	строка	Уникальный идентификатор вызова средства исправления, созданного моделью.	Да
создано пользователем	строка	Идентификатор сущности, создающей выходные данные вызова этого средства.	Нет
id	строка	Уникальный идентификатор выходных данных вызова средства исправления. Заполняется, когда этот элемент возвращается через API.	Да
output	строка или null		Нет
Статус	OpenAI.ApplyPatchCallOutputStatus		Да
type	enum	Тип элемента. Всегда `apply_patch_call_output`. Возможные значения: `apply_patch_call_output`	Да	apply_patch_call_output

OpenAI.OutputItemCodeInterpreterToolCall

Вызов инструмента интерпретатора кода

Вызов инструмента для выполнения кода.

Name	Type	Description	Обязательный	По умолчанию
code	строка или null		Да
container_id	строка	Идентификатор контейнера, используемого для запуска кода.	Да
id	строка	Уникальный идентификатор вызова средства интерпретатора кода.	Да
outputs	массив OpenAI.CodeInterpreterOutputLogs или OpenAI.CodeInterpreterOutputImage или null		Да
Статус	enum	Состояние вызова средства интерпретатора кода. Допустимые значения: `in_progress`, `completed`, `incomplete`, `interpreting`, и `failed`. Возможные значения: `in_progress`, `completed`, `incomplete`, `interpreting`, `failed`	Да
type	enum	Тип вызова средства интерпретатора кода. Всегда `code_interpreter_call`. Возможные значения: `code_interpreter_call`	Да	code_interpreter_call

OpenAI.OutputItemCompactionBody

Пункт уплотнения

Элемент сжатия, v1/responses/compact созданный API.

Name	Type	Description	Обязательный	По умолчанию
создано пользователем	строка	Идентификатор субъекта, создавшего элемент.	Нет
encrypted_content	строка	Зашифрованное содержимое, созданное с помощью сжатия.	Да
id	строка	Уникальный идентификатор элемента сжатия.	Да
type	enum	Тип элемента. Всегда `compaction`. Возможные значения: `compaction`	Да	Уплотнение

OpenAI.OutputItemComputerToolCall

Вызов компьютерного инструмента

Name	Type	Description	Обязательный	По умолчанию
action	OpenAI.ComputerAction		Да
call_id	строка	Идентификатор, используемый при реагировании на вызов инструмента с выходными данными.	Да
id	строка	Уникальный идентификатор вызова компьютера.	Да
pending_safety_checks	массив OpenAI.ComputerCallSafetyCheckParam	Ожидающие проверки безопасности для компьютеризированного процесса.	Да
Статус	enum	Состояние элемента. Один из `in_progress`, `completed`или `incomplete`. Заполняется, когда элементы возвращаются через API. Возможные значения: `in_progress`, `completedincomplete`	Да
type	enum	Тип компьютерного вызова. Всегда `computer_call`. Возможные значения: `computer_call`	Да	computer_call

OpenAI.OutputItemCustomToolCall

Пользовательский вызов инструмента

Вызов пользовательского средства, созданного моделью.

Name	Type	Description	Обязательный
call_id	строка	Идентификатор, используемый для сопоставления этого настраиваемого вызова средства с выходными данными вызова средства.	Да
id	строка	Уникальный идентификатор вызова пользовательского средства на платформе OpenAI.	Нет
input	строка	Входные данные для вызова пользовательского средства, созданного моделью.	Да
имя	строка	Имя вызываемого пользовательского инструмента.	Да
type	enum	Тип вызова пользовательского средства. Всегда `custom_tool_call`. Возможные значения: `custom_tool_call`	Да

OpenAI.OutputItemFileSearchToolCall

Вызов инструмента поиска файлов

Результаты вызова средства поиска файлов. Дополнительные сведения см. в руководстве по поиску файлов .

Name	Type	Description	Обязательный
id	строка	Уникальный идентификатор вызова средства поиска файлов.	Да
queries	массив строк	Запросы, используемые для поиска файлов.	Да
results	массив OpenAI.FileSearchToolCallResults или null		Нет
Статус	enum	Состояние вызова средства поиска файлов. Один из `in_progress`, `searching`, `incomplete` или `failed`, Возможные значения: `in_progress`, `searching`, `completed`, `incomplete`, `failed`	Да
type	enum	Тип вызова средства поиска файлов. Всегда `file_search_call`. Возможные значения: `file_search_call`	Да

OpenAI.OutputItemFunctionShellCall

Вызов инструмента shell

Вызов средства, выполняющий одну или несколько команд оболочки в управляемой среде.

Name	Type	Description	Обязательный	По умолчанию
action	OpenAI.FunctionShellAction	Выполните команду оболочки.	Да
Команды └️	массив строк		Да
└max_output_length	целое число или null		Да
└️ timeout_ms	целое число или null		Да
call_id	строка	Уникальный идентификатор вызова средства оболочки, созданного моделью.	Да
создано пользователем	строка	Идентификатор сущности, созданной этим средством.	Нет
id	строка	Уникальный идентификатор вызова средства оболочки. Заполняется, когда этот элемент возвращается через API.	Да
Статус	OpenAI.LocalShellCallStatus		Да
type	enum	Тип элемента. Всегда `shell_call`. Возможные значения: `shell_call`	Да	shell_call

OpenAI.OutputItemFunctionShellCallOutput

Вывод вызова через оболочку

Выходные данные вызова средства оболочки, который был создан.

Name	Type	Description	Обязательный	По умолчанию
call_id	строка	Уникальный идентификатор вызова средства оболочки, созданного моделью.	Да
создано пользователем	строка	Идентификатор субъекта, создавшего элемент.	Нет
id	строка	Уникальный идентификатор выходных данных вызова оболочки. Заполняется, когда этот элемент возвращается через API.	Да
max_output_length	целое число или null		Да
output	массив OpenAI.FunctionShellCallOutputContent	Массив содержимого вывода вызова оболочки	Да
type	enum	Тип выходных данных вызова оболочки. Всегда `shell_call_output`. Возможные значения: `shell_call_output`	Да	shell_call_output

OpenAI.OutputItemFunctionToolCall

Вызов функционального инструмента

Вызов средства для запуска функции. Дополнительные сведения см. в руководстве по вызову функции .

Name	Type	Description	Обязательный
arguments	строка	Строка JSON аргументов для передачи функции.	Да
call_id	строка	Уникальный идентификатор вызова функции, созданного моделью.	Да
id	строка	Уникальный идентификатор вызова средства функции.	Нет
имя	строка	Имя выполняемой функции.	Да
Статус	enum	Состояние элемента. Один из `in_progress`, `completed`или `incomplete`. Заполняется, когда элементы возвращаются через API. Возможные значения: `in_progress`, `completedincomplete`	Нет
type	enum	Тип вызова инструмента функции. Всегда `function_call`. Возможные значения: `function_call`	Да

OpenAI.OutputItemImageGenToolCall

Вызов генерации изображений

Запрос на создание изображения, сделанный моделью.

Name	Type	Description	Обязательный
id	строка	Уникальный идентификатор вызова создания образа.	Да
result	строка или null		Да
Статус	enum	Состояние вызова создания образа. Возможные значения: `in_progress`, , `completedgeneratingfailed`	Да
type	enum	Тип вызова создания изображения. Всегда `image_generation_call`. Возможные значения: `image_generation_call`	Да

OpenAI.OutputItemLocalShellToolCall

Локальный вызов shell

Вызов инструмента для выполнения команды в локальной оболочке.

Name	Type	Description	Обязательный
action	OpenAI.LocalShellExecAction	Выполните команду оболочки на сервере.	Да
call_id	строка	Уникальный идентификатор вызова локального утилита оболочки, сгенерированного моделью.	Да
id	строка	Уникальный идентификатор вызова локальной оболочки.	Да
Статус	enum	Состояние вызова локальной оболочки. Возможные значения: `in_progress`, `completedincomplete`	Да
type	enum	Тип вызова локальной оболочки. Всегда `local_shell_call`. Возможные значения: `local_shell_call`	Да

OpenAI.OutputItemMcpApprovalRequest

Запрос на одобрение MCP

Запрос на одобрение человеком вызова инструмента.

Name	Type	Description	Обязательный
arguments	строка	Строка JSON с аргументами для средства.	Да
id	строка	Уникальный идентификатор запроса на утверждение.	Да
имя	строка	Имя запускаемого инструмента.	Да
метка сервера	строка	Метка сервера MCP, выполняющего запрос.	Да
type	enum	Тип элемента. Всегда `mcp_approval_request`. Возможные значения: `mcp_approval_request`	Да

OpenAI.OutputItemMcpListTools

Инструменты списка MCP

Список средств, доступных на сервере MCP.

Name	Type	Description	Обязательный
error	строка или null		Нет
id	строка	Уникальный идентификатор списка.	Да
метка сервера	строка	Метка сервера MCP.	Да
tools	массив OpenAI.MCPListToolsTools	Средства, доступные на сервере.	Да
type	enum	Тип элемента. Всегда `mcp_list_tools`. Возможные значения: `mcp_list_tools`	Да

OpenAI.OutputItemMcpToolCall

Вызов инструмента MCP

Вызов инструмента на сервере MCP.

Name	Type	Description	Обязательный
approval_request_id	строка или null		Нет
arguments	строка	Строка JSON аргументов, переданных средству.	Да
error	строка или null		Нет
id	строка	Уникальный идентификатор вызова средства.	Да
имя	строка	Имя запущенного инструмента.	Да
output	строка или null		Нет
метка сервера	строка	Метка сервера MCP, на котором работает инструмент.	Да
Статус	OpenAI.MCPToolCallStatus		Нет
type	enum	Тип элемента. Всегда `mcp_call`. Возможные значения: `mcp_call`	Да

OpenAI.OutputItemOutputMessage

Выходное сообщение

Выходное сообщение из модели.

Name	Type	Description	Обязательный
содержимое	массив OpenAI.OutputMessageContent	Содержимое выходного сообщения.	Да
id	строка	Уникальный идентификатор выходного сообщения.	Да
role	enum	Роль выходного сообщения. Всегда `assistant`. Возможные значения: `assistant`	Да
Статус	enum	Состояние входных данных сообщения. Один из `in_progress`, `completed`или `incomplete`. Заполняется при возврате входных элементов через API. Возможные значения: `in_progress`, `completedincomplete`	Да
type	enum	Тип выходного сообщения. Всегда `message`. Возможные значения: `output_message`	Да

OpenAI.OutputItemReasoningItem

Reasoning

Описание цепочки мысли, используемой моделью причин при создании ответа. Не забудьте включить эти элементы в input API ответов для последующих поворотов беседы, если вы вручную управляете контекстом.

Name	Type	Description	Обязательный
содержимое	массив OpenAI.ReasoningTextContent	Обоснование текстового содержимого.	Нет
encrypted_content	строка или null		Нет
id	строка	Уникальный идентификатор контента рассуждений.	Да
Статус	enum	Состояние элемента. Один из `in_progress`, `completed`или `incomplete`. Заполняется, когда элементы возвращаются через API. Возможные значения: `in_progress`, `completedincomplete`	Нет
summary	массив OpenAI.Summary	Содержимое сводки по причинам.	Да
type	enum	Тип объекта . Всегда `reasoning`. Возможные значения: `reasoning`	Да

OpenAI.OutputItemType

Property	Ценность
Type	строка
Значения	`output_message` `file_search_call` `function_call` `web_search_call` `computer_call` `reasoning` `compaction` `image_generation_call` `code_interpreter_call` `local_shell_call` `shell_call` `shell_call_output` `apply_patch_call` `apply_patch_call_output` `mcp_call` `mcp_list_tools` `mcp_approval_request` `custom_tool_call`

OpenAI.OutputItemWebSearchToolCall

Вызов инструмента веб-поиска

Name	Type	Description	Обязательный
action	OpenAI.WebSearchActionSearch или OpenAI.WebSearchActionOpenPage или OpenAI.WebSearchActionFind	Объект, описывающий конкретные действия, выполненные в этом вызове поиска в Интернете. Содержит сведения об использовании модели в Интернете (поиск, open_page, поиск).	Да
id	строка	Уникальный идентификатор вызова средства поиска в Интернете.	Да
Статус	enum	Состояние вызова функции средства поиска в Интернете. Возможные значения: `in_progress`, , `searchingcompletedfailed`	Да
type	enum	Тип вызова средства поиска в Интернете. Всегда `web_search_call`. Возможные значения: `web_search_call`	Да

OpenAI.OutputMessageContent

Дискриминация для OpenAI.OutputMessageContent

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа	Schema
`output_text`	OpenAI.OutputMessageContentOutputTextContent
`refusal`	OpenAI.OutputMessageContentRefusalContent

Name	Type	Description	Обязательный	По умолчанию
type	OpenAI.OutputMessageContentType		Да

OpenAI.OutputMessageContentOutputTextContent

Выходной текст

Текстовые выходные данные модели.

Name	Type	Description	Обязательный	По умолчанию
annotations	массив OpenAI.Annotation	Заметки к выходным данным текста.	Да
logprobs	массив OpenAI.LogProb		Нет
text	строка	Текстовые выходные данные модели.	Да
type	enum	Тип выходного текста. Всегда `output_text`. Возможные значения: `output_text`	Да	output_text

OpenAI.OutputMessageContentRefusalContent

Refusal

Отказ модели.

Name	Type	Description	Обязательный	По умолчанию
отказ	строка	Объяснение отказа модели.	Да
type	enum	Тип отказа. Всегда `refusal`. Возможные значения: `refusal`	Да	отказ

OpenAI.OutputMessageContentType

Property	Ценность
Type	строка
Значения	`output_text` `refusal`

OpenAI.Prompt

Ссылка на шаблон запроса и его переменные. Подробнее.

Name	Type	Description	Обязательный
id	строка	Уникальный идентификатор используемого шаблона запроса.	Да
variables	OpenAI.ResponsePromptVariables или NULL		Нет
version	строка или null		Нет

OpenAI.RankerVersionType

Property	Ценность
Type	строка
Значения	`auto` `default-2024-11-15`

OpenAI.RankingOptions

Name	Type	Description	Обязательный
hybrid_search	OpenAI.HybridSearchOptions		Нет
└️ embedding_weight	number	Вес внедрения в взаимное ранжирование слияние.	Да
└text_weight	number	Вес текста в взаимном ранжировании слиянием.	Да
офицер	OpenAI.RankerVersionType		Нет
порог оценки	number	Пороговое значение оценки для поиска файлов — от 0 до 1. Числа ближе к 1 будут пытаться вернуть только наиболее релевантные результаты, но могут возвращать меньше результатов.	Нет

OpenAI.Reasoning

Reasoning

Только модели gpt-5 и o-series Параметры конфигурации для моделей причин.

Name	Type	Description	Обязательный
effort	OpenAI.ReasoningEffort	Ограничение усилий в процессе обоснования модели рассуждений. В настоящее время поддерживаются `none`значения , , `minimal`, `lowmedium`, `high`и `xhigh`. Уменьшение Усилия рассуждения могут привести к более быстрым ответам и меньшему использованию маркеров. о рассуждении в ответе. - `gpt-5.1` по умолчанию используется `none`значение , которое не выполняет причину. Поддерживаемые значения `gpt-5.1` аргументов: `none`, `lowmedium`и `high`. Вызовы инструментов поддерживаются для всех значений причин в gpt-5.1. — Все модели до выполнения действий по `gpt-5.1` умолчанию `medium` и не поддерживаются `none`. — Модель `gpt-5-pro` по умолчанию используется (и поддерживает только) `high` усилия по поводу. - `xhigh` поддерживается для всех моделей после `gpt-5.1-codex-max`.	Нет
generate_summary	строка или null		Нет
summary	строка или null		Нет

OpenAI.ReasoningEffort

Ограничивает усилия, направленные на модели рассуждений. В настоящее время поддерживаются noneзначения , , minimal, lowmedium, highи xhigh. Сокращение усилий на рассуждение может привести к более быстрым ответам и меньшему количеству токенов, используемых при рассуждениях в ответе.

gpt-5.1 по умолчанию используется noneзначение , которое не выполняет причину. Поддерживаемые значения gpt-5.1 аргументов: none, lowmediumи high. Вызовы инструментов поддерживаются для всех значений причин в gpt-5.1.
Все модели до выполнения gpt-5.1 действий по умолчанию и medium не поддерживаются none.
Модель gpt-5-pro по умолчанию используется (и поддерживает только) high усилия по соображениям.
xhigh поддерживается для всех моделей после gpt-5.1-codex-max.

Property	Ценность
Description	Ограничивает усилия, направленные на модели рассуждений. В настоящее время поддерживаются `none`значения , , `minimal`, `lowmedium`, `high`и `xhigh`. Сокращение усилий на рассуждение может привести к более быстрым ответам и меньшему количеству токенов, используемых при рассуждениях в ответе. - `gpt-5.1` по умолчанию используется `none`значение , которое не выполняет причину. Поддерживаемые значения `gpt-5.1` аргументов: `none`, `lowmedium`и `high`. Вызовы инструментов поддерживаются для всех значений причин в gpt-5.1. — Все модели до выполнения действий по `gpt-5.1` умолчанию `medium` и не поддерживаются `none`. — Модель `gpt-5-pro` по умолчанию используется (и поддерживает только) `high` усилия по поводу. - `xhigh` поддерживается для всех моделей после `gpt-5.1-codex-max`.
Type	строка
Значения	`none` `minimal` `low` `medium` `high` `xhigh`

OpenAI.ReasoningTextContent

РассуждениеТекстСодержание

Вывод текста из модели.

Name	Type	Description	Обязательный	По умолчанию
text	строка	Текст причины из модели.	Да
type	enum	Тип текста причины. Всегда `reasoning_text`. Возможные значения: `reasoning_text`	Да	reasoning_text

OpenAI.Response

Объект отклика

Name	Type	Description	Обязательный	По умолчанию
фон	логический или null		Нет
завершено_в	строка или null		Нет
content_filters	массив AzureContentFilterForResponsesAPI	Фильтр содержимого приводит к результату RAI.	Да
разговор	OpenAI.ConversationReference или null		Нет
создано_в	целое число (UnixTime)	Метка времени в формате Unix (в секундах), когда был создан этот ответ.	Да
error	OpenAI.ResponseError или null		Да
id	строка	Уникальный идентификатор для этого ответа.	Да
incomplete_details	OpenAI.ResponseIncompleteDetails или null		Да
instructions	строка или массив OpenAI.InputItem или null		Да
max_output_tokens	целое число или null		Нет
max_tool_calls	целое число или null		Нет
metadata	OpenAI.Metadata или NULL		Нет
модель	строка	Идентификатор модели, используемый для создания ответа, например `gpt-4o` или `o3`. OpenAI предлагает широкий спектр моделей с разными возможностями, производительностью характеристики и цены. См. руководство по модели для просмотра и сравнения доступных моделей.	Нет
object	enum	Тип объекта этого ресурса — всегда установлено `response`. Возможные значения: `response`	Да
output	массив OpenAI.OutputItem	Массив элементов контента, созданных моделью. — Длина и порядок элементов в массиве `output` зависят в ответе модели. — Вместо доступа к первому элементу массива `output` и Предположим, что это `assistant` сообщение с содержанием, созданным Вы можете рассмотреть возможность использования свойства `output_text` модели, если поддерживается в пакетах SDK.	Да
output_text	строка или null		Нет
вызовы инструмента в параллельном режиме	boolean	Следует ли разрешить модели запускать вызовы инструментов параллельно.	Да	True
previous_response_id	строка или null		Нет
prompt	OpenAI.Prompt	Ссылка на шаблон запроса и его переменные. Подробнее.	Нет
prompt_cache_key	строка	Используется OpenAI для кэширования ответов для аналогичных запросов для оптимизации частоты попаданий кэша. Заменяет `user` поле. Подробнее.	Нет
prompt_cache_retention	строка или null		Нет
reasoning	OpenAI.Reasoning или NULL		Нет
safety_identifier	строка	Стабильный идентификатор, используемый для обнаружения пользователей приложения, которые могут нарушать политики использования OpenAI. Идентификаторы должны быть строкой, которая однозначно идентифицирует каждого пользователя. Мы рекомендуем хэшировать имя пользователя или адрес электронной почты, чтобы избежать отправки нам каких-либо сведений об идентификации. Подробнее.	Нет
Статус	enum	Статус формирования ответа. Один из `completed`, `failed` `in_progress`, `cancelled`, `queued` или `incomplete`. Возможные значения: `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete`	Нет
Температура	число или null		Нет
text	OpenAI.ResponseTextParam	Параметры конфигурации для текстового ответа модели. Может быть простым текстовые или структурированные данные JSON. Подробнее: - Текстовые входные и выходные данные - Структурированные выходные данные	Нет
выбор инструмента	OpenAI.ToolChoiceParam	Как модель должна выбрать инструмент (или средства), которые следует использовать при создании ответ. См. `tools` параметр, чтобы узнать, как указать инструменты Модель может звонить.	Нет
tools	OpenAI.ToolsArray	Массив инструментов, которые модель может вызывать при создании ответа. Вы может указать, какое средство следует использовать, задав `tool_choice` параметр. Мы поддерживаем следующие категории инструментов: - Встроенные инструменты: инструменты, предоставляемые OpenAI для расширения Возможности модели, такие как поиск в Интернете или поиск по файлам. Дополнительные сведения встроенные средства. - Инструменты MCP: интеграция с сторонними системами с помощью пользовательских серверов MCP или предопределенные соединители, такие как Google Drive и SharePoint. Дополнительные сведения Инструменты MCP. - Вызовы функций (пользовательские средства): функции, определенные вами, включение модели для вызова собственного кода с строго типизированными аргументами и выходные данные. Дополнительные сведения вызов функции. Вы также можете использовать пользовательские средства для вызова собственного кода.	Нет
top_logprobs	целое число или null		Нет
top_p	число или null		Нет
truncation	строка или null		Нет
использование	OpenAI.ResponseUsage	Представляет сведения об использовании маркеров, включая входные маркеры, выходные маркеры, разбивка выходных маркеров и общих используемых маркеров.	Нет
user	string (не рекомендуется)	Это поле заменяется `safety_identifier` и `prompt_cache_key`. Вместо этого используйте `prompt_cache_key` для поддержания оптимизации кэширования. Стабильный идентификатор для конечных пользователей. Используется для повышения скорости попадания кэша в более эффективное сегментирование аналогичных запросов и помогает OpenAI обнаруживать и предотвращать злоупотребление. Подробнее.	Нет

OpenAI.ResponseAudioDeltaEvent

Выдается при наличии частичного аудиореспонса.

Name	Type	Description	Обязательный
delta	строка	Блок аудиобайтов, закодированных в формате Base64. Ограничения: кодирование: base64	Да
sequence_number	целое число	Порядковый номер для этого блока ответа потока.	Да
type	enum	тип события; Всегда `response.audio.delta`. Возможные значения: `response.audio.delta`	Да

OpenAI.ResponseAudioTranscriptDeltaEvent

Выдается при частичной расшифровке звука.

Name	Type	Description	Обязательный
delta	строка	Частичная расшифровка аудиоответа.	Да
sequence_number	целое число	Порядковый номер этого события.	Да
type	enum	тип события; Всегда `response.audio.transcript.delta`. Возможные значения: `response.audio.transcript.delta`	Да

OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent

Создается при потоковой передаче фрагмента частичного кода интерпретатором кода.

Name	Type	Description	Обязательный
delta	строка	Фрагмент частичного кода, передаваемый интерпретатором кода.	Да
item_id	строка	Уникальный идентификатор элемента вызова средства интерпретатора кода.	Да
output_index	целое число	Индекс выходного элемента в ответе, для которого выполняется потоковая передача кода.	Да
sequence_number	целое число	Порядковый номер этого события, используемый для заказа событий потоковой передачи.	Да
type	enum	тип события; Всегда `response.code_interpreter_call_code.delta`. Возможные значения: `response.code_interpreter_call_code.delta`	Да

OpenAI.ResponseCodeInterpreterCallInProgressEvent

Срабатывает при выполнении вызова интерпретатора кода.

Name	Type	Description	Обязательный
item_id	строка	Уникальный идентификатор элемента вызова средства интерпретатора кода.	Да
output_index	целое число	Индекс выходного элемента в ответе, для которого выполняется вызов интерпретатора кода.	Да
sequence_number	целое число	Порядковый номер этого события, используемый для заказа событий потоковой передачи.	Да
type	enum	тип события; Всегда `response.code_interpreter_call.in_progress`. Возможные значения: `response.code_interpreter_call.in_progress`	Да

OpenAI.ResponseCodeInterpreterCallInterpretingEvent

Создается, когда интерпретатор кода активно интерпретирует фрагмент кода.

Name	Type	Description	Обязательный
item_id	строка	Уникальный идентификатор элемента вызова средства интерпретатора кода.	Да
output_index	целое число	Индекс выходного элемента в ответе, для которого интерпретатор кода интерпретирует код.	Да
sequence_number	целое число	Порядковый номер этого события, используемый для заказа событий потоковой передачи.	Да
type	enum	тип события; Всегда `response.code_interpreter_call.interpreting`. Возможные значения: `response.code_interpreter_call.interpreting`	Да

OpenAI.ResponseContentPartAddedEvent

Вызывается при добавлении новой части содержимого.

Name	Type	Description	Обязательный
content_index	целое число	Индекс добавленной части содержимого.	Да
item_id	строка	Идентификатор выходного элемента, к которому была добавлена часть содержимого.	Да
output_index	целое число	Индекс выходного элемента, к которому была добавлена часть содержимого.	Да
part	OpenAI.OutputContent		Да
└─ Тип	OpenAI.OutputContentType		Да
sequence_number	целое число	Порядковый номер этого события.	Да
type	enum	тип события; Всегда `response.content_part.added`. Возможные значения: `response.content_part.added`	Да

OpenAI.ResponseCreatedEvent

Событие, которое эмитируется при создании ответа.

Name	Type	Description	Обязательный	По умолчанию
response	OpenAI.Response		Да
└─ Фон	логический или null		Нет
└️ completed_at	строка или null (unixTimestamp)		Нет
└️ content_filters	массив AzureContentFilterForResponsesAPI	Фильтр содержимого приводит к результату RAI.	Да
Беседа └️	OpenAI.ConversationReference или null		Нет
└️ created_at	целое число (UnixTime)	Метка времени в формате Unix (в секундах), когда был создан этот ответ.	Да
└─ Ошибка	OpenAI.ResponseError или null		Да
Идентификатор └️	строка	Уникальный идентификатор для этого ответа.	Да
└️ incomplete_details	OpenAI.ResponseIncompleteDetails или null		Да
└ Инструкции	строка или массив OpenAI.InputItem или null		Да
└️ max_output_tokens	целое число или null		Нет
└️ max_tool_calls	целое число или null		Нет
└─ Метаданные	OpenAI.Metadata или NULL		Нет
└─ Модель	строка	Идентификатор модели, используемый для создания ответа, например `gpt-4o` или `o3`. OpenAI предлагает широкий спектр моделей с разными возможностями, производительностью характеристики и цены. См. руководство по модели для просмотра и сравнения доступных моделей.	Нет
└─ Объект	enum	Тип объекта этого ресурса — всегда установлено `response`. Возможные значения: `response`	Да
вывод └─	массив OpenAI.OutputItem	Массив элементов контента, созданных моделью. — Длина и порядок элементов в массиве `output` зависят в ответе модели. — Вместо доступа к первому элементу массива `output` и Предположим, что это `assistant` сообщение с содержанием, созданным Вы можете рассмотреть возможность использования свойства `output_text` модели, если поддерживается в пакетах SDK.	Да
└️ output_text	строка или null		Нет
└─ вызовы_инструментов_в_параллельном_режиме	boolean	Следует ли разрешить модели запускать вызовы инструментов параллельно.	Да	True
└previous_response_id	строка или null		Нет
└─ Запрос	OpenAI.Prompt	Ссылка на шаблон запроса и его переменные. Подробнее.	Нет
└prompt_cache_key	строка	Используется OpenAI для кэширования ответов для аналогичных запросов для оптимизации частоты попаданий кэша. Заменяет `user` поле. Подробнее.	Нет
└prompt_cache_retention	строка или null		Нет
└─ рассуждения	OpenAI.Reasoning или NULL		Нет
└safety_identifier	строка	Стабильный идентификатор, используемый для обнаружения пользователей приложения, которые могут нарушать политики использования OpenAI. Идентификаторы должны быть строкой, которая однозначно идентифицирует каждого пользователя. Мы рекомендуем хэшировать имя пользователя или адрес электронной почты, чтобы избежать отправки нам каких-либо сведений об идентификации. Подробнее.	Нет
└─ Состояние	enum	Статус формирования ответа. Один из `completed`, `failed` `in_progress`, `cancelled`, `queued` или `incomplete`. Возможные значения: `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete`	Нет
└─ Температура	число или null		Нет	1
Текст └️	OpenAI.ResponseTextParam	Параметры конфигурации для текстового ответа модели. Может быть простым текстовые или структурированные данные JSON. Подробнее: - Текстовые входные и выходные данные - Структурированные выходные данные	Нет
└─ выбор_инструмента	OpenAI.ToolChoiceParam	Как модель должна выбрать инструмент (или средства), которые следует использовать при создании ответ. См. `tools` параметр, чтобы узнать, как указать инструменты Модель может звонить.	Нет
└─ Инструменты	OpenAI.ToolsArray	Массив инструментов, которые модель может вызывать при создании ответа. Вы может указать, какое средство следует использовать, задав `tool_choice` параметр. Мы поддерживаем следующие категории инструментов: - Встроенные инструменты: инструменты, предоставляемые OpenAI для расширения Возможности модели, такие как поиск в Интернете или поиск по файлам. Дополнительные сведения встроенные средства. - Инструменты MCP: интеграция с сторонними системами с помощью пользовательских серверов MCP или предопределенные соединители, такие как Google Drive и SharePoint. Дополнительные сведения Инструменты MCP. - Вызовы функций (пользовательские средства): функции, определенные вами, включение модели для вызова собственного кода с строго типизированными аргументами и выходные данные. Дополнительные сведения вызов функции. Вы также можете использовать пользовательские средства для вызова собственного кода.	Нет
└️ top_logprobs	целое число или null		Нет
└️ top_p	число или null		Нет	1
└️ усечение	строка или null		Нет	disabled
└─ использование	OpenAI.ResponseUsage	Представляет сведения об использовании маркеров, включая входные маркеры, выходные маркеры, разбивка выходных маркеров и общих используемых маркеров.	Нет
Пользователь └️	string (не рекомендуется)	Это поле заменяется `safety_identifier` и `prompt_cache_key`. Вместо этого используйте `prompt_cache_key` для поддержания оптимизации кэширования. Стабильный идентификатор для конечных пользователей. Используется для повышения скорости попадания кэша в более эффективное сегментирование аналогичных запросов и помогает OpenAI обнаруживать и предотвращать злоупотребление. Подробнее.	Нет
sequence_number	целое число	Порядковый номер для этого события.	Да
type	enum	тип события; Всегда `response.created`. Возможные значения: `response.created`	Да

OpenAI.ResponseCustomToolCallInputDeltaEvent

ResponseCustomToolCallInputDelta

Событие, представляющее разностное (частичное обновление) для ввода пользовательского вызова средства.

Name	Type	Description	Обязательный
delta	строка	Добавочные входные данные (delta) для вызова пользовательского средства.	Да
item_id	строка	Уникальный идентификатор элемента API, связанного с этим событием.	Да
output_index	целое число	Индекс выходных данных, к которые применяется эта разность.	Да
sequence_number	целое число	Порядковый номер этого события.	Да
type	enum	Идентификатор типа события. Возможные значения: `response.custom_tool_call_input.delta`	Да

OpenAI.ResponseError

Объект ошибки, возвращаемый, когда модель не сможет создать ответ.

Name	Type	Description	Обязательный	По умолчанию
code	OpenAI.ResponseErrorCode	Код ошибки для ответа.	Да
message	строка	Описание ошибки, доступной для чтения человеком.	Да

OpenAI.ResponseErrorCode

Код ошибки для ответа.

Property	Ценность
Type	строка
Значения	`server_error` `rate_limit_exceeded` `invalid_prompt` `vector_store_timeout` `invalid_image` `invalid_image_format` `invalid_base64_image` `invalid_image_url` `image_too_large` `image_too_small` `image_parse_error` `image_content_policy_violation` `invalid_image_mode` `image_file_too_large` `unsupported_image_media_type` `empty_image_file` `failed_to_download_image` `image_file_not_found`

OpenAI.ResponseErrorEvent

Эмитируется при возникновении ошибки.

Name	Type	Description	Обязательный
code	строка или null		Да
message	строка	Сообщение об ошибке.	Да
параметр	строка или null		Да
sequence_number	целое число	Порядковый номер этого события.	Да
type	enum	тип события; Всегда `error`. Возможные значения: `error`	Да

OpenAI.ResponseFailedEvent

Событие, которое возникает при сбое ответа.

Name	Type	Description	Обязательный	По умолчанию
response	OpenAI.Response		Да
└─ Фон	логический или null		Нет
└️ completed_at	строка или null (unixTimestamp)		Нет
└️ content_filters	массив AzureContentFilterForResponsesAPI	Фильтр содержимого приводит к результату RAI.	Да
Беседа └️	OpenAI.ConversationReference или null		Нет
└️ created_at	целое число (UnixTime)	Метка времени в формате Unix (в секундах), когда был создан этот ответ.	Да
└─ Ошибка	OpenAI.ResponseError или null		Да
Идентификатор └️	строка	Уникальный идентификатор для этого ответа.	Да
└️ incomplete_details	OpenAI.ResponseIncompleteDetails или null		Да
└ Инструкции	строка или массив OpenAI.InputItem или null		Да
└️ max_output_tokens	целое число или null		Нет
└️ max_tool_calls	целое число или null		Нет
└─ Метаданные	OpenAI.Metadata или NULL		Нет
└─ Модель	строка	Идентификатор модели, используемый для создания ответа, например `gpt-4o` или `o3`. OpenAI предлагает широкий спектр моделей с разными возможностями, производительностью характеристики и цены. См. руководство по модели для просмотра и сравнения доступных моделей.	Нет
└─ Объект	enum	Тип объекта этого ресурса — всегда установлено `response`. Возможные значения: `response`	Да
вывод └─	массив OpenAI.OutputItem	Массив элементов контента, созданных моделью. — Длина и порядок элементов в массиве `output` зависят в ответе модели. — Вместо доступа к первому элементу массива `output` и Предположим, что это `assistant` сообщение с содержанием, созданным Вы можете рассмотреть возможность использования свойства `output_text` модели, если поддерживается в пакетах SDK.	Да
└️ output_text	строка или null		Нет
└─ вызовы_инструментов_в_параллельном_режиме	boolean	Следует ли разрешить модели запускать вызовы инструментов параллельно.	Да	True
└previous_response_id	строка или null		Нет
└─ Запрос	OpenAI.Prompt	Ссылка на шаблон запроса и его переменные. Подробнее.	Нет
└prompt_cache_key	строка	Используется OpenAI для кэширования ответов для аналогичных запросов для оптимизации частоты попаданий кэша. Заменяет `user` поле. Подробнее.	Нет
└prompt_cache_retention	строка или null		Нет
└─ рассуждения	OpenAI.Reasoning или NULL		Нет
└safety_identifier	строка	Стабильный идентификатор, используемый для обнаружения пользователей приложения, которые могут нарушать политики использования OpenAI. Идентификаторы должны быть строкой, которая однозначно идентифицирует каждого пользователя. Мы рекомендуем хэшировать имя пользователя или адрес электронной почты, чтобы избежать отправки нам каких-либо сведений об идентификации. Подробнее.	Нет
└─ Состояние	enum	Статус формирования ответа. Один из `completed`, `failed` `in_progress`, `cancelled`, `queued` или `incomplete`. Возможные значения: `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete`	Нет
└─ Температура	число или null		Нет	1
Текст └️	OpenAI.ResponseTextParam	Параметры конфигурации для текстового ответа модели. Может быть простым текстовые или структурированные данные JSON. Подробнее: - Текстовые входные и выходные данные - Структурированные выходные данные	Нет
└─ выбор_инструмента	OpenAI.ToolChoiceParam	Как модель должна выбрать инструмент (или средства), которые следует использовать при создании ответ. См. `tools` параметр, чтобы узнать, как указать инструменты Модель может звонить.	Нет
└─ Инструменты	OpenAI.ToolsArray	Массив инструментов, которые модель может вызывать при создании ответа. Вы может указать, какое средство следует использовать, задав `tool_choice` параметр. Мы поддерживаем следующие категории инструментов: - Встроенные инструменты: инструменты, предоставляемые OpenAI для расширения Возможности модели, такие как поиск в Интернете или поиск по файлам. Дополнительные сведения встроенные средства. - Инструменты MCP: интеграция с сторонними системами с помощью пользовательских серверов MCP или предопределенные соединители, такие как Google Drive и SharePoint. Дополнительные сведения Инструменты MCP. - Вызовы функций (пользовательские средства): функции, определенные вами, включение модели для вызова собственного кода с строго типизированными аргументами и выходные данные. Дополнительные сведения вызов функции. Вы также можете использовать пользовательские средства для вызова собственного кода.	Нет
└️ top_logprobs	целое число или null		Нет
└️ top_p	число или null		Нет	1
└️ усечение	строка или null		Нет	disabled
└─ использование	OpenAI.ResponseUsage	Представляет сведения об использовании маркеров, включая входные маркеры, выходные маркеры, разбивка выходных маркеров и общих используемых маркеров.	Нет
Пользователь └️	string (не рекомендуется)	Это поле заменяется `safety_identifier` и `prompt_cache_key`. Вместо этого используйте `prompt_cache_key` для поддержания оптимизации кэширования. Стабильный идентификатор для конечных пользователей. Используется для повышения скорости попадания кэша в более эффективное сегментирование аналогичных запросов и помогает OpenAI обнаруживать и предотвращать злоупотребление. Подробнее.	Нет
sequence_number	целое число	Порядковый номер этого события.	Да
type	enum	тип события; Всегда `response.failed`. Возможные значения: `response.failed`	Да

OpenAI.ResponseFileSearchCallInProgressEvent

Срабатывает при инициализации вызова поиска файлов.

Name	Type	Description	Обязательный
item_id	строка	Идентификатор выходного элемента, инициируемого вызовом поиска файлов.	Да
output_index	целое число	Индекс выходного элемента, инициируемого вызовом поиска файлов.	Да
sequence_number	целое число	Порядковый номер этого события.	Да
type	enum	тип события; Всегда `response.file_search_call.in_progress`. Возможные значения: `response.file_search_call.in_progress`	Да

OpenAI.ResponseFileSearchCallSearchingEvent

Генерируется во время текущего поиска файла.

Name	Type	Description	Обязательный
item_id	строка	Идентификатор выходного элемента, инициируемого вызовом поиска файлов.	Да
output_index	целое число	Индекс выходного элемента, вызываемого вызовом поиска файлов.	Да
sequence_number	целое число	Порядковый номер этого события.	Да
type	enum	тип события; Всегда `response.file_search_call.searching`. Возможные значения: `response.file_search_call.searching`	Да

OpenAI.ResponseFormatJsonSchema

Схема JSON

Схема формата ответа, описанная как объект схемы JSON. Узнайте, как создать схемы JSON здесь.

Тип: объект

OpenAI.ResponseFunctionCallArgumentsDeltaEvent

Создается при наличии разностных аргументов вызова функции.

Name	Type	Description	Обязательный
delta	строка	Добавлен аргумент вызова функции, представляющий дельту.	Да
item_id	строка	Идентификатор выходного элемента, к которому добавляется дельта аргументов вызова функции.	Да
output_index	целое число	Индекс выходного элемента, к которому добавляется разность аргументов вызова функции.	Да
sequence_number	целое число	Порядковый номер этого события.	Да
type	enum	тип события; Всегда `response.function_call_arguments.delta`. Возможные значения: `response.function_call_arguments.delta`	Да

OpenAI.ResponseImageGenCallGeneratingEvent

ResponseImageGenCallGeneratingEvent

При вызове средства генерации изображений происходит генерация изображения (промежуточное состояние).

Name	Type	Description	Обязательный
item_id	строка	Уникальный идентификатор обрабатываемого элемента создания изображения.	Да
output_index	целое число	Индекс выходного элемента в выходном массиве ответа.	Да
sequence_number	целое число	Порядковый номер обрабатываемого элемента создания изображения.	Да
type	enum	тип события; Всегда «response.image_generation_call.generating». Возможные значения: `response.image_generation_call.generating`	Да

OpenAI.ResponseImageGenCallInProgressEvent

ResponseImageGenCallInProgressEvent

Излучается, когда происходит вызов средства создания изображений.

Name	Type	Description	Обязательный
item_id	строка	Уникальный идентификатор обрабатываемого элемента создания изображения.	Да
output_index	целое число	Индекс выходного элемента в выходном массиве ответа.	Да
sequence_number	целое число	Порядковый номер обрабатываемого элемента создания изображения.	Да
type	enum	тип события; Всегда «response.image_generation_call.in_progress». Возможные значения: `response.image_generation_call.in_progress`	Да

OpenAI.ResponseImageGenCallPartialImageEvent

ResponseImageGenCallPartialImageEvent

Создается при наличии частичного образа во время потоковой передачи изображений.

Name	Type	Description	Обязательный
item_id	строка	Уникальный идентификатор обрабатываемого элемента создания изображения.	Да
output_index	целое число	Индекс выходного элемента в выходном массиве ответа.	Да
partial_image_b64	строка	Данные частичного изображения в кодировке Base64, которые могут быть отображены как изображение.	Да
partial_image_index	целое число	0-й индекс для частичного изображения (серверная часть использует индекс, начинающийся с 1, но для пользователя это начинается с 0).	Да
sequence_number	целое число	Порядковый номер обрабатываемого элемента создания изображения.	Да
type	enum	тип события; Всегда "response.image_generation_call.partial_image". Возможные значения: `response.image_generation_call.partial_image`	Да

OpenAI.ResponseInProgressEvent

Генерируется во время обработки ответа.

Name	Type	Description	Обязательный	По умолчанию
response	OpenAI.Response		Да
└─ Фон	логический или null		Нет
└️ completed_at	строка или null (unixTimestamp)		Нет
└️ content_filters	массив AzureContentFilterForResponsesAPI	Фильтр содержимого приводит к результату RAI.	Да
Беседа └️	OpenAI.ConversationReference или null		Нет
└️ created_at	целое число (UnixTime)	Метка времени в формате Unix (в секундах), когда был создан этот ответ.	Да
└─ Ошибка	OpenAI.ResponseError или null		Да
Идентификатор └️	строка	Уникальный идентификатор для этого ответа.	Да
└️ incomplete_details	OpenAI.ResponseIncompleteDetails или null		Да
└ Инструкции	строка или массив OpenAI.InputItem или null		Да
└️ max_output_tokens	целое число или null		Нет
└️ max_tool_calls	целое число или null		Нет
└─ Метаданные	OpenAI.Metadata или NULL		Нет
└─ Модель	строка	Идентификатор модели, используемый для создания ответа, например `gpt-4o` или `o3`. OpenAI предлагает широкий спектр моделей с разными возможностями, производительностью характеристики и цены. См. руководство по модели для просмотра и сравнения доступных моделей.	Нет
└─ Объект	enum	Тип объекта этого ресурса — всегда установлено `response`. Возможные значения: `response`	Да
вывод └─	массив OpenAI.OutputItem	Массив элементов контента, созданных моделью. — Длина и порядок элементов в массиве `output` зависят в ответе модели. — Вместо доступа к первому элементу массива `output` и Предположим, что это `assistant` сообщение с содержанием, созданным Вы можете рассмотреть возможность использования свойства `output_text` модели, если поддерживается в пакетах SDK.	Да
└️ output_text	строка или null		Нет
└─ вызовы_инструментов_в_параллельном_режиме	boolean	Следует ли разрешить модели запускать вызовы инструментов параллельно.	Да	True
└previous_response_id	строка или null		Нет
└─ Запрос	OpenAI.Prompt	Ссылка на шаблон запроса и его переменные. Подробнее.	Нет
└prompt_cache_key	строка	Используется OpenAI для кэширования ответов для аналогичных запросов для оптимизации частоты попаданий кэша. Заменяет `user` поле. Подробнее.	Нет
└prompt_cache_retention	строка или null		Нет
└─ рассуждения	OpenAI.Reasoning или NULL		Нет
└safety_identifier	строка	Стабильный идентификатор, используемый для обнаружения пользователей приложения, которые могут нарушать политики использования OpenAI. Идентификаторы должны быть строкой, которая однозначно идентифицирует каждого пользователя. Мы рекомендуем хэшировать имя пользователя или адрес электронной почты, чтобы избежать отправки нам каких-либо сведений об идентификации. Подробнее.	Нет
└─ Состояние	enum	Статус формирования ответа. Один из `completed`, `failed` `in_progress`, `cancelled`, `queued` или `incomplete`. Возможные значения: `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete`	Нет
└─ Температура	число или null		Нет	1
Текст └️	OpenAI.ResponseTextParam	Параметры конфигурации для текстового ответа модели. Может быть простым текстовые или структурированные данные JSON. Подробнее: - Текстовые входные и выходные данные - Структурированные выходные данные	Нет
└─ выбор_инструмента	OpenAI.ToolChoiceParam	Как модель должна выбрать инструмент (или средства), которые следует использовать при создании ответ. См. `tools` параметр, чтобы узнать, как указать инструменты Модель может звонить.	Нет
└─ Инструменты	OpenAI.ToolsArray	Массив инструментов, которые модель может вызывать при создании ответа. Вы может указать, какое средство следует использовать, задав `tool_choice` параметр. Мы поддерживаем следующие категории инструментов: - Встроенные инструменты: инструменты, предоставляемые OpenAI для расширения Возможности модели, такие как поиск в Интернете или поиск по файлам. Дополнительные сведения встроенные средства. - Инструменты MCP: интеграция с сторонними системами с помощью пользовательских серверов MCP или предопределенные соединители, такие как Google Drive и SharePoint. Дополнительные сведения Инструменты MCP. - Вызовы функций (пользовательские средства): функции, определенные вами, включение модели для вызова собственного кода с строго типизированными аргументами и выходные данные. Дополнительные сведения вызов функции. Вы также можете использовать пользовательские средства для вызова собственного кода.	Нет
└️ top_logprobs	целое число или null		Нет
└️ top_p	число или null		Нет	1
└️ усечение	строка или null		Нет	disabled
└─ использование	OpenAI.ResponseUsage	Представляет сведения об использовании маркеров, включая входные маркеры, выходные маркеры, разбивка выходных маркеров и общих используемых маркеров.	Нет
Пользователь └️	string (не рекомендуется)	Это поле заменяется `safety_identifier` и `prompt_cache_key`. Вместо этого используйте `prompt_cache_key` для поддержания оптимизации кэширования. Стабильный идентификатор для конечных пользователей. Используется для повышения скорости попадания кэша в более эффективное сегментирование аналогичных запросов и помогает OpenAI обнаруживать и предотвращать злоупотребление. Подробнее.	Нет
sequence_number	целое число	Порядковый номер этого события.	Да
type	enum	тип события; Всегда `response.in_progress`. Возможные значения: `response.in_progress`	Да

OpenAI.ResponseIncompleteDetails

Name	Type	Description	Обязательный	По умолчанию
причина	enum	Возможные значения: `max_output_tokens`, `content_filter`	Нет

OpenAI.ResponseIncompleteEvent

Событие, которое возникает, когда ответ завершается неполным.

Name	Type	Description	Обязательный	По умолчанию
response	OpenAI.Response		Да
└─ Фон	логический или null		Нет
└️ completed_at	строка или null (unixTimestamp)		Нет
└️ content_filters	массив AzureContentFilterForResponsesAPI	Фильтр содержимого приводит к результату RAI.	Да
Беседа └️	OpenAI.ConversationReference или null		Нет
└️ created_at	целое число (UnixTime)	Метка времени в формате Unix (в секундах), когда был создан этот ответ.	Да
└─ Ошибка	OpenAI.ResponseError или null		Да
Идентификатор └️	строка	Уникальный идентификатор для этого ответа.	Да
└️ incomplete_details	OpenAI.ResponseIncompleteDetails или null		Да
└ Инструкции	строка или массив OpenAI.InputItem или null		Да
└️ max_output_tokens	целое число или null		Нет
└️ max_tool_calls	целое число или null		Нет
└─ Метаданные	OpenAI.Metadata или NULL		Нет
└─ Модель	строка	Идентификатор модели, используемый для создания ответа, например `gpt-4o` или `o3`. OpenAI предлагает широкий спектр моделей с разными возможностями, производительностью характеристики и цены. См. руководство по модели для просмотра и сравнения доступных моделей.	Нет
└─ Объект	enum	Тип объекта этого ресурса — всегда установлено `response`. Возможные значения: `response`	Да
вывод └─	массив OpenAI.OutputItem	Массив элементов контента, созданных моделью. — Длина и порядок элементов в массиве `output` зависят в ответе модели. — Вместо доступа к первому элементу массива `output` и Предположим, что это `assistant` сообщение с содержанием, созданным Вы можете рассмотреть возможность использования свойства `output_text` модели, если поддерживается в пакетах SDK.	Да
└️ output_text	строка или null		Нет
└─ вызовы_инструментов_в_параллельном_режиме	boolean	Следует ли разрешить модели запускать вызовы инструментов параллельно.	Да	True
└previous_response_id	строка или null		Нет
└─ Запрос	OpenAI.Prompt	Ссылка на шаблон запроса и его переменные. Подробнее.	Нет
└prompt_cache_key	строка	Используется OpenAI для кэширования ответов для аналогичных запросов для оптимизации частоты попаданий кэша. Заменяет `user` поле. Подробнее.	Нет
└prompt_cache_retention	строка или null		Нет
└─ рассуждения	OpenAI.Reasoning или NULL		Нет
└safety_identifier	строка	Стабильный идентификатор, используемый для обнаружения пользователей приложения, которые могут нарушать политики использования OpenAI. Идентификаторы должны быть строкой, которая однозначно идентифицирует каждого пользователя. Мы рекомендуем хэшировать имя пользователя или адрес электронной почты, чтобы избежать отправки нам каких-либо сведений об идентификации. Подробнее.	Нет
└─ Состояние	enum	Статус формирования ответа. Один из `completed`, `failed` `in_progress`, `cancelled`, `queued` или `incomplete`. Возможные значения: `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete`	Нет
└─ Температура	число или null		Нет	1
Текст └️	OpenAI.ResponseTextParam	Параметры конфигурации для текстового ответа модели. Может быть простым текстовые или структурированные данные JSON. Подробнее: - Текстовые входные и выходные данные - Структурированные выходные данные	Нет
└─ выбор_инструмента	OpenAI.ToolChoiceParam	Как модель должна выбрать инструмент (или средства), которые следует использовать при создании ответ. См. `tools` параметр, чтобы узнать, как указать инструменты Модель может звонить.	Нет
└─ Инструменты	OpenAI.ToolsArray	Массив инструментов, которые модель может вызывать при создании ответа. Вы может указать, какое средство следует использовать, задав `tool_choice` параметр. Мы поддерживаем следующие категории инструментов: - Встроенные инструменты: инструменты, предоставляемые OpenAI для расширения Возможности модели, такие как поиск в Интернете или поиск по файлам. Дополнительные сведения встроенные средства. - Инструменты MCP: интеграция с сторонними системами с помощью пользовательских серверов MCP или предопределенные соединители, такие как Google Drive и SharePoint. Дополнительные сведения Инструменты MCP. - Вызовы функций (пользовательские средства): функции, определенные вами, включение модели для вызова собственного кода с строго типизированными аргументами и выходные данные. Дополнительные сведения вызов функции. Вы также можете использовать пользовательские средства для вызова собственного кода.	Нет
└️ top_logprobs	целое число или null		Нет
└️ top_p	число или null		Нет	1
└️ усечение	строка или null		Нет	disabled
└─ использование	OpenAI.ResponseUsage	Представляет сведения об использовании маркеров, включая входные маркеры, выходные маркеры, разбивка выходных маркеров и общих используемых маркеров.	Нет
Пользователь └️	string (не рекомендуется)	Это поле заменяется `safety_identifier` и `prompt_cache_key`. Вместо этого используйте `prompt_cache_key` для поддержания оптимизации кэширования. Стабильный идентификатор для конечных пользователей. Используется для повышения скорости попадания кэша в более эффективное сегментирование аналогичных запросов и помогает OpenAI обнаруживать и предотвращать злоупотребление. Подробнее.	Нет
sequence_number	целое число	Порядковый номер этого события.	Да
type	enum	тип события; Всегда `response.incomplete`. Возможные значения: `response.incomplete`	Да

OpenAI.ResponseItemList

Список элементов ответа.

Name	Type	Description	Обязательный
data	массив OpenAI.ItemResource	Список элементов, используемых для создания этого ответа.	Да
первый_идентификатор	строка	Идентификатор первого элемента в списке.	Да
есть_еще	boolean	Доступны ли дополнительные элементы.	Да
last_id	строка	Идентификатор последнего элемента в списке.	Да
object	enum	Тип возвращаемого объекта должен быть `list`. Возможные значения: `list`	Да

OpenAI.ResponseLogProb

Logprob — это логарифмическая вероятность того, что модель назначает определенному маркеру по заданной позиции в последовательности. Менее отрицательные (более высокие) значения logprob указывают на большее доверие модели к выбору маркера.

Name	Type	Description	Обязательный
logprob	number	Вероятность этого токена в журнале.	Да
token	строка	Возможный текстовый маркер.	Да
top_logprobs	массив OpenAI.ResponseLogProbTopLogprobs	Вероятность ведения журнала наиболее вероятных маркеров из 20 лучших.	Нет

OpenAI.ResponseLogProbTopLogprobs

Name	Type	Description	Обязательный	По умолчанию
logprob	number		Нет
token	строка		Нет

OpenAI.ResponseMCPCallArgumentsDeltaEvent

ОтветMCPCallArgumentsDeltaEvent

Выдается, когда происходит разностное (частичное) обновление аргументов вызова средства MCP.

Name	Type	Description	Обязательный
delta	строка	Строка JSON, содержащая частичное обновление аргументов для вызова средства MCP.	Да
item_id	строка	Уникальный идентификатор обрабатываемого элемента вызова средства MCP.	Да
output_index	целое число	Индекс выходного элемента в выходном массиве ответа.	Да
sequence_number	целое число	Порядковый номер этого события.	Да
type	enum	тип события; Всегда "response.mcp_call_arguments.delta". Возможные значения: `response.mcp_call_arguments.delta`	Да

OpenAI.ResponseMCPCallFailedEvent

ResponseMCPCallFailedEvent

Создается при сбое вызова средства MCP.

Name	Type	Description	Обязательный
item_id	строка	Идентификатор элемента вызова средства MCP, который завершился сбоем.	Да
output_index	целое число	Индекс выходного элемента, который завершился сбоем.	Да
sequence_number	целое число	Порядковый номер этого события.	Да
type	enum	тип события; Всегда "response.mcp_call.failed". Возможные значения: `response.mcp_call.failed`	Да

OpenAI.ResponseMCPCallInProgressEvent

ResponseMCPCallInProgressEvent

Испускается в процессе выполнения вызова средства MCP.

Name	Type	Description	Обязательный
item_id	строка	Уникальный идентификатор обрабатываемого элемента вызова средства MCP.	Да
output_index	целое число	Индекс выходного элемента в выходном массиве ответа.	Да
sequence_number	целое число	Порядковый номер этого события.	Да
type	enum	тип события; Всегда "response.mcp_call.in_progress". Возможные значения: `response.mcp_call.in_progress`	Да

OpenAI.ResponseMCPListToolsFailedEvent

ResponseMCPListToolsFailedEvent

Возникает при сбое попытки перечисления доступных средств MCP.

Name	Type	Description	Обязательный
item_id	строка	Идентификатор элемента вызова средства MCP, который завершился сбоем.	Да
output_index	целое число	Индекс выходного элемента, который завершился сбоем.	Да
sequence_number	целое число	Порядковый номер этого события.	Да
type	enum	тип события; Всегда "response.mcp_list_tools.failed". Возможные значения: `response.mcp_list_tools.failed`	Да

OpenAI.ResponseMCPListToolsInProgressEvent

ResponseMCPListToolsInProgressEvent

Подается сигнал, когда система находится в процессе получения списка доступных инструментов MCP.

Name	Type	Description	Обязательный
item_id	строка	Идентификатор обрабатываемого элемента вызова средства MCP.	Да
output_index	целое число	Индекс обрабатываемого выходного элемента.	Да
sequence_number	целое число	Порядковый номер этого события.	Да
type	enum	тип события; Всегда "response.mcp_list_tools.in_progress". Возможные значения: `response.mcp_list_tools.in_progress`	Да

OpenAI.ResponseOutputItemAddedEvent

Создается при добавлении нового выходного элемента.

Name	Type	Description	Обязательный
item	OpenAI.OutputItem		Да
└─ Тип	OpenAI.OutputItemType		Да
output_index	целое число	Индекс добавленного выходного элемента.	Да
sequence_number	целое число	Порядковый номер этого события.	Да
type	enum	тип события; Всегда `response.output_item.added`. Возможные значения: `response.output_item.added`	Да

OpenAI.ResponseOutputTextAnnotationAddedEvent

ResponseOutputTextAnnotationAddedEvent

Создается при добавлении заметки в выходное текстовое содержимое.

Name	Type	Description	Обязательный
Аннотации	OpenAI.Annotation	Заметка, которая применяется к диапазону выходного текста.	Да
└─ Тип	OpenAI.AnnotationType		Да
annotation_index	целое число	Индекс заметки в части содержимого.	Да
content_index	целое число	Индекс части содержимого в выходном элементе.	Да
item_id	строка	Уникальный идентификатор элемента, к которому добавляется заметка.	Да
output_index	целое число	Индекс выходного элемента в выходном массиве ответа.	Да
sequence_number	целое число	Порядковый номер этого события.	Да
type	enum	тип события; Всегда "response.output_text.annotation.added". Возможные значения: `response.output_text.annotation.added`	Да

OpenAI.ResponsePromptVariables

Переменные запросов

Необязательная карта значений для замены переменных в запросе. Значения подстановки могут быть строками или другими типами входных данных ответа, такими как изображения или файлы.

Тип: объект

OpenAI.ResponseQueuedEvent

ResponseQueuedEvent

Возникает, когда ответ поставлен в очередь и ожидает обработки.

Name	Type	Description	Обязательный	По умолчанию
response	OpenAI.Response		Да
└─ Фон	логический или null		Нет
└️ completed_at	строка или null (unixTimestamp)		Нет
└️ content_filters	массив AzureContentFilterForResponsesAPI	Фильтр содержимого приводит к результату RAI.	Да
Беседа └️	OpenAI.ConversationReference или null		Нет
└️ created_at	целое число (UnixTime)	Метка времени в формате Unix (в секундах), когда был создан этот ответ.	Да
└─ Ошибка	OpenAI.ResponseError или null		Да
Идентификатор └️	строка	Уникальный идентификатор для этого ответа.	Да
└️ incomplete_details	OpenAI.ResponseIncompleteDetails или null		Да
└ Инструкции	строка или массив OpenAI.InputItem или null		Да
└️ max_output_tokens	целое число или null		Нет
└️ max_tool_calls	целое число или null		Нет
└─ Метаданные	OpenAI.Metadata или NULL		Нет
└─ Модель	строка	Идентификатор модели, используемый для создания ответа, например `gpt-4o` или `o3`. OpenAI предлагает широкий спектр моделей с разными возможностями, производительностью характеристики и цены. См. руководство по модели для просмотра и сравнения доступных моделей.	Нет
└─ Объект	enum	Тип объекта этого ресурса — всегда установлено `response`. Возможные значения: `response`	Да
вывод └─	массив OpenAI.OutputItem	Массив элементов контента, созданных моделью. — Длина и порядок элементов в массиве `output` зависят в ответе модели. — Вместо доступа к первому элементу массива `output` и Предположим, что это `assistant` сообщение с содержанием, созданным Вы можете рассмотреть возможность использования свойства `output_text` модели, если поддерживается в пакетах SDK.	Да
└️ output_text	строка или null		Нет
└─ вызовы_инструментов_в_параллельном_режиме	boolean	Следует ли разрешить модели запускать вызовы инструментов параллельно.	Да	True
└previous_response_id	строка или null		Нет
└─ Запрос	OpenAI.Prompt	Ссылка на шаблон запроса и его переменные. Подробнее.	Нет
└prompt_cache_key	строка	Используется OpenAI для кэширования ответов для аналогичных запросов для оптимизации частоты попаданий кэша. Заменяет `user` поле. Подробнее.	Нет
└prompt_cache_retention	строка или null		Нет
└─ рассуждения	OpenAI.Reasoning или NULL		Нет
└safety_identifier	строка	Стабильный идентификатор, используемый для обнаружения пользователей приложения, которые могут нарушать политики использования OpenAI. Идентификаторы должны быть строкой, которая однозначно идентифицирует каждого пользователя. Мы рекомендуем хэшировать имя пользователя или адрес электронной почты, чтобы избежать отправки нам каких-либо сведений об идентификации. Подробнее.	Нет
└─ Состояние	enum	Статус формирования ответа. Один из `completed`, `failed` `in_progress`, `cancelled`, `queued` или `incomplete`. Возможные значения: `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete`	Нет
└─ Температура	число или null		Нет	1
Текст └️	OpenAI.ResponseTextParam	Параметры конфигурации для текстового ответа модели. Может быть простым текстовые или структурированные данные JSON. Подробнее: - Текстовые входные и выходные данные - Структурированные выходные данные	Нет
└─ выбор_инструмента	OpenAI.ToolChoiceParam	Как модель должна выбрать инструмент (или средства), которые следует использовать при создании ответ. См. `tools` параметр, чтобы узнать, как указать инструменты Модель может звонить.	Нет
└─ Инструменты	OpenAI.ToolsArray	Массив инструментов, которые модель может вызывать при создании ответа. Вы может указать, какое средство следует использовать, задав `tool_choice` параметр. Мы поддерживаем следующие категории инструментов: - Встроенные инструменты: инструменты, предоставляемые OpenAI для расширения Возможности модели, такие как поиск в Интернете или поиск по файлам. Дополнительные сведения встроенные средства. - Инструменты MCP: интеграция с сторонними системами с помощью пользовательских серверов MCP или предопределенные соединители, такие как Google Drive и SharePoint. Дополнительные сведения Инструменты MCP. - Вызовы функций (пользовательские средства): функции, определенные вами, включение модели для вызова собственного кода с строго типизированными аргументами и выходные данные. Дополнительные сведения вызов функции. Вы также можете использовать пользовательские средства для вызова собственного кода.	Нет
└️ top_logprobs	целое число или null		Нет
└️ top_p	число или null		Нет	1
└️ усечение	строка или null		Нет	disabled
└─ использование	OpenAI.ResponseUsage	Представляет сведения об использовании маркеров, включая входные маркеры, выходные маркеры, разбивка выходных маркеров и общих используемых маркеров.	Нет
Пользователь └️	string (не рекомендуется)	Это поле заменяется `safety_identifier` и `prompt_cache_key`. Вместо этого используйте `prompt_cache_key` для поддержания оптимизации кэширования. Стабильный идентификатор для конечных пользователей. Используется для повышения скорости попадания кэша в более эффективное сегментирование аналогичных запросов и помогает OpenAI обнаруживать и предотвращать злоупотребление. Подробнее.	Нет
sequence_number	целое число	Порядковый номер для этого события.	Да
type	enum	тип события; Всегда «response.queued». Возможные значения: `response.queued`	Да

OpenAI.ResponseReasoningSummaryPartAddedEvent

Выдается при добавлении нового раздела резюме рассуждений.

Name	Type	Description	Обязательный
item_id	строка	Идентификатор элемента, с которым связана эта сводная часть.	Да
output_index	целое число	Индекс выходного элемента, с которым связана сводная часть.	Да
part	OpenAI.ResponseReasoningSummaryPartAddedEventPart		Да
Текст └️	строка		Да
└─ Тип	enum	Возможные значения: `summary_text`	Да
sequence_number	целое число	Порядковый номер этого события.	Да
summary_index	целое число	Индекс сводной части в обобщении рассуждений.	Да
type	enum	тип события; Всегда `response.reasoning_summary_part.added`. Возможные значения: `response.reasoning_summary_part.added`	Да

OpenAI.ResponseReasoningSummaryPartAddedEventPart

Name	Type	Description	Обязательный	По умолчанию
text	строка		Да
type	enum	Возможные значения: `summary_text`	Да

OpenAI.ResponseReasoningSummaryTextDeltaEvent

Создается при добавлении разностного изменения в текст сводной информации.

Name	Type	Description	Обязательный
delta	строка	Изменения текста, добавленные в сводку.	Да
item_id	строка	Идентификатор элемента, с которым связана разность текста сводки.	Да
output_index	целое число	Индекс выходного элемента, с которым связана дельта сводного текста.	Да
sequence_number	целое число	Порядковый номер этого события.	Да
summary_index	целое число	Индекс сводной части в обобщении рассуждений.	Да
type	enum	тип события; Всегда `response.reasoning_summary_text.delta`. Возможные значения: `response.reasoning_summary_text.delta`	Да

OpenAI.ResponseReasoningTextDeltaEvent

Создается при добавлении разностного изменения в текст причины.

Name	Type	Description	Обязательный
content_index	целое число	Индекс части содержимого причины, с которой связана эта разность.	Да
delta	строка	Разностный текст, добавленный в содержимое причины.	Да
item_id	строка	Идентификатор элемента, с которым связан разностный текст.	Да
output_index	целое число	Индекс выходного элемента, с которым связан разностный текст.	Да
sequence_number	целое число	Порядковый номер этого события.	Да
type	enum	тип события; Всегда `response.reasoning_text.delta`. Возможные значения: `response.reasoning_text.delta`	Да

OpenAI.ResponseRefusalDeltaEvent

Срабатывает при наличии частичного текста отказа.

Name	Type	Description	Обязательный
content_index	целое число	Индекс части содержимого, в которую добавляется текст отказа.	Да
delta	строка	Добавлен текст отказа.	Да
item_id	строка	Идентификатор выходного элемента, к которому добавляется текст отказа.	Да
output_index	целое число	Индекс выходного элемента, к которому добавляется текст отказа.	Да
sequence_number	целое число	Порядковый номер этого события.	Да
type	enum	тип события; Всегда `response.refusal.delta`. Возможные значения: `response.refusal.delta`	Да

OpenAI.ResponseStreamOptions

Параметры потоковых ответов. Этот параметр устанавливается только при установке stream: true.

Name	Type	Description	Обязательный	По умолчанию
include_obfuscation	boolean	Если задано значение true, будет включена обфускация потока. Добавляется скрытие потока случайные символы в поле потоковой передачи `obfuscation` событий разностных событий в нормализованные размеры полезных данных в качестве устранения определенных атак на стороне канала. Эти поля маскировки включены по умолчанию, но добавьте небольшое количество. затраты на поток данных. Можно задать `include_obfuscation` значение False для оптимизации пропускной способности, если вы доверяете сетевым каналам между приложение и API OpenAI.	Нет

OpenAI.ResponseTextDeltaEvent

Создается при наличии дополнительного разностного текста.

Name	Type	Description	Обязательный
content_index	целое число	Индекс части содержимого, в которую была добавлена текстовая дельта.	Да
delta	строка	Добавлена разностная строка текста.	Да
item_id	строка	Идентификатор выходного элемента, к которому была добавлена текстовая дельта.	Да
logprobs	массив OpenAI.ResponseLogProb	Вероятности журналов маркеров в разностном формате.	Да
output_index	целое число	Индекс выходного элемента, к которому был добавлен разностный текст.	Да
sequence_number	целое число	Порядковый номер для этого события.	Да
type	enum	тип события; Всегда `response.output_text.delta`. Возможные значения: `response.output_text.delta`	Да

OpenAI.ResponseTextParam

Параметры конфигурации для текстового ответа модели. Можно использовать обычный текст или структурированные данные JSON. Подробнее:

Name	Type	Description	Обязательный	По умолчанию
format	OpenAI.TextResponseFormatConfiguration	Объект, указывающий формат, который должен выводить модель. Настройка `{ "type": "json_schema" }` позволяет использовать структурированные выходные данные, это гарантирует, что модель будет соответствовать предоставленной схеме JSON. Узнайте больше в разделе Формат по умолчанию — это `{ "type": "text" }` без дополнительных параметров. Не рекомендуется использовать для gpt-4o и более новых моделей: Установка `{ "type": "json_object" }` включает старый режим JSON, который гарантирует, что сообщение, которое создает модель, является допустимым JSON. С использованием `json_schema` предпочтителен для моделей, поддерживающих его.	Нет
Детализации	OpenAI.Verbosity	Ограничивает детализацию ответа модели. Более низкие значения будут приводить к более краткие ответы, в то время как более высокие значения приводят к более подробным ответам. В настоящее время поддерживаются `low`значения , `medium`и `high`.	Нет

OpenAI.ResponseUsage

Представляет сведения об использовании маркеров, включая входные маркеры, выходные маркеры, разбивку выходных маркеров и общие используемые маркеры.

Name	Type	Description	Обязательный
input_tokens	целое число	Количество входных токенов.	Да
input_tokens_details	OpenAI.ResponseUsageInputTokensDetails		Да
└ cached_tokens	целое число		Да
output_tokens	целое число	Количество выходных токенов.	Да
output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails		Да
└️ reasoning_tokens	целое число		Да
общее количество токенов	целое число	Общее количество используемых токенов.	Да

OpenAI.ResponseUsageInputTokensDetails

Name	Type	Description	Обязательный	По умолчанию
cached_tokens	целое число		Да

OpenAI.ResponseUsageOutputTokensDetails

Name	Type	Description	Обязательный	По умолчанию
токены рассуждений	целое число		Да

OpenAI.ResponseWebSearchCallInProgressEvent

Примечание. web_search еще недоступен через Azure OpenAI.

Name	Type	Description	Обязательный
item_id	строка	Уникальный идентификатор выходного элемента, связанного с вызовом веб-поиска.	Да
output_index	целое число	Индекс выходного элемента, с которым связан вызов веб-поиска.	Да
sequence_number	целое число	Порядковый номер обрабатываемого вызова поиска в Интернете.	Да
type	enum	тип события; Всегда `response.web_search_call.in_progress`. Возможные значения: `response.web_search_call.in_progress`	Да

OpenAI.ResponseWebSearchCallSearchingEvent

Примечание. web_search еще недоступен через Azure OpenAI.

Name	Type	Description	Обязательный
item_id	строка	Уникальный идентификатор выходного элемента, связанного с вызовом веб-поиска.	Да
output_index	целое число	Индекс выходного элемента, с которым связан вызов веб-поиска.	Да
sequence_number	целое число	Порядковый номер обрабатываемого вызова поиска в Интернете.	Да
type	enum	тип события; Всегда `response.web_search_call.searching`. Возможные значения: `response.web_search_call.searching`	Да

OpenAI.Screenshot

Screenshot

Действие с снимком экрана.

Name	Type	Description	Обязательный	По умолчанию
type	enum	Указывает тип события. Для действия создания снимка экрана это свойство всегда задано значение `screenshot`. Возможные значения: `screenshot`	Да	снимок экрана

OpenAI.Scroll

Scroll

Действие прокрутки.

Name	Type	Description	Обязательный	По умолчанию
scroll_x	целое число	Расстояние горизонтальной прокрутки.	Да
scroll_y	целое число	Расстояние вертикальной прокрутки.	Да
type	enum	Указывает тип события. Для действия прокрутки это свойство имеет значение всегда задано значение `scroll`. Возможные значения: `scroll`	Да	Прокрутки
x	целое число	Координата x, в которой произошла прокрутка.	Да
и	целое число	Координата y, в которой произошла прокрутка.	Да

OpenAI.SearchContextSize

Property	Ценность
Type	строка
Значения	`low` `medium` `high`

OpenAI.SpecificApplyPatchParam

Конкретный выбор инструмента для применения патча

Заставляет модель вызывать средство apply_patch при выполнении вызова средства.

Name	Type	Description	Обязательный	По умолчанию
type	enum	Средство для вызова. Всегда `apply_patch`. Возможные значения: `apply_patch`	Да	apply_patch

OpenAI.SpecificFunctionShellParam

Конкретный выбор инструмента для корпуса

Заставляет модель вызывать средство оболочки при необходимости вызова средства.

Name	Type	Description	Обязательный	По умолчанию
type	enum	Средство для вызова. Всегда `shell`. Возможные значения: `shell`	Да	оболочка

OpenAI.Summary

Краткий текст

Текст сводки из модели.

Name	Type	Description	Обязательный	По умолчанию
text	строка	Сводка по выводу причин модели до сих пор.	Да
type	enum	Тип объекта . Всегда `summary_text`. Возможные значения: `summary_text`	Да	summary_text

OpenAI.TextResponseFormatConfiguration

Объект, указывающий формат, который должен выводить модель. Настройка { "type": "json_schema" } включает структурированные выходные данные, что гарантирует, что модель будет соответствовать предоставленной схеме JSON. Узнайте больше в разделе

Формат по умолчанию — это { "type": "text" } без дополнительных параметров. Не рекомендуется для GPT-4O и более новых моделей: Настройка включает { "type": "json_object" } старый режим JSON, который гарантирует, что сообщение, сгенерируемое моделью, является действительным JSON. Использование json_schema предпочтительнее для моделей, поддерживающих его.

Дискриминация для OpenAI.TextResponseFormatConfiguration

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа	Schema
`json_schema`	OpenAI.TextResponseFormatJsonSchema
`text`	OpenAI.TextResponseFormatConfigurationResponseFormatText
`json_object`	OpenAI.TextResponseFormatConfigurationResponseFormatJsonObject

Name	Type	Description	Обязательный	По умолчанию
type	OpenAI.TextResponseFormatConfigurationType		Да

OpenAI.TextResponseFormatConfigurationResponseFormatJsonObject

Объект JSON

Формат отклика объекта JSON. Старый метод создания ответов JSON. Рекомендуется использовать json_schema для моделей, поддерживающих его. Обратите внимание, что модель не будет создавать JSON без системного или пользовательского сообщения, которое дает ей соответствующую команду.

Name	Type	Description	Обязательный	По умолчанию
type	enum	Тип определяемого формата ответа. Всегда `json_object`. Возможные значения: `json_object`	Да

OpenAI.TextResponseFormatConfigurationResponseFormatText

Текст

Формат ответа по умолчанию. Используется для создания текстовых ответов.

Name	Type	Description	Обязательный	По умолчанию
type	enum	Тип определяемого формата ответа. Всегда `text`. Возможные значения: `text`	Да

OpenAI.TextResponseFormatConfigurationType

Property	Ценность
Type	строка
Значения	`text` `json_schema` `json_object`

OpenAI.TextResponseFormatJsonSchema

Схема JSON

Формат ответа схемы JSON. Используется для создания структурированных ответов JSON. Дополнительные сведения о структурированных выходных данных.

Name	Type	Description	Обязательный
описание	строка	Описание формата ответа, который модель использует для выполнения своих задач. определите, как реагировать в рамках заданного формата.	Нет
имя	строка	Имя формата ответа. Должен содержать латинские буквы a-z, A-Z или цифры 0-9. символы подчеркивания и дефисы с максимальной длиной 64.	Да
schema	OpenAI.ResponseFormatJsonSchema	Схема формата ответа, описанная как объект схемы JSON. Узнайте, как создать схемы JSON здесь.	Да
строгий	логический или null		Нет
type	enum	Тип определяемого формата ответа. Всегда `json_schema`. Возможные значения: `json_schema`	Да

OpenAI.Tool

Средство, которое можно использовать для создания ответа.

Дискриминатор для OpenAI.Инструмент

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа	Schema
`code_interpreter`	OpenAI.CodeInterpreterTool
`function`	OpenAI.FunctionTool
`file_search`	OpenAI.FileSearchTool
`computer_use_preview`	OpenAI.ComputerUsePreviewTool
`web_search`	OpenAI.WebSearchTool
`mcp`	OpenAI.MCPTool
`image_generation`	OpenAI.ImageGenTool
`local_shell`	OpenAI.LocalShellToolParam
`shell`	OpenAI.FunctionShellToolParam
`custom`	OpenAI.CustomToolParam
`web_search_preview`	OpenAI.WebSearchPreviewTool
`apply_patch`	OpenAI.ApplyPatchToolParam

Name	Type	Description	Обязательный	По умолчанию
type	OpenAI.ToolType		Да

OpenAI.ToolChoiceAllowed

Разрешенные средства

Ограничивает средства, доступные для модели, предварительно определенным набором.

Name	Type	Description	Обязательный
mode	enum	Ограничивает средства, доступные для модели, предварительно определенным набором. `auto` позволяет модели выбирать из разрешенных средств и создавать сообщение. `required` требуется, чтобы модель вызывала один или несколько разрешенных средств. Возможные значения: `auto`, `required`	Да
tools	массив объекта	Список определений инструментов, которые модель должна быть разрешена для вызова. Для API ответов список определений инструментов может выглядеть следующим образом: `json<br> [<br> { "type": "function", "name": "get_weather" },<br> { "type": "mcp", "server_label": "deepwiki" },<br> { "type": "image_generation" }<br> ]<br>`	Да
type	enum	Разрешенный тип конфигурации средства. Всегда `allowed_tools`. Возможные значения: `allowed_tools`	Да

OpenAI.ToolChoiceCodeInterpreter

Указывает, что модель должна использовать встроенное средство для создания ответа. Дополнительные сведения о встроенных средствах.

Name	Type	Description	Обязательный	По умолчанию
type	enum	Возможные значения: `code_interpreter`	Да

OpenAI.ToolChoiceComputerUsePreview

Name	Type	Description	Обязательный	По умолчанию
type	enum	Возможные значения: `computer_use_preview`	Да

OpenAI.ToolChoiceCustom

Пользовательский инструмент

Используйте этот параметр для принудительного вызова модели определенного пользовательского инструмента.

Name	Type	Description	Обязательный	По умолчанию
имя	строка	Имя вызываемого пользовательского средства.	Да
type	enum	Для вызова пользовательского инструмента всегда используется `custom`тип. Возможные значения: `custom`	Да

OpenAI.ToolChoiceFileSearch

Name	Type	Description	Обязательный	По умолчанию
type	enum	Возможные значения: `file_search`	Да

OpenAI.ToolChoiceImageGeneration

Name	Type	Description	Обязательный	По умолчанию
type	enum	Возможные значения: `image_generation`	Да

OpenAI.ToolChoiceMCP

Средство MCP

Используйте этот параметр, чтобы принудительно вызвать определенное средство на удаленном сервере MCP.

Name	Type	Description	Обязательный
имя	строка или null		Нет
метка сервера	строка	Метка используемого сервера MCP.	Да
type	enum	Для инструментов MCP тип всегда `mcp`. Возможные значения: `mcp`	Да

OpenAI.ToolChoiceParam

Как модель должна выбрать средство (или инструменты), которое следует использовать при создании ответа. Просмотрите tools параметр, чтобы узнать, как указать, какие средства модель может вызывать.

Дискриминация для OpenAI.ToolChoiceParam

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа	Schema
`allowed_tools`	OpenAI.ToolChoiceAllowed
`mcp`	OpenAI.ToolChoiceMCP
`custom`	OpenAI.ToolChoiceCustom
`apply_patch`	OpenAI.SpecificApplyPatchParam
`shell`	OpenAI.SpecificFunctionShellParam
`file_search`	OpenAI.ToolChoiceFileSearch
`web_search_preview`	OpenAI.ToolChoiceWebSearchPreview
`computer_use_preview`	OpenAI.ToolChoiceComputerUsePreview
`web_search_preview_2025_03_11`	OpenAI.ToolChoiceWebSearchPreview20250311
`image_generation`	OpenAI.ToolChoiceImageGeneration
`code_interpreter`	OpenAI.ToolChoiceCodeInterpreter

Name	Type	Description	Обязательный	По умолчанию
type	OpenAI.ToolChoiceParamType		Да

OpenAI.ToolChoiceParamType

Property	Ценность
Type	строка
Значения	`allowed_tools` `function` `mcp` `custom` `apply_patch` `shell` `file_search` `web_search_preview` `computer_use_preview` `web_search_preview_2025_03_11` `image_generation` `code_interpreter`

OpenAI.ToolChoiceWebSearchPreview

Примечание. web_search еще недоступен через Azure OpenAI.

Name	Type	Description	Обязательный	По умолчанию
type	enum	Возможные значения: `web_search_preview`	Да

OpenAI.ToolChoiceWebSearchPreview20250311

Name	Type	Description	Обязательный	По умолчанию
type	enum	Возможные значения: `web_search_preview_2025_03_11`	Да

OpenAI.ToolType

Property	Ценность
Type	строка
Значения	`function` `file_search` `computer_use_preview` `web_search` `mcp` `code_interpreter` `image_generation` `local_shell` `shell` `custom` `web_search_preview` `apply_patch`

OpenAI.ToolsArray

Массив инструментов, которые модель может вызывать при создании ответа. Можно указать, какое средство следует использовать, задав tool_choice параметр. Мы поддерживаем следующие категории инструментов:

Встроенные средства: средства, предоставляемые OpenAI, которые расширяют возможности модели, такие как поиск в Интернете или поиск по файлам. Дополнительные сведения о встроенных средствах.
MCP Tools: интеграция с сторонними системами с помощью пользовательских серверов MCP или предопределенных соединителей, таких как Google Drive и SharePoint. Дополнительные сведения о средствах MCP.
Вызовы функций (пользовательские средства): функции, определенные вами, что позволяет модели вызывать собственный код с строго типизированными аргументами и выходными данными. Дополнительные сведения о вызове функции. Вы также можете использовать пользовательские средства для вызова собственного кода.

Массив: OpenAI.Tool

OpenAI.TopLogProb

Вероятность верхнего логарифма

Максимальная логарифмическая вероятность токена.

Name	Type	Обязательный
байт	массив целых чисел	Да
logprob	number	Да
token	строка	Да

OpenAI.Type

Type

Действие для ввода текста.

Name	Type	Description	Обязательный	По умолчанию
text	строка	Текст для набора.	Да
type	enum	Указывает тип события. Для действия типа это свойство равно всегда задано значение `type`. Возможные значения: `type`	Да	type

OpenAI.UrlCitationBody

Ссылка на URL

Ссылка на веб-ресурс, используемый для создания ответа модели.

Name	Type	Description	Обязательный	По умолчанию
end_index	целое число	Индекс последнего символа ссылки URL-адреса в сообщении.	Да
start_index	целое число	Индекс первого символа ссылки URL-адреса в сообщении.	Да
title	строка	Заголовок веб-ресурса.	Да
type	enum	Тип URL-ссылки. Всегда `url_citation`. Возможные значения: `url_citation`	Да	url_citation
url	string (URI)	URL-адрес веб-ресурса.	Да

OpenAI.VectorStoreFileAttributes

Набор из 16 пар "ключ-значение", которые можно прикрепить к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате и запроса на объекты через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения могут быть строками с максимальной длиной 512 символов, логическими значениями или числами.

Тип: объект

OpenAI.Verbosity

Ограничивает детализацию ответа модели. Более низкие значения приводят к более кратким ответам, в то время как более подробные значения приводят к более подробным ответам. В настоящее время поддерживаются lowзначения , mediumи high.

Property	Ценность
Description	Ограничивает детализацию ответа модели. Более низкие значения приводят к более кратким ответам, в то время как более подробные значения приводят к более подробным ответам. В настоящее время поддерживаются `low`значения , `medium`и `high`.
Type	строка
Значения	`low` `medium` `high`

OpenAI.Wait

Ожидание

Действие ожидания.

Name	Type	Description	Обязательный	По умолчанию
type	enum	Указывает тип события. Для действия ожидания это свойство устанавливается как всегда задано значение `wait`. Возможные значения: `wait`	Да	wait

OpenAI.WebSearchActionFind

Найти экшн

Тип действия "find": выполняет поиск шаблона на загруженной странице.

Name	Type	Description	Обязательный
pattern	строка	Шаблон или текст для поиска на странице.	Да
type	enum	Тип действия. Возможные значения: `find_in_page`	Да
url	string (URI)	URL-адрес страницы, где искали шаблон.	Да

OpenAI.WebSearchActionOpenPage

Действие открытия страницы

Тип действия "open_page" — открывает определенный URL-адрес из результатов поиска.

Name	Type	Description	Обязательный	По умолчанию
type	enum	Тип действия. Возможные значения: `open_page`	Да
url	string (URI)	URL-адрес, открытый моделью.	Да

OpenAI.WebSearchActionSearch

Поисковые действия

Тип действия "поиск" — выполняет запрос веб-поиска.

Name	Type	Description	Обязательный
queries	массив строк	Поисковые запросы.	Нет
query	string (не рекомендуется)	[НЕ РЕКОМЕНДУЕТСЯ] Поисковый запрос.	Да
Источников	массив OpenAI.WebSearchActionSearchSources	Источники, используемые в поиске.	Нет
type	enum	Тип действия. Возможные значения: `search`	Да

OpenAI.WebSearchActionSearchSources

Name	Type	Description	Обязательный	По умолчанию
type	enum	Возможные значения: `url`	Да
url	строка		Да

OpenAI.WebSearchApproximateLocation

Приблизительное местоположение поиска в интернете

Приблизительное расположение пользователя.

Name	Type	Description	Обязательный	По умолчанию
Города	строка или null		Нет
страна	строка или null		Нет
region	строка или null		Нет
timezone	строка или null		Нет
type	enum	Тип приближения расположения. Всегда `approximate`. Возможные значения: `approximate`	Нет	Приблизительное

OpenAI.WebSearchPreviewTool

Превью веб-поиска

Примечание. web_search еще недоступен через Azure OpenAI.

Name	Type	Description	Обязательный	По умолчанию
размер_контекста_поиска	OpenAI.SearchContextSize		Нет
type	enum	Тип средства поиска в Интернете. Одно из `web_search_preview` или `web_search_preview_2025_03_11`. Возможные значения: `web_search_preview`	Да	web_search_preview
местоположение пользователя	OpenAI.ApproximateLocation или NULL		Нет

OpenAI.WebSearchTool

Поиск в Интернете

Примечание. web_search еще недоступен через Azure OpenAI.

Name	Type	Description	Обязательный	По умолчанию
Фильтры	OpenAI.WebSearchToolFilters или null		Нет
размер_контекста_поиска	enum	Рекомендации высокого уровня для объема пространства контекстного окна, используемого для поиска. Один из `low`, `medium`или `high`. `medium` — значение по умолчанию. Возможные значения: `low`, `mediumhigh`	Нет	medium
type	enum	Тип средства поиска в Интернете. Одно из `web_search` или `web_search_2025_08_26`. Возможные значения: `web_search`	Да	веб-поиск
местоположение пользователя	OpenAI.WebSearchApproximateLocation или null		Нет

OpenAI.WebSearchToolFilters

Name	Type	Description	Обязательный	По умолчанию
allowed_domains	массив строк или null		Нет

Last updated on 2026-06-12