Справочник по REST API Azure OpenAI в Microsoft Foundry Models версии 1

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

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

Переменной По умолчанию Описание
Конечной точки Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com

Проверки подлинности

Ключ API

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

Маркеры проверки подлинности

Передайте маркер проверки подлинности с заголовком authorization .

Oauth2authoauth20

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

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

Области:

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

Пакета

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

POST {endpoint}/openai/v1/batches

Создает и выполняет пакет из отправленного файла запросов

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.

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

Имя Обязательно Тип Описание
Принять Истинный Строка
Возможные значения: application/json

Текст запроса

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

Имя Тип Описание Обязательно По умолчанию
completion_window Перечисления Интервал времени, в течение которого должен обрабатываться пакет. Сейчас поддерживается только 24h сейчас.
Возможные значения: 24h		 Да
Конечной точки Перечисления Конечная точка, используемая для всех запросов в пакете. /v1/chat/completions Сейчас поддерживается.
Возможные значения: /v1/chat/completions, /v1/embeddings		 Да
input_file_id Строка Идентификатор отправленного файла, содержащего запросы для нового пакета.



Входной файл должен быть отформатирован как JSON-файл.
и должен быть отправлен с целью batch.		 Нет

Ответы

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

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

Тип контента Тип Описание
application/json Объекта

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Вывод списка пакетов

GET {endpoint}/openai/v1/batches

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

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
После Запроса Нет Строка Курсор для использования в разбиении на страницы. after — это идентификатор объекта, определяющий место в списке.
Например, если вы делаете запрос списка и получаете 100 объектов, заканчивая obj_foo, вашей
последующий вызов может включать after=obj_foo, чтобы получить следующую страницу списка.
Предел Запроса Нет Целое число Ограничение количества возвращаемых объектов. Ограничение может варьироваться от 1 до 100, а также
значение по умолчанию — 20.

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

Имя Обязательно Тип Описание
Принять Истинный Строка
Возможные значения: application/json

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.ListBatchesResponse

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Получение пакета

GET {endpoint}/openai/v1/batches/{batch_id}

Извлекает пакет.

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
batch_id Путь Да Строка Идентификатор извлекаемого пакета.

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

Имя Обязательно Тип Описание
Принять Истинный Строка
Возможные значения: application/json

Ответы

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

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

Тип контента Тип Описание
application/json Объекта

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Отмена пакета

POST {endpoint}/openai/v1/batches/{batch_id}/cancel

Отменяет выполняемый пакет.

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
batch_id Путь Да Строка Идентификатор пакета для отмены.

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

Имя Обязательно Тип Описание
Принять Истинный Строка
Возможные значения: application/json

Ответы

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

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

Тип контента Тип Описание
application/json Объекта

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Чат

Создание завершения чата

POST {endpoint}/openai/v1/chat/completions

Создает завершение чата.

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.

Текст запроса

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

Имя Тип Описание Обязательно По умолчанию
Аудио OpenAI.CreateChatCompletionRequestAudio или null Параметры выходных данных звука. Требуется при запросе выходных данных звука с помощью
modalities: ["audio"].		 Нет
frequency_penalty число или null Число от -2.0 до 2.0. Положительные значения наказывают новые маркеры на основе
их существующую частоту в тексте до сих пор, уменьшая размер модели
вероятность повторения одной и той же строки.		 Нет
function_call string или OpenAI.ChatCompletionFunctionCallOption Не рекомендуется использовать в пользу tool_choice.
Определяет, какая функция (если есть) вызывается моделью.
none означает, что модель не вызовет функцию и вместо этого создает
Сообщение.
auto означает, что модель может выбирать между созданием сообщения или вызовом
Функции.
Указание определенной функции с помощью принудительного выполнения {"name": "my_function"}
модель для вызова этой функции.
none значение по умолчанию, если функции отсутствуют. auto — значение по умолчанию
Значение , если функции присутствуют.		 Нет
Функции массив OpenAI.ChatCompletionFunctions Не рекомендуется использовать в пользу tools.
Список функций, для которые модель может создавать входные данные JSON.		 Нет
logit_bias объект или null Измените вероятность появления указанных маркеров в завершении.
Принимает объект JSON, который сопоставляет маркеры (указанный их идентификатором маркера в
токенизатор) к связанному значению предвзятости от -100 до 100. Математически
Предвзятость добавляется в журналы, созданные моделью до выборки.
Точный эффект зависит от модели, но значения между -1 и 1 должны быть
уменьшение или увеличение вероятности выбора; значения, такие как -100 или 100
должен привести к запрету или эксклюзивному выбору соответствующего маркера.		 Нет
logprobs логический или null Следует ли возвращать вероятности журналов выходных маркеров или нет. Если значение true,
возвращает вероятности журнала каждого выходного маркера, возвращенного в
content messageиз .		 Нет
max_completion_tokens целое число или null Верхняя граница для числа маркеров, которые можно создать для
завершение, включая видимые выходные маркеры и маркеры причин.		 Нет
max_tokens целое число или null Максимальное количество маркеров, которые можно создать в завершении чата.
Это значение можно использовать для управления затратами на текст, созданный с помощью API.

Это значение теперь устарело в пользу max_completion_tokensи имеет значение
несовместимы с моделями серии o1.		 Нет
Сообщения массив OpenAI.ChatCompletionRequestMessage Список сообщений, составляющих беседу до сих пор. В зависимости от
используется модель, поддерживаются различные типы сообщений (модальности),
например текст, изображения и звук.		 Да
Метаданных OpenAI.Metadata или NULL Нет
Условия OpenAI.ResponseModalities Типы выходных данных, которые вы хотите создать модель.
Большинство моделей могут создавать текст, который по умолчанию:
["text"]
Модель gpt-4o-audio-preview также можно использовать для
создайте звук. Запрос на создание этой модели
Можно использовать как текстовые, так и звуковые ответы:
["text", "audio"]		 Нет
Модели Строка Идентификатор модели, используемый для создания ответа, например gpt-4o или o3. OpenAI
предлагает широкий спектр моделей с разными возможностями, производительностью
характеристики и цены. См. руководство по модели
для просмотра и сравнения доступных моделей.		 Да
N целое число или null Сколько вариантов завершения чата для каждого входного сообщения. Обратите внимание, что плата будет взиматься на основе количества созданных маркеров во всех вариантах. Имейте в виду n , чтобы 1 свести к минимуму затраты. Нет
parallel_tool_calls OpenAI.ParallelToolCalls Следует ли включить параллельные вызовы функций во время использования средства. Нет
Прогноз OpenAI.PredictionContent Статическое прогнозируемое выходное содержимое, например содержимое текстового файла, которое является
повторное создание.		 Нет
Содержимое └️ строка или массив OpenAI.ChatCompletionRequestMessageContentPartText Содержимое, которое должно быть сопоставлено при создании ответа модели.
Если созданные маркеры соответствуют этому содержимому, весь ответ модели
можно вернуть гораздо быстрее.		 Да
Тип └️ Перечисления Тип прогнозируемого содержимого, который требуется предоставить. Этот тип является
в настоящее время всегда content.
Возможные значения: content		 Да
presence_penalty число или null Число от -2.0 до 2.0. Положительные значения наказывают новые маркеры на основе
Будут ли они отображаться в тексте до сих пор, увеличивая вероятность модели
говорить о новых темах.		 Нет
prompt_cache_key Строка Используется OpenAI для кэширования ответов для аналогичных запросов для оптимизации частоты попаданий кэша. Заменяет user поле. Дополнительные сведения. Нет
prompt_cache_retention строка или null Нет
reasoning_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.		 Нет
response_format OpenAI.CreateChatCompletionRequestResponseFormat Объект, указывающий формат, который должен выводить модель.
Параметр включения { "type": "json_schema", "json_schema": {...} }
Структурированные выходные данные, обеспечивающие соответствие модели предоставленному JSON
Схемы. Дополнительные сведения см. в разделе "Структурированные выходные данные"
руководство.
Параметр включения { "type": "json_object" } более старого режима JSON, который
гарантирует, что сообщение, которое создает модель, является допустимым JSON. Используя json_schema
предпочтителен для моделей, поддерживающих его.		 Нет
Тип └️ OpenAI.CreateChatCompletionRequestResponseFormatType Да
safety_identifier Строка Стабильный идентификатор, используемый для обнаружения пользователей приложения, которые могут нарушать политики использования OpenAI.
Идентификаторы должны быть строкой, которая однозначно идентифицирует каждого пользователя. Мы рекомендуем хэшировать имя пользователя или адрес электронной почты, чтобы избежать отправки нам каких-либо сведений об идентификации. Дополнительные сведения.		 Нет
Семян целое число или null Эта функция доступна в бета-версии.
Если задано, наша система будет предпринять лучшие усилия для выборки детерминированного, таким образом, что повторяющиеся запросы с одинаковыми и теми же параметрами должны возвращать тот же seed результат.
Детерминированность не гарантируется, и вы должны ссылаться на system_fingerprint параметр ответа для отслеживания изменений в серверной части.		 Нет
Остановить OpenAI.StopConfiguration Не поддерживается с последними моделями o3 причин и o4-mini.
До четырех последовательностей, в которых API перестанет создавать дополнительные маркеры. Teh
Возвращенный текст не будет содержать последовательность остановки.		 Нет
Магазин логический или null Сохранение выходных данных этого запроса завершения чата
используйте в модели дистилляцию или продукты evals.		 Нет
Поток логический или null Если задано значение true, данные ответа модели будут передаваться клиенту.
при создании с помощью событий, отправленных сервером.		 Нет
stream_options OpenAI.ChatCompletionStreamOptions или null Нет
Температура число или null Нет
tool_choice OpenAI.ChatCompletionToolChoiceOption Определяет, какое средство (если таковое) вызывается моделью.
none означает, что модель не будет вызывать какое-либо средство и вместо этого создает сообщение.
auto означает, что модель может выбирать между созданием сообщения или вызовом одного или нескольких инструментов.
required означает, что модель должна вызывать один или несколько инструментов.
Указание определенного средства с помощью {"type": "function", "function": {"name": "my_function"}} принудительного вызова этого средства моделью.
none значение по умолчанию, если средства отсутствуют. auto значение по умолчанию, если существуют средства.		 Нет
Инструменты массив OpenAI.ChatCompletionTool или OpenAI.CustomToolChatCompletions Список инструментов, которые может вызывать модель. Вы можете указать любой из этих вариантов.
пользовательские средства или
средства функции.		 Нет
top_logprobs целое число или null Нет
top_p число или null Нет
Пользователя string (не рекомендуется) Уникальный идентификатор, представляющий конечного пользователя, который может помочь в этом.
мониторинг и обнаружение злоупотреблений.		 Нет
user_security_context AzureUserSecurityContext Контекст безопасности пользователя содержит несколько параметров, описывающих само приложение, и конечный пользователь, взаимодействующий с приложением. Эти поля помогают группам по операциям безопасности исследовать и устранять инциденты безопасности, предоставляя комплексный подход к защите приложений ИИ. Дополнительные сведения о защите приложений ИИ с помощью Microsoft Defender для облака. Нет
Детализации OpenAI.Verbosity Ограничивает детализацию ответа модели. Более низкие значения будут приводить к
более краткие ответы, в то время как более высокие значения приводят к более подробным ответам.
В настоящее время поддерживаются lowзначения , mediumи high.		 Нет

Ответы

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

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

Тип контента Тип Описание
application/json объект или объект

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Примеры

Примере

POST {endpoint}/openai/v1/chat/completions

Дополнений

Создание завершения

POST {endpoint}/openai/v1/completions

Создает завершение.

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.

Текст запроса

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

Имя Тип Описание Обязательно По умолчанию
best_of целое число или null best_of Создает завершения на стороне сервера и возвращает "лучший" (один с наибольшей вероятностью журнала на токен). Результаты нельзя передавать в поток.
При использовании с n, best_of управляет числом завершения кандидатов и n указывает, сколько возвращаемых — best_of должно быть больше n.
Примечание.* Так как этот параметр создает множество завершений, он может быстро использовать квоту маркера. Используйте тщательно и убедитесь, что у вас есть разумные параметры для max_tokens и stop.		 Нет
Эхо логический или null Обратная обратная копия запроса в дополнение к завершению Нет
frequency_penalty число или null Число от -2.0 до 2.0. Положительные значения наказывают новые маркеры на основе их существующей частоты в тексте до сих пор, уменьшая вероятность повторения той же строки.
Дополнительные сведения о частоте и штрафах присутствия.		 Нет
logit_bias объект или null Измените вероятность появления указанных маркеров в завершении.
Принимает объект JSON, который сопоставляет маркеры (указанные идентификатором маркера в маркеризаторе GPT) с соответствующим значением предвзятости от -100 до 100. Математически предвзятость добавляется в логиты, созданные моделью до выборки. Точный эффект зависит от модели, но значения между -1 и 1 должны уменьшить или увеличить вероятность выбора; такие значения, как -100 или 100, должны привести к запрету или эксклюзивному выбору соответствующего маркера.
Например, можно передать {"50256": -100} маркер |endoftext|< для предотвращения >создания маркера |endoftext.		 Нет
logprobs целое число или null Включите вероятности журнала в logprobs наиболее вероятные выходные маркеры, а также выбранные маркеры. Например, если logprobs значение равно 5, API вернет список из пяти наиболее вероятных маркеров. API всегда возвращает logprob пример маркера, поэтому в ответе может быть до logprobs+1 элементов.
Максимальное значение logprobs для 5.		 Нет
max_tokens целое число или null Максимальное количество маркеров может быть создано в завершении.
Количество маркеров запроса плюс max_tokens не может превышать длину контекста модели. Пример кода Python для подсчета маркеров.		 Нет
Модели Строка Идентификатор используемой модели. Api " Список моделей " можно использовать для просмотра всех доступных моделей или просмотра описания моделей. Да
N целое число или null Сколько завершений для каждого запроса.
Примечание.* Так как этот параметр создает множество завершений, он может быстро использовать квоту маркера. Используйте тщательно и убедитесь, что у вас есть разумные параметры для max_tokens и stop.		 Нет
presence_penalty число или null Число от -2.0 до 2.0. Положительные значения наказывают новые маркеры на основе того, отображаются ли они в тексте до сих пор, увеличив вероятность того, что модель будет говорить о новых темах.
Дополнительные сведения о частоте и штрафах присутствия.		 Нет
Строке строка или массив строк или null Нет
Семян целое число или null Если задано, наша система будет предпринять лучшие усилия для выборки детерминированного, таким образом, что повторяющиеся запросы с одинаковыми и теми же параметрами должны возвращать тот же seed результат.
Детерминированность не гарантируется, и вы должны ссылаться на system_fingerprint параметр ответа для отслеживания изменений в серверной части.		 Нет
Остановить OpenAI.StopConfiguration Не поддерживается с последними моделями o3 причин и o4-mini.
До четырех последовательностей, в которых API перестанет создавать дополнительные маркеры. Teh
Возвращенный текст не будет содержать последовательность остановки.		 Нет
Поток логический или null Выполняется ли потоковая передача частичного хода выполнения. Если задано, маркеры будут отправляться как события, отправленные сервером только для данных, как они становятся доступными, с потоком data: [DONE] , завершаемым сообщением. Пример кода Python. Нет
stream_options OpenAI.ChatCompletionStreamOptions или null Нет
Суффикс строка или null Суффикс, который приходит после завершения вставленного текста.
Этот параметр поддерживается только для gpt-3.5-turbo-instruct.		 Нет
Температура число или null Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным.
Как правило, мы рекомендуем изменить это или top_p не оба.		 Нет
top_p число или null Альтернатива выборке с температурой, называемой выборкой ядра, где модель рассматривает результаты маркеров с top_p массой вероятности. Таким образом, 0,1 означает, что рассматриваются только маркеры, состоящие из 10 лучших% массы вероятностей.
Как правило, мы рекомендуем изменить это или temperature не оба.		 Нет
Пользователя Строка Дополнительные сведения. Нет

Ответы

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

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

Тип контента Тип Описание
application/json Объекта

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Примеры

Примере

POST {endpoint}/openai/v1/completions

Контейнеры

Вывод списка контейнеров

GET {endpoint}/openai/v1/containers

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
Предел Запроса Нет Целое число Ограничение количества возвращаемых объектов. Ограничение может варьироваться от 1 до 100, а также
значение по умолчанию — 20.
Заказ Запроса Нет Строка
Возможные значения: asc, desc		 Сортировка created_at по метке времени объектов. asc для возрастания иdesc
для убывания порядка.
После Запроса Нет Строка Курсор для использования в разбиении на страницы. after — это идентификатор объекта, определяющий место в списке.
Например, если вы делаете запрос списка и получаете 100 объектов, заканчивая obj_foo, вашей
последующий вызов может включать after=obj_foo, чтобы получить следующую страницу списка.
Перед Запроса Нет Строка Курсор для использования в разбиении на страницы. before — это идентификатор объекта, определяющий место в списке.
Например, если вы делаете запрос списка и получаете 100 объектов, заканчивая obj_foo, вашей
последующий вызов может включать до=obj_foo, чтобы получить предыдущую страницу списка.

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.ContainerListResource

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Создание контейнера

POST {endpoint}/openai/v1/containers

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.

Текст запроса

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

Имя Тип Описание Обязательно По умолчанию
expires_after OpenAI.CreateContainerBodyExpiresAfter Нет
Привязка └️ Перечисления
Возможные значения: last_active_at		 Да
└️ минуты Целое число Да
file_ids массив строк Идентификаторы файлов для копирования в контейнер. Нет
memory_limit Перечисления Необязательное ограничение памяти для контейнера. По умолчанию используется 1gзначение .
Возможные значения: 1g, , 4g16g64g		 Нет
Имя Строка Имя создаваемого контейнера. Да

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.ContainerResource

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Получение контейнера

GET {endpoint}/openai/v1/containers/{container_id}

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
container_id Путь Да Строка Идентификатор извлекаемого контейнера.

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.ContainerResource

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Удаление контейнера

DELETE {endpoint}/openai/v1/containers/{container_id}

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
container_id Путь Да Строка Идентификатор удаленного контейнера.

Ответы

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

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

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

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

GET {endpoint}/openai/v1/containers/{container_id}/files

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
container_id Путь Да Строка Идентификатор контейнера для перечисления файлов.
Предел Запроса Нет Целое число Ограничение количества возвращаемых объектов. Ограничение может варьироваться от 1 до 100, а также
значение по умолчанию — 20.
Заказ Запроса Нет Строка
Возможные значения: asc, desc		 Сортировка created_at по метке времени объектов. asc для возрастания иdesc
для убывания порядка.
После Запроса Нет Строка Курсор для использования в разбиении на страницы. after — это идентификатор объекта, определяющий место в списке.
Например, если вы делаете запрос списка и получаете 100 объектов, заканчивая obj_foo, вашей
последующий вызов может включать after=obj_foo, чтобы получить следующую страницу списка.
Перед Запроса Нет Строка Курсор для использования в разбиении на страницы. before — это идентификатор объекта, определяющий место в списке.
Например, если вы делаете запрос списка и получаете 100 объектов, заканчивая obj_foo, вашей
последующий вызов может включать до=obj_foo, чтобы получить предыдущую страницу списка.

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.ContainerFileListResource

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Создание файла контейнера

POST {endpoint}/openai/v1/containers/{container_id}/files

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
container_id Путь Да Строка Идентификатор контейнера для создания файла.

Текст запроса

Content-Type: многочастный формат данных

Имя Тип Описание Обязательно По умолчанию
Файл Объект File (не имя файла) для отправки. Нет
file_id Строка Имя создаваемого файла. Нет

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.ContainerFileResource

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Получение файла контейнера

GET {endpoint}/openai/v1/containers/{container_id}/files/{file_id}

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
container_id Путь Да Строка Идентификатор контейнера.
file_id Путь Да Строка Идентификатор извлекаемого файла.

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.ContainerFileResource

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Удаление файла контейнера

DELETE {endpoint}/openai/v1/containers/{container_id}/files/{file_id}

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
container_id Путь Да Строка Идентификатор контейнера.
file_id Путь Да Строка Идентификатор удаленного файла.

Ответы

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

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

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Получение содержимого файла контейнера

GET {endpoint}/openai/v1/containers/{container_id}/files/{file_id}/content

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
container_id Путь Да Строка Идентификатор контейнера.
file_id Путь Да Строка Идентификатор файла, из которого извлекается содержимое.

Ответы

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

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

Тип контента Тип Описание
application/octet-stream Объекта

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Разговоры

Создание беседы

POST {endpoint}/openai/v1/conversations

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.

Текст запроса

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

Имя Тип Описание Обязательно По умолчанию
Элементы массив OpenAI.InputItem или null Нет
Метаданных OpenAI.Metadata или NULL Нет

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.ConversationResource

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Получение беседы

GET {endpoint}/openai/v1/conversations/{conversation_id}

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
conversation_id Путь Да Строка Идентификатор извлекаемой беседы.

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.ConversationResource

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Обновление беседы

POST {endpoint}/openai/v1/conversations/{conversation_id}

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
conversation_id Путь Да Строка Идентификатор беседы для обновления.

Текст запроса

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

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

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.ConversationResource

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Удаление беседы

DELETE {endpoint}/openai/v1/conversations/{conversation_id}

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
conversation_id Путь Да Строка Идентификатор удаленной беседы.

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.DeletedConversationResource

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Вывод списка элементов беседы

GET {endpoint}/openai/v1/conversations/{conversation_id}/items

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
conversation_id Путь Да Строка Идентификатор беседы для перечисления элементов.
Предел Запроса Нет Целое число Ограничение количества возвращаемых объектов. Ограничение может быть от 1 до 100, а значение по умолчанию — 20.
Заказ Запроса Нет Строка
Возможные значения: asc, desc		 Порядок возврата входных элементов в. descЗначение по умолчанию — .
После Запроса Нет Строка Идентификатор элемента для перечисления элементов после, используемый в разбиении на страницы.
Включают Запроса Нет Массива Укажите дополнительные выходные данные для включения в ответ модели.

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.ConversationItemList

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Создание элементов беседы

POST {endpoint}/openai/v1/conversations/{conversation_id}/items

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
conversation_id Путь Да Строка Идентификатор беседы для добавления элемента.
Включают Запроса Нет Массива Дополнительные поля для включения в ответ.

Текст запроса

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

Имя Тип Описание Обязательно По умолчанию
Элементы массив OpenAI.InputItem Да

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.ConversationItemList

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Получение элемента беседы

GET {endpoint}/openai/v1/conversations/{conversation_id}/items/{item_id}

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
conversation_id Путь Да Строка Идентификатор беседы, содержащей элемент.
item_id Путь Да Строка Идентификатор извлекаемого элемента.
Включают Запроса Нет Массива Дополнительные поля для включения в ответ.

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.ConversationItem

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Удаление элемента беседы

DELETE {endpoint}/openai/v1/conversations/{conversation_id}/items/{item_id}

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
conversation_id Путь Да Строка Идентификатор беседы, содержащей элемент.
item_id Путь Да Строка Идентификатор удаленного элемента.

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.ConversationResource

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Evals

Перечисление evals

GET {endpoint}/openai/v1/evals

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

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
После Запроса Нет Строка Идентификатор последнего eval из предыдущего запроса на страницы.
Предел Запроса Нет Целое число Ограничение на количество возвращаемых вальвов в одном ответе на страницы.
Заказ Запроса Нет Строка
Возможные значения: asc, desc		 Порядок сортировки по меткам времени. Использование asc для возрастания или
desc для убывания порядка.
order_by Запроса Нет Строка
Возможные значения: created_at, updated_at		 Evals можно упорядочить по времени создания или времени последнего обновления. Использовать
created_at время создания или updated_at последнее обновление
Время.

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.EvalList

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Создание eval

POST {endpoint}/openai/v1/evals

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

Оценка — это набор критериев тестирования и источника данных. После создания оценки его можно запустить на разных моделях и параметрах модели. Мы поддерживаем несколько типов классировщиков и источников данных.

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.

Текст запроса

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

Имя Тип Описание Обязательно По умолчанию
data_source_config OpenAI.CreateEvalCustomDataSourceConfig или OpenAI.CreateEvalLogsDataSourceConfig или OpenAI.CreateEvalStoredCompletionsDataSourceConfig Конфигурация источника данных, используемого для выполнения оценки. Определяет схему данных, используемых в оценке. Да
Метаданных OpenAI.Metadata или NULL Нет
Имя Строка Имя оценки. Нет
statusCode Перечисления
Возможные значения: 201		 Да
testing_criteria массив OpenAI.CreateEvalLabelModelGrader или OpenAI.EvalGraderStringCheck или OpenAI.EvalGraderTextSimilarity или OpenAI.EvalGraderPython или OpenAI.EvalGraderScoreModel или EvalGraderEndpoint Список классов для всех запусков eval в этой группе. Классировщики могут ссылаться на переменные в источнике данных с помощью двойной фигурной скобки, например {{item.variable_name}}. Чтобы ссылаться на выходные данные модели, используйте sample пространство имен (т. е. {{sample.output_text}}). Да

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.Eval

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Получение eval

GET {endpoint}/openai/v1/evals/{eval_id}

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

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
eval_id Путь Да Строка

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.Eval

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Обновление eval

POST {endpoint}/openai/v1/evals/{eval_id}

Обновите выбор, изменяемые свойства указанной оценки.

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
eval_id Путь Да Строка

Текст запроса

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

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

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.Eval

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Удаление eval

DELETE {endpoint}/openai/v1/evals/{eval_id}

Удалите указанную оценку.

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
eval_id Путь Да Строка

Ответы

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

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

Тип контента Тип Описание
application/json Объекта

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Получение запусков eval

GET {endpoint}/openai/v1/evals/{eval_id}/runs

Получение списка запусков для указанной оценки.

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
eval_id Путь Да Строка
После Запроса Нет Строка
Предел Запроса Нет Целое число
Заказ Запроса Нет Строка
Возможные значения: asc, desc
Статус Запроса Нет Строка
Возможные значения: queued, , in_progresscompletedcanceledfailed

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.EvalRunList

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Создание запуска eval

POST {endpoint}/openai/v1/evals/{eval_id}/runs

Создайте новый запуск оценки, начинающий процесс оценки.

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
eval_id Путь Да Строка

Текст запроса

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

Имя Тип Описание Обязательно По умолчанию
data_source OpenAI.CreateEvalJsonlRunDataSource или OpenAI.CreateEvalCompletionsRunDataSource или OpenAI.CreateEvalResponsesRunDataSource Сведения об источнике данных запуска. Да
Метаданных OpenAI.Metadata или NULL Нет
Имя Строка Имя запуска. Нет

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.EvalRun

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Получение запуска eval

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}

Получение определенной оценки, выполняемой идентификатором.

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
eval_id Путь Да Строка
run_id Путь Да Строка

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.EvalRun

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Отмена выполнения eval

POST {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}

Отмена определенной оценки, выполняемой идентификатором.

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
eval_id Путь Да Строка
run_id Путь Да Строка

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.EvalRun

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Удаление запуска eval

DELETE {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}

Удалите конкретную оценку, выполняемую идентификатором.

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
eval_id Путь Да Строка
run_id Путь Да Строка

Ответы

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

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

Тип контента Тип Описание
application/json Объекта

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Получение выходных элементов выполнения eval

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}/output_items

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

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
eval_id Путь Да Строка
run_id Путь Да Строка
После Запроса Нет Строка
Предел Запроса Нет Целое число
Статус Запроса Нет Строка
Возможные значения: fail, pass
Заказ Запроса Нет Строка
Возможные значения: asc, desc

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.EvalRunOutputItemList

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Получение выходного элемента выполнения eval

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}/output_items/{output_item_id}

Извлеките определенный выходной элемент из вычисления, выполняемого его идентификатором.

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
eval_id Путь Да Строка
run_id Путь Да Строка
output_item_id Путь Да Строка

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.EvalRunOutputItem

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Файлы

Создание файла

POST {endpoint}/openai/v1/files

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.

Текст запроса

Content-Type: многочастный формат данных

Имя Тип Описание Обязательно По умолчанию
expires_after Объекта Да
Привязка └️ AzureFileExpiryAnchor Да
└= секунды Целое число Да
Файл Объект File (не имя файла) для отправки. Да
Цель Перечисления Предназначенная цель отправленного файла. Одно из следующих: assistants: используется в API помощников: batchиспользуется в API пакетной службы : fine-tuneиспользуется для точной настройки : evalsиспользуется для наборов данных eval
Возможные значения: assistants, , batchfine-tuneevals		 Да

Ответы

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

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

Тип контента Тип Описание
application/json Объекта

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Примеры

Примере

POST {endpoint}/openai/v1/files

Список файлов

GET {endpoint}/openai/v1/files

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
Цель Запроса Нет Строка
Предел Запроса Нет Целое число
Заказ Запроса Нет Строка
Возможные значения: asc, desc
После Запроса Нет Строка

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.ListFilesResponse

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Получение файла

GET {endpoint}/openai/v1/files/{file_id}

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
file_id Путь Да Строка Идентификатор файла, используемого для этого запроса.

Ответы

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

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

Тип контента Тип Описание
application/json Объекта

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Удаление файла

DELETE {endpoint}/openai/v1/files/{file_id}

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
file_id Путь Да Строка Идентификатор файла, используемого для этого запроса.

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.DeleteFileResponse

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Скачивание файла

GET {endpoint}/openai/v1/files/{file_id}/content

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
file_id Путь Да Строка Идентификатор файла, используемого для этого запроса.

Ответы

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

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

Тип контента Тип Описание
application/octet-stream Объекта

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Внедрение

Создание внедрения

POST {endpoint}/openai/v1/embeddings

Создает вектор внедрения, представляющий входной текст.

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.

Текст запроса

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

Имя Тип Описание Обязательно По умолчанию
Размеры Целое число Число измерений, в которых должны быть внедренные выходные данные. Поддерживается только в text-embedding-3 и более поздних моделях.
Ограничения: мин: 1		 Нет
encoding_format Перечисления Формат, в который возвращаются встраиваемые элементы. Может быть либо floatbase64.
Возможные значения: float, base64		 Нет
Вход строка или массив строк или массив целых чисел или массив массива массива Входной текст для внедрения, закодированный в виде строки или массива маркеров. Чтобы внедрить несколько входных данных в один запрос, передайте массив строк или массив массивов маркеров. Входные данные не должны превышать максимальные входные маркеры для модели (8 192 маркеров для всех моделей внедрения), не может быть пустой строкой, и любой массив должен быть 2048 измерений или меньше. Пример кода Python для подсчета маркеров. В дополнение к ограничению маркера для каждого ввода все модели внедрения применяют не более 300 000 маркеров, суммируемых во всех входных данных в одном запросе. Да
Модели Строка Идентификатор используемой модели. Api " Список моделей " можно использовать для просмотра всех доступных моделей или просмотра описания моделей. Да
Пользователя Строка Дополнительные сведения. Нет

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.CreateEmbeddingResponse

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Примеры

Примере

POST {endpoint}/openai/v1/embeddings

Точное настройка

Запустить градер

POST {endpoint}/openai/v1/fine_tuning/alpha/graders/run

Запустите классировщик.

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.

Текст запроса

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

Имя Тип Описание Обязательно По умолчанию
Грейдер OpenAI.GraderStringCheck или OpenAI.GraderTextSimilarity или OpenAI.GraderPython или OpenAI.GraderScoreModel или OpenAI.GraderMulti или GraderEndpoint Классировщик, используемый для задания тонкой настройки. Да
Элемента OpenAI.RunGraderRequestItem Нет
model_sample Строка Пример модели, который необходимо оценить. Это значение будет использоваться для заполнения
sample пространство имен. Дополнительные сведения см . в руководстве .
Переменная output_json будет заполнена, если пример модели является примером
допустимая строка JSON.		 Да

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.RunGraderResponse

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

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

Тип контента Тип Описание
application/json Объекта

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

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

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

POST {endpoint}/openai/v1/fine_tuning/alpha/graders/validate

Проверьте классировщик.

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.

Текст запроса

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

Имя Тип Описание Обязательно По умолчанию
Грейдер OpenAI.GraderStringCheck или OpenAI.GraderTextSimilarity или OpenAI.GraderPython или OpenAI.GraderScoreModel или OpenAI.GraderMulti или GraderEndpoint Нет

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.ValidateGraderResponse

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Перечисление разрешений для точной настройки контрольных точек

GET {endpoint}/openai/v1/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions

Вывод списка разрешений контрольной точки

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
fine_tuned_model_checkpoint Путь Да Строка Идентификатор настраиваемой контрольной точки модели для получения разрешений.
project_id Запроса Нет Строка Идентификатор проекта для получения разрешений.
После Запроса Нет Строка Идентификатор последнего идентификатора разрешения из предыдущего запроса на страницы.
Предел Запроса Нет Целое число Количество разрешений для получения.
Заказ Запроса Нет Строка
Возможные значения: ascending, descending		 Порядок получения разрешений.

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.ListFineTuningCheckpointPermissionResponse

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Создание разрешения на контрольную точку точной настройки

POST {endpoint}/openai/v1/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions

Создание разрешений контрольной точки

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
fine_tuned_model_checkpoint Путь Да Строка Идентификатор настраиваемой контрольной точки модели для создания разрешения.

Текст запроса

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

Имя Тип Описание Обязательно По умолчанию
project_ids массив строк Идентификаторы проекта для предоставления доступа. Да

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.ListFineTuningCheckpointPermissionResponse

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Удаление разрешения на контрольную точку точной настройки

DELETE {endpoint}/openai/v1/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions/{permission_id}

Удаление разрешения контрольной точки

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
fine_tuned_model_checkpoint Путь Да Строка Идентификатор настраиваемой контрольной точки модели для удаления разрешения.
permission_id Путь Да Строка Идентификатор разрешения на удаленную контрольную точку модели.

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.DeleteFineTuningCheckpointPermissionResponse

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Создание задания тонкой настройки

POST {endpoint}/openai/v1/fine_tuning/jobs

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

Ответ содержит подробные сведения о задании, в том числе о состоянии задания и имени настроенных моделей после завершения.

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.

Текст запроса

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

Имя Тип Описание Обязательно По умолчанию
гиперпараметры OpenAI.CreateFineTuningJobRequestHyperparameters Нет
└batch_size строка или целое число Нет Авто
└learning_rate_multiplier learning_rate_multiplier строка или число Нет
└️ n_epochs строка или целое число Нет Авто
Интеграции массив OpenAI.CreateFineTuningJobRequestIntegrations или null Список интеграции для задания тонкой настройки. Нет
Метаданных OpenAI.Metadata или NULL Нет
Метод OpenAI.FineTuneMethod Метод, используемый для точной настройки. Нет
Модели строка (см. допустимые модели ниже) Имя модели для точной настройки. Вы можете выбрать один из них.
поддерживаемые модели.		 Да
Семян целое число или null Начальное значение определяет воспроизводимость задания. Передача одинаковых параметров начального значения и заданий должна иметь одинаковые результаты, но может отличаться в редких случаях.
Если начальное значение не указано, он будет создан для вас.		 Нет
Суффикс строка или null Строка до 64 символов, которые будут добавлены в имя настраиваемой модели.
Например, suffix в поле "Custom-model-name" будет производиться имя модели, например ft:gpt-4o-mini:openai:custom-model-name:7p4lURel.		 Нет
training_file Строка Идентификатор отправленного файла, содержащего данные обучения.
Сведения о том, как отправить файл, см. в разделе "Отправка файла ".
Набор данных должен быть отформатирован в формате JSONL-файла. Кроме того, необходимо передать файл с целью fine-tune.
Содержимое файла должно отличаться в зависимости от того, использует ли модель чат, формат завершения или использует ли метод тонкой настройки формат предпочтения .
Дополнительные сведения см. в руководстве по тонкой настройке .		 Да
validation_file строка или null Идентификатор отправленного файла, содержащего данные проверки.
Если этот файл предоставлен, данные используются для создания проверки
Метрики периодически во время тонкой настройки. Эти метрики можно просмотреть в
файл результатов тонкой настройки.
Одни и те же данные не должны присутствовать в файлах обучения и проверки.
Набор данных должен быть отформатирован в формате JSONL-файла. Необходимо отправить файл с целью fine-tune.
Дополнительные сведения см. в руководстве по тонкой настройке .		 Нет

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.FineTuningJob

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Список заданий тонкой настройки с разбивкой на страницы

GET {endpoint}/openai/v1/fine_tuning/jobs

Перечисление заданий точной настройки организации

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
После Запроса Нет Строка Идентификатор последнего задания из предыдущего запроса на страницы.
Предел Запроса Нет Целое число Количество получаемых заданий точной настройки.

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.ListPaginatedFineTuningJobsResponse

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Получение задания тонкой настройки

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}

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

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
fine_tuning_job_id Путь Да Строка Идентификатор задания тонкой настройки.

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.FineTuningJob

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Отмена задания тонкой настройки

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/cancel

Немедленно отмените задание точной настройки.

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
fine_tuning_job_id Путь Да Строка Идентификатор задания тонкой настройки для отмены.

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.FineTuningJob

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Перечисление контрольных точек задания тонкой настройки

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints

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

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
fine_tuning_job_id Путь Да Строка Идентификатор задания точной настройки для получения контрольных точек.
После Запроса Нет Строка Идентификатор последнего идентификатора контрольной точки из предыдущего запроса на страницы.
Предел Запроса Нет Целое число Количество получаемых контрольных точек.

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.ListFineTuningJobCheckpointsResponse

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Точная настройка — контрольная точка копирования

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints/{fine_tuning_checkpoint_id}/copy

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

ПРИМЕЧАНИЕ. Этот API OpenAI Azure находится в предварительной версии и подлежит изменению.

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
fine_tuning_job_id Путь Да Строка
fine_tuning_checkpoint_id Путь Да Строка

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

Имя Обязательно Тип Описание
aoai-copy-ft-контрольные точки Истинный Строка
Возможные значения: preview		 Обеспечивает доступ к операциям копирования контрольных точек для моделей, предварительной версии функции AOAI.
Для этой функции необходимо задать для заголовка aoai-copy-ft-контрольных точек значение preview.
Принять Истинный Строка
Возможные значения: application/json

Текст запроса

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

Имя Тип Описание Обязательно По умолчанию
destinationResourceId Строка Идентификатор целевого ресурса для копирования. Да
Регионе Строка Регион, в который нужно скопировать модель. Да

Ответы

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

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

Тип контента Тип Описание
application/json CopyModelResponse

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Точное настройка — получение контрольной точки

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints/{fine_tuning_checkpoint_id}/copy

Возвращает состояние копии контрольной точки тонкой настройки.

ПРИМЕЧАНИЕ. Этот API OpenAI Azure находится в предварительной версии и подлежит изменению.

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
fine_tuning_job_id Путь Да Строка
fine_tuning_checkpoint_id Путь Да Строка

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

Имя Обязательно Тип Описание
aoai-copy-ft-контрольные точки Истинный Строка
Возможные значения: preview		 Обеспечивает доступ к операциям копирования контрольных точек для моделей, предварительной версии функции AOAI.
Для этой функции необходимо задать для заголовка aoai-copy-ft-контрольных точек значение preview.
Принять Истинный Строка
Возможные значения: application/json

Ответы

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

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

Тип контента Тип Описание
application/json CopyModelResponse

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Перечисление событий тонкой настройки

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/events

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

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
fine_tuning_job_id Путь Да Строка Идентификатор задания точной настройки для получения событий.
После Запроса Нет Строка Идентификатор последнего события из предыдущего запроса на страницы.
Предел Запроса Нет Целое число Количество извлекаемых событий.

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.ListFineTuningJobEventsResponse

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Приостановка задания тонкой настройки

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/pause

Приостановка задания точной настройки.

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
fine_tuning_job_id Путь Да Строка Идентификатор задания тонкой настройки для приостановки.

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.FineTuningJob

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Возобновление задания тонкой настройки

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/resume

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

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
fine_tuning_job_id Путь Да Строка Идентификатор задания тонкой настройки для возобновления.

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.FineTuningJob

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Модели

Перечисление моделей

GET {endpoint}/openai/v1/models

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

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.ListModelsResponse

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Получение модели

GET {endpoint}/openai/v1/models/{model}

Извлекает экземпляр модели, предоставляя основные сведения о модели, например владельца и разрешения.

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
Модели Путь Да Строка Идентификатор модели, используемой для этого запроса.

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.Model

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Удаление модели

DELETE {endpoint}/openai/v1/models/{model}

Удаляет экземпляр модели.

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
Модели Путь Да Строка Идентификатор модели для удаления.

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.DeleteModelResponse

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Realtime

Создание вызова в режиме реального времени

POST {endpoint}/openai/v1/realtime/calls

Создайте новый вызов API Реального времени через WebRTC и получите ответ SDP, необходимый для завершения однорангового подключения.

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.

Текст запроса

Content-Type: многочастный формат данных

Имя Тип Описание Обязательно По умолчанию
Sdp Строка Предложение протокола описания сеансов WebRTC (SDP), созданное вызывающим оператором. Да
Сессии OpenAI.RealtimeSessionCreateRequestGA Конфигурация объекта сеанса в режиме реального времени. Нет
└️ звук OpenAI.RealtimeSessionCreateRequestGAAudio Настройка входного и выходного звука. Нет
└️ include массив строк Дополнительные поля для включения в выходные данные сервера.
item.input_audio_transcription.logprobs: включите logprobs для транскрибирования входного звука.		 Нет
Инструкции └️ Строка Системные инструкции по умолчанию (т. е. системное сообщение) предопределены для вызовов модели. Это поле позволяет клиенту управлять моделью по нужным ответам. Модель может быть указана по содержимому ответа и формату (например, "быть чрезвычайно краткой", "действовать понятно", "вот примеры хороших ответов") и по поведению звука (например, "быстро говорить", "вводить эмоции в ваш голос", "смеяться часто"). Инструкции не гарантируются моделью, но они предоставляют рекомендации модели по требуемому поведению.
Обратите внимание, что сервер задает инструкции по умолчанию, которые будут использоваться, если это поле не задано и отображается в событии в session.created начале сеанса.		 Нет
└️ max_output_tokens целое число (см. допустимые модели ниже) Максимальное количество выходных маркеров для одного ответа помощника;
включающее вызовы инструментов. Укажите целое число от 1 до 4096.
ограничение выходных маркеров или inf максимально доступных маркеров для
данная модель. По умолчанию используется infзначение .		 Нет
Модель └️ Строка Модель реального времени, используемая для этого сеанса. Нет
└output_modalities массив строк Набор модальностей, с которыми может реагировать модель. Значение по умолчанию , ["audio"]указывающее
что модель будет реагировать на звук и расшифровку. ["text"] можно использовать для создания
Модель отвечает только текстом. Не удается запросить оба text и audio одновременно.		 Нет ['audio']
Запрос └️ OpenAI.Prompt Ссылка на шаблон запроса и его переменные.
Дополнительные сведения.		 Нет
└tool_choice OpenAI.ToolChoiceOptions или OpenAI.ToolChoiceFunction или OpenAI.ToolChoiceMCP Как модель выбирает инструменты. Укажите один из режимов строки или принудительное применение определенного
средство function/MCP.		 Нет Авто
Средства └️ массив OpenAI.RealtimeFunctionTool или OpenAI.MCPTool Средства, доступные для модели. Нет
Трассировка └️ string или OpenAI.RealtimeSessionCreateRequestGATracing или null "" Установите значение NULL, чтобы отключить трассировку. Раз
Трассировка включена для сеанса, конфигурация не может быть изменена.
auto создаст трассировку для сеанса со значениями по умолчанию для
имя рабочего процесса, идентификатор группы и метаданные.		 Нет Авто
└️ усечение OpenAI.RealtimeTruncation Если количество маркеров в беседе превышает ограничение входного маркера модели, беседа будет усечена, то есть сообщения (начиная с самого старого) не будут включены в контекст модели. 32k контекстная модель с 4096 максимальными выходными маркерами может включать только 28 224 маркеров в контексте перед усечением.
Клиенты могут настроить поведение усечения для усечения с более низким максимальным ограничением маркера, что является эффективным способом управления использованием маркеров и затратами.
Усечение уменьшит количество кэшированных маркеров в следующем шаге (перебор кэша), так как сообщения удаляются с начала контекста. Однако клиенты также могут настроить усечение для хранения сообщений до доли максимального размера контекста, что приведет к снижению необходимости в будущих усечениях и, таким образом, повышению скорости кэширования.
Усечение может быть полностью отключено, что означает, что сервер никогда не усечен, но вместо этого возвращает ошибку, если беседа превышает ограничение маркера ввода модели.		 Нет
Тип └️ Перечисления Тип создаваемого сеанса. Всегда realtime для API Реального времени.
Возможные значения: realtime		 Да

Ответы

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

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

Тип контента Тип Описание
application/sdp Строка

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

Заголовка Тип Описание
Расположение Строка Относительный URL-адрес, содержащий идентификатор вызова для последующих запросов элемента управления.

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Прием звонка в режиме реального времени

POST {endpoint}/openai/v1/realtime/calls/{call_id}/accept

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

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
call_id Путь Да Строка Идентификатор вызова, предоставленного в веб-перехватчике realtime.call.incoming.

Текст запроса

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

Имя Тип Описание Обязательно По умолчанию
Аудио OpenAI.RealtimeSessionCreateRequestGAAudio Нет
Входные данные └️ OpenAI.RealtimeSessionCreateRequestGAAudioInput Нет
Выходные данные └️ OpenAI.RealtimeSessionCreateRequestGAAudioOutput Нет
Включают массив строк Дополнительные поля для включения в выходные данные сервера.
item.input_audio_transcription.logprobs: включите logprobs для транскрибирования входного звука.		 Нет
Инструкции Строка Системные инструкции по умолчанию (т. е. системное сообщение) предопределены для вызовов модели. Это поле позволяет клиенту управлять моделью по нужным ответам. Модель может быть указана по содержимому ответа и формату (например, "быть чрезвычайно краткой", "действовать понятно", "вот примеры хороших ответов") и по поведению звука (например, "быстро говорить", "вводить эмоции в ваш голос", "смеяться часто"). Инструкции не гарантируются моделью, но они предоставляют рекомендации модели по требуемому поведению.
Обратите внимание, что сервер задает инструкции по умолчанию, которые будут использоваться, если это поле не задано и отображается в событии в session.created начале сеанса.		 Нет
max_output_tokens целое число (см. допустимые модели ниже) Максимальное количество выходных маркеров для одного ответа помощника;
включающее вызовы инструментов. Укажите целое число от 1 до 4096.
ограничение выходных маркеров или inf максимально доступных маркеров для
данная модель. По умолчанию используется infзначение .		 Нет
Модели Строка Модель реального времени, используемая для этого сеанса. Нет
output_modalities массив строк Набор модальностей, с которыми может реагировать модель. Значение по умолчанию , ["audio"]указывающее
что модель будет реагировать на звук и расшифровку. ["text"] можно использовать для создания
Модель отвечает только текстом. Не удается запросить оба text и audio одновременно.		 Нет ['audio']
Строке OpenAI.Prompt Ссылка на шаблон запроса и его переменные.
Дополнительные сведения.		 Нет
tool_choice OpenAI.ToolChoiceOptions или OpenAI.ToolChoiceFunction или OpenAI.ToolChoiceMCP Как модель выбирает инструменты. Укажите один из режимов строки или принудительное применение определенного
средство function/MCP.		 Нет
Инструменты массив OpenAI.RealtimeFunctionTool или OpenAI.MCPTool Средства, доступные для модели. Нет
Трассировки string или OpenAI.RealtimeSessionCreateRequestGATracing или null "" Установите значение NULL, чтобы отключить трассировку. Раз
Трассировка включена для сеанса, конфигурация не может быть изменена.
auto создаст трассировку для сеанса со значениями по умолчанию для
имя рабочего процесса, идентификатор группы и метаданные.		 Нет
Усечение OpenAI.RealtimeTruncation Если количество маркеров в беседе превышает ограничение входного маркера модели, беседа будет усечена, то есть сообщения (начиная с самого старого) не будут включены в контекст модели. 32k контекстная модель с 4096 максимальными выходными маркерами может включать только 28 224 маркеров в контексте перед усечением.
Клиенты могут настроить поведение усечения для усечения с более низким максимальным ограничением маркера, что является эффективным способом управления использованием маркеров и затратами.
Усечение уменьшит количество кэшированных маркеров в следующем шаге (перебор кэша), так как сообщения удаляются с начала контекста. Однако клиенты также могут настроить усечение для хранения сообщений до доли максимального размера контекста, что приведет к снижению необходимости в будущих усечениях и, таким образом, повышению скорости кэширования.
Усечение может быть полностью отключено, что означает, что сервер никогда не усечен, но вместо этого возвращает ошибку, если беседа превышает ограничение маркера ввода модели.		 Нет
Тип Перечисления Тип создаваемого сеанса. Всегда realtime для API Реального времени.
Возможные значения: realtime		 Да

Ответы

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Зависание звонка в режиме реального времени

POST {endpoint}/openai/v1/realtime/calls/{call_id}/hangup

Завершите активный вызов API в режиме реального времени, независимо от того, был ли он инициирован через SIP или WebRTC.

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
call_id Путь Да Строка Идентификатор вызова.

Ответы

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Ссылка на вызов в режиме реального времени

POST {endpoint}/openai/v1/realtime/calls/{call_id}/refer

Перенесите активный вызов SIP в новое назначение с помощью команды SIP REFER.

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
call_id Путь Да Строка Идентификатор вызова, предоставленного в веб-перехватчике realtime.call.incoming.

Текст запроса

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

Имя Тип Описание Обязательно По умолчанию
target_uri Строка URI, который должен отображаться в заголовке SIP Refer-To. Поддерживает такие значения, как
tel:+14155550123 или sip:agent\@example.com.		 Да

Ответы

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Отклонение вызова в режиме реального времени

POST {endpoint}/openai/v1/realtime/calls/{call_id}/reject

Отклоните входящий вызов SIP, возвратив код состояния SIP вызывающей объекту.

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
call_id Путь Да Строка Идентификатор вызова, предоставленного в веб-перехватчике realtime.call.incoming.

Текст запроса

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

Имя Тип Описание Обязательно По умолчанию
status_code Целое число Код ответа SIP для отправки обратно вызывающей стороне. Значение 603 по умолчанию (отклонить)
при опущении.		 Нет

Ответы

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Создание секрета клиента в режиме реального времени

POST {endpoint}/openai/v1/realtime/client_secrets

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

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.

Текст запроса

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

Имя Тип Описание Обязательно По умолчанию
expires_after OpenAI.RealtimeCreateClientSecretRequestExpiresAfter Нет
Привязка └️ Перечисления
Возможные значения: created_at		 Нет
└= секунды Целое число Ограничения: min: 10, max: 7200 Нет 600
Сессии OpenAI.RealtimeSessionCreateRequestUnion Нет
Тип └️ OpenAI.RealtimeSessionCreateRequestUnionType Да

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.RealtimeCreateClientSecretResponse

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Создание сеанса в режиме реального времени

POST {endpoint}/openai/v1/realtime/sessions

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

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.

Текст запроса

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

Имя Тип Описание Обязательно По умолчанию
client_secret OpenAI.RealtimeSessionCreateRequestClientSecret Да
└expires_at Целое число Да
Значение └️ Строка Да
input_audio_format Строка Формат входного звука. Параметры: pcm16, g711_ulawили g711_alaw. Нет
input_audio_transcription OpenAI.RealtimeSessionCreateRequestInputAudioTranscription Нет
Модель └️ Строка Нет
Инструкции Строка Системные инструкции по умолчанию (т. е. системное сообщение) предопределены для вызовов модели. Это поле позволяет клиенту управлять моделью по нужным ответам. Модель может быть указана по содержимому ответа и формату (например, "быть чрезвычайно краткой", "действовать понятно", "вот примеры хороших ответов") и по поведению звука (например, "быстро говорить", "вводить эмоции в ваш голос", "смеяться часто"). Инструкции не гарантируются моделью, но они предоставляют рекомендации модели по требуемому поведению.
Обратите внимание, что сервер задает инструкции по умолчанию, которые будут использоваться, если это поле не задано и отображается в событии в session.created начале сеанса.		 Нет
max_response_output_tokens целое число (см. допустимые модели ниже) Максимальное количество выходных маркеров для одного ответа помощника;
включающее вызовы инструментов. Укажите целое число от 1 до 4096.
ограничение выходных маркеров или inf максимально доступных маркеров для
данная модель. По умолчанию используется infзначение .		 Нет
Условия массив строк Набор модальностей, с которыми может реагировать модель. Чтобы отключить звук,
Задайте для этого значение ["text"].		 Нет ['text', 'audio']
output_audio_format Строка Формат выходного звука. Параметры: pcm16, g711_ulawили g711_alaw. Нет
Строке OpenAI.Prompt Ссылка на шаблон запроса и его переменные.
Дополнительные сведения.		 Нет
Скорость Номер Скорость голосового ответа модели. 1.0 — это скорость по умолчанию. 0.25 имеет значение
минимальная скорость. 1.5 — максимальная скорость. Это значение можно изменить только
между поворотами модели, а не во время выполнения ответа.
Ограничения: min: 0.25, max: 1.5		 Нет 1
Температура Номер Температура выборки для модели ограничена [0.6, 1.2]. По умолчанию используется значение 0.8. Нет
tool_choice Строка Как модель выбирает инструменты. Параметры: auto, nonerequiredили
укажите функцию.		 Нет
Инструменты массив OpenAI.RealtimeSessionCreateRequestTools Средства (функции), доступные для модели. Нет
Трассировки строка или объект Параметры конфигурации для трассировки. Установите значение NULL, чтобы отключить трассировку. Раз
Трассировка включена для сеанса, конфигурация не может быть изменена.
auto создаст трассировку для сеанса со значениями по умолчанию для
имя рабочего процесса, идентификатор группы и метаданные.		 Нет
Усечение OpenAI.RealtimeTruncation Если количество маркеров в беседе превышает ограничение входного маркера модели, беседа будет усечена, то есть сообщения (начиная с самого старого) не будут включены в контекст модели. 32k контекстная модель с 4096 максимальными выходными маркерами может включать только 28 224 маркеров в контексте перед усечением.
Клиенты могут настроить поведение усечения для усечения с более низким максимальным ограничением маркера, что является эффективным способом управления использованием маркеров и затратами.
Усечение уменьшит количество кэшированных маркеров в следующем шаге (перебор кэша), так как сообщения удаляются с начала контекста. Однако клиенты также могут настроить усечение для хранения сообщений до доли максимального размера контекста, что приведет к снижению необходимости в будущих усечениях и, таким образом, повышению скорости кэширования.
Усечение может быть полностью отключено, что означает, что сервер никогда не усечен, но вместо этого возвращает ошибку, если беседа превышает ограничение маркера ввода модели.		 Нет
turn_detection OpenAI.RealtimeSessionCreateRequestTurnDetection Нет
└prefix_padding_ms Целое число Нет
└️ silence_duration_ms Целое число Нет
Пороговое значение └️ Номер Нет
Тип └️ Строка Нет
Тип Перечисления
Возможные значения: realtime		 Да
Голос OpenAI.VoiceIdsShared Нет

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.RealtimeSessionCreateResponse

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Создание сеанса транскрибирования в режиме реального времени

POST {endpoint}/openai/v1/realtime/transcription_sessions

Создайте эфемерный маркер API для использования в клиентских приложениях с API Реального времени специально для транскрибирования в режиме реального времени.

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.

Текст запроса

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

Имя Тип Описание Обязательно По умолчанию
Включают массив строк Набор элементов для включения в транскрибирование. Текущие доступные элементы:
item.input_audio_transcription.logprobs		 Нет
input_audio_format Перечисления Формат входного звука. Параметры: pcm16, g711_ulawили g711_alaw.
Для pcm16, входной звук должен быть 16-разрядным PCM с частотой выборки 24-кГц,
один канал (mono) и байтовый порядок байтов с небольшим эндианом.
Возможные значения: pcm16, g711_ulawg711_alaw		 Нет
input_audio_noise_reduction OpenAI.RealtimeTranscriptionSessionCreateRequestInputAudioNoiseReduction Нет
Тип └️ OpenAI.NoiseReductionType Тип уменьшения шума. near_field предназначен для микрофонов близкого разговора, таких как наушники, far_field предназначен для микрофонов с дальним полем, таких как ноутбук или микрофоны конференц-зала. Нет
input_audio_transcription OpenAI.AudioTranscription Нет
Язык └️ Строка Язык входного звука. Предоставление языка ввода в
ФОРМАТ ISO-639-1 (например) en
повысит точность и задержку.		 Нет
Модель └️ Строка Модель, используемая для транскрибирования. Текущие параметры: whisper-1, gpt-4o-mini-transcribe, gpt-4o-mini-transcribe-2025-12-15, gpt-4o-transcribeи gpt-4o-transcribe-diarize. Используйте, когда требуется gpt-4o-transcribe-diarize диаризация с метками говорящего. Нет
Запрос └️ Строка Необязательный текст для руководства по стилю модели или продолжения предыдущего звука
Сегмента.
Для whisper-1этого запрос — это список ключевых слов.
Для gpt-4o-transcribe моделей (за исключением), запрос — это бесплатная текстовая строка, например "ожидающие gpt-4o-transcribe-diarizeслова, связанные с технологией".		 Нет
turn_detection OpenAI.RealtimeTranscriptionSessionCreateRequestTurnDetection Нет
└prefix_padding_ms Целое число Нет
└️ silence_duration_ms Целое число Нет
Пороговое значение └️ Номер Нет
Тип └️ Перечисления
Возможные значения: server_vad		 Нет
Тип Перечисления
Возможные значения: transcription		 Да

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.RealtimeTranscriptionSessionCreateResponse

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Ответы

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

POST {endpoint}/openai/v1/responses

Создает ответ модели.

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.

Текст запроса

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

Имя Тип Описание Обязательно По умолчанию
Фон логический или null Нет
Разговор OpenAI.ConversationParam или null Нет
Включают массив OpenAI.IncludeEnum или null Нет
Вход OpenAI.InputParam Текстовые, изображения или входные данные файлов в модель, используемые для создания ответа.
Подробнее:
- Текстовые входные и выходные данные
- Входные данные изображения
- Входные данные файлов
- Состояние беседы
- Вызов функции		 Нет
Инструкции строка или null Нет
max_output_tokens целое число или null Нет
max_tool_calls целое число или null Нет
Метаданных OpenAI.Metadata или NULL Нет
Модели Строка Идентификатор модели, используемый для создания ответа, например gpt-4o или o3. OpenAI
предлагает широкий спектр моделей с разными возможностями, производительностью
характеристики и цены. См. руководство по модели
для просмотра и сравнения доступных моделей.		 Нет
parallel_tool_calls логический или null Нет
previous_response_id строка или null Нет
Строке OpenAI.Prompt Ссылка на шаблон запроса и его переменные.
Дополнительные сведения.		 Нет
prompt_cache_key Строка Используется OpenAI для кэширования ответов для аналогичных запросов для оптимизации частоты попаданий кэша. Заменяет user поле. Дополнительные сведения. Нет
prompt_cache_retention строка или null Нет
Рассуждения OpenAI.Reasoning или NULL Нет
safety_identifier Строка Стабильный идентификатор, используемый для обнаружения пользователей приложения, которые могут нарушать политики использования OpenAI.
Идентификаторы должны быть строкой, которая однозначно идентифицирует каждого пользователя. Мы рекомендуем хэшировать имя пользователя или адрес электронной почты, чтобы избежать отправки нам каких-либо сведений об идентификации. Дополнительные сведения.		 Нет
Магазин логический или null Нет
Поток логический или null Нет
stream_options OpenAI.ResponseStreamOptions или null Нет
Температура число или null Нет
Текст OpenAI.ResponseTextParam Параметры конфигурации для текстового ответа модели. Может быть простым
текстовые или структурированные данные JSON. Подробнее:
- Текстовые входные и выходные данные
- Структурированные выходные данные		 Нет
tool_choice OpenAI.ToolChoiceParam Как модель должна выбрать инструмент (или средства), которые следует использовать при создании
ответ. См. tools параметр, чтобы узнать, как указать инструменты
Модель может вызываться.		 Нет
Инструменты OpenAI.ToolsArray Массив инструментов, которые модель может вызывать при создании ответа. Вы
может указать, какое средство следует использовать, задав tool_choice параметр.
Мы поддерживаем следующие категории инструментов:
- Встроенные средства: средства, предоставляемые OpenAI, расширяющие
Возможности модели, такие как поиск в Интернете
или поиск по файлам. Дополнительные сведения
встроенные средства.
- Инструменты MCP: интеграция с сторонними системами с помощью пользовательских серверов MCP
или предопределенные соединители, такие как Google Drive и SharePoint. Дополнительные сведения
Инструменты MCP.
- Вызовы функций (пользовательские средства): функции, определенные вами,
включение модели для вызова собственного кода с строго типизированными аргументами
и выходные данные. Дополнительные сведения
вызов функции. Вы также можете использовать
пользовательские средства для вызова собственного кода.		 Нет
top_logprobs целое число или null Нет
top_p число или null Нет
Усечение строка или null Нет
Пользователя string (не рекомендуется) Это поле заменяется safety_identifier и prompt_cache_key. Вместо этого используйте prompt_cache_key для поддержания оптимизации кэширования.
Стабильный идентификатор для конечных пользователей.
Используется для повышения скорости попадания кэша в более эффективное сегментирование аналогичных запросов и помогает OpenAI обнаруживать и предотвращать злоупотребление. Дополнительные сведения.		 Нет

Ответы

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

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

Тип контента Тип Описание
application/json Объекта
text/event-stream Объекта

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Примеры

Примере

POST {endpoint}/openai/v1/responses

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

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

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

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
response_id Путь Да Строка
include[] Запроса Нет Массива Дополнительные поля для включения в ответ. Дополнительные сведения см. в параметре include для создания ответа выше.
Поток Запроса Нет Логических Если задано значение true, данные ответа модели будут передаваться клиенту по мере его создания с помощью событий, отправляемых сервером.
starting_after Запроса Нет Целое число Порядковый номер события, после которого необходимо начать потоковую передачу.
include_obfuscation Запроса Нет Логических Если задано значение true, будет включена обфускация потока. Потоковая обфускация добавляет случайные символы в obfuscation поле для потоковой передачи событий разностной передачи, чтобы нормализовать размеры полезных данных в качестве устранения рисков для определенных атак на стороне канала. Эти поля маскирования включаются по умолчанию, но добавляют небольшое количество накладных расходов в поток данных. Значение false можно задать include_obfuscation для оптимизации пропускной способности, если вы доверяете сетевым связям между приложением и API OpenAI.

Ответы

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

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

Тип контента Тип Описание
application/json Объекта

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

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

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

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

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
response_id Путь Да Строка

Ответы

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

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

Тип контента Тип Описание
application/json Объекта

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

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

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

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

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
response_id Путь Да Строка

Ответы

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

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

Тип контента Тип Описание
application/json Объекта

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

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

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

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

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
response_id Путь Да Строка
Предел Запроса Нет Целое число Ограничение количества возвращаемых объектов. Ограничение может варьироваться от 1 до 100, а также
значение по умолчанию — 20.
Заказ Запроса Нет Строка
Возможные значения: asc, desc		 Сортировка created_at по метке времени объектов. asc для возрастания иdesc
для убывания порядка.
После Запроса Нет Строка Курсор для использования в разбиении на страницы. after — это идентификатор объекта, определяющий место в списке.
Например, если вы делаете запрос списка и получаете 100 объектов, заканчивая obj_foo, вашей
последующий вызов может включать after=obj_foo, чтобы получить следующую страницу списка.
Перед Запроса Нет Строка Курсор для использования в разбиении на страницы. before — это идентификатор объекта, определяющий место в списке.
Например, если вы делаете запрос списка и получаете 100 объектов, заканчивая obj_foo, вашей
последующий вызов может включать до=obj_foo, чтобы получить предыдущую страницу списка.

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.ResponseItemList

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Потоков

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

POST {endpoint}/openai/v1/threads

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.

Текст запроса

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

Имя Тип Описание Обязательно По умолчанию
Сообщения массив OpenAI.CreateMessageRequest Список сообщений для запуска потока. Нет
Метаданных OpenAI.Metadata или NULL Нет
tool_resources OpenAI.CreateThreadRequestToolResources или null Нет

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.ThreadObject

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Создание и запуск

POST {endpoint}/openai/v1/threads/runs

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.

Текст запроса

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

Имя Тип Описание Обязательно По умолчанию
assistant_id Строка Идентификатор помощника , используемого для выполнения этого выполнения. Да
Инструкции строка или null Переопределите системное сообщение помощника по умолчанию. Это полезно для изменения поведения на основе каждого запуска. Нет
max_completion_tokens целое число или null Максимальное количество маркеров завершения, которые могут использоваться в ходе выполнения. Выполнение сделает все возможное, чтобы использовать только количество маркеров завершения, указанных в нескольких поворотах выполнения. Если выполнение превышает указанное число маркеров завершения, выполнение завершится состоянием incomplete. Дополнительные сведения см. в разделе incomplete_details . Нет
max_prompt_tokens целое число или null Максимальное количество маркеров запроса, которые могут использоваться в ходе выполнения. Выполнение сделает все возможное, чтобы использовать только количество маркеров запроса, указанных в нескольких поворотах выполнения. Если выполнение превышает указанное число маркеров запроса, выполнение завершится состоянием incomplete. Дополнительные сведения см. в разделе incomplete_details . Нет
Метаданных OpenAI.Metadata или NULL Нет
Модели Строка Идентификатор модели , используемой для выполнения этого выполнения. Если здесь указано значение, оно переопределит модель, связанную с помощником. В противном случае будет использоваться модель, связанная с помощником. Нет
parallel_tool_calls OpenAI.ParallelToolCalls Следует ли включить параллельные вызовы функций во время использования средства. Нет
response_format OpenAI.AssistantsApiResponseFormatOption Указывает формат, который модель должна выводить. Совместим с GPT-4o, GPT-4 Turbo и всеми моделями GPT-3.5 Turbo с тех пор gpt-3.5-turbo-1106.
{ "type": "json_schema", "json_schema": {...} } Чтобы включить структурированные выходные данные, которые гарантируют, что модель будет соответствовать предоставленной схеме JSON. Дополнительные сведения см. в разделе
Параметр включения { "type": "json_object" } режима JSON, который гарантирует, что модель создает сообщение является допустимым JSON.
Важно:* при использовании режима JSON необходимо также указать модели создавать JSON самостоятельно с помощью системного или пользовательского сообщения. Без этого модель может создать неуправляемый поток пробелов до тех пор, пока поколение не достигнет предела маркера, в результате чего длительный и, казалось бы, "застрявший" запрос. Кроме того, обратите внимание, что содержимое сообщения может быть частично отрезано, если finish_reason="length", что указывает на превышение поколения max_tokens или беседа превысила максимальную длину контекста.		 Нет
Поток логический или null Если trueвозвращает поток событий, которые происходят во время событий запуска от имени сервера, завершая выполнение в состоянии терминала с сообщением data: [DONE] . Нет
Температура число или null Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным. Нет
Поток OpenAI.CreateThreadRequest Параметры создания нового потока. Если поток не указан при запуске
запрос, будет создан пустой поток.		 Нет
tool_choice OpenAI.AssistantsApiToolChoiceOption Определяет, какое средство (если таковое) вызывается моделью.
none означает, что модель не будет вызывать средства и вместо этого создает сообщение.
auto — это значение по умолчанию и означает, что модель может выбирать между созданием сообщения или вызовом одного или нескольких инструментов.
required означает, что модель должна вызывать один или несколько инструментов, прежде чем отвечать на запрос пользователя.
Указание определенного инструмента, например {"type": "file_search"} или {"type": "function", "function": {"name": "my_function"}} принудительное вызов модели.		 Нет
tool_resources OpenAI.CreateThreadAndRunRequestToolResources или null Набор ресурсов, используемых средствами помощника. Ресурсы относятся к типу инструмента. Например, для code_interpreter средства требуется список идентификаторов файлов, а для file_search этого средства требуется список идентификаторов векторного хранилища. Нет
Инструменты массив OpenAI.AssistantTool Переопределите средства, которые помощник может использовать для этого запуска. Это полезно для изменения поведения на основе каждого запуска. Нет
top_p число или null Альтернатива выборке с температурой, называемой выборкой ядра, где модель рассматривает результаты маркеров с top_p массой вероятности. Таким образом, 0,1 означает, что рассматриваются только маркеры, состоящие из 10 лучших% массы вероятностей.
Как правило, мы рекомендуем изменить это или температуру, но не оба.		 Нет
truncation_strategy OpenAI.TruncationObject Определяет, как поток будет усечен до выполнения. Используйте это для управления начальным окном контекста выполнения. Нет

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.RunObject

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Удаление потока

DELETE {endpoint}/openai/v1/threads/{thread_id}

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
thread_id Путь Да Строка

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.DeleteThreadResponse

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Получение потока

GET {endpoint}/openai/v1/threads/{thread_id}

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
thread_id Путь Да Строка

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.ThreadObject

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Изменение потока

POST {endpoint}/openai/v1/threads/{thread_id}

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
thread_id Путь Да Строка

Текст запроса

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

Имя Тип Описание Обязательно По умолчанию
Метаданных OpenAI.Metadata или NULL Нет
tool_resources OpenAI.ModifyThreadRequestToolResources или null Нет

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.ThreadObject

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Вывод списка сообщений

GET {endpoint}/openai/v1/threads/{thread_id}/messages

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
thread_id Путь Да Строка
Предел Запроса Нет Целое число
Заказ Запроса Нет Строка
Возможные значения: asc, desc
После Запроса Нет Строка
Перед Запроса Нет Строка
run_id Запроса Нет Строка

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.ListMessagesResponse

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Создание сообщения

POST {endpoint}/openai/v1/threads/{thread_id}/messages

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
thread_id Путь Да Строка

Текст запроса

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

Имя Тип Описание Обязательно По умолчанию
Вложения массив OpenAI.CreateMessageRequestAttachments или null Нет
Содержимого строка или массив OpenAI.MessageContentImageFileObject или OpenAI.MessageContentImageUrlObject или OpenAI.MessageRequestContentTextObject Да
Метаданных OpenAI.Metadata или NULL Нет
Роль Перечисления Роль сущности, создающей сообщение. Допустимые значения:
- user: указывает, что сообщение отправляется фактическим пользователем и должно использоваться в большинстве случаев для представления сообщений, созданных пользователем.
- assistant: указывает, что сообщение создается помощником. Используйте это значение для вставки сообщений от помощника в беседу.
Возможные значения: user, assistant		 Да

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.MessageObject

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Удаление сообщения

DELETE {endpoint}/openai/v1/threads/{thread_id}/messages/{message_id}

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
thread_id Путь Да Строка
message_id Путь Да Строка

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.DeleteMessageResponse

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Получение сообщения

GET {endpoint}/openai/v1/threads/{thread_id}/messages/{message_id}

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
thread_id Путь Да Строка
message_id Путь Да Строка

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.MessageObject

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Изменение сообщения

POST {endpoint}/openai/v1/threads/{thread_id}/messages/{message_id}

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
thread_id Путь Да Строка
message_id Путь Да Строка

Текст запроса

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

Имя Тип Описание Обязательно По умолчанию
Метаданных OpenAI.Metadata или NULL Нет

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.MessageObject

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Создание запуска

POST {endpoint}/openai/v1/threads/{thread_id}/runs

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
thread_id Путь Да Строка

Текст запроса

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

Имя Тип Описание Обязательно По умолчанию
additional_instructions строка или null Добавляет дополнительные инструкции в конце инструкций для выполнения. Это полезно для изменения поведения на основе каждого запуска без переопределения других инструкций. Нет
additional_messages массив OpenAI.CreateMessageRequest или null Добавляет дополнительные сообщения в поток перед созданием запуска. Нет
assistant_id Строка Идентификатор помощника , используемого для выполнения этого выполнения. Да
Инструкции строка или null Переопределяет инструкции помощника. Это полезно для изменения поведения на основе каждого запуска. Нет
max_completion_tokens целое число или null Максимальное количество маркеров завершения, которые могут использоваться в ходе выполнения. Выполнение сделает все возможное, чтобы использовать только количество маркеров завершения, указанных в нескольких поворотах выполнения. Если выполнение превышает указанное число маркеров завершения, выполнение завершится состоянием incomplete. Дополнительные сведения см. в разделе incomplete_details . Нет
max_prompt_tokens целое число или null Максимальное количество маркеров запроса, которые могут использоваться в ходе выполнения. Выполнение сделает все возможное, чтобы использовать только количество маркеров запроса, указанных в нескольких поворотах выполнения. Если выполнение превышает указанное число маркеров запроса, выполнение завершится состоянием incomplete. Дополнительные сведения см. в разделе incomplete_details . Нет
Метаданных OpenAI.Metadata или NULL Нет
Модели Строка Идентификатор модели , используемой для выполнения этого выполнения. Если здесь указано значение, оно переопределит модель, связанную с помощником. В противном случае будет использоваться модель, связанная с помощником. Нет
parallel_tool_calls OpenAI.ParallelToolCalls Следует ли включить параллельные вызовы функций во время использования средства. Нет
reasoning_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.		 Нет
response_format OpenAI.AssistantsApiResponseFormatOption Указывает формат, который модель должна выводить. Совместим с GPT-4o, GPT-4 Turbo и всеми моделями GPT-3.5 Turbo с тех пор gpt-3.5-turbo-1106.
{ "type": "json_schema", "json_schema": {...} } Чтобы включить структурированные выходные данные, которые гарантируют, что модель будет соответствовать предоставленной схеме JSON. Дополнительные сведения см. в разделе
Параметр включения { "type": "json_object" } режима JSON, который гарантирует, что модель создает сообщение является допустимым JSON.
Важно:* при использовании режима JSON необходимо также указать модели создавать JSON самостоятельно с помощью системного или пользовательского сообщения. Без этого модель может создать неуправляемый поток пробелов до тех пор, пока поколение не достигнет предела маркера, в результате чего длительный и, казалось бы, "застрявший" запрос. Кроме того, обратите внимание, что содержимое сообщения может быть частично отрезано, если finish_reason="length", что указывает на превышение поколения max_tokens или беседа превысила максимальную длину контекста.		 Нет
Поток логический или null Если trueвозвращает поток событий, которые происходят во время событий запуска от имени сервера, завершая выполнение в состоянии терминала с сообщением data: [DONE] . Нет
Температура число или null Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным. Нет
tool_choice OpenAI.AssistantsApiToolChoiceOption Определяет, какое средство (если таковое) вызывается моделью.
none означает, что модель не будет вызывать средства и вместо этого создает сообщение.
auto — это значение по умолчанию и означает, что модель может выбирать между созданием сообщения или вызовом одного или нескольких инструментов.
required означает, что модель должна вызывать один или несколько инструментов, прежде чем отвечать на запрос пользователя.
Указание определенного инструмента, например {"type": "file_search"} или {"type": "function", "function": {"name": "my_function"}} принудительное вызов модели.		 Нет
Инструменты массив OpenAI.AssistantTool Переопределите средства, которые помощник может использовать для этого запуска. Это полезно для изменения поведения на основе каждого запуска. Нет
top_p число или null Альтернатива выборке с температурой, называемой выборкой ядра, где модель рассматривает результаты маркеров с top_p массой вероятности. Таким образом, 0,1 означает, что рассматриваются только маркеры, состоящие из 10 лучших% массы вероятностей.
Как правило, мы рекомендуем изменить это или температуру, но не оба.		 Нет
truncation_strategy OpenAI.TruncationObject Определяет, как поток будет усечен до выполнения. Используйте это для управления начальным окном контекста выполнения. Нет

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.RunObject

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Список запусков

GET {endpoint}/openai/v1/threads/{thread_id}/runs

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
thread_id Путь Да Строка
Предел Запроса Нет Целое число
Заказ Запроса Нет Строка
Возможные значения: asc, desc
После Запроса Нет Строка
Перед Запроса Нет Строка

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.ListRunsResponse

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Получение выполнения

GET {endpoint}/openai/v1/threads/{thread_id}/runs/{run_id}

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
thread_id Путь Да Строка
run_id Путь Да Строка

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.RunObject

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Изменение выполнения

POST {endpoint}/openai/v1/threads/{thread_id}/runs/{run_id}

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
thread_id Путь Да Строка
run_id Путь Да Строка

Текст запроса

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

Имя Тип Описание Обязательно По умолчанию
Метаданных OpenAI.Metadata или NULL Нет

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.RunObject

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Отмена выполнения

POST {endpoint}/openai/v1/threads/{thread_id}/runs/{run_id}/cancel

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
thread_id Путь Да Строка
run_id Путь Да Строка

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.RunObject

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Перечисление шагов выполнения

GET {endpoint}/openai/v1/threads/{thread_id}/runs/{run_id}/steps

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
thread_id Путь Да Строка
run_id Путь Да Строка
Предел Запроса Нет Целое число
Заказ Запроса Нет Строка
Возможные значения: asc, desc
После Запроса Нет Строка
Перед Запроса Нет Строка

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.ListRunStepsResponse

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Получение шага выполнения

GET {endpoint}/openai/v1/threads/{thread_id}/runs/{run_id}/steps/{step_id}

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
thread_id Путь Да Строка
run_id Путь Да Строка
step_id Путь Да Строка

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.RunStepObject

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Отправка выходных данных средства для выполнения

POST {endpoint}/openai/v1/threads/{thread_id}/runs/{run_id}/submit_tool_outputs

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
thread_id Путь Да Строка
run_id Путь Да Строка

Текст запроса

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

Имя Тип Описание Обязательно По умолчанию
Поток логический или null Нет
tool_outputs массив OpenAI.SubmitToolOutputsRunRequestToolOutputs Список инструментов, для которых отправляются выходные данные. Да

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.RunObject

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Векторные хранилища

Список хранилищ векторов

GET {endpoint}/openai/v1/vector_stores

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

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
Предел Запроса Нет Целое число Ограничение количества возвращаемых объектов. Ограничение может варьироваться от 1 до 100, а также
значение по умолчанию — 20.
Заказ Запроса Нет Строка
Возможные значения: asc, desc		 Сортировка created_at по метке времени объектов. asc для возрастания иdesc
для убывания порядка.
После Запроса Нет Строка Курсор для использования в разбиении на страницы. after — это идентификатор объекта, определяющий место в списке.
Например, если вы делаете запрос списка и получаете 100 объектов, заканчивая obj_foo, вашей
последующий вызов может включать after=obj_foo, чтобы получить следующую страницу списка.
Перед Запроса Нет Строка Курсор для использования в разбиении на страницы. before — это идентификатор объекта, определяющий место в списке.
Например, если вы делаете запрос списка и получаете 100 объектов, заканчивая obj_foo, вашей
последующий вызов может включать до=obj_foo, чтобы получить предыдущую страницу списка.

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.ListVectorStoresResponse

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Создание хранилища векторов

POST {endpoint}/openai/v1/vector_stores

Создает векторное хранилище.

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.

Текст запроса

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

Имя Тип Описание Обязательно По умолчанию
chunking_strategy OpenAI.ChunkingStrategyRequestParam Стратегия блокирования, используемая для блокирования файлов. Если этот параметр не задан, используйте стратегию auto . Применимо только в том случае, если file_ids он не пуст. Нет
Описание Строка Описание хранилища векторов. Можно использовать для описания цели векторного хранилища. Нет
expires_after OpenAI.VectorStoreExpirationAfter Политика истечения срока действия для хранилища векторов. Нет
file_ids массив строк Список идентификаторов файлов , которые следует использовать векторном хранилище. Полезно для таких средств, как file_search доступ к файлам. Нет
Метаданных OpenAI.Metadata или NULL Нет
Имя Строка Имя векторного хранилища. Нет

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.VectorStoreObject

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Примеры

Примере

POST {endpoint}/openai/v1/vector_stores

Получение хранилища векторов

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}

Извлекает векторное хранилище.

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
vector_store_id Путь Да Строка Идентификатор извлекаемого хранилища векторов.

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.VectorStoreObject

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

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

Изменение хранилища векторов

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}

Изменяет векторное хранилище.

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
vector_store_id Путь Да Строка Идентификатор измененного хранилища векторов.

Текст запроса

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

Имя Тип Описание Обязательно По умолчанию
expires_after OpenAI.VectorStoreExpirationAfter Политика истечения срока действия для хранилища векторов. Нет
Метаданных OpenAI.Metadata или NULL Нет
Имя строка или null Имя векторного хранилища. Нет

Ответы

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

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

Тип контента Тип Описание
application/json OpenAI.VectorStoreObject

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

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

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

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

Тип контента Тип Описание
application/json Объекта

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

Заголовка Тип Описание
apim-request-id Строка Идентификатор запроса, используемый для устранения неполадок.

Удаление хранилища векторов

DELETE {endpoint}/openai/v1/vector_stores/{vector_store_id}

Удаление векторного хранилища.

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
vector_store_id Путь Да Строка Идентификатор удаленного хранилища векторов.

Ответы

Код состояния: 200

Описание: запрос выполнен успешно.

Тип контента Тип Описание
application/json OpenAI.DeleteVectorStoreResponse

Заголовки ответа:

Заголовка Тип Описание
apim-request-id Строка Идентификатор запроса, используемый для устранения неполадок.

Код состояния: по умолчанию

Описание: непредвиденная ошибка.

Тип контента Тип Описание
application/json Объекта

Заголовки ответа:

Заголовка Тип Описание
apim-request-id Строка Идентификатор запроса, используемый для устранения неполадок.

Создание пакета файлов хранилища векторов

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches

Создайте пакет файла векторного хранилища.

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
vector_store_id Путь Да Строка Идентификатор хранилища векторов, для которого создается пакет файла.

Текст запроса

Тип содержания: application/json

Имя Тип Описание Обязательно По умолчанию
Атрибуты OpenAI.VectorStoreFileAttributes или null Нет
chunking_strategy OpenAI.ChunkingStrategyRequestParam Стратегия блокирования, используемая для блокирования файлов. Если этот параметр не задан, используйте стратегию auto . Применимо только в том случае, если file_ids он не пуст. Нет
file_ids массив строк Список идентификаторов файлов , которые следует использовать векторном хранилище. Полезно для таких средств, как file_search доступ к файлам. Если attributes или chunking_strategy предоставлено, они будут применены ко всем файлам в пакете. Взаимоисключающ с files. Нет
Файлы массив OpenAI.CreateVectorStoreFileRequest Список объектов, каждый из которых включает в себя file_id плюс необязательный attributes или chunking_strategy. Используйте это, когда необходимо переопределить метаданные для определенных файлов. Глобальный attributes или chunking_strategy будет игнорироваться и должен быть указан для каждого файла. Взаимоисключающ с file_ids. Нет

Ответы

Код состояния: 200

Описание: запрос выполнен успешно.

Тип контента Тип Описание
application/json OpenAI.VectorStoreFileBatchObject

Заголовки ответа:

Заголовка Тип Описание
apim-request-id Строка Идентификатор запроса, используемый для устранения неполадок.

Код состояния: по умолчанию

Описание: непредвиденная ошибка.

Тип контента Тип Описание
application/json Объекта

Заголовки ответа:

Заголовка Тип Описание
apim-request-id Строка Идентификатор запроса, используемый для устранения неполадок.

Получение пакета файлов хранилища векторов

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}

Извлекает пакет файла векторного хранилища.

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
vector_store_id Путь Да Строка Идентификатор хранилища векторов, к которому принадлежит пакет файла.
batch_id Путь Да Строка Идентификатор извлекаемого пакета файлов.

Ответы

Код состояния: 200

Описание: запрос выполнен успешно.

Тип контента Тип Описание
application/json OpenAI.VectorStoreFileBatchObject

Заголовки ответа:

Заголовка Тип Описание
apim-request-id Строка Идентификатор запроса, используемый для устранения неполадок.

Код состояния: по умолчанию

Описание: непредвиденная ошибка.

Тип контента Тип Описание
application/json Объекта

Заголовки ответа:

Заголовка Тип Описание
apim-request-id Строка Идентификатор запроса, используемый для устранения неполадок.

Отмена пакета файлов хранилища векторов

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel

Отмена пакета файла векторного хранилища. Это пытается отменить обработку файлов в этом пакете как можно скорее.

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
vector_store_id Путь Да Строка Идентификатор хранилища векторов, к которому принадлежит пакет файла.
batch_id Путь Да Строка Идентификатор пакета файла для отмены.

Ответы

Код состояния: 200

Описание: запрос выполнен успешно.

Тип контента Тип Описание
application/json OpenAI.VectorStoreFileBatchObject

Заголовки ответа:

Заголовка Тип Описание
apim-request-id Строка Идентификатор запроса, используемый для устранения неполадок.

Код состояния: по умолчанию

Описание: непредвиденная ошибка.

Тип контента Тип Описание
application/json Объекта

Заголовки ответа:

Заголовка Тип Описание
apim-request-id Строка Идентификатор запроса, используемый для устранения неполадок.

Вывод списка файлов в пакетном хранилище векторного хранилища

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/files

Возвращает список файлов векторного хранилища в пакете.

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
vector_store_id Путь Да Строка Идентификатор хранилища векторов, к которому принадлежит пакет файла.
batch_id Путь Да Строка Идентификатор пакета файлов, к которому принадлежат файлы.
Предел Запроса Нет Целое число Ограничение количества возвращаемых объектов. Ограничение может варьироваться от 1 до 100, а также
значение по умолчанию — 20.
Заказ Запроса Нет Строка
Возможные значения: asc, desc		 Сортировка created_at по метке времени объектов. asc для возрастания иdesc
для убывания порядка.
После Запроса Нет Строка Курсор для использования в разбиении на страницы. after — это идентификатор объекта, определяющий место в списке.
Например, если вы делаете запрос списка и получаете 100 объектов, заканчивая obj_foo, вашей
последующий вызов может включать after=obj_foo, чтобы получить следующую страницу списка.
Перед Запроса Нет Строка Курсор для использования в разбиении на страницы. before — это идентификатор объекта, определяющий место в списке.
Например, если вы делаете запрос списка и получаете 100 объектов, заканчивая obj_foo, вашей
последующий вызов может включать до=obj_foo, чтобы получить предыдущую страницу списка.
Фильтр Запроса Нет Строка
Возможные значения: in_progress, , completedfailedcancelled		 Фильтрация по состоянию файла. Один из in_progress, , completedfailed, cancelled.

Ответы

Код состояния: 200

Описание: запрос выполнен успешно.

Тип контента Тип Описание
application/json OpenAI.ListVectorStoreFilesResponse

Заголовки ответа:

Заголовка Тип Описание
apim-request-id Строка Идентификатор запроса, используемый для устранения неполадок.

Код состояния: по умолчанию

Описание: непредвиденная ошибка.

Тип контента Тип Описание
application/json Объекта

Заголовки ответа:

Заголовка Тип Описание
apim-request-id Строка Идентификатор запроса, используемый для устранения неполадок.

Вывод списка файлов хранилища векторов

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/files

Возвращает список файлов векторного хранилища.

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
vector_store_id Путь Да Строка Идентификатор хранилища векторов, к которому принадлежат файлы.
Предел Запроса Нет Целое число Ограничение количества возвращаемых объектов. Ограничение может варьироваться от 1 до 100, а также
значение по умолчанию — 20.
Заказ Запроса Нет Строка
Возможные значения: asc, desc		 Сортировка created_at по метке времени объектов. asc для возрастания иdesc
для убывания порядка.
После Запроса Нет Строка Курсор для использования в разбиении на страницы. after — это идентификатор объекта, определяющий место в списке.
Например, если вы делаете запрос списка и получаете 100 объектов, заканчивая obj_foo, вашей
последующий вызов может включать after=obj_foo, чтобы получить следующую страницу списка.
Перед Запроса Нет Строка Курсор для использования в разбиении на страницы. before — это идентификатор объекта, определяющий место в списке.
Например, если вы делаете запрос списка и получаете 100 объектов, заканчивая obj_foo, вашей
последующий вызов может включать до=obj_foo, чтобы получить предыдущую страницу списка.
Фильтр Запроса Нет Строка
Возможные значения: in_progress, , completedfailedcancelled		 Фильтрация по состоянию файла. Один из in_progress, , completedfailed, cancelled.

Ответы

Код состояния: 200

Описание: запрос выполнен успешно.

Тип контента Тип Описание
application/json OpenAI.ListVectorStoreFilesResponse

Заголовки ответа:

Заголовка Тип Описание
apim-request-id Строка Идентификатор запроса, используемый для устранения неполадок.

Код состояния: по умолчанию

Описание: непредвиденная ошибка.

Тип контента Тип Описание
application/json Объекта

Заголовки ответа:

Заголовка Тип Описание
apim-request-id Строка Идентификатор запроса, используемый для устранения неполадок.

Создание файла хранилища векторов

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/files

Создайте файл векторного хранилища, вложив файл в векторное хранилище.

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
vector_store_id Путь Да Строка Идентификатор векторного хранилища, для которого создается файл.

Текст запроса

Тип содержания: application/json

Имя Тип Описание Обязательно По умолчанию
Атрибуты OpenAI.VectorStoreFileAttributes или null Нет
chunking_strategy OpenAI.ChunkingStrategyRequestParam Стратегия блокирования, используемая для блокирования файлов. Если этот параметр не задан, используйте стратегию auto . Применимо только в том случае, если file_ids он не пуст. Нет
file_id Строка Идентификатор файла , который должен использовать хранилище векторов. Полезно для таких средств, как file_search доступ к файлам. Да

Ответы

Код состояния: 200

Описание: запрос выполнен успешно.

Тип контента Тип Описание
application/json OpenAI.VectorStoreFileObject

Заголовки ответа:

Заголовка Тип Описание
apim-request-id Строка Идентификатор запроса, используемый для устранения неполадок.

Код состояния: по умолчанию

Описание: непредвиденная ошибка.

Тип контента Тип Описание
application/json Объекта

Заголовки ответа:

Заголовка Тип Описание
apim-request-id Строка Идентификатор запроса, используемый для устранения неполадок.

Получение файла хранилища векторов

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/files/{file_id}

Извлекает файл векторного хранилища.

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
vector_store_id Путь Да Строка Идентификатор векторного хранилища, к которому принадлежит файл.
file_id Путь Да Строка Идентификатор извлекаемого файла.

Ответы

Код состояния: 200

Описание: запрос выполнен успешно.

Тип контента Тип Описание
application/json OpenAI.VectorStoreFileObject

Заголовки ответа:

Заголовка Тип Описание
apim-request-id Строка Идентификатор запроса, используемый для устранения неполадок.

Код состояния: по умолчанию

Описание: непредвиденная ошибка.

Тип контента Тип Описание
application/json Объекта

Заголовки ответа:

Заголовка Тип Описание
apim-request-id Строка Идентификатор запроса, используемый для устранения неполадок.

Обновление атрибутов файла хранилища векторов

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/files/{file_id}

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
vector_store_id Путь Да Строка
file_id Путь Да Строка

Текст запроса

Тип содержания: application/json

Имя Тип Описание Обязательно По умолчанию
Атрибуты OpenAI.VectorStoreFileAttributes или null Да

Ответы

Код состояния: 200

Описание: запрос выполнен успешно.

Тип контента Тип Описание
application/json OpenAI.VectorStoreFileObject

Заголовки ответа:

Заголовка Тип Описание
apim-request-id Строка Идентификатор запроса, используемый для устранения неполадок.

Код состояния: по умолчанию

Описание: непредвиденная ошибка.

Тип контента Тип Описание
application/json Объекта

Заголовки ответа:

Заголовка Тип Описание
apim-request-id Строка Идентификатор запроса, используемый для устранения неполадок.

Удаление файла хранилища векторов

DELETE {endpoint}/openai/v1/vector_stores/{vector_store_id}/files/{file_id}

Удаление файла векторного хранилища. Это приведет к удалению файла из векторного хранилища, но сам файл не будет удален. Чтобы удалить файл, используйте конечную точку конечной точки файла удаления.

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
vector_store_id Путь Да Строка Идентификатор векторного хранилища, к которому принадлежит файл.
file_id Путь Да Строка Идентификатор удаленного файла.

Ответы

Код состояния: 200

Описание: запрос выполнен успешно.

Тип контента Тип Описание
application/json OpenAI.DeleteVectorStoreFileResponse

Заголовки ответа:

Заголовка Тип Описание
apim-request-id Строка Идентификатор запроса, используемый для устранения неполадок.

Код состояния: по умолчанию

Описание: непредвиденная ошибка.

Тип контента Тип Описание
application/json Объекта

Заголовки ответа:

Заголовка Тип Описание
apim-request-id Строка Идентификатор запроса, используемый для устранения неполадок.

Получение содержимого файла векторного хранилища

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/files/{file_id}/content

Получение содержимого файла векторного хранилища

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
vector_store_id Путь Да Строка Идентификатор хранилища векторов для поиска.
file_id Путь Да Строка Идентификатор файла, для которого требуется получить содержимое.

Ответы

Код состояния: 200

Описание: запрос выполнен успешно.

Тип контента Тип Описание
application/json OpenAI.VectorStoreSearchResultsPage

Заголовки ответа:

Заголовка Тип Описание
apim-request-id Строка Идентификатор запроса, используемый для устранения неполадок.

Код состояния: по умолчанию

Описание: непредвиденная ошибка.

Тип контента Тип Описание
application/json Объекта

Заголовки ответа:

Заголовка Тип Описание
apim-request-id Строка Идентификатор запроса, используемый для устранения неполадок.

Хранилище векторов поиска

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/search

Хранилище векторов поиска

Параметры URI

Имя В Обязательно Тип Описание
Конечной точки Путь Да Строка Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: https://aoairesource.openai.azure.com Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
версия API Запроса Нет Строка Явная версия API Моделей ИИ Azure для моделей, используемая для этого запроса.
v1 Значение , если не указано в противном случае.
vector_store_id Путь Да Строка Идентификатор хранилища векторов для поиска.

Текст запроса

Тип содержания: application/json

Имя Тип Описание Обязательно По умолчанию
Фильтры OpenAI.ComparisonFilter или OpenAI.CompoundFilter Фильтр для применения на основе атрибутов файла. Нет
max_num_results Целое число Максимальное количество возвращаемых результатов. Это число должно быть от 1 до 50 включительно.
Ограничения: min: 1, max: 50		 Нет 10
Запроса строка или массив строк Строка запроса для поиска Да
ranking_options OpenAI.VectorStoreSearchRequestRankingOptions Нет
Рангер └️ Перечисления
Возможные значения: none, autodefault-2024-11-15		 Нет
└score_threshold Номер Ограничения: min: 0, max: 1 Нет
rewrite_query Логических Следует ли переписать запрос естественного языка для векторного поиска. Нет

Ответы

Код состояния: 200

Описание: запрос выполнен успешно.

Тип контента Тип Описание
application/json OpenAI.VectorStoreSearchResultsPage

Заголовки ответа:

Заголовка Тип Описание
apim-request-id Строка Идентификатор запроса, используемый для устранения неполадок.

Код состояния: по умолчанию

Описание: непредвиденная ошибка.

Тип контента Тип Описание
application/json Объекта

Заголовки ответа:

Заголовка Тип Описание
apim-request-id Строка Идентификатор запроса, используемый для устранения неполадок.

Компоненты

AudioSegment

Имя Тип Описание Обязательно По умолчанию
avg_logprob Номер Средняя вероятность журнала, связанная с этим сегментом звука. Да
compression_ratio Номер Коэффициент сжатия этого сегмента звука. Да
Конец Номер Время, в течение которого этот сегмент закончился относительно начала переведенного звука. Да
Id Целое число 0-й индекс этого сегмента в переводе. Да
no_speech_prob Номер Вероятность отсутствия обнаружения речи в этом сегменте звука. Да
Искать Целое число Позиция поиска, связанная с обработкой этого сегмента звука.
Позиции поиска выражаются как сотые секунды.
Модель может обрабатывать несколько сегментов из одной позиции поиска, поэтому в то время как позиция поиска никогда не будет представлять
позднее, чем начало сегмента, начало сегмента может представлять собой значительно более позднее время, чем
Связанная позиция поиска сегмента.		 Да
Начать Номер Время начала этого сегмента относительно начала переведенного звука. Да
Температура Номер Оценка температуры, связанная с этим сегментом звука. Да
Текст Строка Переведенный текст, который был частью этого сегмента звука. Да
Маркеры массив целых чисел Идентификаторы маркеров, соответствующие переведенным тексту в этом сегменте звука. Да

AudioTaskLabel

Определяет возможные дескрипторы для доступных ответов на звуковые операции.

Свойство Значение
Описание Определяет возможные дескрипторы для доступных ответов на звуковые операции.
Тип Строка
Значения transcribe
translate

AudioTranslationSegment

Расширенная информация о одном сегменте переведенных звуковых данных. Сегменты обычно представляют примерно 5–10 секунд речи. Границы сегментов обычно происходят между словами, но не обязательно предложениями.

Имя Тип Описание Обязательно По умолчанию
avg_logprob Номер Средняя вероятность журнала, связанная с этим сегментом звука. Да
compression_ratio Номер Коэффициент сжатия этого сегмента звука. Да
Конец Номер Время, в течение которого этот сегмент закончился относительно начала переведенного звука. Да
Id Целое число 0-й индекс этого сегмента в переводе. Да
no_speech_prob Номер Вероятность отсутствия обнаружения речи в этом сегменте звука. Да
Искать Целое число Позиция поиска, связанная с обработкой этого сегмента звука.
Позиции поиска выражаются как сотые секунды.
Модель может обрабатывать несколько сегментов из одной позиции поиска, поэтому в то время как позиция поиска никогда не будет представлять
позднее, чем начало сегмента, начало сегмента может представлять собой значительно более позднее время, чем
Связанная позиция поиска сегмента.		 Да
Начать Номер Время начала этого сегмента относительно начала переведенного звука. Да
Температура Номер Оценка температуры, связанная с этим сегментом звука. Да
Текст Строка Переведенный текст, который был частью этого сегмента звука. Да
Маркеры массив целых чисел Идентификаторы маркеров, соответствующие переведенным тексту в этом сегменте звука. Да

AzureAIFoundryModelsApiVersion

Свойство Значение
Тип Строка
Значения v1
preview

AzureAudioTranscriptionResponse

Сведения о результатах операции, которая транскрибировала голосовой звук в письменный текст.

Имя Тип Описание Обязательно По умолчанию
Длительность Номер Общая длительность звука, обработанного для создания сопроводительных сведений о транскрибировании. Нет
Язык Строка Речной язык, обнаруженный в транскрибированных звуковых данных.
Это выражается как двухбуквенный код языка ISO-639-1, например en или fr.		 Нет
Сегментов массив OpenAI.TranscriptionSegment Коллекция сведений о времени, вероятностях и других деталях каждого обработанного сегмента звука. Нет
Задача AudioTaskLabel Определяет возможные дескрипторы для доступных ответов на звуковые операции. Нет
Текст Строка Транскрибированный текст для предоставленных звуковых данных. Да
Слова массив OpenAI.TranscriptionWord Коллекция сведений о времени обработки каждого обработанного слова. Нет

AzureAudioTranslationResponse

Сведения о результатах операции, которая превратила речной звук в письменный текст.

Имя Тип Описание Обязательно По умолчанию
Длительность Номер Общая длительность звука, обработанного для создания сопровождающих сведений о переводе. Нет
Язык Строка Речной язык, обнаруженный в переведенных звуковых данных.
Это выражается как двухбуквенный код языка ISO-639-1, например en или fr.		 Нет
Сегментов массив AudioTranslationSegment Коллекция сведений о времени, вероятностях и других деталях каждого обработанного сегмента звука. Нет
Задача AudioTaskLabel Определяет возможные дескрипторы для доступных ответов на звуковые операции. Нет
Текст Строка Переведенный текст для предоставленных звуковых данных. Да

AzureCompletionsSamplingParams

Параметры выборки для управления поведением завершения.

Имя Тип Описание Обязательно По умолчанию
max_completion_tokens Целое число Нет
max_tokens Целое число Максимальное количество маркеров в созданных выходных данных. Нет
reasoning_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.		 Нет
response_format OpenAI.ResponseFormatText или OpenAI.ResponseFormatJsonSchema или OpenAI.ResponseFormatJsonObject Нет
Семян Целое число Начальное значение инициализирует случайность во время выборки. Нет 42
Температура Номер Более высокая температура увеличивает случайность выходных данных. Нет 1
Инструменты массив OpenAI.ChatCompletionTool Нет
top_p Номер Альтернатива температуре для выборки ядра; 1.0 включает все маркеры. Нет 1

AzureContentFilterBlocklistIdResult

Элемент результата фильтра содержимого, который связывает существующий пользовательский идентификатор списка блокировок со значением, указывающим, приводит ли соответствующий список блокировок к фильтруемого содержимого.

Имя Тип Описание Обязательно По умолчанию
Фильтруется Логических Приводит ли связанный список блокировок к фильтруемого содержимого. Да
Id Строка Идентификатор настраиваемого списка блокировок, связанного с отфильтрованным состоянием. Да

AzureContentFilterBlocklistResult

Коллекция результатов фильтрации true/false для настроенных настраиваемых списков блокировок.

Имя Тип Описание Обязательно По умолчанию
Детали массив объекта Пары отдельных идентификаторов блок-списков и их ли они привели к действию фильтрации. Нет
Фильтруется Логических Значение, указывающее, приводит ли любой из подробных списков блокировок к действию фильтрации. Да

AzureContentFilterCompletionTextSpan

Представление диапазона текста завершения, используемого результатами фильтра содержимого Azure OpenAI.

Имя Тип Описание Обязательно По умолчанию
completion_end_offset Целое число Смещение первой точки кода UTF32, которая исключается из диапазона. Это поле всегда равно completion_start_offset для пустых диапазонов. Это поле всегда больше completion_start_offset для непустых диапазонов. Да
completion_start_offset Целое число Смещение точки кода UTF32, которая начинает диапазон. Да

AzureContentFilterCompletionTextSpanDetectionResult

Имя Тип Описание Обязательно По умолчанию
Детали массив AzureContentFilterCompletionTextSpan Подробные сведения об обнаруженных диапазонах текста завершения. Да
Обнаружены Логических Обнаружена ли в содержимом категория помеченного содержимого. Да
Фильтруется Логических Приведет ли обнаружение содержимого к действию фильтрации содержимого. Да

AzureContentFilterCustomTopicIdResult

Элемент результата фильтра содержимого, который связывает существующий пользовательский идентификатор раздела со значением, указывающим, обнаружен ли соответствующий раздел.

Имя Тип Описание Обязательно По умолчанию
Обнаружены Логических Указывает, приводит ли связанный пользовательский раздел к обнаружению содержимого. Да
Id Строка Идентификатор настраиваемого раздела, связанного с обнаруженным состоянием. Да

AzureContentFilterCustomTopicResult

Коллекция результатов фильтрации true/false для настроенных пользовательских разделов.

Имя Тип Описание Обязательно По умолчанию
Детали массив объекта Пары идентификаторов отдельных разделов и их обнаружение. Нет
Фильтруется Логических Значение, указывающее, приводит ли любой из подробных разделов к действию фильтрации. Да

AzureContentFilterDetectionResult

Элемент результата фильтра содержимого с метками, указывающий, был ли обнаружен контент и был ли отфильтрован содержимое.

Имя Тип Описание Обязательно По умолчанию
Обнаружены Логических Обнаружена ли в содержимом категория помеченного содержимого. Да
Фильтруется Логических Приведет ли обнаружение содержимого к действию фильтрации содержимого. Да

AzureContentFilterForResponsesAPI

Имя Тип Описание Обязательно По умолчанию
Заблокирован Логических Укажите, заблокирован ли ответ. Да
content_filter_offsets AzureContentFilterResultOffsets Да
content_filter_results AzureContentFilterResultsForResponsesAPI Да
└custom_blocklists custom_blocklists AzureContentFilterBlocklistResult Коллекция результатов двоичной фильтрации для настроенных настраиваемых списков блокировок. Нет
└custom_topics AzureContentFilterCustomTopicResult Коллекция результатов двоичной фильтрации для настроенных пользовательских разделов. Нет
Ошибка └️ Объекта При наличии подробные сведения об ошибке, которая не позволяла фильтровать содержимое, завершив оценку. Нет
Код └️ Целое число Отдельный удобочитаемый компьютером код, связанный с ошибкой. Да
Сообщение └️ Строка Сообщение, доступное для чтения человеком, связанное с ошибкой. Да
└️ ненависть AzureContentFilterSeverityResult Категория фильтра содержимого, которая может ссылаться на любое содержимое, которое атакует или использует дискриминационный или дискриминационный характер.
язык с ссылкой на группу удостоверений или человека на основе определенных атрибутов разных групп
включая, но не ограничивается расой, этнической принадлежностью, национальностью, гендерной идентификацией и выражением, сексуальной ориентацией,
религия, иммиграционный статус, статус способности, личный вид и размер тела.		 Нет
└️ indirect_attack AzureContentFilterDetectionResult Результат обнаружения, описывающий атаки на системы на основе моделей генерированного искусственного интеллекта, которые могут происходить каждый раз
приложение обрабатывает сведения, которые не были непосредственно созданы разработчиком приложения или
пользователь.		 Нет
└️ джейл-брейк AzureContentFilterDetectionResult Результат обнаружения, описывающий атаки на внедрение запросов пользователей, где злоумышленники намеренно эксплуатируют
уязвимости системы для получения несанкционированного поведения от LLM. Это может привести к несоответствующем содержимому
создание или нарушение установленных системой ограничений.		 Да
└personally_identifiable_information personally_identifiable_information AzureContentFilterPersonallyIdentifiableInformationResult Результат обнаружения, описывающий совпадения с персональными идентифицируемыми сведениями с настраиваемыми подкатегориями. Нет
└️ ненормативная лексика AzureContentFilterDetectionResult Результат обнаружения, определяющий, присутствует ли в языке возражений сырая, вульгарная или в противном случае
Содержимого.		 Нет
└️ protected_material_code Объекта Результат обнаружения, описывающий совпадение с лицензированным кодом или другим защищенным исходным материалом. Нет
Ссылка └️ Объекта При наличии сведения о ссылке, описывающей связанную лицензию и ее расположение. Нет
URL-адрес └️ Строка URL-адрес, связанный с лицензией. Нет
Лицензия └️ Строка Имя или идентификатор лицензии, связанной с обнаружением. Нет
Обнаружена └️ Логических Обнаружена ли в содержимом категория помеченного содержимого. Да
└️ отфильтрован Логических Приведет ли обнаружение содержимого к действию фильтрации содержимого. Да
└️ protected_material_text AzureContentFilterDetectionResult Результат обнаружения, описывающий совпадение с текстом, защищенным авторским правом или другим статусом. Нет
└self_harm AzureContentFilterSeverityResult Категория фильтра содержимого, описывающая язык, связанный с физическими действиями, предназначенными для намеренной травмы,
повредить тело или убить себя.		 Нет
└️ сексуальный AzureContentFilterSeverityResult Категория фильтра содержимого для языка, связанного с анатомическими органами и гениталиями, романтическими отношениями, действует
изображается в эротических или ласковых терминах, беременности, физических сексуальных актах, в том числе изображаемых как
нападение или принудительное сексуальное насилие против воли, проституции, порнографии и злоупотреблений.		 Нет
└task_adherence AzureContentFilterDetectionResult Результат обнаружения, указывающий, остается ли поток выполнения придерживаться плана. Да
└️ ungrounded_material AzureContentFilterCompletionTextSpanDetectionResult Нет
└️ насилие AzureContentFilterSeverityResult Категория фильтра содержимого для языка, связанного с физическими действиями, предназначенными для повреждения, травмы, повреждения или убийства
кто-то или что-то; описывает оружие, оружие и связанные сущности, такие как производство, ассоциации,
законодательство и т. д.		 Нет
source_type Строка Имя исходного типа сообщения. Да

AzureContentFilterHarmExtensions

Расширения для категорий вреда, предоставляющие дополнительные параметры конфигурации.

Имя Тип Описание Обязательно По умолчанию
pii_sub_categories массив AzurePiiSubCategory Конфигурация для PIIHarmSubCategory(s). Нет

AzureContentFilterImagePromptResults

Результат фильтра содержимого для содержимого входного запроса операции создания изображения.

Имя Тип Описание Обязательно По умолчанию
custom_blocklists AzureContentFilterBlocklistResult Коллекция результатов фильтрации true/false для настроенных настраиваемых списков блокировок. Нет
└️ подробности массив объекта Пары отдельных идентификаторов блок-списков и их ли они привели к действию фильтрации. Нет
└️ отфильтрован Логических Значение, указывающее, был ли блок-список создан действие фильтрации. Да
Идентификатор └️ Строка Идентификатор настраиваемого списка блоков, вычисляемого. Да
└️ отфильтрован Логических Значение, указывающее, приводит ли любой из подробных списков блокировок к действию фильтрации. Да
custom_topics AzureContentFilterCustomTopicResult Коллекция результатов фильтрации true/false для настроенных пользовательских разделов. Нет
└️ подробности массив объекта Пары идентификаторов отдельных разделов и их обнаружение. Нет
Обнаружена └️ Логических Значение, указывающее, обнаружен ли раздел. Да
Идентификатор └️ Строка Идентификатор вычисляемого пользовательского раздела. Да
└️ отфильтрован Логических Значение, указывающее, приводит ли любой из подробных разделов к действию фильтрации. Да
Ненавижу AzureContentFilterSeverityResult Элемент результата фильтра содержимого с метками, указывающий, было ли отфильтровано содержимое и каким качеством
Уровень серьезности содержимого был оценен по конфигурации фильтра содержимого для категории.		 Нет
└️ отфильтрован Логических Является ли серьезность содержимого результатом действия фильтрации содержимого. Да
Серьезность └️ Перечисления Уровень серьезности содержимого с меткой.
Возможные значения: safe, , lowmediumhigh		 Да
Джейлбрейк AzureContentFilterDetectionResult Элемент результата фильтра содержимого с метками, указывающий, обнаружен ли содержимое и было ли содержимое
Фильтруется.		 Да
Обнаружена └️ Логических Обнаружена ли в содержимом категория помеченного содержимого. Да
└️ отфильтрован Логических Приведет ли обнаружение содержимого к действию фильтрации содержимого. Да
Ненормативной лексики AzureContentFilterDetectionResult Элемент результата фильтра содержимого с метками, указывающий, обнаружен ли содержимое и было ли содержимое
Фильтруется.		 Нет
Обнаружена └️ Логических Обнаружена ли в содержимом категория помеченного содержимого. Да
└️ отфильтрован Логических Приведет ли обнаружение содержимого к действию фильтрации содержимого. Да
self_harm AzureContentFilterSeverityResult Элемент результата фильтра содержимого с метками, указывающий, было ли отфильтровано содержимое и каким качеством
Уровень серьезности содержимого был оценен по конфигурации фильтра содержимого для категории.		 Нет
└️ отфильтрован Логических Является ли серьезность содержимого результатом действия фильтрации содержимого. Да
Серьезность └️ Перечисления Уровень серьезности содержимого с меткой.
Возможные значения: safe, , lowmediumhigh		 Да
Сексуальной AzureContentFilterSeverityResult Элемент результата фильтра содержимого с метками, указывающий, было ли отфильтровано содержимое и каким качеством
Уровень серьезности содержимого был оценен по конфигурации фильтра содержимого для категории.		 Нет
└️ отфильтрован Логических Является ли серьезность содержимого результатом действия фильтрации содержимого. Да
Серьезность └️ Перечисления Уровень серьезности содержимого с меткой.
Возможные значения: safe, , lowmediumhigh		 Да
Насилия AzureContentFilterSeverityResult Элемент результата фильтра содержимого с метками, указывающий, было ли отфильтровано содержимое и каким качеством
Уровень серьезности содержимого был оценен по конфигурации фильтра содержимого для категории.		 Нет
└️ отфильтрован Логических Является ли серьезность содержимого результатом действия фильтрации содержимого. Да
Серьезность └️ Перечисления Уровень серьезности содержимого с меткой.
Возможные значения: safe, , lowmediumhigh		 Да

AzureContentFilterImageResponseResults

Результат фильтра содержимого для содержимого вывода ответа операции создания изображений.

Имя Тип Описание Обязательно По умолчанию
Ненавижу AzureContentFilterSeverityResult Элемент результата фильтра содержимого с метками, указывающий, было ли отфильтровано содержимое и каким качеством
Уровень серьезности содержимого был оценен по конфигурации фильтра содержимого для категории.		 Нет
└️ отфильтрован Логических Является ли серьезность содержимого результатом действия фильтрации содержимого. Да
Серьезность └️ Перечисления Уровень серьезности содержимого с меткой.
Возможные значения: safe, , lowmediumhigh		 Да
self_harm AzureContentFilterSeverityResult Элемент результата фильтра содержимого с метками, указывающий, было ли отфильтровано содержимое и каким качеством
Уровень серьезности содержимого был оценен по конфигурации фильтра содержимого для категории.		 Нет
└️ отфильтрован Логических Является ли серьезность содержимого результатом действия фильтрации содержимого. Да
Серьезность └️ Перечисления Уровень серьезности содержимого с меткой.
Возможные значения: safe, , lowmediumhigh		 Да
Сексуальной AzureContentFilterSeverityResult Элемент результата фильтра содержимого с метками, указывающий, было ли отфильтровано содержимое и каким качеством
Уровень серьезности содержимого был оценен по конфигурации фильтра содержимого для категории.		 Нет
└️ отфильтрован Логических Является ли серьезность содержимого результатом действия фильтрации содержимого. Да
Серьезность └️ Перечисления Уровень серьезности содержимого с меткой.
Возможные значения: safe, , lowmediumhigh		 Да
Насилия AzureContentFilterSeverityResult Элемент результата фильтра содержимого с метками, указывающий, было ли отфильтровано содержимое и каким качеством
Уровень серьезности содержимого был оценен по конфигурации фильтра содержимого для категории.		 Нет
└️ отфильтрован Логических Является ли серьезность содержимого результатом действия фильтрации содержимого. Да
Серьезность └️ Перечисления Уровень серьезности содержимого с меткой.
Возможные значения: safe, , lowmediumhigh		 Да

AzureContentFilterPersonallyIdentifiableInformationResult

Результат обнаружения фильтра содержимого для личных сведений, включающих расширения вреда.

Имя Тип Описание Обязательно По умолчанию
Обнаружены Логических Обнаружена ли в содержимом категория помеченного содержимого. Да
Фильтруется Логических Приведет ли обнаружение содержимого к действию фильтрации содержимого. Да
redacted_text Строка Отредактированные тексты с информацией piI удалены или маскированы. Нет
sub_categories массив AzurePiiSubCategoryResult Подробные результаты для отдельных PIIHarmSubCategory. Нет

AzureContentFilterResultForChoice

Результат фильтра содержимого для одного элемента ответа, созданного системой создания искусственного интеллекта.

Имя Тип Описание Обязательно По умолчанию
custom_blocklists AzureContentFilterBlocklistResult Коллекция результатов фильтрации true/false для настроенных настраиваемых списков блокировок. Нет
└️ подробности массив объекта Пары отдельных идентификаторов блок-списков и их ли они привели к действию фильтрации. Нет
└️ отфильтрован Логических Значение, указывающее, был ли блок-список создан действие фильтрации. Да
Идентификатор └️ Строка Идентификатор настраиваемого списка блоков, вычисляемого. Да
└️ отфильтрован Логических Значение, указывающее, приводит ли любой из подробных списков блокировок к действию фильтрации. Да
custom_topics AzureContentFilterCustomTopicResult Коллекция результатов фильтрации true/false для настроенных пользовательских разделов. Нет
└️ подробности массив объекта Пары идентификаторов отдельных разделов и их обнаружение. Нет
Обнаружена └️ Логических Значение, указывающее, обнаружен ли раздел. Да
Идентификатор └️ Строка Идентификатор вычисляемого пользовательского раздела. Да
└️ отфильтрован Логических Значение, указывающее, приводит ли любой из подробных разделов к действию фильтрации. Да
Ошибка Объекта При наличии подробные сведения об ошибке, которая не позволяла фильтровать содержимое, завершив оценку. Нет
Код └️ Целое число Отдельный удобочитаемый компьютером код, связанный с ошибкой. Да
Сообщение └️ Строка Сообщение, доступное для чтения человеком, связанное с ошибкой. Да
Ненавижу AzureContentFilterSeverityResult Элемент результата фильтра содержимого с метками, указывающий, было ли отфильтровано содержимое и каким качеством
Уровень серьезности содержимого был оценен по конфигурации фильтра содержимого для категории.		 Нет
└️ отфильтрован Логических Является ли серьезность содержимого результатом действия фильтрации содержимого. Да
Серьезность └️ Перечисления Уровень серьезности содержимого с меткой.
Возможные значения: safe, , lowmediumhigh		 Да
personally_identifiable_information AzureContentFilterPersonallyIdentifiableInformationResult Результат обнаружения фильтра содержимого для личных сведений, включающих расширения вреда. Нет
└️ redacted_text Строка Отредактированные тексты с информацией piI удалены или маскированы. Нет
└sub_categories массив AzurePiiSubCategoryResult Подробные результаты для отдельных PIIHarmSubCategory. Нет
Ненормативной лексики AzureContentFilterDetectionResult Элемент результата фильтра содержимого с метками, указывающий, обнаружен ли содержимое и было ли содержимое
Фильтруется.		 Нет
Обнаружена └️ Логических Обнаружена ли в содержимом категория помеченного содержимого. Да
└️ отфильтрован Логических Приведет ли обнаружение содержимого к действию фильтрации содержимого. Да
protected_material_code Объекта Результат обнаружения, описывающий совпадение с лицензированным кодом или другим защищенным исходным материалом. Нет
Ссылка └️ Объекта При наличии сведения о ссылке, описывающей связанную лицензию и ее расположение. Нет
URL-адрес └️ Строка URL-адрес, связанный с лицензией. Нет
Лицензия └️ Строка Имя или идентификатор лицензии, связанной с обнаружением. Нет
Обнаружена └️ Логических Обнаружена ли в содержимом категория помеченного содержимого. Да
└️ отфильтрован Логических Приведет ли обнаружение содержимого к действию фильтрации содержимого. Да
protected_material_text AzureContentFilterDetectionResult Элемент результата фильтра содержимого с метками, указывающий, обнаружен ли содержимое и было ли содержимое
Фильтруется.		 Нет
Обнаружена └️ Логических Обнаружена ли в содержимом категория помеченного содержимого. Да
└️ отфильтрован Логических Приведет ли обнаружение содержимого к действию фильтрации содержимого. Да
self_harm AzureContentFilterSeverityResult Элемент результата фильтра содержимого с метками, указывающий, было ли отфильтровано содержимое и каким качеством
Уровень серьезности содержимого был оценен по конфигурации фильтра содержимого для категории.		 Нет
└️ отфильтрован Логических Является ли серьезность содержимого результатом действия фильтрации содержимого. Да
Серьезность └️ Перечисления Уровень серьезности содержимого с меткой.
Возможные значения: safe, , lowmediumhigh		 Да
Сексуальной AzureContentFilterSeverityResult Элемент результата фильтра содержимого с метками, указывающий, было ли отфильтровано содержимое и каким качеством
Уровень серьезности содержимого был оценен по конфигурации фильтра содержимого для категории.		 Нет
└️ отфильтрован Логических Является ли серьезность содержимого результатом действия фильтрации содержимого. Да
Серьезность └️ Перечисления Уровень серьезности содержимого с меткой.
Возможные значения: safe, , lowmediumhigh		 Да
ungrounded_material AzureContentFilterCompletionTextSpanDetectionResult Нет
Насилия AzureContentFilterSeverityResult Элемент результата фильтра содержимого с метками, указывающий, было ли отфильтровано содержимое и каким качеством
Уровень серьезности содержимого был оценен по конфигурации фильтра содержимого для категории.		 Нет
└️ отфильтрован Логических Является ли серьезность содержимого результатом действия фильтрации содержимого. Да
Серьезность └️ Перечисления Уровень серьезности содержимого с меткой.
Возможные значения: safe, , lowmediumhigh		 Да

AzureContentFilterResultForPrompt

Результат фильтра содержимого, связанный с одним элементом запроса ввода в генерируемую систему ИИ.

Имя Тип Описание Обязательно По умолчанию
content_filter_results Объекта Сведения о категории фильтра содержимого для результата. Нет
└custom_blocklists custom_blocklists AzureContentFilterBlocklistResult Коллекция результатов фильтрации true/false для настроенных настраиваемых списков блокировок. Нет
└️ подробности массив объекта Пары отдельных идентификаторов блок-списков и их ли они привели к действию фильтрации. Нет
└️ отфильтрован Логических Значение, указывающее, был ли блок-список создан действие фильтрации. Да
Идентификатор └️ Строка Идентификатор настраиваемого списка блоков, вычисляемого. Да
└️ отфильтрован Логических Значение, указывающее, приводит ли любой из подробных списков блокировок к действию фильтрации. Да
└custom_topics AzureContentFilterCustomTopicResult Коллекция результатов фильтрации true/false для настроенных пользовательских разделов. Нет
└️ подробности массив объекта Пары идентификаторов отдельных разделов и их обнаружение. Нет
Обнаружена └️ Логических Значение, указывающее, обнаружен ли раздел. Да
Идентификатор └️ Строка Идентификатор вычисляемого пользовательского раздела. Да
└️ отфильтрован Логических Значение, указывающее, приводит ли любой из подробных разделов к действию фильтрации. Да
Ошибка └️ Объекта При наличии подробные сведения об ошибке, которая не позволяла фильтровать содержимое, завершив оценку. Нет
Код └️ Целое число Отдельный удобочитаемый компьютером код, связанный с ошибкой. Да
Сообщение └️ Строка Сообщение, доступное для чтения человеком, связанное с ошибкой. Да
└️ ненависть AzureContentFilterSeverityResult Элемент результата фильтра содержимого с метками, указывающий, было ли отфильтровано содержимое и каким качеством
Уровень серьезности содержимого был оценен по конфигурации фильтра содержимого для категории.		 Нет
└️ отфильтрован Логических Является ли серьезность содержимого результатом действия фильтрации содержимого. Да
Серьезность └️ Перечисления Уровень серьезности содержимого с меткой.
Возможные значения: safe, , lowmediumhigh		 Да
└️ indirect_attack AzureContentFilterDetectionResult Элемент результата фильтра содержимого с метками, указывающий, обнаружен ли содержимое и было ли содержимое
Фильтруется.		 Да
Обнаружена └️ Логических Обнаружена ли в содержимом категория помеченного содержимого. Да
└️ отфильтрован Логических Приведет ли обнаружение содержимого к действию фильтрации содержимого. Да
└️ джейл-брейк AzureContentFilterDetectionResult Элемент результата фильтра содержимого с метками, указывающий, обнаружен ли содержимое и было ли содержимое
Фильтруется.		 Да
Обнаружена └️ Логических Обнаружена ли в содержимом категория помеченного содержимого. Да
└️ отфильтрован Логических Приведет ли обнаружение содержимого к действию фильтрации содержимого. Да
└️ ненормативная лексика AzureContentFilterDetectionResult Элемент результата фильтра содержимого с метками, указывающий, обнаружен ли содержимое и было ли содержимое
Фильтруется.		 Нет
Обнаружена └️ Логических Обнаружена ли в содержимом категория помеченного содержимого. Да
└️ отфильтрован Логических Приведет ли обнаружение содержимого к действию фильтрации содержимого. Да
└self_harm AzureContentFilterSeverityResult Элемент результата фильтра содержимого с метками, указывающий, было ли отфильтровано содержимое и каким качеством
Уровень серьезности содержимого был оценен по конфигурации фильтра содержимого для категории.		 Нет
└️ отфильтрован Логических Является ли серьезность содержимого результатом действия фильтрации содержимого. Да
Серьезность └️ Перечисления Уровень серьезности содержимого с меткой.
Возможные значения: safe, , lowmediumhigh		 Да
└️ сексуальный AzureContentFilterSeverityResult Элемент результата фильтра содержимого с метками, указывающий, было ли отфильтровано содержимое и каким качеством
Уровень серьезности содержимого был оценен по конфигурации фильтра содержимого для категории.		 Нет
└️ отфильтрован Логических Является ли серьезность содержимого результатом действия фильтрации содержимого. Да
Серьезность └️ Перечисления Уровень серьезности содержимого с меткой.
Возможные значения: safe, , lowmediumhigh		 Да
└️ насилие AzureContentFilterSeverityResult Элемент результата фильтра содержимого с метками, указывающий, было ли отфильтровано содержимое и каким качеством
Уровень серьезности содержимого был оценен по конфигурации фильтра содержимого для категории.		 Нет
└️ отфильтрован Логических Является ли серьезность содержимого результатом действия фильтрации содержимого. Да
Серьезность └️ Перечисления Уровень серьезности содержимого с меткой.
Возможные значения: safe, , lowmediumhigh		 Да
prompt_index Целое число Индекс входного запроса, связанного с сопутствующими категориями результатов фильтра содержимого. Нет

AzureContentFilterResultOffsets

Имя Тип Описание Обязательно По умолчанию
check_offset Целое число Да
end_offset Целое число Да
start_offset Целое число Да

AzureContentFilterResultsForResponsesAPI

Имя Тип Описание Обязательно По умолчанию
custom_blocklists AzureContentFilterBlocklistResult Коллекция результатов фильтрации true/false для настроенных настраиваемых списков блокировок. Нет
└️ подробности массив объекта Пары отдельных идентификаторов блок-списков и их ли они привели к действию фильтрации. Нет
└️ отфильтрован Логических Значение, указывающее, был ли блок-список создан действие фильтрации. Да
Идентификатор └️ Строка Идентификатор настраиваемого списка блоков, вычисляемого. Да
└️ отфильтрован Логических Значение, указывающее, приводит ли любой из подробных списков блокировок к действию фильтрации. Да
custom_topics AzureContentFilterCustomTopicResult Коллекция результатов фильтрации true/false для настроенных пользовательских разделов. Нет
└️ подробности массив объекта Пары идентификаторов отдельных разделов и их обнаружение. Нет
Обнаружена └️ Логических Значение, указывающее, обнаружен ли раздел. Да
Идентификатор └️ Строка Идентификатор вычисляемого пользовательского раздела. Да
└️ отфильтрован Логических Значение, указывающее, приводит ли любой из подробных разделов к действию фильтрации. Да
Ошибка Объекта При наличии подробные сведения об ошибке, которая не позволяла фильтровать содержимое, завершив оценку. Нет
Код └️ Целое число Отдельный удобочитаемый компьютером код, связанный с ошибкой. Да
Сообщение └️ Строка Сообщение, доступное для чтения человеком, связанное с ошибкой. Да
Ненавижу AzureContentFilterSeverityResult Элемент результата фильтра содержимого с метками, указывающий, было ли отфильтровано содержимое и каким качеством
Уровень серьезности содержимого был оценен по конфигурации фильтра содержимого для категории.		 Нет
└️ отфильтрован Логических Является ли серьезность содержимого результатом действия фильтрации содержимого. Да
Серьезность └️ Перечисления Уровень серьезности содержимого с меткой.
Возможные значения: safe, , lowmediumhigh		 Да
indirect_attack AzureContentFilterDetectionResult Элемент результата фильтра содержимого с метками, указывающий, обнаружен ли содержимое и было ли содержимое
Фильтруется.		 Нет
Обнаружена └️ Логических Обнаружена ли в содержимом категория помеченного содержимого. Да
└️ отфильтрован Логических Приведет ли обнаружение содержимого к действию фильтрации содержимого. Да
Джейлбрейк AzureContentFilterDetectionResult Элемент результата фильтра содержимого с метками, указывающий, обнаружен ли содержимое и было ли содержимое
Фильтруется.		 Да
Обнаружена └️ Логических Обнаружена ли в содержимом категория помеченного содержимого. Да
└️ отфильтрован Логических Приведет ли обнаружение содержимого к действию фильтрации содержимого. Да
personally_identifiable_information AzureContentFilterPersonallyIdentifiableInformationResult Результат обнаружения фильтра содержимого для личных сведений, включающих расширения вреда. Нет
└️ redacted_text Строка Отредактированные тексты с информацией piI удалены или маскированы. Нет
└sub_categories массив AzurePiiSubCategoryResult Подробные результаты для отдельных PIIHarmSubCategory. Нет
Ненормативной лексики AzureContentFilterDetectionResult Элемент результата фильтра содержимого с метками, указывающий, обнаружен ли содержимое и было ли содержимое
Фильтруется.		 Нет
Обнаружена └️ Логических Обнаружена ли в содержимом категория помеченного содержимого. Да
└️ отфильтрован Логических Приведет ли обнаружение содержимого к действию фильтрации содержимого. Да
protected_material_code Объекта Результат обнаружения, описывающий совпадение с лицензированным кодом или другим защищенным исходным материалом. Нет
Ссылка └️ Объекта При наличии сведения о ссылке, описывающей связанную лицензию и ее расположение. Нет
URL-адрес └️ Строка URL-адрес, связанный с лицензией. Нет
Лицензия └️ Строка Имя или идентификатор лицензии, связанной с обнаружением. Нет
Обнаружена └️ Логических Обнаружена ли в содержимом категория помеченного содержимого. Да
└️ отфильтрован Логических Приведет ли обнаружение содержимого к действию фильтрации содержимого. Да
protected_material_text AzureContentFilterDetectionResult Элемент результата фильтра содержимого с метками, указывающий, обнаружен ли содержимое и было ли содержимое
Фильтруется.		 Нет
Обнаружена └️ Логических Обнаружена ли в содержимом категория помеченного содержимого. Да
└️ отфильтрован Логических Приведет ли обнаружение содержимого к действию фильтрации содержимого. Да
self_harm AzureContentFilterSeverityResult Элемент результата фильтра содержимого с метками, указывающий, было ли отфильтровано содержимое и каким качеством
Уровень серьезности содержимого был оценен по конфигурации фильтра содержимого для категории.		 Нет
└️ отфильтрован Логических Является ли серьезность содержимого результатом действия фильтрации содержимого. Да
Серьезность └️ Перечисления Уровень серьезности содержимого с меткой.
Возможные значения: safe, , lowmediumhigh		 Да
Сексуальной AzureContentFilterSeverityResult Элемент результата фильтра содержимого с метками, указывающий, было ли отфильтровано содержимое и каким качеством
Уровень серьезности содержимого был оценен по конфигурации фильтра содержимого для категории.		 Нет
└️ отфильтрован Логических Является ли серьезность содержимого результатом действия фильтрации содержимого. Да
Серьезность └️ Перечисления Уровень серьезности содержимого с меткой.
Возможные значения: safe, , lowmediumhigh		 Да
task_adherence AzureContentFilterDetectionResult Элемент результата фильтра содержимого с метками, указывающий, обнаружен ли содержимое и было ли содержимое
Фильтруется.		 Да
Обнаружена └️ Логических Обнаружена ли в содержимом категория помеченного содержимого. Да
└️ отфильтрован Логических Приведет ли обнаружение содержимого к действию фильтрации содержимого. Да
ungrounded_material AzureContentFilterCompletionTextSpanDetectionResult Нет
Насилия AzureContentFilterSeverityResult Элемент результата фильтра содержимого с метками, указывающий, было ли отфильтровано содержимое и каким качеством
Уровень серьезности содержимого был оценен по конфигурации фильтра содержимого для категории.		 Нет
└️ отфильтрован Логических Является ли серьезность содержимого результатом действия фильтрации содержимого. Да
Серьезность └️ Перечисления Уровень серьезности содержимого с меткой.
Возможные значения: safe, , lowmediumhigh		 Да

AzureContentFilterSeverityResult

Элемент результата фильтра содержимого с метками, указывающий, был ли отфильтрован контент и какой уровень серьезности содержимого был оценен по конфигурации фильтра содержимого для категории.

Имя Тип Описание Обязательно По умолчанию
Фильтруется Логических Является ли серьезность содержимого результатом действия фильтрации содержимого. Да
Тяжести Перечисления Уровень серьезности содержимого с меткой.
Возможные значения: safe, , lowmediumhigh		 Да

AzureFileExpiryAnchor

Свойство Значение
Тип Строка
Значения created_at

AzureFineTuneReinforcementMethod

Имя Тип Описание Обязательно По умолчанию
Грейдер OpenAI.GraderStringCheck или OpenAI.GraderTextSimilarity или OpenAI.GraderScoreModel или OpenAI.GraderMulti или GraderEndpoint Да
гиперпараметры OpenAI.FineTuneReinforcementHyperparameters Гиперпараметры, используемые для задания точной настройки с подкреплением. Нет
response_format ResponseFormatJSONSchemaRequest Нет
└json_schema Объекта Схема JSON для формата ответа Да
Тип └️ Перечисления Тип формата ответа
Возможные значения: json_schema		 Да

AzurePiiSubCategory

Конфигурация для отдельных piIHarmSubCategory(s) в платформе расширений вреда.

Имя Тип Описание Обязательно По умолчанию
Обнаружить Логических Включена ли функция обнаружения для этой подкатегории. Да
Фильтр Логических Следует ли блокировать содержимое, содержащее эту подкатегорию. Да
redact Логических Следует ли отредактировать содержимое, содержащее этот подкатегорий. Да
sub_category Строка Настраивается PIIHarmSubCategory. Да

AzurePiiSubCategoryResult

Сведения о результатах для отдельных PIIHarmSubCategory.

Имя Тип Описание Обязательно По умолчанию
Обнаружены Логических Обнаружена ли в содержимом подкатегория помеченного содержимого. Да
Фильтруется Логических Является ли обнаружение контента результатом действия фильтрации содержимого для этой подкатегории. Да
отредактировано Логических Редактируется ли содержимое для этой подкатегории. Да
sub_category Строка Оценка piIHarmSubCategory. Да

AzureResponsesSamplingParams

Параметры выборки для управления поведением ответов.

Имя Тип Описание Обязательно По умолчанию
max_tokens Целое число Максимальное количество маркеров в созданных выходных данных. Нет
reasoning_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.		 Нет
Семян Целое число Начальное значение инициализирует случайность во время выборки. Нет 42
Температура Номер Более высокая температура увеличивает случайность выходных данных. Нет 1
Текст OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText Нет
Инструменты массив OpenAI.Tool Нет
top_p Номер Альтернатива температуре для выборки ядра; 1.0 включает все маркеры. Нет 1

AzureUserSecurityContext

Контекст безопасности пользователя содержит несколько параметров, описывающих само приложение, и конечный пользователь, взаимодействующий с приложением. Эти поля помогают группам по операциям безопасности исследовать и устранять инциденты безопасности, предоставляя комплексный подход к защите приложений ИИ. Дополнительные сведения о защите приложений ИИ с помощью Microsoft Defender для облака.

Имя Тип Описание Обязательно По умолчанию
application_name Строка Имя приложения. Конфиденциальная личная информация не должна быть включена в это поле. Нет
end_user_id Строка Этот идентификатор — это идентификатор объекта пользователя Microsoft Entra (ранее Azure Active Directory), используемый для проверки подлинности конечных пользователей в созданном приложении ИИ. Конфиденциальная личная информация не должна быть включена в это поле. Нет
end_user_tenant_id Строка Идентификатор клиента Microsoft 365, к которому принадлежит конечный пользователь. Это необходимо, если созданное приложение искусственного интеллекта является мультитенантным. Нет
source_ip Строка Записывает IP-адрес исходного клиента. Нет

КопированиеAccountDetails

Имя Тип Описание Обязательно По умолчанию
destinationResourceId Строка Идентификатор целевого ресурса, в который была скопирована модель. Да
Регионе Строка Регион, в который была скопирована модель. Да
Статус Перечисления Состояние операции копирования.
Возможные значения: Completed, FailedInProgress		 Да

CopyModelRequest

Имя Тип Описание Обязательно По умолчанию
destinationResourceId Строка Идентификатор целевого ресурса для копирования. Да
Регионе Строка Регион, в который нужно скопировать модель. Да

CopyModelResponse

Имя Тип Описание Обязательно По умолчанию
checkpointedModelName Строка Идентификатор скопированной модели. Да
copiedAccountDetails массив CopiedAccountDetails Идентификатор целевого ресурса, в котором он был скопирован Да
fineTuningJobId Строка Идентификатор задания тонкой настройки, скопированного контрольной точкой. Да

CreateVideoBody

Имя Тип Описание Обязательно По умолчанию
Модели Строка Имя развертывания, используемого для этого запроса. Да
Строке Строка Текстовый запрос, описывающий видео для создания.
Ограничения: minLength: 1		 Да
Секунд VideoSeconds Поддерживаемые продолжительности клипа, измеряемые в секундах. Нет 4
Размер VideoSize Размеры выходных данных, отформатированные как {width}x{height}. Нет 720x1280

CreateVideoBodyWithInputReference

Свойства запроса задания создания видео с файлами мультимедиа.

Имя Тип Описание Обязательно По умолчанию
input_reference Объекта Необязательный справочник по изображениям, направляющим поколение. Да
Модели Объекта Имя развертывания, используемого для этого запроса. Да
Строке Объекта Текстовый запрос, описывающий видео для создания. Да
Секунд Объекта Длительность клипа в секундах. Значение по умолчанию — 4 секунды. Нет
Размер Объекта Разрешение выходных данных в формате ширины x высоты. По умолчанию используется значение 720x1280. Нет

CreateVideoRemixBody

Параметры для ремиксирования существующего созданного видео.

Имя Тип Описание Обязательно По умолчанию
Строке Строка Обновленный текстовый запрос, который направляет создание remix.
Ограничения: minLength: 1		 Да

DeletedVideoResource

Полезные данные подтверждения возвращаются после удаления видео.

Имя Тип Описание Обязательно По умолчанию
Удалены Логических Указывает, что ресурс видео был удален. Да Истинный
Id Строка Идентификатор удаленного видео. Да
Объекта Строка Тип объекта, который сигнализирует об ответе на удаление. Да video.deleted

Ошибка

Имя Тип Описание Обязательно По умолчанию
Код Строка Да
Сообщение Строка Да

EvalGraderEndpoint

Имя Тип Описание Обязательно По умолчанию
Заголовки объект или null Необязательные заголовки HTTP для включения в запросы к конечной точке Нет
Имя Строка Имя классировщика Да
pass_threshold число или null Необязательный пороговый показатель, выше которого оценка считается прохождением
Если не указано, все оценки считаются допустимыми		 Нет
rate_limit целое число или null Необязательный предел скорости запросов в секунду для конечной точки
Должно быть положительным целым числом		 Нет
Тип Перечисления
Возможные значения: endpoint		 Да
Url Строка URL-адрес HTTPS конечной точки для вызова оценки
Ограничения: шаблон:^https://		 Да

GraderEndpoint

Конфигурация оценки конечной точки для оценки внешней конечной точки HTTP

Имя Тип Описание Обязательно По умолчанию
Заголовки объект или null Необязательные заголовки HTTP для включения в запросы к конечной точке Нет
Имя Строка Имя классировщика Да
pass_threshold число или null Необязательный пороговый показатель, выше которого оценка считается прохождением
Если не указано, все оценки считаются допустимыми		 Нет
rate_limit целое число или null Необязательный предел скорости запросов в секунду для конечной точки
Должно быть положительным целым числом		 Нет
Тип Перечисления
Возможные значения: endpoint		 Да
Url Строка URL-адрес HTTPS конечной точки для вызова оценки
Ограничения: шаблон:^https://		 Да

OpenAI.Annotation

Заметка, которая применяется к диапазону выходного текста.

Дискриминация для OpenAI.Annotation

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа Схемы
file_citation OpenAI.FileCitationBody
url_citation OpenAI.UrlCitationBody
container_file_citation OpenAI.ContainerFileCitationBody
file_path OpenAI.FilePath
Имя Тип Описание Обязательно По умолчанию
Тип OpenAI.AnnotationType Да

OpenAI.AnnotationType

Свойство Значение
Тип Строка
Значения file_citation
url_citation
container_file_citation
file_path

OpenAI.ApplyPatchCallOutputStatus

Свойство Значение
Тип Строка
Значения completed
failed

OpenAI.ApplyPatchCallStatus

Свойство Значение
Тип Строка
Значения in_progress
completed

OpenAI.ApplyPatchCreateFileOperation

Инструкция, описывающая создание файла с помощью средства apply_patch.

Имя Тип Описание Обязательно По умолчанию
Diff Строка Дифф для применения. Да
Путь Строка Путь к создаваемому файлу. Да
Тип Перечисления Создайте файл с предоставленным диффом.
Возможные значения: create_file		 Да

OpenAI.ApplyPatchDeleteFileOperation

Инструкция, описывающая удаление файла с помощью средства apply_patch.

Имя Тип Описание Обязательно По умолчанию
Путь Строка Путь к удаленному файлу. Да
Тип Перечисления Удалите указанный файл.
Возможные значения: delete_file		 Да

OpenAI.ApplyPatchFileOperation

Одна из операций create_file, delete_file или update_file, применяемых через apply_patch.

Дискриминация для OpenAI.ApplyPatchFileOperation

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа Схемы
create_file OpenAI.ApplyPatchCreateFileOperation
delete_file OpenAI.ApplyPatchDeleteFileOperation
update_file OpenAI.ApplyPatchUpdateFileOperation
Имя Тип Описание Обязательно По умолчанию
Тип OpenAI.ApplyPatchFileOperationType Да

OpenAI.ApplyPatchFileOperationType

Свойство Значение
Тип Строка
Значения create_file
delete_file
update_file

OpenAI.ApplyPatchToolParam

Позволяет помощнику создавать, удалять или обновлять файлы с помощью унифицированных диффов.

Имя Тип Описание Обязательно По умолчанию
Тип Перечисления Тип средства. Всегда apply_patch.
Возможные значения: apply_patch		 Да

OpenAI.ApplyPatchUpdateFileOperation

Инструкция, описывающая обновление файла с помощью средства apply_patch.

Имя Тип Описание Обязательно По умолчанию
Diff Строка Дифф для применения. Да
Путь Строка Путь к файлу для обновления. Да
Тип Перечисления Обновите существующий файл с предоставленным диффом.
Возможные значения: update_file		 Да

OpenAI.ApproximateLocation

Имя Тип Описание Обязательно По умолчанию
Города строка или null Нет
Страны строка или null Нет
Регионе строка или null Нет
Timezone строка или null Нет
Тип Перечисления Тип приближения расположения. Всегда approximate.
Возможные значения: approximate		 Да

OpenAI.AssistantTool

Дискриминация для OpenAI.AssistantTool

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа Схемы
code_interpreter OpenAI.AssistantToolsCode
file_search OpenAI.AssistantToolsFileSearch
function OpenAI.AssistantToolsFunction
Имя Тип Описание Обязательно По умолчанию
Тип OpenAI.AssistantToolType Да

OpenAI.AssistantToolType

Свойство Значение
Тип Строка
Значения code_interpreter
file_search
function

OpenAI.AssistantToolsCode

Имя Тип Описание Обязательно По умолчанию
Тип Перечисления Тип определяемого средства: code_interpreter
Возможные значения: code_interpreter		 Да

OpenAI.AssistantToolsFileSearch

Имя Тип Описание Обязательно По умолчанию
file_search OpenAI.AssistantToolsFileSearchSearchSearch Нет
└️ max_num_results Целое число Ограничения: min: 1, max: 50 Нет
└️ ranking_options OpenAI.FileSearchRankingOptions Параметры ранжирования для поиска файлов. Если не указано, средство поиска файлов будет использовать auto рангер и score_threshold 0.
Дополнительные сведения см. в документации по средству поиска файлов .		 Нет
Тип Перечисления Тип определяемого средства: file_search
Возможные значения: file_search		 Да

OpenAI.AssistantToolsFileSearchSearchSearch

Имя Тип Описание Обязательно По умолчанию
max_num_results Целое число Ограничения: min: 1, max: 50 Нет
ranking_options OpenAI.FileSearchRankingOptions Параметры ранжирования для поиска файлов. Если не указано, средство поиска файлов будет использовать auto рангер и score_threshold 0.
Дополнительные сведения см. в документации по средству поиска файлов .		 Нет

OpenAI.AssistantToolsFileSearchTypeOnly

Имя Тип Описание Обязательно По умолчанию
Тип Перечисления Тип определяемого средства: file_search
Возможные значения: file_search		 Да

OpenAI.AssistantToolsFunction

Имя Тип Описание Обязательно По умолчанию
Функции OpenAI.FunctionObject Да
Тип Перечисления Тип определяемого средства: function
Возможные значения: function		 Да

OpenAI.AssistantsApiResponseFormatOption

Указывает формат, который модель должна выводить. Совместим с GPT-4o, GPT-4 Turbo и всеми моделями GPT-3.5 Turbo с тех пор gpt-3.5-turbo-1106. { "type": "json_schema", "json_schema": {...} } Чтобы включить структурированные выходные данные, которые гарантируют, что модель будет соответствовать предоставленной схеме JSON. Дополнительные сведения см. в разделе "Параметр", чтобы { "type": "json_object" } включить режим JSON, который гарантирует, что модель создает допустимое значение JSON. Важно:* при использовании режима JSON необходимо также указать модели создавать JSON самостоятельно с помощью системного или пользовательского сообщения. Без этого модель может создать неуправляемый поток пробелов до тех пор, пока поколение не достигнет предела маркера, в результате чего длительный и, казалось бы, "застрявший" запрос. Кроме того, обратите внимание, что содержимое сообщения может быть частично отрезано, если finish_reason="length", что указывает на превышение поколения max_tokens или беседа превысила максимальную длину контекста.

Тип: string или OpenAI.ResponseFormatText или OpenAI.ResponseFormatJsonObject или OpenAI.ResponseFormatJsonSchema

Указывает формат, который модель должна выводить. Совместим с GPT-4o, GPT-4 Turbo и всеми моделями GPT-3.5 Turbo с тех пор gpt-3.5-turbo-1106. { "type": "json_schema", "json_schema": {...} } Чтобы включить структурированные выходные данные, которые гарантируют, что модель будет соответствовать предоставленной схеме JSON. Дополнительные сведения см. в разделе "Параметр", чтобы { "type": "json_object" } включить режим JSON, который гарантирует, что модель создает допустимое значение JSON. Важно:* при использовании режима JSON необходимо также указать модели создавать JSON самостоятельно с помощью системного или пользовательского сообщения. Без этого модель может создать неуправляемый поток пробелов до тех пор, пока поколение не достигнет предела маркера, в результате чего длительный и, казалось бы, "застрявший" запрос. Кроме того, обратите внимание, что содержимое сообщения может быть частично отрезано, если finish_reason="length", что указывает на превышение поколения max_tokens или беседа превысила максимальную длину контекста.

OpenAI.AssistantsApiToolChoiceOption

Определяет, какое средство (если таковое) вызывается моделью. none означает, что модель не будет вызывать средства и вместо этого создает сообщение. auto — это значение по умолчанию и означает, что модель может выбирать между созданием сообщения или вызовом одного или нескольких инструментов. required означает, что модель должна вызывать один или несколько инструментов, прежде чем отвечать на запрос пользователя. Указание определенного инструмента, например {"type": "file_search"} или {"type": "function", "function": {"name": "my_function"}} принудительное вызов модели.

Тип: string или OpenAI.AssistantsNamedToolChoice

Определяет, какое средство (если таковое) вызывается моделью. none означает, что модель не будет вызывать средства и вместо этого создает сообщение. auto — это значение по умолчанию и означает, что модель может выбирать между созданием сообщения или вызовом одного или нескольких инструментов. required означает, что модель должна вызывать один или несколько инструментов, прежде чем отвечать на запрос пользователя. Указание определенного инструмента, например {"type": "file_search"} или {"type": "function", "function": {"name": "my_function"}} принудительное вызов модели.

OpenAI.AssistantsNamedToolChoice

Указывает средство, которое должна использовать модель. Используйте для принудительного вызова модели определенного средства.

Имя Тип Описание Обязательно По умолчанию
Функции OpenAI.AssistantsNamedToolChoiceFunction Нет
Тип Перечисления Тип средства. Если тип имеет тип function, необходимо задать имя функции.
Возможные значения: function, code_interpreterfile_search		 Да

OpenAI.AssistantsNamedToolChoiceFunction

Имя Тип Описание Обязательно По умолчанию
Имя Строка Да

OpenAI.AudioTranscription

Имя Тип Описание Обязательно По умолчанию
Язык Строка Язык входного звука. Предоставление языка ввода в
ФОРМАТ ISO-639-1 (например) en
повысит точность и задержку.		 Нет
Модели Строка Модель, используемая для транскрибирования. Текущие параметры: whisper-1, gpt-4o-mini-transcribe, gpt-4o-mini-transcribe-2025-12-15, gpt-4o-transcribeи gpt-4o-transcribe-diarize. Используйте, когда требуется gpt-4o-transcribe-diarize диаризация с метками говорящего. Нет
Строке Строка Необязательный текст для руководства по стилю модели или продолжения предыдущего звука
Сегмента.
Для whisper-1этого запрос — это список ключевых слов.
Для gpt-4o-transcribe моделей (за исключением), запрос — это бесплатная текстовая строка, например "ожидающие gpt-4o-transcribe-diarizeслова, связанные с технологией".		 Нет

OpenAI.AutoChunkingStrategyRequestParam

Стратегия по умолчанию. В настоящее время эта стратегия использует и max_chunk_size_tokens имеет значение 800chunk_overlap_tokens .400

Имя Тип Описание Обязательно По умолчанию
Тип Перечисления Всегда auto.
Возможные значения: auto		 Да

OpenAI.Batch

Имя Тип Описание Обязательно По умолчанию
cancelled_at Целое число Метка времени Unix (в секундах) для момента отмены пакета. Нет
cancelling_at Целое число Метка времени Unix (в секундах) для момента отмены пакета. Нет
completed_at Целое число Метка времени Unix (в секундах) для завершения пакета. Нет
completion_window Строка Интервал времени, в течение которого должен обрабатываться пакет. Да
created_at Целое число Метка времени Unix (в секундах) для момента создания пакета. Да
Конечной точки Строка Конечная точка API OpenAI, используемая пакетом. Да
error_file_id Строка Идентификатор файла, содержащего выходные данные запросов с ошибками. Нет
Ошибки OpenAI.BatchErrors Нет
expired_at Целое число Метка времени Unix (в секундах) для истечения срока действия пакета. Нет
expires_at Целое число Метка времени Unix (в секундах) для истечения срока действия пакета. Нет
failed_at Целое число Метка времени Unix (в секундах) для момента сбоя пакета. Нет
finalizing_at Целое число Метка времени Unix (в секундах) для завершения пакета. Нет
Id Строка Да
in_progress_at Целое число Метка времени Unix (в секундах) при запуске пакетной обработки. Нет
input_file_id строка или null Нет
Метаданных OpenAI.Metadata или NULL Нет
Модели Строка Идентификатор модели, используемый для обработки пакета, например gpt-5-2025-08-07. OpenAI
предлагает широкий спектр моделей с разными возможностями, производительностью
характеристики и цены. Ознакомьтесь с моделью
руководство по просмотру и сравнению доступных моделей.		 Нет
Объекта Перечисления Тип объекта, который всегда batchявляется .
Возможные значения: batch		 Да
output_file_id Строка Идентификатор файла, содержащего выходные данные успешно выполненных запросов. Нет
request_counts OpenAI.BatchRequestCounts Количество запросов для различных состояний в пакете. Нет
Статус Перечисления Текущее состояние пакета.
Возможные значения: validating, , failedin_progressfinalizingcompletedexpiredcancellingcancelled		 Да
Использования OpenAI.BatchUsage Нет
└input_tokens Целое число Да
└️ input_tokens_details OpenAI.BatchUsageInputTokensDetails Да
└output_tokens Целое число Да
└️ output_tokens_details OpenAI.BatchUsageOutputTokensDetails Да
└️ total_tokens Целое число Да

OpenAI.BatchError

Имя Тип Описание Обязательно По умолчанию
Код Строка Код ошибки, определяющий тип ошибки. Нет
Линии целое число или null Нет
Сообщение Строка Сообщение, доступное для чтения пользователем, предоставляющее дополнительные сведения об ошибке. Нет
Param строка или null Нет

OpenAI.BatchErrors

Имя Тип Описание Обязательно По умолчанию
Данных массив OpenAI.BatchError Нет
Объекта Строка Нет

OpenAI.BatchRequestCounts

Количество запросов для различных состояний в пакете.

Имя Тип Описание Обязательно По умолчанию
Завершена Целое число Количество успешно завершенных запросов. Да
Сбой при Целое число Количество запросов, которые завершились сбоем. Да
Общая Целое число Общее количество запросов в пакете. Да

OpenAI.BatchUsage

Имя Тип Описание Обязательно По умолчанию
input_tokens Целое число Да
input_tokens_details OpenAI.BatchUsageInputTokensDetails Да
output_tokens Целое число Да
output_tokens_details OpenAI.BatchUsageOutputTokensDetails Да
total_tokens Целое число Да

OpenAI.BatchUsageInputTokensDetails

Имя Тип Описание Обязательно По умолчанию
cached_tokens Целое число Да

OpenAI.BatchUsageOutputTokensDetails

Имя Тип Описание Обязательно По умолчанию
reasoning_tokens Целое число Да

OpenAI.ChatCompletionAllowedTools

Ограничивает средства, доступные для модели, предопределенным набором.

Имя Тип Описание Обязательно По умолчанию
Режим Перечисления Ограничивает средства, доступные для модели, предопределенным набором.
auto позволяет модели выбирать из разрешенных средств и создавать
Сообщение.
required требуется, чтобы модель вызывала один или несколько разрешенных средств.
Возможные значения: auto, required		 Да
Инструменты массив объекта Список определений инструментов, которые модель должна быть разрешена для вызова.
Для API завершения чата список определений инструментов может выглядеть следующим образом:
json<br> [<br> { "type": "function", "function": { "name": "get_weather" } },<br> { "type": "function", "function": { "name": "get_time" } }<br> ]<br> 		Да

OpenAI.ChatCompletionAllowedToolsChoice

Ограничивает средства, доступные для модели, предопределенным набором.

Имя Тип Описание Обязательно По умолчанию
allowed_tools OpenAI.ChatCompletionAllowedTools Ограничивает средства, доступные для модели, предопределенным набором. Да
Тип Перечисления Разрешенный тип конфигурации средства. Всегда allowed_tools.
Возможные значения: allowed_tools		 Да

OpenAI.ChatCompletionFunctionCallOption

Указание определенной функции путем {"name": "my_function"} принудительного вызова этой функции моделью.

Имя Тип Описание Обязательно По умолчанию
Имя Строка Имя вызываемой функции. Да

OpenAI.ChatCompletionFunctions

Имя Тип Описание Обязательно По умолчанию
Описание Строка Описание того, что выполняет функция, используемая моделью для выбора времени и способа вызова функции. Нет
Имя Строка Имя вызываемой функции. Должен быть a-z, A-Z, 0-9 или содержать символы подчеркивания и дефисы с максимальной длиной 64. Да
Параметры OpenAI.FunctionParameters Параметры, которые принимают функции, описаны как объект схемы JSON. Примеры см. в руководстве и справочнике по схеме JSON для документации по формату.
Опущение parameters определяет функцию с пустым списком параметров.		 Нет

OpenAI.ChatCompletionMessageCustomToolCall

Вызов пользовательского средства, созданного моделью.

Имя Тип Описание Обязательно По умолчанию
Пользовательские OpenAI.ChatCompletionMessageCustomToolCallCustom Да
Входные данные └️ Строка Да
└️ имя Строка Да
Id Строка Идентификатор вызова средства. Да
Тип Перечисления Тип средства. Всегда custom.
Возможные значения: custom		 Да

OpenAI.ChatCompletionMessageCustomToolCallCustom

Имя Тип Описание Обязательно По умолчанию
Вход Строка Да
Имя Строка Да

OpenAI.ChatCompletionMessageToolCall

Вызов средства функции, созданного моделью.

Имя Тип Описание Обязательно По умолчанию
Функции OpenAI.ChatCompletionMessageToolCallFunction Да
Аргументы └️ Строка Да
└️ имя Строка Да
Id Строка Идентификатор вызова средства. Да
Тип Перечисления Тип средства. В настоящее время поддерживается только function .
Возможные значения: function		 Да

OpenAI.ChatCompletionMessageToolCallChunk

Имя Тип Описание Обязательно По умолчанию
Функции OpenAI.ChatCompletionMessageToolCallChunkFunction Нет
Id Строка Идентификатор вызова средства. Нет
Индекс Целое число Да
Тип Перечисления Тип средства. В настоящее время поддерживается только function .
Возможные значения: function		 Нет

OpenAI.ChatCompletionMessageToolCallChunkFunction

Имя Тип Описание Обязательно По умолчанию
Аргументы Строка Нет
Имя Строка Нет

OpenAI.ChatCompletionMessageToolCallFunction

Имя Тип Описание Обязательно По умолчанию
Аргументы Строка Да
Имя Строка Да

OpenAI.ChatCompletionMessageToolCalls

Вызовы средства, созданные моделью, например вызовы функций.

OpenAI.ChatCompletionMessageToolCallsItem

Вызовы средства, созданные моделью, например вызовы функций.

OpenAI.ChatCompletionNamedToolChoice

Указывает средство, которое должна использовать модель. Используется для принудительного вызова определенной функции.

Имя Тип Описание Обязательно По умолчанию
Функции OpenAI.ChatCompletionNamedToolChoiceFunction Да
Тип Перечисления Для вызова функции всегда используется functionтип.
Возможные значения: function		 Да

OpenAI.ChatCompletionNamedToolChoiceCustom

Указывает средство, которое должна использовать модель. Используйте для принудительного вызова модели определенного пользовательского инструмента.

Имя Тип Описание Обязательно По умолчанию
Пользовательские OpenAI.ChatCompletionNamedToolChoiceCustomCustomCustom Да
Тип Перечисления Для вызова пользовательского инструмента всегда используется customтип.
Возможные значения: custom		 Да

OpenAI.ChatCompletionNamedToolChoiceCustomCustomCustom

Имя Тип Описание Обязательно По умолчанию
Имя Строка Да

OpenAI.ChatCompletionNamedToolChoiceFunction

Имя Тип Описание Обязательно По умолчанию
Имя Строка Да

OpenAI.ChatCompletionRequestAssistantMessage

Сообщения, отправленные моделью в ответ на сообщения пользователя.

Имя Тип Описание Обязательно По умолчанию
Аудио OpenAI.ChatCompletionRequestAssistantMessageAudio или null Данные о предыдущем звуковом ответе модели. Нет
Содержимого строка или массив OpenAI.ChatCompletionRequestAssistantMessageContentPart или null Нет
function_call OpenAI.ChatCompletionRequestAssistantMessageFunctionCall или null Нет
Имя Строка Необязательное имя участника. Предоставляет сведения о модели, чтобы различать участников одной роли. Нет
Отказ строка или null Нет
Роль Перечисления Роль автора сообщений в данном случае assistant.
Возможные значения: assistant		 Да
tool_calls OpenAI.ChatCompletionMessageToolCalls Вызовы средства, созданные моделью, например вызовы функций. Нет

OpenAI.ChatCompletionRequestAssistantMessageAudio

Имя Тип Описание Обязательно По умолчанию
Id Строка Да

OpenAI.ChatCompletionRequestAssistantMessageContentPart

Дискриминация для OpenAI.ChatCompletionRequestAssistantMessageContentPart

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа Схемы
refusal OpenAI.ChatCompletionRequestMessageContentPartRefusal
text OpenAI.ChatCompletionRequestAssistantMessageContentPartChatCompletionRequestMessageContentPartText
Имя Тип Описание Обязательно По умолчанию
Тип OpenAI.ChatCompletionRequestAssistantMessageContentPartType Да

OpenAI.ChatCompletionRequestAssistantMessageContentPartChatCompletionRequestMessageContentPartText

Узнайте о входных данных текста.

Имя Тип Описание Обязательно По умолчанию
Текст Строка Текстовое содержимое. Да
Тип Перечисления Тип части содержимого.
Возможные значения: text		 Да

OpenAI.ChatCompletionRequestAssistantMessageContentPartType

Свойство Значение
Тип Строка
Значения text
refusal

OpenAI.ChatCompletionRequestAssistantMessageFunctionCall

Имя Тип Описание Обязательно По умолчанию
Аргументы Строка Да
Имя Строка Да

OpenAI.ChatCompletionRequestDeveloperMessage

Предоставленные разработчиком инструкции по выполнению модели независимо от сообщений, отправляемых пользователем. При использовании моделей o1 и более поздних developer версий сообщения заменяют предыдущие system сообщения.

Имя Тип Описание Обязательно По умолчанию
Содержимого строка или массив OpenAI.ChatCompletionRequestMessageContentPartText Содержимое сообщения разработчика. Да
Имя Строка Необязательное имя участника. Предоставляет сведения о модели, чтобы различать участников одной роли. Нет
Роль Перечисления Роль автора сообщений в данном случае developer.
Возможные значения: developer		 Да

OpenAI.ChatCompletionRequestFunctionMessage

Имя Тип Описание Обязательно По умолчанию
Содержимого строка или null Да
Имя Строка Имя вызываемой функции. Да
Роль Перечисления Роль автора сообщений в данном случае function.
Возможные значения: function		 Да

OpenAI.ChatCompletionRequestMessage

Дискриминация для OpenAI.ChatCompletionRequestMessage

Этот компонент использует свойство role для дискриминации между различными типами:

Значение типа Схемы
assistant OpenAI.ChatCompletionRequestAssistantMessage
developer OpenAI.ChatCompletionRequestDeveloperMessage
function OpenAI.ChatCompletionRequestFunctionMessage
system OpenAI.ChatCompletionRequestSystemMessage
user OpenAI.ChatCompletionRequestUserMessage
tool OpenAI.ChatCompletionRequestToolMessage
Имя Тип Описание Обязательно По умолчанию
Роль OpenAI.ChatCompletionRequestMessageType Да

OpenAI.ChatCompletionRequestMessageContentPartAudio

Имя Тип Описание Обязательно По умолчанию
input_audio OpenAI.ChatCompletionRequestMessageContentPartAudioInputAudioAudio Да
Тип Перечисления Тип части содержимого. Всегда input_audio.
Возможные значения: input_audio		 Да

OpenAI.ChatCompletionRequestMessageContentPartAudioInputAudioAudio

Имя Тип Описание Обязательно По умолчанию
Данных Строка Да
Формат Перечисления
Возможные значения: wav, mp3		 Да

OpenAI.ChatCompletionRequestMessageContentPartFile

Узнайте о входных данных файлов для создания текста.

Имя Тип Описание Обязательно По умолчанию
Файл OpenAI.ChatCompletionRequestMessageContentPartFileFile Да
└file_data Строка Нет
└file_id Строка Нет
└️ имя файла Строка Нет
Тип Перечисления Тип части содержимого. Всегда file.
Возможные значения: file		 Да

OpenAI.ChatCompletionRequestMessageContentPartFileFile

Имя Тип Описание Обязательно По умолчанию
file_data Строка Нет
file_id Строка Нет
Имени файла Строка Нет

OpenAI.ChatCompletionRequestMessageContentPartImage

Имя Тип Описание Обязательно По умолчанию
image_url OpenAI.ChatCompletionRequestMessageContentPartImageImageUrl Да
Тип Перечисления Тип части содержимого.
Возможные значения: image_url		 Да

OpenAI.ChatCompletionRequestMessageContentPartImageImageUrl

Имя Тип Описание Обязательно По умолчанию
Детали Перечисления
Возможные значения: auto, lowhigh		 Нет
Url Строка Да

OpenAI.ChatCompletionRequestMessageContentPartRefusal

Имя Тип Описание Обязательно По умолчанию
Отказ Строка Сообщение об отказе, созданное моделью. Да
Тип Перечисления Тип части содержимого.
Возможные значения: refusal		 Да

OpenAI.ChatCompletionRequestMessageContentPartText

Имя Тип Описание Обязательно По умолчанию
Текст Строка Текстовое содержимое. Да
Тип Перечисления Тип части содержимого.
Возможные значения: text		 Да

OpenAI.ChatCompletionRequestMessageType

Свойство Значение
Тип Строка
Значения developer
system
user
assistant
tool
function

OpenAI.ChatCompletionRequestSystemMessage

Предоставленные разработчиком инструкции по выполнению модели независимо от сообщений, отправляемых пользователем. Вместо этого используйте developer сообщения для этой цели с помощью моделей o1 и более новых версий.

Имя Тип Описание Обязательно По умолчанию
Содержимого строка или массив OpenAI.ChatCompletionRequestSystemMessageContentPart Содержимое системного сообщения. Да
Имя Строка Необязательное имя участника. Предоставляет сведения о модели, чтобы различать участников одной роли. Нет
Роль Перечисления Роль автора сообщений в данном случае system.
Возможные значения: system		 Да

OpenAI.ChatCompletionRequestSystemMessageContentPart

Ссылки: OpenAI.ChatCompletionRequestMessageContentPartText

OpenAI.ChatCompletionRequestToolMessage

Имя Тип Описание Обязательно По умолчанию
Содержимого строка или массив OpenAI.ChatCompletionRequestToolMessageContentPart Содержимое сообщения средства. Да
Роль Перечисления Роль автора сообщений в данном случае tool.
Возможные значения: tool		 Да
tool_call_id Строка Вызов средства, на который отвечает это сообщение. Да

OpenAI.ChatCompletionRequestToolMessageContentPart

Ссылки: OpenAI.ChatCompletionRequestMessageContentPartText

OpenAI.ChatCompletionRequestUserMessage

Сообщения, отправленные конечным пользователем, содержащие запросы или дополнительные сведения о контексте.

Имя Тип Описание Обязательно По умолчанию
Содержимого строка или массив OpenAI.ChatCompletionRequestUserMessageContentPart Содержимое сообщения пользователя. Да
Имя Строка Необязательное имя участника. Предоставляет сведения о модели, чтобы различать участников одной роли. Нет
Роль Перечисления Роль автора сообщений в данном случае user.
Возможные значения: user		 Да

OpenAI.ChatCompletionRequestUserMessageContentPart

Дискриминация для OpenAI.ChatCompletionRequestUserMessageContentPart

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа Схемы
image_url OpenAI.ChatCompletionRequestMessageContentPartImage
input_audio OpenAI.ChatCompletionRequestMessageContentPartAudio
file OpenAI.ChatCompletionRequestMessageContentPartFile
text OpenAI.ChatCompletionRequestUserMessageContentPartChatCompletionRequestMessageContentPartText
Имя Тип Описание Обязательно По умолчанию
Тип OpenAI.ChatCompletionRequestUserMessageContentPartType Да

OpenAI.ChatCompletionRequestUserMessageContentPartChatCompletionRequestMessageContentPartText

Узнайте о входных данных текста.

Имя Тип Описание Обязательно По умолчанию
Текст Строка Текстовое содержимое. Да
Тип Перечисления Тип части содержимого.
Возможные значения: text		 Да

OpenAI.ChatCompletionRequestUserMessageContentPartType

Свойство Значение
Тип Строка
Значения text
image_url
input_audio
file

OpenAI.ChatCompletionResponseMessage

Если запрашивается модальность вывода звука, этот объект содержит данные о звуковом ответе модели.

Имя Тип Описание Обязательно По умолчанию
Аннотации массив OpenAI.ChatCompletionResponseMessageAnnotations Заметки для сообщения, если это применимо, как при использовании
Средство поиска в Интернете.		 Нет
Аудио OpenAI.ChatCompletionResponseMessageAudio или null Нет
Содержимого строка или null Да
function_call OpenAI.ChatCompletionResponseMessageFunctionCall Нет
Аргументы └️ Строка Да
└️ имя Строка Да
reasoning_content Строка Свойство расширения Azure, содержащее созданное содержимое причин из поддерживаемых моделей. Нет
Отказ строка или null Да
Роль Перечисления Роль автора этого сообщения.
Возможные значения: assistant		 Да
tool_calls OpenAI.ChatCompletionMessageToolCallsItem Вызовы средства, созданные моделью, например вызовы функций. Нет

OpenAI.ChatCompletionResponseMessageAnnotations

Имя Тип Описание Обязательно По умолчанию
Тип Перечисления
Возможные значения: url_citation		 Да
url_citation OpenAI.ChatCompletionResponseMessageAnnotationsUrlCitation Да

OpenAI.ChatCompletionResponseMessageAnnotationsUrlCitation

Имя Тип Описание Обязательно По умолчанию
end_index Целое число Да
start_index Целое число Да
Название Строка Да
Url Строка Да

OpenAI.ChatCompletionResponseMessageAudio

Имя Тип Описание Обязательно По умолчанию
Данных Строка Да
expires_at Целое число Да
Id Строка Да
Стенограмма Строка Да

OpenAI.ChatCompletionResponseMessageFunctionCall

Имя Тип Описание Обязательно По умолчанию
Аргументы Строка Да
Имя Строка Да

OpenAI.ChatCompletionStreamOptions

Параметры потокового ответа. Этот параметр устанавливается только при установке stream: true.

Имя Тип Описание Обязательно По умолчанию
include_obfuscation Логических Если задано значение true, будет включена обфускация потока. Добавляется скрытие потока
случайные символы в поле потоковой передачи obfuscation событий разностных событий в
нормализованные размеры полезных данных в качестве устранения определенных атак на стороне канала.
Эти поля маскировки включены по умолчанию, но добавьте небольшое количество.
затраты на поток данных. Можно задать include_obfuscation значение
False для оптимизации пропускной способности, если вы доверяете сетевым каналам между
приложение и API OpenAI.		 Нет
include_usage Логических Если задано, до этого будет передаваться дополнительный блок. data: [DONE]
Сообщение. Поле на этом блоке usage отображает статистику использования маркеров
для всего запроса, и choices поле всегда будет пустым
Массива.
Все остальные блоки также будут включать usage поле, но с значением NULL
Значение. ПРИМЕЧАНИЕ: Если поток прерван, возможно, вы не получите
окончательный блок использования, содержащий общее использование маркеров для запроса.		 Нет

OpenAI.ChatCompletionStreamResponseDelta

Разностное завершение чата, созданное потоковой передачей ответов модели.

Имя Тип Описание Обязательно По умолчанию
Содержимого строка или null Нет
function_call OpenAI.ChatCompletionStreamResponseDeltaFunctionCall Нет
Аргументы └️ Строка Нет
└️ имя Строка Нет
reasoning_content Строка Свойство расширения Azure, содержащее созданное содержимое причин из поддерживаемых моделей. Нет
Отказ строка или null Нет
Роль Перечисления Роль автора этого сообщения.
Возможные значения: developer, , systemuserassistanttool		 Нет
tool_calls массив OpenAI.ChatCompletionMessageToolCallChunk Нет

OpenAI.ChatCompletionStreamResponseDeltaFunctionCall

Имя Тип Описание Обязательно По умолчанию
Аргументы Строка Нет
Имя Строка Нет

OpenAI.ChatCompletionTokenLogprob

Имя Тип Описание Обязательно По умолчанию
Байт массив целочисленных или null Да
logprob Номер Вероятность этого маркера журнала, если она находится в пределах 20 наиболее вероятных маркеров. В противном случае значение -9999.0 используется для обозначения того, что маркер очень маловероятно. Да
Маркер Строка Маркер. Да
top_logprobs массив OpenAI.ChatCompletionTokenLogprobTopLogprobTopLogprobs Список наиболее вероятных маркеров и их вероятности журналов в этой позиции маркера. В редких случаях количество запрошенных top_logprobs возвращаемых данных может быть меньше. Да

OpenAI.ChatCompletionTokenLogprobTopLogprobs

Имя Тип Описание Обязательно По умолчанию
Байт массив целочисленных или null Да
logprob Номер Да
Маркер Строка Да

OpenAI.ChatCompletionTool

Средство функции, которое можно использовать для создания ответа.

Имя Тип Описание Обязательно По умолчанию
Функции OpenAI.FunctionObject Да
Тип Перечисления Тип средства. В настоящее время поддерживается только function .
Возможные значения: function		 Да

OpenAI.ChatCompletionToolChoiceOption

Определяет, какое средство (если таковое) вызывается моделью. none означает, что модель не будет вызывать какое-либо средство и вместо этого создает сообщение. auto означает, что модель может выбирать между созданием сообщения или вызовом одного или нескольких инструментов. required означает, что модель должна вызывать один или несколько инструментов. Указание определенного средства с помощью {"type": "function", "function": {"name": "my_function"}} принудительного вызова этого средства моделью. none значение по умолчанию, если средства отсутствуют. auto значение по умолчанию, если существуют средства.

Тип: string или OpenAI.ChatCompletionAllowedToolsChoice или OpenAI.ChatCompletionNamedToolChoice или OpenAI.ChatCompletionNamedToolChoiceCustom

Определяет, какое средство (если таковое) вызывается моделью. none означает, что модель не будет вызывать какое-либо средство и вместо этого создает сообщение. auto означает, что модель может выбирать между созданием сообщения или вызовом одного или нескольких инструментов. required означает, что модель должна вызывать один или несколько инструментов. Указание определенного средства с помощью {"type": "function", "function": {"name": "my_function"}} принудительного вызова этого средства моделью. none значение по умолчанию, если средства отсутствуют. auto значение по умолчанию, если существуют средства.

OpenAI.ChunkingStrategyRequestParam

Стратегия блокирования, используемая для блокирования файлов. Если этот параметр не задан, используйте стратегию auto . Применимо только в том случае, если file_ids он не пуст.

Дискриминация для OpenAI.ChunkingStrategyRequestParam

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа Схемы
auto OpenAI.AutoChunkingStrategyRequestParam
static OpenAI.StaticChunkingStrategyRequestParam
Имя Тип Описание Обязательно По умолчанию
Тип OpenAI.ChunkingStrategyRequestParamType Да

OpenAI.ChunkingStrategyRequestParamType

Свойство Значение
Тип Строка
Значения auto
static

OpenAI.ChunkingStrategyResponse

Стратегия, используемая для фрагментации файла.

Дискриминация для OpenAI.ChunkingStrategyResponse

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа Схемы
static OpenAI.StaticChunkingStrategyResponseParam
other OpenAI.OtherChunkingStrategyResponseParam
Имя Тип Описание Обязательно По умолчанию
Тип OpenAI.ChunkingStrategyResponseType Да

OpenAI.ChunkingStrategyResponseType

Свойство Значение
Тип Строка
Значения static
other

OpenAI.ClickButtonType

Свойство Значение
Тип Строка
Значения left
right
wheel
back
forward

OpenAI.ClickParam

Действие щелчка.

Имя Тип Описание Обязательно По умолчанию
Кнопку OpenAI.ClickButtonType Да
Тип Перечисления Указывает тип события. Для действия щелчка это свойство всегда click.
Возможные значения: click		 Да
X Целое число Координата x, в которой произошло нажатие. Да
Y Целое число Координата y, в которой произошло нажатие. Да

OpenAI.CodeInterpreterContainerAuto

Настройка контейнера интерпретатора кода. При необходимости укажите идентификаторы файлов для запуска кода.

Имя Тип Описание Обязательно По умолчанию
file_ids массив строк Необязательный список отправленных файлов для доступа к коду. Нет
memory_limit OpenAI.ContainerMemoryLimit или null Нет
Тип Перечисления Всегда auto.
Возможные значения: auto		 Да

OpenAI.CodeInterpreterOutputImage

Выходные данные изображения интерпретатора кода.

Имя Тип Описание Обязательно По умолчанию
Тип Перечисления Тип выходных данных. Всегда image.
Возможные значения: image		 Да
Url Строка URL-адрес выходных данных изображения из интерпретатора кода. Да

OpenAI.CodeInterpreterOutputLogs

Журналы, выходные данные интерпретатора кода.

Имя Тип Описание Обязательно По умолчанию
Журналы Строка Журналы, выходные данные интерпретатора кода. Да
Тип Перечисления Тип выходных данных. Всегда logs.
Возможные значения: logs		 Да

OpenAI.CodeInterpreterTool

Средство, которое запускает код Python для создания ответа на запрос.

Имя Тип Описание Обязательно По умолчанию
Контейнер string или OpenAI.CodeInterpreterContainerAuto Контейнер интерпретатора кода. Может быть идентификатором контейнера или объектом, который
указывает идентификаторы отправленных файлов, чтобы предоставить доступ к коду, а также
необязательный memory_limit параметр.		 Да
Тип Перечисления Тип средства интерпретатора кода. Всегда code_interpreter.
Возможные значения: code_interpreter		 Да

OpenAI.ComparisonFilter

Фильтр, используемый для сравнения указанного ключа атрибута с заданным значением с помощью определенной операции сравнения.

Имя Тип Описание Обязательно По умолчанию
Ключ Строка Ключ для сравнения со значением. Да
Тип Перечисления Указывает оператор сравнения: eq, negt, gte, lt, , lte, in. nin
- eq:Равно
- ne: не равно
- gt:Больше
- gte: больше или равно
- lt:Менее
- lte: меньше или равно
- in:В
- nin: не в
Возможные значения: eq, , negtgte, ltlte		 Да
Значение строка или число или логическое значение или массив OpenAI.ComparisonFilterValueItems Значение для сравнения с ключом атрибута; поддерживает типы строк, чисел или логических типов. Да

OpenAI.ComparisonFilterValueItems

Эта схема принимает один из следующих типов:

  • Строка
  • Номер

OpenAI.CompletionUsage

Статистика использования для запроса завершения.

Имя Тип Описание Обязательно По умолчанию
completion_tokens Целое число Количество маркеров в созданном завершении. Да
completion_tokens_details OpenAI.CompletionUsageCompletionTokensDetails Нет
└️ accepted_prediction_tokens Целое число Нет
└audio_tokens Целое число Нет
└️ reasoning_tokens Целое число Нет
└rejected_prediction_tokens Целое число Нет
prompt_tokens Целое число Количество маркеров в запросе. Да
prompt_tokens_details OpenAI.CompletionUsagePromptTokensDetails Нет
└audio_tokens Целое число Нет
└️ cached_tokens Целое число Нет
total_tokens Целое число Общее количество маркеров, используемых в запросе (запрос + завершение). Да

OpenAI.CompletionUsageCompletionTokensDetails

Имя Тип Описание Обязательно По умолчанию
accepted_prediction_tokens Целое число Нет
audio_tokens Целое число Нет
reasoning_tokens Целое число Нет
rejected_prediction_tokens Целое число Нет

OpenAI.CompletionUsagePromptTokensDetails

Имя Тип Описание Обязательно По умолчанию
audio_tokens Целое число Нет
cached_tokens Целое число Нет

OpenAI.CompoundFilter

Объединение нескольких фильтров с помощью and или or.

Имя Тип Описание Обязательно По умолчанию
Фильтры массив OpenAI.ComparisonFilter или object Массив фильтров для объединения. Элементы могут быть ComparisonFilter или CompoundFilter. Да
Тип Перечисления Тип операции: and или or.
Возможные значения: and, or		 Да

OpenAI.ComputerAction

Дискриминация для OpenAI.ComputerAction

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа Схемы
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
Имя Тип Описание Обязательно По умолчанию
Тип OpenAI.ComputerActionType Да

OpenAI.ComputerActionType

Свойство Значение
Тип Строка
Значения click
double_click
drag
keypress
move
screenshot
scroll
type
wait

OpenAI.ComputerCallSafetyCheckParam

Ожидающая проверка безопасности для вызова компьютера.

Имя Тип Описание Обязательно По умолчанию
Код строка или null Нет
Id Строка Идентификатор ожидающей проверки безопасности. Да
Сообщение строка или null Нет

OpenAI.ComputerEnvironment

Свойство Значение
Тип Строка
Значения windows
mac
linux
ubuntu
browser

OpenAI.ComputerScreenshotContent

Снимок экрана: компьютер.

Имя Тип Описание Обязательно По умолчанию
file_id строка или null Да
image_url строка или null Да
Тип Перечисления Указывает тип события. Для снимка экрана компьютера это свойство всегда имеет значение computer_screenshot.
Возможные значения: computer_screenshot		 Да

OpenAI.ComputerScreenshotImage

Снимок экрана компьютера, используемый с помощью средства использования компьютера.

Имя Тип Описание Обязательно По умолчанию
file_id Строка Идентификатор отправленного файла, содержащего снимок экрана. Нет
image_url Строка URL-адрес изображения снимка экрана. Нет
Тип Перечисления Указывает тип события. Снимок экрана компьютера: это свойство
всегда задано значение computer_screenshot.
Возможные значения: computer_screenshot		 Да

OpenAI.ComputerUsePreviewTool

Средство управления виртуальным компьютером.

Имя Тип Описание Обязательно По умолчанию
display_height Целое число Высота дисплея компьютера. Да
display_width Целое число Ширина дисплея компьютера. Да
Среды OpenAI.ComputerEnvironment Да
Тип Перечисления Тип средства использования компьютера. Всегда computer_use_preview.
Возможные значения: computer_use_preview		 Да

OpenAI.ContainerFileCitationBody

Ссылка на файл контейнера, используемый для создания ответа модели.

Имя Тип Описание Обязательно По умолчанию
container_id Строка Идентификатор файла контейнера. Да
end_index Целое число Индекс последнего символа ссылки на файл контейнера в сообщении. Да
file_id Строка Идентификатор файла. Да
Имени файла Строка Имя файла контейнера. Да
start_index Целое число Индекс первого символа ссылки на файл контейнера в сообщении. Да
Тип Перечисления Тип ссылки на файл контейнера. Всегда container_file_citation.
Возможные значения: container_file_citation		 Да

OpenAI.ContainerFileListResource

Имя Тип Описание Обязательно По умолчанию
Данных массив OpenAI.ContainerFileResource Список файлов контейнеров. Да
first_id Строка Идентификатор первого файла в списке. Да
has_more Логических Доступны ли дополнительные файлы. Да
last_id Строка Идентификатор последнего файла в списке. Да
Объекта Перечисления Тип возвращаемого объекта должен быть "list".
Возможные значения: list		 Да

OpenAI.ContainerFileResource

Имя Тип Описание Обязательно По умолчанию
Байт Целое число Размер файла в байтах. Да
container_id Строка Контейнер, к которому принадлежит этот файл. Да
created_at Целое число Метка времени Unix (в секундах) при создании файла. Да
Id Строка Уникальный идентификатор файла. Да
Объекта Перечисления Тип этого объекта (container.file).
Возможные значения: container.file		 Да
Путь Строка Путь к файлу в контейнере. Да
Источник Строка Источник файла (например, user, assistant). Да

OpenAI.ContainerListResource

Имя Тип Описание Обязательно По умолчанию
Данных массив OpenAI.ContainerResource Список контейнеров. Да
first_id Строка Идентификатор первого контейнера в списке. Да
has_more Логических Доступно ли больше контейнеров. Да
last_id Строка Идентификатор последнего контейнера в списке. Да
Объекта Перечисления Тип возвращаемого объекта должен быть "list".
Возможные значения: list		 Да

OpenAI.ContainerMemoryLimit

Свойство Значение
Тип Строка
Значения 1g
4g
16g
64g

OpenAI.ContainerResource

Имя Тип Описание Обязательно По умолчанию
created_at Целое число Метка времени Unix (в секундах) при создании контейнера. Да
expires_after OpenAI.ContainerResourceExpiresAfter Нет
Привязка └️ Перечисления
Возможные значения: last_active_at		 Нет
└️ минуты Целое число Нет
Id Строка Уникальный идентификатор контейнера. Да
last_active_at Целое число Метка времени Unix (в секундах), когда контейнер был последним активным. Нет
memory_limit Перечисления Ограничение памяти, настроенное для контейнера.
Возможные значения: 1g, , 4g16g64g		 Нет
Имя Строка Имя контейнера. Да
Объекта Строка Тип этого объекта. Да
Статус Строка Состояние контейнера (например, активное, удаленное). Да

OpenAI.ContainerResourceExpiresAfter

Имя Тип Описание Обязательно По умолчанию
Якорь Перечисления
Возможные значения: last_active_at		 Нет
Минут Целое число Нет

OpenAI.ConversationItem

Один элемент в беседе. Набор возможных типов совпадает с output типом объекта Response.

Дискриминация для OpenAI.ConversationItem

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа Схемы
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
Имя Тип Описание Обязательно По умолчанию
Тип OpenAI.ConversationItemType Да

OpenAI.ConversationItemApplyPatchToolCall

Вызов средства, который применяет диффы файлов, создавая, удаляя или обновляя файлы.

Имя Тип Описание Обязательно По умолчанию
call_id Строка Уникальный идентификатор вызова средства исправления, созданного моделью. Да
created_by Строка Идентификатор сущности, созданной этим средством. Нет
Id Строка Уникальный идентификатор вызова средства исправления. Заполняется, когда этот элемент возвращается через API. Да
Операции OpenAI.ApplyPatchFileOperation Одна из операций create_file, delete_file или update_file, применяемых через apply_patch. Да
Тип └️ OpenAI.ApplyPatchFileOperationType Да
Статус OpenAI.ApplyPatchCallStatus Да
Тип Перечисления Тип элемента. Всегда apply_patch_call.
Возможные значения: apply_patch_call		 Да

OpenAI.ConversationItemApplyPatchToolCallOutput

Выходные данные, создаваемые вызовом средства исправления.

Имя Тип Описание Обязательно По умолчанию
call_id Строка Уникальный идентификатор вызова средства исправления, созданного моделью. Да
created_by Строка Идентификатор сущности, создающей выходные данные вызова этого средства. Нет
Id Строка Уникальный идентификатор выходных данных вызова средства исправления. Заполняется, когда этот элемент возвращается через API. Да
Выход строка или null Нет
Статус OpenAI.ApplyPatchCallOutputStatus Да
Тип Перечисления Тип элемента. Всегда apply_patch_call_output.
Возможные значения: apply_patch_call_output		 Да

OpenAI.ConversationItemCodeInterpreterToolCall

Вызов средства для выполнения кода.

Имя Тип Описание Обязательно По умолчанию
Код строка или null Да
container_id Строка Идентификатор контейнера, используемого для запуска кода. Да
Id Строка Уникальный идентификатор вызова средства интерпретатора кода. Да
Выходы массив OpenAI.CodeInterpreterOutputLogs или OpenAI.CodeInterpreterOutputImage или null Да
Статус Перечисления Состояние вызова средства интерпретатора кода. Допустимые значения: in_progress, , completedincomplete, interpretingи failed.
Возможные значения: in_progress, , completedincompleteinterpretingfailed		 Да
Тип Перечисления Тип вызова средства интерпретатора кода. Всегда code_interpreter_call.
Возможные значения: code_interpreter_call		 Да

OpenAI.ConversationItemComputerToolCall

Вызов средства для использования компьютера. Дополнительные сведения см. в руководстве по использованию компьютера .

Имя Тип Описание Обязательно По умолчанию
Действий OpenAI.ComputerAction Да
call_id Строка Идентификатор, используемый при реагировании на вызов средства с выходными данными. Да
Id Строка Уникальный идентификатор вызова компьютера. Да
pending_safety_checks массив OpenAI.ComputerCallSafetyCheckParam Ожидающие проверки безопасности для вызова компьютера. Да
Статус Перечисления Состояние элемента. Один из in_progress, completedили
incomplete. Заполняется, когда элементы возвращаются через API.
Возможные значения: in_progress, completedincomplete		 Да
Тип Перечисления Тип вызова компьютера. Всегда computer_call.
Возможные значения: computer_call		 Да

OpenAI.ConversationItemComputerToolCallOutputResource

Имя Тип Описание Обязательно По умолчанию
acknowledged_safety_checks массив OpenAI.ComputerCallSafetyCheckParam Проверки безопасности, сообщаемые API, которые были подтверждены
Разработчик.		 Нет
call_id Строка Идентификатор вызова средства компьютера, создающего выходные данные. Да
Id Строка Идентификатор выходных данных вызова средства компьютера. Нет
Выход OpenAI.ComputerScreenshotImage Снимок экрана компьютера, используемый с помощью средства использования компьютера. Да
Статус Перечисления Состояние входных данных сообщения. Один из in_progress, completedили
incomplete. Заполняется при возврате входных элементов через API.
Возможные значения: in_progress, completedincomplete		 Нет
Тип Перечисления Тип выходных данных вызова средства компьютера. Всегда computer_call_output.
Возможные значения: computer_call_output		 Да

OpenAI.ConversationItemCustomToolCall

Вызов пользовательского средства, созданного моделью.

Имя Тип Описание Обязательно По умолчанию
call_id Строка Идентификатор, используемый для сопоставления этого настраиваемого вызова средства с выходными данными вызова средства. Да
Id Строка Уникальный идентификатор вызова пользовательского средства на платформе OpenAI. Нет
Вход Строка Входные данные для вызова пользовательского средства, созданного моделью. Да
Имя Строка Имя вызываемого пользовательского средства. Да
Тип Перечисления Тип вызова пользовательского средства. Всегда custom_tool_call.
Возможные значения: custom_tool_call		 Да

OpenAI.ConversationItemCustomToolCallOutput

Выходные данные вызова пользовательского средства из кода, отправляемые обратно в модель.

Имя Тип Описание Обязательно По умолчанию
call_id Строка Идентификатор вызова, используемый для сопоставления выходных данных этого пользовательского средства с пользовательским вызовом средства. Да
Id Строка Уникальный идентификатор выходных данных вызова пользовательского средства на платформе OpenAI. Нет
Выход строка или массив OpenAI.FunctionAndCustomToolCallOutput Выходные данные из вызова пользовательского средства, созданного кодом.
Может быть строкой или списком выходного содержимого.		 Да
Тип Перечисления Тип выходных данных вызова пользовательского средства. Всегда custom_tool_call_output.
Возможные значения: custom_tool_call_output		 Да

OpenAI.ConversationItemFileSearchToolCall

Результаты вызова средства поиска файлов. Дополнительные сведения см. в руководстве по поиску файлов .

Имя Тип Описание Обязательно По умолчанию
Id Строка Уникальный идентификатор вызова средства поиска файлов. Да
Запросов массив строк Запросы, используемые для поиска файлов. Да
Результаты массив OpenAI.FileSearchToolCallResults или null Нет
Статус Перечисления Состояние вызова средства поиска файлов. Один из in_progress,
searching, incomplete или failed,
Возможные значения: in_progress, , searchingcompletedincompletefailed		 Да
Тип Перечисления Тип вызова средства поиска файлов. Всегда file_search_call.
Возможные значения: file_search_call		 Да

OpenAI.ConversationItemFunctionShellCall

Вызов средства, выполняющий одну или несколько команд оболочки в управляемой среде.

Имя Тип Описание Обязательно По умолчанию
Действий OpenAI.FunctionShellAction Выполните команду оболочки. Да
Команды └️ массив строк Да
└max_output_length целое число или null Да
└️ timeout_ms целое число или null Да
call_id Строка Уникальный идентификатор вызова средства оболочки, созданного моделью. Да
created_by Строка Идентификатор сущности, созданной этим средством. Нет
Id Строка Уникальный идентификатор вызова средства оболочки. Заполняется, когда этот элемент возвращается через API. Да
Статус OpenAI.LocalShellCallStatus Да
Тип Перечисления Тип элемента. Всегда shell_call.
Возможные значения: shell_call		 Да

OpenAI.ConversationItemFunctionShellCallOutput

Выходные данные вызова средства оболочки, который был создан.

Имя Тип Описание Обязательно По умолчанию
call_id Строка Уникальный идентификатор вызова средства оболочки, созданного моделью. Да
created_by Строка Идентификатор субъекта, создавшего элемент. Нет
Id Строка Уникальный идентификатор выходных данных вызова оболочки. Заполняется, когда этот элемент возвращается через API. Да
max_output_length целое число или null Да
Выход массив OpenAI.FunctionShellCallOutputContent Массив содержимого вывода вызова оболочки Да
Тип Перечисления Тип выходных данных вызова оболочки. Всегда shell_call_output.
Возможные значения: shell_call_output		 Да

OpenAI.ConversationItemFunctionToolCallOutputResource

Имя Тип Описание Обязательно По умолчанию
call_id Строка Уникальный идентификатор вызова средства функции, созданного моделью. Да
Id Строка Уникальный идентификатор выходных данных вызова средства функции. Заполнено, когда этот элемент
возвращается через API.		 Нет
Выход строка или массив OpenAI.FunctionAndCustomToolCallOutput Выходные данные вызова функции, созданного кодом.
Может быть строкой или списком выходного содержимого.		 Да
Статус Перечисления Состояние элемента. Один из in_progress, completedили
incomplete. Заполняется, когда элементы возвращаются через API.
Возможные значения: in_progress, completedincomplete		 Нет
Тип Перечисления Тип выходных данных вызова средства функции. Всегда function_call_output.
Возможные значения: function_call_output		 Да

OpenAI.ConversationItemFunctionToolCallResource

Имя Тип Описание Обязательно По умолчанию
Аргументы Строка Строка JSON аргументов для передачи функции. Да
call_id Строка Уникальный идентификатор вызова средства функции, созданного моделью. Да
Id Строка Уникальный идентификатор вызова средства функции. Нет
Имя Строка Имя выполняемой функции. Да
Статус Перечисления Состояние элемента. Один из in_progress, completedили
incomplete. Заполняется, когда элементы возвращаются через API.
Возможные значения: in_progress, completedincomplete		 Нет
Тип Перечисления Тип вызова средства функции. Всегда function_call.
Возможные значения: function_call		 Да

OpenAI.ConversationItemImageGenToolCall

Запрос на создание изображения, сделанный моделью.

Имя Тип Описание Обязательно По умолчанию
Id Строка Уникальный идентификатор вызова создания образа. Да
Результат строка или null Да
Статус Перечисления Состояние вызова создания образа.
Возможные значения: in_progress, , completedgeneratingfailed		 Да
Тип Перечисления Тип вызова создания изображения. Всегда image_generation_call.
Возможные значения: image_generation_call		 Да

OpenAI.ConversationItemList

Список элементов беседы.

Имя Тип Описание Обязательно По умолчанию
Данных массив OpenAI.ConversationItem Список элементов беседы. Да
first_id Строка Идентификатор первого элемента в списке. Да
has_more Логических Доступны ли дополнительные элементы. Да
last_id Строка Идентификатор последнего элемента в списке. Да
Объекта Перечисления Тип возвращаемого объекта должен быть list.
Возможные значения: list		 Да

OpenAI.ConversationItemLocalShellToolCall

Вызов средства для выполнения команды в локальной оболочке.

Имя Тип Описание Обязательно По умолчанию
Действий OpenAI.LocalShellExecAction Выполните команду оболочки на сервере. Да
call_id Строка Уникальный идентификатор вызова локального средства оболочки, созданного моделью. Да
Id Строка Уникальный идентификатор вызова локальной оболочки. Да
Статус Перечисления Состояние вызова локальной оболочки.
Возможные значения: in_progress, completedincomplete		 Да
Тип Перечисления Тип вызова локальной оболочки. Всегда local_shell_call.
Возможные значения: local_shell_call		 Да

OpenAI.ConversationItemLocalShellToolCallOutput

Выходные данные вызова локального средства оболочки.

Имя Тип Описание Обязательно По умолчанию
Id Строка Уникальный идентификатор вызова локального средства оболочки, созданного моделью. Да
Выход Строка Строка JSON выходных данных вызова локального средства оболочки. Да
Статус строка или null Нет
Тип Перечисления Тип выходных данных вызова средства локальной оболочки. Всегда local_shell_call_output.
Возможные значения: local_shell_call_output		 Да

OpenAI.ConversationItemMcpApprovalRequest

Запрос на утверждение человека вызова инструмента.

Имя Тип Описание Обязательно По умолчанию
Аргументы Строка Строка JSON аргументов для средства. Да
Id Строка Уникальный идентификатор запроса на утверждение. Да
Имя Строка Имя запускаемого средства. Да
server_label Строка Метка сервера MCP, выполняющего запрос. Да
Тип Перечисления Тип элемента. Всегда mcp_approval_request.
Возможные значения: mcp_approval_request		 Да

OpenAI.ConversationItemMcpApprovalResponseResource

Ответ на запрос на утверждение MCP.

Имя Тип Описание Обязательно По умолчанию
approval_request_id Строка Идентификатор ответа запроса на утверждение. Да
Утвердить Логических Будет ли утвержден запрос. Да
Id Строка Уникальный идентификатор ответа на утверждение Да
Причина строка или null Нет
Тип Перечисления Тип элемента. Всегда mcp_approval_response.
Возможные значения: mcp_approval_response		 Да

OpenAI.ConversationItemMcpListTools

Список средств, доступных на сервере MCP.

Имя Тип Описание Обязательно По умолчанию
Ошибка строка или null Нет
Id Строка Уникальный идентификатор списка. Да
server_label Строка Метка сервера MCP. Да
Инструменты массив OpenAI.MCPListToolsTools Средства, доступные на сервере. Да
Тип Перечисления Тип элемента. Всегда mcp_list_tools.
Возможные значения: mcp_list_tools		 Да

OpenAI.ConversationItemMcpToolCall

Вызов средства на сервере MCP.

Имя Тип Описание Обязательно По умолчанию
approval_request_id строка или null Нет
Аргументы Строка Строка JSON аргументов, переданных средству. Да
Ошибка строка или null Нет
Id Строка Уникальный идентификатор вызова средства. Да
Имя Строка Имя запущенного средства. Да
Выход строка или null Нет
server_label Строка Метка сервера MCP под управлением средства. Да
Статус OpenAI.MCPToolCallStatus Нет
Тип Перечисления Тип элемента. Всегда mcp_call.
Возможные значения: mcp_call		 Да

OpenAI.ConversationItemMessage

Сообщение в модель или из нее.

Имя Тип Описание Обязательно По умолчанию
Содержимого массив OpenAI.InputTextContent или OpenAI.OutputTextContent или OpenAI.TextContent или OpenAI.SummaryTextContent или OpenAI.ReasoningTextContent или OpenAI.ОтказContent или OpenAI.InputImageContent или OpenAI.ComputerScreenshotContent или OpenAI.InputFileContent Содержимое сообщения Да
Id Строка Уникальный идентификатор сообщения. Да
Роль OpenAI.MessageRole Да
Статус OpenAI.MessageStatus Да
Тип Перечисления Тип сообщения. Всегда задано значение message.
Возможные значения: message		 Да

OpenAI.ConversationItemReasoningItem

Описание цепочки мысли, используемой моделью причин при создании ответа. Не забудьте включить эти элементы в input API ответов для последующих поворотов беседы, если вы вручную управляете контекстом.

Имя Тип Описание Обязательно По умолчанию
Содержимого массив OpenAI.ReasoningTextContent Обоснование текстового содержимого. Нет
encrypted_content строка или null Нет
Id Строка Уникальный идентификатор содержимого причины. Да
Статус Перечисления Состояние элемента. Один из in_progress, completedили
incomplete. Заполняется, когда элементы возвращаются через API.
Возможные значения: in_progress, completedincomplete		 Нет
Сводка массив OpenAI.Summary Содержимое сводки по причинам. Да
Тип Перечисления Тип объекта. Всегда reasoning.
Возможные значения: reasoning		 Да

OpenAI.ConversationItemType

Свойство Значение
Тип Строка
Значения 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

Результаты вызова средства поиска в Интернете. Дополнительные сведения см. в руководстве по поиску в Интернете .

Имя Тип Описание Обязательно По умолчанию
Действий OpenAI.WebSearchActionSearch или OpenAI.WebSearchActionOpenPage или OpenAI.WebSearchActionFind Объект, описывающий конкретные действия, выполненные в этом вызове поиска в Интернете.
Содержит сведения об использовании модели в Интернете (поиск, open_page, поиск).		 Да
Id Строка Уникальный идентификатор вызова средства поиска в Интернете. Да
Статус Перечисления Состояние вызова средства поиска в Интернете.
Возможные значения: in_progress, , searchingcompletedfailed		 Да
Тип Перечисления Тип вызова средства поиска в Интернете. Всегда web_search_call.
Возможные значения: web_search_call		 Да

OpenAI.ConversationParam

Беседа, к которой относится этот ответ. Элементы из этой беседы предопределяются input_items для этого запроса ответа. Входные элементы и выходные элементы из этого ответа автоматически добавляются в эту беседу после завершения этого ответа.

Тип: string или OpenAI.ConversationParam-2

Беседа, к которой относится этот ответ. Элементы из этой беседы предопределяются input_items для этого запроса ответа. Входные элементы и выходные элементы из этого ответа автоматически добавляются в эту беседу после завершения этого ответа.

OpenAI.ConversationParam-2

Беседа, к которой относится этот ответ.

Имя Тип Описание Обязательно По умолчанию
Id Строка Уникальный идентификатор беседы. Да

OpenAI.ConversationReference

Беседа, к которой относится этот ответ. Входные элементы и выходные элементы из этого ответа были автоматически добавлены в эту беседу.

Имя Тип Описание Обязательно По умолчанию
Id Строка Уникальный идентификатор беседы, с которым связан этот ответ. Да

OpenAI.ConversationResource

Имя Тип Описание Обязательно По умолчанию
created_at Целое число Время создания беседы измеряется в секундах с эпохи Unix. Да
Id Строка Уникальный идентификатор беседы. Да
Метаданных Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате и запроса на объекты через API или панель мониторинга.
Ключи — это строки с максимальной длиной 64 символов. Значения — это строки с максимальной длиной 512 символов.		 Да
Объекта Перечисления Тип объекта, который всегда conversationявляется .
Возможные значения: conversation		 Да

OpenAI.CreateChatCompletionRequestAudio

Имя Тип Описание Обязательно По умолчанию
Формат Перечисления
Возможные значения: wav, , aacmp3flac, opuspcm16		 Да
Голос OpenAI.VoiceIdsShared Да

OpenAI.CreateChatCompletionRequestResponseFormat

Объект, указывающий формат, который должен выводить модель. { "type": "json_schema", "json_schema": {...} } Чтобы включить структурированные выходные данные, которые гарантируют, что модель будет соответствовать предоставленной схеме JSON. Дополнительные сведения см. в руководстве по структурированным выходным данным. Параметр для { "type": "json_object" } включения более старого режима JSON, который гарантирует, что сообщение, которое создает модель, является допустимым JSON. Использование json_schema предпочтительнее для моделей, поддерживающих его.

Дискриминация для OpenAI.CreateChatCompletionRequestResponseFormat

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа Схемы
json_schema OpenAI.ResponseFormatJsonSchema
text OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatText
json_object OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject
Имя Тип Описание Обязательно По умолчанию
Тип OpenAI.CreateChatCompletionRequestResponseFormatType Да

OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject

Формат отклика объекта JSON. Старый метод создания ответов JSON. Рекомендуется использовать json_schema для моделей, поддерживающих его. Обратите внимание, что модель не будет генерировать JSON без системного или пользовательского сообщения о том, что это нужно сделать.

Имя Тип Описание Обязательно По умолчанию
Тип Перечисления Тип определяемого формата ответа. Всегда json_object.
Возможные значения: json_object		 Да

OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatText

Формат ответа по умолчанию. Используется для создания текстовых ответов.

Имя Тип Описание Обязательно По умолчанию
Тип Перечисления Тип определяемого формата ответа. Всегда text.
Возможные значения: text		 Да

OpenAI.CreateChatCompletionRequestResponseFormatType

Свойство Значение
Тип Строка
Значения text
json_schema
json_object

OpenAI.CreateChatCompletionResponseChoices

Имя Тип Описание Обязательно По умолчанию
content_filter_results AzureContentFilterResultForChoice Результат фильтра содержимого для одного элемента ответа, созданного системой создания искусственного интеллекта. Нет
finish_reason Перечисления
Возможные значения: stop, , lengthtool_callscontent_filterfunction_call		 Да
Индекс Целое число Да
logprobs OpenAI.CreateChatCompletionResponseChoicesLogprobs или null Да
Сообщение OpenAI.ChatCompletionResponseMessage Если запрашивается модальность вывода звука, этот объект содержит данные
о звуковом ответе модели.		 Да

OpenAI.CreateChatCompletionResponseChoicesLogprobs

Имя Тип Описание Обязательно По умолчанию
Содержимого массив OpenAI.ChatCompletionTokenLogprob или null Да
Отказ массив OpenAI.ChatCompletionTokenLogprob или null Да

OpenAI.CreateChatCompletionStreamResponseChoices

Имя Тип Описание Обязательно По умолчанию
Дельта OpenAI.ChatCompletionStreamResponseDelta Разностное завершение чата, созданное потоковой передачей ответов модели. Да
finish_reason строка или null Да
Индекс Целое число Да
logprobs OpenAI.CreateChatCompletionStreamResponseChoicesLogprobs или null Нет

OpenAI.CreateChatCompletionStreamResponseChoicesLogprobs

Имя Тип Описание Обязательно По умолчанию
Содержимого массив OpenAI.ChatCompletionTokenLogprob или null Да
Отказ массив OpenAI.ChatCompletionTokenLogprob или null Да

OpenAI.CreateCompletionResponseChoices

Имя Тип Описание Обязательно По умолчанию
content_filter_results AzureContentFilterResultForChoice Результат фильтра содержимого для одного элемента ответа, созданного системой создания искусственного интеллекта. Нет
finish_reason Перечисления
Возможные значения: stop, lengthcontent_filter		 Да
Индекс Целое число Да
logprobs OpenAI.CreateCompletionResponseChoicesLogprobs или null Да
Текст Строка Да

OpenAI.CreateCompletionResponseChoicesLogprobs

Имя Тип Описание Обязательно По умолчанию
text_offset массив целых чисел Нет
token_logprobs массив чисел Нет
Маркеры массив строк Нет
top_logprobs массив объекта Нет

OpenAI.CreateContainerBody

Имя Тип Описание Обязательно По умолчанию
expires_after OpenAI.CreateContainerBodyExpiresAfter Нет
Привязка └️ Перечисления
Возможные значения: last_active_at		 Да
└️ минуты Целое число Да
file_ids массив строк Идентификаторы файлов для копирования в контейнер. Нет
memory_limit Перечисления Необязательное ограничение памяти для контейнера. По умолчанию используется значение "1g".
Возможные значения: 1g, , 4g16g64g		 Нет
Имя Строка Имя создаваемого контейнера. Да

OpenAI.CreateContainerBodyExpiresAfter

Имя Тип Описание Обязательно По умолчанию
Якорь Перечисления
Возможные значения: last_active_at		 Да
Минут Целое число Да

OpenAI.CreateContainerFileBody

Имя Тип Описание Обязательно По умолчанию
Файл Объект File (не имя файла) для отправки. Нет
file_id Строка Имя создаваемого файла. Нет

OpenAI.CreateConversationBody

Имя Тип Описание Обязательно По умолчанию
Элементы массив OpenAI.InputItem или null Нет
Метаданных OpenAI.Metadata или NULL Нет

OpenAI.CreateConversationItemsParametersBody

Имя Тип Описание Обязательно По умолчанию
Элементы массив OpenAI.InputItem Да

OpenAI.CreateEmbeddingRequest

Имя Тип Описание Обязательно По умолчанию
Размеры Целое число Число измерений, в которых должны быть внедренные выходные данные. Поддерживается только в text-embedding-3 и более поздних моделях.
Ограничения: мин: 1		 Нет
encoding_format Перечисления Формат, в который возвращаются встраиваемые элементы. Может быть либо floatbase64.
Возможные значения: float, base64		 Нет
Вход строка или массив строк или массив целых чисел или массив массива массива Входной текст для внедрения, закодированный в виде строки или массива маркеров. Чтобы внедрить несколько входных данных в один запрос, передайте массив строк или массив массивов маркеров. Входные данные не должны превышать максимальные входные маркеры для модели (8 192 маркеров для всех моделей внедрения), не может быть пустой строкой, и любой массив должен быть 2048 измерений или меньше. Пример кода Python для подсчета маркеров. В дополнение к ограничению маркера для каждого ввода все модели внедрения применяют не более 300 000 маркеров, суммируемых во всех входных данных в одном запросе. Да
Модели Строка Идентификатор используемой модели. Api " Список моделей " можно использовать для просмотра всех доступных моделей или просмотра описания моделей. Да
Пользователя Строка Дополнительные сведения. Нет

OpenAI.CreateEmbeddingResponse

Имя Тип Описание Обязательно По умолчанию
Данных массив OpenAI.Embedding Список внедрения, созданных моделью. Да
Модели Строка Имя модели, используемой для создания внедрения. Да
Объекта Перечисления Тип объекта, который всегда является "list".
Возможные значения: list		 Да
Использования OpenAI.CreateEmbeddingResponseUsage Да
└prompt_tokens Целое число Да
└️ total_tokens Целое число Да

OpenAI.CreateEmbeddingResponseUsage

Имя Тип Описание Обязательно По умолчанию
prompt_tokens Целое число Да
total_tokens Целое число Да

OpenAI.CreateEvalCompletionsRunDataSource

Объект CompletionsRunDataSource, описывающий конфигурацию выборки модели.

Имя Тип Описание Обязательно По умолчанию
input_messages OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesTemplate или OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference Используется при выборке из модели. Определяет структуру сообщений, передаваемых в модель. Может быть ссылка на предварительно созданную траекторию (т. е. item.input_trajectory) или шаблон с переменными ссылками на item пространство имен. Нет
Модели Строка Имя модели, используемой для создания завершений (например, o3-mini). Нет
sampling_params AzureCompletionsSamplingParams Параметры выборки для управления поведением завершения. Нет
Источник OpenAI.EvalJsonlFileContentSource или OpenAI.EvalJsonlFileIdSource или OpenAI.EvalStoredCompletionsSource Определяет, что заполняет item пространство имен в источнике данных этого запуска. Да
Тип Перечисления Тип источника данных запуска. Всегда completions.
Возможные значения: completions		 Да

OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference

Имя Тип Описание Обязательно По умолчанию
item_reference Строка Да
Тип Перечисления
Возможные значения: item_reference		 Да

OpenAI.CreateEvalCompletionsRunDataSourceInputMessagessTemplate

Имя Тип Описание Обязательно По умолчанию
Шаблон массив OpenAI.EasyInputMessage или OpenAI.EvalItem Да
Тип Перечисления
Возможные значения: template		 Да

OpenAI.CreateEvalCompletionsRunDataSourceSamplingParams

Имя Тип Описание Обязательно По умолчанию
max_completion_tokens Целое число Нет
reasoning_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.		 Нет
response_format OpenAI.ResponseFormatText или OpenAI.ResponseFormatJsonSchema или OpenAI.ResponseFormatJsonObject Нет
Семян Целое число Начальное значение инициализирует случайность во время выборки. Нет 42
Температура Номер Более высокая температура увеличивает случайность выходных данных. Нет 1
Инструменты массив OpenAI.ChatCompletionTool Нет
top_p Номер Альтернатива температуре для выборки ядра; 1.0 включает все маркеры. Нет 1

OpenAI.CreateEvalCustomDataSourceConfig

Объект CustomDataSourceConfig, определяющий схему источника данных, используемого для выполнения оценки. Эта схема используется для определения формы данных, которые будут:

  • Используется для определения критериев тестирования и
  • Какие данные требуются при создании запуска
Имя Тип Описание Обязательно По умолчанию
include_sample_schema Логических Следует ли ожидать, что eval заполняете образец пространства имен (т. е. путем создания ответов из источника данных) Нет
item_schema Объекта Схема JSON для каждой строки в источнике данных. Да
Тип Перечисления Тип источника данных. Всегда custom.
Возможные значения: custom		 Да

OpenAI.CreateEvalItem

Сообщение чата, включающее запрос или контекст. Может содержать ссылки на переменные в item пространство имен, т. е. {{item.name}}.

Имя Тип Описание Обязательно По умолчанию
Содержимого Строка Содержимое сообщения. Да
Роль Строка Роль сообщения (например, system, assistant, user). Да

OpenAI.CreateEvalJsonlRunDataSource

Объект JsonlRunDataSource с указанием JSONL-файла, соответствующего eval

Имя Тип Описание Обязательно По умолчанию
Источник OpenAI.EvalJsonlFileContentSource или OpenAI.EvalJsonlFileIdSource Определяет, что заполняет item пространство имен в источнике данных. Да
Тип Перечисления Тип источника данных. Всегда jsonl.
Возможные значения: jsonl		 Да

OpenAI.CreateEvalLabelModelGrader

Объект LabelModelGrader, использующий модель для назначения меток каждому элементу в оценке.

Имя Тип Описание Обязательно По умолчанию
Вход массив OpenAI.CreateEvalItem Список сообщений чата, формируя запрос или контекст. Может содержать ссылки на переменные в item пространство имен, т. е. {{item.name}}. Да
Метки массив строк Метки для классификации каждого элемента в оценке. Да
Модели Строка Модель, используемая для оценки. Должен поддерживать структурированные выходные данные. Да
Имя Строка Имя классировщика. Да
passing_labels массив строк Метки, указывающие на результат передачи. Должно быть подмножеством меток. Да
Тип Перечисления Тип объекта, который всегда label_modelявляется .
Возможные значения: label_model		 Да

OpenAI.CreateEvalLogsDataSourceConfig

Конфигурация источника данных, указывающая свойство метаданных запроса журналов. Обычно это метаданные, такие как usecase=chatbot или prompt-version=v2и т. д.

Имя Тип Описание Обязательно По умолчанию
Метаданных Объекта Фильтры метаданных для источника данных журналов. Нет
Тип Перечисления Тип источника данных. Всегда logs.
Возможные значения: logs		 Да

OpenAI.CreateEvalResponsesRunDataSource

Объект ResponsesRunDataSource, описывающий конфигурацию выборки модели.

Имя Тип Описание Обязательно По умолчанию
input_messages OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate или OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference Используется при выборке из модели. Определяет структуру сообщений, передаваемых в модель. Может быть ссылка на предварительно созданную траекторию (т. е. item.input_trajectory) или шаблон с переменными ссылками на item пространство имен. Нет
Модели Строка Имя модели, используемой для создания завершений (например, o3-mini). Нет
sampling_params AzureResponsesSamplingParams Параметры выборки для управления поведением ответов. Нет
Источник OpenAI.EvalJsonlFileContentSource или OpenAI.EvalJsonlFileIdSource или OpenAI.EvalResponsesSource Определяет, что заполняет item пространство имен в источнике данных этого запуска. Да
Тип Перечисления Тип источника данных запуска. Всегда responses.
Возможные значения: responses		 Да

OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference

Имя Тип Описание Обязательно По умолчанию
item_reference Строка Да
Тип Перечисления
Возможные значения: item_reference		 Да

OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate

Имя Тип Описание Обязательно По умолчанию
Шаблон массив объекта или OpenAI.EvalItem Да
Тип Перечисления
Возможные значения: template		 Да

OpenAI.CreateEvalResponsesRunDataSourceSamplingParams

Имя Тип Описание Обязательно По умолчанию
reasoning_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.		 Нет
Семян Целое число Начальное значение инициализирует случайность во время выборки. Нет 42
Температура Номер Более высокая температура увеличивает случайность выходных данных. Нет 1
Текст OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText Нет
Инструменты массив OpenAI.Tool Нет
top_p Номер Альтернатива температуре для выборки ядра; 1.0 включает все маркеры. Нет 1

OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText

Имя Тип Описание Обязательно По умолчанию
Формат OpenAI.TextResponseFormatConfiguration Объект, указывающий формат, который должен выводить модель.
{ "type": "json_schema" } Настройка включает структурированные выходные данные,
это гарантирует, что модель будет соответствовать предоставленной схеме JSON. Дополнительные сведения см. в разделе

Формат по умолчанию не имеет { "type": "text" } дополнительных параметров.
*Не рекомендуется для gpt-4o и более новых моделей:**
Параметр включения { "type": "json_object" } более старого режима JSON, который
гарантирует, что сообщение, которое создает модель, является допустимым JSON. Используя json_schema
предпочтителен для моделей, поддерживающих его.		 Нет

OpenAI.CreateEvalRunRequest

Имя Тип Описание Обязательно По умолчанию
data_source OpenAI.CreateEvalJsonlRunDataSource или OpenAI.CreateEvalCompletionsRunDataSource или OpenAI.CreateEvalResponsesRunDataSource Сведения об источнике данных запуска. Да
Метаданных OpenAI.Metadata или NULL Нет
Имя Строка Имя запуска. Нет

OpenAI.CreateEvalStoredCompletionsDataSourceConfig

Не рекомендуется использовать LogsDataSourceConfig.

Имя Тип Описание Обязательно По умолчанию
Метаданных Объекта Фильтры метаданных для источника данных хранимых завершений. Нет
Тип Перечисления Тип источника данных. Всегда stored_completions.
Возможные значения: stored_completions		 Да

OpenAI.CreateFileRequest

Имя Тип Описание Обязательно По умолчанию
expires_after Объекта Да
Привязка └️ AzureFileExpiryAnchor Да
└= секунды Целое число Да
Файл Объект File (не имя файла) для отправки. Да
Цель Перечисления Предназначенная цель отправленного файла. Одно из следующих: assistants: используется в API помощников: batchиспользуется в API пакетной службы : fine-tuneиспользуется для точной настройки : evalsиспользуется для наборов данных eval
Возможные значения: assistants, , batchfine-tuneevals		 Да

OpenAI.CreateFineTuningCheckpointPermissionRequest

Имя Тип Описание Обязательно По умолчанию
project_ids массив строк Идентификаторы проекта для предоставления доступа. Да

OpenAI.CreateFineTuningJobRequest

Допустимые модели:

babbage-002
davinci-002
gpt-3.5-turbo
gpt-4o-mini
Имя Тип Описание Обязательно По умолчанию
гиперпараметры OpenAI.CreateFineTuningJobRequestHyperparameters Нет
└batch_size строка или целое число Нет Авто
└learning_rate_multiplier learning_rate_multiplier строка или число Нет
└️ n_epochs строка или целое число Нет Авто
Интеграции массив OpenAI.CreateFineTuningJobRequestIntegrations или null Список интеграции для задания тонкой настройки. Нет
Метаданных OpenAI.Metadata или NULL Нет
Метод OpenAI.FineTuneMethod Метод, используемый для точной настройки. Нет
Модели строка (см. допустимые модели ниже) Имя модели для точной настройки. Вы можете выбрать один из них.
поддерживаемые модели.		 Да
Семян целое число или null Начальное значение определяет воспроизводимость задания. Передача одинаковых параметров начального значения и заданий должна иметь одинаковые результаты, но может отличаться в редких случаях.
Если начальное значение не указано, он будет создан для вас.		 Нет
Суффикс строка или null Строка до 64 символов, которые будут добавлены в имя настраиваемой модели.
Например, suffix в поле "Custom-model-name" будет производиться имя модели, например ft:gpt-4o-mini:openai:custom-model-name:7p4lURel.		 Нет
training_file Строка Идентификатор отправленного файла, содержащего данные обучения.
Сведения о том, как отправить файл, см. в разделе "Отправка файла ".
Набор данных должен быть отформатирован в формате JSONL-файла. Кроме того, необходимо передать файл с целью fine-tune.
Содержимое файла должно отличаться в зависимости от того, использует ли модель чат, формат завершения или использует ли метод тонкой настройки формат предпочтения .
Дополнительные сведения см. в руководстве по тонкой настройке .		 Да
validation_file строка или null Идентификатор отправленного файла, содержащего данные проверки.
Если этот файл предоставлен, данные используются для создания проверки
Метрики периодически во время тонкой настройки. Эти метрики можно просмотреть в
файл результатов тонкой настройки.
Одни и те же данные не должны присутствовать в файлах обучения и проверки.
Набор данных должен быть отформатирован в формате JSONL-файла. Необходимо отправить файл с целью fine-tune.
Дополнительные сведения см. в руководстве по тонкой настройке .		 Нет

OpenAI.CreateFineTuningJobRequestHyperparameters

Имя Тип Описание Обязательно По умолчанию
batch_size строка или целое число Нет
learning_rate_multiplier строка или число Нет
n_epochs строка или целое число Нет

OpenAI.CreateFineTuningJobRequestIntegrations

Имя Тип Описание Обязательно По умолчанию
Тип Перечисления
Возможные значения: wandb		 Да
wandb OpenAI.CreateFineTuningJobRequestIntegrationsWandb Да

OpenAI.CreateFineTuningJobRequestIntegrationsWandb

Имя Тип Описание Обязательно По умолчанию
Сущности строка или null Нет
Имя строка или null Нет
Проекта Строка Да
Теги массив строк Нет

OpenAI.CreateMessageRequest

Имя Тип Описание Обязательно По умолчанию
Вложения массив OpenAI.CreateMessageRequestAttachments или null Нет
Содержимого строка или массив OpenAI.MessageContentImageFileObject или OpenAI.MessageContentImageUrlObject или OpenAI.MessageRequestContentTextObject Да
Метаданных OpenAI.Metadata или NULL Нет
Роль Перечисления Роль сущности, создающей сообщение. Допустимые значения:
- user: указывает, что сообщение отправляется фактическим пользователем и должно использоваться в большинстве случаев для представления сообщений, созданных пользователем.
- assistant: указывает, что сообщение создается помощником. Используйте это значение для вставки сообщений от помощника в беседу.
Возможные значения: user, assistant		 Да

OpenAI.CreateMessageRequestAttachments

Имя Тип Описание Обязательно По умолчанию
file_id Строка Нет
Инструменты массив OpenAI.AssistantToolsCode или OpenAI.AssistantToolsFileSearchTypeOnly Нет

OpenAI.CreateResponse

Имя Тип Описание Обязательно По умолчанию
Фон логический или null Нет
Разговор OpenAI.ConversationParam или null Нет
Включают массив OpenAI.IncludeEnum или null Нет
Вход OpenAI.InputParam Текстовые, изображения или входные данные файлов в модель, используемые для создания ответа.
Подробнее:
- Текстовые входные и выходные данные
- Входные данные изображения
- Входные данные файлов
- Состояние беседы
- Вызов функции		 Нет
Инструкции строка или null Нет
max_output_tokens целое число или null Нет
max_tool_calls целое число или null Нет
Метаданных OpenAI.Metadata или NULL Нет
Модели Строка Идентификатор модели, используемый для создания ответа, например gpt-4o или o3. OpenAI
предлагает широкий спектр моделей с разными возможностями, производительностью
характеристики и цены. См. руководство по модели
для просмотра и сравнения доступных моделей.		 Нет
parallel_tool_calls логический или null Нет
previous_response_id строка или null Нет
Строке OpenAI.Prompt Ссылка на шаблон запроса и его переменные.
Дополнительные сведения.		 Нет
prompt_cache_key Строка Используется OpenAI для кэширования ответов для аналогичных запросов для оптимизации частоты попаданий кэша. Заменяет user поле. Дополнительные сведения. Нет
prompt_cache_retention строка или null Нет
Рассуждения OpenAI.Reasoning или NULL Нет
safety_identifier Строка Стабильный идентификатор, используемый для обнаружения пользователей приложения, которые могут нарушать политики использования OpenAI.
Идентификаторы должны быть строкой, которая однозначно идентифицирует каждого пользователя. Мы рекомендуем хэшировать имя пользователя или адрес электронной почты, чтобы избежать отправки нам каких-либо сведений об идентификации. Дополнительные сведения.		 Нет
Магазин логический или null Нет
Поток логический или null Нет
stream_options OpenAI.ResponseStreamOptions или null Нет
Температура число или null Нет
Текст OpenAI.ResponseTextParam Параметры конфигурации для текстового ответа модели. Может быть простым
текстовые или структурированные данные JSON. Подробнее:
- Текстовые входные и выходные данные
- Структурированные выходные данные		 Нет
tool_choice OpenAI.ToolChoiceParam Как модель должна выбрать инструмент (или средства), которые следует использовать при создании
ответ. См. tools параметр, чтобы узнать, как указать инструменты
Модель может вызываться.		 Нет
Инструменты OpenAI.ToolsArray Массив инструментов, которые модель может вызывать при создании ответа. Вы
может указать, какое средство следует использовать, задав tool_choice параметр.
Мы поддерживаем следующие категории инструментов:
- Встроенные средства: средства, предоставляемые OpenAI, расширяющие
Возможности модели, такие как поиск в Интернете
или поиск по файлам. Дополнительные сведения
встроенные средства.
- Инструменты MCP: интеграция с сторонними системами с помощью пользовательских серверов MCP
или предопределенные соединители, такие как Google Drive и SharePoint. Дополнительные сведения
Инструменты MCP.
- Вызовы функций (пользовательские средства): функции, определенные вами,
включение модели для вызова собственного кода с строго типизированными аргументами
и выходные данные. Дополнительные сведения
вызов функции. Вы также можете использовать
пользовательские средства для вызова собственного кода.		 Нет
top_logprobs целое число или null Нет
top_p число или null Нет
Усечение строка или null Нет
Пользователя string (не рекомендуется) Это поле заменяется safety_identifier и prompt_cache_key. Вместо этого используйте prompt_cache_key для поддержания оптимизации кэширования.
Стабильный идентификатор для конечных пользователей.
Используется для повышения скорости попадания кэша в более эффективное сегментирование аналогичных запросов и помогает OpenAI обнаруживать и предотвращать злоупотребление. Дополнительные сведения.		 Нет

OpenAI.CreateRunRequest

Имя Тип Описание Обязательно По умолчанию
additional_instructions строка или null Добавляет дополнительные инструкции в конце инструкций для выполнения. Это полезно для изменения поведения на основе каждого запуска без переопределения других инструкций. Нет
additional_messages массив OpenAI.CreateMessageRequest или null Добавляет дополнительные сообщения в поток перед созданием запуска. Нет
assistant_id Строка Идентификатор помощника , используемого для выполнения этого выполнения. Да
Инструкции строка или null Переопределяет инструкции помощника. Это полезно для изменения поведения на основе каждого запуска. Нет
max_completion_tokens целое число или null Максимальное количество маркеров завершения, которые могут использоваться в ходе выполнения. Выполнение сделает все возможное, чтобы использовать только количество маркеров завершения, указанных в нескольких поворотах выполнения. Если выполнение превышает указанное число маркеров завершения, выполнение завершится состоянием incomplete. Дополнительные сведения см. в разделе incomplete_details . Нет
max_prompt_tokens целое число или null Максимальное количество маркеров запроса, которые могут использоваться в ходе выполнения. Выполнение сделает все возможное, чтобы использовать только количество маркеров запроса, указанных в нескольких поворотах выполнения. Если выполнение превышает указанное число маркеров запроса, выполнение завершится состоянием incomplete. Дополнительные сведения см. в разделе incomplete_details . Нет
Метаданных OpenAI.Metadata или NULL Нет
Модели Строка Идентификатор модели , используемой для выполнения этого выполнения. Если здесь указано значение, оно переопределит модель, связанную с помощником. В противном случае будет использоваться модель, связанная с помощником. Нет
parallel_tool_calls OpenAI.ParallelToolCalls Следует ли включить параллельные вызовы функций во время использования средства. Нет
reasoning_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.		 Нет
response_format OpenAI.AssistantsApiResponseFormatOption Указывает формат, который модель должна выводить. Совместим с GPT-4o, GPT-4 Turbo и всеми моделями GPT-3.5 Turbo с тех пор gpt-3.5-turbo-1106.
{ "type": "json_schema", "json_schema": {...} } Чтобы включить структурированные выходные данные, которые гарантируют, что модель будет соответствовать предоставленной схеме JSON. Дополнительные сведения см. в разделе
Параметр включения { "type": "json_object" } режима JSON, который гарантирует, что модель создает сообщение является допустимым JSON.
Важно:* при использовании режима JSON необходимо также указать модели создавать JSON самостоятельно с помощью системного или пользовательского сообщения. Без этого модель может создать неуправляемый поток пробелов до тех пор, пока поколение не достигнет предела маркера, в результате чего длительный и, казалось бы, "застрявший" запрос. Кроме того, обратите внимание, что содержимое сообщения может быть частично отрезано, если finish_reason="length", что указывает на превышение поколения max_tokens или беседа превысила максимальную длину контекста.		 Нет
Поток логический или null Если trueвозвращает поток событий, которые происходят во время событий запуска от имени сервера, завершая выполнение в состоянии терминала с сообщением data: [DONE] . Нет
Температура число или null Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным. Нет
tool_choice OpenAI.AssistantsApiToolChoiceOption Определяет, какое средство (если таковое) вызывается моделью.
none означает, что модель не будет вызывать средства и вместо этого создает сообщение.
auto — это значение по умолчанию и означает, что модель может выбирать между созданием сообщения или вызовом одного или нескольких инструментов.
required означает, что модель должна вызывать один или несколько инструментов, прежде чем отвечать на запрос пользователя.
Указание определенного инструмента, например {"type": "file_search"} или {"type": "function", "function": {"name": "my_function"}} принудительное вызов модели.		 Нет
Инструменты массив OpenAI.AssistantTool Переопределите средства, которые помощник может использовать для этого запуска. Это полезно для изменения поведения на основе каждого запуска. Нет
top_p число или null Альтернатива выборке с температурой, называемой выборкой ядра, где модель рассматривает результаты маркеров с top_p массой вероятности. Таким образом, 0,1 означает, что рассматриваются только маркеры, состоящие из 10 лучших% массы вероятностей.
Как правило, мы рекомендуем изменить это или температуру, но не оба.		 Нет
truncation_strategy OpenAI.TruncationObject Определяет, как поток будет усечен до выполнения. Используйте это для управления начальным окном контекста выполнения. Нет

OpenAI.CreateThreadAndRunRequest

Имя Тип Описание Обязательно По умолчанию
assistant_id Строка Идентификатор помощника , используемого для выполнения этого выполнения. Да
Инструкции строка или null Переопределите системное сообщение помощника по умолчанию. Это полезно для изменения поведения на основе каждого запуска. Нет
max_completion_tokens целое число или null Максимальное количество маркеров завершения, которые могут использоваться в ходе выполнения. Выполнение сделает все возможное, чтобы использовать только количество маркеров завершения, указанных в нескольких поворотах выполнения. Если выполнение превышает указанное число маркеров завершения, выполнение завершится состоянием incomplete. Дополнительные сведения см. в разделе incomplete_details . Нет
max_prompt_tokens целое число или null Максимальное количество маркеров запроса, которые могут использоваться в ходе выполнения. Выполнение сделает все возможное, чтобы использовать только количество маркеров запроса, указанных в нескольких поворотах выполнения. Если выполнение превышает указанное число маркеров запроса, выполнение завершится состоянием incomplete. Дополнительные сведения см. в разделе incomplete_details . Нет
Метаданных OpenAI.Metadata или NULL Нет
Модели Строка Идентификатор модели , используемой для выполнения этого выполнения. Если здесь указано значение, оно переопределит модель, связанную с помощником. В противном случае будет использоваться модель, связанная с помощником. Нет
parallel_tool_calls OpenAI.ParallelToolCalls Следует ли включить параллельные вызовы функций во время использования средства. Нет
response_format OpenAI.AssistantsApiResponseFormatOption Указывает формат, который модель должна выводить. Совместим с GPT-4o, GPT-4 Turbo и всеми моделями GPT-3.5 Turbo с тех пор gpt-3.5-turbo-1106.
{ "type": "json_schema", "json_schema": {...} } Чтобы включить структурированные выходные данные, которые гарантируют, что модель будет соответствовать предоставленной схеме JSON. Дополнительные сведения см. в разделе
Параметр включения { "type": "json_object" } режима JSON, который гарантирует, что модель создает сообщение является допустимым JSON.
Важно:* при использовании режима JSON необходимо также указать модели создавать JSON самостоятельно с помощью системного или пользовательского сообщения. Без этого модель может создать неуправляемый поток пробелов до тех пор, пока поколение не достигнет предела маркера, в результате чего длительный и, казалось бы, "застрявший" запрос. Кроме того, обратите внимание, что содержимое сообщения может быть частично отрезано, если finish_reason="length", что указывает на превышение поколения max_tokens или беседа превысила максимальную длину контекста.		 Нет
Поток логический или null Если trueвозвращает поток событий, которые происходят во время событий запуска от имени сервера, завершая выполнение в состоянии терминала с сообщением data: [DONE] . Нет
Температура число или null Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным. Нет
Поток OpenAI.CreateThreadRequest Параметры создания нового потока. Если поток не указан при запуске
запрос, будет создан пустой поток.		 Нет
tool_choice OpenAI.AssistantsApiToolChoiceOption Определяет, какое средство (если таковое) вызывается моделью.
none означает, что модель не будет вызывать средства и вместо этого создает сообщение.
auto — это значение по умолчанию и означает, что модель может выбирать между созданием сообщения или вызовом одного или нескольких инструментов.
required означает, что модель должна вызывать один или несколько инструментов, прежде чем отвечать на запрос пользователя.
Указание определенного инструмента, например {"type": "file_search"} или {"type": "function", "function": {"name": "my_function"}} принудительное вызов модели.		 Нет
tool_resources OpenAI.CreateThreadAndRunRequestToolResources или null Набор ресурсов, используемых средствами помощника. Ресурсы относятся к типу инструмента. Например, для code_interpreter средства требуется список идентификаторов файлов, а для file_search этого средства требуется список идентификаторов векторного хранилища. Нет
Инструменты массив OpenAI.AssistantTool Переопределите средства, которые помощник может использовать для этого запуска. Это полезно для изменения поведения на основе каждого запуска. Нет
top_p число или null Альтернатива выборке с температурой, называемой выборкой ядра, где модель рассматривает результаты маркеров с top_p массой вероятности. Таким образом, 0,1 означает, что рассматриваются только маркеры, состоящие из 10 лучших% массы вероятностей.
Как правило, мы рекомендуем изменить это или температуру, но не оба.		 Нет
truncation_strategy OpenAI.TruncationObject Определяет, как поток будет усечен до выполнения. Используйте это для управления начальным окном контекста выполнения. Нет

OpenAI.CreateThreadAndRunRequestToolResources

Имя Тип Описание Обязательно По умолчанию
code_interpreter OpenAI.CreateThreadAndRunRequestToolResourcesCodeInterpreter Нет
file_search OpenAI.CreateThreadAndRunRequestToolResourcesFileSearch Нет

OpenAI.CreateThreadAndRunRequestToolResourcesCodeInterpreter

Имя Тип Описание Обязательно По умолчанию
file_ids массив строк Нет []

OpenAI.CreateThreadAndRunRequestToolResourcesFileSearch

Имя Тип Описание Обязательно По умолчанию
vector_store_ids массив строк Нет

OpenAI.CreateThreadRequest

Параметры создания нового потока. Если поток не указан при выполнении запроса, создается пустой поток.

Имя Тип Описание Обязательно По умолчанию
Сообщения массив OpenAI.CreateMessageRequest Список сообщений для запуска потока. Нет
Метаданных OpenAI.Metadata или NULL Нет
tool_resources OpenAI.CreateThreadRequestToolResources или null Нет

OpenAI.CreateThreadRequestToolResources

Имя Тип Описание Обязательно По умолчанию
code_interpreter OpenAI.CreateThreadRequestToolResourcesCodeInterpreter Нет
file_search объект или объект Нет

OpenAI.CreateThreadRequestToolResourcesCodeInterpreter

Имя Тип Описание Обязательно По умолчанию
file_ids массив строк Нет

OpenAI.CreateVectorStoreFileBatchRequest

Имя Тип Описание Обязательно По умолчанию
Атрибуты OpenAI.VectorStoreFileAttributes или null Нет
chunking_strategy OpenAI.ChunkingStrategyRequestParam Стратегия блокирования, используемая для блокирования файлов. Если этот параметр не задан, используйте стратегию auto . Применимо только в том случае, если file_ids он не пуст. Нет
file_ids массив строк Список идентификаторов файлов , которые следует использовать векторном хранилище. Полезно для таких средств, как file_search доступ к файлам. Если attributes или chunking_strategy предоставлено, они будут применены ко всем файлам в пакете. Взаимоисключающ с files. Нет
Файлы массив OpenAI.CreateVectorStoreFileRequest Список объектов, каждый из которых включает в себя file_id плюс необязательный attributes или chunking_strategy. Используйте это, когда необходимо переопределить метаданные для определенных файлов. Глобальный attributes или chunking_strategy будет игнорироваться и должен быть указан для каждого файла. Взаимоисключающ с file_ids. Нет

OpenAI.CreateVectorStoreFileRequest

Имя Тип Описание Обязательно По умолчанию
Атрибуты OpenAI.VectorStoreFileAttributes или null Нет
chunking_strategy OpenAI.ChunkingStrategyRequestParam Стратегия блокирования, используемая для блокирования файлов. Если этот параметр не задан, используйте стратегию auto . Применимо только в том случае, если file_ids он не пуст. Нет
file_id Строка Идентификатор файла , который должен использовать хранилище векторов. Полезно для таких средств, как file_search доступ к файлам. Да

OpenAI.CreateVectorStoreRequest

Имя Тип Описание Обязательно По умолчанию
chunking_strategy OpenAI.ChunkingStrategyRequestParam Стратегия блокирования, используемая для блокирования файлов. Если этот параметр не задан, используйте стратегию auto . Применимо только в том случае, если file_ids он не пуст. Нет
Описание Строка Описание хранилища векторов. Можно использовать для описания цели векторного хранилища. Нет
expires_after OpenAI.VectorStoreExpirationAfter Политика истечения срока действия для хранилища векторов. Нет
file_ids массив строк Список идентификаторов файлов , которые следует использовать векторном хранилище. Полезно для таких средств, как file_search доступ к файлам. Нет
Метаданных OpenAI.Metadata или NULL Нет
Имя Строка Имя векторного хранилища. Нет

OpenAI.CustomGrammarFormatParam

Грамматика, определяемая пользователем.

Имя Тип Описание Обязательно По умолчанию
Определение Строка Определение грамматики. Да
Синтаксис OpenAI.GrammarSyntax1 Да
Тип Перечисления Формат грамматики. Всегда grammar.
Возможные значения: grammar		 Да

OpenAI.CustomTextFormatParam

Без ограничений текст свободной формы.

Имя Тип Описание Обязательно По умолчанию
Тип Перечисления Неограниченный текстовый формат. Всегда text.
Возможные значения: text		 Да

OpenAI.CustomToolChatCompletions

Пользовательское средство, обрабатывающее входные данные с помощью указанного формата.

Имя Тип Описание Обязательно По умолчанию
Пользовательские OpenAI.CustomToolChatCompletionsCustom Да
Описание └️ Строка Нет
Формат └️ OpenAI.CustomToolChatCompletionsCustomFormatText или OpenAI.CustomToolChatCompletionsCustomFormatGrammar Нет
└️ имя Строка Да
Тип Перечисления Тип пользовательского средства. Всегда custom.
Возможные значения: custom		 Да

OpenAI.CustomToolChatCompletionsCustom

Имя Тип Описание Обязательно По умолчанию
Описание Строка Нет
Формат OpenAI.CustomToolChatCompletionsCustomFormatText или OpenAI.CustomToolChatCompletionsCustomFormatGrammar Нет
Имя Строка Да

OpenAI.CustomToolChatCompletionsCustomFormatGrammar

Имя Тип Описание Обязательно По умолчанию
Грамматики OpenAI.CustomToolChatCompletionsCustomFormatGrammarGrammar Да
Определение └️ Строка Да
Синтаксис └️ Перечисления
Возможные значения: lark, regex		 Да
Тип Перечисления
Возможные значения: grammar		 Да

OpenAI.CustomToolChatCompletionsCustomFormatGrammarGrammar

Имя Тип Описание Обязательно По умолчанию
Определение Строка Да
Синтаксис Перечисления
Возможные значения: lark, regex		 Да

OpenAI.CustomToolChatCompletionsCustomFormatText

Имя Тип Описание Обязательно По умолчанию
Тип Перечисления
Возможные значения: text		 Да

OpenAI.CustomToolParam

Пользовательское средство, обрабатывающее входные данные с помощью указанного формата. Дополнительные сведения о пользовательских средствах

Имя Тип Описание Обязательно По умолчанию
Описание Строка Необязательное описание пользовательского инструмента, используемого для предоставления дополнительного контекста. Нет
Формат OpenAI.CustomToolParamFormat Формат входных данных для пользовательского средства. Значение по умолчанию не ограничено текстом. Нет
Тип └️ OpenAI.CustomToolParamFormatType Да
Имя Строка Имя настраиваемого средства, используемого для идентификации его в вызовах инструментов. Да
Тип Перечисления Тип пользовательского средства. Всегда custom.
Возможные значения: custom		 Да

OpenAI.CustomToolParamFormat

Формат входных данных для пользовательского средства. Значение по умолчанию не ограничено текстом.

Дискриминация для OpenAI.CustomToolParamFormat

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа Схемы
text OpenAI.CustomTextFormatParam
grammar OpenAI.CustomGrammarFormatParam
Имя Тип Описание Обязательно По умолчанию
Тип OpenAI.CustomToolParamFormatType Да

OpenAI.CustomToolParamFormatType

Свойство Значение
Тип Строка
Значения text
grammar

OpenAI.DeleteFileResponse

Имя Тип Описание Обязательно По умолчанию
Удалены Логических Да
Id Строка Да
Объекта Перечисления
Возможные значения: file		 Да

OpenAI.DeleteFineTuningCheckpointPermissionResponse

Имя Тип Описание Обязательно По умолчанию
Удалены Логических Успешно ли удалено разрешение на контрольную точку для точной настройки модели. Да
Id Строка Идентификатор удаленного разрешения контрольной точки модели. Да
Объекта Перечисления Тип объекта, который всегда является "checkpoint.permission".
Возможные значения: checkpoint.permission		 Да

OpenAI.DeleteMessageResponse

Имя Тип Описание Обязательно По умолчанию
Удалены Логических Да
Id Строка Да
Объекта Перечисления
Возможные значения: thread.message.deleted		 Да

OpenAI.DeleteModelResponse

Имя Тип Описание Обязательно По умолчанию
Удалены Логических Да
Id Строка Да
Объекта Строка Да

OpenAI.DeleteThreadResponse

Имя Тип Описание Обязательно По умолчанию
Удалены Логических Да
Id Строка Да
Объекта Перечисления
Возможные значения: thread.deleted		 Да

OpenAI.DeleteVectorStoreFileResponse

Имя Тип Описание Обязательно По умолчанию
Удалены Логических Да
Id Строка Да
Объекта Перечисления
Возможные значения: vector_store.file.deleted		 Да

OpenAI.DeleteVectorStoreResponse

Имя Тип Описание Обязательно По умолчанию
Удалены Логических Да
Id Строка Да
Объекта Перечисления
Возможные значения: vector_store.deleted		 Да

OpenAI.DeletedConversationResource

Имя Тип Описание Обязательно По умолчанию
Удалены Логических Да
Id Строка Да
Объекта Перечисления
Возможные значения: conversation.deleted		 Да

OpenAI.DoubleClickAction

Действие двойного щелчка.

Имя Тип Описание Обязательно По умолчанию
Тип Перечисления Указывает тип события. Для действия двойного щелчка это свойство всегда имеет значение double_click.
Возможные значения: double_click		 Да
X Целое число Координата x, в которой произошло двойное щелчко. Да
Y Целое число Координата y, в которой произошло двойное щелчко. Да

OpenAI.Drag

Действие перетаскивания.

Имя Тип Описание Обязательно По умолчанию
Путь массив OpenAI.DragPoint Массив координат, представляющий путь действия перетаскивания. Координаты будут отображаться как массив
объектов, например
<br> [<br> { x: 100, y: 200 },<br> { x: 200, y: 300 }<br> ]<br> 		Да
Тип Перечисления Указывает тип события. Для действия перетаскивания это свойство имеет значение
всегда задано значение drag.
Возможные значения: drag		 Да

OpenAI.DragPoint

Пара координат x/y, например { x: 100, y: 200 }.

Имя Тип Описание Обязательно По умолчанию
X Целое число Координата x. Да
Y Целое число Координата y. Да

OpenAI.EasyInputMessage

Входные данные сообщения в модель с ролью, указывающей инструкцию ниже иерархии. Инструкции, заданные с developer ролью, system имеют приоритет над инструкциями, заданными с ролью user . Предполагается, что сообщения с assistant ролью создаются моделью в предыдущих взаимодействиях.

Имя Тип Описание Обязательно По умолчанию
Содержимого string или OpenAI.InputMessageContentList Текст, изображение или звуковой вход в модель, используемый для создания ответа.
Также может содержать предыдущие ответы помощника.		 Да
Роль Перечисления Роль входных данных сообщения. Одно из user, assistantили system
developer.
Возможные значения: user, , assistantsystemdeveloper		 Да
Тип Перечисления Тип входных данных сообщения. Всегда message.
Возможные значения: message		 Да

OpenAI.Embedding

Представляет вектор внедрения, возвращаемый путем внедрения конечной точки.

Имя Тип Описание Обязательно По умолчанию
Внедрение массив чисел Вектор внедрения, который является списком с плавающей запятой. Длина вектора зависит от модели, указанной в руководстве по внедрению. Да
Индекс Целое число Индекс внедрения в список внедрения. Да
Объекта Перечисления Тип объекта, который всегда является внедрением.
Возможные значения: embedding		 Да

OpenAI.Eval

Объект Eval с конфигурацией источника данных и критериями тестирования. Eval представляет задачу для интеграции LLM. Как:

  • Улучшение качества чат-бота
  • Узнайте, как хорошо мой чат-бот обрабатывает поддержку клиентов
  • Проверьте, лучше ли o4-mini в моем регистре использования, чем gpt-4o
Имя Тип Описание Обязательно По умолчанию
created_at Целое число Метка времени Unix (в секундах) для момента создания eval. Да
data_source_config OpenAI.EvalCustomDataSourceConfig или OpenAI.EvalLogsDataSourceConfig или OpenAI.EvalStoredCompletionsDataSourceConfig Настройка источников данных, используемых при выполнении оценки. Да
Id Строка Уникальный идентификатор для оценки. Да
Метаданных OpenAI.Metadata или NULL Да
Имя Строка Имя оценки. Да
Объекта Перечисления Тип объекта.
Возможные значения: eval		 Да
testing_criteria массив OpenAI.CreateEvalLabelModelGrader или OpenAI.EvalGraderStringCheck или OpenAI.EvalGraderTextSimilarity или OpenAI.EvalGraderPython или OpenAI.EvalGraderScoreModel или EvalGraderEndpoint Список критериев тестирования. Да

OpenAI.EvalApiError

Объект, представляющий ответ об ошибке из API Eval.

Имя Тип Описание Обязательно По умолчанию
Код Строка Код ошибки. Да
Сообщение Строка Сообщение об ошибке. Да

OpenAI.EvalCustomDataSourceConfig

CustomDataSourceConfig, указывающий схему ваших item и при необходимости sample пространств имен. Схема ответа определяет форму данных, которые будут:

  • Используется для определения критериев тестирования и
  • Какие данные требуются при создании запуска
Имя Тип Описание Обязательно По умолчанию
Схемы Объекта Схема JSON для элементов источника данных запуска.
Узнайте, как создать схемы JSON здесь.		 Да
Тип Перечисления Тип источника данных. Всегда custom.
Возможные значения: custom		 Да

OpenAI.EvalGraderPython

Имя Тип Описание Обязательно По умолчанию
image_tag Строка Тег изображения, используемый для скрипта Python. Нет
Имя Строка Имя классировщика. Да
pass_threshold Номер Пороговое значение для оценки. Нет
Источник Строка Исходный код скрипта Python. Да
Тип Перечисления Тип объекта, который всегда pythonявляется .
Возможные значения: python		 Да

OpenAI.EvalGraderScoreModel

Имя Тип Описание Обязательно По умолчанию
Вход массив OpenAI.EvalItem Входные сообщения, вычисляемые классировщиком. Поддерживает текстовые, выходные тексты, входные изображения и блоки звукового содержимого ввода и могут включать строки шаблона. Да
Модели Строка Модель, используемая для оценки. Да
Имя Строка Имя классировщика. Да
pass_threshold Номер Пороговое значение для оценки. Нет
Диапазон массив чисел Диапазон оценки. По умолчанию используется [0, 1]значение . Нет
sampling_params OpenAI.EvalGraderScoreModelSamplingParams Нет
└max_completions_tokens целое число или null Нет
└reasoning_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.		 Нет
Начальное значение └️ целое число или null Нет
Температура └️ число или null Нет
└️ top_p число или null Нет 1
Тип Перечисления Тип объекта, который всегда score_modelявляется .
Возможные значения: score_model		 Да

OpenAI.EvalGraderScoreModelSamplingParams

Имя Тип Описание Обязательно По умолчанию
max_completions_tokens целое число или null Нет
reasoning_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.		 Нет
Семян целое число или null Нет
Температура число или null Нет
top_p число или null Нет

OpenAI.EvalGraderStringCheck

Имя Тип Описание Обязательно По умолчанию
Вход Строка Входной текст. Это может включать строки шаблона. Да
Имя Строка Имя классировщика. Да
Операции Перечисления Выполняемая операция проверки строки. Один из eq, nelikeили ilike.
Возможные значения: eq, , nelikeilike		 Да
Ссылки Строка Текст ссылки. Это может включать строки шаблона. Да
Тип Перечисления Тип объекта, который всегда string_checkявляется .
Возможные значения: string_check		 Да

OpenAI.EvalGraderTextSimilarity

Имя Тип Описание Обязательно По умолчанию
evaluation_metric Перечисления Используемая метрика оценки. Один из cosine, fuzzy_matchbleu
gleu, meteor, rouge_1rouge_2rouge_3rouge_4rouge_5
или rouge_l.
Возможные значения: cosine, , fuzzy_matchbleugleumeteorrouge_1rouge_2rouge_3rouge_4rouge_5rouge_l		 Да
Вход Строка Текст, классируемый. Да
Имя Строка Имя классировщика. Да
pass_threshold Номер Пороговое значение для оценки. Да
Ссылки Строка Текст, классируемый против. Да
Тип Перечисления Тип классировщика.
Возможные значения: text_similarity		 Да

OpenAI.EvalItem

Входные данные сообщения в модель с ролью, указывающей инструкцию ниже иерархии. Инструкции, заданные с developer ролью, system имеют приоритет над инструкциями, заданными с ролью user . Предполагается, что сообщения с assistant ролью создаются моделью в предыдущих взаимодействиях.

Имя Тип Описание Обязательно По умолчанию
Содержимого OpenAI.EvalItemContent Входные данные в модель могут содержать строки шаблона. Поддерживает текст, выходной текст, входные изображения и входной звук как один элемент или массив элементов. Да
Роль Перечисления Роль входных данных сообщения. Одно из user, assistantили system
developer.
Возможные значения: user, , assistantsystemdeveloper		 Да
Тип Перечисления Тип входных данных сообщения. Всегда message.
Возможные значения: message		 Нет

OpenAI.EvalItemContent

Входные данные в модель могут содержать строки шаблона. Поддерживает текст, выходной текст, входные изображения и входной звук как один элемент или массив элементов.

Тип: OpenAI.EvalItemContentItem или OpenAI.EvalItemContentArray

Входные данные в модель могут содержать строки шаблона. Поддерживает текст, выходной текст, входные изображения и входной звук как один элемент или массив элементов.

OpenAI.EvalItemContentArray

Список входных данных, каждый из которых может быть входным текстом, выходным текстом, входным изображением или входным звуковым объектом.

Массив: OpenAI.EvalItemContentItem

OpenAI.EvalItemContentItem

Один элемент содержимого: входной текст, выходной текст, входной образ или входной звук.

Тип: OpenAI.EvalItemContentText или OpenAI.EvalItemContentItemObject

Один элемент содержимого: входной текст, выходной текст, входной образ или входной звук.

OpenAI.EvalItemContentItemObject

Один элемент содержимого: входной текст, выходной текст, входной образ или входной звук.

Дискриминация для OpenAI.EvalItemContentItemObject

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа Схемы
output_text OpenAI.EvalItemContentOutputText
input_image OpenAI.EvalItemInputImage
input_audio OpenAI.InputAudio
input_text OpenAI.EvalItemContentItemObjectInputTextContent
Имя Тип Описание Обязательно По умолчанию
Тип OpenAI.EvalItemContentItemObjectType Да

OpenAI.EvalItemContentItemObjectInputTextContent

Текстовые входные данные модели.

Имя Тип Описание Обязательно По умолчанию
Текст Строка Текстовые входные данные модели. Да
Тип Перечисления Тип входного элемента. Всегда input_text.
Возможные значения: input_text		 Да

OpenAI.EvalItemContentItemObjectType

Свойство Значение
Тип Строка
Значения input_text
output_text
input_image
input_audio

OpenAI.EvalItemContentOutputText

Текстовые выходные данные модели.

Имя Тип Описание Обязательно По умолчанию
Текст Строка Текстовые выходные данные модели. Да
Тип Перечисления Тип выходного текста. Всегда output_text.
Возможные значения: output_text		 Да

OpenAI.EvalItemContentText

Текстовые входные данные модели.

Тип: строка

OpenAI.EvalItemInputImage

Входной блок изображения, используемый в массивах содержимого EvalItem.

Имя Тип Описание Обязательно По умолчанию
Детали Строка Уровень детализации изображения, отправляемого в модель. Один из high, lowили auto. По умолчанию используется autoзначение . Нет
image_url Строка URL-адрес входных данных изображения. Да
Тип Перечисления Тип входных данных изображения. Всегда input_image.
Возможные значения: input_image		 Да

OpenAI.EvalJsonlFileContentSource

Имя Тип Описание Обязательно По умолчанию
Содержимого массив OpenAI.EvalJsonlFileContentSourceContent Содержимое jsonl-файла. Да
Тип Перечисления Тип источника jsonl. Всегда file_content.
Возможные значения: file_content		 Да

OpenAI.EvalJsonlFileContentSourceContent

Имя Тип Описание Обязательно По умолчанию
Элемента Объекта Да
Образец Объекта Нет

OpenAI.EvalJsonlFileIdSource

Имя Тип Описание Обязательно По умолчанию
Id Строка Идентификатор файла. Да
Тип Перечисления Тип источника jsonl. Всегда file_id.
Возможные значения: file_id		 Да

OpenAI.EvalList

Объект, представляющий список evals.

Имя Тип Описание Обязательно По умолчанию
Данных массив OpenAI.Eval Массив объектов eval. Да
first_id Строка Идентификатор первого eval в массиве данных. Да
has_more Логических Указывает, доступны ли более электронные вальы. Да
last_id Строка Идентификатор последнего eval в массиве данных. Да
Объекта Перечисления Тип этого объекта. Для него всегда задано значение list.
Возможные значения: list		 Да

OpenAI.EvalLogsDataSourceConfig

LogsDataSourceConfig, указывающий свойство метаданных запроса журналов. Обычно это метаданные, такие как usecase=chatbot или prompt-version=v2и т. д. Схема, возвращаемая этой конфигурацией источника данных, используется для определения переменных, доступных в ваших evals. item и sample определяются при использовании этой конфигурации источника данных.

Имя Тип Описание Обязательно По умолчанию
Метаданных OpenAI.Metadata или NULL Нет
Схемы Объекта Схема JSON для элементов источника данных запуска.
Узнайте, как создать схемы JSON здесь.		 Да
Тип Перечисления Тип источника данных. Всегда logs.
Возможные значения: logs		 Да

OpenAI.EvalResponsesSource

Объект EvalResponsesSource, описывающий конфигурацию источника данных запуска.

Имя Тип Описание Обязательно По умолчанию
created_after целое число или null Нет
created_before целое число или null Нет
instructions_search строка или null Нет
Метаданных объект или null Нет
Модели строка или null Нет
reasoning_effort OpenAI.ReasoningEffort или null Нет
Температура число или null Нет
Инструменты массив строк или null Нет
top_p число или null Нет
Тип Перечисления Тип источника данных запуска. Всегда responses.
Возможные значения: responses		 Да
Пользователей массив строк или null Нет

OpenAI.EvalRun

Схема, представляющая выполнение оценки.

Имя Тип Описание Обязательно По умолчанию
created_at Целое число Метка времени Unix (в секундах) при создании запуска оценки. Да
data_source OpenAI.CreateEvalJsonlRunDataSource или OpenAI.CreateEvalCompletionsRunDataSource или OpenAI.CreateEvalResponsesRunDataSource Сведения об источнике данных запуска. Да
Ошибка OpenAI.EvalApiError Объект, представляющий ответ об ошибке из API Eval. Да
eval_id Строка Идентификатор связанной оценки. Да
Id Строка Уникальный идентификатор для выполнения оценки. Да
Метаданных OpenAI.Metadata или NULL Да
Модели Строка Модель, которая оценивается, если применимо. Да
Имя Строка Имя запуска оценки. Да
Объекта Перечисления Тип объекта. Всегда "eval.run".
Возможные значения: eval.run		 Да
per_model_usage массив OpenAI.EvalRunPerModelUsage Статистика использования для каждой модели во время выполнения оценки. Да
per_testing_criteria_results массив OpenAI.EvalRunPerTestingCriteriaResults Результаты для каждого критерия тестирования, применяемые во время выполнения оценки. Да
report_url Строка URL-адрес отчета о выполнении отрисованной оценки на панели мониторинга пользовательского интерфейса. Да
result_counts OpenAI.EvalRunResultCounts Да
Ошибка └️ Целое число Да
Ошибка └️ Целое число Да
└️ передано Целое число Да
Всего └️ Целое число Да
Статус Строка Состояние выполнения оценки. Да

OpenAI.EvalRunList

Объект, представляющий список запусков для оценки.

Имя Тип Описание Обязательно По умолчанию
Данных массив OpenAI.EvalRun Массив объектов запуска eval. Да
first_id Строка Идентификатор первого eval запуска в массиве данных. Да
has_more Логических Указывает, доступны ли более электронные вальы. Да
last_id Строка Идентификатор последнего eval запуска в массиве данных. Да
Объекта Перечисления Тип этого объекта. Для него всегда задано значение list.
Возможные значения: list		 Да

OpenAI.EvalRunOutputItem

Схема, представляющая выходной элемент запуска оценки.

Имя Тип Описание Обязательно По умолчанию
created_at Целое число Метка времени Unix (в секундах) при создании запуска оценки. Да
datasource_item Объекта Сведения об элементе источника входных данных. Да
datasource_item_id Целое число Идентификатор элемента источника данных. Да
eval_id Строка Идентификатор группы оценки. Да
Id Строка Уникальный идентификатор выходного элемента выполнения оценки. Да
Объекта Перечисления Тип объекта. Всегда "eval.run.output_item".
Возможные значения: eval.run.output_item		 Да
Результаты массив OpenAI.EvalRunOutputItemResult Список результатов оценки для этого выходного элемента. Да
run_id Строка Идентификатор выполнения оценки, связанного с этим выходным элементом. Да
Образец OpenAI.EvalRunOutputItemSample Да
Ошибка └️ OpenAI.EvalApiError Объект, представляющий ответ об ошибке из API Eval. Да
└️ finish_reason Строка Да
Входные данные └️ массив OpenAI.EvalRunOutputItemSampleInput Да
└max_completion_tokens Целое число Да
Модель └️ Строка Да
Выходные данные └️ массив OpenAI.EvalRunOutputItemSampleOutputOutput Да
Начальное значение └️ Целое число Да
Температура └️ Номер Да
└️ top_p Номер Да
Использование └️ OpenAI.EvalRunOutputItemSampleUsage Да
Статус Строка Состояние выполнения оценки. Да

OpenAI.EvalRunOutputItemList

Объект, представляющий список выходных элементов для выполнения оценки.

Имя Тип Описание Обязательно По умолчанию
Данных массив OpenAI.EvalRunOutputItem Массив объектов выходного элемента eval. Да
first_id Строка Идентификатор первого выходного элемента eval в массиве данных. Да
has_more Логических Указывает, доступны ли более электронные элементы выполнения выходных элементов. Да
last_id Строка Идентификатор последнего выходного элемента eval в массиве данных. Да
Объекта Перечисления Тип этого объекта. Для него всегда задано значение list.
Возможные значения: list		 Да

OpenAI.EvalRunOutputItemResult

Результат одного класса для выходного элемента выполнения оценки.

Имя Тип Описание Обязательно По умолчанию
Имя Строка Имя классировщика. Да
Прошло Логических Считается ли классировщик выходным результатом прохода. Да
Образец объект или null Необязательный пример или промежуточные данные, созданные классировщиком. Нет
Оценка по Номер Числовая оценка, созданная классировщиком. Да
Тип Строка Тип оценок (например, string-check-grader). Нет

OpenAI.EvalRunOutputItemSample

Имя Тип Описание Обязательно По умолчанию
Ошибка OpenAI.EvalApiError Объект, представляющий ответ об ошибке из API Eval. Да
finish_reason Строка Да
Вход массив OpenAI.EvalRunOutputItemSampleInput Да
max_completion_tokens Целое число Да
Модели Строка Да
Выход массив OpenAI.EvalRunOutputItemSampleOutputOutput Да
Семян Целое число Да
Температура Номер Да
top_p Номер Да
Использования OpenAI.EvalRunOutputItemSampleUsage Да

OpenAI.EvalRunOutputItemSampleInput

Имя Тип Описание Обязательно По умолчанию
Содержимого Строка Да
Роль Строка Да

OpenAI.EvalRunOutputItemSampleOutput

Имя Тип Описание Обязательно По умолчанию
Содержимого Строка Нет
Роль Строка Нет

OpenAI.EvalRunOutputItemSampleUsage

Имя Тип Описание Обязательно По умолчанию
cached_tokens Целое число Да
completion_tokens Целое число Да
prompt_tokens Целое число Да
total_tokens Целое число Да

OpenAI.EvalRunPerModelUsage

Имя Тип Описание Обязательно По умолчанию
cached_tokens Целое число Да
completion_tokens Целое число Да
invocation_count Целое число Да
model_name Строка Да
prompt_tokens Целое число Да
total_tokens Целое число Да

OpenAI.EvalRunPerTestingCriteriaResults

Имя Тип Описание Обязательно По умолчанию
Сбой при Целое число Да
Прошло Целое число Да
testing_criteria Строка Да

OpenAI.EvalRunResultCounts

Имя Тип Описание Обязательно По умолчанию
Ошибка Целое число Да
Сбой при Целое число Да
Прошло Целое число Да
Общая Целое число Да

OpenAI.EvalStoredCompletionsDataSourceConfig

Не рекомендуется использовать LogsDataSourceConfig.

Имя Тип Описание Обязательно По умолчанию
Метаданных OpenAI.Metadata или NULL Нет
Схемы Объекта Схема JSON для элементов источника данных запуска.
Узнайте, как создать схемы JSON здесь.		 Да
Тип Перечисления Тип источника данных. Всегда stored_completions.
Возможные значения: stored_completions		 Да

OpenAI.EvalStoredCompletionsSource

Конфигурация StoredCompletionsRunDataSource, описывающая набор фильтров

Имя Тип Описание Обязательно По умолчанию
created_after целое число или null Нет
created_before целое число или null Нет
Предел целое число или null Нет
Метаданных OpenAI.Metadata или NULL Нет
Модели строка или null Нет
Тип Перечисления Тип источника. Всегда stored_completions.
Возможные значения: stored_completions		 Да

OpenAI.FileCitationBody

Ссылка на файл.

Имя Тип Описание Обязательно По умолчанию
file_id Строка Идентификатор файла. Да
Имени файла Строка Имя файла, на который ссылается файл. Да
Индекс Целое число Индекс файла в списке файлов. Да
Тип Перечисления Тип ссылки на файл. Всегда file_citation.
Возможные значения: file_citation		 Да

OpenAI.FilePath

Путь к файлу.

Имя Тип Описание Обязательно По умолчанию
file_id Строка Идентификатор файла. Да
Индекс Целое число Индекс файла в списке файлов. Да
Тип Перечисления Тип пути к файлу. Всегда file_path.
Возможные значения: file_path		 Да

OpenAI.FileSearchRanker

Рангер, используемый для поиска файлов. Если не указано, будет использоваться auto рангер.

Свойство Значение
Тип Строка
Значения auto
default_2024_08_21

OpenAI.FileSearchRankingOptions

Параметры ранжирования для поиска файлов. Если не указано, средство поиска файлов будет использовать auto рангер и score_threshold 0. Дополнительные сведения см. в документации по средству поиска файлов .

Имя Тип Описание Обязательно По умолчанию
рангер OpenAI.FileSearchRanker Рангер, используемый для поиска файлов. Если не указано, будет использоваться auto рангер. Нет
score_threshold Номер Пороговая оценка для поиска файлов. Все значения должны быть числом с плавающей запятой от 0 до 1.
Ограничения: min: 0, max: 1		 Да

OpenAI.FileSearchTool

Средство, которое ищет соответствующее содержимое из отправленных файлов.

Имя Тип Описание Обязательно По умолчанию
Фильтры OpenAI.Filters или NULL Нет
max_num_results Целое число Максимальное количество возвращаемых результатов. Это число должно быть от 1 до 50 включительно. Нет
ranking_options OpenAI.RankingOptions Нет
└️ hybrid_search OpenAI.HybridSearchOptions Весы, которые управляют тем, как взаимное слияние рангов балансирует семантику внедрения совпадений и разреженных ключевых слов при включенном гибридном поиске. Нет
Рангер └️ OpenAI.RankerVersionType Рангер, используемый для поиска файлов. Нет
└score_threshold Номер Пороговое значение оценки для поиска файлов — от 0 до 1. Числа ближе к 1 будут пытаться вернуть только наиболее релевантные результаты, но могут возвращать меньше результатов. Нет
Тип Перечисления Тип средства поиска файлов. Всегда file_search.
Возможные значения: file_search		 Да
vector_store_ids массив строк Идентификаторы векторных хранилищ для поиска. Да

OpenAI.FileSearchToolCallResults

Имя Тип Описание Обязательно По умолчанию
Атрибуты OpenAI.VectorStoreFileAttributes или null Нет
file_id Строка Нет
Имени файла Строка Нет
Оценка по Номер Нет
Текст Строка Нет

OpenAI.Filters

Тип: OpenAI.ComparisonFilter или OpenAI.CompoundFilter

OpenAI.FineTuneDPOHyperparameters

Гиперпараметры, используемые для задания точной настройки DPO.

Имя Тип Описание Обязательно По умолчанию
batch_size строка или целое число Количество примеров в каждом пакете. Более крупный размер пакета означает, что параметры модели обновляются реже, но с более низкой дисперсией. Нет
Бета-версия строка или число Бета-значение для метода DPO. Более высокое бета-значение увеличит вес штрафа между политикой и эталонной моделью. Нет
learning_rate_multiplier строка или число Коэффициент масштабирования для скорости обучения. Меньшая скорость обучения может оказаться полезной, чтобы избежать переполнения. Нет
n_epochs строка или целое число Количество эпох для обучения модели. Эпоха относится к одному полному циклу через обучающий набор данных. Нет

OpenAI.FineTuneDPOMethod

Конфигурация для метода точной настройки DPO.

Имя Тип Описание Обязательно По умолчанию
гиперпараметры OpenAI.FineTuneDPOHyperparameters Гиперпараметры, используемые для задания точной настройки DPO. Нет

OpenAI.FineTuneMethod

Метод, используемый для точной настройки.

Имя Тип Описание Обязательно По умолчанию
Dpo OpenAI.FineTuneDPOMethod Конфигурация для метода точной настройки DPO. Нет
Арматуры AzureFineTuneReinforcementMethod Нет
Контролируется OpenAI.FineTuneSupervisedMethod Настройка защищенного метода тонкой настройки. Нет
Тип Перечисления Тип метода. supervisedЛибо , dpoлибо reinforcement.
Возможные значения: supervised, dporeinforcement		 Да

OpenAI.FineTuneReinforcementHyperparameters

Гиперпараметры, используемые для задания точной настройки с подкреплением.

Имя Тип Описание Обязательно По умолчанию
batch_size строка или целое число Количество примеров в каждом пакете. Более крупный размер пакета означает, что параметры модели обновляются реже, но с более низкой дисперсией. Нет
compute_multiplier строка или число Умножитель на объем вычислительных ресурсов, используемых для изучения пространства поиска во время обучения. Нет
eval_interval строка или целое число Количество шагов обучения между запусками оценки. Нет
eval_samples строка или целое число Количество примеров оценки для каждого шага обучения. Нет
learning_rate_multiplier строка или число Коэффициент масштабирования для скорости обучения. Меньшая скорость обучения может оказаться полезной, чтобы избежать переполнения. Нет
n_epochs строка или целое число Количество эпох для обучения модели. Эпоха относится к одному полному циклу через обучающий набор данных. Нет
reasoning_effort Перечисления Уровень усилий по рассуждениям.
Возможные значения: default, , lowmediumhigh		 Нет

OpenAI.FineTuneSupervisedHyperparameters

Гиперпараметры, используемые для задания тонкой настройки.

Имя Тип Описание Обязательно По умолчанию
batch_size строка или целое число Количество примеров в каждом пакете. Более крупный размер пакета означает, что параметры модели обновляются реже, но с более низкой дисперсией. Нет
learning_rate_multiplier строка или число Коэффициент масштабирования для скорости обучения. Меньшая скорость обучения может оказаться полезной, чтобы избежать переполнения. Нет
n_epochs строка или целое число Количество эпох для обучения модели. Эпоха относится к одному полному циклу через обучающий набор данных. Нет

OpenAI.FineTuneSupervisedMethod

Настройка защищенного метода тонкой настройки.

Имя Тип Описание Обязательно По умолчанию
гиперпараметры OpenAI.FineTuneSupervisedHyperparameters Гиперпараметры, используемые для задания тонкой настройки. Нет

OpenAI.FineTuningCheckpointPermission

Объект checkpoint.permission представляет разрешение для точно настроенной контрольной точки модели.

Имя Тип Описание Обязательно По умолчанию
created_at Целое число Метка времени Unix (в секундах) для момента создания разрешения. Да
Id Строка Идентификатор разрешения, на который можно ссылаться в конечных точках API. Да
Объекта Перечисления Тип объекта, который всегда является "checkpoint.permission".
Возможные значения: checkpoint.permission		 Да
project_id Строка Идентификатор проекта, для которому предназначено разрешение. Да

OpenAI.FineTuningIntegration

Имя Тип Описание Обязательно По умолчанию
Тип Перечисления Тип интеграции, включенной для задания тонкой настройки
Возможные значения: wandb		 Да
wandb OpenAI.FineTuningIntegrationWandb Да
Сущность └️ строка или null Нет
└️ имя строка или null Нет
Проект └️ Строка Да
Теги └️ массив строк Нет

OpenAI.FineTuningIntegrationWandb

Имя Тип Описание Обязательно По умолчанию
Сущности строка или null Нет
Имя строка или null Нет
Проекта Строка Да
Теги массив строк Нет

OpenAI.FineTuningJob

Объект fine_tuning.job представляет задание тонкой настройки, созданное с помощью API.

Имя Тип Описание Обязательно По умолчанию
created_at Целое число Метка времени Unix (в секундах) для создания задания тонкой настройки. Да
Ошибка OpenAI.FineTuningJobError или null Да
estimated_finish строка или null Нет
fine_tuned_model строка или null Да
finished_at строка или null Да
гиперпараметры OpenAI.FineTuningJobHyperparameters Да
└batch_size строка или целое число или null Нет Авто
└learning_rate_multiplier learning_rate_multiplier строка или число Нет
└️ n_epochs строка или целое число Нет Авто
Id Строка Идентификатор объекта, на который можно ссылаться в конечных точках API. Да
Интеграции массив OpenAI.FineTuningIntegration или null Нет
Метаданных OpenAI.Metadata или NULL Нет
Метод OpenAI.FineTuneMethod Метод, используемый для точной настройки. Нет
Модели Строка Базовая модель, которая настраивается. Да
Объекта Перечисления Тип объекта, который всегда является "fine_tuning.job".
Возможные значения: fine_tuning.job		 Да
organization_id Строка Организация, которая владеет заданием тонкой настройки. Да
result_files массив строк Скомпилированные идентификаторы файлов результатов для задания тонкой настройки. Результаты можно получить с помощью API файлов. Да
Семян Целое число Начальное значение, используемое для задания тонкой настройки. Да
Статус Перечисления Текущее состояние задания тонкой настройки, которое может быть validating_filesлибо , , queued, runningsucceededfailedcancelledлибо .
Возможные значения: validating_files, , queuedrunningsucceeded, failedcancelled		 Да
trained_tokens целое число или null Да
training_file Строка Идентификатор файла, используемый для обучения. Вы можете получить обучающие данные с помощью API файлов. Да
validation_file строка или null Да

OpenAI.FineTuningJobCheckpoint

Объект fine_tuning.job.checkpoint представляет контрольную точку модели для задания тонкой настройки, готового к использованию.

Имя Тип Описание Обязательно По умолчанию
created_at Целое число Метка времени Unix (в секундах) для момента создания контрольной точки. Да
fine_tuned_model_checkpoint Строка Имя созданной модели точно настроенной контрольной точки. Да
fine_tuning_job_id Строка Имя задания тонкой настройки, из которому была создана эта контрольная точка. Да
Id Строка Идентификатор контрольной точки, на который можно ссылаться в конечных точках API. Да
Метрики OpenAI.FineTuningJobCheckpointMetrics Да
└️ full_valid_loss Номер Нет
└full_valid_mean_token_accuracy Номер Нет
Шаг └️ Номер Нет
└train_loss Номер Нет
└train_mean_token_accuracy Номер Нет
└️ valid_loss Номер Нет
└valid_mean_token_accuracy valid_mean_token_accuracy Номер Нет
Объекта Перечисления Тип объекта, который всегда является "fine_tuning.job.checkpoint".
Возможные значения: fine_tuning.job.checkpoint		 Да
step_number Целое число Номер шага, на который была создана контрольная точка. Да

OpenAI.FineTuningJobCheckpointMetrics

Имя Тип Описание Обязательно По умолчанию
full_valid_loss Номер Нет
full_valid_mean_token_accuracy Номер Нет
Шаг Номер Нет
train_loss Номер Нет
train_mean_token_accuracy Номер Нет
valid_loss Номер Нет
valid_mean_token_accuracy Номер Нет

OpenAI.FineTuningJobError

Имя Тип Описание Обязательно По умолчанию
Код Строка Да
Сообщение Строка Да
Param строка или null Да

OpenAI.FineTuningJobEvent

Объект события задания точной настройки

Имя Тип Описание Обязательно По умолчанию
created_at Целое число Метка времени Unix (в секундах) для создания задания тонкой настройки. Да
Данных OpenAI.FineTuningJobEventData Нет
Id Строка Идентификатор объекта. Да
Уровень Перечисления Уровень журнала события.
Возможные значения: info, warnerror		 Да
Сообщение Строка Сообщение события. Да
Объекта Перечисления Тип объекта, который всегда является "fine_tuning.job.event".
Возможные значения: fine_tuning.job.event		 Да
Тип Перечисления Тип события.
Возможные значения: message, metrics		 Нет

OpenAI.FineTuningJobEventData

Тип: объект

OpenAI.FineTuningJobHyperparameters

Имя Тип Описание Обязательно По умолчанию
batch_size строка или целое число или null Нет
learning_rate_multiplier строка или число Нет
n_epochs строка или целое число Нет

OpenAI.FunctionAndCustomToolCallOutput

Дискриминация для OpenAI.FunctionAndCustomToolCallOutput

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа Схемы
input_text OpenAI.FunctionAndCustomToolCallOutputInputTextContent
input_image OpenAI.FunctionAndCustomToolCallOutputInputImageContent
input_file OpenAI.FunctionAndCustomToolCallOutputInputFileContent
Имя Тип Описание Обязательно По умолчанию
Тип OpenAI.FunctionAndCustomToolCallOutputType Да

OpenAI.FunctionAndCustomToolCallOutputInputFileContent

Входные данные файла в модель.

Имя Тип Описание Обязательно По умолчанию
file_data Строка Содержимое файла, отправляемого в модель. Нет
file_id строка или null Нет
file_url Строка URL-адрес файла, отправляемого в модель. Нет
Имени файла Строка Имя файла, отправляемого в модель. Нет
Тип Перечисления Тип входного элемента. Всегда input_file.
Возможные значения: input_file		 Да

OpenAI.FunctionAndCustomToolCallOutputInputImageContent

Входные данные изображения для модели. Узнайте о входных данных изображения.

Имя Тип Описание Обязательно По умолчанию
Детали OpenAI.ImageDetail Да
file_id строка или null Нет
image_url строка или null Нет
Тип Перечисления Тип входного элемента. Всегда input_image.
Возможные значения: input_image		 Да

OpenAI.FunctionAndCustomToolCallOutputInputTextContent

Текстовые входные данные модели.

Имя Тип Описание Обязательно По умолчанию
Текст Строка Текстовые входные данные модели. Да
Тип Перечисления Тип входного элемента. Всегда input_text.
Возможные значения: input_text		 Да

OpenAI.FunctionAndCustomToolCallOutputType

Свойство Значение
Тип Строка
Значения input_text
input_image
input_file

OpenAI.FunctionObject

Имя Тип Описание Обязательно По умолчанию
Описание Строка Описание того, что выполняет функция, используемая моделью для выбора времени и способа вызова функции. Нет
Имя Строка Имя вызываемой функции. Должен быть a-z, A-Z, 0-9 или содержать символы подчеркивания и дефисы с максимальной длиной 64. Да
Параметры OpenAI.FunctionParameters Параметры, которые принимают функции, описаны как объект схемы JSON. Примеры см. в руководстве и справочнике по схеме JSON для документации по формату.
Опущение parameters определяет функцию с пустым списком параметров.		 Нет
Строгий логический или null Нет

OpenAI.FunctionParameters

Параметры, которые принимают функции, описаны как объект схемы JSON. Примеры см. в руководстве и справочнике по схеме JSON для документации по формату. Опущение parameters определяет функцию с пустым списком параметров.

Тип: объект

OpenAI.FunctionShellAction

Выполните команду оболочки.

Имя Тип Описание Обязательно По умолчанию
Команды массив строк Да
max_output_length целое число или null Да
timeout_ms целое число или null Да

OpenAI.FunctionShellCallOutputContent

Содержимое выходных данных вызова средства оболочки, которое было создано.

Имя Тип Описание Обязательно По умолчанию
created_by Строка Идентификатор субъекта, создавшего элемент. Нет
Результат OpenAI.FunctionShellCallOutputOutcome Представляет результат выхода (с кодом выхода) или результат ожидания для блока вывода вызова оболочки. Да
Тип └️ OpenAI.FunctionShellCallOutputOutcomeType Да
Stderr Строка Стандартные выходные данные ошибок, которые были записаны. Да
Stdout Строка Стандартные выходные данные, которые были записаны. Да

OpenAI.FunctionShellCallOutputExitOutcome

Указывает, что команды оболочки завершены и возвращен код выхода.

Имя Тип Описание Обязательно По умолчанию
exit_code Целое число Выход из процесса оболочки. Да
Тип Перечисления Тип результата. Всегда exit.
Возможные значения: exit		 Да

OpenAI.FunctionShellCallOutputOutcome

Представляет результат выхода (с кодом выхода) или результат ожидания для блока вывода вызова оболочки.

Дискриминация для OpenAI.FunctionShellCallOutputOutcome

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа Схемы
timeout OpenAI.FunctionShellCallOutputTimeoutOutcome
exit OpenAI.FunctionShellCallOutputExitOutcome
Имя Тип Описание Обязательно По умолчанию
Тип OpenAI.FunctionShellCallOutputOutcomeType Да

OpenAI.FunctionShellCallOutputOutcomeType

Свойство Значение
Тип Строка
Значения timeout
exit

OpenAI.FunctionShellCallOutputTimeoutOutcome

Указывает, что вызов оболочки превысил настроенное ограничение времени.

Имя Тип Описание Обязательно По умолчанию
Тип Перечисления Тип результата. Всегда timeout.
Возможные значения: timeout		 Да

OpenAI.FunctionShellToolParam

Средство, позволяющее модели выполнять команды оболочки.

Имя Тип Описание Обязательно По умолчанию
Тип Перечисления Тип средства оболочки. Всегда shell.
Возможные значения: shell		 Да

OpenAI.FunctionTool

Определяет функцию в собственном коде, которую модель может вызвать.

Имя Тип Описание Обязательно По умолчанию
Описание строка или null Нет
Имя Строка Имя вызываемой функции. Да
Параметры объект или null Да
Строгий логический или null Да
Тип Перечисления Тип средства функции. Всегда function.
Возможные значения: function		 Да

OpenAI.GraderMulti

Объект MultiGrader объединяет выходные данные нескольких классировщиков для создания одной оценки.

Имя Тип Описание Обязательно По умолчанию
calculate_output Строка Формула для вычисления выходных данных на основе результатов оценки. Да
Грейдеры OpenAI.GraderStringCheck или OpenAI.GraderTextSimilarity или OpenAI.GraderScoreModel или GraderEndpoint Да
Имя Строка Имя классировщика. Да
Тип Перечисления Тип объекта, который всегда multiявляется .
Возможные значения: multi		 Да

OpenAI.GraderPython

Объект PythonGrader, который запускает скрипт Python на входных данных.

Имя Тип Описание Обязательно По умолчанию
image_tag Строка Тег изображения, используемый для скрипта Python. Нет
Имя Строка Имя классировщика. Да
Источник Строка Исходный код скрипта Python. Да
Тип Перечисления Тип объекта, который всегда pythonявляется .
Возможные значения: python		 Да

OpenAI.GraderScoreModel

Объект ScoreModelGrader, использующий модель для назначения оценки входным данным.

Имя Тип Описание Обязательно По умолчанию
Вход массив OpenAI.EvalItem Входные сообщения, вычисляемые классировщиком. Поддерживает текстовые, выходные тексты, входные изображения и блоки звукового содержимого ввода и могут включать строки шаблона. Да
Модели Строка Модель, используемая для оценки. Да
Имя Строка Имя классировщика. Да
Диапазон массив чисел Диапазон оценки. По умолчанию используется [0, 1]значение . Нет
sampling_params OpenAI.EvalGraderScoreModelSamplingParams Нет
└max_completions_tokens целое число или null Нет
└reasoning_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.		 Нет
Начальное значение └️ целое число или null Нет
Температура └️ число или null Нет
└️ top_p число или null Нет 1
Тип Перечисления Тип объекта, который всегда score_modelявляется .
Возможные значения: score_model		 Да

OpenAI.GraderStringCheck

Объект StringCheckGrader, выполняющий сравнение строк между входами и ссылкой с помощью указанной операции.

Имя Тип Описание Обязательно По умолчанию
Вход Строка Входной текст. Это может включать строки шаблона. Да
Имя Строка Имя классировщика. Да
Операции Перечисления Выполняемая операция проверки строки. Один из eq, nelikeили ilike.
Возможные значения: eq, , nelikeilike		 Да
Ссылки Строка Текст ссылки. Это может включать строки шаблона. Да
Тип Перечисления Тип объекта, который всегда string_checkявляется .
Возможные значения: string_check		 Да

OpenAI.GraderTextSimilarity

Объект TextSimilarityGrader, который классирует текст на основе метрик сходства.

Имя Тип Описание Обязательно По умолчанию
evaluation_metric Перечисления Используемая метрика оценки. Один из cosine, fuzzy_matchbleu
gleu, meteor, rouge_1rouge_2rouge_3rouge_4rouge_5
или rouge_l.
Возможные значения: cosine, , fuzzy_matchbleugleumeteorrouge_1rouge_2rouge_3rouge_4rouge_5rouge_l		 Да
Вход Строка Текст, классируемый. Да
Имя Строка Имя классировщика. Да
Ссылки Строка Текст, классируемый против. Да
Тип Перечисления Тип классировщика.
Возможные значения: text_similarity		 Да

OpenAI.GrammarSyntax1

Свойство Значение
Тип Строка
Значения lark
regex

OpenAI.HybridSearchOptions

Имя Тип Описание Обязательно По умолчанию
embedding_weight Номер Вес внедрения в взаимное ранжирование слияние. Да
text_weight Номер Вес текста в взаимном ранжировании слиянием. Да

OpenAI.ImageDetail

Свойство Значение
Тип Строка
Значения low
high
auto

OpenAI.ImageGenTool

Средство, которое создает изображения с помощью моделей изображений GPT.

Допустимые модели:

gpt-image-1
gpt-image-1-mini
gpt-image-2
Имя Тип Описание Обязательно По умолчанию
Фон Перечисления Тип фона для созданного изображения. Один из transparent,
opaque, или auto. По умолчанию: auto.
Возможные значения: transparent, opaqueauto		 Нет
input_fidelity OpenAI.InputFidelity или null Нет
input_image_mask OpenAI.ImageGenToolInputImageMask Нет
└file_id Строка Нет
└image_url Строка Нет
Модели строка (см. допустимые модели ниже) Нет
Умеренности Перечисления Уровень модерации для созданного образа. По умолчанию: auto.
Возможные значения: auto, low		 Нет
output_compression Целое число Уровень сжатия для выходного изображения. Значение по умолчанию: 100.
Ограничения: min: 0, max: 100		 Нет 100
output_format Перечисления Формат выходных данных созданного изображения. Один из png, webpили
jpeg. По умолчанию: png.
Возможные значения: png, webpjpeg		 Нет
partial_images Целое число Количество частичных образов для создания в режиме потоковой передачи от 0 (значение по умолчанию) до 3.
Ограничения: min: 0, max: 3		 Нет
Качество Перечисления Качество созданного изображения. Один из low, mediumhigh
или auto. По умолчанию: auto.
Возможные значения: low, , mediumhighauto		 Нет
Размер Перечисления Размер созданного изображения. Один из 1024x1024, 1024x1536
1536x1024, или auto. По умолчанию: auto.
Возможные значения: 1024x1024, , 1024x15361536x1024auto		 Нет
Тип Перечисления Тип средства создания изображений. Всегда image_generation.
Возможные значения: image_generation		 Да

OpenAI.ImageGenToolInputImageMask

Имя Тип Описание Обязательно По умолчанию
file_id Строка Нет
image_url Строка Нет

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или когда организация зарегистрирована в программе хранения данных нулевого значения).
Свойство Значение
Описание Укажите дополнительные выходные данные для включения в ответ модели. В настоящее время поддерживаются следующие значения:
  • 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 |

OpenAI.InputAudio

Входные данные звука для модели.

Имя Тип Описание Обязательно По умолчанию
input_audio OpenAI.InputAudioInputAudioAudio Да
Тип Перечисления Тип входного элемента. Всегда input_audio.
Возможные значения: input_audio		 Да

OpenAI.InputAudioInputAudioAudio

Имя Тип Описание Обязательно По умолчанию
Данных Строка Да
Формат Перечисления
Возможные значения: mp3, wav		 Да

OpenAI.InputContent

Дискриминация для OpenAI.InputContent

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа Схемы
input_text OpenAI.InputContentInputTextContent
input_image OpenAI.InputContentInputImageContent
input_file OpenAI.InputContentInputFileContent
Имя Тип Описание Обязательно По умолчанию
Тип OpenAI.InputContentType Да

OpenAI.InputContentInputFileContent

Входные данные файла в модель.

Имя Тип Описание Обязательно По умолчанию
file_data Строка Содержимое файла, отправляемого в модель. Нет
file_id строка или null Нет
file_url Строка URL-адрес файла, отправляемого в модель. Нет
Имени файла Строка Имя файла, отправляемого в модель. Нет
Тип Перечисления Тип входного элемента. Всегда input_file.
Возможные значения: input_file		 Да

OpenAI.InputContentInputImageContent

Входные данные изображения для модели. Узнайте о входных данных изображения.

Имя Тип Описание Обязательно По умолчанию
Детали OpenAI.ImageDetail Да
file_id строка или null Нет
image_url строка или null Нет
Тип Перечисления Тип входного элемента. Всегда input_image.
Возможные значения: input_image		 Да

OpenAI.InputContentInputTextContent

Текстовые входные данные модели.

Имя Тип Описание Обязательно По умолчанию
Текст Строка Текстовые входные данные модели. Да
Тип Перечисления Тип входного элемента. Всегда input_text.
Возможные значения: input_text		 Да

OpenAI.InputContentType

Свойство Значение
Тип Строка
Значения input_text
input_image
input_file

OpenAI.InputFidelity

Контроль того, сколько усилий модель будет оказывать, чтобы соответствовать стилю и функциям, особенно признакам лица, входным изображениям. Этот параметр поддерживается только для gpt-image-1 и gpt-image-2. Неподдерживаемый для gpt-image-1-mini. Поддерживает high и low. По умолчанию используется lowзначение .

Свойство Значение
Тип Строка
Значения high
low

OpenAI.InputFileContent

Входные данные файла в модель.

Имя Тип Описание Обязательно По умолчанию
file_data Строка Содержимое файла, отправляемого в модель. Нет
file_id строка или null Нет
file_url Строка URL-адрес файла, отправляемого в модель. Нет
Имени файла Строка Имя файла, отправляемого в модель. Нет
Тип Перечисления Тип входного элемента. Всегда input_file.
Возможные значения: input_file		 Да

OpenAI.InputImageContent

Входные данные изображения для модели. Узнайте о входных данных изображения.

Имя Тип Описание Обязательно По умолчанию
Детали OpenAI.ImageDetail Да
file_id строка или null Нет
image_url строка или null Нет
Тип Перечисления Тип входного элемента. Всегда input_image.
Возможные значения: input_image		 Да

OpenAI.InputItem

Дискриминация для OpenAI.InputItem

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа Схемы
message OpenAI.EasyInputMessage
item_reference OpenAI.ItemReferenceParam
Имя Тип Описание Обязательно По умолчанию
Тип OpenAI.InputItemType Да

OpenAI.InputItemType

Свойство Значение
Тип Строка
Значения message
item_reference

OpenAI.InputMessageContentList

Список одного или нескольких входных элементов модели, содержащий различные типы контента.

Массив: OpenAI.InputContent

OpenAI.InputMessageResource

Имя Тип Описание Обязательно По умолчанию
Содержимого OpenAI.InputMessageContentList Список одного или нескольких входных элементов модели, содержащий другое содержимое.
Типы.		 Да
Id Строка Уникальный идентификатор входных данных сообщения. Да
Роль Перечисления Роль входных данных сообщения. Один из user, systemили developer.
Возможные значения: user, systemdeveloper		 Да
Статус Перечисления Состояние элемента. Один из in_progress, completedили
incomplete. Заполняется, когда элементы возвращаются через API.
Возможные значения: in_progress, completedincomplete		 Нет
Тип Перечисления Тип входных данных сообщения. Всегда задано значение message.
Возможные значения: message		 Да

OpenAI.InputParam

Текстовые, изображения или входные данные файлов в модель, используемые для создания ответа. Подробнее:

Тип: строка или массив OpenAI.InputItem

Текстовые, изображения или входные данные файлов в модель, используемые для создания ответа. Подробнее:

OpenAI.InputTextContent

Текстовые входные данные модели.

Имя Тип Описание Обязательно По умолчанию
Текст Строка Текстовые входные данные модели. Да
Тип Перечисления Тип входного элемента. Всегда input_text.
Возможные значения: input_text		 Да

OpenAI.ItemReferenceParam

Внутренний идентификатор для ссылки на элемент.

Имя Тип Описание Обязательно По умолчанию
Id Строка Идентификатор элемента для ссылки. Да
Тип Перечисления Тип элемента для ссылки. Всегда item_reference.
Возможные значения: item_reference		 Да

OpenAI.ItemResource

Элемент содержимого, используемый для создания ответа.

Дискриминация для OpenAI.ItemResource

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа Схемы
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
Имя Тип Описание Обязательно По умолчанию
Тип OpenAI.ItemResourceType Да

OpenAI.ItemResourceApplyPatchToolCall

Вызов средства, который применяет диффы файлов, создавая, удаляя или обновляя файлы.

Имя Тип Описание Обязательно По умолчанию
call_id Строка Уникальный идентификатор вызова средства исправления, созданного моделью. Да
created_by Строка Идентификатор сущности, созданной этим средством. Нет
Id Строка Уникальный идентификатор вызова средства исправления. Заполняется, когда этот элемент возвращается через API. Да
Операции OpenAI.ApplyPatchFileOperation Одна из операций create_file, delete_file или update_file, применяемых через apply_patch. Да
Тип └️ OpenAI.ApplyPatchFileOperationType Да
Статус OpenAI.ApplyPatchCallStatus Да
Тип Перечисления Тип элемента. Всегда apply_patch_call.
Возможные значения: apply_patch_call		 Да

OpenAI.ItemResourceApplyPatchToolCallOutput

Выходные данные, создаваемые вызовом средства исправления.

Имя Тип Описание Обязательно По умолчанию
call_id Строка Уникальный идентификатор вызова средства исправления, созданного моделью. Да
created_by Строка Идентификатор сущности, создающей выходные данные вызова этого средства. Нет
Id Строка Уникальный идентификатор выходных данных вызова средства исправления. Заполняется, когда этот элемент возвращается через API. Да
Выход строка или null Нет
Статус OpenAI.ApplyPatchCallOutputStatus Да
Тип Перечисления Тип элемента. Всегда apply_patch_call_output.
Возможные значения: apply_patch_call_output		 Да

OpenAI.ItemResourceCodeInterpreterToolCall

Вызов средства для выполнения кода.

Имя Тип Описание Обязательно По умолчанию
Код строка или null Да
container_id Строка Идентификатор контейнера, используемого для запуска кода. Да
Id Строка Уникальный идентификатор вызова средства интерпретатора кода. Да
Выходы массив OpenAI.CodeInterpreterOutputLogs или OpenAI.CodeInterpreterOutputImage или null Да
Статус Перечисления Состояние вызова средства интерпретатора кода. Допустимые значения: in_progress, , completedincomplete, interpretingи failed.
Возможные значения: in_progress, , completedincompleteinterpretingfailed		 Да
Тип Перечисления Тип вызова средства интерпретатора кода. Всегда code_interpreter_call.
Возможные значения: code_interpreter_call		 Да

OpenAI.ItemResourceComputerToolCall

Вызов средства для использования компьютера. Дополнительные сведения см. в руководстве по использованию компьютера .

Имя Тип Описание Обязательно По умолчанию
Действий OpenAI.ComputerAction Да
call_id Строка Идентификатор, используемый при реагировании на вызов средства с выходными данными. Да
Id Строка Уникальный идентификатор вызова компьютера. Да
pending_safety_checks массив OpenAI.ComputerCallSafetyCheckParam Ожидающие проверки безопасности для вызова компьютера. Да
Статус Перечисления Состояние элемента. Один из in_progress, completedили
incomplete. Заполняется, когда элементы возвращаются через API.
Возможные значения: in_progress, completedincomplete		 Да
Тип Перечисления Тип вызова компьютера. Всегда computer_call.
Возможные значения: computer_call		 Да

OpenAI.ItemResourceComputerToolCallOutputResource

Имя Тип Описание Обязательно По умолчанию
acknowledged_safety_checks массив OpenAI.ComputerCallSafetyCheckParam Проверки безопасности, сообщаемые API, которые были подтверждены
Разработчик.		 Нет
call_id Строка Идентификатор вызова средства компьютера, создающего выходные данные. Да
Id Строка Идентификатор выходных данных вызова средства компьютера. Нет
Выход OpenAI.ComputerScreenshotImage Снимок экрана компьютера, используемый с помощью средства использования компьютера. Да
Статус Перечисления Состояние входных данных сообщения. Один из in_progress, completedили
incomplete. Заполняется при возврате входных элементов через API.
Возможные значения: in_progress, completedincomplete		 Нет
Тип Перечисления Тип выходных данных вызова средства компьютера. Всегда computer_call_output.
Возможные значения: computer_call_output		 Да

OpenAI.ItemResourceFileSearchToolCall

Результаты вызова средства поиска файлов. Дополнительные сведения см. в руководстве по поиску файлов .

Имя Тип Описание Обязательно По умолчанию
Id Строка Уникальный идентификатор вызова средства поиска файлов. Да
Запросов массив строк Запросы, используемые для поиска файлов. Да
Результаты массив OpenAI.FileSearchToolCallResults или null Нет
Статус Перечисления Состояние вызова средства поиска файлов. Один из in_progress,
searching, incomplete или failed,
Возможные значения: in_progress, , searchingcompletedincompletefailed		 Да
Тип Перечисления Тип вызова средства поиска файлов. Всегда file_search_call.
Возможные значения: file_search_call		 Да

OpenAI.ItemResourceFunctionShellCall

Вызов средства, выполняющий одну или несколько команд оболочки в управляемой среде.

Имя Тип Описание Обязательно По умолчанию
Действий OpenAI.FunctionShellAction Выполните команду оболочки. Да
Команды └️ массив строк Да
└max_output_length целое число или null Да
└️ timeout_ms целое число или null Да
call_id Строка Уникальный идентификатор вызова средства оболочки, созданного моделью. Да
created_by Строка Идентификатор сущности, созданной этим средством. Нет
Id Строка Уникальный идентификатор вызова средства оболочки. Заполняется, когда этот элемент возвращается через API. Да
Статус OpenAI.LocalShellCallStatus Да
Тип Перечисления Тип элемента. Всегда shell_call.
Возможные значения: shell_call		 Да

OpenAI.ItemResourceFunctionShellCallOutput

Выходные данные вызова средства оболочки, который был создан.

Имя Тип Описание Обязательно По умолчанию
call_id Строка Уникальный идентификатор вызова средства оболочки, созданного моделью. Да
created_by Строка Идентификатор субъекта, создавшего элемент. Нет
Id Строка Уникальный идентификатор выходных данных вызова оболочки. Заполняется, когда этот элемент возвращается через API. Да
max_output_length целое число или null Да
Выход массив OpenAI.FunctionShellCallOutputContent Массив содержимого вывода вызова оболочки Да
Тип Перечисления Тип выходных данных вызова оболочки. Всегда shell_call_output.
Возможные значения: shell_call_output		 Да

OpenAI.ItemResourceFunctionToolCallOutputResource

Имя Тип Описание Обязательно По умолчанию
call_id Строка Уникальный идентификатор вызова средства функции, созданного моделью. Да
Id Строка Уникальный идентификатор выходных данных вызова средства функции. Заполнено, когда этот элемент
возвращается через API.		 Нет
Выход строка или массив OpenAI.FunctionAndCustomToolCallOutput Выходные данные вызова функции, созданного кодом.
Может быть строкой или списком выходного содержимого.		 Да
Статус Перечисления Состояние элемента. Один из in_progress, completedили
incomplete. Заполняется, когда элементы возвращаются через API.
Возможные значения: in_progress, completedincomplete		 Нет
Тип Перечисления Тип выходных данных вызова средства функции. Всегда function_call_output.
Возможные значения: function_call_output		 Да

OpenAI.ItemResourceFunctionToolCallResource

Имя Тип Описание Обязательно По умолчанию
Аргументы Строка Строка JSON аргументов для передачи функции. Да
call_id Строка Уникальный идентификатор вызова средства функции, созданного моделью. Да
Id Строка Уникальный идентификатор вызова средства функции. Нет
Имя Строка Имя выполняемой функции. Да
Статус Перечисления Состояние элемента. Один из in_progress, completedили
incomplete. Заполняется, когда элементы возвращаются через API.
Возможные значения: in_progress, completedincomplete		 Нет
Тип Перечисления Тип вызова средства функции. Всегда function_call.
Возможные значения: function_call		 Да

OpenAI.ItemResourceImageGenToolCall

Запрос на создание изображения, сделанный моделью.

Имя Тип Описание Обязательно По умолчанию
Id Строка Уникальный идентификатор вызова создания образа. Да
Результат строка или null Да
Статус Перечисления Состояние вызова создания образа.
Возможные значения: in_progress, , completedgeneratingfailed		 Да
Тип Перечисления Тип вызова создания изображения. Всегда image_generation_call.
Возможные значения: image_generation_call		 Да

OpenAI.ItemResourceLocalShellToolCall

Вызов средства для выполнения команды в локальной оболочке.

Имя Тип Описание Обязательно По умолчанию
Действий OpenAI.LocalShellExecAction Выполните команду оболочки на сервере. Да
call_id Строка Уникальный идентификатор вызова локального средства оболочки, созданного моделью. Да
Id Строка Уникальный идентификатор вызова локальной оболочки. Да
Статус Перечисления Состояние вызова локальной оболочки.
Возможные значения: in_progress, completedincomplete		 Да
Тип Перечисления Тип вызова локальной оболочки. Всегда local_shell_call.
Возможные значения: local_shell_call		 Да

OpenAI.ItemResourceLocalShellToolCallOutput

Выходные данные вызова локального средства оболочки.

Имя Тип Описание Обязательно По умолчанию
Id Строка Уникальный идентификатор вызова локального средства оболочки, созданного моделью. Да
Выход Строка Строка JSON выходных данных вызова локального средства оболочки. Да
Статус строка или null Нет
Тип Перечисления Тип выходных данных вызова средства локальной оболочки. Всегда local_shell_call_output.
Возможные значения: local_shell_call_output		 Да

OpenAI.ItemResourceMcpApprovalRequest

Запрос на утверждение человека вызова инструмента.

Имя Тип Описание Обязательно По умолчанию
Аргументы Строка Строка JSON аргументов для средства. Да
Id Строка Уникальный идентификатор запроса на утверждение. Да
Имя Строка Имя запускаемого средства. Да
server_label Строка Метка сервера MCP, выполняющего запрос. Да
Тип Перечисления Тип элемента. Всегда mcp_approval_request.
Возможные значения: mcp_approval_request		 Да

OpenAI.ItemResourceMcpApprovalResponseResource

Ответ на запрос на утверждение MCP.

Имя Тип Описание Обязательно По умолчанию
approval_request_id Строка Идентификатор ответа запроса на утверждение. Да
Утвердить Логических Будет ли утвержден запрос. Да
Id Строка Уникальный идентификатор ответа на утверждение Да
Причина строка или null Нет
Тип Перечисления Тип элемента. Всегда mcp_approval_response.
Возможные значения: mcp_approval_response		 Да

OpenAI.ItemResourceMcpListTools

Список средств, доступных на сервере MCP.

Имя Тип Описание Обязательно По умолчанию
Ошибка строка или null Нет
Id Строка Уникальный идентификатор списка. Да
server_label Строка Метка сервера MCP. Да
Инструменты массив OpenAI.MCPListToolsTools Средства, доступные на сервере. Да
Тип Перечисления Тип элемента. Всегда mcp_list_tools.
Возможные значения: mcp_list_tools		 Да

OpenAI.ItemResourceMcpToolCall

Вызов средства на сервере MCP.

Имя Тип Описание Обязательно По умолчанию
approval_request_id строка или null Нет
Аргументы Строка Строка JSON аргументов, переданных средству. Да
Ошибка строка или null Нет
Id Строка Уникальный идентификатор вызова средства. Да
Имя Строка Имя запущенного средства. Да
Выход строка или null Нет
server_label Строка Метка сервера MCP под управлением средства. Да
Статус OpenAI.MCPToolCallStatus Нет
Тип Перечисления Тип элемента. Всегда mcp_call.
Возможные значения: mcp_call		 Да

OpenAI.ItemResourceOutputMessage

Выходное сообщение из модели.

Имя Тип Описание Обязательно По умолчанию
Содержимого массив OpenAI.OutputMessageContent Содержимое выходного сообщения. Да
Id Строка Уникальный идентификатор выходного сообщения. Да
Роль Перечисления Роль выходного сообщения. Всегда assistant.
Возможные значения: assistant		 Да
Статус Перечисления Состояние входных данных сообщения. Один из in_progress, completedили
incomplete. Заполняется при возврате входных элементов через API.
Возможные значения: in_progress, completedincomplete		 Да
Тип Перечисления Тип выходного сообщения. Всегда message.
Возможные значения: output_message		 Да

OpenAI.ItemResourceType

Свойство Значение
Тип Строка
Значения message
output_message
file_search_call
computer_call
computer_call_output
web_search_call
function_call
function_call_output
image_generation_call
code_interpreter_call
local_shell_call
local_shell_call_output
shell_call
shell_call_output
apply_patch_call
apply_patch_call_output
mcp_list_tools
mcp_approval_request
mcp_approval_response
mcp_call

OpenAI.ItemResourceWebSearchToolCall

Результаты вызова средства поиска в Интернете. Дополнительные сведения см. в руководстве по поиску в Интернете .

Имя Тип Описание Обязательно По умолчанию
Действий OpenAI.WebSearchActionSearch или OpenAI.WebSearchActionOpenPage или OpenAI.WebSearchActionFind Объект, описывающий конкретные действия, выполненные в этом вызове поиска в Интернете.
Содержит сведения об использовании модели в Интернете (поиск, open_page, поиск).		 Да
Id Строка Уникальный идентификатор вызова средства поиска в Интернете. Да
Статус Перечисления Состояние вызова средства поиска в Интернете.
Возможные значения: in_progress, , searchingcompletedfailed		 Да
Тип Перечисления Тип вызова средства поиска в Интернете. Всегда web_search_call.
Возможные значения: web_search_call		 Да

OpenAI.KeyPressAction

Коллекция нажатий клавиш, которые модель хотела бы выполнить.

Имя Тип Описание Обязательно По умолчанию
Ключи массив строк Сочетание клавиш, которые модель запрашивает для нажатия. Это массив строк, каждый из которых представляет ключ. Да
Тип Перечисления Указывает тип события. Для действия keypress это свойство всегда имеет значение keypress.
Возможные значения: keypress		 Да

OpenAI.ListBatchesResponse

Имя Тип Описание Обязательно По умолчанию
Данных массив OpenAI.Batch Да
first_id Строка Нет
has_more Логических Да
last_id Строка Нет
Объекта Перечисления
Возможные значения: list		 Да

OpenAI.ListFilesResponse

Имя Тип Описание Обязательно По умолчанию
Данных массив OpenAI.OpenAIFile Да
first_id Строка Да
has_more Логических Да
last_id Строка Да
Объекта Строка Да

OpenAI.ListFineTuningCheckpointPermissionResponse

Имя Тип Описание Обязательно По умолчанию
Данных массив OpenAI.FineTuningCheckpointPermission Да
first_id строка или null Нет
has_more Логических Да
last_id строка или null Нет
Объекта Перечисления
Возможные значения: list		 Да

OpenAI.ListFineTuningJobCheckpointsResponse

Имя Тип Описание Обязательно По умолчанию
Данных массив OpenAI.FineTuningJobCheckpoint Да
first_id строка или null Нет
has_more Логических Да
last_id строка или null Нет
Объекта Перечисления
Возможные значения: list		 Да

OpenAI.ListFineTuningJobEventsResponse

Имя Тип Описание Обязательно По умолчанию
Данных массив OpenAI.FineTuningJobEvent Да
has_more Логических Да
Объекта Перечисления
Возможные значения: list		 Да

OpenAI.ListMessagesResponse

Имя Тип Описание Обязательно По умолчанию
Данных массив OpenAI.MessageObject Да
first_id Строка Да
has_more Логических Да
last_id Строка Да
Объекта Строка Да

OpenAI.ListModelsResponse

Имя Тип Описание Обязательно По умолчанию
Данных массив OpenAI.Model Да
Объекта Перечисления
Возможные значения: list		 Да

OpenAI.ListPaginatedFineTuningJobsResponse

Имя Тип Описание Обязательно По умолчанию
Данных массив OpenAI.FineTuningJob Да
has_more Логических Да
Объекта Перечисления
Возможные значения: list		 Да

OpenAI.ListRunStepsResponse

Имя Тип Описание Обязательно По умолчанию
Данных массив OpenAI.RunStepObject Да
first_id Строка Да
has_more Логических Да
last_id Строка Да
Объекта Строка Да

OpenAI.ListRunsResponse

Имя Тип Описание Обязательно По умолчанию
Данных массив OpenAI.RunObject Да
first_id Строка Да
has_more Логических Да
last_id Строка Да
Объекта Строка Да

OpenAI.ListVectorStoreFilesResponse

Имя Тип Описание Обязательно По умолчанию
Данных массив OpenAI.VectorStoreFileObject Да
first_id Строка Да
has_more Логических Да
last_id Строка Да
Объекта Строка Да

OpenAI.ListVectorStoresResponse

Имя Тип Описание Обязательно По умолчанию
Данных массив OpenAI.VectorStoreObject Да
first_id Строка Да
has_more Логических Да
last_id Строка Да
Объекта Строка Да

OpenAI.LocalShellCallStatus

Свойство Значение
Тип Строка
Значения in_progress
completed
incomplete

OpenAI.LocalShellExecAction

Выполните команду оболочки на сервере.

Имя Тип Описание Обязательно По умолчанию
Команды массив строк Команда для выполнения. Да
Env Объекта Переменные среды, заданные для команды. Да
timeout_ms целое число или null Нет
Тип Перечисления Тип действия локальной оболочки. Всегда exec.
Возможные значения: exec		 Да
Пользователя строка или null Нет
working_directory строка или null Нет

OpenAI.LocalShellToolParam

Средство, позволяющее модели выполнять команды оболочки в локальной среде.

Имя Тип Описание Обязательно По умолчанию
Тип Перечисления Тип локального средства оболочки. Всегда local_shell.
Возможные значения: local_shell		 Да

OpenAI.LogProb

Вероятность использования маркера в журнале.

Имя Тип Описание Обязательно По умолчанию
Байт массив целых чисел Да
logprob Номер Да
Маркер Строка Да
top_logprobs массив OpenAI.TopLogProb Да

OpenAI.MCPListToolsToolsTool

Средство, доступное на сервере MCP.

Имя Тип Описание Обязательно По умолчанию
Аннотации OpenAI.MCPListToolsToolAnnotations или NULL Нет
Описание строка или null Нет
input_schema OpenAI.MCPListToolsToolInputSchema Да
Имя Строка Имя средства. Да

OpenAI.MCPListToolsToolAnnotations

Тип: объект

OpenAI.MCPListToolsToolInputSchema

Тип: объект

OpenAI.MCPTool

Предоставьте модели доступ к дополнительным средствам через удаленные серверы протокола контекста модели (MCP). Дополнительные сведения о MCP.

Имя Тип Описание Обязательно По умолчанию
allowed_tools массив строк или OpenAI.MCPToolFilter или NULL Нет
Авторизации Строка Маркер доступа OAuth, который можно использовать с удаленным сервером MCP, либо
с настраиваемым URL-адресом сервера MCP или соединителем службы. Ваше приложение
должен обработать поток авторизации OAuth и указать здесь маркер.		 Нет
connector_id Перечисления Идентификатор соединителей служб, например тех, которые доступны в 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_gmailconnector_googlecalendarconnector_googledriveconnector_microsoftteamsconnector_outlookcalendarconnector_outlookemailconnector_sharepoint		 Нет
Заголовки объект или null Нет
require_approval OpenAI.MCPToolRequireApproval или string или null Нет
server_description Строка Необязательное описание сервера MCP, используемого для предоставления дополнительного контекста. Нет
server_label Строка Метка для этого сервера MCP, используемая для идентификации его в вызовах инструментов. Да
server_url Строка URL-адрес сервера MCP. Одно из server_url или connector_id должно быть
Предоставляются.		 Нет
Тип Перечисления Тип средства MCP. Всегда mcp.
Возможные значения: mcp		 Да

OpenAI.MCPToolCallStatus

Свойство Значение
Тип Строка
Значения in_progress
completed
incomplete
calling
failed

OpenAI.MCPToolFilter

Объект фильтра, указывающий, какие средства разрешены.

Имя Тип Описание Обязательно По умолчанию
read_only Логических Указывает, изменяет ли средство данные или доступно только для чтения. Если
Сервер MCP аннотирован с помощью < a0/&a0>.
он будет соответствовать этому фильтру.		 Нет
tool_names массив строк Список разрешенных имен инструментов. Нет

OpenAI.MCPToolRequireApproval

Имя Тип Описание Обязательно По умолчанию
Всегда OpenAI.MCPToolFilter Объект фильтра, указывающий, какие средства разрешены. Нет
Нвер OpenAI.MCPToolFilter Объект фильтра, указывающий, какие средства разрешены. Нет

OpenAI.MessageContent

Дискриминация для OpenAI.MessageContent

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа Схемы
image_url OpenAI.MessageContentImageUrlObject
text OpenAI.MessageContentTextObject
refusal OpenAI.MessageContentRefusalObject
Имя Тип Описание Обязательно По умолчанию
Тип OpenAI.MessageContentType Да

OpenAI.MessageContentImageFileObject

Ссылается на файл изображения в содержимом сообщения.

Имя Тип Описание Обязательно По умолчанию
image_file OpenAI.MessageContentImageFileObjectImageFile Да
Тип Перечисления Всегда image_file.
Возможные значения: image_file		 Да

OpenAI.MessageContentImageFileObjectImageFile

Имя Тип Описание Обязательно По умолчанию
Детали Перечисления
Возможные значения: auto, lowhigh		 Нет
file_id Строка Да

OpenAI.MessageContentImageUrlObject

Ссылается на URL-адрес изображения в содержимом сообщения.

Имя Тип Описание Обязательно По умолчанию
image_url OpenAI.MessageContentImageUrlObjectImageUrl Да
Тип Перечисления Тип части содержимого.
Возможные значения: image_url		 Да

OpenAI.MessageContentImageUrlObjectImageUrl

Имя Тип Описание Обязательно По умолчанию
Детали Перечисления
Возможные значения: auto, lowhigh		 Нет
Url Строка Да

OpenAI.MessageContentRefusalObject

Содержимое отказа, созданное помощником.

Имя Тип Описание Обязательно По умолчанию
Отказ Строка Да
Тип Перечисления Всегда refusal.
Возможные значения: refusal		 Да

OpenAI.MessageContentTextAnnotationsFileCitationObject

Ссылка в сообщении, указывающая на определенную цитату из определенного файла, связанного с помощником или сообщением. Создается, когда помощник использует средство "file_search" для поиска файлов.

Имя Тип Описание Обязательно По умолчанию
end_index Целое число Ограничения: мин: 0 Да
file_citation OpenAI.MessageContentTextAnnotationsFileCitationObjectFileCitation Да
start_index Целое число Ограничения: мин: 0 Да
Текст Строка Текст в содержимом сообщения, который необходимо заменить. Да
Тип Перечисления Всегда file_citation.
Возможные значения: file_citation		 Да

OpenAI.MessageContentTextAnnotationsFileCitationObjectFileCitation

Имя Тип Описание Обязательно По умолчанию
file_id Строка Да

OpenAI.MessageContentTextAnnotationsFilePathObject

URL-адрес файла, созданного при создании файла помощником, который использовал code_interpreter средство для создания файла.

Имя Тип Описание Обязательно По умолчанию
end_index Целое число Ограничения: мин: 0 Да
file_path OpenAI.MessageContentTextAnnotationsFilePathObjectFilePath Да
start_index Целое число Ограничения: мин: 0 Да
Текст Строка Текст в содержимом сообщения, который необходимо заменить. Да
Тип Перечисления Всегда file_path.
Возможные значения: file_path		 Да

OpenAI.MessageContentTextAnnotationsFilePathObjectFilePath

Имя Тип Описание Обязательно По умолчанию
file_id Строка Да

OpenAI.MessageContentTextObject

Текстовое содержимое, которое входит в сообщение.

Имя Тип Описание Обязательно По умолчанию
Текст OpenAI.MessageContentTextObjectText Да
Тип Перечисления Всегда text.
Возможные значения: text		 Да

OpenAI.MessageContentTextObjectText

Имя Тип Описание Обязательно По умолчанию
Аннотации массив OpenAI.TextAnnotation Да
Значение Строка Да

OpenAI.MessageContentType

Свойство Значение
Тип Строка
Значения image_file
image_url
text
refusal

OpenAI.MessageObject

Представляет сообщение в потоке.

Имя Тип Описание Обязательно По умолчанию
assistant_id строка или null Да
Вложения массив OpenAI.MessageObjectAttachments или null Да
completed_at строка или null Да
Содержимого массив OpenAI.MessageContent Содержимое сообщения в массиве текста и(или) изображений. Да
created_at Целое число Метка времени Unix (в секундах) для момента создания сообщения. Да
Id Строка Идентификатор, на который можно ссылаться в конечных точках API. Да
incomplete_at строка или null Да
incomplete_details OpenAI.MessageObjectIncompleteDetails или null Да
Метаданных OpenAI.Metadata или NULL Да
Объекта Перечисления Тип объекта, который всегда thread.messageявляется .
Возможные значения: thread.message		 Да
Роль Перечисления Сущность, создающая сообщение. Одно из user или assistant.
Возможные значения: user, assistant		 Да
run_id строка или null Да
Статус Перечисления Состояние сообщения, которое может быть либо in_progress, incompleteлибо completed.
Возможные значения: in_progress, incompletecompleted		 Да
thread_id Строка Идентификатор потока , к которому принадлежит это сообщение. Да

OpenAI.MessageObjectAttachments

Имя Тип Описание Обязательно По умолчанию
file_id Строка Нет
Инструменты массив OpenAI.AssistantToolsCode или OpenAI.AssistantToolsFileSearchTypeOnly Нет

OpenAI.MessageObjectIncompleteDetails

Имя Тип Описание Обязательно По умолчанию
Причина Перечисления
Возможные значения: content_filter, , max_tokensrun_cancelledrun_expiredrun_failed		 Да

OpenAI.MessageRequestContentTextObject

Текстовое содержимое, которое входит в сообщение.

Имя Тип Описание Обязательно По умолчанию
Текст Строка Текстовое содержимое для отправки в модель Да
Тип Перечисления Всегда text.
Возможные значения: text		 Да

OpenAI.MessageRole

Свойство Значение
Тип Строка
Значения unknown
user
assistant
system
critic
discriminator
developer
tool

OpenAI.MessageStatus

Свойство Значение
Тип Строка
Значения in_progress
completed
incomplete

OpenAI.Metadata

Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате и запроса на объекты через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — это строки с максимальной длиной 512 символов.

Тип: объект

OpenAI.Model

Описывает предложение модели OpenAI, которое можно использовать с API.

Имя Тип Описание Обязательно По умолчанию
Создан Целое число Метка времени Unix (в секундах) при создании модели. Да
Id Строка Идентификатор модели, на который можно ссылаться в конечных точках API. Да
Объекта Перечисления Тип объекта, который всегда является моделью.
Возможные значения: model		 Да
owned_by Строка Организация, которая владеет моделью. Да

OpenAI.ModifyMessageRequest

Имя Тип Описание Обязательно По умолчанию
Метаданных OpenAI.Metadata или NULL Нет

OpenAI.ModifyRunRequest

Имя Тип Описание Обязательно По умолчанию
Метаданных OpenAI.Metadata или NULL Нет

OpenAI.ModifyThreadRequest

Имя Тип Описание Обязательно По умолчанию
Метаданных OpenAI.Metadata или NULL Нет
tool_resources OpenAI.ModifyThreadRequestToolResources или null Нет

OpenAI.ModifyThreadRequestToolResources

Имя Тип Описание Обязательно По умолчанию
code_interpreter OpenAI.ModifyThreadRequestToolResourcesCodeInterpreter Нет
file_search OpenAI.ModifyThreadRequestToolResourcesFileSearch Нет

OpenAI.ModifyThreadRequestToolResourcesCodeInterpreter

Имя Тип Описание Обязательно По умолчанию
file_ids массив строк Нет

OpenAI.ModifyThreadRequestToolResourcesFileSearch

Имя Тип Описание Обязательно По умолчанию
vector_store_ids массив строк Нет

OpenAI.Move

Действие перемещения мыши.

Имя Тип Описание Обязательно По умолчанию
Тип Перечисления Указывает тип события. Для действия перемещения это свойство имеет значение
всегда задано значение move.
Возможные значения: move		 Да
X Целое число Координата x для перемещения. Да
Y Целое число Координата y для перемещения. Да

OpenAI.NoiseReductionType

Тип уменьшения шума. near_field предназначен для микрофонов близкого разговора, таких как наушники, far_field предназначен для микрофонов с дальним полем, таких как ноутбук или микрофоны конференц-зала.

Свойство Значение
Тип Строка
Значения near_field
far_field

OpenAI.OpenAIFile

Объект File представляет документ, который был отправлен в OpenAI.

Имя Тип Описание Обязательно По умолчанию
Байт Целое число Размер файла в байтах. Да
created_at Целое число Метка времени Unix (в секундах) для момента создания файла. Да
expires_at Целое число Метка времени Unix (в секундах) для истечения срока действия файла. Нет
Имени файла Строка Имя файла. Да
Id Строка Идентификатор файла, на который можно ссылаться в конечных точках API. Да
Объекта Перечисления Тип объекта, который всегда fileявляется .
Возможные значения: file		 Да
Цель Перечисления Предназначение файла. Поддерживаемые значения: assistants, , assistants_outputbatch, batch_outputfine-tuneи fine-tune-results.
Возможные значения: assistants, , , assistants_outputbatchbatch_outputfine-tunefine-tune-resultsevals		 Да
Статус Перечисления
Возможные значения: uploaded, , , pendingrunningprocessederrordeletingdeleted		 Да
status_details string (не рекомендуется) Устаревшие. Дополнительные сведения о том, почему сбой проверки файла обучения точной настройки см. в errorfine_tuning.jobполе . Нет

OpenAI.OtherChunkingStrategyResponseParam

Это возвращается, когда стратегия блокирования неизвестна. Как правило, это связано с тем, что файл был индексирован до chunking_strategy появления концепции в API.

Имя Тип Описание Обязательно По умолчанию
Тип Перечисления Всегда other.
Возможные значения: other		 Да

OpenAI.OutputContent

Дискриминация для OpenAI.OutputContent

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа Схемы
output_text OpenAI.OutputContentOutputTextContent
refusal OpenAI.OutputContentRefusalContent
Имя Тип Описание Обязательно По умолчанию
Тип OpenAI.OutputContentType Да

OpenAI.OutputContentOutputTextContent

Текстовые выходные данные модели.

Имя Тип Описание Обязательно По умолчанию
Аннотации массив OpenAI.Annotation Заметки к выходным данным текста. Да
logprobs массив OpenAI.LogProb Нет
Текст Строка Текстовые выходные данные модели. Да
Тип Перечисления Тип выходного текста. Всегда output_text.
Возможные значения: output_text		 Да

OpenAI.OutputContentRefusalContent

Отказ от модели.

Имя Тип Описание Обязательно По умолчанию
Отказ Строка Объяснение отказа от модели. Да
Тип Перечисления Тип отказа. Всегда refusal.
Возможные значения: refusal		 Да

OpenAI.OutputContentType

Свойство Значение
Тип Строка
Значения output_text
refusal
reasoning_text

OpenAI.OutputItem

Дискриминация для OpenAI.OutputItem

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа Схемы
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
Имя Тип Описание Обязательно По умолчанию
Тип OpenAI.OutputItemType Да

OpenAI.OutputItemApplyPatchToolCall

Вызов средства, который применяет диффы файлов, создавая, удаляя или обновляя файлы.

Имя Тип Описание Обязательно По умолчанию
call_id Строка Уникальный идентификатор вызова средства исправления, созданного моделью. Да
created_by Строка Идентификатор сущности, созданной этим средством. Нет
Id Строка Уникальный идентификатор вызова средства исправления. Заполняется, когда этот элемент возвращается через API. Да
Операции OpenAI.ApplyPatchFileOperation Одна из операций create_file, delete_file или update_file, применяемых через apply_patch. Да
Тип └️ OpenAI.ApplyPatchFileOperationType Да
Статус OpenAI.ApplyPatchCallStatus Да
Тип Перечисления Тип элемента. Всегда apply_patch_call.
Возможные значения: apply_patch_call		 Да

OpenAI.OutputItemApplyPatchToolCallOutput

Выходные данные, создаваемые вызовом средства исправления.

Имя Тип Описание Обязательно По умолчанию
call_id Строка Уникальный идентификатор вызова средства исправления, созданного моделью. Да
created_by Строка Идентификатор сущности, создающей выходные данные вызова этого средства. Нет
Id Строка Уникальный идентификатор выходных данных вызова средства исправления. Заполняется, когда этот элемент возвращается через API. Да
Выход строка или null Нет
Статус OpenAI.ApplyPatchCallOutputStatus Да
Тип Перечисления Тип элемента. Всегда apply_patch_call_output.
Возможные значения: apply_patch_call_output		 Да

OpenAI.OutputItemCodeInterpreterToolCall

Вызов средства для выполнения кода.

Имя Тип Описание Обязательно По умолчанию
Код строка или null Да
container_id Строка Идентификатор контейнера, используемого для запуска кода. Да
Id Строка Уникальный идентификатор вызова средства интерпретатора кода. Да
Выходы массив OpenAI.CodeInterpreterOutputLogs или OpenAI.CodeInterpreterOutputImage или null Да
Статус Перечисления Состояние вызова средства интерпретатора кода. Допустимые значения: in_progress, , completedincomplete, interpretingи failed.
Возможные значения: in_progress, , completedincompleteinterpretingfailed		 Да
Тип Перечисления Тип вызова средства интерпретатора кода. Всегда code_interpreter_call.
Возможные значения: code_interpreter_call		 Да

OpenAI.OutputItemCompactionBody

Элемент сжатия, v1/responses/compact созданный API.

Имя Тип Описание Обязательно По умолчанию
created_by Строка Идентификатор субъекта, создавшего элемент. Нет
encrypted_content Строка Зашифрованное содержимое, созданное с помощью сжатия. Да
Id Строка Уникальный идентификатор элемента сжатия. Да
Тип Перечисления Тип элемента. Всегда compaction.
Возможные значения: compaction		 Да

OpenAI.OutputItemComputerToolCall

Вызов средства для использования компьютера. Дополнительные сведения см. в руководстве по использованию компьютера .

Имя Тип Описание Обязательно По умолчанию
Действий OpenAI.ComputerAction Да
call_id Строка Идентификатор, используемый при реагировании на вызов средства с выходными данными. Да
Id Строка Уникальный идентификатор вызова компьютера. Да
pending_safety_checks массив OpenAI.ComputerCallSafetyCheckParam Ожидающие проверки безопасности для вызова компьютера. Да
Статус Перечисления Состояние элемента. Один из in_progress, completedили
incomplete. Заполняется, когда элементы возвращаются через API.
Возможные значения: in_progress, completedincomplete		 Да
Тип Перечисления Тип вызова компьютера. Всегда computer_call.
Возможные значения: computer_call		 Да

OpenAI.OutputItemCustomToolCall

Вызов пользовательского средства, созданного моделью.

Имя Тип Описание Обязательно По умолчанию
call_id Строка Идентификатор, используемый для сопоставления этого настраиваемого вызова средства с выходными данными вызова средства. Да
Id Строка Уникальный идентификатор вызова пользовательского средства на платформе OpenAI. Нет
Вход Строка Входные данные для вызова пользовательского средства, созданного моделью. Да
Имя Строка Имя вызываемого пользовательского средства. Да
Тип Перечисления Тип вызова пользовательского средства. Всегда custom_tool_call.
Возможные значения: custom_tool_call		 Да

OpenAI.OutputItemFileSearchToolCall

Результаты вызова средства поиска файлов. Дополнительные сведения см. в руководстве по поиску файлов .

Имя Тип Описание Обязательно По умолчанию
Id Строка Уникальный идентификатор вызова средства поиска файлов. Да
Запросов массив строк Запросы, используемые для поиска файлов. Да
Результаты массив OpenAI.FileSearchToolCallResults или null Нет
Статус Перечисления Состояние вызова средства поиска файлов. Один из in_progress,
searching, incomplete или failed,
Возможные значения: in_progress, , searchingcompletedincompletefailed		 Да
Тип Перечисления Тип вызова средства поиска файлов. Всегда file_search_call.
Возможные значения: file_search_call		 Да

OpenAI.OutputItemFunctionShellCall

Вызов средства, выполняющий одну или несколько команд оболочки в управляемой среде.

Имя Тип Описание Обязательно По умолчанию
Действий OpenAI.FunctionShellAction Выполните команду оболочки. Да
Команды └️ массив строк Да
└max_output_length целое число или null Да
└️ timeout_ms целое число или null Да
call_id Строка Уникальный идентификатор вызова средства оболочки, созданного моделью. Да
created_by Строка Идентификатор сущности, созданной этим средством. Нет
Id Строка Уникальный идентификатор вызова средства оболочки. Заполняется, когда этот элемент возвращается через API. Да
Статус OpenAI.LocalShellCallStatus Да
Тип Перечисления Тип элемента. Всегда shell_call.
Возможные значения: shell_call		 Да

OpenAI.OutputItemFunctionShellCallOutput

Выходные данные вызова средства оболочки, который был создан.

Имя Тип Описание Обязательно По умолчанию
call_id Строка Уникальный идентификатор вызова средства оболочки, созданного моделью. Да
created_by Строка Идентификатор субъекта, создавшего элемент. Нет
Id Строка Уникальный идентификатор выходных данных вызова оболочки. Заполняется, когда этот элемент возвращается через API. Да
max_output_length целое число или null Да
Выход массив OpenAI.FunctionShellCallOutputContent Массив содержимого вывода вызова оболочки Да
Тип Перечисления Тип выходных данных вызова оболочки. Всегда shell_call_output.
Возможные значения: shell_call_output		 Да

OpenAI.OutputItemFunctionToolCall

Вызов средства для запуска функции. Дополнительные сведения см. в руководстве по вызову функции .

Имя Тип Описание Обязательно По умолчанию
Аргументы Строка Строка JSON аргументов для передачи функции. Да
call_id Строка Уникальный идентификатор вызова средства функции, созданного моделью. Да
Id Строка Уникальный идентификатор вызова средства функции. Нет
Имя Строка Имя выполняемой функции. Да
Статус Перечисления Состояние элемента. Один из in_progress, completedили
incomplete. Заполняется, когда элементы возвращаются через API.
Возможные значения: in_progress, completedincomplete		 Нет
Тип Перечисления Тип вызова средства функции. Всегда function_call.
Возможные значения: function_call		 Да

OpenAI.OutputItemImageGenToolCall

Запрос на создание изображения, сделанный моделью.

Имя Тип Описание Обязательно По умолчанию
Id Строка Уникальный идентификатор вызова создания образа. Да
Результат строка или null Да
Статус Перечисления Состояние вызова создания образа.
Возможные значения: in_progress, , completedgeneratingfailed		 Да
Тип Перечисления Тип вызова создания изображения. Всегда image_generation_call.
Возможные значения: image_generation_call		 Да

OpenAI.OutputItemLocalShellToolCall

Вызов средства для выполнения команды в локальной оболочке.

Имя Тип Описание Обязательно По умолчанию
Действий OpenAI.LocalShellExecAction Выполните команду оболочки на сервере. Да
call_id Строка Уникальный идентификатор вызова локального средства оболочки, созданного моделью. Да
Id Строка Уникальный идентификатор вызова локальной оболочки. Да
Статус Перечисления Состояние вызова локальной оболочки.
Возможные значения: in_progress, completedincomplete		 Да
Тип Перечисления Тип вызова локальной оболочки. Всегда local_shell_call.
Возможные значения: local_shell_call		 Да

OpenAI.OutputItemMcpApprovalRequest

Запрос на утверждение человека вызова инструмента.

Имя Тип Описание Обязательно По умолчанию
Аргументы Строка Строка JSON аргументов для средства. Да
Id Строка Уникальный идентификатор запроса на утверждение. Да
Имя Строка Имя запускаемого средства. Да
server_label Строка Метка сервера MCP, выполняющего запрос. Да
Тип Перечисления Тип элемента. Всегда mcp_approval_request.
Возможные значения: mcp_approval_request		 Да

OpenAI.OutputItemMcpListTools

Список средств, доступных на сервере MCP.

Имя Тип Описание Обязательно По умолчанию
Ошибка строка или null Нет
Id Строка Уникальный идентификатор списка. Да
server_label Строка Метка сервера MCP. Да
Инструменты массив OpenAI.MCPListToolsTools Средства, доступные на сервере. Да
Тип Перечисления Тип элемента. Всегда mcp_list_tools.
Возможные значения: mcp_list_tools		 Да

OpenAI.OutputItemMcpToolCall

Вызов средства на сервере MCP.

Имя Тип Описание Обязательно По умолчанию
approval_request_id строка или null Нет
Аргументы Строка Строка JSON аргументов, переданных средству. Да
Ошибка строка или null Нет
Id Строка Уникальный идентификатор вызова средства. Да
Имя Строка Имя запущенного средства. Да
Выход строка или null Нет
server_label Строка Метка сервера MCP под управлением средства. Да
Статус OpenAI.MCPToolCallStatus Нет
Тип Перечисления Тип элемента. Всегда mcp_call.
Возможные значения: mcp_call		 Да

OpenAI.OutputItemOutputMessage

Выходное сообщение из модели.

Имя Тип Описание Обязательно По умолчанию
Содержимого массив OpenAI.OutputMessageContent Содержимое выходного сообщения. Да
Id Строка Уникальный идентификатор выходного сообщения. Да
Роль Перечисления Роль выходного сообщения. Всегда assistant.
Возможные значения: assistant		 Да
Статус Перечисления Состояние входных данных сообщения. Один из in_progress, completedили
incomplete. Заполняется при возврате входных элементов через API.
Возможные значения: in_progress, completedincomplete		 Да
Тип Перечисления Тип выходного сообщения. Всегда message.
Возможные значения: output_message		 Да

OpenAI.OutputItemReasoningItem

Описание цепочки мысли, используемой моделью причин при создании ответа. Не забудьте включить эти элементы в input API ответов для последующих поворотов беседы, если вы вручную управляете контекстом.

Имя Тип Описание Обязательно По умолчанию
Содержимого массив OpenAI.ReasoningTextContent Обоснование текстового содержимого. Нет
encrypted_content строка или null Нет
Id Строка Уникальный идентификатор содержимого причины. Да
Статус Перечисления Состояние элемента. Один из in_progress, completedили
incomplete. Заполняется, когда элементы возвращаются через API.
Возможные значения: in_progress, completedincomplete		 Нет
Сводка массив OpenAI.Summary Содержимое сводки по причинам. Да
Тип Перечисления Тип объекта. Всегда reasoning.
Возможные значения: reasoning		 Да

OpenAI.OutputItemType

Свойство Значение
Тип Строка
Значения output_message
file_search_call
function_call
web_search_call
computer_call
reasoning
compaction
image_generation_call
code_interpreter_call
local_shell_call
shell_call
shell_call_output
apply_patch_call
apply_patch_call_output
mcp_call
mcp_list_tools
mcp_approval_request
custom_tool_call

OpenAI.OutputItemWebSearchToolCall

Результаты вызова средства поиска в Интернете. Дополнительные сведения см. в руководстве по поиску в Интернете .

Имя Тип Описание Обязательно По умолчанию
Действий OpenAI.WebSearchActionSearch или OpenAI.WebSearchActionOpenPage или OpenAI.WebSearchActionFind Объект, описывающий конкретные действия, выполненные в этом вызове поиска в Интернете.
Содержит сведения об использовании модели в Интернете (поиск, open_page, поиск).		 Да
Id Строка Уникальный идентификатор вызова средства поиска в Интернете. Да
Статус Перечисления Состояние вызова средства поиска в Интернете.
Возможные значения: in_progress, , searchingcompletedfailed		 Да
Тип Перечисления Тип вызова средства поиска в Интернете. Всегда web_search_call.
Возможные значения: web_search_call		 Да

OpenAI.OutputMessageContent

Дискриминация для OpenAI.OutputMessageContent

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа Схемы
output_text OpenAI.OutputMessageContentOutputTextContent
refusal OpenAI.OutputMessageContentRefusalContent
Имя Тип Описание Обязательно По умолчанию
Тип OpenAI.OutputMessageContentType Да

OpenAI.OutputMessageContentOutputTextContent

Текстовые выходные данные модели.

Имя Тип Описание Обязательно По умолчанию
Аннотации массив OpenAI.Annotation Заметки к выходным данным текста. Да
logprobs массив OpenAI.LogProb Нет
Текст Строка Текстовые выходные данные модели. Да
Тип Перечисления Тип выходного текста. Всегда output_text.
Возможные значения: output_text		 Да

OpenAI.OutputMessageContentRefusalContent

Отказ от модели.

Имя Тип Описание Обязательно По умолчанию
Отказ Строка Объяснение отказа от модели. Да
Тип Перечисления Тип отказа. Всегда refusal.
Возможные значения: refusal		 Да

OpenAI.OutputMessageContentType

Свойство Значение
Тип Строка
Значения output_text
refusal

OpenAI.OutputTextContent

Текстовые выходные данные модели.

Имя Тип Описание Обязательно По умолчанию
Аннотации массив OpenAI.Annotation Заметки к выходным данным текста. Да
logprobs массив OpenAI.LogProb Нет
Текст Строка Текстовые выходные данные модели. Да
Тип Перечисления Тип выходного текста. Всегда output_text.
Возможные значения: output_text		 Да

OpenAI.ParallelToolCalls

Следует ли включить параллельные вызовы функций во время использования средства.

Тип: логический

OpenAI.PredictionContent

Статическое прогнозируемое выходное содержимое, например содержимое создаваемого текстового файла.

Имя Тип Описание Обязательно По умолчанию
Содержимого строка или массив OpenAI.ChatCompletionRequestMessageContentPartText Содержимое, которое должно быть сопоставлено при создании ответа модели.
Если созданные маркеры соответствуют этому содержимому, весь ответ модели
можно вернуть гораздо быстрее.		 Да
Тип Перечисления Тип прогнозируемого содержимого, который требуется предоставить. Этот тип является
в настоящее время всегда content.
Возможные значения: content		 Да

OpenAI.Prompt

Ссылка на шаблон запроса и его переменные. Дополнительные сведения.

Имя Тип Описание Обязательно По умолчанию
Id Строка Уникальный идентификатор используемого шаблона запроса. Да
Переменные OpenAI.ResponsePromptVariables или NULL Нет
Версия строка или null Нет

OpenAI.RankerVersionType

Свойство Значение
Тип Строка
Значения auto
default-2024-11-15

OpenAI.RankingOptions

Имя Тип Описание Обязательно По умолчанию
hybrid_search OpenAI.HybridSearchOptions Нет
└️ embedding_weight Номер Вес внедрения в взаимное ранжирование слияние. Да
└text_weight Номер Вес текста в взаимном ранжировании слиянием. Да
рангер OpenAI.RankerVersionType Нет
score_threshold Номер Пороговое значение оценки для поиска файлов — от 0 до 1. Числа ближе к 1 будут пытаться вернуть только наиболее релевантные результаты, но могут возвращать меньше результатов. Нет

OpenAI.RealtimeAudioFormats

Дискриминация для OpenAI.RealtimeAudioFormats

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа Схемы
audio/pcm OpenAI.RealtimeAudioFormatsAudioPcm
audio/pcmu OpenAI.RealtimeAudioFormatsAudioPcmu
audio/pcma OpenAI.RealtimeAudioFormatsAudioPcma
Имя Тип Описание Обязательно По умолчанию
Тип OpenAI.RealtimeAudioFormatsType Да

OpenAI.RealtimeAudioFormatsAudioPcm

Имя Тип Описание Обязательно По умолчанию
Ставка Перечисления
Возможные значения: 24000		 Нет
Тип Перечисления
Возможные значения: audio/pcm		 Да

OpenAI.RealtimeAudioFormatsAudioPcma

Имя Тип Описание Обязательно По умолчанию
Тип Перечисления
Возможные значения: audio/pcma		 Да

OpenAI.RealtimeAudioFormatsAudioPcmu

Имя Тип Описание Обязательно По умолчанию
Тип Перечисления
Возможные значения: audio/pcmu		 Да

OpenAI.RealtimeAudioFormatsType

Свойство Значение
Тип Строка
Значения audio/pcm
audio/pcmu
audio/pcma

OpenAI.RealtimeCallCreateRequest

Имя Тип Описание Обязательно По умолчанию
Sdp Строка Предложение протокола описания сеансов WebRTC (SDP), созданное вызывающим оператором. Да
Сессии OpenAI.RealtimeSessionCreateRequestGA Конфигурация объекта сеанса в режиме реального времени. Нет
└️ звук OpenAI.RealtimeSessionCreateRequestGAAudio Настройка входного и выходного звука. Нет
└️ include массив строк Дополнительные поля для включения в выходные данные сервера.
item.input_audio_transcription.logprobs: включите logprobs для транскрибирования входного звука.		 Нет
Инструкции └️ Строка Системные инструкции по умолчанию (т. е. системное сообщение) предопределены для вызовов модели. Это поле позволяет клиенту управлять моделью по нужным ответам. Модель может быть указана по содержимому ответа и формату (например, "быть чрезвычайно краткой", "действовать понятно", "вот примеры хороших ответов") и по поведению звука (например, "быстро говорить", "вводить эмоции в ваш голос", "смеяться часто"). Инструкции не гарантируются моделью, но они предоставляют рекомендации модели по требуемому поведению.
Обратите внимание, что сервер задает инструкции по умолчанию, которые будут использоваться, если это поле не задано и отображается в событии в session.created начале сеанса.		 Нет
└️ max_output_tokens целое число (см. допустимые модели ниже) Максимальное количество выходных маркеров для одного ответа помощника;
включающее вызовы инструментов. Укажите целое число от 1 до 4096.
ограничение выходных маркеров или inf максимально доступных маркеров для
данная модель. По умолчанию используется infзначение .		 Нет
Модель └️ Строка Модель реального времени, используемая для этого сеанса. Нет
└output_modalities массив строк Набор модальностей, с которыми может реагировать модель. Значение по умолчанию , ["audio"]указывающее
что модель будет реагировать на звук и расшифровку. ["text"] можно использовать для создания
Модель отвечает только текстом. Не удается запросить оба text и audio одновременно.		 Нет ['audio']
Запрос └️ OpenAI.Prompt Ссылка на шаблон запроса и его переменные.
Дополнительные сведения.		 Нет
└tool_choice OpenAI.ToolChoiceOptions или OpenAI.ToolChoiceFunction или OpenAI.ToolChoiceMCP Как модель выбирает инструменты. Укажите один из режимов строки или принудительное применение определенного
средство function/MCP.		 Нет Авто
Средства └️ массив OpenAI.RealtimeFunctionTool или OpenAI.MCPTool Средства, доступные для модели. Нет
Трассировка └️ string или OpenAI.RealtimeSessionCreateRequestGATracing или null "" Установите значение NULL, чтобы отключить трассировку. Раз
Трассировка включена для сеанса, конфигурация не может быть изменена.
auto создаст трассировку для сеанса со значениями по умолчанию для
имя рабочего процесса, идентификатор группы и метаданные.		 Нет Авто
└️ усечение OpenAI.RealtimeTruncation Если количество маркеров в беседе превышает ограничение входного маркера модели, беседа будет усечена, то есть сообщения (начиная с самого старого) не будут включены в контекст модели. 32k контекстная модель с 4096 максимальными выходными маркерами может включать только 28 224 маркеров в контексте перед усечением.
Клиенты могут настроить поведение усечения для усечения с более низким максимальным ограничением маркера, что является эффективным способом управления использованием маркеров и затратами.
Усечение уменьшит количество кэшированных маркеров в следующем шаге (перебор кэша), так как сообщения удаляются с начала контекста. Однако клиенты также могут настроить усечение для хранения сообщений до доли максимального размера контекста, что приведет к снижению необходимости в будущих усечениях и, таким образом, повышению скорости кэширования.
Усечение может быть полностью отключено, что означает, что сервер никогда не усечен, но вместо этого возвращает ошибку, если беседа превышает ограничение маркера ввода модели.		 Нет
Тип └️ Перечисления Тип создаваемого сеанса. Всегда realtime для API Реального времени.
Возможные значения: realtime		 Да

OpenAI.RealtimeCallReferRequest

Параметры, необходимые для передачи вызова SIP в новое назначение с помощью API Реального времени.

Имя Тип Описание Обязательно По умолчанию
target_uri Строка URI, который должен отображаться в заголовке SIP Refer-To. Поддерживает такие значения, как
tel:+14155550123 или sip:agent\@example.com.		 Да

OpenAI.RealtimeCallRejectRequest

Параметры, используемые для отклонения входящих вызовов SIP, обрабатываемых API Реального времени.

Имя Тип Описание Обязательно По умолчанию
status_code Целое число Код ответа SIP для отправки обратно вызывающей стороне. Значение 603 по умолчанию (отклонить)
при опущении.		 Нет

OpenAI.RealtimeCreateClientSecretRequest

Создайте секрет сеанса и клиента для API Реального времени. Запрос может указывать конфигурацию сеанса транскрибирования в режиме реального времени или транскрибирования. Дополнительные сведения об API Реального времени.

Имя Тип Описание Обязательно По умолчанию
expires_after OpenAI.RealtimeCreateClientSecretRequestExpiresAfter Нет
Привязка └️ Перечисления
Возможные значения: created_at		 Нет
└= секунды Целое число Ограничения: min: 10, max: 7200 Нет 600
Сессии OpenAI.RealtimeSessionCreateRequestUnion Нет
Тип └️ OpenAI.RealtimeSessionCreateRequestUnionType Да

OpenAI.RealtimeCreateClientSecretRequestExpiresAfter

Имя Тип Описание Обязательно По умолчанию
Якорь Перечисления
Возможные значения: created_at		 Нет
Секунд Целое число Ограничения: min: 10, max: 7200 Нет 600

OpenAI.RealtimeCreateClientSecretResponse

Ответ от создания секрета сеанса и клиента для API Реального времени.

Имя Тип Описание Обязательно По умолчанию
expires_at Целое число Метка времени окончания срока действия секрета клиента в секундах с момента эпохи. Да
Сессии OpenAI.RealtimeSessionCreateResponseUnion Да
Тип └️ OpenAI.RealtimeSessionCreateResponseUnionType Да
Значение Строка Созданное значение секрета клиента. Да

OpenAI.RealtimeFunctionTool

Имя Тип Описание Обязательно По умолчанию
Описание Строка Описание функции, включая рекомендации по тому, когда и как
чтобы вызвать его, и рекомендации о том, что нужно сообщить пользователю при вызове.
(если что-нибудь).		 Нет
Имя Строка Имя функции. Нет
Параметры OpenAI.RealtimeFunctionToolParameters Нет
Тип Перечисления Тип инструмента, т. е. function
Возможные значения: function		 Нет

OpenAI.RealtimeFunctionToolParameters

Тип: объект

OpenAI.RealtimeSessionCreateRequest

Новая конфигурация сеанса Realtime с временным ключом. Срок жизни по умолчанию для ключей составляет одну минуту.

Имя Тип Описание Обязательно По умолчанию
client_secret OpenAI.RealtimeSessionCreateRequestClientSecret Да
└expires_at Целое число Да
Значение └️ Строка Да
input_audio_format Строка Формат входного звука. Параметры: pcm16, g711_ulawили g711_alaw. Нет
input_audio_transcription OpenAI.RealtimeSessionCreateRequestInputAudioTranscription Нет
Модель └️ Строка Нет
Инструкции Строка Системные инструкции по умолчанию (т. е. системное сообщение) предопределены для вызовов модели. Это поле позволяет клиенту управлять моделью по нужным ответам. Модель может быть указана по содержимому ответа и формату (например, "быть чрезвычайно краткой", "действовать понятно", "вот примеры хороших ответов") и по поведению звука (например, "быстро говорить", "вводить эмоции в ваш голос", "смеяться часто"). Инструкции не гарантируются моделью, но они предоставляют рекомендации модели по требуемому поведению.
Обратите внимание, что сервер задает инструкции по умолчанию, которые будут использоваться, если это поле не задано и отображается в событии в session.created начале сеанса.		 Нет
max_response_output_tokens целое число (см. допустимые модели ниже) Максимальное количество выходных маркеров для одного ответа помощника;
включающее вызовы инструментов. Укажите целое число от 1 до 4096.
ограничение выходных маркеров или inf максимально доступных маркеров для
данная модель. По умолчанию используется infзначение .		 Нет
Условия массив строк Набор модальностей, с которыми может реагировать модель. Чтобы отключить звук,
Задайте для этого значение ["text"].		 Нет ['text', 'audio']
output_audio_format Строка Формат выходного звука. Параметры: pcm16, g711_ulawили g711_alaw. Нет
Строке OpenAI.Prompt Ссылка на шаблон запроса и его переменные.
Дополнительные сведения.		 Нет
Скорость Номер Скорость голосового ответа модели. 1.0 — это скорость по умолчанию. 0.25 имеет значение
минимальная скорость. 1.5 — максимальная скорость. Это значение можно изменить только
между поворотами модели, а не во время выполнения ответа.
Ограничения: min: 0.25, max: 1.5		 Нет 1
Температура Номер Температура выборки для модели ограничена [0.6, 1.2]. По умолчанию используется значение 0.8. Нет
tool_choice Строка Как модель выбирает инструменты. Параметры: auto, nonerequiredили
укажите функцию.		 Нет
Инструменты массив OpenAI.RealtimeSessionCreateRequestTools Средства (функции), доступные для модели. Нет
Трассировки строка или объект Параметры конфигурации для трассировки. Установите значение NULL, чтобы отключить трассировку. Раз
Трассировка включена для сеанса, конфигурация не может быть изменена.
auto создаст трассировку для сеанса со значениями по умолчанию для
имя рабочего процесса, идентификатор группы и метаданные.		 Нет
Усечение OpenAI.RealtimeTruncation Если количество маркеров в беседе превышает ограничение входного маркера модели, беседа будет усечена, то есть сообщения (начиная с самого старого) не будут включены в контекст модели. 32k контекстная модель с 4096 максимальными выходными маркерами может включать только 28 224 маркеров в контексте перед усечением.
Клиенты могут настроить поведение усечения для усечения с более низким максимальным ограничением маркера, что является эффективным способом управления использованием маркеров и затратами.
Усечение уменьшит количество кэшированных маркеров в следующем шаге (перебор кэша), так как сообщения удаляются с начала контекста. Однако клиенты также могут настроить усечение для хранения сообщений до доли максимального размера контекста, что приведет к снижению необходимости в будущих усечениях и, таким образом, повышению скорости кэширования.
Усечение может быть полностью отключено, что означает, что сервер никогда не усечен, но вместо этого возвращает ошибку, если беседа превышает ограничение маркера ввода модели.		 Нет
turn_detection OpenAI.RealtimeSessionCreateRequestTurnDetection Нет
└prefix_padding_ms Целое число Нет
└️ silence_duration_ms Целое число Нет
Пороговое значение └️ Номер Нет
Тип └️ Строка Нет
Тип Перечисления
Возможные значения: realtime		 Да
Голос OpenAI.VoiceIdsShared Нет

OpenAI.RealtimeSessionCreateRequestClientSecret

Имя Тип Описание Обязательно По умолчанию
expires_at Целое число Да
Значение Строка Да

OpenAI.RealtimeSessionCreateRequestGA

Конфигурация объекта сеанса в режиме реального времени.

Имя Тип Описание Обязательно По умолчанию
Аудио OpenAI.RealtimeSessionCreateRequestGAAudio Нет
Входные данные └️ OpenAI.RealtimeSessionCreateRequestGAAudioInput Нет
Выходные данные └️ OpenAI.RealtimeSessionCreateRequestGAAudioOutput Нет
Включают массив строк Дополнительные поля для включения в выходные данные сервера.
item.input_audio_transcription.logprobs: включите logprobs для транскрибирования входного звука.		 Нет
Инструкции Строка Системные инструкции по умолчанию (т. е. системное сообщение) предопределены для вызовов модели. Это поле позволяет клиенту управлять моделью по нужным ответам. Модель может быть указана по содержимому ответа и формату (например, "быть чрезвычайно краткой", "действовать понятно", "вот примеры хороших ответов") и по поведению звука (например, "быстро говорить", "вводить эмоции в ваш голос", "смеяться часто"). Инструкции не гарантируются моделью, но они предоставляют рекомендации модели по требуемому поведению.
Обратите внимание, что сервер задает инструкции по умолчанию, которые будут использоваться, если это поле не задано и отображается в событии в session.created начале сеанса.		 Нет
max_output_tokens целое число (см. допустимые модели ниже) Максимальное количество выходных маркеров для одного ответа помощника;
включающее вызовы инструментов. Укажите целое число от 1 до 4096.
ограничение выходных маркеров или inf максимально доступных маркеров для
данная модель. По умолчанию используется infзначение .		 Нет
Модели Строка Модель реального времени, используемая для этого сеанса. Нет
output_modalities массив строк Набор модальностей, с которыми может реагировать модель. Значение по умолчанию , ["audio"]указывающее
что модель будет реагировать на звук и расшифровку. ["text"] можно использовать для создания
Модель отвечает только текстом. Не удается запросить оба text и audio одновременно.		 Нет ['audio']
Строке OpenAI.Prompt Ссылка на шаблон запроса и его переменные.
Дополнительные сведения.		 Нет
tool_choice OpenAI.ToolChoiceOptions или OpenAI.ToolChoiceFunction или OpenAI.ToolChoiceMCP Как модель выбирает инструменты. Укажите один из режимов строки или принудительное применение определенного
средство function/MCP.		 Нет
Инструменты массив OpenAI.RealtimeFunctionTool или OpenAI.MCPTool Средства, доступные для модели. Нет
Трассировки string или OpenAI.RealtimeSessionCreateRequestGATracing или null "" Установите значение NULL, чтобы отключить трассировку. Раз
Трассировка включена для сеанса, конфигурация не может быть изменена.
auto создаст трассировку для сеанса со значениями по умолчанию для
имя рабочего процесса, идентификатор группы и метаданные.		 Нет
Усечение OpenAI.RealtimeTruncation Если количество маркеров в беседе превышает ограничение входного маркера модели, беседа будет усечена, то есть сообщения (начиная с самого старого) не будут включены в контекст модели. 32k контекстная модель с 4096 максимальными выходными маркерами может включать только 28 224 маркеров в контексте перед усечением.
Клиенты могут настроить поведение усечения для усечения с более низким максимальным ограничением маркера, что является эффективным способом управления использованием маркеров и затратами.
Усечение уменьшит количество кэшированных маркеров в следующем шаге (перебор кэша), так как сообщения удаляются с начала контекста. Однако клиенты также могут настроить усечение для хранения сообщений до доли максимального размера контекста, что приведет к снижению необходимости в будущих усечениях и, таким образом, повышению скорости кэширования.
Усечение может быть полностью отключено, что означает, что сервер никогда не усечен, но вместо этого возвращает ошибку, если беседа превышает ограничение маркера ввода модели.		 Нет
Тип Перечисления Тип создаваемого сеанса. Всегда realtime для API Реального времени.
Возможные значения: realtime		 Да

OpenAI.RealtimeSessionCreateRequestGAAudio

Имя Тип Описание Обязательно По умолчанию
Вход OpenAI.RealtimeSessionCreateRequestGAAudioInput Нет
Выход OpenAI.RealtimeSessionCreateRequestGAAudioOutput Нет

OpenAI.RealtimeSessionCreateRequestGAAudioInput

Имя Тип Описание Обязательно По умолчанию
Формат OpenAI.RealtimeAudioFormats Нет
noise_reduction OpenAI.RealtimeSessionCreateRequestGAAudioInputNoiseReduction Нет
Транскрипции OpenAI.AudioTranscription Нет
turn_detection OpenAI.RealtimeTurnDetection Нет

OpenAI.RealtimeSessionCreateRequestGAAudioInputNoiseReduction

Имя Тип Описание Обязательно По умолчанию
Тип OpenAI.NoiseReductionType Тип уменьшения шума. near_field предназначен для микрофонов близкого разговора, таких как наушники, far_field предназначен для микрофонов с дальним полем, таких как ноутбук или микрофоны конференц-зала. Нет

OpenAI.RealtimeSessionCreateRequestGAAudioOutput

Имя Тип Описание Обязательно По умолчанию
Формат OpenAI.RealtimeAudioFormats Нет
Скорость Номер Ограничения: min: 0.25, max: 1.5 Нет 1
Голос OpenAI.VoiceIdsShared Нет

OpenAI.RealtimeSessionCreateRequestGATracing

Имя Тип Описание Обязательно По умолчанию
group_id Строка Нет
Метаданных Объекта Нет
workflow_name Строка Нет

OpenAI.RealtimeSessionCreateRequestInputAudioTranscription

Имя Тип Описание Обязательно По умолчанию
Модели Строка Нет

OpenAI.RealtimeSessionCreateRequestTools

Имя Тип Описание Обязательно По умолчанию
Описание Строка Нет
Имя Строка Нет
Параметры OpenAI.RealtimeSessionCreateRequestToolsParameters Нет
Тип Перечисления
Возможные значения: function		 Нет

OpenAI.RealtimeSessionCreateRequestToolsParameters

Тип: объект

OpenAI.RealtimeSessionCreateRequestTurnDetection

Имя Тип Описание Обязательно По умолчанию
prefix_padding_ms Целое число Нет
silence_duration_ms Целое число Нет
Порог Номер Нет
Тип Строка Нет

OpenAI.RealtimeSessionCreateRequestUnion

Дискриминация для OpenAI.RealtimeSessionCreateRequestUnion

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа Схемы
realtime OpenAI.RealtimeSessionCreateRequest
transcription OpenAI.RealtimeTranscriptionSessionCreateRequest
Имя Тип Описание Обязательно По умолчанию
Тип OpenAI.RealtimeSessionCreateRequestUnionType Да

OpenAI.RealtimeSessionCreateRequestUnionType

Свойство Значение
Тип Строка
Значения realtime
transcription

OpenAI.RealtimeSessionCreateResponse

Объект конфигурации сеанса в режиме реального времени.

Имя Тип Описание Обязательно По умолчанию
Аудио OpenAI.RealtimeSessionCreateResponseAudio Нет
Входные данные └️ OpenAI.RealtimeSessionCreateResponseAudioInput Нет
Выходные данные └️ OpenAI.RealtimeSessionCreateResponseAudioOutput Нет
expires_at Целое число Метка времени окончания срока действия сеанса в секундах с момента эпохи. Нет
Id Строка Уникальный идентификатор сеанса, который выглядит следующим sess_1234567890abcdefобразом. Нет
Включают массив строк Дополнительные поля для включения в выходные данные сервера.
- item.input_audio_transcription.logprobs: включите logprobs для транскрибирования входного звука.		 Нет
Инструкции Строка Системные инструкции по умолчанию (т. е. системное сообщение), предварительно подготовленные для модели
Звонки. Это поле позволяет клиенту управлять моделью в нужном случае
Ответы. Модель может быть указана по содержимому ответа и формату.
(например, "быть чрезвычайно кратким", "акт дружественный", "вот примеры хороших"
ответы) и по поведению звука (например, "говорить быстро", "внедрить эмоции"
в ваш голос", "смеется часто"). Инструкции не гарантируются
за которым следует модель, но они предоставляют рекомендации для модели в
требуемое поведение.
Обратите внимание, что сервер задает инструкции по умолчанию, которые будут использоваться, если это
поле не задано и отображается в событии session.created в
начало сеанса.		 Нет
max_output_tokens целое число (см. допустимые модели ниже) Максимальное количество выходных маркеров для одного ответа помощника;
включающее вызовы инструментов. Укажите целое число от 1 до 4096.
ограничение выходных маркеров или inf максимально доступных маркеров для
данная модель. По умолчанию используется infзначение .		 Нет
Модели Строка Модель реального времени, используемая для этого сеанса. Нет
Объекта Строка Тип объекта. Всегда realtime.session. Нет
output_modalities массив строк Набор модальностей, с которыми может реагировать модель. Чтобы отключить звук,
Задайте для этого значение ["text"].		 Нет
tool_choice Строка Как модель выбирает инструменты. Параметры: auto, nonerequiredили
укажите функцию.		 Нет
Инструменты массив OpenAI.RealtimeFunctionTool Средства (функции), доступные для модели. Нет
Трассировки строка или объект Параметры конфигурации для трассировки. Установите значение NULL, чтобы отключить трассировку. Раз
Трассировка включена для сеанса, конфигурация не может быть изменена.
auto создаст трассировку для сеанса со значениями по умолчанию для
имя рабочего процесса, идентификатор группы и метаданные.		 Нет
turn_detection OpenAI.RealtimeSessionCreateResponseTurnDetection Нет
└prefix_padding_ms Целое число Нет
└️ silence_duration_ms Целое число Нет
Пороговое значение └️ Номер Нет
Тип └️ Строка Нет
Тип Перечисления
Возможные значения: realtime		 Да

OpenAI.RealtimeSessionCreateResponseAudio

Имя Тип Описание Обязательно По умолчанию
Вход OpenAI.RealtimeSessionCreateResponseAudioInput Нет
Выход OpenAI.RealtimeSessionCreateResponseAudioOutput Нет

OpenAI.RealtimeSessionCreateResponseAudioInput

Имя Тип Описание Обязательно По умолчанию
Формат OpenAI.RealtimeAudioFormats Нет
noise_reduction OpenAI.RealtimeSessionCreateResponseAudioInputNoiseReduction Нет
Транскрипции OpenAI.AudioTranscription Нет
turn_detection OpenAI.RealtimeSessionCreateResponseAudioInputTurnDetection Нет

OpenAI.RealtimeSessionCreateResponseAudioInputNoiseReduction

Имя Тип Описание Обязательно По умолчанию
Тип OpenAI.NoiseReductionType Тип уменьшения шума. near_field предназначен для микрофонов близкого разговора, таких как наушники, far_field предназначен для микрофонов с дальним полем, таких как ноутбук или микрофоны конференц-зала. Нет

OpenAI.RealtimeSessionCreateResponseAudioInputTurnDetection

Имя Тип Описание Обязательно По умолчанию
prefix_padding_ms Целое число Нет
silence_duration_ms Целое число Нет
Порог Номер Нет
Тип Строка Нет

OpenAI.RealtimeSessionCreateResponseAudioOutput

Имя Тип Описание Обязательно По умолчанию
Формат OpenAI.RealtimeAudioFormats Нет
Скорость Номер Нет
Голос OpenAI.VoiceIdsShared Нет

OpenAI.RealtimeSessionCreateResponseTurnDetection

Имя Тип Описание Обязательно По умолчанию
prefix_padding_ms Целое число Нет
silence_duration_ms Целое число Нет
Порог Номер Нет
Тип Строка Нет

OpenAI.RealtimeSessionCreateResponseUnion

Дискриминация для OpenAI.RealtimeSessionCreateResponseUnion

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа Схемы
realtime OpenAI.RealtimeSessionCreateResponse
transcription OpenAI.RealtimeTranscriptionSessionCreateResponse
Имя Тип Описание Обязательно По умолчанию
Тип OpenAI.RealtimeSessionCreateResponseUnionType Да

OpenAI.RealtimeSessionCreateResponseUnionType

Свойство Значение
Тип Строка
Значения realtime
transcription

OpenAI.RealtimeTranscriptionSessionCreateRequest

Конфигурация объекта сеанса транскрибирования в реальном времени.

Имя Тип Описание Обязательно По умолчанию
Включают массив строк Набор элементов для включения в транскрибирование. Текущие доступные элементы:
item.input_audio_transcription.logprobs		 Нет
input_audio_format Перечисления Формат входного звука. Параметры: pcm16, g711_ulawили g711_alaw.
Для pcm16, входной звук должен быть 16-разрядным PCM с частотой выборки 24-кГц,
один канал (mono) и байтовый порядок байтов с небольшим эндианом.
Возможные значения: pcm16, g711_ulawg711_alaw		 Нет
input_audio_noise_reduction OpenAI.RealtimeTranscriptionSessionCreateRequestInputAudioNoiseReduction Нет
Тип └️ OpenAI.NoiseReductionType Тип уменьшения шума. near_field предназначен для микрофонов близкого разговора, таких как наушники, far_field предназначен для микрофонов с дальним полем, таких как ноутбук или микрофоны конференц-зала. Нет
input_audio_transcription OpenAI.AudioTranscription Нет
Язык └️ Строка Язык входного звука. Предоставление языка ввода в
ФОРМАТ ISO-639-1 (например) en
повысит точность и задержку.		 Нет
Модель └️ Строка Модель, используемая для транскрибирования. Текущие параметры: whisper-1, gpt-4o-mini-transcribe, gpt-4o-mini-transcribe-2025-12-15, gpt-4o-transcribeи gpt-4o-transcribe-diarize. Используйте, когда требуется gpt-4o-transcribe-diarize диаризация с метками говорящего. Нет
Запрос └️ Строка Необязательный текст для руководства по стилю модели или продолжения предыдущего звука
Сегмента.
Для whisper-1этого запрос — это список ключевых слов.
Для gpt-4o-transcribe моделей (за исключением), запрос — это бесплатная текстовая строка, например "ожидающие gpt-4o-transcribe-diarizeслова, связанные с технологией".		 Нет
turn_detection OpenAI.RealtimeTranscriptionSessionCreateRequestTurnDetection Нет
└prefix_padding_ms Целое число Нет
└️ silence_duration_ms Целое число Нет
Пороговое значение └️ Номер Нет
Тип └️ Перечисления
Возможные значения: server_vad		 Нет
Тип Перечисления
Возможные значения: transcription		 Да

OpenAI.RealtimeTranscriptionSessionCreateRequestInputAudioNoiseReduction

Имя Тип Описание Обязательно По умолчанию
Тип OpenAI.NoiseReductionType Тип уменьшения шума. near_field предназначен для микрофонов близкого разговора, таких как наушники, far_field предназначен для микрофонов с дальним полем, таких как ноутбук или микрофоны конференц-зала. Нет

OpenAI.RealtimeTranscriptionSessionCreateRequestTurnDetection

Имя Тип Описание Обязательно По умолчанию
prefix_padding_ms Целое число Нет
silence_duration_ms Целое число Нет
Порог Номер Нет
Тип Перечисления
Возможные значения: server_vad		 Нет

OpenAI.RealtimeTranscriptionSessionCreateResponse

Новая конфигурация сеанса транскрибирования в реальном времени. При создании сеанса на сервере с помощью REST API объект сеанса также содержит временный ключ. Значение TTL по умолчанию для ключей составляет 10 минут. Это свойство отсутствует при обновлении сеанса через API WebSocket.

Имя Тип Описание Обязательно По умолчанию
client_secret OpenAI.RealtimeTranscriptionSessionCreateResponseClientSecret Да
└expires_at Целое число Да
Значение └️ Строка Да
input_audio_format Строка Формат входного звука. Параметры: pcm16, g711_ulawили g711_alaw. Нет
input_audio_transcription OpenAI.AudioTranscription Нет
Язык └️ Строка Язык входного звука. Предоставление языка ввода в
ФОРМАТ ISO-639-1 (например) en
повысит точность и задержку.		 Нет
Модель └️ Строка Модель, используемая для транскрибирования. Текущие параметры: whisper-1, gpt-4o-mini-transcribe, gpt-4o-mini-transcribe-2025-12-15, gpt-4o-transcribeи gpt-4o-transcribe-diarize. Используйте, когда требуется gpt-4o-transcribe-diarize диаризация с метками говорящего. Нет
Запрос └️ Строка Необязательный текст для руководства по стилю модели или продолжения предыдущего звука
Сегмента.
Для whisper-1этого запрос — это список ключевых слов.
Для gpt-4o-transcribe моделей (за исключением), запрос — это бесплатная текстовая строка, например "ожидающие gpt-4o-transcribe-diarizeслова, связанные с технологией".		 Нет
Условия массив строк Набор модальностей, с которыми может реагировать модель. Чтобы отключить звук,
Задайте для этого значение ["text"].		 Нет
turn_detection OpenAI.RealtimeTranscriptionSessionCreateResponseTurnDetection Нет
└prefix_padding_ms Целое число Нет
└️ silence_duration_ms Целое число Нет
Пороговое значение └️ Номер Нет
Тип └️ Строка Нет
Тип Перечисления
Возможные значения: transcription		 Да

OpenAI.RealtimeTranscriptionSessionCreateResponseClientSecret

Имя Тип Описание Обязательно По умолчанию
expires_at Целое число Да
Значение Строка Да

OpenAI.RealtimeTranscriptionSessionCreateResponseTurnDetection

Имя Тип Описание Обязательно По умолчанию
prefix_padding_ms Целое число Нет
silence_duration_ms Целое число Нет
Порог Номер Нет
Тип Строка Нет

OpenAI.RealtimeTruncation

Если количество маркеров в беседе превышает ограничение входного маркера модели, беседа будет усечена, то есть сообщения (начиная с самого старого) не будут включены в контекст модели. 32k контекстная модель с 4096 максимальными выходными маркерами может включать только 28 224 маркеров в контексте перед усечением. Клиенты могут настроить поведение усечения для усечения с более низким максимальным ограничением маркера, что является эффективным способом управления использованием маркеров и затратами. Усечение уменьшит количество кэшированных маркеров в следующем шаге (перебор кэша), так как сообщения удаляются с начала контекста. Однако клиенты также могут настроить усечение для хранения сообщений до доли максимального размера контекста, что приведет к снижению необходимости в будущих усечениях и, таким образом, повышению скорости кэширования. Усечение может быть полностью отключено, что означает, что сервер никогда не усечен, но вместо этого возвращает ошибку, если беседа превышает ограничение маркера ввода модели.

Свойство Значение
Тип Строка
Значения auto
disabled

OpenAI.RealtimeTurnDetection

Дискриминация для OpenAI.RealtimeTurnDetection

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа Схемы
Имя Тип Описание Обязательно По умолчанию
Тип OpenAI.RealtimeTurnDetectionType Да

OpenAI.RealtimeTurnDetectionType

Тип: строка

OpenAI.Reasoning

Только модели 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 строка или null Нет
Сводка строка или null Нет

OpenAI.ReasoningEffort

Ограничивает усилия по рассуждениям моделей. В настоящее время поддерживаются noneзначения , , minimal, lowmedium, highи xhigh. Сокращение усилий по поводу может привести к более быстрым откликам и меньшем количестве маркеров, используемых при рассуждениях в ответе.

  • gpt-5.1 по умолчанию используется noneзначение , которое не выполняет причину. Поддерживаемые значения gpt-5.1 аргументов: none, lowmediumи high. Вызовы инструментов поддерживаются для всех значений причин в gpt-5.1.
  • Все модели до выполнения gpt-5.1 действий по умолчанию и medium не поддерживаются none.
  • Модель gpt-5-pro по умолчанию используется (и поддерживает только) high усилия по соображениям.
  • xhigh поддерживается для всех моделей после gpt-5.1-codex-max.
Свойство Значение
Тип Строка
Значения none
minimal
low
medium
high
xhigh

OpenAI.ReasoningTextContent

Вывод текста из модели.

Имя Тип Описание Обязательно По умолчанию
Текст Строка Текст причины из модели. Да
Тип Перечисления Тип текста причины. Всегда reasoning_text.
Возможные значения: reasoning_text		 Да

OpenAI.ОтказContent

Отказ от модели.

Имя Тип Описание Обязательно По умолчанию
Отказ Строка Объяснение отказа от модели. Да
Тип Перечисления Тип отказа. Всегда refusal.
Возможные значения: refusal		 Да

OpenAI.Response

Имя Тип Описание Обязательно По умолчанию
Фон логический или null Нет
completed_at строка или null Нет
content_filters массив AzureContentFilterForResponsesAPI Фильтр содержимого приводит к результату RAI. Да
Разговор OpenAI.ConversationReference или null Нет
created_at Целое число Метка времени Unix (в секундах) при создании этого ответа. Да
Ошибка OpenAI.ResponseError или null Да
Id Строка Уникальный идентификатор для этого ответа. Да
incomplete_details OpenAI.ResponseIncompleteDetails или null Да
Инструкции строка или массив OpenAI.InputItem или null Да
max_output_tokens целое число или null Нет
max_tool_calls целое число или null Нет
Метаданных OpenAI.Metadata или NULL Нет
Модели Строка Идентификатор модели, используемый для создания ответа, например gpt-4o или o3. OpenAI
предлагает широкий спектр моделей с разными возможностями, производительностью
характеристики и цены. См. руководство по модели
для просмотра и сравнения доступных моделей.		 Нет
Объекта Перечисления Тип объекта этого ресурса — всегда задано responseзначение .
Возможные значения: response		 Да
Выход массив OpenAI.OutputItem Массив элементов контента, созданных моделью.
— Длина и порядок элементов в массиве output зависит
в ответе модели.
— Вместо доступа к первому элементу в массиве output и
Предполагая, что это assistant сообщение с содержимым, созданным
Модель, можно рассмотреть возможность использования output_text свойства, где
поддерживается в пакетах SDK.		 Да
output_text строка или null Нет
parallel_tool_calls Логических Следует ли разрешить модели запускать вызовы инструментов параллельно. Да Истинный
previous_response_id строка или null Нет
Строке OpenAI.Prompt Ссылка на шаблон запроса и его переменные.
Дополнительные сведения.		 Нет
prompt_cache_key Строка Используется OpenAI для кэширования ответов для аналогичных запросов для оптимизации частоты попаданий кэша. Заменяет user поле. Дополнительные сведения. Нет
prompt_cache_retention строка или null Нет
Рассуждения OpenAI.Reasoning или NULL Нет
safety_identifier Строка Стабильный идентификатор, используемый для обнаружения пользователей приложения, которые могут нарушать политики использования OpenAI.
Идентификаторы должны быть строкой, которая однозначно идентифицирует каждого пользователя. Мы рекомендуем хэшировать имя пользователя или адрес электронной почты, чтобы избежать отправки нам каких-либо сведений об идентификации. Дополнительные сведения.		 Нет
Статус Перечисления Состояние создания ответа. Один из completed, failed
in_progress, , cancelledqueuedили incomplete.
Возможные значения: completed, , failedin_progresscancelled, queuedincomplete		 Нет
Температура число или null Нет
Текст OpenAI.ResponseTextParam Параметры конфигурации для текстового ответа модели. Может быть простым
текстовые или структурированные данные JSON. Подробнее:
- Текстовые входные и выходные данные
- Структурированные выходные данные		 Нет
tool_choice OpenAI.ToolChoiceParam Как модель должна выбрать инструмент (или средства), которые следует использовать при создании
ответ. См. tools параметр, чтобы узнать, как указать инструменты
Модель может вызываться.		 Нет
Инструменты OpenAI.ToolsArray Массив инструментов, которые модель может вызывать при создании ответа. Вы
может указать, какое средство следует использовать, задав tool_choice параметр.
Мы поддерживаем следующие категории инструментов:
- Встроенные средства: средства, предоставляемые OpenAI, расширяющие
Возможности модели, такие как поиск в Интернете
или поиск по файлам. Дополнительные сведения
встроенные средства.
- Инструменты MCP: интеграция с сторонними системами с помощью пользовательских серверов MCP
или предопределенные соединители, такие как Google Drive и SharePoint. Дополнительные сведения
Инструменты MCP.
- Вызовы функций (пользовательские средства): функции, определенные вами,
включение модели для вызова собственного кода с строго типизированными аргументами
и выходные данные. Дополнительные сведения
вызов функции. Вы также можете использовать
пользовательские средства для вызова собственного кода.		 Нет
top_logprobs целое число или null Нет
top_p число или null Нет
Усечение строка или null Нет
Использования OpenAI.ResponseUsage Представляет сведения об использовании маркеров, включая входные маркеры, выходные маркеры,
разбивка выходных маркеров и общих используемых маркеров.		 Нет
Пользователя string (не рекомендуется) Это поле заменяется safety_identifier и prompt_cache_key. Вместо этого используйте prompt_cache_key для поддержания оптимизации кэширования.
Стабильный идентификатор для конечных пользователей.
Используется для повышения скорости попадания кэша в более эффективное сегментирование аналогичных запросов и помогает OpenAI обнаруживать и предотвращать злоупотребление. Дополнительные сведения.		 Нет

OpenAI.ResponseAudioDeltaEvent

Создается при наличии частичного звукового ответа.

Имя Тип Описание Обязательно По умолчанию
Дельта Строка Блок аудиобайта в кодировке Base64. Да
sequence_number Целое число Порядковый номер для этого блока ответа потока. Да
Тип Перечисления Тип события. Всегда response.audio.delta.
Возможные значения: response.audio.delta		 Да

OpenAI.ResponseAudioTranscriptDeltaEvent

Создается при частичной расшифровки звука.

Имя Тип Описание Обязательно По умолчанию
Дельта Строка Частичное расшифровка звукового ответа. Да
sequence_number Целое число Порядковый номер этого события. Да
Тип Перечисления Тип события. Всегда response.audio.transcript.delta.
Возможные значения: response.audio.transcript.delta		 Да

OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent

Создается при потоковой передаче фрагмента частичного кода интерпретатором кода.

Имя Тип Описание Обязательно По умолчанию
Дельта Строка Фрагмент частичного кода, передаваемый интерпретатором кода. Да
item_id Строка Уникальный идентификатор элемента вызова средства интерпретатора кода. Да
output_index Целое число Индекс выходного элемента в ответе, для которого выполняется потоковая передача кода. Да
sequence_number Целое число Порядковый номер этого события, используемый для заказа событий потоковой передачи. Да
Тип Перечисления Тип события. Всегда response.code_interpreter_call_code.delta.
Возможные значения: response.code_interpreter_call_code.delta		 Да

OpenAI.ResponseCodeInterpreterCallInProgressEvent

Создается при выполнении вызова интерпретатора кода.

Имя Тип Описание Обязательно По умолчанию
item_id Строка Уникальный идентификатор элемента вызова средства интерпретатора кода. Да
output_index Целое число Индекс выходного элемента в ответе, для которого выполняется вызов интерпретатора кода. Да
sequence_number Целое число Порядковый номер этого события, используемый для заказа событий потоковой передачи. Да
Тип Перечисления Тип события. Всегда response.code_interpreter_call.in_progress.
Возможные значения: response.code_interpreter_call.in_progress		 Да

OpenAI.ResponseCodeInterpreterCallInterpretingEvent

Создается, когда интерпретатор кода активно интерпретирует фрагмент кода.

Имя Тип Описание Обязательно По умолчанию
item_id Строка Уникальный идентификатор элемента вызова средства интерпретатора кода. Да
output_index Целое число Индекс выходного элемента в ответе, для которого интерпретатор кода интерпретирует код. Да
sequence_number Целое число Порядковый номер этого события, используемый для заказа событий потоковой передачи. Да
Тип Перечисления Тип события. Всегда response.code_interpreter_call.interpreting.
Возможные значения: response.code_interpreter_call.interpreting		 Да

OpenAI.ResponseContentPartAddedEvent

Создается при добавлении новой части содержимого.

Имя Тип Описание Обязательно По умолчанию
content_index Целое число Индекс добавленной части содержимого. Да
item_id Строка Идентификатор выходного элемента, к которому была добавлена часть содержимого. Да
output_index Целое число Индекс выходного элемента, к которому была добавлена часть содержимого. Да
Часть OpenAI.OutputContent Да
Тип └️ OpenAI.OutputContentType Да
sequence_number Целое число Порядковый номер этого события. Да
Тип Перечисления Тип события. Всегда response.content_part.added.
Возможные значения: response.content_part.added		 Да

OpenAI.ResponseCreatedEvent

Событие, которое создается при создании ответа.

Имя Тип Описание Обязательно По умолчанию
Ответ OpenAI.Response Да
Фон └️ логический или null Нет
└️ completed_at строка или null Нет
└️ content_filters массив AzureContentFilterForResponsesAPI Фильтр содержимого приводит к результату RAI. Да
Беседа └️ OpenAI.ConversationReference или null Нет
└️ created_at Целое число Метка времени Unix (в секундах) при создании этого ответа. Да
Ошибка └️ OpenAI.ResponseError или null Да
Идентификатор └️ Строка Уникальный идентификатор для этого ответа. Да
└️ incomplete_details OpenAI.ResponseIncompleteDetails или null Да
Инструкции └️ строка или массив OpenAI.InputItem или null Да
└️ max_output_tokens целое число или null Нет
└️ max_tool_calls целое число или null Нет
Метаданные └️ OpenAI.Metadata или NULL Нет
Модель └️ Строка Идентификатор модели, используемый для создания ответа, например gpt-4o или o3. OpenAI
предлагает широкий спектр моделей с разными возможностями, производительностью
характеристики и цены. См. руководство по модели
для просмотра и сравнения доступных моделей.		 Нет
Объект └️ Перечисления Тип объекта этого ресурса — всегда задано responseзначение .
Возможные значения: response		 Да
Выходные данные └️ массив OpenAI.OutputItem Массив элементов контента, созданных моделью.
— Длина и порядок элементов в массиве output зависит
в ответе модели.
— Вместо доступа к первому элементу в массиве output и
Предполагая, что это assistant сообщение с содержимым, созданным
Модель, можно рассмотреть возможность использования output_text свойства, где
поддерживается в пакетах SDK.		 Да
└️ output_text строка или null Нет
└️ parallel_tool_calls Логических Следует ли разрешить модели запускать вызовы инструментов параллельно. Да Истинный
└previous_response_id строка или null Нет
Запрос └️ OpenAI.Prompt Ссылка на шаблон запроса и его переменные.
Дополнительные сведения.		 Нет
└prompt_cache_key Строка Используется OpenAI для кэширования ответов для аналогичных запросов для оптимизации частоты попаданий кэша. Заменяет user поле. Дополнительные сведения. Нет
└prompt_cache_retention строка или null Нет
└️ рассуждения OpenAI.Reasoning или NULL Нет
└safety_identifier Строка Стабильный идентификатор, используемый для обнаружения пользователей приложения, которые могут нарушать политики использования OpenAI.
Идентификаторы должны быть строкой, которая однозначно идентифицирует каждого пользователя. Мы рекомендуем хэшировать имя пользователя или адрес электронной почты, чтобы избежать отправки нам каких-либо сведений об идентификации. Дополнительные сведения.		 Нет
Состояние └️ Перечисления Состояние создания ответа. Один из completed, failed
in_progress, , cancelledqueuedили incomplete.
Возможные значения: completed, , failedin_progresscancelled, queuedincomplete		 Нет
Температура └️ число или null Нет 1
Текст └️ OpenAI.ResponseTextParam Параметры конфигурации для текстового ответа модели. Может быть простым
текстовые или структурированные данные JSON. Подробнее:
- Текстовые входные и выходные данные
- Структурированные выходные данные		 Нет
└tool_choice OpenAI.ToolChoiceParam Как модель должна выбрать инструмент (или средства), которые следует использовать при создании
ответ. См. tools параметр, чтобы узнать, как указать инструменты
Модель может вызываться.		 Нет
Средства └️ OpenAI.ToolsArray Массив инструментов, которые модель может вызывать при создании ответа. Вы
может указать, какое средство следует использовать, задав tool_choice параметр.
Мы поддерживаем следующие категории инструментов:
- Встроенные средства: средства, предоставляемые OpenAI, расширяющие
Возможности модели, такие как поиск в Интернете
или поиск по файлам. Дополнительные сведения
встроенные средства.
- Инструменты MCP: интеграция с сторонними системами с помощью пользовательских серверов MCP
или предопределенные соединители, такие как Google Drive и SharePoint. Дополнительные сведения
Инструменты MCP.
- Вызовы функций (пользовательские средства): функции, определенные вами,
включение модели для вызова собственного кода с строго типизированными аргументами
и выходные данные. Дополнительные сведения
вызов функции. Вы также можете использовать
пользовательские средства для вызова собственного кода.		 Нет
└️ top_logprobs целое число или null Нет
└️ top_p число или null Нет 1
└️ усечение строка или null Нет Отключен
Использование └️ OpenAI.ResponseUsage Представляет сведения об использовании маркеров, включая входные маркеры, выходные маркеры,
разбивка выходных маркеров и общих используемых маркеров.		 Нет
Пользователь └️ string (не рекомендуется) Это поле заменяется safety_identifier и prompt_cache_key. Вместо этого используйте prompt_cache_key для поддержания оптимизации кэширования.
Стабильный идентификатор для конечных пользователей.
Используется для повышения скорости попадания кэша в более эффективное сегментирование аналогичных запросов и помогает OpenAI обнаруживать и предотвращать злоупотребление. Дополнительные сведения.		 Нет
sequence_number Целое число Порядковый номер для этого события. Да
Тип Перечисления Тип события. Всегда response.created.
Возможные значения: response.created		 Да

OpenAI.ResponseCustomToolCallInputDeltaEvent

Событие, представляющее разностное (частичное обновление) для ввода пользовательского вызова средства.

Имя Тип Описание Обязательно По умолчанию
Дельта Строка Добавочные входные данные (delta) для вызова пользовательского средства. Да
item_id Строка Уникальный идентификатор элемента API, связанного с этим событием. Да
output_index Целое число Индекс выходных данных, к которые применяется эта разность. Да
sequence_number Целое число Порядковый номер этого события. Да
Тип Перечисления Идентификатор типа события.
Возможные значения: response.custom_tool_call_input.delta		 Да

OpenAI.ResponseError

Объект ошибки, возвращаемый, когда модель не сможет создать ответ.

Имя Тип Описание Обязательно По умолчанию
Код OpenAI.ResponseErrorCode Код ошибки для ответа. Да
Сообщение Строка Описание ошибки, доступной для чтения человеком. Да

OpenAI.ResponseErrorCode

Код ошибки для ответа.

Свойство Значение
Тип Строка
Значения 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

Создается при возникновении ошибки.

Имя Тип Описание Обязательно По умолчанию
Код строка или null Да
Сообщение Строка Сообщение об ошибке. Да
Param строка или null Да
sequence_number Целое число Порядковый номер этого события. Да
Тип Перечисления Тип события. Всегда error.
Возможные значения: error		 Да

OpenAI.ResponseFailedEvent

Событие, которое возникает при сбое ответа.

Имя Тип Описание Обязательно По умолчанию
Ответ OpenAI.Response Да
Фон └️ логический или null Нет
└️ completed_at строка или null Нет
└️ content_filters массив AzureContentFilterForResponsesAPI Фильтр содержимого приводит к результату RAI. Да
Беседа └️ OpenAI.ConversationReference или null Нет
└️ created_at Целое число Метка времени Unix (в секундах) при создании этого ответа. Да
Ошибка └️ OpenAI.ResponseError или null Да
Идентификатор └️ Строка Уникальный идентификатор для этого ответа. Да
└️ incomplete_details OpenAI.ResponseIncompleteDetails или null Да
Инструкции └️ строка или массив OpenAI.InputItem или null Да
└️ max_output_tokens целое число или null Нет
└️ max_tool_calls целое число или null Нет
Метаданные └️ OpenAI.Metadata или NULL Нет
Модель └️ Строка Идентификатор модели, используемый для создания ответа, например gpt-4o или o3. OpenAI
предлагает широкий спектр моделей с разными возможностями, производительностью
характеристики и цены. См. руководство по модели
для просмотра и сравнения доступных моделей.		 Нет
Объект └️ Перечисления Тип объекта этого ресурса — всегда задано responseзначение .
Возможные значения: response		 Да
Выходные данные └️ массив OpenAI.OutputItem Массив элементов контента, созданных моделью.
— Длина и порядок элементов в массиве output зависит
в ответе модели.
— Вместо доступа к первому элементу в массиве output и
Предполагая, что это assistant сообщение с содержимым, созданным
Модель, можно рассмотреть возможность использования output_text свойства, где
поддерживается в пакетах SDK.		 Да
└️ output_text строка или null Нет
└️ parallel_tool_calls Логических Следует ли разрешить модели запускать вызовы инструментов параллельно. Да Истинный
└previous_response_id строка или null Нет
Запрос └️ OpenAI.Prompt Ссылка на шаблон запроса и его переменные.
Дополнительные сведения.		 Нет
└prompt_cache_key Строка Используется OpenAI для кэширования ответов для аналогичных запросов для оптимизации частоты попаданий кэша. Заменяет user поле. Дополнительные сведения. Нет
└prompt_cache_retention строка или null Нет
└️ рассуждения OpenAI.Reasoning или NULL Нет
└safety_identifier Строка Стабильный идентификатор, используемый для обнаружения пользователей приложения, которые могут нарушать политики использования OpenAI.
Идентификаторы должны быть строкой, которая однозначно идентифицирует каждого пользователя. Мы рекомендуем хэшировать имя пользователя или адрес электронной почты, чтобы избежать отправки нам каких-либо сведений об идентификации. Дополнительные сведения.		 Нет
Состояние └️ Перечисления Состояние создания ответа. Один из completed, failed
in_progress, , cancelledqueuedили incomplete.
Возможные значения: completed, , failedin_progresscancelled, queuedincomplete		 Нет
Температура └️ число или null Нет 1
Текст └️ OpenAI.ResponseTextParam Параметры конфигурации для текстового ответа модели. Может быть простым
текстовые или структурированные данные JSON. Подробнее:
- Текстовые входные и выходные данные
- Структурированные выходные данные		 Нет
└tool_choice OpenAI.ToolChoiceParam Как модель должна выбрать инструмент (или средства), которые следует использовать при создании
ответ. См. tools параметр, чтобы узнать, как указать инструменты
Модель может вызываться.		 Нет
Средства └️ OpenAI.ToolsArray Массив инструментов, которые модель может вызывать при создании ответа. Вы
может указать, какое средство следует использовать, задав tool_choice параметр.
Мы поддерживаем следующие категории инструментов:
- Встроенные средства: средства, предоставляемые OpenAI, расширяющие
Возможности модели, такие как поиск в Интернете
или поиск по файлам. Дополнительные сведения
встроенные средства.
- Инструменты MCP: интеграция с сторонними системами с помощью пользовательских серверов MCP
или предопределенные соединители, такие как Google Drive и SharePoint. Дополнительные сведения
Инструменты MCP.
- Вызовы функций (пользовательские средства): функции, определенные вами,
включение модели для вызова собственного кода с строго типизированными аргументами
и выходные данные. Дополнительные сведения
вызов функции. Вы также можете использовать
пользовательские средства для вызова собственного кода.		 Нет
└️ top_logprobs целое число или null Нет
└️ top_p число или null Нет 1
└️ усечение строка или null Нет Отключен
Использование └️ OpenAI.ResponseUsage Представляет сведения об использовании маркеров, включая входные маркеры, выходные маркеры,
разбивка выходных маркеров и общих используемых маркеров.		 Нет
Пользователь └️ string (не рекомендуется) Это поле заменяется safety_identifier и prompt_cache_key. Вместо этого используйте prompt_cache_key для поддержания оптимизации кэширования.
Стабильный идентификатор для конечных пользователей.
Используется для повышения скорости попадания кэша в более эффективное сегментирование аналогичных запросов и помогает OpenAI обнаруживать и предотвращать злоупотребление. Дополнительные сведения.		 Нет
sequence_number Целое число Порядковый номер этого события. Да
Тип Перечисления Тип события. Всегда response.failed.
Возможные значения: response.failed		 Да

OpenAI.ResponseFileSearchCallInProgressEvent

Создается при инициировании вызова поиска файлов.

Имя Тип Описание Обязательно По умолчанию
item_id Строка Идентификатор выходного элемента, инициируемого вызовом поиска файлов. Да
output_index Целое число Индекс выходного элемента, инициируемого вызовом поиска файлов. Да
sequence_number Целое число Порядковый номер этого события. Да
Тип Перечисления Тип события. Всегда response.file_search_call.in_progress.
Возможные значения: response.file_search_call.in_progress		 Да

OpenAI.ResponseFileCallSearchingEvent

Создается при поиске файла в настоящее время.

Имя Тип Описание Обязательно По умолчанию
item_id Строка Идентификатор выходного элемента, инициируемого вызовом поиска файлов. Да
output_index Целое число Индекс выходного элемента, вызываемого вызовом поиска файлов. Да
sequence_number Целое число Порядковый номер этого события. Да
Тип Перечисления Тип события. Всегда response.file_search_call.searching.
Возможные значения: response.file_search_call.searching		 Да

OpenAI.ResponseFormatJsonObject

Формат отклика объекта JSON. Старый метод создания ответов JSON. Рекомендуется использовать json_schema для моделей, поддерживающих его. Обратите внимание, что модель не будет генерировать JSON без системного или пользовательского сообщения о том, что это нужно сделать.

Имя Тип Описание Обязательно По умолчанию
Тип Перечисления Тип определяемого формата ответа. Всегда json_object.
Возможные значения: json_object		 Да

OpenAI.ResponseFormatJsonSchema

Формат ответа схемы JSON. Используется для создания структурированных ответов JSON. Дополнительные сведения о структурированных выходных данных.

Имя Тип Описание Обязательно По умолчанию
json_schema OpenAI.ResponseFormatJsonSchemaJsonSchemaSchema Да
Описание └️ Строка Нет
└️ имя Строка Да
Схема └️ OpenAI.ResponseFormatJsonSchema Схема формата ответа, описанная как объект схемы JSON.
Узнайте, как создать схемы JSON здесь.		 Нет
└️ строгий логический или null Нет
Тип Перечисления Тип определяемого формата ответа. Всегда json_schema.
Возможные значения: json_schema		 Да

OpenAI.ResponseFormatJsonSchemaJsonSchemaSchema

Имя Тип Описание Обязательно По умолчанию
Описание Строка Нет
Имя Строка Да
Схемы OpenAI.ResponseFormatJsonSchema Схема формата ответа, описанная как объект схемы JSON.
Узнайте, как создать схемы JSON здесь.		 Нет
Строгий логический или null Нет

OpenAI.ResponseFormatJsonSchema

Схема формата ответа, описанная как объект схемы JSON. Узнайте, как создать схемы JSON здесь.

Тип: объект

OpenAI.ResponseFormatText

Формат ответа по умолчанию. Используется для создания текстовых ответов.

Имя Тип Описание Обязательно По умолчанию
Тип Перечисления Тип определяемого формата ответа. Всегда text.
Возможные значения: text		 Да

OpenAI.ResponseFunctionCallArgumentsDeltaEvent

Создается при наличии разностных аргументов вызова функции.

Имя Тип Описание Обязательно По умолчанию
Дельта Строка Добавлен разностный аргумент вызова функции. Да
item_id Строка Идентификатор выходного элемента, к которому добавляется разностное значение аргументов вызова функции. Да
output_index Целое число Индекс выходного элемента, к которому добавляется разность аргументов вызова функции. Да
sequence_number Целое число Порядковый номер этого события. Да
Тип Перечисления Тип события. Всегда response.function_call_arguments.delta.
Возможные значения: response.function_call_arguments.delta		 Да

OpenAI.ResponseImageGenCallGeneratingEvent

Создается при вызове средства создания изображений активное создание образа (промежуточное состояние).

Имя Тип Описание Обязательно По умолчанию
item_id Строка Уникальный идентификатор обрабатываемого элемента создания изображения. Да
output_index Целое число Индекс выходного элемента в выходном массиве ответа. Да
sequence_number Целое число Порядковый номер обрабатываемого элемента создания изображения. Да
Тип Перечисления Тип события. Всегда "response.image_generation_call.generating".
Возможные значения: response.image_generation_call.generating		 Да

OpenAI.ResponseImageGenCallInProgressEvent

Создается при выполнении вызова средства создания изображений.

Имя Тип Описание Обязательно По умолчанию
item_id Строка Уникальный идентификатор обрабатываемого элемента создания изображения. Да
output_index Целое число Индекс выходного элемента в выходном массиве ответа. Да
sequence_number Целое число Порядковый номер обрабатываемого элемента создания изображения. Да
Тип Перечисления Тип события. Всегда "response.image_generation_call.in_progress".
Возможные значения: response.image_generation_call.in_progress		 Да

OpenAI.ResponseImageGenCallPartialImageEvent

Создается при наличии частичного образа во время потоковой передачи изображений.

Имя Тип Описание Обязательно По умолчанию
item_id Строка Уникальный идентификатор обрабатываемого элемента создания изображения. Да
output_index Целое число Индекс выходного элемента в выходном массиве ответа. Да
partial_image_b64 Строка Данные частичного изображения в кодировке Base64, подходящие для отрисовки в виде изображения. Да
partial_image_index Целое число 0-й индекс для частичного образа (серверная часть основана на 1, но это 0 для пользователя). Да
sequence_number Целое число Порядковый номер обрабатываемого элемента создания изображения. Да
Тип Перечисления Тип события. Всегда "response.image_generation_call.partial_image".
Возможные значения: response.image_generation_call.partial_image		 Да

OpenAI.ResponseInProgressEvent

Создается при выполнении ответа.

Имя Тип Описание Обязательно По умолчанию
Ответ OpenAI.Response Да
Фон └️ логический или null Нет
└️ completed_at строка или null Нет
└️ content_filters массив AzureContentFilterForResponsesAPI Фильтр содержимого приводит к результату RAI. Да
Беседа └️ OpenAI.ConversationReference или null Нет
└️ created_at Целое число Метка времени Unix (в секундах) при создании этого ответа. Да
Ошибка └️ OpenAI.ResponseError или null Да
Идентификатор └️ Строка Уникальный идентификатор для этого ответа. Да
└️ incomplete_details OpenAI.ResponseIncompleteDetails или null Да
Инструкции └️ строка или массив OpenAI.InputItem или null Да
└️ max_output_tokens целое число или null Нет
└️ max_tool_calls целое число или null Нет
Метаданные └️ OpenAI.Metadata или NULL Нет
Модель └️ Строка Идентификатор модели, используемый для создания ответа, например gpt-4o или o3. OpenAI
предлагает широкий спектр моделей с разными возможностями, производительностью
характеристики и цены. См. руководство по модели
для просмотра и сравнения доступных моделей.		 Нет
Объект └️ Перечисления Тип объекта этого ресурса — всегда задано responseзначение .
Возможные значения: response		 Да
Выходные данные └️ массив OpenAI.OutputItem Массив элементов контента, созданных моделью.
— Длина и порядок элементов в массиве output зависит
в ответе модели.
— Вместо доступа к первому элементу в массиве output и
Предполагая, что это assistant сообщение с содержимым, созданным
Модель, можно рассмотреть возможность использования output_text свойства, где
поддерживается в пакетах SDK.		 Да
└️ output_text строка или null Нет
└️ parallel_tool_calls Логических Следует ли разрешить модели запускать вызовы инструментов параллельно. Да Истинный
└previous_response_id строка или null Нет
Запрос └️ OpenAI.Prompt Ссылка на шаблон запроса и его переменные.
Дополнительные сведения.		 Нет
└prompt_cache_key Строка Используется OpenAI для кэширования ответов для аналогичных запросов для оптимизации частоты попаданий кэша. Заменяет user поле. Дополнительные сведения. Нет
└prompt_cache_retention строка или null Нет
└️ рассуждения OpenAI.Reasoning или NULL Нет
└safety_identifier Строка Стабильный идентификатор, используемый для обнаружения пользователей приложения, которые могут нарушать политики использования OpenAI.
Идентификаторы должны быть строкой, которая однозначно идентифицирует каждого пользователя. Мы рекомендуем хэшировать имя пользователя или адрес электронной почты, чтобы избежать отправки нам каких-либо сведений об идентификации. Дополнительные сведения.		 Нет
Состояние └️ Перечисления Состояние создания ответа. Один из completed, failed
in_progress, , cancelledqueuedили incomplete.
Возможные значения: completed, , failedin_progresscancelled, queuedincomplete		 Нет
Температура └️ число или null Нет 1
Текст └️ OpenAI.ResponseTextParam Параметры конфигурации для текстового ответа модели. Может быть простым
текстовые или структурированные данные JSON. Подробнее:
- Текстовые входные и выходные данные
- Структурированные выходные данные		 Нет
└tool_choice OpenAI.ToolChoiceParam Как модель должна выбрать инструмент (или средства), которые следует использовать при создании
ответ. См. tools параметр, чтобы узнать, как указать инструменты
Модель может вызываться.		 Нет
Средства └️ OpenAI.ToolsArray Массив инструментов, которые модель может вызывать при создании ответа. Вы
может указать, какое средство следует использовать, задав tool_choice параметр.
Мы поддерживаем следующие категории инструментов:
- Встроенные средства: средства, предоставляемые OpenAI, расширяющие
Возможности модели, такие как поиск в Интернете
или поиск по файлам. Дополнительные сведения
встроенные средства.
- Инструменты MCP: интеграция с сторонними системами с помощью пользовательских серверов MCP
или предопределенные соединители, такие как Google Drive и SharePoint. Дополнительные сведения
Инструменты MCP.
- Вызовы функций (пользовательские средства): функции, определенные вами,
включение модели для вызова собственного кода с строго типизированными аргументами
и выходные данные. Дополнительные сведения
вызов функции. Вы также можете использовать
пользовательские средства для вызова собственного кода.		 Нет
└️ top_logprobs целое число или null Нет
└️ top_p число или null Нет 1
└️ усечение строка или null Нет Отключен
Использование └️ OpenAI.ResponseUsage Представляет сведения об использовании маркеров, включая входные маркеры, выходные маркеры,
разбивка выходных маркеров и общих используемых маркеров.		 Нет
Пользователь └️ string (не рекомендуется) Это поле заменяется safety_identifier и prompt_cache_key. Вместо этого используйте prompt_cache_key для поддержания оптимизации кэширования.
Стабильный идентификатор для конечных пользователей.
Используется для повышения скорости попадания кэша в более эффективное сегментирование аналогичных запросов и помогает OpenAI обнаруживать и предотвращать злоупотребление. Дополнительные сведения.		 Нет
sequence_number Целое число Порядковый номер этого события. Да
Тип Перечисления Тип события. Всегда response.in_progress.
Возможные значения: response.in_progress		 Да

OpenAI.ResponseIncompleteDetails

Имя Тип Описание Обязательно По умолчанию
Причина Перечисления
Возможные значения: max_output_tokens, content_filter		 Нет

OpenAI.ResponseIncompleteEvent

Событие, которое возникает, когда ответ завершается как неполный.

Имя Тип Описание Обязательно По умолчанию
Ответ OpenAI.Response Да
Фон └️ логический или null Нет
└️ completed_at строка или null Нет
└️ content_filters массив AzureContentFilterForResponsesAPI Фильтр содержимого приводит к результату RAI. Да
Беседа └️ OpenAI.ConversationReference или null Нет
└️ created_at Целое число Метка времени Unix (в секундах) при создании этого ответа. Да
Ошибка └️ OpenAI.ResponseError или null Да
Идентификатор └️ Строка Уникальный идентификатор для этого ответа. Да
└️ incomplete_details OpenAI.ResponseIncompleteDetails или null Да
Инструкции └️ строка или массив OpenAI.InputItem или null Да
└️ max_output_tokens целое число или null Нет
└️ max_tool_calls целое число или null Нет
Метаданные └️ OpenAI.Metadata или NULL Нет
Модель └️ Строка Идентификатор модели, используемый для создания ответа, например gpt-4o или o3. OpenAI
предлагает широкий спектр моделей с разными возможностями, производительностью
характеристики и цены. См. руководство по модели
для просмотра и сравнения доступных моделей.		 Нет
Объект └️ Перечисления Тип объекта этого ресурса — всегда задано responseзначение .
Возможные значения: response		 Да
Выходные данные └️ массив OpenAI.OutputItem Массив элементов контента, созданных моделью.
— Длина и порядок элементов в массиве output зависит
в ответе модели.
— Вместо доступа к первому элементу в массиве output и
Предполагая, что это assistant сообщение с содержимым, созданным
Модель, можно рассмотреть возможность использования output_text свойства, где
поддерживается в пакетах SDK.		 Да
└️ output_text строка или null Нет
└️ parallel_tool_calls Логических Следует ли разрешить модели запускать вызовы инструментов параллельно. Да Истинный
└previous_response_id строка или null Нет
Запрос └️ OpenAI.Prompt Ссылка на шаблон запроса и его переменные.
Дополнительные сведения.		 Нет
└prompt_cache_key Строка Используется OpenAI для кэширования ответов для аналогичных запросов для оптимизации частоты попаданий кэша. Заменяет user поле. Дополнительные сведения. Нет
└prompt_cache_retention строка или null Нет
└️ рассуждения OpenAI.Reasoning или NULL Нет
└safety_identifier Строка Стабильный идентификатор, используемый для обнаружения пользователей приложения, которые могут нарушать политики использования OpenAI.
Идентификаторы должны быть строкой, которая однозначно идентифицирует каждого пользователя. Мы рекомендуем хэшировать имя пользователя или адрес электронной почты, чтобы избежать отправки нам каких-либо сведений об идентификации. Дополнительные сведения.		 Нет
Состояние └️ Перечисления Состояние создания ответа. Один из completed, failed
in_progress, , cancelledqueuedили incomplete.
Возможные значения: completed, , failedin_progresscancelled, queuedincomplete		 Нет
Температура └️ число или null Нет 1
Текст └️ OpenAI.ResponseTextParam Параметры конфигурации для текстового ответа модели. Может быть простым
текстовые или структурированные данные JSON. Подробнее:
- Текстовые входные и выходные данные
- Структурированные выходные данные		 Нет
└tool_choice OpenAI.ToolChoiceParam Как модель должна выбрать инструмент (или средства), которые следует использовать при создании
ответ. См. tools параметр, чтобы узнать, как указать инструменты
Модель может вызываться.		 Нет
Средства └️ OpenAI.ToolsArray Массив инструментов, которые модель может вызывать при создании ответа. Вы
может указать, какое средство следует использовать, задав tool_choice параметр.
Мы поддерживаем следующие категории инструментов:
- Встроенные средства: средства, предоставляемые OpenAI, расширяющие
Возможности модели, такие как поиск в Интернете
или поиск по файлам. Дополнительные сведения
встроенные средства.
- Инструменты MCP: интеграция с сторонними системами с помощью пользовательских серверов MCP
или предопределенные соединители, такие как Google Drive и SharePoint. Дополнительные сведения
Инструменты MCP.
- Вызовы функций (пользовательские средства): функции, определенные вами,
включение модели для вызова собственного кода с строго типизированными аргументами
и выходные данные. Дополнительные сведения
вызов функции. Вы также можете использовать
пользовательские средства для вызова собственного кода.		 Нет
└️ top_logprobs целое число или null Нет
└️ top_p число или null Нет 1
└️ усечение строка или null Нет Отключен
Использование └️ OpenAI.ResponseUsage Представляет сведения об использовании маркеров, включая входные маркеры, выходные маркеры,
разбивка выходных маркеров и общих используемых маркеров.		 Нет
Пользователь └️ string (не рекомендуется) Это поле заменяется safety_identifier и prompt_cache_key. Вместо этого используйте prompt_cache_key для поддержания оптимизации кэширования.
Стабильный идентификатор для конечных пользователей.
Используется для повышения скорости попадания кэша в более эффективное сегментирование аналогичных запросов и помогает OpenAI обнаруживать и предотвращать злоупотребление. Дополнительные сведения.		 Нет
sequence_number Целое число Порядковый номер этого события. Да
Тип Перечисления Тип события. Всегда response.incomplete.
Возможные значения: response.incomplete		 Да

OpenAI.ResponseItemList

Список элементов ответа.

Имя Тип Описание Обязательно По умолчанию
Данных массив OpenAI.ItemResource Список элементов, используемых для создания этого ответа. Да
first_id Строка Идентификатор первого элемента в списке. Да
has_more Логических Доступны ли дополнительные элементы. Да
last_id Строка Идентификатор последнего элемента в списке. Да
Объекта Перечисления Тип возвращаемого объекта должен быть list.
Возможные значения: list		 Да

OpenAI.ResponseLogProb

Logprob — это логарифмическая вероятность того, что модель назначает определенному маркеру по заданной позиции в последовательности. Менее отрицательные (более высокие) значения logprob указывают на большее доверие модели к выбору маркера.

Имя Тип Описание Обязательно По умолчанию
logprob Номер Вероятность этого токена в журнале. Да
Маркер Строка Возможный текстовый маркер. Да
top_logprobs массив OpenAI.ResponseLogProbTopLogprobs Вероятность ведения журнала наиболее вероятных маркеров из 20 лучших. Нет

OpenAI.ResponseLogProbTopLogprobs

Имя Тип Описание Обязательно По умолчанию
logprob Номер Нет
Маркер Строка Нет

OpenAI.ResponseMCPCallArgumentsDeltaEvent

Создается при наличии разностного (частичного обновления) аргументов вызова средства MCP.

Имя Тип Описание Обязательно По умолчанию
Дельта Строка Строка JSON, содержащая частичное обновление аргументов для вызова средства MCP. Да
item_id Строка Уникальный идентификатор обрабатываемого элемента вызова средства MCP. Да
output_index Целое число Индекс выходного элемента в выходном массиве ответа. Да
sequence_number Целое число Порядковый номер этого события. Да
Тип Перечисления Тип события. Всегда "response.mcp_call_arguments.delta".
Возможные значения: response.mcp_call_arguments.delta		 Да

OpenAI.ResponseMCPCallFailedEvent

Создается при сбое вызова средства MCP.

Имя Тип Описание Обязательно По умолчанию
item_id Строка Идентификатор элемента вызова средства MCP, который завершился сбоем. Да
output_index Целое число Индекс выходного элемента, который завершился сбоем. Да
sequence_number Целое число Порядковый номер этого события. Да
Тип Перечисления Тип события. Всегда "response.mcp_call.failed".
Возможные значения: response.mcp_call.failed		 Да

OpenAI.ResponseMCPCallInProgressEvent

Создается при выполнении вызова средства MCP.

Имя Тип Описание Обязательно По умолчанию
item_id Строка Уникальный идентификатор обрабатываемого элемента вызова средства MCP. Да
output_index Целое число Индекс выходного элемента в выходном массиве ответа. Да
sequence_number Целое число Порядковый номер этого события. Да
Тип Перечисления Тип события. Всегда "response.mcp_call.in_progress".
Возможные значения: response.mcp_call.in_progress		 Да

OpenAI.ResponseMCPListToolsFailedEvent

Возникает при сбое попытки перечисления доступных средств MCP.

Имя Тип Описание Обязательно По умолчанию
item_id Строка Идентификатор элемента вызова средства MCP, который завершился сбоем. Да
output_index Целое число Индекс выходного элемента, который завершился сбоем. Да
sequence_number Целое число Порядковый номер этого события. Да
Тип Перечисления Тип события. Всегда "response.mcp_list_tools.failed".
Возможные значения: response.mcp_list_tools.failed		 Да

OpenAI.ResponseMCPListToolsInProgressEvent

Создается, когда система находится в процессе получения списка доступных средств MCP.

Имя Тип Описание Обязательно По умолчанию
item_id Строка Идентификатор обрабатываемого элемента вызова средства MCP. Да
output_index Целое число Индекс обрабатываемого выходного элемента. Да
sequence_number Целое число Порядковый номер этого события. Да
Тип Перечисления Тип события. Всегда "response.mcp_list_tools.in_progress".
Возможные значения: response.mcp_list_tools.in_progress		 Да

OpenAI.ResponseModalities

Типы выходных данных, которые вы хотите создать модель. Большинство моделей могут создавать текст, который по умолчанию: ["text"] Модель gpt-4o-audio-preview также может использоваться для создания звука. Чтобы запросить, что эта модель создает как текстовые, так и звуковые ответы, можно использовать: ["text", "audio"]

Эта схема принимает один из следующих типов:

  • Массива
  • Null

OpenAI.ResponseOutputItemAddedEvent

Создается при добавлении нового выходного элемента.

Имя Тип Описание Обязательно По умолчанию
Элемента OpenAI.OutputItem Да
Тип └️ OpenAI.OutputItemType Да
output_index Целое число Индекс добавленного выходного элемента. Да
sequence_number Целое число Порядковый номер этого события. Да
Тип Перечисления Тип события. Всегда response.output_item.added.
Возможные значения: response.output_item.added		 Да

OpenAI.ResponseOutputTextAnnotationAddedEvent

Создается при добавлении заметки в выходное текстовое содержимое.

Имя Тип Описание Обязательно По умолчанию
Аннотации OpenAI.Annotation Заметка, которая применяется к диапазону выходного текста. Да
Тип └️ OpenAI.AnnotationType Да
annotation_index Целое число Индекс заметки в части содержимого. Да
content_index Целое число Индекс части содержимого в выходном элементе. Да
item_id Строка Уникальный идентификатор элемента, к которому добавляется заметка. Да
output_index Целое число Индекс выходного элемента в выходном массиве ответа. Да
sequence_number Целое число Порядковый номер этого события. Да
Тип Перечисления Тип события. Всегда "response.output_text.annotation.added".
Возможные значения: response.output_text.annotation.added		 Да

OpenAI.ResponsePromptVariables

Необязательная карта значений для замены переменных в запросе. Значения подстановки могут быть строками или другими типами входных данных ответа, такими как изображения или файлы.

Тип: объект

OpenAI.ResponseQueuedEvent

Создается при очереди ответа и ожидании обработки.

Имя Тип Описание Обязательно По умолчанию
Ответ OpenAI.Response Да
Фон └️ логический или null Нет
└️ completed_at строка или null Нет
└️ content_filters массив AzureContentFilterForResponsesAPI Фильтр содержимого приводит к результату RAI. Да
Беседа └️ OpenAI.ConversationReference или null Нет
└️ created_at Целое число Метка времени Unix (в секундах) при создании этого ответа. Да
Ошибка └️ OpenAI.ResponseError или null Да
Идентификатор └️ Строка Уникальный идентификатор для этого ответа. Да
└️ incomplete_details OpenAI.ResponseIncompleteDetails или null Да
Инструкции └️ строка или массив OpenAI.InputItem или null Да
└️ max_output_tokens целое число или null Нет
└️ max_tool_calls целое число или null Нет
Метаданные └️ OpenAI.Metadata или NULL Нет
Модель └️ Строка Идентификатор модели, используемый для создания ответа, например gpt-4o или o3. OpenAI
предлагает широкий спектр моделей с разными возможностями, производительностью
характеристики и цены. См. руководство по модели
для просмотра и сравнения доступных моделей.		 Нет
Объект └️ Перечисления Тип объекта этого ресурса — всегда задано responseзначение .
Возможные значения: response		 Да
Выходные данные └️ массив OpenAI.OutputItem Массив элементов контента, созданных моделью.
— Длина и порядок элементов в массиве output зависит
в ответе модели.
— Вместо доступа к первому элементу в массиве output и
Предполагая, что это assistant сообщение с содержимым, созданным
Модель, можно рассмотреть возможность использования output_text свойства, где
поддерживается в пакетах SDK.		 Да
└️ output_text строка или null Нет
└️ parallel_tool_calls Логических Следует ли разрешить модели запускать вызовы инструментов параллельно. Да Истинный
└previous_response_id строка или null Нет
Запрос └️ OpenAI.Prompt Ссылка на шаблон запроса и его переменные.
Дополнительные сведения.		 Нет
└prompt_cache_key Строка Используется OpenAI для кэширования ответов для аналогичных запросов для оптимизации частоты попаданий кэша. Заменяет user поле. Дополнительные сведения. Нет
└prompt_cache_retention строка или null Нет
└️ рассуждения OpenAI.Reasoning или NULL Нет
└safety_identifier Строка Стабильный идентификатор, используемый для обнаружения пользователей приложения, которые могут нарушать политики использования OpenAI.
Идентификаторы должны быть строкой, которая однозначно идентифицирует каждого пользователя. Мы рекомендуем хэшировать имя пользователя или адрес электронной почты, чтобы избежать отправки нам каких-либо сведений об идентификации. Дополнительные сведения.		 Нет
Состояние └️ Перечисления Состояние создания ответа. Один из completed, failed
in_progress, , cancelledqueuedили incomplete.
Возможные значения: completed, , failedin_progresscancelled, queuedincomplete		 Нет
Температура └️ число или null Нет 1
Текст └️ OpenAI.ResponseTextParam Параметры конфигурации для текстового ответа модели. Может быть простым
текстовые или структурированные данные JSON. Подробнее:
- Текстовые входные и выходные данные
- Структурированные выходные данные		 Нет
└tool_choice OpenAI.ToolChoiceParam Как модель должна выбрать инструмент (или средства), которые следует использовать при создании
ответ. См. tools параметр, чтобы узнать, как указать инструменты
Модель может вызываться.		 Нет
Средства └️ OpenAI.ToolsArray Массив инструментов, которые модель может вызывать при создании ответа. Вы
может указать, какое средство следует использовать, задав tool_choice параметр.
Мы поддерживаем следующие категории инструментов:
- Встроенные средства: средства, предоставляемые OpenAI, расширяющие
Возможности модели, такие как поиск в Интернете
или поиск по файлам. Дополнительные сведения
встроенные средства.
- Инструменты MCP: интеграция с сторонними системами с помощью пользовательских серверов MCP
или предопределенные соединители, такие как Google Drive и SharePoint. Дополнительные сведения
Инструменты MCP.
- Вызовы функций (пользовательские средства): функции, определенные вами,
включение модели для вызова собственного кода с строго типизированными аргументами
и выходные данные. Дополнительные сведения
вызов функции. Вы также можете использовать
пользовательские средства для вызова собственного кода.		 Нет
└️ top_logprobs целое число или null Нет
└️ top_p число или null Нет 1
└️ усечение строка или null Нет Отключен
Использование └️ OpenAI.ResponseUsage Представляет сведения об использовании маркеров, включая входные маркеры, выходные маркеры,
разбивка выходных маркеров и общих используемых маркеров.		 Нет
Пользователь └️ string (не рекомендуется) Это поле заменяется safety_identifier и prompt_cache_key. Вместо этого используйте prompt_cache_key для поддержания оптимизации кэширования.
Стабильный идентификатор для конечных пользователей.
Используется для повышения скорости попадания кэша в более эффективное сегментирование аналогичных запросов и помогает OpenAI обнаруживать и предотвращать злоупотребление. Дополнительные сведения.		 Нет
sequence_number Целое число Порядковый номер для этого события. Да
Тип Перечисления Тип события. Всегда "response.queued".
Возможные значения: response.queued		 Да

OpenAI.ResponseReasoningSummaryPartAddedEvent

Создается при добавлении новой сводной части сводных причин.

Имя Тип Описание Обязательно По умолчанию
item_id Строка Идентификатор элемента, с которым связана эта сводная часть. Да
output_index Целое число Индекс выходного элемента, с которым связана сводная часть. Да
Часть OpenAI.ResponseReasoningSummaryPartAddedEventPart Да
Текст └️ Строка Да
Тип └️ Перечисления
Возможные значения: summary_text		 Да
sequence_number Целое число Порядковый номер этого события. Да
summary_index Целое число Индекс сводной части в сводке по причинам. Да
Тип Перечисления Тип события. Всегда response.reasoning_summary_part.added.
Возможные значения: response.reasoning_summary_part.added		 Да

OpenAI.ResponseReasoningSummaryPartAddedEventPart

Имя Тип Описание Обязательно По умолчанию
Текст Строка Да
Тип Перечисления
Возможные значения: summary_text		 Да

OpenAI.ResponseReasoningSummaryTextDeltaEvent

Создается при добавлении разностного изменения в текст сводной информации.

Имя Тип Описание Обязательно По умолчанию
Дельта Строка Разностный текст, добавленный в сводку. Да
item_id Строка Идентификатор элемента, с которым связана разность текста сводки. Да
output_index Целое число Индекс выходного элемента, с которым связана сводная разность текста. Да
sequence_number Целое число Порядковый номер этого события. Да
summary_index Целое число Индекс сводной части в сводке по причинам. Да
Тип Перечисления Тип события. Всегда response.reasoning_summary_text.delta.
Возможные значения: response.reasoning_summary_text.delta		 Да

OpenAI.ResponseReasoningTextDeltaEvent

Создается при добавлении разностного изменения в текст причины.

Имя Тип Описание Обязательно По умолчанию
content_index Целое число Индекс части содержимого причины, с которой связана эта разность. Да
Дельта Строка Разностный текст, добавленный в содержимое причины. Да
item_id Строка Идентификатор элемента, с которым связан разностный текст. Да
output_index Целое число Индекс выходного элемента, с которым связан разностный текст. Да
sequence_number Целое число Порядковый номер этого события. Да
Тип Перечисления Тип события. Всегда response.reasoning_text.delta.
Возможные значения: response.reasoning_text.delta		 Да

OpenAI.ResponseRefusalDeltaEvent

Создается при наличии частичного текста отказа.

Имя Тип Описание Обязательно По умолчанию
content_index Целое число Индекс части содержимого, в которую добавляется текст отказа. Да
Дельта Строка Добавлен текст отказа. Да
item_id Строка Идентификатор выходного элемента, к которому добавляется текст отказа. Да
output_index Целое число Индекс выходного элемента, к которому добавляется текст отказа. Да
sequence_number Целое число Порядковый номер этого события. Да
Тип Перечисления Тип события. Всегда response.refusal.delta.
Возможные значения: response.refusal.delta		 Да

OpenAI.ResponseStreamOptions

Параметры потоковых ответов. Этот параметр устанавливается только при установке stream: true.

Имя Тип Описание Обязательно По умолчанию
include_obfuscation Логических Если задано значение true, будет включена обфускация потока. Добавляется скрытие потока
случайные символы в поле потоковой передачи obfuscation событий разностных событий в
нормализованные размеры полезных данных в качестве устранения определенных атак на стороне канала.
Эти поля маскировки включены по умолчанию, но добавьте небольшое количество.
затраты на поток данных. Можно задать include_obfuscation значение
False для оптимизации пропускной способности, если вы доверяете сетевым каналам между
приложение и API OpenAI.		 Нет

OpenAI.ResponseTextDeltaEvent

Создается при наличии дополнительного разностного текста.

Имя Тип Описание Обязательно По умолчанию
content_index Целое число Индекс части содержимого, в которую был добавлен разностный текст. Да
Дельта Строка Добавлена разностная строка текста. Да
item_id Строка Идентификатор выходного элемента, к которому был добавлен разностный текст. Да
logprobs массив OpenAI.ResponseLogProb Вероятности журналов маркеров в разностном формате. Да
output_index Целое число Индекс выходного элемента, к которому был добавлен разностный текст. Да
sequence_number Целое число Порядковый номер для этого события. Да
Тип Перечисления Тип события. Всегда response.output_text.delta.
Возможные значения: response.output_text.delta		 Да

OpenAI.ResponseTextParam

Параметры конфигурации для текстового ответа модели. Можно использовать обычный текст или структурированные данные JSON. Подробнее:

Имя Тип Описание Обязательно По умолчанию
Формат OpenAI.TextResponseFormatConfiguration Объект, указывающий формат, который должен выводить модель.
{ "type": "json_schema" } Настройка включает структурированные выходные данные,
это гарантирует, что модель будет соответствовать предоставленной схеме JSON. Дополнительные сведения см. в разделе

Формат по умолчанию не имеет { "type": "text" } дополнительных параметров.
*Не рекомендуется для gpt-4o и более новых моделей:
Параметр включения { "type": "json_object" } более старого режима JSON, который
гарантирует, что сообщение, которое создает модель, является допустимым JSON. Используя json_schema
предпочтителен для моделей, поддерживающих его.		 Нет
Детализации OpenAI.Verbosity Ограничивает детализацию ответа модели. Более низкие значения будут приводить к
более краткие ответы, в то время как более высокие значения приводят к более подробным ответам.
В настоящее время поддерживаются lowзначения , mediumи high.		 Нет

OpenAI.ResponseUsage

Представляет сведения об использовании маркеров, включая входные маркеры, выходные маркеры, разбивку выходных маркеров и общие используемые маркеры.

Имя Тип Описание Обязательно По умолчанию
input_tokens Целое число Количество входных маркеров. Да
input_tokens_details OpenAI.ResponseUsageInputTokensDetails Да
└️ cached_tokens Целое число Да
output_tokens Целое число Количество выходных маркеров. Да
output_tokens_details OpenAI.ResponseUsageOutputTokensDetails Да
└️ reasoning_tokens Целое число Да
total_tokens Целое число Общее количество используемых маркеров. Да

OpenAI.ResponseUsageInputTokensDetails

Имя Тип Описание Обязательно По умолчанию
cached_tokens Целое число Да

OpenAI.ResponseUsageOutputTokensDetails

Имя Тип Описание Обязательно По умолчанию
reasoning_tokens Целое число Да

OpenAI.ResponseWebSearchCallInProgressEvent

Примечание. web_search еще недоступен через Azure OpenAI.

Имя Тип Описание Обязательно По умолчанию
item_id Строка Уникальный идентификатор выходного элемента, связанного с вызовом поиска в Интернете. Да
output_index Целое число Индекс выходного элемента, с которым связан вызов веб-поиска. Да
sequence_number Целое число Порядковый номер обрабатываемого вызова поиска в Интернете. Да
Тип Перечисления Тип события. Всегда response.web_search_call.in_progress.
Возможные значения: response.web_search_call.in_progress		 Да

OpenAI.ResponseWebSearchCallSearchingEvent

Примечание. web_search еще недоступен через Azure OpenAI.

Имя Тип Описание Обязательно По умолчанию
item_id Строка Уникальный идентификатор выходного элемента, связанного с вызовом поиска в Интернете. Да
output_index Целое число Индекс выходного элемента, с которым связан вызов веб-поиска. Да
sequence_number Целое число Порядковый номер обрабатываемого вызова поиска в Интернете. Да
Тип Перечисления Тип события. Всегда response.web_search_call.searching.
Возможные значения: response.web_search_call.searching		 Да

OpenAI.RunCompletionUsage

Статистика использования, связанная с выполнением. Это значение будет иметь значение null , если выполнение не находится в состоянии терминала (т. е. in_progress, queuedи т. д.).

Имя Тип Описание Обязательно По умолчанию
completion_tokens Целое число Количество маркеров завершения, используемых в ходе выполнения. Да
prompt_tokens Целое число Количество маркеров запроса, используемых в ходе выполнения. Да
total_tokens Целое число Общее количество используемых маркеров (запрос и завершение). Да

OpenAI.RunGraderRequest

Имя Тип Описание Обязательно По умолчанию
Грейдер OpenAI.GraderStringCheck или OpenAI.GraderTextSimilarity или OpenAI.GraderPython или OpenAI.GraderScoreModel или OpenAI.GraderMulti или GraderEndpoint Классировщик, используемый для задания тонкой настройки. Да
Элемента OpenAI.RunGraderRequestItem Нет
model_sample Строка Пример модели, который необходимо оценить. Это значение будет использоваться для заполнения
sample пространство имен. Дополнительные сведения см . в руководстве .
Переменная output_json будет заполнена, если пример модели является примером
допустимая строка JSON.		 Да

OpenAI.RunGraderRequestItem

Тип: объект

OpenAI.RunGraderResponse

Имя Тип Описание Обязательно По умолчанию
Метаданных OpenAI.RunGraderResponseMetadata Да
model_grader_token_usage_per_model Объекта Да
Награда Номер Да
sub_rewards Объекта Да

OpenAI.RunGraderResponseMetadata

Имя Тип Описание Обязательно По умолчанию
Ошибки OpenAI.RunGraderResponseMetadataErrors Да
execution_time Номер Да
Имя Строка Да
sampled_model_name строка или null Да
Отзывов Объекта Да
token_usage целое число или null Да
Тип Строка Да

OpenAI.RunGraderResponseMetadataErrors

Имя Тип Описание Обязательно По умолчанию
formula_parse_error Логических Да
invalid_variable_error Логических Да
model_grader_parse_error Логических Да
model_grader_refusal_error Логических Да
model_grader_server_error Логических Да
model_grader_server_error_details строка или null Да
other_error Логических Да
python_grader_runtime_error Логических Да
python_grader_runtime_error_details строка или null Да
python_grader_server_error Логических Да
python_grader_server_error_type строка или null Да
sample_parse_error Логических Да
truncated_observation_error Логических Да
unresponsive_reward_error Логических Да

OpenAI.RunObject

Представляет выполнение в потоке.

Имя Тип Описание Обязательно По умолчанию
assistant_id Строка Идентификатор помощника , используемого для выполнения этого запуска. Да
cancelled_at строка или null Метка времени Unix (в секундах) для момента отмены выполнения. Да
completed_at строка или null Метка времени Unix (в секундах) для завершения выполнения. Да
created_at Целое число Метка времени Unix (в секундах) для момента создания запуска. Да
expires_at строка или null Метка времени Unix (в секундах) для истечения срока действия выполнения. Да
failed_at строка или null Метка времени Unix (в секундах) для момента сбоя выполнения. Да
Id Строка Идентификатор, на который можно ссылаться в конечных точках API. Да
incomplete_details OpenAI.RunObjectIncompleteDetails или null Сведения о том, почему выполнение является неполным. Будет, null если выполнение не является неполным. Да
Инструкции Строка Инструкции, используемые помощником для этого запуска. Да
last_error OpenAI.RunObjectLastError или null Последняя ошибка, связанная с этим выполнением. null Если ошибок нет. Да
max_completion_tokens целое число или null Максимальное количество маркеров завершения, указанных в ходе выполнения. Да
max_prompt_tokens целое число или null Максимальное количество маркеров запроса, указанных в ходе выполнения. Да
Метаданных OpenAI.Metadata или NULL Да
Модели Строка Модель, используемая помощником для этого запуска. Да
Объекта Перечисления Тип объекта, который всегда thread.runявляется .
Возможные значения: thread.run		 Да
parallel_tool_calls OpenAI.ParallelToolCalls Следует ли включить параллельные вызовы функций во время использования средства. Да
required_action OpenAI.RunObjectRequiredAction или null Сведения о действии, необходимом для продолжения выполнения. null Если никаких действий не требуется. Да
response_format OpenAI.AssistantsApiResponseFormatOption Указывает формат, который модель должна выводить. Совместим с GPT-4o, GPT-4 Turbo и всеми моделями GPT-3.5 Turbo с тех пор gpt-3.5-turbo-1106.
{ "type": "json_schema", "json_schema": {...} } Чтобы включить структурированные выходные данные, которые гарантируют, что модель будет соответствовать предоставленной схеме JSON. Дополнительные сведения см. в разделе
Параметр включения { "type": "json_object" } режима JSON, который гарантирует, что модель создает сообщение является допустимым JSON.
Важно:* при использовании режима JSON необходимо также указать модели создавать JSON самостоятельно с помощью системного или пользовательского сообщения. Без этого модель может создать неуправляемый поток пробелов до тех пор, пока поколение не достигнет предела маркера, в результате чего длительный и, казалось бы, "застрявший" запрос. Кроме того, обратите внимание, что содержимое сообщения может быть частично отрезано, если finish_reason="length", что указывает на превышение поколения max_tokens или беседа превысила максимальную длину контекста.		 Да
started_at строка или null Метка времени Unix (в секундах) для начала выполнения. Да
Статус OpenAI.RunStatus Состояние выполнения, которое может быть queued, in_progressrequires_actioncancellingcancelled, , failedcompletedincompleteили .expired Да
Температура число или null Температура выборки, используемая для этого запуска. Если значение не задано, значение по умолчанию — 1. Нет
thread_id Строка Идентификатор потока , выполняемого в рамках этого запуска. Да
tool_choice OpenAI.AssistantsApiToolChoiceOption Определяет, какое средство (если таковое) вызывается моделью.
none означает, что модель не будет вызывать средства и вместо этого создает сообщение.
auto — это значение по умолчанию и означает, что модель может выбирать между созданием сообщения или вызовом одного или нескольких инструментов.
required означает, что модель должна вызывать один или несколько инструментов, прежде чем отвечать на запрос пользователя.
Указание определенного инструмента, например {"type": "file_search"} или {"type": "function", "function": {"name": "my_function"}} принудительное вызов модели.		 Да
Инструменты массив OpenAI.AssistantTool Список инструментов, используемых помощником для этого запуска. Да []
top_p число или null Значение выборки ядра, используемое для этого запуска. Если значение не задано, значение по умолчанию — 1. Нет
truncation_strategy OpenAI.TruncationObject Определяет, как поток будет усечен до выполнения. Используйте это для управления начальным окном контекста выполнения. Да
Использования OpenAI.RunCompletionUsage или null Да

OpenAI.RunObjectIncompleteDetails

Имя Тип Описание Обязательно По умолчанию
Причина Перечисления
Возможные значения: max_completion_tokens, max_prompt_tokens		 Нет

OpenAI.RunObjectLastError

Имя Тип Описание Обязательно По умолчанию
Код Перечисления
Возможные значения: server_error, rate_limit_exceededinvalid_prompt		 Да
Сообщение Строка Да

OpenAI.RunObjectRequiredAction

Имя Тип Описание Обязательно По умолчанию
submit_tool_outputs OpenAI.RunObjectRequiredActionSubmitToolOutputs Да
Тип Перечисления
Возможные значения: submit_tool_outputs		 Да

OpenAI.RunObjectRequiredActionSubmitToolOutputs

Имя Тип Описание Обязательно По умолчанию
tool_calls массив OpenAI.RunToolCallObject Да

OpenAI.RunStatus

Состояние выполнения, которое может быть queued, in_progressrequires_actioncancellingcancelled, , failedcompletedincompleteили .expired

Свойство Значение
Тип Строка
Значения queued
in_progress
requires_action
cancelling
cancelled
failed
completed
incomplete
expired

OpenAI.RunStepCompletionUsage

Статистика использования, связанная с шагом выполнения. Это значение будет находиться null в состоянии in_progressшага выполнения.

Имя Тип Описание Обязательно По умолчанию
completion_tokens Целое число Количество маркеров завершения, используемых на этапе выполнения. Да
prompt_tokens Целое число Количество маркеров запроса, используемых на этапе выполнения. Да
total_tokens Целое число Общее количество используемых маркеров (запрос и завершение). Да

OpenAI.RunStepDetailsMessageCreationObject

Сведения о создании сообщения на шаге выполнения.

Имя Тип Описание Обязательно По умолчанию
message_creation OpenAI.RunStepDetailsMessageCreationObjectMessageCreation Да
Тип Перечисления Всегда message_creation.
Возможные значения: message_creation		 Да

OpenAI.RunStepDetailsMessageCreationObjectMessageCreation

Имя Тип Описание Обязательно По умолчанию
message_id Строка Да

OpenAI.RunStepDetailsToolCall

Дискриминация для OpenAI.RunStepDetailsToolCall

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа Схемы
code_interpreter OpenAI.RunStepDetailsToolCallsCodeObject
file_search OpenAI.RunStepDetailsToolCallsFileSearchObject
function OpenAI.RunStepDetailsToolCallsFunctionObject
Имя Тип Описание Обязательно По умолчанию
Тип OpenAI.RunStepDetailsToolCallType Да

OpenAI.RunStepDetailsToolCallType

Свойство Значение
Тип Строка
Значения code_interpreter
file_search
function

OpenAI.RunStepDetailsToolCallsCodeObject

Сведения о средстве интерпретатора кода, в котором был задействован шаг выполнения.

Имя Тип Описание Обязательно По умолчанию
code_interpreter OpenAI.RunStepDetailsToolCallsCodeObjectCodeInterpreter Да
Входные данные └️ Строка Да
Выходные данные └️ массив OpenAI.RunStepDetailsToolCallsCodeOutputLogsObject или OpenAI.RunStepDetailsToolCallsCodeOutputImageObject Да
Id Строка Идентификатор вызова средства. Да
Тип Перечисления Тип вызова средства. Это всегда будет для code_interpreter этого типа вызова средства.
Возможные значения: code_interpreter		 Да

OpenAI.RunStepDetailsToolCallsCodeObjectCodeInterpreter

Имя Тип Описание Обязательно По умолчанию
Вход Строка Да
Выходы массив OpenAI.RunStepDetailsToolCallsCodeOutputLogsObject или OpenAI.RunStepDetailsToolCallsCodeOutputImageObject Да

OpenAI.RunStepDetailsToolCallsCodeOutputImageObject

Имя Тип Описание Обязательно По умолчанию
Изображения OpenAI.RunStepDetailsToolCallsCodeOutputImageObjectImage Да
Тип Перечисления Всегда image.
Возможные значения: image		 Да

OpenAI.RunStepDetailsToolCallsCodeOutputImageObjectImage

Имя Тип Описание Обязательно По умолчанию
file_id Строка Да

OpenAI.RunStepDetailsToolCallsCodeOutputLogsObject

Текстовые выходные данные из вызова средства интерпретатора кода в рамках шага выполнения.

Имя Тип Описание Обязательно По умолчанию
Журналы Строка Вывод текста из вызова средства интерпретатора кода. Да
Тип Перечисления Всегда logs.
Возможные значения: logs		 Да

OpenAI.RunStepDetailsToolCallsFileSearchObject

Имя Тип Описание Обязательно По умолчанию
file_search OpenAI.RunStepDetailsToolCallsFileSearchObjectFileSearchSearch Да
└️ ranking_options OpenAI.RunStepDetailsToolCallsFileSearchRankingOptionsObject Параметры ранжирования для поиска файлов. Нет
Результаты └️ массив OpenAI.RunStepDetailsToolCallsFileSearchResultObject Нет
Id Строка Идентификатор объекта вызова средства. Да
Тип Перечисления Тип вызова средства. Это всегда будет для file_search этого типа вызова средства.
Возможные значения: file_search		 Да

OpenAI.RunStepDetailsToolCallsFileSearchObjectFileSearchSearch

Имя Тип Описание Обязательно По умолчанию
ranking_options OpenAI.RunStepDetailsToolCallsFileSearchRankingOptionsObject Параметры ранжирования для поиска файлов. Нет
Результаты массив OpenAI.RunStepDetailsToolCallsFileSearchResultObject Нет

OpenAI.RunStepDetailsToolCallsFileSearchRankingOptionsObject

Параметры ранжирования для поиска файлов.

Имя Тип Описание Обязательно По умолчанию
рангер OpenAI.FileSearchRanker Рангер, используемый для поиска файлов. Если не указано, будет использоваться auto рангер. Да
score_threshold Номер Пороговая оценка для поиска файлов. Все значения должны быть числом с плавающей запятой от 0 до 1.
Ограничения: min: 0, max: 1		 Да

OpenAI.RunStepDetailsToolCallsFileSearchResultObject

Результирующий экземпляр поиска файла.

Имя Тип Описание Обязательно По умолчанию
Содержимого массив OpenAI.RunStepDetailsToolCallsFileSearchResultObjectContent Содержимое найденного результата. Содержимое включается только в том случае, если он запрашивается с помощью параметра запроса include. Нет
file_id Строка Идентификатор файла, в который был найден результат. Да
file_name Строка Имя файла, в результате в который был найден результат. Да
Оценка по Номер Оценка результата. Все значения должны быть числом с плавающей запятой от 0 до 1.
Ограничения: min: 0, max: 1		 Да

OpenAI.RunStepDetailsToolCallsFileSearchResultObjectContent

Имя Тип Описание Обязательно По умолчанию
Текст Строка Нет
Тип Перечисления
Возможные значения: text		 Нет

OpenAI.RunStepDetailsToolCallsFunctionObject

Имя Тип Описание Обязательно По умолчанию
Функции OpenAI.RunStepDetailsToolCallsFunctionObjectFunction Да
Аргументы └️ Строка Да
└️ имя Строка Да
Выходные данные └️ строка или null Да
Id Строка Идентификатор объекта вызова средства. Да
Тип Перечисления Тип вызова средства. Это всегда будет для function этого типа вызова средства.
Возможные значения: function		 Да

OpenAI.RunStepDetailsToolCallsFunctionObjectFunction

Имя Тип Описание Обязательно По умолчанию
Аргументы Строка Да
Имя Строка Да
Выход строка или null Да

OpenAI.RunStepDetailsToolCallsObject

Сведения о вызове средства.

Имя Тип Описание Обязательно По умолчанию
tool_calls массив OpenAI.RunStepDetailsToolCall Массив инструментов вызывает этап выполнения. Они могут быть связаны с одним из трех типов инструментов: code_interpreter, file_searchили function. Да
Тип Перечисления Всегда tool_calls.
Возможные значения: tool_calls		 Да

OpenAI.RunStepObject

Представляет шаг выполнения выполнения выполнения.

Имя Тип Описание Обязательно По умолчанию
assistant_id Строка Идентификатор помощника , связанного с шагом выполнения. Да
cancelled_at строка или null Да
completed_at строка или null Да
created_at Целое число Метка времени Unix (в секундах) для момента создания шага выполнения. Да
expired_at строка или null Да
failed_at строка или null Да
Id Строка Идентификатор шага выполнения, на который можно ссылаться в конечных точках API. Да
last_error OpenAI.RunStepObjectLastError или null Да
Метаданных OpenAI.Metadata или NULL Да
Объекта Перечисления Тип объекта, который всегда thread.run.stepявляется .
Возможные значения: thread.run.step		 Да
run_id Строка Идентификатор выполнения , на который выполняется этот шаг, является частью. Да
Статус Перечисления Состояние шага выполнения, которое может быть либо in_progress, либо .cancelledfailedcompletedexpired
Возможные значения: in_progress, , cancelledfailedcompletedexpired		 Да
step_details OpenAI.RunStepDetailsMessageCreationObject или OpenAI.RunStepDetailsToolCallsObject Сведения о шаге выполнения. Да
thread_id Строка Идентификатор выполняемого потока . Да
Тип Перечисления Тип шага выполнения, который может быть либо message_creationtool_calls.
Возможные значения: message_creation, tool_calls		 Да
Использования OpenAI.RunStepCompletionUsage Статистика использования, связанная с шагом выполнения. Это значение будет находиться null в состоянии in_progressшага выполнения. Да

OpenAI.RunStepObjectLastError

Имя Тип Описание Обязательно По умолчанию
Код Перечисления
Возможные значения: server_error, rate_limit_exceeded		 Да
Сообщение Строка Да

OpenAI.RunToolCallObject

Объекты вызова средства

Имя Тип Описание Обязательно По умолчанию
Функции OpenAI.RunToolCallObjectFunction Да
Аргументы └️ Строка Да
└️ имя Строка Да
Id Строка Идентификатор вызова средства. Этот идентификатор должен ссылаться при отправке выходных данных средства с помощью выходных данных средства отправки для запуска конечной точки. Да
Тип Перечисления Для вызова выходных данных требуется тип средства. На данный момент это всегда function.
Возможные значения: function		 Да

OpenAI.RunToolCallObjectFunction

Имя Тип Описание Обязательно По умолчанию
Аргументы Строка Да
Имя Строка Да

OpenAI.Screenshot

Действие снимка экрана.

Имя Тип Описание Обязательно По умолчанию
Тип Перечисления Указывает тип события. Для действия с снимка экрана это свойство
всегда задано значение screenshot.
Возможные значения: screenshot		 Да

OpenAI.Scroll

Действие прокрутки.

Имя Тип Описание Обязательно По умолчанию
scroll_x Целое число Расстояние горизонтальной прокрутки. Да
scroll_y Целое число Расстояние вертикальной прокрутки. Да
Тип Перечисления Указывает тип события. Для действия прокрутки это свойство имеет значение
всегда задано значение scroll.
Возможные значения: scroll		 Да
X Целое число Координата x, в которой произошла прокрутка. Да
Y Целое число Координата y, в которой произошла прокрутка. Да

OpenAI.SearchContextSize

Свойство Значение
Тип Строка
Значения low
medium
high

OpenAI.SpecificApplyPatchParam

Заставляет модель вызывать средство apply_patch при выполнении вызова средства.

Имя Тип Описание Обязательно По умолчанию
Тип Перечисления Средство для вызова. Всегда apply_patch.
Возможные значения: apply_patch		 Да

OpenAI.SpecificFunctionShellParam

Заставляет модель вызывать средство оболочки при необходимости вызова средства.

Имя Тип Описание Обязательно По умолчанию
Тип Перечисления Средство для вызова. Всегда shell.
Возможные значения: shell		 Да

OpenAI.StaticChunkingStrategy

Имя Тип Описание Обязательно По умолчанию
chunk_overlap_tokens Целое число Количество маркеров, перекрывающихся между блоками. Значение по умолчанию — 400.
Обратите внимание, что перекрытие не должно превышать половину max_chunk_size_tokens.		 Да
max_chunk_size_tokens Целое число Максимальное количество токенов в каждом блоке. Значение по умолчанию — 800. Минимальное значение равно 100 , а максимальное — 4096.
Ограничения: min: 100, max: 4096		 Да

OpenAI.StaticChunkingStrategyRequestParam

Настройте собственную стратегию блокирования, задав размер блока и перекрытие блоков.

Имя Тип Описание Обязательно По умолчанию
Статический OpenAI.StaticChunkingStrategy Да
Тип Перечисления Всегда static.
Возможные значения: static		 Да

OpenAI.StaticChunkingStrategyResponseParam

Имя Тип Описание Обязательно По умолчанию
Статический OpenAI.StaticChunkingStrategy Да
Тип Перечисления Всегда static.
Возможные значения: static		 Да

OpenAI.StopConfiguration

Не поддерживается с последними моделями o3 причин и o4-mini. До четырех последовательностей, в которых API перестанет создавать дополнительные маркеры. Возвращенный текст не будет содержать последовательность остановки.

Эта схема принимает один из следующих типов:

  • Массива
  • Null

OpenAI.SubmitToolOutputsRunRequest

Имя Тип Описание Обязательно По умолчанию
Поток логический или null Нет
tool_outputs массив OpenAI.SubmitToolOutputsRunRequestToolOutputs Список инструментов, для которых отправляются выходные данные. Да

OpenAI.SubmitToolOutputsRunRequestToolOutputs

Имя Тип Описание Обязательно По умолчанию
Выход Строка Нет
tool_call_id Строка Нет

OpenAI.Summary

Текст сводки из модели.

Имя Тип Описание Обязательно По умолчанию
Текст Строка Сводка по выводу причин модели до сих пор. Да
Тип Перечисления Тип объекта. Всегда summary_text.
Возможные значения: summary_text		 Да

OpenAI.SummaryTextContent

Текст сводки из модели.

Имя Тип Описание Обязательно По умолчанию
Текст Строка Сводка по выводу причин модели до сих пор. Да
Тип Перечисления Тип объекта. Всегда summary_text.
Возможные значения: summary_text		 Да

OpenAI.TextAnnotation

Дискриминация для OpenAI.TextAnnotation

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа Схемы
file_citation OpenAI.MessageContentTextAnnotationsFileCitationObject
file_path OpenAI.MessageContentTextAnnotationsFilePathObject
Имя Тип Описание Обязательно По умолчанию
Тип OpenAI.TextAnnotationType Да

OpenAI.TextAnnotationType

Свойство Значение
Тип Строка
Значения file_citation
file_path

OpenAI.TextContent

Текстовое содержимое.

Имя Тип Описание Обязательно По умолчанию
Текст Строка Да
Тип Перечисления
Возможные значения: text		 Да

OpenAI.TextResponseFormatConfiguration

Объект, указывающий формат, который должен выводить модель. Настройка { "type": "json_schema" } включает структурированные выходные данные, что гарантирует, что модель будет соответствовать предоставленной схеме JSON. Дополнительные сведения см. в разделе

Формат по умолчанию не имеет { "type": "text" } дополнительных параметров. Не рекомендуется для gpt-4o и более новых моделей:* Параметр { "type": "json_object" } позволяет включить старый режим JSON, который гарантирует, что созданная модель сообщением является допустимым JSON. Использование json_schema предпочтительнее для моделей, поддерживающих его.

Дискриминация для OpenAI.TextResponseFormatConfiguration

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа Схемы
json_schema OpenAI.TextResponseFormatJsonSchema
text OpenAI.TextResponseFormatConfigurationResponseFormatText
json_object OpenAI.TextResponseFormatConfigurationResponseFormatJsonObject
Имя Тип Описание Обязательно По умолчанию
Тип OpenAI.TextResponseFormatConfigurationType Да

OpenAI.TextResponseFormatConfigurationResponseFormatJsonObject

Формат отклика объекта JSON. Старый метод создания ответов JSON. Рекомендуется использовать json_schema для моделей, поддерживающих его. Обратите внимание, что модель не будет генерировать JSON без системного или пользовательского сообщения о том, что это нужно сделать.

Имя Тип Описание Обязательно По умолчанию
Тип Перечисления Тип определяемого формата ответа. Всегда json_object.
Возможные значения: json_object		 Да

OpenAI.TextResponseFormatConfigurationResponseFormatText

Формат ответа по умолчанию. Используется для создания текстовых ответов.

Имя Тип Описание Обязательно По умолчанию
Тип Перечисления Тип определяемого формата ответа. Всегда text.
Возможные значения: text		 Да

OpenAI.TextResponseFormatConfigurationType

Свойство Значение
Тип Строка
Значения text
json_schema
json_object

OpenAI.TextResponseFormatJsonSchema

Формат ответа схемы JSON. Используется для создания структурированных ответов JSON. Дополнительные сведения о структурированных выходных данных.

Имя Тип Описание Обязательно По умолчанию
Описание Строка Описание формата отклика, используемого моделью для
определите способ реагирования в формате.		 Нет
Имя Строка Имя формата ответа. Должен быть a-z, A-Z, 0-9 или содержать
символы подчеркивания и дефисы с максимальной длиной 64.		 Да
Схемы OpenAI.ResponseFormatJsonSchema Схема формата ответа, описанная как объект схемы JSON.
Узнайте, как создать схемы JSON здесь.		 Да
Строгий логический или null Нет
Тип Перечисления Тип определяемого формата ответа. Всегда json_schema.
Возможные значения: json_schema		 Да

OpenAI.ThreadObject

Представляет поток, содержащий сообщения.

Имя Тип Описание Обязательно По умолчанию
created_at Целое число Метка времени Unix (в секундах) для момента создания потока. Да
Id Строка Идентификатор, на который можно ссылаться в конечных точках API. Да
Метаданных OpenAI.Metadata или NULL Да
Объекта Перечисления Тип объекта, который всегда threadявляется .
Возможные значения: thread		 Да
tool_resources OpenAI.ThreadObjectToolResources или null Да

OpenAI.ThreadObjectToolResources

Имя Тип Описание Обязательно По умолчанию
code_interpreter OpenAI.ThreadObjectToolResourcesCodeInterpreter Нет
file_search OpenAI.ThreadObjectToolResourcesFileSearch Нет

OpenAI.ThreadObjectToolResourcesCodeInterpreter

Имя Тип Описание Обязательно По умолчанию
file_ids массив строк Нет

OpenAI.ThreadObjectToolResourcesFileSearch

Имя Тип Описание Обязательно По умолчанию
vector_store_ids массив строк Нет

OpenAI.TokenLimits

Имя Тип Описание Обязательно По умолчанию
post_instructions Целое число Ограничения: мин: 0 Нет

OpenAI.Tool

Средство, которое можно использовать для создания ответа.

Дискриминация для OpenAI.Tool

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа Схемы
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
Имя Тип Описание Обязательно По умолчанию
Тип OpenAI.ToolType Да

OpenAI.ToolChoiceAllowed

Ограничивает средства, доступные для модели, предопределенным набором.

Имя Тип Описание Обязательно По умолчанию
Режим Перечисления Ограничивает средства, доступные для модели, предопределенным набором.
auto позволяет модели выбирать из разрешенных средств и создавать
Сообщение.
required требуется, чтобы модель вызывала один или несколько разрешенных средств.
Возможные значения: auto, required		 Да
Инструменты массив объекта Список определений инструментов, которые модель должна быть разрешена для вызова.
Для API ответов список определений инструментов может выглядеть следующим образом:
json<br> [<br> { "type": "function", "name": "get_weather" },<br> { "type": "mcp", "server_label": "deepwiki" },<br> { "type": "image_generation" }<br> ]<br> 		Да
Тип Перечисления Разрешенный тип конфигурации средства. Всегда allowed_tools.
Возможные значения: allowed_tools		 Да

OpenAI.ToolChoiceCodeInterpreter

Указывает, что модель должна использовать встроенное средство для создания ответа. Дополнительные сведения о встроенных средствах.

Имя Тип Описание Обязательно По умолчанию
Тип Перечисления
Возможные значения: code_interpreter		 Да

OpenAI.ToolChoiceComputerUsePreview

Указывает, что модель должна использовать встроенное средство для создания ответа. Дополнительные сведения о встроенных средствах.

Имя Тип Описание Обязательно По умолчанию
Тип Перечисления
Возможные значения: computer_use_preview		 Да

OpenAI.ToolChoiceCustom

Используйте этот параметр для принудительного вызова модели определенного пользовательского инструмента.

Имя Тип Описание Обязательно По умолчанию
Имя Строка Имя вызываемого пользовательского средства. Да
Тип Перечисления Для вызова пользовательского инструмента всегда используется customтип.
Возможные значения: custom		 Да

OpenAI.ToolChoiceFileSearch

Указывает, что модель должна использовать встроенное средство для создания ответа. Дополнительные сведения о встроенных средствах.

Имя Тип Описание Обязательно По умолчанию
Тип Перечисления
Возможные значения: file_search		 Да

OpenAI.ToolChoiceFunction

Используйте этот параметр, чтобы принудительно вызвать определенную функцию.

Имя Тип Описание Обязательно По умолчанию
Имя Строка Имя вызываемой функции. Да
Тип Перечисления Для вызова функции всегда используется functionтип.
Возможные значения: function		 Да

OpenAI.ToolChoiceImageGeneration

Указывает, что модель должна использовать встроенное средство для создания ответа. Дополнительные сведения о встроенных средствах.

Имя Тип Описание Обязательно По умолчанию
Тип Перечисления
Возможные значения: image_generation		 Да

OpenAI.ToolChoiceMCP

Используйте этот параметр, чтобы принудительно вызвать определенное средство на удаленном сервере MCP.

Имя Тип Описание Обязательно По умолчанию
Имя строка или null Нет
server_label Строка Метка используемого сервера MCP. Да
Тип Перечисления Для инструментов MCP всегда используется mcpтип.
Возможные значения: mcp		 Да

OpenAI.ToolChoiceOptions

Определяет, какое средство (если таковое) вызывается моделью. none означает, что модель не будет вызывать какое-либо средство и вместо этого создает сообщение. auto означает, что модель может выбирать между созданием сообщения или вызовом одного или нескольких инструментов. required означает, что модель должна вызывать один или несколько инструментов.

Свойство Значение
Тип Строка
Значения none
auto
required

OpenAI.ToolChoiceParam

Как модель должна выбрать средство (или инструменты), которое следует использовать при создании ответа. Просмотрите tools параметр, чтобы узнать, как указать, какие средства модель может вызывать.

Дискриминация для OpenAI.ToolChoiceParam

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа Схемы
allowed_tools OpenAI.ToolChoiceAllowed
mcp OpenAI.ToolChoiceMCP
custom OpenAI.ToolChoiceCustom
apply_patch OpenAI.SpecificApplyPatchParam
shell OpenAI.SpecificFunctionShellParam
file_search OpenAI.ToolChoiceFileSearch
web_search_preview OpenAI.ToolChoiceWebSearchPreview
computer_use_preview OpenAI.ToolChoiceComputerUsePreview
web_search_preview_2025_03_11 OpenAI.ToolChoiceWebSearchPreview20250311
image_generation OpenAI.ToolChoiceImageGeneration
code_interpreter OpenAI.ToolChoiceCodeInterpreter
Имя Тип Описание Обязательно По умолчанию
Тип OpenAI.ToolChoiceParamType Да

OpenAI.ToolChoiceParamType

Свойство Значение
Тип Строка
Значения allowed_tools
function
mcp
custom
apply_patch
shell
file_search
web_search_preview
computer_use_preview
web_search_preview_2025_03_11
image_generation
code_interpreter

OpenAI.ToolChoiceWebSearchPreview

Примечание. web_search еще недоступен через Azure OpenAI.

Имя Тип Описание Обязательно По умолчанию
Тип Перечисления
Возможные значения: web_search_preview		 Да

OpenAI.ToolChoiceWebSearchPreview20250311

Указывает, что модель должна использовать встроенное средство для создания ответа. Дополнительные сведения о встроенных средствах.

Имя Тип Описание Обязательно По умолчанию
Тип Перечисления
Возможные значения: web_search_preview_2025_03_11		 Да

OpenAI.ToolType

Свойство Значение
Тип Строка
Значения function
file_search
computer_use_preview
web_search
mcp
code_interpreter
image_generation
local_shell
shell
custom
web_search_preview
apply_patch

OpenAI.ToolsArray

Массив инструментов, которые модель может вызывать при создании ответа. Можно указать, какое средство следует использовать, задав tool_choice параметр. Мы поддерживаем следующие категории инструментов:

  • Встроенные средства: средства, предоставляемые OpenAI, которые расширяют возможности модели, такие как поиск в Интернете или поиск по файлам. Дополнительные сведения о встроенных средствах.
  • Инструменты MCP: интеграция с сторонними системами с помощью пользовательских серверов MCP или предопределенных соединителей, таких как Google Drive и SharePoint. Дополнительные сведения о средствах MCP.
  • Вызовы функций (пользовательские средства): функции, определенные вами, что позволяет модели вызывать собственный код с строго типизированными аргументами и выходными данными. Дополнительные сведения о вызове функции. Вы также можете использовать пользовательские средства для вызова собственного кода.

Массив: OpenAI.Tool

OpenAI.TopLogProb

Верхняя вероятность использования маркера в журнале.

Имя Тип Описание Обязательно По умолчанию
Байт массив целых чисел Да
logprob Номер Да
Маркер Строка Да

OpenAI.TranscriptionSegment

Имя Тип Описание Обязательно По умолчанию
avg_logprob Номер Среднее значение logprob сегмента. Если значение меньше -1, рассмотрите сбой логарифмов. Да
compression_ratio Номер Коэффициент сжатия сегмента. Если значение больше 2,4, рассмотрите сбой сжатия. Да
Конец Номер Время окончания сегмента в секундах. Да
Id Целое число Уникальный идентификатор сегмента. Да
no_speech_prob Номер Вероятность отсутствия речи в сегменте. Если значение выше 1,0 и avg_logprob ниже -1, рассмотрите этот сегмент безмолвно. Да
Искать Целое число Поиск смещения сегмента. Да
Начать Номер Время начала сегмента в секундах. Да
Температура Номер Параметр температуры, используемый для создания сегмента. Да
Текст Строка Текстовое содержимое сегмента. Да
Маркеры массив целых чисел Массив идентификаторов маркеров для текстового содержимого. Да

OpenAI.TranscriptionWord

Имя Тип Описание Обязательно По умолчанию
Конец Номер Время окончания слова в секундах. Да
Начать Номер Время начала слова в секундах. Да
Слово Строка Текстовое содержимое слова. Да

OpenAI.TruncationObject

Определяет, как поток будет усечен до выполнения. Используйте это для управления начальным окном контекста выполнения.

Имя Тип Описание Обязательно По умолчанию
last_messages целое число или null Нет
Тип Перечисления Стратегия усечения, используемая для потока. Значение по умолчанию — auto. Если задано значение last_messages, поток будет усечен до n последних сообщений в потоке. Если задано значение auto, сообщения в середине потока будут удалены, чтобы соответствовать длине контекста модели. max_prompt_tokens
Возможные значения: auto, last_messages		 Да

OpenAI.Type

Действие для ввода текста.

Имя Тип Описание Обязательно По умолчанию
Текст Строка Текст для типа. Да
Тип Перечисления Указывает тип события. Для действия типа это свойство имеет значение
всегда задано значение type.
Возможные значения: type		 Да

OpenAI.UpdateConversationBody

Имя Тип Описание Обязательно По умолчанию
Метаданных OpenAI.Metadata или NULL Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате и запроса на объекты через API или панель мониторинга.
Ключи — это строки с максимальной длиной 64 символов. Значения — это строки с максимальной длиной 512 символов.		 Да

OpenAI.UpdateVectorStoreFileAttributesRequest

Имя Тип Описание Обязательно По умолчанию
Атрибуты OpenAI.VectorStoreFileAttributes или null Да

OpenAI.UpdateVectorStoreRequest

Имя Тип Описание Обязательно По умолчанию
expires_after OpenAI.VectorStoreExpirationAfter Политика истечения срока действия для хранилища векторов. Нет
Метаданных OpenAI.Metadata или NULL Нет
Имя строка или null Имя векторного хранилища. Нет

OpenAI.UrlCitationBody

Ссылка на веб-ресурс, используемый для создания ответа модели.

Имя Тип Описание Обязательно По умолчанию
end_index Целое число Индекс последнего символа ссылки URL-адреса в сообщении. Да
start_index Целое число Индекс первого символа ссылки URL-адреса в сообщении. Да
Название Строка Заголовок веб-ресурса. Да
Тип Перечисления Тип ссылки URL-адреса. Всегда url_citation.
Возможные значения: url_citation		 Да
Url Строка URL-адрес веб-ресурса. Да

OpenAI.ValidateGraderResponse

Имя Тип Описание Обязательно По умолчанию
Грейдер OpenAI.GraderStringCheck или OpenAI.GraderTextSimilarity или OpenAI.GraderPython или OpenAI.GraderScoreModel или OpenAI.GraderMulti или GraderEndpoint Классировщик, используемый для задания тонкой настройки. Нет

OpenAI.VectorStoreExpirationAfter

Политика истечения срока действия для хранилища векторов.

Имя Тип Описание Обязательно По умолчанию
Якорь Перечисления Метка времени привязки, после которой применяется политика истечения срока действия. Поддерживаемые привязки: last_active_at.
Возможные значения: last_active_at		 Да
Дней Целое число Количество дней после истечения срока действия привязки хранилища векторов.
Ограничения: min: 1, max: 365		 Да

OpenAI.VectorStoreFileAttributes

Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате и запроса на объекты через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — это строки с максимальной длиной 512 символов, логических значений или чисел.

Тип: объект

OpenAI.VectorStoreFileBatchObject

Пакет файлов, присоединенных к хранилищу векторов.

Имя Тип Описание Обязательно По умолчанию
created_at Целое число Метка времени Unix (в секундах) для создания пакета файлов векторного хранилища. Да
file_counts OpenAI.VectorStoreFileBatchObjectFileCounts Да
Id Строка Идентификатор, на который можно ссылаться в конечных точках API. Да
Объекта Перечисления Тип объекта, который всегда vector_store.file_batchявляется .
Возможные значения: vector_store.files_batch		 Да
Статус Перечисления Состояние пакета векторного хранилища файлов, которые могут быть либо in_progress, completedcancelled либо failed.
Возможные значения: in_progress, , completedcancelledfailed		 Да
vector_store_id Строка Идентификатор векторного хранилища , к которому подключен файл . Да

OpenAI.VectorStoreFileBatchObjectFileCounts

Имя Тип Описание Обязательно По умолчанию
Отменен Целое число Да
Завершена Целое число Да
Сбой при Целое число Да
in_progress Целое число Да
Общая Целое число Да

OpenAI.VectorStoreFileObject

Список файлов, подключенных к хранилищу векторов.

Имя Тип Описание Обязательно По умолчанию
Атрибуты OpenAI.VectorStoreFileAttributes или null Нет
chunking_strategy OpenAI.ChunkingStrategyResponse Стратегия, используемая для фрагментации файла. Нет
created_at Целое число Метка времени Unix (в секундах) для момента создания файла векторного хранилища. Да
Id Строка Идентификатор, на который можно ссылаться в конечных точках API. Да
last_error OpenAI.VectorStoreFileObjectLastError или NULL Да
Объекта Перечисления Тип объекта, который всегда vector_store.fileявляется .
Возможные значения: vector_store.file		 Да
Статус Перечисления Состояние файла векторного хранилища, который может быть либо in_progress, completedcancelledлибо failed. completed Состояние указывает, что файл векторного хранилища готов к использованию.
Возможные значения: in_progress, , completedcancelledfailed		 Да
usage_bytes Целое число Общее использование векторного хранилища в байтах. Обратите внимание, что это может отличаться от исходного размера файла. Да
vector_store_id Строка Идентификатор векторного хранилища , к которому подключен файл . Да

OpenAI.VectorStoreFileObjectLastError

Имя Тип Описание Обязательно По умолчанию
Код Перечисления
Возможные значения: server_error, unsupported_fileinvalid_file		 Да
Сообщение Строка Да

OpenAI.VectorStoreObject

Векторное хранилище — это коллекция обработанных файлов, которые можно использовать file_search средством.

Имя Тип Описание Обязательно По умолчанию
created_at Целое число Метка времени Unix (в секундах) для создания векторного хранилища. Да
expires_after OpenAI.VectorStoreExpirationAfter Политика истечения срока действия для хранилища векторов. Нет
expires_at строка или null Нет
file_counts OpenAI.VectorStoreObjectFileCounts Да
Id Строка Идентификатор, на который можно ссылаться в конечных точках API. Да
last_active_at строка или null Да
Метаданных OpenAI.Metadata или NULL Да
Имя Строка Имя векторного хранилища. Да
Объекта Перечисления Тип объекта, который всегда vector_storeявляется .
Возможные значения: vector_store		 Да
Статус Перечисления Состояние векторного хранилища, которое может быть либо expired, in_progressлибо completed. Состояние указывает, что хранилище векторов completed готово для использования.
Возможные значения: expired, in_progresscompleted		 Да
usage_bytes Целое число Общее количество байтов, используемых файлами в хранилище векторов. Да

OpenAI.VectorStoreObjectFileCounts

Имя Тип Описание Обязательно По умолчанию
Отменен Целое число Да
Завершена Целое число Да
Сбой при Целое число Да
in_progress Целое число Да
Общая Целое число Да

OpenAI.VectorStoreSearchRequest

Имя Тип Описание Обязательно По умолчанию
Фильтры OpenAI.ComparisonFilter или OpenAI.CompoundFilter Фильтр для применения на основе атрибутов файла. Нет
max_num_results Целое число Максимальное количество возвращаемых результатов. Это число должно быть от 1 до 50 включительно.
Ограничения: min: 1, max: 50		 Нет 10
Запроса строка или массив строк Строка запроса для поиска Да
ranking_options OpenAI.VectorStoreSearchRequestRankingOptions Нет
Рангер └️ Перечисления
Возможные значения: none, autodefault-2024-11-15		 Нет
└score_threshold Номер Ограничения: min: 0, max: 1 Нет
rewrite_query Логических Следует ли переписать запрос естественного языка для векторного поиска. Нет

OpenAI.VectorStoreSearchRequestRankingOptions

Имя Тип Описание Обязательно По умолчанию
рангер Перечисления
Возможные значения: none, autodefault-2024-11-15		 Нет
score_threshold Номер Ограничения: min: 0, max: 1 Нет

OpenAI.VectorStoreSearchResultContentObject

Имя Тип Описание Обязательно По умолчанию
Текст Строка Текстовое содержимое, возвращенное из поиска. Да
Тип Перечисления Тип содержимого.
Возможные значения: text		 Да

OpenAI.VectorStoreSearchResultItem

Имя Тип Описание Обязательно По умолчанию
Атрибуты OpenAI.VectorStoreFileAttributes или null Да
Содержимого массив OpenAI.VectorStoreSearchResultContentObject Фрагменты содержимого из файла. Да
file_id Строка Идентификатор файла векторного хранилища. Да
Имени файла Строка Имя файла векторного хранилища. Да
Оценка по Номер Оценка сходства для результата.
Ограничения: min: 0, max: 1		 Да

OpenAI.VectorStoreSearchResultsPage

Имя Тип Описание Обязательно По умолчанию
Данных массив OpenAI.VectorStoreSearchResultItem Список элементов результатов поиска. Да
has_more Логических Указывает, есть ли дополнительные результаты для получения. Да
next_page строка или null Да
Объекта Перечисления Тип объекта, который всегда является vector_store.search_results.page
Возможные значения: vector_store.search_results.page		 Да
search_query массив строк Да

OpenAI.Verbosity

Ограничивает детализацию ответа модели. Более низкие значения приводят к более кратким ответам, в то время как более подробные значения приводят к более подробным ответам. В настоящее время поддерживаются lowзначения , mediumи high.

Свойство Значение
Тип Строка
Значения low
medium
high

OpenAI.VoiceIdsShared

Свойство Значение
Тип Строка
Значения alloy
ash
ballad
coral
echo
sage
shimmer
verse
marin
cedar

OpenAI.Wait

Действие ожидания.

Имя Тип Описание Обязательно По умолчанию
Тип Перечисления Указывает тип события. Для действия ожидания это свойство имеет значение
всегда задано значение wait.
Возможные значения: wait		 Да

OpenAI.WebSearchActionFind

Тип действия "find": выполняет поиск шаблона на загруженной странице.

Имя Тип Описание Обязательно По умолчанию
Узор Строка Шаблон или текст для поиска на странице. Да
Тип Перечисления Тип действия.
Возможные значения: find_in_page		 Да
Url Строка URL-адрес страницы, найдите шаблон. Да

OpenAI.WebSearchActionOpenPage

Тип действия "open_page" — открывает определенный URL-адрес из результатов поиска.

Имя Тип Описание Обязательно По умолчанию
Тип Перечисления Тип действия.
Возможные значения: open_page		 Да
Url Строка URL-адрес, открытый моделью. Да

OpenAI.WebSearchActionSearch

Тип действия "поиск" — выполняет запрос веб-поиска.

Имя Тип Описание Обязательно По умолчанию
Запросов массив строк Поисковые запросы. Нет
Запроса string (не рекомендуется) [НЕ РЕКОМЕНДУЕТСЯ] Поисковый запрос. Да
Источников массив OpenAI.WebSearchActionSearchSources Источники, используемые в поиске. Нет
Тип Перечисления Тип действия.
Возможные значения: search		 Да

OpenAI.WebSearchActionSearchSources

Имя Тип Описание Обязательно По умолчанию
Тип Перечисления
Возможные значения: url		 Да
Url Строка Да

OpenAI.WebSearchApproximateLocation

Приблизительное расположение пользователя.

Имя Тип Описание Обязательно По умолчанию
Города строка или null Нет
Страны строка или null Нет
Регионе строка или null Нет
Timezone строка или null Нет
Тип Перечисления Тип приближения расположения. Всегда approximate.
Возможные значения: approximate		 Нет

OpenAI.WebSearchPreviewTool

Примечание. web_search еще недоступен через Azure OpenAI.

Имя Тип Описание Обязательно По умолчанию
search_context_size OpenAI.SearchContextSize Нет
Тип Перечисления Тип средства поиска в Интернете. Одно из web_search_preview или web_search_preview_2025_03_11.
Возможные значения: web_search_preview		 Да
user_location OpenAI.ApproximateLocation или NULL Нет

OpenAI.WebSearchTool

Примечание. web_search еще недоступен через Azure OpenAI.

Имя Тип Описание Обязательно По умолчанию
Фильтры OpenAI.WebSearchToolFilters или null Нет
search_context_size Перечисления Рекомендации высокого уровня для объема пространства контекстного окна, используемого для поиска. Один из low, mediumили high. medium — значение по умолчанию.
Возможные значения: low, mediumhigh		 Нет
Тип Перечисления Тип средства поиска в Интернете. Одно из web_search или web_search_2025_08_26.
Возможные значения: web_search		 Да
user_location OpenAI.WebSearchApproximateLocation или null Нет

OpenAI.WebSearchToolFilters

Имя Тип Описание Обязательно По умолчанию
allowed_domains массив строк или null Нет

Заказ

Свойство Значение
Тип Строка
Значения asc
desc

ResponseFormatJSONSchemaRequest

Имя Тип Описание Обязательно По умолчанию
json_schema Объекта Схема JSON для формата ответа Да
Тип Перечисления Тип формата ответа
Возможные значения: json_schema		 Да

SpeechGenerationResponse

Представление ответа для операции преобразования текста в речь.

Имя Тип Описание Обязательно По умолчанию
Аудио Строка Созданный звук, созданный в запрошенном формате вывода звука. Да

SpeechGenerationResponseFormat

Поддерживаемые форматы выходных данных звука для преобразования текста в речь.

Этот компонент может быть одним из следующих компонентов:

  • Строка
  • string: mp3, , opusaacflac, wavpcm

SpeechVoice

Доступные голоса для преобразования текста в речь.

Свойство Значение
Описание Доступные голоса для преобразования текста в речь.
Тип Строка
Значения alloy
echo
fable
onyx
nova
shimmer

VideoContent

Имя Тип Описание Обязательно По умолчанию
Содержимого Строка Да

VideoContentVariant

Варианты доступных ресурсов для скачаемого содержимого.

Свойство Значение
Описание Варианты доступных ресурсов для скачаемого содержимого.
Тип Строка
Значения video
thumbnail
spritesheet

VideoIdParameter

Имя Тип Описание Обязательно По умолчанию
video-id Строка Идентификатор видео, используемого для запроса Azure OpenAI. Да

VideoList

Список заданий создания видео.

Имя Тип Описание Обязательно По умолчанию
Данных массив VideoResource Список заданий создания видео. Да
first_id Строка Идентификатор первого видео на текущей странице, если он доступен. Нет
has_more Логических Флаг, указывающий, есть ли больше заданий после списка. Да
last_id Строка Идентификатор последнего видео на текущей странице, если он доступен. Нет
Объекта Перечисления
Возможные значения: list		 Да

VideoResource

Структурированные сведения, описывающие созданное видео-задание.

Имя Тип Описание Обязательно По умолчанию
completed_at Целое число Метка времени Unix (в секундах) для завершения задания при завершении. Нет
created_at Целое число Метка времени Unix (секунды) для момента создания задания. Да
Ошибка Ошибка Нет
Код └️ Строка Да
Сообщение └️ Строка Да
expires_at Целое число Метка времени Unix (в секундах) для истечения срока действия поколения видео (и будет удалена). Нет
Id Строка Уникальный идентификатор для задания видео. Да
Модели Строка Развертывание модели создания видео, создающее задание. Да
Объекта Строка Тип объекта, который всегда videoявляется . Да
Прогресс Целое число Приблизительный процент завершения задачи создания. Да
remixed_from_video_id Строка Идентификатор исходного видео, если это видео является ремиксом. Нет
Секунд VideoSeconds Поддерживаемые продолжительности клипа, измеряемые в секундах. Да
Размер VideoSize Размеры выходных данных, отформатированные как {width}x{height}. Да
Статус VideoStatus Состояние жизненного цикла созданного видео. Да

VideoSeconds

Поддерживаемые продолжительности клипа, измеряемые в секундах.

Свойство Значение
Описание Поддерживаемые продолжительности клипа, измеряемые в секундах.
Тип Строка
Значения 4
8
12

VideoSize

Размеры выходных данных, отформатированные как {width}x{height}.

Свойство Значение
Описание Размеры выходных данных, отформатированные как {width}x{height}.
Тип Строка
Значения 720x1280
1280x720
1024x1792
1792x1024

VideoStatus

Состояние жизненного цикла созданного видео.

Свойство Значение
Описание Состояние жизненного цикла созданного видео.
Тип Строка
Значения queued
in_progress
completed
failed
  • Last updated on