Microsoft Foundry

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

Authentication

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

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

Области:

• https://ai.azure.com/.default

Агенты

Агенты — создание агента

POST {endpoint}/agents?api-version=v1

Создает агент.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
версия API	query	Да	строка	Версия API, используемая для данной операции.

Заголовок запроса

Name	Обязательный	Type	Description
Foundry-Features	Неправда	строка Возможные значения: ContainerAgents=V1Preview, HostedAgents=V1PreviewWorkflowAgents=V1Preview	Флаг функции, необходимый при использовании операций предварительной версии или изменении сохраненных ресурсов предварительной версии.

Тело запроса

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

Name	Type	Description	Обязательный	По умолчанию
Определение	AgentDefinition		Да
└️ вид	AgentKind		Да
└️ rai_config	RaiConfig	Конфигурация для фильтрации содержимого и функций безопасности Responsible AI (RAI).	Нет
описание	строка	Понятное описание агента. Ограничения: maxLength: 512	Нет
metadata	object	Набор из 16 пар "ключ-значение", которые можно прикрепить к объекту. Это может быть Полезно для хранения дополнительных сведений об объекте в структурированном виде. форматирование и запрос объектов через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — строки с максимальной длиной 512 символов.	Нет
имя	строка	Уникальное имя, определяющее агент. Имя может быть использовано для получения/обновления/удаления агента. — должно начинаться и заканчиваться буквенно-цифровыми символами, - Может содержать дефисы в середине — не должно превышать 63 символов. Ограничения: maxLength: 63	Да

Responses

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

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

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

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

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

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

Агенты — агенты списка

GET {endpoint}/agents?api-version=v1

Возвращает список всех агентов.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
kind	query	Нет	строка Возможные значения: prompt, , hostedcontainer_appworkflow	Фильтрация агентов по типу. В противном случае возвращаются все агенты.
limit	query	Нет	целое число	Ограничение количества возвращаемых объектов. Ограничение может варьироваться от 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, чтобы получить предыдущую страницу списка.
версия API	query	Да	строка	Версия API, используемая для данной операции.

Responses

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

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

Тип содержимого	Type	Description
application/json	object	Данные ответа для запрошенного списка элементов.

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

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

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

Агенты — получение агента

GET {endpoint}/agents/{agent_name}?api-version=v1

Извлекает агента.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Да	строка	Имя извлекаемого агента.
версия API	query	Да	строка	Версия API, используемая для данной операции.

Responses

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

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

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

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

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

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

Агенты — агент обновления

POST {endpoint}/agents/{agent_name}?api-version=v1

Обновляет агент путем добавления новой версии, если в определение агента вносятся какие-либо изменения. Если изменений нет, возвращается существующая версия агента.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Да	строка	Имя извлекаемого агента.
версия API	query	Да	строка	Версия API, используемая для данной операции.

Заголовок запроса

Name	Обязательный	Type	Description
Foundry-Features	Неправда	строка Возможные значения: ContainerAgents=V1Preview, HostedAgents=V1PreviewWorkflowAgents=V1Preview	Флаг функции, необходимый при использовании операций предварительной версии или изменении сохраненных ресурсов предварительной версии.

Тело запроса

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

Name	Type	Description	Обязательный	По умолчанию
Определение	AgentDefinition		Да
└️ вид	AgentKind		Да
└️ rai_config	RaiConfig	Конфигурация для фильтрации содержимого и функций безопасности Responsible AI (RAI).	Нет
описание	строка	Понятное описание агента. Ограничения: maxLength: 512	Нет
metadata	object	Набор из 16 пар "ключ-значение", которые можно прикрепить к объекту. Это может быть Полезно для хранения дополнительных сведений об объекте в структурированном виде. форматирование и запрос объектов через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — строки с максимальной длиной 512 символов.	Нет

Responses

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

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

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

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

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

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

Агенты — удаление агента

DELETE {endpoint}/agents/{agent_name}?api-version=v1

Удаляет агент.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Да	строка	Имя агента для удаления.
версия API	query	Да	строка	Версия API, используемая для данной операции.

Responses

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

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

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

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

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

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

Агенты — обновление агента из манифеста

POST {endpoint}/agents/{agent_name}/import?api-version=v1

Обновляет агент из манифеста, добавив новую версию, если в определении агента есть какие-либо изменения. Если изменений нет, возвращается существующая версия агента.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Да	строка	Имя агента для обновления.
версия API	query	Да	строка	Версия API, используемая для данной операции.

Тело запроса

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

Name	Type	Description	Обязательный	По умолчанию
описание	строка	Понятное описание агента. Ограничения: maxLength: 512	Нет
manifest_id	строка	Идентификатор манифеста для импорта версии агента из.	Да
metadata	object	Набор из 16 пар "ключ-значение", которые можно прикрепить к объекту. Это может быть Полезно для хранения дополнительных сведений об объекте в структурированном виде. форматирование и запрос объектов через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — строки с максимальной длиной 512 символов.	Нет
parameter_values	object	Входные данные манифеста, которые будут приводить к полностью материализованному агенту.	Да

Responses

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

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

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

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

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

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

Агенты — создание версии агента

POST {endpoint}/agents/{agent_name}/versions?api-version=v1

Создайте новую версию агента.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Да	строка	Уникальное имя, определяющее агент. Имя может быть использовано для получения/обновления/удаления агента. — должно начинаться и заканчиваться буквенно-цифровыми символами, - Может содержать дефисы в середине — не должно превышать 63 символов.
версия API	query	Да	строка	Версия API, используемая для данной операции.

Заголовок запроса

Name	Обязательный	Type	Description
Foundry-Features	Неправда	строка Возможные значения: ContainerAgents=V1Preview, HostedAgents=V1PreviewWorkflowAgents=V1Preview	Флаг функции, необходимый при использовании операций предварительной версии или изменении сохраненных ресурсов предварительной версии.

Тело запроса

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

Name	Type	Description	Обязательный	По умолчанию
Определение	AgentDefinition		Да
└️ вид	AgentKind		Да
└️ rai_config	RaiConfig	Конфигурация для фильтрации содержимого и функций безопасности Responsible AI (RAI).	Нет
описание	строка	Понятное описание агента. Ограничения: maxLength: 512	Нет
metadata	object	Набор из 16 пар "ключ-значение", которые можно прикрепить к объекту. Это может быть Полезно для хранения дополнительных сведений об объекте в структурированном виде. форматирование и запрос объектов через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — строки с максимальной длиной 512 символов.	Нет

Responses

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

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

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

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

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

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

Агенты — версии агента списка

GET {endpoint}/agents/{agent_name}/versions?api-version=v1

Возвращает список версий агента.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Да	строка	Имя агента, для которого требуется получить версии.
limit	query	Нет	целое число	Ограничение количества возвращаемых объектов. Ограничение может варьироваться от 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, чтобы получить предыдущую страницу списка.
версия API	query	Да	строка	Версия API, используемая для данной операции.

Responses

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

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

Тип содержимого	Type	Description
application/json	object	Данные ответа для запрошенного списка элементов.

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

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

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

Агенты — получение версии агента

GET {endpoint}/agents/{agent_name}/versions/{agent_version}?api-version=v1

Извлекает определенную версию агента.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Да	строка	Имя извлекаемого агента.
agent_version	path	Да	строка	Версия извлекаемого агента.
версия API	query	Да	строка	Версия API, используемая для данной операции.

Responses

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

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

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

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

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

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

Агенты — удаление версии агента

DELETE {endpoint}/agents/{agent_name}/versions/{agent_version}?api-version=v1

Удаляет определенную версию агента.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Да	строка	Имя агента для удаления.
agent_version	path	Да	строка	Версия агента для удаления
версия API	query	Да	строка	Версия API, используемая для данной операции.

Responses

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

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

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

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

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

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

Агенты — создание версии агента из манифеста

POST {endpoint}/agents/{agent_name}/versions:import?api-version=v1

Создайте новую версию агента из манифеста.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Да	строка	Уникальное имя, определяющее агент. Имя может быть использовано для получения/обновления/удаления агента. — должно начинаться и заканчиваться буквенно-цифровыми символами, - Может содержать дефисы в середине — не должно превышать 63 символов.
версия API	query	Да	строка	Версия API, используемая для данной операции.

Тело запроса

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

Name	Type	Description	Обязательный	По умолчанию
описание	строка	Понятное описание агента. Ограничения: maxLength: 512	Нет
manifest_id	строка	Идентификатор манифеста для импорта версии агента из.	Да
metadata	object	Набор из 16 пар "ключ-значение", которые можно прикрепить к объекту. Это может быть Полезно для хранения дополнительных сведений об объекте в структурированном виде. форматирование и запрос объектов через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — строки с максимальной длиной 512 символов.	Нет
parameter_values	object	Входные данные манифеста, которые будут приводить к полностью материализованному агенту.	Да

Responses

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

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

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

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

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

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

Агенты — создание агента из манифеста

POST {endpoint}/agents:import?api-version=v1

Создает агента из манифеста.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
версия API	query	Да	строка	Версия API, используемая для данной операции.

Тело запроса

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

Name	Type	Description	Обязательный	По умолчанию
описание	строка	Понятное описание агента. Ограничения: maxLength: 512	Нет
manifest_id	строка	Идентификатор манифеста для импорта версии агента из.	Да
metadata	object	Набор из 16 пар "ключ-значение", которые можно прикрепить к объекту. Это может быть Полезно для хранения дополнительных сведений об объекте в структурированном виде. форматирование и запрос объектов через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — строки с максимальной длиной 512 символов.	Нет
имя	строка	Уникальное имя, определяющее агент. Имя может быть использовано для получения/обновления/удаления агента. — должно начинаться и заканчиваться буквенно-цифровыми символами, - Может содержать дефисы в середине — не должно превышать 63 символов. Ограничения: maxLength: 63	Да
parameter_values	object	Входные данные манифеста, которые будут приводить к полностью материализованному агенту.	Да

Responses

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

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

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

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

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

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

Контейнеры агентов

Контейнеры агента — операции контейнера агента списка

GET {endpoint}/agents/{agent_name}/operations?api-version=v1

Вывод списка операций контейнера для агента.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Да	строка	Имя агента.
limit	query	Нет	целое число	Ограничение количества возвращаемых объектов. Ограничение может варьироваться от 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, чтобы получить предыдущую страницу списка.
версия API	query	Да	строка	Версия API, используемая для данной операции.

Заголовок запроса

Name	Обязательный	Type	Description
Foundry-Features	Неправда	строка Возможные значения: ContainerAgents=V1Preview	Флаг функции, необходимый при использовании операций предварительной версии или изменении сохраненных ресурсов предварительной версии.

Responses

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

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

Тип содержимого	Type	Description
application/json	object	Данные ответа для запрошенного списка элементов.

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

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

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

Контейнеры агента — получение операции контейнера агента

GET {endpoint}/agents/{agent_name}/operations/{operation_id}?api-version=v1

Получение состояния операции контейнера для агента.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Да	строка	Имя агента.
operation_id	path	Да	строка	Идентификатор операции.
версия API	query	Да	строка	Версия API, используемая для данной операции.

Заголовок запроса

Name	Обязательный	Type	Description
Foundry-Features	Неправда	строка Возможные значения: ContainerAgents=V1Preview	Флаг функции, необходимый при использовании операций предварительной версии или изменении сохраненных ресурсов предварительной версии.

Responses

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

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

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

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

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

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

Контейнеры агента — получение контейнера агента

GET {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default?api-version=v1

Получите контейнер для определенной версии агента.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Да	строка	Имя агента.
agent_version	path	Да	строка	Версия агента.
версия API	query	Да	строка	Версия API, используемая для данной операции.

Заголовок запроса

Name	Обязательный	Type	Description
Foundry-Features	Неправда	строка Возможные значения: ContainerAgents=V1Preview	Флаг функции, необходимый при использовании операций предварительной версии или изменении сохраненных ресурсов предварительной версии.

Responses

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

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

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

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

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

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

Контейнеры агента — операции контейнера версии агента списка

GET {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default/operations?api-version=v1

Вывод списка операций контейнера для определенной версии агента.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Да	строка	Имя агента.
agent_version	path	Да	строка	Версия агента.
limit	query	Нет	целое число	Ограничение количества возвращаемых объектов. Ограничение может варьироваться от 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, чтобы получить предыдущую страницу списка.
версия API	query	Да	строка	Версия API, используемая для данной операции.

Заголовок запроса

Name	Обязательный	Type	Description
Foundry-Features	Неправда	строка Возможные значения: ContainerAgents=V1Preview	Флаг функции, необходимый при использовании операций предварительной версии или изменении сохраненных ресурсов предварительной версии.

Responses

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

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

Тип содержимого	Type	Description
application/json	object	Данные ответа для запрошенного списка элементов.

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

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

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

Контейнеры агента — удаление контейнера агента

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:delete?api-version=v1

Удалите контейнер для определенной версии агента. Если контейнер не существует, операция будет no-op. Операция является длительной операцией. Следуя рекомендациям по проектированию для длительных операций в Azure REST API. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Да	строка	Имя агента.
agent_version	path	Да	строка	Версия агента.
версия API	query	Да	строка	Версия API, используемая для данной операции.

Заголовок запроса

Name	Обязательный	Type	Description
Foundry-Features	Неправда	строка Возможные значения: ContainerAgents=V1Preview	Флаг функции, необходимый при использовании операций предварительной версии или изменении сохраненных ресурсов предварительной версии.

Responses

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

Описание. Запрос был принят для обработки, но обработка еще не завершена.

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

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

Заголовка	Type	Description
Операция-Местоположение	строка

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

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

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

Контейнеры агентов — журналы контейнеров агента потоковой передачи

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:logstream?api-version=v1

Запись журнала контейнеров, потоковая из контейнера в виде фрагментов текста. Каждая часть — это строка UTF-8, которая может быть строкой журнала обычного текста или записью в формате JSON в зависимости от типа потокового журнала контейнера. Клиенты должны рассматривать каждый блок как непрозрачный текст и при необходимости пытаться проанализировать его как JSON на основе требований к ведению журнала.

Для системных журналов Формат JSON имеет следующую структуру: {"TimeStamp":"2025-12-15T16:51:33Z","Type":"Normal","ContainerAppName":null,"VersionName":NULL,"ReplicaName":"Msg":"Подключение к сборщику событий...", "Причина":"StartingGettingEvent","EventSource":"ContainerAppController","Count":1} {"TimeStamp":"2025-12-15T16:51:51:34Z","Type":"Normal","ContainerAppName":null,"RevisionName":null,"ReplicaName":null,"Msg":"Успешно подключен к событиям server","Reason":"ConnectedToEventsServer","EventSource":"ContainerAppController","Count":1}

Для журналов консоли формат представляет собой обычный текст, создаваемый stdout/stderr контейнера. 2025-12-15T08:43:48.72656 Подключение к контейнеру "agent-container"... 2025-12-15T08:43:48.75451 Successfully Connected to container: 'agent-container' [Revision: 'je90fe655aa742ef9a188b9fd14d6764--7tca06b', Replica: 'je90fe655aa742ef9a188b9fd14d6764--7tca06b-6898b9c89f-mpkjc'] 2025-12-15T08:33:59.0671054Z stdout F INFO: 127.0.0.1:42588 - "GET /readiness HTTP/1.1" 200 OK 2025-12-15T08:34:29.0649033Z stdout F INFO: 127.0.0.1:60246 - "GET /readiness HTTP/1.1" 200 OK 2025-12-15T08:34:59.0644467Z stdout F INFO: 127.0.0.1:43994 - "GET /readiness HTTP/1.1" 200 OK

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Да	строка	Имя агента.
agent_version	path	Да	строка	Версия агента.
kind	query	Нет	строка Возможные значения: console, system	консоль возвращает контейнер stdout/stderr, система возвращает поток событий приложения-контейнера. значение по умолчанию для консоли
replica_name	query	Нет	строка	Если параметр не указан, сервер выбирает первую реплику для консольных журналов. Требуется нацелиться на конкретную реплику.
хвост	query	Нет	целое число	Число возвращаемых конечных строк. Применяется к 1-300. Значение по умолчанию — 20
версия API	query	Да	строка	Версия API, используемая для данной операции.

Заголовок запроса

Name	Обязательный	Type	Description
Foundry-Features	Неправда	строка Возможные значения: ContainerAgents=V1Preview	Флаг функции, необходимый при использовании операций предварительной версии или изменении сохраненных ресурсов предварительной версии.

Responses

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

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

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

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

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

Контейнеры агента — запуск контейнера агента

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:start?api-version=v1

Запустите контейнер для определенной версии агента. Если контейнер уже запущен, операция будет no-op. Операция является длительной операцией. Следуя рекомендациям по проектированию для длительных операций в Azure REST API. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Да	строка	Имя агента.
agent_version	path	Да	строка	Версия агента.
версия API	query	Да	строка	Версия API, используемая для данной операции.

Заголовок запроса

Name	Обязательный	Type	Description
Foundry-Features	Неправда	строка Возможные значения: ContainerAgents=V1Preview	Флаг функции, необходимый при использовании операций предварительной версии или изменении сохраненных ресурсов предварительной версии.

Тело запроса

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

Name	Type	Description	Обязательный	По умолчанию
max_replicas	целое число	Максимальное количество реплик. По умолчанию равен 1.	Нет	1
min_replicas	целое число	Минимальное количество реплик. По умолчанию равен 1.	Нет	1

Responses

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

Описание. Запрос был принят для обработки, но обработка еще не завершена.

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

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

Заголовка	Type	Description
Операция-Местоположение	строка

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

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

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

Контейнеры агента — контейнер агента остановки

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:stop?api-version=v1

Остановите контейнер для определенной версии агента. Если контейнер не запущен или уже остановлен, операция будет no-op. Операция является длительной операцией. Следуя рекомендациям по проектированию для длительных операций в Azure REST API. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Да	строка	Имя агента.
agent_version	path	Да	строка	Версия агента.
версия API	query	Да	строка	Версия API, используемая для данной операции.

Заголовок запроса

Name	Обязательный	Type	Description
Foundry-Features	Неправда	строка Возможные значения: ContainerAgents=V1Preview	Флаг функции, необходимый при использовании операций предварительной версии или изменении сохраненных ресурсов предварительной версии.

Responses

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

Описание. Запрос был принят для обработки, но обработка еще не завершена.

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

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

Заголовка	Type	Description
Операция-Местоположение	строка

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

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

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

Контейнеры агента — контейнер агента обновления

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:update?api-version=v1

Обновите контейнер для определенной версии агента. Если контейнер не запущен, операция будет no-op. Операция является длительной операцией. Следуя рекомендациям по проектированию для длительных операций в Azure REST API. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Да	строка	Имя агента.
agent_version	path	Да	строка	Версия агента.
версия API	query	Да	строка	Версия API, используемая для данной операции.

Заголовок запроса

Name	Обязательный	Type	Description
Foundry-Features	Неправда	строка Возможные значения: ContainerAgents=V1Preview	Флаг функции, необходимый при использовании операций предварительной версии или изменении сохраненных ресурсов предварительной версии.

Тело запроса

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

Name	Type	Description	Обязательный	По умолчанию
max_replicas	целое число	Максимальное количество реплик.	Нет
min_replicas	целое число	Минимальное количество реплик.	Нет

Responses

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

Описание. Запрос был принят для обработки, но обработка еще не завершена.

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

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

Заголовка	Type	Description
Операция-Местоположение	строка

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

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

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

Connections

Подключения — список

GET {endpoint}/connections?api-version=v1

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

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
версия API	query	Да	строка	Версия API, используемая для данной операции.
тип соединения	query	Нет	строка Возможные значения: AzureOpenAI, AzureBlob, AzureStorageAccount, CognitiveSearch, CosmosDB, ApiKey, AppConfig, AppInsights, CustomKeys, RemoteTool_Preview	Перечисление подключений этого конкретного типа
defaultConnection	query	Нет	boolean	Вывод списка подключений, которые являются подключениями по умолчанию

Заголовок запроса

Name	Обязательный	Type	Description
x-ms-client-request-id	Неправда	строка	Непрозрачный, глобально уникальный, созданный клиентом идентификатор строки для запроса.

Responses

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

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

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

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

Заголовка	Type	Description
x-ms-client-request-id		Непрозрачный, глобально уникальный, созданный клиентом идентификатор строки для запроса.

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

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

Тип содержимого	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

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

Заголовка	Type	Description
X-ms-error-code	строка	Код строковой ошибки, указывающий на то, что произошло неправильно.

Подключения — получение

GET {endpoint}/connections/{name}?api-version=v1

Получение подключения по имени без заполнения учетных данных подключения

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
версия API	query	Да	строка	Версия API, используемая для данной операции.
имя	path	Да	строка	Понятное имя подключения, предоставленное пользователем.

Заголовок запроса

Name	Обязательный	Type	Description
x-ms-client-request-id	Неправда	строка	Непрозрачный, глобально уникальный, созданный клиентом идентификатор строки для запроса.

Responses

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

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

Тип содержимого	Type	Description
application/json	Подключение

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

Заголовка	Type	Description
x-ms-client-request-id		Непрозрачный, глобально уникальный, созданный клиентом идентификатор строки для запроса.

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

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

Тип содержимого	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

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

Заголовка	Type	Description
X-ms-error-code	строка	Код строковой ошибки, указывающий на то, что произошло неправильно.

Подключения — получение учетных данных

POST {endpoint}/connections/{name}/getConnectionWithCredentials?api-version=v1

Получение подключения по имени с учетными данными подключения

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
версия API	query	Да	строка	Версия API, используемая для данной операции.
имя	path	Да	строка	Понятное имя подключения, предоставленное пользователем.

Заголовок запроса

Name	Обязательный	Type	Description
x-ms-client-request-id	Неправда	строка	Непрозрачный, глобально уникальный, созданный клиентом идентификатор строки для запроса.

Responses

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

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

Тип содержимого	Type	Description
application/json	Подключение

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

Заголовка	Type	Description
x-ms-client-request-id		Непрозрачный, глобально уникальный, созданный клиентом идентификатор строки для запроса.

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

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

Тип содержимого	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

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

Заголовка	Type	Description
X-ms-error-code	строка	Код строковой ошибки, указывающий на то, что произошло неправильно.

Datasets

Наборы данных — список последних версий

GET {endpoint}/datasets?api-version=v1

Список последней версии каждого набора данных

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
версия API	query	Да	строка	Версия API, используемая для данной операции.

Responses

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

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

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

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

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

Тип содержимого	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

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

Заголовка	Type	Description
X-ms-error-code	строка	Код строковой ошибки, указывающий на то, что произошло неправильно.

Наборы данных — версии списка

GET {endpoint}/datasets/{name}/versions?api-version=v1

Вывод списка всех версий заданного набора данных

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
версия API	query	Да	строка	Версия API, используемая для данной операции.
имя	path	Да	строка	Имя ресурса.

Responses

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

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

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

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

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

Тип содержимого	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

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

Заголовка	Type	Description
X-ms-error-code	строка	Код строковой ошибки, указывающий на то, что произошло неправильно.

Наборы данных — получение версии

GET {endpoint}/datasets/{name}/versions/{version}?api-version=v1

Получите определенную версию DatasetVersion. Служба возвращает ошибку 404 Not Found, если datasetVersion не существует.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
версия API	query	Да	строка	Версия API, используемая для данной операции.
имя	path	Да	строка	Имя ресурса.
version	path	Да	строка	Идентификатор конкретной версии извлекаемого набора данных.

Responses

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

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

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

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

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

Тип содержимого	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

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

Заголовка	Type	Description
X-ms-error-code	строка	Код строковой ошибки, указывающий на то, что произошло неправильно.

Наборы данных — удаление версии

DELETE {endpoint}/datasets/{name}/versions/{version}?api-version=v1

Удалите определенную версию DatasetVersion. Служба возвращает значение 204 No Content, если datasetVersion был успешно удален или если datasetVersion не существует.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
версия API	query	Да	строка	Версия API, используемая для данной операции.
имя	path	Да	строка	Имя ресурса.
version	path	Да	строка	Версия набора данных Для удаления.

Responses

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

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

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

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

Тип содержимого	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

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

Заголовка	Type	Description
X-ms-error-code	строка	Код строковой ошибки, указывающий на то, что произошло неправильно.

Наборы данных — создание или обновление версии

PATCH {endpoint}/datasets/{name}/versions/{version}?api-version=v1

Создание нового или обновление существующего набора данных с указанным идентификатором версии

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
версия API	query	Да	строка	Версия API, используемая для данной операции.
имя	path	Да	строка	Имя ресурса.
version	path	Да	строка	Идентификатор конкретной версии datasetVersion для создания или обновления.

Тело запроса

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

Name	Type	Description	Обязательный	По умолчанию
описание	строка	Текст описания ресурса.	Нет
tags	object	Словарь тегов. Теги можно добавлять, удалять и обновлять.	Нет
type	DatasetType	Перечисление для определения типа данных.	Да

Responses

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

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

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

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

Описание: запрос успешно выполнен, и в результате был создан новый ресурс.

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

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

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

Тип содержимого	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

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

Заголовка	Type	Description
X-ms-error-code	строка	Код строковой ошибки, указывающий на то, что произошло неправильно.

Наборы данных — получение учетных данных

POST {endpoint}/datasets/{name}/versions/{version}/credentials?api-version=v1

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

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
версия API	query	Да	строка	Версия API, используемая для данной операции.
имя	path	Да	строка	Имя ресурса.
version	path	Да	строка	Идентификатор конкретной версии datasetVersion для работы.

Responses

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

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

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

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

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

Тип содержимого	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

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

Заголовка	Type	Description
X-ms-error-code	строка	Код строковой ошибки, указывающий на то, что произошло неправильно.

Наборы данных — запуск ожидающей отправки версии

POST {endpoint}/datasets/{name}/versions/{version}/startPendingUpload?api-version=v1

Запустите новую или получите существующую ожидающий отправку набора данных для определенной версии.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
версия API	query	Да	строка	Версия API, используемая для данной операции.
имя	path	Да	строка	Имя ресурса.
version	path	Да	строка	Идентификатор конкретной версии datasetVersion для работы.

Тело запроса

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

Name	Type	Description	Обязательный	По умолчанию
connectionName	строка	Имя подключения учетной записи хранения Azure для создания временного маркера SAS	Нет
pendingUploadId	строка	Если PendingUploadId не указан, будет использоваться случайный идентификатор GUID.	Нет
pendingUploadType	enum	BlobReference — единственный поддерживаемый тип. Возможные значения: BlobReference	Да

Responses

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

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

Тип содержимого	Type	Description
application/json	ОжиданиеUploadResponse

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

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

Тип содержимого	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

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

Заголовка	Type	Description
X-ms-error-code	строка	Код строковой ошибки, указывающий на то, что произошло неправильно.

Развертывания

Развертывания — список

GET {endpoint}/deployments?api-version=v1

Список всех развернутых моделей в проекте

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
версия API	query	Да	строка	Версия API, используемая для данной операции.
modelPublisher	query	Нет	строка	Издатель моделей для фильтрации моделей по
modelName	query	Нет	строка	Имя модели (конкретное имя издателя) для фильтрации моделей по
deploymentType	query	Нет	строка Возможные значения: ModelDeployment	Тип развертывания для фильтрации списка по

Заголовок запроса

Name	Обязательный	Type	Description
x-ms-client-request-id	Неправда	строка	Непрозрачный, глобально уникальный, созданный клиентом идентификатор строки для запроса.

Responses

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

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

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

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

Заголовка	Type	Description
x-ms-client-request-id		Непрозрачный, глобально уникальный, созданный клиентом идентификатор строки для запроса.

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

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

Тип содержимого	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

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

Заголовка	Type	Description
X-ms-error-code	строка	Код строковой ошибки, указывающий на то, что произошло неправильно.

Развертывания — получение

GET {endpoint}/deployments/{name}?api-version=v1

Получите развернутую модель.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
версия API	query	Да	строка	Версия API, используемая для данной операции.
имя	path	Да	строка	Имя развертывания

Заголовок запроса

Name	Обязательный	Type	Description
x-ms-client-request-id	Неправда	строка	Непрозрачный, глобально уникальный, созданный клиентом идентификатор строки для запроса.

Responses

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

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

Тип содержимого	Type	Description
application/json	Развертывание

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

Заголовка	Type	Description
x-ms-client-request-id		Непрозрачный, глобально уникальный, созданный клиентом идентификатор строки для запроса.

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

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

Тип содержимого	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

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

Заголовка	Type	Description
X-ms-error-code	строка	Код строковой ошибки, указывающий на то, что произошло неправильно.

Оценка таксономий

Оценка таксономий — список

GET {endpoint}/evaluationtaxonomies?api-version=v1

Перечисление таксономий оценки

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
версия API	query	Да	строка	Версия API, используемая для данной операции.
inputName	query	Нет	строка	Фильтруйте по имени входных данных оценки.
inputType	query	Нет	строка	Фильтрация по типу входных данных таксономии.

Заголовок запроса

Name	Обязательный	Type	Description
Foundry-Features	True	строка Возможные значения: Evaluations=V1Preview	Флаг функции, необходимый при использовании операций предварительной версии или изменении сохраненных ресурсов предварительной версии.

Responses

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

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

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

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

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

Тип содержимого	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

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

Заголовка	Type	Description
X-ms-error-code	строка	Код строковой ошибки, указывающий на то, что произошло неправильно.

Оценка таксономий — получение

GET {endpoint}/evaluationtaxonomies/{name}?api-version=v1

Получение запуска оценки по имени.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
версия API	query	Да	строка	Версия API, используемая для данной операции.
имя	path	Да	строка	Имя ресурса.

Заголовок запроса

Name	Обязательный	Type	Description
Foundry-Features	True	строка Возможные значения: Evaluations=V1Preview	Флаг функции, необходимый при использовании операций предварительной версии или изменении сохраненных ресурсов предварительной версии.

Responses

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

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

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

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

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

Тип содержимого	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

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

Заголовка	Type	Description
X-ms-error-code	строка	Код строковой ошибки, указывающий на то, что произошло неправильно.

Оценка таксономий — удаление

DELETE {endpoint}/evaluationtaxonomies/{name}?api-version=v1

Удалите таксономию оценки по имени.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
версия API	query	Да	строка	Версия API, используемая для данной операции.
имя	path	Да	строка	Имя ресурса.

Заголовок запроса

Name	Обязательный	Type	Description
Foundry-Features	True	строка Возможные значения: Evaluations=V1Preview	Флаг функции, необходимый при использовании операций предварительной версии или изменении сохраненных ресурсов предварительной версии.

Responses

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

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

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

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

Тип содержимого	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

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

Заголовка	Type	Description
X-ms-error-code	строка	Код строковой ошибки, указывающий на то, что произошло неправильно.

Оценка таксономий — создание

PUT {endpoint}/evaluationtaxonomies/{name}?api-version=v1

Создайте таксономию оценки.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
версия API	query	Да	строка	Версия API, используемая для данной операции.
имя	path	Да	строка	Имя таксономии оценки.

Заголовок запроса

Name	Обязательный	Type	Description
Foundry-Features	True	строка Возможные значения: Evaluations=V1Preview	Флаг функции, необходимый при использовании операций предварительной версии или изменении сохраненных ресурсов предварительной версии.

Тело запроса

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

Name	Type	Description	Обязательный	По умолчанию
описание	строка	Текст описания ресурса.	Нет
properties	object	Дополнительные свойства для таксономии оценки.	Нет
tags	object	Словарь тегов. Теги можно добавлять, удалять и обновлять.	Нет
категории таксономии	массив ТаксономииCategory	Список категорий таксономии.	Нет
таксономияInput	EvaluationTaxonomyInput	Входная конфигурация для таксономии оценки.	Да
└─ Тип	EvaluationTaxonomyInputType	Тип входных данных для таксономии оценки.	Да

Responses

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

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

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

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

Описание: запрос успешно выполнен, и в результате был создан новый ресурс.

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

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

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

Тип содержимого	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

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

Заголовка	Type	Description
X-ms-error-code	строка	Код строковой ошибки, указывающий на то, что произошло неправильно.

Оценка таксономий — обновление

PATCH {endpoint}/evaluationtaxonomies/{name}?api-version=v1

Обновите таксономию оценки.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
версия API	query	Да	строка	Версия API, используемая для данной операции.
имя	path	Да	строка	Имя таксономии оценки.

Заголовок запроса

Name	Обязательный	Type	Description
Foundry-Features	True	строка Возможные значения: Evaluations=V1Preview	Флаг функции, необходимый при использовании операций предварительной версии или изменении сохраненных ресурсов предварительной версии.

Тело запроса

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

Name	Type	Description	Обязательный	По умолчанию
описание	строка	Текст описания ресурса.	Нет
properties	object	Дополнительные свойства для таксономии оценки.	Нет
tags	object	Словарь тегов. Теги можно добавлять, удалять и обновлять.	Нет
категории таксономии	массив ТаксономииCategory	Список категорий таксономии.	Нет
таксономияInput	EvaluationTaxonomyInputUpdate	Входная конфигурация для таксономии оценки.	Нет
└─ Тип	EvaluationTaxonomyInputType	Тип входных данных для таксономии оценки.	Да

Responses

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

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

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

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

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

Тип содержимого	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

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

Заголовка	Type	Description
X-ms-error-code	строка	Код строковой ошибки, указывающий на то, что произошло неправильно.

Правила оценки

Правила оценки — список

GET {endpoint}/evaluationrules?api-version=v1

Вывод списка всех правил оценки.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
версия API	query	Да	строка	Версия API, используемая для данной операции.
actionType	query	Нет	строка Возможные значения: continuousEvaluation, humanEvaluationPreview	Фильтруйте по типу правила оценки.
agentName	query	Нет	строка	Фильтрация по имени агента.
enabled	query	Нет	boolean	Фильтруйте по включенном состоянию.

Responses

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

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

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

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

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

Тип содержимого	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

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

Заголовка	Type	Description
X-ms-error-code	строка	Код строковой ошибки, указывающий на то, что произошло неправильно.

Правила оценки — получение

GET {endpoint}/evaluationrules/{id}?api-version=v1

Получите правило оценки.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
версия API	query	Да	строка	Версия API, используемая для данной операции.
id	path	Да	строка	Уникальный идентификатор правила оценки.

Responses

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

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

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

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

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

Тип содержимого	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

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

Заголовка	Type	Description
X-ms-error-code	строка	Код строковой ошибки, указывающий на то, что произошло неправильно.

Правила оценки — удаление

DELETE {endpoint}/evaluationrules/{id}?api-version=v1

Удаление правила оценки.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
версия API	query	Да	строка	Версия API, используемая для данной операции.
id	path	Да	строка	Уникальный идентификатор правила оценки.

Responses

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

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

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

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

Тип содержимого	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

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

Заголовка	Type	Description
X-ms-error-code	строка	Код строковой ошибки, указывающий на то, что произошло неправильно.

Правила оценки — создание или обновление

PUT {endpoint}/evaluationrules/{id}?api-version=v1

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

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
версия API	query	Да	строка	Версия API, используемая для данной операции.
id	path	Да	строка	Уникальный идентификатор правила оценки.

Заголовок запроса

Name	Обязательный	Type	Description
Foundry-Features	Неправда	строка Возможные значения: Evaluations=V1Preview	Флаг функции, необходимый при использовании операций предварительной версии или изменении сохраненных ресурсов предварительной версии.

Тело запроса

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

Name	Type	Description	Обязательный	По умолчанию
action	EvaluationRuleAction	Модель действия по оценке.	Да
└─ Тип	EvaluationRuleActionType	Тип действия по оценке.	Да
описание	строка	Описание правила оценки.	Нет
displayName	строка	Отображаемое имя правила оценки.	Нет
enabled	boolean	Указывает, включено ли правило оценки. Значение по умолчанию: true.	Да
eventType	EvaluationRuleEventType	Тип события правила оценки.	Да
filter	EvaluationRuleFilter	Модель фильтра оценки.	Нет
└️ agentName	строка	Фильтруйте по имени агента.	Да
id	строка (только для чтения)	Уникальный идентификатор правила оценки.	Да
данные системы	object (только для чтения)	Системные метаданные для правила оценки.	Да

Responses

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

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

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

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

Описание: запрос успешно выполнен, и в результате был создан новый ресурс.

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

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

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

Тип содержимого	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

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

Заголовка	Type	Description
X-ms-error-code	строка	Код строковой ошибки, указывающий на то, что произошло неправильно.

Оценщиков

Вычислители — список последних версий

GET {endpoint}/evaluators?api-version=v1

Перечислите последнюю версию каждого оценщика

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
версия API	query	Да	строка	Версия API, используемая для данной операции.
type	query	Нет	строка Возможные значения: builtin, customall	Фильтрующие вычислители по типу. Возможные значения: "all", "custom", "builtin".
limit	query	Нет	целое число	Ограничение количества возвращаемых объектов. Ограничение может быть от 1 до 100, а значение по умолчанию — 20.

Заголовок запроса

Name	Обязательный	Type	Description
Foundry-Features	True	строка Возможные значения: Evaluations=V1Preview	Флаг функции, необходимый при использовании операций предварительной версии или изменении сохраненных ресурсов предварительной версии.

Responses

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

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

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

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

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

Тип содержимого	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

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

Заголовка	Type	Description
X-ms-error-code	строка	Код строковой ошибки, указывающий на то, что произошло неправильно.

Вычислители — версии списка

GET {endpoint}/evaluators/{name}/versions?api-version=v1

Перечислите все версии данного оценщика

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
версия API	query	Да	строка	Версия API, используемая для данной операции.
имя	path	Да	строка	Имя ресурса.
type	query	Нет	строка Возможные значения: builtin, customall	Фильтрующие вычислители по типу. Возможные значения: "all", "custom", "builtin".
limit	query	Нет	целое число	Ограничение количества возвращаемых объектов. Ограничение может быть от 1 до 100, а значение по умолчанию — 20.

Заголовок запроса

Name	Обязательный	Type	Description
Foundry-Features	True	строка Возможные значения: Evaluations=V1Preview	Флаг функции, необходимый при использовании операций предварительной версии или изменении сохраненных ресурсов предварительной версии.

Responses

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

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

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

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

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

Тип содержимого	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

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

Заголовка	Type	Description
X-ms-error-code	строка	Код строковой ошибки, указывающий на то, что произошло неправильно.

Вычислители — создание версии

POST {endpoint}/evaluators/{name}/versions?api-version=v1

Создание нового EvaluatorVersion с автоматически увеличиваемым идентификатором версии

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
версия API	query	Да	строка	Версия API, используемая для данной операции.
имя	path	Да	строка	Имя ресурса.

Заголовок запроса

Name	Обязательный	Type	Description
Foundry-Features	True	строка Возможные значения: Evaluations=V1Preview	Флаг функции, необходимый при использовании операций предварительной версии или изменении сохраненных ресурсов предварительной версии.

Тело запроса

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

Name	Type	Description	Обязательный	По умолчанию
categories	массив проценщикаCategory	Категории оценщика	Да
Определение	ScoreorDefinition	Конфигурация базового оценщика с дискриминатором	Да
└️ data_schema	object	Схема JSON (проект 2020-12) для входных данных оценщика. Это включает в себя такие параметры, как тип, свойства, обязательные.	Нет
└init_parameters init_parameters	object	Схема JSON (проект 2020-12) для входных параметров оценщика. Это включает в себя такие параметры, как тип, свойства, обязательные.	Нет
Метрики └️	object	Список выходных метрик, полученных данным оценщиком	Нет
└─ Тип	ScoreorDefinitionType	Тип определения оценщика	Да
описание	строка	Текст описания ресурса.	Нет
display_name	строка	Отображаемое имя для оценщика. В AI Foundry легко найти оценщика. Он не обязательно должен быть уникальным.	Нет
evaluator_type	ScoreorType	Тип оценщика	Да
metadata	object	Метаданные об оценщике	Нет
tags	object	Словарь тегов. Теги можно добавлять, удалять и обновлять.	Нет

Responses

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

Описание: запрос успешно выполнен, и в результате был создан новый ресурс.

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

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

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

Тип содержимого	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

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

Заголовка	Type	Description
X-ms-error-code	строка	Код строковой ошибки, указывающий на то, что произошло неправильно.

Вычислители — получение версии

GET {endpoint}/evaluators/{name}/versions/{version}?api-version=v1

Получите конкретную версию EvaluatorVersion. Служба возвращает ошибку 404 Not Found, если EvaluatorVersion не существует.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
версия API	query	Да	строка	Версия API, используемая для данной операции.
имя	path	Да	строка	Имя ресурса.
version	path	Да	строка	Идентификатор конкретной версии извлекаемого объекта ScoreorVersion.

Заголовок запроса

Name	Обязательный	Type	Description
Foundry-Features	True	строка Возможные значения: Evaluations=V1Preview	Флаг функции, необходимый при использовании операций предварительной версии или изменении сохраненных ресурсов предварительной версии.

Responses

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

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

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

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

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

Тип содержимого	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

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

Заголовка	Type	Description
X-ms-error-code	строка	Код строковой ошибки, указывающий на то, что произошло неправильно.

Вычислители — удаление версии

DELETE {endpoint}/evaluators/{name}/versions/{version}?api-version=v1

Удалите конкретную версию EvaluatorVersion. Служба возвращает 204 No Content, если EvaluatorVersion был успешно удален или если EvaluatorVersion не существует.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
версия API	query	Да	строка	Версия API, используемая для данной операции.
имя	path	Да	строка	Имя ресурса.
version	path	Да	строка	Версия объекта ScoreorVersion для удаления.

Заголовок запроса

Name	Обязательный	Type	Description
Foundry-Features	True	строка Возможные значения: Evaluations=V1Preview	Флаг функции, необходимый при использовании операций предварительной версии или изменении сохраненных ресурсов предварительной версии.

Responses

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

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

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

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

Тип содержимого	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

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

Заголовка	Type	Description
X-ms-error-code	строка	Код строковой ошибки, указывающий на то, что произошло неправильно.

Вычислители — версия обновления

PATCH {endpoint}/evaluators/{name}/versions/{version}?api-version=v1

Обновите существующую версию EvaluatorVersion с указанным идентификатором версии

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
версия API	query	Да	строка	Версия API, используемая для данной операции.
имя	path	Да	строка	Имя ресурса.
version	path	Да	строка	Версия объекта ScoreorVersion для обновления.

Заголовок запроса

Name	Обязательный	Type	Description
Foundry-Features	True	строка Возможные значения: Evaluations=V1Preview	Флаг функции, необходимый при использовании операций предварительной версии или изменении сохраненных ресурсов предварительной версии.

Тело запроса

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

Name	Type	Description	Обязательный	По умолчанию
categories	массив проценщикаCategory	Категории оценщика	Нет
описание	строка	Текст описания ресурса.	Нет
display_name	строка	Отображаемое имя для оценщика. В AI Foundry легко найти оценщика. Он не обязательно должен быть уникальным.	Нет
metadata	object	Метаданные об оценщике	Нет
tags	object	Словарь тегов. Теги можно добавлять, удалять и обновлять.	Нет

Responses

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

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

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

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

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

Тип содержимого	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

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

Заголовка	Type	Description
X-ms-error-code	строка	Код строковой ошибки, указывающий на то, что произошло неправильно.

Indexes

Индексы — список последних версий

GET {endpoint}/indexes?api-version=v1

Вывод списка последней версии каждого индекса

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
версия API	query	Да	строка	Версия API, используемая для данной операции.

Responses

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

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

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

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

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

Тип содержимого	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

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

Заголовка	Type	Description
X-ms-error-code	строка	Код строковой ошибки, указывающий на то, что произошло неправильно.

Индексы — версии списка

GET {endpoint}/indexes/{name}/versions?api-version=v1

Вывод списка всех версий заданного индекса

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
версия API	query	Да	строка	Версия API, используемая для данной операции.
имя	path	Да	строка	Имя ресурса.

Responses

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

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

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

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

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

Тип содержимого	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

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

Заголовка	Type	Description
X-ms-error-code	строка	Код строковой ошибки, указывающий на то, что произошло неправильно.

Индексы — получение версии

GET {endpoint}/indexes/{name}/versions/{version}?api-version=v1

Получите определенную версию индекса. Служба возвращает ошибку 404 Not Found, если индекс не существует.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
версия API	query	Да	строка	Версия API, используемая для данной операции.
имя	path	Да	строка	Имя ресурса.
version	path	Да	строка	Идентификатор конкретной версии извлекаемого индекса.

Responses

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

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

Тип содержимого	Type	Description
application/json	Указатель

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

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

Тип содержимого	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

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

Заголовка	Type	Description
X-ms-error-code	строка	Код строковой ошибки, указывающий на то, что произошло неправильно.

Индексы — удаление версии

DELETE {endpoint}/indexes/{name}/versions/{version}?api-version=v1

Удалите определенную версию индекса. Служба возвращает значение 204 No Content, если индекс был удален успешно или если индекс не существует.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
версия API	query	Да	строка	Версия API, используемая для данной операции.
имя	path	Да	строка	Имя ресурса.
version	path	Да	строка	Версия индекса для удаления.

Responses

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

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

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

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

Тип содержимого	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

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

Заголовка	Type	Description
X-ms-error-code	строка	Код строковой ошибки, указывающий на то, что произошло неправильно.

Индексы — создание или обновление версии

PATCH {endpoint}/indexes/{name}/versions/{version}?api-version=v1

Создание нового или обновление существующего индекса с заданным идентификатором версии

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
версия API	query	Да	строка	Версия API, используемая для данной операции.
имя	path	Да	строка	Имя ресурса.
version	path	Да	строка	Идентификатор конкретной версии индекса для создания или обновления.

Тело запроса

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

Name	Type	Description	Обязательный	По умолчанию
описание	строка	Текст описания ресурса.	Нет
tags	object	Словарь тегов. Теги можно добавлять, удалять и обновлять.	Нет
type	IndexType		Да

Responses

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

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

Тип содержимого	Type	Description
application/json	Указатель

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

Описание: запрос успешно выполнен, и в результате был создан новый ресурс.

Тип содержимого	Type	Description
application/json	Указатель

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

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

Тип содержимого	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

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

Заголовка	Type	Description
X-ms-error-code	строка	Код строковой ошибки, указывающий на то, что произошло неправильно.

Insights

Аналитика — создание

POST {endpoint}/insights?api-version=v1

Создание аналитики

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
версия API	query	Да	строка	Версия API, используемая для данной операции.

Заголовок запроса

Name	Обязательный	Type	Description
Foundry-Features	True	строка Возможные значения: Insights=V1Preview	Флаг функции, необходимый при использовании операций предварительной версии или изменении сохраненных ресурсов предварительной версии.
Повторяемость—Request-ID	Неправда	строка	Уникальный, генерируемый клиентом идентификатор для обеспечения идемпотентности запросов. Используйте один и тот же идентификатор для повторных попыток, чтобы избежать дублирования оценок.
Повторяемость—First-Sent	Неправда	строка	Временная метка, указывающая, когда этот запрос был впервые инициирован. Используется в сочетании с repeatability-request-id для управления идемпотентностью.

Тело запроса

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

Name	Type	Description	Обязательный	По умолчанию
displayName	строка	Понятное отображаемое имя для аналитических сведений.	Да
id	строка (только для чтения)	Уникальный идентификатор отчета аналитики.	Да
metadata	InsightsMetadata (только для чтения)	Метаданные об инсайтах.	Да
└️ completedAt	строка	Метка времени завершения аналитических сведений.	Нет
└️ createdAt	строка	Метка времени создания аналитических сведений.	Да
просьба	InsightsRequest	Запрос аналитического отчета.	Да
└─ Тип	InsightsType	Тип запроса.	Да
result	InsightsResult (только для чтения)	Результат инсайтов.	Нет
└─ Тип	InsightsType	Тип результата аналитики.	Да
state	Azure. Core.Foundations.OperationState (только для чтения)	Перечисление, описывающее разрешенные состояния операций.	Да

Responses

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

Описание: запрос успешно выполнен, и в результате был создан новый ресурс.

Тип содержимого	Type	Description
application/json	Полезные сведения

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

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

Тип содержимого	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

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

Заголовка	Type	Description
X-ms-error-code	строка	Код строковой ошибки, указывающий на то, что произошло неправильно.

Аналитика — список

GET {endpoint}/insights?api-version=v1

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

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
версия API	query	Да	строка	Версия API, используемая для данной операции.
type	query	Нет	строка Возможные значения: EvaluationRunClusterInsight, AgentClusterInsightEvaluationComparison	Фильтрация по типу анализа.
evalId	query	Нет	строка	Фильтрация по идентификатору оценки.
runId	query	Нет	строка	Фильтрация по идентификатору пробного запуска.
agentName	query	Нет	строка	Фильтрация по имени агента.
includeCoordinates	query	Нет	boolean	Включать ли в ответ координаты для визуализации. По умолчанию false.

Заголовок запроса

Name	Обязательный	Type	Description
Foundry-Features	True	строка Возможные значения: Insights=V1Preview	Флаг функции, необходимый при использовании операций предварительной версии или изменении сохраненных ресурсов предварительной версии.

Responses

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

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

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

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

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

Тип содержимого	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

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

Заголовка	Type	Description
X-ms-error-code	строка	Код строковой ошибки, указывающий на то, что произошло неправильно.

Аналитика — получение

GET {endpoint}/insights/{id}?api-version=v1

Получите определенное представление по идентификатору.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
версия API	query	Да	строка	Версия API, используемая для данной операции.
id	path	Да	строка	Уникальный идентификатор отчета аналитики.
includeCoordinates	query	Нет	boolean	Включать ли в ответ координаты для визуализации. По умолчанию false.

Заголовок запроса

Name	Обязательный	Type	Description
Foundry-Features	True	строка Возможные значения: Insights=V1Preview	Флаг функции, необходимый при использовании операций предварительной версии или изменении сохраненных ресурсов предварительной версии.

Responses

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

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

Тип содержимого	Type	Description
application/json	Полезные сведения

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

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

Тип содержимого	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

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

Заголовка	Type	Description
X-ms-error-code	строка	Код строковой ошибки, указывающий на то, что произошло неправильно.

Хранилища памяти

Создание хранилища памяти

POST {endpoint}/memory_stores?api-version=v1

Создайте хранилище памяти.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
версия API	query	Да	строка	Версия API, используемая для данной операции.

Заголовок запроса

Name	Обязательный	Type	Description
Foundry-Features	True	строка Возможные значения: MemoryStores=V1Preview	Флаг функции, необходимый при использовании операций предварительной версии или изменении сохраненных ресурсов предварительной версии.

Тело запроса

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

Name	Type	Description	Обязательный	По умолчанию
Определение	MemoryStoreDefinition	Базовое определение для конфигураций хранилища памяти.	Да
└️ вид	MemoryStoreKind	Тип хранилища памяти.	Да
описание	строка	Читаемое человеком описание хранилища памяти. Ограничения: maxLength: 512	Нет
metadata	object	Произвольные метаданные значения ключа для связывания с хранилищем памяти.	Нет
имя	строка	Имя хранилища памяти. Ограничения: maxLength: 256	Да

Responses

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

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

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

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

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

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

Список хранилищ памяти

GET {endpoint}/memory_stores?api-version=v1

Перечислите все хранилища памяти.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
limit	query	Нет	целое число	Ограничение количества возвращаемых объектов. Ограничение может варьироваться от 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, чтобы получить предыдущую страницу списка.
версия API	query	Да	строка	Версия API, используемая для данной операции.

Заголовок запроса

Name	Обязательный	Type	Description
Foundry-Features	True	строка Возможные значения: MemoryStores=V1Preview	Флаг функции, необходимый при использовании операций предварительной версии или изменении сохраненных ресурсов предварительной версии.

Responses

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

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

Тип содержимого	Type	Description
application/json	object	Данные ответа для запрошенного списка элементов.

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

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

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

Обновление хранилища памяти

POST {endpoint}/memory_stores/{name}?api-version=v1

Обновите хранилище памяти.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
имя	path	Да	строка	Имя хранилища памяти для обновления.
версия API	query	Да	строка	Версия API, используемая для данной операции.

Заголовок запроса

Name	Обязательный	Type	Description
Foundry-Features	True	строка Возможные значения: MemoryStores=V1Preview	Флаг функции, необходимый при использовании операций предварительной версии или изменении сохраненных ресурсов предварительной версии.

Тело запроса

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

Name	Type	Description	Обязательный	По умолчанию
описание	строка	Читаемое человеком описание хранилища памяти. Ограничения: maxLength: 512	Нет
metadata	object	Произвольные метаданные значения ключа для связывания с хранилищем памяти.	Нет

Responses

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

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

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

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

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

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

Получение хранилища памяти

GET {endpoint}/memory_stores/{name}?api-version=v1

Извлечение хранилища памяти.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
имя	path	Да	строка	Имя извлекаемого хранилища памяти.
версия API	query	Да	строка	Версия API, используемая для данной операции.

Заголовок запроса

Name	Обязательный	Type	Description
Foundry-Features	True	строка Возможные значения: MemoryStores=V1Preview	Флаг функции, необходимый при использовании операций предварительной версии или изменении сохраненных ресурсов предварительной версии.

Responses

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

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

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

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

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

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

Удаление хранилища памяти

DELETE {endpoint}/memory_stores/{name}?api-version=v1

Удалите хранилище памяти.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
имя	path	Да	строка	Имя удаленного хранилища памяти.
версия API	query	Да	строка	Версия API, используемая для данной операции.

Заголовок запроса

Name	Обязательный	Type	Description
Foundry-Features	True	строка Возможные значения: MemoryStores=V1Preview	Флаг функции, необходимый при использовании операций предварительной версии или изменении сохраненных ресурсов предварительной версии.

Responses

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

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

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

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

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

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

Получение результата обновления

GET {endpoint}/memory_stores/{name}/updates/{update_id}?api-version=v1

Получите результат обновления хранилища памяти.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
имя	path	Да	строка	Имя хранилища памяти.
update_id	path	Да	строка	Идентификатор операции обновления памяти.
версия API	query	Да	строка	Версия API, используемая для данной операции.

Заголовок запроса

Name	Обязательный	Type	Description
Foundry-Features	True	строка Возможные значения: MemoryStores=V1Preview	Флаг функции, необходимый при использовании операций предварительной версии или изменении сохраненных ресурсов предварительной версии.

Responses

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

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

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

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

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

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

Удаление памяти области

POST {endpoint}/memory_stores/{name}:delete_scope?api-version=v1

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

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
имя	path	Да	строка	Имя хранилища памяти.
версия API	query	Да	строка	Версия API, используемая для данной операции.

Заголовок запроса

Name	Обязательный	Type	Description
Foundry-Features	True	строка Возможные значения: MemoryStores=V1Preview	Флаг функции, необходимый при использовании операций предварительной версии или изменении сохраненных ресурсов предварительной версии.

Тело запроса

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

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

Responses

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

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

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

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

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

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

Поиск воспоминаний

POST {endpoint}/memory_stores/{name}:search_memories?api-version=v1

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

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
имя	path	Да	строка	Имя хранилища памяти для поиска.
версия API	query	Да	строка	Версия API, используемая для данной операции.

Заголовок запроса

Name	Обязательный	Type	Description
Foundry-Features	True	строка Возможные значения: MemoryStores=V1Preview	Флаг функции, необходимый при использовании операций предварительной версии или изменении сохраненных ресурсов предварительной версии.

Тело запроса

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

Name	Type	Description	Обязательный	По умолчанию
items	массив OpenAI.InputItem	Элементы, для которых следует искать соответствующие воспоминания.	Нет
options	MemorySearchOptions	Варианты поиска в памяти.	Нет
└max_memories	целое число	Максимальное количество возвращаемых элементов памяти.	Нет
previous_search_id	строка	Уникальный идентификатор предыдущего поискового запроса, включив добавочный поиск памяти, из которого ушла последняя операция.	Нет
scope	строка	Пространство имен, которое логически группирует и изолирует воспоминания, например идентификатор пользователя.	Да

Responses

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

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

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

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

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

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

Обновление воспоминаний

POST {endpoint}/memory_stores/{name}:update_memories?api-version=v1

Обновите хранилище памяти с помощью воспоминаний о разговорах.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
имя	path	Да	строка	Имя хранилища памяти для обновления.
версия API	query	Да	строка	Версия API, используемая для данной операции.

Заголовок запроса

Name	Обязательный	Type	Description
Foundry-Features	True	строка Возможные значения: MemoryStores=V1Preview	Флаг функции, необходимый при использовании операций предварительной версии или изменении сохраненных ресурсов предварительной версии.

Тело запроса

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

Name	Type	Description	Обязательный	По умолчанию
items	массив OpenAI.InputItem	Элементы беседы, из которых извлекаются воспоминания.	Нет
previous_update_id	строка	Уникальный идентификатор предыдущего запроса на обновление, включив добавочные обновления памяти, от которых ушла последняя операция.	Нет
scope	строка	Пространство имен, которое логически группирует и изолирует воспоминания, например идентификатор пользователя.	Да
update_delay	целое число	Период ожидания перед обработкой обновления памяти в секундах. Если новый запрос обновления получен в течение этого периода, он отменит текущий запрос и сбросит время ожидания. Установите значение 0, чтобы немедленно активировать обновление без задержки. По умолчанию — 300 (5 минут).	Нет	300

Responses

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

Описание. Запрос был принят для обработки, но обработка еще не завершена.

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

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

Заголовка	Type	Description
Операция-Местоположение	строка	Расположение для мониторинга состояния операции.

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

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

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

Беседы

Создание беседы

POST {endpoint}/openai/v1/conversations

Создайте беседу.

Тело запроса

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

Name	Type	Description	Обязательный	По умолчанию
items	массив OpenAI.InputItem		Нет
metadata	OpenAI.Metadata (nullable)	Набор из 16 пар "ключ-значение", которые можно прикрепить к объекту. Это может быть Полезно для хранения дополнительных сведений об объекте в структурированном виде. форматирование и запрос объектов через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — строки с максимальной длиной 512 символов.	Нет

Responses

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

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

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

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

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

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

Список бесед

GET {endpoint}/openai/v1/conversations

Возвращает список всех бесед.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
limit	query	Нет	целое число	Ограничение количества возвращаемых объектов. Ограничение может варьироваться от 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, чтобы получить предыдущую страницу списка.
agent_name	query	Нет	строка	Фильтруйте по имени агента. При условии возвращаются только элементы, связанные с указанным агентом.
agent_id	query	Нет	строка	Фильтрация по идентификатору агента в формате name:version. Если указано, будут возвращены только элементы, связанные с указанным идентификатором агента.

Responses

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

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

Тип содержимого	Type	Description
application/json	object	Данные ответа для запрошенного списка элементов.

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

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

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

Обновление беседы

POST {endpoint}/openai/v1/conversations/{conversation_id}

Обновите беседу.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	path	Да	строка	Идентификатор беседы для обновления.

Тело запроса

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

Name	Type	Description	Обязательный	По умолчанию
metadata	OpenAI.Metadata (nullable)	Набор из 16 пар "ключ-значение", которые можно прикрепить к объекту. Это может быть Полезно для хранения дополнительных сведений об объекте в структурированном виде. форматирование и запрос объектов через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — строки с максимальной длиной 512 символов.	Да

Responses

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

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

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

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

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

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

Получение беседы

GET {endpoint}/openai/v1/conversations/{conversation_id}

Извлекает беседу.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	path	Да	строка	Идентификатор извлекаемой беседы.

Responses

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

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

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

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

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

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

Удаление беседы

DELETE {endpoint}/openai/v1/conversations/{conversation_id}

Удаляет беседу.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	path	Да	строка	Идентификатор удаленной беседы.

Responses

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

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

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

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

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

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

Создание элементов беседы

POST {endpoint}/openai/v1/conversations/{conversation_id}/items

Создайте элементы в беседе с заданным идентификатором.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	path	Да	строка	Идентификатор беседы, в которой необходимо создать элемент.
Включают	query	Нет	массив	Дополнительные поля для включения в ответ. Дополнительные сведения см. в параметре include для перечисления элементов беседы.

Тело запроса

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

Name	Type	Description	Обязательный	По умолчанию
items	массив OpenAI.Item	Элементы, добавляемые в беседу. Вы можете добавить до 20 элементов за раз.	Да

Responses

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

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

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

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

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

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

Вывод списка элементов беседы

GET {endpoint}/openai/v1/conversations/{conversation_id}/items

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

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	path	Да	строка	Идентификатор беседы, в которой должны быть перечислены элементы.
limit	query	Нет	целое число	Ограничение количества возвращаемых объектов. Ограничение может варьироваться от 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, чтобы получить предыдущую страницу списка.
item_type	query	Нет	строка Возможные значения: message, , output_messagefile_search_callcomputer_callcomputer_call_outputweb_search_callfunction_callfunction_call_outputreasoningcompactionimage_generation_callcode_interpreter_calllocal_shell_calllocal_shell_call_outputshell_callshell_call_outputapply_patch_callapply_patch_call_outputmcp_list_toolsmcp_approval_requestmcp_approval_responsemcp_callcustom_tool_call_outputcustom_tool_callstructured_outputsoauth_consent_requestmemory_search_callworkflow_action	Фильтрация по типу элемента. При условии возвращаются только элементы указанного типа.

Responses

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

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

Тип содержимого	Type	Description
application/json	object	Данные ответа для запрошенного списка элементов.

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

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

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

Получение элемента беседы

GET {endpoint}/openai/v1/conversations/{conversation_id}/items/{item_id}

Получите один элемент из беседы с заданными идентификаторами.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	path	Да	строка	Идентификатор беседы, содержащей элемент.
item_id	path	Да	строка	Идентификатор извлекаемого элемента беседы.

Responses

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

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

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

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

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

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

Удаление элемента беседы

DELETE {endpoint}/openai/v1/conversations/{conversation_id}/items/{item_id}

Удалите элемент из беседы с заданными идентификаторами.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	path	Да	строка	Идентификатор беседы, из которой необходимо удалить элемент.
item_id	path	Да	строка	Идентификатор элемента беседы для удаления.

Responses

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

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

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

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

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

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

Evals

Evals — список evals

GET {endpoint}/openai/v1/evals

Вывод списка всех оценок списка для проекта.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
После	query	Нет	строка	Идентификатор последнего выполнения из предыдущего запроса разбиения на страницы.
limit	query	Нет	целое число	Количество запусков для извлечения.
order	query	Нет	строка Возможные значения: asc, desc	Порядок сортировки запусков по метке времени. Используется asc для возрастания или desc для убывающего порядка. По умолчанию — asc.
сортировать_по	query	Нет	строка Возможные значения: created_at, updated_at	Evals можно упорядочить по времени создания или времени последнего обновления. Используется created_at для времени создания или updated_at последнего обновления.

Responses

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

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

Тип содержимого	Type	Description
application/json	object	Данные ответа для запрошенного списка элементов.

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

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

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

Evals — создание eval

POST {endpoint}/openai/v1/evals

Создание структуры оценки, которую можно использовать для тестирования производительности модели. Оценка — это набор критериев тестирования и конфигурации для источника данных, который определяет схему данных, используемых в оценке. После создания оценки его можно запустить на разных моделях и параметрах модели. Мы поддерживаем несколько типов классировщиков и источников данных. Дополнительные сведения см. в разделе

Тело запроса

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

Name	Type	Description	Обязательный	По умолчанию
настройка_источника_данных	OpenAI.CreateEvalCustomDataSourceConfig или OpenAI.CreateEvalLogsDataSourceConfig или OpenAI.CreateEvalStoredCompletionsDataSourceConfig или AzureAIDataSourceConfig	Конфигурация источника данных, используемого для выполнения оценки. Определяет схему данных, используемых в оценке.	Да
metadata	OpenAI.Metadata (nullable)	Набор из 16 пар "ключ-значение", которые можно прикрепить к объекту. Это может быть Полезно для хранения дополнительных сведений об объекте в структурированном виде. форматирование и запрос объектов через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — строки с максимальной длиной 512 символов.	Нет
имя	строка	Название оценки.	Нет
properties	object	Набор неизменяемых пар "ключ-значение", которые могут быть присоединены к объекту для хранения дополнительных сведений. Ключи — это строки с максимальной длиной 64 символов. Значения — это строки с максимальной длиной 512 символов.	Нет
критерии тестирования	массив OpenAI.EvalGraderLabelModel или OpenAI.EvalGraderStringCheck или OpenAI.EvalGraderTextSimilarity или OpenAI.EvalGraderPython или OpenAI.EvalGraderScoreModel или EvalGraderAzureAIEvaluator	Список оценщиков для всех запусков оценок в этой группе. Классировщики могут ссылаться на переменные в источнике данных с помощью двойной фигурной скобки, например {{item.variable_name}}. Чтобы ссылаться на выходные данные модели, используйте sample пространство имен (т. е. {{sample.output_text}}).	Да

Responses

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

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

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

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

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

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

Evals — удаление eval

DELETE {endpoint}/openai/v1/evals/{eval_id}

Удаление оценки Удаление оценки.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Да	строка	Идентификатор оценки для удаления.

Responses

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

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

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

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

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

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

Evals — получение eval

GET {endpoint}/openai/v1/evals/{eval_id}

Получение оценки получения оценки по идентификатору.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Да	строка	Идентификатор процесса оценки для извлечения.

Responses

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

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

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

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

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

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

Evals — обновление eval

POST {endpoint}/openai/v1/evals/{eval_id}

Обновите некоторые свойства оценки для оценки.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Да	строка	Идентификатор обновляемой оценки.

Тело запроса

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

Name	Type	Description	Обязательный	По умолчанию
metadata	OpenAI.Metadata (nullable)	Набор из 16 пар "ключ-значение", которые можно прикрепить к объекту. Это может быть Полезно для хранения дополнительных сведений об объекте в структурированном виде. форматирование и запрос объектов через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — строки с максимальной длиной 512 символов.	Нет
имя	строка		Нет
properties	object	Набор неизменяемых пар "ключ-значение", которые могут быть присоединены к объекту для хранения дополнительных сведений. Ключи — это строки с максимальной длиной 64 символов. Значения — это строки с максимальной длиной 512 символов.	Нет

Responses

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

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

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

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

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

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

Evals — запуски списка

GET {endpoint}/openai/v1/evals/{eval_id}/runs

Получение списка запусков для оценки получения списка запусков для оценки.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Да	строка	Идентификатор вычисления, для которого требуется получить запуски.
После	query	Нет	строка	Идентификатор последнего выполнения из предыдущего запроса разбиения на страницы.
limit	query	Нет	целое число	Количество запусков для извлечения.
order	query	Нет	строка Возможные значения: asc, desc	Порядок сортировки запусков по метке времени. Используется asc для возрастания или desc для убывающего порядка. По умолчанию — asc.
Статус	query	Нет	строка Возможные значения: queued, , in_progresscompleted, canceledfailed. Фильтруйте запуски по статусу. Один из queued, , in_progressfailedcompleted, , canceled.

Responses

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

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

Тип содержимого	Type	Description
application/json	object	Данные ответа для запрошенного списка элементов.

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

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

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

Evals — создание запуска eval

POST {endpoint}/openai/v1/evals/{eval_id}/runs

Создание запуска оценки

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Да	строка	Идентификатор оценки для создания процедуры выполнения.

Тело запроса

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

Name	Type	Description	Обязательный	По умолчанию
источник данных	OpenAI.CreateEvalJsonlRunDataSource или OpenAI.CreateEvalCompletionsRunDataSource или OpenAI.CreateEvalResponsesRunDataSource или EvalRunDataSource	Сведения об источнике данных запуска.	Да
metadata	OpenAI.Metadata (nullable)	Набор из 16 пар "ключ-значение", которые можно прикрепить к объекту. Это может быть Полезно для хранения дополнительных сведений об объекте в структурированном виде. форматирование и запрос объектов через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — строки с максимальной длиной 512 символов.	Нет
имя	строка	Имя запуска.	Нет
properties	object	Набор неизменяемых пар "ключ-значение", которые могут быть присоединены к объекту для хранения дополнительных сведений. Ключи — это строки с максимальной длиной 64 символов. Значения — это строки с максимальной длиной 512 символов.	Нет

Responses

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

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

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

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

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

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

Evals — удаление запуска eval

DELETE {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}

Удаление ознакомительного запуска Delete a eval run.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Да	строка	Идентификатор оценки, из которой нужно удалить запуск.
run_id	path	Да	строка	Идентификатор запуска для удаления.

Responses

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

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

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

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

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

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

Evals — получение запуска eval

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}

Проведите оценку. Проведите оценку в ID.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Да	строка	Идентификатор вычисления, для которого требуется получить запуски.
run_id	path	Да	строка	Идентификатор извлекаемого запуска.

Responses

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

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

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

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

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

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

Evals — отмена выполнения eval

POST {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}

Отмена выполнения оценки отмены текущего выполнения оценки.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Да	строка	Идентификатор оценки, выполнение которой требуется отменить.
run_id	path	Да	строка	Идентификатор запуска, который необходимо отменить.

Responses

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

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

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

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

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

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

Evals — получение выходных элементов выполнения eval

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}/output_items

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

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Да	строка
run_id	path	Да	строка	Идентификатор запуска для получения результатов.
После	query	Нет	строка	Идентификатор последнего выполнения из предыдущего запроса разбиения на страницы.
limit	query	Нет	целое число	Количество запусков для извлечения.
order	query	Нет	строка Возможные значения: asc, desc	Порядок сортировки запусков по метке времени. Используется asc для возрастания или desc для убывающего порядка. По умолчанию — asc.
Статус	query	Нет	строка Возможные значения: fail, pass	Фильтрация выходных элементов по состоянию. Использование failed для фильтрации по неудачным выходным данным элементы или pass фильтрация по переданным выходным элементам.

Responses

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

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

Тип содержимого	Type	Description
application/json	object	Данные ответа для запрошенного списка элементов.

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

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

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

Evals — получение выходного элемента выполнения eval

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}/output_items/{output_item_id}

Получение выходного элемента ознакомительного запуска Get an evaluation run output item by ID.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Да	строка	Идентификатор вычисления, для которого требуется получить запуски.
run_id	path	Да	строка	Идентификатор извлекаемого запуска.
идентификатор_выходного_элемента	path	Да	строка	Идентификатор извлекаемого выходного элемента.

Responses

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

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

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

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

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

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

Fine-Tuning

Создание задания тонкой настройки

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

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

Ответ содержит подробные сведения о поставленной задаче, включая состояние задания и название доработанных моделей после их завершения.

Дополнительные сведения о тонкой настройке

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
версия API	query	Да	строка	Версия API, используемая для данной операции.

Тело запроса

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

Name	Type	Description	Обязательный	По умолчанию
гиперпараметры	OpenAI.CreateFineTuningJobRequestHyperparameters		Нет
└batch_size	string или OpenAI.integer		Нет	авто
└─ learning_rate_multiplier	string или OpenAI.numeric		Нет
└️ n_epochs	string или OpenAI.integer		Нет	авто
Интеграции	массив OpenAI.CreateFineTuningJobRequestIntegrations	Список интеграций, которые нужно включить для задания по тонкой настройке.	Нет
metadata	OpenAI.Metadata (nullable)	Набор из 16 пар "ключ-значение", которые можно прикрепить к объекту. Это может быть Полезно для хранения дополнительных сведений об объекте в структурированном виде. форматирование и запрос объектов через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — строки с максимальной длиной 512 символов.	Нет
method	OpenAI.FineTuneMethod	Метод, используемый для точной настройки.	Нет
модель	строка (см. допустимые модели ниже)	Имя модели для точной настройки. Вы можете выбрать один из них. поддерживаемые модели.	Да
seed	OpenAI.integer (nullable)		Нет
Суффикс	Строка (нулевая)	Строка длиной до 64 символов, которая будет добавлена к имени настраиваемой модели. Например, suffix "custom-model-name" даст имя модели, подобное ft:gpt-4o-mini:openai:custom-model-name:7p4lURel. Ограничения: minLength: 1, maxLength: 64	Нет
файл_обучения	строка	Идентификатор отправленного файла, содержащего данные обучения. Сведения о том, как отправить файл, см. в разделе "Отправка файла ". Набор данных должен быть отформатирован в формате JSONL-файла. Кроме того, необходимо загрузить ваш файл для цели fine-tune. Содержимое файла должно отличаться в зависимости от того, использует ли модель чат, формат завершения или использует ли метод тонкой настройки формат предпочтения . Дополнительные сведения см. в руководстве по тонкой настройке .	Да
Файл_валидации	Строка (нулевая)	Идентификатор отправленного файла, содержащего данные проверки. Если этот файл предоставлен, данные используются для создания валидации Метрики измеряются периодически во время тонкой настройки. Эти метрики можно просмотреть в файл результатов тонкой настройки. Одни и те же данные не должны присутствовать в файлах обучения и проверки. Набор данных должен быть отформатирован в формате JSONL-файла. Необходимо загрузить файл с целью fine-tune. Дополнительные сведения см. в руководстве по тонкой настройке .	Нет

Responses

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

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

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

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

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

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

Список заданий тонкой настройки с разбивкой на страницы

GET {endpoint}/openai/v1/fine_tuning/jobs?api-version=v1

Перечислите задания по тонкой настройке вашей организации

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
После	query	Нет	строка	Идентификатор последнего задания из предыдущего запроса на страницы.
limit	query	Нет	целое число	Количество получаемых заданий точной настройки.
версия API	query	Да	строка	Версия API, используемая для данной операции.

Responses

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

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

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

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

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

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

Получение задания тонкой настройки

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}?api-version=v1

Получение сведений о задаче тонкой настройки.

Дополнительные сведения о тонкой настройке

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
идентификатор_задания_тончайшей_настройки	path	Да	строка	Идентификатор задачи тонкой настройки.
версия API	query	Да	строка	Версия API, используемая для данной операции.

Responses

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

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

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

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

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

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

Отмена задания тонкой настройки

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/cancel?api-version=v1

Немедленно отмените задание настройки.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
идентификатор_задания_тончайшей_настройки	path	Да	строка	Идентификатор задания тонкой настройки для отмены.
версия API	query	Да	строка	Версия API, используемая для данной операции.

Responses

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

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

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

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

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

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

Перечисление контрольных точек задания тонкой настройки

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints?api-version=v1

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

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
идентификатор_задания_тончайшей_настройки	path	Да	строка	Идентификатор задачи тонкой настройки для получения контрольных точек.
После	query	Нет	строка	Идентификатор последней контрольной точки из предыдущего запроса на разбивку на страницы.
limit	query	Нет	целое число	Количество контрольных точек для получения.
версия API	query	Да	строка	Версия API, используемая для данной операции.

Responses

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

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

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

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

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

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

Перечисление событий точной настройки заданий

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/events?api-version=v1

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

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
идентификатор_задания_тончайшей_настройки	path	Да	строка	Идентификатор задачи для точной настройки для получения событий.
После	query	Нет	строка	Идентификатор последнего события из предыдущего запроса пагинации.
limit	query	Нет	целое число	Количество извлекаемых событий.
версия API	query	Да	строка	Версия API, используемая для данной операции.

Responses

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

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

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

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

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

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

Приостановка задания тонкой настройки

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/pause?api-version=v1

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

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
идентификатор_задания_тончайшей_настройки	path	Да	строка	Идентификатор задания тонкой настройки для приостановки.
версия API	query	Да	строка	Версия API, используемая для данной операции.

Responses

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

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

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

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

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

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

Возобновление задания тонкой настройки

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/resume?api-version=v1

Возобновите приостановленное задание по тонкой настройке.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
идентификатор_задания_тончайшей_настройки	path	Да	строка	Идентификатор задачи тонкой настройки для возобновления.
версия API	query	Да	строка	Версия API, используемая для данной операции.

Responses

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

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

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

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

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

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

Responses

Создание ответа — создание потока ответов

POST {endpoint}/openai/v1/responses

Создает модельный ответ. Создает ответ модели (потоковой ответ).

Тело запроса

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

Name	Type	Description	Обязательный	По умолчанию
agent_reference	AgentReference		Нет
└️ имя	строка	Имя агента. Ограничения: maxLength: 256	Да
└─ Тип	enum	Возможные значения: agent_reference	Да
└─ Версия	строка	Идентификатор версии агента.	Нет
фон	Булев (нулируемый)		Нет
разговор	OpenAI.ConversationParam (nullable)	Беседа, к которой относится этот ответ. Элементы из этой беседы предопределяются input_items для этого запроса ответа. Входные элементы и выходные элементы из этого ответа автоматически добавляются в эту беседу после завершения этого ответа.	Нет
Включают	массив OpenAI.IncludeEnum		Нет
input	OpenAI.InputParam	Входные данные, такие как текст, изображения или файлы, в модель, используемые для генерации ответа. Подробнее: - Текстовые входные и выходные данные - Входные данные изображения - Входные данные файлов - Состояние беседы - Вызов функции	Нет
instructions	Строка (нулевая)		Нет
max_output_tokens	OpenAI.integer (nullable)		Нет
max_tool_calls	OpenAI.integer (nullable)		Нет
metadata	OpenAI.Metadata (nullable)	Набор из 16 пар "ключ-значение", которые можно прикрепить к объекту. Это может быть Полезно для хранения дополнительных сведений об объекте в структурированном виде. форматирование и запрос объектов через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — строки с максимальной длиной 512 символов.	Нет
модель	строка	Развертывание модели, используемое для создания этого ответа.	Нет
вызовы инструмента в параллельном режиме	Булев (нулируемый)		Нет	True
previous_response_id	Строка (нулевая)		Нет
prompt	OpenAI.Prompt	Ссылка на шаблон запроса и его переменные. Подробнее.	Нет
prompt_cache_key	строка	Используется OpenAI для кэширования ответов для аналогичных запросов для оптимизации частоты попаданий кэша. Заменяет user поле. Подробнее.	Нет
prompt_cache_retention	enum	Возможные значения: in-memory, 24h	Нет
reasoning	OpenAI.Reasoning (nullable)	Только модели gpt-5 и o-series Параметры конфигурации для модели рассуждений.	Нет
- усилия	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	enum	Возможные значения: auto, concisedetailed	Нет
└️ сводка	enum	Возможные значения: auto, concisedetailed	Нет
safety_identifier	строка	Стабильный идентификатор, используемый для обнаружения пользователей приложения, которые могут нарушать политики использования OpenAI. Идентификаторы должны быть строкой, которая однозначно идентифицирует каждого пользователя. Мы рекомендуем хэшировать имя пользователя или адрес электронной почты, чтобы избежать отправки нам каких-либо сведений об идентификации. Подробнее.	Нет
уровень обслуживания	OpenAI.ServiceTier	Указывает тип обработки, используемый для обслуживания запроса. — Если задано значение auto, запрос будет обработан с уровнем служб, настроенным в параметрах Project. Если иное не настроено, Project будет использовать значение по умолчанию. — Если задано значение "по умолчанию", запрос будет обработан со стандартными ценами и производительностью выбранной модели. — Если задано значение "flex" или "приоритет", запрос будет обработан соответствующим уровнем служб. — Если не задано, поведение по умолчанию — auto. service_tier Если параметр задан, текст ответа будет включать service_tier значение на основе режима обработки, который фактически использовался для обслуживания запроса. Это значение ответа может отличаться от значения, заданного в параметре.	Нет
store	Булев (нулируемый)		Нет	True
stream	Булев (нулируемый)		Нет
stream_options	OpenAI.ResponseStreamOptions (допускающий значение NULL)	Параметры потоковых ответов. Этот параметр устанавливается только при установке stream: true.	Нет
└include_obfuscation	boolean	Если задано значение true, будет включена обфускация потока. Добавляется скрытие потока случайные символы в поле потоковой передачи obfuscation событий разностных событий в нормализованные размеры полезных данных в качестве устранения определенных атак на стороне канала. Эти поля маскировки включены по умолчанию, но добавьте небольшое количество. затраты на поток данных. Можно задать include_obfuscation значение False для оптимизации пропускной способности, если вы доверяете сетевым каналам между приложение и API OpenAI.	Нет
structured_inputs	object	Структурированные входные данные ответа, которые могут участвовать в подстановке шаблона запроса или привязках аргументов инструментов.	Нет
Температура	OpenAI.numeric (nullable)		Нет	1
text	OpenAI.ResponseTextParam	Параметры конфигурации для текстового ответа модели. Может быть простым текстовые или структурированные данные JSON. Подробнее: - Текстовые входные и выходные данные - Структурированные выходные данные	Нет
выбор инструмента	OpenAI.ToolChoiceOptions или OpenAI.ToolChoiceParam		Нет
tools	OpenAI.ToolsArray	Массив инструментов, которые модель может вызывать при создании ответа. Вы может указать, какое средство следует использовать, задав tool_choice параметр. Мы поддерживаем следующие категории инструментов: - Встроенные инструменты: инструменты, предоставляемые OpenAI для расширения Возможности модели, такие как поиск в Интернете или поиск по файлам. Дополнительные сведения встроенные средства. - Инструменты MCP: интеграция с сторонними системами с помощью пользовательских серверов MCP или предопределенные соединители, такие как Google Drive и SharePoint. Дополнительные сведения Инструменты MCP. - Вызовы функций (пользовательские средства): функции, определенные вами, включение модели для вызова собственного кода с строго типизированными аргументами и выходные данные. Дополнительные сведения вызов функции. Вы также можете использовать пользовательские средства для вызова собственного кода.	Нет
top_logprobs	OpenAI.integer (nullable)		Нет
top_p	OpenAI.numeric (nullable)		Нет	1
truncation	enum	Возможные значения: auto, disabled	Нет
user	string (не рекомендуется)	Это поле заменяется safety_identifier и prompt_cache_key. Вместо этого используйте prompt_cache_key для поддержания оптимизации кэширования. Стабильный идентификатор для конечных пользователей. Используется для повышения скорости попадания кэша в более эффективное сегментирование аналогичных запросов и помогает OpenAI обнаруживать и предотвращать злоупотребление. Подробнее.	Нет

Responses

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

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

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

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

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

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

Вывод списка ответов

GET {endpoint}/openai/v1/responses

Возвращает список всех ответов.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
limit	query	Нет	целое число	Ограничение количества возвращаемых объектов. Ограничение может варьироваться от 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, чтобы получить предыдущую страницу списка.
agent_name	query	Нет	строка	Фильтруйте по имени агента. При условии возвращаются только элементы, связанные с указанным агентом.
agent_id	query	Нет	строка	Фильтрация по идентификатору агента в формате name:version. Если указано, будут возвращены только элементы, связанные с указанным идентификатором агента.
conversation_id	query	Нет	строка	Фильтрация по идентификатору беседы. Если это указано, будут возвращены только ответы, связанные с указанной беседой.

Responses

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

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

Тип содержимого	Type	Description
application/json	object	Данные ответа для запрошенного списка элементов.

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

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

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

Компактный диалог ответа

POST {endpoint}/openai/v1/responses/compact

Создает сжатие беседы с ответами.

Тело запроса

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

Name	Type	Description	Обязательный	По умолчанию
input	строка или массив OpenAI.InputItem		Нет
instructions	Строка (нулевая)		Нет
модель	OpenAI.ModelIdsCompaction	Идентификатор модели, используемый для создания ответа, например gpt-5 или o3. OpenAI предлагает широкий спектр моделей с разными возможностями, характеристиками производительности и ценами. Ознакомьтесь с руководством по модели для просмотра и сравнения доступных моделей.	Да
previous_response_id	Строка (нулевая)		Нет

Responses

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

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

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

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

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

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

Получение ответа — получение потока ответа

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

Извлекает ответ модели с заданным идентификатором. Извлекает ответ модели с заданным идентификатором (ответ потоковой передачи).

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
response_id	path	Да	строка
include[]	query	Нет	массив
stream	query	Нет	boolean
starting_after	query	Нет	целое число

Заголовок запроса

Name	Обязательный	Type	Description
принимать	Неправда	строка Возможные значения: text/event-stream

Responses

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

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

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

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

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

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

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

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

Удаляет ответ модели.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
response_id	path	Да	строка	Идентификатор ответа для удаления.

Responses

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

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

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

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

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

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

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

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

Отменяет ответ модели.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
response_id	path	Да	строка	Идентификатор ответа на отмену.

Responses

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

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

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

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

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

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

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

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

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

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
response_id	path	Да	строка
limit	query	Нет	целое число	Ограничение количества возвращаемых объектов. Ограничение может варьироваться от 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	object	Данные ответа для запрошенного списка элементов.

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

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

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

Redteams

Redteams — список

GET {endpoint}/redTeams/runs?api-version=v1

Вывод списка redteam по имени.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
версия API	query	Да	строка	Версия API, используемая для данной операции.

Заголовок запроса

Name	Обязательный	Type	Description
Foundry-Features	True	строка Возможные значения: RedTeams=V1Preview	Флаг функции, необходимый при использовании операций предварительной версии или изменении сохраненных ресурсов предварительной версии.

Responses

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

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

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

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

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

Тип содержимого	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

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

Заголовка	Type	Description
X-ms-error-code	строка	Код строковой ошибки, указывающий на то, что произошло неправильно.

Красные команды — идите

GET {endpoint}/redTeams/runs/{name}?api-version=v1

Получите redteam по имени.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
версия API	query	Да	строка	Версия API, используемая для данной операции.
имя	path	Да	строка	Идентификатор запуска красной команды.

Заголовок запроса

Name	Обязательный	Type	Description
Foundry-Features	True	строка Возможные значения: RedTeams=V1Preview	Флаг функции, необходимый при использовании операций предварительной версии или изменении сохраненных ресурсов предварительной версии.

Responses

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

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

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

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

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

Тип содержимого	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

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

Заголовка	Type	Description
X-ms-error-code	строка	Код строковой ошибки, указывающий на то, что произошло неправильно.

Redteams — создание

POST {endpoint}/redTeams/runs:run?api-version=v1

Создает выполнение redteam.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
версия API	query	Да	строка	Версия API, используемая для данной операции.

Заголовок запроса

Name	Обязательный	Type	Description
Foundry-Features	True	строка Возможные значения: RedTeams=V1Preview	Флаг функции, необходимый при использовании операций предварительной версии или изменении сохраненных ресурсов предварительной версии.

Тело запроса

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

Name	Type	Description	Обязательный	По умолчанию
applicationScenario	строка	Сценарий приложения для операции красной команды для создания конкретных атак сценария.	Нет
атакиStrategies	массив АтакStrategy	Список стратегий атак или вложенных списков стратегий атак.	Нет
displayName	строка	Имя запуска red-team.	Нет
id	строка (только для чтения)	Идентификатор запуска красной команды.	Да
numTurns	целое число	Количество округлений моделирования.	Нет
properties	object	Свойства красной команды. В отличие от тегов, свойства являются только надстройками. После добавления свойство невозможно удалить.	Нет
Категории рисков	массив RiskCategory	Список категорий рисков для создания целей атаки.	Нет
имитацияOnly	boolean	Только имитация или моделирование + оценка. Значение false по умолчанию, если значение true для беседы сканирования не выполняется вычисление.	Нет	Неправда
Статус	строка (только для чтения)	Состояние красной команды. Он устанавливается службой и доступен только для чтения.	Нет
tags	object	Теги красной команды. В отличие от свойств, теги полностью изменяются.	Нет
target	TargetConfig	Абстрактный класс для целевой конфигурации.	Да
└─ Тип	строка	Тип конфигурации модели.	Да

Responses

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

Описание: запрос успешно выполнен, и в результате был создан новый ресурс.

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

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

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

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

Schedules

Расписания — список

GET {endpoint}/schedules?api-version=v1

Вывод списка всех расписаний.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
версия API	query	Да	строка	Версия API, используемая для данной операции.
type	query	Нет	строка Возможные значения: Evaluation, Insight	Фильтруйте по типу расписания.
enabled	query	Нет	boolean	Фильтруйте по включенном состоянию.

Заголовок запроса

Name	Обязательный	Type	Description
Foundry-Features	True	строка Возможные значения: Schedules=V1Preview	Флаг функции, необходимый при использовании операций предварительной версии или изменении сохраненных ресурсов предварительной версии.

Responses

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

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

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

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

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

Тип содержимого	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

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

Заголовка	Type	Description
X-ms-error-code	строка	Код строковой ошибки, указывающий на то, что произошло неправильно.

Расписания — удаление

DELETE {endpoint}/schedules/{id}?api-version=v1

Удалить расписание.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
версия API	query	Да	строка	Версия API, используемая для данной операции.
id	path	Да	строка	Идентификатор расписания.

Заголовок запроса

Name	Обязательный	Type	Description
Foundry-Features	True	строка Возможные значения: Schedules=V1Preview	Флаг функции, необходимый при использовании операций предварительной версии или изменении сохраненных ресурсов предварительной версии.

Responses

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

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

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

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

Тип содержимого	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

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

Заголовка	Type	Description
X-ms-error-code	строка	Код строковой ошибки, указывающий на то, что произошло неправильно.

Расписания — получение

GET {endpoint}/schedules/{id}?api-version=v1

Получение расписания по идентификатору.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
версия API	query	Да	строка	Версия API, используемая для данной операции.
id	path	Да	строка	Идентификатор расписания.

Заголовок запроса

Name	Обязательный	Type	Description
Foundry-Features	True	строка Возможные значения: Schedules=V1Preview	Флаг функции, необходимый при использовании операций предварительной версии или изменении сохраненных ресурсов предварительной версии.

Responses

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

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

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

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

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

Тип содержимого	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

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

Заголовка	Type	Description
X-ms-error-code	строка	Код строковой ошибки, указывающий на то, что произошло неправильно.

Расписания — создание или обновление

PUT {endpoint}/schedules/{id}?api-version=v1

Создание или обновление шаблона операции.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
версия API	query	Да	строка	Версия API, используемая для данной операции.
id	path	Да	строка	Идентификатор расписания.

Заголовок запроса

Name	Обязательный	Type	Description
Foundry-Features	True	строка Возможные значения: Schedules=V1Preview	Флаг функции, необходимый при использовании операций предварительной версии или изменении сохраненных ресурсов предварительной версии.

Тело запроса

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

Name	Type	Description	Обязательный	По умолчанию
описание	строка	Описание расписания.	Нет
displayName	строка	Имя расписания.	Нет
enabled	boolean	Включено состояние расписания.	Да
id	строка (только для чтения)	Идентификатор расписания.	Да
properties	object	Свойства расписания. В отличие от тегов, свойства являются только надстройками. После добавления свойство невозможно удалить.	Нет
provisioningStatus	ScheduleProvisioningStatus (только для чтения)	Состояние подготовки расписания.	Нет
данные системы	object (только для чтения)	Системные метаданные ресурса.	Да
tags	object	Теги расписания. В отличие от свойств, теги полностью изменяются.	Нет
Задача	ScheduleTask	Модель задачи планирования.	Да
Конфигурация └️	object	Конфигурация для задачи.	Нет
└─ Тип	ScheduleTaskType	Тип задачи.	Да
trigger	Trigger	Базовая модель для триггера расписания.	Да
└─ Тип	TriggerType	Тип спускового крючка.	Да

Responses

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

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

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

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

Описание: запрос успешно выполнен, и в результате был создан новый ресурс.

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

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

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

Тип содержимого	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

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

Заголовка	Type	Description
X-ms-error-code	строка	Код строковой ошибки, указывающий на то, что произошло неправильно.

Расписания — запуски списка

GET {endpoint}/schedules/{id}/runs?api-version=v1

Перечислить все запуски расписания.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
версия API	query	Да	строка	Версия API, используемая для данной операции.
id	path	Да	строка	Идентификатор расписания.
type	query	Нет	строка Возможные значения: Evaluation, Insight	Фильтруйте по типу расписания.
enabled	query	Нет	boolean	Фильтруйте по включенном состоянию.

Заголовок запроса

Name	Обязательный	Type	Description
Foundry-Features	True	строка Возможные значения: Schedules=V1Preview	Флаг функции, необходимый при использовании операций предварительной версии или изменении сохраненных ресурсов предварительной версии.

Responses

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

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

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

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

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

Тип содержимого	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

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

Заголовка	Type	Description
X-ms-error-code	строка	Код строковой ошибки, указывающий на то, что произошло неправильно.

Расписания — получение запуска

GET {endpoint}/schedules/{schedule_id}/runs/{run_id}?api-version=v1

Получение расписания выполнения по идентификатору.

Параметры URI

Name	In	Обязательный	Type	Description
endpoint	path	Да	строка	Конечная точка Project foundry в форме "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Если у вас есть только один Project в Центре Foundry или нацелить Project по умолчанию в Центре используйте форму "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
schedule_id	path	Да	строка	Уникальный идентификатор расписания.
run_id	path	Да	строка	Уникальный идентификатор выполнения расписания.
версия API	query	Да	строка	Версия API, используемая для данной операции.

Заголовок запроса

Name	Обязательный	Type	Description
Foundry-Features	True	строка Возможные значения: Schedules=V1Preview	Флаг функции, необходимый при использовании операций предварительной версии или изменении сохраненных ресурсов предварительной версии.

Responses

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

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

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

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

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

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

Components

A2APreviewTool

Агент, реализующий протокол A2A.

Name	Type	Description	Обязательный	По умолчанию
agent_card_path	строка	Путь к карточке агента относительно .base_url Если не указано, по умолчанию используется значение /.well-known/agent-card.json	Нет
base_url	строка	Базовый URL агента.	Нет
project_connection_id	строка	Идентификатор подключения в project для сервера A2A. Соединение хранит аутентификацию и другие сведения о подключении, необходимые для подключения к серверу A2A.	Нет
type	enum	Тип средства. Всегда "a2a_preview. Возможные значения: a2a_preview	Да

AISearchIndexResource

Ресурс индекса поиска AI.

Name	Type	Description	Обязательный	По умолчанию
filter	строка	Строка фильтра для ресурса поиска. Дополнительные сведения см. здесь.	Нет
index_asset_id	строка	Идентификатор ресурса индекса для ресурса поиска.	Нет
имя_индекса	строка	Имя индекса в индексе, подключенном к этому агенту.	Нет
project_connection_id	строка	Идентификатор подключения индекса в indexResource, присоединенном к этому агенту.	Нет
тип_запроса	AzureAISearchQueryType	Доступные типы запросов для инструмента Поиск с использованием ИИ Azure.	Нет
top_k	целое число	Количество документов для извлечения из поиска и представления модели.	Нет

AgentClusterInsightRequest

Анализ набора результатов оценки операторов

Name	Type	Description	Обязательный	По умолчанию
agentName	строка	Идентификатор агента.	Да
ModelConfiguration	InsightsModelConfiguration	Конфигурация модели, используемой при создании аналитических сведений.	Нет
└️ modelDeploymentName	строка	Вычислить развертывание модели. Принимает только имя развертывания или имя подключения как {connectionName}/<modelDeploymentName>.	Да
type	enum	Тип запроса. Возможные значения: AgentClusterInsight	Да

AgentClusterInsightResult

Выводы из кластерного анализа агентов.

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

AgentContainerObject

Сведения о контейнере определенной версии агента.

Name	Type	Description	Обязательный	По умолчанию
container	ContainerDetails (только для чтения)	Подробные сведения о контейнере.	Нет
└health_state	строка	Состояние работоспособности контейнера.	Да
└️ provisioning_error	строка	Ошибка подготовки контейнера, если она есть.	Нет
└provisioning_state	строка	Состояние подготовки контейнера.	Да
Реплики └️	массив ContainerReplica	Список реплик в контейнере.	Да
Состояние └️	строка	Состояние контейнера.	Да
└️ updated_on	строка	Время последнего обновления контейнера.	Да
создано_в	строка	Время создания контейнера.	Да
error_message	строка (только для чтения)	Сообщение об ошибке, если контейнер не работал, если таковой не выполнен.	Нет
id	строка (только для чтения)	Идентификатор контейнера.	Нет
max_replicas	целое число	Максимальное количество реплик для контейнера. По умолчанию 1.	Нет
min_replicas	целое число	Минимальное количество реплик для контейнера. По умолчанию 1.	Нет
object	enum	Тип объекта, который всегда является agent.container. Возможные значения: agent.container	Да
Статус	AgentContainerStatus (только для чтения)	Состояние контейнера определенной версии агента.	Да
updated_at	строка	Время последнего обновления контейнера.	Да

AgentContainerOperationError

Сведения об ошибке операции контейнера, если таковые есть.

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

AgentContainerOperationObject

Операция контейнера для определенной версии агента.

Name	Type	Description	Обязательный	По умолчанию
agent_id	строка	Идентификатор агента.	Да
agent_version_id	строка	Идентификатор версии агента.	Да
container	AgentContainerObject	Сведения о контейнере определенной версии агента.	Нет
Контейнер └️	ContainerDetails (только для чтения)	Подробные сведения о контейнере.	Нет
└️ created_at	строка (только для чтения)	Время создания контейнера.	Да
└️ error_message	строка (только для чтения)	Сообщение об ошибке, если контейнер не работал, если таковой не выполнен.	Нет
Идентификатор └️	строка (только для чтения)	Идентификатор контейнера.	Нет
└️ max_replicas	целое число	Максимальное количество реплик для контейнера. По умолчанию 1.	Нет
└min_replicas	целое число	Минимальное количество реплик для контейнера. По умолчанию 1.	Нет
└─ Объект	enum	Тип объекта, который всегда является agent.container. Возможные значения: agent.container	Да
└─ Состояние	AgentContainerStatus (только для чтения)	Состояние контейнера определенной версии агента.	Да
└updated_at updated_at	строка (только для чтения)	Время последнего обновления контейнера.	Да
error	AgentContainerOperationError	Сведения об ошибке операции контейнера, если таковые есть.	Нет
└─ Код	строка	Код ошибки операции контейнера, если таковой есть.	Да
Сообщение └️	строка	Сообщение об ошибке операции контейнера, если таковой есть.	Да
└─ Тип	строка	Тип ошибки операции контейнера, если таковой есть.	Да
id	строка	Идентификатор операции контейнера. Этот идентификатор является уникальным идентификатором в системе.	Да
Статус	AgentContainerOperationStatus	Состояние операции контейнера для определенной версии агента.	Да

AgentContainerOperationStatus

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

Property	Ценность
Type	строка
Значения	NotStarted InProgress Succeeded Failed

AgentContainerStatus

Состояние контейнера определенной версии агента.

Property	Ценность
Type	строка
Значения	Starting Running Stopping Stopped Failed Deleting Deleted Updating

AgentDefinition

Дискриминация для AgentDefinition

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

Значение типа	Schema
prompt	PromptAgentDefinition
workflow	WorkflowAgentDefinition
hosted	HostedAgentDefinition
container_app	ContainerAppAgentDefinition

Name	Type	Description	Обязательный	По умолчанию
kind	AgentKind		Да
rai_config	RaiConfig	Конфигурация для фильтрации содержимого и функций безопасности Responsible AI (RAI).	Нет
└rai_policy_name	строка	Имя политики RAI, применяемой.	Да

AgentKind

Property	Ценность
Type	строка
Значения	prompt hosted container_app workflow

AgentObject

Name	Type	Description	Обязательный	По умолчанию
id	строка	Уникальный идентификатор агента.	Да
имя	строка	Имя агента. Ограничения: maxLength: 63	Да
object	enum	Тип объекта, который всегда является агентом. Возможные значения: agent	Да
versions	object	Последняя версия агента.	Да
└️ последняя версия	AgentVersionObject		Да

AgentProtocol

Property	Ценность
Type	строка
Значения	activity_protocol responses

AgentReference

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

AgentTaxonomyInput

Конфигурация входных данных для таксономии оценки, если тип ввода — agent.

Name	Type	Description	Обязательный	По умолчанию
Категории рисков	массив RiskCategory	Список категорий рисков для оценки.	Да
target	Цель	Базовый класс для целей с поддержкой дискриминаторов.	Да
└─ Тип	строка	Тип целевого объекта.	Да
type	enum	Тип входных данных для таксономии оценки. Возможные значения: agent	Да

AgentTaxonomyInputUpdate

Конфигурация входных данных для таксономии оценки, если тип ввода — agent.

Name	Type	Description	Обязательный	По умолчанию
Категории рисков	массив RiskCategory	Список категорий рисков для оценки.	Нет
target	TargetUpdate	Базовый класс для целей с поддержкой дискриминаторов.	Нет
└─ Тип	строка	Тип целевого объекта.	Да
type	enum	Тип входных данных для таксономии оценки. Возможные значения: agent	Да

AgentVersionObject

Name	Type	Description	Обязательный	По умолчанию
создано_в	целое число	Временная метка Unix (в секундах) на момент создания агента.	Да
Определение	AgentDefinition		Да
описание	строка	Понятное описание агента. Ограничения: maxLength: 512	Нет
id	строка	Уникальный идентификатор версии агента.	Да
metadata	Объект (нулируемый)	Набор из 16 пар "ключ-значение", которые можно прикрепить к объекту. Это может быть Полезно для хранения дополнительных сведений об объекте в структурированном виде. форматирование и запрос объектов через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — строки с максимальной длиной 512 символов.	Да
имя	строка	Имя агента. Имя может быть использовано для получения/обновления/удаления агента. Ограничения: maxLength: 256	Да
object	enum	Тип объекта, которым всегда является 'agent.version'. Возможные значения: agent.version	Да
version	строка	Идентификатор версии агента. Агенты неизменяемы, и каждое обновление создает новую версию с сохранением того же имени.	Да

AgenticIdentityPreviewCredentials

Определение учетных данных удостоверения агента

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

ApiErrorResponse

Ответ об ошибке при сбоях API.

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

ApiKeyCredentials

Определение учетных данных ключа API

Name	Type	Description	Обязательный	По умолчанию
key	строка (только для чтения)	Ключ API	Нет
type	enum	Тип учетных данных Возможные значения: ApiKey	Да

AssetCredentialResponse

Представляет ссылку на большой двоичный объект для использования

Name	Type	Description	Обязательный	По умолчанию
BLOBReference	BlobReference	Сведения о ссылке на BLOB-объекты.	Да
└️ blobUri	строка	Путь URI большого двоичного объекта для клиента для отправки данных. Пример: https://blob.windows.core.net/Container/Path	Да
Учетные данные └️	SasCredential	Учетные данные для доступа к учетной записи хранения.	Да
└️ storageAccountArmId	строка	Идентификатор ARM учетной записи хранения, используемой.	Да

Идентификатор актива

Идентификатор сохраненного ресурса.

Тип: строка

АтакаStrategy

Стратегии атак.

Property	Ценность
Description	Стратегии атак.
Type	строка
Значения	easy moderate difficult ascii_art ascii_smuggler atbash base64 binary caesar character_space jailbreak ansi_attack character_swap suffix_append string_join unicode_confusable unicode_substitution diacritic flip leetspeak rot13 morse url baseline indirect_jailbreak tense multi_turn crescendo

Azure. Core.Foundations.Error

Объект ошибки.

Name	Type	Description	Обязательный	По умолчанию
code	строка	Один из определяемых сервером кодов ошибок.	Да
details	массив Azure. Core.Foundations.Error	Массив сведений об определенных ошибках, которые привели к этой сообщаемой ошибке.	Нет
innererror	Azure. Core.Foundations.InnerError	Объект, содержащий более конкретные сведения об ошибке. Согласно Azure рекомендациям REST API — https://aka.ms/AzureRestApiGuidelines#handling-errors.	Нет
└─ Код	строка	Один из определяемых сервером кодов ошибок.	Нет
└️ innererror	Azure. Core.Foundations.InnerError	Внутренняя ошибка.	Нет
message	строка	Читаемое пользователем представление ошибки.	Да
target	строка	Целевой объект ошибки.	Нет

Azure. Core.Foundations.ErrorResponse

Ответ, содержащий сведения об ошибке.

Name	Type	Description	Обязательный	По умолчанию
error	Azure. Core.Foundations.Error	Объект ошибки.	Да
└─ Код	строка	Один из определяемых сервером кодов ошибок.	Да
└️ подробности	массив Azure. Core.Foundations.Error	Массив сведений об определенных ошибках, которые привели к этой сообщаемой ошибке.	Нет
└️ innererror	Azure. Core.Foundations.InnerError	Объект, содержащий более конкретные сведения, чем текущий объект об ошибке.	Нет
Сообщение └️	строка	Читаемое пользователем представление ошибки.	Да
Целевой объект └️	строка	Целевой объект ошибки.	Нет

Azure. Core.Foundations.InnerError

Объект, содержащий более конкретные сведения об ошибке. Согласно Azure рекомендациям REST API — https://aka.ms/AzureRestApiGuidelines#handling-errors.

Name	Type	Description	Обязательный	По умолчанию
code	строка	Один из определяемых сервером кодов ошибок.	Нет
innererror	Azure. Core.Foundations.InnerError	Объект, содержащий более конкретные сведения об ошибке. Согласно Azure рекомендациям REST API — https://aka.ms/AzureRestApiGuidelines#handling-errors.	Нет
└─ Код	строка	Один из определяемых сервером кодов ошибок.	Нет
└️ innererror	Azure. Core.Foundations.InnerError	Внутренняя ошибка.	Нет

Azure. Core.Foundations.OperationState

Перечисление, описывающее разрешенные состояния операций.

Property	Ценность
Description	Перечисление, описывающее разрешенные состояния операций.
Type	строка
Значения	NotStarted Running Succeeded Failed Canceled

Azure. Core.uuid

Универсальный уникальный идентификатор

Тип: строка

Формат: uuid

AzureAIAgentTarget

Представляет цель, указывающую агент AI Azure.

Name	Type	Description	Обязательный	По умолчанию
имя	строка	Уникальный идентификатор агента Azure ИИ.	Да
tool_descriptions	массив ToolDescription	Параметры, используемые для управления поведением выборки агента во время создания текста.	Нет
type	enum	Тип цели, всегда azure_ai_agent. Возможные значения: azure_ai_agent	Да
version	строка	Версия агента Azure ИИ.	Нет

AzureAIAgentTargetUpdate

Представляет цель, указывающую агент AI Azure.

Name	Type	Description	Обязательный	По умолчанию
имя	строка	Уникальный идентификатор агента Azure ИИ.	Нет
tool_descriptions	массив ToolDescription	Параметры, используемые для управления поведением выборки агента во время создания текста.	Нет
type	enum	Тип цели, всегда azure_ai_agent. Возможные значения: azure_ai_agent	Да
version	строка	Версия агента Azure ИИ.	Нет

AzureAIDataSourceConfig

Name	Type	Description	Обязательный	По умолчанию
сценарий	enum	Сценарий схемы данных. Возможные значения: red_team, , responsestraces_previewsynthetic_data_gen_preview	Да
schema	object	Общая схема JSON объекта для элементов источника данных запуска.	Да
type	enum	Тип объекта, который всегда является azure_ai_source. Возможные значения: azure_ai_source	Да

AzureAIModelTarget

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

Name	Type	Description	Обязательный	По умолчанию
модель	строка	Уникальный идентификатор модели Azure ИИ.	Нет
параметры выборки	ModelSamplingParams	Представляет набор параметров, используемых для управления поведением выборки языковой модели во время создания текста.	Нет
└─max_completion_tokens	целое число	Максимальное число маркеров, разрешенных в завершении.	Да
Начальное значение └️	целое число	Случайное начальное значение для воспроизведения.	Да
└─ Температура	number	Параметр температуры для выборки.	Да
└️ top_p	number	Параметр top-p для выборки ядра.	Да
type	enum	Тип цели, всегда azure_ai_model. Возможные значения: azure_ai_model	Да

AzureAIModelTargetUpdate

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

Name	Type	Description	Обязательный	По умолчанию
модель	строка	Уникальный идентификатор модели Azure ИИ.	Нет
параметры выборки	ModelSamplingParamsUpdate	Представляет набор параметров, используемых для управления поведением выборки языковой модели во время создания текста.	Нет
└─max_completion_tokens	целое число	Максимальное число маркеров, разрешенных в завершении.	Нет
Начальное значение └️	целое число	Случайное начальное значение для воспроизведения.	Нет
└─ Температура	number	Параметр температуры для выборки.	Нет
└️ top_p	number	Параметр top-p для выборки ядра.	Нет
type	enum	Тип цели, всегда azure_ai_model. Возможные значения: azure_ai_model	Да

AzureAIResponsesEvalRunDataSource

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

Name	Type	Description	Обязательный	По умолчанию
event_configuration_id	строка	Имя конфигурации события, связанное с этим запуском оценки.	Да
item_generation_params	ResponseRetrievalItemGenerationParams	Представляет параметры для создания элемента извлечения ответа.	Да
└️ data_mapping	object	Сопоставление из исходных полей в поле response_id, необходимое для получения журнала чата.	Да
└max_num_turns	целое число	Максимальное количество поворотов журнала чата для вычисления.	Да
└─ Источник	OpenAI.EvalJsonlFileContentSource или OpenAI.EvalJsonlFileIdSource	Источник, из которого считывается содержимое JSONL.	Да
└─ Тип	enum	Тип параметров создания элементов всегда response_retrieval. Возможные значения: response_retrieval	Да
max_runs_hourly	целое число	Максимальное количество запусков оценки, разрешенных в час.	Да
type	enum	Тип источника данных всегда azure_ai_responses. Возможные значения: azure_ai_responses	Да

Индекс поиска Azure AI

Определение индекса Поиск с использованием ИИ Azure

Name	Type	Description	Обязательный	По умолчанию
id	строка (только для чтения)	Asset ID — уникальный идентификатор актива	Нет
имя	строка (только для чтения)	Имя ресурса.	Да
type	enum	Тип индекса Возможные значения: AzureSearch	Да
version	строка (только для чтения)	Версия ресурса	Да

AzureAISearchIndexUpdate

Определение индекса Поиск с использованием ИИ Azure

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

AzureAISearchQueryType

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

Property	Ценность
Description	Доступные типы запросов для инструмента Поиск с использованием ИИ Azure.
Type	строка
Значения	simple semantic vector vector_simple_hybrid vector_semantic_hybrid

AzureAISearchTool

Входная информация о определении для инструмента поиска Azure AI, используемого для настройки агента.

Name	Type	Description	Обязательный	По умолчанию
azure_ai_search	AzureAISearchToolResource	Набор ресурсов индекса, используемых средством azure_ai_search.	Да
Индексы └️	массив AISearchIndexResource	Индексы, присоединенные к этому агенту. Может быть не более 1 индекса ресурс, подключенный к агенту. Ограничения: maxItems: 1	Да
type	enum	Тип объекта, который всегда равен 'azure_ai_search'. Возможные значения: azure_ai_search	Да

AzureAISearchToolResource

Набор ресурсов индекса, используемых средством azure_ai_search.

Name	Type	Description	Обязательный	По умолчанию
индексы	массив AISearchIndexResource	Индексы, присоединенные к этому агенту. Может быть не более 1 индекса ресурс, подключенный к агенту.	Да

AzureFunctionBinding

Структура хранения имени очереди storage и URI.

Name	Type	Description	Обязательный	По умолчанию
storage_queue	AzureFunctionStorageQueue	Структура хранения имени очереди storage и URI.	Да
└queue_name	строка	Имя очереди хранилища функций Azure.	Да
└️ queue_service_endpoint	строка	Универсальный код ресурса (URI) в службу очередей служба хранилища Azure, позволяющий управлять очередью.	Да
type	enum	Тип привязки, который всегда является "storage_queue". Возможные значения: storage_queue	Да

AzureFunctionDefinition

Определение функции Azure.

Name	Type	Description	Обязательный	По умолчанию
function	object	Определение функции Azure и ее параметров.	Да
└─ Описание	строка	Описание того, что выполняет функция, используемая моделью для выбора времени и способа вызова функции.	Нет
└️ имя	строка	Имя вызываемой функции.	Да
└️ Параметры	object	Параметры, которые принимают функции, описаны как объект схемы JSON.	Да
input_binding	AzureFunctionBinding	Структура хранения имени очереди storage и URI.	Да
└️ storage_queue	AzureFunctionStorageQueue	Очередь хранилища.	Да
└─ Тип	enum	Тип привязки, который всегда является "storage_queue". Возможные значения: storage_queue	Да
output_binding	AzureFunctionBinding	Структура хранения имени очереди storage и URI.	Да
└️ storage_queue	AzureFunctionStorageQueue	Очередь хранилища.	Да
└─ Тип	enum	Тип привязки, который всегда является "storage_queue". Возможные значения: storage_queue	Да

AzureFunctionStorageQueue

Структура хранения имени очереди storage и URI.

Name	Type	Description	Обязательный	По умолчанию
queue_name	строка	Имя очереди хранилища функций Azure.	Да
queue_service_endpoint	строка	Универсальный код ресурса (URI) в службу очередей служба хранилища Azure, позволяющий управлять очередью.	Да

AzureFunctionTool

Входная информация о определении для инструмента функции Azure, используемая для настройки агента.

Name	Type	Description	Обязательный	По умолчанию
azure_function	AzureFunctionDefinition	Определение функции Azure.	Да
Функция └️	object	Определение функции Azure и ее параметров.	Да
└─ Описание	строка	Описание того, что выполняет функция, используемая моделью для выбора времени и способа вызова функции.	Нет
└️ имя	строка	Имя вызываемой функции.	Да
└️ Параметры	object	Параметры, которые принимают функции, описаны как объект схемы JSON.	Да
└️ input_binding	AzureFunctionBinding	Очередь входного хранилища. Триггер хранилища очередей запускает функцию при добавлении в него сообщений.	Да
└️ output_binding	AzureFunctionBinding	Очередь выходного хранилища. Функция записывает выходные данные в эту очередь при обработке входных элементов.	Да
type	enum	Тип объекта, который всегда равен 'browser_automation'. Возможные значения: azure_function	Да

AzureOpenAIModelConfiguration

Azure конфигурации модели OpenAI. Версия API будет выбрана сервисом для запроса модели.

Name	Type	Description	Обязательный	По умолчанию
modelDeploymentName	строка	Имя развертывания для модели AOAI. Пример: gpt-4o, если в AIServices или на основе connection_name/deployment_name подключений (например, my-aoai-connection/gpt-4o).	Да
type	enum	Возможные значения: AzureOpenAIModel	Да

BaseCredentials

Базовый класс для учетных данных подключения

Дискриминация для BaseCredentials

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

Значение типа	Schema
ApiKey	ApiKeyCredentials
AAD	EntraIDCredentials
CustomKeys	CustomCredential
SAS	SASCredentials
None	NoAuthenticationCredentials
AgenticIdentityToken_Preview	AgenticIdentityPreviewCredentials

Name	Type	Description	Обязательный	По умолчанию
type	CredentialType (только для чтения)	Тип учетных данных, используемых подключением	Да

BingCustomSearchConfiguration

Конфигурация пользовательского поиска bing.

Name	Type	Description	Обязательный	По умолчанию
count	целое число	Количество результатов поиска, возвращаемых в ответе api bing	Нет
freshness	строка	Фильтрация результатов поиска по определенному диапазону времени. См. здесь принятые значения.	Нет
instance_name	строка	Имя настраиваемого экземпляра конфигурации, заданного для конфигурации.	Да
Рынке	строка	Рынок, из которого приходят результаты.	Нет
project_connection_id	строка	Project идентификатор подключения для приземления с помощью поиска bing	Да
set_lang	строка	Язык, используемый для строк пользовательского интерфейса при вызове API Bing.	Нет

BingCustomSearchPreviewTool

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

Name	Type	Description	Обязательный	По умолчанию
bing_custom_search_preview	BingCustomSearchToolParameters	Параметры пользовательского средства поиска bing.	Да
└search_configurations	массив BingCustomSearchConfiguration	Подключения project, подключенные к этому средству. Может быть не более 1 подключения ресурс, подключенный к средству. Ограничения: maxItems: 1	Да
type	enum	Тип объекта, который всегда «bing_custom_search_preview». Возможные значения: bing_custom_search_preview	Да

BingCustomSearchToolParameters

Параметры пользовательского средства поиска bing.

Name	Type	Description	Обязательный	По умолчанию
search_configurations	массив BingCustomSearchConfiguration	Подключения project, подключенные к этому средству. Может быть не более 1 подключения ресурс, подключенный к средству.	Да

BingGroundingSearchConfiguration

Настройка поиска для Bing Заземления

Name	Type	Description	Обязательный	По умолчанию
count	целое число	Количество результатов поиска, возвращаемых в ответе api bing	Нет
freshness	строка	Фильтрация результатов поиска по определенному диапазону времени. См. здесь принятые значения.	Нет
Рынке	строка	Рынок, из которого приходят результаты.	Нет
project_connection_id	строка	Project идентификатор подключения для приземления с помощью поиска bing	Да
set_lang	строка	Язык, используемый для строк пользовательского интерфейса при вызове API Bing.	Нет

BingGroundingSearchToolParameters

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

Name	Type	Description	Обязательный	По умолчанию
search_configurations	массив BingGroundingSearchConfiguration	Конфигурации поиска, подключенные к этому средству. Может быть не более 1 Ресурс конфигурации поиска, подключенный к средству.	Да

BingGroundingTool

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

Name	Type	Description	Обязательный	По умолчанию
bing_grounding	BingGroundingSearchToolParameters	Параметры средства поиска bing заземления.	Да
└search_configurations	массив BingGroundingSearchConfiguration	Конфигурации поиска, подключенные к этому средству. Может быть не более 1 Ресурс конфигурации поиска, подключенный к средству. Ограничения: maxItems: 1	Да
type	enum	Тип объекта, который всегда является "bing_grounding". Возможные значения: bing_grounding	Да

BlobReference

Сведения о ссылке на BLOB-объекты.

Name	Type	Description	Обязательный	По умолчанию
BLOBURI	строка	Путь URI большого двоичного объекта для клиента для отправки данных. Пример: https://blob.windows.core.net/Container/Path	Да
credential	SasCredential	Определение учетных данных SAS	Да
└️ sasUri	строка (только для чтения)	URI SAS	Да
└─ Тип	enum	Тип учетных данных Возможные значения: SAS	Да
storageAccountArmId	строка	Идентификатор ARM учетной записи хранения, используемой.	Да

BrowserAutomationPreviewTool

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

Name	Type	Description	Обязательный	По умолчанию
browser_automation_preview	BrowserAutomationToolParameters	Определение входных параметров для Browser Automation Tool.	Да
Подключение └️	BrowserAutomationToolConnectionParameters	Параметры подключения проекта, связанные с средством автоматизации браузера.	Да
type	enum	Тип объекта, который всегда является «browser_automation_preview». Возможные значения: browser_automation_preview	Да

BrowserAutomationToolConnectionParameters

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

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

BrowserAutomationToolParameters

Определение входных параметров для Browser Automation Tool.

Name	Type	Description	Обязательный	По умолчанию
connection	BrowserAutomationToolConnectionParameters	Определение входных параметров для соединения, используемого средством автоматизации браузера.	Да
└project_connection_id	строка	Идентификатор подключения проекта к ресурсу Azure Playwright.	Да

CaptureStructuredOutputsTool

Инструмент для фиксации структурированных выходных данных

Name	Type	Description	Обязательный	По умолчанию
outputs	StructuredOutputDefinition	Структурированные выходные данные, которые можно создать агентом.	Да
└─ Описание	строка	Описание выходных данных для выдачи. Используется моделью для определения времени выдачи выходных данных.	Да
└️ имя	строка	Имя структурированных выходных данных.	Да
└─ Схема	object	Схема JSON для структурированных выходных данных.	Да
└─ строгий	Булев (нулируемый)	Следует ли применять строгую проверку. trueпо умолчанию.	Да
type	enum	Тип средства. Всегда capture_structured_outputs. Возможные значения: capture_structured_outputs	Да

ChartCoordinate

Координаты для диаграммы анализа.

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

ChatSummaryMemoryItem

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

Name	Type	Description	Обязательный	По умолчанию
содержимое	строка	Содержимое памяти.	Да
kind	enum	Тип элемента памяти. Возможные значения: chat_summary	Да
memory_id	строка	Уникальный идентификатор элемента памяти.	Да
scope	строка	Пространство имен, которое логически группирует и изолирует воспоминания, например идентификатор пользователя.	Да
updated_at	целое число	Время последнего обновления элемента памяти.	Да

ClusterInsightResult

Выводы из кластерного анализа.

Name	Type	Description	Обязательный	По умолчанию
clusters	массив InsightsCluster	Список кластеров, определенных в аналитике.	Да
Координаты	object	Необязательное сопоставление идентификаторов с 2D-координатами, используемыми пользовательским интерфейсом для визуализации. Ключи карты — это строковые идентификаторы (например, идентификатор кластера или пример идентификатора) и значения — координаты и визуальный размер для отрисовки на трехмерной диаграмме. Это свойство опущено, если координаты клиентских запросов (например, путем передачи includeCoordinates=true в качестве параметра запроса). Пример: <br> {<br> "cluster-1": { "x": 12, "y": 34, "size": 8 },<br> "sample-123": { "x": 18, "y": 22, "size": 4 }<br> }<br> Координаты предназначены только для визуализации на стороне клиента и не используются измените результаты канонической аналитики.	Нет
summary	InsightsSummary	Сводка кластерного анализа ошибок.	Да
Метод └️	строка	Метод, используемый для кластеризации.	Да
└️ sampleCount	целое число	Общее количество проанализированных примеров.	Да
└️ uniqueClusterCount	целое число	Общее количество уникальных кластеров.	Да
└️ uniqueSubclusterCount	целое число	Общее количество уникальных меток подкластера.	Да
└─ использование	ClusterTokenUsage	Использование маркеров при выполнении анализа кластеризации	Да

ClusterTokenUsage

Использование токенов для кластерного анализа

Name	Type	Description	Обязательный	По умолчанию
inputTokenUsage	целое число	использование входного маркера	Да
outputTokenUsage	целое число	Использование маркера вывода	Да
totalTokenUsage	целое число	общее использование маркеров	Да

CodeBasedEvaluatorDefinition

Определение оценщика на основе кода с использованием кода Python

Name	Type	Description	Обязательный	По умолчанию
code_text	строка	Встроенный текст кода для вычислителя	Да
data_schema	object	Схема JSON (проект 2020-12) для входных данных оценщика. Это включает в себя такие параметры, как тип, свойства, обязательные.	Нет
init_parameters	object	Схема JSON (проект 2020-12) для входных параметров оценщика. Это включает в себя такие параметры, как тип, свойства, обязательные.	Нет
metrics	object	Список выходных метрик, полученных данным оценщиком	Нет
type	enum	Возможные значения: code	Да

ЗавершениеMessageToolCallChunk

Сведения о вызове средства в сообщении.

Name	Type	Description	Обязательный	По умолчанию
function	FunctionToolCall	Сведения о вызове средства функции.	Нет
└─ аргументы	строка	Аргументы, с которыми вызывается функция, генерируемые моделью в формате JSON.	Да
└️ имя	строка	Имя вызываемой функции.	Да
id	строка	Идентификатор вызова средства.	Да
type	enum	Тип вызова средства, который всегда является функцией. Возможные значения: function	Да

Подключение

Ответ из списка и операции получения соединений

Name	Type	Description	Обязательный	По умолчанию
credentials	BaseCredentials (только для чтения)	Базовый класс для учетных данных подключения	Да
└─ Тип	CredentialType (только для чтения)	Тип учетных данных, используемых подключением	Да
id	строка (только для чтения)	Уникальный идентификатор подключения, созданный службой	Да
isDefault	boolean (только для чтения)	Указывает, помечено ли соединение по умолчанию в качестве подключения по умолчанию для его типа.	Да
metadata	object (только для чтения)	Метаданные подключения	Да
имя	строка (только для чтения)	Понятное имя подключения, предоставленное пользователем.	Да
target	строка (только для чтения)	URL-адрес подключения, используемый для этой службы	Да
type	ConnectionType (только для чтения)	Тип (или категория) подключения	Да

ConnectionType

Тип (или категория) подключения

Property	Ценность
Description	Тип (или категория) подключения
Type	строка
Значения	AzureOpenAI AzureBlob AzureStorageAccount CognitiveSearch CosmosDB ApiKey AppConfig AppInsights CustomKeys RemoteTool_Preview

ContainerAppAgentDefinition

Определение агента приложения контейнера.

Name	Type	Description	Обязательный	По умолчанию
container_app_resource_id	строка	Идентификатор ресурса приложения контейнера Azure, на котором размещается этот агент. Не изменяется в разных версиях.	Да
container_protocol_versions	массив ProtocolVersionRecord	Протоколы, поддерживаемые агентом для входящего трафика контейнеров.	Да
ingress_subdomain_suffix	строка	Суффикс, применяемый к поддомену приложения при отправке входящего трафика агенту. Это может быть метка (например, ---current), определенная редакция (например, "--0000001" или пустая для использования конечной точки по умолчанию для приложения контейнера.	Да
kind	enum	Возможные значения: container_app	Да
rai_config	RaiConfig	Конфигурация для фильтрации содержимого и функций безопасности Responsible AI (RAI).	Нет
└rai_policy_name	строка	Имя политики RAI, применяемой.	Да

ContainerDetails

Подробные сведения о контейнере.

Name	Type	Description	Обязательный	По умолчанию
health_state	строка	Состояние работоспособности контейнера.	Да
provisioning_error	строка	Ошибка подготовки контейнера, если она есть.	Нет
provisioning_state	строка	Состояние подготовки контейнера.	Да
replicas	массив ContainerReplica	Список реплик в контейнере.	Да
state	строка	Состояние контейнера.	Да
updated_on	строка	Время последнего обновления контейнера.	Да

ContainerLogKind

Тип журналов для потоковой передачи из контейнера.

Property	Ценность
Type	строка
Значения	console system

ContainerReplica

Сведения о реплике контейнера.

Name	Type	Description	Обязательный	По умолчанию
container_state	строка	Состояние контейнера реплики.	Да
имя	строка	Имя реплики.	Да
state	строка	Состояние реплики.	Да

ContinuousEvaluationRuleAction

Действие правила оценки для непрерывной оценки.

Name	Type	Description	Обязательный	По умолчанию
evalId	строка	Идентификатор Eval для добавления непрерывных запусков оценки.	Да
maxHourlyRuns	целое число	Максимальное количество запусков оценки, разрешенных в час.	Нет
type	enum	Возможные значения: continuousEvaluation	Да

CosmosDBIndex

Определение индекса векторного хранилища CosmosDB

Name	Type	Description	Обязательный	По умолчанию
id	строка (только для чтения)	Asset ID — уникальный идентификатор актива	Нет
имя	строка (только для чтения)	Имя ресурса.	Да
type	enum	Тип индекса Возможные значения: CosmosDBNoSqlVectorStore	Да
version	строка (только для чтения)	Версия ресурса	Да

CosmosDBIndexUpdate

Определение индекса векторного хранилища CosmosDB

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

CreateAgentFromManifestRequest

Name	Type	Description	Обязательный	По умолчанию
описание	строка	Понятное описание агента. Ограничения: maxLength: 512	Нет
manifest_id	строка	Идентификатор манифеста для импорта версии агента из.	Да
metadata	object	Набор из 16 пар "ключ-значение", которые можно прикрепить к объекту. Это может быть Полезно для хранения дополнительных сведений об объекте в структурированном виде. форматирование и запрос объектов через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — строки с максимальной длиной 512 символов.	Нет
имя	строка	Уникальное имя, определяющее агент. Имя может быть использовано для получения/обновления/удаления агента. — должно начинаться и заканчиваться буквенно-цифровыми символами, - Может содержать дефисы в середине — не должно превышать 63 символов. Ограничения: maxLength: 63	Да
parameter_values	object	Входные данные манифеста, которые будут приводить к полностью материализованному агенту.	Да

CreateAgentRequest

Name	Type	Description	Обязательный	По умолчанию
Определение	AgentDefinition		Да
└️ вид	AgentKind		Да
└️ rai_config	RaiConfig	Конфигурация для фильтрации содержимого и функций безопасности Responsible AI (RAI).	Нет
описание	строка	Понятное описание агента. Ограничения: maxLength: 512	Нет
metadata	object	Набор из 16 пар "ключ-значение", которые можно прикрепить к объекту. Это может быть Полезно для хранения дополнительных сведений об объекте в структурированном виде. форматирование и запрос объектов через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — строки с максимальной длиной 512 символов.	Нет
имя	строка	Уникальное имя, определяющее агент. Имя может быть использовано для получения/обновления/удаления агента. — должно начинаться и заканчиваться буквенно-цифровыми символами, - Может содержать дефисы в середине — не должно превышать 63 символов. Ограничения: maxLength: 63	Да

CreateAgentVersionFromManifestRequest

Name	Type	Description	Обязательный	По умолчанию
описание	строка	Понятное описание агента. Ограничения: maxLength: 512	Нет
manifest_id	строка	Идентификатор манифеста для импорта версии агента из.	Да
metadata	object	Набор из 16 пар "ключ-значение", которые можно прикрепить к объекту. Это может быть Полезно для хранения дополнительных сведений об объекте в структурированном виде. форматирование и запрос объектов через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — строки с максимальной длиной 512 символов.	Нет
parameter_values	object	Входные данные манифеста, которые будут приводить к полностью материализованному агенту.	Да

CreateAgentVersionRequest

Name	Type	Description	Обязательный	По умолчанию
Определение	AgentDefinition		Да
└️ вид	AgentKind		Да
└️ rai_config	RaiConfig	Конфигурация для фильтрации содержимого и функций безопасности Responsible AI (RAI).	Нет
описание	строка	Понятное описание агента. Ограничения: maxLength: 512	Нет
metadata	object	Набор из 16 пар "ключ-значение", которые можно прикрепить к объекту. Это может быть Полезно для хранения дополнительных сведений об объекте в структурированном виде. форматирование и запрос объектов через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — строки с максимальной длиной 512 символов.	Нет

СоздатьЗапросОценки

Name	Type	Description	Обязательный	По умолчанию
настройка_источника_данных	OpenAI.CreateEvalCustomDataSourceConfig или OpenAI.CreateEvalLogsDataSourceConfig или OpenAI.CreateEvalStoredCompletionsDataSourceConfig или AzureAIDataSourceConfig	Конфигурация источника данных, используемого для выполнения оценки. Определяет схему данных, используемых в оценке.	Да
metadata	OpenAI.Metadata (nullable)	Набор из 16 пар "ключ-значение", которые можно прикрепить к объекту. Это может быть Полезно для хранения дополнительных сведений об объекте в структурированном виде. форматирование и запрос объектов через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — строки с максимальной длиной 512 символов.	Нет
имя	строка	Название оценки.	Нет
properties	object	Набор неизменяемых пар "ключ-значение", которые могут быть присоединены к объекту для хранения дополнительных сведений. Ключи — это строки с максимальной длиной 64 символов. Значения — это строки с максимальной длиной 512 символов.	Нет
критерии тестирования	массив OpenAI.EvalGraderLabelModel или OpenAI.EvalGraderStringCheck или OpenAI.EvalGraderTextSimilarity или OpenAI.EvalGraderPython или OpenAI.EvalGraderScoreModel или EvalGraderAzureAIEvaluator	Список оценщиков для всех запусков оценок в этой группе. Классировщики могут ссылаться на переменные в источнике данных с помощью двойной фигурной скобки, например {{item.variable_name}}. Чтобы ссылаться на выходные данные модели, используйте sample пространство имен (т. е. {{sample.output_text}}).	Да

СоздатьЗапросНаВыполнениеОценки

Name	Type	Description	Обязательный	По умолчанию
источник данных	OpenAI.CreateEvalJsonlRunDataSource или OpenAI.CreateEvalCompletionsRunDataSource или OpenAI.CreateEvalResponsesRunDataSource или EvalRunDataSource	Сведения об источнике данных запуска.	Да
metadata	OpenAI.Metadata (nullable)	Набор из 16 пар "ключ-значение", которые можно прикрепить к объекту. Это может быть Полезно для хранения дополнительных сведений об объекте в структурированном виде. форматирование и запрос объектов через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — строки с максимальной длиной 512 символов.	Нет
имя	строка	Имя запуска.	Нет
properties	object	Набор неизменяемых пар "ключ-значение", которые могут быть присоединены к объекту для хранения дополнительных сведений. Ключи — это строки с максимальной длиной 64 символов. Значения — это строки с максимальной длиной 512 символов.	Нет

CredentialType

Тип учетных данных, используемых подключением

Property	Ценность
Description	Тип учетных данных, используемых подключением
Type	строка
Значения	ApiKey AAD SAS CustomKeys None AgenticIdentityToken_Preview

CronTrigger

Триггер на основе cron.

Name	Type	Description	Обязательный	По умолчанию
endTime	строка	Время окончания графика cron в формате ISO 8601.	Нет
expression	строка	Выражение cron, определяющее частоту расписания.	Да
startTime	строка	Время начала работы по расписанию cron в формате ISO 8601.	Нет
timeZone	строка	Часовой пояс для расписания cron.	Нет	UTC
type	enum	Возможные значения: Cron	Да

CustomCredential

Определение пользовательских учетных данных

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

Этот объект также принимает дополнительные свойства типа: строка

DailyRecurrenceSchedule

Ежедневный график повторения.

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

DataSourceConfig

Базовый класс для запуска источников данных с дискриминационным поддержкой.

Дискриминация для DataSourceConfig

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

Значение типа	Schema

Name	Type	Description	Обязательный	По умолчанию
schema	object	Общая схема JSON объекта для элементов источника данных запуска.	Да
type	строка	Тип источника данных дискриминационный.	Да

DatasetType

Перечисление для определения типа данных.

Property	Ценность
Description	Перечисление для определения типа данных.
Type	строка
Значения	uri_file uri_folder

DatasetVersion

Определение DatasetVersion

Дискриминация для DatasetVersion

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

Значение типа	Schema
uri_file	FileDatasetVersion
uri_folder	FolderDatasetVersion

Name	Type	Description	Обязательный	По умолчанию
connectionName	строка	Имя подключения служба хранилища Azure учетной записи. Требуется, если startPendingUploadVersion не был вызван перед созданием набора данных	Нет
dataUri	строка	Универсальный код ресурса (URI) данных (пример) Ограничения: minLength: 1, шаблон: [a-zA-Z0-9_]	Да
id	строка (только для чтения)	Asset ID — уникальный идентификатор актива	Нет
isReference	boolean (только для чтения)	Указывает, содержит ли набор данных ссылку на хранилище или набор данных управляет самим хранилищем. Если значение true, базовые данные не будут удалены при удалении версии набора данных.	Нет
имя	строка (только для чтения)	Имя ресурса.	Да
type	DatasetType	Перечисление для определения типа данных.	Да
version	строка (только для чтения)	Версия ресурса	Да

DatasetVersionUpdate

Определение DatasetVersion

Дискриминация для DatasetVersionUpdate

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

Значение типа	Schema
uri_file	FileDatasetVersionUpdate
uri_folder	FolderDatasetVersionUpdate

Name	Type	Description	Обязательный	По умолчанию
описание	строка	Текст описания ресурса.	Нет
tags	object	Словарь тегов. Теги можно добавлять, удалять и обновлять.	Нет
type	DatasetType	Перечисление для определения типа данных.	Да

ДеньНедели

Дни недели для графика повторения.

Property	Ценность
Description	Дни недели для графика повторения.
Type	строка
Значения	Sunday Monday Tuesday Wednesday Thursday Friday Saturday

DeleteAgentResponse

Удаленный объект агента

Name	Type	Description	Обязательный	По умолчанию
удалено	boolean	Был ли агент успешно удален.	Да
имя	строка	Имя агента.	Да
object	enum	Тип объекта. Всегда "agent.deleted". Возможные значения: agent.deleted	Да

DeleteAgentVersionResponse

Удаленная версия агента Object

Name	Type	Description	Обязательный	По умолчанию
удалено	boolean	Был ли агент успешно удален.	Да
имя	строка	Имя агента.	Да
object	enum	Тип объекта. Всегда "agent.version.deleted". Возможные значения: agent.version.deleted	Да
version	строка	Идентификатор версии агента.	Да

DeleteEvalResponse

Удаленный объект оценки

Name	Type	Description	Обязательный	По умолчанию
удалено	boolean	Успешно ли удалена овал.	Да
eval_id	строка	идентификатор eval.	Да
object	enum	Тип объекта. Всегда "eval.deleted". Возможные значения: eval.deleted	Да

DeleteEvalRunResponse

Удаленный объект запуска оценки.

Name	Type	Description	Обязательный	По умолчанию
удалено	boolean	Успешно ли удалена овал.	Нет
object	enum	Тип объекта. Всегда "eval.deleted". Возможные значения: eval.deleted	Нет
run_id	строка	идентификатор eval.	Нет

DeleteMemoryStoreResponse

Name	Type	Description	Обязательный	По умолчанию
удалено	boolean	Успешно ли удалено хранилище памяти.	Да
имя	строка	Имя хранилища памяти.	Да
object	enum	Тип объекта. Всегда "memory_store.deleted". Возможные значения: memory_store.deleted	Да

DeleteResponseResult

Результат операции удаления ответа.

Name	Type	Description	Обязательный	По умолчанию
удалено	enum	Всегда возвращать значение true Возможные значения: True	Да
id	строка	Идентификатор операции.	Да
object	enum	Всегда возвращайте "ответ". Возможные значения: response	Да

Deployment

Определение развертывания модели

Дискриминация для развертывания

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

Значение типа	Schema
ModelDeployment	ModelDeployment

Name	Type	Description	Обязательный	По умолчанию
имя	строка (только для чтения)	Имя развертывания	Да
type	DeploymentType		Да

DeploymentType

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

EntraIDCredentials

Entra ID определение учетных данных

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

Оценка

Объект Eval с конфигурацией источника данных и критериями тестирования. Eval представляет задачу для интеграции LLM. Нравится:

• Улучшение качества чат-бота
• Узнайте, как хорошо мой чат-бот обрабатывает поддержку клиентов
• Проверьте, лучше ли o4-mini для моего сценария использования, чем gpt-4o.

Name	Type	Description	Обязательный	По умолчанию
создано_в	целое число	Метка времени Unix (в секундах) для момента создания eval.	Да
создано пользователем	строка	имя пользователя, создавшего запуск.	Нет
настройка_источника_данных	OpenAI.CreateEvalCustomDataSourceConfig или OpenAI.CreateEvalLogsDataSourceConfig или OpenAI.CreateEvalStoredCompletionsDataSourceConfig или AzureAIDataSourceConfig	Настройка источников данных, используемых при выполнении оценки.	Да
id	строка	Уникальный идентификатор для оценки.	Да
metadata	OpenAI.Metadata (nullable)	Набор из 16 пар "ключ-значение", которые можно прикрепить к объекту. Это может быть Полезно для хранения дополнительных сведений об объекте в структурированном виде. форматирование и запрос объектов через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — строки с максимальной длиной 512 символов.	Да
modified_at	integer		Нет
имя	строка	Название оценки.	Да
object	enum	Тип объекта. Возможные значения: eval	Да
properties	object	Набор неизменяемых пар "ключ-значение", которые могут быть присоединены к объекту для хранения дополнительных сведений. Ключи — это строки с максимальной длиной 64 символов. Значения — это строки с максимальной длиной 512 символов.	Нет
критерии тестирования	массив OpenAI.EvalGraderLabelModel или OpenAI.EvalGraderStringCheck или OpenAI.EvalGraderTextSimilarity или OpenAI.EvalGraderPython или OpenAI.EvalGraderScoreModel или EvalGraderAzureAIEvaluator	Список критериев тестирования.	Да

EvalCsvFileIdSource

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

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

EvalCsvRunDataSource

Представляет источник данных CSV для выполнения оценки.

Name	Type	Description	Обязательный	По умолчанию
Источник	EvalCsvFileIdSource	Представляет ссылку на отправленный CSV-файл, используемый в качестве источника для оценки данных.	Да
Идентификатор └️	строка	Идентификатор отправленного CSV-файла.	Да
└─ Тип	enum	Тип источника всегда file_id. Возможные значения: file_id	Да
type	enum	Тип источника данных всегда csv. Возможные значения: csv	Да

EvalGraderAzureAIEvaluator

Name	Type	Description	Обязательный	По умолчанию
сопоставление данных	object	Модель, используемая для оценки. Должен поддерживать структурированные выходные данные.	Нет
evaluator_name	строка	Имя вычислителя.	Да
evaluator_version	строка	Версия вычислителя. Последняя версия, если она не указана.	Нет
initialization_parameters	object	Параметры инициализации для оценки. Должен поддерживать структурированные выходные данные.	Нет
имя	строка	Имя классировщика.	Да
type	enum	Тип объекта, который всегда является azure_ai_evaluator. Возможные значения: azure_ai_evaluator	Да

EvalResult

Результат оценки.

Name	Type	Description	Обязательный	По умолчанию
имя	строка	имя проверки	Да
Прошло	boolean	указывает, пройдена или не выполнена ли проверка.	Да
Оценка	number	Оценка	Да
type	строка	тип проверки	Да

EvalRun

Схема, представляющая процесс оценки.

Name	Type	Description	Обязательный	По умолчанию
создано_в	целое число	Метка времени Unix (в секундах) при создании запуска оценки.	Да
создано пользователем	строка	имя пользователя, создавшего запуск.	Нет
источник данных	OpenAI.CreateEvalJsonlRunDataSource или OpenAI.CreateEvalCompletionsRunDataSource или OpenAI.CreateEvalResponsesRunDataSource или EvalRunDataSource	Сведения об источнике данных запуска.	Да
error	OpenAI.EvalApiError	Объект, представляющий ответ об ошибке из API Eval.	Да
eval_id	строка	Идентификатор ассоциированной оценки.	Да
id	строка	Уникальный идентификатор для оценочной сессии.	Да
metadata	OpenAI.Metadata (nullable)	Набор из 16 пар "ключ-значение", которые можно прикрепить к объекту. Это может быть Полезно для хранения дополнительных сведений об объекте в структурированном виде. форматирование и запрос объектов через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — строки с максимальной длиной 512 символов.	Да
модель	строка	Модель, подлежащая оценке, если применимо.	Да
modified_at	integer		Нет
имя	строка	Имя запуска оценки.	Да
object	enum	Тип объекта . Всегда "eval.run". Возможные значения: eval.run	Да
использование_на_модель	массив OpenAI.EvalRunPerModelUsage	Статистика использования для каждой модели во время выполнения оценки.	Да
результаты_по_критериям_тестирования	массив OpenAI.EvalRunPerTestingCriteriaResults	Результаты для каждого критерия тестирования, применяемые во время выполнения оценки.	Да
properties	object	Набор неизменяемых пар "ключ-значение", которые могут быть присоединены к объекту для хранения дополнительных сведений. Ключи — это строки с максимальной длиной 64 символов. Значения — это строки с максимальной длиной 512 символов.	Нет
report_url	строка	URL-адрес отчета о визуализации результатов выполнения оценочного запуска на панели мониторинга пользовательского интерфейса.	Да
количество_результатов	OpenAI.EvalRunResultCounts		Да
Ошибка	OpenAI.integer		Да
└─ Ошибка	OpenAI.integer		Да
├─ прошло	OpenAI.integer		Да
└─ всего	OpenAI.integer		Да
Статус	строка	Состояние выполнения оценки.	Да

EvalRunDataSource

Базовый класс для запуска источников данных с дискриминационным поддержкой.

Дискриминация для EvalRunDataSource

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

Значение типа	Schema
azure_ai_traces_preview	TracesPreviewEvalRunDataSource
azure_ai_synthetic_data_gen_preview	SyntheticDataGenerationPreviewEvalRunDataSource
azure_ai_responses	AzureAIResponsesEvalRunDataSource
azure_ai_target_completions	TargetCompletionEvalRunDataSource
csv	EvalCsvRunDataSource
azure_ai_red_team	RedTeamEvalRunDataSource

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

EvalRunOutputItem

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

Name	Type	Description	Обязательный	По умолчанию
создано_в	целое число	Метка времени Unix (в секундах) при создании запуска оценки.	Да
элемент источника данных	object	Сведения об элементе источника входных данных.	Да
идентификатор_элемента_источника_данных	OpenAI.integer		Да
eval_id	строка	Идентификатор группы оценки.	Да
id	строка	Уникальный идентификатор элемента результата выполнения оценки.	Да
object	enum	Тип объекта . Всегда "eval.run.output_item". Возможные значения: eval.run.output_item	Да
results	массив EvalRunOutputItemResult	Список результатов оценки для этого выходного элемента.	Да
run_id	строка	Идентификатор оценки, связанной с этим результирующим элементом.	Да
образец	OpenAI.EvalRunOutputItemSample		Да
└─ Ошибка	OpenAI.EvalApiError	Объект, представляющий ответ об ошибке из API Eval.	Да
└️ причина_завершения	строка		Да
└─ Входные данные	массив EvalRunOutputItemSampleInput		Да
└─max_completion_tokens	OpenAI.integer		Да
└─ Модель	строка		Да
вывод └─	массив EvalRunOutputItemSampleOutputOutput		Да
Начальное значение └️	OpenAI.integer		Да
└─ Температура	OpenAI.numeric		Да
└️ top_p	OpenAI.numeric		Да
└─ использование	OpenAI.EvalRunOutputItemSampleUsage		Да
Статус	строка	Состояние выполнения оценки.	Да

EvalRunOutputItemResult

Результат одного класса для выходного элемента выполнения оценки.

Name	Type	Description	Обязательный	По умолчанию
label	строка	Метка, связанная с метрикой критериев теста (например, pass, fail, "good", "bad").	Нет
metric	строка	Имя метрики (например, "fluency", "f1_score").	Нет
имя	строка	Имя классировщика.	Да
Прошло	boolean	Считается ли классировщик выходным результатом прохода.	Да
properties	object	Дополнительные сведения о метриках критериев тестирования.	Нет
причина	строка	Причина метрики критериев теста.	Нет
образец	Объект (нулируемый)	Необязательный пример или промежуточные данные, созданные классировщиком.	Нет
Оценка	OpenAI.numeric		Да
threshold	number	Пороговое значение, используемое для определения прохождения или сбоя для этого критерия теста, если оно числовое.	Нет
type	строка	Тип оценок (например, string-check-grader).	Нет

Этот объект также принимает дополнительные свойства.

EvalRunOutputItemSampleInput

Сообщение в выполнении оценки.

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

EvalRunOutputItemSampleOutput

Сообщение в выполнении оценки.

Name	Type	Description	Обязательный	По умолчанию
содержимое	строка		Нет
role	строка		Нет
вызовы инструментов	массив CompletionMessageToolCallChunk	Вызовы инструментов, сделанные в сообщении, если таковые есть.	Да

EvalRunResultCompareItem

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

Name	Type	Description	Обязательный	По умолчанию
deltaEstimate	number	Предполагаемое различие между лечением и базовым показателем.	Да
pValue	number	P-значение для эффекта лечения.	Да
лечениеEffect	TreatmentEffectType	Тип эффекта лечения.	Да
treatmentRunId	строка	Идентификатор выполнения лечения.	Да
treatmentRunSummary	EvalRunResultSummary	Сводная статистика метрики в прогоне оценки.	Да
└️ среднее	number	Среднее значение метрики в выполнении оценки.	Да
└️ runId	строка	Идентификатор выполнения оценки.	Да
└️ sampleCount	целое число	Количество примеров в выполнении оценки.	Да
└️ standardDeviation	number	Стандартное отклонение метрики в выполнении оценки.	Да

EvalRunResultComparison

Результаты сравнения результатов лечения с исходным уровнем.

Name	Type	Description	Обязательный	По умолчанию
базовая версияRunSummary	EvalRunResultSummary	Сводная статистика метрики в прогоне оценки.	Да
└️ среднее	number	Среднее значение метрики в выполнении оценки.	Да
└️ runId	строка	Идентификатор выполнения оценки.	Да
└️ sampleCount	целое число	Количество примеров в выполнении оценки.	Да
└️ standardDeviation	number	Стандартное отклонение метрики в выполнении оценки.	Да
compareItems	массив EvalRunResultCompareItem	Список результатов сравнения для каждого запуска лечения.	Да
Оценщика	строка	Имя вычислителя для этого критерия тестирования.	Да
metric	строка	Вычисляемая метрика.	Да
testingCriteria	строка	Имя критерия тестирования.	Да

EvalRunResultSummary

Сводная статистика метрики в прогоне оценки.

Name	Type	Description	Обязательный	По умолчанию
средний	number	Среднее значение метрики в выполнении оценки.	Да
runId	строка	Идентификатор выполнения оценки.	Да
sampleCount	целое число	Количество примеров в выполнении оценки.	Да
StandardDeviation	number	Стандартное отклонение метрики в выполнении оценки.	Да

EvaluationComparisonInsightRequest

Запрос на сравнение оценок

Name	Type	Description	Обязательный	По умолчанию
baselineRunId	строка	Базовый идентификатор выполнения для сравнения.	Да
evalId	строка	Идентификатор оценки.	Да
treatmentRunIds	массив строк	Список идентификаторов запуска лечения для сравнения.	Да
type	enum	Тип запроса. Возможные значения: EvaluationComparison	Да

EvaluationComparisonInsightResult

Выводы из сравнения оценок.

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

EvaluationResultSample

Образец из результата оценки.

Name	Type	Description	Обязательный	По умолчанию
correlationInfo	object	Сведения о корреляции для примера анализа.	Да
evaluationResult	EvalResult	Результат оценки.	Да
└️ имя	строка	имя проверки	Да
├─ прошло	boolean	указывает, пройдена или не выполнена ли проверка.	Да
└️ оценка	number	Оценка	Да
└─ Тип	строка	тип проверки	Да
features	object	Функции, помогающие с дополнительной фильтрацией данных в пользовательском интерфейсе.	Да
id	строка	Уникальный идентификатор для примера анализа.	Да
type	enum	Тип примера результата оценки Возможные значения: EvaluationResultSample	Да

Правило оценки

Модель правила оценки.

Name	Type	Description	Обязательный	По умолчанию
action	EvaluationRuleAction	Модель действия по оценке.	Да
└─ Тип	EvaluationRuleActionType	Тип действия по оценке.	Да
описание	строка	Описание правила оценки.	Нет
displayName	строка	Отображаемое имя правила оценки.	Нет
enabled	boolean	Указывает, включено ли правило оценки. Значение по умолчанию: true.	Да
eventType	EvaluationRuleEventType	Тип события правила оценки.	Да
filter	EvaluationRuleFilter	Модель фильтра оценки.	Нет
└️ agentName	строка	Фильтруйте по имени агента.	Да
id	строка (только для чтения)	Уникальный идентификатор правила оценки.	Да
данные системы	object (только для чтения)	Системные метаданные для правила оценки.	Да

EvaluationRuleAction

Модель действия по оценке.

Дискриминация для EvaluationRuleAction

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

Значение типа	Schema
continuousEvaluation	ContinuousEvaluationRuleAction
humanEvaluationPreview	HumanEvaluationPreviewRuleAction

Name	Type	Description	Обязательный	По умолчанию
type	EvaluationRuleActionType	Тип действия по оценке.	Да

EvaluationRuleActionType

Тип действия по оценке.

Property	Ценность
Description	Тип действия по оценке.
Type	строка
Значения	continuousEvaluation humanEvaluationPreview

EvaluationRuleEventType

Тип события правила оценки.

Property	Ценность
Description	Тип события правила оценки.
Type	строка
Значения	responseCompleted manual

EvaluationRuleFilter

Модель фильтра оценки.

Name	Type	Description	Обязательный	По умолчанию
agentName	строка	Фильтруйте по имени агента.	Да

EvaluationRunClusterInsightRequest

Выводы о наборе результатов оценки

Name	Type	Description	Обязательный	По умолчанию
evalId	строка	Идентификатор оценки для аналитических сведений.	Да
ModelConfiguration	InsightsModelConfiguration	Конфигурация модели, используемой при создании аналитических сведений.	Нет
└️ modelDeploymentName	строка	Вычислить развертывание модели. Принимает только имя развертывания или имя подключения как {connectionName}/<modelDeploymentName>.	Да
runIds	массив строк	Список идентификаторов запуска оценки для аналитических сведений.	Да
type	enum	Тип запроса аналитики. Возможные значения: EvaluationRunClusterInsight	Да

EvaluationRunClusterInsightResult

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

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

EvaluationScheduleTask

Задание на оценку расписания.

Name	Type	Description	Обязательный	По умолчанию
configuration	object	Конфигурация для задачи.	Нет
evalId	строка	Идентификатор группы оценки.	Да
evalRun	object	Полезные данные запуска оценки.	Да
type	enum	Возможные значения: Evaluation	Да

EvaluationTaxonomy

Определение таксономии оценки

Name	Type	Description	Обязательный	По умолчанию
id	строка (только для чтения)	Asset ID — уникальный идентификатор актива	Нет
имя	строка (только для чтения)	Имя ресурса.	Да
properties	object	Дополнительные свойства для таксономии оценки.	Нет
категории таксономии	массив ТаксономииCategory	Список категорий таксономии.	Нет
таксономияInput	EvaluationTaxonomyInput	Входная конфигурация для таксономии оценки.	Да
└─ Тип	EvaluationTaxonomyInputType	Тип входных данных для таксономии оценки.	Да
version	строка (только для чтения)	Версия ресурса	Да

EvaluationTaxonomyCreateOrUpdate

Определение таксономии оценки

Name	Type	Description	Обязательный	По умолчанию
описание	строка	Текст описания ресурса.	Нет
properties	object	Дополнительные свойства для таксономии оценки.	Нет
tags	object	Словарь тегов. Теги можно добавлять, удалять и обновлять.	Нет
категории таксономии	массив ТаксономииCategory	Список категорий таксономии.	Нет
таксономияInput	EvaluationTaxonomyInput	Входная конфигурация для таксономии оценки.	Да
└─ Тип	EvaluationTaxonomyInputType	Тип входных данных для таксономии оценки.	Да

EvaluationTaxonomyInput

Входная конфигурация для таксономии оценки.

Дискриминация для EvaluationTaxonomyInput

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

Значение типа	Schema
agent	AgentTaxonomyInput

Name	Type	Description	Обязательный	По умолчанию
type	EvaluationTaxonomyInputType	Тип входных данных таксономии оценки.	Да

EvaluationTaxonomyInputType

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

Property	Ценность
Description	Тип входных данных таксономии оценки.
Type	строка
Значения	agent policy

EvaluationTaxonomyInputUpdate

Входная конфигурация для таксономии оценки.

Дискриминация для EvaluationTaxonomyInputUpdate

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

Значение типа	Schema
agent	AgentTaxonomyInputUpdate

Name	Type	Description	Обязательный	По умолчанию
type	EvaluationTaxonomyInputType	Тип входных данных таксономии оценки.	Да

EvaluationTaxonomyUpdate

Определение таксономии оценки

Name	Type	Description	Обязательный	По умолчанию
описание	строка	Текст описания ресурса.	Нет
properties	object	Дополнительные свойства для таксономии оценки.	Нет
tags	object	Словарь тегов. Теги можно добавлять, удалять и обновлять.	Нет
категории таксономии	массив ТаксономииCategory	Список категорий таксономии.	Нет
таксономияInput	EvaluationTaxonomyInputUpdate	Входная конфигурация для таксономии оценки.	Нет
└─ Тип	EvaluationTaxonomyInputType	Тип входных данных для таксономии оценки.	Да

ОценщикCategory

Категория оценщика

Property	Ценность
Description	Категория оценщика
Type	строка
Значения	quality safety agents

ScoreorDefinition

Конфигурация базового оценщика с дискриминатором

Дискриминация для scoreorDefinition

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

Значение типа	Schema
code	CodeBasedEvaluatorDefinition
prompt	PromptBasedEvaluatorDefinition

Name	Type	Description	Обязательный	По умолчанию
data_schema	object	Схема JSON (проект 2020-12) для входных данных оценщика. Это включает в себя такие параметры, как тип, свойства, обязательные.	Нет
init_parameters	object	Схема JSON (проект 2020-12) для входных параметров оценщика. Это включает в себя такие параметры, как тип, свойства, обязательные.	Нет
metrics	object	Список выходных метрик, полученных данным оценщиком	Нет
type	ScoreorDefinitionType	Тип определения оценщика	Да

ScoreorDefinitionType

Тип определения оценщика

Property	Ценность
Description	Тип определения оценщика
Type	строка
Значения	prompt code prompt_and_code service openai_graders

Оценка метрик

Метрика Evaluator

Name	Type	Description	Обязательный	По умолчанию
desirable_direction	ScoreorMetricDirection	Направление метрики, указывающее, является ли более высокое значение лучше, более низкое значение лучше или нейтральным	Нет
is_primary	boolean	Указывает, является ли эта метрика первичной при наличии нескольких метрик.	Нет
max_value	number	Максимальное значение для метрики. Если он не указан, предполагается, что он не указан.	Нет
min_value	number	Минимальное значение для метрики	Нет
type	ScoreorMetricType	Тип оценщика	Нет

ScoreorMetricDirection

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

Property	Ценность
Description	Направление метрики, указывающее, является ли более высокое значение лучше, более низкое значение лучше или нейтральным
Type	строка
Значения	increase decrease neutral

ScoreorMetricType

Тип оценщика

Property	Ценность
Description	Тип оценщика
Type	строка
Значения	ordinal continuous boolean

ScoreorType

Тип оценщика

Property	Ценность
Description	Тип оценщика
Type	строка
Значения	builtin custom

ScoreorVersion

Определение оценщика

Name	Type	Description	Обязательный	По умолчанию
categories	массив проценщикаCategory	Категории оценщика	Да
создано_в	строка (только для чтения)	Дата/время создания оценщика	Да
создано пользователем	строка (только для чтения)	Создатель оценщика	Да
Определение	ScoreorDefinition	Конфигурация базового оценщика с дискриминатором	Да
└️ data_schema	object	Схема JSON (проект 2020-12) для входных данных оценщика. Это включает в себя такие параметры, как тип, свойства, обязательные.	Нет
└init_parameters init_parameters	object	Схема JSON (проект 2020-12) для входных параметров оценщика. Это включает в себя такие параметры, как тип, свойства, обязательные.	Нет
Метрики └️	object	Список выходных метрик, полученных данным оценщиком	Нет
└─ Тип	ScoreorDefinitionType	Тип определения оценщика	Да
display_name	строка	Отображаемое имя для оценщика. В AI Foundry легко найти оценщика. Он не обязательно должен быть уникальным.	Нет
evaluator_type	ScoreorType	Тип оценщика	Да
id	строка (только для чтения)	Asset ID — уникальный идентификатор актива	Нет
metadata	object	Метаданные об оценщике	Нет
modified_at	строка (только для чтения)	Дата и время последнего изменения оценщика	Да
имя	строка (только для чтения)	Имя ресурса.	Да
version	строка (только для чтения)	Версия ресурса	Да

ScoreorVersionCreate

Определение оценщика

Name	Type	Description	Обязательный	По умолчанию
categories	массив проценщикаCategory	Категории оценщика	Да
Определение	ScoreorDefinition	Конфигурация базового оценщика с дискриминатором	Да
└️ data_schema	object	Схема JSON (проект 2020-12) для входных данных оценщика. Это включает в себя такие параметры, как тип, свойства, обязательные.	Нет
└init_parameters init_parameters	object	Схема JSON (проект 2020-12) для входных параметров оценщика. Это включает в себя такие параметры, как тип, свойства, обязательные.	Нет
Метрики └️	object	Список выходных метрик, полученных данным оценщиком	Нет
└─ Тип	ScoreorDefinitionType	Тип определения оценщика	Да
описание	строка	Текст описания ресурса.	Нет
display_name	строка	Отображаемое имя для оценщика. В AI Foundry легко найти оценщика. Он не обязательно должен быть уникальным.	Нет
evaluator_type	ScoreorType	Тип оценщика	Да
metadata	object	Метаданные об оценщике	Нет
tags	object	Словарь тегов. Теги можно добавлять, удалять и обновлять.	Нет

ScoreorVersionUpdate

Определение оценщика

Name	Type	Description	Обязательный	По умолчанию
categories	массив проценщикаCategory	Категории оценщика	Нет
описание	строка	Текст описания ресурса.	Нет
display_name	строка	Отображаемое имя для оценщика. В AI Foundry легко найти оценщика. Он не обязательно должен быть уникальным.	Нет
metadata	object	Метаданные об оценщике	Нет
tags	object	Словарь тегов. Теги можно добавлять, удалять и обновлять.	Нет

FabricDataAgentToolParameters

Параметры инструмента агента данных набора данных.

Name	Type	Description	Обязательный	По умолчанию
project_connections	массив ToolProjectConnection	Подключения project, подключенные к этому средству. Может быть не более 1 подключения ресурс, подключенный к средству.	Нет

FileDatasetVersion

Определение FileDatasetVersion

Name	Type	Description	Обязательный	По умолчанию
connectionName	строка	Имя подключения служба хранилища Azure учетной записи. Требуется, если startPendingUploadVersion не был вызван перед созданием набора данных	Нет
dataUri	строка	Универсальный код ресурса (URI) данных (пример) Ограничения: minLength: 1, шаблон: [a-zA-Z0-9_]	Да
id	строка (только для чтения)	Asset ID — уникальный идентификатор актива	Нет
isReference	boolean (только для чтения)	Указывает, содержит ли набор данных ссылку на хранилище или набор данных управляет самим хранилищем. Если значение true, базовые данные не будут удалены при удалении версии набора данных.	Нет
имя	строка (только для чтения)	Имя ресурса.	Да
type	enum	Тип набора данных Возможные значения: uri_file	Да
version	строка (только для чтения)	Версия ресурса	Да

FileDatasetVersionUpdate

Определение FileDatasetVersion

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

FolderDatasetVersion

Определение FileDatasetVersion

Name	Type	Description	Обязательный	По умолчанию
connectionName	строка	Имя подключения служба хранилища Azure учетной записи. Требуется, если startPendingUploadVersion не был вызван перед созданием набора данных	Нет
dataUri	строка	Универсальный код ресурса (URI) данных (пример) Ограничения: minLength: 1, шаблон: [a-zA-Z0-9_]	Да
id	строка (только для чтения)	Asset ID — уникальный идентификатор актива	Нет
isReference	boolean (только для чтения)	Указывает, содержит ли набор данных ссылку на хранилище или набор данных управляет самим хранилищем. Если значение true, базовые данные не будут удалены при удалении версии набора данных.	Нет
имя	строка (только для чтения)	Имя ресурса.	Да
type	enum	Тип набора данных Возможные значения: uri_folder	Да
version	строка (только для чтения)	Версия ресурса	Да

FolderDatasetVersionUpdate

Определение FileDatasetVersion

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

FunctionToolCall

Сведения о вызове средства функции.

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

HostedAgentDefinition

Определение размещенного агента.

Name	Type	Description	Обязательный	По умолчанию
container_protocol_versions	массив ProtocolVersionRecord	Протоколы, поддерживаемые агентом для входящего трафика контейнеров.	Да
cpu	строка	Конфигурация ЦП для размещенного агента.	Да
environment_variables	object	Переменные среды, устанавливаемые в контейнере размещенного агента.	Нет
image	строка	Идентификатор образа агента, применимый к размещенным агентам на основе образа.	Нет
kind	enum	Возможные значения: hosted	Да
memory	строка	Конфигурация памяти для размещенного агента.	Да
rai_config	RaiConfig	Конфигурация для фильтрации содержимого и функций безопасности Responsible AI (RAI).	Нет
└rai_policy_name	строка	Имя политики RAI, применяемой.	Да
tools	массив OpenAI.Tool	Набор инструментов, которые модель размещенного агента может вызывать во время генерации ответа. Вы может указать, какое средство следует использовать, задав tool_choice параметр.	Нет

HourlyRecurrenceSchedule

Почасовой график повторения.

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

HumanEvaluationPreviewRuleAction

Действие правила оценки для оценки человека.

Name	Type	Description	Обязательный	По умолчанию
templateId	AssetId	Идентификатор сохраненного ресурса.	Да
type	enum	Возможные значения: humanEvaluationPreview	Да

Index

Определение ресурса индекса

Дискриминация по индексу

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

Значение типа	Schema
AzureSearch	AzureAISearchIndex
ManagedAzureSearch	ManagedAzureAISearchIndex
CosmosDBNoSqlVectorStore	CosmosDBIndex

Name	Type	Description	Обязательный	По умолчанию
id	строка (только для чтения)	Asset ID — уникальный идентификатор актива	Нет
имя	строка (только для чтения)	Имя ресурса.	Да
type	IndexType		Да
version	строка (только для чтения)	Версия ресурса	Да

IndexType

Property	Ценность
Type	строка
Значения	AzureSearch CosmosDBNoSqlVectorStore ManagedAzureSearch

IndexUpdate

Определение ресурса индекса

Дискриминация для IndexUpdate

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

Значение типа	Schema
AzureSearch	AzureAISearchIndexUpdate
ManagedAzureSearch	ManagedAzureAISearchIndexUpdate
CosmosDBNoSqlVectorStore	CosmosDBIndexUpdate

Name	Type	Description	Обязательный	По умолчанию
описание	строка	Текст описания ресурса.	Нет
tags	object	Словарь тегов. Теги можно добавлять, удалять и обновлять.	Нет
type	IndexType		Да

Проницательность

Тело ответа для аналитики кластера.

Name	Type	Description	Обязательный	По умолчанию
displayName	строка	Понятное отображаемое имя для аналитических сведений.	Да
id	строка (только для чтения)	Уникальный идентификатор отчета аналитики.	Да
metadata	InsightsMetadata (только для чтения)	Метаданные об инсайтах.	Да
└️ completedAt	строка	Метка времени завершения аналитических сведений.	Нет
└️ createdAt	строка	Метка времени создания аналитических сведений.	Да
просьба	InsightsRequest	Запрос аналитического отчета.	Да
└─ Тип	InsightsType	Тип запроса.	Да
result	InsightsResult (только для чтения)	Результат инсайтов.	Нет
└─ Тип	InsightsType	Тип результата аналитики.	Да
state	Azure. Core.Foundations.OperationState (только для чтения)	Перечисление, описывающее разрешенные состояния операций.	Да

InsightsCluster

Кластер образцов анализа.

Name	Type	Description	Обязательный	По умолчанию
описание	строка	Описание кластера анализа.	Да
id	строка	Идентификатор кластера анализа.	Да
label	строка	Метка для кластера	Да
Образцы	массив InsightsSample	Список примеров, принадлежащих этому кластеру. Пусто, если примеры являются частью подкластеров.	Нет
subClusters	массив InsightsCluster	Список подкластеров в этом кластере. Пусто, если не существуют подкластеры.	Нет
Предложение	строка	Предложение для кластера	Да
предложениеTitle	строка	Заголовок предложения для кластера	Да
weight	целое число	Вес кластера анализа. Это указывает количество примеров в кластере.	Да

InsightsModelConfiguration

Конфигурация модели, используемой при создании аналитических сведений.

Name	Type	Description	Обязательный	По умолчанию
modelDeploymentName	строка	Вычислить развертывание модели. Принимает только имя развертывания или имя подключения как {connectionName}/<modelDeploymentName>.	Да

InsightsRequest

Запрос аналитического отчета.

Дискриминация для InsightsRequest

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

Значение типа	Schema
EvaluationRunClusterInsight	EvaluationRunClusterInsightRequest
AgentClusterInsight	AgentClusterInsightRequest
EvaluationComparison	EvaluationComparisonInsightRequest

Name	Type	Description	Обязательный	По умолчанию
type	InsightsType	Запрос инсайтов.	Да

InsightsResult

Результат инсайтов.

Дискриминация для InsightsResult

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

Значение типа	Schema
EvaluationComparison	EvaluationComparisonInsightResult
EvaluationRunClusterInsight	EvaluationRunClusterInsightResult
AgentClusterInsight	AgentClusterInsightResult

Name	Type	Description	Обязательный	По умолчанию
type	InsightsType	Запрос инсайтов.	Да

InsightsSample

Образец из анализа.

Дискриминация для InsightsSample

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

Значение типа	Schema
EvaluationResultSample	EvaluationResultSample

Name	Type	Description	Обязательный	По умолчанию
correlationInfo	object	Сведения о корреляции для примера анализа.	Да
features	object	Функции, помогающие с дополнительной фильтрацией данных в пользовательском интерфейсе.	Да
id	строка	Уникальный идентификатор для примера анализа.	Да
type	SampleType	Тип пробы, используемой при анализе.	Да

InsightsScheduleTask

Задача анализа для расписания.

Name	Type	Description	Обязательный	По умолчанию
configuration	object	Конфигурация для задачи.	Нет
Понимание	Полезные сведения	Тело ответа для аналитики кластера.	Да
└️ displayName	строка	Понятное отображаемое имя для аналитических сведений.	Да
Идентификатор └️	строка (только для чтения)	Уникальный идентификатор отчета аналитики.	Да
└─ Метаданные	InsightsMetadata (только для чтения)	Метаданные отчета аналитики.	Да
Запрос └️	InsightsRequest	Запрос на анализ аналитических сведений.	Да
Результат └️	InsightsResult (только для чтения)	Результат отчета аналитики.	Нет
Состояние └️	Azure. Core.Foundations.OperationState (только для чтения)	Текущее состояние аналитических сведений.	Да
type	enum	Возможные значения: Insight	Да

InsightsSummary

Сводка кластерного анализа ошибок.

Name	Type	Description	Обязательный	По умолчанию
method	строка	Метод, используемый для кластеризации.	Да
sampleCount	целое число	Общее количество проанализированных примеров.	Да
uniqueClusterCount	целое число	Общее количество уникальных кластеров.	Да
uniqueSubclusterCount	целое число	Общее количество уникальных меток подкластера.	Да
использование	ClusterTokenUsage	Использование токенов для кластерного анализа	Да
└️ inputTokenUsage	целое число	использование входного маркера	Да
└️ outputTokenUsage	целое число	Использование маркера вывода	Да
└️ totalTokenUsage	целое число	общее использование маркеров	Да

InsightsType

Запрос инсайтов.

Property	Ценность
Description	Запрос инсайтов.
Type	строка
Значения	EvaluationRunClusterInsight AgentClusterInsight EvaluationComparison

InsightsMetadata

Метаданные об инсайтах.

Name	Type	Description	Обязательный	По умолчанию
completedAt	строка	Метка времени завершения аналитических сведений.	Нет
createdAt	строка	Метка времени создания аналитических сведений.	Да

ItemGenerationParams

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

Дискриминация для ItemGenerationParams

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

Значение типа	Schema
red_team	RedTeamItemGenerationParams
red_team_seed_prompts	RedTeamSeedPromptsItemGenerationParams
red_team_taxonomy	RedTeamTaxonomyItemGenerationParams
response_retrieval	ResponseRetrievalItemGenerationParams

Name	Type	Description	Обязательный	По умолчанию
type	ItemGenerationParamsType	Типы параметров для создания элементов красной команды.	Да

ItemGenerationParamsType

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

Property	Ценность
Description	Типы параметров для создания элементов красной команды.
Type	строка
Значения	red_team response_retrieval red_team_seed_prompts red_team_taxonomy synthetic_data_gen_preview

ManagedAzureAISearchIndex

Определение управляемого индекса Поиск с использованием ИИ Azure

Name	Type	Description	Обязательный	По умолчанию
id	строка (только для чтения)	Asset ID — уникальный идентификатор актива	Нет
имя	строка (только для чтения)	Имя ресурса.	Да
type	enum	Тип индекса Возможные значения: ManagedAzureSearch	Да
version	строка (только для чтения)	Версия ресурса	Да

ManagedAzureAISearchIndexUpdate

Определение управляемого индекса Поиск с использованием ИИ Azure

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

MemoryItem

Один элемент памяти, хранящийся в хранилище памяти и содержащий содержимое и метаданные.

Дискриминация для MemoryItem

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

Значение типа	Schema
user_profile	UserProfileMemoryItem
chat_summary	ChatSummaryMemoryItem

Name	Type	Description	Обязательный	По умолчанию
содержимое	строка	Содержимое памяти.	Да
kind	MemoryItemKind	Вид элемента памяти.	Да
memory_id	строка	Уникальный идентификатор элемента памяти.	Да
scope	строка	Пространство имен, которое логически группирует и изолирует воспоминания, например идентификатор пользователя.	Да
updated_at	целое число	Время последнего обновления элемента памяти.	Да

MemoryItemKind

Вид элемента памяти.

Property	Ценность
Description	Вид элемента памяти.
Type	строка
Значения	user_profile chat_summary

MemoryOperation

Представляет собой одну операцию памяти (создание, обновление или удаление), выполненную над элементом памяти.

Name	Type	Description	Обязательный	По умолчанию
kind	MemoryOperationKind	Вид операций с памятью.	Да
memory_item	MemoryItem	Один элемент памяти, хранящийся в хранилище памяти и содержащий содержимое и метаданные.	Да
└─ Содержимое	строка	Содержимое памяти.	Да
└️ вид	MemoryItemKind	Тип элемента памяти.	Да
└️ memory_id	строка	Уникальный идентификатор элемента памяти.	Да
Область └️	строка	Пространство имен, которое логически группирует и изолирует воспоминания, например идентификатор пользователя.	Да
└updated_at updated_at	целое число	Время последнего обновления элемента памяти.	Да

MemoryOperationKind

Вид операций с памятью.

Property	Ценность
Description	Вид операций с памятью.
Type	строка
Значения	create update delete

MemorySearchItem

Извлеченный элемент памяти из поиска в памяти.

Name	Type	Description	Обязательный	По умолчанию
memory_item	MemoryItem	Один элемент памяти, хранящийся в хранилище памяти и содержащий содержимое и метаданные.	Да
└─ Содержимое	строка	Содержимое памяти.	Да
└️ вид	MemoryItemKind	Тип элемента памяти.	Да
└️ memory_id	строка	Уникальный идентификатор элемента памяти.	Да
Область └️	строка	Пространство имен, которое логически группирует и изолирует воспоминания, например идентификатор пользователя.	Да
└updated_at updated_at	целое число	Время последнего обновления элемента памяти.	Да

MemorySearchOptions

Варианты поиска в памяти.

Name	Type	Description	Обязательный	По умолчанию
max_memories	целое число	Максимальное количество возвращаемых элементов памяти.	Нет

MemorySearchPreviewTool

Инструмент для интеграции воспоминаний в агент.

Name	Type	Description	Обязательный	По умолчанию
memory_store_name	строка	Имя используемого хранилища памяти.	Да
scope	строка	Пространство имен, используемое для группировки и изоляции воспоминаний, например идентификатор пользователя. Ограничивает количество воспоминаний, которые могут быть восстановлены или обновлены. Используйте специальную переменную {{$userId}} для ограничения памяти текущим вошедшим в систему пользователем.	Да
search_options	MemorySearchOptions	Варианты поиска в памяти.	Нет
└max_memories	целое число	Максимальное количество возвращаемых элементов памяти.	Нет
type	enum	Тип средства. Всегда memory_search_preview. Возможные значения: memory_search_preview	Да
update_delay	целое число	Время ожидания перед обновлением воспоминаний после бездействия (секунды). По умолчанию 300.	Нет	300

MemorySearchToolCallItemParam

Name	Type	Description	Обязательный	По умолчанию
results	массив MemorySearchItem	Результаты, возвращаемые из поиска памяти.	Нет
type	enum	Возможные значения: memory_search_call	Да

MemorySearchToolCallItemResource

Name	Type	Description	Обязательный	По умолчанию
agent_reference	AgentReference		Нет
└️ имя	строка	Имя агента. Ограничения: maxLength: 256	Да
└─ Тип	enum	Возможные значения: agent_reference	Да
└─ Версия	строка	Идентификатор версии агента.	Нет
response_id	строка	Ответ, на котором создается элемент.	Нет
results	массив MemorySearchItem	Результаты, возвращаемые из поиска памяти.	Нет
Статус	enum	Состояние вызова средства поиска памяти. Один из in_progress, searching completed, или ,incompletefailed Возможные значения: in_progress, searching, completed, incomplete, failed	Да
type	enum	Возможные значения: memory_search_call	Да

MemoryStoreDefaultDefinition

Реализация хранилища памяти по умолчанию.

Name	Type	Description	Обязательный	По умолчанию
chat_model	строка	Имя или идентификатор развертывания модели завершения чата, используемой для обработки памяти.	Да
embedding_model	строка	Имя или идентификатор развертывания модели внедрения, используемого для обработки памяти.	Да
kind	enum	Тип хранилища памяти. Возможные значения: default	Да
options	MemoryStoreDefaultOptions	Конфигурации хранилища памяти по умолчанию.	Нет
└chat_summary_enabled	boolean	Следует ли включить извлечение сводки чата и storage. Значение по умолчанию: true.	Да	True
└user_profile_details	строка	Определенные категории или типы информации профиля пользователя для извлечения и хранения.	Нет
└user_profile_enabled	boolean	Следует ли включить извлечение профилей пользователей и storage. Значение по умолчанию: true.	Да	True

MemoryStoreDefaultOptions

Конфигурации хранилища памяти по умолчанию.

Name	Type	Description	Обязательный	По умолчанию
chat_summary_enabled	boolean	Следует ли включить извлечение сводки чата и storage. Значение по умолчанию: true.	Да	True
user_profile_details	строка	Определенные категории или типы информации профиля пользователя для извлечения и хранения.	Нет
user_profile_enabled	boolean	Следует ли включить извлечение профилей пользователей и storage. Значение по умолчанию: true.	Да	True

MemoryStoreDefinition

Базовое определение для конфигураций хранилища памяти.

Дискриминация для MemoryStoreDefinition

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

Значение типа	Schema
default	MemoryStoreDefaultDefinition

Name	Type	Description	Обязательный	По умолчанию
kind	MemoryStoreKind	Тип используемой реализации хранилища памяти.	Да

MemoryStoreDeleteScopeResponse

Реакция на удаление воспоминаний из области видимости.

Name	Type	Description	Обязательный	По умолчанию
удалено	boolean	Успешно ли выполнена операция удаления.	Да
имя	строка	Имя хранилища памяти.	Да
object	enum	Тип объекта. Всегда "memory_store.scope.deleted". Возможные значения: memory_store.scope.deleted	Да
scope	строка	Область, из которой были удалены воспоминания.	Да

MemoryStoreKind

Тип используемой реализации хранилища памяти.

Property	Ценность
Description	Тип используемой реализации хранилища памяти.
Type	строка
Значения	default

MemoryStoreObject

Хранилище памяти, которое может хранить и извлекать воспоминания пользователя.

Name	Type	Description	Обязательный	По умолчанию
создано_в	целое число	Метка времени Unix (секунды) при создании хранилища памяти.	Да
Определение	MemoryStoreDefinition	Базовое определение для конфигураций хранилища памяти.	Да
└️ вид	MemoryStoreKind	Тип хранилища памяти.	Да
описание	строка	Читаемое человеком описание хранилища памяти. Ограничения: maxLength: 512	Нет
id	строка	Уникальный идентификатор хранилища памяти.	Да
metadata	object	Произвольные метаданные значения ключа для связывания с хранилищем памяти.	Нет
имя	строка	Имя хранилища памяти. Ограничения: maxLength: 256	Да
object	enum	Тип объекта, который всегда является "memory_store". Возможные значения: memory_store	Да
updated_at	целое число	Метка времени Unix (секунды) при последнем обновлении хранилища памяти.	Да

MemoryStoreOperationUsage

Статистика использования операции с хранилищем памяти.

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

MemoryStoreSearchResponse

Реакция на поиск в памяти.

Name	Type	Description	Обязательный	По умолчанию
Воспоминания	массив MemorySearchItem	Связанные элементы памяти, найденные во время операции поиска.	Да
search_id	строка	Уникальный идентификатор этого запроса поиска. Используйте это значение как previous_search_id в последующих запросах для выполнения добавочного поиска.	Да
использование	MemoryStoreOperationUsage	Статистика использования операции с хранилищем памяти.	Да
└embedding_tokens	целое число	Количество токенов внедрения.	Да
└input_tokens	OpenAI.integer	Количество входных токенов.	Да
└─ данные_входных_токенов	OpenAI.ResponseUsageInputTokensDetails	Подробная разбивка входных токенов.	Да
└─ выходные_токены (output_tokens)	OpenAI.integer	Количество выходных токенов.	Да
└️ output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails	Подробная разбивка выходных маркеров.	Да
└️ всего_токенов	OpenAI.integer	Общее количество используемых токенов.	Да

MemoryStoreUpdateCompletedResult

Результат обновления памяти.

Name	Type	Description	Обязательный	По умолчанию
memory_operations	массив MemoryOperation	Список отдельных операций памяти, выполняемых во время обновления.	Да
использование	MemoryStoreOperationUsage	Статистика использования операции с хранилищем памяти.	Да
└embedding_tokens	целое число	Количество токенов внедрения.	Да
└input_tokens	OpenAI.integer	Количество входных токенов.	Да
└─ данные_входных_токенов	OpenAI.ResponseUsageInputTokensDetails	Подробная разбивка входных токенов.	Да
└─ выходные_токены (output_tokens)	OpenAI.integer	Количество выходных токенов.	Да
└️ output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails	Подробная разбивка выходных маркеров.	Да
└️ всего_токенов	OpenAI.integer	Общее количество используемых токенов.	Да

MemoryStoreUpdateResponse

Предоставляет состояние операции обновления хранилища памяти.

Name	Type	Description	Обязательный	По умолчанию
error	OpenAI.Error		Нет
└️ additionalInfo	object		Нет
└─ Код	Строка (нулевая)		Да
└️ debugInfo	object		Нет
└️ подробности	массив OpenAI.Error		Нет
Сообщение └️	строка		Да
└─ параметр	Строка (нулевая)		Нет
└─ Тип	строка		Нет
result	MemoryStoreUpdateCompletedResult	Результат обновления памяти.	Нет
└memory_operations	массив MemoryOperation	Список отдельных операций памяти, выполняемых во время обновления.	Да
└─ использование	MemoryStoreOperationUsage	Статистика использования, связанная с операцией обновления памяти.	Да
Статус	MemoryStoreUpdateStatus	Состояние операции обновления хранилища памяти.	Да
superseded_by	строка	Update_id операция была заменена, когда состояние "заменено".	Нет
update_id	строка	Уникальный идентификатор этого запроса на обновление. Используйте это значение как previous_update_id в последующих запросах для выполнения добавочных обновлений.	Да

MemoryStoreUpdateStatus

Состояние операции обновления хранилища памяти.

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

MicrosoftFabricPreviewTool

Информация о определении ввода инструмента Microsoft Fabric, используемая для настройки агента.

Name	Type	Description	Обязательный	По умолчанию
fabric_dataagent_preview	FabricDataAgentToolParameters	Параметры инструмента агента данных набора данных.	Да
└project_connections project_connections	массив ToolProjectConnection	Подключения project, подключенные к этому средству. Может быть не более 1 подключения ресурс, подключенный к средству. Ограничения: maxItems: 1	Нет
type	enum	Тип объекта, который всегда «fabric_dataagent_preview». Возможные значения: fabric_dataagent_preview	Да

Развертывание модели

Определение развертывания модели

Name	Type	Description	Обязательный	По умолчанию
capabilities	object (только для чтения)	Возможности развернутой модели	Да
connectionName	строка (только для чтения)	Имя подключения, из который происходит развертывание	Нет
modelName	строка (только для чтения)	Publisher имя развернутой модели	Да
modelPublisher	строка (только для чтения)	Имя издателя развернутой модели	Да
версия модели	строка (только для чтения)	Publisher версия развернутой модели	Да
имя	строка (только для чтения)	Имя развертывания	Да
sku	Sku (только для чтения)	Сведения о номере SKU	Да
Емкость └️	целое число	Емкость SKU	Да
Семья └️	строка	Семейство Sku	Да
└️ имя	строка	Имя SKU	Да
└️ размер	строка	Размер SKU	Да
Уровень └️	строка	Уровень SKU	Да
type	enum	Тип развертывания Возможные значения: ModelDeployment	Да

ModelSamplingParams

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

Name	Type	Description	Обязательный	По умолчанию
max_completion_tokens (максимальное количество токенов завершения)	целое число	Максимальное число маркеров, разрешенных в завершении.	Да
seed	целое число	Случайное начальное значение для воспроизведения.	Да
Температура	number	Параметр температуры для выборки.	Да
top_p	number	Параметр top-p для выборки ядра.	Да

ModelSamplingParamsUpdate

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

Name	Type	Description	Обязательный	По умолчанию
max_completion_tokens (максимальное количество токенов завершения)	целое число	Максимальное число маркеров, разрешенных в завершении.	Нет
seed	целое число	Случайное начальное значение для воспроизведения.	Нет
Температура	number	Параметр температуры для выборки.	Нет
top_p	number	Параметр top-p для выборки ядра.	Нет

MonthlyRecurrenceSchedule

Ежемесячный график повторения.

Name	Type	Description	Обязательный	По умолчанию
daysOfMonth	массив целых чисел	Дни месяца для расписания повторения.	Да
type	enum	Ежемесячный тип повторения. Возможные значения: Monthly	Да

NoAuthenticationCredentials

Учетные данные, не требующие аутентификации

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

OAuthConsentRequestOutputItem

Запрос от службы для пользователя для выполнения согласия OAuth.

Name	Type	Description	Обязательный	По умолчанию
agent_reference	AgentReference		Нет
└️ имя	строка	Имя агента. Ограничения: maxLength: 256	Да
└─ Тип	enum	Возможные значения: agent_reference	Да
└─ Версия	строка	Идентификатор версии агента.	Нет
consent_link	строка	Ссылка, используемая пользователем для выполнения согласия OAuth.	Да
id	строка		Да
response_id	строка	Ответ, на котором создается элемент.	Нет
метка сервера	строка	Метка сервера для запроса на согласие OAuth.	Да
type	enum	Возможные значения: oauth_consent_request	Да

OneTimeTrigger

Одноразовый спусковой крючок.

Name	Type	Description	Обязательный	По умолчанию
timeZone	строка	Часовой пояс для одноразового триггера.	Нет	UTC
triggerAt	строка	Дата и время для одноразового запуска в формате ISO 8601.	Да
type	enum	Возможные значения: OneTime	Да

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.ApplyPatchCallOutputStatusParam

Значения результатов, сообщаемые для выходных данных apply_patch средства.

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

OpenAI.ApplyPatchCallStatus

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

OpenAI.ApplyPatchCallStatusParam

Значения состояния, сообщаемые для вызовов apply_patch инструментов.

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

OpenAI.ApplyPatchCreateFileOperation

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

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

OpenAI.ApplyPatchCreateFileOperationParam

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

Name	Type	Description	Обязательный	По умолчанию
Diff	строка	Унифицированное содержимое диффа, применяемое при создании файла. Ограничения: maxLength: 10485760	Да
path	строка	Путь к файлу для создания относительно корневого каталога рабочей области. Ограничения: minLength: 1	Да
type	enum	Тип операции. Всегда create_file. Возможные значения: create_file	Да

OpenAI.ApplyPatchDeleteFileOperation

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

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

OpenAI.ApplyPatchDeleteFileOperationParam

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

Name	Type	Description	Обязательный	По умолчанию
path	строка	Путь к файлу для удаления относительно корневого каталога рабочей области. Ограничения: minLength: 1	Да
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.ApplyPatchOperationParam

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

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

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

Значение типа	Schema
create_file	OpenAI.ApplyPatchCreateFileOperationParam
delete_file	OpenAI.ApplyPatchDeleteFileOperationParam
update_file	OpenAI.ApplyPatchUpdateFileOperationParam

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

OpenAI.ApplyPatchOperationParamType

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

OpenAI.ApplyPatchToolParam

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

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

OpenAI.ApplyPatchUpdateFileOperation

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

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

OpenAI.ApplyPatchUpdateFileOperationParam

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

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

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

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

Инструмент завершения чата OpenAI

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

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

OpenAI.ChatModel

Property	Ценность
Type	строка
Значения	gpt-5.2 gpt-5.2-2025-12-11 gpt-5.2-chat-latest gpt-5.2-pro gpt-5.2-pro-2025-12-11 gpt-5.1 gpt-5.1-2025-11-13 gpt-5.1-codex gpt-5.1-mini gpt-5.1-chat-latest gpt-5 gpt-5-mini gpt-5-nano gpt-5-2025-08-07 gpt-5-mini-2025-08-07 gpt-5-nano-2025-08-07 gpt-5-chat-latest gpt-4.1 gpt-4.1-mini gpt-4.1-nano gpt-4.1-2025-04-14 gpt-4.1-mini-2025-04-14 gpt-4.1-nano-2025-04-14 o4-mini o4-mini-2025-04-16 o3 o3-2025-04-16 o3-mini o3-mini-2025-01-31 o1 o1-2024-12-17 o1-preview o1-preview-2024-09-12 o1-mini o1-mini-2024-09-12 gpt-4o gpt-4o-2024-11-20 gpt-4o-2024-08-06 gpt-4o-2024-05-13 gpt-4o-audio-preview gpt-4o-audio-preview-2024-10-01 gpt-4o-audio-preview-2024-12-17 gpt-4o-audio-preview-2025-06-03 gpt-4o-mini-audio-preview gpt-4o-mini-audio-preview-2024-12-17 gpt-4o-search-preview gpt-4o-mini-search-preview gpt-4o-search-preview-2025-03-11 gpt-4o-mini-search-preview-2025-03-11 chatgpt-4o-latest codex-mini-latest gpt-4o-mini gpt-4o-mini-2024-07-18 gpt-4-turbo gpt-4-turbo-2024-04-09 gpt-4-0125-preview gpt-4-turbo-preview gpt-4-1106-preview gpt-4-vision-preview gpt-4 gpt-4-0314 gpt-4-0613 gpt-4-32k gpt-4-32k-0314 gpt-4-32k-0613 gpt-3.5-turbo gpt-3.5-turbo-16k gpt-3.5-turbo-0301 gpt-3.5-turbo-0613 gpt-3.5-turbo-1106 gpt-3.5-turbo-0125 gpt-3.5-turbo-16k-0613

OpenAI.ClickButtonType

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

OpenAI.ClickParam

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

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

OpenAI.CodeInterpreterContainerAuto

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

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

OpenAI.CodeInterpreterOutputImage

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

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

OpenAI.CodeInterpreterOutputLogs

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

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

OpenAI.CodeInterpreterTool

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

Name	Type	Description	Обязательный	По умолчанию
container	string или OpenAI.CodeInterpreterContainerAuto	Контейнер интерпретатора кода. Может быть идентификатором контейнера или объектом, который указывает идентификаторы отправленных файлов, чтобы предоставить доступ к коду, а также необязательный memory_limit параметр. Если эта служба не указана, служба предполагает автоматическое использование.	Нет
type	enum	Тип средства интерпретатора кода. Всегда code_interpreter. Возможные значения: code_interpreter	Да

OpenAI.CompactResource

Name	Type	Description	Обязательный	По умолчанию
создано_в	целое число	Метка времени Unix (в секундах) при создании сжатой беседы.	Да
id	строка	Уникальный идентификатор компактного ответа.	Да
object	enum	Тип объекта. Всегда response.compaction. Возможные значения: response.compaction	Да
output	массив OpenAI.OutputItem	Сжатый список выходных элементов. Это список всех сообщений пользователей, за которым следует один элемент сжатия.	Да
использование	OpenAI.ResponseUsage	Представляет сведения об использовании маркеров, включая входные маркеры, выходные маркеры, разбивка выходных маркеров и общих используемых маркеров.	Да
└input_tokens	OpenAI.integer	Количество входных токенов.	Да
└─ данные_входных_токенов	OpenAI.ResponseUsageInputTokensDetails	Подробная разбивка входных токенов.	Да
└─ выходные_токены (output_tokens)	OpenAI.integer	Количество выходных токенов.	Да
└️ output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails	Подробная разбивка выходных маркеров.	Да
└️ всего_токенов	OpenAI.integer	Общее количество используемых токенов.	Да

OpenAI.CompactResponseMethodPublicBody

Name	Type	Description	Обязательный	По умолчанию
input	строка или массив OpenAI.InputItem		Нет
instructions	Строка (нулевая)		Нет
модель	OpenAI.ModelIdsCompaction	Идентификатор модели, используемый для создания ответа, например gpt-5 или o3. OpenAI предлагает широкий спектр моделей с разными возможностями, характеристиками производительности и ценами. Ознакомьтесь с руководством по модели для просмотра и сравнения доступных моделей.	Да
previous_response_id	Строка (нулевая)		Нет

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	Да
value	string или OpenAI.numeric или boolean или массив OpenAI.ComparisonFilterValueItems	Значение для сравнения с ключом атрибута; поддерживает типы строк, чисел или логических типов.	Да

OpenAI.ComparisonFilterValueItems

Тип: string или OpenAI.numeric

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	Строка (нулевая)		Нет
id	строка	Идентификатор ожидающей проверки безопасности.	Да
message	Строка (нулевая)		Нет

OpenAI.ComputerEnvironment

Property	Ценность
Type	строка
Значения	windows mac linux ubuntu browser

OpenAI.ComputerScreenshotContent

Снимок экрана: компьютер.

Name	Type	Description	Обязательный	По умолчанию
идентификатор_файла	Строка (нулевая)		Да
ссылка_на_изображение	строка		Да
type	enum	Указывает тип события. Для снимка экрана компьютера это свойство всегда имеет значение computer_screenshot. Возможные значения: computer_screenshot	Да

OpenAI.ComputerScreenshotImage

Снимок экрана компьютера, используемый с помощью инструмента для использования компьютера.

Name	Type	Description	Обязательный	По умолчанию
идентификатор_файла	строка	Идентификатор отправленного файла, содержащего снимок экрана.	Нет
ссылка_на_изображение	строка	URL-адрес изображения снимка экрана.	Нет
type	enum	Указывает тип события. Снимок экрана компьютера: это свойство всегда задано значение computer_screenshot. Возможные значения: computer_screenshot	Да

OpenAI.ИнструментПредварительногоПросмотраИспользованияКомпьютера

Средство управления виртуальным компьютером.

Name	Type	Description	Обязательный	По умолчанию
высота дисплея	OpenAI.integer		Да
ширина дисплея	OpenAI.integer		Да
environment	OpenAI.ComputerEnvironment		Да
type	enum	Тип средства использования компьютера. Всегда computer_use_preview. Возможные значения: computer_use_preview	Да

OpenAI.ContainerFileCitationBody

Ссылка на файл контейнера, используемый для создания ответа модели.

Name	Type	Description	Обязательный	По умолчанию
container_id	строка	Идентификатор файла контейнера.	Да
end_index	OpenAI.integer		Да
идентификатор_файла	строка	Идентификатор файла.	Да
filename	строка	Имя файла контейнера.	Да
start_index	OpenAI.integer		Да
type	enum	Тип ссылки на файл контейнера. Всегда container_file_citation. Возможные значения: container_file_citation	Да

OpenAI.ContainerMemoryLimit

Property	Ценность
Type	строка
Значения	1g 4g 16g 64g

OpenAI.ConversationItem

Один элемент в беседе. Набор возможных типов совпадает с output типом объекта Response.

Дискриминация для OpenAI.ConversationItem

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа	Schema
message	OpenAI.ConversationItemMessage
function_call	OpenAI.ConversationItemFunctionToolCallResource
function_call_output	OpenAI.ConversationItemFunctionToolCallOutputResource
file_search_call	OpenAI.ConversationItemFileSearchToolCall
web_search_call	OpenAI.ConversationItemWebSearchToolCall
image_generation_call	OpenAI.ConversationItemImageGenToolCall
computer_call	OpenAI.ConversationItemComputerToolCall
computer_call_output	OpenAI.ConversationItemComputerToolCallOutputResource
reasoning	OpenAI.ConversationItemReasoningItem
code_interpreter_call	OpenAI.ConversationItemCodeInterpreterToolCall
local_shell_call	OpenAI.ConversationItemLocalShellToolCall
local_shell_call_output	OpenAI.ConversationItemLocalShellToolCallOutput
shell_call	OpenAI.ConversationItemFunctionShellCall
shell_call_output	OpenAI.ConversationItemFunctionShellCallOutput
apply_patch_call	OpenAI.ConversationItemApplyPatchToolCall
apply_patch_call_output	OpenAI.ConversationItemApplyPatchToolCallOutput
mcp_list_tools	OpenAI.ConversationItemMcpListTools
mcp_approval_request	OpenAI.ConversationItemMcpApprovalRequest
mcp_approval_response	OpenAI.ConversationItemMcpApprovalResponseResource
mcp_call	OpenAI.ConversationItemMcpToolCall
custom_tool_call	OpenAI.ConversationItemCustomToolCall
custom_tool_call_output	OpenAI.ConversationItemCustomToolCallOutput

Name	Type	Description	Обязательный	По умолчанию
type	OpenAI.ConversationItemType		Да

OpenAI.ConversationItemApplyPatchToolCall

Вызов средства, который применяет диффы файлов, создавая, удаляя или обновляя файлы.

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	Да

OpenAI.ConversationItemApplyPatchToolCallOutput

Выходные данные, создаваемые вызовом средства исправления.

Name	Type	Description	Обязательный	По умолчанию
call_id	строка	Уникальный идентификатор вызова средства исправления, созданного моделью.	Да
создано пользователем	строка	Идентификатор сущности, создающей выходные данные вызова этого средства.	Нет
id	строка	Уникальный идентификатор выходных данных вызова средства исправления. Заполняется, когда этот элемент возвращается через API.	Да
output	Строка (нулевая)		Нет
Статус	OpenAI.ApplyPatchCallOutputStatus		Да
type	enum	Тип элемента. Всегда apply_patch_call_output. Возможные значения: apply_patch_call_output	Да

OpenAI.ConversationItemCodeInterpreterToolCall

Вызов инструмента для выполнения кода.

Name	Type	Description	Обязательный	По умолчанию
code	Строка (нулевая)		Да
container_id	строка	Идентификатор контейнера, используемого для запуска кода.	Да
id	строка	Уникальный идентификатор вызова средства интерпретатора кода.	Да
outputs	массив OpenAI.CodeInterpreterOutputLogs или OpenAI.CodeInterpreterOutputImage		Да
Статус	enum	Состояние вызова средства интерпретатора кода. Допустимые значения: in_progress, completed, incomplete, interpreting, и failed. Возможные значения: in_progress, completed, incomplete, interpreting, failed	Да
type	enum	Тип вызова средства интерпретатора кода. Всегда code_interpreter_call. Возможные значения: code_interpreter_call	Да

OpenAI.ConversationItemComputerToolCall

Вызов инструмента для работы с компьютером. Дополнительные сведения см. в руководстве по использованию компьютера .

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	Да

OpenAI.ConversationItemComputerToolCallOutputResource

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	Да

OpenAI.ConversationItemCustomToolCall

Вызов пользовательского средства, созданного моделью.

Name	Type	Description	Обязательный	По умолчанию
call_id	строка	Идентификатор, используемый для сопоставления этого настраиваемого вызова средства с выходными данными вызова средства.	Да
id	строка	Уникальный идентификатор вызова пользовательского средства на платформе OpenAI.	Нет
input	строка	Входные данные для вызова пользовательского средства, созданного моделью.	Да
имя	строка	Имя вызываемого пользовательского инструмента.	Да
type	enum	Тип вызова пользовательского средства. Всегда custom_tool_call. Возможные значения: custom_tool_call	Да

OpenAI.ConversationItemCustomToolCallOutput

Выходные данные вызова пользовательского средства из кода, отправляемые обратно в модель.

Name	Type	Description	Обязательный	По умолчанию
call_id	строка	Идентификатор вызова, используемый для сопоставления выходных данных этого пользовательского средства с пользовательским вызовом средства.	Да
id	строка	Уникальный идентификатор выходных данных вызова пользовательского средства на платформе OpenAI.	Нет
output	строка или массив OpenAI.FunctionAndCustomToolCallOutput	Выходные данные из вызова пользовательского средства, созданного кодом. Может быть строкой или списком выходного содержимого.	Да
type	enum	Тип выходных данных вызова пользовательского средства. Всегда custom_tool_call_output. Возможные значения: custom_tool_call_output	Да

OpenAI.ConversationItemFileSearchToolCall

Результаты вызова средства поиска файлов. Дополнительные сведения см. в руководстве по поиску файлов .

Name	Type	Description	Обязательный	По умолчанию
id	строка	Уникальный идентификатор вызова средства поиска файлов.	Да
queries	массив строк	Запросы, используемые для поиска файлов.	Да
results	массив OpenAI.FileSearchToolCallResults		Нет
Статус	enum	Состояние вызова средства поиска файлов. Один из in_progress, searching, incomplete или failed, Возможные значения: in_progress, searching, completed, incomplete, failed	Да
type	enum	Тип вызова средства поиска файлов. Всегда file_search_call. Возможные значения: file_search_call	Да

OpenAI.ConversationItemFunctionShellCall

Вызов средства, выполняющий одну или несколько команд оболочки в управляемой среде.

Name	Type	Description	Обязательный	По умолчанию
action	OpenAI.FunctionShellAction	Выполните команду оболочки.	Да
Команды └️	массив строк		Да
└max_output_length	OpenAI.integer (nullable)		Да
└️ timeout_ms	OpenAI.integer (nullable)		Да
call_id	строка	Уникальный идентификатор вызова средства оболочки, созданного моделью.	Да
создано пользователем	строка	Идентификатор сущности, созданной этим средством.	Нет
id	строка	Уникальный идентификатор вызова средства оболочки. Заполняется, когда этот элемент возвращается через API.	Да
Статус	OpenAI.LocalShellCallStatus		Да
type	enum	Тип элемента. Всегда shell_call. Возможные значения: shell_call	Да

OpenAI.ConversationItemFunctionShellCallOutput

Выходные данные вызова средства оболочки, который был создан.

Name	Type	Description	Обязательный	По умолчанию
call_id	строка	Уникальный идентификатор вызова средства оболочки, созданного моделью.	Да
создано пользователем	строка	Идентификатор субъекта, создавшего элемент.	Нет
id	строка	Уникальный идентификатор выходных данных вызова оболочки. Заполняется, когда этот элемент возвращается через API.	Да
max_output_length	OpenAI.integer (nullable)		Да
output	массив OpenAI.FunctionShellCallOutputContent	Массив содержимого вывода вызова оболочки	Да
type	enum	Тип выходных данных вызова оболочки. Всегда shell_call_output. Возможные значения: shell_call_output	Да

OpenAI.ConversationItemFunctionToolCallOutputResource

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.ConversationItemFunctionToolCallResource

Name	Type	Description	Обязательный	По умолчанию
arguments	строка	Строка JSON аргументов для передачи функции.	Да
call_id	строка	Уникальный идентификатор вызова функции, созданного моделью.	Да
id	строка	Уникальный идентификатор вызова средства функции.	Нет
имя	строка	Имя выполняемой функции.	Да
Статус	enum	Состояние элемента. Один из in_progress, completedили incomplete. Заполняется, когда элементы возвращаются через API. Возможные значения: in_progress, completedincomplete	Нет
type	enum	Тип вызова инструмента функции. Всегда function_call. Возможные значения: function_call	Да

OpenAI.ConversationItemImageGenToolCall

Запрос на создание изображения, сделанный моделью.

Name	Type	Description	Обязательный	По умолчанию
id	строка	Уникальный идентификатор вызова создания образа.	Да
result	Строка (нулевая)		Да
Статус	enum	Состояние вызова создания образа. Возможные значения: in_progress, , completedgeneratingfailed	Да
type	enum	Тип вызова создания изображения. Всегда image_generation_call. Возможные значения: image_generation_call	Да

OpenAI.ConversationItemList

Список элементов беседы.

Name	Type	Description	Обязательный	По умолчанию
data	массив OpenAI.ConversationItem	Список элементов беседы.	Да
первый_идентификатор	строка	Идентификатор первого элемента в списке.	Да
есть_еще	boolean	Доступны ли дополнительные элементы.	Да
last_id	строка	Идентификатор последнего элемента в списке.	Да
object	enum	Тип возвращаемого объекта должен быть list. Возможные значения: list	Да

OpenAI.ConversationItemLocalShellToolCall

Вызов инструмента для выполнения команды в локальной оболочке.

Name	Type	Description	Обязательный	По умолчанию
action	OpenAI.LocalShellExecAction	Выполните команду оболочки на сервере.	Да
call_id	строка	Уникальный идентификатор вызова локального утилита оболочки, сгенерированного моделью.	Да
id	строка	Уникальный идентификатор вызова локальной оболочки.	Да
Статус	enum	Состояние вызова локальной оболочки. Возможные значения: in_progress, completedincomplete	Да
type	enum	Тип вызова локальной оболочки. Всегда local_shell_call. Возможные значения: local_shell_call	Да

OpenAI.ConversationItemLocalShellToolCallOutput

Выходные данные вызова локального оболочечного инструмента.

Name	Type	Description	Обязательный	По умолчанию
id	строка	Уникальный идентификатор вызова локального утилита оболочки, сгенерированного моделью.	Да
output	строка	Строка JSON, представляющая результаты вызова локального инструмента оболочки.	Да
Статус	enum	Возможные значения: in_progress, completedincomplete	Нет
type	enum	Тип выходных данных вызова средства локальной оболочки. Всегда local_shell_call_output. Возможные значения: local_shell_call_output	Да

OpenAI.ConversationItemMcpApprovalRequest

Запрос на одобрение человеком вызова инструмента.

Name	Type	Description	Обязательный	По умолчанию
arguments	строка	Строка JSON с аргументами для средства.	Да
id	строка	Уникальный идентификатор запроса на утверждение.	Да
имя	строка	Имя запускаемого инструмента.	Да
метка сервера	строка	Метка сервера MCP, выполняющего запрос.	Да
type	enum	Тип элемента. Всегда mcp_approval_request. Возможные значения: mcp_approval_request	Да

OpenAI.ConversationItemMcpApprovalResponseResource

Ответ на запрос на утверждение MCP.

Name	Type	Description	Обязательный	По умолчанию
approval_request_id	строка	Идентификатор запроса на утверждение, на который даётся ответ.	Да
Утвердить	boolean	Будет ли утвержден запрос.	Да
id	строка	Уникальный идентификатор ответа на утверждение	Да
причина	Строка (нулевая)		Нет
type	enum	Тип элемента. Всегда mcp_approval_response. Возможные значения: mcp_approval_response	Да

OpenAI.ConversationItemMcpListTools

Список средств, доступных на сервере MCP.

Name	Type	Description	Обязательный	По умолчанию
error	Строка (нулевая)		Нет
id	строка	Уникальный идентификатор списка.	Да
метка сервера	строка	Метка сервера MCP.	Да
tools	массив OpenAI.MCPListToolsTools	Средства, доступные на сервере.	Да
type	enum	Тип элемента. Всегда mcp_list_tools. Возможные значения: mcp_list_tools	Да

OpenAI.ConversationItemMcpToolCall

Вызов инструмента на сервере MCP.

Name	Type	Description	Обязательный	По умолчанию
approval_request_id	Строка (нулевая)		Нет
arguments	строка	Строка JSON аргументов, переданных средству.	Да
error	Строка (нулевая)		Нет
id	строка	Уникальный идентификатор вызова средства.	Да
имя	строка	Имя запущенного инструмента.	Да
output	Строка (нулевая)		Нет
метка сервера	строка	Метка сервера MCP, на котором работает инструмент.	Да
Статус	OpenAI.MCPToolCallStatus		Нет
type	enum	Тип элемента. Всегда mcp_call. Возможные значения: mcp_call	Да

OpenAI.ConversationItemMessage

Сообщение в модель или из нее.

Name	Type	Description	Обязательный	По умолчанию
содержимое	массив OpenAI.MessageContent	Содержимое сообщения	Да
id	строка	Уникальный идентификатор сообщения.	Да
role	OpenAI.MessageRole		Да
Статус	OpenAI.MessageStatus		Да
type	enum	Тип сообщения. Всегда задано значение message. Возможные значения: message	Да

OpenAI.ConversationItemReasoningItem

Описание цепочки мысли, используемой моделью причин при создании ответа. Не забудьте включить эти элементы в input API ответов для последующих поворотов беседы, если вы вручную управляете контекстом.

Name	Type	Description	Обязательный	По умолчанию
содержимое	массив OpenAI.ReasoningTextContent	Обоснование текстового содержимого.	Нет
encrypted_content	Строка (нулевая)		Нет
id	строка	Уникальный идентификатор контента рассуждений.	Да
Статус	enum	Состояние элемента. Один из in_progress, completedили incomplete. Заполняется, когда элементы возвращаются через API. Возможные значения: in_progress, completedincomplete	Нет
summary	массив OpenAI.Summary	Содержимое сводки по причинам.	Да
type	enum	Тип объекта . Всегда reasoning. Возможные значения: reasoning	Да

OpenAI.ConversationItemType

Property	Ценность
Type	строка
Значения	message function_call function_call_output file_search_call web_search_call image_generation_call computer_call computer_call_output reasoning 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 custom_tool_call custom_tool_call_output

OpenAI.ConversationItemWebSearchToolCall

Результаты вызова средства поиска в Интернете. Дополнительные сведения см. в руководстве по поиску в Интернете .

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.ConversationParam

Беседа, к которой относится этот ответ. Элементы из этой беседы предопределяются input_items для этого запроса ответа. Входные элементы и выходные элементы из этого ответа автоматически добавляются в эту беседу после завершения этого ответа.

Тип: string или OpenAI.ConversationParam-2

Беседа, к которой относится этот ответ. Элементы из этой беседы предопределяются input_items для этого запроса ответа. Входные элементы и выходные элементы из этого ответа автоматически добавляются в эту беседу после завершения этого ответа.

OpenAI.ConversationParam-2

Беседа, к которой относится этот ответ.

Name	Type	Description	Обязательный	По умолчанию
id	строка	Уникальный идентификатор беседы.	Да

OpenAI.ConversationReference

Беседа, к которой относится этот ответ. Входные элементы и выходные элементы из этого ответа были автоматически добавлены в эту беседу.

Name	Type	Description	Обязательный	По умолчанию
id	строка	Уникальный идентификатор беседы, с которым связан этот ответ.	Да

OpenAI.ConversationResource

Name	Type	Description	Обязательный	По умолчанию
создано_в	целое число	Время создания беседы измеряется в секундах с эпохи Unix.	Да
id	строка	Уникальный идентификатор беседы.	Да
metadata	OpenAI.Metadata	Набор из 16 пар "ключ-значение", которые можно прикрепить к объекту. Это может быть Полезно для хранения дополнительных сведений об объекте в структурированном виде. форматирование и запрос объектов через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — строки с максимальной длиной 512 символов.	Да
object	enum	Тип объекта, который всегда является conversation. Возможные значения: conversation	Да

OpenAI.CreateChatCompletionRequestResponseFormat

Объект, указывающий формат, который должен выводить модель. Параметр для { "type": "json_schema", "json_schema": {...} } включения структурированных выходных данных, которые гарантируют, что модель будет соответствовать предоставленной схеме JSON. Дополнительные сведения см. в руководстве по структурированным выходным данным. Настройка для { "type": "json_object" } включает старый режим JSON, который гарантирует, что создаваемое моделью сообщение является допустимым JSON. Использование json_schema предпочтительнее для моделей, поддерживающих его.

Дискриминация для OpenAI.CreateChatCompletionRequestResponseFormat

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа	Schema
text	OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatText
json_object	OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject

Name	Type	Description	Обязательный	По умолчанию
type	OpenAI.CreateChatCompletionRequestResponseFormatType		Да

OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject

Формат отклика объекта JSON. Старый метод создания ответов JSON. Рекомендуется использовать json_schema для моделей, поддерживающих его. Обратите внимание, что модель не будет создавать JSON без системного или пользовательского сообщения, которое дает ей соответствующую команду.

Name	Type	Description	Обязательный	По умолчанию
type	enum	Тип определяемого формата ответа. Всегда json_object. Возможные значения: json_object	Да

OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatText

Формат ответа по умолчанию. Используется для создания текстовых ответов.

Name	Type	Description	Обязательный	По умолчанию
type	enum	Тип определяемого формата ответа. Всегда text. Возможные значения: text	Да

OpenAI.CreateChatCompletionRequestResponseFormatType

Property	Ценность
Type	строка
Значения	text json_schema json_object

OpenAI.CreateConversationBody

Name	Type	Description	Обязательный	По умолчанию
items	массив OpenAI.InputItem		Нет
metadata	OpenAI.Metadata (nullable)	Набор из 16 пар "ключ-значение", которые можно прикрепить к объекту. Это может быть Полезно для хранения дополнительных сведений об объекте в структурированном виде. форматирование и запрос объектов через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — строки с максимальной длиной 512 символов.	Нет

OpenAI.CreateEvalCompletionsRunDataSource

Объект CompletionsRunDataSource, описывающий конфигурацию выборки модели.

Name	Type	Description	Обязательный	По умолчанию
входные_сообщения	OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesTemplate или OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference	Используется при выборке из модели. Определяет структуру сообщений, передаваемых в модель. Может быть ссылка на предварительно созданную траекторию (т. е. item.input_trajectory) или шаблон с переменными ссылками на item пространство имен.	Нет
модель	строка	Имя модели, используемой для генерации завершений (например, "o3-mini").	Нет
параметры выборки	OpenAI.CreateEvalCompletionsRunDataSourceSamplingParams		Нет
Источник	OpenAI.EvalJsonlFileContentSource или OpenAI.EvalJsonlFileIdSource или OpenAI.EvalStoredCompletionsSource	Определяет, что заполняет item пространство имен в источнике данных этого запуска.	Да
type	enum	Тип источника данных запуска. Всегда completions. Возможные значения: completions	Да

OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference

Name	Type	Description	Обязательный	По умолчанию
item_reference	строка		Да
type	enum	Возможные значения: item_reference	Да

OpenAI.CreateEvalCompletionsRunDataSourceInputMessagessTemplate

Name	Type	Description	Обязательный	По умолчанию
template	массив OpenAI.EasyInputMessage или OpenAI.EvalItem		Да
type	enum	Возможные значения: template	Да

OpenAI.CreateEvalCompletionsRunDataSourceSamplingParams

Name	Type	Description	Обязательный	По умолчанию
max_completion_tokens (максимальное количество токенов завершения)	OpenAI.integer		Нет
усилия на рассуждение	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.	Нет
формат_ответа	OpenAI.ResponseFormatText или OpenAI.ResponseFormatJsonSchema или OpenAI.ResponseFormatJsonObject		Нет
seed	OpenAI.integer		Нет	42
Температура	OpenAI.numeric		Нет	1
tools	массив OpenAI.ChatCompletionTool		Нет
top_p	OpenAI.numeric		Нет	1

OpenAI.CreateEvalCustomDataSourceConfig

Объект CustomDataSourceConfig, определяющий схему источника данных, используемого для выполнения оценки. Эта схема используется для определения формы данных, которые будут:

• Используется для определения критериев тестирования и
• Какие данные требуются при создании запуска

Name	Type	Description	Обязательный	По умолчанию
включить_пример_схемы	boolean	Должен ли eval ожидать, что вы заполните пространство имен образца (т. е. создавая ответы на основе вашего источника данных)	Нет
схема_элемента	object	Схема JSON для каждой строки в источнике данных.	Да
type	enum	Тип источника данных. Всегда custom. Возможные значения: custom	Да

OpenAI.CreateEvalJsonlRunDataSource

Объект JsonlRunDataSource, указывающий JSONL-файл, соответствующий оценке.

Name	Type	Description	Обязательный	По умолчанию
Источник	OpenAI.EvalJsonlFileContentSource или OpenAI.EvalJsonlFileIdSource	Определяет, что заполняет item пространство имен в источнике данных.	Да
type	enum	Тип источника данных. Всегда jsonl. Возможные значения: jsonl	Да

OpenAI.CreateEvalLogsDataSourceConfig

Конфигурация источника данных, указывающая свойство метаданных запроса журналов. Обычно это метаданные, такие как usecase=chatbot или prompt-version=v2и т. д.

Name	Type	Description	Обязательный	По умолчанию
metadata	object	Фильтры метаданных для источника данных журналов.	Нет
type	enum	Тип источника данных. Всегда logs. Возможные значения: logs	Да

OpenAI.CreateEvalResponsesRunDataSource

Объект ResponsesRunDataSource, описывающий конфигурацию выборки модели.

Name	Type	Description	Обязательный	По умолчанию
входные_сообщения	OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate или OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference	Используется при выборке из модели. Определяет структуру сообщений, передаваемых в модель. Может быть ссылка на предварительно созданную траекторию (т. е. item.input_trajectory) или шаблон с переменными ссылками на item пространство имен.	Нет
модель	строка	Имя модели, используемой для генерации завершений (например, "o3-mini").	Нет
параметры выборки	OpenAI.CreateEvalResponsesRunDataSourceSamplingParams		Нет
Источник	OpenAI.EvalJsonlFileContentSource или OpenAI.EvalJsonlFileIdSource или OpenAI.EvalResponsesSource	Определяет, что заполняет item пространство имен в источнике данных этого запуска.	Да
type	enum	Тип источника данных запуска. Всегда responses. Возможные значения: responses	Да

OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference

Name	Type	Description	Обязательный	По умолчанию
item_reference	строка		Да
type	enum	Возможные значения: item_reference	Да

OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate

Name	Type	Description	Обязательный	По умолчанию
template	массив объекта или OpenAI.EvalItem		Да
type	enum	Возможные значения: template	Да

OpenAI.CreateEvalResponsesRunDataSourceSamplingParams

Name	Type	Description	Обязательный	По умолчанию
max_completion_tokens (максимальное количество токенов завершения)	OpenAI.integer		Нет
усилия на рассуждение	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.	Нет
seed	OpenAI.integer		Нет	42
Температура	OpenAI.numeric		Нет	1
text	OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText		Нет
tools	массив OpenAI.Tool		Нет
top_p	OpenAI.numeric		Нет	1

OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText

Name	Type	Description	Обязательный	По умолчанию
format	OpenAI.TextResponseFormatConfiguration	Объект, указывающий формат, который должен выводить модель. Настройка { "type": "json_schema" } позволяет использовать структурированные выходные данные, это гарантирует, что модель будет соответствовать предоставленной схеме JSON. Узнайте больше в разделе Формат по умолчанию — это { "type": "text" } без дополнительных параметров. *Не рекомендуется для gpt-4o и более новых моделей:** Установка { "type": "json_object" } включает старый режим JSON, который гарантирует, что сообщение, которое создает модель, является допустимым JSON. С использованием json_schema предпочтителен для моделей, поддерживающих его.	Нет

OpenAI.CreateEvalStoredCompletionsDataSourceConfig

Устарел в пользу LogsDataSourceConfig.

Name	Type	Description	Обязательный	По умолчанию
metadata	object	Фильтры метаданных для источника данных сохранённых завершений.	Нет
type	enum	Тип источника данных. Всегда stored_completions. Возможные значения: stored_completions	Да

OpenAI.CreateFineTuningJobRequest

Допустимые модели:

babbage-002
davinci-002
gpt-3.5-turbo
gpt-4o-mini

Name	Type	Description	Обязательный	По умолчанию
гиперпараметры	OpenAI.CreateFineTuningJobRequestHyperparameters		Нет
└batch_size	string или OpenAI.integer		Нет	авто
└─ learning_rate_multiplier	string или OpenAI.numeric		Нет
└️ n_epochs	string или OpenAI.integer		Нет	авто
Интеграции	массив OpenAI.CreateFineTuningJobRequestIntegrations	Список интеграций, которые нужно включить для задания по тонкой настройке.	Нет
metadata	OpenAI.Metadata (nullable)	Набор из 16 пар "ключ-значение", которые можно прикрепить к объекту. Это может быть Полезно для хранения дополнительных сведений об объекте в структурированном виде. форматирование и запрос объектов через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — строки с максимальной длиной 512 символов.	Нет
method	OpenAI.FineTuneMethod	Метод, используемый для точной настройки.	Нет
модель	строка (см. допустимые модели ниже)	Имя модели для точной настройки. Вы можете выбрать один из них. поддерживаемые модели.	Да
seed	OpenAI.integer (nullable)		Нет
Суффикс	Строка (нулевая)	Строка длиной до 64 символов, которая будет добавлена к имени настраиваемой модели. Например, suffix "custom-model-name" даст имя модели, подобное ft:gpt-4o-mini:openai:custom-model-name:7p4lURel. Ограничения: minLength: 1, maxLength: 64	Нет
файл_обучения	строка	Идентификатор отправленного файла, содержащего данные обучения. Сведения о том, как отправить файл, см. в разделе "Отправка файла ". Набор данных должен быть отформатирован в формате JSONL-файла. Кроме того, необходимо загрузить ваш файл для цели fine-tune. Содержимое файла должно отличаться в зависимости от того, использует ли модель чат, формат завершения или использует ли метод тонкой настройки формат предпочтения . Дополнительные сведения см. в руководстве по тонкой настройке .	Да
Файл_валидации	Строка (нулевая)	Идентификатор отправленного файла, содержащего данные проверки. Если этот файл предоставлен, данные используются для создания валидации Метрики измеряются периодически во время тонкой настройки. Эти метрики можно просмотреть в файл результатов тонкой настройки. Одни и те же данные не должны присутствовать в файлах обучения и проверки. Набор данных должен быть отформатирован в формате JSONL-файла. Необходимо загрузить файл с целью fine-tune. Дополнительные сведения см. в руководстве по тонкой настройке .	Нет

OpenAI.CreateFineTuningJobRequestHyperparameters

Name	Type	Description	Обязательный	По умолчанию
размер пакета	string или OpenAI.integer		Нет
множитель скорости обучения	string или OpenAI.numeric		Нет
количество эпох	string или OpenAI.integer		Нет

OpenAI.CreateFineTuningJobRequestIntegrations

Name	Type	Description	Обязательный	По умолчанию
type	enum	Возможные значения: wandb	Да
wandb	OpenAI.CreateFineTuningJobRequestIntegrationsWandb		Да

OpenAI.CreateFineTuningJobRequestIntegrationsWandb

Name	Type	Description	Обязательный	По умолчанию
Объект	Строка (нулевая)		Нет
имя	Строка (нулевая)		Нет
project	строка		Да
tags	массив строк		Нет

OpenAI.CreateResponseStreamingResponse

Тип: OpenAI.ResponseAudioDeltaEvent или OpenAI.ResponseAudioTranscriptDeltaEvent или OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent или OpenAI.ResponseCodeInterpreterCallInProgressEvent или OpenAI.ResponseCodeInterpreterCallInterpretingEvent или OpenAI.ResponseContentPartAddedEvent или OpenAI.ResponseCreatedEvent или OpenAI.ResponseErrorEvent или OpenAI.ResponseFileSearchCallInProgressEvent или OpenAI.ResponseFileSearchCallSearchingEvent или OpenAI.ResponseFunctionCallArgumentsDeltaEvent или OpenAI.ResponseInProgressEvent или OpenAI.ResponseFailedEvent или OpenAI.ResponseIncompleteEvent или OpenAI.ResponseOutputItemAddedEvent или OpenAI.ResponseReasoningSummaryPartAddedEvent или OpenAI.ResponseReasoningSummaryTextDeltaEvent или OpenAI.ResponseReasoningTextDeltaEvent или OpenAI.ResponseRefusalDeltaEvent или OpenAI.ResponseTextDeltaEvent или OpenAI.ResponseWebSearchCallInProgressEvent или OpenAI.ResponseWebSearchCallSearchingEvent или OpenAI.ResponseImageGenCallGeneratingEvent или OpenAI.ResponseImageGenCallInProgressEvent или OpenAI.ResponseImageGenCallPartialImageEvent или OpenAI.ResponseMCPCallArgumentsDeltaEvent или OpenAI.ResponseMCPCallFailedEvent или OpenAI.ResponseMCPCallInProgressEvent или OpenAI.ResponseMCPListToolsFailedEvent или OpenAI.ResponseMCPListToolsInProgressEvent или OpenAI.ResponseOutputTextAnnotationAddedEvent или OpenAI.ResponseQueuedEvent или OpenAI.ResponseCustomToolCallInputDeltaEvent или OpenAI.ResponseAudioDoneEvent или OpenAI.ResponseAudioTranscriptDoneEvent или OpenAI.ResponseCodeInterpreterCallCodeDoneEvent или OpenAI.ResponseCodeInterpreterCallCompletedEvent или OpenAI.ResponseCompletedEvent или OpenAI.ResponseContentPartDoneEvent или OpenAI.ResponseFileSearchCallCompletedEvent или OpenAI.ResponseFunctionCallArgumentsDoneEvent или OpenAI.ResponseOutputItemDoneEvent или OpenAI.ResponseReasoningSummaryPartDoneEvent или OpenAI.ResponseReasoningSummaryTextDoneEvent или OpenAI.ResponseReasoningTextDoneEvent или OpenAI.ResponseRefusalDoneEvent или OpenAI.ResponseTextDoneEvent или OpenAI.ResponseWebSearchCallCompletedEvent или OpenAI.ResponseImageGenCallCompletedEvent или OpenAI.ResponseMCPCallArgumentsDoneEvent или OpenAI.ResponseMCPCallCompletedEvent или OpenAI.ResponseMCPListToolsCompletedEvent или OpenAI.ResponseCustomToolCallInputDoneEvent

OpenAI.CustomGrammarFormatParam

Грамматика, определяемая пользователем.

Name	Type	Description	Обязательный	По умолчанию
Определение	строка	Определение грамматики.	Да
Синтаксис	OpenAI.GrammarSyntax1		Да
type	enum	Формат грамматики. Всегда grammar. Возможные значения: grammar	Да

OpenAI.CustomTextFormatParam

Без ограничений текст свободной формы.

Name	Type	Description	Обязательный	По умолчанию
type	enum	Неограниченный текстовый формат. Всегда 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.DeletedConversationResource

Name	Type	Description	Обязательный	По умолчанию
удалено	boolean		Да
id	строка		Да
object	enum	Возможные значения: conversation.deleted	Да

OpenAI.DetailEnum

Property	Ценность
Type	строка
Значения	low high auto

OpenAI.DoubleClickAction

Действие двойного щелчка.

Name	Type	Description	Обязательный	По умолчанию
type	enum	Указывает тип события. Для действия двойного щелчка это свойство всегда имеет значение double_click. Возможные значения: double_click	Да
x	OpenAI.integer		Да
и	OpenAI.integer		Да

OpenAI.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

Пара координат x/y, например { x: 100, y: 200 }.

Name	Type	Description	Обязательный	По умолчанию
x	OpenAI.integer		Да
и	OpenAI.integer		Да

OpenAI.EasyInputMessage

Входное сообщение модели с ролью, указывающей на следование иерархии инструкций. Инструкции с ролью developer или system имеют приоритет над инструкциями с ролью user. Предполагается, что сообщения с assistant ролью были созданы моделью в предыдущих взаимодействиях.

Name	Type	Description	Обязательный	По умолчанию
содержимое	string или OpenAI.InputMessageContentList	Текст, изображение или звуковой вход в модель, используемый для создания ответа. Также может содержать предыдущие ответы помощника.	Да
role	enum	Роль входных данных сообщения. Одно из user, assistantили system developer. Возможные значения: user, , assistantsystemdeveloper	Да
Статус	enum	Состояние элемента. Один из in_progress, completedили incomplete. Заполняется, когда элементы возвращаются через API. Возможные значения: in_progress, completedincomplete	Нет
type	enum	Тип входных данных сообщения. Всегда message. Возможные значения: message	Да

OpenAI.Error

Name	Type	Description	Обязательный	По умолчанию
дополнительная информация	object		Нет
code	Строка (нулевая)		Да
debugInfo	object		Нет
details	массив OpenAI.Error		Нет
message	строка		Да
параметр	Строка (нулевая)		Нет
type	строка		Нет

OpenAI.EvalApiError

Объект, представляющий ответ об ошибке из API Eval.

Name	Type	Description	Обязательный	По умолчанию
code	строка	Код ошибки.	Да
message	строка	Сообщение об ошибке.	Да

OpenAI.EvalGraderLabelModel

Name	Type	Description	Обязательный	По умолчанию
input	массив OpenAI.EvalItem		Да
labels	массив строк	Метки, назначенные каждому элементу в оценке.	Да
модель	строка	Модель, используемая для оценки. Должен поддерживать структурированные выходные данные.	Да
имя	строка	Имя классировщика.	Да
передача_меток	массив строк	Метки, указывающие на успешный результат. Должно быть подмножеством этих меток.	Да
type	enum	Тип объекта, который всегда является label_model. Возможные значения: label_model	Да

OpenAI.EvalGraderPython

Name	Type	Description	Обязательный	По умолчанию
тег_изображения	строка	Тег изображения, используемый для скрипта Python.	Нет
имя	строка	Имя классировщика.	Да
порог_прохода	OpenAI.numeric		Нет
Источник	строка	Исходный код скрипта Python.	Да
type	enum	Тип объекта, который всегда является python. Возможные значения: python	Да

OpenAI.EvalGraderScoreModel

Name	Type	Description	Обязательный	По умолчанию
input	массив OpenAI.EvalItem	Входные сообщения, вычисляемые классировщиком. Поддерживает текстовые, выходные тексты, входные изображения и блоки звукового содержимого ввода и могут включать строки шаблона.	Да
модель	строка	Модель, используемая для оценки.	Да
имя	строка	Имя классировщика.	Да
порог_прохода	OpenAI.numeric		Нет
range	массив OpenAI.numeric	Диапазон оценки. По умолчанию — [0, 1].	Нет
параметры выборки	OpenAI.EvalGraderScoreModelSamplingParams		Нет
└max_completions_tokens	OpenAI.integer (nullable)		Нет
└─ усилия_по_рассуждению	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.	Нет
Начальное значение └️	OpenAI.integer (nullable)		Нет
└─ Температура	OpenAI.numeric (nullable)		Нет
└️ top_p	OpenAI.numeric (nullable)		Нет	1
type	enum	Тип объекта, который всегда является score_model. Возможные значения: score_model	Да

OpenAI.EvalGraderScoreModelSamplingParams

Name	Type	Description	Обязательный	По умолчанию
max_completions_tokens	OpenAI.integer (nullable)		Нет
усилия на рассуждение	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.	Нет
seed	OpenAI.integer (nullable)		Нет
Температура	OpenAI.numeric (nullable)		Нет
top_p	OpenAI.numeric (nullable)		Нет	1

OpenAI.EvalGraderStringCheck

Name	Type	Description	Обязательный	По умолчанию
input	строка	Входной текст. Это может включать строки шаблона.	Да
имя	строка	Имя классировщика.	Да
Операция	enum	Операция проверки строки, которую нужно выполнить. Один из eq, nelikeили ilike. Возможные значения: eq, , nelikeilike	Да
ссылка	строка	Текст ссылки. Это может включать строки шаблона.	Да
type	enum	Тип объекта, который всегда является string_check. Возможные значения: string_check	Да

OpenAI.EvalGraderTextSimilarity

Name	Type	Description	Обязательный	По умолчанию
метрика оценки	enum	Используемая метрика оценки. Один из cosine, fuzzy_matchbleu gleu, meteor, rouge_1rouge_2rouge_3rouge_4rouge_5 или rouge_l. Возможные значения: cosine, , fuzzy_matchbleugleumeteorrouge_1rouge_2rouge_3rouge_4rouge_5rouge_l	Да
input	строка	Текст, оцениваемый.	Да
имя	строка	Имя классировщика.	Да
порог_прохода	OpenAI.numeric		Да
ссылка	строка	Текст, классируемый против.	Да
type	enum	Тип классировщика. Возможные значения: text_similarity	Да

OpenAI.EvalItem

Входное сообщение модели с ролью, указывающей на следование иерархии инструкций. Инструкции с ролью developer или system имеют приоритет над инструкциями с ролью user. Предполагается, что сообщения с assistant ролью были созданы моделью в предыдущих взаимодействиях.

Name	Type	Description	Обязательный	По умолчанию
содержимое	OpenAI.EvalItemContent	Входные данные в модель могут содержать строки шаблона. Поддерживает текст, выходной текст, входные изображения и входной звук как один элемент или массив элементов.	Да
role	enum	Роль входных данных сообщения. Одно из user, assistantили system developer. Возможные значения: user, , assistantsystemdeveloper	Да
type	enum	Тип входных данных сообщения. Всегда message. Возможные значения: message	Нет

OpenAI.EvalItemContent

Входные данные в модель могут содержать строки шаблона. Поддерживает текст, выходной текст, входные изображения и входной звук как один элемент или массив элементов.

Тип: OpenAI.EvalItemContentItem или OpenAI.EvalItemContentArray

Входные данные в модель могут содержать строки шаблона. Поддерживает текст, выходной текст, входные изображения и входной звук как один элемент или массив элементов.

OpenAI.EvalItemContentArray

Список входных данных, каждый из которых может быть входным текстом, выходным текстом, входным изображением или входным звуковым объектом.

Массив: OpenAI.EvalItemContentItem

OpenAI.EvalItemContentItem

Один элемент содержимого: входной текст, выходной текст, входной образ или входной звук.

Тип: OpenAI.EvalItemContentText или OpenAI.EvalItemContentItemObject

Один элемент содержимого: входной текст, выходной текст, входной образ или входной звук.

OpenAI.EvalItemContentItemObject

Один элемент содержимого: входной текст, выходной текст, входной образ или входной звук.

Дискриминация для OpenAI.EvalItemContentItemObject

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа	Schema
output_text	OpenAI.EvalItemContentOutputText
input_image	OpenAI.EvalItemInputImage
input_audio	OpenAI.InputAudio
input_text	OpenAI.EvalItemContentItemObjectInputTextContent

Name	Type	Description	Обязательный	По умолчанию
type	OpenAI.EvalItemContentItemObjectType		Да

OpenAI.EvalItemContentItemObjectInputTextContent

Текстовые входные данные модели.

Name	Type	Description	Обязательный	По умолчанию
text	строка	Текстовые входные данные модели.	Да
type	enum	Тип входного элемента. Всегда input_text. Возможные значения: input_text	Да

OpenAI.EvalItemContentItemObjectType

Property	Ценность
Type	строка
Значения	input_text output_text input_image input_audio

OpenAI.EvalItemContentOutputText

Текстовые выходные данные модели.

Name	Type	Description	Обязательный	По умолчанию
text	строка	Текстовые выходные данные модели.	Да
type	enum	Тип выходного текста. Всегда output_text. Возможные значения: output_text	Да

OpenAI.EvalItemContentText

Текстовые входные данные модели.

Тип: строка

OpenAI.EvalItemInputImage

Входной блок изображения, используемый в массивах содержимого EvalItem.

Name	Type	Description	Обязательный	По умолчанию
detail	строка	Уровень детализации изображения, отправляемого в модель. Один из high, lowили auto. По умолчанию — auto.	Нет
ссылка_на_изображение	строка	URL-адрес входных данных изображения.	Да
type	enum	Тип входных данных изображения. Всегда input_image. Возможные значения: input_image	Да

OpenAI.EvalJsonlFileContentSource

Name	Type	Description	Обязательный	По умолчанию
содержимое	массив OpenAI.EvalJsonlFileContentSourceContent	Содержимое jsonl-файла.	Да
type	enum	Тип источника jsonl. Всегда file_content. Возможные значения: file_content	Да

OpenAI.EvalJsonlFileContentSourceContent

Name	Type	Description	Обязательный	По умолчанию
item	object		Да
образец	object		Нет

OpenAI.EvalJsonlFileIdSource

Name	Type	Description	Обязательный	По умолчанию
id	строка	Идентификатор файла.	Да
type	enum	Тип источника jsonl. Всегда file_id. Возможные значения: file_id	Да

OpenAI.EvalResponsesSource

Объект EvalResponsesSource, описывающий конфигурацию источника данных запуска.

Name	Type	Description	Обязательный	По умолчанию
создано после	OpenAI.integer (nullable)		Нет
создано до	OpenAI.integer (nullable)		Нет
поиск_инструкций	Строка (нулевая)		Нет
metadata	Объект (нулируемый)		Нет
модель	Строка (нулевая)		Нет
усилия на рассуждение	OpenAI.ReasoningEffort (nullable)	Ограничение усилий в процессе обоснования модели рассуждений. В настоящее время поддерживаются 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.	Нет
Температура	OpenAI.numeric (nullable)		Нет
tools	массив строк		Нет
top_p	OpenAI.numeric (nullable)		Нет
type	enum	Тип источника данных запуска. Всегда responses. Возможные значения: responses	Да
users	массив строк		Нет

OpenAI.EvalRunOutputItemSample

Name	Type	Description	Обязательный	По умолчанию
error	OpenAI.EvalApiError	Объект, представляющий ответ об ошибке из API Eval.	Да
причина окончания	строка		Да
input	массив EvalRunOutputItemSampleInput		Да
max_completion_tokens (максимальное количество токенов завершения)	OpenAI.integer		Да
модель	строка		Да
output	массив EvalRunOutputItemSampleOutputOutput		Да
seed	OpenAI.integer		Да
Температура	OpenAI.numeric		Да
top_p	OpenAI.numeric		Да
использование	OpenAI.EvalRunOutputItemSampleUsage		Да

OpenAI.EvalRunOutputItemSampleUsage

Name	Type	Description	Обязательный	По умолчанию
cached_tokens	OpenAI.integer		Да
токены завершения	OpenAI.integer		Да
подсказывающие токены	OpenAI.integer		Да
общее количество токенов	OpenAI.integer		Да

OpenAI.EvalRunPerModelUsage

Name	Type	Description	Обязательный	По умолчанию
cached_tokens	OpenAI.integer		Да
токены завершения	OpenAI.integer		Да
invocation_count	OpenAI.integer		Да
model_name	строка		Да
подсказывающие токены	OpenAI.integer		Да
общее количество токенов	OpenAI.integer		Да

OpenAI.EvalRunPerTestingCriteriaResults

Name	Type	Description	Обязательный	По умолчанию
ошибка	OpenAI.integer		Да
Прошло	OpenAI.integer		Да
критерии тестирования	строка		Да

OpenAI.EvalRunResultCounts

Name	Type	Description	Обязательный	По умолчанию
Ошибка	OpenAI.integer		Да
ошибка	OpenAI.integer		Да
Прошло	OpenAI.integer		Да
Общая	OpenAI.integer		Да

OpenAI.EvalStoredCompletionsSource

Конфигурация StoredCompletionsRunDataSource, описывающая набор фильтров

Name	Type	Description	Обязательный	По умолчанию
создано после	OpenAI.integer (nullable)		Нет
создано до	OpenAI.integer (nullable)		Нет
limit	OpenAI.integer (nullable)		Нет
metadata	OpenAI.Metadata (nullable)	Набор из 16 пар "ключ-значение", которые можно прикрепить к объекту. Это может быть Полезно для хранения дополнительных сведений об объекте в структурированном виде. форматирование и запрос объектов через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — строки с максимальной длиной 512 символов.	Нет
модель	Строка (нулевая)		Нет
type	enum	Тип источника. Всегда stored_completions. Возможные значения: stored_completions	Да

OpenAI.FileCitationBody

Ссылка на файл.

Name	Type	Description	Обязательный	По умолчанию
идентификатор_файла	строка	Идентификатор файла.	Да
filename	строка	Имя цитируемого файла.	Да
index	OpenAI.integer		Да
type	enum	Тип ссылки на файл. Всегда file_citation. Возможные значения: file_citation	Да

OpenAI.FilePath

Путь к файлу.

Name	Type	Description	Обязательный	По умолчанию
идентификатор_файла	строка	Идентификатор файла.	Да
index	OpenAI.integer		Да
type	enum	Тип пути к файлу. Всегда file_path. Возможные значения: file_path	Да

OpenAI.FileSearchTool

Средство, которое ищет соответствующее содержимое из отправленных файлов.

Name	Type	Description	Обязательный	По умолчанию
Фильтры	OpenAI.Filters (допускает значение NULL)		Нет
максимальное_количество_результатов	OpenAI.integer		Нет
опции рейтинга	OpenAI.RankingOptions		Нет
└️ hybrid_search	OpenAI.HybridSearchOptions	Весы, которые управляют тем, как взаимное слияние рангов балансирует семантику внедрения совпадений и разреженных ключевых слов при включенном гибридном поиске.	Нет
Рангер └️	OpenAI.RankerVersionType	Рангер, используемый для поиска файлов.	Нет
└─ порог оценки	OpenAI.numeric	Пороговое значение оценки для поиска файлов — от 0 до 1. Числа ближе к 1 будут пытаться вернуть только наиболее релевантные результаты, но могут возвращать меньше результатов.	Нет
type	enum	Тип средства поиска файлов. Всегда file_search. Возможные значения: file_search	Да
vector_store_ids	массив строк	Идентификаторы векторных хранилищ для поиска.	Да

OpenAI.FileSearchToolCallResults

Name	Type	Description	Обязательный	По умолчанию
attributes	OpenAI.VectorStoreFileAttributes (nullable)	Набор из 16 пар "ключ-значение", которые можно прикрепить к объекту. Это может быть Полезно для хранения дополнительных сведений об объекте в структурированном виде. форматирование и запрос объектов через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — это строки с максимальной длиной. длина 512 символов, логических значений или чисел.	Нет
идентификатор_файла	строка		Нет
filename	строка		Нет
Оценка	number		Нет
text	строка		Нет

OpenAI.Фильтры

Тип: OpenAI.ComparisonFilter или OpenAI.CompoundFilter

OpenAI.FineTuneDPOHyperparameters

Гиперпараметры, используемые для задачи точной настройки DPO.

Name	Type	Description	Обязательный	По умолчанию
размер пакета	string или OpenAI.integer	Количество примеров в каждом пакете. Более крупный размер пакета означает, что параметры модели обновляются реже, но с более низкой дисперсией.	Нет
Бета	string или OpenAI.numeric	Бета-значение для метода DPO. Более высокое бета-значение увеличит вес штрафа между политикой и эталонной моделью.	Нет
множитель скорости обучения	string или OpenAI.numeric	Коэффициент масштабирования для скорости обучения. Меньшая скорость обучения может оказаться полезной, чтобы избежать переобучения.	Нет
количество эпох	string или OpenAI.integer	Количество эпох, на которое следует обучать модель. Под эпохой понимается один полный цикл обработки набора данных для обучения.	Нет

OpenAI.FineTuneDPOMethod

Конфигурация для метода точной настройки DPO.

Name	Type	Description	Обязательный	По умолчанию
гиперпараметры	OpenAI.FineTuneDPOHyperparameters	Гиперпараметры, используемые для задачи точной настройки DPO.	Нет

OpenAI.FineTuneMethod

Метод, используемый для точной настройки.

Name	Type	Description	Обязательный	По умолчанию
dpo	OpenAI.FineTuneDPOMethod	Конфигурация для метода точной настройки DPO.	Нет
усиление	OpenAI.FineTuneReinforcementMethod	Конфигурация для метода точной настройки с подкреплением.	Нет
Под наблюдением	OpenAI.FineTuneSupervisedMethod	Настройка метода контролируемой тонкой настройки.	Нет
type	enum	Тип метода. Либо supervised, либо dpo, либо reinforcement. Возможные значения: supervised, dporeinforcement	Да

OpenAI.FineTuneReinforcementHyperparameters

Гиперпараметры, используемые для задания тонкой настройки с подкреплением.

Name	Type	Description	Обязательный	По умолчанию
размер пакета	string или OpenAI.integer	Количество примеров в каждом пакете. Более крупный размер пакета означает, что параметры модели обновляются реже, но с более низкой дисперсией.	Нет
compute_multiplier	string или OpenAI.numeric	Умножитель на объем вычислительных ресурсов, используемых для изучения пространства поиска во время обучения.	Нет
интервал_оценки	string или OpenAI.integer	Количество шагов обучения между этапами оценки.	Нет
образцы для оценки	string или OpenAI.integer	Количество примеров оценки для каждого шага обучения.	Нет
множитель скорости обучения	string или OpenAI.numeric	Коэффициент масштабирования для скорости обучения. Меньшая скорость обучения может оказаться полезной, чтобы избежать переобучения.	Нет
количество эпох	string или OpenAI.integer	Количество эпох, на которое следует обучать модель. Под эпохой понимается один полный цикл обработки набора данных для обучения.	Нет
усилия на рассуждение	enum	Уровень усилий по рассуждениям. Возможные значения: default, , lowmediumhigh	Нет

OpenAI.FineTuneReinforcementMethod

Конфигурация для метода точной настройки с подкреплением.

Name	Type	Description	Обязательный	По умолчанию
грейдер	OpenAI.GraderStringCheck или OpenAI.GraderTextSimilarity или OpenAI.GraderPython или OpenAI.GraderScoreModel или OpenAI.GraderMulti	Классировщик, используемый для задания тонкой настройки.	Да
гиперпараметры	OpenAI.FineTuneReinforcementHyperparameters	Гиперпараметры, используемые для задания тонкой настройки с подкреплением.	Нет

OpenAI.FineTuneSupervisedHyperparameters

Гиперпараметры, используемые для процесса тонкой настройки.

Name	Type	Description	Обязательный	По умолчанию
размер пакета	string или OpenAI.integer	Количество примеров в каждом пакете. Более крупный размер пакета означает, что параметры модели обновляются реже, но с более низкой дисперсией.	Нет
множитель скорости обучения	string или OpenAI.numeric	Коэффициент масштабирования для скорости обучения. Меньшая скорость обучения может оказаться полезной, чтобы избежать переобучения.	Нет
количество эпох	string или OpenAI.integer	Количество эпох, на которое следует обучать модель. Под эпохой понимается один полный цикл обработки набора данных для обучения.	Нет

OpenAI.FineTuneSupervisedMethod

Настройка метода контролируемой тонкой настройки.

Name	Type	Description	Обязательный	По умолчанию
гиперпараметры	OpenAI.FineTuneSupervisedHyperparameters	Гиперпараметры, используемые для процесса тонкой настройки.	Нет

OpenAI.FineTuningIntegration

Name	Type	Description	Обязательный	По умолчанию
type	enum	Тип интеграции, включаемой для задачи тонкой настройки Возможные значения: wandb	Да
wandb	OpenAI.FineTuningIntegrationWandb		Да
└─ Сущность	Строка (нулевая)		Нет
└️ имя	Строка (нулевая)		Нет
└─ Проект	строка		Да
└─ Теги	массив строк		Нет

OpenAI.FineTuningIntegrationWandb

Name	Type	Description	Обязательный	По умолчанию
Объект	Строка (нулевая)		Нет
имя	Строка (нулевая)		Нет
project	строка		Да
tags	массив строк		Нет

OpenAI.FineTuningJob

Объект fine_tuning.job представляет задание тонкой настройки, созданное с помощью API.

Name	Type	Description	Обязательный	По умолчанию
создано_в	целое число	Метка времени Unix (в секундах) для момента, когда задание по тонкой настройке было создано.	Да
error	OpenAI.FineTuningJobError (nullable)		Да
└─ Код	строка		Да
Сообщение └️	строка		Да
└─ параметр	Строка (нулевая)		Да
предполагаемое завершение	целое число		Нет
fine_tuned_model	Строка (нулевая)		Да
завершено_в	целое число		Да
гиперпараметры	OpenAI.FineTuningJobHyperparameters		Да
└batch_size	string или OpenAI.integer		Нет	авто
└─ learning_rate_multiplier	string или OpenAI.numeric		Нет
└️ n_epochs	string или OpenAI.integer		Нет	авто
id	строка	Идентификатор объекта, на который можно ссылаться в конечных точках API.	Да
Интеграции	массив OpenAI.FineTuningIntegration		Нет
metadata	OpenAI.Metadata (nullable)	Набор из 16 пар "ключ-значение", которые можно прикрепить к объекту. Это может быть Полезно для хранения дополнительных сведений об объекте в структурированном виде. форматирование и запрос объектов через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — строки с максимальной длиной 512 символов.	Нет
method	OpenAI.FineTuneMethod	Метод, используемый для точной настройки.	Нет
модель	строка	Базовая модель, которая подвергается настройке.	Да
object	enum	Тип объекта, который всегда является "fine_tuning.job". Возможные значения: fine_tuning.job	Да
идентификатор_организации	строка	Организация, которая ответственна за задание финальной настройки.	Да
файлы_результатов	массив строк	Идентификаторы файлов с результатами компиляции для задания по тонкой настройке. Результаты можно получить с помощью API файлов.	Да
seed	OpenAI.integer		Да
Статус	enum	Текущее состояние задания тонкой настройки, которое может быть либо validating_files, либо queued, либо running, либо succeeded, либо failed, либо cancelled. Возможные значения: validating_files, queued, running, succeeded, failed, cancelled	Да
обученные_токены	OpenAI.integer (nullable)		Да
файл_обучения	строка	Идентификатор файла, используемый для обучения. Вы можете получить обучающие данные с помощью API файлов.	Да
Файл_валидации	Строка (нулевая)		Да

OpenAI.FineTuningJobCheckpoint

Объект fine_tuning.job.checkpoint представляет собой контрольную точку модели для тонкой настройки, готовую к использованию.

Name	Type	Description	Обязательный	По умолчанию
создано_в	целое число	Метка времени Unix (в секундах) для момента создания контрольной точки.	Да
контрольная точка тонко настроенной модели	строка	Имя созданной модели точно настроенной контрольной точки.	Да
идентификатор_задания_тончайшей_настройки	строка	Имя задания тонкой настройки, из которого был создан этот контрольный пункт.	Да
id	строка	Идентификатор контрольной точки, на который можно ссылаться в конечных точках API.	Да
metrics	OpenAI.FineTuningJobCheckpointMetrics		Да
└️ full_valid_loss	OpenAI.numeric		Нет
└ full_valid_mean_token_accuracy (полная средняя точность токена)	OpenAI.numeric		Нет
└─ Шаг	OpenAI.numeric		Нет
└train_loss	OpenAI.numeric		Нет
└train_mean_token_accuracy	OpenAI.numeric		Нет
└️ valid_loss	OpenAI.numeric		Нет
└─ valid_mean_token_accuracy	OpenAI.numeric		Нет
object	enum	Тип объекта всегда обозначается как "fine_tuning.job.checkpoint". Возможные значения: fine_tuning.job.checkpoint	Да
номер_шага	OpenAI.integer		Да

OpenAI.FineTuningJobCheckpointMetrics

Name	Type	Description	Обязательный	По умолчанию
full_valid_loss	OpenAI.numeric		Нет
full_valid_mean_token_accuracy	OpenAI.numeric		Нет
шаг	OpenAI.numeric		Нет
train_loss	OpenAI.numeric		Нет
train_mean_token_accuracy	OpenAI.numeric		Нет
valid_loss	OpenAI.numeric		Нет
valid_mean_token_accuracy	OpenAI.numeric		Нет

OpenAI.FineTuningJobError

Name	Type	Description	Обязательный	По умолчанию
code	строка		Да
message	строка		Да
параметр	Строка (нулевая)		Да

OpenAI.FineTuningJobEvent

Объект события задания по тонкой настройке

Name	Type	Description	Обязательный	По умолчанию
создано_в	целое число	Метка времени Unix (в секундах) для момента, когда задание по тонкой настройке было создано.	Да
data	OpenAI.FineTuningJobEventData		Нет
id	строка	Идентификатор объекта.	Да
level	enum	Уровень ведения журнала события. Возможные значения: info, warnerror	Да
message	строка	Сообщение события.	Да
object	enum	Тип объекта, всегда равный "fine_tuning.job.event". Возможные значения: fine_tuning.job.event	Да
type	enum	Тип события. Возможные значения: message, metrics	Нет

OpenAI.FineTuningJobEventData

Тип: объект

OpenAI.FineTuningJobHyperparameters

Name	Type	Description	Обязательный	По умолчанию
размер пакета	string или OpenAI.integer		Нет
множитель скорости обучения	string или OpenAI.numeric		Нет
количество эпох	string или OpenAI.integer		Нет

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	строка	Содержимое файла, отправляемого в модель.	Нет
идентификатор_файла	Строка (нулевая)		Нет
file_url	строка	URL-адрес файла, отправляемого в модель.	Нет
filename	строка	Имя файла, отправляемого в модель.	Нет
type	enum	Тип входного элемента. Всегда input_file. Возможные значения: input_file	Да

OpenAI.FunctionAndCustomToolCallOutputInputImageContent

Изображение в качестве входных данных для модели. Узнайте о входных данных изображения.

Name	Type	Description	Обязательный	По умолчанию
detail	OpenAI.ImageDetail		Да
идентификатор_файла	Строка (нулевая)		Нет
ссылка_на_изображение	строка		Нет
type	enum	Тип входного элемента. Всегда input_image. Возможные значения: input_image	Да

OpenAI.FunctionAndCustomToolCallOutputInputTextContent

Текстовые входные данные модели.

Name	Type	Description	Обязательный	По умолчанию
text	строка	Текстовые входные данные модели.	Да
type	enum	Тип входного элемента. Всегда input_text. Возможные значения: input_text	Да

OpenAI.FunctionAndCustomToolCallOutputType

Property	Ценность
Type	строка
Значения	input_text input_image input_file

OpenAI.FunctionCallItemStatus

Property	Ценность
Type	строка
Значения	in_progress completed incomplete

OpenAI.FunctionObject

Name	Type	Description	Обязательный	По умолчанию
описание	строка	Описание того, что выполняет функция, используемая моделью для выбора времени и способа вызова функции.	Нет
имя	строка	Имя вызываемой функции. Должен содержать символы от a до z, от A до Z, цифры от 0 до 9 или включать символы подчеркивания и дефисы, с максимальной длиной в 64 символа.	Да
parameters	OpenAI.FunctionParameters	Параметры, которые принимают функции, описаны как объект схемы JSON. Примеры см. в руководстве и справочнике по схеме JSON для документации по формату. Опущение parameters определяет функцию с пустым списком параметров.	Нет
строгий	Булев (нулируемый)		Нет

OpenAI.FunctionParameters

Параметры, которые принимают функции, описаны как объект схемы JSON. Примеры см. в руководстве и справочнике по схеме JSON для документации по формату. Опущение parameters определяет функцию с пустым списком параметров.

Тип: объект

OpenAI.FunctionShellAction

Выполните команду оболочки.

Name	Type	Description	Обязательный	По умолчанию
commands	массив строк		Да
max_output_length	OpenAI.integer (nullable)		Да
таймаут_мс	OpenAI.integer (nullable)		Да

OpenAI.FunctionShellActionParam

Команды и ограничения, описывающие запуск вызова средства оболочки.

Name	Type	Description	Обязательный	По умолчанию
commands	массив строк	Упорядоченные команды оболочки для выполнения среды выполнения.	Да
max_output_length	OpenAI.integer (nullable)		Нет
таймаут_мс	OpenAI.integer (nullable)		Нет

OpenAI.FunctionShellCallItemStatus

Значения состояния, сообщаемые для вызовов инструментов оболочки.

Property	Ценность
Type	строка
Значения	in_progress completed incomplete

OpenAI.FunctionShellCallOutputContent

Содержимое выходных данных вызова средства оболочки, которое было создано.

Name	Type	Description	Обязательный	По умолчанию
создано пользователем	строка	Идентификатор субъекта, создавшего элемент.	Нет
результат	OpenAI.FunctionShellCallOutputOutcome	Представляет результат выхода (с кодом выхода) или результат ожидания для блока вывода вызова оболочки.	Да
└─ Тип	OpenAI.FunctionShellCallOutputOutcomeType		Да
Stderr	строка	Стандартные выходные данные ошибок, которые были записаны.	Да
stdout	строка	Стандартные выходные данные, которые были записаны.	Да

OpenAI.FunctionShellCallOutputContentParam

Захваченный stdout и stderr для части выходных данных вызова средства оболочки.

Name	Type	Description	Обязательный	По умолчанию
результат	OpenAI.FunctionShellCallOutputOutcomeParam	Результат выхода или ожидания, связанный с этим вызовом оболочки.	Да
└─ Тип	OpenAI.FunctionShellCallOutputOutcomeParamType		Да
Stderr	строка	Захваченные выходные данные stderr для вызова оболочки. Ограничения: maxLength: 10485760	Да
stdout	строка	Захваченные выходные данные stdout для вызова оболочки. Ограничения: maxLength: 10485760	Да

OpenAI.FunctionShellCallOutputExitOutcome

Указывает, что команды оболочки завершены и возвращен код выхода.

Name	Type	Description	Обязательный	По умолчанию
exit_code	OpenAI.integer		Да
type	enum	Тип результата. Всегда exit. Возможные значения: exit	Да

OpenAI.FunctionShellCallOutputExitOutcomeParam

Указывает, что команды оболочки завершены и возвращен код выхода.

Name	Type	Description	Обязательный	По умолчанию
exit_code	OpenAI.integer		Да
type	enum	Тип результата. Всегда exit. Возможные значения: exit	Да

OpenAI.FunctionShellCallOutputOutcome

Представляет результат выхода (с кодом выхода) или результат ожидания для блока вывода вызова оболочки.

Дискриминация для OpenAI.FunctionShellCallOutputOutcome

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа	Schema
timeout	OpenAI.FunctionShellCallOutputTimeoutOutcome
exit	OpenAI.FunctionShellCallOutputExitOutcome

Name	Type	Description	Обязательный	По умолчанию
type	OpenAI.FunctionShellCallOutputOutcomeType		Да

OpenAI.FunctionShellCallOutputOutcomeParam

Результат выхода или ожидания, связанный с этим вызовом оболочки.

Дискриминация для OpenAI.FunctionShellCallOutputOutcomeParam

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа	Schema
timeout	OpenAI.FunctionShellCallOutputTimeoutOutcomeParam
exit	OpenAI.FunctionShellCallOutputExitOutcomeParam

Name	Type	Description	Обязательный	По умолчанию
type	OpenAI.FunctionShellCallOutputOutcomeParamType		Да

OpenAI.FunctionShellCallOutputOutcomeParamType

Property	Ценность
Type	строка
Значения	timeout exit

OpenAI.FunctionShellCallOutputOutcomeType

Property	Ценность
Type	строка
Значения	timeout exit

OpenAI.FunctionShellCallOutputTimeoutOutcome

Указывает, что вызов оболочки превысил настроенное ограничение времени.

Name	Type	Description	Обязательный	По умолчанию
type	enum	Тип результата. Всегда timeout. Возможные значения: timeout	Да

OpenAI.FunctionShellCallOutputTimeoutOutcomeParam

Указывает, что вызов оболочки превысил настроенное ограничение времени.

Name	Type	Description	Обязательный	По умолчанию
type	enum	Тип результата. Всегда timeout. Возможные значения: timeout	Да

OpenAI.FunctionShellToolParam

Средство, позволяющее модели выполнять команды оболочки.

Name	Type	Description	Обязательный	По умолчанию
type	enum	Тип средства оболочки. Всегда shell. Возможные значения: shell	Да

OpenAI.FunctionTool

Определяет функцию в собственном коде, которую модель может вызвать.

Name	Type	Description	Обязательный	По умолчанию
описание	Строка (нулевая)		Нет
имя	строка	Имя вызываемой функции.	Да
parameters	Объект (нулируемый)		Да
строгий	Булев (нулируемый)		Да
type	enum	Тип средства функции. Всегда function. Возможные значения: function	Да

OpenAI.GraderLabelModel

Объект LabelModelGrader, использующий модель для назначения меток каждому элементу в оценке.

Name	Type	Description	Обязательный	По умолчанию
input	массив OpenAI.EvalItem		Да
labels	массив строк	Метки, назначенные каждому элементу в оценке.	Да
модель	строка	Модель, используемая для оценки. Должен поддерживать структурированные выходные данные.	Да
имя	строка	Имя классировщика.	Да
передача_меток	массив строк	Метки, указывающие на успешный результат. Должно быть подмножеством этих меток.	Да
type	enum	Тип объекта, который всегда является label_model. Возможные значения: label_model	Да

OpenAI.GraderMulti

Объект MultiGrader объединяет выходные данные нескольких классировщиков для создания одной оценки.

Name	Type	Description	Обязательный	По умолчанию
вычислить_результат	строка	Формула для расчета выходных данных на основе результатов работы градуировщика.	Да
Грейдеры	OpenAI.GraderStringCheck или OpenAI.GraderTextSimilarity или OpenAI.GraderPython или OpenAI.GraderScoreModel или OpenAI.GraderLabelModel		Да
имя	строка	Имя классировщика.	Да
type	enum	Тип объекта, который всегда является multi. Возможные значения: multi	Да

OpenAI.GraderPython

Объект PythonGrader, который запускает скрипт Python на входных данных.

Name	Type	Description	Обязательный	По умолчанию
тег_изображения	строка	Тег изображения, используемый для скрипта Python.	Нет
имя	строка	Имя классировщика.	Да
Источник	строка	Исходный код скрипта Python.	Да
type	enum	Тип объекта, который всегда является python. Возможные значения: python	Да

OpenAI.GraderScoreModel

Объект ScoreModelGrader, использующий модель для назначения оценки входным данным.

Name	Type	Description	Обязательный	По умолчанию
input	массив OpenAI.EvalItem	Входные сообщения, вычисляемые классировщиком. Поддерживает текстовые, выходные тексты, входные изображения и блоки звукового содержимого ввода и могут включать строки шаблона.	Да
модель	строка	Модель, используемая для оценки.	Да
имя	строка	Имя классировщика.	Да
range	массив OpenAI.numeric	Диапазон оценки. По умолчанию — [0, 1].	Нет
параметры выборки	OpenAI.EvalGraderScoreModelSamplingParams		Нет
└max_completions_tokens	OpenAI.integer (nullable)		Нет
└─ усилия_по_рассуждению	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.	Нет
Начальное значение └️	OpenAI.integer (nullable)		Нет
└─ Температура	OpenAI.numeric (nullable)		Нет
└️ top_p	OpenAI.numeric (nullable)		Нет	1
type	enum	Тип объекта, который всегда является score_model. Возможные значения: score_model	Да

OpenAI.GraderStringCheck

Объект StringCheckGrader, выполняющий сравнение строк между входами и ссылкой с помощью указанной операции.

Name	Type	Description	Обязательный	По умолчанию
input	строка	Входной текст. Это может включать строки шаблона.	Да
имя	строка	Имя классировщика.	Да
Операция	enum	Операция проверки строки, которую нужно выполнить. Один из eq, nelikeили ilike. Возможные значения: eq, , nelikeilike	Да
ссылка	строка	Текст ссылки. Это может включать строки шаблона.	Да
type	enum	Тип объекта, который всегда является string_check. Возможные значения: string_check	Да

OpenAI.GraderTextSimilarity

Объект TextSimilarityGrader, который классирует текст на основе метрик сходства.

Name	Type	Description	Обязательный	По умолчанию
метрика оценки	enum	Используемая метрика оценки. Один из cosine, fuzzy_matchbleu gleu, meteor, rouge_1rouge_2rouge_3rouge_4rouge_5 или rouge_l. Возможные значения: cosine, , fuzzy_matchbleugleumeteorrouge_1rouge_2rouge_3rouge_4rouge_5rouge_l	Да
input	строка	Текст, оцениваемый.	Да
имя	строка	Имя классировщика.	Да
ссылка	строка	Текст, классируемый против.	Да
type	enum	Тип классировщика. Возможные значения: text_similarity	Да

OpenAI.GrammarSyntax1

Property	Ценность
Type	строка
Значения	lark regex

OpenAI.HybridSearchOptions

Name	Type	Description	Обязательный	По умолчанию
embedding_weight	OpenAI.numeric		Да
text_weight	OpenAI.numeric		Да

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 (nullable)	Контролируйте усилия модели для соответствия стилю и особенностям, в частности, чертам лица, на входных изображениях. Этот параметр поддерживается только для gpt-image-1. Неподдерживаемый для gpt-image-1-mini. Поддерживает high и low. По умолчанию — low.	Нет
входная маска изображения	OpenAI.ImageGenToolInputImageMask		Нет
└ file_id	строка		Нет
└image_url	строка		Нет
модель	строка (см. допустимые модели ниже)		Нет
Умеренности	enum	Уровень модерации для созданного образа. По умолчанию: auto. Возможные значения: auto, low	Нет
сжатие вывода	OpenAI.integer		Нет	100
формат_выходных_данных	enum	Формат выходных данных созданного изображения. Один из png, webpили jpeg. По умолчанию: png. Возможные значения: png, webpjpeg	Нет
частичные_изображения	OpenAI.integer		Нет
качество	enum	Качество созданного изображения. Один из low, mediumhigh или auto. По умолчанию: auto. Возможные значения: low, , mediumhighauto	Нет
size	enum	Размер созданного изображения. Один из 1024x1024, 1024x1536 1536x1024 или auto. По умолчанию: auto. Возможные значения: 1024x1024, , 1024x15361536x1024auto	Нет
type	enum	Тип средства создания изображений. Всегда 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, или когда организация зарегистрирована в программе нулевого хранения данных). | | Тип | string | | Значения | 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
memory_search_call.results |

OpenAI.InputAudio

Аудиовход для модели.

Name	Type	Description	Обязательный	По умолчанию
input_audio	OpenAI.InputAudioInputAudioAudio		Да
type	enum	Тип входного элемента. Всегда input_audio. Возможные значения: input_audio	Да

OpenAI.InputAudioInputAudioAudio

Name	Type	Description	Обязательный	По умолчанию
data	строка		Да
format	enum	Возможные значения: mp3, wav	Да

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	строка	Содержимое файла, отправляемого в модель.	Нет
идентификатор_файла	Строка (нулевая)		Нет
file_url	строка	URL-адрес файла, отправляемого в модель.	Нет
filename	строка	Имя файла, отправляемого в модель.	Нет
type	enum	Тип входного элемента. Всегда input_file. Возможные значения: input_file	Да

OpenAI.InputContentInputImageContent

Изображение в качестве входных данных для модели. Узнайте о входных данных изображения.

Name	Type	Description	Обязательный	По умолчанию
detail	OpenAI.ImageDetail		Да
идентификатор_файла	Строка (нулевая)		Нет
ссылка_на_изображение	строка		Нет
type	enum	Тип входного элемента. Всегда input_image. Возможные значения: input_image	Да

OpenAI.InputContentInputTextContent

Текстовые входные данные модели.

Name	Type	Description	Обязательный	По умолчанию
text	строка	Текстовые входные данные модели.	Да
type	enum	Тип входного элемента. Всегда 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	строка	Содержимое файла, отправляемого в модель.	Нет
идентификатор_файла	Строка (нулевая)		Нет
file_url	строка	URL-адрес файла, отправляемого в модель.	Нет
filename	строка	Имя файла, отправляемого в модель.	Нет
type	enum	Тип входного элемента. Всегда input_file. Возможные значения: input_file	Да

OpenAI.InputFileContentParam

Файл в качестве входных данных для модели.

Name	Type	Description	Обязательный	По умолчанию
file_data	Строка (нулевая)		Нет
идентификатор_файла	Строка (нулевая)		Нет
file_url	строка		Нет
filename	Строка (нулевая)		Нет
type	enum	Тип входного элемента. Всегда input_file. Возможные значения: input_file	Да

OpenAI.InputImageContent

Изображение в качестве входных данных для модели. Узнайте о входных данных изображения.

Name	Type	Description	Обязательный	По умолчанию
detail	OpenAI.ImageDetail		Да
идентификатор_файла	Строка (нулевая)		Нет
ссылка_на_изображение	строка		Нет
type	enum	Тип входного элемента. Всегда input_image. Возможные значения: input_image	Да

OpenAI.InputImageContentParamAutoParam

Изображение в качестве входных данных для модели. Сведения об входных данных изображения

Name	Type	Description	Обязательный	По умолчанию
detail	OpenAI.DetailEnum (nullable)		Нет
идентификатор_файла	Строка (нулевая)		Нет
ссылка_на_изображение	строка		Нет
type	enum	Тип входного элемента. Всегда input_image. Возможные значения: input_image	Да

OpenAI.InputItem

Элемент, представляющий часть контекста для ответа, создаваемого моделью. Может содержать текст, изображения и звуковые входные данные, а также предыдущие ответы помощника и выходные данные вызова средства.

Дискриминация для OpenAI.InputItem

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа	Schema
message	OpenAI.EasyInputMessage
item_reference	OpenAI.ItemReferenceParam
output_message	OpenAI.InputItemOutputMessage
file_search_call	OpenAI.InputItemFileSearchToolCall
computer_call	OpenAI.InputItemComputerToolCall
computer_call_output	OpenAI.InputItemComputerCallOutputItemParam
web_search_call	OpenAI.InputItemWebSearchToolCall
function_call	OpenAI.InputItemFunctionToolCall
function_call_output	OpenAI.InputItemFunctionCallOutputItemParam
reasoning	OpenAI.InputItemReasoningItem
compaction	OpenAI.InputItemCompactionSummaryItemParam
image_generation_call	OpenAI.InputItemImageGenToolCall
code_interpreter_call	OpenAI.InputItemCodeInterpreterToolCall
local_shell_call	OpenAI.InputItemLocalShellToolCall
local_shell_call_output	OpenAI.InputItemLocalShellToolCallOutput
shell_call	OpenAI.InputItemFunctionShellCallItemParam
shell_call_output	OpenAI.InputItemFunctionShellCallOutputItemParam
apply_patch_call	OpenAI.InputItemApplyPatchToolCallItemParam
apply_patch_call_output	OpenAI.InputItemApplyPatchToolCallOutputItemParam
mcp_list_tools	OpenAI.InputItemMcpListTools
mcp_approval_request	OpenAI.InputItemMcpApprovalRequest
mcp_approval_response	OpenAI.InputItemMcpApprovalResponse
mcp_call	OpenAI.InputItemMcpToolCall
custom_tool_call_output	OpenAI.InputItemCustomToolCallOutput
custom_tool_call	OpenAI.InputItemCustomToolCall

Name	Type	Description	Обязательный	По умолчанию
type	OpenAI.InputItemType		Да

OpenAI.InputItemApplyPatchToolCallItemParam

Вызов средства, представляющий запрос на создание, удаление или обновление файлов с помощью исправлений diff.

Name	Type	Description	Обязательный	По умолчанию
call_id	строка	Уникальный идентификатор вызова средства исправления, созданного моделью. Ограничения: minLength: 1, maxLength: 64	Да
id	Строка (нулевая)		Нет
Операция	OpenAI.ApplyPatchOperationParam	Одна из операций create_file, delete_file или update_file, предоставляемых средству apply_patch.	Да
└─ Тип	OpenAI.ApplyPatchOperationParamType		Да
Статус	OpenAI.ApplyPatchCallStatusParam	Значения состояния, сообщаемые для вызовов apply_patch инструментов.	Да
type	enum	Тип элемента. Всегда apply_patch_call. Возможные значения: apply_patch_call	Да

OpenAI.InputItemApplyPatchToolCallOutputItemParam

Потоковые выходные данные, создаваемые вызовом средства исправления.

Name	Type	Description	Обязательный	По умолчанию
call_id	строка	Уникальный идентификатор вызова средства исправления, созданного моделью. Ограничения: minLength: 1, maxLength: 64	Да
id	Строка (нулевая)		Нет
output	Строка (нулевая)		Нет
Статус	OpenAI.ApplyPatchCallOutputStatusParam	Значения результатов, сообщаемые для выходных данных apply_patch средства.	Да
type	enum	Тип элемента. Всегда apply_patch_call_output. Возможные значения: apply_patch_call_output	Да

OpenAI.InputItemCodeInterpreterToolCall

Вызов инструмента для выполнения кода.

Name	Type	Description	Обязательный	По умолчанию
code	Строка (нулевая)		Да
container_id	строка	Идентификатор контейнера, используемого для запуска кода.	Да
id	строка	Уникальный идентификатор вызова средства интерпретатора кода.	Да
outputs	массив OpenAI.CodeInterpreterOutputLogs или OpenAI.CodeInterpreterOutputImage		Да
Статус	enum	Состояние вызова средства интерпретатора кода. Допустимые значения: in_progress, completed, incomplete, interpreting, и failed. Возможные значения: in_progress, completed, incomplete, interpreting, failed	Да
type	enum	Тип вызова средства интерпретатора кода. Всегда code_interpreter_call. Возможные значения: code_interpreter_call	Да

OpenAI.InputItemCompactionSummaryItemParam

Элемент сжатия, v1/responses/compact созданный API.

Name	Type	Description	Обязательный	По умолчанию
encrypted_content	строка	Зашифрованное содержимое сводки сжатия. Ограничения: maxLength: 10485760	Да
id	Строка (нулевая)		Нет
type	enum	Тип элемента. Всегда compaction. Возможные значения: compaction	Да

OpenAI.InputItemComputerCallOutputItemParam

Выходные данные запуска компьютерного инструмента.

Name	Type	Description	Обязательный	По умолчанию
acknowledged_safety_checks	массив OpenAI.ComputerCallSafetyCheckParam		Нет
call_id	строка	Идентификатор вызова средства компьютера, создающего выходные данные. Ограничения: minLength: 1, maxLength: 64	Да
id	Строка (нулевая)		Нет
output	OpenAI.ComputerScreenshotImage	Снимок экрана компьютера, используемый с помощью инструмента для использования компьютера.	Да
Статус	OpenAI.FunctionCallItemStatus (nullable)		Нет
type	enum	Тип выходных данных компьютерного средства вызова. Всегда computer_call_output. Возможные значения: computer_call_output	Да

OpenAI.InputItemComputerToolCall

Вызов инструмента для работы с компьютером. Дополнительные сведения см. в руководстве по использованию компьютера .

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	Да

OpenAI.InputItemCustomToolCall

Вызов пользовательского средства, созданного моделью.

Name	Type	Description	Обязательный	По умолчанию
call_id	строка	Идентификатор, используемый для сопоставления этого настраиваемого вызова средства с выходными данными вызова средства.	Да
id	строка	Уникальный идентификатор вызова пользовательского средства на платформе OpenAI.	Нет
input	строка	Входные данные для вызова пользовательского средства, созданного моделью.	Да
имя	строка	Имя вызываемого пользовательского инструмента.	Да
type	enum	Тип вызова пользовательского средства. Всегда custom_tool_call. Возможные значения: custom_tool_call	Да

OpenAI.InputItemCustomToolCallOutput

Выходные данные вызова пользовательского средства из кода, отправляемые обратно в модель.

Name	Type	Description	Обязательный	По умолчанию
call_id	строка	Идентификатор вызова, используемый для сопоставления выходных данных этого пользовательского средства с пользовательским вызовом средства.	Да
id	строка	Уникальный идентификатор выходных данных вызова пользовательского средства на платформе OpenAI.	Нет
output	строка или массив OpenAI.FunctionAndCustomToolCallOutput	Выходные данные из вызова пользовательского средства, созданного кодом. Может быть строкой или списком выходного содержимого.	Да
type	enum	Тип выходных данных вызова пользовательского средства. Всегда custom_tool_call_output. Возможные значения: custom_tool_call_output	Да

OpenAI.InputItemFileSearchToolCall

Результаты вызова средства поиска файлов. Дополнительные сведения см. в руководстве по поиску файлов .

Name	Type	Description	Обязательный	По умолчанию
id	строка	Уникальный идентификатор вызова средства поиска файлов.	Да
queries	массив строк	Запросы, используемые для поиска файлов.	Да
results	массив OpenAI.FileSearchToolCallResults		Нет
Статус	enum	Состояние вызова средства поиска файлов. Один из in_progress, searching, incomplete или failed, Возможные значения: in_progress, searching, completed, incomplete, failed	Да
type	enum	Тип вызова средства поиска файлов. Всегда file_search_call. Возможные значения: file_search_call	Да

OpenAI.InputItemFunctionCallOutputItemParam

Выходные данные вызова инструмента функции.

Name	Type	Description	Обязательный	По умолчанию
call_id	строка	Уникальный идентификатор вызова функции, созданного моделью. Ограничения: minLength: 1, maxLength: 64	Да
id	Строка (нулевая)		Нет
output	строка или массив OpenAI.InputTextContentParam или OpenAI.InputImageContentParamAutoParam или OpenAI.InputFileContentParam	Вывод текста, изображения или файла вызова средства функции.	Да
Статус	OpenAI.FunctionCallItemStatus (nullable)		Нет
type	enum	Тип выходных данных вызова функции. Всегда function_call_output. Возможные значения: function_call_output	Да

OpenAI.InputItemFunctionShellCallItemParam

Средство, представляющее запрос на выполнение одной или нескольких команд оболочки.

Name	Type	Description	Обязательный	По умолчанию
action	OpenAI.FunctionShellActionParam	Команды и ограничения, описывающие запуск вызова средства оболочки.	Да
Команды └️	массив строк	Упорядоченные команды оболочки для выполнения среды выполнения.	Да
└max_output_length	OpenAI.integer (nullable)		Нет
└️ timeout_ms	OpenAI.integer (nullable)		Нет
call_id	строка	Уникальный идентификатор вызова средства оболочки, созданного моделью. Ограничения: minLength: 1, maxLength: 64	Да
id	Строка (нулевая)		Нет
Статус	OpenAI.FunctionShellCallItemStatus (nullable)	Значения состояния, сообщаемые для вызовов инструментов оболочки.	Нет
type	enum	Тип элемента. Всегда shell_call. Возможные значения: shell_call	Да

OpenAI.InputItemFunctionShellCallOutputItemParam

Потоковые выходные элементы, создаваемые вызовом средства оболочки.

Name	Type	Description	Обязательный	По умолчанию
call_id	строка	Уникальный идентификатор вызова средства оболочки, созданного моделью. Ограничения: minLength: 1, maxLength: 64	Да
id	Строка (нулевая)		Нет
max_output_length	OpenAI.integer (nullable)		Нет
output	массив OpenAI.FunctionShellCallOutputContentParam	Захваченные фрагменты выходных данных stdout и stderr, а также связанные с ними результаты.	Да
type	enum	Тип элемента. Всегда shell_call_output. Возможные значения: shell_call_output	Да

OpenAI.InputItemFunctionToolCall

Вызов средства для запуска функции. Дополнительные сведения см. в руководстве по вызову функции .

Name	Type	Description	Обязательный	По умолчанию
arguments	строка	Строка JSON аргументов для передачи функции.	Да
call_id	строка	Уникальный идентификатор вызова функции, созданного моделью.	Да
id	строка	Уникальный идентификатор вызова средства функции.	Нет
имя	строка	Имя выполняемой функции.	Да
Статус	enum	Состояние элемента. Один из in_progress, completedили incomplete. Заполняется, когда элементы возвращаются через API. Возможные значения: in_progress, completedincomplete	Нет
type	enum	Тип вызова инструмента функции. Всегда function_call. Возможные значения: function_call	Да

OpenAI.InputItemImageGenToolCall

Запрос на создание изображения, сделанный моделью.

Name	Type	Description	Обязательный	По умолчанию
id	строка	Уникальный идентификатор вызова создания образа.	Да
result	Строка (нулевая)		Да
Статус	enum	Состояние вызова создания образа. Возможные значения: in_progress, , completedgeneratingfailed	Да
type	enum	Тип вызова создания изображения. Всегда image_generation_call. Возможные значения: image_generation_call	Да

OpenAI.InputItemLocalShellToolCall

Вызов инструмента для выполнения команды в локальной оболочке.

Name	Type	Description	Обязательный	По умолчанию
action	OpenAI.LocalShellExecAction	Выполните команду оболочки на сервере.	Да
call_id	строка	Уникальный идентификатор вызова локального утилита оболочки, сгенерированного моделью.	Да
id	строка	Уникальный идентификатор вызова локальной оболочки.	Да
Статус	enum	Состояние вызова локальной оболочки. Возможные значения: in_progress, completedincomplete	Да
type	enum	Тип вызова локальной оболочки. Всегда local_shell_call. Возможные значения: local_shell_call	Да

OpenAI.InputItemLocalShellToolCallOutput

Выходные данные вызова локального оболочечного инструмента.

Name	Type	Description	Обязательный	По умолчанию
id	строка	Уникальный идентификатор вызова локального утилита оболочки, сгенерированного моделью.	Да
output	строка	Строка JSON, представляющая результаты вызова локального инструмента оболочки.	Да
Статус	enum	Возможные значения: in_progress, completedincomplete	Нет
type	enum	Тип выходных данных вызова средства локальной оболочки. Всегда local_shell_call_output. Возможные значения: local_shell_call_output	Да

OpenAI.InputItemMcpApprovalRequest

Запрос на одобрение человеком вызова инструмента.

Name	Type	Description	Обязательный	По умолчанию
arguments	строка	Строка JSON с аргументами для средства.	Да
id	строка	Уникальный идентификатор запроса на утверждение.	Да
имя	строка	Имя запускаемого инструмента.	Да
метка сервера	строка	Метка сервера MCP, выполняющего запрос.	Да
type	enum	Тип элемента. Всегда mcp_approval_request. Возможные значения: mcp_approval_request	Да

OpenAI.InputItemMcpApprovalResponse

Ответ на запрос на утверждение MCP.

Name	Type	Description	Обязательный	По умолчанию
approval_request_id	строка	Идентификатор запроса на утверждение, на который даётся ответ.	Да
Утвердить	boolean	Будет ли утвержден запрос.	Да
id	Строка (нулевая)		Нет
причина	Строка (нулевая)		Нет
type	enum	Тип элемента. Всегда mcp_approval_response. Возможные значения: mcp_approval_response	Да

OpenAI.InputItemMcpListTools

Список средств, доступных на сервере MCP.

Name	Type	Description	Обязательный	По умолчанию
error	Строка (нулевая)		Нет
id	строка	Уникальный идентификатор списка.	Да
метка сервера	строка	Метка сервера MCP.	Да
tools	массив OpenAI.MCPListToolsTools	Средства, доступные на сервере.	Да
type	enum	Тип элемента. Всегда mcp_list_tools. Возможные значения: mcp_list_tools	Да

OpenAI.InputItemMcpToolCall

Вызов инструмента на сервере MCP.

Name	Type	Description	Обязательный	По умолчанию
approval_request_id	Строка (нулевая)		Нет
arguments	строка	Строка JSON аргументов, переданных средству.	Да
error	Строка (нулевая)		Нет
id	строка	Уникальный идентификатор вызова средства.	Да
имя	строка	Имя запущенного инструмента.	Да
output	Строка (нулевая)		Нет
метка сервера	строка	Метка сервера MCP, на котором работает инструмент.	Да
Статус	OpenAI.MCPToolCallStatus		Нет
type	enum	Тип элемента. Всегда mcp_call. Возможные значения: mcp_call	Да

OpenAI.InputItemOutputMessage

Выходное сообщение из модели.

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.InputItemReasoningItem

Описание цепочки мысли, используемой моделью причин при создании ответа. Не забудьте включить эти элементы в input API ответов для последующих поворотов беседы, если вы вручную управляете контекстом.

Name	Type	Description	Обязательный	По умолчанию
содержимое	массив OpenAI.ReasoningTextContent	Обоснование текстового содержимого.	Нет
encrypted_content	Строка (нулевая)		Нет
id	строка	Уникальный идентификатор контента рассуждений.	Да
Статус	enum	Состояние элемента. Один из in_progress, completedили incomplete. Заполняется, когда элементы возвращаются через API. Возможные значения: in_progress, completedincomplete	Нет
summary	массив OpenAI.Summary	Содержимое сводки по причинам.	Да
type	enum	Тип объекта . Всегда reasoning. Возможные значения: reasoning	Да

OpenAI.InputItemType

Property	Ценность
Type	строка
Значения	message output_message file_search_call computer_call computer_call_output web_search_call function_call function_call_output reasoning compaction 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 custom_tool_call_output custom_tool_call item_reference

OpenAI.InputItemWebSearchToolCall

Результаты вызова средства поиска в Интернете. Дополнительные сведения см. в руководстве по поиску в Интернете .

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.InputMessage

Входное сообщение модели с ролью, указывающей на следование иерархии инструкций. Инструкции с ролью developer или system имеют приоритет над инструкциями с ролью user.

Name	Type	Description	Обязательный	По умолчанию
содержимое	OpenAI.InputMessageContentList	Список одного или нескольких входных элементов модели, содержащий другое содержимое. types.	Да
role	enum	Роль входных данных сообщения. Один из user, systemили developer. Возможные значения: user, systemdeveloper	Да
Статус	enum	Состояние элемента. Один из in_progress, completedили incomplete. Заполняется, когда элементы возвращаются через API. Возможные значения: in_progress, completedincomplete	Нет
type	enum	Тип входных данных сообщения. Всегда задано значение message. Возможные значения: message	Да

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	Да

OpenAI.InputTextContentParam

Текстовые входные данные модели.

Name	Type	Description	Обязательный	По умолчанию
text	строка	Текстовые входные данные модели. Ограничения: maxLength: 10485760	Да
type	enum	Тип входного элемента. Всегда input_text. Возможные значения: input_text	Да

OpenAI.Item

Элемент содержимого, используемый для создания ответа.

Дискриминация для OpenAI.Item

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа	Schema
memory_search_call	MemorySearchToolCallItemParam
message	OpenAI.InputMessage
output_message	OpenAI.ItemOutputMessage
file_search_call	OpenAI.ItemFileSearchToolCall
computer_call	OpenAI.ItemComputerToolCall
computer_call_output	OpenAI.ItemComputerCallOutputItemParam
web_search_call	OpenAI.ItemWebSearchToolCall
function_call	OpenAI.ItemFunctionToolCall
function_call_output	OpenAI.ItemFunctionCallOutputItemParam
reasoning	OpenAI.ItemReasoningItem
compaction	OpenAI.ItemCompactionSummaryItemParam
image_generation_call	OpenAI.ItemImageGenToolCall
code_interpreter_call	OpenAI.ItemCodeInterpreterToolCall
local_shell_call	OpenAI.ItemLocalShellToolCall
local_shell_call_output	OpenAI.ItemLocalShellToolCallOutput
shell_call	OpenAI.ItemFunctionShellCallItemParam
shell_call_output	OpenAI.ItemFunctionShellCallOutputItemParam
apply_patch_call	OpenAI.ItemApplyPatchToolCallItemParam
apply_patch_call_output	OpenAI.ItemApplyPatchToolCallOutputItemParam
mcp_list_tools	OpenAI.ItemMcpListTools
mcp_approval_request	OpenAI.ItemMcpApprovalRequest
mcp_approval_response	OpenAI.ItemMcpApprovalResponse
mcp_call	OpenAI.ItemMcpToolCall
custom_tool_call_output	OpenAI.ItemCustomToolCallOutput
custom_tool_call	OpenAI.ItemCustomToolCall

Name	Type	Description	Обязательный	По умолчанию
type	OpenAI.ItemType		Да

OpenAI.ItemApplyPatchToolCallItemParam

Вызов средства, представляющий запрос на создание, удаление или обновление файлов с помощью исправлений diff.

Name	Type	Description	Обязательный	По умолчанию
call_id	строка	Уникальный идентификатор вызова средства исправления, созданного моделью. Ограничения: minLength: 1, maxLength: 64	Да
id	Строка (нулевая)		Нет
Операция	OpenAI.ApplyPatchOperationParam	Одна из операций create_file, delete_file или update_file, предоставляемых средству apply_patch.	Да
└─ Тип	OpenAI.ApplyPatchOperationParamType		Да
Статус	OpenAI.ApplyPatchCallStatusParam	Значения состояния, сообщаемые для вызовов apply_patch инструментов.	Да
type	enum	Тип элемента. Всегда apply_patch_call. Возможные значения: apply_patch_call	Да

OpenAI.ItemApplyPatchToolCallOutputItemParam

Потоковые выходные данные, создаваемые вызовом средства исправления.

Name	Type	Description	Обязательный	По умолчанию
call_id	строка	Уникальный идентификатор вызова средства исправления, созданного моделью. Ограничения: minLength: 1, maxLength: 64	Да
id	Строка (нулевая)		Нет
output	Строка (нулевая)		Нет
Статус	OpenAI.ApplyPatchCallOutputStatusParam	Значения результатов, сообщаемые для выходных данных apply_patch средства.	Да
type	enum	Тип элемента. Всегда apply_patch_call_output. Возможные значения: apply_patch_call_output	Да

OpenAI.ItemCodeInterpreterToolCall

Вызов инструмента для выполнения кода.

Name	Type	Description	Обязательный	По умолчанию
code	Строка (нулевая)		Да
container_id	строка	Идентификатор контейнера, используемого для запуска кода.	Да
id	строка	Уникальный идентификатор вызова средства интерпретатора кода.	Да
outputs	массив OpenAI.CodeInterpreterOutputLogs или OpenAI.CodeInterpreterOutputImage		Да
Статус	enum	Состояние вызова средства интерпретатора кода. Допустимые значения: in_progress, completed, incomplete, interpreting, и failed. Возможные значения: in_progress, completed, incomplete, interpreting, failed	Да
type	enum	Тип вызова средства интерпретатора кода. Всегда code_interpreter_call. Возможные значения: code_interpreter_call	Да

OpenAI.ItemCompactionSummaryItemParam

Элемент сжатия, v1/responses/compact созданный API.

Name	Type	Description	Обязательный	По умолчанию
encrypted_content	строка	Зашифрованное содержимое сводки сжатия. Ограничения: maxLength: 10485760	Да
id	Строка (нулевая)		Нет
type	enum	Тип элемента. Всегда compaction. Возможные значения: compaction	Да

OpenAI.ItemComputerCallOutputItemParam

Выходные данные запуска компьютерного инструмента.

Name	Type	Description	Обязательный	По умолчанию
acknowledged_safety_checks	массив OpenAI.ComputerCallSafetyCheckParam		Нет
call_id	строка	Идентификатор вызова средства компьютера, создающего выходные данные. Ограничения: minLength: 1, maxLength: 64	Да
id	Строка (нулевая)		Нет
output	OpenAI.ComputerScreenshotImage	Снимок экрана компьютера, используемый с помощью инструмента для использования компьютера.	Да
Статус	OpenAI.FunctionCallItemStatus (nullable)		Нет
type	enum	Тип выходных данных компьютерного средства вызова. Всегда computer_call_output. Возможные значения: computer_call_output	Да

OpenAI.ItemComputerToolCall

Вызов инструмента для работы с компьютером. Дополнительные сведения см. в руководстве по использованию компьютера .

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	Да

OpenAI.ItemCustomToolCall

Вызов пользовательского средства, созданного моделью.

Name	Type	Description	Обязательный	По умолчанию
call_id	строка	Идентификатор, используемый для сопоставления этого настраиваемого вызова средства с выходными данными вызова средства.	Да
id	строка	Уникальный идентификатор вызова пользовательского средства на платформе OpenAI.	Нет
input	строка	Входные данные для вызова пользовательского средства, созданного моделью.	Да
имя	строка	Имя вызываемого пользовательского инструмента.	Да
type	enum	Тип вызова пользовательского средства. Всегда custom_tool_call. Возможные значения: custom_tool_call	Да

OpenAI.ItemCustomToolCallOutput

Выходные данные вызова пользовательского средства из кода, отправляемые обратно в модель.

Name	Type	Description	Обязательный	По умолчанию
call_id	строка	Идентификатор вызова, используемый для сопоставления выходных данных этого пользовательского средства с пользовательским вызовом средства.	Да
id	строка	Уникальный идентификатор выходных данных вызова пользовательского средства на платформе OpenAI.	Нет
output	строка или массив OpenAI.FunctionAndCustomToolCallOutput	Выходные данные из вызова пользовательского средства, созданного кодом. Может быть строкой или списком выходного содержимого.	Да
type	enum	Тип выходных данных вызова пользовательского средства. Всегда custom_tool_call_output. Возможные значения: custom_tool_call_output	Да

OpenAI.ItemFileSearchToolCall

Результаты вызова средства поиска файлов. Дополнительные сведения см. в руководстве по поиску файлов .

Name	Type	Description	Обязательный	По умолчанию
id	строка	Уникальный идентификатор вызова средства поиска файлов.	Да
queries	массив строк	Запросы, используемые для поиска файлов.	Да
results	массив OpenAI.FileSearchToolCallResults		Нет
Статус	enum	Состояние вызова средства поиска файлов. Один из in_progress, searching, incomplete или failed, Возможные значения: in_progress, searching, completed, incomplete, failed	Да
type	enum	Тип вызова средства поиска файлов. Всегда file_search_call. Возможные значения: file_search_call	Да

OpenAI.ItemFunctionCallOutputItemParam

Выходные данные вызова инструмента функции.

Name	Type	Description	Обязательный	По умолчанию
call_id	строка	Уникальный идентификатор вызова функции, созданного моделью. Ограничения: minLength: 1, maxLength: 64	Да
id	Строка (нулевая)		Нет
output	строка или массив OpenAI.InputTextContentParam или OpenAI.InputImageContentParamAutoParam или OpenAI.InputFileContentParam	Вывод текста, изображения или файла вызова средства функции.	Да
Статус	OpenAI.FunctionCallItemStatus (nullable)		Нет
type	enum	Тип выходных данных вызова функции. Всегда function_call_output. Возможные значения: function_call_output	Да

OpenAI.ItemFunctionShellCallItemParam

Средство, представляющее запрос на выполнение одной или нескольких команд оболочки.

Name	Type	Description	Обязательный	По умолчанию
action	OpenAI.FunctionShellActionParam	Команды и ограничения, описывающие запуск вызова средства оболочки.	Да
Команды └️	массив строк	Упорядоченные команды оболочки для выполнения среды выполнения.	Да
└max_output_length	OpenAI.integer (nullable)		Нет
└️ timeout_ms	OpenAI.integer (nullable)		Нет
call_id	строка	Уникальный идентификатор вызова средства оболочки, созданного моделью. Ограничения: minLength: 1, maxLength: 64	Да
id	Строка (нулевая)		Нет
Статус	OpenAI.FunctionShellCallItemStatus (nullable)	Значения состояния, сообщаемые для вызовов инструментов оболочки.	Нет
type	enum	Тип элемента. Всегда shell_call. Возможные значения: shell_call	Да

OpenAI.ItemFunctionShellCallOutputItemParam

Потоковые выходные элементы, создаваемые вызовом средства оболочки.

Name	Type	Description	Обязательный	По умолчанию
call_id	строка	Уникальный идентификатор вызова средства оболочки, созданного моделью. Ограничения: minLength: 1, maxLength: 64	Да
id	Строка (нулевая)		Нет
max_output_length	OpenAI.integer (nullable)		Нет
output	массив OpenAI.FunctionShellCallOutputContentParam	Захваченные фрагменты выходных данных stdout и stderr, а также связанные с ними результаты.	Да
type	enum	Тип элемента. Всегда shell_call_output. Возможные значения: shell_call_output	Да

OpenAI.ItemFunctionToolCall

Вызов средства для запуска функции. Дополнительные сведения см. в руководстве по вызову функции .

Name	Type	Description	Обязательный	По умолчанию
arguments	строка	Строка JSON аргументов для передачи функции.	Да
call_id	строка	Уникальный идентификатор вызова функции, созданного моделью.	Да
id	строка	Уникальный идентификатор вызова средства функции.	Нет
имя	строка	Имя выполняемой функции.	Да
Статус	enum	Состояние элемента. Один из in_progress, completedили incomplete. Заполняется, когда элементы возвращаются через API. Возможные значения: in_progress, completedincomplete	Нет
type	enum	Тип вызова инструмента функции. Всегда function_call. Возможные значения: function_call	Да

OpenAI.ItemImageGenToolCall

Запрос на создание изображения, сделанный моделью.

Name	Type	Description	Обязательный	По умолчанию
id	строка	Уникальный идентификатор вызова создания образа.	Да
result	Строка (нулевая)		Да
Статус	enum	Состояние вызова создания образа. Возможные значения: in_progress, , completedgeneratingfailed	Да
type	enum	Тип вызова создания изображения. Всегда image_generation_call. Возможные значения: image_generation_call	Да

OpenAI.ItemLocalShellToolCall

Вызов инструмента для выполнения команды в локальной оболочке.

Name	Type	Description	Обязательный	По умолчанию
action	OpenAI.LocalShellExecAction	Выполните команду оболочки на сервере.	Да
call_id	строка	Уникальный идентификатор вызова локального утилита оболочки, сгенерированного моделью.	Да
id	строка	Уникальный идентификатор вызова локальной оболочки.	Да
Статус	enum	Состояние вызова локальной оболочки. Возможные значения: in_progress, completedincomplete	Да
type	enum	Тип вызова локальной оболочки. Всегда local_shell_call. Возможные значения: local_shell_call	Да

OpenAI.ItemLocalShellToolCallOutput

Выходные данные вызова локального оболочечного инструмента.

Name	Type	Description	Обязательный	По умолчанию
id	строка	Уникальный идентификатор вызова локального утилита оболочки, сгенерированного моделью.	Да
output	строка	Строка JSON, представляющая результаты вызова локального инструмента оболочки.	Да
Статус	enum	Возможные значения: in_progress, completedincomplete	Нет
type	enum	Тип выходных данных вызова средства локальной оболочки. Всегда local_shell_call_output. Возможные значения: local_shell_call_output	Да

OpenAI.ItemMcpApprovalRequest

Запрос на одобрение человеком вызова инструмента.

Name	Type	Description	Обязательный	По умолчанию
arguments	строка	Строка JSON с аргументами для средства.	Да
id	строка	Уникальный идентификатор запроса на утверждение.	Да
имя	строка	Имя запускаемого инструмента.	Да
метка сервера	строка	Метка сервера MCP, выполняющего запрос.	Да
type	enum	Тип элемента. Всегда mcp_approval_request. Возможные значения: mcp_approval_request	Да

OpenAI.ItemMcpApprovalResponse

Ответ на запрос на утверждение MCP.

Name	Type	Description	Обязательный	По умолчанию
approval_request_id	строка	Идентификатор запроса на утверждение, на который даётся ответ.	Да
Утвердить	boolean	Будет ли утвержден запрос.	Да
id	Строка (нулевая)		Нет
причина	Строка (нулевая)		Нет
type	enum	Тип элемента. Всегда mcp_approval_response. Возможные значения: mcp_approval_response	Да

OpenAI.ItemMcpListTools

Список средств, доступных на сервере MCP.

Name	Type	Description	Обязательный	По умолчанию
error	Строка (нулевая)		Нет
id	строка	Уникальный идентификатор списка.	Да
метка сервера	строка	Метка сервера MCP.	Да
tools	массив OpenAI.MCPListToolsTools	Средства, доступные на сервере.	Да
type	enum	Тип элемента. Всегда mcp_list_tools. Возможные значения: mcp_list_tools	Да

OpenAI.ItemMcpToolCall

Вызов инструмента на сервере MCP.

Name	Type	Description	Обязательный	По умолчанию
approval_request_id	Строка (нулевая)		Нет
arguments	строка	Строка JSON аргументов, переданных средству.	Да
error	Строка (нулевая)		Нет
id	строка	Уникальный идентификатор вызова средства.	Да
имя	строка	Имя запущенного инструмента.	Да
output	Строка (нулевая)		Нет
метка сервера	строка	Метка сервера MCP, на котором работает инструмент.	Да
Статус	OpenAI.MCPToolCallStatus		Нет
type	enum	Тип элемента. Всегда mcp_call. Возможные значения: mcp_call	Да

OpenAI.ItemOutputMessage

Выходное сообщение из модели.

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.ItemReasoningItem

Описание цепочки мысли, используемой моделью причин при создании ответа. Не забудьте включить эти элементы в input API ответов для последующих поворотов беседы, если вы вручную управляете контекстом.

Name	Type	Description	Обязательный	По умолчанию
содержимое	массив OpenAI.ReasoningTextContent	Обоснование текстового содержимого.	Нет
encrypted_content	Строка (нулевая)		Нет
id	строка	Уникальный идентификатор контента рассуждений.	Да
Статус	enum	Состояние элемента. Один из in_progress, completedили incomplete. Заполняется, когда элементы возвращаются через API. Возможные значения: in_progress, completedincomplete	Нет
summary	массив OpenAI.Summary	Содержимое сводки по причинам.	Да
type	enum	Тип объекта . Всегда reasoning. Возможные значения: reasoning	Да

OpenAI.ItemReferenceParam

Внутренний идентификатор для ссылки на элемент.

Name	Type	Description	Обязательный	По умолчанию
id	строка	Идентификатор элемента для ссылки.	Да
type	enum	Тип элемента для ссылки. Всегда 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

Вызов средства, который применяет диффы файлов, создавая, удаляя или обновляя файлы.

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	Да

OpenAI.ItemResourceApplyPatchToolCallOutput

Выходные данные, создаваемые вызовом средства исправления.

Name	Type	Description	Обязательный	По умолчанию
call_id	строка	Уникальный идентификатор вызова средства исправления, созданного моделью.	Да
создано пользователем	строка	Идентификатор сущности, создающей выходные данные вызова этого средства.	Нет
id	строка	Уникальный идентификатор выходных данных вызова средства исправления. Заполняется, когда этот элемент возвращается через API.	Да
output	Строка (нулевая)		Нет
Статус	OpenAI.ApplyPatchCallOutputStatus		Да
type	enum	Тип элемента. Всегда apply_patch_call_output. Возможные значения: apply_patch_call_output	Да

OpenAI.ItemResourceCodeInterpreterToolCall

Вызов инструмента для выполнения кода.

Name	Type	Description	Обязательный	По умолчанию
code	Строка (нулевая)		Да
container_id	строка	Идентификатор контейнера, используемого для запуска кода.	Да
id	строка	Уникальный идентификатор вызова средства интерпретатора кода.	Да
outputs	массив OpenAI.CodeInterpreterOutputLogs или OpenAI.CodeInterpreterOutputImage		Да
Статус	enum	Состояние вызова средства интерпретатора кода. Допустимые значения: in_progress, completed, incomplete, interpreting, и failed. Возможные значения: in_progress, completed, incomplete, interpreting, failed	Да
type	enum	Тип вызова средства интерпретатора кода. Всегда 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	Да

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	Да

OpenAI.ItemResourceFileSearchToolCall

Результаты вызова средства поиска файлов. Дополнительные сведения см. в руководстве по поиску файлов .

Name	Type	Description	Обязательный	По умолчанию
id	строка	Уникальный идентификатор вызова средства поиска файлов.	Да
queries	массив строк	Запросы, используемые для поиска файлов.	Да
results	массив OpenAI.FileSearchToolCallResults		Нет
Статус	enum	Состояние вызова средства поиска файлов. Один из in_progress, searching, incomplete или failed, Возможные значения: in_progress, searching, completed, incomplete, failed	Да
type	enum	Тип вызова средства поиска файлов. Всегда file_search_call. Возможные значения: file_search_call	Да

OpenAI.ItemResourceFunctionShellCall

Вызов средства, выполняющий одну или несколько команд оболочки в управляемой среде.

Name	Type	Description	Обязательный	По умолчанию
action	OpenAI.FunctionShellAction	Выполните команду оболочки.	Да
Команды └️	массив строк		Да
└max_output_length	OpenAI.integer (nullable)		Да
└️ timeout_ms	OpenAI.integer (nullable)		Да
call_id	строка	Уникальный идентификатор вызова средства оболочки, созданного моделью.	Да
создано пользователем	строка	Идентификатор сущности, созданной этим средством.	Нет
id	строка	Уникальный идентификатор вызова средства оболочки. Заполняется, когда этот элемент возвращается через API.	Да
Статус	OpenAI.LocalShellCallStatus		Да
type	enum	Тип элемента. Всегда shell_call. Возможные значения: shell_call	Да

OpenAI.ItemResourceFunctionShellCallOutput

Выходные данные вызова средства оболочки, который был создан.

Name	Type	Description	Обязательный	По умолчанию
call_id	строка	Уникальный идентификатор вызова средства оболочки, созданного моделью.	Да
создано пользователем	строка	Идентификатор субъекта, создавшего элемент.	Нет
id	строка	Уникальный идентификатор выходных данных вызова оболочки. Заполняется, когда этот элемент возвращается через API.	Да
max_output_length	OpenAI.integer (nullable)		Да
output	массив OpenAI.FunctionShellCallOutputContent	Массив содержимого вывода вызова оболочки	Да
type	enum	Тип выходных данных вызова оболочки. Всегда 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	Строка (нулевая)		Да
Статус	enum	Состояние вызова создания образа. Возможные значения: in_progress, , completedgeneratingfailed	Да
type	enum	Тип вызова создания изображения. Всегда image_generation_call. Возможные значения: image_generation_call	Да

OpenAI.ItemResourceLocalShellToolCall

Вызов инструмента для выполнения команды в локальной оболочке.

Name	Type	Description	Обязательный	По умолчанию
action	OpenAI.LocalShellExecAction	Выполните команду оболочки на сервере.	Да
call_id	строка	Уникальный идентификатор вызова локального утилита оболочки, сгенерированного моделью.	Да
id	строка	Уникальный идентификатор вызова локальной оболочки.	Да
Статус	enum	Состояние вызова локальной оболочки. Возможные значения: in_progress, completedincomplete	Да
type	enum	Тип вызова локальной оболочки. Всегда local_shell_call. Возможные значения: local_shell_call	Да

OpenAI.ItemResourceLocalShellToolCallOutput

Выходные данные вызова локального оболочечного инструмента.

Name	Type	Description	Обязательный	По умолчанию
id	строка	Уникальный идентификатор вызова локального утилита оболочки, сгенерированного моделью.	Да
output	строка	Строка JSON, представляющая результаты вызова локального инструмента оболочки.	Да
Статус	enum	Возможные значения: in_progress, completedincomplete	Нет
type	enum	Тип выходных данных вызова средства локальной оболочки. Всегда local_shell_call_output. Возможные значения: local_shell_call_output	Да

OpenAI.ItemResourceMcpApprovalRequest

Запрос на одобрение человеком вызова инструмента.

Name	Type	Description	Обязательный	По умолчанию
arguments	строка	Строка JSON с аргументами для средства.	Да
id	строка	Уникальный идентификатор запроса на утверждение.	Да
имя	строка	Имя запускаемого инструмента.	Да
метка сервера	строка	Метка сервера MCP, выполняющего запрос.	Да
type	enum	Тип элемента. Всегда mcp_approval_request. Возможные значения: mcp_approval_request	Да

OpenAI.ItemResourceMcpApprovalResponseResource

Ответ на запрос на утверждение MCP.

Name	Type	Description	Обязательный	По умолчанию
approval_request_id	строка	Идентификатор запроса на утверждение, на который даётся ответ.	Да
Утвердить	boolean	Будет ли утвержден запрос.	Да
id	строка	Уникальный идентификатор ответа на утверждение	Да
причина	Строка (нулевая)		Нет
type	enum	Тип элемента. Всегда mcp_approval_response. Возможные значения: mcp_approval_response	Да

OpenAI.ItemResourceMcpListTools

Список средств, доступных на сервере MCP.

Name	Type	Description	Обязательный	По умолчанию
error	Строка (нулевая)		Нет
id	строка	Уникальный идентификатор списка.	Да
метка сервера	строка	Метка сервера MCP.	Да
tools	массив OpenAI.MCPListToolsTools	Средства, доступные на сервере.	Да
type	enum	Тип элемента. Всегда mcp_list_tools. Возможные значения: mcp_list_tools	Да

OpenAI.ItemResourceMcpToolCall

Вызов инструмента на сервере MCP.

Name	Type	Description	Обязательный	По умолчанию
approval_request_id	Строка (нулевая)		Нет
arguments	строка	Строка JSON аргументов, переданных средству.	Да
error	Строка (нулевая)		Нет
id	строка	Уникальный идентификатор вызова средства.	Да
имя	строка	Имя запущенного инструмента.	Да
output	Строка (нулевая)		Нет
метка сервера	строка	Метка сервера 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 structured_outputs oauth_consent_request memory_search_call workflow_action

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.ItemType

Property	Ценность
Type	строка
Значения	message output_message file_search_call computer_call computer_call_output web_search_call function_call function_call_output reasoning compaction 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 custom_tool_call_output custom_tool_call structured_outputs oauth_consent_request memory_search_call workflow_action

OpenAI.ItemWebSearchToolCall

Результаты вызова средства поиска в Интернете. Дополнительные сведения см. в руководстве по поиску в Интернете .

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

Коллекция нажатий клавиш, которые модель хотела бы выполнить.

Name	Type	Description	Обязательный	По умолчанию
keys	массив строк	Сочетание клавиш, которые модель просит нажать. Это массив строк, каждый из которых представляет ключ.	Да
type	enum	Указывает тип события. Для действия keypress это свойство всегда имеет значение keypress. Возможные значения: keypress	Да

OpenAI.ListFineTuningJobCheckpointsResponse

Name	Type	Description	Обязательный	По умолчанию
data	массив OpenAI.FineTuningJobCheckpoint		Да
первый_идентификатор	Строка (нулевая)		Нет
есть_еще	boolean		Да
last_id	Строка (нулевая)		Нет
object	enum	Возможные значения: list	Да

OpenAI.ListFineTuningJobEventsResponse

Name	Type	Description	Обязательный	По умолчанию
data	массив OpenAI.FineTuningJobEvent		Да
есть_еще	boolean		Да
object	enum	Возможные значения: list	Да

OpenAI.ListPaginatedFineTuningJobsResponse

Name	Type	Description	Обязательный	По умолчанию
data	массив OpenAI.FineTuningJob		Да
есть_еще	boolean		Да
object	enum	Возможные значения: list	Да

OpenAI.LocalShellCallStatus

Property	Ценность
Type	строка
Значения	in_progress completed incomplete

OpenAI.LocalShellExecAction

Выполните команду оболочки на сервере.

Name	Type	Description	Обязательный	По умолчанию
command	массив строк	Команда для выполнения	Да
окружение	object	Переменные среды, заданные для команды.	Да
таймаут_мс	OpenAI.integer (nullable)		Нет
type	enum	Тип операции локального интерфейса оболочки. Всегда exec. Возможные значения: exec	Да
user	Строка (нулевая)		Нет
рабочий каталог	Строка (нулевая)		Нет

OpenAI.LocalShellToolParam

Средство, позволяющее модели выполнять команды оболочки в локальной среде.

Name	Type	Description	Обязательный	По умолчанию
type	enum	Тип локального инструмента оболочки. Всегда local_shell. Возможные значения: local_shell	Да

OpenAI.LogProb

Логарифмическая вероятность токена.

Name	Type	Description	Обязательный	По умолчанию
байт	массив OpenAI.integer		Да
logprob	OpenAI.numeric		Да
token	строка		Да
top_logprobs	массив OpenAI.TopLogProb		Да

OpenAI.MCPListToolsTool

Средство, доступное на сервере MCP.

Name	Type	Description	Обязательный	По умолчанию
annotations	OpenAI.MCPListToolsToolAnnotations (nullable)		Нет
описание	Строка (нулевая)		Нет
input_schema	OpenAI.MCPListToolsToolInputSchema		Да
имя	строка	Имя средства.	Да

OpenAI.MCPListToolsToolAnnotations

Тип: объект

OpenAI.MCPListToolsToolInputSchema

Тип: объект

OpenAI.MCPTool

Предоставьте модели доступ к дополнительным инструментам через удаленные серверы протокола контекста модели (MCP). Дополнительные сведения о MCP.

Name	Type	Description	Обязательный	По умолчанию
разрешённые_инструменты	массив строк или OpenAI.MCPToolFilter		Нет
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	Объект (нулируемый)		Нет
project_connection_id	строка	Идентификатор подключения в project сервера MCP. В подключении хранятся данные аутентификации и другие сведения о подключении, необходимые для подключения к серверу MCP.	Нет
требовать_одобрение	object (см. допустимые модели ниже)		Нет
server_description	строка	Необязательное описание сервера MCP, используемого для предоставления дополнительного контекста.	Нет
метка сервера	строка	Метка для этого сервера MCP, используемая для идентификации его в вызовах инструментов.	Да
URL сервера	строка	URL-адрес сервера MCP. Одно из server_url или connector_id должно быть Предоставляются.	Нет
type	enum	Тип средства MCP. Всегда mcp. Возможные значения: mcp	Да

OpenAI.MCPToolCallStatus

Property	Ценность
Type	строка
Значения	in_progress completed incomplete calling failed

OpenAI.MCPToolFilter

Объект фильтра, указывающий, какие средства разрешены.

Name	Type	Description	Обязательный	По умолчанию
read_only	boolean	Указывает, изменяет ли средство данные или доступно только для чтения. Если Сервер MCP аннотирован с помощью < a0/&a0>. он будет соответствовать этому фильтру.	Нет
tool_names	массив строк	Список разрешенных имен инструментов.	Нет

OpenAI.MCPToolRequireApproval

Name	Type	Description	Обязательный	По умолчанию
Всегда	OpenAI.MCPToolFilter	Объект фильтра, указывающий, какие средства разрешены.	Нет
никогда	OpenAI.MCPToolFilter	Объект фильтра, указывающий, какие средства разрешены.	Нет

OpenAI.MessageContent

Часть содержимого, которая состоит из входного или выходного элемента.

Дискриминация для OpenAI.MessageContent

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа	Schema
text	OpenAI.TextContent
summary_text	OpenAI.SummaryTextContent
computer_screenshot	OpenAI.ComputerScreenshotContent
input_text	OpenAI.MessageContentInputTextContent
output_text	OpenAI.MessageContentOutputTextContent
reasoning_text	OpenAI.MessageContentReasoningTextContent
refusal	OpenAI.MessageContentRefusalContent
input_image	OpenAI.MessageContentInputImageContent
input_file	OpenAI.MessageContentInputFileContent

Name	Type	Description	Обязательный	По умолчанию
type	OpenAI.MessageContentType		Да

OpenAI.MessageContentInputFileContent

Файл в качестве входных данных для модели.

Name	Type	Description	Обязательный	По умолчанию
file_data	строка	Содержимое файла, отправляемого в модель.	Нет
идентификатор_файла	Строка (нулевая)		Нет
file_url	строка	URL-адрес файла, отправляемого в модель.	Нет
filename	строка	Имя файла, отправляемого в модель.	Нет
type	enum	Тип входного элемента. Всегда input_file. Возможные значения: input_file	Да

OpenAI.MessageContentInputImageContent

Изображение в качестве входных данных для модели. Узнайте о входных данных изображения.

Name	Type	Description	Обязательный	По умолчанию
detail	OpenAI.ImageDetail		Да
идентификатор_файла	Строка (нулевая)		Нет
ссылка_на_изображение	строка		Нет
type	enum	Тип входного элемента. Всегда input_image. Возможные значения: input_image	Да

OpenAI.MessageContentInputTextContent

Текстовые входные данные модели.

Name	Type	Description	Обязательный	По умолчанию
text	строка	Текстовые входные данные модели.	Да
type	enum	Тип входного элемента. Всегда input_text. Возможные значения: input_text	Да

OpenAI.MessageContentOutputTextContent

Текстовые выходные данные модели.

Name	Type	Description	Обязательный	По умолчанию
annotations	массив OpenAI.Annotation	Заметки к выходным данным текста.	Да
logprobs	массив OpenAI.LogProb		Нет
text	строка	Текстовые выходные данные модели.	Да
type	enum	Тип выходного текста. Всегда output_text. Возможные значения: output_text	Да

OpenAI.MessageContentReasoningTextContent

Вывод текста из модели.

Name	Type	Description	Обязательный	По умолчанию
text	строка	Текст причины из модели.	Да
type	enum	Тип текста причины. Всегда reasoning_text. Возможные значения: reasoning_text	Да

OpenAI.MessageContentRefusalContent

Отказ модели.

Name	Type	Description	Обязательный	По умолчанию
отказ	строка	Объяснение отказа модели.	Да
type	enum	Тип отказа. Всегда refusal. Возможные значения: refusal	Да

OpenAI.MessageContentType

Property	Ценность
Type	строка
Значения	input_text output_text text summary_text reasoning_text refusal input_image computer_screenshot input_file

OpenAI.MessageRole

Property	Ценность
Type	строка
Значения	unknown user assistant system critic discriminator developer tool

OpenAI.MessageStatus

Property	Ценность
Type	строка
Значения	in_progress completed incomplete

OpenAI.Metadata

Набор из 16 пар "ключ-значение", которые можно прикрепить к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате и запроса на объекты через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — это строки с максимальной длиной 512 символов.

Тип: объект

OpenAI.ModelIdsCompaction

Идентификатор модели, используемый для создания ответа, например gpt-5 или o3. OpenAI предлагает широкий спектр моделей с разными возможностями, характеристиками производительности и ценами. Ознакомьтесь с руководством по модели для просмотра и сравнения доступных моделей.

Тип: OpenAI.ModelIdsResponses или string

Идентификатор модели, используемый для создания ответа, например gpt-5 или o3. OpenAI предлагает широкий спектр моделей с разными возможностями, характеристиками производительности и ценами. Ознакомьтесь с руководством по модели для просмотра и сравнения доступных моделей.

OpenAI.ModelIdsResponses

Property	Ценность
Type	строка
Значения	o1-pro o1-pro-2025-03-19 o3-pro o3-pro-2025-06-10 o3-deep-research o3-deep-research-2025-06-26 o4-mini-deep-research o4-mini-deep-research-2025-06-26 computer-use-preview computer-use-preview-2025-03-11 gpt-5-codex gpt-5-pro gpt-5-pro-2025-10-06 gpt-5.1-codex-max

OpenAI.ModelIdsShared

Тип: string или OpenAI.ChatModel

OpenAI.Move

Операция перемещения мыши.

Name	Type	Description	Обязательный	По умолчанию
type	enum	Указывает тип события. Для действия перемещения это свойство имеет значение всегда задано значение move. Возможные значения: move	Да
x	OpenAI.integer		Да
и	OpenAI.integer		Да

OpenAI.OutputContent

Дискриминация для OpenAI.OutputContent

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа	Schema
output_text	OpenAI.OutputContentOutputTextContent
refusal	OpenAI.OutputContentRefusalContent
reasoning_text	OpenAI.OutputContentReasoningTextContent

Name	Type	Description	Обязательный	По умолчанию
type	OpenAI.OutputContentType		Да

OpenAI.OutputContentOutputTextContent

Текстовые выходные данные модели.

Name	Type	Description	Обязательный	По умолчанию
annotations	массив OpenAI.Annotation	Заметки к выходным данным текста.	Да
logprobs	массив OpenAI.LogProb		Нет
text	строка	Текстовые выходные данные модели.	Да
type	enum	Тип выходного текста. Всегда output_text. Возможные значения: output_text	Да

OpenAI.OutputContentReasoningTextContent

Вывод текста из модели.

Name	Type	Description	Обязательный	По умолчанию
text	строка	Текст причины из модели.	Да
type	enum	Тип текста причины. Всегда reasoning_text. Возможные значения: reasoning_text	Да

OpenAI.OutputContentRefusalContent

Отказ модели.

Name	Type	Description	Обязательный	По умолчанию
отказ	строка	Объяснение отказа модели.	Да
type	enum	Тип отказа. Всегда refusal. Возможные значения: refusal	Да

OpenAI.OutputContentType

Property	Ценность
Type	строка
Значения	output_text refusal reasoning_text

OpenAI.OutputItem

Дискриминация для OpenAI.OutputItem

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа	Schema
structured_outputs	StructuredOutputsOutputItem
workflow_action	WorkflowActionOutputItem
oauth_consent_request	OAuthConsentRequestOutputItem
memory_search_call	MemorySearchToolCallItemResource
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	Обязательный	По умолчанию
agent_reference	AgentReference		Нет
└️ имя	строка	Имя агента. Ограничения: maxLength: 256	Да
└─ Тип	enum	Возможные значения: agent_reference	Да
└─ Версия	строка	Идентификатор версии агента.	Нет
response_id	строка	Ответ, на котором создается элемент.	Нет
type	OpenAI.OutputItemType		Да

OpenAI.OutputItemApplyPatchToolCall

Вызов средства, который применяет диффы файлов, создавая, удаляя или обновляя файлы.

Name	Type	Description	Обязательный	По умолчанию
agent_reference	AgentReference		Нет
└️ имя	строка	Имя агента. Ограничения: maxLength: 256	Да
└─ Тип	enum	Возможные значения: agent_reference	Да
└─ Версия	строка	Идентификатор версии агента.	Нет
call_id	строка	Уникальный идентификатор вызова средства исправления, созданного моделью.	Да
создано пользователем	строка	Идентификатор сущности, созданной этим средством.	Нет
id	строка	Уникальный идентификатор вызова средства исправления. Заполняется, когда этот элемент возвращается через API.	Да
Операция	OpenAI.ApplyPatchFileOperation	Одна из операций create_file, delete_file или update_file, применяемых через apply_patch.	Да
└─ Тип	OpenAI.ApplyPatchFileOperationType		Да
response_id	строка	Ответ, на котором создается элемент.	Нет
Статус	OpenAI.ApplyPatchCallStatus		Да
type	enum	Тип элемента. Всегда apply_patch_call. Возможные значения: apply_patch_call	Да

OpenAI.OutputItemApplyPatchToolCallOutput

Выходные данные, создаваемые вызовом средства исправления.

Name	Type	Description	Обязательный	По умолчанию
agent_reference	AgentReference		Нет
└️ имя	строка	Имя агента. Ограничения: maxLength: 256	Да
└─ Тип	enum	Возможные значения: agent_reference	Да
└─ Версия	строка	Идентификатор версии агента.	Нет
call_id	строка	Уникальный идентификатор вызова средства исправления, созданного моделью.	Да
создано пользователем	строка	Идентификатор сущности, создающей выходные данные вызова этого средства.	Нет
id	строка	Уникальный идентификатор выходных данных вызова средства исправления. Заполняется, когда этот элемент возвращается через API.	Да
output	Строка (нулевая)		Нет
response_id	строка	Ответ, на котором создается элемент.	Нет
Статус	OpenAI.ApplyPatchCallOutputStatus		Да
type	enum	Тип элемента. Всегда apply_patch_call_output. Возможные значения: apply_patch_call_output	Да

OpenAI.OutputItemCodeInterpreterToolCall

Вызов инструмента для выполнения кода.

Name	Type	Description	Обязательный	По умолчанию
agent_reference	AgentReference		Нет
└️ имя	строка	Имя агента. Ограничения: maxLength: 256	Да
└─ Тип	enum	Возможные значения: agent_reference	Да
└─ Версия	строка	Идентификатор версии агента.	Нет
code	Строка (нулевая)		Да
container_id	строка	Идентификатор контейнера, используемого для запуска кода.	Да
id	строка	Уникальный идентификатор вызова средства интерпретатора кода.	Да
outputs	массив OpenAI.CodeInterpreterOutputLogs или OpenAI.CodeInterpreterOutputImage		Да
response_id	строка	Ответ, на котором создается элемент.	Нет
Статус	enum	Состояние вызова средства интерпретатора кода. Допустимые значения: in_progress, completed, incomplete, interpreting, и failed. Возможные значения: in_progress, completed, incomplete, interpreting, failed	Да
type	enum	Тип вызова средства интерпретатора кода. Всегда code_interpreter_call. Возможные значения: code_interpreter_call	Да

OpenAI.OutputItemCompactionBody

Элемент сжатия, v1/responses/compact созданный API.

Name	Type	Description	Обязательный	По умолчанию
agent_reference	AgentReference		Нет
└️ имя	строка	Имя агента. Ограничения: maxLength: 256	Да
└─ Тип	enum	Возможные значения: agent_reference	Да
└─ Версия	строка	Идентификатор версии агента.	Нет
создано пользователем	строка	Идентификатор субъекта, создавшего элемент.	Нет
encrypted_content	строка	Зашифрованное содержимое, созданное с помощью сжатия.	Да
id	строка	Уникальный идентификатор элемента сжатия.	Да
response_id	строка	Ответ, на котором создается элемент.	Нет
type	enum	Тип элемента. Всегда compaction. Возможные значения: compaction	Да

OpenAI.OutputItemComputerToolCall

Вызов инструмента для работы с компьютером. Дополнительные сведения см. в руководстве по использованию компьютера .

Name	Type	Description	Обязательный	По умолчанию
action	OpenAI.ComputerAction		Да
agent_reference	AgentReference		Нет
└️ имя	строка	Имя агента. Ограничения: maxLength: 256	Да
└─ Тип	enum	Возможные значения: agent_reference	Да
└─ Версия	строка	Идентификатор версии агента.	Нет
call_id	строка	Идентификатор, используемый при реагировании на вызов инструмента с выходными данными.	Да
id	строка	Уникальный идентификатор вызова компьютера.	Да
pending_safety_checks	массив OpenAI.ComputerCallSafetyCheckParam	Ожидающие проверки безопасности для компьютеризированного процесса.	Да
response_id	строка	Ответ, на котором создается элемент.	Нет
Статус	enum	Состояние элемента. Один из in_progress, completedили incomplete. Заполняется, когда элементы возвращаются через API. Возможные значения: in_progress, completedincomplete	Да
type	enum	Тип компьютерного вызова. Всегда computer_call. Возможные значения: computer_call	Да

OpenAI.OutputItemCustomToolCall

Вызов пользовательского средства, созданного моделью.

Name	Type	Description	Обязательный	По умолчанию
agent_reference	AgentReference		Нет
└️ имя	строка	Имя агента. Ограничения: maxLength: 256	Да
└─ Тип	enum	Возможные значения: agent_reference	Да
└─ Версия	строка	Идентификатор версии агента.	Нет
call_id	строка	Идентификатор, используемый для сопоставления этого настраиваемого вызова средства с выходными данными вызова средства.	Да
id	строка	Уникальный идентификатор вызова пользовательского средства на платформе OpenAI.	Нет
input	строка	Входные данные для вызова пользовательского средства, созданного моделью.	Да
имя	строка	Имя вызываемого пользовательского инструмента.	Да
response_id	строка	Ответ, на котором создается элемент.	Нет
type	enum	Тип вызова пользовательского средства. Всегда custom_tool_call. Возможные значения: custom_tool_call	Да

OpenAI.OutputItemFileSearchToolCall

Результаты вызова средства поиска файлов. Дополнительные сведения см. в руководстве по поиску файлов .

Name	Type	Description	Обязательный	По умолчанию
agent_reference	AgentReference		Нет
└️ имя	строка	Имя агента. Ограничения: maxLength: 256	Да
└─ Тип	enum	Возможные значения: agent_reference	Да
└─ Версия	строка	Идентификатор версии агента.	Нет
id	строка	Уникальный идентификатор вызова средства поиска файлов.	Да
queries	массив строк	Запросы, используемые для поиска файлов.	Да
response_id	строка	Ответ, на котором создается элемент.	Нет
results	массив OpenAI.FileSearchToolCallResults		Нет
Статус	enum	Состояние вызова средства поиска файлов. Один из in_progress, searching, incomplete или failed, Возможные значения: in_progress, searching, completed, incomplete, failed	Да
type	enum	Тип вызова средства поиска файлов. Всегда file_search_call. Возможные значения: file_search_call	Да

OpenAI.OutputItemFunctionShellCall

Вызов средства, выполняющий одну или несколько команд оболочки в управляемой среде.

Name	Type	Description	Обязательный	По умолчанию
action	OpenAI.FunctionShellAction	Выполните команду оболочки.	Да
Команды └️	массив строк		Да
└max_output_length	OpenAI.integer (nullable)		Да
└️ timeout_ms	OpenAI.integer (nullable)		Да
agent_reference	AgentReference		Нет
└️ имя	строка	Имя агента. Ограничения: maxLength: 256	Да
└─ Тип	enum	Возможные значения: agent_reference	Да
└─ Версия	строка	Идентификатор версии агента.	Нет
call_id	строка	Уникальный идентификатор вызова средства оболочки, созданного моделью.	Да
создано пользователем	строка	Идентификатор сущности, созданной этим средством.	Нет
id	строка	Уникальный идентификатор вызова средства оболочки. Заполняется, когда этот элемент возвращается через API.	Да
response_id	строка	Ответ, на котором создается элемент.	Нет
Статус	OpenAI.LocalShellCallStatus		Да
type	enum	Тип элемента. Всегда shell_call. Возможные значения: shell_call	Да

OpenAI.OutputItemFunctionShellCallOutput

Выходные данные вызова средства оболочки, который был создан.

Name	Type	Description	Обязательный	По умолчанию
agent_reference	AgentReference		Нет
└️ имя	строка	Имя агента. Ограничения: maxLength: 256	Да
└─ Тип	enum	Возможные значения: agent_reference	Да
└─ Версия	строка	Идентификатор версии агента.	Нет
call_id	строка	Уникальный идентификатор вызова средства оболочки, созданного моделью.	Да
создано пользователем	строка	Идентификатор субъекта, создавшего элемент.	Нет
id	строка	Уникальный идентификатор выходных данных вызова оболочки. Заполняется, когда этот элемент возвращается через API.	Да
max_output_length	OpenAI.integer (nullable)		Да
output	массив OpenAI.FunctionShellCallOutputContent	Массив содержимого вывода вызова оболочки	Да
response_id	строка	Ответ, на котором создается элемент.	Нет
type	enum	Тип выходных данных вызова оболочки. Всегда shell_call_output. Возможные значения: shell_call_output	Да

OpenAI.OutputItemFunctionToolCall

Вызов средства для запуска функции. Дополнительные сведения см. в руководстве по вызову функции .

Name	Type	Description	Обязательный	По умолчанию
agent_reference	AgentReference		Нет
└️ имя	строка	Имя агента. Ограничения: maxLength: 256	Да
└─ Тип	enum	Возможные значения: agent_reference	Да
└─ Версия	строка	Идентификатор версии агента.	Нет
arguments	строка	Строка JSON аргументов для передачи функции.	Да
call_id	строка	Уникальный идентификатор вызова функции, созданного моделью.	Да
id	строка	Уникальный идентификатор вызова средства функции.	Нет
имя	строка	Имя выполняемой функции.	Да
response_id	строка	Ответ, на котором создается элемент.	Нет
Статус	enum	Состояние элемента. Один из in_progress, completedили incomplete. Заполняется, когда элементы возвращаются через API. Возможные значения: in_progress, completedincomplete	Нет
type	enum	Тип вызова инструмента функции. Всегда function_call. Возможные значения: function_call	Да

OpenAI.OutputItemImageGenToolCall

Запрос на создание изображения, сделанный моделью.

Name	Type	Description	Обязательный	По умолчанию
agent_reference	AgentReference		Нет
└️ имя	строка	Имя агента. Ограничения: maxLength: 256	Да
└─ Тип	enum	Возможные значения: agent_reference	Да
└─ Версия	строка	Идентификатор версии агента.	Нет
id	строка	Уникальный идентификатор вызова создания образа.	Да
response_id	строка	Ответ, на котором создается элемент.	Нет
result	Строка (нулевая)		Да
Статус	enum	Состояние вызова создания образа. Возможные значения: in_progress, , completedgeneratingfailed	Да
type	enum	Тип вызова создания изображения. Всегда image_generation_call. Возможные значения: image_generation_call	Да

OpenAI.OutputItemLocalShellToolCall

Вызов инструмента для выполнения команды в локальной оболочке.

Name	Type	Description	Обязательный	По умолчанию
action	OpenAI.LocalShellExecAction	Выполните команду оболочки на сервере.	Да
agent_reference	AgentReference		Нет
└️ имя	строка	Имя агента. Ограничения: maxLength: 256	Да
└─ Тип	enum	Возможные значения: agent_reference	Да
└─ Версия	строка	Идентификатор версии агента.	Нет
call_id	строка	Уникальный идентификатор вызова локального утилита оболочки, сгенерированного моделью.	Да
id	строка	Уникальный идентификатор вызова локальной оболочки.	Да
response_id	строка	Ответ, на котором создается элемент.	Нет
Статус	enum	Состояние вызова локальной оболочки. Возможные значения: in_progress, completedincomplete	Да
type	enum	Тип вызова локальной оболочки. Всегда local_shell_call. Возможные значения: local_shell_call	Да

OpenAI.OutputItemMcpApprovalRequest

Запрос на одобрение человеком вызова инструмента.

Name	Type	Description	Обязательный	По умолчанию
agent_reference	AgentReference		Нет
└️ имя	строка	Имя агента. Ограничения: maxLength: 256	Да
└─ Тип	enum	Возможные значения: agent_reference	Да
└─ Версия	строка	Идентификатор версии агента.	Нет
arguments	строка	Строка JSON с аргументами для средства.	Да
id	строка	Уникальный идентификатор запроса на утверждение.	Да
имя	строка	Имя запускаемого инструмента.	Да
response_id	строка	Ответ, на котором создается элемент.	Нет
метка сервера	строка	Метка сервера MCP, выполняющего запрос.	Да
type	enum	Тип элемента. Всегда mcp_approval_request. Возможные значения: mcp_approval_request	Да

OpenAI.OutputItemMcpListTools

Список средств, доступных на сервере MCP.

Name	Type	Description	Обязательный	По умолчанию
agent_reference	AgentReference		Нет
└️ имя	строка	Имя агента. Ограничения: maxLength: 256	Да
└─ Тип	enum	Возможные значения: agent_reference	Да
└─ Версия	строка	Идентификатор версии агента.	Нет
error	Строка (нулевая)		Нет
id	строка	Уникальный идентификатор списка.	Да
response_id	строка	Ответ, на котором создается элемент.	Нет
метка сервера	строка	Метка сервера MCP.	Да
tools	массив OpenAI.MCPListToolsTools	Средства, доступные на сервере.	Да
type	enum	Тип элемента. Всегда mcp_list_tools. Возможные значения: mcp_list_tools	Да

OpenAI.OutputItemMcpToolCall

Вызов инструмента на сервере MCP.

Name	Type	Description	Обязательный	По умолчанию
agent_reference	AgentReference		Нет
└️ имя	строка	Имя агента. Ограничения: maxLength: 256	Да
└─ Тип	enum	Возможные значения: agent_reference	Да
└─ Версия	строка	Идентификатор версии агента.	Нет
approval_request_id	Строка (нулевая)		Нет
arguments	строка	Строка JSON аргументов, переданных средству.	Да
error	Строка (нулевая)		Нет
id	строка	Уникальный идентификатор вызова средства.	Да
имя	строка	Имя запущенного инструмента.	Да
output	Строка (нулевая)		Нет
response_id	строка	Ответ, на котором создается элемент.	Нет
метка сервера	строка	Метка сервера MCP, на котором работает инструмент.	Да
Статус	OpenAI.MCPToolCallStatus		Нет
type	enum	Тип элемента. Всегда mcp_call. Возможные значения: mcp_call	Да

OpenAI.OutputItemOutputMessage

Выходное сообщение из модели.

Name	Type	Description	Обязательный	По умолчанию
agent_reference	AgentReference		Нет
└️ имя	строка	Имя агента. Ограничения: maxLength: 256	Да
└─ Тип	enum	Возможные значения: agent_reference	Да
└─ Версия	строка	Идентификатор версии агента.	Нет
содержимое	массив OpenAI.OutputMessageContent	Содержимое выходного сообщения.	Да
id	строка	Уникальный идентификатор выходного сообщения.	Да
response_id	строка	Ответ, на котором создается элемент.	Нет
role	enum	Роль выходного сообщения. Всегда assistant. Возможные значения: assistant	Да
Статус	enum	Состояние входных данных сообщения. Один из in_progress, completedили incomplete. Заполняется при возврате входных элементов через API. Возможные значения: in_progress, completedincomplete	Да
type	enum	Тип выходного сообщения. Всегда message. Возможные значения: output_message	Да

OpenAI.OutputItemReasoningItem

Описание цепочки мысли, используемой моделью причин при создании ответа. Не забудьте включить эти элементы в input API ответов для последующих поворотов беседы, если вы вручную управляете контекстом.

Name	Type	Description	Обязательный	По умолчанию
agent_reference	AgentReference		Нет
└️ имя	строка	Имя агента. Ограничения: maxLength: 256	Да
└─ Тип	enum	Возможные значения: agent_reference	Да
└─ Версия	строка	Идентификатор версии агента.	Нет
содержимое	массив OpenAI.ReasoningTextContent	Обоснование текстового содержимого.	Нет
encrypted_content	Строка (нулевая)		Нет
id	строка	Уникальный идентификатор контента рассуждений.	Да
response_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 structured_outputs oauth_consent_request memory_search_call workflow_action

OpenAI.OutputItemWebSearchToolCall

Результаты вызова средства поиска в Интернете. Дополнительные сведения см. в руководстве по поиску в Интернете .

Name	Type	Description	Обязательный	По умолчанию
action	OpenAI.WebSearchActionSearch или OpenAI.WebSearchActionOpenPage или OpenAI.WebSearchActionFind	Объект, описывающий конкретные действия, выполненные в этом вызове поиска в Интернете. Содержит сведения об использовании модели в Интернете (поиск, open_page, поиск).	Да
agent_reference	AgentReference		Нет
└️ имя	строка	Имя агента. Ограничения: maxLength: 256	Да
└─ Тип	enum	Возможные значения: agent_reference	Да
└─ Версия	строка	Идентификатор версии агента.	Нет
id	строка	Уникальный идентификатор вызова средства поиска в Интернете.	Да
response_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	Да

OpenAI.OutputMessageContentRefusalContent

Отказ модели.

Name	Type	Description	Обязательный	По умолчанию
отказ	строка	Объяснение отказа модели.	Да
type	enum	Тип отказа. Всегда refusal. Возможные значения: refusal	Да

OpenAI.OutputMessageContentType

Property	Ценность
Type	строка
Значения	output_text refusal

OpenAI.Prompt

Ссылка на шаблон запроса и его переменные. Подробнее.

Name	Type	Description	Обязательный	По умолчанию
id	строка	Уникальный идентификатор используемого шаблона запроса.	Да
variables	OpenAI.ResponsePromptVariables (nullable )	Необязательная карта значений для подстановки в переменные подсказка. Значения подстановки могут быть строками или другими Типы входных данных ответа, такие как изображения или файлы.	Нет
version	Строка (нулевая)		Нет

OpenAI.RankerVersionType

Property	Ценность
Type	строка
Значения	auto default-2024-11-15

OpenAI.RankingOptions

Name	Type	Description	Обязательный	По умолчанию
hybrid_search	OpenAI.HybridSearchOptions		Нет
└️ embedding_weight	OpenAI.numeric	Вес внедрения в взаимное ранжирование слияние.	Да
└text_weight	OpenAI.numeric	Вес текста в взаимном ранжировании слиянием.	Да
офицер	OpenAI.RankerVersionType		Нет
порог оценки	OpenAI.numeric		Нет

OpenAI.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	enum	Возможные значения: auto, concisedetailed	Нет
summary	enum	Возможные значения: auto, concisedetailed	Нет

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	Ценность
Type	строка
Nullable	Да
Значения	none minimal low medium high xhigh

OpenAI.ReasoningTextContent

Вывод текста из модели.

Name	Type	Description	Обязательный	По умолчанию
text	строка	Текст причины из модели.	Да
type	enum	Тип текста причины. Всегда reasoning_text. Возможные значения: reasoning_text	Да

OpenAI.Response

Name	Type	Description	Обязательный	По умолчанию
agent_reference	AgentReference (nullable)		Да
└️ имя	строка	Имя агента. Ограничения: maxLength: 256	Да
└─ Тип	enum	Возможные значения: agent_reference	Да
└─ Версия	строка	Идентификатор версии агента.	Нет
фон	Булев (нулируемый)		Нет
завершено_в	целое число		Нет
разговор	OpenAI.ConversationReference (допускает значение NULL)	Беседа, к которой относится этот ответ. Входные элементы и выходные элементы из этого ответа были автоматически добавлены в эту беседу.	Нет
Идентификатор └️	строка	Уникальный идентификатор беседы, с которым связан этот ответ.	Да
создано_в	целое число	Метка времени в формате Unix (в секундах), когда был создан этот ответ.	Да
error	OpenAI.ResponseError (nullable)	Объект ошибки, возвращаемый, когда модель не сможет создать ответ.	Да
└─ Код	OpenAI.ResponseErrorCode	Код ошибки для ответа.	Да
Сообщение └️	строка	Описание ошибки, доступной для чтения человеком.	Да
id	строка	Уникальный идентификатор для этого ответа.	Да
incomplete_details	OpenAI.ResponseIncompleteDetails (nullable)		Да
└─ Причина	enum	Возможные значения: max_output_tokens, content_filter	Нет
instructions	строка или массив OpenAI.InputItem		Да
max_output_tokens	OpenAI.integer (nullable)		Нет
max_tool_calls	OpenAI.integer (nullable)		Нет
metadata	OpenAI.Metadata (nullable)	Набор из 16 пар "ключ-значение", которые можно прикрепить к объекту. Это может быть Полезно для хранения дополнительных сведений об объекте в структурированном виде. форматирование и запрос объектов через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — строки с максимальной длиной 512 символов.	Нет
модель	строка	Развертывание модели, используемое для создания этого ответа.	Нет
object	enum	Тип объекта этого ресурса — всегда установлено response. Возможные значения: response	Да
output	массив OpenAI.OutputItem	Массив элементов контента, созданных моделью. — Длина и порядок элементов в массиве output зависят в ответе модели. — Вместо доступа к первому элементу массива output и Предположим, что это assistant сообщение с содержанием, созданным Вы можете рассмотреть возможность использования свойства output_text модели, если поддерживается в пакетах SDK.	Да
output_text	Строка (нулевая)		Нет
вызовы инструмента в параллельном режиме	boolean	Следует ли разрешить модели запускать вызовы инструментов параллельно.	Да	True
previous_response_id	Строка (нулевая)		Нет
prompt	OpenAI.Prompt	Ссылка на шаблон запроса и его переменные. Подробнее.	Нет
prompt_cache_key	строка	Используется OpenAI для кэширования ответов для аналогичных запросов для оптимизации частоты попаданий кэша. Заменяет user поле. Подробнее.	Нет
prompt_cache_retention	enum	Возможные значения: in-memory, 24h	Нет
reasoning	OpenAI.Reasoning (nullable)	Только модели gpt-5 и o-series Параметры конфигурации для модели рассуждений.	Нет
- усилия	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	enum	Возможные значения: auto, concisedetailed	Нет
└️ сводка	enum	Возможные значения: auto, concisedetailed	Нет
safety_identifier	строка	Стабильный идентификатор, используемый для обнаружения пользователей приложения, которые могут нарушать политики использования OpenAI. Идентификаторы должны быть строкой, которая однозначно идентифицирует каждого пользователя. Мы рекомендуем хэшировать имя пользователя или адрес электронной почты, чтобы избежать отправки нам каких-либо сведений об идентификации. Подробнее.	Нет
уровень обслуживания	OpenAI.ServiceTier	Указывает тип обработки, используемый для обслуживания запроса. — Если задано значение auto, запрос будет обработан с уровнем служб, настроенным в параметрах Project. Если иное не настроено, Project будет использовать значение по умолчанию. — Если задано значение "по умолчанию", запрос будет обработан со стандартными ценами и производительностью выбранной модели. — Если задано значение "flex" или "приоритет", запрос будет обработан соответствующим уровнем служб. — Если не задано, поведение по умолчанию — auto. service_tier Если параметр задан, текст ответа будет включать service_tier значение на основе режима обработки, который фактически использовался для обслуживания запроса. Это значение ответа может отличаться от значения, заданного в параметре.	Нет
Статус	enum	Статус формирования ответа. Один из completed, failed in_progress, cancelled, queued или incomplete. Возможные значения: completed, failed, in_progress, cancelled, queued, incomplete	Нет
Температура	OpenAI.numeric (nullable)		Нет	1
text	OpenAI.ResponseTextParam	Параметры конфигурации для текстового ответа модели. Может быть простым текстовые или структурированные данные JSON. Подробнее: - Текстовые входные и выходные данные - Структурированные выходные данные	Нет
выбор инструмента	OpenAI.ToolChoiceOptions или OpenAI.ToolChoiceParam		Нет
tools	OpenAI.ToolsArray	Массив инструментов, которые модель может вызывать при создании ответа. Вы может указать, какое средство следует использовать, задав tool_choice параметр. Мы поддерживаем следующие категории инструментов: - Встроенные инструменты: инструменты, предоставляемые OpenAI для расширения Возможности модели, такие как поиск в Интернете или поиск по файлам. Дополнительные сведения встроенные средства. - Инструменты MCP: интеграция с сторонними системами с помощью пользовательских серверов MCP или предопределенные соединители, такие как Google Drive и SharePoint. Дополнительные сведения Инструменты MCP. - Вызовы функций (пользовательские средства): функции, определенные вами, включение модели для вызова собственного кода с строго типизированными аргументами и выходные данные. Дополнительные сведения вызов функции. Вы также можете использовать пользовательские средства для вызова собственного кода.	Нет
top_logprobs	OpenAI.integer (nullable)		Нет
top_p	OpenAI.numeric (nullable)		Нет	1
truncation	enum	Возможные значения: auto, disabled	Нет
использование	OpenAI.ResponseUsage	Представляет сведения об использовании маркеров, включая входные маркеры, выходные маркеры, разбивка выходных маркеров и общих используемых маркеров.	Нет
user	string (не рекомендуется)	Это поле заменяется safety_identifier и prompt_cache_key. Вместо этого используйте prompt_cache_key для поддержания оптимизации кэширования. Стабильный идентификатор для конечных пользователей. Используется для повышения скорости попадания кэша в более эффективное сегментирование аналогичных запросов и помогает OpenAI обнаруживать и предотвращать злоупотребление. Подробнее.	Нет

OpenAI.ResponseAudioDeltaEvent

Выдается при наличии частичного аудиореспонса.

Name	Type	Description	Обязательный	По умолчанию
delta	строка	Блок аудиобайтов, закодированных в формате Base64.	Да
sequence_number	OpenAI.integer		Да
type	enum	тип события; Всегда response.audio.delta. Возможные значения: response.audio.delta	Да

OpenAI.ResponseAudioDoneEvent

Излучается при завершении аудиоответа.

Name	Type	Description	Обязательный	По умолчанию
sequence_number	OpenAI.integer		Да
type	enum	тип события; Всегда response.audio.done. Возможные значения: response.audio.done	Да

OpenAI.ResponseAudioTranscriptDeltaEvent

Выдается при частичной расшифровке звука.

Name	Type	Description	Обязательный	По умолчанию
delta	строка	Частичная расшифровка аудиоответа.	Да
sequence_number	OpenAI.integer		Да
type	enum	тип события; Всегда response.audio.transcript.delta. Возможные значения: response.audio.transcript.delta	Да

OpenAI.ResponseAudioTranscriptDoneEvent

Издается при завершении полной расшифровки аудио.

Name	Type	Description	Обязательный	По умолчанию
sequence_number	OpenAI.integer		Да
type	enum	тип события; Всегда response.audio.transcript.done. Возможные значения: response.audio.transcript.done	Да

OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent

Создается при потоковой передаче фрагмента частичного кода интерпретатором кода.

Name	Type	Description	Обязательный	По умолчанию
delta	строка	Фрагмент частичного кода, передаваемый интерпретатором кода.	Да
item_id	строка	Уникальный идентификатор элемента вызова средства интерпретатора кода.	Да
output_index	OpenAI.integer		Да
sequence_number	OpenAI.integer		Да
type	enum	тип события; Всегда response.code_interpreter_call_code.delta. Возможные значения: response.code_interpreter_call_code.delta	Да

OpenAI.ResponseCodeInterpreterCallCodeDoneEvent

Создается при завершении фрагмента кода интерпретатором кода.

Name	Type	Description	Обязательный	По умолчанию
code	строка	Окончательный фрагмент кода выводится интерпретатором кода.	Да
item_id	строка	Уникальный идентификатор элемента вызова средства интерпретатора кода.	Да
output_index	OpenAI.integer		Да
sequence_number	OpenAI.integer		Да
type	enum	тип события; Всегда response.code_interpreter_call_code.done. Возможные значения: response.code_interpreter_call_code.done	Да

OpenAI.ResponseCodeInterpreterCallCompletedEvent

Эмитируется при завершении вызова интерпретатора кода.

Name	Type	Description	Обязательный	По умолчанию
item_id	строка	Уникальный идентификатор элемента вызова средства интерпретатора кода.	Да
output_index	OpenAI.integer		Да
sequence_number	OpenAI.integer		Да
type	enum	тип события; Всегда response.code_interpreter_call.completed. Возможные значения: response.code_interpreter_call.completed	Да

OpenAI.ResponseCodeInterpreterCallInProgressEvent

Срабатывает при выполнении вызова интерпретатора кода.

Name	Type	Description	Обязательный	По умолчанию
item_id	строка	Уникальный идентификатор элемента вызова средства интерпретатора кода.	Да
output_index	OpenAI.integer		Да
sequence_number	OpenAI.integer		Да
type	enum	тип события; Всегда response.code_interpreter_call.in_progress. Возможные значения: response.code_interpreter_call.in_progress	Да

OpenAI.ResponseCodeInterpreterCallInterpretingEvent

Создается, когда интерпретатор кода активно интерпретирует фрагмент кода.

Name	Type	Description	Обязательный	По умолчанию
item_id	строка	Уникальный идентификатор элемента вызова средства интерпретатора кода.	Да
output_index	OpenAI.integer		Да
sequence_number	OpenAI.integer		Да
type	enum	тип события; Всегда response.code_interpreter_call.interpreting. Возможные значения: response.code_interpreter_call.interpreting	Да

OpenAI.ResponseCompletedEvent

Выдается при завершении ответа модели.

Name	Type	Description	Обязательный	По умолчанию
response	OpenAI.Response		Да
└agent_reference	AgentReference (nullable)	Агент, используемый для этого ответа	Да
└─ Фон	Булев (нулируемый)		Нет
└️ completed_at	целое число (nullable)		Нет
Беседа └️	OpenAI.ConversationReference (допускает значение NULL)	Беседа, к которой относится этот ответ. Входные элементы и выходные элементы из этого ответа были автоматически добавлены в эту беседу.	Нет
└️ created_at	целое число	Метка времени в формате Unix (в секундах), когда был создан этот ответ.	Да
└─ Ошибка	OpenAI.ResponseError (nullable)	Объект ошибки, возвращаемый, когда модель не сможет создать ответ.	Да
Идентификатор └️	строка	Уникальный идентификатор для этого ответа.	Да
└️ incomplete_details	OpenAI.ResponseIncompleteDetails (nullable)		Да
└ Инструкции	строка или массив OpenAI.InputItem (nullable)		Да
└️ max_output_tokens	OpenAI.integer (nullable)		Нет
└️ max_tool_calls	OpenAI.integer (nullable)		Нет
└─ Метаданные	OpenAI.Metadata (nullable)	Набор из 16 пар "ключ-значение", которые можно прикрепить к объекту. Это может быть Полезно для хранения дополнительных сведений об объекте в структурированном виде. форматирование и запрос объектов через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — строки с максимальной длиной 512 символов.	Нет
└─ Модель	строка	Развертывание модели, используемое для создания этого ответа.	Нет
└─ Объект	enum	Тип объекта этого ресурса — всегда установлено response. Возможные значения: response	Да
вывод └─	массив OpenAI.OutputItem	Массив элементов контента, созданных моделью. — Длина и порядок элементов в массиве output зависят в ответе модели. — Вместо доступа к первому элементу массива output и Предположим, что это assistant сообщение с содержанием, созданным Вы можете рассмотреть возможность использования свойства output_text модели, если поддерживается в пакетах SDK.	Да
└️ output_text	Строка (нулевая)		Нет
└─ вызовы_инструментов_в_параллельном_режиме	boolean	Следует ли разрешить модели запускать вызовы инструментов параллельно.	Да	True
└previous_response_id	Строка (нулевая)		Нет
└─ Запрос	OpenAI.Prompt	Ссылка на шаблон запроса и его переменные. Подробнее.	Нет
└prompt_cache_key	строка	Используется OpenAI для кэширования ответов для аналогичных запросов для оптимизации частоты попаданий кэша. Заменяет user поле. Подробнее.	Нет
└prompt_cache_retention	enum	Возможные значения: in-memory, 24h	Нет
└─ рассуждения	OpenAI.Reasoning (nullable)	Только модели gpt-5 и o-series Параметры конфигурации для модели рассуждений.	Нет
└safety_identifier	строка	Стабильный идентификатор, используемый для обнаружения пользователей приложения, которые могут нарушать политики использования OpenAI. Идентификаторы должны быть строкой, которая однозначно идентифицирует каждого пользователя. Мы рекомендуем хэшировать имя пользователя или адрес электронной почты, чтобы избежать отправки нам каких-либо сведений об идентификации. Подробнее.	Нет
└service_tier	OpenAI.ServiceTier	Указывает тип обработки, используемый для обслуживания запроса. — Если задано значение auto, запрос будет обработан с уровнем служб, настроенным в параметрах Project. Если иное не настроено, Project будет использовать значение по умолчанию. — Если задано значение "по умолчанию", запрос будет обработан со стандартными ценами и производительностью выбранной модели. — Если задано значение "flex" или "приоритет", запрос будет обработан соответствующим уровнем служб. — Если не задано, поведение по умолчанию — auto. service_tier Если параметр задан, текст ответа будет включать service_tier значение на основе режима обработки, который фактически использовался для обслуживания запроса. Это значение ответа может отличаться от значения, заданного в параметре.	Нет
└─ Состояние	enum	Статус формирования ответа. Один из completed, failed in_progress, cancelled, queued или incomplete. Возможные значения: completed, failed, in_progress, cancelled, queued, incomplete	Нет
└─ Температура	OpenAI.numeric (nullable)		Нет	1
Текст └️	OpenAI.ResponseTextParam	Параметры конфигурации для текстового ответа модели. Может быть простым текстовые или структурированные данные JSON. Подробнее: - Текстовые входные и выходные данные - Структурированные выходные данные	Нет
└─ выбор_инструмента	OpenAI.ToolChoiceOptions или OpenAI.ToolChoiceParam		Нет
└─ Инструменты	OpenAI.ToolsArray	Массив инструментов, которые модель может вызывать при создании ответа. Вы может указать, какое средство следует использовать, задав tool_choice параметр. Мы поддерживаем следующие категории инструментов: - Встроенные инструменты: инструменты, предоставляемые OpenAI для расширения Возможности модели, такие как поиск в Интернете или поиск по файлам. Дополнительные сведения встроенные средства. - Инструменты MCP: интеграция с сторонними системами с помощью пользовательских серверов MCP или предопределенные соединители, такие как Google Drive и SharePoint. Дополнительные сведения Инструменты MCP. - Вызовы функций (пользовательские средства): функции, определенные вами, включение модели для вызова собственного кода с строго типизированными аргументами и выходные данные. Дополнительные сведения вызов функции. Вы также можете использовать пользовательские средства для вызова собственного кода.	Нет
└️ top_logprobs	OpenAI.integer (nullable)		Нет
└️ top_p	OpenAI.numeric (nullable)		Нет	1
└️ усечение	enum	Возможные значения: auto, disabled	Нет
└─ использование	OpenAI.ResponseUsage	Представляет сведения об использовании маркеров, включая входные маркеры, выходные маркеры, разбивка выходных маркеров и общих используемых маркеров.	Нет
Пользователь └️	string (не рекомендуется)	Это поле заменяется safety_identifier и prompt_cache_key. Вместо этого используйте prompt_cache_key для поддержания оптимизации кэширования. Стабильный идентификатор для конечных пользователей. Используется для повышения скорости попадания кэша в более эффективное сегментирование аналогичных запросов и помогает OpenAI обнаруживать и предотвращать злоупотребление. Подробнее.	Нет
sequence_number	OpenAI.integer		Да
type	enum	тип события; Всегда response.completed. Возможные значения: response.completed	Да

OpenAI.ResponseContentPartAddedEvent

Вызывается при добавлении новой части содержимого.

Name	Type	Description	Обязательный	По умолчанию
content_index	OpenAI.integer		Да
item_id	строка	Идентификатор выходного элемента, к которому была добавлена часть содержимого.	Да
output_index	OpenAI.integer		Да
part	OpenAI.OutputContent		Да
└─ Тип	OpenAI.OutputContentType		Да
sequence_number	OpenAI.integer		Да
type	enum	тип события; Всегда response.content_part.added. Возможные значения: response.content_part.added	Да

OpenAI.ResponseContentPartDoneEvent

Выдается при завершении части содержимого.

Name	Type	Description	Обязательный	По умолчанию
content_index	OpenAI.integer		Да
item_id	строка	Идентификатор выходного элемента, к которому была добавлена часть содержимого.	Да
output_index	OpenAI.integer		Да
part	OpenAI.OutputContent		Да
└─ Тип	OpenAI.OutputContentType		Да
sequence_number	OpenAI.integer		Да
type	enum	тип события; Всегда response.content_part.done. Возможные значения: response.content_part.done	Да

OpenAI.ResponseCreatedEvent

Событие, которое эмитируется при создании ответа.

Name	Type	Description	Обязательный	По умолчанию
response	OpenAI.Response		Да
└agent_reference	AgentReference (nullable)	Агент, используемый для этого ответа	Да
└─ Фон	Булев (нулируемый)		Нет
└️ completed_at	целое число (nullable)		Нет
Беседа └️	OpenAI.ConversationReference (допускает значение NULL)	Беседа, к которой относится этот ответ. Входные элементы и выходные элементы из этого ответа были автоматически добавлены в эту беседу.	Нет
└️ created_at	целое число	Метка времени в формате Unix (в секундах), когда был создан этот ответ.	Да
└─ Ошибка	OpenAI.ResponseError (nullable)	Объект ошибки, возвращаемый, когда модель не сможет создать ответ.	Да
Идентификатор └️	строка	Уникальный идентификатор для этого ответа.	Да
└️ incomplete_details	OpenAI.ResponseIncompleteDetails (nullable)		Да
└ Инструкции	строка или массив OpenAI.InputItem (nullable)		Да
└️ max_output_tokens	OpenAI.integer (nullable)		Нет
└️ max_tool_calls	OpenAI.integer (nullable)		Нет
└─ Метаданные	OpenAI.Metadata (nullable)	Набор из 16 пар "ключ-значение", которые можно прикрепить к объекту. Это может быть Полезно для хранения дополнительных сведений об объекте в структурированном виде. форматирование и запрос объектов через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — строки с максимальной длиной 512 символов.	Нет
└─ Модель	строка	Развертывание модели, используемое для создания этого ответа.	Нет
└─ Объект	enum	Тип объекта этого ресурса — всегда установлено response. Возможные значения: response	Да
вывод └─	массив OpenAI.OutputItem	Массив элементов контента, созданных моделью. — Длина и порядок элементов в массиве output зависят в ответе модели. — Вместо доступа к первому элементу массива output и Предположим, что это assistant сообщение с содержанием, созданным Вы можете рассмотреть возможность использования свойства output_text модели, если поддерживается в пакетах SDK.	Да
└️ output_text	Строка (нулевая)		Нет
└─ вызовы_инструментов_в_параллельном_режиме	boolean	Следует ли разрешить модели запускать вызовы инструментов параллельно.	Да	True
└previous_response_id	Строка (нулевая)		Нет
└─ Запрос	OpenAI.Prompt	Ссылка на шаблон запроса и его переменные. Подробнее.	Нет
└prompt_cache_key	строка	Используется OpenAI для кэширования ответов для аналогичных запросов для оптимизации частоты попаданий кэша. Заменяет user поле. Подробнее.	Нет
└prompt_cache_retention	enum	Возможные значения: in-memory, 24h	Нет
└─ рассуждения	OpenAI.Reasoning (nullable)	Только модели gpt-5 и o-series Параметры конфигурации для модели рассуждений.	Нет
└safety_identifier	строка	Стабильный идентификатор, используемый для обнаружения пользователей приложения, которые могут нарушать политики использования OpenAI. Идентификаторы должны быть строкой, которая однозначно идентифицирует каждого пользователя. Мы рекомендуем хэшировать имя пользователя или адрес электронной почты, чтобы избежать отправки нам каких-либо сведений об идентификации. Подробнее.	Нет
└service_tier	OpenAI.ServiceTier	Указывает тип обработки, используемый для обслуживания запроса. — Если задано значение auto, запрос будет обработан с уровнем служб, настроенным в параметрах Project. Если иное не настроено, Project будет использовать значение по умолчанию. — Если задано значение "по умолчанию", запрос будет обработан со стандартными ценами и производительностью выбранной модели. — Если задано значение "flex" или "приоритет", запрос будет обработан соответствующим уровнем служб. — Если не задано, поведение по умолчанию — auto. service_tier Если параметр задан, текст ответа будет включать service_tier значение на основе режима обработки, который фактически использовался для обслуживания запроса. Это значение ответа может отличаться от значения, заданного в параметре.	Нет
└─ Состояние	enum	Статус формирования ответа. Один из completed, failed in_progress, cancelled, queued или incomplete. Возможные значения: completed, failed, in_progress, cancelled, queued, incomplete	Нет
└─ Температура	OpenAI.numeric (nullable)		Нет	1
Текст └️	OpenAI.ResponseTextParam	Параметры конфигурации для текстового ответа модели. Может быть простым текстовые или структурированные данные JSON. Подробнее: - Текстовые входные и выходные данные - Структурированные выходные данные	Нет
└─ выбор_инструмента	OpenAI.ToolChoiceOptions или OpenAI.ToolChoiceParam		Нет
└─ Инструменты	OpenAI.ToolsArray	Массив инструментов, которые модель может вызывать при создании ответа. Вы может указать, какое средство следует использовать, задав tool_choice параметр. Мы поддерживаем следующие категории инструментов: - Встроенные инструменты: инструменты, предоставляемые OpenAI для расширения Возможности модели, такие как поиск в Интернете или поиск по файлам. Дополнительные сведения встроенные средства. - Инструменты MCP: интеграция с сторонними системами с помощью пользовательских серверов MCP или предопределенные соединители, такие как Google Drive и SharePoint. Дополнительные сведения Инструменты MCP. - Вызовы функций (пользовательские средства): функции, определенные вами, включение модели для вызова собственного кода с строго типизированными аргументами и выходные данные. Дополнительные сведения вызов функции. Вы также можете использовать пользовательские средства для вызова собственного кода.	Нет
└️ top_logprobs	OpenAI.integer (nullable)		Нет
└️ top_p	OpenAI.numeric (nullable)		Нет	1
└️ усечение	enum	Возможные значения: auto, disabled	Нет
└─ использование	OpenAI.ResponseUsage	Представляет сведения об использовании маркеров, включая входные маркеры, выходные маркеры, разбивка выходных маркеров и общих используемых маркеров.	Нет
Пользователь └️	string (не рекомендуется)	Это поле заменяется safety_identifier и prompt_cache_key. Вместо этого используйте prompt_cache_key для поддержания оптимизации кэширования. Стабильный идентификатор для конечных пользователей. Используется для повышения скорости попадания кэша в более эффективное сегментирование аналогичных запросов и помогает OpenAI обнаруживать и предотвращать злоупотребление. Подробнее.	Нет
sequence_number	OpenAI.integer		Да
type	enum	тип события; Всегда response.created. Возможные значения: response.created	Да

OpenAI.ResponseCustomToolCallInputDeltaEvent

Событие, представляющее разностное (частичное обновление) для ввода пользовательского вызова средства.

Name	Type	Description	Обязательный	По умолчанию
delta	строка	Добавочные входные данные (delta) для вызова пользовательского средства.	Да
item_id	строка	Уникальный идентификатор элемента API, связанного с этим событием.	Да
output_index	OpenAI.integer		Да
sequence_number	OpenAI.integer		Да
type	enum	Идентификатор типа события. Возможные значения: response.custom_tool_call_input.delta	Да

OpenAI.ResponseCustomToolCallInputDoneEvent

Событие, указывающее, что входные данные для вызова пользовательского средства завершены.

Name	Type	Description	Обязательный	По умолчанию
input	строка	Полные входные данные для вызова пользовательского средства.	Да
item_id	строка	Уникальный идентификатор элемента API, связанного с этим событием.	Да
output_index	OpenAI.integer		Да
sequence_number	OpenAI.integer		Да
type	enum	Идентификатор типа события. Возможные значения: response.custom_tool_call_input.done	Да

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	Строка (нулевая)		Да
message	строка	Сообщение об ошибке.	Да
параметр	Строка (нулевая)		Да
sequence_number	OpenAI.integer		Да
type	enum	тип события; Всегда error. Возможные значения: error	Да

OpenAI.ResponseFailedEvent

Событие, которое возникает при сбое ответа.

Name	Type	Description	Обязательный	По умолчанию
response	OpenAI.Response		Да
└agent_reference	AgentReference (nullable)	Агент, используемый для этого ответа	Да
└─ Фон	Булев (нулируемый)		Нет
└️ completed_at	целое число (nullable)		Нет
Беседа └️	OpenAI.ConversationReference (допускает значение NULL)	Беседа, к которой относится этот ответ. Входные элементы и выходные элементы из этого ответа были автоматически добавлены в эту беседу.	Нет
└️ created_at	целое число	Метка времени в формате Unix (в секундах), когда был создан этот ответ.	Да
└─ Ошибка	OpenAI.ResponseError (nullable)	Объект ошибки, возвращаемый, когда модель не сможет создать ответ.	Да
Идентификатор └️	строка	Уникальный идентификатор для этого ответа.	Да
└️ incomplete_details	OpenAI.ResponseIncompleteDetails (nullable)		Да
└ Инструкции	строка или массив OpenAI.InputItem (nullable)		Да
└️ max_output_tokens	OpenAI.integer (nullable)		Нет
└️ max_tool_calls	OpenAI.integer (nullable)		Нет
└─ Метаданные	OpenAI.Metadata (nullable)	Набор из 16 пар "ключ-значение", которые можно прикрепить к объекту. Это может быть Полезно для хранения дополнительных сведений об объекте в структурированном виде. форматирование и запрос объектов через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — строки с максимальной длиной 512 символов.	Нет
└─ Модель	строка	Развертывание модели, используемое для создания этого ответа.	Нет
└─ Объект	enum	Тип объекта этого ресурса — всегда установлено response. Возможные значения: response	Да
вывод └─	массив OpenAI.OutputItem	Массив элементов контента, созданных моделью. — Длина и порядок элементов в массиве output зависят в ответе модели. — Вместо доступа к первому элементу массива output и Предположим, что это assistant сообщение с содержанием, созданным Вы можете рассмотреть возможность использования свойства output_text модели, если поддерживается в пакетах SDK.	Да
└️ output_text	Строка (нулевая)		Нет
└─ вызовы_инструментов_в_параллельном_режиме	boolean	Следует ли разрешить модели запускать вызовы инструментов параллельно.	Да	True
└previous_response_id	Строка (нулевая)		Нет
└─ Запрос	OpenAI.Prompt	Ссылка на шаблон запроса и его переменные. Подробнее.	Нет
└prompt_cache_key	строка	Используется OpenAI для кэширования ответов для аналогичных запросов для оптимизации частоты попаданий кэша. Заменяет user поле. Подробнее.	Нет
└prompt_cache_retention	enum	Возможные значения: in-memory, 24h	Нет
└─ рассуждения	OpenAI.Reasoning (nullable)	Только модели gpt-5 и o-series Параметры конфигурации для модели рассуждений.	Нет
└safety_identifier	строка	Стабильный идентификатор, используемый для обнаружения пользователей приложения, которые могут нарушать политики использования OpenAI. Идентификаторы должны быть строкой, которая однозначно идентифицирует каждого пользователя. Мы рекомендуем хэшировать имя пользователя или адрес электронной почты, чтобы избежать отправки нам каких-либо сведений об идентификации. Подробнее.	Нет
└service_tier	OpenAI.ServiceTier	Указывает тип обработки, используемый для обслуживания запроса. — Если задано значение auto, запрос будет обработан с уровнем служб, настроенным в параметрах Project. Если иное не настроено, Project будет использовать значение по умолчанию. — Если задано значение "по умолчанию", запрос будет обработан со стандартными ценами и производительностью выбранной модели. — Если задано значение "flex" или "приоритет", запрос будет обработан соответствующим уровнем служб. — Если не задано, поведение по умолчанию — auto. service_tier Если параметр задан, текст ответа будет включать service_tier значение на основе режима обработки, который фактически использовался для обслуживания запроса. Это значение ответа может отличаться от значения, заданного в параметре.	Нет
└─ Состояние	enum	Статус формирования ответа. Один из completed, failed in_progress, cancelled, queued или incomplete. Возможные значения: completed, failed, in_progress, cancelled, queued, incomplete	Нет
└─ Температура	OpenAI.numeric (nullable)		Нет	1
Текст └️	OpenAI.ResponseTextParam	Параметры конфигурации для текстового ответа модели. Может быть простым текстовые или структурированные данные JSON. Подробнее: - Текстовые входные и выходные данные - Структурированные выходные данные	Нет
└─ выбор_инструмента	OpenAI.ToolChoiceOptions или OpenAI.ToolChoiceParam		Нет
└─ Инструменты	OpenAI.ToolsArray	Массив инструментов, которые модель может вызывать при создании ответа. Вы может указать, какое средство следует использовать, задав tool_choice параметр. Мы поддерживаем следующие категории инструментов: - Встроенные инструменты: инструменты, предоставляемые OpenAI для расширения Возможности модели, такие как поиск в Интернете или поиск по файлам. Дополнительные сведения встроенные средства. - Инструменты MCP: интеграция с сторонними системами с помощью пользовательских серверов MCP или предопределенные соединители, такие как Google Drive и SharePoint. Дополнительные сведения Инструменты MCP. - Вызовы функций (пользовательские средства): функции, определенные вами, включение модели для вызова собственного кода с строго типизированными аргументами и выходные данные. Дополнительные сведения вызов функции. Вы также можете использовать пользовательские средства для вызова собственного кода.	Нет
└️ top_logprobs	OpenAI.integer (nullable)		Нет
└️ top_p	OpenAI.numeric (nullable)		Нет	1
└️ усечение	enum	Возможные значения: auto, disabled	Нет
└─ использование	OpenAI.ResponseUsage	Представляет сведения об использовании маркеров, включая входные маркеры, выходные маркеры, разбивка выходных маркеров и общих используемых маркеров.	Нет
Пользователь └️	string (не рекомендуется)	Это поле заменяется safety_identifier и prompt_cache_key. Вместо этого используйте prompt_cache_key для поддержания оптимизации кэширования. Стабильный идентификатор для конечных пользователей. Используется для повышения скорости попадания кэша в более эффективное сегментирование аналогичных запросов и помогает OpenAI обнаруживать и предотвращать злоупотребление. Подробнее.	Нет
sequence_number	OpenAI.integer		Да
type	enum	тип события; Всегда response.failed. Возможные значения: response.failed	Да

OpenAI.ResponseFileSearchCallCompletedEvent

Создается при завершении вызова поиска файлов (найденные результаты).

Name	Type	Description	Обязательный	По умолчанию
item_id	строка	Идентификатор выходного элемента, инициируемого вызовом поиска файлов.	Да
output_index	OpenAI.integer		Да
sequence_number	OpenAI.integer		Да
type	enum	тип события; Всегда response.file_search_call.completed. Возможные значения: response.file_search_call.completed	Да

OpenAI.ResponseFileSearchCallInProgressEvent

Срабатывает при инициализации вызова поиска файлов.

Name	Type	Description	Обязательный	По умолчанию
item_id	строка	Идентификатор выходного элемента, инициируемого вызовом поиска файлов.	Да
output_index	OpenAI.integer		Да
sequence_number	OpenAI.integer		Да
type	enum	тип события; Всегда response.file_search_call.in_progress. Возможные значения: response.file_search_call.in_progress	Да

OpenAI.ResponseFileSearchCallSearchingEvent

Генерируется во время текущего поиска файла.

Name	Type	Description	Обязательный	По умолчанию
item_id	строка	Идентификатор выходного элемента, инициируемого вызовом поиска файлов.	Да
output_index	OpenAI.integer		Да
sequence_number	OpenAI.integer		Да
type	enum	тип события; Всегда response.file_search_call.searching. Возможные значения: response.file_search_call.searching	Да

OpenAI.ResponseFormatJsonObject

Формат отклика объекта JSON. Старый метод создания ответов JSON. Рекомендуется использовать json_schema для моделей, поддерживающих его. Обратите внимание, что модель не будет создавать JSON без системного или пользовательского сообщения, которое дает ей соответствующую команду.

Name	Type	Description	Обязательный	По умолчанию
type	enum	Тип определяемого формата ответа. Всегда json_object. Возможные значения: json_object	Да

OpenAI.ResponseFormatJsonSchema

Формат ответа схемы JSON. Используется для создания структурированных ответов JSON. Дополнительные сведения о структурированных выходных данных.

Name	Type	Description	Обязательный	По умолчанию
JSON-схема	OpenAI.ResponseFormatJsonSchemaJsonSchemaSchema		Да
└─ Описание	строка		Нет
└️ имя	строка		Да
└─ Схема	OpenAI.ResponseFormatJsonSchema	Схема формата ответа, описанная как объект схемы JSON. Узнайте, как создать схемы JSON здесь.	Нет
└─ строгий	Булев (нулируемый)		Нет
type	enum	Тип определяемого формата ответа. Всегда json_schema. Возможные значения: json_schema	Да

OpenAI.ResponseFormatJsonSchemaJsonSchemaSchema

Name	Type	Description	Обязательный	По умолчанию
описание	строка		Нет
имя	строка		Да
schema	OpenAI.ResponseFormatJsonSchema	Схема формата ответа, описанная как объект схемы JSON. Узнайте, как создать схемы JSON здесь.	Нет
строгий	Булев (нулируемый)		Нет

OpenAI.ResponseFormatJsonSchema

Схема формата ответа, описанная как объект схемы JSON. Узнайте, как создать схемы JSON здесь.

Тип: объект

OpenAI.ResponseFormatText

Формат ответа по умолчанию. Используется для создания текстовых ответов.

Name	Type	Description	Обязательный	По умолчанию
type	enum	Тип определяемого формата ответа. Всегда text. Возможные значения: text	Да

OpenAI.ResponseFunctionCallArgumentsDeltaEvent

Создается при наличии разностных аргументов вызова функции.

Name	Type	Description	Обязательный	По умолчанию
delta	строка	Добавлен аргумент вызова функции, представляющий дельту.	Да
item_id	строка	Идентификатор выходного элемента, к которому добавляется дельта аргументов вызова функции.	Да
output_index	OpenAI.integer		Да
sequence_number	OpenAI.integer		Да
type	enum	тип события; Всегда response.function_call_arguments.delta. Возможные значения: response.function_call_arguments.delta	Да

OpenAI.ResponseFunctionCallArgumentsDoneEvent

Вызывается, когда аргументы вызова функции завершены.

Name	Type	Description	Обязательный	По умолчанию
arguments	строка	Аргументы вызова функции.	Да
item_id	строка	Идентификатор элемента.	Да
имя	строка	Название функции, которую вызывали.	Да
output_index	OpenAI.integer		Да
sequence_number	OpenAI.integer		Да
type	enum	Возможные значения: response.function_call_arguments.done	Да

OpenAI.ResponseImageGenCallCompletedEvent

Сигнализируется при завершении вызова инструмента генерации изображений и доступности окончательного изображения.

Name	Type	Description	Обязательный	По умолчанию
item_id	строка	Уникальный идентификатор обрабатываемого элемента создания изображения.	Да
output_index	OpenAI.integer		Да
sequence_number	OpenAI.integer		Да
type	enum	тип события; Всегда "response.image_generation_call.completed". Возможные значения: response.image_generation_call.completed	Да

OpenAI.ResponseImageGenCallGeneratingEvent

При вызове средства генерации изображений происходит генерация изображения (промежуточное состояние).

Name	Type	Description	Обязательный	По умолчанию
item_id	строка	Уникальный идентификатор обрабатываемого элемента создания изображения.	Да
output_index	OpenAI.integer		Да
sequence_number	OpenAI.integer		Да
type	enum	тип события; Всегда «response.image_generation_call.generating». Возможные значения: response.image_generation_call.generating	Да

OpenAI.ResponseImageGenCallInProgressEvent

Излучается, когда происходит вызов средства создания изображений.

Name	Type	Description	Обязательный	По умолчанию
item_id	строка	Уникальный идентификатор обрабатываемого элемента создания изображения.	Да
output_index	OpenAI.integer		Да
sequence_number	OpenAI.integer		Да
type	enum	тип события; Всегда «response.image_generation_call.in_progress». Возможные значения: response.image_generation_call.in_progress	Да

OpenAI.ResponseImageGenCallPartialImageEvent

Создается при наличии частичного образа во время потоковой передачи изображений.

Name	Type	Description	Обязательный	По умолчанию
item_id	строка	Уникальный идентификатор обрабатываемого элемента создания изображения.	Да
output_index	OpenAI.integer		Да
partial_image_b64	строка	Данные частичного изображения в кодировке Base64, которые могут быть отображены как изображение.	Да
partial_image_index	OpenAI.integer		Да
sequence_number	OpenAI.integer		Да
type	enum	тип события; Всегда "response.image_generation_call.partial_image". Возможные значения: response.image_generation_call.partial_image	Да

OpenAI.ResponseInProgressEvent

Генерируется во время обработки ответа.

Name	Type	Description	Обязательный	По умолчанию
response	OpenAI.Response		Да
└agent_reference	AgentReference (nullable)	Агент, используемый для этого ответа	Да
└─ Фон	Булев (нулируемый)		Нет
└️ completed_at	целое число (nullable)		Нет
Беседа └️	OpenAI.ConversationReference (допускает значение NULL)	Беседа, к которой относится этот ответ. Входные элементы и выходные элементы из этого ответа были автоматически добавлены в эту беседу.	Нет
└️ created_at	целое число	Метка времени в формате Unix (в секундах), когда был создан этот ответ.	Да
└─ Ошибка	OpenAI.ResponseError (nullable)	Объект ошибки, возвращаемый, когда модель не сможет создать ответ.	Да
Идентификатор └️	строка	Уникальный идентификатор для этого ответа.	Да
└️ incomplete_details	OpenAI.ResponseIncompleteDetails (nullable)		Да
└ Инструкции	строка или массив OpenAI.InputItem (nullable)		Да
└️ max_output_tokens	OpenAI.integer (nullable)		Нет
└️ max_tool_calls	OpenAI.integer (nullable)		Нет
└─ Метаданные	OpenAI.Metadata (nullable)	Набор из 16 пар "ключ-значение", которые можно прикрепить к объекту. Это может быть Полезно для хранения дополнительных сведений об объекте в структурированном виде. форматирование и запрос объектов через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — строки с максимальной длиной 512 символов.	Нет
└─ Модель	строка	Развертывание модели, используемое для создания этого ответа.	Нет
└─ Объект	enum	Тип объекта этого ресурса — всегда установлено response. Возможные значения: response	Да
вывод └─	массив OpenAI.OutputItem	Массив элементов контента, созданных моделью. — Длина и порядок элементов в массиве output зависят в ответе модели. — Вместо доступа к первому элементу массива output и Предположим, что это assistant сообщение с содержанием, созданным Вы можете рассмотреть возможность использования свойства output_text модели, если поддерживается в пакетах SDK.	Да
└️ output_text	Строка (нулевая)		Нет
└─ вызовы_инструментов_в_параллельном_режиме	boolean	Следует ли разрешить модели запускать вызовы инструментов параллельно.	Да	True
└previous_response_id	Строка (нулевая)		Нет
└─ Запрос	OpenAI.Prompt	Ссылка на шаблон запроса и его переменные. Подробнее.	Нет
└prompt_cache_key	строка	Используется OpenAI для кэширования ответов для аналогичных запросов для оптимизации частоты попаданий кэша. Заменяет user поле. Подробнее.	Нет
└prompt_cache_retention	enum	Возможные значения: in-memory, 24h	Нет
└─ рассуждения	OpenAI.Reasoning (nullable)	Только модели gpt-5 и o-series Параметры конфигурации для модели рассуждений.	Нет
└safety_identifier	строка	Стабильный идентификатор, используемый для обнаружения пользователей приложения, которые могут нарушать политики использования OpenAI. Идентификаторы должны быть строкой, которая однозначно идентифицирует каждого пользователя. Мы рекомендуем хэшировать имя пользователя или адрес электронной почты, чтобы избежать отправки нам каких-либо сведений об идентификации. Подробнее.	Нет
└service_tier	OpenAI.ServiceTier	Указывает тип обработки, используемый для обслуживания запроса. — Если задано значение auto, запрос будет обработан с уровнем служб, настроенным в параметрах Project. Если иное не настроено, Project будет использовать значение по умолчанию. — Если задано значение "по умолчанию", запрос будет обработан со стандартными ценами и производительностью выбранной модели. — Если задано значение "flex" или "приоритет", запрос будет обработан соответствующим уровнем служб. — Если не задано, поведение по умолчанию — auto. service_tier Если параметр задан, текст ответа будет включать service_tier значение на основе режима обработки, который фактически использовался для обслуживания запроса. Это значение ответа может отличаться от значения, заданного в параметре.	Нет
└─ Состояние	enum	Статус формирования ответа. Один из completed, failed in_progress, cancelled, queued или incomplete. Возможные значения: completed, failed, in_progress, cancelled, queued, incomplete	Нет
└─ Температура	OpenAI.numeric (nullable)		Нет	1
Текст └️	OpenAI.ResponseTextParam	Параметры конфигурации для текстового ответа модели. Может быть простым текстовые или структурированные данные JSON. Подробнее: - Текстовые входные и выходные данные - Структурированные выходные данные	Нет
└─ выбор_инструмента	OpenAI.ToolChoiceOptions или OpenAI.ToolChoiceParam		Нет
└─ Инструменты	OpenAI.ToolsArray	Массив инструментов, которые модель может вызывать при создании ответа. Вы может указать, какое средство следует использовать, задав tool_choice параметр. Мы поддерживаем следующие категории инструментов: - Встроенные инструменты: инструменты, предоставляемые OpenAI для расширения Возможности модели, такие как поиск в Интернете или поиск по файлам. Дополнительные сведения встроенные средства. - Инструменты MCP: интеграция с сторонними системами с помощью пользовательских серверов MCP или предопределенные соединители, такие как Google Drive и SharePoint. Дополнительные сведения Инструменты MCP. - Вызовы функций (пользовательские средства): функции, определенные вами, включение модели для вызова собственного кода с строго типизированными аргументами и выходные данные. Дополнительные сведения вызов функции. Вы также можете использовать пользовательские средства для вызова собственного кода.	Нет
└️ top_logprobs	OpenAI.integer (nullable)		Нет
└️ top_p	OpenAI.numeric (nullable)		Нет	1
└️ усечение	enum	Возможные значения: auto, disabled	Нет
└─ использование	OpenAI.ResponseUsage	Представляет сведения об использовании маркеров, включая входные маркеры, выходные маркеры, разбивка выходных маркеров и общих используемых маркеров.	Нет
Пользователь └️	string (не рекомендуется)	Это поле заменяется safety_identifier и prompt_cache_key. Вместо этого используйте prompt_cache_key для поддержания оптимизации кэширования. Стабильный идентификатор для конечных пользователей. Используется для повышения скорости попадания кэша в более эффективное сегментирование аналогичных запросов и помогает OpenAI обнаруживать и предотвращать злоупотребление. Подробнее.	Нет
sequence_number	OpenAI.integer		Да
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		Да
└agent_reference	AgentReference (nullable)	Агент, используемый для этого ответа	Да
└─ Фон	Булев (нулируемый)		Нет
└️ completed_at	целое число (nullable)		Нет
Беседа └️	OpenAI.ConversationReference (допускает значение NULL)	Беседа, к которой относится этот ответ. Входные элементы и выходные элементы из этого ответа были автоматически добавлены в эту беседу.	Нет
└️ created_at	целое число	Метка времени в формате Unix (в секундах), когда был создан этот ответ.	Да
└─ Ошибка	OpenAI.ResponseError (nullable)	Объект ошибки, возвращаемый, когда модель не сможет создать ответ.	Да
Идентификатор └️	строка	Уникальный идентификатор для этого ответа.	Да
└️ incomplete_details	OpenAI.ResponseIncompleteDetails (nullable)		Да
└ Инструкции	строка или массив OpenAI.InputItem (nullable)		Да
└️ max_output_tokens	OpenAI.integer (nullable)		Нет
└️ max_tool_calls	OpenAI.integer (nullable)		Нет
└─ Метаданные	OpenAI.Metadata (nullable)	Набор из 16 пар "ключ-значение", которые можно прикрепить к объекту. Это может быть Полезно для хранения дополнительных сведений об объекте в структурированном виде. форматирование и запрос объектов через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — строки с максимальной длиной 512 символов.	Нет
└─ Модель	строка	Развертывание модели, используемое для создания этого ответа.	Нет
└─ Объект	enum	Тип объекта этого ресурса — всегда установлено response. Возможные значения: response	Да
вывод └─	массив OpenAI.OutputItem	Массив элементов контента, созданных моделью. — Длина и порядок элементов в массиве output зависят в ответе модели. — Вместо доступа к первому элементу массива output и Предположим, что это assistant сообщение с содержанием, созданным Вы можете рассмотреть возможность использования свойства output_text модели, если поддерживается в пакетах SDK.	Да
└️ output_text	Строка (нулевая)		Нет
└─ вызовы_инструментов_в_параллельном_режиме	boolean	Следует ли разрешить модели запускать вызовы инструментов параллельно.	Да	True
└previous_response_id	Строка (нулевая)		Нет
└─ Запрос	OpenAI.Prompt	Ссылка на шаблон запроса и его переменные. Подробнее.	Нет
└prompt_cache_key	строка	Используется OpenAI для кэширования ответов для аналогичных запросов для оптимизации частоты попаданий кэша. Заменяет user поле. Подробнее.	Нет
└prompt_cache_retention	enum	Возможные значения: in-memory, 24h	Нет
└─ рассуждения	OpenAI.Reasoning (nullable)	Только модели gpt-5 и o-series Параметры конфигурации для модели рассуждений.	Нет
└safety_identifier	строка	Стабильный идентификатор, используемый для обнаружения пользователей приложения, которые могут нарушать политики использования OpenAI. Идентификаторы должны быть строкой, которая однозначно идентифицирует каждого пользователя. Мы рекомендуем хэшировать имя пользователя или адрес электронной почты, чтобы избежать отправки нам каких-либо сведений об идентификации. Подробнее.	Нет
└service_tier	OpenAI.ServiceTier	Указывает тип обработки, используемый для обслуживания запроса. — Если задано значение auto, запрос будет обработан с уровнем служб, настроенным в параметрах Project. Если иное не настроено, Project будет использовать значение по умолчанию. — Если задано значение "по умолчанию", запрос будет обработан со стандартными ценами и производительностью выбранной модели. — Если задано значение "flex" или "приоритет", запрос будет обработан соответствующим уровнем служб. — Если не задано, поведение по умолчанию — auto. service_tier Если параметр задан, текст ответа будет включать service_tier значение на основе режима обработки, который фактически использовался для обслуживания запроса. Это значение ответа может отличаться от значения, заданного в параметре.	Нет
└─ Состояние	enum	Статус формирования ответа. Один из completed, failed in_progress, cancelled, queued или incomplete. Возможные значения: completed, failed, in_progress, cancelled, queued, incomplete	Нет
└─ Температура	OpenAI.numeric (nullable)		Нет	1
Текст └️	OpenAI.ResponseTextParam	Параметры конфигурации для текстового ответа модели. Может быть простым текстовые или структурированные данные JSON. Подробнее: - Текстовые входные и выходные данные - Структурированные выходные данные	Нет
└─ выбор_инструмента	OpenAI.ToolChoiceOptions или OpenAI.ToolChoiceParam		Нет
└─ Инструменты	OpenAI.ToolsArray	Массив инструментов, которые модель может вызывать при создании ответа. Вы может указать, какое средство следует использовать, задав tool_choice параметр. Мы поддерживаем следующие категории инструментов: - Встроенные инструменты: инструменты, предоставляемые OpenAI для расширения Возможности модели, такие как поиск в Интернете или поиск по файлам. Дополнительные сведения встроенные средства. - Инструменты MCP: интеграция с сторонними системами с помощью пользовательских серверов MCP или предопределенные соединители, такие как Google Drive и SharePoint. Дополнительные сведения Инструменты MCP. - Вызовы функций (пользовательские средства): функции, определенные вами, включение модели для вызова собственного кода с строго типизированными аргументами и выходные данные. Дополнительные сведения вызов функции. Вы также можете использовать пользовательские средства для вызова собственного кода.	Нет
└️ top_logprobs	OpenAI.integer (nullable)		Нет
└️ top_p	OpenAI.numeric (nullable)		Нет	1
└️ усечение	enum	Возможные значения: auto, disabled	Нет
└─ использование	OpenAI.ResponseUsage	Представляет сведения об использовании маркеров, включая входные маркеры, выходные маркеры, разбивка выходных маркеров и общих используемых маркеров.	Нет
Пользователь └️	string (не рекомендуется)	Это поле заменяется safety_identifier и prompt_cache_key. Вместо этого используйте prompt_cache_key для поддержания оптимизации кэширования. Стабильный идентификатор для конечных пользователей. Используется для повышения скорости попадания кэша в более эффективное сегментирование аналогичных запросов и помогает OpenAI обнаруживать и предотвращать злоупотребление. Подробнее.	Нет
sequence_number	OpenAI.integer		Да
type	enum	тип события; Всегда response.incomplete. Возможные значения: response.incomplete	Да

OpenAI.ResponseLogProb

Logprob — это логарифмическая вероятность того, что модель назначает определенному маркеру по заданной позиции в последовательности. Менее отрицательные (более высокие) значения logprob указывают на большее доверие модели к выбору маркера.

Name	Type	Description	Обязательный	По умолчанию
logprob	OpenAI.numeric		Да
token	строка	Возможный текстовый маркер.	Да
top_logprobs	массив OpenAI.ResponseLogProbTopLogprobs	Вероятность ведения журнала наиболее вероятных маркеров из 20 лучших.	Нет

OpenAI.ResponseLogProbTopLogprobs

Name	Type	Description	Обязательный	По умолчанию
logprob	OpenAI.numeric		Нет
token	строка		Нет

OpenAI.ResponseMCPCallArgumentsDeltaEvent

Выдается, когда происходит разностное (частичное) обновление аргументов вызова средства MCP.

Name	Type	Description	Обязательный	По умолчанию
delta	строка	Строка JSON, содержащая частичное обновление аргументов для вызова средства MCP.	Да
item_id	строка	Уникальный идентификатор обрабатываемого элемента вызова средства MCP.	Да
output_index	OpenAI.integer		Да
sequence_number	OpenAI.integer		Да
type	enum	тип события; Всегда "response.mcp_call_arguments.delta". Возможные значения: response.mcp_call_arguments.delta	Да

OpenAI.ResponseMCPCallArgumentsDoneEvent

Генерируется, когда аргументы для вызова инструмента MCP завершены.

Name	Type	Description	Обязательный	По умолчанию
arguments	строка	Строка JSON, содержащая завершенные аргументы для вызова средства MCP.	Да
item_id	строка	Уникальный идентификатор обрабатываемого элемента вызова средства MCP.	Да
output_index	OpenAI.integer		Да
sequence_number	OpenAI.integer		Да
type	enum	тип события; Всегда "response.mcp_call_arguments.готово". Возможные значения: response.mcp_call_arguments.done	Да

OpenAI.ResponseMCPCallCompletedEvent

Срабатывает при успешном выполнении вызова средства MCP.

Name	Type	Description	Обязательный	По умолчанию
item_id	строка	Идентификатор завершенного элемента вызова средства MCP.	Да
output_index	OpenAI.integer		Да
sequence_number	OpenAI.integer		Да
type	enum	тип события; Всегда «response.mcp_call.completed». Возможные значения: response.mcp_call.completed	Да

OpenAI.ResponseMCPCallFailedEvent

Создается при сбое вызова средства MCP.

Name	Type	Description	Обязательный	По умолчанию
item_id	строка	Идентификатор элемента вызова средства MCP, который завершился сбоем.	Да
output_index	OpenAI.integer		Да
sequence_number	OpenAI.integer		Да
type	enum	тип события; Всегда "response.mcp_call.failed". Возможные значения: response.mcp_call.failed	Да

OpenAI.ResponseMCPCallInProgressEvent

Испускается в процессе выполнения вызова средства MCP.

Name	Type	Description	Обязательный	По умолчанию
item_id	строка	Уникальный идентификатор обрабатываемого элемента вызова средства MCP.	Да
output_index	OpenAI.integer		Да
sequence_number	OpenAI.integer		Да
type	enum	тип события; Всегда "response.mcp_call.in_progress". Возможные значения: response.mcp_call.in_progress	Да

OpenAI.ResponseMCPListToolsCompletedEvent

Инициируется при успешном получении списка доступных средств MCP.

Name	Type	Description	Обязательный	По умолчанию
item_id	строка	Идентификатор элемента вызова средства MCP, создающего эти выходные данные.	Да
output_index	OpenAI.integer		Да
sequence_number	OpenAI.integer		Да
type	enum	тип события; Всегда "response.mcp_list_tools.completed". Возможные значения: response.mcp_list_tools.completed	Да

OpenAI.ResponseMCPListToolsFailedEvent

Возникает при сбое попытки перечисления доступных средств MCP.

Name	Type	Description	Обязательный	По умолчанию
item_id	строка	Идентификатор элемента вызова средства MCP, который завершился сбоем.	Да
output_index	OpenAI.integer		Да
sequence_number	OpenAI.integer		Да
type	enum	тип события; Всегда "response.mcp_list_tools.failed". Возможные значения: response.mcp_list_tools.failed	Да

OpenAI.ResponseMCPListToolsInProgressEvent

Подается сигнал, когда система находится в процессе получения списка доступных инструментов MCP.

Name	Type	Description	Обязательный	По умолчанию
item_id	строка	Идентификатор обрабатываемого элемента вызова средства MCP.	Да
output_index	OpenAI.integer		Да
sequence_number	OpenAI.integer		Да
type	enum	тип события; Всегда "response.mcp_list_tools.in_progress". Возможные значения: response.mcp_list_tools.in_progress	Да

OpenAI.ResponseOutputItemAddedEvent

Создается при добавлении нового выходного элемента.

Name	Type	Description	Обязательный	По умолчанию
item	OpenAI.OutputItem		Да
└agent_reference	AgentReference	Агент, создавший элемент.	Нет
└️ response_id	строка	Ответ, на котором создается элемент.	Нет
└─ Тип	OpenAI.OutputItemType		Да
output_index	OpenAI.integer		Да
sequence_number	OpenAI.integer		Да
type	enum	тип события; Всегда response.output_item.added. Возможные значения: response.output_item.added	Да

OpenAI.ResponseOutputItemDoneEvent

Излучается, когда выходной элемент помечен как завершенный.

Name	Type	Description	Обязательный	По умолчанию
item	OpenAI.OutputItem		Да
└agent_reference	AgentReference	Агент, создавший элемент.	Нет
└️ response_id	строка	Ответ, на котором создается элемент.	Нет
└─ Тип	OpenAI.OutputItemType		Да
output_index	OpenAI.integer		Да
sequence_number	OpenAI.integer		Да
type	enum	тип события; Всегда response.output_item.done. Возможные значения: response.output_item.done	Да

OpenAI.ResponseOutputTextAnnotationAddedEvent

Создается при добавлении заметки в выходное текстовое содержимое.

Name	Type	Description	Обязательный	По умолчанию
Аннотации	OpenAI.Annotation	Заметка, которая применяется к диапазону выходного текста.	Да
└─ Тип	OpenAI.AnnotationType		Да
annotation_index	OpenAI.integer		Да
content_index	OpenAI.integer		Да
item_id	строка	Уникальный идентификатор элемента, к которому добавляется заметка.	Да
output_index	OpenAI.integer		Да
sequence_number	OpenAI.integer		Да
type	enum	тип события; Всегда "response.output_text.annotation.added". Возможные значения: response.output_text.annotation.added	Да

OpenAI.ResponsePromptVariables

Необязательная карта значений для замены переменных в запросе. Значения подстановки могут быть строками или другими типами входных данных ответа, такими как изображения или файлы.

Тип: объект

OpenAI.ResponseQueuedEvent

Возникает, когда ответ поставлен в очередь и ожидает обработки.

Name	Type	Description	Обязательный	По умолчанию
response	OpenAI.Response		Да
└agent_reference	AgentReference (nullable)	Агент, используемый для этого ответа	Да
└─ Фон	Булев (нулируемый)		Нет
└️ completed_at	целое число (nullable)		Нет
Беседа └️	OpenAI.ConversationReference (допускает значение NULL)	Беседа, к которой относится этот ответ. Входные элементы и выходные элементы из этого ответа были автоматически добавлены в эту беседу.	Нет
└️ created_at	целое число	Метка времени в формате Unix (в секундах), когда был создан этот ответ.	Да
└─ Ошибка	OpenAI.ResponseError (nullable)	Объект ошибки, возвращаемый, когда модель не сможет создать ответ.	Да
Идентификатор └️	строка	Уникальный идентификатор для этого ответа.	Да
└️ incomplete_details	OpenAI.ResponseIncompleteDetails (nullable)		Да
└ Инструкции	строка или массив OpenAI.InputItem (nullable)		Да
└️ max_output_tokens	OpenAI.integer (nullable)		Нет
└️ max_tool_calls	OpenAI.integer (nullable)		Нет
└─ Метаданные	OpenAI.Metadata (nullable)	Набор из 16 пар "ключ-значение", которые можно прикрепить к объекту. Это может быть Полезно для хранения дополнительных сведений об объекте в структурированном виде. форматирование и запрос объектов через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — строки с максимальной длиной 512 символов.	Нет
└─ Модель	строка	Развертывание модели, используемое для создания этого ответа.	Нет
└─ Объект	enum	Тип объекта этого ресурса — всегда установлено response. Возможные значения: response	Да
вывод └─	массив OpenAI.OutputItem	Массив элементов контента, созданных моделью. — Длина и порядок элементов в массиве output зависят в ответе модели. — Вместо доступа к первому элементу массива output и Предположим, что это assistant сообщение с содержанием, созданным Вы можете рассмотреть возможность использования свойства output_text модели, если поддерживается в пакетах SDK.	Да
└️ output_text	Строка (нулевая)		Нет
└─ вызовы_инструментов_в_параллельном_режиме	boolean	Следует ли разрешить модели запускать вызовы инструментов параллельно.	Да	True
└previous_response_id	Строка (нулевая)		Нет
└─ Запрос	OpenAI.Prompt	Ссылка на шаблон запроса и его переменные. Подробнее.	Нет
└prompt_cache_key	строка	Используется OpenAI для кэширования ответов для аналогичных запросов для оптимизации частоты попаданий кэша. Заменяет user поле. Подробнее.	Нет
└prompt_cache_retention	enum	Возможные значения: in-memory, 24h	Нет
└─ рассуждения	OpenAI.Reasoning (nullable)	Только модели gpt-5 и o-series Параметры конфигурации для модели рассуждений.	Нет
└safety_identifier	строка	Стабильный идентификатор, используемый для обнаружения пользователей приложения, которые могут нарушать политики использования OpenAI. Идентификаторы должны быть строкой, которая однозначно идентифицирует каждого пользователя. Мы рекомендуем хэшировать имя пользователя или адрес электронной почты, чтобы избежать отправки нам каких-либо сведений об идентификации. Подробнее.	Нет
└service_tier	OpenAI.ServiceTier	Указывает тип обработки, используемый для обслуживания запроса. — Если задано значение auto, запрос будет обработан с уровнем служб, настроенным в параметрах Project. Если иное не настроено, Project будет использовать значение по умолчанию. — Если задано значение "по умолчанию", запрос будет обработан со стандартными ценами и производительностью выбранной модели. — Если задано значение "flex" или "приоритет", запрос будет обработан соответствующим уровнем служб. — Если не задано, поведение по умолчанию — auto. service_tier Если параметр задан, текст ответа будет включать service_tier значение на основе режима обработки, который фактически использовался для обслуживания запроса. Это значение ответа может отличаться от значения, заданного в параметре.	Нет
└─ Состояние	enum	Статус формирования ответа. Один из completed, failed in_progress, cancelled, queued или incomplete. Возможные значения: completed, failed, in_progress, cancelled, queued, incomplete	Нет
└─ Температура	OpenAI.numeric (nullable)		Нет	1
Текст └️	OpenAI.ResponseTextParam	Параметры конфигурации для текстового ответа модели. Может быть простым текстовые или структурированные данные JSON. Подробнее: - Текстовые входные и выходные данные - Структурированные выходные данные	Нет
└─ выбор_инструмента	OpenAI.ToolChoiceOptions или OpenAI.ToolChoiceParam		Нет
└─ Инструменты	OpenAI.ToolsArray	Массив инструментов, которые модель может вызывать при создании ответа. Вы может указать, какое средство следует использовать, задав tool_choice параметр. Мы поддерживаем следующие категории инструментов: - Встроенные инструменты: инструменты, предоставляемые OpenAI для расширения Возможности модели, такие как поиск в Интернете или поиск по файлам. Дополнительные сведения встроенные средства. - Инструменты MCP: интеграция с сторонними системами с помощью пользовательских серверов MCP или предопределенные соединители, такие как Google Drive и SharePoint. Дополнительные сведения Инструменты MCP. - Вызовы функций (пользовательские средства): функции, определенные вами, включение модели для вызова собственного кода с строго типизированными аргументами и выходные данные. Дополнительные сведения вызов функции. Вы также можете использовать пользовательские средства для вызова собственного кода.	Нет
└️ top_logprobs	OpenAI.integer (nullable)		Нет
└️ top_p	OpenAI.numeric (nullable)		Нет	1
└️ усечение	enum	Возможные значения: auto, disabled	Нет
└─ использование	OpenAI.ResponseUsage	Представляет сведения об использовании маркеров, включая входные маркеры, выходные маркеры, разбивка выходных маркеров и общих используемых маркеров.	Нет
Пользователь └️	string (не рекомендуется)	Это поле заменяется safety_identifier и prompt_cache_key. Вместо этого используйте prompt_cache_key для поддержания оптимизации кэширования. Стабильный идентификатор для конечных пользователей. Используется для повышения скорости попадания кэша в более эффективное сегментирование аналогичных запросов и помогает OpenAI обнаруживать и предотвращать злоупотребление. Подробнее.	Нет
sequence_number	OpenAI.integer		Да
type	enum	тип события; Всегда «response.queued». Возможные значения: response.queued	Да

OpenAI.ResponseReasoningSummaryPartAddedEvent

Выдается при добавлении нового раздела резюме рассуждений.

Name	Type	Description	Обязательный	По умолчанию
item_id	строка	Идентификатор элемента, с которым связана эта сводная часть.	Да
output_index	OpenAI.integer		Да
part	OpenAI.ResponseReasoningSummaryPartAddedEventPart		Да
Текст └️	строка		Да
└─ Тип	enum	Возможные значения: summary_text	Да
sequence_number	OpenAI.integer		Да
summary_index	OpenAI.integer		Да
type	enum	тип события; Всегда response.reasoning_summary_part.added. Возможные значения: response.reasoning_summary_part.added	Да

OpenAI.ResponseReasoningSummaryPartAddedEventPart

Name	Type	Description	Обязательный	По умолчанию
text	строка		Да
type	enum	Возможные значения: summary_text	Да

OpenAI.ResponseReasoningSummaryPartDoneEvent

Испускается при завершении части обоснования.

Name	Type	Description	Обязательный	По умолчанию
item_id	строка	Идентификатор элемента, с которым связана эта сводная часть.	Да
output_index	OpenAI.integer		Да
part	OpenAI.ResponseReasoningSummaryPartDoneEventPart		Да
Текст └️	строка		Да
└─ Тип	enum	Возможные значения: summary_text	Да
sequence_number	OpenAI.integer		Да
summary_index	OpenAI.integer		Да
type	enum	тип события; Всегда response.reasoning_summary_part.done. Возможные значения: response.reasoning_summary_part.done	Да

OpenAI.ResponseReasoningSummaryPartDoneEventPart

Name	Type	Description	Обязательный	По умолчанию
text	строка		Да
type	enum	Возможные значения: summary_text	Да

OpenAI.ResponseReasoningSummaryTextDeltaEvent

Создается при добавлении разностного изменения в текст сводной информации.

Name	Type	Description	Обязательный	По умолчанию
delta	строка	Изменения текста, добавленные в сводку.	Да
item_id	строка	Идентификатор элемента, с которым связана разность текста сводки.	Да
output_index	OpenAI.integer		Да
sequence_number	OpenAI.integer		Да
summary_index	OpenAI.integer		Да
type	enum	тип события; Всегда response.reasoning_summary_text.delta. Возможные значения: response.reasoning_summary_text.delta	Да

OpenAI.ResponseReasoningSummaryTextDoneEvent

Генерируется при завершении сводного текста аргументирования.

Name	Type	Description	Обязательный	По умолчанию
item_id	строка	Идентификатор элемента, с которым связан текст сводки.	Да
output_index	OpenAI.integer		Да
sequence_number	OpenAI.integer		Да
summary_index	OpenAI.integer		Да
text	строка	Полный текст завершенной сводки об обосновании.	Да
type	enum	тип события; Всегда response.reasoning_summary_text.done. Возможные значения: response.reasoning_summary_text.done	Да

OpenAI.ResponseReasoningTextDeltaEvent

Создается при добавлении разностного изменения в текст причины.

Name	Type	Description	Обязательный	По умолчанию
content_index	OpenAI.integer		Да
delta	строка	Разностный текст, добавленный в содержимое причины.	Да
item_id	строка	Идентификатор элемента, с которым связан разностный текст.	Да
output_index	OpenAI.integer		Да
sequence_number	OpenAI.integer		Да
type	enum	тип события; Всегда response.reasoning_text.delta. Возможные значения: response.reasoning_text.delta	Да

OpenAI.ResponseReasoningTextDoneEvent

Создается при завершении текста причины.

Name	Type	Description	Обязательный	По умолчанию
content_index	OpenAI.integer		Да
item_id	строка	Идентификатор элемента, с которым связан текст причины.	Да
output_index	OpenAI.integer		Да
sequence_number	OpenAI.integer		Да
text	строка	Полный текст завершенного содержимого аргументирования.	Да
type	enum	тип события; Всегда response.reasoning_text.done. Возможные значения: response.reasoning_text.done	Да

OpenAI.ResponseRefusalDeltaEvent

Срабатывает при наличии частичного текста отказа.

Name	Type	Description	Обязательный	По умолчанию
content_index	OpenAI.integer		Да
delta	строка	Добавлен текст отказа.	Да
item_id	строка	Идентификатор выходного элемента, к которому добавляется текст отказа.	Да
output_index	OpenAI.integer		Да
sequence_number	OpenAI.integer		Да
type	enum	тип события; Всегда response.refusal.delta. Возможные значения: response.refusal.delta	Да

OpenAI.ResponseRefusalDoneEvent

Воспроизводится, когда текст отказа окончательно сформирован.

Name	Type	Description	Обязательный	По умолчанию
content_index	OpenAI.integer		Да
item_id	строка	Идентификатор выходного элемента, имеющего окончательный текст отказа.	Да
output_index	OpenAI.integer		Да
отказ	строка	Текст отказа, завершенный.	Да
sequence_number	OpenAI.integer		Да
type	enum	тип события; Всегда response.refusal.done. Возможные значения: response.refusal.done	Да

OpenAI.ResponseStreamOptions

Параметры потоковых ответов. Этот параметр устанавливается только при установке stream: true.

Name	Type	Description	Обязательный	По умолчанию
include_obfuscation	boolean	Если задано значение true, будет включена обфускация потока. Добавляется скрытие потока случайные символы в поле потоковой передачи obfuscation событий разностных событий в нормализованные размеры полезных данных в качестве устранения определенных атак на стороне канала. Эти поля маскировки включены по умолчанию, но добавьте небольшое количество. затраты на поток данных. Можно задать include_obfuscation значение False для оптимизации пропускной способности, если вы доверяете сетевым каналам между приложение и API OpenAI.	Нет

OpenAI.ResponseTextDeltaEvent

Создается при наличии дополнительного разностного текста.

Name	Type	Description	Обязательный	По умолчанию
content_index	OpenAI.integer		Да
delta	строка	Добавлена разностная строка текста.	Да
item_id	строка	Идентификатор выходного элемента, к которому была добавлена текстовая дельта.	Да
logprobs	массив OpenAI.ResponseLogProb	Вероятности журналов маркеров в разностном формате.	Да
output_index	OpenAI.integer		Да
sequence_number	OpenAI.integer		Да
type	enum	тип события; Всегда response.output_text.delta. Возможные значения: response.output_text.delta	Да

OpenAI.ResponseTextDoneEvent

Излучается при завершении работы с текстовым содержимым.

Name	Type	Description	Обязательный	По умолчанию
content_index	OpenAI.integer		Да
item_id	строка	Идентификатор выходного элемента, для которого завершается текстовое содержимое.	Да
logprobs	массив OpenAI.ResponseLogProb	Вероятности журналов маркеров в разностном формате.	Да
output_index	OpenAI.integer		Да
sequence_number	OpenAI.integer		Да
text	строка	Текстовое содержимое, завершенное.	Да
type	enum	тип события; Всегда response.output_text.done. Возможные значения: response.output_text.done	Да

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	OpenAI.integer		Да
input_tokens_details	OpenAI.ResponseUsageInputTokensDetails		Да
└ cached_tokens	OpenAI.integer		Да
output_tokens	OpenAI.integer		Да
output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails		Да
└️ reasoning_tokens	OpenAI.integer		Да
общее количество токенов	OpenAI.integer		Да

OpenAI.ResponseUsageInputTokensDetails

Name	Type	Description	Обязательный	По умолчанию
cached_tokens	OpenAI.integer		Да

OpenAI.ResponseUsageOutputTokensDetails

Name	Type	Description	Обязательный	По умолчанию
токены рассуждений	OpenAI.integer		Да

OpenAI.ResponseWebSearchCallCompletedEvent

Создается при завершении вызова веб-поиска.

Name	Type	Description	Обязательный	По умолчанию
item_id	строка	Уникальный идентификатор выходного элемента, связанного с вызовом веб-поиска.	Да
output_index	OpenAI.integer		Да
sequence_number	OpenAI.integer		Да
type	enum	тип события; Всегда response.web_search_call.completed. Возможные значения: response.web_search_call.completed	Да

OpenAI.ResponseWebSearchCallInProgressEvent

Создается при инициировании вызова поиска в Интернете.

Name	Type	Description	Обязательный	По умолчанию
item_id	строка	Уникальный идентификатор выходного элемента, связанного с вызовом веб-поиска.	Да
output_index	OpenAI.integer		Да
sequence_number	OpenAI.integer		Да
type	enum	тип события; Всегда response.web_search_call.in_progress. Возможные значения: response.web_search_call.in_progress	Да

OpenAI.ResponseWebSearchCallSearchingEvent

Создается при выполнении вызова веб-поиска.

Name	Type	Description	Обязательный	По умолчанию
item_id	строка	Уникальный идентификатор выходного элемента, связанного с вызовом веб-поиска.	Да
output_index	OpenAI.integer		Да
sequence_number	OpenAI.integer		Да
type	enum	тип события; Всегда response.web_search_call.searching. Возможные значения: response.web_search_call.searching	Да

OpenAI.Screenshot

Действие с снимком экрана.

Name	Type	Description	Обязательный	По умолчанию
type	enum	Указывает тип события. Для действия создания снимка экрана это свойство всегда задано значение screenshot. Возможные значения: screenshot	Да

OpenAI.Scroll

Действие прокрутки.

Name	Type	Description	Обязательный	По умолчанию
scroll_x	OpenAI.integer		Да
scroll_y	OpenAI.integer		Да
type	enum	Указывает тип события. Для действия прокрутки это свойство имеет значение всегда задано значение scroll. Возможные значения: scroll	Да
x	OpenAI.integer		Да
и	OpenAI.integer		Да

OpenAI.SearchContextSize

Property	Ценность
Type	строка
Значения	low medium high

OpenAI.ServiceTier

Указывает тип обработки, используемый для обслуживания запроса.

• Если задано значение auto, запрос будет обработан с уровнем служб, настроенным в параметрах Project. Если иное не настроено, Project будет использовать значение по умолчанию.
• Если задано значение "по умолчанию", запрос будет обработан со стандартными ценами и производительностью выбранной модели.
• Если задано значение "flex" или "priority", запрос будет обработан соответствующим уровнем служб.
• Если не задано, поведение по умолчанию — "auto". service_tier Если параметр задан, текст ответа будет включать service_tier значение на основе режима обработки, который фактически использовался для обслуживания запроса. Это значение ответа может отличаться от значения, заданного в параметре.

Property	Ценность
Type	строка
Nullable	Да
Значения	auto default flex scale priority

OpenAI.SpecificApplyPatchParam

Заставляет модель вызывать средство apply_patch при выполнении вызова средства.

Name	Type	Description	Обязательный	По умолчанию
type	enum	Средство для вызова. Всегда 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	Да

OpenAI.SummaryTextContent

Текст сводки из модели.

Name	Type	Description	Обязательный	По умолчанию
text	строка	Сводка по выводу причин модели до сих пор.	Да
type	enum	Тип объекта . Всегда summary_text. Возможные значения: summary_text	Да

OpenAI.TextContent

Текстовое содержимое.

Name	Type	Description	Обязательный	По умолчанию
text	строка		Да
type	enum	Возможные значения: 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_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. Дополнительные сведения о структурированных выходных данных.

Name	Type	Description	Обязательный	По умолчанию
описание	строка	Описание формата ответа, который модель использует для выполнения своих задач. определите, как реагировать в рамках заданного формата.	Нет
имя	строка	Имя формата ответа. Должен содержать латинские буквы a-z, A-Z или цифры 0-9. символы подчеркивания и дефисы с максимальной длиной 64.	Да
schema	OpenAI.ResponseFormatJsonSchema	Схема формата ответа, описанная как объект схемы JSON. Узнайте, как создать схемы JSON здесь.	Да
строгий	Булев (нулируемый)		Нет
type	enum	Тип определяемого формата ответа. Всегда json_schema. Возможные значения: json_schema	Да

OpenAI.Tool

Средство, которое можно использовать для создания ответа.

Дискриминатор для OpenAI.Инструмент

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа	Schema
bing_grounding	BingGroundingTool
fabric_dataagent_preview	MicrosoftFabricPreviewTool
sharepoint_grounding_preview	SharepointPreviewTool
azure_ai_search	AzureAISearchTool
openapi	OpenApiTool
bing_custom_search_preview	BingCustomSearchPreviewTool
browser_automation_preview	BrowserAutomationPreviewTool
azure_function	AzureFunctionTool
capture_structured_outputs	CaptureStructuredOutputsTool
a2a_preview	A2APreviewTool
memory_search_preview	MemorySearchPreviewTool
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.ToolChoiceFunction

Используйте этот параметр, чтобы принудительно вызвать определенную функцию.

Name	Type	Description	Обязательный	По умолчанию
имя	строка	Имя вызываемой функции.	Да
type	enum	Для вызова функции тип всегда function. Возможные значения: function	Да

OpenAI.ToolChoiceImageGeneration

Указывает, что модель должна использовать встроенное средство для создания ответа. Дополнительные сведения о встроенных средствах.

Name	Type	Description	Обязательный	По умолчанию
type	enum	Возможные значения: image_generation	Да

OpenAI.ToolChoiceMCP

Используйте этот параметр, чтобы принудительно вызвать определенное средство на удаленном сервере MCP.

Name	Type	Description	Обязательный	По умолчанию
имя	Строка (нулевая)		Нет
метка сервера	строка	Метка используемого сервера MCP.	Да
type	enum	Для инструментов MCP тип всегда mcp. Возможные значения: mcp	Да

OpenAI.ToolChoiceOptions

Определяет, какое средство (если таковое) вызывается моделью. none означает, что модель не будет вызывать какое-либо средство и вместо этого создает сообщение. auto означает, что модель может выбирать между созданием сообщения или вызовом одного или нескольких инструментов. required означает, что модель должна вызывать один или несколько инструментов.

Property	Ценность
Type	строка
Значения	none auto required

OpenAI.ToolChoiceParam

Как модель должна выбрать средство (или инструменты), которое следует использовать при создании ответа. Просмотрите tools параметр, чтобы узнать, как указать, какие средства модель может вызывать.

Дискриминация для OpenAI.ToolChoiceParam

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа	Schema
allowed_tools	OpenAI.ToolChoiceAllowed
function	OpenAI.ToolChoiceFunction
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

Указывает, что модель должна использовать встроенное средство для создания ответа. Дополнительные сведения о встроенных средствах.

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 a2a_preview bing_custom_search_preview browser_automation_preview fabric_dataagent_preview sharepoint_grounding_preview memory_search_preview azure_ai_search azure_function bing_grounding capture_structured_outputs openapi

OpenAI.ToolsArray

Массив инструментов, которые модель может вызывать при создании ответа. Можно указать, какое средство следует использовать, задав tool_choice параметр. Мы поддерживаем следующие категории инструментов:

• Встроенные средства: средства, предоставляемые OpenAI, которые расширяют возможности модели, такие как поиск в Интернете или поиск по файлам. Дополнительные сведения о встроенных средствах.
• MCP Tools: интеграция с сторонними системами с помощью пользовательских серверов MCP или предопределенных соединителей, таких как Google Drive и SharePoint. Дополнительные сведения о средствах MCP.
• Вызовы функций (пользовательские средства): функции, определенные вами, что позволяет модели вызывать собственный код с строго типизированными аргументами и выходными данными. Дополнительные сведения о вызове функции. Вы также можете использовать пользовательские средства для вызова собственного кода.

Массив: OpenAI.Tool

OpenAI.TopLogProb

Максимальная логарифмическая вероятность токена.

Name	Type	Description	Обязательный	По умолчанию
байт	массив OpenAI.integer		Да
logprob	OpenAI.numeric		Да
token	строка		Да

OpenAI.Type

Действие для ввода текста.

Name	Type	Description	Обязательный	По умолчанию
text	строка	Текст для набора.	Да
type	enum	Указывает тип события. Для действия типа это свойство равно всегда задано значение type. Возможные значения: type	Да

OpenAI.UpdateConversationBody

Name	Type	Description	Обязательный	По умолчанию
metadata	OpenAI.Metadata (nullable)	Набор из 16 пар "ключ-значение", которые можно прикрепить к объекту. Это может быть Полезно для хранения дополнительных сведений об объекте в структурированном виде. форматирование и запрос объектов через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — строки с максимальной длиной 512 символов.	Да

OpenAI.UrlCitationBody

Ссылка на веб-ресурс, используемый для создания ответа модели.

Name	Type	Description	Обязательный	По умолчанию
end_index	OpenAI.integer		Да
start_index	OpenAI.integer		Да
title	строка	Заголовок веб-ресурса.	Да
type	enum	Тип URL-ссылки. Всегда url_citation. Возможные значения: url_citation	Да
url	строка	URL-адрес веб-ресурса.	Да

OpenAI.VectorStoreFileAttributes

Набор из 16 пар "ключ-значение", которые можно прикрепить к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате и запроса на объекты через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения могут быть строками с максимальной длиной 512 символов, логическими значениями или числами.

Тип: объект

OpenAI.Verbosity

Ограничивает детализацию ответа модели. Более низкие значения приводят к более кратким ответам, в то время как более подробные значения приводят к более подробным ответам. В настоящее время поддерживаются lowзначения , mediumи high.

Property	Ценность
Type	строка
Nullable	Да
Значения	low medium high

OpenAI.Wait

Действие ожидания.

Name	Type	Description	Обязательный	По умолчанию
type	enum	Указывает тип события. Для действия ожидания это свойство устанавливается как всегда задано значение wait. Возможные значения: wait	Да

OpenAI.WebSearchActionFind

Тип действия "find": выполняет поиск шаблона на загруженной странице.

Name	Type	Description	Обязательный	По умолчанию
pattern	строка	Шаблон или текст для поиска на странице.	Да
type	enum	Тип действия. Возможные значения: find_in_page	Да
url	строка	URL-адрес страницы, где искали шаблон.	Да

OpenAI.WebSearchActionOpenPage

Тип действия "open_page" — открывает определенный URL-адрес из результатов поиска.

Name	Type	Description	Обязательный	По умолчанию
type	enum	Тип действия. Возможные значения: open_page	Да
url	строка	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	Обязательный	По умолчанию
Города	Строка (нулевая)		Нет
страна	Строка (нулевая)		Нет
region	Строка (нулевая)		Нет
timezone	Строка (нулевая)		Нет
type	enum	Тип приближения расположения. Всегда approximate. Возможные значения: approximate	Нет

OpenAI.WebSearchPreviewTool

Этот инструмент ищет в интернете релевантные результаты для ответа. Дополнительные сведения о средстве поиска web.

Name	Type	Description	Обязательный	По умолчанию
размер_контекста_поиска	OpenAI.SearchContextSize		Нет
type	enum	Тип средства поиска в Интернете. Одно из web_search_preview или web_search_preview_2025_03_11. Возможные значения: web_search_preview	Да
местоположение пользователя	OpenAI.ApproximateLocation (допустимое значение NULL)		Нет
└️ город	Строка (нулевая)		Нет
└️ страна	Строка (нулевая)		Нет
└️ регион	Строка (нулевая)		Нет
└️ часовой пояс	Строка (нулевая)		Нет
└─ Тип	enum	Тип приближения расположения. Всегда approximate. Возможные значения: approximate	Да

OpenAI.WebSearchTool

Ищите в Интернете источники, связанные с этим заданием. Дополнительные сведения о средстве поиска web.

Name	Type	Description	Обязательный	По умолчанию
custom_search_configuration	WebSearchConfiguration	Конфигурация поиска в Интернете для bing пользовательского поиска	Нет
└instance_name instance_name	строка	Имя настраиваемого экземпляра конфигурации, заданного для конфигурации.	Да
└project_connection_id	строка	идентификатор подключения Project для приземления с помощью пользовательского поиска bing	Да
Фильтры	OpenAI.WebSearchToolFilters (nullable)		Нет
└allowed_domains	массив строк (допускающий значение NULL)		Нет
размер_контекста_поиска	enum	Рекомендации высокого уровня для объема пространства контекстного окна, используемого для поиска. Один из low, mediumили high. medium — значение по умолчанию. Возможные значения: low, mediumhigh	Нет
type	enum	Тип средства поиска в Интернете. Одно из web_search или web_search_2025_08_26. Возможные значения: web_search	Да
местоположение пользователя	OpenAI.WebSearchApproximateLocation (nullable)	Приблизительное расположение пользователя.	Нет
└️ город	Строка (нулевая)		Нет
└️ страна	Строка (нулевая)		Нет
└️ регион	Строка (нулевая)		Нет
└️ часовой пояс	Строка (нулевая)		Нет
└─ Тип	enum	Тип приближения расположения. Всегда approximate. Возможные значения: approximate	Нет

OpenAI.WebSearchToolFilters

Name	Type	Description	Обязательный	По умолчанию
allowed_domains	массив строк		Нет

OpenAI.integer

Тип: целое число

Формат: int64

OpenAI.numeric

Тип: число

Формат: double

OpenApiAnonymousAuthDetails

Сведения о безопасности для анонимной проверки подлинности OpenApi

Name	Type	Description	Обязательный	По умолчанию
type	enum	Тип объекта, который всегда является анонимным. Возможные значения: anonymous	Да

OpenApiAuthDetails

сведения о проверке подлинности для OpenApiFunctionDefinition

Дискриминация для OpenApiAuthDetails

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа	Schema
anonymous	OpenApiAnonymousAuthDetails
project_connection	OpenApiProjectConnectionAuthDetails
managed_identity	OpenApiManagedAuthDetails

Name	Type	Description	Обязательный	По умолчанию
type	OpenApiAuthType	Тип аутентификации для конечной точки OpenApi. Допустимые типы: — анонимный (проверка подлинности не требуется) — подключение Project (требуется project_connection_id к конечной точке, как настройка в AI Foundry) — Managed_Identity (требуется аудитория для проверки подлинности на основе удостоверений)	Да

OpenApiAuthType

Тип аутентификации для конечной точки OpenApi. Допустимые типы:

• Анонимный (аутентификация не требуется)
• Project Соединение (требует project_connection_id для конечной точки, как это установлено в AI Foundry)
• Managed_Identity (требуется аудитория для аутентификации на основе удостоверений)

Property	Ценность
Description	Тип аутентификации для конечной точки OpenApi. Допустимые типы: — анонимный (проверка подлинности не требуется) — подключение Project (требуется project_connection_id к конечной точке, как настройка в AI Foundry) — Managed_Identity (требуется аудитория для проверки подлинности на основе удостоверений)
Type	строка
Значения	anonymous project_connection managed_identity

OpenApiFunctionDefinition

Сведения об определении входных данных для функции openapi.

Name	Type	Description	Обязательный	По умолчанию
auth	OpenApiAuthDetails	сведения о проверке подлинности для OpenApiFunctionDefinition	Да
└─ Тип	OpenApiAuthType	Тип проверки подлинности должен быть анонимным/project_connection/managed_identity	Да
default_params	массив строк	Список параметров спецификации OpenAPI, которые будут использовать предоставленные пользователем значения по умолчанию	Нет
описание	строка	Описание того, что выполняет функция, используемая моделью для выбора времени и способа вызова функции.	Нет
functions	массив объекта	Список определений функций, используемых средством OpenApi	Нет
имя	строка	Имя вызываемой функции.	Да
spec	object	Фигура функции openapi, описанная как объект схемы JSON.	Да

OpenApiManagedAuthDetails

Сведения о безопасности для проверки подлинности OpenApi managed_identity

Name	Type	Description	Обязательный	По умолчанию
security_scheme	OpenApiManagedSecurityScheme	Схема безопасности для проверки подлинности OpenApi managed_identity	Да
Аудитория └️	строка	Область проверки подлинности для типа проверки подлинности managed_identity	Да
type	enum	Тип объекта, который всегда является "managed_identity". Возможные значения: managed_identity	Да

OpenApiManagedSecurityScheme

Схема безопасности для проверки подлинности OpenApi managed_identity

Name	Type	Description	Обязательный	По умолчанию
audience	строка	Область проверки подлинности для типа проверки подлинности managed_identity	Да

OpenApiProjectConnectionAuthDetails

Сведения о безопасности для проверки подлинности подключения OpenApi project

Name	Type	Description	Обязательный	По умолчанию
security_scheme	OpenApiProjectConnectionSecurityScheme	Схема безопасности для проверки подлинности OpenApi managed_identity	Да
└project_connection_id	строка	идентификатор подключения Project для типа проверки подлинности подключения Project	Да
type	enum	Тип объекта, который всегда является "project_connection". Возможные значения: project_connection	Да

OpenApiProjectConnectionSecurityScheme

Схема безопасности для проверки подлинности OpenApi managed_identity

Name	Type	Description	Обязательный	По умолчанию
project_connection_id	строка	идентификатор подключения Project для типа проверки подлинности подключения Project	Да

OpenApiTool

Сведения об определении входных данных для средства OpenAPI, используемого для настройки агента.

Name	Type	Description	Обязательный	По умолчанию
openapi	OpenApiFunctionDefinition	Сведения об определении входных данных для функции openapi.	Да
└️ аутентификация	OpenApiAuthDetails	Сведения о проверке подлинности API	Да
└️ default_params	массив строк	Список параметров спецификации OpenAPI, которые будут использовать предоставленные пользователем значения по умолчанию	Нет
└─ Описание	строка	Описание того, что выполняет функция, используемая моделью для выбора времени и способа вызова функции.	Нет
Функции └️	массив объекта (только для чтения)	Список определений функций, используемых средством OpenApi	Нет
└─ Описание	строка	Описание того, что выполняет функция, используемая моделью для выбора времени и способа вызова функции.	Нет
└️ имя	строка	Имя вызываемой функции.	Да
└️ Параметры	object	Параметры, которые принимают функции, описаны как объект схемы JSON.	Да
└️ имя	строка	Имя вызываемой функции.	Да
└️ спецификация	object	Фигура функции openapi, описанная как объект схемы JSON.	Да
type	enum	Тип объекта, которым всегда является 'openapi'. Возможные значения: openapi	Да

PageOrder

Property	Ценность
Type	строка
Значения	asc desc

PagedConnection

Коллекция элементов подключения со страницами

Name	Type	Description	Обязательный	По умолчанию
nextLink	строка	Ссылка на следующую страницу элементов	Нет
value	массив подключения	Элементы подключения на этой странице	Да

PagedDatasetVersion

Коллекция элементов DatasetVersion со страницами

Name	Type	Description	Обязательный	По умолчанию
nextLink	строка	Ссылка на следующую страницу элементов	Нет
value	массив DatasetVersion	Элементы DatasetVersion на этой странице	Да

PagedDeployment

Коллекция элементов развертывания со страницами

Name	Type	Description	Обязательный	По умолчанию
nextLink	строка	Ссылка на следующую страницу элементов	Нет
value	массив развертывания	Элементы развертывания на этой странице	Да

PagedEvaluationRule

Коллекция paged элементов EvaluationRule

Name	Type	Description	Обязательный	По умолчанию
nextLink	строка	Ссылка на следующую страницу элементов	Нет
value	массив EvaluationRule	Элементы EvaluationRule на этой странице	Да

PagedEvaluationTaxonomy

Коллекция paged элементов EvaluationTaxonomy

Name	Type	Description	Обязательный	По умолчанию
nextLink	строка	Ссылка на следующую страницу элементов	Нет
value	массив EvaluationTaxonomy	Элементы EvaluationTaxonomy на этой странице	Да

PagedEvaluatorVersion

Коллекция paged элементов ScoreorVersion

Name	Type	Description	Обязательный	По умолчанию
nextLink	строка	Ссылка на следующую страницу элементов	Нет
value	массив оценкиVersion	Элементы ScoreorVersion на этой странице	Да

PagedIndex

Коллекция элементов Индекса со страницами

Name	Type	Description	Обязательный	По умолчанию
nextLink	строка	Ссылка на следующую страницу элементов	Нет
value	массив индекса	Элементы индекса на этой странице	Да

PagedInsight

Коллекция элементов Аналитики со страницами

Name	Type	Description	Обязательный	По умолчанию
nextLink	строка	Ссылка на следующую страницу элементов	Нет
value	массив аналитических сведений	Элементы аналитики на этой странице	Да

PagedRedTeam

Коллекция paged элементов RedTeam

Name	Type	Description	Обязательный	По умолчанию
nextLink	строка	Ссылка на следующую страницу элементов	Нет
value	массив RedTeam	Элементы RedTeam на этой странице	Да

PagedSchedule

Коллекция элементов Schedule

Name	Type	Description	Обязательный	По умолчанию
nextLink	строка	Ссылка на следующую страницу элементов	Нет
value	массив schedule	Элементы расписания на этой странице	Да

PagedScheduleRun

Коллекция страниц элементов ScheduleRun

Name	Type	Description	Обязательный	По умолчанию
nextLink	строка	Ссылка на следующую страницу элементов	Нет
value	массив ScheduleRun	Элементы ScheduleRun на этой странице	Да

PendingUploadRequest

Представляет запрос на ожидающую загрузку.

Name	Type	Description	Обязательный	По умолчанию
connectionName	строка	Имя подключения учетной записи хранения Azure для создания временного маркера SAS	Нет
pendingUploadId	строка	Если PendingUploadId не указан, будет использоваться случайный идентификатор GUID.	Нет
pendingUploadType	enum	BlobReference — единственный поддерживаемый тип. Возможные значения: BlobReference	Да

ОжиданиеUploadResponse

Представляет ответ на ожидающий запрос на загрузку

Name	Type	Description	Обязательный	По умолчанию
BLOBReference	BlobReference	Сведения о ссылке на BLOB-объекты.	Да
└️ blobUri	строка	Путь URI большого двоичного объекта для клиента для отправки данных. Пример: https://blob.windows.core.net/Container/Path	Да
Учетные данные └️	SasCredential	Учетные данные для доступа к учетной записи хранения.	Да
└️ storageAccountArmId	строка	Идентификатор ARM учетной записи хранения, используемой.	Да
pendingUploadId	строка	ID для этого запроса на загрузку.	Да
pendingUploadType	enum	BlobReference — единственный поддерживаемый тип Возможные значения: BlobReference	Да
version	строка	Версия актива, которая должна быть создана, если пользователь не указал версию при первоначальном создании загрузки	Нет

PromptAgentDefinition

Определение агента запроса

Name	Type	Description	Обязательный	По умолчанию
instructions	Строка (нулевая)	Сообщение системы (или разработчика), вставленное в контекст модели.	Нет
kind	enum	Возможные значения: prompt	Да
модель	строка	Модель развертывания, используемая для этого агента.	Да
rai_config	RaiConfig	Конфигурация для фильтрации содержимого и функций безопасности Responsible AI (RAI).	Нет
└rai_policy_name	строка	Имя политики RAI, применяемой.	Да
reasoning	OpenAI.Reasoning (nullable)	Только модели gpt-5 и o-series Параметры конфигурации для модели рассуждений.	Нет
- усилия	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	enum	Возможные значения: auto, concisedetailed	Нет
└️ сводка	enum	Возможные значения: auto, concisedetailed	Нет
structured_inputs	object	Набор структурированных входных данных, которые могут участвовать в подстановке шаблона или привязке аргументов инструмента.	Нет
Температура	number	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным. Как правило, мы рекомендуем изменить это или top_p, но не и то и другое.	Нет	1
text	PromptAgentDefinitionTextOptions	Параметры конфигурации для текстового ответа модели. Можно использовать обычный текст или структурированные данные JSON.	Нет
└─ Формат	OpenAI.TextResponseFormatConfiguration	Объект, указывающий формат, который должен выводить модель. Настройка { "type": "json_schema" } позволяет использовать структурированные выходные данные, это гарантирует, что модель будет соответствовать предоставленной схеме JSON. Узнайте больше в разделе Формат по умолчанию — это { "type": "text" } без дополнительных параметров. *Не рекомендуется для gpt-4o и более новых моделей:** Установка { "type": "json_object" } включает старый режим JSON, который гарантирует, что сообщение, которое создает модель, является допустимым JSON. С использованием json_schema предпочтителен для моделей, поддерживающих его.	Нет
выбор инструмента	string или OpenAI.ToolChoiceParam	Как модель должна выбрать средство (или инструменты), которое следует использовать при создании ответа. Просмотрите tools параметр, чтобы узнать, как указать, какие средства модель может вызывать.	Нет
tools	массив OpenAI.Tool	Массив инструментов, которые модель может вызывать при создании ответа. Вы может указать, какое средство следует использовать, задав tool_choice параметр.	Нет
top_p	number	Альтернатива выборке с температурой, называемой выборкой ядра, где модель рассматривает результаты маркеров с вероятностью top_p масса. Таким образом, 0,1 означает только токены, составляющие верхние 10% массы вероятности%. считаются. Как правило, мы рекомендуем изменить это или temperature, но не и то и другое.	Нет	1

PromptAgentDefinitionTextOptions

Параметры конфигурации для текстового ответа модели. Можно использовать обычный текст или структурированные данные JSON.

Name	Type	Description	Обязательный	По умолчанию
format	OpenAI.TextResponseFormatConfiguration	Объект, указывающий формат, который должен выводить модель. Настройка { "type": "json_schema" } позволяет использовать структурированные выходные данные, это гарантирует, что модель будет соответствовать предоставленной схеме JSON. Узнайте больше в разделе Формат по умолчанию — это { "type": "text" } без дополнительных параметров. *Не рекомендуется для gpt-4o и более новых моделей:** Установка { "type": "json_object" } включает старый режим JSON, который гарантирует, что сообщение, которое создает модель, является допустимым JSON. С использованием json_schema предпочтителен для моделей, поддерживающих его.	Нет

PromptBasedEvaluatorDefinition

Оценщик на основе подсказок

Name	Type	Description	Обязательный	По умолчанию
data_schema	object	Схема JSON (проект 2020-12) для входных данных оценщика. Это включает в себя такие параметры, как тип, свойства, обязательные.	Нет
init_parameters	object	Схема JSON (проект 2020-12) для входных параметров оценщика. Это включает в себя такие параметры, как тип, свойства, обязательные.	Нет
metrics	object	Список выходных метрик, полученных данным оценщиком	Нет
prompt_text	строка	Текст запроса, используемый для оценки	Да
type	enum	Возможные значения: prompt	Да

ProtocolVersionRecord

Сопоставление записей для одного протокола и его версии.

Name	Type	Description	Обязательный	По умолчанию
protocol	AgentProtocol		Да
version	строка	Строка версии для протокола, например "v0.1.1".	Да

RaiConfig

Конфигурация для фильтрации содержимого и функций безопасности Responsible AI (RAI).

Name	Type	Description	Обязательный	По умолчанию
rai_policy_name	строка	Имя политики RAI, применяемой.	Да

RecurrenceSchedule

Модель графика повторения.

Дискриминация для повторенияSchedule

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа	Schema
Hourly	HourlyRecurrenceSchedule
Daily	DailyRecurrenceSchedule
Weekly	WeeklyRecurrenceSchedule
Monthly	MonthlyRecurrenceSchedule

Name	Type	Description	Обязательный	По умолчанию
type	Повторение типа	Тип рецидива.	Да

RecurrenceTrigger

Триггер на основе рецидива.

Name	Type	Description	Обязательный	По умолчанию
endTime	строка	Время окончания графика повторения в формате ISO 8601.	Нет
interval	целое число	Интервал для графика повторения.	Да
schedule	RecurrenceSchedule	Модель графика повторения.	Да
└─ Тип	Повторение типа	Тип повторения для расписания повторения.	Да
startTime	строка	Время начала составления графика повторения в формате ISO 8601.	Нет
timeZone	строка	Часовой пояс для расписания повторения.	Нет	UTC
type	enum	Тип спускового крючка. Возможные значения: Recurrence	Да

RecurrenceType

Тип рецидива.

Property	Ценность
Description	Тип рецидива.
Type	строка
Значения	Hourly Daily Weekly Monthly

RedTeam

Красная команда.

Name	Type	Description	Обязательный	По умолчанию
applicationScenario	строка	Сценарий приложения для операции красной команды для создания конкретных атак сценария.	Нет
атакиStrategies	массив АтакStrategy	Список стратегий атак или вложенных списков стратегий атак.	Нет
displayName	строка	Имя запуска red-team.	Нет
id	строка (только для чтения)	Идентификатор запуска красной команды.	Да
numTurns	целое число	Количество округлений моделирования.	Нет
properties	object	Свойства красной команды. В отличие от тегов, свойства являются только надстройками. После добавления свойство невозможно удалить.	Нет
Категории рисков	массив RiskCategory	Список категорий рисков для создания целей атаки.	Нет
имитацияOnly	boolean	Только имитация или моделирование + оценка. Значение false по умолчанию, если значение true для беседы сканирования не выполняется вычисление.	Нет	Неправда
Статус	строка (только для чтения)	Состояние красной команды. Он устанавливается службой и доступен только для чтения.	Нет
tags	object	Теги красной команды. В отличие от свойств, теги полностью изменяются.	Нет
target	TargetConfig	Абстрактный класс для целевой конфигурации.	Да
└─ Тип	строка	Тип конфигурации модели.	Да

RedTeamEvalRunDataSource

Name	Type	Description	Обязательный	По умолчанию
item_generation_params	ItemGenerationParams	Представляет набор параметров, используемых для управления операциями создания элементов.	Да
└─ Тип	ItemGenerationParamsType	Тип параметров создания элементов, используемых.	Да
target	Цель	Базовый класс для целей с поддержкой дискриминаторов.	Да
└─ Тип	строка	Тип целевого объекта.	Да
type	enum	Тип источника данных. Всегда azure_ai_red_team. Возможные значения: azure_ai_red_team	Да

RedTeamItemGenerationParams

Name	Type	Description	Обязательный	По умолчанию
attack_strategies	массив АтакStrategy	Коллекция стратегий атак, которые следует использовать.	Да
num_turns	целое число	Количество поворотов, разрешенных в игре.	Да	20
type	enum	Тип параметров создания элементов. Возможные значения: red_team	Да

RedTeamSeedPromptsItemGenerationParams

Представляет параметры для создания элементов с начальным значением красной команды.

Name	Type	Description	Обязательный	По умолчанию
attack_strategies	массив АтакStrategy	Коллекция стратегий атак, которые следует использовать.	Да
num_turns	целое число	Количество поворотов, разрешенных в игре.	Да	20
Источник	OpenAI.EvalJsonlFileContentSource		Да
└─ Содержимое	массив OpenAI.EvalJsonlFileContentSourceContent	Содержимое jsonl-файла.	Да
└─ Тип	enum	Тип источника jsonl. Всегда file_content. Возможные значения: file_content	Да
type	enum	Тип параметров создания элементов всегда red_team_seed_prompts. Возможные значения: red_team_seed_prompts	Да

RedTeamTaxonomyItemGenerationParams

Представляет параметры для создания элементов таксономии красной команды.

Name	Type	Description	Обязательный	По умолчанию
attack_strategies	массив АтакStrategy	Коллекция стратегий атак, которые следует использовать.	Да
num_turns	целое число	Количество поворотов, разрешенных в игре.	Да	20
Источник	OpenAI.EvalJsonlFileContentSource		Да
└─ Содержимое	массив OpenAI.EvalJsonlFileContentSourceContent	Содержимое jsonl-файла.	Да
└─ Тип	enum	Тип источника jsonl. Всегда file_content. Возможные значения: file_content	Да
type	enum	Тип параметров создания элементов всегда red_team_taxonomy. Возможные значения: red_team_taxonomy	Да

ResponseRetrievalItemGenerationParams

Представляет параметры для создания элемента извлечения ответа.

Name	Type	Description	Обязательный	По умолчанию
сопоставление данных	object	Сопоставление из исходных полей в поле response_id, необходимое для получения журнала чата.	Да
max_num_turns	целое число	Максимальное количество поворотов журнала чата для вычисления.	Да
Источник	OpenAI.EvalJsonlFileContentSource или OpenAI.EvalJsonlFileIdSource	Источник, из которого считывается содержимое JSONL.	Да
type	enum	Тип параметров создания элементов всегда response_retrieval. Возможные значения: response_retrieval	Да

RiskCategory

Категория риска для цели атаки.

Property	Ценность
Description	Категория риска для цели атаки.
Type	строка
Значения	HateUnfairness Violence Sexual SelfHarm ProtectedMaterial CodeVulnerability UngroundedAttributes ProhibitedActions SensitiveDataLeakage TaskAdherence

SASCredentials

Определение учетных данных подписанного URL-адреса (SAS)

Name	Type	Description	Обязательный	По умолчанию
SAS	строка (только для чтения)	Маркер SAS	Нет
type	enum	Тип учетных данных Возможные значения: SAS	Да

SampleType

Тип пробы, используемой при анализе.

Property	Ценность
Description	Тип пробы, используемой при анализе.
Type	строка
Значения	EvaluationResultSample

SasCredential

Определение учетных данных SAS

Name	Type	Description	Обязательный	По умолчанию
sasUri	строка (только для чтения)	URI SAS	Да
type	enum	Тип учетных данных Возможные значения: SAS	Да

Schedule

Модель расписания.

Name	Type	Description	Обязательный	По умолчанию
описание	строка	Описание расписания.	Нет
displayName	строка	Имя расписания.	Нет
enabled	boolean	Включено состояние расписания.	Да
id	строка (только для чтения)	Идентификатор расписания.	Да
properties	object	Свойства расписания. В отличие от тегов, свойства являются только надстройками. После добавления свойство невозможно удалить.	Нет
provisioningStatus	ScheduleProvisioningStatus (только для чтения)	Состояние подготовки расписания.	Нет
данные системы	object (только для чтения)	Системные метаданные ресурса.	Да
tags	object	Теги расписания. В отличие от свойств, теги полностью изменяются.	Нет
Задача	ScheduleTask	Модель задачи планирования.	Да
Конфигурация └️	object	Конфигурация для задачи.	Нет
└─ Тип	ScheduleTaskType	Тип задачи.	Да
trigger	Trigger	Базовая модель для триггера расписания.	Да
└─ Тип	TriggerType	Тип спускового крючка.	Да

ScheduleProvisioningStatus

Состояние подготовки расписания.

Property	Ценность
Description	Состояние подготовки расписания.
Type	строка
Значения	Creating Updating Deleting Succeeded Failed

ScheduleRun

Модель прогона по расписанию.

Name	Type	Description	Обязательный	По умолчанию
error	строка (только для чтения)	Сведения об ошибке для выполнения расписания.	Нет
id	строка (только для чтения)	Идентификатор выполнения расписания.	Да
properties	object (только для чтения)	Свойства выполнения расписания.	Да
scheduleId	строка	Идентификатор расписания.	Да
success	boolean (только для чтения)	Состояние успешности запуска расписания.	Да
triggerTime	строка	Время запуска расписания.	Нет

Запланированная задача

Модель задачи планирования.

Дискриминация для ScheduleTask

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа	Schema
Evaluation	EvaluationScheduleTask
Insight	InsightsScheduleTask

Name	Type	Description	Обязательный	По умолчанию
configuration	object	Конфигурация для задачи.	Нет
type	ScheduleTaskType	Тип задачи.	Да

ScheduleTaskType

Тип задачи.

Property	Ценность
Description	Тип задачи.
Type	строка
Значения	Evaluation Insight

SharepointGroundingToolParameters

Параметры инструмента заземления SharePoint.

Name	Type	Description	Обязательный	По умолчанию
project_connections	массив ToolProjectConnection	Подключения project, подключенные к этому средству. Может быть не более 1 подключения ресурс, подключенный к средству.	Нет

SharepointPreviewTool

Сведения об определении входных данных для инструмента SharePoint, используемого для настройки агента.

Name	Type	Description	Обязательный	По умолчанию
sharepoint_grounding_preview	SharepointGroundingToolParameters	Параметры инструмента заземления SharePoint.	Да
└project_connections project_connections	массив ToolProjectConnection	Подключения project, подключенные к этому средству. Может быть не более 1 подключения ресурс, подключенный к средству. Ограничения: maxItems: 1	Нет
type	enum	Тип объекта, который всегда является «sharepoint_grounding_preview». Возможные значения: sharepoint_grounding_preview	Да

Sku

Сведения о номере SKU

Name	Type	Description	Обязательный	По умолчанию
capacity	целое число	Емкость SKU	Да
family	строка	Семейство Sku	Да
имя	строка	Имя SKU	Да
size	строка	Размер SKU	Да
tier	строка	Уровень SKU	Да

StructuredInputDefinition

Структурированные входные данные, которые могут участвовать в подстановках шаблонов и привязке аргументов инструмента.

Name	Type	Description	Обязательный	По умолчанию
default_value		Значение по умолчанию для входных данных, если значение времени выполнения не указано.	Нет
описание	строка	Удобочитаемое описание входных данных.	Нет
required	boolean	Является ли входное свойство обязательным при вызове агента.	Нет	Неправда
schema	object	Схема JSON для структурированных входных данных (необязательно).	Нет

StructuredOutputDefinition

Структурированные выходные данные, которые можно создать агентом.

Name	Type	Description	Обязательный	По умолчанию
описание	строка	Описание выходных данных для выдачи. Используется моделью для определения времени выдачи выходных данных.	Да
имя	строка	Имя структурированных выходных данных.	Да
schema	object	Схема JSON для структурированных выходных данных.	Да
строгий	Булев (нулируемый)	Следует ли применять строгую проверку. trueпо умолчанию.	Да

StructuredOutputsOutputItem

Name	Type	Description	Обязательный	По умолчанию
agent_reference	AgentReference		Нет
└️ имя	строка	Имя агента. Ограничения: maxLength: 256	Да
└─ Тип	enum	Возможные значения: agent_reference	Да
└─ Версия	строка	Идентификатор версии агента.	Нет
output		Структурированные выходные данные, захваченные во время ответа.	Да
response_id	строка	Ответ, на котором создается элемент.	Нет
type	enum	Возможные значения: structured_outputs	Да

SyntheticDataGenerationPreviewEvalRunDataSource

Представляет источник данных для выполнения оценки, который оценивается на основе созданных искусственных данных для тестирования.

Name	Type	Description	Обязательный	По умолчанию
входные_сообщения	OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate		Нет
└─ Шаблон	массив объекта или OpenAI.EvalItem		Да
└─ Тип	enum	Возможные значения: template	Да
item_generation_params	SyntheticDataGenerationPreviewItemGenerationParams		Да
└️ model_deployment_name	строка	Имя развертывания модели, используемого для создания синтетических данных.	Да
└output_dataset_id	строка (только для чтения)	Идентификатор выходного набора данных, в котором хранятся созданные искусственные данные. Созданные данные — это jsonl-файл с идентификатором столбцов, запросом и test_description.	Нет
└️ output_dataset_name	строка	Имя выходного набора данных, в котором будут храниться созданные искусственные данные. Если оно не указано, служба автоматически создает имя набора данных.	Нет
└─ Запрос	строка	Запрос, используемый для создания синтетических данных. Это параметр, если целевой объект имеет тип "azure_ai_agent" с инструкциями, настроенными в агенте.	Нет
└samples_count	целое число	Максимальное количество генерируемых примеров данных.	Да
Источники └️	массив OpenAI.EvalJsonlFileIdSource	Необязательные файлы источника содержимого начального содержимого для создания данных.	Да
└─ Тип	enum	Тип параметров создания элементов. Возможные значения: synthetic_data_gen_preview	Да
target	Цель	Базовый класс для целей с поддержкой дискриминаторов.	Да
└─ Тип	строка	Тип целевого объекта.	Да
type	enum	Тип источника данных всегда azure_ai_synthetic_data_gen_preview. Возможные значения: azure_ai_synthetic_data_gen_preview	Да

SyntheticDataGenerationPreviewItemGenerationParams

Name	Type	Description	Обязательный	По умолчанию
model_deployment_name	строка	Имя развертывания модели, используемого для создания синтетических данных.	Да
output_dataset_id	строка (только для чтения)	Идентификатор выходного набора данных, в котором хранятся созданные искусственные данные. Созданные данные — это jsonl-файл с идентификатором столбцов, запросом и test_description.	Нет
output_dataset_name	строка	Имя выходного набора данных, в котором будут храниться созданные искусственные данные. Если оно не указано, служба автоматически создает имя набора данных.	Нет
prompt	строка	Запрос, используемый для создания синтетических данных. Это параметр, если целевой объект имеет тип "azure_ai_agent" с инструкциями, настроенными в агенте.	Нет
samples_count	целое число	Максимальное количество генерируемых примеров данных.	Да
Источников	массив OpenAI.EvalJsonlFileIdSource	Необязательные файлы источника содержимого начального содержимого для создания данных.	Да
type	enum	Тип параметров создания элементов. Возможные значения: synthetic_data_gen_preview	Да

Цель

Базовый класс для целей с поддержкой дискриминаторов.

Дискриминация для целевого объекта

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа	Schema
azure_ai_model	AzureAIModelTarget
azure_ai_agent	AzureAIAgentTarget

Name	Type	Description	Обязательный	По умолчанию
type	строка	Тип целевого объекта.	Да

TargetCompletionEvalRunDataSource

Представляет источник данных для целевой конфигурации оценки завершения.

Name	Type	Description	Обязательный	По умолчанию
входные_сообщения	OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference		Нет
└─ ссылка_на_элемент	строка		Да
└─ Тип	enum	Возможные значения: item_reference	Да
Источник	OpenAI.EvalJsonlFileContentSource или OpenAI.EvalJsonlFileIdSource	Исходная конфигурация для встроенных или файловой данных.	Да
target	Цель	Базовый класс для целей с поддержкой дискриминаторов.	Да
└─ Тип	строка	Тип целевого объекта.	Да
type	enum	Тип источника данных всегда azure_ai_target_completions. Возможные значения: azure_ai_target_completions	Да

TargetConfig

Абстрактный класс для целевой конфигурации.

Дискриминация для TargetConfig

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа	Schema
AzureOpenAIModel	AzureOpenAIModelConfiguration

Name	Type	Description	Обязательный	По умолчанию
type	строка	Тип конфигурации модели.	Да

TargetUpdate

Базовый класс для целей с поддержкой дискриминаторов.

Дискриминация для TargetUpdate

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа	Schema
azure_ai_model	AzureAIModelTargetUpdate
azure_ai_agent	AzureAIAgentTargetUpdate

Name	Type	Description	Обязательный	По умолчанию
type	строка	Тип целевого объекта.	Да

ТаксономияCategory

Определение категории таксономии.

Name	Type	Description	Обязательный	По умолчанию
описание	строка	Описание категории таксономии.	Нет
id	строка	Уникальный идентификатор категории таксономии.	Да
имя	строка	Имя категории таксономии.	Да
properties	object	Дополнительные свойства для категории таксономии.	Нет
riskCategory	RiskCategory	Категория риска для цели атаки.	Да
Подкатегории	массив TaxonomySubCategory	Список подкатегорий таксономии.	Да

ТаксономияSubCategory

Определение подкатегории таксономии.

Name	Type	Description	Обязательный	По умолчанию
описание	строка	Описание подкатегомии таксономии.	Нет
enabled	boolean	Список элементов таксономии в этой подкатеголии.	Да
id	строка	Уникальный идентификатор подкатегои таксономии.	Да
имя	строка	Имя подкатегомии таксономии.	Да
properties	object	Дополнительные свойства для подкатеголии таксономии.	Нет

ToolDescription

Описание инструмента, который может быть использован агентом.

Name	Type	Description	Обязательный	По умолчанию
описание	строка	Краткое описание цели инструмента.	Нет
имя	строка	Имя средства.	Нет

ToolProjectConnection

Ресурс подключения project.

Name	Type	Description	Обязательный	По умолчанию
project_connection_id	строка	Подключение проекта в ToolProjectConnectionList, подключенном к этому инструменту.	Да

TracesPreviewEvalRunDataSource

Представляет источник данных для вычислений, работающих над трассировками агента, хранящимися в Application Insights.

Name	Type	Description	Обязательный	По умолчанию
agent_id	строка	Идентификатор агента, используемый для фильтрации трассировок для оценки.	Нет
agent_name	строка	Имя агента, используемое для фильтрации трассировок для оценки.	Нет
время окончания	целое число	Метка времени Unix (в секундах) помечает конец окна запроса трассировки. По умолчанию используется текущее время.	Нет
ingestion_delay_seconds	целое число	Задержка, применяемая к приему при запросе трассировок.	Нет	300
lookback_hours	целое число	Окно обратного просмотра (в часах) применяется при получении трассировок из Application Insights. Для запланированных вычислений это выводится из интервала повторения.	Нет	168
max_traces	целое число	Ограничение выборки, применяемое к трассировкам, извлеченным для оценки.	Нет	1000
trace_ids	массив строк	Коллекция идентификаторов трассировки агента, которые следует оценить.	Нет
type	enum	Тип источника данных всегда azure_ai_traces_preview. Возможные значения: azure_ai_traces_preview	Да

TreatmentEffectType

Тип эффекта лечения.

Property	Ценность
Description	Тип эффекта лечения.
Type	строка
Значения	TooFewSamples Inconclusive Changed Improved Degraded

Trigger

Базовая модель для триггера расписания.

Дискриминация для триггера

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа	Schema
Cron	КранТриггер
Recurrence	повторения
OneTime	OneTimeTrigger

Name	Type	Description	Обязательный	По умолчанию
type	TriggerType	Тип спускового крючка.	Да

Тип триггера

Тип спускового крючка.

Property	Ценность
Description	Тип спускового крючка.
Type	строка
Значения	Cron Recurrence OneTime

UpdateAgentFromManifestRequest

Name	Type	Description	Обязательный	По умолчанию
описание	строка	Понятное описание агента. Ограничения: maxLength: 512	Нет
manifest_id	строка	Идентификатор манифеста для импорта версии агента из.	Да
metadata	object	Набор из 16 пар "ключ-значение", которые можно прикрепить к объекту. Это может быть Полезно для хранения дополнительных сведений об объекте в структурированном виде. форматирование и запрос объектов через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — строки с максимальной длиной 512 символов.	Нет
parameter_values	object	Входные данные манифеста, которые будут приводить к полностью материализованному агенту.	Да

UpdateAgentRequest

Name	Type	Description	Обязательный	По умолчанию
Определение	AgentDefinition		Да
└️ вид	AgentKind		Да
└️ rai_config	RaiConfig	Конфигурация для фильтрации содержимого и функций безопасности Responsible AI (RAI).	Нет
описание	строка	Понятное описание агента. Ограничения: maxLength: 512	Нет
metadata	object	Набор из 16 пар "ключ-значение", которые можно прикрепить к объекту. Это может быть Полезно для хранения дополнительных сведений об объекте в структурированном виде. форматирование и запрос объектов через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — строки с максимальной длиной 512 символов.	Нет

UpdateEvalParametersBody

Name	Type	Description	Обязательный	По умолчанию
metadata	OpenAI.Metadata (nullable)	Набор из 16 пар "ключ-значение", которые можно прикрепить к объекту. Это может быть Полезно для хранения дополнительных сведений об объекте в структурированном виде. форматирование и запрос объектов через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — строки с максимальной длиной 512 символов.	Нет
имя	строка		Нет
properties	object	Набор неизменяемых пар "ключ-значение", которые могут быть присоединены к объекту для хранения дополнительных сведений. Ключи — это строки с максимальной длиной 64 символов. Значения — это строки с максимальной длиной 512 символов.	Нет

UserProfileMemoryItem

Элемент памяти, содержащий информацию профиля пользователя, извлеченную из бесед, такую как предпочтения, интересы и личные данные.

Name	Type	Description	Обязательный	По умолчанию
содержимое	строка	Содержимое памяти.	Да
kind	enum	Тип элемента памяти. Возможные значения: user_profile	Да
memory_id	строка	Уникальный идентификатор элемента памяти.	Да
scope	строка	Пространство имен, которое логически группирует и изолирует воспоминания, например идентификатор пользователя.	Да
updated_at	целое число	Время последнего обновления элемента памяти.	Да

WebSearchConfiguration

Конфигурация поиска в Интернете для bing пользовательского поиска

Name	Type	Description	Обязательный	По умолчанию
instance_name	строка	Имя настраиваемого экземпляра конфигурации, заданного для конфигурации.	Да
project_connection_id	строка	идентификатор подключения Project для приземления с помощью пользовательского поиска bing	Да

WeeklyRecurrenceSchedule

Еженедельный график повторения.

Name	Type	Description	Обязательный	По умолчанию
daysOfWeek	массив DayOfWeek	Дни недели для расписания повторения.	Да
type	enum	Еженедельный тип повторения. Возможные значения: Weekly	Да

WorkflowActionOutputItem

Name	Type	Description	Обязательный	По умолчанию
action_id	строка	Уникальный идентификатор действия.	Да
agent_reference	AgentReference		Нет
└️ имя	строка	Имя агента. Ограничения: maxLength: 256	Да
└─ Тип	enum	Возможные значения: agent_reference	Да
└─ Версия	строка	Идентификатор версии агента.	Нет
kind	строка	Тип действия CSDL (например, SetVariable, InvokeAzureAgent).	Да
parent_action_id	строка	Идентификатор родительского действия, если это вложенное действие.	Нет
previous_action_id	строка	Идентификатор предыдущего действия, если это действие следует другому.	Нет
response_id	строка	Ответ, на котором создается элемент.	Нет
Статус	enum	Состояние действия (например, "in_progress", "завершено", "не удалось", "отменено". Возможные значения: completed, , failedin_progresscancelled	Да
type	enum	Возможные значения: workflow_action	Да

WorkflowAgentDefinition

Определение агента рабочего процесса.

Name	Type	Description	Обязательный	По умолчанию
kind	enum	Возможные значения: workflow	Да
rai_config	RaiConfig	Конфигурация для фильтрации содержимого и функций безопасности Responsible AI (RAI).	Нет
└rai_policy_name	строка	Имя политики RAI, применяемой.	Да
workflow	строка	Определение YAML CSDL рабочего процесса.	Нет

целое число

Тип: целое число

Формат: int64