Azure OpenAI в справочнике по REST API для моделей Microsoft Foundry версии 1

В этой статье содержатся сведения о конечных точках REST API вывода для Azure OpenAI.

Вывод плоскости данных

Остальная часть статьи охватывает новый выпуск API предварительной версии 1 для спецификации вывода Azure плоскости данных OpenAI. Дополнительные сведения см. в руководстве по жизненному циклу API.

Если вы ищете документацию по последнему выпуску API общедоступной версии 1, обратитесь к последнему API вывода плоскости данных общедоступной версии

Создание речи

POST {endpoint}/openai/v1/audio/speech?api-version=preview

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

Параметры URI

Имя.	In	Обязательно	Тип	Description
endpoint	путь	Да	струна URL-адрес	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например `https://aoairesource.openai.azure.com`. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai. azure.com
версия API	query	нет		Явная версия API моделей Microsoft Foundry, используемая для этого запроса. `v1`, если не указано иначе.

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

Используйте аутентификацию на основе токенов или API-ключ. Рекомендуется использовать аутентификацию на основе токенов, так как это более безопасно.

Имя.	Обязательно	Тип	Description
Authorization	True	струна	Пример:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To создайте маркер проверки подлинности с помощью Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Тип: oauth2 URL-адрес авторизации: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` область: `https://ai.azure.com/.default`
API-ключ	True	струна	Укажите здесь ключ API OpenAI Azure

Тело запроса

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

Имя.	Тип	Description	Обязательно	По умолчанию
ввод	струна	Текст для создания аудио. Максимальная длина — 4096 символов.	Да
instructions	струна	Управляйте голосом созданного звука с помощью дополнительных инструкций. Не работает с `tts-1` или `tts-1-hd`.	нет
модель	струна	Модель, используемая для этого текстового запроса на речь.	Да
формат_ответа	объект	Поддерживаемые форматы выходных данных звука для преобразования текста в речь.	нет
speed	число/номер	Скорость речи для сгенерированного аудио. Значения допустимы в диапазоне от 0,25 до 4.0 с 1.0 по умолчанию и более высокими значениями, соответствующими более быстрой речи.	нет	1
stream_format	перечисление	Формат для потоковой передачи звука. Поддерживаемые форматы: `sse` и `audio`. `sse` не поддерживается или `tts-1tts-1-hd`не поддерживается. Возможные значения: `sse`, `audio`	нет
голос	объект		Да

Responses

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

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

Тип содержимого	Тип	Описание
application/octet-stream	струна

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

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

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

Примеры

Пример

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

POST {endpoint}/openai/v1/audio/speech?api-version=preview

{
 "input": "Hi! What are you going to make?",
 "voice": "fable",
 "response_format": "mp3",
 "model": "tts-1"
}

Ответы: код состояния: 200

{
  "body": "101010101"
}

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

POST {endpoint}/openai/v1/audio/transcriptions?api-version=preview

Транскрибирует звук на язык ввода.

Параметры URI

Имя.	In	Обязательно	Тип	Description
endpoint	путь	Да	струна URL-адрес	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например `https://aoairesource.openai.azure.com`. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai. azure.com
версия API	query	нет		Явная версия API Foundry Models, которую следует использовать для этого запроса. `v1`, если не указано иначе.

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

Имя.	Обязательно	Тип	Description
Authorization	True	струна	Пример:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To создайте маркер проверки подлинности с помощью Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Тип: oauth2 URL-адрес авторизации: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` область: `https://ai.azure.com/.default`
API-ключ	True	струна	Укажите здесь ключ API OpenAI Azure

Тело запроса

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

Имя.	Тип	Description	Обязательно	По умолчанию
chunking_strategy	объект		нет
└prefix_padding_ms	целое число	Длительность звука, которую нужно включить до речи, обнаруженной VAD (в миллисекундах).	нет	300
└─ длительность_тишины_мс	целое число	Длительность молчания для обнаружения остановки речи (в миллисекундах). С более короткими значениями модель будет реагировать быстрее, но может вмешиваться при коротких паузах пользователя.	нет	200
Пороговое значение └️	число/номер	Порог чувствительности (от 0.0 до 1.0) для обнаружения голосовой активности. Более высокий пороговый уровень потребует более громкого звука для активации модели, и таким образом модель может работать лучше в шумных средах.	нет	0,5
└─ Тип	перечисление	Необходимо установить значение `server_vad`, чтобы включить ручное фрагментирование с использованием серверного VAD. Возможные значения: `server_vad`	нет
файл	струна		Да
filename	струна	Необязательный идентификатор файла или описательный идентификатор для связывания с звуковыми данными.	нет
include[]	массив	Дополнительные сведения для добавления в ответ транскрипции. `logprobs` возвращает логарифмы вероятностей маркеров в ответе, чтобы понять достоверность модели в транскрипции. `logprobs` работает только с response_format, заданным на `json`, и только с моделями `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, `gpt-4o-mini-transcribe` и `gpt-4o-mini-transcribe-2025-12-15`.	нет
язык	струна	Язык входного звука. Предоставление языка ввода в формате ISO-639-1 (например `en`, ) повышает точность и задержку.	нет
модель	струна	Модель, используемая для этого запроса транскрибирования.	нет
prompt	струна	Необязательный текст для руководства стилем модели или продолжением предыдущего сегмента звука. Запрос должен соответствовать языку звука.	нет
формат_ответа	объект		нет
поток	булевый	Если задано значение true, данные ответа модели будут передаваться клиенту по мере его создания с помощью событий, отправляемых сервером. Примечание. Потоковая передача не поддерживается для `whisper-1` модели и будет игнорироваться.	нет	Неправда
Температура	число/номер	Температура выборки от 0 до 1. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным. Если задано значение 0, модель будет использовать логарифмическую вероятность для автоматического повышения температуры до достижения определённых пороговых значений.	нет	0
timestamp_granularities[]	массив	Гранулярность метки времени для заполнения этой транскрибирования. `response_format` необходимо задать `verbose_json` для использования детализации метки времени. Поддерживаются либо оба этих параметра: `word`или `segment`. Примечание. Дополнительная задержка для меток времени сегмента отсутствует, но при создании меток времени слова возникает дополнительная задержка.	нет	['segment']

Responses

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

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

Тип содержимого	Тип	Описание
application/json	AzureAudioTranscriptionResponse
текст/без форматирования	струна

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

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

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

Примеры

Пример

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

POST {endpoint}/openai/v1/audio/transcriptions?api-version=preview

{
 "file": "<binary audio data>",
 "model": "whisper-1",
 "response_format": "text"
}

Ответы: код состояния: 200

{
  "body": "plain text when requesting text, srt, or vtt"
}

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

POST {endpoint}/openai/v1/audio/translations?api-version=preview

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

Параметры URI

Имя.	In	Обязательно	Тип	Description
endpoint	путь	Да	струна URL-адрес	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например `https://aoairesource.openai.azure.com`. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai. azure.com
версия API	query	нет		Явная версия API Foundry Models, которую следует использовать для этого запроса. `v1`, если не указано иначе.

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

Имя.	Обязательно	Тип	Description
Authorization	True	струна	Пример:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To создайте маркер проверки подлинности с помощью Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Тип: oauth2 URL-адрес авторизации: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` область: `https://ai.azure.com/.default`
API-ключ	True	струна	Укажите здесь ключ API OpenAI Azure

Тело запроса

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

Имя.	Тип	Description	Обязательно	По умолчанию
файл	струна		Да
filename	струна	Необязательный идентификатор файла или описательный идентификатор для связи с звуковыми данными	нет
модель	струна	Модель, используемая для этого запроса на перевод.	нет
prompt	струна	Необязательный текст для руководства стилем модели или продолжением предыдущего сегмента звука. Запрос должен находиться на английском языке.	нет
формат_ответа	объект		нет
Температура	число/номер	Температура выборки от 0 до 1. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным. Если задано значение 0, модель будет использовать логарифмическую вероятность для автоматического повышения температуры до достижения определённых пороговых значений.	нет	0

Responses

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

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

Тип содержимого	Тип	Описание
application/json	AzureAudioTranslationResponse
текст/без форматирования	струна

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

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

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

Примеры

Пример

POST {endpoint}/openai/v1/audio/translations?api-version=preview

{
 "file": "<binary audio data>",
 "model": "whisper-1",
 "response_format": "text"
}

Ответы: код состояния: 200

{
  "body": "plain text when requesting text, srt, or vtt"
}

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

POST {endpoint}/openai/v1/chat/completions?api-version=preview

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

Параметры URI

Имя.	In	Обязательно	Тип	Description
endpoint	путь	Да	струна URL-адрес	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например `https://aoairesource.openai.azure.com`. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai. azure.com
версия API	query	нет		Явная версия API Foundry Models, которую следует использовать для этого запроса. `v1`, если не указано иначе.

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

Имя.	Обязательно	Тип	Description
Authorization	True	струна	Пример:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To создайте маркер проверки подлинности с помощью Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Тип: oauth2 URL-адрес авторизации: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` область: `https://ai.azure.com/.default`
API-ключ	True	струна	Укажите здесь ключ API OpenAI Azure

Тело запроса

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

Имя.	Тип	Description	Обязательно	По умолчанию
audio	объект	Параметры выходных данных звука. Требуется при запросе на вывод звука с `modalities: ["audio"]`.	нет
└─ Формат	перечисление	Указывает выходной формат звука. Должен быть одним из `wav`, , `mp3`,`flacopus` или `pcm16`. Возможные значения: `wav`, `aac`, `mp3`, `flac`, `opus`, `pcm16`	нет
└️ голос	объект		нет
источники данных	массив	Источники данных, используемые для функции On Your Data, эксклюзивные для Azure OpenAI.	нет
штраф за частоту	число/номер	Число от -2.0 до 2.0. Положительные значения наказывают новые маркеры на основе их существующей частоты в тексте до сих пор, уменьшая вероятность повторения модели той же строки дословно.	нет	0
вызов_функции	перечисление	Указание определенной функции путем `{"name": "my_function"}` принудительного вызова этой функции моделью. Возможные значения: `none`, `auto`	нет
functions	массив	Не рекомендуется использовать в пользу `tools`. Список функций, для которые модель может создавать входные данные JSON.	нет
логит_биас	объект	Изменяет вероятность появления указанных маркеров в завершении. Принимает объект JSON, который сопоставляет маркеры (указанные идентификатором маркера в токенизаторе) со связанным значением предвзятости от -100 до 100. С математической точки зрения смещение добавляется к логитам, созданным моделью до выборки. Точный эффект зависит от модели, но значения от –1 до 1 должны уменьшать или увеличивать вероятность выбора; такие значения, как –100 или 100, должны приводить к запрету или эксклюзивному выбору соответствующего маркера.	нет	None
logprobs	булевый	Следует ли возвращать вероятности журналов выходных маркеров или нет. Если значение true, возвращает вероятности журнала каждого выходного маркера, возвращаемого в параметре `contentmessage`.	нет	Неправда
max_completion_tokens (максимальное количество токенов завершения)	целое число	Верхняя граница для числа маркеров, которые можно создать для завершения, включая видимые выходные маркеры и маркеры причин.	нет
макс_токены	целое число	Максимальное количество маркеров, которые можно создать в завершении чата. Это значение можно использовать для управления затратами на текст, созданный с помощью API. Это значение теперь устарело, а предпочитается `max_completion_tokens`, и несовместимо с моделями серии o1.	нет
messages	массив	Список сообщений, составляющих беседу до сих пор. В зависимости от используемой модели поддерживаются различные типы сообщений (модальности), такие как текст, изображения и звук.	Да
metadata	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате и запроса на объекты через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — это строки с максимальной длиной 512 символов.	нет
Условия	объект	Типы выходных данных, которые вы хотите, чтобы модель генерировала. Большинство моделей могут создавать текст, который по умолчанию: `["text"]` Модель `gpt-4o-audio-preview` также может использоваться для создания звука. Чтобы запросить, что эта модель создает как текстовые, так и звуковые ответы, можно использовать: `["text", "audio"]`	нет
модель	струна	Идентификатор развертывания модели, используемый для запроса завершения чата.	Да
н	целое число	Сколько вариантов завершения чата для каждого входного сообщения. Обратите внимание, что плата будет взиматься на основе количества созданных маркеров во всех вариантах. Имейте в виду `n` , чтобы `1` свести к минимуму затраты.	нет	1
вызовы инструмента в параллельном режиме	объект	Следует ли включить параллельные вызовы функций во время использования средства.	нет
prediction	объект	Базовое представление прогнозируемых выходных данных модели.	нет
└─ Тип	OpenAI.ChatOutputPredictionType		нет
штраф за присутствие	число/номер	Число от -2.0 до 2.0. Положительные значения наказывают новые маркеры в зависимости от того, появляются ли они в тексте до сих пор, что повышает вероятность того, что модель будет говорить о новых темах.	нет	0
усилия на рассуждение	объект	Только модели o-серии Ограничивает усилия по рассуждениям моделей. В настоящее время поддерживаются `low`значения , `medium`и `high`. Сокращение усилий по поводу может привести к более быстрым откликам и меньшем количестве маркеров, используемых при рассуждениях в ответе.	нет
формат_ответа	объект		нет
└─ Тип	перечисление	Возможные значения: `text`, `json_objectjson_schema`	нет
seed	целое число	Эта функция доступна в бета-версии. Если задано, наша система будет предпринять лучшие усилия для выборки детерминированного, таким образом, что повторяющиеся запросы с одинаковыми и теми же параметрами должны возвращать тот же `seed` результат. Детерминированность не гарантируется, и вы должны ссылаться на `system_fingerprint` параметр ответа для отслеживания изменений в серверной части.	нет
stop	объект	Не поддерживается с последними моделями рассуждений `o3` и `o4-mini`. До 4 последовательностей, в которых API перестанет создавать дополнительные маркеры. Возвращенный текст не будет содержать последовательность остановки.	нет
store	булевый	Следует ли хранить выходные данные этого запроса завершения чата для использования в дистилляциях модели или продуктах оценки.	нет	Неправда
поток	булевый	Если задано значение true, данные ответа модели будут передаваться клиенту по мере его создания с помощью событий, отправляемых сервером.	нет	Неправда
stream_options	объект	Параметры потокового ответа. Этот параметр устанавливается только при установке `stream: true`.	нет
└️ include_usage	булевый	Если задано, перед сообщением будет передаваться `data: [DONE]` дополнительный блок. Поле `usage` на этом блоке отображает статистику использования маркеров для всего запроса, и `choices` поле всегда будет пустым массивом. Все остальные блоки также будут содержать `usage` поле, но со значением NULL. ЗАМЕТКА: Если поток прерван, вы можете не получить последний блок данных об использовании, содержащий общие данные о количестве использованных токенов для запроса.	нет
Температура	число/номер	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным. Как правило, мы рекомендуем изменить это или `top_p` не оба.	нет	1
выбор инструмента	OpenAI.ChatCompletionToolChoiceOption	Определяет, какое средство (если таковое) вызывается моделью. `none` означает, что модель не будет вызывать какое-либо средство и вместо этого создает сообщение. `auto` означает, что модель может выбирать между созданием сообщения или вызовом одного или нескольких инструментов. `required` означает, что модель должна вызывать один или несколько инструментов. Указание определенного средства с помощью `{"type": "function", "function": {"name": "my_function"}}` принудительного вызова этого средства моделью. `none` значение по умолчанию, если средства отсутствуют. `auto` значение по умолчанию, если существуют средства.	нет
инструменты	массив	Список инструментов, которые может вызывать модель. В настоящее время в качестве инструмента поддерживаются только функции. Используйте это для предоставления списка функций, для которые модель может создавать входные данные JSON. Поддерживаются не более 128 функций.	нет
top_logprobs	целое число	Целое число от 0 до 20, указывающее число наиболее вероятных маркеров, возвращаемых по каждой позиции маркера, каждый из которых имеет связанную вероятность журнала.	нет
top_p	число/номер	Альтернативой выборке с температурой является так называемая выборка ядра, где модель рассматривает результаты маркеров с top_p всего массива значений вероятности. Таким образом, 0,1 означает, что учитываются только маркеры, входящие в верхние 10% массива значений вероятности. Как правило, мы рекомендуем изменить это или `temperature` не оба.	нет	1
Пользователь	струна	Уникальный идентификатор, представляющий конечного пользователя, который может помочь в мониторинге и обнаружении злоупотреблений.	нет
user_security_context	AzureUserSecurityContext	Контекст безопасности пользователя содержит несколько параметров, описывающих само приложение, и конечный пользователь, взаимодействующий с приложением. Эти поля помогают группам по операциям безопасности исследовать и устранять инциденты безопасности, предоставляя комплексный подход к защите приложений ИИ. Learn more о защите приложений ИИ с помощью Microsoft Defender for Cloud.	нет

Responses

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

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

Тип содержимого	Тип	Описание
application/json	AzureCreateChatCompletionResponse
text/event-stream	AzureCreateChatCompletionStreamResponse

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

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

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

Примеры

Пример

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

POST {endpoint}/openai/v1/chat/completions?api-version=preview

{
 "model": "gpt-4o-mini",
 "messages": [
  {
   "role": "system",
   "content": "you are a helpful assistant that talks like a pirate"
  },
  {
   "role": "user",
   "content": "can you tell me how to care for a parrot?"
  }
 ]
}

Ответы: код состояния: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh?..."
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

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

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

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

Параметры URI

Имя.	In	Обязательно	Тип	Description
endpoint	путь	Да	струна URL-адрес	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например `https://aoairesource.openai.azure.com`. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai. azure.com
версия API	query	нет		Явная версия API Foundry Models, которую следует использовать для этого запроса. `v1`, если не указано иначе.

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

Имя.	Обязательно	Тип	Description
Authorization	True	струна	Пример:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To создайте маркер проверки подлинности с помощью Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Тип: oauth2 URL-адрес авторизации: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` область: `https://ai.azure.com/.default`
API-ключ	True	струна	Укажите здесь ключ API OpenAI Azure

Тело запроса

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

Имя.	Тип	Description	Обязательно
dimensions	целое число	Число измерений, в которых должны быть внедренные выходные данные. Поддерживается только в `text-embedding-3` и более поздних моделях.	нет
формат_кодирования	перечисление	Формат, в который возвращаются встраиваемые элементы. Может быть либо `float`, либо `base64`. Возможные значения: `float`, `base64`	нет
ввод	строка или массив		Да
модель	струна	Модель, используемая для запроса внедрения.	Да
Пользователь	струна	Уникальный идентификатор, представляющий пользователя, который может помочь OpenAI отслеживать и обнаруживать злоупотребления.	нет

Responses

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

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

Тип содержимого	Тип	Описание
application/json	OpenAI.CreateEmbeddingResponse

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

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

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

Примеры

Пример

Верните встраивания для заданного запроса.

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

{
 "model": "text-embedding-ada-002",
 "input": [
  "this is a test"
 ]
}

Ответы: код состояния: 200

{
  "body": {
    "data": [
      {
        "index": 0,
        "embedding": [
          -0.012838088,
          -0.007421397,
          -0.017617522,
          -0.028278312,
          -0.018666342,
          0.01737855,
          -0.01821495,
          -0.006950092,
          -0.009937238,
          -0.038580645,
          0.010674067,
          0.02412286,
          -0.013647936,
          0.013189907,
          0.0021125758,
          0.012406612,
          0.020790534,
          0.00074595667,
          0.008397198,
          -0.00535031,
          0.008968075,
          0.014351576,
          -0.014086051,
          0.015055214,
          -0.022211088,
          -0.025198232,
          0.0065186154,
          -0.036350243,
          0.009180495,
          -0.009698266,
          0.009446018,
          -0.008463579,
          -0.0040426035,
          -0.03443847,
          -0.00091273896,
          -0.0019217303,
          0.002349888,
          -0.021560553,
          0.016515596,
          -0.015572986,
          0.0038666942,
          -8.432463e-05,
          0.0032178196,
          -0.020365695,
          -0.009631885,
          -0.007647093,
          0.0033837722,
          -0.026764825,
          -0.010501476,
          0.020219658,
          0.024640633,
          -0.0066912062,
          -0.036456455,
          -0.0040923897,
          -0.013966565,
          0.017816665,
          0.005366905,
          0.022835068,
          0.0103488,
          -0.0010811808,
          -0.028942121,
          0.0074280356,
          -0.017033368,
          0.0074877786,
          0.021640211,
          0.002499245,
          0.013316032,
          0.0021524043,
          0.010129742,
          0.0054731146,
          0.03143805,
          0.014856071,
          0.0023366117,
          -0.0008243692,
          0.022781964,
          0.003038591,
          -0.017617522,
          0.0013309394,
          0.0022154662,
          0.00097414135,
          0.012041516,
          -0.027906578,
          -0.023817508,
          0.013302756,
          -0.003003741,
          -0.006890349,
          0.0016744611
        ]
      }
    ],
    "usage": {
      "prompt_tokens": 4,
      "total_tokens": 4
    }
  }
}

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

GET {endpoint}/openai/v1/evals?api-version=preview

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

Параметры URI

Имя.	In	Обязательно	Тип	Description
endpoint	путь	Да	струна URL-адрес	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например `https://aoairesource.openai.azure.com`. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai. azure.com
версия API	query	нет		Явная версия API Foundry Models, которую следует использовать для этого запроса. `v1`, если не указано иначе.
aoai-evals	header	Да	струна Возможные значения: `preview`	Включает access в AOAI Evals, предварительная версия функции. Для этой функции необходимо задать для заголовка aoai-evals значение preview.
after	query	нет	струна	Идентификатор последней оценки из предыдущего запроса на страничную навигацию.
limit	query	нет	целое число	Ограничение на количество возвращаемых вальвов в одном ответе на страницы.
заказ	query	нет	струна Возможные значения: `asc`, `desc`	Порядок сортировки оценок по временным меткам. Используется `asc` для возрастания или `desc` для убывающего порядка.
сортировать_по	query	нет	струна Возможные значения: `created_at`, `updated_at`	Evals можно упорядочить по времени создания или времени последнего обновления. Используется `created_at` для времени создания или `updated_at` последнего обновления.

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

Имя.	Обязательно	Тип	Description
Authorization	True	струна	Пример:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To создайте маркер проверки подлинности с помощью Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Тип: oauth2 URL-адрес авторизации: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` область: `https://ai.azure.com/.default`
API-ключ	True	струна	Укажите здесь ключ API OpenAI Azure

Responses

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

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

Тип содержимого	Тип	Описание
application/json	OpenAI.EvalList

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

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

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

Createeval

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

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

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

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

Параметры URI

Имя.	In	Обязательно	Тип	Description
endpoint	путь	Да	струна URL-адрес	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например `https://aoairesource.openai.azure.com`. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai. azure.com
версия API	query	нет		Явная версия API Foundry Models, которую следует использовать для этого запроса. `v1`, если не указано иначе.
aoai-evals	header	Да	струна Возможные значения: `preview`	Включает access в AOAI Evals, предварительная версия функции. Для этой функции необходимо задать для заголовка aoai-evals значение preview.

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

Имя.	Обязательно	Тип	Description
Authorization	True	струна	Пример:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To создайте маркер проверки подлинности с помощью Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Тип: oauth2 URL-адрес авторизации: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` область: `https://ai.azure.com/.default`
API-ключ	True	струна	Укажите здесь ключ API OpenAI Azure

Тело запроса

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

Имя.	Тип	Description	Обязательно
настройка_источника_данных	объект		Да
└─ Тип	OpenAI.EvalDataSourceConfigType		нет
metadata	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате и запроса на объекты через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — это строки с максимальной длиной 512 символов.	нет
имя	струна	Имя оценки.	нет
код состояния	перечисление	Возможные значения: `201`	Да
критерии тестирования	массив	Список оценщиков для всех запусков оценок в этой группе. Классировщики могут ссылаться на переменные в источнике данных с помощью двойной фигурной скобки, например `{{item.variable_name}}`. Чтобы ссылаться на выходные данные модели, используйте `sample` пространство имен (т. е. `{{sample.output_text}}`).	Да

Responses

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

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

Тип содержимого	Тип	Описание
application/json	OpenAI.Eval

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

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

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

Получение eval

GET {endpoint}/openai/v1/evals/{eval_id}?api-version=preview

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

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

Параметры URI

Имя.	In	Обязательно	Тип	Description
endpoint	путь	Да	струна URL-адрес	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например `https://aoairesource.openai.azure.com`. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai. azure.com
версия API	query	нет		Явная версия API Foundry Models, которую следует использовать для этого запроса. `v1`, если не указано иначе.
aoai-evals	header	Да	струна Возможные значения: `preview`	Включает access в AOAI Evals, предварительная версия функции. Для этой функции необходимо задать для заголовка aoai-evals значение preview.
eval_id	путь	Да	струна

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

Имя.	Обязательно	Тип	Description
Authorization	True	струна	Пример:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To создайте маркер проверки подлинности с помощью Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Тип: oauth2 URL-адрес авторизации: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` область: `https://ai.azure.com/.default`
API-ключ	True	струна	Укажите здесь ключ API OpenAI Azure

Responses

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

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

Тип содержимого	Тип	Описание
application/json	OpenAI.Eval

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

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

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

Обновление eval

POST {endpoint}/openai/v1/evals/{eval_id}?api-version=preview

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

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

Параметры URI

Имя.	In	Обязательно	Тип	Description
endpoint	путь	Да	струна URL-адрес	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например `https://aoairesource.openai.azure.com`. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai. azure.com
версия API	query	нет		Явная версия API Foundry Models, которую следует использовать для этого запроса. `v1`, если не указано иначе.
aoai-evals	header	Да	струна Возможные значения: `preview`	Включает access в AOAI Evals, предварительная версия функции. Для этой функции необходимо задать для заголовка aoai-evals значение preview.
eval_id	путь	Да	струна

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

Имя.	Обязательно	Тип	Description
Authorization	True	струна	Пример:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To создайте маркер проверки подлинности с помощью Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Тип: oauth2 URL-адрес авторизации: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` область: `https://ai.azure.com/.default`
API-ключ	True	струна	Укажите здесь ключ API OpenAI Azure

Тело запроса

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

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

Responses

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

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

Тип содержимого	Тип	Описание
application/json	OpenAI.Eval

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

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

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

Удаление eval

DELETE {endpoint}/openai/v1/evals/{eval_id}?api-version=preview

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

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

Параметры URI

Имя.	In	Обязательно	Тип	Description
endpoint	путь	Да	струна URL-адрес	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например `https://aoairesource.openai.azure.com`. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai. azure.com
версия API	query	нет		Явная версия API Foundry Models, которую следует использовать для этого запроса. `v1`, если не указано иначе.
aoai-evals	header	Да	струна Возможные значения: `preview`	Включает access в AOAI Evals, предварительная версия функции. Для этой функции необходимо задать для заголовка aoai-evals значение preview.
eval_id	путь	Да	струна

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

Имя.	Обязательно	Тип	Description
Authorization	True	струна	Пример:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To создайте маркер проверки подлинности с помощью Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Тип: oauth2 URL-адрес авторизации: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` область: `https://ai.azure.com/.default`
API-ключ	True	струна	Укажите здесь ключ API OpenAI Azure

Responses

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

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

Тип содержимого	Тип	Описание
application/json	объект

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

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

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

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

GET {endpoint}/openai/v1/evals/{eval_id}/runs?api-version=preview

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

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

Параметры URI

Имя.	In	Обязательно	Тип	Description
endpoint	путь	Да	струна URL-адрес	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например `https://aoairesource.openai.azure.com`. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai. azure.com
версия API	query	нет		Явная версия API Foundry Models, которую следует использовать для этого запроса. `v1`, если не указано иначе.
aoai-evals	header	Да	струна Возможные значения: `preview`	Включает access в AOAI Evals, предварительная версия функции. Для этой функции необходимо задать для заголовка aoai-evals значение preview.
eval_id	путь	Да	струна
after	query	нет	струна
limit	query	нет	целое число
заказ	query	нет	струна Возможные значения: `asc`, `desc`
статус	query	нет	струна Возможные значения: `queued`, `in_progress`, `completed`, `canceled`, `failed`

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

Имя.	Обязательно	Тип	Description
Authorization	True	струна	Пример:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To создайте маркер проверки подлинности с помощью Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Тип: oauth2 URL-адрес авторизации: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` область: `https://ai.azure.com/.default`
API-ключ	True	струна	Укажите здесь ключ API OpenAI Azure

Responses

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

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

Тип содержимого	Тип	Описание
application/json	OpenAI.EvalRunList

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

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

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

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

POST {endpoint}/openai/v1/evals/{eval_id}/runs?api-version=preview

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

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

Параметры URI

Имя.	In	Обязательно	Тип	Description
endpoint	путь	Да	струна URL-адрес	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например `https://aoairesource.openai.azure.com`. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai. azure.com
версия API	query	нет		Явная версия API Foundry Models, которую следует использовать для этого запроса. `v1`, если не указано иначе.
aoai-evals	header	Да	струна Возможные значения: `preview`	Включает access в AOAI Evals, предварительная версия функции. Для этой функции необходимо задать для заголовка aoai-evals значение preview.
eval_id	путь	Да	струна

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

Имя.	Обязательно	Тип	Description
Authorization	True	струна	Пример:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To создайте маркер проверки подлинности с помощью Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Тип: oauth2 URL-адрес авторизации: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` область: `https://ai.azure.com/.default`
API-ключ	True	струна	Укажите здесь ключ API OpenAI Azure

Тело запроса

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

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

Responses

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

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

Тип содержимого	Тип	Описание
application/json	OpenAI.EvalRun

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

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

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

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

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}?api-version=preview

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

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

Параметры URI

Имя.	In	Обязательно	Тип	Description
endpoint	путь	Да	струна URL-адрес	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например `https://aoairesource.openai.azure.com`. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai. azure.com
версия API	query	нет		Явная версия API Foundry Models, которую следует использовать для этого запроса. `v1`, если не указано иначе.
aoai-evals	header	Да	струна Возможные значения: `preview`	Включает access в AOAI Evals, предварительная версия функции. Для этой функции необходимо задать для заголовка aoai-evals значение preview.
eval_id	путь	Да	струна
run_id	путь	Да	струна

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

Имя.	Обязательно	Тип	Description
Authorization	True	струна	Пример:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To создайте маркер проверки подлинности с помощью Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Тип: oauth2 URL-адрес авторизации: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` область: `https://ai.azure.com/.default`
API-ключ	True	струна	Укажите здесь ключ API OpenAI Azure

Responses

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

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

Тип содержимого	Тип	Описание
application/json	OpenAI.EvalRun

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

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

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

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

POST {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}?api-version=preview

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

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

Параметры URI

Имя.	In	Обязательно	Тип	Description
endpoint	путь	Да	струна URL-адрес	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например `https://aoairesource.openai.azure.com`. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai. azure.com
версия API	query	нет		Явная версия API Foundry Models, которую следует использовать для этого запроса. `v1`, если не указано иначе.
aoai-evals	header	Да	струна Возможные значения: `preview`	Включает access в AOAI Evals, предварительная версия функции. Для этой функции необходимо задать для заголовка aoai-evals значение preview.
eval_id	путь	Да	струна
run_id	путь	Да	струна

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

Имя.	Обязательно	Тип	Description
Authorization	True	струна	Пример:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To создайте маркер проверки подлинности с помощью Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Тип: oauth2 URL-адрес авторизации: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` область: `https://ai.azure.com/.default`
API-ключ	True	струна	Укажите здесь ключ API OpenAI Azure

Responses

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

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

Тип содержимого	Тип	Описание
application/json	OpenAI.EvalRun

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

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

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

Deleteevalrun

DELETE {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}?api-version=preview

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

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

Параметры URI

Имя.	In	Обязательно	Тип	Description
endpoint	путь	Да	струна URL-адрес	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например `https://aoairesource.openai.azure.com`. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai. azure.com
версия API	query	нет		Явная версия API Foundry Models, которую следует использовать для этого запроса. `v1`, если не указано иначе.
aoai-evals	header	Да	струна Возможные значения: `preview`	Включает access в AOAI Evals, предварительная версия функции. Для этой функции необходимо задать для заголовка aoai-evals значение preview.
eval_id	путь	Да	струна
run_id	путь	Да	струна

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

Имя.	Обязательно	Тип	Description
Authorization	True	струна	Пример:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To создайте маркер проверки подлинности с помощью Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Тип: oauth2 URL-адрес авторизации: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` область: `https://ai.azure.com/.default`
API-ключ	True	струна	Укажите здесь ключ API OpenAI Azure

Responses

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

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

Тип содержимого	Тип	Описание
application/json	объект

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

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

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

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

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}/output_items?api-version=preview

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

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

Параметры URI

Имя.	In	Обязательно	Тип	Description
endpoint	путь	Да	струна URL-адрес	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например `https://aoairesource.openai.azure.com`. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai. azure.com
версия API	query	нет		Явная версия API Foundry Models, которую следует использовать для этого запроса. `v1`, если не указано иначе.
aoai-evals	header	Да	струна Возможные значения: `preview`	Включает access в AOAI Evals, предварительная версия функции. Для этой функции необходимо задать для заголовка aoai-evals значение preview.
eval_id	путь	Да	струна
run_id	путь	Да	струна
after	query	нет	струна
limit	query	нет	целое число
статус	query	нет	струна Возможные значения: `fail`, `pass`
заказ	query	нет	струна Возможные значения: `asc`, `desc`

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

Имя.	Обязательно	Тип	Description
Authorization	True	струна	Пример:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To создайте маркер проверки подлинности с помощью Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Тип: oauth2 URL-адрес авторизации: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` область: `https://ai.azure.com/.default`
API-ключ	True	струна	Укажите здесь ключ API OpenAI Azure

Responses

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

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

Тип содержимого	Тип	Описание
application/json	OpenAI.EvalRunOutputItemList

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

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

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

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

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}/output_items/{output_item_id}?api-version=preview

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

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

Параметры URI

Имя.	In	Обязательно	Тип	Description
endpoint	путь	Да	струна URL-адрес	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например `https://aoairesource.openai.azure.com`. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai. azure.com
версия API	query	нет		Явная версия API Foundry Models, которую следует использовать для этого запроса. `v1`, если не указано иначе.
aoai-evals	header	Да	струна Возможные значения: `preview`	Включает access в AOAI Evals, предварительная версия функции. Для этой функции необходимо задать для заголовка aoai-evals значение preview.
eval_id	путь	Да	струна
run_id	путь	Да	струна
output_item_id	путь	Да	струна

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

Имя.	Обязательно	Тип	Description
Authorization	True	струна	Пример:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To создайте маркер проверки подлинности с помощью Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Тип: oauth2 URL-адрес авторизации: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` область: `https://ai.azure.com/.default`
API-ключ	True	струна	Укажите здесь ключ API OpenAI Azure

Responses

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

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

Тип содержимого	Тип	Описание
application/json	OpenAI.EvalRunOutputItem

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

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

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

Создать файл

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

Параметры URI

Имя.	In	Обязательно	Тип	Description
endpoint	путь	Да	струна URL-адрес	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например `https://aoairesource.openai.azure.com`. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai. azure.com
версия API	query	нет		Явная версия API Foundry Models, которую следует использовать для этого запроса. `v1`, если не указано иначе.

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

Имя.	Обязательно	Тип	Description
Authorization	True	струна	Пример:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To создайте маркер проверки подлинности с помощью Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Тип: oauth2 URL-адрес авторизации: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` область: `https://ai.azure.com/.default`
API-ключ	True	струна	Укажите здесь ключ API OpenAI Azure

Тело запроса

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

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

Responses

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

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

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

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

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

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

Примеры

Пример

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

Перечень файлов

GET {endpoint}/openai/v1/files?api-version=preview

Параметры URI

Имя.	In	Обязательно	Тип	Description
endpoint	путь	Да	струна URL-адрес	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например `https://aoairesource.openai.azure.com`. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai. azure.com
версия API	query	нет		Явная версия API Foundry Models, которую следует использовать для этого запроса. `v1`, если не указано иначе.
purpose	query	нет	струна

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

Имя.	Обязательно	Тип	Description
Authorization	True	струна	Пример:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To создайте маркер проверки подлинности с помощью Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Тип: oauth2 URL-адрес авторизации: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` область: `https://ai.azure.com/.default`
API-ключ	True	струна	Укажите здесь ключ API OpenAI Azure

Responses

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

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

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

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

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

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

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

GET {endpoint}/openai/v1/files/{file_id}?api-version=preview

Параметры URI

Имя.	In	Обязательно	Тип	Description
endpoint	путь	Да	струна URL-адрес	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например `https://aoairesource.openai.azure.com`. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai. azure.com
версия API	query	нет		Явная версия API Foundry Models, которую следует использовать для этого запроса. `v1`, если не указано иначе.
идентификатор_файла	путь	Да	струна	Идентификатор файла, используемого для этого запроса.

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

Имя.	Обязательно	Тип	Description
Authorization	True	струна	Пример:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To создайте маркер проверки подлинности с помощью Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Тип: oauth2 URL-адрес авторизации: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` область: `https://ai.azure.com/.default`
API-ключ	True	струна	Укажите здесь ключ API OpenAI Azure

Responses

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

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

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

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

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

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

Удалить файл

DELETE {endpoint}/openai/v1/files/{file_id}?api-version=preview

Параметры URI

Имя.	In	Обязательно	Тип	Description
endpoint	путь	Да	струна URL-адрес	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например `https://aoairesource.openai.azure.com`. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai. azure.com
версия API	query	нет		Явная версия API Foundry Models, которую следует использовать для этого запроса. `v1`, если не указано иначе.
идентификатор_файла	путь	Да	струна	Идентификатор файла, используемого для этого запроса.

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

Имя.	Обязательно	Тип	Description
Authorization	True	струна	Пример:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To создайте маркер проверки подлинности с помощью Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Тип: oauth2 URL-адрес авторизации: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` область: `https://ai.azure.com/.default`
API-ключ	True	струна	Укажите здесь ключ API OpenAI Azure

Responses

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

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

Тип содержимого	Тип	Описание
application/json	OpenAI.DeleteFileResponse

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

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

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

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

GET {endpoint}/openai/v1/files/{file_id}/content?api-version=preview

Параметры URI

Имя.	In	Обязательно	Тип	Description
endpoint	путь	Да	струна URL-адрес	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например `https://aoairesource.openai.azure.com`. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai. azure.com
версия API	query	нет		Явная версия API Foundry Models, которую следует использовать для этого запроса. `v1`, если не указано иначе.
идентификатор_файла	путь	Да	струна	Идентификатор файла, используемого для этого запроса.

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

Имя.	Обязательно	Тип	Description
Authorization	True	струна	Пример:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To создайте маркер проверки подлинности с помощью Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Тип: oauth2 URL-адрес авторизации: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` область: `https://ai.azure.com/.default`
API-ключ	True	струна	Укажите здесь ключ API OpenAI Azure

Responses

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

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

Тип содержимого	Тип	Описание
application/octet-stream	струна

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

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

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

Rungrader

POST {endpoint}/openai/v1/fine_tuning/alpha/graders/run?api-version=preview

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

Параметры URI

Имя.	In	Обязательно	Тип	Description
endpoint	путь	Да	струна URL-адрес	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например `https://aoairesource.openai.azure.com`. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai. azure.com
версия API	query	нет		Явная версия API Foundry Models, которую следует использовать для этого запроса. `v1`, если не указано иначе.

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

Имя.	Обязательно	Тип	Description
Authorization	True	струна	Пример:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To создайте маркер проверки подлинности с помощью Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Тип: oauth2 URL-адрес авторизации: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` область: `https://ai.azure.com/.default`
API-ключ	True	струна	Укажите здесь ключ API OpenAI Azure

Тело запроса

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

Имя.	Тип	Description	Обязательно
грейдер	объект	Объект StringCheckGrader, выполняющий сравнение строк между входами и ссылкой с помощью указанной операции.	Да
└calculate_output calculate_output	струна	Формула для вычисления выходных данных на основе результатов оценки.	нет
└️ evaluation_metric	перечисление	Используемая метрика оценки. Один из `fuzzy_match`, `bleu`, `gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`, или `rouge_l`. Возможные значения: `fuzzy_match`, `bleu`, `gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`, `rouge_l`	нет
└️ классировщиков	объект		нет
└image_tag	струна	Тег изображения, используемый для скрипта Python.	нет
└─ Входные данные	массив	Входной текст. Это может включать строки шаблона.	нет
└─ Модель	струна	Модель, используемая для оценки.	нет
└️ имя	струна	Имя классировщика.	нет
Операция └️	перечисление	Операция проверки строки, которую нужно выполнить. Один из `eq`, `nelike`или `ilike`. Возможные значения: `eq`, , `nelikeilike`	нет
Диапазон └️	массив	Диапазон оценки. По умолчанию — `[0, 1]`.	нет
Справочник по └️	струна	Текст, классируемый против.	нет
└─sampling_params		Параметры выборки для модели.	нет
└─ Источник	струна	Исходный код скрипта Python.	нет
└─ Тип	перечисление	Тип объекта, который всегда `multi`является . Возможные значения: `multi`	нет
item		Элемент набора данных, предоставленный классировщику. Это будет использоваться для заполнения `item` пространства имен.	нет
model_sample	струна	Пример модели, который необходимо оценить. Это значение будет использоваться для заполнения `sample` пространства имен. Переменная `output_json` будет заполнена, если пример модели является допустимой строкой JSON.	Да

Responses

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

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

Тип содержимого	Тип	Описание
application/json	OpenAI.RunGraderResponse

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

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

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

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

POST {endpoint}/openai/v1/fine_tuning/alpha/graders/validate?api-version=preview

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

Параметры URI

Имя.	In	Обязательно	Тип	Description
endpoint	путь	Да	струна URL-адрес	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например `https://aoairesource.openai.azure.com`. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai. azure.com
версия API	query	нет		Явная версия API Foundry Models, которую следует использовать для этого запроса. `v1`, если не указано иначе.

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

Имя.	Обязательно	Тип	Description
Authorization	True	струна	Пример:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To создайте маркер проверки подлинности с помощью Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Тип: oauth2 URL-адрес авторизации: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` область: `https://ai.azure.com/.default`
API-ключ	True	струна	Укажите здесь ключ API OpenAI Azure

Тело запроса

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

Имя.	Тип	Description	Обязательно
грейдер	объект	Объект StringCheckGrader, выполняющий сравнение строк между входами и ссылкой с помощью указанной операции.	Да
└calculate_output calculate_output	струна	Формула для вычисления выходных данных на основе результатов оценки.	нет
└️ evaluation_metric	перечисление	Используемая метрика оценки. Один из `fuzzy_match`, `bleu`, `gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`, или `rouge_l`. Возможные значения: `fuzzy_match`, `bleu`, `gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`, `rouge_l`	нет
└️ классировщиков	объект		нет
└image_tag	струна	Тег изображения, используемый для скрипта Python.	нет
└─ Входные данные	массив	Входной текст. Это может включать строки шаблона.	нет
└─ Модель	струна	Модель, используемая для оценки.	нет
└️ имя	струна	Имя классировщика.	нет
Операция └️	перечисление	Операция проверки строки, которую нужно выполнить. Один из `eq`, `nelike`или `ilike`. Возможные значения: `eq`, , `nelikeilike`	нет
Диапазон └️	массив	Диапазон оценки. По умолчанию — `[0, 1]`.	нет
Справочник по └️	струна	Текст, классируемый против.	нет
└─sampling_params		Параметры выборки для модели.	нет
└─ Источник	струна	Исходный код скрипта Python.	нет
└─ Тип	перечисление	Тип объекта, который всегда `multi`является . Возможные значения: `multi`	нет

Responses

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

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

Тип содержимого	Тип	Описание
application/json	OpenAI.ValidateGraderResponse

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

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

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

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

POST {endpoint}/openai/v1/fine_tuning/jobs?api-version=preview

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

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

Параметры URI

Имя.	In	Обязательно	Тип	Description
endpoint	путь	Да	струна URL-адрес	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например `https://aoairesource.openai.azure.com`. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai. azure.com
версия API	query	нет		Явная версия API Foundry Models, которую следует использовать для этого запроса. `v1`, если не указано иначе.

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

Имя.	Обязательно	Тип	Description
Authorization	True	струна	Пример:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To создайте маркер проверки подлинности с помощью Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Тип: oauth2 URL-адрес авторизации: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` область: `https://ai.azure.com/.default`
API-ключ	True	струна	Укажите здесь ключ API OpenAI Azure

Тело запроса

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

Имя.	Тип	Description	Обязательно	По умолчанию
гиперпараметры	объект	Гиперпараметры, используемые для задания тонкой настройки. Это значение теперь устарело в пользу `method`и должно передаваться в соответствии с параметром `method` .	нет
└batch_size	перечисление	Возможные значения: `auto`	нет
└learning_rate_multiplier learning_rate_multiplier	перечисление	Возможные значения: `auto`	нет
└️ n_epochs	перечисление	Возможные значения: `auto`	нет
Интеграции	массив	Список интеграции для задания тонкой настройки.	нет
metadata	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате и запроса на объекты через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — это строки с максимальной длиной 512 символов.	нет
method	OpenAI.FineTuneMethod	Метод, используемый для точной настройки.	нет
модель	строка (см. допустимые модели ниже)	Имя модели для точной настройки.	Да
seed	целое число	Сид определяет воспроизводимость задания. Передача одинаковых параметров начального значения и заданий должна иметь одинаковые результаты, но может отличаться в редких случаях. Если начальное значение не указано, он будет создан для вас.	нет
Суффикс	струна	Строка до 64 символов, которые будут добавлены в имя настраиваемой модели. Например, `suffix` в поле "Custom-model-name" будет производиться имя модели, например `ft:gpt-4o-mini:openai:custom-model-name:7p4lURel`.	нет	None
файл_обучения	струна	Идентификатор отправленного файла, содержащего данные обучения. Набор данных должен быть отформатирован в формате JSONL-файла. Кроме того, необходимо передать файл с целью `fine-tune`. Содержимое файла должно отличаться в зависимости от того, использует ли модель чат, формат завершения или использует ли метод тонкой настройки формат предпочтения.	Да
Файл_валидации	струна	Идентификатор отправленного файла, содержащего данные проверки. Если вы предоставляете этот файл, данные используются для периодического создания метрик валидации во время точной настройки. Эти показатели можно просмотреть в файле результатов тонкой настройки. Одни и те же данные не должны присутствовать в файлах обучения и проверки. Набор данных должен быть отформатирован в формате JSONL-файла. Необходимо отправить файл с целью `fine-tune`.	нет

Responses

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

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

Тип содержимого	Тип	Описание
application/json	OpenAI.FineTuningJob

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

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

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

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

GET {endpoint}/openai/v1/fine_tuning/jobs?api-version=preview

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

Параметры URI

Имя.	In	Обязательно	Тип	Description
endpoint	путь	Да	струна URL-адрес	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например `https://aoairesource.openai.azure.com`. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai. azure.com
версия API	query	нет		Явная версия API Foundry Models, которую следует использовать для этого запроса. `v1`, если не указано иначе.
after	query	нет	струна	Идентификатор последнего задания из предыдущего запроса на страницы.
limit	query	нет	целое число	Количество получаемых заданий точной настройки.

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

Имя.	Обязательно	Тип	Description
Authorization	True	струна	Пример:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To создайте маркер проверки подлинности с помощью Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Тип: oauth2 URL-адрес авторизации: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` область: `https://ai.azure.com/.default`
API-ключ	True	струна	Укажите здесь ключ API OpenAI Azure

Responses

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

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

Тип содержимого	Тип	Описание
application/json	OpenAI.ListPaginatedFineTuningJobsResponse

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

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

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

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

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}?api-version=preview

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

Параметры URI

Имя.	In	Обязательно	Тип	Description
endpoint	путь	Да	струна URL-адрес	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например `https://aoairesource.openai.azure.com`. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai. azure.com
версия API	query	нет		Явная версия API Foundry Models, которую следует использовать для этого запроса. `v1`, если не указано иначе.
идентификатор_задания_тончайшей_настройки	путь	Да	струна	Идентификатор задания тонкой настройки.

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

Имя.	Обязательно	Тип	Description
Authorization	True	струна	Пример:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To создайте маркер проверки подлинности с помощью Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Тип: oauth2 URL-адрес авторизации: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` область: `https://ai.azure.com/.default`
API-ключ	True	струна	Укажите здесь ключ API OpenAI Azure

Responses

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

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

Тип содержимого	Тип	Описание
application/json	OpenAI.FineTuningJob

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

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

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

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

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/cancel?api-version=preview

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

Параметры URI

Имя.	In	Обязательно	Тип	Description
endpoint	путь	Да	струна URL-адрес	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например `https://aoairesource.openai.azure.com`. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai. azure.com
версия API	query	нет		Явная версия API Foundry Models, которую следует использовать для этого запроса. `v1`, если не указано иначе.
идентификатор_задания_тончайшей_настройки	путь	Да	струна	Идентификатор задания тонкой настройки для отмены.

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

Имя.	Обязательно	Тип	Description
Authorization	True	струна	Пример:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To создайте маркер проверки подлинности с помощью Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Тип: oauth2 URL-адрес авторизации: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` область: `https://ai.azure.com/.default`
API-ключ	True	струна	Укажите здесь ключ API OpenAI Azure

Responses

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

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

Тип содержимого	Тип	Описание
application/json	OpenAI.FineTuningJob

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

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

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

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

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints?api-version=preview

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

Параметры URI

Имя.	In	Обязательно	Тип	Description
endpoint	путь	Да	струна URL-адрес	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например `https://aoairesource.openai.azure.com`. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai. azure.com
версия API	query	нет		Явная версия API Foundry Models, которую следует использовать для этого запроса. `v1`, если не указано иначе.
идентификатор_задания_тончайшей_настройки	путь	Да	струна	Идентификатор задания точной настройки для получения контрольных точек.
after	query	нет	струна	Идентификатор последнего идентификатора контрольной точки из предыдущего запроса на страницы.
limit	query	нет	целое число	Количество получаемых контрольных точек.

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

Имя.	Обязательно	Тип	Description
Authorization	True	струна	Пример:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To создайте маркер проверки подлинности с помощью Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Тип: oauth2 URL-адрес авторизации: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` область: `https://ai.azure.com/.default`
API-ключ	True	струна	Укажите здесь ключ API OpenAI Azure

Responses

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

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

Тип содержимого	Тип	Описание
application/json	OpenAI.ListFineTuningJobCheckpointsResponse

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

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

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

Список событий настройки параметров

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/events?api-version=preview

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

Параметры URI

Имя.	In	Обязательно	Тип	Description
endpoint	путь	Да	струна URL-адрес	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например `https://aoairesource.openai.azure.com`. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai. azure.com
версия API	query	нет		Явная версия API Foundry Models, которую следует использовать для этого запроса. `v1`, если не указано иначе.
идентификатор_задания_тончайшей_настройки	путь	Да	струна	Идентификатор задания точной настройки для получения событий.
after	query	нет	струна	Идентификатор последнего события из предыдущего запроса на страницы.
limit	query	нет	целое число	Количество извлекаемых событий.

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

Имя.	Обязательно	Тип	Description
Authorization	True	струна	Пример:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To создайте маркер проверки подлинности с помощью Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Тип: oauth2 URL-адрес авторизации: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` область: `https://ai.azure.com/.default`
API-ключ	True	струна	Укажите здесь ключ API OpenAI Azure

Responses

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

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

Тип содержимого	Тип	Описание
application/json	OpenAI.ListFineTuningJobEventsResponse

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

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

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

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

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/pause?api-version=preview

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

Параметры URI

Имя.	In	Обязательно	Тип	Description
endpoint	путь	Да	струна URL-адрес	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например `https://aoairesource.openai.azure.com`. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai. azure.com
версия API	query	нет		Явная версия API Foundry Models, которую следует использовать для этого запроса. `v1`, если не указано иначе.
идентификатор_задания_тончайшей_настройки	путь	Да	струна	Идентификатор задания тонкой настройки для приостановки.

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

Имя.	Обязательно	Тип	Description
Authorization	True	струна	Пример:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To создайте маркер проверки подлинности с помощью Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Тип: oauth2 URL-адрес авторизации: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` область: `https://ai.azure.com/.default`
API-ключ	True	струна	Укажите здесь ключ API OpenAI Azure

Responses

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

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

Тип содержимого	Тип	Описание
application/json	OpenAI.FineTuningJob

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

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

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

Возобновление задания тонкой настройки

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/resume?api-version=preview

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

Параметры URI

Имя.	In	Обязательно	Тип	Description
endpoint	путь	Да	струна URL-адрес	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например `https://aoairesource.openai.azure.com`. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai. azure.com
версия API	query	нет		Явная версия API Foundry Models, которую следует использовать для этого запроса. `v1`, если не указано иначе.
идентификатор_задания_тончайшей_настройки	путь	Да	струна	Идентификатор задания тонкой настройки для возобновления.

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

Имя.	Обязательно	Тип	Description
Authorization	True	струна	Пример:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To создайте маркер проверки подлинности с помощью Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Тип: oauth2 URL-адрес авторизации: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` область: `https://ai.azure.com/.default`
API-ключ	True	струна	Укажите здесь ключ API OpenAI Azure

Responses

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

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

Тип содержимого	Тип	Описание
application/json	OpenAI.FineTuningJob

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

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

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

Редактировать изображение

POST {endpoint}/openai/v1/images/edits?api-version=preview

Параметры URI

Имя.	In	Обязательно	Тип	Description
endpoint	путь	Да	струна URL-адрес	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например `https://aoairesource.openai.azure.com`. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai. azure.com
версия API	query	нет		Явная версия API Foundry Models, которую следует использовать для этого запроса. `v1`, если не указано иначе.

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

Имя.	Обязательно	Тип	Description
Authorization	True	струна	Пример:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To создайте маркер проверки подлинности с помощью Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Тип: oauth2 URL-адрес авторизации: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` область: `https://ai.azure.com/.default`
API-ключ	True	струна	Укажите здесь ключ API OpenAI Azure

Тело запроса

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

Имя.	Тип	Description	Обязательно	По умолчанию
фон	перечисление	Позволяет задать прозрачность фона созданных образов. Этот параметр поддерживается только для `gpt-image-1`моделей серии. Должно быть одним из значений `transparentopaque` или `auto` (значение по умолчанию). При `auto` использовании модель автоматически определяет лучший фон для изображения. Если `transparent`выходной формат должен поддерживать прозрачность, поэтому он должен иметь значение `png` (значение по умолчанию) или `webp`. Возможные значения: `transparent`, `opaqueauto`	нет
image	строка или массив		Да
mask	струна		нет
модель	струна	Развертывание модели для использования в операции по редактированию изображения.	Да
н	целое число	Количество генерируемых изображений. Должно быть от 1 до 10.	нет	1
сжатие вывода	целое число	Уровень сжатия (0–100%) для созданных образов. Этот параметр поддерживается только для `gpt-image-1`-серий моделей с `webp` или `jpeg` выходными форматами, и по умолчанию, 100.	нет	100
формат_выходных_данных	перечисление	Формат, в котором возвращаются созданные изображения. Этот параметр поддерживается только для `gpt-image-1`моделей серии. Должно иметь один из типов `png`, `jpeg` или `webp`. Значение по умолчанию — `png`. Возможные значения: `png`, `jpegwebp`	нет
prompt	струна	Текстовое описание требуемых изображений. Максимальная длина — 1000 символов для `dall-e-2gpt-image-1`моделей серии и 32000 символов.	Да
качество	перечисление	Качество создаваемого изображения. `high`, `medium` и `low` поддерживаются только для `gpt-image-1`моделей серии. `dall-e-2` поддерживает только `standard` качество. По умолчанию — `auto`. Возможные значения: `standard`, `low`, `medium`, `high`, `auto`	нет
формат_ответа	перечисление	Формат, в котором возвращаются созданные изображения. Должен быть одним из `url` или `b64_json`. URL-адреса действительны только в течение 60 минут после создания образа. Этот параметр поддерживается только для `dall-e-2`моделей серии , так как `gpt-image-1`всегда возвращает образы в кодировке Base64. Возможные значения: `url`, `b64_json`	нет
size	перечисление	Размер созданных изображений. Должен быть одним из `1024x1024`, `1536x1024` (альбомная ориентация), `1024x1536` (книжная ориентация) или `auto` (значение по умолчанию) для моделей серии `gpt-image-1`, а также одно из `256x256`, `512x512` или `1024x1024` для `dall-e-2`. Возможные значения: `256x256`, `512x512`, `1024x1024`, `1536x1024`, `1024x1536`, `auto`	нет
Пользователь	струна	Уникальный идентификатор, представляющий пользователя, который может помочь OpenAI отслеживать и обнаруживать злоупотребления.	нет

Responses

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

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

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

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

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

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

Createimage

POST {endpoint}/openai/v1/images/generations?api-version=preview

Параметры URI

Имя.	In	Обязательно	Тип	Description
endpoint	путь	Да	струна URL-адрес	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например `https://aoairesource.openai.azure.com`. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai. azure.com
версия API	query	нет		Явная версия API Foundry Models, которую следует использовать для этого запроса. `v1`, если не указано иначе.

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

Имя.	Обязательно	Тип	Description
Authorization	True	струна	Пример:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To создайте маркер проверки подлинности с помощью Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Тип: oauth2 URL-адрес авторизации: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` область: `https://ai.azure.com/.default`
API-ключ	True	струна	Укажите здесь ключ API OpenAI Azure

Тело запроса

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

Имя.	Тип	Description	Обязательно	По умолчанию
фон	перечисление	Позволяет задать прозрачность фона созданных образов. Этот параметр поддерживается только для `gpt-image-1`моделей серии. Должно быть одним из значений `transparentopaque` или `auto` (значение по умолчанию). При `auto` использовании модель автоматически определяет лучший фон для изображения. Если `transparent`выходной формат должен поддерживать прозрачность, поэтому он должен иметь значение `png` (значение по умолчанию) или `webp`. Возможные значения: `transparent`, `opaqueauto`	нет
модель	струна	Развертывание модели, используемое для создания образа.	Да
moderation	перечисление	Управление уровнем модерации содержимого для изображений, созданных моделями серии `gpt-image-1`. `low` Для менее строгой фильтрации или `auto` (значения по умолчанию). Возможные значения: `low`, `auto`	нет
н	целое число	Количество генерируемых изображений. Должно быть от 1 до 10. Для `dall-e-3` поддерживается только `n=1`.	нет	1
сжатие вывода	целое число	Уровень сжатия (0–100%) для созданных образов. Этот параметр поддерживается только для `gpt-image-1`-серий моделей с `webp` или `jpeg` выходными форматами, и по умолчанию, 100.	нет	100
формат_выходных_данных	перечисление	Формат, в котором возвращаются созданные изображения. Этот параметр поддерживается только для `gpt-image-1`моделей серии. Должно иметь один из типов `png`, `jpeg` или `webp`. Возможные значения: `png`, `jpegwebp`	нет
prompt	струна	Текстовое описание требуемых изображений. Максимальная длина — 32000 символов для `gpt-image-1`моделей серии, 1000 символов для `dall-e-2` и 4000 символов.`dall-e-3`	Да
качество	перечисление	Качество создаваемого изображения. - `auto` (значение по умолчанию) автоматически выбирает лучшее качество для данной модели. - `high`, `medium` и `low` поддерживаются для `gpt-image-1`моделей серии. - `hd` и `standard` поддерживаются для `dall-e-3`. - `standard` — единственный вариант для `dall-e-2`. Возможные значения: `standard`, `hd`, `low`, `medium`, `high`, `auto`	нет
формат_ответа	перечисление	Формат, в котором сгенерированные изображения с `dall-e-2` и `dall-e-3` возвращаются. Должен быть одним из `url` или `b64_json`. URL-адреса действительны только в течение 60 минут после создания образа. Этот параметр не поддерживается для `gpt-image-1`моделей серии, которые всегда возвращают образы в кодировке Base64. Возможные значения: `url`, `b64_json`	нет
size	перечисление	Размер созданных изображений. Должен быть одним из `1024x1024`, `1536x1024` (альбомная), `1024x1536` (книжная) или `auto` (значение по умолчанию) для моделей серии `gpt-image-1`, одним из `256x256`, `512x512`, или `1024x1024` для `dall-e-2`, и одним из `1024x1024`, `1792x1024` или `1024x1792` для `dall-e-3`. Возможные значения: `auto`, `1024x1024`, `1536x1024`, `1024x1536`, `256x256`, `512x512`, `1792x1024`, `1024x1792`	нет
стиль	перечисление	Стиль созданных изображений. Этот параметр поддерживается только для `dall-e-3`. Должен быть одним из `vivid` или `natural`. Яркость заставляет модель стремиться к созданию гипер-реальных и драматических изображений. Естественные свойства модели позволяют создавать более естественные, менее гипер-реалистичные изображения. Возможные значения: `vivid`, `natural`	нет
Пользователь	струна	Уникальный идентификатор, представляющий пользователя, который может помочь OpenAI отслеживать и обнаруживать злоупотребления.	нет

Responses

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

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

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

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

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

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

Примеры

Пример

Создает изображения с запросом.

POST {endpoint}/openai/v1/images/generations?api-version=preview

{
 "model": "dall-e-3",
 "prompt": "In the style of WordArt, Microsoft Clippy wearing a cowboy hat.",
 "n": 1,
 "style": "natural",
 "quality": "standard"
}

Ответы: код состояния: 200

{
  "body": {
    "created": 1698342300,
    "data": [
      {
        "revised_prompt": "A vivid, natural representation of Microsoft Clippy wearing a cowboy hat.",
        "prompt_filter_results": {
          "sexual": {
            "severity": "safe",
            "filtered": false
          },
          "violence": {
            "severity": "safe",
            "filtered": false
          },
          "hate": {
            "severity": "safe",
            "filtered": false
          },
          "self_harm": {
            "severity": "safe",
            "filtered": false
          },
          "profanity": {
            "detected": false,
            "filtered": false
          },
          "custom_blocklists": {
            "filtered": false,
            "details": []
          }
        },
        "url": "https://dalletipusw2.blob.core.windows.net/private/images/e5451cc6-b1ad-4747-bd46-b89a3a3b8bc3/generated_00.png?se=2023-10-27T17%3A45%3A09Z&...",
        "content_filter_results": {
          "sexual": {
            "severity": "safe",
            "filtered": false
          },
          "violence": {
            "severity": "safe",
            "filtered": false
          },
          "hate": {
            "severity": "safe",
            "filtered": false
          },
          "self_harm": {
            "severity": "safe",
            "filtered": false
          }
        }
      }
    ]
  }
}

Перечисление моделей

GET {endpoint}/openai/v1/models?api-version=preview

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

Параметры URI

Имя.	In	Обязательно	Тип	Description
endpoint	путь	Да	струна URL-адрес	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например `https://aoairesource.openai.azure.com`. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai. azure.com
версия API	query	нет		Явная версия API Foundry Models, которую следует использовать для этого запроса. `v1`, если не указано иначе.

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

Имя.	Обязательно	Тип	Description
Authorization	True	струна	Пример:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To создайте маркер проверки подлинности с помощью Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Тип: oauth2 URL-адрес авторизации: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` область: `https://ai.azure.com/.default`
API-ключ	True	струна	Укажите здесь ключ API OpenAI Azure

Responses

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

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

Тип содержимого	Тип	Описание
application/json	OpenAI.ListModelsResponse

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

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

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

Получение модели

GET {endpoint}/openai/v1/models/{model}?api-version=preview

Извлекает экземпляр модели, предоставляя основные сведения о модели, например владельца и разрешения.

Параметры URI

Имя.	In	Обязательно	Тип	Description
endpoint	путь	Да	струна URL-адрес	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например `https://aoairesource.openai.azure.com`. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai. azure.com
версия API	query	нет		Явная версия API Foundry Models, которую следует использовать для этого запроса. `v1`, если не указано иначе.
модель	путь	Да	струна	Идентификатор модели, используемой для этого запроса.

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

Имя.	Обязательно	Тип	Description
Authorization	True	струна	Пример:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To создайте маркер проверки подлинности с помощью Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Тип: oauth2 URL-адрес авторизации: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` область: `https://ai.azure.com/.default`
API-ключ	True	струна	Укажите здесь ключ API OpenAI Azure

Responses

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

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

Тип содержимого	Тип	Описание
application/json	OpenAI.Model

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

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

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

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

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

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

Параметры URI

Имя.	In	Обязательно	Тип	Description
endpoint	путь	Да	струна URL-адрес	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например `https://aoairesource.openai.azure.com`. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai. azure.com
версия API	query	нет		Явная версия API Foundry Models, которую следует использовать для этого запроса. `v1`, если не указано иначе.

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

Имя.	Обязательно	Тип	Description
Authorization	True	струна	Пример:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To создайте маркер проверки подлинности с помощью Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Тип: oauth2 URL-адрес авторизации: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` область: `https://ai.azure.com/.default`
API-ключ	True	струна	Укажите здесь ключ API OpenAI Azure

Тело запроса

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

Имя.	Тип	Description	Обязательно	По умолчанию
фон	булевый	Запускать ли ответ модели в фоновом режиме.	нет	Неправда
include	массив	Укажите дополнительные выходные данные для включения в ответ модели. В настоящее время поддерживаются следующие значения: - `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`, или когда организация зарегистрирована в программе нулевого хранения данных).	нет
ввод	строка или массив		нет
instructions	струна	Сообщение системы (или разработчика), вставленное в контекст модели. При использовании вместе с `previous_response_id` инструкциями из предыдущего ответа не будут перенесены в следующий ответ. Это упрощает замену системных сообщений (или сообщений разработчиками) в новых ответах.	нет
max_output_tokens	целое число	Верхняя граница для числа маркеров, которые можно создать для ответа, включая видимые выходные маркеры и маркеры причин	нет
max_tool_calls	целое число	Максимальное количество общих вызовов встроенных инструментов, которые могут обрабатываться в ответе. Это максимальное число применяется ко всем встроенным вызовам инструментов, а не для каждого отдельного средства. Любые дальнейшие попытки вызова средства моделью будут игнорироваться.	нет
metadata	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате и запроса на объекты через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — это строки с максимальной длиной 512 символов.	нет
модель	струна	Развертывание модели, используемое для создания этого ответа.	Да
вызовы инструмента в параллельном режиме	булевый	Следует ли разрешить модели запускать вызовы инструментов параллельно.	нет	True
previous_response_id	струна	Уникальный идентификатор предыдущего ответа на модель. Используйте эту функцию для создания многоэтапных бесед.	нет
prompt	объект	Ссылка на шаблон запроса и его переменные.	нет
Идентификатор └️	струна	Уникальный идентификатор используемого шаблона запроса.	нет
Переменные └️	OpenAI.ResponsePromptVariables	Необязательная карта значений для замены переменных в запросе. Значения подстановки могут быть строками или другими типами входных данных ответа, такими как изображения или файлы.	нет
Версия └️	струна	Необязательная версия шаблона запроса.	нет
reasoning	объект	Только модели o-серии Параметры конфигурации для моделей рассуждений.	нет
- усилия	OpenAI.ReasoningEffort	Только модели o-серии Ограничивает усилия по рассуждениям моделей. В настоящее время поддерживаются `low`значения , `medium`и `high`. Сокращение усилий по поводу может привести к более быстрым откликам и меньшем количестве маркеров, используемых при рассуждениях в ответе.	нет
└─generate_summary	перечисление	Не рекомендуется: используйте `summary` вместо этого. Сводка умозаключений, сделанных моделью. Это может быть полезно для отладки и понимания процесса рассуждений модели. Один из `auto`, `concise`, или `detailed`. Возможные значения: `auto`, `concisedetailed`	нет
└️ сводка	перечисление	Сводка умозаключений, сделанных моделью. Это может быть полезно для отладки и понимания процесса рассуждений модели. Один из `auto`, `concise`, или `detailed`. Возможные значения: `auto`, `concisedetailed`	нет
store	булевый	Следует ли хранить созданный ответ модели для последующего получения через API.	нет	True
поток	булевый	Если задано значение true, данные ответа модели будут передаваться клиенту по мере его создания с помощью событий, отправляемых сервером.	нет	Неправда
Температура	число/номер	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным. Как правило, мы рекомендуем изменить это или `top_p` не оба.	нет	1
текст	объект	Параметры конфигурации для текстового ответа модели. Можно использовать обычный текст или структурированные данные JSON.	нет
└─ Формат	OpenAI.ResponseTextFormatConfiguration		нет
выбор инструмента	объект	Определяет, какое средство (если таковое) вызывается моделью. `none` означает, что модель не будет вызывать какое-либо средство и вместо этого создает сообщение. `auto` означает, что модель может выбирать между созданием сообщения или вызовом одного или нескольких инструментов. `required` означает, что модель должна вызывать один или несколько инструментов.	нет
└─ Тип	OpenAI.ToolChoiceObjectType	Указывает, что модель должна использовать встроенное средство для создания ответа.	нет
инструменты	массив	Массив инструментов, которые модель может вызывать при создании ответа. Ты может указать, какое средство следует использовать, задав `tool_choice` параметр. Ниже приведены две категории инструментов, которые можно предоставить модели: - Встроенные средства: средства, предоставляемые OpenAI, которые расширяют возможности модели, например поиск файлов. - Вызовы функций (пользовательские средства): функции, определенные вами, что позволяет модели вызывать собственный код.	нет
top_logprobs	целое число	Целое число от 0 до 20, указывающее число наиболее вероятных маркеров, возвращаемых по каждой позиции маркера, каждый из которых имеет связанную вероятность журнала.	нет
top_p	число/номер	Альтернативой выборке с температурой является так называемая выборка ядра, где модель рассматривает результаты маркеров с top_p всего массива значений вероятности. Таким образом, 0,1 означает, что учитываются только маркеры, входящие в верхние 10% массива значений вероятности. Как правило, мы рекомендуем изменить это или `temperature` не оба.	нет	1
truncation	перечисление	Стратегия усечения, которую следует использовать для генерирования ответа модели. - `auto`: если контекст этого ответа и предыдущих превышает размер окна контекста модели, модель усечет ответ, чтобы он соответствовал этому окну, удаляя элементы ввода в середине беседы. - `disabled` (по умолчанию): если ответ модели превысит размер окна контекста для модели, запрос завершится ошибкой 400. Возможные значения: `auto`, `disabled`	нет
Пользователь	струна	Уникальный идентификатор, представляющий пользователя, который может помочь OpenAI отслеживать и обнаруживать злоупотребления.	нет

Responses

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

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

Тип содержимого	Тип	Описание
application/json	AzureResponse
text/event-stream	OpenAI.ResponseStreamEvent

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

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

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

Примеры

Пример

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

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

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

GET {endpoint}/openai/v1/responses/{response_id}?api-version=preview

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

Параметры URI

Имя.	In	Обязательно	Тип	Description
endpoint	путь	Да	струна URL-адрес	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например `https://aoairesource.openai.azure.com`. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai. azure.com
версия API	query	нет		Явная версия API Foundry Models, которую следует использовать для этого запроса. `v1`, если не указано иначе.
response_id	путь	Да	струна
include[]	query	нет	массив

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

Имя.	Обязательно	Тип	Description
Authorization	True	струна	Пример:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To создайте маркер проверки подлинности с помощью Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Тип: oauth2 URL-адрес авторизации: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` область: `https://ai.azure.com/.default`
API-ключ	True	струна	Укажите здесь ключ API OpenAI Azure

Responses

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

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

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

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

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

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

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

DELETE {endpoint}/openai/v1/responses/{response_id}?api-version=preview

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

Параметры URI

Имя.	In	Обязательно	Тип	Description
endpoint	путь	Да	струна URL-адрес	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например `https://aoairesource.openai.azure.com`. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai. azure.com
версия API	query	нет		Явная версия API Foundry Models, которую следует использовать для этого запроса. `v1`, если не указано иначе.
response_id	путь	Да	струна

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

Имя.	Обязательно	Тип	Description
Authorization	True	струна	Пример:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To создайте маркер проверки подлинности с помощью Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Тип: oauth2 URL-адрес авторизации: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` область: `https://ai.azure.com/.default`
API-ключ	True	струна	Укажите здесь ключ API OpenAI Azure

Responses

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

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

Тип содержимого	Тип	Описание
application/json	объект

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

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

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

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

GET {endpoint}/openai/v1/responses/{response_id}/input_items?api-version=preview

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

Параметры URI

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

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

Имя.	Обязательно	Тип	Description
Authorization	True	струна	Пример:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To создайте маркер проверки подлинности с помощью Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Тип: oauth2 URL-адрес авторизации: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` область: `https://ai.azure.com/.default`
API-ключ	True	струна	Укажите здесь ключ API OpenAI Azure

Responses

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

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

Тип содержимого	Тип	Описание
application/json	OpenAI.ResponseItemList

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

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

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

Список хранилищ векторов

GET {endpoint}/openai/v1/vector_stores?api-version=preview

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

Параметры URI

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

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

Имя.	Обязательно	Тип	Description
Authorization	True	струна	Пример:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To создайте маркер проверки подлинности с помощью Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Тип: oauth2 URL-адрес авторизации: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` область: `https://ai.azure.com/.default`
API-ключ	True	струна	Укажите здесь ключ API OpenAI Azure

Responses

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

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

Тип содержимого	Тип	Описание
application/json	OpenAI.ListVectorStoresResponse

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

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

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

Создание хранилища векторов

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

Создает векторное хранилище.

Параметры URI

Имя.	In	Обязательно	Тип	Description
endpoint	путь	Да	струна URL-адрес	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например `https://aoairesource.openai.azure.com`. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai. azure.com
версия API	query	нет		Явная версия API Foundry Models, которую следует использовать для этого запроса. `v1`, если не указано иначе.

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

Имя.	Обязательно	Тип	Description
Authorization	True	струна	Пример:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To создайте маркер проверки подлинности с помощью Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Тип: oauth2 URL-адрес авторизации: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` область: `https://ai.azure.com/.default`
API-ключ	True	струна	Укажите здесь ключ API OpenAI Azure

Тело запроса

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

Имя.	Тип	Description	Обязательно
chunking_strategy	объект	Стратегия по умолчанию. В настоящее время эта стратегия использует и `max_chunk_size_tokens` имеет значение `800chunk_overlap_tokens` .`400`	нет
└️ статический	OpenAI.StaticChunkingStrategy		нет
└─ Тип	перечисление	Всегда `static`. Возможные значения: `static`	нет
истекает через	OpenAI.VectorStoreExpirationAfter	Политика истечения срока действия для хранилища векторов.	нет
идентификаторы_файлов	массив	Список идентификаторов файлов, которые следует использовать векторным хранилищем. Полезно для таких средств, как `file_search`, которые могут access файлов.	нет
metadata	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате и запроса на объекты через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — это строки с максимальной длиной 512 символов.	нет
имя	струна	Имя векторного хранилища.	нет

Responses

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

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

Тип содержимого	Тип	Описание
application/json	OpenAI.VectorStoreObject

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

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

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

Примеры

Пример файла не найден: ./examples/vector_stores.json

Получение хранилища векторов

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}?api-version=preview

Извлекает векторное хранилище.

Параметры URI

Имя.	In	Обязательно	Тип	Description
endpoint	путь	Да	струна URL-адрес	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например `https://aoairesource.openai.azure.com`. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai. azure.com
версия API	query	нет		Явная версия API Foundry Models, которую следует использовать для этого запроса. `v1`, если не указано иначе.
vector_store_id	путь	Да	струна	Идентификатор извлекаемого хранилища векторов.

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

Имя.	Обязательно	Тип	Description
Authorization	True	струна	Пример:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To создайте маркер проверки подлинности с помощью Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Тип: oauth2 URL-адрес авторизации: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` область: `https://ai.azure.com/.default`
API-ключ	True	струна	Укажите здесь ключ API OpenAI Azure

Responses

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

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

Тип содержимого	Тип	Описание
application/json	OpenAI.VectorStoreObject

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

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

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

Изменение хранилища векторов

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}?api-version=preview

Изменяет векторное хранилище.

Параметры URI

Имя.	In	Обязательно	Тип	Description
endpoint	путь	Да	струна URL-адрес	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например `https://aoairesource.openai.azure.com`. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai. azure.com
версия API	query	нет		Явная версия API Foundry Models, которую следует использовать для этого запроса. `v1`, если не указано иначе.
vector_store_id	путь	Да	струна	Идентификатор измененного хранилища векторов.

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

Имя.	Обязательно	Тип	Description
Authorization	True	струна	Пример:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To создайте маркер проверки подлинности с помощью Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Тип: oauth2 URL-адрес авторизации: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` область: `https://ai.azure.com/.default`
API-ключ	True	струна	Укажите здесь ключ API OpenAI Azure

Тело запроса

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

Имя.	Тип	Description	Обязательно
истекает через	объект	Политика истечения срока действия для хранилища векторов.	нет
Привязка └️	перечисление	Метка времени привязки, после которой применяется политика истечения срока действия. Поддерживаемые привязки: `last_active_at`. Возможные значения: `last_active_at`	нет
└️ дней	целое число	Количество дней после истечения срока действия привязки хранилища векторов.	нет
metadata	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате и запроса на объекты через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — это строки с максимальной длиной 512 символов.	нет
имя	струна	Имя векторного хранилища.	нет

Responses

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

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

Тип содержимого	Тип	Описание
application/json	OpenAI.VectorStoreObject

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

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

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

Удаление хранилища векторов

DELETE {endpoint}/openai/v1/vector_stores/{vector_store_id}?api-version=preview

Удаление векторного хранилища.

Параметры URI

Имя.	In	Обязательно	Тип	Description
endpoint	путь	Да	струна URL-адрес	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например `https://aoairesource.openai.azure.com`. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai. azure.com
версия API	query	нет		Явная версия API Foundry Models, которую следует использовать для этого запроса. `v1`, если не указано иначе.
vector_store_id	путь	Да	струна	Идентификатор удаленного хранилища векторов.

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

Имя.	Обязательно	Тип	Description
Authorization	True	струна	Пример:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To создайте маркер проверки подлинности с помощью Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Тип: oauth2 URL-адрес авторизации: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` область: `https://ai.azure.com/.default`
API-ключ	True	струна	Укажите здесь ключ API OpenAI Azure

Responses

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

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

Тип содержимого	Тип	Описание
application/json	OpenAI.DeleteVectorStoreResponse

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

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

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

Создание пакета файлов хранилища векторов

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches?api-version=preview

Создайте пакет файла векторного хранилища.

Параметры URI

Имя.	In	Обязательно	Тип	Description
endpoint	путь	Да	струна URL-адрес	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например `https://aoairesource.openai.azure.com`. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai. azure.com
версия API	query	нет		Явная версия API Foundry Models, которую следует использовать для этого запроса. `v1`, если не указано иначе.
vector_store_id	путь	Да	струна	Идентификатор хранилища векторов, для которого создается пакет файла.

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

Имя.	Обязательно	Тип	Description
Authorization	True	струна	Пример:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To создайте маркер проверки подлинности с помощью Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Тип: oauth2 URL-адрес авторизации: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` область: `https://ai.azure.com/.default`
API-ключ	True	струна	Укажите здесь ключ API OpenAI Azure

Тело запроса

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

Имя.	Тип	Description	Обязательно
attributes	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате и запроса на объекты через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения могут быть строками с максимальной длиной 512 символов, логическими значениями или числами.	нет
chunking_strategy	OpenAI.ChunkingStrategyRequestParam	Стратегия блокирования, используемая для блокирования файлов. Если этот параметр не задан, используйте стратегию `auto` .	нет
идентификаторы_файлов	массив	Список идентификаторов файлов, которые следует использовать векторным хранилищем. Полезно для таких средств, как `file_search`, которые могут access файлов.	Да

Responses

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

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

Тип содержимого	Тип	Описание
application/json	OpenAI.VectorStoreFileBatchObject

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

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

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

Получение пакета файлов хранилища векторов

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}?api-version=preview

Извлекает пакет файла векторного хранилища.

Параметры URI

Имя.	In	Обязательно	Тип	Description
endpoint	путь	Да	струна URL-адрес	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например `https://aoairesource.openai.azure.com`. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai. azure.com
версия API	query	нет		Явная версия API Foundry Models, которую следует использовать для этого запроса. `v1`, если не указано иначе.
vector_store_id	путь	Да	струна	Идентификатор хранилища векторов, к которому принадлежит пакет файла.
batch_id	путь	Да	струна	Идентификатор извлекаемого пакета файлов.

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

Имя.	Обязательно	Тип	Description
Authorization	True	струна	Пример:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To создайте маркер проверки подлинности с помощью Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Тип: oauth2 URL-адрес авторизации: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` область: `https://ai.azure.com/.default`
API-ключ	True	струна	Укажите здесь ключ API OpenAI Azure

Responses

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

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

Тип содержимого	Тип	Описание
application/json	OpenAI.VectorStoreFileBatchObject

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

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

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

Отмена пакета файлов хранилища векторов

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel?api-version=preview

Отмена пакета файла векторного хранилища. Это пытается отменить обработку файлов в этом пакете как можно скорее.

Параметры URI

Имя.	In	Обязательно	Тип	Description
endpoint	путь	Да	струна URL-адрес	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например `https://aoairesource.openai.azure.com`. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai. azure.com
версия API	query	нет		Явная версия API Foundry Models, которую следует использовать для этого запроса. `v1`, если не указано иначе.
vector_store_id	путь	Да	струна	Идентификатор хранилища векторов, к которому принадлежит пакет файла.
batch_id	путь	Да	струна	Идентификатор партии файлов, которую нужно отменить.

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

Имя.	Обязательно	Тип	Description
Authorization	True	струна	Пример:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To создайте маркер проверки подлинности с помощью Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Тип: oauth2 URL-адрес авторизации: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` область: `https://ai.azure.com/.default`
API-ключ	True	струна	Укажите здесь ключ API OpenAI Azure

Responses

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

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

Тип содержимого	Тип	Описание
application/json	OpenAI.VectorStoreFileBatchObject

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

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

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

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

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/files?api-version=preview

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

Параметры URI

Имя.	In	Обязательно	Тип	Description
endpoint	путь	Да	струна URL-адрес	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например `https://aoairesource.openai.azure.com`. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai. azure.com
версия API	query	нет		Явная версия API Foundry Models, которую следует использовать для этого запроса. `v1`, если не указано иначе.
vector_store_id	путь	Да	струна	Идентификатор хранилища векторов, к которому принадлежит пакет файла.
batch_id	путь	Да	струна	Идентификатор пакета файлов, к которому принадлежат файлы.
limit	query	нет	целое число	Ограничение количества возвращаемых объектов. Ограничение может быть от 1 до 100, а значение по умолчанию — 20.
заказ	query	нет	струна Возможные значения: `asc`, `desc`	Сортировка объектов по их метке времени `created_at`. `asc` для возрастания порядка и`desc` для убывания.
after	query	нет	струна	Курсор для использования в разбиении на страницы. `after` — это идентификатор объекта, определяющий место в списке. Например, если вы делаете запрос списка и получаете 100 объектов, заканчивая obj_foo, последующий вызов может включать after=obj_foo, чтобы получить следующую страницу списка.
before	query	нет	струна	Курсор для использования в разбиении на страницы. `before` — это идентификатор объекта, определяющий место в списке. Например, если вы делаете запрос списка и получаете 100 объектов, список заканчивается на obj_foo, ваш последующий вызов может содержать before=obj_foo, чтобы получить предыдущую страницу списка.
фильтр	query	нет		Фильтрация по состоянию файла. Один из `in_progress`, `completed`, `failed`, `cancelled`.

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

Имя.	Обязательно	Тип	Description
Authorization	True	струна	Пример:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To создайте маркер проверки подлинности с помощью Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Тип: oauth2 URL-адрес авторизации: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` область: `https://ai.azure.com/.default`
API-ключ	True	струна	Укажите здесь ключ API OpenAI Azure

Responses

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

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

Тип содержимого	Тип	Описание
application/json	OpenAI.ListVectorStoreFilesResponse

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

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

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

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

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/files?api-version=preview

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

Параметры URI

Имя.	In	Обязательно	Тип	Description
endpoint	путь	Да	струна URL-адрес	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например `https://aoairesource.openai.azure.com`. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai. azure.com
версия API	query	нет		Явная версия API Foundry Models, которую следует использовать для этого запроса. `v1`, если не указано иначе.
vector_store_id	путь	Да	струна	Идентификатор хранилища векторов, к которому принадлежат файлы.
limit	query	нет	целое число	Ограничение количества возвращаемых объектов. Ограничение может быть от 1 до 100, а значение по умолчанию — 20.
заказ	query	нет	струна Возможные значения: `asc`, `desc`	Сортировка объектов по их метке времени `created_at`. `asc` для возрастания порядка и`desc` для убывания.
after	query	нет	струна	Курсор для использования в разбиении на страницы. `after` — это идентификатор объекта, определяющий место в списке. Например, если вы делаете запрос списка и получаете 100 объектов, заканчивая obj_foo, последующий вызов может включать after=obj_foo, чтобы получить следующую страницу списка.
before	query	нет	струна	Курсор для использования в разбиении на страницы. `before` — это идентификатор объекта, определяющий место в списке. Например, если вы делаете запрос списка и получаете 100 объектов, список заканчивается на obj_foo, ваш последующий вызов может содержать before=obj_foo, чтобы получить предыдущую страницу списка.
фильтр	query	нет		Фильтрация по состоянию файла. Один из `in_progress`, `completed`, `failed`, `cancelled`.

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

Имя.	Обязательно	Тип	Description
Authorization	True	струна	Пример:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To создайте маркер проверки подлинности с помощью Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Тип: oauth2 URL-адрес авторизации: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` область: `https://ai.azure.com/.default`
API-ключ	True	струна	Укажите здесь ключ API OpenAI Azure

Responses

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

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

Тип содержимого	Тип	Описание
application/json	OpenAI.ListVectorStoreFilesResponse

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

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

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

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

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/files?api-version=preview

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

Параметры URI

Имя.	In	Обязательно	Тип	Description
endpoint	путь	Да	струна URL-адрес	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например `https://aoairesource.openai.azure.com`. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai. azure.com
версия API	query	нет		Явная версия API Foundry Models, которую следует использовать для этого запроса. `v1`, если не указано иначе.
vector_store_id	путь	Да	струна	Идентификатор векторного хранилища, для которого создается файл.

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

Имя.	Обязательно	Тип	Description
Authorization	True	струна	Пример:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To создайте маркер проверки подлинности с помощью Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Тип: oauth2 URL-адрес авторизации: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` область: `https://ai.azure.com/.default`
API-ключ	True	струна	Укажите здесь ключ API OpenAI Azure

Тело запроса

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

Имя.	Тип	Description	Обязательно
attributes	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате и запроса на объекты через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения могут быть строками с максимальной длиной 512 символов, логическими значениями или числами.	нет
chunking_strategy	OpenAI.ChunkingStrategyRequestParam	Стратегия блокирования, используемая для блокирования файлов. Если этот параметр не задан, используйте стратегию `auto` .	нет
идентификатор_файла	струна	Идентификатор файла, который должен использовать хранилище векторов. Полезно для таких средств, как `file_search`, которые могут access файлов.	Да

Responses

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

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

Тип содержимого	Тип	Описание
application/json	OpenAI.VectorStoreFileObject

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

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

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

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

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/files/{file_id}?api-version=preview

Извлекает файл векторного хранилища.

Параметры URI

Имя.	In	Обязательно	Тип	Description
endpoint	путь	Да	струна URL-адрес	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например `https://aoairesource.openai.azure.com`. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai. azure.com
версия API	query	нет		Явная версия API Foundry Models, которую следует использовать для этого запроса. `v1`, если не указано иначе.
vector_store_id	путь	Да	струна	Идентификатор векторного хранилища, к которому принадлежит файл.
идентификатор_файла	путь	Да	струна	Идентификатор извлекаемого файла.

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

Имя.	Обязательно	Тип	Description
Authorization	True	струна	Пример:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To создайте маркер проверки подлинности с помощью Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Тип: oauth2 URL-адрес авторизации: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` область: `https://ai.azure.com/.default`
API-ключ	True	струна	Укажите здесь ключ API OpenAI Azure

Responses

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

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

Тип содержимого	Тип	Описание
application/json	OpenAI.VectorStoreFileObject

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

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

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

Обновление атрибутов файла хранилища векторов

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/files/{file_id}?api-version=preview

Параметры URI

Имя.	In	Обязательно	Тип	Description
endpoint	путь	Да	струна URL-адрес	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например `https://aoairesource.openai.azure.com`. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai. azure.com
версия API	query	нет		Явная версия API Foundry Models, которую следует использовать для этого запроса. `v1`, если не указано иначе.
vector_store_id	путь	Да	струна
идентификатор_файла	путь	Да	струна

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

Имя.	Обязательно	Тип	Description
Authorization	True	струна	Пример:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To создайте маркер проверки подлинности с помощью Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Тип: oauth2 URL-адрес авторизации: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` область: `https://ai.azure.com/.default`
API-ключ	True	струна	Укажите здесь ключ API OpenAI Azure

Тело запроса

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

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

Responses

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

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

Тип содержимого	Тип	Описание
application/json	OpenAI.VectorStoreFileObject

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

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

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

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

DELETE {endpoint}/openai/v1/vector_stores/{vector_store_id}/files/{file_id}?api-version=preview

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

Параметры URI

Имя.	In	Обязательно	Тип	Description
endpoint	путь	Да	струна URL-адрес	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например `https://aoairesource.openai.azure.com`. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai. azure.com
версия API	query	нет		Явная версия API Foundry Models, которую следует использовать для этого запроса. `v1`, если не указано иначе.
vector_store_id	путь	Да	струна	Идентификатор векторного хранилища, к которому принадлежит файл.
идентификатор_файла	путь	Да	струна	Идентификатор удаленного файла.

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

Имя.	Обязательно	Тип	Description
Authorization	True	струна	Пример:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To создайте маркер проверки подлинности с помощью Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Тип: oauth2 URL-адрес авторизации: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` область: `https://ai.azure.com/.default`
API-ключ	True	струна	Укажите здесь ключ API OpenAI Azure

Responses

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

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

Тип содержимого	Тип	Описание
application/json	OpenAI.DeleteVectorStoreFileResponse

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

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

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

Задания создания видео — создание

POST {endpoint}/openai/v1/video/generations/jobs?api-version=preview

Создает задание создания видео.

Параметры URI

Имя.	In	Обязательно	Тип	Description
endpoint	путь	Да	струна URL-адрес	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например `https://aoairesource.openai.azure.com`. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai. azure.com
версия API	query	нет		Явная версия API Foundry Models, которую следует использовать для этого запроса. `v1`, если не указано иначе.

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

Имя.	Обязательно	Тип	Description
Authorization	True	струна	Пример:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To создайте маркер проверки подлинности с помощью Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Тип: oauth2 URL-адрес авторизации: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` область: `https://ai.azure.com/.default`
API-ключ	True	струна	Укажите здесь ключ API OpenAI Azure

Тело запроса

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

Имя.	Тип	Description	Обязательно	По умолчанию
height	целое число	Высота видео. Поддерживаются следующие измерения: 480x480, 854x480, 720x720, 1280x720, 1080x1080 и 1920x1080 в альбомной и книжной ориентации.	Да
модель	струна	Имя развертывания, используемого для этого запроса.	Да
n_seconds	целое число	Длительность задания создания видео. Должно быть от 1 до 20 секунд.	нет	5
n_variants	целое число	Количество видео для создания в качестве вариантов для этого задания. Значение должно находиться в диапазоне от 1 до 5. Меньшие размеры позволяют больше вариантов.	нет	1
prompt	струна	Запрос для задания создания видео.	Да
Ширина	целое число	Ширина видео. Поддерживаются следующие измерения: 480x480, 854x480, 720x720, 1280x720, 1080x1080 и 1920x1080 в альбомной и книжной ориентации.	Да

Тело запроса

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

Имя.	Тип	Description	Обязательно	По умолчанию
files	массив		Да
height	целое число	Высота видео. Поддерживаются следующие измерения: 480x480, 854x480, 720x720, 1280x720, 1080x1080 и 1920x1080 в альбомной и книжной ориентации.	Да
inpaint_items	массив	Необязательные элементы для этого задания создания видео.	нет
модель	струна	Имя развертывания, используемого для этого запроса.	Да
n_seconds	целое число	Длительность задания создания видео. Должно быть от 1 до 20 секунд.	нет	5
n_variants	целое число	Количество видео для создания в качестве вариантов для этого задания. Значение должно находиться в диапазоне от 1 до 5. Меньшие размеры позволяют больше вариантов.	нет	1
prompt	струна	Запрос для задания создания видео.	Да
Ширина	целое число	Ширина видео. Поддерживаются следующие измерения: 480x480, 854x480, 720x720, 1280x720, 1080x1080 и 1920x1080 в альбомной и книжной ориентации.	Да

Responses

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

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

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

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

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

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

Примеры

Пример файла не найден: ./examples/create_video_generation_job_simple.json

Задания создания видео — список

GET {endpoint}/openai/v1/video/generations/jobs?api-version=preview

Выводит список заданий создания видео.

Параметры URI

Имя.	In	Обязательно	Тип	Description
endpoint	путь	Да	струна URL-адрес	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например `https://aoairesource.openai.azure.com`. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai. azure.com
версия API	query	нет		Явная версия API Foundry Models, которую следует использовать для этого запроса. `v1`, если не указано иначе.
before	query	нет	струна
after	query	нет	струна
limit	query	Да	целое число
statuses	query	нет	массив

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

Имя.	Обязательно	Тип	Description
Authorization	True	струна	Пример:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To создайте маркер проверки подлинности с помощью Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Тип: oauth2 URL-адрес авторизации: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` область: `https://ai.azure.com/.default`
API-ключ	True	струна	Укажите здесь ключ API OpenAI Azure

Responses

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

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

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

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

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

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

Примеры

Пример файла не найден: ./examples/get_video_generation_job_list.json

Задания создания видео — Получение

GET {endpoint}/openai/v1/video/generations/jobs/{job-id}?api-version=preview

Извлекает свойства задания создания видео.

Параметры URI

Имя.	In	Обязательно	Тип	Description
endpoint	путь	Да	струна URL-адрес	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например `https://aoairesource.openai.azure.com`. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai. azure.com
версия API	query	нет		Явная версия API Foundry Models, которую следует использовать для этого запроса. `v1`, если не указано иначе.
идентификатор задания	путь	Да	струна	Идентификатор задания создания видео, используемого для запроса OpenAI Azure.

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

Имя.	Обязательно	Тип	Description
Authorization	True	струна	Пример:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To создайте маркер проверки подлинности с помощью Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Тип: oauth2 URL-адрес авторизации: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` область: `https://ai.azure.com/.default`
API-ключ	True	струна	Укажите здесь ключ API OpenAI Azure

Responses

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

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

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

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

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

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

Примеры

Пример файла не найден: ./examples/get_video_generation_job.json

Задания создания видео — удаление

DELETE {endpoint}/openai/v1/video/generations/jobs/{job-id}?api-version=preview

Удаляет задание создания видео.

Параметры URI

Имя.	In	Обязательно	Тип	Description
endpoint	путь	Да	струна URL-адрес	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например `https://aoairesource.openai.azure.com`. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai. azure.com
версия API	query	нет		Явная версия API Foundry Models, которую следует использовать для этого запроса. `v1`, если не указано иначе.
идентификатор задания	путь	Да	струна	Идентификатор задания создания видео, используемого для запроса OpenAI Azure.

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

Имя.	Обязательно	Тип	Description
Authorization	True	струна	Пример:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To создайте маркер проверки подлинности с помощью Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Тип: oauth2 URL-адрес авторизации: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` область: `https://ai.azure.com/.default`
API-ключ	True	струна	Укажите здесь ключ API OpenAI Azure

Responses

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

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

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

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

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

Поколения видео — Получить

GET {endpoint}/openai/v1/video/generations/{generation-id}?api-version=preview

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

Параметры URI

Имя.	In	Обязательно	Тип	Description
endpoint	путь	Да	струна URL-адрес	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например `https://aoairesource.openai.azure.com`. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai. azure.com
версия API	query	нет		Явная версия API Foundry Models, которую следует использовать для этого запроса. `v1`, если не указано иначе.
generation-id	путь	Да	струна	Идентификатор создания видео, используемого для запроса OpenAI Azure.

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

Имя.	Обязательно	Тип	Description
Authorization	True	струна	Пример:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To создайте маркер проверки подлинности с помощью Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Тип: oauth2 URL-адрес авторизации: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` область: `https://ai.azure.com/.default`
API-ключ	True	струна	Укажите здесь ключ API OpenAI Azure

Responses

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

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

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

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

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

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

Примеры

Пример файла не найден: ./examples/get_video_generation.json

Генерация видео — получение миниатюры

GET {endpoint}/openai/v1/video/generations/{generation-id}/content/thumbnail?api-version=preview

Извлекает эскиз созданного видеоконтента.

Параметры URI

Имя.	In	Обязательно	Тип	Description
endpoint	путь	Да	струна URL-адрес	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например `https://aoairesource.openai.azure.com`. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai. azure.com
версия API	query	нет		Явная версия API Foundry Models, которую следует использовать для этого запроса. `v1`, если не указано иначе.
generation-id	путь	Да	струна	Идентификатор создания видео, используемого для запроса OpenAI Azure.

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

Имя.	Обязательно	Тип	Description
Authorization	True	струна	Пример:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To создайте маркер проверки подлинности с помощью Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Тип: oauth2 URL-адрес авторизации: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` область: `https://ai.azure.com/.default`
API-ключ	True	струна	Укажите здесь ключ API OpenAI Azure

Responses

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

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

Тип содержимого	Тип	Описание
image/jpg	струна

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

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

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

Поколения видео — получение содержимого видео

GET {endpoint}/openai/v1/video/generations/{generation-id}/content/video?api-version=preview

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

Параметры URI

Имя.	In	Обязательно	Тип	Description
endpoint	путь	Да	струна URL-адрес	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например `https://aoairesource.openai.azure.com`. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai. azure.com
версия API	query	нет		Явная версия API Foundry Models, которую следует использовать для этого запроса. `v1`, если не указано иначе.
generation-id	путь	Да	струна	Идентификатор создания видео, используемого для запроса OpenAI Azure.
качество	query	нет

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

Имя.	Обязательно	Тип	Description
Authorization	True	струна	Пример:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To создайте маркер проверки подлинности с помощью Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Тип: oauth2 URL-адрес авторизации: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` область: `https://ai.azure.com/.default`
API-ключ	True	струна	Укажите здесь ключ API OpenAI Azure

Responses

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

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

Тип содержимого	Тип	Описание
video/mp4	струна

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

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

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

Поколения видео — получение только заголовков видеоконтентов

HEAD {endpoint}/openai/v1/video/generations/{generation-id}/content/video?api-version=preview

Извлекает заголовки для созданного видеоконтента.

Параметры URI

Имя.	In	Обязательно	Тип	Description
endpoint	путь	Да	струна URL-адрес	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например `https://aoairesource.openai.azure.com`. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai. azure.com
версия API	query	нет		Явная версия API Foundry Models, которую следует использовать для этого запроса. `v1`, если не указано иначе.
generation-id	путь	Да	струна	Идентификатор создания видео, используемого для запроса OpenAI Azure.
качество	query	нет

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

Имя.	Обязательно	Тип	Description
Authorization	True	струна	Пример:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To создайте маркер проверки подлинности с помощью Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Тип: oauth2 URL-адрес авторизации: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` область: `https://ai.azure.com/.default`
API-ключ	True	струна	Укажите здесь ключ API OpenAI Azure

Responses

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

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

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

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

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

Components

AudioTaskLabel

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

Недвижимость	Ценность
Описание	Определяет возможные дескрипторы для доступных ответов на звуковые операции.
Тип	струна
Значения	`transcribe` `translate`

AudioTranslationSegment

Расширенная информация о одном сегменте переведенных звуковых данных. Сегменты обычно представляют примерно 5–10 секунд речи. Границы сегментов обычно происходят между словами, но не обязательно предложениями.

Имя.	Тип	Description	Обязательно
avg_logprob	число/номер	Средняя вероятность журнала, связанная с этим сегментом звука.	Да
коэффициент сжатия	число/номер	Коэффициент сжатия этого сегмента звука.	Да
конец	число/номер	Время, в течение которого этот сегмент закончился относительно начала переведенного звука.	Да
id	целое число	0-й индекс этого сегмента в переводе.	Да
вероятность_отсутствия_речи	число/номер	Вероятность отсутствия обнаружения речи в этом сегменте звука.	Да
seek	целое число	Позиция поиска, связанная с обработкой этого сегмента звука. Позиции поиска выражаются как сотые секунды. Модель может обрабатывать несколько сегментов из одной позиции поиска, поэтому, хотя позиция поиска никогда не будет указывать на более позднее время, чем начало сегмента, начало сегмента может отражать значительно более позднее время, чем связанная с ним поисковая позиция.	Да
начало	число/номер	Время начала этого сегмента относительно начала переведенного звука.	Да
Температура	число/номер	Оценка температуры, связанная с этим сегментом звука.	Да
текст	струна	Переведенный текст, который был частью этого сегмента звука.	Да
tokens	массив	Идентификаторы маркеров, соответствующие переведенным тексту в этом сегменте звука.	Да

AzureAIFoundryModelsApiVersion

Недвижимость	Ценность
Тип	струна
Значения	`v1` `preview`

AzureAudioTranscriptionResponse

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

Имя.	Тип	Description	Обязательно
duration	число/номер	Общая длительность звука, обработанного для создания сопроводительных сведений о транскрибировании.	нет
язык	струна	Речной язык, обнаруженный в транскрибированных звуковых данных. Это выражается как двухбуквенный код языка ISO-639-1, например en или fr.	нет
segments	массив	Коллекция сведений о времени, вероятностях и других деталях каждого обработанного сегмента звука.	нет
Задача	объект	Определяет возможные дескрипторы для доступных ответов на звуковые операции.	нет
текст	струна	Транскрибированный текст для предоставленных аудиофайлов.	Да
words	массив	Коллекция сведений о времени обработки каждого обработанного слова.	нет

AzureAudioTranslationResponse

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

Имя.	Тип	Description	Обязательно
duration	число/номер	Общая длительность звука, обработанного для создания сопровождающих сведений о переводе.	нет
язык	струна	Речной язык, обнаруженный в переведенных звуковых данных. Это выражается как двухбуквенный код языка ISO-639-1, например en или fr.	нет
segments	массив	Коллекция сведений о времени, вероятностях и других деталях каждого обработанного сегмента звука.	нет
Задача	объект	Определяет возможные дескрипторы для доступных ответов на звуковые операции.	нет
текст	струна	Переведенный текст для предоставленных звуковых данных.	Да

AzureChatCompletionResponseMessage

Компонент расширенной модели ответа для сообщений ответа о завершении чата на Azure OpenAI service. Эта модель добавляет поддержку контекста сообщения чата, используемого функцией On Your Data для намерений, ссылок и других сведений, связанных с получением дополненного поколения.

Имя.	Тип	Description	Обязательно
аннотации	массив	Заметки для сообщения, если это применимо, как при использовании средства поиска в Интернете.	нет
audio	объект	Если запрашивается модальность вывода звука, этот объект содержит данные о звуковом ответе модели.	нет
└─ Данные	струна	Звуковые байты в кодировке Base64, созданные моделью, в формате, указанном в запросе.	нет
└ истекает_в	целое число	Метка времени Unix (в секундах), когда этот звуковой ответ больше не будет доступен на сервере для использования в многоэтапных беседах.	нет
Идентификатор └️	струна	Уникальный идентификатор для этого звукового ответа.	нет
└─ Расшифровка	струна	Расшифровка звука, созданного моделью.	нет
содержимое	струна	Содержимое сообщения.	Да
context	объект	Дополнительное свойство, добавленное в ответные сообщения о завершении чата, созданное Azure OpenAI service при использовании поведения расширения. Сюда входят сведения о намерении и ссылке из функции On Your Data.	нет
└─ все_извлеченные_документы	объект	Сводная информация о документах, полученных операцией извлечения данных.	нет
└chunk_id	струна	Идентификатор блока для ссылки.	нет
└─ Содержимое	струна	Содержимое ссылки.	нет
└ data_source_index	целое число	Индекс источника данных, используемый для извлечения.	нет
└─ путь к файлу	струна	Путь к файлу для цитирования.	нет
└️ причина_фильтрации	перечисление	Если применимо, указывает на то, почему документ был отфильтрован. Возможные значения: `score`, `rerank`	нет
└─ оригинальный_оценочный_балл_поиска	число/номер	Исходная оценка релевантности для поиска.	нет
└─ пересчет_оценки	число/номер	Оценка повторного извлечения.	нет
└─ поисковые_запросы	массив	Поисковые запросы, выполняемые для получения документов.	нет
Заголовок	струна	Заголовок ссылки.	нет
└─ URL	струна	URL-адрес ссылки.	нет
Цитаты	массив	Ссылки, созданные извлечением данных.	нет
└─ намерение	струна	Детектированное намерение из истории чата, которое используется для сохранения контекста беседы между взаимодействиями	нет
вызов_функции	объект	Устаревшие и замененные `tool_calls`. Имя и аргументы вызываемой функции, созданной моделью.	нет
└─ аргументы	струна		нет
└️ имя	струна		нет
reasoning_content	струна	Свойство расширения Azure, содержащее созданное содержимое причин из поддерживаемых моделей.	нет
отказ	струна	Сообщение об отказе, созданное моделью.	Да
роль	перечисление	Роль автора этого сообщения. Возможные значения: `assistant`	Да
вызовы инструментов	ChatCompletionMessageToolCallsItem	Вызовы средства, созданные моделью, например вызовы функций.	нет

AzureChatCompletionStreamResponseDelta

Модель расширенного ответа для ответа потокового чата в Azure OpenAI service. Эта модель добавляет поддержку контекста сообщения чата, используемого функцией On Your Data для намерений, ссылок и других сведений, связанных с получением дополненного поколения.

Имя.	Тип	Description	Обязательно
audio	объект		нет
└─ Данные	струна		нет
└ истекает_в	целое число		нет
Идентификатор └️	струна		нет
└─ Расшифровка	струна		нет
содержимое	струна	Содержимое сообщения блока.	нет
context	объект	Дополнительное свойство, добавленное в ответные сообщения о завершении чата, созданное Azure OpenAI service при использовании поведения расширения. Сюда входят сведения о намерении и ссылке из функции On Your Data.	нет
└─ все_извлеченные_документы	объект	Сводная информация о документах, полученных операцией извлечения данных.	нет
└chunk_id	струна	Идентификатор блока для ссылки.	нет
└─ Содержимое	струна	Содержимое ссылки.	нет
└ data_source_index	целое число	Индекс источника данных, используемый для извлечения.	нет
└─ путь к файлу	струна	Путь к файлу для цитирования.	нет
└️ причина_фильтрации	перечисление	Если применимо, указывает на то, почему документ был отфильтрован. Возможные значения: `score`, `rerank`	нет
└─ оригинальный_оценочный_балл_поиска	число/номер	Исходная оценка релевантности для поиска.	нет
└─ пересчет_оценки	число/номер	Оценка повторного извлечения.	нет
└─ поисковые_запросы	массив	Поисковые запросы, выполняемые для получения документов.	нет
Заголовок	струна	Заголовок ссылки.	нет
└─ URL	струна	URL-адрес ссылки.	нет
Цитаты	массив	Ссылки, созданные извлечением данных.	нет
└─ намерение	струна	Детектированное намерение из истории чата, которое используется для сохранения контекста беседы между взаимодействиями	нет
вызов_функции	объект	Устаревшие и замененные `tool_calls`. Имя и аргументы вызываемой функции, созданной моделью.	нет
└─ аргументы	струна		нет
└️ имя	струна		нет
reasoning_content	струна	Свойство расширения Azure, содержащее созданное содержимое причин из поддерживаемых моделей.	нет
отказ	струна	Сообщение об отказе, созданное моделью.	нет
роль	объект	Роль автора сообщения	нет
вызовы инструментов	массив		нет

AzureChatDataSource

Представление данных конфигурации для одного источника данных чата OpenAI Azure. Это будет использоваться запросом завершения чата, который должен использовать Azure расширения чата OpenAI для расширения поведения ответа. Использование этой конфигурации совместимо только с Azure OpenAI.

Дискриминатор для AzureChatDataSource

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

Значение типа	Схема
`azure_search`	AzureSearchChatDataSource
`azure_cosmos_db`	AzureCosmosDBChatDataSource
`elasticsearch`	ElasticsearchChatDataSource
`pinecone`	PineconeChatDataSource
`mongo_db`	MongoDBChatDataSource

Имя.	Тип	Description	Обязательно	По умолчанию
type	объект		Да

AzureChatDataSourceAccessTokenAuthenticationOptions

Имя.	Тип	Description	Обязательно	По умолчанию
access_token	струна		Да
type	перечисление	Возможные значения: `access_token`	Да

AzureChatDataSourceApiKeyAuthenticationOptions

Имя.	Тип	Description	Обязательно	По умолчанию
ключ	струна		Да
type	перечисление	Возможные значения: `api_key`	Да

AzureChatDataSourceAuthenticationOptions

Дискриминатор для AzureChatDataSourceAuthenticationOptions

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

Значение типа	Схема
`system_assigned_managed_identity`	AzureChatDataSourceSystemAssignedManagedIdentityAuthenticationOptions
`user_assigned_managed_identity`	AzureChatDataSourceUserAssignedManagedIdentityAuthenticationOptions
`access_token`	AzureChatDataSourceAccessTokenAuthenticationOptions
`connection_string`	AzureChatDataSourceConnectionStringAuthenticationOptions
`key_and_key_id`	AzureChatDataSourceKeyAndKeyIdAuthenticationOptions
`encoded_api_key`	AzureChatDataSourceEncodedApiKeyAuthenticationOptions
`username_and_password`	AzureChatDataSourceUsernameAndPasswordAuthenticationOptions

Имя.	Тип	Description	Обязательно	По умолчанию
type	AzureChatDataSourceAuthenticationOptionsType		Да

AzureChatDataSourceAuthenticationOptionsType

Недвижимость	Ценность
Тип	струна
Значения	`api_key` `username_and_password` `connection_string` `key_and_key_id` `encoded_api_key` `access_token` `system_assigned_managed_identity` `user_assigned_managed_identity`

AzureChatDataSourceConnectionStringAuthenticationOptions

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

AzureChatDataSourceDeploymentNameVectorizationSource

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

Имя.	Тип	Description	Обязательно
имя_развертывания	струна	Модель встраивания, используемая для векторизации. Это развертывание должно существовать в том же Azure ресурсе OpenAI, что и развертывание модели, используемое для завершения чата.	Да
dimensions	целое число	Количество измерений, запрашиваемых для эмбеддингов. Поддерживается только в моделях text-embedding-3 и более поздних версий.	нет
type	перечисление	Идентификатор типа, всегда «deployment_name» для этого источника данных векторизации. Возможные значения: `deployment_name`	Да

AzureChatDataSourceEncodedApiKeyAuthenticationOptions

Имя.	Тип	Description	Обязательно	По умолчанию
encoded_api_key	струна		Да
type	перечисление	Возможные значения: `encoded_api_key`	Да

AzureChatDataSourceEndpointVectorizationSource

Представляет источник векторизации, который вызывает вызовы общедоступной службы к развертыванию модели внедрения openAI Azure.

Имя.	Тип	Description	Обязательно
аутентификация	объект		Да
└─access_token	струна		нет
└─ Ключ	струна		нет
└─ Тип	перечисление	Возможные значения: `access_token`	нет
dimensions	целое число	Количество измерений, запрашиваемых для эмбеддингов. Поддерживается только в моделях text-embedding-3 и более поздних версий.	нет
endpoint	струна	Указывает URL-адрес конечной точки ресурса, из которого должны быть получены внедренные модули. Он должен быть в формате: https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings. Параметр запроса версии API не разрешен.	Да
type	перечисление	Идентификатор типа всегда "endpoint" для этого типа источника векторизации. Возможные значения: `endpoint`	Да

AzureChatDataSourceIntegratedVectorizationSource

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

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

AzureChatDataSourceKeyAndKeyIdAuthenticationOptions

Имя.	Тип	Description	Обязательно
ключ	струна		Да
key_id	струна		Да
type	перечисление	Возможные значения: `key_and_key_id`	Да

AzureChatDataSourceModelIdVectorizationSource

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

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

AzureChatDataSourceSystemAssignedManagedIdentityAuthenticationOptions

Имя.	Тип	Description	Обязательно	По умолчанию
type	перечисление	Возможные значения: `system_assigned_managed_identity`	Да

AzureChatDataSourceType

Недвижимость	Ценность
Тип	струна
Значения	`azure_search` `azure_cosmos_db` `elasticsearch` `pinecone` `mongo_db`

AzureChatDataSourceUserAssignedManagedIdentityAuthenticationOptions

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

AzureChatDataSourceUsernameAndPasswordAuthenticationOptions

Имя.	Тип	Description	Обязательно
пароль	струна		Да
type	перечисление	Возможные значения: `username_and_password`	Да
username	струна		Да

AzureChatDataSourceVectorizationSource

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

Дискриминатор для AzureChatDataSourceVectorizationSource

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

Значение типа	Схема
`deployment_name`	AzureChatDataSourceDeploymentNameVectorizationSource
`integrated`	AzureChatDataSourceIntegratedVectorizationSource
`model_id`	AzureChatDataSourceModelIdVectorizationSource

Имя.	Тип	Description	Обязательно	По умолчанию
type	объект		Да

AzureChatDataSourceVectorizationSourceType

Недвижимость	Ценность
Тип	струна
Значения	`endpoint` `deployment_name` `model_id` `integrated`

AzureChatMessageContext

Дополнительное свойство, добавленное в ответные сообщения о завершении чата, созданное Azure OpenAI service при использовании поведения расширения. Сюда входят сведения о намерении и ссылке из функции On Your Data.

Имя.	Тип	Description	Обязательно
all_retrieved_documents	объект	Сводная информация о документах, полученных операцией извлечения данных.	нет
└chunk_id	струна	Идентификатор блока для ссылки.	нет
└─ Содержимое	струна	Содержимое ссылки.	нет
└ data_source_index	целое число	Индекс источника данных, используемый для извлечения.	нет
└─ путь к файлу	струна	Путь к файлу для цитирования.	нет
└️ причина_фильтрации	перечисление	Если применимо, указывает на то, почему документ был отфильтрован. Возможные значения: `score`, `rerank`	нет
└─ оригинальный_оценочный_балл_поиска	число/номер	Исходная оценка релевантности для поиска.	нет
└─ пересчет_оценки	число/номер	Оценка повторного извлечения.	нет
└─ поисковые_запросы	массив	Поисковые запросы, выполняемые для получения документов.	нет
Заголовок	струна	Заголовок ссылки.	нет
└─ URL	струна	URL-адрес ссылки.	нет
citations	массив	Ссылки, созданные извлечением данных.	нет
намерение	струна	Детектированное намерение из истории чата, которое используется для сохранения контекста беседы между взаимодействиями	нет

AzureContentFilterBlocklistResult

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

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

AzureContentFilterCompletionTextSpan

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

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

AzureContentFilterCompletionTextSpanDetectionResult

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

AzureContentFilterCustomTopicResult

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

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

AzureContentFilterDetectionResult

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

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

AzureContentFilterImagePromptResults

Результат фильтра содержимого для содержимого входного запроса операции создания изображения.

Имя.	Тип	Description	Обязательно
custom_blocklists	объект	Коллекция результатов фильтрации true/false для настроенных настраиваемых списков блокировок.	нет
└️ подробности	массив	Пары отдельных идентификаторов черных списков и привели ли они к действию фильтрации.	нет
└️ отфильтрован	булевый	Значение, указывающее, приводит ли любой из подробных списков блокировок к действию фильтрации.	нет
custom_topics	объект	Коллекция результатов фильтрации true/false для настроенных пользовательских разделов.	нет
└️ подробности	массив	Пары идентификаторов отдельных разделов и их обнаружение.	нет
└️ отфильтрован	булевый	Значение, указывающее, приводит ли любой из подробных разделов к действию фильтрации.	нет
jailbreak	объект	Элемент результата фильтра содержимого с метками, указывающий, был ли обнаружен контент и был ли отфильтрован содержимое.	Да
└─ Обнаружено	булевый	Обнаружена ли в содержимом категория отмеченного контента.	нет
└️ отфильтрован	булевый	Приведет ли обнаружение содержимого к действию фильтрации содержимого.	нет
profanity	объект	Элемент результата фильтра содержимого с метками, указывающий, был ли обнаружен контент и был ли отфильтрован содержимое.	нет
└─ Обнаружено	булевый	Обнаружена ли в содержимом категория отмеченного контента.	нет
└️ отфильтрован	булевый	Приведет ли обнаружение содержимого к действию фильтрации содержимого.	нет

AzureContentFilterImageResponseResults

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

Имя.	Тип	Description	Обязательно
hate	объект	Элемент результата фильтра содержимого с метками, указывающий, был ли отфильтрован контент и какой уровень серьезности содержимого был оценен по конфигурации фильтра содержимого для категории.	нет
└️ отфильтрован	булевый	Является ли серьезность содержимого результатом действия фильтрации содержимого.	нет
└─ серьезность	перечисление	Заданный уровень серьезности содержимого. Возможные значения: `safe`, , `lowmediumhigh`	нет
самоповреждение	объект	Элемент результата фильтра содержимого с метками, указывающий, был ли отфильтрован контент и какой уровень серьезности содержимого был оценен по конфигурации фильтра содержимого для категории.	нет
└️ отфильтрован	булевый	Является ли серьезность содержимого результатом действия фильтрации содержимого.	нет
└─ серьезность	перечисление	Заданный уровень серьезности содержимого. Возможные значения: `safe`, , `lowmediumhigh`	нет
sexual	объект	Элемент результата фильтра содержимого с метками, указывающий, был ли отфильтрован контент и какой уровень серьезности содержимого был оценен по конфигурации фильтра содержимого для категории.	нет
└️ отфильтрован	булевый	Является ли серьезность содержимого результатом действия фильтрации содержимого.	нет
└─ серьезность	перечисление	Заданный уровень серьезности содержимого. Возможные значения: `safe`, , `lowmediumhigh`	нет
violence	объект	Элемент результата фильтра содержимого с метками, указывающий, был ли отфильтрован контент и какой уровень серьезности содержимого был оценен по конфигурации фильтра содержимого для категории.	нет
└️ отфильтрован	булевый	Является ли серьезность содержимого результатом действия фильтрации содержимого.	нет
└─ серьезность	перечисление	Заданный уровень серьезности содержимого. Возможные значения: `safe`, , `lowmediumhigh`	нет

AzureContentFilterResultForChoice

Результат фильтра содержимого для одного элемента ответа, созданного системой создания искусственного интеллекта.

Имя.	Тип	Description	Обязательно
custom_blocklists	объект	Коллекция результатов фильтрации true/false для настроенных настраиваемых списков блокировок.	нет
└️ подробности	массив	Пары отдельных идентификаторов черных списков и привели ли они к действию фильтрации.	нет
└️ отфильтрован	булевый	Значение, указывающее, приводит ли любой из подробных списков блокировок к действию фильтрации.	нет
custom_topics	объект	Коллекция результатов фильтрации true/false для настроенных пользовательских разделов.	нет
└️ подробности	массив	Пары идентификаторов отдельных разделов и их обнаружение.	нет
└️ отфильтрован	булевый	Значение, указывающее, приводит ли любой из подробных разделов к действию фильтрации.	нет
ошибка	объект	Если имеются, подробные сведения об ошибке, которая помешала завершить оценку фильтрации содержимого.	нет
└─ Код	целое число	Отдельный удобочитаемый компьютером код, связанный с ошибкой.	нет
Сообщение └️	струна	Сообщение, доступное для чтения человеком, связанное с ошибкой.	нет
hate	объект	Элемент результата фильтра содержимого с метками, указывающий, был ли отфильтрован контент и какой уровень серьезности содержимого был оценен по конфигурации фильтра содержимого для категории.	нет
└️ отфильтрован	булевый	Является ли серьезность содержимого результатом действия фильтрации содержимого.	нет
└─ серьезность	перечисление	Заданный уровень серьезности содержимого. Возможные значения: `safe`, , `lowmediumhigh`	нет
profanity	объект	Элемент результата фильтра содержимого с метками, указывающий, был ли обнаружен контент и был ли отфильтрован содержимое.	нет
└─ Обнаружено	булевый	Обнаружена ли в содержимом категория отмеченного контента.	нет
└️ отфильтрован	булевый	Приведет ли обнаружение содержимого к действию фильтрации содержимого.	нет
код_защищённого_материала	объект	Результат обнаружения, описывающий совпадение с лицензированным кодом или другим защищенным исходным материалом.	нет
└─ цитирование	объект	Если возможно, детали цитирования, описывающие связанную лицензию и место их расположения.	нет
URL-адрес	струна	URL-адрес, связанный с лицензией.	нет
Лицензия	струна	Имя или идентификатор лицензии, связанной с обнаружением.	нет
└─ Обнаружено	булевый	Обнаружена ли в содержимом категория отмеченного контента.	нет
└️ отфильтрован	булевый	Приведет ли обнаружение содержимого к действию фильтрации содержимого.	нет
защищённый_текст_материала	объект	Элемент результата фильтра содержимого с метками, указывающий, был ли обнаружен контент и был ли отфильтрован содержимое.	нет
└─ Обнаружено	булевый	Обнаружена ли в содержимом категория отмеченного контента.	нет
└️ отфильтрован	булевый	Приведет ли обнаружение содержимого к действию фильтрации содержимого.	нет
самоповреждение	объект	Элемент результата фильтра содержимого с метками, указывающий, был ли отфильтрован контент и какой уровень серьезности содержимого был оценен по конфигурации фильтра содержимого для категории.	нет
└️ отфильтрован	булевый	Является ли серьезность содержимого результатом действия фильтрации содержимого.	нет
└─ серьезность	перечисление	Заданный уровень серьезности содержимого. Возможные значения: `safe`, , `lowmediumhigh`	нет
sexual	объект	Элемент результата фильтра содержимого с метками, указывающий, был ли отфильтрован контент и какой уровень серьезности содержимого был оценен по конфигурации фильтра содержимого для категории.	нет
└️ отфильтрован	булевый	Является ли серьезность содержимого результатом действия фильтрации содержимого.	нет
└─ серьезность	перечисление	Заданный уровень серьезности содержимого. Возможные значения: `safe`, , `lowmediumhigh`	нет
ungrounded_material	AzureContentFilterCompletionTextSpanDetectionResult		нет
violence	объект	Элемент результата фильтра содержимого с метками, указывающий, был ли отфильтрован контент и какой уровень серьезности содержимого был оценен по конфигурации фильтра содержимого для категории.	нет
└️ отфильтрован	булевый	Является ли серьезность содержимого результатом действия фильтрации содержимого.	нет
└─ серьезность	перечисление	Заданный уровень серьезности содержимого. Возможные значения: `safe`, , `lowmediumhigh`	нет

AzureContentFilterResultForPrompt

Результат фильтрации содержимого, связанный с одним элементом входного запроса в генеративную систему ИИ.

Имя.	Тип	Description	Обязательно
результаты фильтрации контента	объект	Сведения о категории фильтрации содержимого для результата.	нет
└─ настраиваемые черные списки	объект	Коллекция результатов фильтрации true/false для настроенных настраиваемых списков блокировок.	нет
└️ подробности	массив	Пары отдельных идентификаторов черных списков и привели ли они к действию фильтрации.	нет
└️ отфильтрован	булевый	Значение, указывающее, приводит ли любой из подробных списков блокировок к действию фильтрации.	нет
└custom_topics	объект	Коллекция результатов фильтрации true/false для настроенных пользовательских разделов.	нет
└️ подробности	массив	Пары идентификаторов отдельных разделов и их обнаружение.	нет
└️ отфильтрован	булевый	Значение, указывающее, приводит ли любой из подробных разделов к действию фильтрации.	нет
└─ Ошибка	объект	Если имеются, подробные сведения об ошибке, которая помешала завершить оценку фильтрации содержимого.	нет
└─ Код	целое число	Отдельный удобочитаемый компьютером код, связанный с ошибкой.	нет
Сообщение └️	струна	Сообщение, доступное для чтения человеком, связанное с ошибкой.	нет
└️ ненависть	объект	Элемент результата фильтра содержимого с метками, указывающий, был ли отфильтрован контент и какой уровень серьезности содержимого был оценен по конфигурации фильтра содержимого для категории.	нет
└️ отфильтрован	булевый	Является ли серьезность содержимого результатом действия фильтрации содержимого.	нет
└─ серьезность	перечисление	Заданный уровень серьезности содержимого. Возможные значения: `safe`, , `lowmediumhigh`	нет
└─ косвенная_атака	объект	Элемент результата фильтра содержимого с метками, указывающий, был ли обнаружен контент и был ли отфильтрован содержимое.	нет
└─ Обнаружено	булевый	Обнаружена ли в содержимом категория отмеченного контента.	нет
└️ отфильтрован	булевый	Приведет ли обнаружение содержимого к действию фильтрации содержимого.	нет
└️ джейл-брейк	объект	Элемент результата фильтра содержимого с метками, указывающий, был ли обнаружен контент и был ли отфильтрован содержимое.	нет
└─ Обнаружено	булевый	Обнаружена ли в содержимом категория отмеченного контента.	нет
└️ отфильтрован	булевый	Приведет ли обнаружение содержимого к действию фильтрации содержимого.	нет
└️ ненормативная лексика	объект	Элемент результата фильтра содержимого с метками, указывающий, был ли обнаружен контент и был ли отфильтрован содержимое.	нет
└─ Обнаружено	булевый	Обнаружена ли в содержимом категория отмеченного контента.	нет
└️ отфильтрован	булевый	Приведет ли обнаружение содержимого к действию фильтрации содержимого.	нет
└─ членовредительство	объект	Элемент результата фильтра содержимого с метками, указывающий, был ли отфильтрован контент и какой уровень серьезности содержимого был оценен по конфигурации фильтра содержимого для категории.	нет
└️ отфильтрован	булевый	Является ли серьезность содержимого результатом действия фильтрации содержимого.	нет
└─ серьезность	перечисление	Заданный уровень серьезности содержимого. Возможные значения: `safe`, , `lowmediumhigh`	нет
└️ сексуальный	объект	Элемент результата фильтра содержимого с метками, указывающий, был ли отфильтрован контент и какой уровень серьезности содержимого был оценен по конфигурации фильтра содержимого для категории.	нет
└️ отфильтрован	булевый	Является ли серьезность содержимого результатом действия фильтрации содержимого.	нет
└─ серьезность	перечисление	Заданный уровень серьезности содержимого. Возможные значения: `safe`, , `lowmediumhigh`	нет
└️ насилие	объект	Элемент результата фильтра содержимого с метками, указывающий, был ли отфильтрован контент и какой уровень серьезности содержимого был оценен по конфигурации фильтра содержимого для категории.	нет
└️ отфильтрован	булевый	Является ли серьезность содержимого результатом действия фильтрации содержимого.	нет
└─ серьезность	перечисление	Заданный уровень серьезности содержимого. Возможные значения: `safe`, , `lowmediumhigh`	нет
индекс_подсказки	целое число	Индекс входного запроса, связанного с сопутствующими категориями результатов фильтра содержимого.	нет

AzureContentFilterSeverityResult

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

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

AzureCosmosDBChatDataSource

Представляет конфигурацию источника данных, которая будет использовать ресурс Azure CosmosDB.

Имя.	Тип	Description	Обязательно	По умолчанию
параметры	объект	Сведения о параметрах для управления использованием источника данных Azure CosmosDB.	Да
└️ allow_partial_result	булевый	Если установлено значение true, система позволит использовать частичные результаты поиска, и запрос будет считаться неуспешным, если все частичные запросы окажутся неудачными. Если запрос не указан или указан как false, запрос завершится ошибкой, если любой поисковый запрос завершается ошибкой.	нет	Неправда
└─ проверка подлинности	AzureChatDataSourceConnectionStringAuthenticationOptions		нет
└️ container_name	струна		нет
└ «database_name»	струна		нет
└─ встраивание_зависимости	AzureChatDataSourceVectorizationSource	Представление источника векторизации данных, который можно использовать как ресурс внедрения с источником данных.	нет
└─ сопоставление_полей	объект		нет
└─ поля_контента	массив		нет
└─content_fields_separator	струна		нет
└filepath_field	струна		нет
└─ название_поля	струна		нет
└─ поле_ссылки	струна		нет
└─ векторные_поля	массив		нет
└in_scope	булевый	Следует ли ограничить запросы использованием индексированных данных.	нет
└─ включить_контексты	массив	Свойства контекста выходных данных, которые необходимо включить в ответ. По умолчанию запрашивается ссылка и намерение.	нет	['цитаты', 'намерение']
└– index_name	струна		нет
└max_search_queries	целое число	Максимальное количество перезаписанных запросов, которые должны отправляться поставщику поиска для одного сообщения пользователя. По умолчанию система сделает автоматическое определение.	нет
└️ строгость	целое число	Настроенная строгость фильтрации релевантности поиска. Более строгие критерии увеличат точность, но снизят полноту ответа.	нет
└top_n_documents	целое число	Настроено количество документов, которые нужно выделить в запросе.	нет
type	перечисление	Идентификатор различаемого типа, который всегда равен azure_cosmos_db. Возможные значения: `azure_cosmos_db`	Да

AzureCreateChatCompletionRequest

Модель расширенного запроса для завершения чата в Azure OpenAI service. Это добавляет возможность предоставлять источники данных для функции On Your Data.

Имя.	Тип	Description	Обязательно	По умолчанию
audio	объект	Параметры выходных данных звука. Требуется при запросе на вывод звука с `modalities: ["audio"]`.	нет
└─ Формат	перечисление	Указывает выходной формат звука. Должен быть одним из `wav`, `mp3`, `flac`, `opus` или `pcm16`. Возможные значения: `wav`, `aac`, `mp3`, `flac`, `opus`, `pcm16`	нет
└️ голос	объект		нет
источники данных	массив	Источники данных, используемые для функции On Your Data, эксклюзивные для Azure OpenAI.	нет
штраф за частоту	число/номер	Число от -2.0 до 2.0. Положительные значения наказывают новые маркеры на основе их существующей частоты в тексте до сих пор, уменьшая вероятность повторения модели той же строки дословно.	нет	0
вызов_функции	перечисление	Указание определенной функции путем `{"name": "my_function"}` принудительного вызова этой функции моделью. Возможные значения: `none`, `auto`	нет
functions	массив	Не рекомендуется использовать в пользу `tools`. Список функций, для которые модель может создавать входные данные JSON.	нет
логит_биас	объект	Изменяет вероятность появления указанных маркеров в завершении. Принимает объект JSON, который сопоставляет маркеры (указанные идентификатором маркера в токенизаторе) со связанным значением предвзятости от -100 до 100. С математической точки зрения смещение добавляется к логитам, созданным моделью до выборки. Точный эффект зависит от модели, но значения от –1 до 1 должны уменьшать или увеличивать вероятность выбора; такие значения, как –100 или 100, должны приводить к запрету или эксклюзивному выбору соответствующего маркера.	нет	None
logprobs	булевый	Следует ли возвращать вероятности журналов выходных маркеров или нет. Если значение true, возвращает вероятности журнала каждого выходного маркера, возвращаемого в параметре `contentmessage`.	нет	Неправда
max_completion_tokens (максимальное количество токенов завершения)	целое число	Верхняя граница для числа маркеров, которые можно создать для завершения, включая видимые выходные маркеры и маркеры причин.	нет
макс_токены	целое число	Максимальное количество маркеров, которые можно создать в завершении чата. Это значение можно использовать для управления затратами на текст, созданный с помощью API. Это значение теперь устарело, а предпочитается `max_completion_tokens`, и несовместимо с моделями серии o1.	нет
messages	массив	Список сообщений, составляющих беседу до сих пор. В зависимости от используемой модели поддерживаются различные типы сообщений (модальности), такие как текст, изображения и звук.	Да
metadata	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате и запроса на объекты через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — это строки с максимальной длиной 512 символов.	нет
Условия	объект	Типы выходных данных, которые вы хотите, чтобы модель генерировала. Большинство моделей могут создавать текст, который по умолчанию: `["text"]` Модель `gpt-4o-audio-preview` также может использоваться для создания звука. Чтобы запросить, что эта модель создает как текстовые, так и звуковые ответы, можно использовать: `["text", "audio"]`	нет
модель	струна	Идентификатор развертывания модели, используемый для запроса завершения чата.	Да
н	целое число	Сколько вариантов завершения чата для каждого входного сообщения. Обратите внимание, что плата будет взиматься на основе количества созданных маркеров во всех вариантах. Имейте в виду `n` , чтобы `1` свести к минимуму затраты.	нет	1
вызовы инструмента в параллельном режиме	объект	Следует ли включить параллельные вызовы функций во время использования средства.	нет
prediction	объект	Базовое представление прогнозируемых выходных данных модели.	нет
└─ Тип	OpenAI.ChatOutputPredictionType		нет
штраф за присутствие	число/номер	Число от -2.0 до 2.0. Положительные значения наказывают новые маркеры в зависимости от того, появляются ли они в тексте до сих пор, что повышает вероятность того, что модель будет говорить о новых темах.	нет	0
усилия на рассуждение	объект	Только модели o-серии Ограничивает усилия по рассуждениям моделей. В настоящее время поддерживаются `low`значения , `medium`и `high`. Сокращение усилий по поводу может привести к более быстрым откликам и меньшем количестве маркеров, используемых при рассуждениях в ответе.	нет
формат_ответа	объект		нет
└─ Тип	перечисление	Возможные значения: `text`, `json_objectjson_schema`	нет
seed	целое число	Эта функция доступна в бета-версии. Если задано, наша система будет предпринять лучшие усилия для выборки детерминированного, таким образом, что повторяющиеся запросы с одинаковыми и теми же параметрами должны возвращать тот же `seed` результат. Детерминированность не гарантируется, и вы должны ссылаться на `system_fingerprint` параметр ответа для отслеживания изменений в серверной части.	нет
stop	объект	Не поддерживается с последними моделями рассуждений `o3` и `o4-mini`. До 4 последовательностей, в которых API перестанет создавать дополнительные маркеры. Возвращенный текст не будет содержать последовательность остановки.	нет
store	булевый	Независимо от того, следует ли хранить результаты этого запроса на завершение чата для использования в дистилляции модели или продуктах оценки.	нет	Неправда
поток	булевый	Если задано значение true, данные ответа модели будут передаваться клиенту по мере его создания с помощью событий, отправляемых сервером.	нет	Неправда
stream_options	объект	Параметры потокового ответа. Этот параметр устанавливается только при установке `stream: true`.	нет
└️ include_usage	булевый	Если задано, перед сообщением будет передаваться `data: [DONE]` дополнительный блок. Поле `usage` на этом блоке отображает статистику использования маркеров для всего запроса, и `choices` поле всегда будет пустым массивом. Все остальные блоки также будут содержать `usage` поле, но со значением NULL. ЗАМЕТКА: Если поток прерван, вы можете не получить последний блок данных об использовании, содержащий общие данные о количестве использованных токенов для запроса.	нет
Температура	число/номер	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным. Как правило, мы рекомендуем изменить это или `top_p` не оба.	нет	1
выбор инструмента	OpenAI.ChatCompletionToolChoiceOption	Определяет, какое средство (если таковое) вызывается моделью. `none` означает, что модель не будет вызывать какое-либо средство и вместо этого создает сообщение. `auto` означает, что модель может выбирать между созданием сообщения или вызовом одного или нескольких инструментов. `required` означает, что модель должна вызывать один или несколько инструментов. Указание определенного средства с помощью `{"type": "function", "function": {"name": "my_function"}}` принудительного вызова этого средства моделью. `none` значение по умолчанию, если средства отсутствуют. `auto` значение по умолчанию, если существуют средства.	нет
инструменты	массив	Список инструментов, которые может вызывать модель. В настоящее время в качестве инструмента поддерживаются только функции. Используйте это для предоставления списка функций, для которые модель может создавать входные данные JSON. Поддерживаются не более 128 функций.	нет
top_logprobs	целое число	Целое число от 0 до 20, указывающее число наиболее вероятных маркеров, возвращаемых по каждой позиции маркера, каждый из которых имеет связанную вероятность журнала.	нет
top_p	число/номер	Альтернативой выборке с температурой является так называемая выборка ядра, где модель рассматривает результаты маркеров с top_p всего массива значений вероятности. Таким образом, 0,1 означает, что учитываются только маркеры, входящие в верхние 10% массива значений вероятности. Как правило, мы рекомендуем изменить это или `temperature` не оба.	нет	1
Пользователь	струна	Уникальный идентификатор, представляющий конечного пользователя, который может помочь в мониторинге и обнаружении злоупотреблений.	нет
user_security_context	AzureUserSecurityContext	Контекст безопасности пользователя содержит несколько параметров, описывающих само приложение, и конечный пользователь, взаимодействующий с приложением. Эти поля помогают группам по операциям безопасности исследовать и устранять инциденты безопасности, предоставляя комплексный подход к защите приложений ИИ. Learn more о защите приложений ИИ с помощью Microsoft Defender for Cloud.	нет

AzureCreateChatCompletionResponse

Расширенная модель ответа на завершение чата верхнего уровня для Azure OpenAI service. Эта модель добавляет аннотации на основе фильтрации содержимого для ответственного использования ИИ при вводе запросов.

Имя.	Тип	Description	Обязательно
choices	массив		Да
создано	целое число	Метка времени Unix (в секундах) при создании завершения чата.	Да
id	струна	Уникальный идентификатор завершения чата.	Да
модель	струна	Модель, используемая для завершения чата.	Да
объект	перечисление	Тип объекта, который всегда `chat.completion`является . Возможные значения: `chat.completion`	Да
результаты_фильтрации_запросов	массив	Заметки фильтра содержимого ответственного искусственного интеллекта, связанные с вводом запроса в завершения чата.	нет
системный отпечаток	струна	Этот отпечаток представляет конфигурацию серверной части, с которой работает модель. Можно использовать в сочетании с параметром `seed` запроса, чтобы понять, когда внутренние изменения были внесены, что может повлиять на детерминированность.	нет
использование	OpenAI.CompletionUsage	Статистика использования для запроса завершения.	нет

AzureCreateChatCompletionStreamResponse

Имя.	Тип	Description	Обязательно	По умолчанию
choices	массив	Список вариантов завершения чата. Может содержать несколько элементов, если `n` больше 1. Может также быть пустым для последнего блока, если вы установите `stream_options: {"include_usage": true}`.	Да
результаты фильтрации контента	AzureContentFilterResultForChoice	Результат фильтра содержимого для одного элемента ответа, созданного системой создания искусственного интеллекта.	нет
создано	целое число	Метка времени Unix (в секундах) при создании завершения чата. Каждый блок имеет одинаковую метку времени.	Да
delta	AzureChatCompletionStreamResponseDelta	Модель расширенного ответа для ответа потокового чата в Azure OpenAI service. Эта модель добавляет поддержку контекста сообщения чата, используемого функцией On Your Data для намерений, ссылок и других сведений, связанных с получением дополненного поколения.	нет
id	струна	Уникальный идентификатор завершения чата. Каждый блок имеет один и тот же идентификатор.	Да
модель	струна	Модель для создания завершения.	Да
объект	перечисление	Тип объекта, который всегда `chat.completion.chunk`является . Возможные значения: `chat.completion.chunk`	Да
системный отпечаток	струна	Этот отпечаток представляет конфигурацию серверной части, с которой работает модель. Можно использовать в сочетании с параметром `seed` запроса, чтобы понять, когда внутренние изменения были внесены, что может повлиять на детерминированность.	нет
использование	объект	Статистика использования для запроса завершения.	нет
└─ токены завершения	целое число	Количество маркеров в созданном завершении.	нет	0
└completion_tokens_details	объект	Разбивка маркеров, используемых в завершении.	нет
└️ accepted_prediction_tokens	целое число	При использовании прогнозируемых выходных данных число маркеров в прогнозе, появившемся в завершении.	нет	0
└audio_tokens	целое число	Маркеры ввода звука, созданные моделью.	нет	0
└️ reasoning_tokens	целое число	Маркеры, созданные моделью для рассуждений.	нет	0
└─ отклонённые_токены_предсказания	целое число	При использовании прогнозируемых выходных данных число маркеров в прогнозе, которое не отображалось в завершении. Однако, как и маркеры причин, эти маркеры по-прежнему учитываются в общих маркерах завершения для целей выставления счетов, выходных данных и контекстного окна.	нет	0
└─ токены_запроса	целое число	Количество маркеров в запросе.	нет	0
└ prompt_tokens_details	объект	Разбивка токенов, используемых в запросе.	нет
└audio_tokens	целое число	Маркеры ввода звука, представленные в запросе.	нет	0
└ cached_tokens	целое число	Кэшированные маркеры присутствуют в запросе.	нет	0
└️ всего_токенов	целое число	Общее количество маркеров, используемых в запросе (запрос + завершение).	нет	0

AzureCreateEmbeddingRequest

Имя.	Тип	Description	Обязательно
dimensions	целое число	Число измерений, в которых должны быть внедренные выходные данные. Поддерживается только в `text-embedding-3` и более поздних моделях.	нет
формат_кодирования	перечисление	Формат, в который возвращаются встраиваемые элементы. Может быть либо `float`, либо `base64`. Возможные значения: `float`, `base64`	нет
ввод	строка или массив		Да
модель	струна	Модель, используемая для запроса внедрения.	Да
Пользователь	струна	Уникальный идентификатор, представляющий пользователя, который может помочь OpenAI отслеживать и обнаруживать злоупотребления.	нет

AzureCreateFileRequestMultiPart

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

AzureCreateImageEditRequestMultiPart

Имя.	Тип	Description	Обязательно	По умолчанию
фон	перечисление	Позволяет задать прозрачность фона созданных образов. Этот параметр поддерживается только для `gpt-image-1`моделей серии. Должно быть одним из значений `transparentopaque` или `auto` (значение по умолчанию). При `auto` использовании модель автоматически определяет лучший фон для изображения. Если `transparent`выходной формат должен поддерживать прозрачность, поэтому он должен иметь значение `png` (значение по умолчанию) или `webp`. Возможные значения: `transparent`, `opaqueauto`	нет
image	строка или массив		Да
mask	струна		нет
модель	струна	Развертывание модели для использования в операции по редактированию изображения.	Да
н	целое число	Количество генерируемых изображений. Должно быть от 1 до 10.	нет	1
сжатие вывода	целое число	Уровень сжатия (0–100%) для созданных образов. Этот параметр поддерживается только для `gpt-image-1`-серий моделей с `webp` или `jpeg` выходными форматами, и по умолчанию, 100.	нет	100
формат_выходных_данных	перечисление	Формат, в котором возвращаются созданные изображения. Этот параметр поддерживается только для `gpt-image-1`моделей серии. Должно иметь один из типов `png`, `jpeg` или `webp`. Значение по умолчанию — `png`. Возможные значения: `png`, `jpegwebp`	нет
prompt	струна	Текстовое описание требуемых изображений. Максимальная длина — 1000 символов для `dall-e-2gpt-image-1`моделей серии и 32000 символов.	Да
качество	перечисление	Качество создаваемого изображения. `high`, `medium` и `low` поддерживаются только для `gpt-image-1`моделей серии. `dall-e-2` поддерживает только `standard` качество. По умолчанию — `auto`. Возможные значения: `standard`, `low`, `medium`, `high`, `auto`	нет
формат_ответа	перечисление	Формат, в котором возвращаются созданные изображения. Должен быть одним из `url` или `b64_json`. URL-адреса действительны только в течение 60 минут после создания образа. Этот параметр поддерживается только для `dall-e-2`моделей серии , так как `gpt-image-1`всегда возвращает образы в кодировке Base64. Возможные значения: `url`, `b64_json`	нет
size	перечисление	Размер созданных изображений. Должен быть одним из `1024x1024`, `1536x1024` (альбомная ориентация), `1024x1536` (книжная ориентация) или `auto` (значение по умолчанию) для моделей серии `gpt-image-1`, а также одно из `256x256`, `512x512` или `1024x1024` для `dall-e-2`. Возможные значения: `256x256`, `512x512`, `1024x1024`, `1536x1024`, `1024x1536`, `auto`	нет
Пользователь	струна	Уникальный идентификатор, представляющий пользователя, который может помочь OpenAI отслеживать и обнаруживать злоупотребления.	нет

AzureCreateImageRequest

Имя.	Тип	Description	Обязательно	По умолчанию
фон	перечисление	Позволяет задать прозрачность фона созданных образов. Этот параметр поддерживается только для `gpt-image-1`моделей серии. Должно быть одним из значений `transparentopaque` или `auto` (значение по умолчанию). При `auto` использовании модель автоматически определяет лучший фон для изображения. Если `transparent`выходной формат должен поддерживать прозрачность, поэтому он должен иметь значение `png` (значение по умолчанию) или `webp`. Возможные значения: `transparent`, `opaqueauto`	нет
модель	струна	Развертывание модели, используемое для создания образа.	Да
moderation	перечисление	Управление уровнем модерации содержимого для изображений, созданных моделями серии `gpt-image-1`. `low` Для менее строгой фильтрации или `auto` (значения по умолчанию). Возможные значения: `low`, `auto`	нет
н	целое число	Количество генерируемых изображений. Должно быть от 1 до 10. Для `dall-e-3` поддерживается только `n=1`.	нет	1
сжатие вывода	целое число	Уровень сжатия (0–100%) для созданных образов. Этот параметр поддерживается только для `gpt-image-1`-серий моделей с `webp` или `jpeg` выходными форматами, и по умолчанию, 100.	нет	100
формат_выходных_данных	перечисление	Формат, в котором возвращаются созданные изображения. Этот параметр поддерживается только для `gpt-image-1`моделей серии. Должно иметь один из типов `png`, `jpeg` или `webp`. Возможные значения: `png`, `jpegwebp`	нет
prompt	струна	Текстовое описание требуемых изображений. Максимальная длина — 32000 символов для `gpt-image-1`моделей серии, 1000 символов для `dall-e-2` и 4000 символов.`dall-e-3`	Да
качество	перечисление	Качество создаваемого изображения. - `auto` (значение по умолчанию) автоматически выбирает лучшее качество для данной модели. - `high`, `medium` и `low` поддерживаются для `gpt-image-1`моделей серии. - `hd` и `standard` поддерживаются для `dall-e-3`. - `standard` — единственный вариант для `dall-e-2`. Возможные значения: `standard`, `hd`, `low`, `medium`, `high`, `auto`	нет
формат_ответа	перечисление	Формат, в котором сгенерированные изображения с `dall-e-2` и `dall-e-3` возвращаются. Должен быть одним из `url` или `b64_json`. URL-адреса действительны только в течение 60 минут после создания образа. Этот параметр не поддерживается для `gpt-image-1`моделей серии, которые всегда возвращают образы в кодировке Base64. Возможные значения: `url`, `b64_json`	нет
size	перечисление	Размер созданных изображений. Должен быть одним из `1024x1024`, `1536x1024` (альбомная), `1024x1536` (книжная) или `auto` (значение по умолчанию) для моделей серии `gpt-image-1`, одним из `256x256`, `512x512`, или `1024x1024` для `dall-e-2`, и одним из `1024x1024`, `1792x1024` или `1024x1792` для `dall-e-3`. Возможные значения: `auto`, `1024x1024`, `1536x1024`, `1024x1536`, `256x256`, `512x512`, `1792x1024`, `1024x1792`	нет
стиль	перечисление	Стиль созданных изображений. Этот параметр поддерживается только для `dall-e-3`. Должен быть одним из `vivid` или `natural`. Яркость заставляет модель стремиться к созданию гипер-реальных и драматических изображений. Естественные свойства модели позволяют создавать более естественные, менее гипер-реалистичные изображения. Возможные значения: `vivid`, `natural`	нет
Пользователь	струна	Уникальный идентификатор, представляющий пользователя, который может помочь OpenAI отслеживать и обнаруживать злоупотребления.	нет

AzureCreateResponse

Имя.	Тип	Description	Обязательно	По умолчанию
фон	булевый	Запускать ли ответ модели в фоновом режиме.	нет	Неправда
include	массив	Укажите дополнительные выходные данные для включения в ответ модели. В настоящее время поддерживаются следующие значения: - `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`, или когда организация зарегистрирована в программе нулевого хранения данных).	нет
ввод	строка или массив		нет
instructions	струна	Сообщение системы (или разработчика), вставленное в контекст модели. При использовании вместе с `previous_response_id` инструкциями из предыдущего ответа не будут перенесены в следующий ответ. Это упрощает замену системных сообщений (или сообщений разработчиками) в новых ответах.	нет
max_output_tokens	целое число	Верхняя граница для числа маркеров, которые можно создать для ответа, включая видимые выходные маркеры и маркеры причин	нет
max_tool_calls	целое число	Максимальное количество общих вызовов встроенных инструментов, которые могут обрабатываться в ответе. Это максимальное число применяется ко всем встроенным вызовам инструментов, а не для каждого отдельного средства. Любые дальнейшие попытки вызова средства моделью будут игнорироваться.	нет
metadata	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате и запроса на объекты через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — это строки с максимальной длиной 512 символов.	нет
модель	струна	Развертывание модели, используемое для создания этого ответа.	Да
вызовы инструмента в параллельном режиме	булевый	Следует ли разрешить модели запускать вызовы инструментов параллельно.	нет	True
previous_response_id	струна	Уникальный идентификатор предыдущего ответа на модель. Используйте эту функцию для создания многоэтапных бесед.	нет
prompt	объект	Ссылка на шаблон запроса и его переменные.	нет
Идентификатор └️	струна	Уникальный идентификатор используемого шаблона запроса.	нет
Переменные └️	OpenAI.ResponsePromptVariables	Необязательная карта значений для замены переменных в запросе. Значения подстановки могут быть строками или другими типами входных данных ответа, такими как изображения или файлы.	нет
Версия └️	струна	Необязательная версия шаблона запроса.	нет
reasoning	объект	Только модели o-серии Параметры конфигурации для моделей рассуждений.	нет
- усилия	OpenAI.ReasoningEffort	Только модели o-серии Ограничивает усилия по рассуждениям моделей. В настоящее время поддерживаются `low`значения , `medium`и `high`. Сокращение усилий по поводу может привести к более быстрым откликам и меньшем количестве маркеров, используемых при рассуждениях в ответе.	нет
└─generate_summary	перечисление	Не рекомендуется: используйте `summary` вместо этого. Сводка умозаключений, сделанных моделью. Это может быть полезно для отладки и понимания процесса рассуждений модели. Один из `auto`, `concise`, или `detailed`. Возможные значения: `auto`, `concisedetailed`	нет
└️ сводка	перечисление	Сводка умозаключений, сделанных моделью. Это может быть полезно для отладки и понимания процесса рассуждений модели. Один из `auto`, `concise`, или `detailed`. Возможные значения: `auto`, `concisedetailed`	нет
store	булевый	Следует ли хранить созданный ответ модели для последующего получения через API.	нет	True
поток	булевый	Если задано значение true, данные ответа модели будут передаваться клиенту по мере его создания с помощью событий, отправляемых сервером.	нет	Неправда
Температура	число/номер	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным. Как правило, мы рекомендуем изменить это или `top_p` не оба.	нет	1
текст	объект	Параметры конфигурации для текстового ответа модели. Можно использовать обычный текст или структурированные данные JSON.	нет
└─ Формат	OpenAI.ResponseTextFormatConfiguration		нет
выбор инструмента	объект	Определяет, какое средство (если таковое) вызывается моделью. `none` означает, что модель не будет вызывать какое-либо средство и вместо этого создает сообщение. `auto` означает, что модель может выбирать между созданием сообщения или вызовом одного или нескольких инструментов. `required` означает, что модель должна вызывать один или несколько инструментов.	нет
└─ Тип	OpenAI.ToolChoiceObjectType	Указывает, что модель должна использовать встроенное средство для создания ответа.	нет
инструменты	массив	Массив инструментов, которые модель может вызывать при создании ответа. Можно указать, какое средство следует использовать, задав `tool_choice` параметр. Ниже приведены две категории инструментов, которые можно предоставить модели: - Встроенные средства: средства, предоставляемые OpenAI, которые расширяют возможности модели, например поиск файлов. - Вызовы функций (пользовательские средства): функции, определенные вами, что позволяет модели вызывать собственный код.	нет
top_logprobs	целое число	Целое число от 0 до 20, указывающее число наиболее вероятных маркеров, возвращаемых по каждой позиции маркера, каждый из которых имеет связанную вероятность журнала.	нет
top_p	число/номер	Альтернативой выборке с температурой является так называемая выборка ядра, где модель рассматривает результаты маркеров с top_p всего массива значений вероятности. Таким образом, 0,1 означает, что учитываются только маркеры, входящие в верхние 10% массива значений вероятности. Как правило, мы рекомендуем изменить это или `temperature` не оба.	нет	1
truncation	перечисление	Стратегия усечения, которую следует использовать для генерирования ответа модели. - `auto`: если контекст этого ответа и предыдущих превышает размер окна контекста модели, модель усечет ответ, чтобы он соответствовал этому окну, удаляя элементы ввода в середине беседы. - `disabled` (по умолчанию): если ответ модели превысит размер окна контекста для модели, запрос завершится ошибкой 400. Возможные значения: `auto`, `disabled`	нет
Пользователь	струна	Уникальный идентификатор, представляющий пользователя, который может помочь OpenAI отслеживать и обнаруживать злоупотребления.	нет

AzureCreateSpeechRequestMultiPart

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

Имя.	Тип	Description	Обязательно	По умолчанию
ввод	струна	Текст для создания аудио. Максимальная длина — 4096 символов.	Да
instructions	струна	Управляйте голосом созданного звука с помощью дополнительных инструкций. Не работает с `tts-1` или `tts-1-hd`.	нет
модель	струна	Модель, используемая для этого текстового запроса на речь.	Да
формат_ответа	объект	Поддерживаемые форматы выходных данных звука для преобразования текста в речь.	нет
speed	число/номер	Скорость речи для сгенерированного аудио. Значения допустимы в диапазоне от 0,25 до 4.0 с 1.0 по умолчанию и более высокими значениями, соответствующими более быстрой речи.	нет	1
stream_format	перечисление	Формат для потоковой передачи звука. Поддерживаемые форматы: `sse` и `audio`. `sse` не поддерживается или `tts-1tts-1-hd`не поддерживается. Возможные значения: `sse`, `audio`	нет
голос	объект		Да

AzureCreateTranscriptionRequestMultiPart

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

Имя.	Тип	Description	Обязательно	По умолчанию
chunking_strategy	объект		нет
└prefix_padding_ms	целое число	Длительность звука, которую нужно включить до речи, обнаруженной VAD (в миллисекундах).	нет	300
└─ длительность_тишины_мс	целое число	Длительность молчания для обнаружения остановки речи (в миллисекундах). С более короткими значениями модель будет реагировать быстрее, но может вмешиваться при коротких паузах пользователя.	нет	200
Пороговое значение └️	число/номер	Порог чувствительности (от 0.0 до 1.0) для обнаружения голосовой активности. Более высокий пороговый уровень потребует более громкого звука для активации модели, и таким образом модель может работать лучше в шумных средах.	нет	0,5
└─ Тип	перечисление	Необходимо установить значение `server_vad`, чтобы включить ручное фрагментирование с использованием серверного VAD. Возможные значения: `server_vad`	нет
файл	струна		Да
filename	струна	Необязательный идентификатор файла или описательный идентификатор для связывания с звуковыми данными.	нет
include[]	массив	Дополнительные сведения для добавления в ответ транскрипции. `logprobs` возвращает логарифмы вероятностей маркеров в ответе, чтобы понять достоверность модели в транскрипции. `logprobs` работает только с response_format, заданным на `json`, и только с моделями `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, `gpt-4o-mini-transcribe` и `gpt-4o-mini-transcribe-2025-12-15`.	нет
язык	струна	Язык входного звука. Предоставление языка ввода в формате ISO-639-1 (например `en`, ) повышает точность и задержку.	нет
модель	струна	Модель, используемая для этого запроса транскрибирования.	нет
prompt	струна	Необязательный текст для руководства стилем модели или продолжением предыдущего сегмента звука. Запрос должен соответствовать языку звука.	нет
формат_ответа	объект		нет
поток	булевый	Если задано значение true, данные ответа модели будут передаваться клиенту по мере его создания с помощью событий, отправляемых сервером. Примечание. Потоковая передача не поддерживается для `whisper-1` модели и будет игнорироваться.	нет	Неправда
Температура	число/номер	Температура выборки от 0 до 1. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным. Если задано значение 0, модель будет использовать логарифмическую вероятность для автоматического повышения температуры до достижения определённых пороговых значений.	нет	0
timestamp_granularities[]	массив	Гранулярность метки времени для заполнения этой транскрибирования. `response_format` необходимо задать `verbose_json` для использования детализации метки времени. Поддерживаются либо оба этих параметра: `word`или `segment`. Примечание. Дополнительная задержка для меток времени сегмента отсутствует, но при создании меток времени слова возникает дополнительная задержка.	нет	['segment']

AzureCreateTranslationRequestMultiPart

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

Имя.	Тип	Description	Обязательно	По умолчанию
файл	струна		Да
filename	струна	Необязательный идентификатор файла или описательный идентификатор для связи с звуковыми данными	нет
модель	струна	Модель, используемая для этого запроса на перевод.	нет
prompt	струна	Необязательный текст для руководства стилем модели или продолжением предыдущего сегмента звука. Запрос должен находиться на английском языке.	нет
формат_ответа	объект		нет
Температура	число/номер	Температура выборки от 0 до 1. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным. Если задано значение 0, модель будет использовать логарифмическую вероятность для автоматического повышения температуры до достижения определённых пороговых значений.	нет	0

Ответ об ошибке Azure

Имя.	Тип	Description	Обязательно
ошибка	объект	Сведения об ошибке.	нет
└─ Код	струна	Отдельный идентификатор, созданный компьютером для ошибки.	нет
└─ внутренняя_ошибка			нет
Сообщение └️	струна	Сообщение, доступное для чтения человеком, связанное с ошибкой.	нет
└─ параметр	струна	Если применимо, входной параметр запроса, связанный с ошибкой	нет
└─ Тип	перечисление	Тип объекта всегда "error". Возможные значения: `error`	нет

AzureEvalAPICompletionsSamplingParams

Имя.	Тип	Обязательно
вызовы инструмента в параллельном режиме	булевый	нет
формат_ответа	OpenAI.ResponseTextFormatConfiguration	нет
инструменты	массив	нет

AzureEvalAPIModelSamplingParams

Имя.	Тип	Description	Обязательно
макс_токены	целое число	Максимальное количество токенов в сгенерированном выводе.	нет
усилия на рассуждение	перечисление	Управляет уровнем усилий, применяемых во время создания. Возможные значения: `low`, `mediumhigh`	нет
seed	целое число	Начальное значение для инициализации случайности во время выборки.	нет
Температура	число/номер	Более высокая температура увеличивает случайность выходных данных.	нет
top_p	число/номер	Альтернатива температуре для выборки ядра; 1.0 включает все маркеры.	нет

AzureEvalAPIResponseSamplingParams

Имя.	Тип	Обязательно
вызовы инструмента в параллельном режиме	булевый	нет
формат_ответа	OpenAI.ResponseTextFormatConfiguration	нет
инструменты	массив	нет

AzureFileExpiryAnchor

Недвижимость	Ценность
Тип	струна
Значения	`created_at`

AzureFineTuneReinforcementMethod

Имя.	Тип	Description	Обязательно
грейдер	объект	Объект StringCheckGrader, выполняющий сравнение строк между входами и ссылкой с помощью указанной операции.	Да
└calculate_output calculate_output	струна	Формула для вычисления выходных данных на основе результатов оценки.	нет
└️ evaluation_metric	перечисление	Используемая метрика оценки. Один из `fuzzy_match`, `bleu`, `gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`, или `rouge_l`. Возможные значения: `fuzzy_match`, `bleu`, `gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`, `rouge_l`	нет
└️ классировщиков	объект		нет
└─ Входные данные	массив	Входной текст. Это может включать строки шаблона.	нет
└─ Модель	струна	Модель, используемая для оценки.	нет
└️ имя	струна	Имя классировщика.	нет
Операция └️	перечисление	Операция проверки строки, которую нужно выполнить. Один из `eq`, `nelike`или `ilike`. Возможные значения: `eq`, , `nelikeilike`	нет
Диапазон └️	массив	Диапазон оценки. По умолчанию — `[0, 1]`.	нет
Справочник по └️	струна	Текст, классируемый против.	нет
└─sampling_params		Параметры выборки для модели.	нет
└─ Тип	перечисление	Тип объекта, который всегда `multi`является . Возможные значения: `multi`	нет
гиперпараметры	OpenAI.FineTuneReinforcementHyperparameters	Гиперпараметры, используемые для задания точной настройки с подкреплением.	нет
формат_ответа	объект		нет
└json_schema	объект	Схема JSON для формата ответа	нет
└─ Тип	перечисление	Тип формата ответа. Возможные значения: `json_schema`	нет

AzureImage

Имя.	Тип	Description	Обязательно
b64_json	струна	Кодированный в кодировке Base64 JSON созданного образа. Значение по умолчанию для моделей серии `gpt-image-1`, и только если `response_format` имеет значение `b64_json` для `dall-e-2` и `dall-e-3`.	нет
результаты фильтрации контента	AzureContentFilterImageResponseResults	Результат фильтрации содержимого для вывода содержимого ответа операции генерации изображений.	Да
результаты_фильтрации_запросов	AzureContentFilterImagePromptResults	Результат фильтра содержимого для содержимого входного запроса операции создания изображения.	Да
пересмотренный_запрос	струна	Только `dall-e-3` измененный запрос, который использовался для создания образа.	нет
URL-адрес	струна	При использовании `dall-e-2` или `dall-e-3`URL-адрес созданного изображения, если `response_format` задано значение `url` (значение по умолчанию). Не поддерживается для моделей серии `gpt-image-1`.	нет

AzureImagesResponse

Имя.	Тип	Description	Обязательно
фон	перечисление	Фоновый параметр, используемый для создания образа. `transparent` или `opaque`. Возможные значения: `transparent`, `opaque`	нет
создано	целое число	Метка времени Unix (в секундах) момента создания образа.	Да
данные	массив		нет
формат_выходных_данных	перечисление	Выходной формат создания изображения. Возможные значения: `png`, `webp` или `jpeg`. Возможные значения: `png`, `webpjpeg`	нет
качество	перечисление	Качество созданного изображения. Возможные значения: `low`, `medium` или `high`. Возможные значения: `low`, `mediumhigh`	нет
size	перечисление	Размер созданного изображения. Возможные значения: `1024x1024`, `1024x1536` или `1536x1024`. Возможные значения: `1024x1024`, `1024x15361536x1024`	нет
использование	объект	Только для моделей серии `gpt-image-1`: информация об использовании токенов для генерации изображений.	нет
└input_tokens	целое число	Количество токенов (изображений и текста) в входном запросе.	нет
└─ данные_входных_токенов	объект	Подробные сведения о входных токенах для создания изображения.	нет
└─image_tokens	целое число	Количество маркеров изображения во входной подсказке.	нет
└️ текст_токены	целое число	Количество текстовых токенов в запросе ввода.	нет
└─ выходные_токены (output_tokens)	целое число	Количество маркеров изображения в выходном изображении.	нет
└️ всего_токенов	целое число	Общее количество маркеров (изображений и текста), используемых для создания изображения.	нет

AzureListFilesResponse

Имя.	Тип	Description	Обязательно
данные	массив		Да
первый_идентификатор	струна		Да
есть_еще	булевый		Да
last_id	струна		Да
объект	перечисление	Возможные значения: `list`	Да

AzureOpenAIFile

Имя.	Тип	Description	Обязательно
байт	целое число	Размер файла в байтах.	Да
создано_в	целое число	Метка времени Unix (в секундах) для момента создания файла.	Да
срок_действия_до	целое число	Метка времени Unix (в секундах) для истечения срока действия файла.	нет
filename	струна	Имя файла.	Да
id	струна	Идентификатор файла, на который можно ссылаться в конечных точках API.	Да
объект	перечисление	Тип объекта, который всегда `file`является . Возможные значения: `file`	Да
purpose	перечисление	Предназначение файла. Поддерживаемые значения: `assistants`, , `assistants_outputbatch`, `batch_outputfine-tune`и `fine-tune-results`. Возможные значения: `assistants`, , , `assistants_outputbatchbatch_outputfine-tunefine-tune-resultsevals`	Да
статус	перечисление	Возможные значения: `uploaded`, , , `pendingrunningprocessederrordeletingdeleted`	Да
подробности_статуса	струна	Устарело. Дополнительные сведения о том, почему сбой проверки файла обучения точной настройки см. в `errorfine_tuning.job`поле .	нет

AzureOpenAIVideoGenerationErrorResponse

Имя.	Тип	Description	Обязательно
код	струна	Отдельный идентификатор, созданный компьютером для ошибки.	нет
внутренняя ошибка	объект	Если применимо, ошибкой, которая вызвала эту ошибку, является вышестоящая ошибка.	нет
└─ Код	перечисление	Код, связанный с внутренней ошибкой. Возможные значения: `ResponsibleAIPolicyViolation`	нет
└─ детали ошибки		Сведения о результатах фильтра содержимого, связанные с внутренней ошибкой.	нет
└─ пересмотренный_запрос	струна	Если применимо, измененный запрос, используемый для генерации.	нет
сообщение	струна	Сообщение, доступное для чтения человеком, связанное с ошибкой.	нет
параметр	струна	Если применимо, входной параметр запроса, связанный с ошибкой	нет
type	струна	Если применимо, номер строки ввода, связанный с ошибкой.	нет

AzureResponse

Имя.	Тип	Description	Обязательно	По умолчанию
фон	булевый	Запускать ли ответ модели в фоновом режиме.	нет	Неправда
создано_в	целое число	Метка времени в формате Unix (в секундах), когда был создан этот ответ.	Да
ошибка	объект	Объект ошибки, возвращаемый, когда модель не сможет создать ответ.	Да
└─ Код	OpenAI.ResponseErrorCode	Код ошибки для ответа.	нет
Сообщение └️	струна	Описание ошибки, доступной для чтения человеком.	нет
id	струна	Уникальный идентификатор для этого ответа.	Да
incomplete_details	объект	Сведения о том, почему ответ неполный.	Да
└─ Причина	перечисление	Причина, по которой ответ является неполным. Возможные значения: `max_output_tokens`, `content_filter`	нет
instructions	строка или массив		Да
max_output_tokens	целое число	Верхняя граница для числа маркеров, которые можно создать для ответа, включая видимые выходные маркеры и маркеры причин	нет
max_tool_calls	целое число	Максимальное количество общих вызовов встроенных инструментов, которые могут обрабатываться в ответе. Это максимальное число применяется ко всем встроенным вызовам инструментов, а не для каждого отдельного средства. Любые дальнейшие попытки вызова средства моделью будут игнорироваться.	нет
metadata	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате и запроса на объекты через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — это строки с максимальной длиной 512 символов.	Да
модель	струна	Модель, используемая для создания этого ответа.	Да
объект	перечисление	Тип объекта этого ресурса — всегда установлено `response`. Возможные значения: `response`	Да
output	массив	Массив элементов контента, созданных моделью. — длина и порядок элементов в массиве `output` зависит от ответа модели. — Вместо доступа к первому элементу `output` массива и предположения, что это `assistant` сообщение с содержимым, созданным моделью, попробуйте использовать свойство `output_text`, где это поддержано в пакетах SDK.	Да
output_text	струна	Доступное только для пакета SDK свойство, содержащее агрегированные текстовые выходные данные всех `output_text` элементов в массиве `output` , если они присутствуют. Поддерживается в пакетах SDK для Python и JavaScript.	нет
вызовы инструмента в параллельном режиме	булевый	Следует ли разрешить модели запускать вызовы инструментов параллельно.	Да	True
previous_response_id	струна	Уникальный идентификатор предыдущего ответа на модель. Используйте эту функцию для создания многоэтапных бесед.	нет
prompt	объект	Ссылка на шаблон запроса и его переменные.	нет
Идентификатор └️	струна	Уникальный идентификатор используемого шаблона запроса.	нет
Переменные └️	OpenAI.ResponsePromptVariables	Необязательная карта значений для замены переменных в запросе. Значения подстановки могут быть строками или другими типами входных данных ответа, такими как изображения или файлы.	нет
Версия └️	струна	Необязательная версия шаблона запроса.	нет
reasoning	объект	Только модели o-серии Параметры конфигурации для моделей рассуждений.	нет
- усилия	OpenAI.ReasoningEffort	Только модели o-серии Ограничивает усилия по рассуждениям моделей. В настоящее время поддерживаются `low`значения , `medium`и `high`. Сокращение усилий по поводу может привести к более быстрым откликам и меньшем количестве маркеров, используемых при рассуждениях в ответе.	нет
└─generate_summary	перечисление	Не рекомендуется: используйте `summary` вместо этого. Сводка умозаключений, сделанных моделью. Это может быть полезно для отладки и понимания процесса рассуждений модели. Один из `auto`, `concise`, или `detailed`. Возможные значения: `auto`, `concisedetailed`	нет
└️ сводка	перечисление	Сводка умозаключений, сделанных моделью. Это может быть полезно для отладки и понимания процесса рассуждений модели. Один из `auto`, `concise`, или `detailed`. Возможные значения: `auto`, `concisedetailed`	нет
статус	перечисление	Статус формирования ответа. Один из `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete` или . Возможные значения: `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete`	нет
Температура	число/номер	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным. Как правило, мы рекомендуем изменить это или `top_p` не оба.	Да
текст	объект	Параметры конфигурации для текстового ответа модели. Можно использовать обычный текст или структурированные данные JSON.	нет
└─ Формат	OpenAI.ResponseTextFormatConfiguration		нет
выбор инструмента	объект	Определяет, какое средство (если таковое) вызывается моделью. `none` означает, что модель не будет вызывать какое-либо средство и вместо этого создает сообщение. `auto` означает, что модель может выбирать между созданием сообщения или вызовом одного или нескольких инструментов. `required` означает, что модель должна вызывать один или несколько инструментов.	нет
└─ Тип	OpenAI.ToolChoiceObjectType	Указывает, что модель должна использовать встроенное средство для создания ответа.	нет
инструменты	массив	Массив инструментов, которые модель может вызывать при создании ответа. Можно указать, какое средство следует использовать, задав `tool_choice` параметр. Ниже приведены две категории инструментов, которые можно предоставить модели: - Встроенные средства: средства, предоставляемые OpenAI, которые расширяют возможности модели.	нет
top_logprobs	целое число	Целое число от 0 до 20, указывающее число наиболее вероятных маркеров, возвращаемых по каждой позиции маркера, каждый из которых имеет связанную вероятность журнала.	нет
top_p	число/номер	Альтернативой выборке с температурой является так называемая выборка ядра, где модель рассматривает результаты маркеров с top_p всего массива значений вероятности. Таким образом, 0,1 означает, что учитываются только маркеры, входящие в верхние 10% массива значений вероятности. Как правило, мы рекомендуем изменить это или `temperature` не оба.	Да
truncation	перечисление	Стратегия усечения, которую следует использовать для генерирования ответа модели. - `auto`: если контекст этого ответа и предыдущих превышает размер окна контекста модели, модель усечет ответ, чтобы он соответствовал этому окну, удаляя элементы ввода в середине беседы. - `disabled` (по умолчанию): если ответ модели превысит размер окна контекста для модели, запрос завершится ошибкой 400. Возможные значения: `auto`, `disabled`	нет
использование	OpenAI.ResponseUsage	Представляет сведения об использовании маркеров, включая входные маркеры, выходные маркеры, разбивку выходных маркеров и общие используемые маркеры.	нет
Пользователь	струна	Уникальный идентификатор, представляющий пользователя, который может помочь OpenAI отслеживать и обнаруживать злоупотребления.	Да

AzureSearchChatDataSource

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

Имя.	Тип	Description	Обязательно	По умолчанию
параметры	объект	Сведения о параметрах для управления использованием источника данных Azure поиска.	Да
└️ allow_partial_result	булевый	Если установлено значение true, система позволит использовать частичные результаты поиска, и запрос будет считаться неуспешным, если все частичные запросы окажутся неудачными. Если запрос не указан или указан как false, запрос завершится ошибкой, если любой поисковый запрос завершается ошибкой.	нет	Неправда
└─ проверка подлинности	объект		нет
└─access_token	струна		нет
└─ Ключ	струна		нет
└managed_identity_resource_id	струна		нет
└─ Тип	перечисление	Возможные значения: `access_token`	нет
└─ встраивание_зависимости	объект	Представляет источник векторизации, который вызывает вызовы общедоступной службы к развертыванию модели внедрения openAI Azure.	нет
└─ проверка подлинности	AzureChatDataSourceApiKeyAuthenticationOptions или AzureChatDataSourceAccessTokenAuthenticationOptions	Механизм аутентификации, используемый с источником векторизации, основанным на конечной точке. Проверка подлинности конечной точки поддерживает ключ API и механизмы маркеров access.	нет
└deployment_name deployment_name	струна	Модель встраивания, используемая для векторизации. Это развертывание должно существовать в том же Azure ресурсе OpenAI, что и развертывание модели, используемое для завершения чата.	нет
Размеры	целое число	Количество измерений, запрашиваемых для эмбеддингов. Поддерживается только в моделях text-embedding-3 и более поздних версий.	нет
Конечная точка	струна	Указывает URL-адрес конечной точки ресурса, из которого должны быть получены внедренные модули. Он должен быть в формате: https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings. Параметр запроса версии API не разрешен.	нет
└─ Тип	перечисление	Идентификатор типа всегда "интегрированный" для этого типа источника векторизации. Возможные значения: `integrated`	нет
Конечная точка	струна	Абсолютный путь конечной точки для используемого ресурса поиска Azure.	нет
└─ сопоставление_полей	объект	Сопоставления полей для использования с ресурсом поиска Azure.	нет
└─ поля_контента	массив	Имена полей индекса, которые следует рассматривать как содержимое.	нет
└─content_fields_separator	струна	Шаблон разделителя, который должны использовать поля содержимого.	нет
└filepath_field	струна	Имя поля индекса, используемого в качестве файлового пути.	нет
└️ image_vector_fields	массив	Имена полей, представляющих векторные данные изображения.	нет
└─ название_поля	струна	Имя поля индекса, используемого в качестве заголовка.	нет
└─ поле_ссылки	струна	Имя поля индекса, используемого в качестве URL-адреса.	нет
└─ векторные_поля	массив	Имена полей, представляющих векторные данные.	нет
└─ Фильтр	струна	Фильтр для применения к поиску.	нет
└in_scope	булевый	Следует ли ограничить запросы использованием индексированных данных.	нет
└─ включить_контексты	массив	Свойства контекста выходных данных, которые необходимо включить в ответ. По умолчанию запрашивается ссылка и намерение.	нет	['цитаты', 'намерение']
└– index_name	струна	Имя используемого индекса, как указано в ресурсе поиска Azure.	нет
└max_search_queries	целое число	Максимальное количество перезаписанных запросов, которые должны отправляться поставщику поиска для одного сообщения пользователя. По умолчанию система сделает автоматическое определение.	нет
└️ тип_запроса	перечисление	Тип запроса для используемого ресурса поиска Azure. Возможные значения: `simple`, `semantic`, `vector`, `vector_simple_hybrid`, `vector_semantic_hybrid`	нет
└─ семантическая_конфигурация	струна	Дополнительная семантическая конфигурация для запроса.	нет
└️ строгость	целое число	Настроенная строгость фильтрации релевантности поиска. Более строгие критерии увеличат точность, но снизят полноту ответа.	нет
└top_n_documents	целое число	Настроено количество документов, которые нужно выделить в запросе.	нет
type	перечисление	Идентификатор различаемого типа, который всегда равен "azure_search". Возможные значения: `azure_search`	Да

AzureUserSecurityContext

Контекст безопасности пользователя содержит несколько параметров, описывающих само приложение, и конечный пользователь, взаимодействующий с приложением. Эти поля помогают группам по операциям безопасности исследовать и устранять инциденты безопасности, предоставляя комплексный подход к защите приложений ИИ. Learn more о защите приложений ИИ с помощью Microsoft Defender for Cloud.

Имя.	Тип	Description	Обязательно
application_name	струна	Имя приложения. Конфиденциальная личная информация не должна быть включена в это поле.	нет
end_user_id	струна	Этот идентификатор — это идентификатор объекта пользователя Microsoft Entra ID (ранее Azure Active Directory), используемый для проверки подлинности конечных пользователей в созданном приложении ИИ. Конфиденциальная личная информация не должна быть включена в это поле.	нет
end_user_tenant_id	струна	Идентификатор клиента Microsoft 365, к которому принадлежит конечный пользователь. Это необходимо, если созданное приложение искусственного интеллекта является мультитенантным.	нет
source_ip	струна	Записывает IP-адрес исходного клиента.	нет

ChatCompletionMessageToolCallsItem

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

Массив: OpenAI.ChatCompletionMessageToolCall

CreateVideoGenerationRequest

Имя.	Тип	Description	Обязательно	По умолчанию
height	целое число	Высота видео. Поддерживаются следующие измерения: 480x480, 854x480, 720x720, 1280x720, 1080x1080 и 1920x1080 в альбомной и книжной ориентации.	Да
модель	струна	Имя развертывания, используемого для этого запроса.	Да
n_seconds	целое число	Длительность задания создания видео. Должно быть от 1 до 20 секунд.	нет	5
n_variants	целое число	Количество видео для создания в качестве вариантов для этого задания. Значение должно находиться в диапазоне от 1 до 5. Меньшие размеры позволяют больше вариантов.	нет	1
prompt	струна	Запрос для задания создания видео.	Да
Ширина	целое число	Ширина видео. Поддерживаются следующие измерения: 480x480, 854x480, 720x720, 1280x720, 1080x1080 и 1920x1080 в альбомной и книжной ориентации.	Да

CreateVideoGenerationWithMediaRequestMultiPart

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

Имя.	Тип	Description	Обязательно	По умолчанию
files	массив		Да
height	целое число	Высота видео. Поддерживаются следующие измерения: 480x480, 854x480, 720x720, 1280x720, 1080x1080 и 1920x1080 в альбомной и книжной ориентации.	Да
inpaint_items	массив	Необязательные элементы для этого задания создания видео.	нет
модель	струна	Имя развертывания, используемого для этого запроса.	Да
n_seconds	целое число	Длительность задания создания видео. Должно быть от 1 до 20 секунд.	нет	5
n_variants	целое число	Количество видео для создания в качестве вариантов для этого задания. Значение должно находиться в диапазоне от 1 до 5. Меньшие размеры позволяют больше вариантов.	нет	1
prompt	струна	Запрос для задания создания видео.	Да
Ширина	целое число	Ширина видео. Поддерживаются следующие измерения: 480x480, 854x480, 720x720, 1280x720, 1080x1080 и 1920x1080 в альбомной и книжной ориентации.	Да

Обрезки

Границы обрезки для элемента инпакетирования. Это указывает область элемента мультимедиа, который следует использовать для вставки.

Имя.	Тип	Description	Обязательно	По умолчанию
bottom_fraction	число/номер	Нижняя граница поля обрезки, указанная как доля высоты исходного элемента мультимедиа. Должно быть от 0.0 до 1.0. Используйте, например, 0,5 для половины высоты исходного элемента мультимедиа.	нет	1
left_fraction	число/номер	Левая граница поля обрезки, указанная как доля ширины исходного элемента мультимедиа. Должно быть от 0.0 до 1.0. Используйте, например, 0,5 для половины ширины исходного элемента мультимедиа.	нет	0
right_fraction	число/номер	Правая граница поля обрезки, указанная как доля ширины исходного элемента мультимедиа. Должно быть от 0.0 до 1.0. Используйте, например, 0,5 для половины ширины исходного элемента мультимедиа.	нет	1
top_fraction	число/номер	Верхняя граница поля обрезки, указанная как доля высоты исходного элемента мультимедиа. Должно быть от 0.0 до 1.0. Используйте, например, 0,5 для половины высоты исходного элемента мультимедиа.	нет	0

ElasticsearchChatDataSource

Имя.	Тип	Description	Обязательно	По умолчанию
параметры	объект	Сведения о параметрах для управления использованием источника данных Elasticsearch.	Да
└️ allow_partial_result	булевый	Если установлено значение true, система позволит использовать частичные результаты поиска, и запрос будет считаться неуспешным, если все частичные запросы окажутся неудачными. Если запрос не указан или указан как false, запрос завершится ошибкой, если любой поисковый запрос завершается ошибкой.	нет	Неправда
└─ проверка подлинности	объект		нет
└─encoded_api_key	струна		нет
└─ Ключ	струна		нет
└key_id	струна		нет
└─ Тип	перечисление	Возможные значения: `encoded_api_key`	нет
└─ встраивание_зависимости	AzureChatDataSourceVectorizationSource	Представление источника векторизации данных, который можно использовать как ресурс внедрения с источником данных.	нет
Конечная точка	струна		нет
└─ сопоставление_полей	объект		нет
└─ поля_контента	массив		нет
└─content_fields_separator	струна		нет
└filepath_field	струна		нет
└─ название_поля	струна		нет
└─ поле_ссылки	струна		нет
└─ векторные_поля	массив		нет
└in_scope	булевый	Следует ли ограничить запросы использованием индексированных данных.	нет
└─ включить_контексты	массив	Свойства контекста выходных данных, которые необходимо включить в ответ. По умолчанию запрашивается ссылка и намерение.	нет	['цитаты', 'намерение']
└– index_name	струна		нет
└max_search_queries	целое число	Максимальное количество перезаписанных запросов, которые должны отправляться поставщику поиска для одного сообщения пользователя. По умолчанию система сделает автоматическое определение.	нет
└️ тип_запроса	перечисление	Возможные значения: `simple`, `vector`	нет
└️ строгость	целое число	Настроенная строгость фильтрации релевантности поиска. Более строгие критерии увеличат точность, но снизят полноту ответа.	нет
└top_n_documents	целое число	Настроено количество документов, которые нужно выделить в запросе.	нет
type	перечисление	Идентификатор различаемого типа, который всегда — 'elasticsearch'. Возможные значения: `elasticsearch`	Да

InpaintItem

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

Имя.	Тип	Description	Обязательно	По умолчанию
crop_bounds	объект	Границы обрезки для элемента инпакетирования. Это указывает область элемента мультимедиа, который следует использовать для вставки.	нет
└bottom_fraction	число/номер	Нижняя граница поля обрезки, указанная как доля высоты исходного элемента мультимедиа. Должно быть от 0.0 до 1.0. Используйте, например, 0,5 для половины высоты исходного элемента мультимедиа.	нет	1
└️ left_fraction	число/номер	Левая граница поля обрезки, указанная как доля ширины исходного элемента мультимедиа. Должно быть от 0.0 до 1.0. Используйте, например, 0,5 для половины ширины исходного элемента мультимедиа.	нет	0
└right_fraction	число/номер	Правая граница поля обрезки, указанная как доля ширины исходного элемента мультимедиа. Должно быть от 0.0 до 1.0. Используйте, например, 0,5 для половины ширины исходного элемента мультимедиа.	нет	1
└top_fraction	число/номер	Верхняя граница поля обрезки, указанная как доля высоты исходного элемента мультимедиа. Должно быть от 0.0 до 1.0. Используйте, например, 0,5 для половины высоты исходного элемента мультимедиа.	нет	0
file_name	струна	Имя файла элемента мультимедиа. Он должен соответствовать имени файла вложения в этом запросе.	Да
frame_index	целое число	Индекс кадра для этого элемента мультимедиа. Это указывает начальный кадр в полученном созданном видео для этого элемента инпакетирования.	Да	0
type	объект	Тип элемента инпайтирования.	Да

JobStatus

Состояние задания создания видео.

Недвижимость	Ценность
Описание	Состояние задания создания видео.
Тип	струна
Значения	`preprocessing` `queued` `running` `processing` `cancelled` `succeeded` `failed`

MediaItemType

Тип элемента инпайтирования.

Недвижимость	Ценность
Описание	Тип элемента инпайтирования.
Тип	струна
Значения	`image`

MongoDBChatDataSource

Имя.	Тип	Description	Обязательно	По умолчанию
параметры	объект	Сведения о параметрах для управления использованием источника данных MongoDB.	Да
└️ allow_partial_result	булевый	Если установлено значение true, система позволит использовать частичные результаты поиска, и запрос будет считаться неуспешным, если все частичные запросы окажутся неудачными. Если запрос не указан или указан как false, запрос завершится ошибкой, если любой поисковый запрос завершается ошибкой.	нет	Неправда
└app_name	струна	Имя приложения MongoDB.	нет
└─ проверка подлинности	объект		нет
└─ Пароль	струна		нет
└─ Тип	перечисление	Возможные значения: `username_and_password`	нет
└️ имя пользователя	струна		нет
└─ имя_коллекции	струна	Имя коллекции MongoDB.	нет
└ «database_name»	струна	Имя базы данных MongoDB.	нет
└─ встраивание_зависимости	объект	Представляет источник векторизации, который вызывает вызовы общедоступной службы к развертыванию модели внедрения openAI Azure.	нет
└─ проверка подлинности	AzureChatDataSourceApiKeyAuthenticationOptions или AzureChatDataSourceAccessTokenAuthenticationOptions	Механизм аутентификации, используемый с источником векторизации, основанным на конечной точке. Проверка подлинности конечной точки поддерживает ключ API и механизмы маркеров access.	нет
└deployment_name deployment_name	струна	Модель встраивания, используемая для векторизации. Это развертывание должно существовать в том же Azure ресурсе OpenAI, что и развертывание модели, используемое для завершения чата.	нет
Размеры	целое число	Количество измерений, запрашиваемых для эмбеддингов. Поддерживается только в моделях text-embedding-3 и более поздних версий.	нет
Конечная точка	струна	Указывает URL-адрес конечной точки ресурса, из которого должны быть получены внедренные модули. Он должен быть в формате: https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings. Параметр запроса версии API не разрешен.	нет
└─ Тип	перечисление	Идентификатор типа, всегда «deployment_name» для этого источника данных векторизации. Возможные значения: `deployment_name`	нет
Конечная точка	струна	Имя конечной точки кластера MongoDB.	нет
└─ сопоставление_полей	объект	Сопоставления полей для применения к данным, используемым источником данных MongoDB. Обратите внимание, что для MongoDB требуются сопоставления содержимого и векторных полей.	нет
└─ поля_контента	массив		нет
└─content_fields_separator	струна		нет
└filepath_field	струна		нет
└─ название_поля	струна		нет
└─ поле_ссылки	струна		нет
└─ векторные_поля	массив		нет
└in_scope	булевый	Следует ли ограничить запросы использованием индексированных данных.	нет
└─ включить_контексты	массив	Свойства контекста выходных данных, которые необходимо включить в ответ. По умолчанию запрашивается ссылка и намерение.	нет	['цитаты', 'намерение']
└– index_name	струна	Имя индекса MongoDB.	нет
└max_search_queries	целое число	Максимальное количество перезаписанных запросов, которые должны отправляться поставщику поиска для одного сообщения пользователя. По умолчанию система сделает автоматическое определение.	нет
└️ строгость	целое число	Настроенная строгость фильтрации релевантности поиска. Более строгие критерии увеличат точность, но снизят полноту ответа.	нет
└top_n_documents	целое число	Настроено количество документов, которые нужно выделить в запросе.	нет
type	перечисление	Идентификатор дискриминируемого типа, который всегда равен "mongo_db". Возможные значения: `mongo_db`	Да

OpenAI.Annotation

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

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

Значение типа	Схема
`file_citation`	OpenAI.AnnotationFileCitation
`url_citation`	OpenAI.AnnotationUrlCitation
`file_path`	OpenAI.AnnotationFilePath

Имя.	Тип	Description	Обязательно	По умолчанию
type	OpenAI.AnnotationType		Да

OpenAI.AnnotationFileCitation

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

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

OpenAI.AnnotationFilePath

Путь к файлу.

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

OpenAI.AnnotationType

Недвижимость	Ценность
Тип	струна
Значения	`file_citation` `url_citation` `file_path` `container_file_citation`

OpenAI.AnnotationUrlCitation

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

Имя.	Тип	Description	Обязательно
end_index	целое число	Индекс последнего символа ссылки URL-адреса в сообщении.	Да
start_index	целое число	Индекс первого символа ссылки URL-адреса в сообщении.	Да
title	струна	Заголовок веб-ресурса.	Да
type	перечисление	Тип URL-ссылки. Всегда `url_citation`. Возможные значения: `url_citation`	Да
URL-адрес	струна	URL-адрес веб-ресурса.	Да

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

Имя.	Тип	Description	Обязательно
city	струна		нет
country	струна		нет
region	струна		нет
timezone	струна		нет
type	перечисление	Возможные значения: `approximate`	Да

OpenAI.AudioResponseFormat

Формат выходных данных в одном из следующих параметров: json, , text, srtverbose_jsonили vtt. Для gpt-4o-transcribe, gpt-4o-transcribe-diarizeи gpt-4o-mini-transcribegpt-4o-mini-transcribe-2025-12-15. Единственным поддерживаемым форматом является json.

Недвижимость	Ценность
Описание	Формат выходных данных в одном из следующих параметров: `json`, , `text`, `srtverbose_json`или `vtt`. Для `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`и `gpt-4o-mini-transcribegpt-4o-mini-transcribe-2025-12-15`. Единственным поддерживаемым форматом является `json`.
Тип	струна
Значения	`json` `text` `srt` `verbose_json` `vtt`

OpenAI.AutoChunkingStrategyRequestParam

Стратегия по умолчанию. В настоящее время эта стратегия использует и max_chunk_size_tokens имеет значение 800chunk_overlap_tokens .400

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

OpenAI.ChatCompletionFunctionCallOption

Указание определенной функции путем {"name": "my_function"} принудительного вызова этой функции моделью.

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

OpenAI.ChatCompletionFunctions

Имя.	Тип	Description	Обязательно
описание	струна	Описание того, что выполняет функция, используемая моделью для выбора времени и способа вызова функции.	нет
имя	струна	Имя вызываемой функции. Должен быть a-z, A-Z, 0-9 или содержать символы подчеркивания и дефисы с максимальной длиной 64.	Да
параметры		Параметры, которые принимают функции, описаны как объект схемы JSON. Дополнительные сведения о формате см. в справочнике по схеме JSON . Опущение `parameters` определяет функцию с пустым списком параметров.	нет

OpenAI.ChatCompletionMessageAudioChunk

Имя.	Тип	Обязательно
данные	струна	нет
срок_действия_до	целое число	нет
id	струна	нет
transcript	струна	нет

OpenAI.ChatCompletionMessageToolCall

Имя.	Тип	Description	Обязательно
function	объект	Функция, вызываемая моделью.	Да
└─ аргументы	струна	Аргументы, с которыми вызывается функция, как создается моделью в формате JSON. Обратите внимание, что модель не всегда создает допустимые json и может галлюцинировать параметры, не определенные схемой функции. Перед вызовом функции проверьте аргументы в коде.	нет
└️ имя	струна	Имя вызываемой функции.	нет
id	струна	Идентификатор вызова средства.	Да
type	перечисление	Тип средства. В настоящее время поддерживается только `function` . Возможные значения: `function`	Да

OpenAI.ChatCompletionMessageToolCallChunk

Имя.	Тип	Description	Обязательно
function	объект		нет
└─ аргументы	струна	Аргументы, с которыми вызывается функция, как создается моделью в формате JSON. Обратите внимание, что модель не всегда создает допустимые json и может галлюцинировать параметры, не определенные схемой функции. Перед вызовом функции проверьте аргументы в коде.	нет
└️ имя	струна	Имя вызываемой функции.	нет
id	струна	Идентификатор вызова средства.	нет
index	целое число		Да
type	перечисление	Тип средства. В настоящее время поддерживается только `function` . Возможные значения: `function`	нет

OpenAI.ChatCompletionNamedToolChoice

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

Имя.	Тип	Description	Обязательно
function	объект		Да
└️ имя	струна	Имя вызываемой функции.	нет
type	перечисление	Тип средства. В настоящее время поддерживается только `function` . Возможные значения: `function`	Да

OpenAI.ChatCompletionRequestAssistantMessage

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

Имя.	Тип	Description	Обязательно
audio	объект	Данные о предыдущем звуковом ответе модели.	нет
Идентификатор └️	струна	Уникальный идентификатор предыдущего звукового ответа модели.	нет
содержимое	строка или массив		нет
вызов_функции	объект	Устаревшие и замененные `tool_calls`. Имя и аргументы вызываемой функции, созданной моделью.	нет
└─ аргументы	струна		нет
└️ имя	струна		нет
имя	струна	Необязательное имя участника. Предоставляет сведения о модели, чтобы различать участников одной роли.	нет
отказ	струна	Сообщение об отказе помощником.	нет
роль	перечисление	Роль автора сообщений в данном случае `assistant`. Возможные значения: `assistant`	Да
вызовы инструментов	ChatCompletionMessageToolCallsItem	Вызовы средства, созданные моделью, например вызовы функций.	нет

OpenAI.ChatCompletionRequestAssistantMessageContentPart

Имя.	Тип	Description	Обязательно
отказ	струна	Сообщение об отказе, созданное моделью.	Да
текст	струна	Текстовое содержимое.	Да
type	перечисление	Тип части содержимого. Возможные значения: `refusal`	Да

OpenAI.ChatCompletionRequestDeveloperMessage

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

Имя.	Тип	Description	Обязательно
содержимое	строка или массив		Да
имя	струна	Необязательное имя участника. Предоставляет сведения о модели, чтобы различать участников одной роли.	нет
роль	перечисление	Роль автора сообщений в данном случае `developer`. Возможные значения: `developer`	Да

OpenAI.ChatCompletionRequestFunctionMessage

Имя.	Тип	Description	Обязательно
содержимое	струна	Содержимое сообщения функции.	Да
имя	струна	Имя вызываемой функции.	Да
роль	перечисление	Роль автора сообщений в данном случае `function`. Возможные значения: `function`	Да

OpenAI.ChatCompletionRequestMessage

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

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

Значение типа	Схема
`system`	OpenAI.ChatCompletionRequestSystemMessage
`developer`	OpenAI.ChatCompletionRequestDeveloperMessage
`user`	OpenAI.ChatCompletionRequestUserMessage
`assistant`	OpenAI.ChatCompletionRequestAssistantMessage
`tool`	OpenAI.ChatCompletionRequestToolMessage
`function`	OpenAI.ChatCompletionRequestFunctionMessage

Имя.	Тип	Description	Обязательно	По умолчанию
содержимое	строка или массив		нет
роль	объект	Роль автора сообщения	Да

OpenAI.ChatCompletionRequestMessageContentPart

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

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

Значение типа	Схема
`text`	OpenAI.ChatCompletionRequestMessageContentPartText
`image_url`	OpenAI.ChatCompletionRequestMessageContentPartImage
`refusal`	OpenAI.ChatCompletionRequestMessageContentPartRefusal
`file`	OpenAI.ChatCompletionRequestMessageContentPartFile
`input_audio`	OpenAI.ChatCompletionRequestMessageContentPartAudio

Имя.	Тип	Description	Обязательно	По умолчанию
type	OpenAI.ChatCompletionRequestMessageContentPartType		Да

OpenAI.ChatCompletionRequestMessageContentPartAudio

Имя.	Тип	Description	Обязательно
input_audio	объект		Да
└─ Данные	струна	Звуковые данные в кодировке Base64.	нет
└─ Формат	перечисление	Формат закодированных звуковых данных. В настоящее время поддерживается wav и mp3. Возможные значения: `wav`, `mp3`	нет
type	перечисление	Тип части содержимого. Всегда `input_audio`. Возможные значения: `input_audio`	Да

OpenAI.ChatCompletionRequestMessageContentPartFile

Имя.	Тип	Description	Обязательно
файл	объект		Да
└ file_data	струна	Данные файла, кодированные в формате Base64, используемые при передаче файла в модель в виде текстовой строки.	нет
└ file_id	струна	Идентификатор отправленного файла, который будет использоваться в качестве входных данных.	нет
└️ имя файла	струна	Имя файла, используемое при передаче файла в модель в виде строки.	нет
type	перечисление	Тип части содержимого. Всегда `file`. Возможные значения: `file`	Да

OpenAI.ChatCompletionRequestMessageContentPartImage

Имя.	Тип	Description	Обязательно
ссылка_на_изображение	объект		Да
└️ подробные сведения	перечисление	Указывает уровень детализации изображения. Возможные значения: `auto`, `lowhigh`	нет
└─ URL	струна	URL-адрес изображения или данных в кодировке Base64.	нет
type	перечисление	Тип части содержимого. Возможные значения: `image_url`	Да

OpenAI.ChatCompletionRequestMessageContentPartRefusal

Имя.	Тип	Description	Обязательно	По умолчанию
отказ	струна	Сообщение об отказе, созданное моделью.	Да
type	перечисление	Тип части содержимого. Возможные значения: `refusal`	Да

OpenAI.ChatCompletionRequestMessageContentPartText

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

OpenAI.ChatCompletionRequestMessageContentPartType

Недвижимость	Ценность
Тип	струна
Значения	`text` `file` `input_audio` `image_url` `refusal`

OpenAI.ChatCompletionRequestSystemMessage

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

Имя.	Тип	Description	Обязательно
содержимое	строка или массив		Да
имя	струна	Необязательное имя участника. Предоставляет сведения о модели, чтобы различать участников одной роли.	нет
роль	перечисление	Роль автора сообщений в данном случае `system`. Возможные значения: `system`	Да

OpenAI.ChatCompletionRequestSystemMessageContentPart

Ссылки: OpenAI.ChatCompletionRequestMessageContentPartText

OpenAI.ChatCompletionRequestToolMessage

Имя.	Тип	Description	Обязательно
содержимое	строка или массив		Да
роль	перечисление	Роль автора сообщений в данном случае `tool`. Возможные значения: `tool`	Да
идентификатор вызова инструмента	струна	Вызов средства, на который отвечает это сообщение.	Да

OpenAI.ChatCompletionRequestToolMessageContentPart

Ссылки: OpenAI.ChatCompletionRequestMessageContentPartText

OpenAI.ChatCompletionRequestUserMessage

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

Имя.	Тип	Description	Обязательно
содержимое	строка или массив		Да
имя	струна	Необязательное имя участника. Предоставляет сведения о модели, чтобы различать участников одной роли.	нет
роль	перечисление	Роль автора сообщений в данном случае `user`. Возможные значения: `user`	Да

OpenAI.ChatCompletionRequestUserMessageContentPart

Имя.	Тип	Description	Обязательно
файл	объект		Да
└ file_data	струна	Данные файла, кодированные в формате Base64, используемые при передаче файла в модель в виде текстовой строки.	нет
└ file_id	струна	Идентификатор отправленного файла, который будет использоваться в качестве входных данных.	нет
└️ имя файла	струна	Имя файла, используемое при передаче файла в модель в виде строки.	нет
ссылка_на_изображение	объект		Да
└️ подробные сведения	перечисление	Указывает уровень детализации изображения. Возможные значения: `auto`, `lowhigh`	нет
└─ URL	струна	URL-адрес изображения или данных в кодировке Base64.	нет
input_audio	объект		Да
└─ Данные	струна	Звуковые данные в кодировке Base64.	нет
└─ Формат	перечисление	Формат закодированных звуковых данных. В настоящее время поддерживается wav и mp3. Возможные значения: `wav`, `mp3`	нет
текст	струна	Текстовое содержимое.	Да
type	перечисление	Тип части содержимого. Всегда `file`. Возможные значения: `file`	Да

OpenAI.ChatCompletionRole

Роль автора сообщения

Недвижимость	Ценность
Описание	Роль автора сообщения
Тип	струна
Значения	`system` `developer` `user` `assistant` `tool` `function`

OpenAI.ChatCompletionStreamOptions

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

Имя.	Тип	Description	Обязательно	По умолчанию
включить_использование	булевый	Если задано, перед сообщением будет передаваться `data: [DONE]` дополнительный блок. Поле `usage` на этом блоке отображает статистику использования маркеров для всего запроса, и `choices` поле всегда будет пустым массивом. Все остальные блоки также будут содержать `usage` поле, но со значением NULL. ЗАМЕТКА: Если поток прерван, вы можете не получить последний блок данных об использовании, содержащий общие данные о количестве использованных токенов для запроса.	нет

OpenAI.ChatCompletionStreamResponseDelta

Разностное завершение чата, созданное потоковой передачей ответов модели.

Имя.	Тип	Description	Обязательно
audio	объект		нет
└─ Данные	струна		нет
└ истекает_в	целое число		нет
Идентификатор └️	струна		нет
└─ Расшифровка	струна		нет
содержимое	струна	Содержимое сообщения блока.	нет
вызов_функции	объект	Устаревшие и замененные `tool_calls`. Имя и аргументы вызываемой функции, созданной моделью.	нет
└─ аргументы	струна		нет
└️ имя	струна		нет
отказ	струна	Сообщение об отказе, созданное моделью.	нет
роль	объект	Роль автора сообщения	нет
вызовы инструментов	массив		нет

OpenAI.ChatCompletionTokenLogprob

Имя.	Тип	Description	Обязательно
байт	массив	Список целых чисел, представляющих представление маркера UTF-8 байт. Полезно в случаях, когда символы представлены несколькими токенами, а их байтовые представления должны объединяться для создания правильного текстового представления. Может быть `null` , если для маркера нет представления байтов.	Да
logprob	число/номер	Вероятность этого маркера журнала, если она находится в пределах 20 наиболее вероятных маркеров. В противном случае значение `-9999.0` используется для обозначения того, что маркер очень маловероятно.	Да
token	струна	Маркер.	Да
top_logprobs	массив	Список наиболее вероятных маркеров и их вероятности журналов в этой позиции маркера. В редких случаях количество запрошенных `top_logprobs` возвращаемых данных может быть меньше.	Да

Инструмент завершения чата OpenAI

Имя.	Тип	Description	Обязательно	По умолчанию
function	OpenAI.FunctionObject		Да
type	перечисление	Тип средства. В настоящее время поддерживается только `function` . Возможные значения: `function`	Да

OpenAI.ChatCompletionToolChoiceOption

Определяет, какое средство (если таковое) вызывается моделью. none означает, что модель не будет вызывать какое-либо средство и вместо этого создает сообщение. auto означает, что модель может выбирать между созданием сообщения или вызовом одного или нескольких инструментов. required означает, что модель должна вызывать один или несколько инструментов. Указание определенного средства с помощью {"type": "function", "function": {"name": "my_function"}} принудительного вызова этого средства моделью.

none значение по умолчанию, если средства отсутствуют. auto значение по умолчанию, если существуют средства.

Имя.	Тип	Description	Обязательно
function	объект		Да
└️ имя	струна	Имя вызываемой функции.	нет
type	перечисление	Тип средства. В настоящее время поддерживается только `function` . Возможные значения: `function`	Да

OpenAI.ChatOutputPrediction

Базовое представление прогнозируемых выходных данных модели.

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

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

Значение типа	Схема
`content`	OpenAI.ChatOutputPredictionContent

Имя.	Тип	Description	Обязательно	По умолчанию
type	OpenAI.ChatOutputPredictionType		Да

OpenAI.ChatOutputPredictionContent

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

Имя.	Тип	Description	Обязательно	По умолчанию
содержимое	строка или массив		Да
type	перечисление	Тип прогнозируемого содержимого, который требуется предоставить. Этот тип в настоящее время всегда `content`. Возможные значения: `content`	Да

OpenAI.ChatOutputPredictionType

Недвижимость	Ценность
Тип	струна
Значения	`content`

OpenAI.ChunkingStrategyRequestParam

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

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

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

Значение типа	Схема
`static`	OpenAI.StaticChunkingStrategyRequestParam

Имя.	Тип	Description	Обязательно	По умолчанию
type	перечисление	Тип стратегии блокирования. Возможные значения: `auto`, `static`	Да

OpenAI.ChunkingStrategyResponseParam

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

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

Значение типа	Схема
`other`	OpenAI.OtherChunkingStrategyResponseParam
`static`	OpenAI.StaticChunkingStrategyResponseParam

Имя.	Тип	Description	Обязательно	По умолчанию
type	перечисление	Возможные значения: `static`, `other`	Да

OpenAI.CodeInterpreterOutput

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

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

Значение типа	Схема
`image`	OpenAI.CodeInterpreterOutputImage
`logs`	OpenAI.CodeInterpreterOutputLogs

Имя.	Тип	Description	Обязательно	По умолчанию
type	OpenAI.CodeInterpreterOutputType		Да

OpenAI.CodeInterpreterOutputImage

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

Имя.	Тип	Description	Обязательно	По умолчанию
type	перечисление	Тип выходных данных. Всегда "изображение". Возможные значения: `image`	Да
URL-адрес	струна	URL-адрес выходных данных изображения из интерпретатора кода.	Да

OpenAI.CodeInterpreterOutputLogs

Журналы, выходные данные интерпретатора кода.

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

OpenAI.CodeInterpreterOutputType

Недвижимость	Ценность
Тип	струна
Значения	`logs` `image`

OpenAI.CodeInterpreterTool

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

Имя.	Тип	Description	Обязательно
container	объект	Настройка контейнера интерпретатора кода. При необходимости укажите идентификаторы файлов для запуска кода.	Да
└ file_ids	массив	Необязательный список загруженных файлов для использования в вашем коде.	нет
└─ Тип	перечисление	Всегда `auto`. Возможные значения: `auto`	нет
type	перечисление	Тип средства интерпретатора кода. Всегда `code_interpreter`. Возможные значения: `code_interpreter`	Да

OpenAI.CodeInterpreterToolAuto

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

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

OpenAI.CodeInterpreterToolCallItemParam

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

Имя.	Тип	Description	Обязательно
код	струна	Код для запуска или null, если он недоступен.	Да
container_id	струна	Идентификатор контейнера, используемого для запуска кода.	Да
выходные данные	массив	Выходные данные, созданные интерпретатором кода, такими как журналы или изображения. Может иметь значение NULL, если выходные данные недоступны.	Да
type	перечисление	Возможные значения: `code_interpreter_call`	Да

OpenAI.CodeInterpreterToolCallItemResource

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

Имя.	Тип	Description	Обязательно
код	струна	Код для запуска или null, если он недоступен.	Да
container_id	струна	Идентификатор контейнера, используемого для запуска кода.	Да
выходные данные	массив	Выходные данные, созданные интерпретатором кода, такими как журналы или изображения. Может иметь значение NULL, если выходные данные недоступны.	Да
статус	перечисление	Возможные значения: `in_progress`, `completed`, `incomplete`, `interpreting`, `failed`	Да
type	перечисление	Возможные значения: `code_interpreter_call`	Да

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

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

Имя.	Тип	Description	Обязательно
ключ	струна	Ключ для сопоставления со значением.	Да
type	перечисление	Указывает оператор сравнения: `eq`, `ne`, `gt`, `gte`, `lt`. `lte` - `eq`: Равно - `ne`: не равно - `gt`: больше чем - `gte`: больше или равно - `lt`:Менее - `lte`: меньше или равно. Возможные значения: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`	Да
value	строка или число или логическое значение		Да

OpenAI.CompletionUsage

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

Имя.	Тип	Description	Обязательно	По умолчанию
токены завершения	целое число	Количество маркеров в созданном завершении.	Да	0
детали_токенов_завершения	объект	Разбивка маркеров, используемых в завершении.	нет
└️ accepted_prediction_tokens	целое число	При использовании прогнозируемых выходных данных число маркеров в прогнозе, появившемся в завершении.	нет	0
└audio_tokens	целое число	Маркеры ввода звука, созданные моделью.	нет	0
└️ reasoning_tokens	целое число	Маркеры, созданные моделью для рассуждений.	нет	0
└─ отклонённые_токены_предсказания	целое число	При использовании прогнозируемых выходных данных число маркеров в прогнозе, которое не отображалось в завершении. Однако, как и маркеры причин, эти маркеры по-прежнему учитываются в общих маркерах завершения для целей выставления счетов, выходных данных и контекстного окна.	нет	0
подсказывающие токены	целое число	Количество маркеров в запросе.	Да	0
prompt_tokens_details	объект	Разбивка токенов, используемых в запросе.	нет
└audio_tokens	целое число	Маркеры ввода звука, представленные в запросе.	нет	0
└ cached_tokens	целое число	Кэшированные маркеры присутствуют в запросе.	нет	0
общее количество токенов	целое число	Общее количество маркеров, используемых в запросе (запрос + завершение).	Да	0

OpenAI.CompoundFilter

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

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

OpenAI.ComputerAction

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

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

Значение типа	Схема
`click`	OpenAI.ComputerActionClick
`double_click`	OpenAI.ComputerActionDoubleClick
`drag`	OpenAI.ComputerActionDrag
`move`	OpenAI.ComputerActionMove
`screenshot`	OpenAI.ComputerActionScreenshot
`scroll`	OpenAI.ComputerActionScroll
`type`	OpenAI.ComputerActionTypeKeys
`wait`	OpenAI.ComputerActionWait
`keypress`	OpenAI.ComputerActionKeyPress

Имя.	Тип	Description	Обязательно	По умолчанию
type	OpenAI.ComputerActionType		Да

OpenAI.ComputerActionClick

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

Имя.	Тип	Description	Обязательно
button	перечисление	Указывает, какая кнопка мыши была нажата во время нажатия кнопки. Одно из значений `left`, `right`, `wheel`, `back` или `forward`. Возможные значения: `left`, `right`, `wheel`, `back`, `forward`	Да
type	перечисление	Указывает тип события. Для действия щелчка это свойство всегда имеет значение `click`. Возможные значения: `click`	Да
x	целое число	Координата x, в которой произошло нажатие.	Да
и	целое число	Координата y, в которой произошло нажатие.	Да

OpenAI.ComputerActionDoubleClick

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

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

OpenAI.ComputerActionDrag

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

Имя.	Тип	Description	Обязательно	По умолчанию
путь	массив	Массив координат, представляющий путь действия перетаскивания. Координаты будут отображаться в виде массива объектов, например`{ x: 100, y: 200 }, { x: 200, y: 300 }`	Да
type	перечисление	Указывает тип события. Для действия перетаскивания это свойство всегда имеет значение `drag`. Возможные значения: `drag`	Да

OpenAI.ComputerActionKeyPress

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

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

OpenAI.ComputerActionMove

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

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

OpenAI.ComputerActionScreenshot

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

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

OpenAI.ComputerActionScroll

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

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

OpenAI.ComputerActionType

Недвижимость	Ценность
Тип	струна
Значения	`screenshot` `click` `double_click` `scroll` `type` `wait` `keypress` `drag` `move`

OpenAI.ComputerActionTypeKeys

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

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

OpenAI.ComputerActionWait

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

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

OpenAI.ComputerToolCallItemParam

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

Имя.	Тип	Description	Обязательно
действие	OpenAI.ComputerAction		Да
call_id	струна	Идентификатор, используемый при реагировании на вызов инструмента с выходными данными.	Да
pending_safety_checks	массив	Ожидающие проверки безопасности для компьютеризированного процесса.	Да
type	перечисление	Возможные значения: `computer_call`	Да

OpenAI.ComputerToolCallItemResource

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

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

OpenAI.ComputerToolCallOutputItemOutput

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

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

Значение типа	Схема
`computer_screenshot`	OpenAI.ComputerToolCallOutputItemOutputComputerScreenshot

Имя.	Тип	Description	Обязательно	По умолчанию
type	OpenAI.ComputerToolCallOutputItemOutputType	Снимок экрана компьютера, используемый с помощью инструмента для использования компьютера.	Да

OpenAI.ComputerToolCallOutputItemOutputComputerScreenshot

Имя.	Тип	Description	Обязательно
идентификатор_файла	струна		нет
ссылка_на_изображение	струна		нет
type	перечисление	Возможные значения: `computer_screenshot`	Да

OpenAI.ComputerToolCallOutputItemOutputType

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

Недвижимость	Ценность
Описание	Снимок экрана компьютера, используемый с помощью инструмента для использования компьютера.
Тип	струна
Значения	`computer_screenshot`

OpenAI.ComputerToolCallOutputItemParam

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

Имя.	Тип	Description	Обязательно
acknowledged_safety_checks	массив	API сообщила о проверках безопасности, которые были подтверждены разработчиком.	нет
call_id	струна	Идентификатор вызова средства компьютера, создающего выходные данные.	Да
output	OpenAI.ComputerToolCallOutputItemOutput		Да
type	перечисление	Возможные значения: `computer_call_output`	Да

OpenAI.ComputerToolCallOutputItemResource

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

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

OpenAI.ComputerToolCallSafetyCheck

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

Имя.	Тип	Description	Обязательно
код	струна	Тип ожидающей проверки безопасности.	Да
id	струна	Идентификатор ожидающей проверки безопасности.	Да
сообщение	струна	Сведения об этой ожидающейся проверке безопасности.	Да

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

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

Имя.	Тип	Description	Обязательно
высота дисплея	целое число	Высота дисплея компьютера.	Да
ширина дисплея	целое число	Ширина дисплея компьютера.	Да
environment	перечисление	Тип управляемой компьютерной среды. Возможные значения: `windows`, `mac`, `linux`, `ubuntu`, `browser`	Да
type	перечисление	Тип средства использования компьютера. Всегда `computer_use_preview`. Возможные значения: `computer_use_preview`	Да

OpenAI.Coordinate

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

Имя.	Тип	Description	Обязательно	По умолчанию
x	целое число	Координата x.	Да
и	целое число	Координата y.	Да

OpenAI.CreateEmbeddingResponse

Имя.	Тип	Description	Обязательно
данные	массив	Список внедрения, созданных моделью.	Да
модель	струна	Имя модели, используемой для создания внедрения.	Да
объект	перечисление	Тип объекта, который всегда является "list". Возможные значения: `list`	Да
использование	объект	Сведения об использовании запроса.	Да
└─ токены_запроса	целое число	Количество маркеров, используемых запросом.	нет
└️ всего_токенов	целое число	Общее количество маркеров, используемых запросом.	нет

OpenAI.CreateEvalItem

Сообщение чата, включающее запрос или контекст. Может содержать ссылки на переменные в item пространство имен, т. е. {{item.name}}.

Имя.	Тип	Description	Обязательно
содержимое	string или OpenAI.EvalItemContent	Текстовые входные данные модели могут содержать строки шаблона.	Да
роль	перечисление	Роль входных данных сообщения. Один из `user`, `assistantsystem`или `developer`. Возможные значения: `user`, , `assistantsystemdeveloper`	Да
type	перечисление	Тип входных данных сообщения. Всегда `message`. Возможные значения: `message`	нет

OpenAI.CreateEvalRunRequest

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

OpenAI.CreateFineTuningJobRequest

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

babbage-002
davinci-002
gpt-3.5-turbo
gpt-4o-mini

Имя.	Тип	Description	Обязательно	По умолчанию
гиперпараметры	объект	Гиперпараметры, используемые для задания тонкой настройки. Это значение теперь устарело в пользу `method`и должно передаваться в соответствии с параметром `method` .	нет
└batch_size	перечисление	Возможные значения: `auto`	нет
└learning_rate_multiplier learning_rate_multiplier	перечисление	Возможные значения: `auto`	нет
└️ n_epochs	перечисление	Возможные значения: `auto`	нет
Интеграции	массив	Список интеграции для задания тонкой настройки.	нет
metadata	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате и запроса на объекты через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — это строки с максимальной длиной 512 символов.	нет
method	OpenAI.FineTuneMethod	Метод, используемый для точной настройки.	нет
модель	строка (см. допустимые модели ниже)	Имя модели для точной настройки.	Да
seed	целое число	Сид определяет воспроизводимость задания. Передача одинаковых параметров начального значения и заданий должна иметь одинаковые результаты, но может отличаться в редких случаях. Если начальное значение не указано, он будет создан для вас.	нет
Суффикс	струна	Строка до 64 символов, которые будут добавлены в имя настраиваемой модели. Например, `suffix` в поле "Custom-model-name" будет производиться имя модели, например `ft:gpt-4o-mini:openai:custom-model-name:7p4lURel`.	нет	None
файл_обучения	струна	Идентификатор отправленного файла, содержащего данные обучения. Набор данных должен быть отформатирован в формате JSONL-файла. Кроме того, необходимо передать файл с целью `fine-tune`. Содержимое файла должно отличаться в зависимости от того, использует ли модель чат, формат завершения или использует ли метод тонкой настройки формат предпочтения.	Да
Файл_валидации	струна	Идентификатор отправленного файла, содержащего данные проверки. Если вы предоставляете этот файл, данные используются для периодического создания метрик валидации во время точной настройки. Эти показатели можно просмотреть в файле результатов тонкой настройки. Одни и те же данные не должны присутствовать в файлах обучения и проверки. Набор данных должен быть отформатирован в формате JSONL-файла. Необходимо отправить файл с целью `fine-tune`.	нет

OpenAI.CreateFineTuningJobRequestIntegration

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

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

Значение типа	Схема
`wandb`	OpenAI.CreateFineTuningJobRequestWandbIntegration

Имя.	Тип	Description	Обязательно	По умолчанию
type	строка (см. допустимые модели ниже)		Да

OpenAI.CreateFineTuningJobRequestWandbIntegration

Имя.	Тип	Description	Обязательно
type	перечисление	Возможные значения: `wandb`	Да
wandb	объект		Да
Сущность └️	струна		нет
└️ имя	струна		нет
└️ project	струна		нет
Теги └️	массив		нет

OpenAI.CreateVectorStoreFileBatchRequest

Имя.	Тип	Description	Обязательно
attributes	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате и запроса на объекты через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения могут быть строками с максимальной длиной 512 символов, логическими значениями или числами.	нет
chunking_strategy	OpenAI.ChunkingStrategyRequestParam	Стратегия блокирования, используемая для блокирования файлов. Если этот параметр не задан, используйте стратегию `auto` .	нет
идентификаторы_файлов	массив	Список идентификаторов файлов, которые следует использовать векторным хранилищем. Полезно для таких средств, как `file_search`, которые могут access файлов.	Да

OpenAI.CreateVectorStoreFileRequest

Имя.	Тип	Description	Обязательно
attributes	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате и запроса на объекты через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения могут быть строками с максимальной длиной 512 символов, логическими значениями или числами.	нет
chunking_strategy	OpenAI.ChunkingStrategyRequestParam	Стратегия блокирования, используемая для блокирования файлов. Если этот параметр не задан, используйте стратегию `auto` .	нет
идентификатор_файла	струна	Идентификатор файла, который должен использовать хранилище векторов. Полезно для таких средств, как `file_search`, которые могут access файлов.	Да

OpenAI.CreateVectorStoreRequest

Имя.	Тип	Description	Обязательно
chunking_strategy	объект	Стратегия по умолчанию. В настоящее время эта стратегия использует и `max_chunk_size_tokens` имеет значение `800chunk_overlap_tokens` .`400`	нет
└️ статический	OpenAI.StaticChunkingStrategy		нет
└─ Тип	перечисление	Всегда `static`. Возможные значения: `static`	нет
истекает через	OpenAI.VectorStoreExpirationAfter	Политика истечения срока действия для хранилища векторов.	нет
идентификаторы_файлов	массив	Список идентификаторов файлов, которые следует использовать векторным хранилищем. Полезно для таких средств, как `file_search`, которые могут access файлов.	нет
metadata	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате и запроса на объекты через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — это строки с максимальной длиной 512 символов.	нет
имя	струна	Имя векторного хранилища.	нет

OpenAI.DeleteFileResponse

Имя.	Тип	Description	Обязательно
удалено	булевый		Да
id	струна		Да
объект	перечисление	Возможные значения: `file`	Да

OpenAI.DeleteVectorStoreFileResponse

Имя.	Тип	Description	Обязательно
удалено	булевый		Да
id	струна		Да
объект	перечисление	Возможные значения: `vector_store.file.deleted`	Да

OpenAI.DeleteVectorStoreResponse

Имя.	Тип	Description	Обязательно
удалено	булевый		Да
id	струна		Да
объект	перечисление	Возможные значения: `vector_store.deleted`	Да

OpenAI.Embedding

Представляет собой вектор эмбеддинга, возвращаемый конечной точкой эмбеддинга.

Имя.	Тип	Description	Обязательно
embedding	массив или строка		Да
index	целое число	Индекс внедрения в список внедрения.	Да
объект	перечисление	Тип объекта, который всегда является внедрением. Возможные значения: `embedding`	Да

OpenAI.Eval

Объект Eval с конфигурацией источника данных и критериями тестирования. Eval представляет задачу для интеграции LLM. Любить:

Улучшение качества чат-бота
Узнайте, как хорошо мой чат-бот обрабатывает поддержку клиентов
Проверьте, лучше ли o4-mini в моем регистре использования, чем gpt-4o

Имя.	Тип	Description	Обязательно	По умолчанию
создано_в	целое число	Метка времени Unix (в секундах) для момента создания eval.	Да
настройка_источника_данных	объект		Да
└─ Тип	OpenAI.EvalDataSourceConfigType		нет
id	струна	Уникальный идентификатор для оценки.	Да
metadata	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате и запроса на объекты через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — это строки с максимальной длиной 512 символов.	Да
имя	струна	Имя оценки.	Да
объект	перечисление	Тип объекта. Возможные значения: `eval`	Да
критерии тестирования	массив	Список критериев тестирования.	Да	None

OpenAI.EvalApiError

Объект, представляющий ответ об ошибке из API Eval.

Имя.	Тип	Description	Обязательно	По умолчанию
код	струна	Код ошибки.	Да
сообщение	струна	Сообщение об ошибке.	Да

OpenAI.EvalCompletionsRunDataSourceParams

Объект CompletionsRunDataSource, описывающий конфигурацию выборки модели.

Имя.	Тип	Description	Обязательно
входные_сообщения	объект		нет
└─ ссылка_на_элемент	струна	Ссылка на переменную в `item` пространстве имен. Т.е., "item.input_trajectory"	нет
└─ Шаблон	массив	Список сообщений чата, который формирует запрос или контекст. Может содержать ссылки на переменные в `item` пространство имен, т. е. {{item.name}}.	нет
└─ Тип	перечисление	Тип входных сообщений. Всегда `item_reference`. Возможные значения: `item_reference`	нет
модель	струна	Имя модели, используемой для создания завершений (например, o3-mini).	нет
параметры выборки	AzureEvalAPICompletionsSamplingParams		нет
Источник	объект		Да
└─ Содержимое	массив	Содержимое jsonl-файла.	нет
└created_after	целое число	Необязательная метка времени Unix для фильтрации элементов, созданных после этого времени.	нет
└created_before	целое число	Необязательная метка времени Unix для фильтрации элементов, созданных до этого времени.	нет
Идентификатор └️	струна	Идентификатор файла.	нет
Ограничение └️	целое число	Необязательное максимальное количество возвращаемых элементов.	нет
└─ Метаданные	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате и запроса на объекты через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — это строки с максимальной длиной 512 символов.	нет
└─ Модель	струна	Необязательная модель для фильтрации (например, gpt-4o).	нет
└─ Тип	перечисление	Тип источника . Всегда `stored_completions`. Возможные значения: `stored_completions`	нет
type	перечисление	Тип источника данных запуска. Всегда `completions`. Возможные значения: `completions`	Да

OpenAI.EvalCustomDataSourceConfigParams

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

Используется для определения критериев тестирования и
Какие данные требуются при создании запуска

Имя.	Тип	Description	Обязательно	По умолчанию
включить_пример_схемы	булевый	Должен ли eval ожидать, что вы заполните пространство имен образца (т. е. создавая ответы на основе вашего источника данных)	нет	Неправда
схема_элемента	объект	Схема JSON для каждой строки в источнике данных.	Да
type	перечисление	Тип источника данных. Всегда `custom`. Возможные значения: `custom`	Да

OpenAI.EvalCustomDataSourceConfigResource

CustomDataSourceConfig, указывающий схему ваших item и при необходимости sample пространств имен. Схема ответа определяет форму данных, которые будут:

Используется для определения критериев тестирования и
Какие данные требуются при создании запуска

Имя.	Тип	Description	Обязательно	По умолчанию
schema	объект	Схема JSON для элементов источника данных запуска. Узнайте, как создать схемы JSON здесь.	Да
type	перечисление	Тип источника данных. Всегда `custom`. Возможные значения: `custom`	Да

OpenAI.EvalDataSourceConfigParams

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

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

Значение типа	Схема
`custom`	OpenAI.EvalCustomDataSourceConfigParams
`logs`	OpenAI.EvalLogsDataSourceConfigParams
`stored_completions`	OpenAI.EvalStoredCompletionsDataSourceConfigParams

Имя.	Тип	Description	Обязательно	По умолчанию
type	OpenAI.EvalDataSourceConfigType		Да

OpenAI.EvalDataSourceConfigResource

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

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

Значение типа	Схема
`custom`	OpenAI.EvalCustomDataSourceConfigResource
`stored_completions`	OpenAI.EvalStoredCompletionsDataSourceConfigResource
`logs`	OpenAI.EvalLogsDataSourceConfigResource

Имя.	Тип	Description	Обязательно	По умолчанию
type	OpenAI.EvalDataSourceConfigType		Да

OpenAI.EvalDataSourceConfigType

Недвижимость	Ценность
Тип	струна
Значения	`custom` `logs` `stored_completions`

OpenAI.EvalGraderLabelModelParams

Объект LabelModelGrader, использующий модель для назначения меток каждому элементу в оценке.

Имя.	Тип	Description	Обязательно
ввод	массив	Список сообщений чата, который формирует запрос или контекст. Может содержать ссылки на переменные в `item` пространство имен, т. е. {{item.name}}.	Да
labels	массив	Метки для классификации каждого элемента в оценке.	Да
модель	струна	Модель, используемая для оценки. Должен поддерживать структурированные выходные данные.	Да
имя	струна	Имя классировщика.	Да
передача_меток	массив	Метки, указывающие на успешный результат. Должно быть подмножеством этих меток.	Да
type	перечисление	Тип объекта, который всегда `label_model`является . Возможные значения: `label_model`	Да

OpenAI.EvalGraderLabelModelResource

Имя.	Тип	Description	Обязательно
ввод	массив		Да
labels	массив	Метки, назначенные каждому элементу в оценке.	Да
модель	струна	Модель, используемая для оценки. Должен поддерживать структурированные выходные данные.	Да
имя	струна	Имя классировщика.	Да
передача_меток	массив	Метки, указывающие на успешный результат. Должно быть подмножеством этих меток.	Да
type	перечисление	Тип объекта, который всегда `label_model`является . Возможные значения: `label_model`	Да

OpenAI.EvalGraderParams

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

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

Значение типа	Схема
`label_model`	OpenAI.EvalGraderLabelModelParams
`string_check`	OpenAI.EvalGraderStringCheckParams
`text_similarity`	OpenAI.EvalGraderTextSimilarityParams
`python`	OpenAI.EvalGraderPythonParams
`score_model`	OpenAI.EvalGraderScoreModelParams

Имя.	Тип	Description	Обязательно	По умолчанию
type	OpenAI.GraderType		Да

OpenAI.EvalGraderPythonParams

Имя.	Тип	Description	Обязательно
image_tag	струна	Тег изображения, используемый для скрипта Python.	нет
имя	струна	Имя классировщика.	Да
порог_прохода	число/номер	Пороговое значение для оценки.	нет
Источник	струна	Исходный код скрипта Python.	Да
type	перечисление	Тип объекта, который всегда `python`является . Возможные значения: `python`	Да

OpenAI.EvalGraderPythonResource

Имя.	Тип	Description	Обязательно
image_tag	струна	Тег изображения, используемый для скрипта Python.	нет
имя	струна	Имя классировщика.	Да
порог_прохода	число/номер	Пороговое значение для оценки.	нет
Источник	струна	Исходный код скрипта Python.	Да
type	перечисление	Тип объекта, который всегда `python`является . Возможные значения: `python`	Да

OpenAI.EvalGraderResource

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

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

Значение типа	Схема
`label_model`	OpenAI.EvalGraderLabelModelResource
`text_similarity`	OpenAI.EvalGraderTextSimilarityResource
`python`	OpenAI.EvalGraderPythonResource
`score_model`	OpenAI.EvalGraderScoreModelResource

Имя.	Тип	Description	Обязательно	По умолчанию
type	OpenAI.GraderType		Да

OpenAI.EvalGraderScoreModelParams

Имя.	Тип	Description	Обязательно
ввод	массив	Входной текст. Это может включать строки шаблона.	Да
модель	струна	Модель, используемая для оценки.	Да
имя	струна	Имя классировщика.	Да
порог_прохода	число/номер	Пороговое значение для оценки.	нет
диапазон	массив	Диапазон оценки. По умолчанию — `[0, 1]`.	нет
параметры выборки		Параметры выборки для модели.	нет
type	перечисление	Тип объекта, который всегда `score_model`является . Возможные значения: `score_model`	Да

OpenAI.EvalGraderScoreModelResource

Имя.	Тип	Description	Обязательно
ввод	массив	Входной текст. Это может включать строки шаблона.	Да
модель	струна	Модель, используемая для оценки.	Да
имя	струна	Имя классировщика.	Да
порог_прохода	число/номер	Пороговое значение для оценки.	нет
диапазон	массив	Диапазон оценки. По умолчанию — `[0, 1]`.	нет
параметры выборки		Параметры выборки для модели.	нет
type	перечисление	Тип объекта, который всегда `score_model`является . Возможные значения: `score_model`	Да

OpenAI.EvalGraderStringCheckParams

Имя.	Тип	Description	Обязательно
ввод	струна	Входной текст. Это может включать строки шаблона.	Да
имя	струна	Имя классировщика.	Да
Операция	перечисление	Операция проверки строки, которую нужно выполнить. Один из `eq`, `nelike`или `ilike`. Возможные значения: `eq`, , `nelikeilike`	Да
Ссылка	струна	Текст ссылки. Это может включать строки шаблона.	Да
type	перечисление	Тип объекта, который всегда `string_check`является . Возможные значения: `string_check`	Да

OpenAI.EvalGraderTextSimilarityParams

Имя.	Тип	Description	Обязательно
метрика оценки	перечисление	Используемая метрика оценки. Один из `fuzzy_match`, `bleu`, `gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`, или `rouge_l`. Возможные значения: `fuzzy_match`, `bleu`, `gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`, `rouge_l`	Да
ввод	струна	Текст, оцениваемый.	Да
имя	струна	Имя классировщика.	Да
порог_прохода	число/номер	Пороговое значение для оценки.	Да
Ссылка	струна	Текст, классируемый против.	Да
type	перечисление	Тип классировщика. Возможные значения: `text_similarity`	Да

OpenAI.EvalGraderTextSimilarityResource

Имя.	Тип	Description	Обязательно
метрика оценки	перечисление	Используемая метрика оценки. Один из `fuzzy_match`, `bleu`, `gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`, или `rouge_l`. Возможные значения: `fuzzy_match`, `bleu`, `gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`, `rouge_l`	Да
ввод	струна	Текст, оцениваемый.	Да
имя	струна	Имя классировщика.	Да
порог_прохода	число/номер	Пороговое значение для оценки.	Да
Ссылка	струна	Текст, классируемый против.	Да
type	перечисление	Тип классировщика. Возможные значения: `text_similarity`	Да

OpenAI.EvalItem

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

Имя.	Тип	Description	Обязательно
содержимое	объект		Да
└─ Тип	OpenAI.EvalItemContentType		нет
роль	перечисление	Роль входных данных сообщения. Один из `user`, `assistantsystem`или `developer`. Возможные значения: `user`, , `assistantsystemdeveloper`	Да
type	перечисление	Тип входных данных сообщения. Всегда `message`. Возможные значения: `message`	нет

OpenAI.EvalItemContent

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

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

Значение типа	Схема
`input_text`	OpenAI.EvalItemContentInputText
`output_text`	OpenAI.EvalItemContentOutputText

Имя.	Тип	Description	Обязательно	По умолчанию
type	OpenAI.EvalItemContentType		Да

OpenAI.EvalItemContentInputText

Имя.	Тип	Description	Обязательно	По умолчанию
текст	струна		Да
type	перечисление	Возможные значения: `input_text`	Да

OpenAI.EvalItemContentOutputText

Имя.	Тип	Description	Обязательно	По умолчанию
текст	струна		Да
type	перечисление	Возможные значения: `output_text`	Да

OpenAI.EvalItemContentType

Недвижимость	Ценность
Тип	струна
Значения	`input_text` `output_text`

OpenAI.EvalJsonlRunDataSourceParams

Объект JsonlRunDataSource, указывающий JSONL-файл, соответствующий оценке.

Имя.	Тип	Description	Обязательно
Источник	объект		Да
└─ Содержимое	массив	Содержимое jsonl-файла.	нет
Идентификатор └️	струна	Идентификатор файла.	нет
└─ Тип	перечисление	Тип источника jsonl. Всегда `file_id`. Возможные значения: `file_id`	нет
type	перечисление	Тип источника данных. Всегда `jsonl`. Возможные значения: `jsonl`	Да

OpenAI.EvalList

Объект, представляющий список оценок.

Имя.	Тип	Description	Обязательно
данные	массив	Массив объектов eval.	Да
первый_идентификатор	струна	Идентификатор первой функции eval в массиве данных.	Да
есть_еще	булевый	Указывает, доступны ли дополнительные оценки.	Да
last_id	струна	Идентификатор последнего eval в массиве данных.	Да
объект	перечисление	Тип этого объекта. Для него всегда задано значение list. Возможные значения: `list`	Да

OpenAI.EvalLogsDataSourceConfigParams

Конфигурация источника данных, указывающая свойство метаданных запроса журналов. Обычно это метаданные, такие как usecase=chatbot или prompt-version=v2и т. д.

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

OpenAI.EvalLogsDataSourceConfigResource

LogsDataSourceConfig, указывающий свойство метаданных запроса журналов. Обычно это метаданные, такие как usecase=chatbot или prompt-version=v2и т. д. Схема, возвращаемая этой конфигурацией источника данных, используется для определения переменных, доступных в оценках. item и sample определяются при использовании этой конфигурации источника данных.

Имя.	Тип	Description	Обязательно
metadata	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате и запроса на объекты через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — это строки с максимальной длиной 512 символов.	Да
schema	объект	Схема JSON для элементов источника данных запуска. Узнайте, как создать схемы JSON здесь.	Да
type	перечисление	Тип источника данных. Всегда `logs`. Возможные значения: `logs`	Да

OpenAI.EvalResponsesRunDataSourceParams

Объект ResponsesRunDataSource, описывающий конфигурацию выборки модели.

Имя.	Тип	Description	Обязательно
входные_сообщения	объект		нет
└─ ссылка_на_элемент	струна	Ссылка на переменную в `item` пространстве имен. Т.е., "item.name"	нет
└─ Шаблон	массив	Список сообщений чата, который формирует запрос или контекст. Может содержать ссылки на переменные в `item` пространство имен, т. е. {{item.name}}.	нет
└─ Тип	перечисление	Тип входных сообщений. Всегда `item_reference`. Возможные значения: `item_reference`	нет
модель	струна	Имя модели, используемой для создания завершений (например, o3-mini).	нет
параметры выборки	AzureEvalAPIResponseSamplingParams		нет
Источник	объект		Да
└─ Содержимое	массив	Содержимое jsonl-файла.	нет
└created_after	целое число	Включайте только элементы, созданные после этого метки времени (включительно). Это параметр запроса, используемый для выбора ответов.	нет
└created_before	целое число	Включайте только элементы, созданные до этого метки времени (включительно). Это параметр запроса, используемый для выбора ответов.	нет
Идентификатор └️	струна	Идентификатор файла.	нет
└instructions_search	струна	Необязательная строка для поиска в поле "инструкции". Это параметр запроса, используемый для выбора ответов.	нет
└─ Метаданные	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате и запроса на объекты через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — это строки с максимальной длиной 512 символов.	нет
└─ Модель	струна	Имя модели для поиска ответов. Это параметр запроса, используемый для выбора ответов.	нет
└reasoning_effort	OpenAI.ReasoningEffort	Необязательный параметр усилий по соображениям. Это параметр запроса, используемый для выбора ответов.	нет
└─ Температура	число/номер	Температура выборки. Это параметр запроса, используемый для выбора ответов.	нет
└─ Инструменты	массив	Список имен инструментов. Это параметр запроса, используемый для выбора ответов.	нет
└️ top_p	число/номер	Параметр выборки ядра. Это параметр запроса, используемый для выбора ответов.	нет
└─ Тип	перечисление	Тип источника данных запуска. Всегда `responses`. Возможные значения: `responses`	нет
Пользователи └️	массив	Список идентификаторов пользователей. Это параметр запроса, используемый для выбора ответов.	нет
type	перечисление	Тип источника данных запуска. Всегда `responses`. Возможные значения: `responses`	Да

OpenAI.EvalRun

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

Имя.	Тип	Description	Обязательно
создано_в	целое число	Метка времени Unix (в секундах) при создании запуска оценки.	Да
источник данных	объект		Да
└─ Тип	OpenAI.EvalRunDataSourceType		нет
ошибка	OpenAI.EvalApiError	Объект, представляющий ответ об ошибке из API Eval.	Да
eval_id	струна	Идентификатор ассоциированной оценки.	Да
id	струна	Уникальный идентификатор для оценочной сессии.	Да
metadata	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате и запроса на объекты через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — это строки с максимальной длиной 512 символов.	Да
модель	струна	Модель, подлежащая оценке, если применимо.	Да
имя	струна	Название сеанса оценки.	Да
объект	перечисление	Тип объекта . Всегда "eval.run". Возможные значения: `eval.run`	Да
использование_на_модель	массив	Статистика использования для каждой модели во время выполнения оценки.	Да
результаты_по_критериям_тестирования	массив	Результаты для каждого критерия тестирования, применяемые во время выполнения оценки.	Да
report_url	струна	URL-адрес отчета о визуализации результатов выполнения оценочного запуска на панели мониторинга пользовательского интерфейса.	Да
количество_результатов	объект	Счетчики, обобщающие результаты выполнения оценки.	Да
Ошибка	целое число	Количество выходных элементов, которые привели к ошибке.	нет
└─ Ошибка	целое число	Количество выходных элементов, которые не прошли оценку.	нет
├─ прошло	целое число	Количество выходных элементов, которые прошли оценку.	нет
└─ всего	целое число	Общее количество выполненных выходных элементов.	нет
статус	струна	Состояние выполнения оценки.	Да

OpenAI.EvalRunDataContentSource

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

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

Значение типа	Схема
`file_id`	OpenAI.EvalRunFileIdDataContentSource
`stored_completions`	OpenAI.EvalRunStoredCompletionsDataContentSource
`responses`	OpenAI.EvalRunResponsesDataContentSource

Имя.	Тип	Description	Обязательно	По умолчанию
type	OpenAI.EvalRunDataContentSourceType		Да

OpenAI.EvalRunDataContentSourceType

Недвижимость	Ценность
Тип	струна
Значения	`file_id` `file_content` `stored_completions` `responses`

OpenAI.EvalRunDataSourceCompletionsResource

Имя.	Тип	Description	Обязательно	По умолчанию
type	перечисление	Возможные значения: `completions`	Да

OpenAI.EvalRunDataSourceJsonlResource

Имя.	Тип	Description	Обязательно	По умолчанию
type	перечисление	Возможные значения: `jsonl`	Да

OpenAI.EvalRunDataSourceParams

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

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

Значение типа	Схема
`jsonl`	OpenAI.EvalJsonlRunDataSourceParams
`completions`	OpenAI.EvalCompletionsRunDataSourceParams
`responses`	OpenAI.EvalResponsesRunDataSourceParams

Имя.	Тип	Description	Обязательно	По умолчанию
type	OpenAI.EvalRunDataSourceType		Да

OpenAI.EvalRunDataSourceResource

Имя.	Тип	Description	Обязательно	По умолчанию
type	OpenAI.EvalRunDataSourceType		Да

OpenAI.EvalRunDataSourceResponsesResource

Имя.	Тип	Description	Обязательно	По умолчанию
type	перечисление	Возможные значения: `responses`	Да

OpenAI.EvalRunDataSourceType

Недвижимость	Ценность
Тип	струна
Значения	`jsonl` `completions` `responses`

OpenAI.EvalRunFileContentDataContentSource

Имя.	Тип	Description	Обязательно	По умолчанию
содержимое	массив	Содержимое jsonl-файла.	Да
type	перечисление	Тип источника jsonl. Всегда `file_content`. Возможные значения: `file_content`	Да

OpenAI.EvalRunFileIdDataContentSource

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

OpenAI.EvalRunList

Объект, представляющий список запусков для оценки.

Имя.	Тип	Description	Обязательно
данные	массив	Массив объектов выполнения eval.	Да
первый_идентификатор	струна	Идентификатор первого запуска оценки в массиве данных.	Да
есть_еще	булевый	Указывает, доступны ли дополнительные оценки.	Да
last_id	струна	Идентификатор последнего запуска eval в массиве данных.	Да
объект	перечисление	Тип этого объекта. Для него всегда задано значение list. Возможные значения: `list`	Да

OpenAI.EvalRunOutputItem

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

Имя.	Тип	Description	Обязательно
создано_в	целое число	Метка времени Unix (в секундах) при создании запуска оценки.	Да
элемент источника данных	объект	Сведения об элементе источника входных данных.	Да
идентификатор_элемента_источника_данных	целое число	Идентификатор элемента источника данных.	Да
eval_id	струна	Идентификатор группы оценки.	Да
id	струна	Уникальный идентификатор элемента результата выполнения оценки.	Да
объект	перечисление	Тип объекта . Всегда "eval.run.output_item". Возможные значения: `eval.run.output_item`	Да
results	массив	Список результатов выполнения оценки.	Да
run_id	струна	Идентификатор оценки, связанной с этим результирующим элементом.	Да
образец	объект	Пример, содержащий входные и выходные данные выполнения оценки.	Да
└─ Ошибка	OpenAI.EvalApiError	Объект, представляющий ответ об ошибке из API Eval.	нет
└️ причина_завершения	струна	Причина завершения создания образца.	нет
└─ Входные данные	массив	Массив входных сообщений.	нет
└─max_completion_tokens	целое число	Максимальное количество токенов, разрешенных для завершения.	нет
└─ Модель	струна	Модель, используемая для создания примера.	нет
вывод └─	массив	Массив выходных сообщений.	нет
Начальное значение └️	целое число	Значение, используемое в качестве семени для генерации образца.	нет
└─ Температура	число/номер	Используемая температура выборки.	нет
└️ top_p	число/номер	Значение top_p, используемое для выборки.	нет
└─ использование	объект	Сведения об использовании токенов в качестве примера.	нет
└ cached_tokens	целое число	Количество токенов, полученных из кэша.	нет
└─ токены завершения	целое число	Количество созданных маркеров завершения.	нет
└─ токены_запроса	целое число	Количество используемых токенов запроса.	нет
└️ всего_токенов	целое число	Общее количество используемых токенов.	нет
статус	струна	Состояние выполнения оценки.	Да

OpenAI.EvalRunOutputItemList

Объект, представляющий список выходных элементов для выполнения оценки.

Имя.	Тип	Description	Обязательно
данные	массив	Массив объектов элементов результата выполнения eval.	Да
первый_идентификатор	струна	Идентификатор первого выходного элемента eval в массиве данных.	Да
есть_еще	булевый	Указывает, доступны ли еще элементы вывода из оценки.	Да
last_id	струна	Идентификатор последнего элемента вывода eval в массиве данных.	Да
объект	перечисление	Тип этого объекта. Для него всегда задано значение list. Возможные значения: `list`	Да

OpenAI.EvalRunResponsesDataContentSource

Объект EvalResponsesSource, описывающий конфигурацию источника данных запуска.

Имя.	Тип	Description	Обязательно
создано после	целое число	Включайте только элементы, созданные после этого метки времени (включительно). Это параметр запроса, используемый для выбора ответов.	нет
создано до	целое число	Включайте только элементы, созданные до этого метки времени (включительно). Это параметр запроса, используемый для выбора ответов.	нет
instructions_search	струна	Необязательная строка для поиска в поле "инструкции". Это параметр запроса, используемый для выбора ответов.	нет
metadata	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате и запроса на объекты через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — это строки с максимальной длиной 512 символов.	нет
модель	струна	Имя модели для поиска ответов. Это параметр запроса, используемый для выбора ответов.	нет
усилия на рассуждение	объект	Только модели o-серии Ограничивает усилия по рассуждениям моделей. В настоящее время поддерживаются `low`значения , `medium`и `high`. Сокращение усилий по поводу может привести к более быстрым откликам и меньшем количестве маркеров, используемых при рассуждениях в ответе.	нет
Температура	число/номер	Температура выборки. Это параметр запроса, используемый для выбора ответов.	нет
инструменты	массив	Список имен инструментов. Это параметр запроса, используемый для выбора ответов.	нет
top_p	число/номер	Параметр выборки ядра. Это параметр запроса, используемый для выбора ответов.	нет
type	перечисление	Тип источника данных запуска. Всегда `responses`. Возможные значения: `responses`	Да
users	массив	Список идентификаторов пользователей. Это параметр запроса, используемый для выбора ответов.	нет

OpenAI.EvalRunStoredCompletionsDataContentSource

Конфигурация StoredCompletionsRunDataSource, описывающая набор фильтров

Имя.	Тип	Description	Обязательно
создано после	целое число	Необязательная метка времени Unix для фильтрации элементов, созданных после этого времени.	нет
создано до	целое число	Необязательная метка времени Unix для фильтрации элементов, созданных до этого времени.	нет
limit	целое число	Необязательное максимальное количество возвращаемых элементов.	нет
metadata	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате и запроса на объекты через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — это строки с максимальной длиной 512 символов.	Да
модель	струна	Необязательная модель для фильтрации (например, gpt-4o).	нет
type	перечисление	Тип источника . Всегда `stored_completions`. Возможные значения: `stored_completions`	Да

OpenAI.EvalStoredCompletionsDataSourceConfigParams

Не рекомендуется использовать LogsDataSourceConfig.

Имя.	Тип	Description	Обязательно	По умолчанию
metadata	объект	Фильтры метаданных для источника данных хранимых завершений.	нет
type	перечисление	Тип источника данных. Всегда `stored_completions`. Возможные значения: `stored_completions`	Да

OpenAI.EvalStoredCompletionsDataSourceConfigResource

Не рекомендуется использовать LogsDataSourceConfig.

Имя.	Тип	Description	Обязательно
metadata	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате и запроса на объекты через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — это строки с максимальной длиной 512 символов.	Да
schema	объект	Схема JSON для элементов источника данных запуска. Узнайте, как создать схемы JSON здесь.	Да
type	перечисление	Тип источника данных. Всегда `stored_completions`. Возможные значения: `stored_completions`	Да

OpenAI.FileSearchTool

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

Имя.	Тип	Description	Обязательно
filters	объект		нет
максимальное_количество_результатов	целое число	Максимальное количество отображаемых результатов. Это число должно быть от 1 до 50 включительно.	нет
опции рейтинга	объект		нет
Рангер └️	перечисление	Рангер, используемый для поиска файлов. Возможные значения: `auto`, `default-2024-11-15`	нет
└─ порог оценки	число/номер	Пороговое значение оценки для поиска файлов — от 0 до 1. Числа ближе к 1 будут пытаться вернуть только наиболее релевантные результаты, но могут возвращать меньше результатов.	нет
type	перечисление	Тип средства поиска файлов. Всегда `file_search`. Возможные значения: `file_search`	Да
vector_store_ids	массив	Идентификаторы векторных хранилищ для поиска.	Да

OpenAI.FileSearchToolCallItemParam

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

Имя.	Тип	Description	Обязательно
queries	массив	Запросы, используемые для поиска файлов.	Да
results	массив	Результаты вызова средства поиска файлов.	нет
type	перечисление	Возможные значения: `file_search_call`	Да

OpenAI.FileSearchToolCallItemResource

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

Имя.	Тип	Description	Обязательно
queries	массив	Запросы, используемые для поиска файлов.	Да
results	массив	Результаты вызова средства поиска файлов.	нет
статус	перечисление	Состояние вызова средства поиска файлов. Один из `in_progress`, `searchingincomplete` или `failed`. Возможные значения: `in_progress`, `searching`, `completed`, `incomplete`, `failed`	Да
type	перечисление	Возможные значения: `file_search_call`	Да

OpenAI.Фильтры

Имя.	Тип	Description	Обязательно
filters	массив	Массив фильтров для объединения. Элементы могут быть `ComparisonFilter` или `CompoundFilter`.	Да
ключ	струна	Ключ для сопоставления со значением.	Да
type	перечисление	Тип операции: `and` или `or`. Возможные значения: `and`, `or`	Да
value	строка или число или логическое значение	Значение для сравнения с ключом атрибута; поддерживает типы строк, чисел или логических типов.	Да

OpenAI.FineTuneDPOHyperparameters

Гиперпараметры, используемые для задания точной настройки DPO.

Имя.	Тип	Description	Обязательно
размер пакета	перечисление	Возможные значения: `auto`	нет
Бета	перечисление	Возможные значения: `auto`	нет
множитель скорости обучения	перечисление	Возможные значения: `auto`	нет
количество эпох	перечисление	Возможные значения: `auto`	нет

OpenAI.FineTuneDPOMethod

Конфигурация для метода точной настройки DPO.

Имя.	Тип	Description	Обязательно	По умолчанию
гиперпараметры	OpenAI.FineTuneDPOHyperparameters	Гиперпараметры, используемые для задания точной настройки DPO.	нет

OpenAI.FineTuneMethod

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

Имя.	Тип	Description	Обязательно
dpo	OpenAI.FineTuneDPOMethod	Конфигурация для метода точной настройки DPO.	нет
усиление	AzureFineTuneReinforcementMethod		нет
Под наблюдением	OpenAI.FineTuneSupervisedMethod	Настройка защищенного метода тонкой настройки.	нет
type	перечисление	Тип метода. `supervised`Либо , `dpo`либо `reinforcement`. Возможные значения: `supervised`, `dporeinforcement`	Да

OpenAI.FineTuneReinforcementHyperparameters

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

Имя.	Тип	Description	Обязательно
размер пакета	перечисление	Возможные значения: `auto`	нет
compute_multiplier	перечисление	Возможные значения: `auto`	нет
eval_interval	перечисление	Возможные значения: `auto`	нет
eval_samples	перечисление	Возможные значения: `auto`	нет
множитель скорости обучения	перечисление	Возможные значения: `auto`	нет
количество эпох	перечисление	Возможные значения: `auto`	нет
усилия на рассуждение	перечисление	Уровень усилий по рассуждениям. Возможные значения: `default`, , `lowmediumhigh`	нет

OpenAI.FineTuneSupervisedHyperparameters

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

Имя.	Тип	Description	Обязательно
размер пакета	перечисление	Возможные значения: `auto`	нет
множитель скорости обучения	перечисление	Возможные значения: `auto`	нет
количество эпох	перечисление	Возможные значения: `auto`	нет

OpenAI.FineTuneSupervisedMethod

Настройка защищенного метода тонкой настройки.

Имя.	Тип	Description	Обязательно	По умолчанию
гиперпараметры	OpenAI.FineTuneSupervisedHyperparameters	Гиперпараметры, используемые для задания тонкой настройки.	нет

OpenAI.FineTuningIntegration

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

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

Значение типа	Схема
`wandb`	OpenAI.FineTuningIntegrationWandb

Имя.	Тип	Description	Обязательно	По умолчанию
type	строка (см. допустимые модели ниже)		Да

OpenAI.FineTuningIntegrationWandb

Имя.	Тип	Description	Обязательно
type	перечисление	Тип интеграции, включаемой для задания тонкой настройки. Возможные значения: `wandb`	Да
wandb	объект	Параметры интеграции с весами и смещениями. Эта полезные данные указывает project, в которые будут отправляться метрики. При необходимости можно задать явное отображаемое имя для запуска, добавить теги в выполнение и задать сущность по умолчанию (команда, имя пользователя и т. д.), которая будет связана с выполнением.	Да
Сущность └️	струна	Сущность, используемая для выполнения. Это позволяет вам задать команду или имя пользователя WandB, которые вы хотите ассоциировать с запуском. Если не задано, используется сущность по умолчанию для зарегистрированного ключа API WandB.	нет
└️ имя	струна	Отображаемое имя, заданное для выполнения. Если этот параметр не задан, в качестве имени будет использоваться идентификатор задания.	нет
└️ project	струна	Имя project, в которую будет создан новый запуск.	нет
Теги └️	массив	Список тегов, присоединенных к созданному запуску. Эти теги передаются непосредственно в WandB. Некоторые теги по умолчанию создаются OpenAI: openai/finetune, openai/{base-model}, openai/{ftjob-abcdef}.	нет

OpenAI.FineTuningJob

Объект fine_tuning.job представляет задание тонкой настройки, созданное с помощью API.

Имя.	Тип	Description	Обязательно
создано_в	целое число	Метка времени Unix (в секундах) для создания задания тонкой настройки.	Да
ошибка	объект	Для заданий тонкой настройки, имеющихся `failed`, это будет содержать дополнительные сведения о причине сбоя.	Да
└─ Код	струна	Код ошибки, доступный для чтения компьютером.	нет
Сообщение └️	струна	Сообщение об ошибке, доступное для чтения человеком.	нет
└─ параметр	струна	Недопустимый параметр, обычно `training_file` или `validation_file`. Это поле будет иметь значение NULL, если сбой не был определенным параметром.	нет
предполагаемое завершение	целое число	Метка времени Unix (в секундах) для завершения задания тонкой настройки. Значение будет иметь значение NULL, если задание тонкой настройки не выполняется.	нет
fine_tuned_model	струна	Имя созданной точно настроенной модели. Значение будет иметь значение NULL, если задание тонкой настройки по-прежнему выполняется.	Да
завершено_в	целое число	Метка времени Unix (в секундах) для завершения задания тонкой настройки. Значение будет иметь значение NULL, если задание тонкой настройки по-прежнему выполняется.	Да
гиперпараметры	объект	Гиперпараметры, используемые для задания тонкой настройки. Это значение будет возвращено только при выполнении `supervised` заданий.	Да
└batch_size	перечисление	Возможные значения: `auto`	нет
└learning_rate_multiplier learning_rate_multiplier	перечисление	Возможные значения: `auto`	нет
└️ n_epochs	перечисление	Возможные значения: `auto`	нет
id	струна	Идентификатор объекта, на который можно ссылаться в конечных точках API.	Да
Интеграции	массив	Список интеграции для этого задания тонкой настройки.	нет
metadata	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате и запроса на объекты через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — это строки с максимальной длиной 512 символов.	Да
method	OpenAI.FineTuneMethod	Метод, используемый для точной настройки.	нет
модель	струна	Базовая модель, которая настраивается.	Да
объект	перечисление	Тип объекта, который всегда является "fine_tuning.job". Возможные значения: `fine_tuning.job`	Да
organization_id	струна	Организация, которая владеет заданием тонкой настройки.	Да
файлы_результатов	массив	Скомпилированные идентификаторы файлов результатов для задания тонкой настройки. Результаты можно получить с помощью API файлов.	Да
seed	целое число	Сид, используемый для задания тонкой настройки.	Да
статус	перечисление	Текущее состояние задания тонкой настройки, которое может быть `validating_files`либо , , `queued`, `runningsucceededfailedcancelled`либо . Возможные значения: `validating_files`, `queued`, `running`, `succeeded`, `failed`, `cancelled`	Да
обученные_токены	целое число	Общее количество оплачиваемых маркеров, обработанных этим заданием тонкой настройки. Значение будет иметь значение NULL, если задание тонкой настройки по-прежнему выполняется.	Да
файл_обучения	струна	Идентификатор файла, используемый для обучения. Вы можете получить обучающие данные с помощью API файлов.	Да
user_provided_suffix	струна	Описательный суффикс, примененный к заданию, как указано в запросе на создание задания.	нет
Файл_валидации	струна	Идентификатор файла, используемый для проверки. Результаты проверки можно получить с помощью API файлов.	Да

OpenAI.FineTuningJobCheckpoint

Объект fine_tuning.job.checkpoint представляет контрольную точку модели для задания тонкой настройки, готового к использованию.

Имя.	Тип	Description	Обязательно
создано_в	целое число	Метка времени Unix (в секундах) для момента создания контрольной точки.	Да
контрольная точка тонко настроенной модели	струна	Имя созданной модели точно настроенной контрольной точки.	Да
идентификатор_задания_тончайшей_настройки	струна	Имя задания тонкой настройки, из которого был создан этот контрольный пункт.	Да
id	струна	Идентификатор контрольной точки, на который можно ссылаться в конечных точках API.	Да
metrics	объект	Метрики на номере шага во время задания тонкой настройки.	Да
└️ 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`	Да
номер_шага	целое число	Номер шага, на который была создана контрольная точка.	Да

OpenAI.FineTuningJobEvent

Объект события задания точной настройки

Имя.	Тип	Description	Обязательно
создано_в	целое число	Метка времени Unix (в секундах) для создания задания тонкой настройки.	Да
данные		Данные, связанные с событием.	нет
id	струна	Идентификатор объекта.	Да
уровень	перечисление	Уровень журнала события. Возможные значения: `info`, `warnerror`	Да
сообщение	струна	Сообщение события.	Да
объект	перечисление	Тип объекта, который всегда является "fine_tuning.job.event". Возможные значения: `fine_tuning.job.event`	Да
type	перечисление	Тип события. Возможные значения: `message`, `metrics`	нет

OpenAI.FunctionObject

Имя.	Тип	Description	Обязательно	По умолчанию
описание	струна	Описание того, что выполняет функция, используемая моделью для выбора времени и способа вызова функции.	нет
имя	струна	Имя вызываемой функции. Должен быть a-z, A-Z, 0-9 или содержать символы подчеркивания и дефисы с максимальной длиной 64.	Да
параметры		Параметры, которые принимают функции, описаны как объект схемы JSON.	нет
строгий	булевый	Следует ли включить строгое соблюдение схемы при создании вызова функции. Если задано значение true, модель будет соответствовать точной схеме, определенной `parameters` в поле. Только подмножество схемы JSON поддерживается, если `stricttrue`.	нет	Неправда

OpenAI.FunctionTool

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

Имя.	Тип	Description	Обязательно
описание	струна	Описание функции. Используется моделью для определения того, следует ли вызывать функцию.	нет
имя	струна	Имя вызываемой функции.	Да
параметры		Объект схемы JSON, описывающий параметры функции.	Да
строгий	булевый	Следует ли применять строгую проверку параметров. `true`по умолчанию.	Да
type	перечисление	Тип средства функции. Всегда `function`. Возможные значения: `function`	Да

OpenAI.FunctionToolCallItemParam

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

Имя.	Тип	Description	Обязательно
arguments	струна	Строка JSON аргументов для передачи функции.	Да
call_id	струна	Уникальный идентификатор вызова функции, созданного моделью.	Да
имя	струна	Имя выполняемой функции.	Да
type	перечисление	Возможные значения: `function_call`	Да

OpenAI.FunctionToolCallItemResource

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

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

OpenAI.FunctionToolCallOutputItemParam

Выходные данные вызова инструмента функции.

Имя.	Тип	Description	Обязательно
call_id	струна	Уникальный идентификатор вызова функции, созданного моделью.	Да
output	струна	Строка JSON данных, полученных в результате вызова инструмента функции.	Да
type	перечисление	Возможные значения: `function_call_output`	Да

OpenAI.FunctionToolCallOutputItemResource

Выходные данные вызова инструмента функции.

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

OpenAI.Grader

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

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

Значение типа	Схема
`label_model`	OpenAI.GraderLabelModel
`text_similarity`	OpenAI.GraderTextSimilarity
`python`	OpenAI.GraderPython
`score_model`	OpenAI.GraderScoreModel
`multi`	OpenAI.GraderMulti

Имя.	Тип	Description	Обязательно	По умолчанию
type	OpenAI.GraderType		Да

OpenAI.GraderLabelModel

Объект LabelModelGrader, использующий модель для назначения меток каждому элементу в оценке.

Имя.	Тип	Description	Обязательно
ввод	массив		Да
labels	массив	Метки, назначенные каждому элементу в оценке.	Да
модель	струна	Модель, используемая для оценки. Должен поддерживать структурированные выходные данные.	Да
имя	струна	Имя классировщика.	Да
передача_меток	массив	Метки, указывающие на успешный результат. Должно быть подмножеством этих меток.	Да
type	перечисление	Тип объекта, который всегда `label_model`является . Возможные значения: `label_model`	Да

OpenAI.GraderMulti

Объект MultiGrader объединяет выходные данные нескольких классировщиков для создания одной оценки.

Имя.	Тип	Description	Обязательно
calculate_output	струна	Формула для вычисления выходных данных на основе результатов оценки.	Да
Грейдеры	объект		Да
имя	струна	Имя классировщика.	Да
type	перечисление	Тип объекта, который всегда `multi`является . Возможные значения: `multi`	Да

OpenAI.GraderPython

Объект PythonGrader, который запускает скрипт Python на входных данных.

Имя.	Тип	Description	Обязательно
image_tag	струна	Тег изображения, используемый для скрипта Python.	нет
имя	струна	Имя классировщика.	Да
Источник	струна	Исходный код скрипта Python.	Да
type	перечисление	Тип объекта, который всегда `python`является . Возможные значения: `python`	Да

OpenAI.GraderScoreModel

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

Имя.	Тип	Description	Обязательно
ввод	массив	Входной текст. Это может включать строки шаблона.	Да
модель	струна	Модель, используемая для оценки.	Да
имя	струна	Имя классировщика.	Да
диапазон	массив	Диапазон оценки. По умолчанию — `[0, 1]`.	нет
параметры выборки		Параметры выборки для модели.	нет
type	перечисление	Тип объекта, который всегда `score_model`является . Возможные значения: `score_model`	Да

OpenAI.GraderStringCheck

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

Имя.	Тип	Description	Обязательно
ввод	струна	Входной текст. Это может включать строки шаблона.	Да
имя	струна	Имя классировщика.	Да
Операция	перечисление	Операция проверки строки, которую нужно выполнить. Один из `eq`, `nelike`или `ilike`. Возможные значения: `eq`, , `nelikeilike`	Да
Ссылка	струна	Текст ссылки. Это может включать строки шаблона.	Да
type	перечисление	Тип объекта, который всегда `string_check`является . Возможные значения: `string_check`	Да

OpenAI.GraderTextSimilarity

Объект TextSimilarityGrader, который классирует текст на основе метрик сходства.

Имя.	Тип	Description	Обязательно
метрика оценки	перечисление	Используемая метрика оценки. Один из `fuzzy_match`, `bleu`, `gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`, или `rouge_l`. Возможные значения: `fuzzy_match`, `bleu`, `gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`, `rouge_l`	Да
ввод	струна	Текст, оцениваемый.	Да
имя	струна	Имя классировщика.	Да
Ссылка	струна	Текст, классируемый против.	Да
type	перечисление	Тип классировщика. Возможные значения: `text_similarity`	Да

OpenAI.GraderType

Недвижимость	Ценность
Тип	струна
Значения	`string_check` `text_similarity` `score_model` `label_model` `python` `multi`

OpenAI.ImageGenTool

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

Имя.	Тип	Description	Обязательно	По умолчанию
фон	перечисление	Тип фона для созданного изображения. Один из `transparent`, `opaque`, или `auto`. По умолчанию: `auto`. Возможные значения: `transparent`, `opaqueauto`	нет
входная маска изображения	объект	Опциональная маска для инпейнтинга. Содержит `image_url` (строка, необязательно) и `file_id` (строка, необязательно).	нет
└ file_id	струна	Идентификатор файла для изображения маски.	нет
└image_url	струна	Изображение маски в кодировке Base64.	нет
модель	перечисление	Модель создания изображений, используемая. По умолчанию: `gpt-image-1`. Возможные значения: `gpt-image-1`, `gpt-image-1.5`	нет
moderation	перечисление	Уровень модерации для созданного образа. По умолчанию: `auto`. Возможные значения: `auto`, `low`	нет
сжатие вывода	целое число	Уровень сжатия для выходного изображения. Значение по умолчанию: 100.	нет	100
формат_выходных_данных	перечисление	Формат выходных данных созданного изображения. Один из `png`, `webp`, или `jpeg`. По умолчанию: `png`. Возможные значения: `png`, `webpjpeg`	нет
частичные_изображения	целое число	Количество частичных образов для создания в режиме потоковой передачи от 0 (значение по умолчанию) до 3.	нет	0
качество	перечисление	Качество созданного изображения. Один из `low`, `mediumhigh`или `auto`. По умолчанию: `auto`. Возможные значения: `low`, , `mediumhighauto`	нет
size	перечисление	Размер созданного изображения. Один из `1024x1024`, `1024x15361536x1024`или `auto`. По умолчанию: `auto`. Возможные значения: `1024x1024`, , `1024x15361536x1024auto`	нет
type	перечисление	Тип средства создания изображений. Всегда `image_generation`. Возможные значения: `image_generation`	Да

OpenAI.ImageGenToolCallItemParam

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

Имя.	Тип	Description	Обязательно	По умолчанию
результат	струна	Созданный образ, закодированный в base64.	Да
type	перечисление	Возможные значения: `image_generation_call`	Да

OpenAI.ImageGenToolCallItemResource

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

Имя.	Тип	Description	Обязательно
результат	струна	Созданный образ, закодированный в base64.	Да
статус	перечисление	Возможные значения: `in_progress`, , `completedgeneratingfailed`	Да
type	перечисление	Возможные значения: `image_generation_call`	Да

OpenAI.ImplicitUserMessage

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

OpenAI.Includable

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

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, или когда организация зарегистрирована в программе нулевого хранения данных).

Недвижимость	Ценность
Описание	Укажите дополнительные выходные данные для включения в ответ модели. В настоящее время поддерживаются следующие значения: - `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`, или когда организация зарегистрирована в программе нулевого хранения данных).
Тип	струна
Значения	`code_interpreter_call.outputs` `computer_call_output.output.image_url` `file_search_call.results` `message.input_image.image_url` `message.output_text.logprobs` `reasoning.encrypted_content`

OpenAI.ItemContent

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

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

Значение типа	Схема
`input_audio`	OpenAI.ItemContentInputAudio
`output_audio`	OpenAI.ItemContentOutputAudio
`refusal`	OpenAI.ItemContentRefusal
`input_text`	OpenAI.ItemContentInputText
`input_image`	OpenAI.ItemContentInputImage
`input_file`	OpenAI.ItemContentInputFile
`output_text`	OpenAI.ItemContentOutputText

Имя.	Тип	Description	Обязательно	По умолчанию
type	OpenAI.ItemContentType	Много модальное содержимое входных и выходных данных.	Да

OpenAI.ItemContentInputAudio

Аудиовход для модели.

Имя.	Тип	Description	Обязательно
данные	струна	Звуковые данные в кодировке Base64.	Да
format	перечисление	Формат звуковых данных. В настоящее время поддерживаются `mp3` форматы и `wav`. Возможные значения: `mp3`, `wav`	Да
type	перечисление	Тип входного элемента. Всегда `input_audio`. Возможные значения: `input_audio`	Да

OpenAI.ItemContentInputFile

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

Имя.	Тип	Description	Обязательно
file_data	струна	Содержимое файла, отправляемого в модель.	нет
идентификатор_файла	струна	Идентификатор файла, отправляемого в модель.	нет
filename	струна	Имя файла, отправляемого в модель.	нет
type	перечисление	Тип входного элемента. Всегда `input_file`. Возможные значения: `input_file`	Да

OpenAI.ItemContentInputImage

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

Имя.	Тип	Description	Обязательно
detail	перечисление	Уровень детализации изображения, отправляемого в модель. Один из `high`, `low`, или `auto`. По умолчанию — `auto`. Возможные значения: `low`, `highauto`	нет
идентификатор_файла	струна	Идентификатор файла, отправляемого в модель.	нет
ссылка_на_изображение	струна	URL-адрес изображения, отправляемого в модель. Полностью квалифицированный URL-адрес или изображение, закодированное в формате Base64 в URL-адресе данных.	нет
type	перечисление	Тип входного элемента. Всегда `input_image`. Возможные значения: `input_image`	Да

OpenAI.ItemContentInputText

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

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

OpenAI.ItemContentOutputAudio

Выходные данные звука из модели.

Имя.	Тип	Description	Обязательно
данные	струна	Звуковые данные в кодировке Base64 из модели.	Да
transcript	струна	Расшифровка звуковых данных из модели.	Да
type	перечисление	Тип выходного звука. Всегда `output_audio`. Возможные значения: `output_audio`	Да

OpenAI.ItemContentOutputText

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

Имя.	Тип	Description	Обязательно
аннотации	массив	Заметки к выходным данным текста.	Да
logprobs	массив		нет
текст	струна	Текстовые выходные данные модели.	Да
type	перечисление	Тип выходного текста. Всегда `output_text`. Возможные значения: `output_text`	Да

OpenAI.ItemContentRefusal

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

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

OpenAI.ItemContentType

Много модальное содержимое входных и выходных данных.

Недвижимость	Ценность
Описание	Много модальное содержимое входных и выходных данных.
Тип	струна
Значения	`input_text` `input_audio` `input_image` `input_file` `output_text` `output_audio` `refusal`

OpenAI.ItemParam

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

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

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

Значение типа	Схема
`file_search_call`	OpenAI.FileSearchToolCallItemParam
`computer_call`	OpenAI.ComputerToolCallItemParam
`computer_call_output`	OpenAI.ComputerToolCallOutputItemParam
`web_search_call`	OpenAI.WebSearchToolCallItemParam
`function_call`	OpenAI.FunctionToolCallItemParam
`function_call_output`	OpenAI.FunctionToolCallOutputItemParam
`reasoning`	OpenAI.ReasoningItemParam
`item_reference`	OpenAI.ItemReferenceItemParam
`image_generation_call`	OpenAI.ImageGenToolCallItemParam
`code_interpreter_call`	OpenAI.CodeInterpreterToolCallItemParam
`local_shell_call`	OpenAI.LocalShellToolCallItemParam
`local_shell_call_output`	OpenAI.LocalShellToolCallOutputItemParam
`mcp_list_tools`	OpenAI.MCPListToolsItemParam
`mcp_approval_request`	OpenAI.MCPApprovalRequestItemParam
`mcp_approval_response`	OpenAI.MCPApprovalResponseItemParam
`mcp_call`	OpenAI.MCPCallItemParam
`message`	OpenAI.ResponsesMessageItemParam

Имя.	Тип	Description	Обязательно	По умолчанию
type	OpenAI.ItemType		Да

OpenAI.ItemReferenceItemParam

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

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

OpenAI.ItemResource

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

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

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

Значение типа	Схема
`file_search_call`	OpenAI.FileSearchToolCallItemResource
`computer_call`	OpenAI.ComputerToolCallItemResource
`computer_call_output`	OpenAI.ComputerToolCallOutputItemResource
`web_search_call`	OpenAI.WebSearchToolCallItemResource
`function_call`	OpenAI.FunctionToolCallItemResource
`function_call_output`	OpenAI.FunctionToolCallOutputItemResource
`reasoning`	OpenAI.ReasoningItemResource
`image_generation_call`	OpenAI.ImageGenToolCallItemResource
`code_interpreter_call`	OpenAI.CodeInterpreterToolCallItemResource
`local_shell_call`	OpenAI.LocalShellToolCallItemResource
`local_shell_call_output`	OpenAI.LocalShellToolCallOutputItemResource
`mcp_list_tools`	OpenAI.MCPListToolsItemResource
`mcp_approval_request`	OpenAI.MCPApprovalRequestItemResource
`mcp_approval_response`	OpenAI.MCPApprovalResponseItemResource
`mcp_call`	OpenAI.MCPCallItemResource
`message`	OpenAI.ResponsesMessageItemResource

Имя.	Тип	Description	Обязательно	По умолчанию
id	струна		Да
type	OpenAI.ItemType		Да

OpenAI.ItemType

Недвижимость	Ценность
Тип	струна
Значения	`message` `file_search_call` `function_call` `function_call_output` `computer_call` `computer_call_output` `web_search_call` `reasoning` `item_reference` `image_generation_call` `code_interpreter_call` `local_shell_call` `local_shell_call_output` `mcp_list_tools` `mcp_approval_request` `mcp_approval_response` `mcp_call`

OpenAI.ListFineTuningJobCheckpointsResponse

Имя.	Тип	Description	Обязательно
данные	массив		Да
первый_идентификатор	струна		нет
есть_еще	булевый		Да
last_id	струна		нет
объект	перечисление	Возможные значения: `list`	Да

OpenAI.ListFineTuningJobEventsResponse

Имя.	Тип	Description	Обязательно
данные	массив		Да
есть_еще	булевый		Да
объект	перечисление	Возможные значения: `list`	Да

OpenAI.ListModelsResponse

Имя.	Тип	Description	Обязательно	По умолчанию
данные	массив		Да
объект	перечисление	Возможные значения: `list`	Да

OpenAI.ListPaginatedFineTuningJobsResponse

Имя.	Тип	Description	Обязательно
данные	массив		Да
есть_еще	булевый		Да
объект	перечисление	Возможные значения: `list`	Да

OpenAI.ListVectorStoreFilesFilter

Недвижимость	Ценность
Тип	струна
Значения	`in_progress` `completed` `failed` `cancelled`

OpenAI.ListVectorStoreFilesResponse

Имя.	Тип	Description	Обязательно
данные	массив		Да
первый_идентификатор	струна		Да
есть_еще	булевый		Да
last_id	струна		Да
объект	перечисление	Возможные значения: `list`	Да

OpenAI.ListVectorStoresResponse

Имя.	Тип	Description	Обязательно
данные	массив		Да
первый_идентификатор	струна		Да
есть_еще	булевый		Да
last_id	струна		Да
объект	перечисление	Возможные значения: `list`	Да

OpenAI.LocalShellExecAction

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

Имя.	Тип	Description	Обязательно
command	массив	Выполняемая команда	Да
окружение	объект	Переменные среды, заданные для команды.	Да
таймаут_мс	целое число	Необязательное время ожидания в миллисекундах для команды.	нет
type	перечисление	Тип действия локальной оболочки. Всегда `exec`. Возможные значения: `exec`	Да
Пользователь	струна	Необязательный пользователь для выполнения команды как.	нет
working_directory	струна	Необязательный рабочий каталог для выполнения команды.	нет

OpenAI.LocalShellTool

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

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

OpenAI.LocalShellToolCallItemParam

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

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

OpenAI.LocalShellToolCallItemResource

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

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

OpenAI.LocalShellToolCallOutputItemParam

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

Имя.	Тип	Description	Обязательно	По умолчанию
output	струна	Строка JSON выходных данных вызова локального средства оболочки.	Да
type	перечисление	Возможные значения: `local_shell_call_output`	Да

OpenAI.LocalShellToolCallOutputItemResource

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

Имя.	Тип	Description	Обязательно
output	струна	Строка JSON выходных данных вызова локального средства оболочки.	Да
статус	перечисление	Возможные значения: `in_progress`, `completedincomplete`	Да
type	перечисление	Возможные значения: `local_shell_call_output`	Да

OpenAI.Location

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

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

Значение типа	Схема
`approximate`	OpenAI.ApproximateLocation

Имя.	Тип	Description	Обязательно	По умолчанию
type	OpenAI.LocationType		Да

OpenAI.LocationType

Недвижимость	Ценность
Тип	струна
Значения	`approximate`

OpenAI.LogProb

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

Имя.	Тип	Обязательно
байт	массив	Да
logprob	число/номер	Да
token	струна	Да
top_logprobs	массив	Да

OpenAI.MCPApprovalRequestItemParam

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

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

OpenAI.MCPApprovalRequestItemResource

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

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

OpenAI.MCPApprovalResponseItemParam

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

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

OpenAI.MCPApprovalResponseItemResource

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

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

OpenAI.MCPCallItemParam

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

Имя.	Тип	Description	Обязательно
arguments	струна	Строка JSON аргументов, переданных средству.	Да
ошибка	струна	Ошибка при вызове инструмента, если таковая имеется.	нет
имя	струна	Имя запущенного инструмента.	Да
output	струна	Выходные данные вызова инструмента.	нет
метка сервера	струна	Метка сервера MCP, на котором работает инструмент.	Да
type	перечисление	Возможные значения: `mcp_call`	Да

OpenAI.MCPCallItemResource

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

Имя.	Тип	Description	Обязательно
arguments	струна	Строка JSON аргументов, переданных средству.	Да
ошибка	струна	Ошибка при вызове инструмента, если таковая имеется.	нет
имя	струна	Имя запущенного инструмента.	Да
output	струна	Выходные данные вызова инструмента.	нет
метка сервера	струна	Метка сервера MCP, на котором работает инструмент.	Да
type	перечисление	Возможные значения: `mcp_call`	Да

OpenAI.MCPListToolsItemParam

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

Имя.	Тип	Description	Обязательно
ошибка	струна	Сообщение об ошибке, если сервер не смог перечислить инструменты.	нет
метка сервера	струна	Метка сервера MCP.	Да
инструменты	массив	Средства, доступные на сервере.	Да
type	перечисление	Возможные значения: `mcp_list_tools`	Да

OpenAI.MCPListToolsItemResource

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

Имя.	Тип	Description	Обязательно
ошибка	струна	Сообщение об ошибке, если сервер не смог перечислить инструменты.	нет
метка сервера	струна	Метка сервера MCP.	Да
инструменты	массив	Средства, доступные на сервере.	Да
type	перечисление	Возможные значения: `mcp_list_tools`	Да

OpenAI.MCPListToolsTool

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

Имя.	Тип	Description	Обязательно
аннотации		Дополнительные заметки о инструменте.	нет
описание	струна	Описание средства.	нет
input_schema		Схема JSON, описывающая входные данные средства.	Да
имя	струна	Имя средства.	Да

OpenAI.MCPTool

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

Имя.	Тип	Description	Обязательно
разрешённые_инструменты	объект		нет
└tool_names	массив	Список разрешенных имен инструментов.	нет
headers	объект	Необязательные заголовки HTTP для отправки на сервер MCP. Используется для проверки подлинности или других целей.	нет
требовать_одобрение	object (см. допустимые модели ниже)	Укажите, какие средства сервера MCP требуют утверждения.	нет
метка сервера	струна	Метка для этого сервера MCP, используемая для идентификации его в вызовах инструментов.	Да
URL сервера	струна	URL-адрес сервера MCP.	Да
type	перечисление	Тип средства MCP. Всегда `mcp`. Возможные значения: `mcp`	Да

OpenAI.MetadataPropertyForRequest

Ключи — это строки с максимальной длиной 64 символов. Значения — это строки с максимальной длиной 512 символов.

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

OpenAI.Model

Описывает предложение модели OpenAI, которое можно использовать с API.

Имя.	Тип	Description	Обязательно
создано	целое число	Метка времени Unix (в секундах) при создании модели.	Да
id	струна	Идентификатор модели, на который можно ссылаться в конечных точках API.	Да
объект	перечисление	Тип объекта, который всегда является моделью. Возможные значения: `model`	Да
owned_by	струна	Организация, которая владеет моделью.	Да

OpenAI.OtherChunkingStrategyResponseParam

Это возвращается, когда стратегия блокирования неизвестна. Как правило, это связано с тем, что файл был индексирован до chunking_strategy появления концепции в API.

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

OpenAI.ParallelToolCalls

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

Тип: логический

OpenAI.Prompt

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

Имя.	Тип	Description	Обязательно
id	струна	Уникальный идентификатор используемого шаблона запроса.	Да
переменные	объект	Необязательная карта значений для замены переменных в запросе. Значения подстановки могут быть строками или другими типами входных данных ответа, такими как изображения или файлы.	нет
version	струна	Необязательная версия шаблона запроса.	нет

OpenAI.RankingOptions

Имя.	Тип	Description	Обязательно	По умолчанию
офицер	перечисление	Рангер, используемый для поиска файлов. Возможные значения: `auto`, `default-2024-11-15`	нет
порог оценки	число/номер	Пороговое значение оценки для поиска файлов — от 0 до 1. Числа ближе к 1 будут пытаться вернуть только наиболее релевантные результаты, но могут возвращать меньше результатов.	нет

OpenAI.Reasoning

Только модели o-серии

Имя.	Тип	Description	Обязательно
effort	объект	Только модели o-серии Ограничивает усилия по рассуждениям моделей. В настоящее время поддерживаются `low`значения , `medium`и `high`. Сокращение усилий по поводу может привести к более быстрым откликам и меньшем количестве маркеров, используемых при рассуждениях в ответе.	нет
generate_summary	перечисление	Не рекомендуется: используйте `summary` вместо этого. Сводка умозаключений, сделанных моделью. Это может быть полезно для отладки и понимания процесса рассуждений модели. Один из `auto`, `concise`, или `detailed`. Возможные значения: `auto`, `concisedetailed`	нет
summary	перечисление	Сводка умозаключений, сделанных моделью. Это может быть полезно для отладки и понимания процесса рассуждений модели. Один из `auto`, `concise`, или `detailed`. Возможные значения: `auto`, `concisedetailed`	нет

OpenAI.ReasoningEffort

Только модели o-серии

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

Недвижимость	Ценность
Описание	Только модели o-серии Ограничивает усилия по рассуждениям моделей. В настоящее время поддерживаются `low`значения , `medium`и `high`. Сокращение усилий по поводу может привести к более быстрым откликам и меньшем количестве маркеров, используемых при рассуждениях в ответе.
Тип	струна
Значения	`low` `medium` `high`

OpenAI.ReasoningItemParam

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

Имя.	Тип	Description	Обязательно
encrypted_content	струна	Зашифрованное содержимое элемента логики — заполняется при создании ответа с помощью `reasoning.encrypted_content` в параметре `include`.	нет
summary	массив	Обоснование содержимого текста.	Да
type	перечисление	Возможные значения: `reasoning`	Да

OpenAI.ReasoningItemResource

Имя.	Тип	Description	Обязательно
encrypted_content	струна	Зашифрованное содержимое элемента логики — заполняется при создании ответа с помощью `reasoning.encrypted_content` в параметре `include`.	нет
summary	массив	Обоснование содержимого текста.	Да
type	перечисление	Возможные значения: `reasoning`	Да

OpenAI.ReasoningItemSummaryPart

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

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

Значение типа	Схема
`summary_text`	OpenAI.ReasoningItemSummaryTextPart

Имя.	Тип	Description	Обязательно	По умолчанию
type	OpenAI.ReasoningItemSummaryPartType		Да

OpenAI.ReasoningItemSummaryPartType

Недвижимость	Ценность
Тип	струна
Значения	`summary_text`

OpenAI.ReasoningItemSummaryTextPart

Имя.	Тип	Description	Обязательно	По умолчанию
текст	струна		Да
type	перечисление	Возможные значения: `summary_text`	Да

OpenAI.Response

Имя.	Тип	Description	Обязательно	По умолчанию
фон	булевый	Запускать ли ответ модели в фоновом режиме.	нет	Неправда
создано_в	целое число	Метка времени в формате Unix (в секундах), когда был создан этот ответ.	Да
ошибка	объект	Объект ошибки, возвращаемый, когда модель не сможет создать ответ.	Да
└─ Код	OpenAI.ResponseErrorCode	Код ошибки для ответа.	нет
Сообщение └️	струна	Описание ошибки, доступной для чтения человеком.	нет
id	струна	Уникальный идентификатор для этого ответа.	Да
incomplete_details	объект	Сведения о том, почему ответ неполный.	Да
└─ Причина	перечисление	Причина, по которой ответ является неполным. Возможные значения: `max_output_tokens`, `content_filter`	нет
instructions	строка или массив		Да
max_output_tokens	целое число	Верхняя граница для числа маркеров, которые можно создать для ответа, включая видимые выходные маркеры и маркеры причин	нет
max_tool_calls	целое число	Максимальное количество общих вызовов встроенных инструментов, которые могут обрабатываться в ответе. Это максимальное число применяется ко всем встроенным вызовам инструментов, а не для каждого отдельного средства. Любые дальнейшие попытки вызова средства моделью будут игнорироваться.	нет
metadata	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате и запроса на объекты через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — это строки с максимальной длиной 512 символов.	Да
объект	перечисление	Тип объекта этого ресурса — всегда установлено `response`. Возможные значения: `response`	Да
output	массив	Массив элементов контента, созданных моделью. — длина и порядок элементов в массиве `output` зависит от ответа модели. — Вместо доступа к первому элементу `output` массива и предположения, что это `assistant` сообщение с содержимым, созданным моделью, попробуйте использовать свойство `output_text`, где это поддержано в пакетах SDK.	Да
output_text	струна	Доступное только для пакета SDK свойство, содержащее агрегированные текстовые выходные данные всех `output_text` элементов в массиве `output` , если они присутствуют. Поддерживается в пакетах SDK для Python и JavaScript.	нет
вызовы инструмента в параллельном режиме	булевый	Следует ли разрешить модели запускать вызовы инструментов параллельно.	Да	True
previous_response_id	струна	Уникальный идентификатор предыдущего ответа на модель. Используйте эту функцию для создания многоэтапных бесед.	нет
prompt	объект	Ссылка на шаблон запроса и его переменные.	нет
Идентификатор └️	струна	Уникальный идентификатор используемого шаблона запроса.	нет
Переменные └️	OpenAI.ResponsePromptVariables	Необязательная карта значений для замены переменных в запросе. Значения подстановки могут быть строками или другими типами входных данных ответа, такими как изображения или файлы.	нет
Версия └️	струна	Необязательная версия шаблона запроса.	нет
reasoning	объект	Только модели o-серии Параметры конфигурации для моделей рассуждений.	нет
- усилия	OpenAI.ReasoningEffort	Только модели o-серии Ограничивает усилия по рассуждениям моделей. В настоящее время поддерживаются `low`значения , `medium`и `high`. Сокращение усилий по поводу может привести к более быстрым откликам и меньшем количестве маркеров, используемых при рассуждениях в ответе.	нет
└─generate_summary	перечисление	Не рекомендуется: используйте `summary` вместо этого. Сводка умозаключений, сделанных моделью. Это может быть полезно для отладки и понимания процесса рассуждений модели. Один из `auto`, `concise`, или `detailed`. Возможные значения: `auto`, `concisedetailed`	нет
└️ сводка	перечисление	Сводка умозаключений, сделанных моделью. Это может быть полезно для отладки и понимания процесса рассуждений модели. Один из `auto`, `concise`, или `detailed`. Возможные значения: `auto`, `concisedetailed`	нет
статус	перечисление	Статус формирования ответа. Один из `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete` или . Возможные значения: `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete`	нет
Температура	число/номер	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным. Как правило, мы рекомендуем изменить это или `top_p` не оба.	Да
текст	объект	Параметры конфигурации для текстового ответа модели. Можно использовать обычный текст или структурированные данные JSON.	нет
└─ Формат	OpenAI.ResponseTextFormatConfiguration		нет
выбор инструмента	объект	Определяет, какое средство (если таковое) вызывается моделью. `none` означает, что модель не будет вызывать какое-либо средство и вместо этого создает сообщение. `auto` означает, что модель может выбирать между созданием сообщения или вызовом одного или нескольких инструментов. `required` означает, что модель должна вызывать один или несколько инструментов.	нет
└─ Тип	OpenAI.ToolChoiceObjectType	Указывает, что модель должна использовать встроенное средство для создания ответа.	нет
инструменты	массив	Массив инструментов, которые модель может вызывать при создании ответа. Можно указать, какое средство следует использовать, задав `tool_choice` параметр. Ниже приведены две категории инструментов, которые можно предоставить модели: - Встроенные средства: средства, предоставляемые OpenAI, которые расширяют возможности модели.	нет
top_logprobs	целое число	Целое число от 0 до 20, указывающее число наиболее вероятных маркеров, возвращаемых по каждой позиции маркера, каждый из которых имеет связанную вероятность журнала.	нет
top_p	число/номер	Альтернативой выборке с температурой является так называемая выборка ядра, где модель рассматривает результаты маркеров с top_p всего массива значений вероятности. Таким образом, 0,1 означает, что учитываются только маркеры, входящие в верхние 10% массива значений вероятности. Как правило, мы рекомендуем изменить это или `temperature` не оба.	Да
truncation	перечисление	Стратегия усечения, которую следует использовать для генерирования ответа модели. - `auto`: если контекст этого ответа и предыдущих превышает размер окна контекста модели, модель усечет ответ, чтобы он соответствовал этому окну, удаляя элементы ввода в середине беседы. - `disabled` (по умолчанию): если ответ модели превысит размер окна контекста для модели, запрос завершится ошибкой 400. Возможные значения: `auto`, `disabled`	нет
использование	OpenAI.ResponseUsage	Представляет сведения об использовании маркеров, включая входные маркеры, выходные маркеры, разбивку выходных маркеров и общие используемые маркеры.	нет
Пользователь	струна	Уникальный идентификатор, представляющий пользователя, который может помочь OpenAI отслеживать и обнаруживать злоупотребления.	Да

OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent

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

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

OpenAI.ResponseCodeInterpreterCallCodeDoneEvent

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

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

OpenAI.ResponseCodeInterpreterCallCompletedEvent

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

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

OpenAI.ResponseCodeInterpreterCallInProgressEvent

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

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

OpenAI.ResponseCodeInterpreterCallInterpretingEvent

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

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

OpenAI.ResponseCompletedEvent

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

Имя.	Тип	Description	Обязательно	По умолчанию
response	объект		Да
└─ Фон	булевый	Запускать ли ответ модели в фоновом режиме.	нет	Неправда
└️ created_at	целое число	Метка времени в формате Unix (в секундах), когда был создан этот ответ.	нет
└─ Ошибка	OpenAI.ResponseError	Объект ошибки, возвращаемый, когда модель не сможет создать ответ.	нет
Идентификатор └️	струна	Уникальный идентификатор для этого ответа.	нет
└️ incomplete_details	объект	Сведения о том, почему ответ неполный.	нет
└─ Причина	перечисление	Причина, по которой ответ является неполным. Возможные значения: `max_output_tokens`, `content_filter`	нет
└ Инструкции	строка или массив	Сообщение системы (или разработчика), вставленное в контекст модели. При использовании вместе с `previous_response_id` инструкциями из предыдущего ответа не будут перенесены в следующий ответ. Это упрощает замену системных сообщений (или сообщений разработчиками) в новых ответах.	нет
└️ max_output_tokens	целое число	Верхняя граница для числа маркеров, которые можно создать для ответа, включая видимые выходные маркеры и маркеры причин	нет
└️ max_tool_calls	целое число	Максимальное количество общих вызовов встроенных инструментов, которые могут обрабатываться в ответе. Это максимальное число применяется ко всем встроенным вызовам инструментов, а не для каждого отдельного средства. Любые дальнейшие попытки вызова средства моделью будут игнорироваться.	нет
└─ Метаданные	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате и запроса на объекты через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — это строки с максимальной длиной 512 символов.	нет
└─ Объект	перечисление	Тип объекта этого ресурса — всегда установлено `response`. Возможные значения: `response`	нет
вывод └─	массив	Массив элементов контента, созданных моделью. — длина и порядок элементов в массиве `output` зависит от ответа модели. — Вместо доступа к первому элементу `output` массива и предположения, что это `assistant` сообщение с содержимым, созданным моделью, попробуйте использовать свойство `output_text`, где это поддержано в пакетах SDK.	нет
└️ output_text	струна	Доступное только для пакета SDK свойство, содержащее агрегированные текстовые выходные данные всех `output_text` элементов в массиве `output` , если они присутствуют. Поддерживается в пакетах SDK для Python и JavaScript.	нет
└─ вызовы_инструментов_в_параллельном_режиме	булевый	Следует ли разрешить модели запускать вызовы инструментов параллельно.	нет	True
└previous_response_id	струна	Уникальный идентификатор предыдущего ответа на модель. Используйте эту функцию для создания многоэтапных бесед.	нет
└─ Запрос	OpenAI.Prompt	Ссылка на шаблон запроса и его переменные.	нет
└─ рассуждения	OpenAI.Reasoning	Только модели o-серии Параметры конфигурации для моделей рассуждений.	нет
└─ Состояние	перечисление	Статус формирования ответа. Один из `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete` или . Возможные значения: `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete`	нет
└─ Температура	число/номер	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным. Как правило, мы рекомендуем изменить это или `top_p` не оба.	нет
Текст └️	объект	Параметры конфигурации для текстового ответа модели. Можно использовать обычный текст или структурированные данные JSON.	нет
└─ Формат	OpenAI.ResponseTextFormatConfiguration		нет
└─ выбор_инструмента	OpenAI.ToolChoiceOptions или OpenAI.ToolChoiceObject	Как модель должна выбрать средство (или инструменты), которое следует использовать при создании ответа. Просмотрите `tools` параметр, чтобы узнать, как указать, какие средства модель может вызывать.	нет
└─ Инструменты	массив	Массив инструментов, которые модель может вызывать при создании ответа. Можно указать, какое средство следует использовать, задав `tool_choice` параметр. Ниже приведены две категории инструментов, которые можно предоставить модели: - Встроенные средства: средства, предоставляемые OpenAI, которые расширяют возможности модели.	нет
└️ top_logprobs	целое число	Целое число от 0 до 20, указывающее число наиболее вероятных маркеров, возвращаемых по каждой позиции маркера, каждый из которых имеет связанную вероятность журнала.	нет
└️ top_p	число/номер	Альтернативой выборке с температурой является так называемая выборка ядра, где модель рассматривает результаты маркеров с top_p всего массива значений вероятности. Таким образом, 0,1 означает, что учитываются только маркеры, входящие в верхние 10% массива значений вероятности. Как правило, мы рекомендуем изменить это или `temperature` не оба.	нет
└️ усечение	перечисление	Стратегия усечения, которую следует использовать для генерирования ответа модели. - `auto`: если контекст этого ответа и предыдущих превышает размер окна контекста модели, модель усечет ответ, чтобы он соответствовал этому окну, удаляя элементы ввода в середине беседы. - `disabled` (по умолчанию): если ответ модели превысит размер окна контекста для модели, запрос завершится ошибкой 400. Возможные значения: `auto`, `disabled`	нет
└─ использование	OpenAI.ResponseUsage	Представляет сведения об использовании маркеров, включая входные маркеры, выходные маркеры, разбивку выходных маркеров и общие используемые маркеры.	нет
Пользователь └️	струна	Уникальный идентификатор, представляющий пользователя, который может помочь OpenAI отслеживать и обнаруживать злоупотребления.	нет
type	перечисление	тип события; Всегда `response.completed`. Возможные значения: `response.completed`	Да

OpenAI.ResponseContentPartAddedEvent

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

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

OpenAI.ResponseContentPartDoneEvent

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

Имя.	Тип	Description	Обязательно
content_index	целое число	Индекс завершенной части содержимого.	Да
item_id	струна	Идентификатор выходного элемента, к которому была добавлена часть содержимого.	Да
output_index	целое число	Индекс выходного элемента, к которому была добавлена часть содержимого.	Да
part	объект		Да
└─ Тип	OpenAI.ItemContentType	Много модальное содержимое входных и выходных данных.	нет
type	перечисление	тип события; Всегда `response.content_part.done`. Возможные значения: `response.content_part.done`	Да

OpenAI.ResponseCreatedEvent

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

Имя.	Тип	Description	Обязательно	По умолчанию
response	объект		Да
└─ Фон	булевый	Запускать ли ответ модели в фоновом режиме.	нет	Неправда
└️ created_at	целое число	Метка времени в формате Unix (в секундах), когда был создан этот ответ.	нет
└─ Ошибка	OpenAI.ResponseError	Объект ошибки, возвращаемый, когда модель не сможет создать ответ.	нет
Идентификатор └️	струна	Уникальный идентификатор для этого ответа.	нет
└️ incomplete_details	объект	Сведения о том, почему ответ неполный.	нет
└─ Причина	перечисление	Причина, по которой ответ является неполным. Возможные значения: `max_output_tokens`, `content_filter`	нет
└ Инструкции	строка или массив	Сообщение системы (или разработчика), вставленное в контекст модели. При использовании вместе с `previous_response_id` инструкциями из предыдущего ответа не будут перенесены в следующий ответ. Это упрощает замену системных сообщений (или сообщений разработчиками) в новых ответах.	нет
└️ max_output_tokens	целое число	Верхняя граница для числа маркеров, которые можно создать для ответа, включая видимые выходные маркеры и маркеры причин	нет
└️ max_tool_calls	целое число	Максимальное количество общих вызовов встроенных инструментов, которые могут обрабатываться в ответе. Это максимальное число применяется ко всем встроенным вызовам инструментов, а не для каждого отдельного средства. Любые дальнейшие попытки вызова средства моделью будут игнорироваться.	нет
└─ Метаданные	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате и запроса на объекты через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — это строки с максимальной длиной 512 символов.	нет
└─ Объект	перечисление	Тип объекта этого ресурса — всегда установлено `response`. Возможные значения: `response`	нет
вывод └─	массив	Массив элементов контента, созданных моделью. — длина и порядок элементов в массиве `output` зависит от ответа модели. — Вместо доступа к первому элементу `output` массива и предположения, что это `assistant` сообщение с содержимым, созданным моделью, попробуйте использовать свойство `output_text`, где это поддержано в пакетах SDK.	нет
└️ output_text	струна	Доступное только для пакета SDK свойство, содержащее агрегированные текстовые выходные данные всех `output_text` элементов в массиве `output` , если они присутствуют. Поддерживается в пакетах SDK для Python и JavaScript.	нет
└─ вызовы_инструментов_в_параллельном_режиме	булевый	Следует ли разрешить модели запускать вызовы инструментов параллельно.	нет	True
└previous_response_id	струна	Уникальный идентификатор предыдущего ответа на модель. Используйте эту функцию для создания многоэтапных бесед.	нет
└─ Запрос	OpenAI.Prompt	Ссылка на шаблон запроса и его переменные.	нет
└─ рассуждения	OpenAI.Reasoning	Только модели o-серии Параметры конфигурации для моделей рассуждений.	нет
└─ Состояние	перечисление	Статус формирования ответа. Один из `completed`, `failed` `in_progress`, `cancelled`, `queued` или `incomplete`. Возможные значения: `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete`	нет
└─ Температура	число/номер	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным. Как правило, мы рекомендуем изменить это или `top_p` не оба.	нет
Текст └️	объект	Параметры конфигурации для текстового ответа модели. Можно использовать обычный текст или структурированные данные JSON.	нет
└─ Формат	OpenAI.ResponseTextFormatConfiguration		нет
└─ выбор_инструмента	OpenAI.ToolChoiceOptions или OpenAI.ToolChoiceObject	Как модель должна выбрать средство (или инструменты), которое следует использовать при создании ответа. Просмотрите `tools` параметр, чтобы узнать, как указать, какие средства модель может вызывать.	нет
└─ Инструменты	массив	Массив инструментов, которые модель может вызывать при создании ответа. Можно указать, какое средство следует использовать, задав `tool_choice` параметр. Ниже приведены две категории инструментов, которые можно предоставить модели: - Встроенные средства: средства, предоставляемые OpenAI, которые расширяют возможности модели.	нет
└️ top_logprobs	целое число	Целое число от 0 до 20, указывающее число наиболее вероятных маркеров, возвращаемых по каждой позиции маркера, каждый из которых имеет связанную вероятность журнала.	нет
└️ top_p	число/номер	Альтернативой выборке с температурой является так называемая выборка ядра, где модель рассматривает результаты маркеров с top_p всего массива значений вероятности. Таким образом, 0,1 означает, что учитываются только маркеры, входящие в верхние 10% массива значений вероятности. Как правило, мы рекомендуем изменить это или `temperature` не оба.	нет
└️ усечение	перечисление	Стратегия усечения, которую следует использовать для генерирования ответа модели. - `auto`: если контекст этого ответа и предыдущих превышает размер окна контекста модели, модель усечет ответ, чтобы он соответствовал этому окну, удаляя элементы ввода в середине беседы. - `disabled` (по умолчанию): если ответ модели превысит размер окна контекста для модели, запрос завершится ошибкой 400. Возможные значения: `auto`, `disabled`	нет
└─ использование	OpenAI.ResponseUsage	Представляет сведения об использовании маркеров, включая входные маркеры, выходные маркеры, разбивку выходных маркеров и общие используемые маркеры.	нет
Пользователь └️	струна	Уникальный идентификатор, представляющий пользователя, который может помочь OpenAI отслеживать и обнаруживать злоупотребления.	нет
type	перечисление	тип события; Всегда `response.created`. Возможные значения: `response.created`	Да

OpenAI.ResponseError

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

Имя.	Тип	Description	Обязательно	По умолчанию
код	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

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

Имя.	Тип	Description	Обязательно
код	струна	Код ошибки.	Да
сообщение	струна	Сообщение об ошибке.	Да
параметр	струна	Параметр ошибки.	Да
type	перечисление	тип события; Всегда `error`. Возможные значения: `error`	Да

OpenAI.ResponseFailedEvent

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

Имя.	Тип	Description	Обязательно	По умолчанию
response	объект		Да
└─ Фон	булевый	Запускать ли ответ модели в фоновом режиме.	нет	Неправда
└️ created_at	целое число	Метка времени в формате Unix (в секундах), когда был создан этот ответ.	нет
└─ Ошибка	OpenAI.ResponseError	Объект ошибки, возвращаемый, когда модель не сможет создать ответ.	нет
Идентификатор └️	струна	Уникальный идентификатор для этого ответа.	нет
└️ incomplete_details	объект	Сведения о том, почему ответ неполный.	нет
└─ Причина	перечисление	Причина, по которой ответ является неполным. Возможные значения: `max_output_tokens`, `content_filter`	нет
└ Инструкции	строка или массив	Сообщение системы (или разработчика), вставленное в контекст модели. При использовании вместе с `previous_response_id` инструкциями из предыдущего ответа не будут перенесены в следующий ответ. Это упрощает замену системных сообщений (или сообщений разработчиками) в новых ответах.	нет
└️ max_output_tokens	целое число	Верхняя граница для числа маркеров, которые можно создать для ответа, включая видимые выходные маркеры и маркеры причин	нет
└️ max_tool_calls	целое число	Максимальное количество общих вызовов встроенных инструментов, которые могут обрабатываться в ответе. Это максимальное число применяется ко всем встроенным вызовам инструментов, а не для каждого отдельного средства. Любые дальнейшие попытки вызова средства моделью будут игнорироваться.	нет
└─ Метаданные	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате и запроса на объекты через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — это строки с максимальной длиной 512 символов.	нет
└─ Объект	перечисление	Тип объекта этого ресурса — всегда установлено `response`. Возможные значения: `response`	нет
вывод └─	массив	Массив элементов контента, созданных моделью. — длина и порядок элементов в массиве `output` зависит от ответа модели. — Вместо доступа к первому элементу `output` массива и предположения, что это `assistant` сообщение с содержимым, созданным моделью, попробуйте использовать свойство `output_text`, где это поддержано в пакетах SDK.	нет
└️ output_text	струна	Доступное только для пакета SDK свойство, содержащее агрегированные текстовые выходные данные всех `output_text` элементов в массиве `output` , если они присутствуют. Поддерживается в пакетах SDK для Python и JavaScript.	нет
└─ вызовы_инструментов_в_параллельном_режиме	булевый	Следует ли разрешить модели запускать вызовы инструментов параллельно.	нет	True
└previous_response_id	струна	Уникальный идентификатор предыдущего ответа на модель. Используйте эту функцию для создания многоэтапных бесед.	нет
└─ Запрос	OpenAI.Prompt	Ссылка на шаблон запроса и его переменные.	нет
└─ рассуждения	OpenAI.Reasoning	Только модели o-серии Параметры конфигурации для моделей рассуждений.	нет
└─ Состояние	перечисление	Статус формирования ответа. Один из `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete` или . Возможные значения: `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete`	нет
└─ Температура	число/номер	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным. Как правило, мы рекомендуем изменить это или `top_p` не оба.	нет
Текст └️	объект	Параметры конфигурации для текстового ответа модели. Можно использовать обычный текст или структурированные данные JSON.	нет
└─ Формат	OpenAI.ResponseTextFormatConfiguration		нет
└─ выбор_инструмента	OpenAI.ToolChoiceOptions или OpenAI.ToolChoiceObject	Как модель должна выбрать средство (или инструменты), которое следует использовать при создании ответа. Просмотрите `tools` параметр, чтобы узнать, как указать, какие средства модель может вызывать.	нет
└─ Инструменты	массив	Массив инструментов, которые модель может вызывать при создании ответа. Можно указать, какое средство следует использовать, задав `tool_choice` параметр. Ниже приведены две категории инструментов, которые можно предоставить модели: - Встроенные средства: средства, предоставляемые OpenAI, которые расширяют возможности модели.	нет
└️ top_logprobs	целое число	Целое число от 0 до 20, указывающее число наиболее вероятных маркеров, возвращаемых по каждой позиции маркера, каждый из которых имеет связанную вероятность журнала.	нет
└️ top_p	число/номер	Альтернативой выборке с температурой является так называемая выборка ядра, где модель рассматривает результаты маркеров с top_p всего массива значений вероятности. Таким образом, 0,1 означает, что учитываются только маркеры, входящие в верхние 10% массива значений вероятности. Как правило, мы рекомендуем изменить это или `temperature` не оба.	нет
└️ усечение	перечисление	Стратегия усечения, которую следует использовать для генерирования ответа модели. - `auto`: если контекст этого ответа и предыдущих превышает размер окна контекста модели, модель усечет ответ, чтобы он соответствовал этому окну, удаляя элементы ввода в середине беседы. - `disabled` (по умолчанию): если ответ модели превысит размер окна контекста для модели, запрос завершится ошибкой 400. Возможные значения: `auto`, `disabled`	нет
└─ использование	OpenAI.ResponseUsage	Представляет сведения об использовании маркеров, включая входные маркеры, выходные маркеры, разбивку выходных маркеров и общие используемые маркеры.	нет
Пользователь └️	струна	Уникальный идентификатор, представляющий пользователя, который может помочь OpenAI отслеживать и обнаруживать злоупотребления.	нет
type	перечисление	тип события; Всегда `response.failed`. Возможные значения: `response.failed`	Да

OpenAI.ResponseFileSearchCallCompletedEvent

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

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

OpenAI.ResponseFileSearchCallInProgressEvent

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

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

OpenAI.ResponseFileSearchCallSearchingEvent

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

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

OpenAI.ResponseFormat

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

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

Значение типа	Схема
`text`	OpenAI.ResponseFormatText
`json_object`	OpenAI.ResponseFormatJsonObject
`json_schema`	OpenAI.ResponseFormatJsonSchema

Имя.	Тип	Description	Обязательно	По умолчанию
type	перечисление	Возможные значения: `text`, `json_objectjson_schema`	Да

OpenAI.ResponseFormatJsonObject

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

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

OpenAI.ResponseFormatJsonSchema

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

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

OpenAI.ResponseFormatJsonSchema

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

Тип: объект

OpenAI.ResponseFormatText

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

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

OpenAI.ResponseFunctionCallArgumentsDeltaEvent

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

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

OpenAI.ResponseFunctionCallArgumentsDoneEvent

Вызывается, когда аргументы вызова функции завершены.

Имя.	Тип	Description	Обязательно
arguments	струна	Аргументы вызова функции.	Да
item_id	струна	Идентификатор элемента.	Да
output_index	целое число	Индекс выходного элемента.	Да
type	перечисление	Возможные значения: `response.function_call_arguments.done`	Да

OpenAI.ResponseImageGenCallCompletedEvent

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

Имя.	Тип	Description	Обязательно
item_id	струна	Уникальный идентификатор обрабатываемого элемента создания изображения.	Да
output_index	целое число	Индекс выходного элемента в выходном массиве ответа.	Да
type	перечисление	тип события; Всегда "response.image_generation_call.completed". Возможные значения: `response.image_generation_call.completed`	Да

OpenAI.ResponseImageGenCallGeneratingEvent

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

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

OpenAI.ResponseImageGenCallInProgressEvent

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

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

OpenAI.ResponseImageGenCallPartialImageEvent

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

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

OpenAI.ResponseInProgressEvent

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

Имя.	Тип	Description	Обязательно	По умолчанию
response	объект		Да
└─ Фон	булевый	Запускать ли ответ модели в фоновом режиме.	нет	Неправда
└️ created_at	целое число	Метка времени в формате Unix (в секундах), когда был создан этот ответ.	нет
└─ Ошибка	OpenAI.ResponseError	Объект ошибки, возвращаемый, когда модель не сможет создать ответ.	нет
Идентификатор └️	струна	Уникальный идентификатор для этого ответа.	нет
└️ incomplete_details	объект	Сведения о том, почему ответ неполный.	нет
└─ Причина	перечисление	Причина, по которой ответ является неполным. Возможные значения: `max_output_tokens`, `content_filter`	нет
└ Инструкции	строка или массив	Сообщение системы (или разработчика), вставленное в контекст модели. При использовании вместе с `previous_response_id` инструкциями из предыдущего ответа не будут перенесены в следующий ответ. Это упрощает замену системных сообщений (или сообщений разработчиками) в новых ответах.	нет
└️ max_output_tokens	целое число	Верхняя граница для числа маркеров, которые можно создать для ответа, включая видимые выходные маркеры и маркеры причин	нет
└️ max_tool_calls	целое число	Максимальное количество общих вызовов встроенных инструментов, которые могут обрабатываться в ответе. Это максимальное число применяется ко всем встроенным вызовам инструментов, а не для каждого отдельного средства. Любые дальнейшие попытки вызова средства моделью будут игнорироваться.	нет
└─ Метаданные	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате и запроса на объекты через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — это строки с максимальной длиной 512 символов.	нет
└─ Объект	перечисление	Тип объекта этого ресурса — всегда установлено `response`. Возможные значения: `response`	нет
вывод └─	массив	Массив элементов контента, созданных моделью. — длина и порядок элементов в массиве `output` зависит от ответа модели. — Вместо доступа к первому элементу `output` массива и предположения, что это `assistant` сообщение с содержимым, созданным моделью, попробуйте использовать свойство `output_text`, где это поддержано в пакетах SDK.	нет
└️ output_text	струна	Доступное только для пакета SDK свойство, содержащее агрегированные текстовые выходные данные всех `output_text` элементов в массиве `output` , если они присутствуют. Поддерживается в пакетах SDK для Python и JavaScript.	нет
└─ вызовы_инструментов_в_параллельном_режиме	булевый	Следует ли разрешить модели запускать вызовы инструментов параллельно.	нет	True
└previous_response_id	струна	Уникальный идентификатор предыдущего ответа на модель. Используйте эту функцию для создания многоэтапных бесед.	нет
└─ Запрос	OpenAI.Prompt	Ссылка на шаблон запроса и его переменные.	нет
└─ рассуждения	OpenAI.Reasoning	Только модели o-серии Параметры конфигурации для моделей рассуждений.	нет
└─ Состояние	перечисление	Статус формирования ответа. Один из `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete` или . Возможные значения: `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete`	нет
└─ Температура	число/номер	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным. Как правило, мы рекомендуем изменить это или `top_p` не оба.	нет
Текст └️	объект	Параметры конфигурации для текстового ответа модели. Можно использовать обычный текст или структурированные данные JSON.	нет
└─ Формат	OpenAI.ResponseTextFormatConfiguration		нет
└─ выбор_инструмента	OpenAI.ToolChoiceOptions или OpenAI.ToolChoiceObject	Как модель должна выбрать средство (или инструменты), которое следует использовать при создании ответа. Просмотрите `tools` параметр, чтобы узнать, как указать, какие средства модель может вызывать.	нет
└─ Инструменты	массив	Массив инструментов, которые модель может вызывать при создании ответа. Можно указать, какое средство следует использовать, задав `tool_choice` параметр. Ниже приведены две категории инструментов, которые можно предоставить модели: - Встроенные средства: средства, предоставляемые OpenAI, которые расширяют возможности модели.	нет
└️ top_logprobs	целое число	Целое число от 0 до 20, указывающее число наиболее вероятных маркеров, возвращаемых по каждой позиции маркера, каждый из которых имеет связанную вероятность журнала.	нет
└️ top_p	число/номер	Альтернативой выборке с температурой является так называемая выборка ядра, где модель рассматривает результаты маркеров с top_p всего массива значений вероятности. Таким образом, 0,1 означает, что учитываются только маркеры, входящие в верхние 10% массива значений вероятности. Как правило, мы рекомендуем изменить это или `temperature` не оба.	нет
└️ усечение	перечисление	Стратегия усечения, которую следует использовать для генерирования ответа модели. - `auto`: если контекст этого ответа и предыдущих превышает размер окна контекста модели, модель усечет ответ, чтобы он соответствовал этому окну, удаляя элементы ввода в середине беседы. - `disabled` (по умолчанию): если ответ модели превысит размер окна контекста для модели, запрос завершится ошибкой 400. Возможные значения: `auto`, `disabled`	нет
└─ использование	OpenAI.ResponseUsage	Представляет сведения об использовании маркеров, включая входные маркеры, выходные маркеры, разбивку выходных маркеров и общие используемые маркеры.	нет
Пользователь └️	струна	Уникальный идентификатор, представляющий пользователя, который может помочь OpenAI отслеживать и обнаруживать злоупотребления.	нет
type	перечисление	тип события; Всегда `response.in_progress`. Возможные значения: `response.in_progress`	Да

OpenAI.ResponseIncompleteEvent

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

Имя.	Тип	Description	Обязательно	По умолчанию
response	объект		Да
└─ Фон	булевый	Запускать ли ответ модели в фоновом режиме.	нет	Неправда
└️ created_at	целое число	Метка времени в формате Unix (в секундах), когда был создан этот ответ.	нет
└─ Ошибка	OpenAI.ResponseError	Объект ошибки, возвращаемый, когда модель не сможет создать ответ.	нет
Идентификатор └️	струна	Уникальный идентификатор для этого ответа.	нет
└️ incomplete_details	объект	Сведения о том, почему ответ неполный.	нет
└─ Причина	перечисление	Причина, по которой ответ является неполным. Возможные значения: `max_output_tokens`, `content_filter`	нет
└ Инструкции	строка или массив	Сообщение системы (или разработчика), вставленное в контекст модели. При использовании вместе с `previous_response_id` инструкциями из предыдущего ответа не будут перенесены в следующий ответ. Это упрощает замену системных сообщений (или сообщений разработчиками) в новых ответах.	нет
└️ max_output_tokens	целое число	Верхняя граница для числа маркеров, которые можно создать для ответа, включая видимые выходные маркеры и маркеры причин	нет
└️ max_tool_calls	целое число	Максимальное количество общих вызовов встроенных инструментов, которые могут обрабатываться в ответе. Это максимальное число применяется ко всем встроенным вызовам инструментов, а не для каждого отдельного средства. Любые дальнейшие попытки вызова средства моделью будут игнорироваться.	нет
└─ Метаданные	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате и запроса на объекты через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — это строки с максимальной длиной 512 символов.	нет
└─ Объект	перечисление	Тип объекта этого ресурса — всегда установлено `response`. Возможные значения: `response`	нет
вывод └─	массив	Массив элементов контента, созданных моделью. — длина и порядок элементов в массиве `output` зависит от ответа модели. — Вместо доступа к первому элементу `output` массива и предположения, что это `assistant` сообщение с содержимым, созданным моделью, попробуйте использовать свойство `output_text`, где это поддержано в пакетах SDK.	нет
└️ output_text	струна	Доступное только для пакета SDK свойство, содержащее агрегированные текстовые выходные данные всех `output_text` элементов в массиве `output` , если они присутствуют. Поддерживается в пакетах SDK для Python и JavaScript.	нет
└─ вызовы_инструментов_в_параллельном_режиме	булевый	Следует ли разрешить модели запускать вызовы инструментов параллельно.	нет	True
└previous_response_id	струна	Уникальный идентификатор предыдущего ответа на модель. Используйте эту функцию для создания многоэтапных бесед.	нет
└─ Запрос	OpenAI.Prompt	Ссылка на шаблон запроса и его переменные.	нет
└─ рассуждения	OpenAI.Reasoning	Только модели o-серии Параметры конфигурации для моделей рассуждений.	нет
└─ Состояние	перечисление	Статус формирования ответа. Один из `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete` или . Возможные значения: `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete`	нет
└─ Температура	число/номер	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным. Как правило, мы рекомендуем изменить это или `top_p` не оба.	нет
Текст └️	объект	Параметры конфигурации для текстового ответа модели. Можно использовать обычный текст или структурированные данные JSON.	нет
└─ Формат	OpenAI.ResponseTextFormatConfiguration		нет
└─ выбор_инструмента	OpenAI.ToolChoiceOptions или OpenAI.ToolChoiceObject	Как модель должна выбрать средство (или инструменты), которое следует использовать при создании ответа. Просмотрите `tools` параметр, чтобы узнать, как указать, какие средства модель может вызывать.	нет
└─ Инструменты	массив	Массив инструментов, которые модель может вызывать при создании ответа. Можно указать, какое средство следует использовать, задав `tool_choice` параметр. Ниже приведены две категории инструментов, которые можно предоставить модели: - Встроенные средства: средства, предоставляемые OpenAI, которые расширяют возможности модели.	нет
└️ top_logprobs	целое число	Целое число от 0 до 20, указывающее число наиболее вероятных маркеров, возвращаемых по каждой позиции маркера, каждый из которых имеет связанную вероятность журнала.	нет
└️ top_p	число/номер	Альтернативой выборке с температурой является так называемая выборка ядра, где модель рассматривает результаты маркеров с top_p всего массива значений вероятности. Таким образом, 0,1 означает, что учитываются только маркеры, входящие в верхние 10% массива значений вероятности. Как правило, мы рекомендуем изменить это или `temperature` не оба.	нет
└️ усечение	перечисление	Стратегия усечения, которую следует использовать для генерирования ответа модели. - `auto`: если контекст этого ответа и предыдущих превышает размер окна контекста модели, модель усечет ответ, чтобы он соответствовал этому окну, удаляя элементы ввода в середине беседы. - `disabled` (по умолчанию): если ответ модели превысит размер окна контекста для модели, запрос завершится ошибкой 400. Возможные значения: `auto`, `disabled`	нет
└─ использование	OpenAI.ResponseUsage	Представляет сведения об использовании маркеров, включая входные маркеры, выходные маркеры, разбивку выходных маркеров и общие используемые маркеры.	нет
Пользователь └️	струна	Уникальный идентификатор, представляющий пользователя, который может помочь OpenAI отслеживать и обнаруживать злоупотребления.	нет
type	перечисление	тип события; Всегда `response.incomplete`. Возможные значения: `response.incomplete`	Да

OpenAI.ResponseItemList

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

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

OpenAI.ResponseMCPCallArgumentsDeltaEvent

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

Имя.	Тип	Description	Обязательно
delta		Частичное обновление аргументов для вызова средства MCP.	Да
item_id	струна	Уникальный идентификатор обрабатываемого элемента вызова средства MCP.	Да
output_index	целое число	Индекс выходного элемента в выходном массиве ответа.	Да
type	перечисление	тип события; Всегда «response.mcp_call.arguments_delta». Возможные значения: `response.mcp_call.arguments_delta`	Да

OpenAI.ResponseMCPCallArgumentsDoneEvent

Генерируется, когда аргументы для вызова инструмента MCP завершены.

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

OpenAI.ResponseMCPCallCompletedEvent

Срабатывает при успешном выполнении вызова средства MCP.

Имя.	Тип	Description	Обязательно	По умолчанию
type	перечисление	тип события; Всегда «response.mcp_call.completed». Возможные значения: `response.mcp_call.completed`	Да

OpenAI.ResponseMCPCallFailedEvent

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

Имя.	Тип	Description	Обязательно	По умолчанию
type	перечисление	тип события; Всегда "response.mcp_call.failed". Возможные значения: `response.mcp_call.failed`	Да

OpenAI.ResponseMCPCallInProgressEvent

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

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

OpenAI.ResponseMCPListToolsCompletedEvent

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

Имя.	Тип	Description	Обязательно	По умолчанию
type	перечисление	тип события; Всегда "response.mcp_list_tools.completed". Возможные значения: `response.mcp_list_tools.completed`	Да

OpenAI.ResponseMCPListToolsFailedEvent

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

Имя.	Тип	Description	Обязательно	По умолчанию
type	перечисление	тип события; Всегда "response.mcp_list_tools.failed". Возможные значения: `response.mcp_list_tools.failed`	Да

OpenAI.ResponseMCPListToolsInProgressEvent

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

Имя.	Тип	Description	Обязательно	По умолчанию
type	перечисление	тип события; Всегда "response.mcp_list_tools.in_progress". Возможные значения: `response.mcp_list_tools.in_progress`	Да

OpenAI.ResponseOutputItemAddedEvent

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

Имя.	Тип	Description	Обязательно
item	объект	Элемент содержимого, используемый для создания ответа.	Да
Идентификатор └️	струна		нет
└─ Тип	OpenAI.ItemType		нет
output_index	целое число	Индекс добавленного выходного элемента.	Да
type	перечисление	тип события; Всегда `response.output_item.added`. Возможные значения: `response.output_item.added`	Да

OpenAI.ResponseOutputItemDoneEvent

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

Имя.	Тип	Description	Обязательно
item	объект	Элемент содержимого, используемый для создания ответа.	Да
Идентификатор └️	струна		нет
└─ Тип	OpenAI.ItemType		нет
output_index	целое число	Индекс выходного элемента, помеченного как выполненный.	Да
type	перечисление	тип события; Всегда `response.output_item.done`. Возможные значения: `response.output_item.done`	Да

OpenAI.ResponsePromptVariables

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

Тип: объект

OpenAI.ResponseQueuedEvent

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

Имя.	Тип	Description	Обязательно	По умолчанию
response	объект		Да
└─ Фон	булевый	Запускать ли ответ модели в фоновом режиме.	нет	Неправда
└️ created_at	целое число	Метка времени в формате Unix (в секундах), когда был создан этот ответ.	нет
└─ Ошибка	OpenAI.ResponseError	Объект ошибки, возвращаемый, когда модель не сможет создать ответ.	нет
Идентификатор └️	струна	Уникальный идентификатор для этого ответа.	нет
└️ incomplete_details	объект	Сведения о том, почему ответ неполный.	нет
└─ Причина	перечисление	Причина, по которой ответ является неполным. Возможные значения: `max_output_tokens`, `content_filter`	нет
└ Инструкции	строка или массив	Сообщение системы (или разработчика), вставленное в контекст модели. При использовании вместе с `previous_response_id` инструкциями из предыдущего ответа не будут перенесены в следующий ответ. Это упрощает замену системных сообщений (или сообщений разработчиками) в новых ответах.	нет
└️ max_output_tokens	целое число	Верхняя граница для числа маркеров, которые можно создать для ответа, включая видимые выходные маркеры и маркеры причин	нет
└️ max_tool_calls	целое число	Максимальное количество общих вызовов встроенных инструментов, которые могут обрабатываться в ответе. Это максимальное число применяется ко всем встроенным вызовам инструментов, а не для каждого отдельного средства. Любые дальнейшие попытки вызова средства моделью будут игнорироваться.	нет
└─ Метаданные	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате и запроса на объекты через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — это строки с максимальной длиной 512 символов.	нет
└─ Объект	перечисление	Тип объекта этого ресурса — всегда установлено `response`. Возможные значения: `response`	нет
вывод └─	массив	Массив элементов контента, созданных моделью. — длина и порядок элементов в массиве `output` зависит от ответа модели. — Вместо доступа к первому элементу `output` массива и предположения, что это `assistant` сообщение с содержимым, созданным моделью, попробуйте использовать свойство `output_text`, где это поддержано в пакетах SDK.	нет
└️ output_text	струна	Доступное только для пакета SDK свойство, содержащее агрегированные текстовые выходные данные всех `output_text` элементов в массиве `output` , если они присутствуют. Поддерживается в пакетах SDK для Python и JavaScript.	нет
└─ вызовы_инструментов_в_параллельном_режиме	булевый	Следует ли разрешить модели запускать вызовы инструментов параллельно.	нет	True
└previous_response_id	струна	Уникальный идентификатор предыдущего ответа на модель. Используйте эту функцию для создания многоэтапных бесед.	нет
└─ Запрос	OpenAI.Prompt	Ссылка на шаблон запроса и его переменные.	нет
└─ рассуждения	OpenAI.Reasoning	Только модели o-серии Параметры конфигурации для моделей рассуждений.	нет
└─ Состояние	перечисление	Статус формирования ответа. Один из `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete` или . Возможные значения: `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete`	нет
└─ Температура	число/номер	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным. Как правило, мы рекомендуем изменить это или `top_p` не оба.	нет
Текст └️	объект	Параметры конфигурации для текстового ответа модели. Можно использовать обычный текст или структурированные данные JSON.	нет
└─ Формат	OpenAI.ResponseTextFormatConfiguration		нет
└─ выбор_инструмента	OpenAI.ToolChoiceOptions или OpenAI.ToolChoiceObject	Как модель должна выбрать средство (или инструменты), которое следует использовать при создании ответа. Просмотрите `tools` параметр, чтобы узнать, как указать, какие средства модель может вызывать.	нет
└─ Инструменты	массив	Массив инструментов, которые модель может вызывать при создании ответа. Можно указать, какое средство следует использовать, задав `tool_choice` параметр. Ниже приведены две категории инструментов, которые можно предоставить модели: - Встроенные средства: средства, предоставляемые OpenAI, которые расширяют возможности модели.	нет
└️ top_logprobs	целое число	Целое число от 0 до 20, указывающее число наиболее вероятных маркеров, возвращаемых по каждой позиции маркера, каждый из которых имеет связанную вероятность журнала.	нет
└️ top_p	число/номер	Альтернативой выборке с температурой является так называемая выборка ядра, где модель рассматривает результаты маркеров с top_p всего массива значений вероятности. Таким образом, 0,1 означает, что учитываются только маркеры, входящие в верхние 10% массива значений вероятности. Как правило, мы рекомендуем изменить это или `temperature` не оба.	нет
└️ усечение	перечисление	Стратегия усечения, которую следует использовать для генерирования ответа модели. - `auto`: если контекст этого ответа и предыдущих превышает размер окна контекста модели, модель усечет ответ, чтобы он соответствовал этому окну, удаляя элементы ввода в середине беседы. - `disabled` (по умолчанию): если ответ модели превысит размер окна контекста для модели, запрос завершится ошибкой 400. Возможные значения: `auto`, `disabled`	нет
└─ использование	OpenAI.ResponseUsage	Представляет сведения об использовании маркеров, включая входные маркеры, выходные маркеры, разбивку выходных маркеров и общие используемые маркеры.	нет
Пользователь └️	струна	Уникальный идентификатор, представляющий пользователя, который может помочь OpenAI отслеживать и обнаруживать злоупотребления.	нет
type	перечисление	тип события; Всегда «response.queued». Возможные значения: `response.queued`	Да

OpenAI.ResponseReasoningDeltaEvent

Генерируется при изменении (частичном обновлении) содержимого рассуждений.

Имя.	Тип	Description	Обязательно
content_index	целое число	Индекс содержательного аспекта рассуждений в выходном элементе.	Да
delta		Частичное обновление содержания рассуждения.	Да
item_id	струна	Уникальный идентификатор элемента, по которому обновляется обоснование.	Да
output_index	целое число	Индекс выходного элемента в выходном массиве ответа.	Да
type	перечисление	тип события; Всегда "response.reasoning.delta". Возможные значения: `response.reasoning.delta`	Да

OpenAI.ResponseReasoningDoneEvent

Генерируется при завершении логического содержимого для элемента.

Имя.	Тип	Description	Обязательно
content_index	целое число	Индекс содержательного аспекта рассуждений в выходном элементе.	Да
item_id	струна	Уникальный идентификатор элемента, по которому завершается обоснование.	Да
output_index	целое число	Индекс выходного элемента в выходном массиве ответа.	Да
текст	струна	Завершенный текст обоснования.	Да
type	перечисление	тип события; Всегда "response.reasoning.done". Возможные значения: `response.reasoning.done`	Да

OpenAI.ResponseReasoningSummaryDeltaEvent

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

Имя.	Тип	Description	Обязательно
delta		Частичное обновление содержимого сводки причин.	Да
item_id	струна	Уникальный идентификатор элемента, для которого обновляется сводка по причинам.	Да
output_index	целое число	Индекс выходного элемента в выходном массиве ответа.	Да
summary_index	целое число	Индекс сводной части в выходном элементе.	Да
type	перечисление	тип события; Всегда "response.reasoning_summary.delta". Возможные значения: `response.reasoning_summary.delta`	Да

OpenAI.ResponseReasoningSummaryDoneEvent

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

Имя.	Тип	Description	Обязательно
item_id	струна	Уникальный идентификатор элемента, для которого завершается сводка причин.	Да
output_index	целое число	Индекс выходного элемента в выходном массиве ответа.	Да
summary_index	целое число	Индекс сводной части в выходном элементе.	Да
текст	струна	Завершенный текст резюме рассуждений.	Да
type	перечисление	тип события; Всегда "response.reasoning_summary.готово". Возможные значения: `response.reasoning_summary.done`	Да

OpenAI.ResponseReasoningSummaryPartAddedEvent

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

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

OpenAI.ResponseReasoningSummaryPartDoneEvent

Испускается при завершении части обоснования.

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

OpenAI.ResponseReasoningSummaryTextDeltaEvent

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

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

OpenAI.ResponseReasoningSummaryTextDoneEvent

Генерируется при завершении сводного текста аргументирования.

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

OpenAI.ResponseRefusalDeltaEvent

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

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

OpenAI.ResponseRefusalDoneEvent

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

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

OpenAI.ResponseStreamEvent

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

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

Значение типа	Схема
`response.completed`	OpenAI.ResponseCompletedEvent
`response.content_part.added`	OpenAI.ResponseContentPartAddedEvent
`response.content_part.done`	OpenAI.ResponseContentPartDoneEvent
`response.created`	OpenAI.ResponseCreatedEvent
`error`	OpenAI.ResponseErrorEvent
`response.file_search_call.completed`	OpenAI.ResponseFileSearchCallCompletedEvent
`response.file_search_call.in_progress`	OpenAI.ResponseFileSearchCallInProgressEvent
`response.file_search_call.searching`	OpenAI.ResponseFileSearchCallSearchingEvent
`response.function_call_arguments.delta`	OpenAI.ResponseFunctionCallArgumentsDeltaEvent
`response.function_call_arguments.done`	OpenAI.ResponseFunctionCallArgumentsDoneEvent
`response.in_progress`	OpenAI.ResponseInProgressEvent
`response.failed`	OpenAI.ResponseFailedEvent
`response.incomplete`	OpenAI.ResponseIncompleteEvent
`response.output_item.added`	OpenAI.ResponseOutputItemAddedEvent
`response.output_item.done`	OpenAI.ResponseOutputItemDoneEvent
`response.refusal.delta`	OpenAI.ResponseRefusalDeltaEvent
`response.refusal.done`	OpenAI.ResponseRefusalDoneEvent
`response.output_text.delta`	OpenAI.ResponseTextDeltaEvent
`response.output_text.done`	OpenAI.ResponseTextDoneEvent
`response.reasoning_summary_part.added`	OpenAI.ResponseReasoningSummaryPartAddedEvent
`response.reasoning_summary_part.done`	OpenAI.ResponseReasoningSummaryPartDoneEvent
`response.reasoning_summary_text.delta`	OpenAI.ResponseReasoningSummaryTextDeltaEvent
`response.reasoning_summary_text.done`	OpenAI.ResponseReasoningSummaryTextDoneEvent
`response.web_search_call.completed`	OpenAI.ResponseWebSearchCallCompletedEvent
`response.web_search_call.in_progress`	OpenAI.ResponseWebSearchCallInProgressEvent
`response.web_search_call.searching`	OpenAI.ResponseWebSearchCallSearchingEvent
`response.image_generation_call.completed`	OpenAI.ResponseImageGenCallCompletedEvent
`response.image_generation_call.generating`	OpenAI.ResponseImageGenCallGeneratingEvent
`response.image_generation_call.in_progress`	OpenAI.ResponseImageGenCallInProgressEvent
`response.image_generation_call.partial_image`	OpenAI.ResponseImageGenCallPartialImageEvent
`response.mcp_call.arguments_delta`	OpenAI.ResponseMCPCallArgumentsDeltaEvent
`response.mcp_call.arguments_done`	OpenAI.ResponseMCPCallArgumentsDoneEvent
`response.mcp_call.completed`	OpenAI.ResponseMCPCallCompletedEvent
`response.mcp_call.failed`	OpenAI.ResponseMCPCallFailedEvent
`response.mcp_call.in_progress`	OpenAI.ResponseMCPCallInProgressEvent
`response.mcp_list_tools.completed`	OpenAI.ResponseMCPListToolsCompletedEvent
`response.mcp_list_tools.failed`	OpenAI.ResponseMCPListToolsFailedEvent
`response.mcp_list_tools.in_progress`	OpenAI.ResponseMCPListToolsInProgressEvent
`response.queued`	OpenAI.ResponseQueuedEvent
`response.reasoning.delta`	OpenAI.ResponseReasoningDeltaEvent
`response.reasoning.done`	OpenAI.ResponseReasoningDoneEvent
`response.reasoning_summary.delta`	OpenAI.ResponseReasoningSummaryDeltaEvent
`response.reasoning_summary.done`	OpenAI.ResponseReasoningSummaryDoneEvent
`response.code_interpreter_call_code.delta`	OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent
`response.code_interpreter_call_code.done`	OpenAI.ResponseCodeInterpreterCallCodeDoneEvent
`response.code_interpreter_call.completed`	OpenAI.ResponseCodeInterpreterCallCompletedEvent
`response.code_interpreter_call.in_progress`	OpenAI.ResponseCodeInterpreterCallInProgressEvent
`response.code_interpreter_call.interpreting`	OpenAI.ResponseCodeInterpreterCallInterpretingEvent

Имя.	Тип	Description	Обязательно	По умолчанию
sequence_number	целое число	Порядковый номер для этого события.	Да
type	OpenAI.ResponseStreamEventType		Да

OpenAI.ResponseStreamEventType

Недвижимость Ценность

Тип струна

Значения response.audio.delta
response.audio.done
response.audio_transcript.delta
response.audio_transcript.done
response.code_interpreter_call_code.delta
response.code_interpreter_call_code.done
response.code_interpreter_call.completed
response.code_interpreter_call.in_progress
response.code_interpreter_call.interpreting
response.completed
response.content_part.added
response.content_part.done
response.created
error
response.file_search_call.completed
response.file_search_call.in_progress
response.file_search_call.searching
response.function_call_arguments.delta
response.function_call_arguments.done
response.in_progress
response.failed
response.incomplete
response.output_item.added
response.output_item.done
response.refusal.delta
response.refusal.done
response.output_text.annotation.added
response.output_text.delta
response.output_text.done
response.reasoning_summary_part.added
response.reasoning_summary_part.done
response.reasoning_summary_text.delta
response.reasoning_summary_text.done
response.web_search_call.completed
response.web_search_call.in_progress
response.web_search_call.searching
response.image_generation_call.completed
response.image_generation_call.generating
response.image_generation_call.in_progress
response.image_generation_call.partial_image
response.mcp_call.arguments_delta
response.mcp_call.arguments_done
response.mcp_call.completed
response.mcp_call.failed
response.mcp_call.in_progress
response.mcp_list_tools.completed
response.mcp_list_tools.failed
response.mcp_list_tools.in_progress
response.queued
response.reasoning.delta
response.reasoning.done
response.reasoning_summary.delta
response.reasoning_summary.done

OpenAI.ResponseTextDeltaEvent

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

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

OpenAI.ResponseTextDoneEvent

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

Имя.	Тип	Description	Обязательно
content_index	целое число	Индекс части содержимого, где завершается текстовое содержимое.	Да
item_id	струна	Идентификатор выходного элемента, для которого завершается текстовое содержимое.	Да
output_index	целое число	Индекс выходного элемента, в котором завершается текстовое содержимое.	Да
текст	струна	Текстовое содержимое, завершенное.	Да
type	перечисление	тип события; Всегда `response.output_text.done`. Возможные значения: `response.output_text.done`	Да

OpenAI.ResponseTextFormatConfiguration

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

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

Значение типа	Схема
`text`	OpenAI.ResponseTextFormatConfigurationText
`json_object`	OpenAI.ResponseTextFormatConfigurationJsonObject
`json_schema`	Конфигурация текстового формата ответа OpenAI (OpenAI.ResponseTextFormatConfigurationJsonSchema)

Имя.	Тип	Description	Обязательно	По умолчанию
type	OpenAI.ResponseTextFormatConfigurationType	Объект, указывающий формат, который должен выводить модель. Настройка `{ "type": "json_schema" }` включает структурированные выходные данные, что гарантирует, что модель будет соответствовать предоставленной схеме JSON. Формат по умолчанию — это `{ "type": "text" }` без дополнительных параметров. Не рекомендуется использовать для gpt-4o и более новых моделей: Настройка для `{ "type": "json_object" }` включает старый режим JSON, который гарантирует, что создаваемое моделью сообщение является допустимым JSON. Использование `json_schema` предпочтительнее для моделей, поддерживающих его.	Да

OpenAI.ResponseTextFormatConfigurationJsonObject (формат конфигурации объекта JSON ответа)

Имя.	Тип	Description	Обязательно	По умолчанию
type	перечисление	Возможные значения: `json_object`	Да

OpenAI.ResponseTextFormatConfigurationJsonSchema

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

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

OpenAI.ResponseTextFormatConfigurationText

Имя.	Тип	Description	Обязательно	По умолчанию
type	перечисление	Возможные значения: `text`	Да

OpenAI.ResponseTextFormatConfigurationType

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

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

Формат по умолчанию — это { "type": "text" } без дополнительных параметров.

Не рекомендуется использовать для gpt-4o и более новых моделей:

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

Недвижимость	Ценность
Описание	Объект, указывающий формат, который должен выводить модель.

Формат по умолчанию — это { "type": "text" } без дополнительных параметров.

Не рекомендуется использовать для gpt-4o и более новых моделей:

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

OpenAI.ResponseUsage

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

Имя.	Тип	Description	Обязательно
input_tokens	целое число	Количество входных токенов.	Да
input_tokens_details	объект	Подробная разбивка входных токенов.	Да
└ cached_tokens	целое число	Количество токенов, полученных из кэша.	нет
output_tokens	целое число	Количество выходных токенов.	Да
output_tokens_details	объект	Подробная разбивка выходных маркеров.	Да
└️ reasoning_tokens	целое число	Количество токенов рассуждения.	нет
общее количество токенов	целое число	Общее количество используемых токенов.	Да

OpenAI.ResponseWebSearchCallCompletedEvent

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

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

OpenAI.ResponseWebSearchCallInProgressEvent

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

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

OpenAI.ResponseWebSearchCallSearchingEvent

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

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

OpenAI.ResponsesAssistantMessageItemParam

Элемент параметра сообщения с ролью assistant .

Имя.	Тип	Description	Обязательно	По умолчанию
содержимое	массив	Содержимое, связанное с сообщением.	Да
роль	перечисление	Роль сообщения, которая всегда `assistant`. Возможные значения: `assistant`	Да

OpenAI.ResponsesAssistantMessageItemResource

Элемент сообщения из ресурса с ролью assistant.

Имя.	Тип	Description	Обязательно	По умолчанию
содержимое	массив	Содержимое, связанное с сообщением.	Да
роль	перечисление	Роль сообщения, которая всегда `assistant`. Возможные значения: `assistant`	Да

OpenAI.ResponsesDeveloperMessageItemParam

Элемент параметра сообщения с ролью developer .

Имя.	Тип	Description	Обязательно	По умолчанию
содержимое	массив	Содержимое, связанное с сообщением.	Да
роль	перечисление	Роль сообщения, которая всегда `developer`. Возможные значения: `developer`	Да

OpenAI.ResponsesDeveloperMessageItemResource

Элемент сообщения из ресурса с ролью developer.

Имя.	Тип	Description	Обязательно	По умолчанию
содержимое	массив	Содержимое, связанное с сообщением.	Да
роль	перечисление	Роль сообщения, которая всегда `developer`. Возможные значения: `developer`	Да

OpenAI.ResponsesMessageItemParam

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

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

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

Значение типа	Схема
`user`	OpenAI.ResponsesUserMessageItemParam
`system`	OpenAI.ResponsesSystemMessageItemParam
`developer`	OpenAI.ResponsesDeveloperMessageItemParam
`assistant`	OpenAI.ResponsesAssistantMessageItemParam

Имя.	Тип	Description	Обязательно	По умолчанию
роль	объект	Коллекция допустимых ролей для элементов сообщений, связанных с ответами.	Да
type	перечисление	Тип элемента ответа, который всегда является сообщением. Возможные значения: `message`	Да

OpenAI.ResponsesMessageItemResource

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

Дискриминатор для OpenAI.ResponsesMessageItemResource

Этот компонент использует свойство role для дискриминации между различными типами:

Значение типа	Схема
`user`	OpenAI.ResponsesUserMessageItemResource
`system`	OpenAI.ResponsesSystemMessageItemResource
`developer`	OpenAI.ResponsesDeveloperMessageItemResource
`assistant`	OpenAI.ResponsesAssistantMessageItemResource

Имя.	Тип	Description	Обязательно
роль	объект	Коллекция допустимых ролей для элементов сообщений, связанных с ответами.	Да
статус	перечисление	Состояние элемента. Один из `in_progress`, `completed`, или `incomplete`. Заполняется, когда элементы возвращаются через API. Возможные значения: `in_progress`, `completedincomplete`	Да
type	перечисление	Тип элемента ответа, который всегда является сообщением. Возможные значения: `message`	Да

OpenAI.ResponsesMessageRole

Коллекция допустимых ролей для элементов сообщений, связанных с ответами.

Недвижимость	Ценность
Описание	Коллекция допустимых ролей для элементов сообщений, связанных с ответами.
Тип	струна
Значения	`system` `developer` `user` `assistant`

OpenAI.ResponsesSystemMessageItemParam

Элемент параметра сообщения с ролью system .

Имя.	Тип	Description	Обязательно	По умолчанию
содержимое	массив	Содержимое, связанное с сообщением.	Да
роль	перечисление	Роль сообщения, которая всегда `system`. Возможные значения: `system`	Да

OpenAI.ResponsesSystemMessageItemResource

Элемент сообщения из ресурса с ролью system.

Имя.	Тип	Description	Обязательно	По умолчанию
содержимое	массив	Содержимое, связанное с сообщением.	Да
роль	перечисление	Роль сообщения, которая всегда `system`. Возможные значения: `system`	Да

OpenAI.ResponsesUserMessageItemParam

Элемент параметра сообщения с ролью user .

Имя.	Тип	Description	Обязательно	По умолчанию
содержимое	массив	Содержимое, связанное с сообщением.	Да
роль	перечисление	Роль сообщения, которая всегда `user`. Возможные значения: `user`	Да

OpenAI.ResponsesUserMessageItemResource

Элемент сообщения из ресурса с ролью user.

Имя.	Тип	Description	Обязательно	По умолчанию
содержимое	массив	Содержимое, связанное с сообщением.	Да
роль	перечисление	Роль сообщения, которая всегда `user`. Возможные значения: `user`	Да

OpenAI.RunGraderRequest

Имя.	Тип	Description	Обязательно
грейдер	объект	Объект StringCheckGrader, выполняющий сравнение строк между входами и ссылкой с помощью указанной операции.	Да
└calculate_output calculate_output	струна	Формула для вычисления выходных данных на основе результатов оценки.	нет
└️ evaluation_metric	перечисление	Используемая метрика оценки. Один из `fuzzy_match`, `bleu`, `gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`, или `rouge_l`. Возможные значения: `fuzzy_match`, `bleu`, `gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`, `rouge_l`	нет
└️ классировщиков	объект		нет
└image_tag	струна	Тег изображения, используемый для скрипта Python.	нет
└─ Входные данные	массив	Входной текст. Это может включать строки шаблона.	нет
└─ Модель	струна	Модель, используемая для оценки.	нет
└️ имя	струна	Имя классировщика.	нет
Операция └️	перечисление	Операция проверки строки, которую нужно выполнить. Один из `eq`, `nelike`или `ilike`. Возможные значения: `eq`, , `nelikeilike`	нет
Диапазон └️	массив	Диапазон оценки. По умолчанию — `[0, 1]`.	нет
Справочник по └️	струна	Текст, классируемый против.	нет
└─sampling_params		Параметры выборки для модели.	нет
└─ Источник	струна	Исходный код скрипта Python.	нет
└─ Тип	перечисление	Тип объекта, который всегда `multi`является . Возможные значения: `multi`	нет
item		Элемент набора данных, предоставленный классировщику. Это будет использоваться для заполнения `item` пространства имен.	нет
model_sample	струна	Пример модели, который необходимо оценить. Это значение будет использоваться для заполнения `sample` пространства имен. Переменная `output_json` будет заполнена, если пример модели является допустимой строкой JSON.	Да

OpenAI.RunGraderResponse

Имя.	Тип	Обязательно
metadata	объект	Да
Ошибки └️	объект	нет
└formula_parse_error	булевый	нет
└️ invalid_variable_error	булевый	нет
└model_grader_parse_error	булевый	нет
└model_grader_refusal_error model_grader_refusal_error	булевый	нет
└model_grader_server_error	булевый	нет
└model_grader_server_error_details	струна	нет
└️ other_error	булевый	нет
└python_grader_runtime_error	булевый	нет
└️ python_grader_runtime_error_details	струна	нет
└python_grader_server_error	булевый	нет
└️ python_grader_server_error_type	струна	нет
└sample_parse_error	булевый	нет
└truncated_observation_error	булевый	нет
└unresponsive_reward_error	булевый	нет
└execution_time execution_time	число/номер	нет
└️ имя	струна	нет
└️ sampled_model_name	струна	нет
Оценки └️		нет
└token_usage	целое число	нет
└─ Тип	струна	нет
model_grader_token_usage_per_model		Да
награда	число/номер	Да
sub_rewards		Да

OpenAI.StaticChunkingStrategy

Имя.	Тип	Description	Обязательно	По умолчанию
chunk_overlap_tokens	целое число	Количество маркеров, перекрывающихся между блоками. Значение по умолчанию — `400`. Обратите внимание, что перекрытие не должно превышать половину `max_chunk_size_tokens`.	Да
max_chunk_size_tokens	целое число	Максимальное количество токенов в каждом блоке. Значение по умолчанию — `800`. Минимальное значение равно `100` , а максимальное — `4096`.	Да

OpenAI.StaticChunkingStrategyRequestParam

Настройте собственную стратегию блокирования, задав размер блока и перекрытие блоков.

Имя.	Тип	Description	Обязательно	По умолчанию
статичный	OpenAI.StaticChunkingStrategy		Да
type	перечисление	Всегда `static`. Возможные значения: `static`	Да

OpenAI.StaticChunkingStrategyResponseParam

Имя.	Тип	Description	Обязательно	По умолчанию
статичный	OpenAI.StaticChunkingStrategy		Да
type	перечисление	Всегда `static`. Возможные значения: `static`	Да

OpenAI.StopConfiguration

Не поддерживается с последними моделями рассуждений o3 и o4-mini.

До 4 последовательностей, в которых API перестанет создавать дополнительные маркеры. Возвращенный текст не будет содержать последовательность остановки.

Эта схема принимает один из следующих типов:

string
array

OpenAI.Tool

Дискриминатор для OpenAI.Инструмент

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа	Схема
`function`	OpenAI.FunctionTool
`file_search`	OpenAI.FileSearchTool
`computer_use_preview`	OpenAI.ComputerUsePreviewTool
`web_search_preview`	OpenAI.WebSearchPreviewTool
`code_interpreter`	OpenAI.CodeInterpreterTool
`image_generation`	OpenAI.ImageGenTool
`local_shell`	OpenAI.LocalShellTool
`mcp`	OpenAI.MCPTool

Имя.	Тип	Description	Обязательно	По умолчанию
type	OpenAI.ToolType	Средство, которое можно использовать для создания ответа.	Да

OpenAI.ToolChoiceObject

Дискриминация для OpenAI.ToolChoiceObject

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа	Схема
`file_search`	OpenAI.ToolChoiceObjectFileSearch
`computer_use_preview`	OpenAI.ToolChoiceObjectComputer
`web_search_preview`	OpenAI.ToolChoiceObjectWebSearch
`image_generation`	OpenAI.ToolChoiceObjectImageGen
`code_interpreter`	OpenAI.ToolChoiceObjectCodeInterpreter
`function`	OpenAI.ToolChoiceObjectFunction
`mcp`	OpenAI.ToolChoiceObjectMCP

Имя.	Тип	Description	Обязательно	По умолчанию
type	OpenAI.ToolChoiceObjectType	Указывает, что модель должна использовать встроенное средство для создания ответа.	Да

OpenAI.ToolChoiceObjectCodeInterpreter

Имя.	Тип	Description	Обязательно	По умолчанию
type	перечисление	Возможные значения: `code_interpreter`	Да

OpenAI.ToolChoiceObjectComputer

Имя.	Тип	Description	Обязательно	По умолчанию
type	перечисление	Возможные значения: `computer_use_preview`	Да

OpenAI.ToolChoiceObjectFileSearch

Имя.	Тип	Description	Обязательно	По умолчанию
type	перечисление	Возможные значения: `file_search`	Да

OpenAI.ToolChoiceObjectFunction

Используйте этот параметр, чтобы принудительно вызвать определенную функцию.

Имя.	Тип	Description	Обязательно	По умолчанию
имя	струна	Имя вызываемой функции.	Да
type	перечисление	Для вызова функции тип всегда `function`. Возможные значения: `function`	Да

OpenAI.ToolChoiceObjectImageGen

Имя.	Тип	Description	Обязательно	По умолчанию
type	перечисление	Возможные значения: `image_generation`	Да

OpenAI.ToolChoiceObjectMCP

Используйте этот параметр, чтобы принудительно вызвать определенное средство на удаленном сервере MCP.

Имя.	Тип	Description	Обязательно
имя	струна	Имя средства для вызова на сервере.	нет
метка сервера	струна	Метка используемого сервера MCP.	Да
type	перечисление	Для инструментов MCP всегда используется `mcp`тип. Возможные значения: `mcp`	Да

OpenAI.ToolChoiceObjectType

Указывает, что модель должна использовать встроенное средство для создания ответа.

Недвижимость	Ценность
Описание	Указывает, что модель должна использовать встроенное средство для создания ответа.

Тип	струна
Значения	`file_search` `function` `computer_use_preview` `web_search_preview` `image_generation` `code_interpreter` `mcp`

OpenAI.ToolChoiceObjectWebSearch

Примечание. web_search еще не доступна через Azure OpenAI.

Имя.	Тип	Description	Обязательно	По умолчанию
type	перечисление	Возможные значения: `web_search_preview`	Да

OpenAI.ToolChoiceOptions

Определяет, какое средство (если таковое) вызывается моделью.

none означает, что модель не будет вызывать какое-либо средство и вместо этого создает сообщение.

auto означает, что модель может выбирать между созданием сообщения или вызовом одного или нескольких инструментов.

required означает, что модель должна вызывать один или несколько инструментов.

Недвижимость	Ценность
Описание	Определяет, какое средство (если таковое) вызывается моделью. `none` означает, что модель не будет вызывать какое-либо средство и вместо этого создает сообщение. `auto` означает, что модель может выбирать между созданием сообщения или вызовом одного или нескольких инструментов. `required` означает, что модель должна вызывать один или несколько инструментов.
Тип	струна
Значения	`none` `auto` `required`

OpenAI.ToolType

Средство, которое можно использовать для создания ответа.

Недвижимость	Ценность
Описание	Средство, которое можно использовать для создания ответа.
Тип	струна
Значения	`file_search` `function` `computer_use_preview` `web_search_preview` `mcp` `code_interpreter` `image_generation` `local_shell`

OpenAI.TopLogProb

Верхняя вероятность использования маркера в журнале.

Имя.	Тип	Обязательно
байт	массив	Да
logprob	число/номер	Да
token	струна	Да

OpenAI.TranscriptionAudioResponseFormat

Ссылки: OpenAI.AudioResponseFormat

OpenAI.TranscriptionInclude

Недвижимость	Ценность
Тип	струна
Значения	`logprobs`

OpenAI.TranscriptionSegment

Имя.	Тип	Description	Обязательно
avg_logprob	число/номер	Среднее значение logprob сегмента. Если значение меньше -1, рассмотрите сбой логарифмов.	Да
коэффициент сжатия	число/номер	Коэффициент сжатия сегмента. Если значение больше 2,4, рассмотрите сбой сжатия.	Да
конец	число/номер	Время окончания сегмента в секундах.	Да
id	целое число	Уникальный идентификатор сегмента.	Да
вероятность_отсутствия_речи	число/номер	Вероятность отсутствия речи в сегменте. Если значение выше 1,0 и `avg_logprob` ниже -1, рассмотрите этот сегмент безмолвно.	Да
seek	целое число	Поиск смещения сегмента.	Да
начало	число/номер	Время начала сегмента в секундах.	Да
Температура	число/номер	Параметр температуры, используемый для создания сегмента.	Да
текст	струна	Текстовое содержимое сегмента.	Да
tokens	массив	Массив идентификаторов маркеров для текстового содержимого.	Да

OpenAI.TranscriptionWord

Имя.	Тип	Description	Обязательно
конец	число/номер	Время окончания слова в секундах.	Да
начало	число/номер	Время начала слова в секундах.	Да
word	струна	Текстовое содержимое слова.	Да

OpenAI.TranslationAudioResponseFormat

Ссылки: OpenAI.AudioResponseFormat

OpenAI.UpdateVectorStoreFileAttributesRequest

Имя.	Тип	Description	Обязательно	По умолчанию
attributes	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате и запроса на объекты через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения могут быть строками с максимальной длиной 512 символов, логическими значениями или числами.	Да

OpenAI.UpdateVectorStoreRequest

Имя.	Тип	Description	Обязательно
истекает через	объект	Политика истечения срока действия для хранилища векторов.	нет
Привязка └️	перечисление	Метка времени привязки, после которой применяется политика истечения срока действия. Поддерживаемые привязки: `last_active_at`. Возможные значения: `last_active_at`	нет
└️ дней	целое число	Количество дней после истечения срока действия привязки хранилища векторов.	нет
metadata	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате и запроса на объекты через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — это строки с максимальной длиной 512 символов.	нет
имя	струна	Имя векторного хранилища.	нет

OpenAI.VadConfig

Имя.	Тип	Description	Обязательно	По умолчанию
prefix_padding_ms (предварительное заполнение в миллисекундах)	целое число	Длительность звука, которую нужно включить до речи, обнаруженной VAD (в миллисекундах).	нет	300
длительность_тишины_мс	целое число	Длительность молчания для обнаружения остановки речи (в миллисекундах). С более короткими значениями модель будет реагировать быстрее, но может вмешиваться при коротких паузах пользователя.	нет	200
threshold	число/номер	Порог чувствительности (от 0.0 до 1.0) для обнаружения голосовой активности. Более высокий пороговый уровень потребует более громкого звука для активации модели, и таким образом модель может работать лучше в шумных средах.	нет	0,5
type	перечисление	Необходимо установить значение `server_vad`, чтобы включить ручное фрагментирование с использованием серверного VAD. Возможные значения: `server_vad`	Да

OpenAI.ValidateGraderRequest

Имя.	Тип	Description	Обязательно
грейдер	объект	Объект StringCheckGrader, выполняющий сравнение строк между входами и ссылкой с помощью указанной операции.	Да
└calculate_output calculate_output	струна	Формула для вычисления выходных данных на основе результатов оценки.	нет
└️ evaluation_metric	перечисление	Используемая метрика оценки. Один из `fuzzy_match`, `bleu`, `gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`, или `rouge_l`. Возможные значения: `fuzzy_match`, `bleu`, `gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`, `rouge_l`	нет
└️ классировщиков	объект		нет
└image_tag	струна	Тег изображения, используемый для скрипта Python.	нет
└─ Входные данные	массив	Входной текст. Это может включать строки шаблона.	нет
└─ Модель	струна	Модель, используемая для оценки.	нет
└️ имя	струна	Имя классировщика.	нет
Операция └️	перечисление	Операция проверки строки, которую нужно выполнить. Один из `eq`, `nelike`или `ilike`. Возможные значения: `eq`, , `nelikeilike`	нет
Диапазон └️	массив	Диапазон оценки. По умолчанию — `[0, 1]`.	нет
Справочник по └️	струна	Текст, классируемый против.	нет
└─sampling_params		Параметры выборки для модели.	нет
└─ Источник	струна	Исходный код скрипта Python.	нет
└─ Тип	перечисление	Тип объекта, который всегда `multi`является . Возможные значения: `multi`	нет

OpenAI.ValidateGraderResponse

Имя.	Тип	Description	Обязательно
грейдер	объект	Объект StringCheckGrader, выполняющий сравнение строк между входами и ссылкой с помощью указанной операции.	нет
└calculate_output calculate_output	струна	Формула для вычисления выходных данных на основе результатов оценки.	нет
└️ evaluation_metric	перечисление	Используемая метрика оценки. Один из `fuzzy_match`, `bleu`, `gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`, или `rouge_l`. Возможные значения: `fuzzy_match`, `bleu`, `gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`, `rouge_l`	нет
└️ классировщиков	объект		нет
└image_tag	струна	Тег изображения, используемый для скрипта Python.	нет
└─ Входные данные	массив	Входной текст. Это может включать строки шаблона.	нет
└─ Модель	струна	Модель, используемая для оценки.	нет
└️ имя	струна	Имя классировщика.	нет
Операция └️	перечисление	Операция проверки строки, которую нужно выполнить. Один из `eq`, `nelike`или `ilike`. Возможные значения: `eq`, , `nelikeilike`	нет
Диапазон └️	массив	Диапазон оценки. По умолчанию — `[0, 1]`.	нет
Справочник по └️	струна	Текст, классируемый против.	нет
└─sampling_params		Параметры выборки для модели.	нет
└─ Источник	струна	Исходный код скрипта Python.	нет
└─ Тип	перечисление	Тип объекта, который всегда `multi`является . Возможные значения: `multi`	нет

OpenAI.VectorStoreExpirationAfter

Политика истечения срока действия для хранилища векторов.

Имя.	Тип	Description	Обязательно	По умолчанию
anchor	перечисление	Метка времени привязки, после которой применяется политика истечения срока действия. Поддерживаемые привязки: `last_active_at`. Возможные значения: `last_active_at`	Да
Дни	целое число	Количество дней после истечения срока действия привязки хранилища векторов.	Да

OpenAI.VectorStoreFileAttributes

Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате и запроса на объекты через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения могут быть строками с максимальной длиной 512 символов, логическими значениями или числами.

Тип: объект

OpenAI.VectorStoreFileBatchObject

Пакет файлов, присоединенных к хранилищу векторов.

Имя.	Тип	Description	Обязательно
создано_в	целое число	Метка времени Unix (в секундах) для создания пакета файлов векторного хранилища.	Да
file_counts	объект		Да
└️ отменено	целое число	Количество файлов, которые были отменены.	нет
└️ завершено	целое число	Количество обработанных файлов.	нет
└─ Ошибка	целое число	Количество файлов, которые не удалось обработать.	нет
└─ в процессе	целое число	Количество обрабатываемых файлов.	нет
└─ всего	целое число	Общее количество файлов.	нет
id	струна	Идентификатор, на который можно ссылаться в конечных точках API.	Да
объект	перечисление	Тип объекта, который всегда `vector_store.file_batch`является . Возможные значения: `vector_store.files_batch`	Да
статус	перечисление	Состояние пакета векторного хранилища файлов, которые могут быть либо `in_progress`, `completedcancelled` либо `failed`. Возможные значения: `in_progress`, , `completedcancelledfailed`	Да
vector_store_id	струна	Идентификатор векторного хранилища, к которому подключен файл.	Да

OpenAI.VectorStoreFileObject

Список файлов, подключенных к хранилищу векторов.

Имя.	Тип	Description	Обязательно
attributes	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате и запроса на объекты через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения могут быть строками с максимальной длиной 512 символов, логическими значениями или числами.	нет
chunking_strategy	объект		нет
└─ Тип	перечисление	Возможные значения: `static`, `other`	нет
создано_в	целое число	Метка времени Unix (в секундах) для момента создания файла векторного хранилища.	Да
id	струна	Идентификатор, на который можно ссылаться в конечных точках API.	Да
last_error	объект	Последняя ошибка, связанная с этим файлом хранилища векторов. `null` Если ошибок нет.	Да
└─ Код	перечисление	Один из `server_error` или `rate_limit_exceeded`. Возможные значения: `server_error`, `unsupported_fileinvalid_file`	нет
Сообщение └️	струна	Описание ошибки, доступной для чтения человеком.	нет
объект	перечисление	Тип объекта, который всегда `vector_store.file`является . Возможные значения: `vector_store.file`	Да
статус	перечисление	Состояние файла векторного хранилища, который может быть либо `in_progress`, `completedcancelled`либо `failed`. `completed` Состояние указывает, что файл векторного хранилища готов к использованию. Возможные значения: `in_progress`, , `completedcancelledfailed`	Да
usage_bytes	целое число	Общее использование векторного хранилища в байтах. Обратите внимание, что это может отличаться от исходного размера файла.	Да
vector_store_id	струна	Идентификатор векторного хранилища, к которому подключен файл.	Да

OpenAI.VectorStoreObject

Векторное хранилище — это коллекция обработанных файлов, которые можно использовать file_search средством.

Имя.	Тип	Description	Обязательно
создано_в	целое число	Метка времени Unix (в секундах) для создания векторного хранилища.	Да
истекает через	OpenAI.VectorStoreExpirationAfter	Политика истечения срока действия для хранилища векторов.	нет
срок_действия_до	целое число	Метка времени Unix (в секундах) для истечения срока действия хранилища векторов.	нет
file_counts	объект		Да
└️ отменено	целое число	Количество отмененных файлов.	нет
└️ завершено	целое число	Количество успешно обработанных файлов.	нет
└─ Ошибка	целое число	Количество файлов, которые не удалось обработать.	нет
└─ в процессе	целое число	Количество обрабатываемых файлов.	нет
└─ всего	целое число	Общее количество файлов.	нет
id	струна	Идентификатор, на который можно ссылаться в конечных точках API.	Да
last_active_at	целое число	Метка времени Unix (в секундах) для последнего активного хранилища векторов.	Да
metadata	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате и запроса на объекты через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — это строки с максимальной длиной 512 символов.	Да
имя	струна	Имя векторного хранилища.	Да
объект	перечисление	Тип объекта, который всегда `vector_store`является . Возможные значения: `vector_store`	Да
статус	перечисление	Состояние векторного хранилища, которое может быть либо `expired`, `in_progress`либо `completed`. Состояние указывает, что хранилище векторов `completed` готово для использования. Возможные значения: `expired`, `in_progresscompleted`	Да
usage_bytes	целое число	Общее количество байтов, используемых файлами в хранилище векторов.	Да

OpenAI.VoiceIdsShared

Недвижимость	Ценность
Тип	струна
Значения	`alloy` `ash` `ballad` `coral` `echo` `fable` `onyx` `nova` `sage` `shimmer` `verse`

OpenAI.WebSearchAction

Дискриминация для OpenAI.WebSearchAction

Этот компонент использует свойство type для дискриминации между различными типами:

Значение типа	Схема
`find`	OpenAI.WebSearchActionFind
`open_page`	OpenAI.WebSearchActionOpenPage
`search`	OpenAI.WebSearchActionSearch

Имя.	Тип	Description	Обязательно	По умолчанию
type	OpenAI.WebSearchActionType		Да

OpenAI.WebSearchActionFind

Тип действия "find": выполняет поиск шаблона на загруженной странице.

Имя.	Тип	Description	Обязательно
шаблон	струна	Шаблон или текст для поиска на странице.	Да
type	перечисление	Тип действия. Возможные значения: `find`	Да
URL-адрес	струна	URL-адрес страницы, найдите шаблон.	Да

OpenAI.WebSearchActionOpenPage

Тип действия "open_page" — открывает определенный URL-адрес из результатов поиска.

Имя.	Тип	Description	Обязательно	По умолчанию
type	перечисление	Тип действия. Возможные значения: `open_page`	Да
URL-адрес	струна	URL-адрес, открытый моделью.	Да

OpenAI.WebSearchActionSearch

Тип действия "поиск" — выполняет запрос веб-поиска.

Имя.	Тип	Description	Обязательно	По умолчанию
query	струна	Поисковый запрос.	Да
type	перечисление	Тип действия. Возможные значения: `search`	Да

OpenAI.WebSearchActionType

Недвижимость	Ценность
Тип	струна
Значения	`search` `open_page` `find`

OpenAI.WebSearchPreviewTool

Примечание. web_search еще не доступна через Azure OpenAI.

Имя.	Тип	Description	Обязательно
размер_контекста_поиска	перечисление	Рекомендации высокого уровня для объема пространства контекстного окна, используемого для поиска. Один из `low`, `medium`, или `high`. `medium` — это значение по умолчанию. Возможные значения: `low`, `mediumhigh`	нет
type	перечисление	Тип средства поиска в Интернете. Один из `web_search_preview` или `web_search_preview_2025_03_11`. Возможные значения: `web_search_preview`	Да
местоположение пользователя	объект		нет
└─ Тип	OpenAI.LocationType		нет

OpenAI.WebSearchToolCallItemParam

Примечание. web_search еще не доступна через Azure OpenAI.

Имя.	Тип	Description	Обязательно
действие	объект		Да
└─ Тип	OpenAI.WebSearchActionType		нет
type	перечисление	Возможные значения: `web_search_call`	Да

OpenAI.WebSearchToolCallItemResource

Примечание. web_search еще не доступна через Azure OpenAI.

Имя.	Тип	Description	Обязательно
действие	объект		Да
└─ Тип	OpenAI.WebSearchActionType		нет
статус	перечисление	Состояние вызова функции средства поиска в Интернете. Возможные значения: `in_progress`, , `searchingcompletedfailed`	Да
type	перечисление	Возможные значения: `web_search_call`	Да

PineconeChatDataSource

Имя.	Тип	Description	Обязательно	По умолчанию
параметры	объект	Сведения о параметрах для управления использованием источника данных Pinecone.	Да
└️ allow_partial_result	булевый	Если установлено значение true, система позволит использовать частичные результаты поиска, и запрос будет считаться неуспешным, если все частичные запросы окажутся неудачными. Если запрос не указан или указан как false, запрос завершится ошибкой, если любой поисковый запрос завершается ошибкой.	нет	Неправда
└─ проверка подлинности	объект		нет
└─ Ключ	струна		нет
└─ Тип	перечисление	Возможные значения: `api_key`	нет
└─ встраивание_зависимости	объект	Представление источника векторизации данных, который можно использовать как ресурс внедрения с источником данных.	нет
└─ Тип	AzureChatDataSourceVectorizationSourceType	Идентификатор, различающий конкретный источник векторизации.	нет
└─ среда	струна	Имя среды, используемое с Pinecone.	нет
└─ сопоставление_полей	объект	Сопоставления полей для применения к данным, используемым источником данных Pinecone. Обратите внимание, что сопоставления полей содержимого необходимы для Pinecone.	нет
└─ поля_контента	массив		нет
└─content_fields_separator	струна		нет
└filepath_field	струна		нет
└─ название_поля	струна		нет
└─ поле_ссылки	струна		нет
└in_scope	булевый	Следует ли ограничить запросы использованием индексированных данных.	нет
└─ включить_контексты	массив	Свойства контекста выходных данных, которые необходимо включить в ответ. По умолчанию запрашивается ссылка и намерение.	нет	['цитаты', 'намерение']
└– index_name	струна	Имя используемого индекса базы данных Pinecone.	нет
└max_search_queries	целое число	Максимальное количество перезаписанных запросов, которые должны отправляться поставщику поиска для одного сообщения пользователя. По умолчанию система сделает автоматическое определение.	нет
└️ строгость	целое число	Настроенная строгость фильтрации релевантности поиска. Более строгие критерии увеличат точность, но снизят полноту ответа.	нет
└top_n_documents	целое число	Настроено количество документов, которые нужно выделить в запросе.	нет
type	перечисление	Идентификатор различаемого типа, который всегда является "pinecone". Возможные значения: `pinecone`	Да

Качество

Качество извлекаемого видео. Это указывает качество содержимого видео, которое должно быть возвращено.

Недвижимость	Ценность
Описание	Качество извлекаемого видео. Это указывает качество содержимого видео, которое должно быть возвращено.
Тип	струна
Значения	`high` `low`

ResponseFormatJSONSchemaRequest

Имя.	Тип	Description	Обязательно	По умолчанию
JSON-схема	объект	Схема JSON для формата ответа	Да
type	перечисление	Тип формата ответа Возможные значения: `json_schema`	Да

ResponseModalities

Типы выходных данных, которые вы хотите, чтобы модель генерировала. Большинство моделей могут создавать текст, который по умолчанию:

["text"]

Модель gpt-4o-audio-preview также может использоваться для создания звука. Чтобы запросить, что эта модель создает как текстовые, так и звуковые ответы, можно использовать:

["text", "audio"]

Массив строк

SpeechGenerationResponseFormat

Поддерживаемые форматы выходных данных звука для преобразования текста в речь.

Этот компонент может быть одним из следующих компонентов:

VideoGeneration

Результат создания видео.

Имя.	Тип	Description	Обязательно
создано_в	целое число	Время генерации видео.	Да
height	целое число	Высота видео.	Да
id	струна	Идентификатор поколения видео.	Да
job_id	струна	Идентификатор задания по созданию видео для этого видео.	Да
n_seconds	целое число	Длительность создания видео.	Да
объект	перечисление	Возможные значения: `video.generation`	Да
prompt	струна	Запрос для создания видео.	Да
Ширина	целое число	Ширина видео.	Да

VideoGenerationJob

Задание создания видео.

Имя.	Тип	Description	Обязательно
создано_в	целое число	Время создания задания.	Да
срок_действия_до	целое число	Время автоматического удаления задания из службы. Содержимое видео и метаданные задания должны храниться до этой даты, чтобы избежать потери данных.	нет
failure_reason	строка (см. допустимые модели ниже)		нет
завершено_в	целое число	Время завершения работы со всеми видеогенерациями.	нет
Поколений	массив	Созданные видео для этого задания. Число зависит от заданного n_variants и успешности создания поколений.	нет
height	целое число	Высота видео.	Да
id	струна	Идентификатор задания.	Да
inpaint_items	массив	Необязательные элементы для этого задания создания видео.	нет
модель	струна	Имя развертывания, используемого для этого задания по созданию видео.	Да
n_seconds	целое число	Длительность задания создания видео.	Да
n_variants	целое число	Количество видео для создания в качестве вариантов для этого задания создания видео.	Да
объект	перечисление	Возможные значения: `video.generation.job`	Да
prompt	струна	Запрос для задания создания видео.	Да
статус	объект	Состояние задания создания видео.	Да
Ширина	целое число	Высота видео.	Да

VideoGenerationJobList

Список заданий создания видео.

Имя.	Тип	Description	Обязательно
данные	массив	Список заданий создания видео.	Да
первый_идентификатор	струна	Идентификатор первого задания на текущей странице, если он доступен.	нет
есть_еще	булевый	Флаг, указывающий, есть ли больше заданий после списка.	Да
last_id	струна	Идентификатор последнего задания на текущей странице, если он доступен.	нет
объект	перечисление	Возможные значения: `list`	Да

Дальнейшие шаги

Узнайте о моделях и тонкой настройке с помощью REST API. Узнайте больше о недоумение моделей, которые Azure OpenAI.

Обратная связь

Были ли сведения на этой странице полезными?

Last updated on 2026-02-28

Поделиться через

Azure OpenAI в справочнике по REST API для моделей Microsoft Foundry версии 1

Вывод плоскости данных

Создание речи

Параметры URI

Заголовок запроса

Тело запроса

Responses

Примеры

Пример

Создание транскрибирования

Параметры URI

Заголовок запроса

Тело запроса

Responses

Примеры

Пример

Создание перевода

Параметры URI

Заголовок запроса

Тело запроса

Responses

Примеры

Пример

Создание завершения чата

Параметры URI

Заголовок запроса

Тело запроса

Responses

Примеры

Пример

Создание внедрения

Параметры URI

Заголовок запроса

Тело запроса

Responses

Примеры

Пример

Перечисление evals

Параметры URI

Заголовок запроса

Responses

Createeval

Параметры URI

Заголовок запроса

Тело запроса

Responses

Получение eval

Параметры URI

Заголовок запроса

Responses

Обновление eval

Параметры URI

Заголовок запроса

Тело запроса

Responses

Удаление eval

Параметры URI

Заголовок запроса

Responses

Получение запусков eval

Параметры URI

Заголовок запроса

Responses

Создание запуска eval

Параметры URI

Заголовок запроса

Тело запроса

Responses

Получение запуска eval

Параметры URI

Заголовок запроса

Responses

Отмена выполнения eval

Параметры URI

Заголовок запроса

Responses

Deleteevalrun

Параметры URI

Заголовок запроса