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

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

API specs

Управление и взаимодействие с моделями и ресурсами Azure OpenAI разделено на три основных поверхности API:

Control plane
Плоскость данных — разработка
Плоскость данных — вывод

Каждая область или спецификация API инкапсулирует другой набор возможностей Azure OpenAI. Каждый API имеет собственный уникальный набор выпусков API предварительной версии и стабильных и общедоступных (GA). Предварительные версии выпусков в настоящее время, как правило, следуют ежемесячному курсу.

Important

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

API	Последний предварительный выпуск	Последний выпуск общедоступной версии	Specifications	Description
Control plane	`2025-07-01-preview`	`2025-06-01`	Spec files	API уровня управления используется для операций, таких как создание ресурсов, развертывание модели и другие задачи управления ресурсами более высокого уровня. Плоскость управления также управляет возможностями, такими как Azure Resource Manager, Bicep, Terraform и Azure CLI.
Data plane	`v1 preview`	`v1`	Spec files	API плоскости данных управляет операциями вывода и разработки.

Authentication

Azure OpenAI предоставляет два метода проверки подлинности. Вы можете использовать ключи API или идентификатор Microsoft Entra.

Проверка подлинности ключа API. Для этого типа проверки подлинности все запросы API должны включать ключ API в api-key заголовок HTTP. В кратком руководстве показано, как выполнять вызовы с помощью этого типа проверки подлинности.
Проверка подлинности идентификатора Microsoft Entra: можно пройти проверку подлинности вызова API с помощью маркера Microsoft Entra. Маркеры проверки подлинности включаются в запрос в качестве заголовка Authorization . Предоставленный маркер должен предшествовать Bearer, например Bearer YOUR_AUTH_TOKEN. Вы можете ознакомиться с нашим руководством по проверке подлинности с помощью идентификатора Microsoft Entra.

Управление версиями REST API

API-интерфейсы службы версии api-version используют параметр запроса. Все версии соответствуют структуре YYYY-MM-DD дат. For example:

POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/chat/completions?api-version=2024-06-01

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

В остальной части статьи рассматривается 2025-04-01-preview предварительная версия спецификации вывода плоскости данных Azure OpenAI.

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

Завершение — создание

POST https://{endpoint}/openai/deployments/{deployment-id}/completions?api-version=2025-04-01-preview

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: `https://aoairesource.openai.azure.com` Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
deployment-id	path	Yes	string
api-version	query	Yes	string

Request Header

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

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

Request Body

Content-Type: application/json

Name	Type	Description	Required	Default
best_of	integer	`best_of` Создает завершения на стороне сервера и возвращает "лучший" (один с наибольшей вероятностью журнала на токен). Результаты не могут быть потоковые. При использовании с `n`, `best_of` управляет числом завершений кандидата и `n` указывает, сколько для возврата Ã'â''â€j `best_of` должен быть больше `n`. Примечание: Так как этот параметр создает множество завершений, он может быстро использовать квоту маркера. Используйте тщательно и убедитесь, что у вас есть разумные параметры для `max_tokens` и `stop`.	No	1
echo	boolean	Обратная обратная копия запроса в дополнение к завершению	No	False
frequency_penalty	number	Число от -2.0 до 2.0. Положительные значения наказывают новые маркеры на основе их существующей частоты в тексте до сих пор, уменьшая вероятность повторения той же строки.	No	0
logit_bias	object	Измените вероятность появления указанных маркеров в завершении. Принимает объект JSON, который сопоставляет маркеры (указанные идентификатором маркера в маркеризаторе GPT) с соответствующим значением предвзятости от -100 до 100. Математически предвзятость добавляется в журналы, созданные моделью перед выборкой. Точный эффект зависит от модели, но значения между -1 и 1 должны уменьшаться или увеличивать вероятность выбора; такие значения, как -100 или 100, должны привести к запрету или эксклюзивному выбору соответствующего маркера. Например, можно передать `{"50256": -100}` маркер \|endoftext\|< для предотвращения >создания маркера \|endoftext.	No	None
logprobs	integer	Включите вероятности журнала в `logprobs` наиболее вероятные выходные маркеры, а также выбранные маркеры. Например, если `logprobs` значение равно 5, API возвращает список из 5 наиболее вероятных маркеров. API всегда возвращает `logprob` пример маркера, поэтому в ответе может быть до `logprobs+1` элементов. Максимальное значение `logprobs` для 5.	No	None
max_tokens	integer	Максимальное количество маркеров, которые можно создать в завершении. Количество маркеров запроса плюс `max_tokens` не может превышать длину контекста модели.	No	16
n	integer	Сколько завершений для каждого запроса. Примечание: Так как этот параметр создает множество завершений, он может быстро использовать квоту маркера. Используйте тщательно и убедитесь, что у вас есть разумные параметры для `max_tokens` и `stop`.	No	1
presence_penalty	number	Число от -2.0 до 2.0. Положительные значения наказывают новые маркеры на основе того, отображаются ли они в тексте до сих пор, увеличив вероятность того, что модель будет говорить о новых темах.	No	0
prompt	строка или массив	Запрос на создание завершения для, закодированного в виде строки, массива строк, массива маркеров или массива массивов маркеров. Обратите внимание, что <\|endoftext\|> — это разделитель документов, который модель видит во время обучения, поэтому если запрос не указан, модель создает как будто с начала нового документа.	Yes
seed	integer	Если задано, наша система делает все возможное для выборки детерминированного, таким образом, что повторяющиеся запросы с одинаковыми и параметрами должны возвращать тот же `seed` результат. Детерминированность не гарантируется, и вы должны ссылаться на `system_fingerprint` параметр ответа для отслеживания изменений в серверной части.	No
stop	строка или массив	До четырех последовательностей, в которых API останавливает создание дополнительных маркеров. Возвращенный текст не будет содержать последовательность остановки.	No
stream	boolean	Выполняется ли потоковая передача частичного хода выполнения. Если задано, маркеры отправляются как события, отправляемые сервером только для данных по мере их доступности, при этом поток завершается сообщением `data: [DONE]` . Пример кода Python.	No	False
suffix	string	Суффикс, который приходит после завершения вставленного текста. Этот параметр поддерживается только для `gpt-3.5-turbo-instruct`.	No	None
temperature	number	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным. Как правило, мы рекомендуем изменить это или `top_p` не оба.	No	1
top_p	number	Альтернатива выборке с температурой, называемой выборкой ядра, где модель рассматривает результаты маркеров с top_p массой вероятности. Таким образом, 0,1 означает, что рассматриваются только маркеры, состоящие из 10 лучших% массы вероятностей. Как правило, мы рекомендуем изменить это или `temperature` не оба.	No	1
user	string	Уникальный идентификатор, представляющий конечного пользователя, который может помочь в мониторинге и обнаружении злоупотреблений.	No

Responses

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

Description: OK

Content-Type	Type	Description
application/json	createCompletionResponse

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

Описание: служба недоступна

Content-Type	Type	Description
application/json	errorResponse

Examples

Example

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

POST https://{endpoint}/openai/deployments/{deployment-id}/completions?api-version=2025-04-01-preview

{
 "prompt": [
  "tell me a joke about mango"
 ],
 "max_tokens": 32,
 "temperature": 1.0,
 "n": 1
}

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

{
  "body": {
    "id": "cmpl-7QmVI15qgYVllxK0FtxVGG6ywfzaq",
    "created": 1686617332,
    "choices": [
      {
        "text": "es\n\nWhat do you call a mango who's in charge?\n\nThe head mango.",
        "index": 0,
        "finish_reason": "stop",
        "logprobs": null
      }
    ],
    "usage": {
      "completion_tokens": 20,
      "prompt_tokens": 6,
      "total_tokens": 26
    }
  }
}

Внедрение — создание

POST https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2025-04-01-preview

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: `https://aoairesource.openai.azure.com` Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
deployment-id	path	Yes	string	Идентификатор развертывания развернутой модели.
api-version	query	Yes	string

Request Header

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

Request Body

Content-Type: application/json

Name	Type	Description	Required
dimensions	integer	Число измерений, в которых должны быть внедренные выходные данные. Поддерживается только в `text-embedding-3` и более поздних моделях.	No
encoding_format	string	Формат, в который возвращаются встраиваемые элементы. Может быть либо `floatbase64`. По умолчанию используется `float`значение .	No
input	строка или массив	Входной текст для внедрения, закодированный в виде строки или массива маркеров. Чтобы внедрить несколько входных данных в один запрос, передайте массив строк или массив массивов маркеров. Входные данные не должны превышать максимальные входные маркеры для модели (8 192 маркеров для `text-embedding-ada-002`), не может быть пустой строкой, и любой массив должен быть 2048 измерений или меньше.	Yes
input_type	string	тип входных данных для внедрения поиска для использования	No
user	string	Уникальный идентификатор, представляющий пользователя, который может помочь в мониторинге и обнаружении злоупотреблений.	No

Responses

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

Description: OK

Content-Type	Type	Description
application/json	object

Examples

Example

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

POST https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2025-04-01-preview

{
 "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.0020113448
        ]
      }
    ],
    "usage": {
      "prompt_tokens": 4,
      "total_tokens": 4
    }
  }
}

Завершение чата — создание

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

Создает завершение для сообщения чата

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: `https://aoairesource.openai.azure.com` Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
deployment-id	path	Yes	string
api-version	query	Yes	string

Request Header

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

Request Body

Content-Type: application/json

Name	Type	Description	Required	Default
audio	object	Параметры выходных данных звука. Требуется при запросе выходных данных звука.`modalities: ["audio"]`	No
└─ format	enum	Указывает выходной формат звука. Должен быть одним из `wav`, , `mp3flac`, `opus`или `pcm16`. Возможные значения: `wav`, , `mp3flacopuspcm16`	No
└─ voice	enum	Указывает тип голоса. Поддерживаемые голоса: `alloy`, `echo`, `fable`, `onyx`и `novashimmer`. Возможные значения: `alloy`, , `echofableonyx`, `novashimmer`	No
data_sources	array	Записи конфигурации для расширений чата Azure OpenAI, которые используют их. Эта дополнительная спецификация совместима только с Azure OpenAI.	No
frequency_penalty	number	Число от -2.0 до 2.0. Положительные значения наказывают новые маркеры на основе их существующей частоты в тексте до сих пор, уменьшая вероятность повторения той же строки.	No	0
function_call	string или chatCompletionFunctionCallOption	Не рекомендуется использовать в пользу `tool_choice`. Определяет, какая функция (если есть) вызывается моделью. `none` означает, что модель не вызывает функцию и вместо этого создает сообщение. `auto` означает, что модель может выбирать между созданием сообщения или вызовом функции. Указание определенной функции путем `{"name": "my_function"}` принудительного вызова этой функции моделью. `none` значение по умолчанию, если функции отсутствуют. `auto` значение по умолчанию, если функции присутствуют.	No
functions	array	Не рекомендуется использовать в пользу `tools`. Список функций, для которые модель может создавать входные данные JSON.	No
logit_bias	object	Измените вероятность появления указанных маркеров в завершении. Принимает объект JSON, который сопоставляет маркеры (указанные идентификатором маркера в токенизаторе) со связанным значением предвзятости от -100 до 100. Математически предвзятость добавляется в журналы, созданные моделью перед выборкой. Точный эффект зависит от модели, но значения между -1 и 1 должны уменьшаться или увеличивать вероятность выбора; такие значения, как -100 или 100, должны привести к запрету или эксклюзивному выбору соответствующего маркера.	No	None
logprobs	boolean	Следует ли возвращать вероятности журналов выходных маркеров или нет. Если значение true, возвращает вероятности журнала каждого выходного маркера, возвращаемого в параметре `contentmessage`.	No	False
max_completion_tokens	integer	Верхняя граница для числа маркеров, которые можно создать для завершения, включая видимые выходные маркеры и маркеры причин.	No
max_tokens	integer	Максимальное количество маркеров, которые можно создать в завершении чата. Общая длина входных маркеров и созданных маркеров ограничена длиной контекста модели.	No
messages	array	Список сообщений, составляющих беседу до сих пор. Пример кода Python.	Yes
metadata	object	Определяемые разработчиком теги и значения, используемые для фильтрации завершений на панели мониторинга хранимых завершений.	No
modalities	ChatCompletionModalities	Типы выходных данных, которые нужно создать для этого запроса. Большинство моделей могут создавать текст, который по умолчанию: `["text"]` Модель `gpt-4o-audio-preview` также может использоваться для создания звука. Чтобы запросить, что эта модель создает как текстовые, так и звуковые ответы, можно использовать: `["text", "audio"]`	No
n	integer	Сколько вариантов завершения чата для каждого входного сообщения. Плата будет взиматься в зависимости от количества созданных маркеров во всех вариантах. Имейте в виду `n` , чтобы `1` свести к минимуму затраты.	No	1
parallel_tool_calls	ParallelToolCalls	Следует ли включить параллельные вызовы функций во время использования средства.	No	True
prediction	PredictionContent	Конфигурация прогнозируемых выходных данных, которая может значительно улучшить время отклика, когда большие части ответа модели известны заранее. Это наиболее распространено при повторном создании файла с незначительными изменениями в большинстве содержимого.	No
presence_penalty	number	Число от -2.0 до 2.0. Положительные значения наказывают новые маркеры на основе того, отображаются ли они в тексте до сих пор, увеличив вероятность того, что модель будет говорить о новых темах.	No	0
reasoning_effort	enum	Только модели o1 Ограничивает усилия по рассуждениям моделей. В настоящее время поддерживаются `low`значения , `medium`и `high`. Сокращение усилий по поводу может привести к более быстрым откликам и меньшем количестве маркеров, используемых при рассуждениях в ответе. Возможные значения: `low`, `mediumhigh`	No
response_format	ResponseFormatText или ResponseFormatJsonObject или ResponseFormatJsonSchema	Объект, указывающий формат, который должен выводить модель. Совместим с GPT-4o, GPT-4o mini, GPT-4 Turbo и всеми моделями GPT-3.5 Turbo, чем `gpt-3.5-turbo-1106`более новые. Параметр для `{ "type": "json_schema", "json_schema": {...} }` включения структурированных выходных данных, гарантирующих соответствие модели предоставленной схеме JSON. Параметр включения `{ "type": "json_object" }` режима JSON, который гарантирует, что модель создает сообщение является допустимым JSON. Важно: при использовании режима JSON необходимо также указать модели создавать JSON самостоятельно с помощью системного или пользовательского сообщения. Без этого модель может создать неуправляемый поток пробелов до тех пор, пока поколение не достигнет предела маркера, в результате чего длительный и, казалось бы, "застрявший" запрос. Кроме того, обратите внимание, что содержимое сообщения может быть частично отрезано, если `finish_reason="length"`, что указывает на превышение поколения `max_tokens` или беседа превысила максимальную длину контекста.	No
seed	integer	Эта функция доступна в бета-версии. Если задано, наша система делает все возможное для выборки детерминированного, таким образом, что повторяющиеся запросы с одинаковыми и параметрами должны возвращать тот же `seed` результат. Детерминированность не гарантируется, и вы должны ссылаться на `system_fingerprint` параметр ответа для отслеживания изменений в серверной части.	No
stop	строка или массив	До 4 последовательностей, в которых API перестает создавать дополнительные маркеры.	No
store	boolean	Независимо от того, следует ли хранить выходные данные этого запроса на завершение чата для использования в наших продуктах для дистилляции или оценки модели.	No
stream	boolean	Если задано, разностные сообщения отправляются, например в ChatGPT. Маркеры отправляются как события, отправляемые сервером только для данных по мере их доступности, при этом поток завершается сообщением `data: [DONE]` . Пример кода Python.	No	False
stream_options	chatCompletionStreamOptions	Параметры потокового ответа. Этот параметр устанавливается только при установке `stream: true`.	No	None
temperature	number	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным. Как правило, мы рекомендуем изменить это или `top_p` не оба.	No	1
tool_choice	chatCompletionToolChoiceOption	Определяет, какое средство (если таковое) вызывается моделью. `none` означает, что модель не вызывает никаких инструментов и вместо этого создает сообщение. `auto` означает, что модель может выбирать между созданием сообщения или вызовом одного или нескольких инструментов. `required` означает, что модель должна вызывать один или несколько инструментов. Указание определенного средства с помощью `{"type": "function", "function": {"name": "my_function"}}` принудительного вызова этого средства моделью. `none` значение по умолчанию, если средства отсутствуют. `auto` значение по умолчанию, если существуют средства.	No
tools	array	Список инструментов, которые может вызывать модель. В настоящее время в качестве инструмента поддерживаются только функции. Используйте это для предоставления списка функций, для которые модель может создавать входные данные JSON. Поддерживаются не более 128 функций.	No
top_logprobs	integer	Целое число от 0 до 20, указывающее число наиболее вероятных маркеров, возвращаемых по каждой позиции маркера, каждый из которых имеет связанную вероятность журнала. `logprobs` Необходимо задать значение `true` , если этот параметр используется.	No
top_p	number	Альтернатива выборке с температурой, называемой выборкой ядра, где модель рассматривает результаты маркеров с top_p массой вероятности. Таким образом, 0,1 означает, что рассматриваются только маркеры, состоящие из 10 лучших% массы вероятностей. Как правило, мы рекомендуем изменить это или `temperature` не оба.	No	1
user	string	Уникальный идентификатор, представляющий конечного пользователя, который может помочь в мониторинге и обнаружении злоупотреблений.	No
user_security_context	userSecurityContext	Контекст безопасности пользователей содержит несколько параметров, описывающих само приложение ИИ, и конечный пользователь, взаимодействующий с приложением ИИ. Эти поля помогают группам по операциям безопасности исследовать и устранять инциденты безопасности, предоставляя комплексный подход к защите приложений ИИ. Дополнительные сведения о защите приложений ИИ с помощью Microsoft Defender для облака.	No

Responses

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

Description: OK

Content-Type	Type	Description
application/json	object

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

Описание: служба недоступна

Content-Type	Type	Description
application/json	errorResponse

Examples

Example

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

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "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? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye\u00e2\u20ac\u2122ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' \u00e2\u20ac\u2122bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!"
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

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

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_search",
   "parameters": {
    "endpoint": "https://your-search-endpoint.search.windows.net/",
    "index_name": "{index name}",
    "authentication": {
     "type": "system_assigned_managed_identity"
    }
   }
  }
 ]
}

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

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

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

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_search",
   "parameters": {
    "endpoint": "https://your-search-endpoint.search.windows.net/",
    "index_name": "{index name}",
    "query_type": "vector",
    "fields_mapping": {
     "image_vector_fields": [
      "image_vector"
     ]
    },
    "authentication": {
     "type": "api_key",
     "key": "{api key}"
    }
   }
  }
 ]
}

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

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion."
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

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

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a cat?"
  },
  {
   "role": "assistant",
   "content": "Content of the completion [doc1].",
   "context": {
    "intent": "cat care"
   }
  },
  {
   "role": "user",
   "content": "how about dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_search",
   "parameters": {
    "endpoint": "https://your-search-endpoint.search.windows.net/",
    "authentication": {
     "type": "user_assigned_managed_identity",
     "managed_identity_resource_id": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resource-name}"
    },
    "index_name": "{index name}",
    "query_type": "vector",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "in_scope": true,
    "top_n_documents": 5,
    "strictness": 3,
    "role_information": "You are an AI assistant that helps people find information.",
    "fields_mapping": {
     "content_fields_separator": "\\n",
     "content_fields": [
      "content"
     ],
     "filepath_field": "filepath",
     "title_field": "title",
     "url_field": "url",
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

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

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content 2.",
                "title": "Citation Title 2",
                "filepath": "contoso2.txt",
                "url": "https://contoso.blob.windows.net/container/contoso2.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

Создает завершение для предоставленного Azure Cosmos DB.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_cosmos_db",
   "parameters": {
    "authentication": {
     "type": "connection_string",
     "connection_string": "mongodb+srv://rawantest:{password}$@{cluster-name}.mongocluster.cosmos.azure.com/?tls=true&authMechanism=SCRAM-SHA-256&retrywrites=false&maxIdleTimeMS=120000"
    },
    "database_name": "vectordb",
    "container_name": "azuredocs",
    "index_name": "azuredocindex",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "fields_mapping": {
     "content_fields": [
      "content"
     ],
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

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

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

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

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "mongo_db",
   "parameters": {
    "authentication": {
     "type": "username_and_password",
     "username": "<username>",
     "password": "<password>"
    },
    "endpoint": "<endpoint_name>",
    "app_name": "<application name>",
    "database_name": "sampledb",
    "collection_name": "samplecollection",
    "index_name": "sampleindex",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "fields_mapping": {
     "content_fields": [
      "content"
     ],
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

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

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

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

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "elasticsearch",
   "parameters": {
    "endpoint": "https://your-elasticsearch-endpoint.eastus.azurecontainer.io",
    "index_name": "{index name}",
    "authentication": {
     "type": "key_and_key_id",
     "key": "{key}",
     "key_id": "{key id}"
    }
   }
  }
 ]
}

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

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

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

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "pinecone",
   "parameters": {
    "authentication": {
     "type": "api_key",
     "key": "{api key}"
    },
    "environment": "{environment name}",
    "index_name": "{index name}",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "fields_mapping": {
     "title_field": "title",
     "url_field": "url",
     "filepath_field": "filepath",
     "content_fields": [
      "content"
     ],
     "content_fields_separator": "\n"
    }
   }
  }
 ]
}

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

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Транскрибирование — создание

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2025-04-01-preview

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: `https://aoairesource.openai.azure.com` Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
deployment-id	path	Yes	string
api-version	query	Yes	string

Request Header

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

Request Body

Content-Type: multipart/form-data

Name	Type	Description	Required	Default
model	string	Идентификатор используемой модели. Параметры: `gpt-4o-transcribe`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15whisper-1`и `gpt-4o-transcribe-diarize`.	Yes
file	string	Объект звукового файла для транскрибирования.	Yes
language	string	Язык входного звука. Предоставление языка ввода в формате ISO-639-1 повышает точность и задержку.	No
prompt	string	Необязательный текст для руководства стилем модели или продолжением предыдущего сегмента звука. Запрос должен соответствовать языку звука.	No
response_format	audioResponseFormat	Определяет формат выходных данных.	No
temperature	number	Температура выборки от 0 до 1. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным. Если задано значение 0, модель использует вероятность журнала для автоматического увеличения температуры до тех пор, пока определенные пороговые значения не будут достигнуты.	No	0
timestamp_granularities[]	array	Гранулярность метки времени для заполнения этой транскрибирования. `response_format` необходимо задать `verbose_json` для использования детализации метки времени. Поддерживаются либо оба этих параметра: `word`или `segment`. Примечание. Дополнительная задержка для меток времени сегмента отсутствует, но при создании меток времени слова возникает дополнительная задержка.	No	['segment']

Responses

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

Description: OK

Content-Type	Type	Description
application/json	object
text/plain	string	Транскрибированные тексты в выходном формате (когда response_format был одним из `text`или `vttsrt`).

Examples

Example

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

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2025-04-01-preview

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

{
  "body": {
    "text": "A structured object when requesting json or verbose_json"
  }
}

Example

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

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2025-04-01-preview

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

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

{
  "type": "string",
  "example": "plain text when requesting text, srt, or vtt"
}

Переводы — создание

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2025-04-01-preview

Транскрибирует и преобразует входной звук на английский текст.

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: `https://aoairesource.openai.azure.com` Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
deployment-id	path	Yes	string
api-version	query	Yes	string

Request Header

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

Request Body

Content-Type: multipart/form-data

Name	Type	Description	Required	Default
file	string	Звуковой файл для перевода.	Yes
prompt	string	Необязательный текст для руководства стилем модели или продолжением предыдущего сегмента звука. Запрос должен находиться на английском языке.	No
response_format	audioResponseFormat	Определяет формат выходных данных.	No
temperature	number	Температура выборки от 0 до 1. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным. Если задано значение 0, модель использует вероятность журнала для автоматического увеличения температуры до тех пор, пока определенные пороговые значения не будут достигнуты.	No	0

Responses

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

Description: OK

Content-Type	Type	Description
application/json	object
text/plain	string	Транскрибированные тексты в выходном формате (когда response_format был одним из текста, vtt или srt).

Examples

Example

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

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2025-04-01-preview

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

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

{
  "body": {
    "text": "A structured object when requesting json or verbose_json"
  }
}

Example

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2025-04-01-preview

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

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

{
  "type": "string",
  "example": "plain text when requesting text, srt, or vtt"
}

Речь — создание

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/speech?api-version=2025-04-01-preview

Создает звук из входного текста.

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: `https://aoairesource.openai.azure.com` Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
deployment-id	path	Yes	string
api-version	query	Yes	string

Request Header

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

Request Body

Content-Type: multipart/form-data

Name	Type	Description	Required	Default
input	string	Текст для синтеза звука. Максимальная длина — 4096 символов.	Yes
response_format	enum	Формат синтеза звука в. Возможные значения: `mp3`, , `opusaacflac`, `wavpcm`	No
speed	number	Скорость синтезированного звука. Выберите значение из `0.254.0`. `1.0` — значение по умолчанию.	No	1.0
voice	enum	Голос, используемый для синтеза речи. Возможные значения: `alloy`, , `echofableonyx`, `novashimmer`	Yes

Responses

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

Description: OK

Content-Type	Type	Description
application/octet-stream	string

Examples

Example

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

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/speech?api-version=2025-04-01-preview

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

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

{
  "body": "101010101"
}

Поколения изображений — создание

POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2025-04-01-preview

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: `https://aoairesource.openai.azure.com` Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
deployment-id	path	Yes	string
api-version	query	Yes	string

Request Header

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

Request Body

Content-Type: application/json

Name	Type	Description	Required	Default
background	imageBackground	Позволяет задать прозрачность фона созданных изображений. Этот параметр поддерживается только для моделей серии gpt-image-1.	No	auto
n	integer	Количество генерируемых изображений. Для dall-e-3 поддерживается только n=1.	No	1
output_compression	integer	Уровень сжатия (0–100%) для созданных образов. Этот параметр поддерживается только для моделей серии gpt-image-1 с форматом выходных данных JPEG.	No	100
output_format	imagesOutputFormat	Формат файла, в котором возвращаются созданные изображения. Поддерживается только для моделей серии gpt-image-1.	No	png
prompt	string	Текстовое описание требуемых изображений. Максимальная длина — 32000 символов для серии gpt-image-1 и 4000 символов для dall-e-3	Yes
partial_images	integer	Количество генерируемых частичных образов. Этот параметр используется для потоковых ответов, возвращающих частичные изображения. Значение должно быть от 0 до 3. Если задано значение 0, ответ будет одним изображением, отправленным в одном событии потоковой передачи. Обратите внимание, что окончательное изображение может быть отправлено до создания полного количества частичных образов, если полный образ создается быстрее.	0
stream	boolean	Измените изображение в режиме потоковой передачи.	no	`false`
quality	imageQuality	Качество создаваемого изображения.	No	auto
response_format	imagesResponseFormat	Формат, в котором возвращаются созданные изображения. Этот параметр не поддерживается для `gpt-image-1`моделей серии, которые всегда возвращают образы в кодировке Base64. Возможные значения: `url`, `b64_json`.	No	url
size	imageSize	Размер созданных изображений.	No	auto
style	imageStyle	Стиль созданных изображений. Поддерживается только для dall-e-3.	No	vivid
user	string	Уникальный идентификатор, представляющий конечного пользователя, который может помочь в мониторинге и обнаружении злоупотреблений.	No

Responses

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

Description: Ok

Content-Type	Type	Description
application/json	generateImagesResponse

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

Описание: произошла ошибка.

Content-Type	Type	Description
application/json	dalleErrorResponse

Examples

Example

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

POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2025-04-01-preview

{
 "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
          }
        }
      }
    ]
  }
}

Поколения изображений — изменение

POST https://{endpoint}/openai/deployments/{deployment-id}/images/edits?api-version=2025-04-01-preview

Изменяет изображение из текстового заголовка для заданного развертывания модели gpt-image-1

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: `https://aoairesource.openai.azure.com` Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
deployment-id	path	Yes	string
api-version	query	Yes	string

Request Header

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

Request Body

Content-Type: multipart/form-data

Name	Type	Description	Required	Default
image	строка или массив	Изображения для редактирования. Должен быть поддерживаемым файлом изображения или массивом изображений. Каждое изображение должно быть png или jpg-файл менее 50 МБ.	Yes
input_fidelity	string	Контроль того, сколько усилий модель будет оказывать, чтобы соответствовать стилю и функциям, особенно признакам лица, входным изображениям. Этот параметр поддерживается только для моделей серии gpt-image-1. Поддерживает `high` и `low`.	no	`low`.
mask	string	Дополнительное изображение с полностью прозрачными областями (например, альфа-нулем) указывает, где следует изменить изображение. Если есть несколько изображений, маска будет применена к первому изображению. Должен быть допустимым PNG-файлом, менее 4 МБ и иметь те же размеры, что и изображение.	No
n	integer	Количество генерируемых изображений. Должно быть от 1 до 10.	No	1
prompt	string	Текстовое описание требуемых изображений. Максимальная длина — 32000 символов.	Yes
quality	imageQuality	Качество создаваемого изображения.	No	auto
partial_images	Количество генерируемых частичных образов. Этот параметр используется для потоковых ответов, возвращающих частичные изображения. Значение должно быть от 0 до 3. Если задано значение 0, ответ будет одним изображением, отправленным в одном событии потоковой передачи. Обратите внимание, что окончательное изображение может быть отправлено до создания полного количества частичных образов, если полный образ создается быстрее.
stream	boolean	Измените изображение в режиме потоковой передачи.	no	`false`
response_format	imagesResponseFormat	Формат, в котором возвращаются созданные изображения.	No	url
size	imageSize	Размер созданных изображений.	No	auto
user	string	Уникальный идентификатор, представляющий конечного пользователя, который может помочь в мониторинге и обнаружении злоупотреблений.	No

Responses

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

Description: Ok

Content-Type	Type	Description
application/json	generateImagesResponse

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

Описание: произошла ошибка.

Content-Type	Type	Description
application/json	dalleErrorResponse

Список — помощники

Note

API Помощников устарел и будет прекращен 26 августа 2026 года. Используйте общедоступную службу Microsoft Foundry Agent. Следуйте инструкциям по миграции , чтобы обновить рабочие нагрузки. Learn more.

GET https://{endpoint}/openai/assistants?api-version=2025-04-01-preview

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: `https://aoairesource.openai.azure.com` Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
limit	query	No	integer	Ограничение количества возвращаемых объектов. Ограничение может быть от 1 до 100, а значение по умолчанию — 20.
order	query	No	string Возможные значения: `asc`, `desc`	Сортировка `created_at` по метке времени объектов. `asc` для возрастания порядка и `desc` для убывания.
after	query	No	string	Курсор для использования в разбиении на страницы. `after` — это идентификатор объекта, определяющий место в списке. Например, если вы делаете запрос списка и получаете 100 объектов, заканчивая obj_foo, последующий вызов может включать after=obj_foo, чтобы получить следующую страницу списка.
before	query	No	string	Курсор для использования в разбиении на страницы. `before` — это идентификатор объекта, определяющий место в списке. Например, если вы делаете запрос списка и получаете 100 объектов, начиная с obj_foo, последующий вызов может включать до=obj_foo, чтобы получить предыдущую страницу списка.
api-version	query	Yes	string

Request Header

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

Responses

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

Description: OK

Content-Type	Type	Description
application/json	listAssistantsResponse

Examples

Example

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

GET https://{endpoint}/openai/assistants?api-version=2025-04-01-preview

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

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "asst_abc123",
        "object": "assistant",
        "created_at": 1707257477,
        "name": "Stock Analyst",
        "description": null,
        "model": "gpt-4-1106-preview",
        "instructions": "You are a financial analyst that analyzes stock market prices and other financial data present on user uploaded files or by calling external APIs.",
        "tools": [
          {
            "type": "code_interpreter"
          }
        ],
        "tool_resources": {},
        "metadata": {},
        "top_p": 1.0,
        "temperature": 1.0,
        "response_format": "auto"
      },
      {
        "id": "asst_abc456",
        "object": "assistant",
        "created_at": 1698982718,
        "name": "My Assistant",
        "description": null,
        "model": "gpt-4-turbo",
        "instructions": "You are a helpful assistant designed to make me better at coding!",
        "tools": [],
        "tool_resources": {},
        "metadata": {},
        "top_p": 1.0,
        "temperature": 1.0,
        "response_format": "auto"
      },
      {
        "id": "asst_abc789",
        "object": "assistant",
        "created_at": 1698982643,
        "name": null,
        "description": null,
        "model": "gpt-4-turbo",
        "instructions": null,
        "tools": [],
        "tool_resources": {},
        "metadata": {},
        "top_p": 1.0,
        "temperature": 1.0,
        "response_format": "auto"
      }
    ],
    "first_id": "asst_abc123",
    "last_id": "asst_abc789",
    "has_more": false
  }
}

Создание — помощник

POST https://{endpoint}/openai/assistants?api-version=2025-04-01-preview

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: `https://aoairesource.openai.azure.com` Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
api-version	query	Yes	string

Request Header

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

Request Body

Content-Type: application/json

Name	Type	Description	Required	Default
description	string	Описание помощника. Максимальная длина — 512 символов.	No
instructions	string	Системные инструкции, которые использует помощник. Максимальная длина — 256 000 символов.	No
metadata	object	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.	No
model	string		Yes
name	string	Имя помощника. Максимальная длина — 256 символов.	No
response_format	assistantsApiResponseFormatOption	Указывает формат, который модель должна выводить. Совместим с GPT-4o, GPT-4 Turbo и всеми моделями GPT-3.5 Turbo с тех пор `gpt-3.5-turbo-1106`. `{ "type": "json_schema", "json_schema": {...} }` Чтобы включить структурированные выходные данные, которые обеспечивают соответствие модели предоставленной схеме JSON. Дополнительные сведения см. в руководстве по структурированным выходным данным. Параметр включения `{ "type": "json_object" }` режима JSON, который гарантирует, что модель создает сообщение является допустимым JSON. Важно: при использовании режима JSON необходимо также указать модели создавать JSON самостоятельно с помощью системного или пользовательского сообщения. Без этого модель может создать неуправляемый поток пробелов до тех пор, пока поколение не достигнет предела маркера, в результате чего длительный и, казалось бы, "застрявший" запрос. Кроме того, обратите внимание, что содержимое сообщения может быть частично отрезано, если `finish_reason="length"`, что указывает на превышение поколения `max_tokens` или беседа превысила максимальную длину контекста.	No
temperature	number	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным.	No	1
tool_resources	object	Набор ресурсов, используемых средствами помощника. Ресурсы относятся к типу инструмента. Например, для `code_interpreter` средства требуется список идентификаторов файлов, а для `file_search` этого средства требуется список идентификаторов векторного хранилища.	No
└─ code_interpreter	object		No
└─ file_ids	array	Список идентификаторов файлов, доступных средству `code_interpreter` . С инструментом может быть не более 20 файлов.	No	[]
└─ file_search	object		No
└─ vector_store_ids	array	Хранилище векторов, присоединенное к этому помощнику. К помощнику может быть подключено не более 1 векторного хранилища.	No
└─ vector_stores	array	Помощник по созданию векторного хранилища с file_ids и присоединению его к этому помощнику. К помощнику может быть подключено не более 1 векторного хранилища.	No
tools	array	Список инструментов, включенных помощником. На помощника может быть не более 128 инструментов. Средства могут быть типами `code_interpreter`, `retrieval`или `function`.	No	[]
top_p	number	Альтернатива выборке с температурой, называемой выборкой ядра, где модель рассматривает результаты маркеров с top_p массой вероятности. Таким образом, 0,1 означает, что рассматриваются только маркеры, состоящие из 10 лучших% массы вероятностей. Как правило, мы рекомендуем изменить это или температуру, но не оба.	No	1

Responses

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

Description: OK

Content-Type	Type	Description
application/json	assistantObject

Examples

Example

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

POST https://{endpoint}/openai/assistants?api-version=2025-04-01-preview

{
 "name": "Math Tutor",
 "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.",
 "tools": [
  {
   "type": "code_interpreter"
  }
 ],
 "model": "gpt-4-1106-preview"
}

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

{
  "body": {
    "id": "asst_4nsG2qgNzimRPE7MazXTXbU7",
    "object": "assistant",
    "created_at": 1707295707,
    "name": "Math Tutor",
    "description": null,
    "model": "gpt-4-1106-preview",
    "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.",
    "tools": [
      {
        "type": "code_interpreter"
      }
    ],
    "metadata": {},
    "top_p": 1.0,
    "temperature": 1.0,
    "response_format": "auto"
  }
}

Получить - Ассистент

GET https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

Извлекает помощника.

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: `https://aoairesource.openai.azure.com` Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
assistant_id	path	Yes	string	Идентификатор извлекаемого помощника.
api-version	query	Yes	string

Request Header

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

Responses

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

Description: OK

Content-Type	Type	Description
application/json	assistantObject

Examples

Example

Извлекает помощника.

GET https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

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

{
  "body": {
    "id": "asst_abc123",
    "object": "assistant",
    "created_at": 1699009709,
    "name": "HR Helper",
    "description": null,
    "model": "gpt-4-turbo",
    "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies.",
    "tools": [
      {
        "type": "file_search"
      }
    ],
    "metadata": {},
    "top_p": 1.0,
    "temperature": 1.0,
    "response_format": "auto"
  }
}

Изменение — помощник

POST https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

Изменяет помощника.

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: `https://aoairesource.openai.azure.com` Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
assistant_id	path	Yes	string	Идентификатор помощника для изменения.
api-version	query	Yes	string

Request Header

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

Request Body

Content-Type: application/json

Name	Type	Description	Required	Default
description	string	Описание помощника. Максимальная длина — 512 символов.	No
instructions	string	Системные инструкции, которые использует помощник. Максимальная длина — 32768 символов.	No
metadata	object	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.	No
model	string		No
name	string	Имя помощника. Максимальная длина — 256 символов.	No
response_format	assistantsApiResponseFormatOption	Указывает формат, который модель должна выводить. Совместим с GPT-4o, GPT-4 Turbo и всеми моделями GPT-3.5 Turbo с тех пор `gpt-3.5-turbo-1106`. `{ "type": "json_schema", "json_schema": {...} }` Чтобы включить структурированные выходные данные, которые обеспечивают соответствие модели предоставленной схеме JSON. Дополнительные сведения см. в руководстве по структурированным выходным данным. Параметр включения `{ "type": "json_object" }` режима JSON, который гарантирует, что модель создает сообщение является допустимым JSON. Важно: при использовании режима JSON необходимо также указать модели создавать JSON самостоятельно с помощью системного или пользовательского сообщения. Без этого модель может создать неуправляемый поток пробелов до тех пор, пока поколение не достигнет предела маркера, в результате чего длительный и, казалось бы, "застрявший" запрос. Кроме того, обратите внимание, что содержимое сообщения может быть частично отрезано, если `finish_reason="length"`, что указывает на превышение поколения `max_tokens` или беседа превысила максимальную длину контекста.	No
temperature	number	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным.	No	1
tool_resources	object	Набор ресурсов, используемых средствами помощника. Ресурсы относятся к типу инструмента. Например, для `code_interpreter` средства требуется список идентификаторов файлов, а для `file_search` этого средства требуется список идентификаторов векторного хранилища.	No
└─ code_interpreter	object		No
└─ file_ids	array	Переопределяет список идентификаторов файлов, доступных средству `code_interpreter` . С инструментом может быть не более 20 файлов.	No	[]
└─ file_search	object		No
└─ vector_store_ids	array	Переопределяет хранилище векторов, подключенное к этому помощнику. К помощнику может быть подключено не более 1 векторного хранилища.	No
tools	array	Список инструментов, включенных помощником. На помощника может быть не более 128 инструментов. Средства могут быть типами `code_interpreter`, `retrieval`или `function`.	No	[]
top_p	number	Альтернатива выборке с температурой, называемой выборкой ядра, где модель рассматривает результаты маркеров с top_p массой вероятности. Таким образом, 0,1 означает, что рассматриваются только маркеры, состоящие из 10 лучших% массы вероятностей. Как правило, мы рекомендуем изменить это или температуру, но не оба.	No	1

Responses

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

Description: OK

Content-Type	Type	Description
application/json	assistantObject

Examples

Example

Изменяет помощника.

POST https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

{
 "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.",
 "tools": [
  {
   "type": "file_search"
  }
 ],
 "model": "gpt-4-turbo"
}

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

{
  "body": {
    "id": "asst_123",
    "object": "assistant",
    "created_at": 1699009709,
    "name": "HR Helper",
    "description": null,
    "model": "gpt-4-turbo",
    "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.",
    "tools": [
      {
        "type": "file_search"
      }
    ],
    "tool_resources": {
      "file_search": {
        "vector_store_ids": []
      }
    },
    "metadata": {},
    "top_p": 1.0,
    "temperature": 1.0,
    "response_format": "auto"
  }
}

Delete — Помощник

DELETE https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

Удаление помощника.

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: `https://aoairesource.openai.azure.com` Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
assistant_id	path	Yes	string	Идентификатор удаляемого помощника.
api-version	query	Yes	string

Request Header

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

Responses

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

Description: OK

Content-Type	Type	Description
application/json	deleteAssistantResponse

Examples

Example

Удаляет помощника.

DELETE https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

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

{
  "body": {
    "id": "asst_4nsG2qgNzimRPE7MazXTXbU7",
    "object": "assistant.deleted",
    "deleted": true
  }
}

Create — Thread

Note

POST https://{endpoint}/openai/threads?api-version=2025-04-01-preview

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: `https://aoairesource.openai.azure.com` Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
api-version	query	Yes	string

Request Header

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

Request Body

Content-Type: application/json

Name	Type	Description	Required	Default
messages	array	Список сообщений для запуска потока.	No
metadata	object	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.	No
tool_resources	object	Набор ресурсов, доступных средствам помощника в этом потоке. Ресурсы относятся к типу инструмента. Например, для `code_interpreter` средства требуется список идентификаторов файлов, а для `file_search` этого средства требуется список идентификаторов векторного хранилища.	No
└─ code_interpreter	object		No
└─ file_ids	array	Список идентификаторов файлов, доступных средству `code_interpreter` . С инструментом может быть не более 20 файлов.	No	[]
└─ file_search	object		No
└─ vector_store_ids	array	Хранилище векторов, присоединенное к этому потоку. К потоку может быть подключено не более 1 векторного хранилища.	No
└─ vector_stores	array	Вспомогательный объект для создания хранилища векторов с file_ids и присоединения его к этому потоку. К потоку может быть подключено не более 1 векторного хранилища.	No

Responses

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

Description: OK

Content-Type	Type	Description
application/json	threadObject

Examples

Example

Создает поток.

POST https://{endpoint}/openai/threads?api-version=2025-04-01-preview

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

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread",
    "created_at": 1707297136,
    "metadata": {}
  }
}

Get - Thread

GET https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: `https://aoairesource.openai.azure.com` Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
thread_id	path	Yes	string	Идентификатор извлекаемого потока.
api-version	query	Yes	string

Request Header

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

Responses

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

Description: OK

Content-Type	Type	Description
application/json	threadObject

Examples

Example

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

GET https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

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

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread",
    "created_at": 1707297136,
    "metadata": {},
    "tool_resources": {
      "code_interpreter": {
        "file_ids": []
      }
    }
  }
}

Изменение — поток

POST https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

Изменяет поток.

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: `https://aoairesource.openai.azure.com` Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
thread_id	path	Yes	string	Идентификатор потока для изменения. Изменить можно только те, которые `metadata` можно изменить.
api-version	query	Yes	string

Request Header

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

Request Body

Content-Type: application/json

Name	Type	Description	Required	Default
metadata	object	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.	No
tool_resources	object	Набор ресурсов, доступных средствам помощника в этом потоке. Ресурсы относятся к типу инструмента. Например, для `code_interpreter` средства требуется список идентификаторов файлов, а для `file_search` этого средства требуется список идентификаторов векторного хранилища.	No
└─ code_interpreter	object		No
└─ file_ids	array	Список идентификаторов файлов, доступных средству `code_interpreter` . С инструментом может быть не более 20 файлов.	No	[]
└─ file_search	object		No
└─ vector_store_ids	array	Хранилище векторов, присоединенное к этому потоку. К потоку может быть подключено не более 1 векторного хранилища.	No

Responses

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

Description: OK

Content-Type	Type	Description
application/json	threadObject

Examples

Example

Изменяет поток.

POST https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

{
 "metadata": {
  "modified": "true",
  "user": "abc123"
 }
}

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

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread",
    "created_at": 1707297136,
    "metadata": {
      "modified": "true",
      "user": "abc123"
    },
    "tool_resources": {}
  }
}

Delete — Thread

DELETE https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

Удаление потока.

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: `https://aoairesource.openai.azure.com` Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
thread_id	path	Yes	string	Идентификатор удаляемого потока.
api-version	query	Yes	string

Request Header

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

Responses

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

Description: OK

Content-Type	Type	Description
application/json	deleteThreadResponse

Examples

Example

Удаляет поток.

DELETE https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

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

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread.deleted",
    "deleted": true
  }
}

Список — сообщения

Note

GET https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-01-preview

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: `https://aoairesource.openai.azure.com` Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
thread_id	path	Yes	string	Идентификатор потоков, к которому относятся сообщения.
limit	query	No	integer	Ограничение количества возвращаемых объектов. Ограничение может быть от 1 до 100, а значение по умолчанию — 20.
order	query	No	string Возможные значения: `asc`, `desc`	Сортировка `created_at` по метке времени объектов. `asc` для возрастания порядка и `desc` для убывания.
after	query	No	string	Курсор для использования в разбиении на страницы. `after` — это идентификатор объекта, определяющий место в списке. Например, если вы делаете запрос списка и получаете 100 объектов, заканчивая obj_foo, последующий вызов может включать after=obj_foo, чтобы получить следующую страницу списка.
before	query	No	string	Курсор для использования в разбиении на страницы. `before` — это идентификатор объекта, определяющий место в списке. Например, если вы делаете запрос списка и получаете 100 объектов, начиная с obj_foo, последующий вызов может включать до=obj_foo, чтобы получить предыдущую страницу списка.
run_id	query	No	string	Фильтруйте сообщения по идентификатору запуска, который создал их.
api-version	query	Yes	string

Request Header

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

Responses

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

Description: OK

Content-Type	Type	Description
application/json	listMessagesResponse

Examples

Example

List Messages

GET https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-01-preview

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

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "msg_abc123",
        "object": "thread.message",
        "created_at": 1699016383,
        "assistant_id": null,
        "thread_id": "thread_abc123",
        "run_id": null,
        "role": "user",
        "content": [
          {
            "type": "text",
            "text": {
              "value": "How does AI work? Explain it in simple terms.",
              "annotations": []
            }
          }
        ],
        "attachments": [],
        "metadata": {}
      },
      {
        "id": "msg_abc456",
        "object": "thread.message",
        "created_at": 1699016383,
        "assistant_id": null,
        "thread_id": "thread_abc123",
        "run_id": null,
        "role": "user",
        "content": [
          {
            "type": "text",
            "text": {
              "value": "Hello, what is AI?",
              "annotations": []
            }
          }
        ],
        "attachments": [],
        "metadata": {}
      }
    ],
    "first_id": "msg_abc123",
    "last_id": "msg_abc456",
    "has_more": false
  }
}

Создание — сообщение

POST https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-01-preview

Создайте сообщение.

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: `https://aoairesource.openai.azure.com` Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
thread_id	path	Yes	string	Идентификатор потоков для создания сообщения.
api-version	query	Yes	string

Request Header

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

Request Body

Content-Type: application/json

Name	Type	Description	Required
attachments	array	Список файлов, присоединенных к сообщению, и инструменты, к которому они должны быть добавлены.	No
content	string	Содержимое сообщения.	Yes
metadata	object	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.	No
role	string	Роль сущности, создающей сообщение. Допустимые значения: - `user`: указывает, что сообщение отправляется фактическим пользователем и должно использоваться в большинстве случаев для представления сообщений, созданных пользователем. - `assistant`: указывает, что сообщение создается помощником. Используйте это значение для вставки сообщений от помощника в беседу.	Yes

Responses

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

Description: OK

Content-Type	Type	Description
application/json	messageObject

Examples

Example

Создайте сообщение.

POST https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-01-preview

{
 "role": "user",
 "content": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces."
}

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

{
  "body": {
    "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4",
    "object": "thread.message",
    "created_at": 1707298421,
    "assistant_id": null,
    "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "run_id": null,
    "role": "user",
    "content": [
      {
        "type": "text",
        "text": {
          "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.",
          "annotations": []
        }
      }
    ],
    "attachments": [],
    "metadata": {}
  }
}

Получить - Сообщение

GET https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-01-preview

Получение сообщения.

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: `https://aoairesource.openai.azure.com` Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
thread_id	path	Yes	string	Идентификатор потоков, к которым принадлежит это сообщение.
message_id	path	Yes	string	Идентификатор полученного сообщения.
api-version	query	Yes	string

Request Header

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

Responses

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

Description: OK

Content-Type	Type	Description
application/json	messageObject

Examples

Example

Получение сообщения.

GET https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-01-preview

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

{
  "body": {
    "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4",
    "object": "thread.message",
    "created_at": 1707298421,
    "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "role": "user",
    "content": [
      {
        "type": "text",
        "text": {
          "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.",
          "annotations": []
        }
      }
    ],
    "file_ids": [],
    "assistant_id": null,
    "run_id": null,
    "metadata": {}
  }
}

Изменение — сообщение

POST https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-01-preview

Изменяет сообщение.

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: `https://aoairesource.openai.azure.com` Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
thread_id	path	Yes	string	Идентификатор потока, к которому принадлежит это сообщение.
message_id	path	Yes	string	Идентификатор сообщения для изменения.
api-version	query	Yes	string

Request Header

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

Request Body

Content-Type: application/json

Name	Type	Description	Required	Default
metadata	object	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.	No

Responses

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

Description: OK

Content-Type	Type	Description
application/json	messageObject

Examples

Example

Изменение сообщения.

POST https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-01-preview

{
 "metadata": {
  "modified": "true",
  "user": "abc123"
 }
}

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

{
  "body": {
    "id": "msg_abc123",
    "object": "thread.message",
    "created_at": 1699017614,
    "assistant_id": null,
    "thread_id": "thread_abc123",
    "run_id": null,
    "role": "user",
    "content": [
      {
        "type": "text",
        "text": {
          "value": "How does AI work? Explain it in simple terms.",
          "annotations": []
        }
      }
    ],
    "file_ids": [],
    "metadata": {
      "modified": "true",
      "user": "abc123"
    }
  }
}

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

Note

POST https://{endpoint}/openai/threads/runs?api-version=2025-04-01-preview

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: `https://aoairesource.openai.azure.com` Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
api-version	query	Yes	string

Request Header

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

Request Body

Content-Type: application/json

Name	Type	Description	Required	Default
assistant_id	string	Идентификатор помощника, используемого для выполнения этого выполнения.	Yes
instructions	string	Переопределите системное сообщение помощника по умолчанию. Это полезно для изменения поведения на основе каждого запуска.	No
max_completion_tokens	integer	Максимальное количество маркеров завершения, которые могут использоваться в ходе выполнения. Выполнение делает все возможное, чтобы использовать только количество маркеров завершения, указанных в нескольких поворотах выполнения. Если выполнение превышает указанное число маркеров завершения, выполнение завершится состоянием `incomplete`. Дополнительные сведения см. в разделе `incomplete_details` .	No
max_prompt_tokens	integer	Максимальное количество маркеров запроса, которые могут использоваться в ходе выполнения. Выполнение делает все возможное, чтобы использовать только количество маркеров запроса, указанных в нескольких поворотах выполнения. Если выполнение превышает указанное число маркеров запроса, выполнение завершится состоянием `incomplete`. Дополнительные сведения см. в разделе `incomplete_details` .	No
metadata	object	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.	No
model	string	Идентификатор моделей, используемых для выполнения этого выполнения. Если здесь указано значение, оно переопределит модель, связанную с помощником. В противном случае будет использоваться модель, связанная с помощником.	No
parallel_tool_calls	ParallelToolCalls	Следует ли включить параллельные вызовы функций во время использования средства.	No	True
response_format	assistantsApiResponseFormatOption	Указывает формат, который модель должна выводить. Совместим с GPT-4o, GPT-4 Turbo и всеми моделями GPT-3.5 Turbo с тех пор `gpt-3.5-turbo-1106`. `{ "type": "json_schema", "json_schema": {...} }` Чтобы включить структурированные выходные данные, которые обеспечивают соответствие модели предоставленной схеме JSON. Дополнительные сведения см. в руководстве по структурированным выходным данным. Параметр включения `{ "type": "json_object" }` режима JSON, который гарантирует, что модель создает сообщение является допустимым JSON. Важно: при использовании режима JSON необходимо также указать модели создавать JSON самостоятельно с помощью системного или пользовательского сообщения. Без этого модель может создать неуправляемый поток пробелов до тех пор, пока поколение не достигнет предела маркера, в результате чего длительный и, казалось бы, "застрявший" запрос. Кроме того, обратите внимание, что содержимое сообщения может быть частично отрезано, если `finish_reason="length"`, что указывает на превышение поколения `max_tokens` или беседа превысила максимальную длину контекста.	No
stream	boolean	Если `true`возвращает поток событий, которые происходят во время событий запуска от имени сервера, завершая выполнение в состоянии терминала с сообщением `data: [DONE]` .	No
stream_options	chatCompletionStreamOptions	Параметры потокового ответа. Этот параметр устанавливается только при установке `stream: true`.	No	None
temperature	number	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным.	No	1
thread	createThreadRequest		No
tool_choice	assistantsApiToolChoiceOption	Определяет, какое средство (если таковое) вызывается моделью. `none` означает, что модель не вызывает средства и вместо этого создает сообщение. `auto` является значением по умолчанию и означает, что модель может выбирать между созданием сообщения или вызовом средства. Указание определенного инструмента, например `{"type": "file_search"}` или `{"type": "function", "function": {"name": "my_function"}}` принудительное вызов модели.	No
tool_resources	object	Набор ресурсов, используемых средствами помощника. Ресурсы относятся к типу инструмента. Например, для `code_interpreter` средства требуется список идентификаторов файлов, а для `file_search` этого средства требуется список идентификаторов векторного хранилища.	No
└─ code_interpreter	object		No
└─ file_ids	array	Список идентификаторов файлов, доступных средству `code_interpreter` . С инструментом может быть не более 20 файлов.	No	[]
└─ file_search	object		No
└─ vector_store_ids	array	Идентификатор хранилища векторов, присоединенного к этому помощнику. К помощнику может быть подключено не более 1 векторного хранилища.	No
tools	array	Переопределите средства, которые помощник может использовать для этого запуска. Это полезно для изменения поведения на основе каждого запуска.	No
top_p	number	Альтернатива выборке с температурой, называемой выборкой ядра, где модель рассматривает результаты маркеров с top_p массой вероятности. Таким образом, 0,1 означает, что рассматриваются только маркеры, состоящие из 10 лучших% массы вероятностей. Как правило, мы рекомендуем изменить это или температуру, но не оба.	No	1
truncation_strategy	truncationObject	Определяет, как поток будет усечен до выполнения. Используйте это для управления начальным окном контекста выполнения.	No

Responses

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

Description: OK

Content-Type	Type	Description
application/json	runObject

Examples

Example

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

POST https://{endpoint}/openai/threads/runs?api-version=2025-04-01-preview

{
 "assistant_id": "asst_abc123",
 "thread": {
  "messages": [
   {
    "role": "user",
    "content": "Explain deep learning to a 5 year old."
   }
  ]
 }
}

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

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699076792,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "queued",
    "started_at": null,
    "expires_at": 1699077392,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": null,
    "required_action": null,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": "You are a helpful assistant.",
    "tools": [],
    "tool_resources": {},
    "metadata": {},
    "temperature": 1.0,
    "top_p": 1.0,
    "max_completion_tokens": null,
    "max_prompt_tokens": null,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "incomplete_details": null,
    "usage": null,
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

Список — запуски

GET https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-01-preview

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: `https://aoairesource.openai.azure.com` Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
thread_id	path	Yes	string	Идентификатор потока, к которому принадлежит выполнение.
limit	query	No	integer	Ограничение количества возвращаемых объектов. Ограничение может быть от 1 до 100, а значение по умолчанию — 20.
order	query	No	string Возможные значения: `asc`, `desc`	Сортировка `created_at` по метке времени объектов. `asc` для возрастания порядка и `desc` для убывания.
after	query	No	string	Курсор для использования в разбиении на страницы. `after` — это идентификатор объекта, определяющий место в списке. Например, если вы делаете запрос списка и получаете 100 объектов, заканчивая obj_foo, последующий вызов может включать after=obj_foo, чтобы получить следующую страницу списка.
before	query	No	string	Курсор для использования в разбиении на страницы. `before` — это идентификатор объекта, определяющий место в списке. Например, если вы делаете запрос списка и получаете 100 объектов, начиная с obj_foo, последующий вызов может включать до=obj_foo, чтобы получить предыдущую страницу списка.
api-version	query	Yes	string

Request Header

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

Responses

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

Description: OK

Content-Type	Type	Description
application/json	listRunsResponse

Examples

Example

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

GET https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-01-preview

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

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "run_abc123",
        "object": "thread.run",
        "created_at": 1699075072,
        "assistant_id": "asst_abc123",
        "thread_id": "thread_abc123",
        "status": "completed",
        "started_at": 1699075072,
        "expires_at": null,
        "cancelled_at": null,
        "failed_at": null,
        "completed_at": 1699075073,
        "last_error": null,
        "model": "gpt-4-turbo",
        "instructions": null,
        "incomplete_details": null,
        "tools": [
          {
            "type": "code_interpreter"
          }
        ],
        "tool_resources": {
          "code_interpreter": {
            "file_ids": [
              "file-abc123",
              "file-abc456"
            ]
          }
        },
        "metadata": {},
        "usage": {
          "prompt_tokens": 123,
          "completion_tokens": 456,
          "total_tokens": 579
        },
        "temperature": 1.0,
        "top_p": 1.0,
        "max_prompt_tokens": 1000,
        "max_completion_tokens": 1000,
        "truncation_strategy": {
          "type": "auto",
          "last_messages": null
        },
        "response_format": "auto",
        "tool_choice": "auto"
      },
      {
        "id": "run_abc456",
        "object": "thread.run",
        "created_at": 1699063290,
        "assistant_id": "asst_abc123",
        "thread_id": "thread_abc123",
        "status": "completed",
        "started_at": 1699063290,
        "expires_at": null,
        "cancelled_at": null,
        "failed_at": null,
        "completed_at": 1699063291,
        "last_error": null,
        "model": "gpt-4-turbo",
        "instructions": null,
        "incomplete_details": null,
        "tools": [
          {
            "type": "code_interpreter"
          }
        ],
        "tool_resources": {
          "code_interpreter": {
            "file_ids": [
              "file-abc123",
              "file-abc456"
            ]
          }
        },
        "metadata": {},
        "usage": {
          "prompt_tokens": 123,
          "completion_tokens": 456,
          "total_tokens": 579
        },
        "temperature": 1.0,
        "top_p": 1.0,
        "max_prompt_tokens": 1000,
        "max_completion_tokens": 1000,
        "truncation_strategy": {
          "type": "auto",
          "last_messages": null
        },
        "response_format": "auto",
        "tool_choice": "auto"
      }
    ],
    "first_id": "run_abc123",
    "last_id": "run_abc456",
    "has_more": false
  }
}

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

POST https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-01-preview

Создайте запуск.

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: `https://aoairesource.openai.azure.com` Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
thread_id	path	Yes	string	Идентификатор выполняемого потока.
include[]	query	No	array	Список дополнительных полей для включения в ответ. В настоящее время единственным поддерживаемым значением является `step_details.tool_calls[].file_search.results[].content` получение содержимого результата поиска файла.
api-version	query	Yes	string

Request Header

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

Request Body

Content-Type: application/json

Name	Type	Description	Required	Default
additional_instructions	string	Добавляет дополнительные инструкции в конце инструкций для выполнения. Это полезно для изменения поведения на основе каждого запуска без переопределения других инструкций.	No
additional_messages	array	Добавляет дополнительные сообщения в поток перед созданием запуска.	No
assistant_id	string	Идентификатор помощника, используемого для выполнения этого выполнения.	Yes
instructions	string	Переопределите системное сообщение помощника по умолчанию. Это полезно для изменения поведения на основе каждого запуска.	No
max_completion_tokens	integer	Максимальное количество маркеров завершения, которые могут использоваться в ходе выполнения. Выполнение делает все возможное, чтобы использовать только количество маркеров завершения, указанных в нескольких поворотах выполнения. Если выполнение превышает указанное число маркеров завершения, выполнение завершится состоянием `incomplete`. Дополнительные сведения см. в разделе `incomplete_details` .	No
max_prompt_tokens	integer	Максимальное количество маркеров запроса, которые могут использоваться в ходе выполнения. Выполнение делает все возможное, чтобы использовать только количество маркеров запроса, указанных в нескольких поворотах выполнения. Если выполнение превышает указанное число маркеров запроса, выполнение завершится состоянием `incomplete`. Дополнительные сведения см. в разделе `incomplete_details` .	No
metadata	object	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.	No
model	string	Идентификатор модели, используемой для выполнения этого выполнения. Если здесь указано значение, оно переопределит модель, связанную с помощником. В противном случае будет использоваться модель, связанная с помощником.	No
parallel_tool_calls	ParallelToolCalls	Следует ли включить параллельные вызовы функций во время использования средства.	No	True
response_format	assistantsApiResponseFormatOption	Указывает формат, который модель должна выводить. Совместим с GPT-4o, GPT-4 Turbo и всеми моделями GPT-3.5 Turbo с тех пор `gpt-3.5-turbo-1106`. `{ "type": "json_schema", "json_schema": {...} }` Чтобы включить структурированные выходные данные, которые обеспечивают соответствие модели предоставленной схеме JSON. Дополнительные сведения см. в руководстве по структурированным выходным данным. Параметр включения `{ "type": "json_object" }` режима JSON, который гарантирует, что модель создает сообщение является допустимым JSON. Важно: при использовании режима JSON необходимо также указать модели создавать JSON самостоятельно с помощью системного или пользовательского сообщения. Без этого модель может создать неуправляемый поток пробелов до тех пор, пока поколение не достигнет предела маркера, в результате чего длительный и, казалось бы, "застрявший" запрос. Кроме того, обратите внимание, что содержимое сообщения может быть частично отрезано, если `finish_reason="length"`, что указывает на превышение поколения `max_tokens` или беседа превысила максимальную длину контекста.	No
stream	boolean	Если `true`возвращает поток событий, которые происходят во время событий запуска от имени сервера, завершая выполнение в состоянии терминала с сообщением `data: [DONE]` .	No
temperature	number	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным.	No	1
tool_choice	assistantsApiToolChoiceOption	Определяет, какое средство (если таковое) вызывается моделью. `none` означает, что модель не вызывает средства и вместо этого создает сообщение. `auto` является значением по умолчанию и означает, что модель может выбирать между созданием сообщения или вызовом средства. Указание определенного инструмента, например `{"type": "file_search"}` или `{"type": "function", "function": {"name": "my_function"}}` принудительное вызов модели.	No
tools	array	Переопределите средства, которые помощник может использовать для этого запуска. Это полезно для изменения поведения на основе каждого запуска.	No
top_p	number	Альтернатива выборке с температурой, называемой выборкой ядра, где модель рассматривает результаты маркеров с top_p массой вероятности. Таким образом, 0,1 означает, что рассматриваются только маркеры, состоящие из 10 лучших% массы вероятностей. Как правило, мы рекомендуем изменить это или температуру, но не оба.	No	1
truncation_strategy	truncationObject	Определяет, как поток будет усечен до выполнения. Используйте это для управления начальным окном контекста выполнения.	No

Responses

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

Description: OK

Content-Type	Type	Description
application/json	runObject

Examples

Example

Создайте запуск.

POST https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-01-preview

{
 "assistant_id": "asst_abc123"
}

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

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699063290,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "queued",
    "started_at": 1699063290,
    "expires_at": null,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": 1699063291,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": null,
    "incomplete_details": null,
    "tools": [
      {
        "type": "code_interpreter"
      }
    ],
    "metadata": {},
    "usage": null,
    "temperature": 1.0,
    "top_p": 1.0,
    "max_prompt_tokens": 1000,
    "max_completion_tokens": 1000,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

Получить - Запустить

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-01-preview

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: `https://aoairesource.openai.azure.com` Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
thread_id	path	Yes	string	Идентификатор выполняемых потоков.
run_id	path	Yes	string	Идентификатор извлекаемого запуска.
api-version	query	Yes	string

Request Header

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

Responses

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

Description: OK

Content-Type	Type	Description
application/json	runObject

Examples

Example

Возвращает выполнение.

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-01-preview

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

{
  "body": {
    "id": "run_HsO8tYM4K5AAMAHgK0J3om8Q",
    "object": "thread.run",
    "created_at": 1707303196,
    "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl",
    "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh",
    "status": "completed",
    "started_at": 1707303197,
    "expires_at": null,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": 1707303201,
    "last_error": null,
    "model": "gpt-4-1106-preview",
    "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.",
    "tools": [],
    "file_ids": [],
    "metadata": {}
  }
}

Изменение — запуск

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-01-preview

Изменяет выполнение.

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: `https://aoairesource.openai.azure.com` Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
thread_id	path	Yes	string	Идентификатор выполняемых потоков.
run_id	path	Yes	string	Идентификатор запуска для изменения.
api-version	query	Yes	string

Request Header

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

Request Body

Content-Type: application/json

Name	Type	Description	Required	Default
metadata	object	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.	No

Responses

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

Description: OK

Content-Type	Type	Description
application/json	runObject

Examples

Example

Изменяет выполнение.

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-01-preview

{
 "metadata": {
  "user_id": "user_abc123"
 }
}

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

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699075072,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "completed",
    "started_at": 1699075072,
    "expires_at": null,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": 1699075073,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": null,
    "incomplete_details": null,
    "tools": [
      {
        "type": "code_interpreter"
      }
    ],
    "tool_resources": {
      "code_interpreter": {
        "file_ids": [
          "file-abc123",
          "file-abc456"
        ]
      }
    },
    "metadata": {
      "user_id": "user_abc123"
    },
    "usage": {
      "prompt_tokens": 123,
      "completion_tokens": 456,
      "total_tokens": 579
    },
    "temperature": 1.0,
    "top_p": 1.0,
    "max_prompt_tokens": 1000,
    "max_completion_tokens": 1000,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

Отправка — выходные данные средства для запуска

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/submit_tool_outputs?api-version=2025-04-01-preview

Если выполнение имеет status: "requires_action" и required_action.type есть submit_tool_outputs, эта конечная точка может использоваться для отправки выходных данных из вызовов средства после их завершения. Все выходные данные должны быть отправлены в одном запросе.

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: `https://aoairesource.openai.azure.com` Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
thread_id	path	Yes	string	Идентификатор потоков, к которым принадлежит этот запуск.
run_id	path	Yes	string	Идентификатор выполнения, требующего отправки выходных данных средства.
api-version	query	Yes	string

Request Header

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

Request Body

Content-Type: application/json

Name	Type	Description	Required	Default
stream	boolean	Если `true`возвращает поток событий, которые происходят во время событий запуска от имени сервера, завершая выполнение в состоянии терминала с сообщением `data: [DONE]` .	No
tool_outputs	array	Список инструментов, для которых отправляются выходные данные.	Yes

Responses

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

Description: OK

Content-Type	Type	Description
application/json	runObject

Examples

Example

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/submit_tool_outputs?api-version=2025-04-01-preview

{
 "tool_outputs": [
  {
   "tool_call_id": "call_001",
   "output": "70 degrees and sunny."
  }
 ]
}

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

{
  "body": {
    "id": "run_123",
    "object": "thread.run",
    "created_at": 1699075592,
    "assistant_id": "asst_123",
    "thread_id": "thread_123",
    "status": "queued",
    "started_at": 1699075592,
    "expires_at": 1699076192,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": null,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": null,
    "tools": [
      {
        "type": "function",
        "function": {
          "name": "get_current_weather",
          "description": "Get the current weather in a given location",
          "parameters": {
            "type": "object",
            "properties": {
              "location": {
                "type": "string",
                "description": "The city and state, e.g. San Francisco, CA"
              },
              "unit": {
                "type": "string",
                "enum": [
                  "celsius",
                  "fahrenheit"
                ]
              }
            },
            "required": [
              "location"
            ]
          }
        }
      }
    ],
    "metadata": {},
    "usage": null,
    "temperature": 1.0,
    "top_p": 1.0,
    "max_prompt_tokens": 1000,
    "max_completion_tokens": 1000,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

Отмена — запуск

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/cancel?api-version=2025-04-01-preview

Отменяет запуск, который является in_progress.

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: `https://aoairesource.openai.azure.com` Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
thread_id	path	Yes	string	Идентификатор потока, к которому принадлежит этот запуск.
run_id	path	Yes	string	Идентификатор запуска для отмены.
api-version	query	Yes	string

Request Header

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

Responses

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

Description: OK

Content-Type	Type	Description
application/json	runObject

Examples

Example

Отменяет запуск, который является in_progress.

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/cancel?api-version=2025-04-01-preview

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

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699076126,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "cancelling",
    "started_at": 1699076126,
    "expires_at": 1699076726,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": null,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": "You summarize books.",
    "tools": [
      {
        "type": "file_search"
      }
    ],
    "tool_resources": {
      "file_search": {
        "vector_store_ids": [
          "vs_123"
        ]
      }
    },
    "metadata": {},
    "usage": null,
    "temperature": 1.0,
    "top_p": 1.0,
    "response_format": "auto"
  }
}

Список — шаги выполнения

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps?api-version=2025-04-01-preview

Возвращает список шагов выполнения, принадлежащих выполнению.

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: `https://aoairesource.openai.azure.com` Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
thread_id	path	Yes	string	Идентификатор потока, к которому относятся шаги выполнения и выполнения.
run_id	path	Yes	string	Идентификатор выполнения шагов выполнения принадлежит.
limit	query	No	integer	Ограничение количества возвращаемых объектов. Ограничение может быть от 1 до 100, а значение по умолчанию — 20.
order	query	No	string Возможные значения: `asc`, `desc`	Сортировка `created_at` по метке времени объектов. `asc` для возрастания порядка и `desc` для убывания.
after	query	No	string	Курсор для использования в разбиении на страницы. `after` — это идентификатор объекта, определяющий место в списке. Например, если вы делаете запрос списка и получаете 100 объектов, заканчивая obj_foo, последующий вызов может включать after=obj_foo, чтобы получить следующую страницу списка.
before	query	No	string	Курсор для использования в разбиении на страницы. `before` — это идентификатор объекта, определяющий место в списке. Например, если вы делаете запрос списка и получаете 100 объектов, начиная с obj_foo, последующий вызов может включать до=obj_foo, чтобы получить предыдущую страницу списка.
api-version	query	Yes	string
include[]	query	No	array	Список дополнительных полей для включения в ответ. В настоящее время единственным поддерживаемым значением является `step_details.tool_calls[].file_search.results[].content` получение содержимого результата поиска файла.

Request Header

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

Responses

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

Description: OK

Content-Type	Type	Description
application/json	listRunStepsResponse

Examples

Example

Возвращает список шагов выполнения, принадлежащих выполнению.

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps?api-version=2025-04-01-preview

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

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "step_abc123",
        "object": "thread.run.step",
        "created_at": 1699063291,
        "run_id": "run_abc123",
        "assistant_id": "asst_abc123",
        "thread_id": "thread_abc123",
        "type": "message_creation",
        "status": "completed",
        "cancelled_at": null,
        "completed_at": 1699063291,
        "expired_at": null,
        "failed_at": null,
        "last_error": null,
        "step_details": {
          "type": "message_creation",
          "message_creation": {
            "message_id": "msg_abc123"
          }
        },
        "usage": {
          "prompt_tokens": 123,
          "completion_tokens": 456,
          "total_tokens": 579
        }
      }
    ],
    "first_id": "step_abc123",
    "last_id": "step_abc456",
    "has_more": false
  }
}

Получение — шаг выполнения

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps/{step_id}?api-version=2025-04-01-preview

Извлекает шаг выполнения.

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: `https://aoairesource.openai.azure.com` Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
thread_id	path	Yes	string	Идентификатор потока, к которому принадлежит шаг выполнения и выполнения.
run_id	path	Yes	string	Идентификатор выполнения, к которому принадлежит шаг выполнения.
step_id	path	Yes	string	Идентификатор шага выполнения, который требуется получить.
include[]	query	No	array	Список дополнительных полей для включения в ответ. В настоящее время единственным поддерживаемым значением является `step_details.tool_calls[].file_search.results[].content` получение содержимого результата поиска файла.
api-version	query	Yes	string

Request Header

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

Responses

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

Description: OK

Content-Type	Type	Description
application/json	runStepObject

Examples

Example

Извлекает шаг выполнения.

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps/{step_id}?api-version=2025-04-01-preview

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

{
  "body": {
    "id": "step_abc123",
    "object": "thread.run.step",
    "created_at": 1699063291,
    "run_id": "run_abc123",
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "type": "message_creation",
    "status": "completed",
    "cancelled_at": null,
    "completed_at": 1699063291,
    "expired_at": null,
    "failed_at": null,
    "last_error": null,
    "step_details": {
      "type": "message_creation",
      "message_creation": {
        "message_id": "msg_abc123"
      }
    },
    "usage": {
      "prompt_tokens": 123,
      "completion_tokens": 456,
      "total_tokens": 579
    }
  }
}

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

GET https://{endpoint}/openai/vector_stores?api-version=2025-04-01-preview

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: `https://aoairesource.openai.azure.com` Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
limit	query	No	integer	Ограничение количества возвращаемых объектов. Ограничение может быть от 1 до 100, а значение по умолчанию — 20.
order	query	No	string Возможные значения: `asc`, `desc`	Сортировка `created_at` по метке времени объектов. `asc` для возрастания порядка и `desc` для убывания.
after	query	No	string	Курсор для использования в разбиении на страницы. `after` — это идентификатор объекта, определяющий место в списке. Например, если вы делаете запрос списка и получаете 100 объектов, заканчивая obj_foo, последующий вызов может включать after=obj_foo, чтобы получить следующую страницу списка.
before	query	No	string	Курсор для использования в разбиении на страницы. `before` — это идентификатор объекта, определяющий место в списке. Например, если вы делаете запрос списка и получаете 100 объектов, начиная с obj_foo, последующий вызов может включать до=obj_foo, чтобы получить предыдущую страницу списка.
api-version	query	Yes	string	api version

Request Header

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

Responses

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

Description: OK

Content-Type	Type	Description
application/json	listVectorStoresResponse

Examples

Example

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

GET https://{endpoint}/openai/vector_stores?api-version=2025-04-01-preview

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

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "vs_abc123",
        "object": "vector_store",
        "created_at": 1699061776,
        "name": "Support FAQ",
        "bytes": 139920,
        "file_counts": {
          "in_progress": 0,
          "completed": 3,
          "failed": 0,
          "cancelled": 0,
          "total": 3
        }
      },
      {
        "id": "vs_abc456",
        "object": "vector_store",
        "created_at": 1699061776,
        "name": "Support FAQ v2",
        "bytes": 139920,
        "file_counts": {
          "in_progress": 0,
          "completed": 3,
          "failed": 0,
          "cancelled": 0,
          "total": 3
        }
      }
    ],
    "first_id": "vs_abc123",
    "last_id": "vs_abc456",
    "has_more": false
  }
}

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

POST https://{endpoint}/openai/vector_stores?api-version=2025-04-01-preview

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: `https://aoairesource.openai.azure.com` Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
api-version	query	Yes	string	api version

Request Header

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

Request Body

Content-Type: application/json

Name	Type	Description	Required
chunking_strategy	autoChunkingStrategyRequestParam или staticChunkingStrategyRequestParam	Стратегия блокирования, используемая для блокирования файлов. Если этот параметр не задан, используйте стратегию `auto` . Применимо только в том случае, если `file_ids` он не пуст.	No
expires_after	vectorStoreExpirationAfter	Политика истечения срока действия для хранилища векторов.	No
file_ids	array	Список идентификаторов файлов, которые следует использовать векторным хранилищем. Полезно для таких средств, как `file_search` доступ к файлам.	No
metadata	object	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.	No
name	string	Имя векторного хранилища.	No

Responses

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

Description: OK

Content-Type	Type	Description
application/json	vectorStoreObject

Examples

Example

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

POST https://{endpoint}/openai/vector_stores?api-version=2025-04-01-preview

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

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store",
    "created_at": 1699061776,
    "name": "Support FAQ",
    "bytes": 139920,
    "file_counts": {
      "in_progress": 0,
      "completed": 3,
      "failed": 0,
      "cancelled": 0,
      "total": 3
    }
  }
}

Get — Vector Store

GET https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: `https://aoairesource.openai.azure.com` Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
vector_store_id	path	Yes	string	Идентификатор извлекаемого хранилища векторов.
api-version	query	Yes	string	api version

Request Header

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

Responses

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

Description: OK

Content-Type	Type	Description
application/json	vectorStoreObject

Examples

Example

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

GET https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

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

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store",
    "created_at": 1699061776
  }
}

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

POST https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: `https://aoairesource.openai.azure.com` Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
vector_store_id	path	Yes	string	Идентификатор измененного хранилища векторов.
api-version	query	Yes	string	api version

Request Header

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

Request Body

Content-Type: application/json

Name	Type	Description	Required
expires_after	vectorStoreExpirationAfter	Политика истечения срока действия для хранилища векторов.	No
metadata	object	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.	No
name	string	Имя векторного хранилища.	No

Responses

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

Description: OK

Content-Type	Type	Description
application/json	vectorStoreObject

Examples

Example

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

POST https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

{
 "name": "Support FAQ"
}

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

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store",
    "created_at": 1699061776,
    "name": "Support FAQ",
    "bytes": 139920,
    "file_counts": {
      "in_progress": 0,
      "completed": 3,
      "failed": 0,
      "cancelled": 0,
      "total": 3
    }
  }
}

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

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: `https://aoairesource.openai.azure.com` Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
vector_store_id	path	Yes	string	Идентификатор удаленного хранилища векторов.
api-version	query	Yes	string	api version

Request Header

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

Responses

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

Description: OK

Content-Type	Type	Description
application/json	deleteVectorStoreResponse

Examples

Example

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

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

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

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store.deleted",
    "deleted": true
  }
}

Список — файлы векторного хранилища

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-01-preview

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: `https://aoairesource.openai.azure.com` Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
vector_store_id	path	Yes	string	Идентификатор хранилища векторов, к которому принадлежат файлы.
limit	query	No	integer	Ограничение количества возвращаемых объектов. Ограничение может быть от 1 до 100, а значение по умолчанию — 20.
order	query	No	string Возможные значения: `asc`, `desc`	Сортировка `created_at` по метке времени объектов. `asc` для возрастания порядка и `desc` для убывания.
after	query	No	string	Курсор для использования в разбиении на страницы. `after` — это идентификатор объекта, определяющий место в списке. Например, если вы делаете запрос списка и получаете 100 объектов, заканчивая obj_foo, последующий вызов может включать after=obj_foo, чтобы получить следующую страницу списка.
before	query	No	string	Курсор для использования в разбиении на страницы. `before` — это идентификатор объекта, определяющий место в списке. Например, если вы делаете запрос списка и получаете 100 объектов, начиная с obj_foo, последующий вызов может включать до=obj_foo, чтобы получить предыдущую страницу списка.
filter	query	No	string Возможные значения: `in_progress`, , `completedfailedcancelled`	Фильтрация по состоянию файла. Один из `in_progress`, , `completedfailed`, `cancelled`.
api-version	query	Yes	string	api version

Request Header

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

Responses

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

Description: OK

Content-Type	Type	Description
application/json	listVectorStoreFilesResponse

Examples

Example

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

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-01-preview

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

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "file-abc123",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      },
      {
        "id": "file-abc456",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      }
    ],
    "first_id": "file-abc123",
    "last_id": "file-abc456",
    "has_more": false
  }
}

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

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-01-preview

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: `https://aoairesource.openai.azure.com` Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
vector_store_id	path	Yes	string	Идентификатор векторного хранилища, для которого создается файл.
api-version	query	Yes	string	api version

Request Header

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

Request Body

Content-Type: application/json

Name	Type	Description	Required	Default
chunking_strategy	chunkingStrategyRequestParam	Стратегия блокирования, используемая для блокирования файлов. Если этот параметр не задан, используйте стратегию `auto` .	No
file_id	string	Идентификатор файла, который должен использовать хранилище векторов. Полезно для таких средств, как `file_search` доступ к файлам.	Yes

Responses

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

Description: OK

Content-Type	Type	Description
application/json	vectorStoreFileObject

Examples

Example

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

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-01-preview

{
 "file_id": "file-abc123"
}

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

{
  "body": {
    "id": "file-abc123",
    "object": "vector_store.file",
    "created_at": 1699061776,
    "usage_bytes": 1234,
    "vector_store_id": "vs_abcd",
    "status": "completed",
    "last_error": null
  }
}

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

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: `https://aoairesource.openai.azure.com` Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
vector_store_id	path	Yes	string	Идентификатор векторного хранилища, к которому принадлежит файл.
file_id	path	Yes	string	Идентификатор извлекаемого файла.
api-version	query	Yes	string	api version

Request Header

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

Responses

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

Description: OK

Content-Type	Type	Description
application/json	vectorStoreFileObject

Examples

Example

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

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

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

{
  "body": {
    "id": "file-abc123",
    "object": "vector_store.file",
    "created_at": 1699061776,
    "vector_store_id": "vs_abcd",
    "status": "completed",
    "last_error": null
  }
}

Delete — векторный файл хранилища

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: `https://aoairesource.openai.azure.com` Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
vector_store_id	path	Yes	string	Идентификатор векторного хранилища, к которому принадлежит файл.
file_id	path	Yes	string	Идентификатор удаленного файла.
api-version	query	Yes	string	api version

Request Header

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

Responses

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

Description: OK

Content-Type	Type	Description
application/json	deleteVectorStoreFileResponse

Examples

Example

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

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

{
  "body": {
    "id": "file_abc123",
    "object": "vector_store.file.deleted",
    "deleted": true
  }
}

Updatevectorstorefileattributes

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: `https://aoairesource.openai.azure.com` Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
vector_store_id	path	Yes	string	Идентификатор векторного хранилища, к которому принадлежит файл.
file_id	path	Yes	string	Идентификатор файла для обновления атрибутов.

Request Header

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

Request Body

Content-Type: application/json

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

Responses

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

Description: OK

Content-Type	Type	Description
application/json	vectorStoreFileObject

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

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}/content?api-version=2025-04-01-preview

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: `https://aoairesource.openai.azure.com` Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
vector_store_id	path	Yes	string	Идентификатор хранилища векторов.
file_id	path	Yes	string	Идентификатор файла в хранилище векторов.

Request Header

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

Responses

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

Description: OK

Content-Type	Type	Description
application/json	VectorStoreFileContentResponse

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

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/search?api-version=2025-04-01-preview

Поиск векторного хранилища соответствующих блоков на основе фильтра атрибутов запроса и файла.

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: `https://aoairesource.openai.azure.com` Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
vector_store_id	path	Yes	string	Идентификатор хранилища векторов для поиска.

Request Header

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

Request Body

Content-Type: application/json

Name	Type	Description	Required	Default
filters	ComparisonFilter или CompoundFilter	Фильтр для применения на основе атрибутов файла.	No
max_num_results	integer	Максимальное количество возвращаемых результатов. Это число должно быть от 1 до 50 включительно.	No	10
query	строка или массив	Строка запроса для поиска	Yes
ranking_options	object	Параметры ранжирования для поиска.	No
└─ ranker	enum	Возможные значения: `auto`, `default-2024-11-15`	No
└─ score_threshold	number		No	0
rewrite_query	boolean	Следует ли переписать запрос естественного языка для векторного поиска.	No	False

Responses

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

Description: OK

Content-Type	Type	Description
application/json	VectorStoreSearchResultsPage

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

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches?api-version=2025-04-01-preview

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: `https://aoairesource.openai.azure.com` Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
vector_store_id	path	Yes	string	Идентификатор векторного хранилища, для которого создается пакетная служба файлов.
api-version	query	Yes	string	api version

Request Header

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

Request Body

Content-Type: application/json

Name	Type	Description	Required	Default
chunking_strategy	chunkingStrategyRequestParam	Стратегия блокирования, используемая для блокирования файлов. Если этот параметр не задан, используйте стратегию `auto` .	No
file_ids	array	Список идентификаторов файлов, которые следует использовать векторном хранилище. Полезно для таких средств, как `file_search` доступ к файлам.	Yes

Responses

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

Description: OK

Content-Type	Type	Description
application/json	vectorStoreFileBatchObject

Examples

Example

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

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches?api-version=2025-04-01-preview

{
 "file_ids": [
  "file-abc123",
  "file-abc456"
 ]
}

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

{
  "id": "vsfb_abc123",
  "object": "vector_store.file_batch",
  "created_at": 1699061776,
  "vector_store_id": "vs_abc123",
  "status": "in_progress",
  "file_counts": {
    "in_progress": 1,
    "completed": 1,
    "failed": 0,
    "cancelled": 0,
    "total": 0
  }
}

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

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}?api-version=2025-04-01-preview

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: `https://aoairesource.openai.azure.com` Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
vector_store_id	path	Yes	string	Идентификатор хранилища векторов, к которому принадлежит пакет файла.
batch_id	path	Yes	string	Идентификатор извлекаемого пакета файлов.
api-version	query	Yes	string	api version

Request Header

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

Responses

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

Description: OK

Content-Type	Type	Description
application/json	vectorStoreFileBatchObject

Examples

Example

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

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}?api-version=2025-04-01-preview

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

{
  "body": {
    "id": "vsfb_abc123",
    "object": "vector_store.file_batch",
    "created_at": 1699061776,
    "vector_store_id": "vs_abc123",
    "status": "in_progress",
    "file_counts": {
      "in_progress": 1,
      "completed": 1,
      "failed": 0,
      "cancelled": 0,
      "total": 0
    }
  }
}

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

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel?api-version=2025-04-01-preview

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: `https://aoairesource.openai.azure.com` Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
vector_store_id	path	Yes	string	Идентификатор хранилища векторов, к которому принадлежит пакет файла.
batch_id	path	Yes	string	Идентификатор пакета файла для отмены.
api-version	query	Yes	string	api version

Request Header

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

Responses

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

Description: OK

Content-Type	Type	Description
application/json	vectorStoreFileBatchObject

Examples

Example

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel?api-version=2025-04-01-preview

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

{
  "body": {
    "id": "vsfb_abc123",
    "object": "vector_store.file_batch",
    "created_at": 1699061776,
    "vector_store_id": "vs_abc123",
    "status": "cancelling",
    "file_counts": {
      "in_progress": 12,
      "completed": 3,
      "failed": 0,
      "cancelled": 0,
      "total": 15
    }
  }
}

Список — пакетные файлы векторного хранилища

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/files?api-version=2025-04-01-preview

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: `https://aoairesource.openai.azure.com` Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
vector_store_id	path	Yes	string	Идентификатор хранилища векторов, к которому принадлежат файлы.
batch_id	path	Yes	string	Идентификатор пакета файлов, к которому принадлежат файлы.
limit	query	No	integer	Ограничение количества возвращаемых объектов. Ограничение может быть от 1 до 100, а значение по умолчанию — 20.
order	query	No	string Возможные значения: `asc`, `desc`	Сортировка `created_at` по метке времени объектов. `asc` для возрастания порядка и `desc` для убывания.
after	query	No	string	Курсор для использования в разбиении на страницы. `after` — это идентификатор объекта, определяющий место в списке. Например, если вы делаете запрос списка и получаете 100 объектов, заканчивая obj_foo, последующий вызов может включать after=obj_foo, чтобы получить следующую страницу списка.
before	query	No	string	Курсор для использования в разбиении на страницы. `before` — это идентификатор объекта, определяющий место в списке. Например, если вы делаете запрос списка и получаете 100 объектов, начиная с obj_foo, последующий вызов может включать до=obj_foo, чтобы получить предыдущую страницу списка.
filter	query	No	string Возможные значения: `in_progress`, , `completedfailedcancelled`	Фильтрация по состоянию файла. Один из `in_progress`, , `completedfailed`, `cancelled`.
api-version	query	Yes	string	api version

Request Header

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

Responses

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

Description: OK

Content-Type	Type	Description
application/json	listVectorStoreFilesResponse

Examples

Example

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

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/files?api-version=2025-04-01-preview

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

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "file-abc123",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      },
      {
        "id": "file-abc456",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      }
    ],
    "first_id": "file-abc123",
    "last_id": "file-abc456",
    "has_more": false
  }
}

Создание — Realtimesession

POST https://{endpoint}/openai/realtimeapi/sessions?api-version=2025-04-01-preview

Создайте временный маркер API для использования в клиентских приложениях с API Realtime. Можно настроить с теми же параметрами сеанса session.update , что и событие клиента. Он отвечает с объектом сеанса, а также client_secret ключом, который содержит эфемерный маркер API, который можно использовать для проверки подлинности клиентов браузера для API Реального времени.

Request Body

Content-Type: application/json

Name	Type	Description	Required	Default
input_audio_format	enum	Формат входного звука. Параметры: `pcm16`, `g711_ulaw`или `g711_alaw`. Для `pcm16`, входной звук должен быть 16-разрядным PCM с частотой выборки 24 кбГц, одним каналом (моно) и байтовой последовательности байтов. Возможные значения: `pcm16`, `g711_ulawg711_alaw`	No
input_audio_noise_reduction	object	Настройка для уменьшения шума входного звука. Это можно установить, чтобы `null` отключить. Уменьшение шума фильтрует звук, добавленный в входной звуковой буфер перед отправкой в VAD и модель. Фильтрация звука может повысить точность обнаружения VAD и поворота (уменьшая ложные срабатывания) и производительность модели, повышая восприятие входного звука.	No
└─ type	enum	Тип уменьшения шума. `near_field` предназначен для микрофонов близкого разговора, таких как наушники, `far_field` предназначен для микрофонов с дальним полем, таких как ноутбук или микрофоны конференц-зала. Возможные значения: `near_field`, `far_field`	No
input_audio_transcription	object	Настройка входного транскрибирования звука, значение по умолчанию отключено и может быть задано, чтобы `null` отключить один раз. Транскрибирование входного звука не является собственным для модели, так как модель использует звук напрямую. Транскрибирование выполняется асинхронно через конечную точку транскрибирования и должно рассматриваться как руководство по входным звуковым содержимым, а не точно то, что слышала модель. Клиент может при необходимости задать язык и запрашивать транскрибирование, они предлагают дополнительные рекомендации для службы транскрибирования.	No
└─ language	string	Язык входного звука. Предоставление языка ввода в формате ISO-639-1 (например `en`, ) повышает точность и задержку.	No
└─ model	string	Модель, используемая для транскрибирования, текущие параметры: `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, `gpt-4o-mini-transcribe`и `gpt-4o-mini-transcribe-2025-12-15whisper-1`.	No
└─ prompt	string	Необязательный текст для руководства стилем модели или продолжением предыдущего сегмента звука. Для `whisper-1`этого запрос — это список ключевых слов. Для `gpt-4o-transcribe` моделей запрос — это бесплатная текстовая строка, например "ожидает слов, связанных с технологией".	No
instructions	string	Системные инструкции по умолчанию (т. е. системное сообщение) предопределены для вызовов модели. Это поле позволяет клиенту управлять моделью по нужным ответам. Модель может быть указана по содержимому ответа и формату (например, "быть чрезвычайно кратким", "действовать понятно", "вот примеры хороших ответов") и на звуковом поведении (например, "говорить быстро", "вводить эмоции в ваш голос", "смеяться часто"). Инструкции не гарантируются моделью, но они предоставляют рекомендации модели по требуемому поведению. Обратите внимание, что сервер задает инструкции по умолчанию, которые будут использоваться, если это поле не задано и отображается в событии в `session.created` начале сеанса.	No
max_response_output_tokens	целое число или строка	Максимальное количество выходных маркеров для одного ответа помощника, включающее вызовы инструментов. Укажите целое число от 1 до 4096, чтобы ограничить выходные маркеры или `inf` максимальные доступные маркеры для данной модели. По умолчанию используется `inf`значение .	No
modalities		Набор модальностей, с которыми может реагировать модель. Чтобы отключить звук, установите для этого значение ["text"].	No
model	string	Имя развертывания, используемого для этого сеанса.	No
output_audio_format	enum	Формат выходного звука. Параметры: `pcm16`, `g711_ulaw`или `g711_alaw`. Для `pcm16`выходных звуковых данных выборка составляет 24 кбГц. Возможные значения: `pcm16`, `g711_ulawg711_alaw`	No
temperature	number	Температура выборки для модели ограничена [0.6, 1.2]. Для звуковых моделей температура 0,8 настоятельно рекомендуется для оптимальной производительности.	No	0.8
tool_choice	string	Как модель выбирает инструменты. Параметры: `auto`, `nonerequired`или укажите функцию.	No	auto
tools	array	Средства (функции), доступные для модели.	No
turn_detection	object	Конфигурация для обнаружения поворота, VAD или семантического VAD сервера эфира. Это можно задать для `null` отключения, в этом случае клиент должен вручную активировать ответ модели. VaD сервера означает, что модель будет обнаруживать начало и конец речи на основе звукового тома и реагировать на речь пользователя. Семантическая vaD более расширена и использует модель обнаружения поворота (в сочетании с VAD) для семантической оценки того, закончил ли пользователь говорить, а затем динамически задает время ожидания на основе этой вероятности. Например, если пользователь отключает аудиозапись, `uhhm`модель будет оценить низкую вероятность завершения и ждать больше времени, пока пользователь продолжит говорить. Это может быть полезно для более естественных бесед, но может иметь более высокую задержку.	No
└─ create_response	boolean	Следует ли автоматически создавать ответ при возникновении события остановки VAD.	No	True
└─ eagerness	enum	Используется только для `semantic_vad` режима. Стремление модели реагировать. `low` будет ждать, пока пользователь продолжит говорить, `high` будет реагировать быстрее. `auto` значение по умолчанию и эквивалентно `medium`. Возможные значения: `low`, , `mediumhighauto`	No
└─ interrupt_response	boolean	Следует ли автоматически прерывать любой текущий ответ с выходными данными беседы по умолчанию (т. е. `conversationauto`при возникновении события запуска VAD).	No	True
└─ prefix_padding_ms	integer	Используется только для `server_vad` режима. Объем звука, который требуется включить до обнаруженной речи VAD (в миллисекундах). Значение по умолчанию — 300 мс.	No
└─ silence_duration_ms	integer	Используется только для `server_vad` режима. Длительность молчания для обнаружения остановки речи (в миллисекундах). Значение по умолчанию — 500 мс. С более короткими значениями модель будет реагировать быстрее, но может переходить на короткие паузы от пользователя.	No
└─ threshold	number	Используется только для `server_vad` режима. Порог активации для VAD (0.0 до 1.0), по умолчанию используется значение 0.5. Для активации модели требуется более высокий пороговый уровень звука и, таким образом, может улучшиться в шумных средах.	No
└─ type	enum	Тип обнаружения поворота. Возможные значения: `server_vad`, `semantic_vad`	No
voice	VoiceIdsShared		No

Responses

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

Описание: сеанс успешно создан.

Content-Type	Type	Description
application/json	RealtimeSessionCreateResponse

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

POST https://{endpoint}/openai/realtimeapi/transcription_sessions?api-version=2025-04-01-preview

Создайте эфемерный маркер API для использования в клиентских приложениях с API Реального времени специально для транскрибирования в режиме реального времени. Можно настроить с теми же параметрами сеанса transcription_session.update , что и событие клиента. Он отвечает с объектом сеанса, а также client_secret ключом, который содержит эфемерный маркер API, который можно использовать для проверки подлинности клиентов браузера для API Реального времени.

Request Body

Content-Type: application/json

Name	Type	Description	Required	Default
include	array	Набор элементов для включения в транскрибирование. Текущие доступные элементы: - `item.input_audio_transcription.logprobs`	No
input_audio_format	enum	Формат входного звука. Параметры: `pcm16`, `g711_ulaw`или `g711_alaw`. Для `pcm16`, входной звук должен быть 16-разрядным PCM с частотой выборки 24 кбГц, одним каналом (моно) и байтовой последовательности байтов. Возможные значения: `pcm16`, `g711_ulawg711_alaw`	No
input_audio_noise_reduction	object	Настройка для уменьшения шума входного звука. Это можно установить, чтобы `null` отключить. Уменьшение шума фильтрует звук, добавленный в входной звуковой буфер перед отправкой в VAD и модель. Фильтрация звука может повысить точность обнаружения VAD и поворота (уменьшая ложные срабатывания) и производительность модели, повышая восприятие входного звука.	No
└─ type	enum	Тип уменьшения шума. `near_field` предназначен для микрофонов близкого разговора, таких как наушники, `far_field` предназначен для микрофонов с дальним полем, таких как ноутбук или микрофоны конференц-зала. Возможные значения: `near_field`, `far_field`	No
input_audio_transcription	object	Конфигурация входного транскрибирования звука. Клиент может при необходимости задать язык и запрашивать транскрибирование, они предлагают дополнительные рекомендации для службы транскрибирования.	No
└─ language	string	Язык входного звука. Предоставление языка ввода в формате ISO-639-1 (например `en`, ) повышает точность и задержку.	No
└─ model	enum	Модель, используемая для транскрибирования, текущие параметры: `gpt-4o-transcribe`, `gpt-4o-mini-transcribegpt-4o-mini-transcribe-2025-12-15`и `whisper-1`. Возможные значения: `gpt-4o-transcribe`, , `gpt-4o-mini-transcribegpt-4o-mini-transcribe-2025-12-15whisper-1`	No
└─ prompt	string	Необязательный текст для руководства стилем модели или продолжением предыдущего сегмента звука. Для `whisper-1`этого запрос — это список ключевых слов. Для `gpt-4o-transcribe` моделей запрос — это бесплатная текстовая строка, например "ожидает слов, связанных с технологией".	No
modalities		Набор модальностей, с которыми может реагировать модель. Чтобы отключить звук, установите для этого значение ["text"].	No
turn_detection	object	Конфигурация для обнаружения поворота, VAD или семантического VAD сервера эфира. Это можно задать для `null` отключения, в этом случае клиент должен вручную активировать ответ модели. VaD сервера означает, что модель будет обнаруживать начало и конец речи на основе звукового тома и реагировать на речь пользователя. Семантическая vaD более расширена и использует модель обнаружения поворота (в сочетании с VAD) для семантической оценки того, закончил ли пользователь говорить, а затем динамически задает время ожидания на основе этой вероятности. Например, если пользователь отключает аудиозапись, `uhhm`модель будет оценить низкую вероятность завершения и ждать больше времени, пока пользователь продолжит говорить. Это может быть полезно для более естественных бесед, но может иметь более высокую задержку.	No
└─ create_response	boolean	Следует ли автоматически создавать ответ при возникновении события остановки VAD. Недоступно для сеансов транскрибирования.	No	True
└─ eagerness	enum	Используется только для `semantic_vad` режима. Стремление модели реагировать. `low` будет ждать, пока пользователь продолжит говорить, `high` будет реагировать быстрее. `auto` значение по умолчанию и эквивалентно `medium`. Возможные значения: `low`, , `mediumhighauto`	No
└─ interrupt_response	boolean	Следует ли автоматически прерывать любой текущий ответ с выходными данными беседы по умолчанию (т. е. `conversationauto`при возникновении события запуска VAD). Недоступно для сеансов транскрибирования.	No	True
└─ prefix_padding_ms	integer	Используется только для `server_vad` режима. Объем звука, который требуется включить до обнаруженной речи VAD (в миллисекундах). Значение по умолчанию — 300 мс.	No
└─ silence_duration_ms	integer	Используется только для `server_vad` режима. Длительность молчания для обнаружения остановки речи (в миллисекундах). Значение по умолчанию — 500 мс. С более короткими значениями модель будет реагировать быстрее, но может переходить на короткие паузы от пользователя.	No
└─ threshold	number	Используется только для `server_vad` режима. Порог активации для VAD (0.0 до 1.0), по умолчанию используется значение 0.5. Для активации модели требуется более высокий пороговый уровень звука и, таким образом, может улучшиться в шумных средах.	No
└─ type	enum	Тип обнаружения поворота. Возможные значения: `server_vad`, `semantic_vad`	No

Responses

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

Описание: сеанс успешно создан.

Content-Type	Type	Description
application/json	RealtimeTranscriptionSessionCreateResponse

Responses

POST https://{endpoint}/openai/responses?api-version=2025-04-01-preview

Создает ответ модели.

Request Body

Content-Type: application/json

Name	Type	Description	Required	Default
include	array		No
input	строка или массив	Model inputs	Yes
instructions	string	Вставляет сообщение системы (или разработчика) в качестве первого элемента в контексте модели. При использовании вместе с `previous_response_id`этим инструкции из предыдущего ответа не будут перенесены в следующий ответ. Это упрощает переключение системных сообщений (или разработчиков) в новых ответах.	No
max_output_tokens	integer	Верхняя граница для числа маркеров, которые можно создать для ответа, включая видимые выходные маркеры и состояние беседы.	No
parallel_tool_calls	boolean	Следует ли разрешить модели запускать вызовы инструментов параллельно.	No	True
previous_response_id	string	Уникальный идентификатор предыдущего ответа на модель. Используйте эту функцию для создания многоэтапных бесед. Дополнительные сведения о состоянии беседы.	No
reasoning	Reasoning	Параметры конфигурации для моделей причин.	No
store	boolean	Следует ли хранить созданный ответ модели для последующего получения через API.	No	True
stream	boolean	Если задано значение true, данные ответа модели будут передаваться клиенту по мере его создания с помощью событий, отправляемых сервером. Дополнительные сведения см. в разделе "Потоковая передача" ниже.	No	False
text	object	Параметры конфигурации для текстового ответа модели. Можно использовать обычный текст или структурированные данные JSON. Learn more: — текстовые входные и выходные данные — структурированные выходные данные	No
└─ format	TextResponseFormatConfiguration	Объект, указывающий формат, который должен выводить модель. Настройка `{ "type": "json_schema" }` включает структурированные выходные данные, что гарантирует соответствие модели предоставленной схеме JSON. Формат по умолчанию не имеет `{ "type": "text" }` дополнительных параметров. Не рекомендуется использовать для gpt-4o и более новых моделей: Параметр для `{ "type": "json_object" }` включения более старого режима JSON, который гарантирует, что сообщение, которое создает модель, является допустимым JSON. Использование `json_schema` предпочтительнее для моделей, поддерживающих его.	No
tool_choice	ToolChoiceOptions или ToolChoiceTypes или ToolChoiceFunction	Как модель должна выбрать средство (или инструменты), которое следует использовать при создании ответа. Просмотрите `tools` параметр, чтобы узнать, как указать, какие средства модель может вызывать.	No
tools	array	Массив инструментов, которые модель может вызывать при создании ответа. Можно указать, какое средство следует использовать, задав `tool_choice` параметр. Ниже приведены две категории инструментов, которые можно предоставить модели: - Встроенные средства: средства, предоставляемые OpenAI, расширяющие model's capabilities	No
truncation	enum	Стратегия усечения, используемая для ответа модели. - `auto`: если контекст этого ответа и предыдущих превышает размер окна контекста модели, модель усетит ответ для соответствия окну контекстного окна путем удаления входных элементов в середине беседы. - `disabled` (по умолчанию): если ответ модели превысит размер окна контекста для модели, запрос завершится ошибкой 400. Возможные значения: `auto`, `disabled`	No

Responses

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

Description: OK

Content-Type	Type	Description
application/json	response
text/event-stream	responseStreamEvent

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

Описание: служба недоступна

Content-Type	Type	Description
application/json	errorResponse

API ответов — входные элементы

GET https://{endpoint}/openai/responses/{response_id}?api-version=2025-04-01-preview

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: `https://aoairesource.openai.azure.com` Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
response_id	path	Yes	string	Идентификатор полученного ответа.
include	query	No	array	Дополнительные поля для включения в ответ. Дополнительные сведения см. в параметре `include` создания ответа выше.

Request Header

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

Responses

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

Description: OK

Content-Type	Type	Description
application/json	response

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

Описание: служба недоступна

Content-Type	Type	Description
application/json	errorResponse

Delete response

DELETE https://{endpoint}/openai/responses/{response_id}?api-version=2025-04-01-preview

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: `https://aoairesource.openai.azure.com` Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
response_id	path	Yes	string	Идентификатор удаленного ответа.

Request Header

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

Responses

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

Description: OK

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

Описание: не найдено

Content-Type	Type	Description
application/json	error

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

Описание: служба недоступна

Content-Type	Type	Description
application/json	errorResponse

API ответов — список элементов ответа

GET https://{endpoint}/openai/responses/{response_id}/input_items?api-version=2025-04-01-preview

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: `https://aoairesource.openai.azure.com` Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
response_id	path	Yes	string	Идентификатор ответа для получения входных элементов.
limit	query	No	integer	Ограничение количества возвращаемых объектов. Ограничение может быть от 1 до 100, а значение по умолчанию — 20.
order	query	No	string Возможные значения: `asc`, `desc`	Порядок возврата входных элементов в. `asc`Значение по умолчанию — . - `asc`: возвращает входные элементы в порядке возрастания. - `desc`: возвращает входные элементы в порядке убывания.
after	query	No	string	Идентификатор элемента для перечисления элементов после, используемый в разбиении на страницы.
before	query	No	string	Идентификатор элемента для перечисления элементов, используемых в разбиении на страницы.

Request Header

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

Responses

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

Description: OK

Content-Type	Type	Description
application/json	responseItemList

Components

errorResponse

Name	Type	Description	Required	Default
error	error		No

errorBase

Name	Type	Description	Required	Default
code	string		No
message	string		No

error

Name	Type	Description	Required
inner_error	innerError	Внутренняя ошибка с дополнительными сведениями.	No
param	string		No
type	string		No

innerError

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

Name	Type	Description	Required	Default
code	innerErrorCode	Коды ошибок для внутреннего объекта ошибки.	No
content_filter_results	contentFilterPromptResults	Сведения о категории фильтрации содержимого (ненавидимая, сексуальность, насилие, self_harm), если она обнаружена, а также уровень серьезности (very_low, низкий, средний, высокомасштабируемый, определяющий интенсивность и уровень риска вредного содержимого) и если он был отфильтрован или нет. Сведения о содержимом и ненормативной лексике, если он обнаружен, и если он был отфильтрован или нет. И сведения о списке блокировок клиента, если он был отфильтрован и его идентификатор.	No

innerErrorCode

Коды ошибок для внутреннего объекта ошибки.

Property	Value
Description	Коды ошибок для внутреннего объекта ошибки.
Type	string
Values	`ResponsibleAIPolicyViolation`

dalleErrorResponse

Name	Type	Description	Required	Default
error	dalleError		No

dalleError

Name	Type	Description	Required
inner_error	dalleInnerError	Внутренняя ошибка с дополнительными сведениями.	No
param	string		No
type	string		No

dalleInnerError

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

Name	Type	Description	Required
code	innerErrorCode	Коды ошибок для внутреннего объекта ошибки.	No
content_filter_results	dalleFilterResults	Сведения о категории фильтрации содержимого (ненавидимая, сексуальность, насилие, self_harm), если она обнаружена, а также уровень серьезности (very_low, низкий, средний, высокомасштабируемый, определяющий интенсивность и уровень риска вредного содержимого) и если он был отфильтрован или нет. Сведения о содержимом и ненормативной лексике, если он обнаружен, и если он был отфильтрован или нет. И сведения о списке блокировок клиента, если он был отфильтрован и его идентификатор.	No
revised_prompt	string	Запрос, который использовался для создания образа, если в запросе была любая редакция.	No

contentFilterCompletionTextSpan

Описывает диапазон в созданном тексте завершения. Смещение 0 является первой точкой кода UTF32 текста завершения.

Name	Type	Description	Required	Default
completion_end_offset	integer	Смещение первой точки кода UTF32, которая исключается из диапазона. Это поле всегда равно completion_start_offset для пустых диапазонов. Это поле всегда больше completion_start_offset для непустых диапазонов.	Yes
completion_start_offset	integer	Смещение точки кода UTF32, которая начинает диапазон.	Yes

contentFilterResultBase

Name	Type	Description	Required	Default
filtered	boolean		Yes

contentFilterSeverityResult

Name	Type	Description	Required	Default
filtered	boolean		Yes
severity	string		No

contentFilterDetectedResult

Name	Type	Description	Required	Default
detected	boolean		No
filtered	boolean		Yes

contentFilterDetectedWithCitationResult

Name	Type	Required
citation	object	No
└─ URL	string	No
└─ license	string	No

contentFilterDetectedWithCompletionTextSpansResult

Name	Type	Description	Required	Default
details	array		No

contentFilterIdResult

Name	Type	Description	Required	Default
filtered	boolean		Yes
id	string		No

contentFilterResultsBase

Сведения о результатах фильтрации содержимого.

Name	Type	Description	Required
custom_blocklists	contentFilterDetailedResults	Результаты фильтрации содержимого с подробными сведениями о идентификаторах фильтра содержимого для отфильтрованных сегментов.	No
error	errorBase		No
hate	contentFilterSeverityResult		No
profanity	contentFilterDetectedResult		No
self_harm	contentFilterSeverityResult		No
sexual	contentFilterSeverityResult		No
violence	contentFilterSeverityResult		No

contentFilterPromptResults

Сведения о категории фильтрации содержимого (ненавидимая, сексуальность, насилие, self_harm), если она обнаружена, а также уровень серьезности (very_low, низкий, средний, высокомасштабируемый, определяющий интенсивность и уровень риска вредного содержимого) и если он был отфильтрован или нет. Сведения о содержимом и ненормативной лексике, если он обнаружен, и если он был отфильтрован или нет. И сведения о списке блокировок клиента, если он был отфильтрован и его идентификатор.

Name	Type	Description	Required
custom_blocklists	contentFilterDetailedResults	Результаты фильтрации содержимого с подробными сведениями о идентификаторах фильтра содержимого для отфильтрованных сегментов.	No
error	errorBase		No
hate	contentFilterSeverityResult		No
indirect_attack	contentFilterDetectedResult		No
jailbreak	contentFilterDetectedResult		No
profanity	contentFilterDetectedResult		No
self_harm	contentFilterSeverityResult		No
sexual	contentFilterSeverityResult		No
violence	contentFilterSeverityResult		No

contentFilterChoiceResults

Сведения о категории фильтрации содержимого (ненавидимая, сексуальность, насилие, self_harm), если она обнаружена, а также уровень серьезности (very_low, низкий, средний, высокомасштабируемый, определяющий интенсивность и уровень риска вредного содержимого) и если он был отфильтрован или нет. Сведения о стороннем тексте и ненормативной лексике, если он обнаружен, и если он был отфильтрован или нет. И сведения о списке блокировок клиента, если он был отфильтрован и его идентификатор.

Name	Type	Description	Required
custom_blocklists	contentFilterDetailedResults	Результаты фильтрации содержимого с подробными сведениями о идентификаторах фильтра содержимого для отфильтрованных сегментов.	No
error	errorBase		No
hate	contentFilterSeverityResult		No
profanity	contentFilterDetectedResult		No
protected_material_code	contentFilterDetectedWithCitationResult		No
protected_material_text	contentFilterDetectedResult		No
self_harm	contentFilterSeverityResult		No
sexual	contentFilterSeverityResult		No
ungrounded_material	contentFilterDetectedWithCompletionTextSpansResult		No
violence	contentFilterSeverityResult		No

contentFilterDetailedResults

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

Name	Type	Description	Required	Default
details	array		No
filtered	boolean		Yes

promptFilterResult

Результаты фильтрации содержимого для одного запроса.

Name	Type	Description	Required	Default
content_filter_results	contentFilterPromptResults	Сведения о категории фильтрации содержимого (ненавидимая, сексуальность, насилие, self_harm), если она обнаружена, а также уровень серьезности (very_low, низкий, средний, высокомасштабируемый, определяющий интенсивность и уровень риска вредного содержимого) и если он был отфильтрован или нет. Сведения о содержимом и ненормативной лексике, если он обнаружен, и если он был отфильтрован или нет. И сведения о списке блокировок клиента, если он был отфильтрован и его идентификатор.	No
prompt_index	integer		No

promptFilterResults

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

Для этого компонента не определены свойства.

dalleContentFilterResults

Сведения о результатах фильтрации содержимого.

Name	Type	Required
hate	contentFilterSeverityResult	No
self_harm	contentFilterSeverityResult	No
sexual	contentFilterSeverityResult	No
violence	contentFilterSeverityResult	No

dalleFilterResults

Name	Type	Description	Required
custom_blocklists	contentFilterDetailedResults	Результаты фильтрации содержимого с подробными сведениями о идентификаторах фильтра содержимого для отфильтрованных сегментов.	No
hate	contentFilterSeverityResult		No
jailbreak	contentFilterDetectedResult		No
profanity	contentFilterDetectedResult		No
self_harm	contentFilterSeverityResult		No
sexual	contentFilterSeverityResult		No
violence	contentFilterSeverityResult		No

chatCompletionsRequestCommon

Name	Type	Description	Required	Default
frequency_penalty	number	Число от -2.0 до 2.0. Положительные значения наказывают новые маркеры на основе их существующей частоты в тексте до сих пор, уменьшая вероятность повторения той же строки.	No	0
logit_bias	object	Измените вероятность появления указанных маркеров в завершении. Принимает объект JSON, который сопоставляет маркеры (указанные идентификатором маркера в токенизаторе) с соответствующим значением предвзятости от -100 до 100. Математически предвзятость добавляется в логиты, созданные моделью до выборки. Точный эффект зависит от модели, но значения между -1 и 1 должны уменьшаться или увеличивать вероятность выбора; такие значения, как -100 или 100, должны привести к запрету или эксклюзивному выбору соответствующего маркера.	No
max_completion_tokens	integer	Верхняя граница для числа маркеров, которые можно создать для завершения, включая видимые выходные маркеры и маркеры причин.	No
max_tokens	integer	Максимальное количество маркеров, разрешенных для созданного ответа. По умолчанию число маркеров, возвращаемых моделью, будет (4096 — маркеры запроса). Это несовместимо с моделями серии o1.	No	4096
metadata	object	Определяемые разработчиком теги и значения, используемые для фильтрации завершений на панели мониторинга хранимых завершений.	No
presence_penalty	number	Число от -2.0 до 2.0. Положительные значения наказывают новые маркеры на основе того, отображаются ли они в тексте до сих пор, увеличив вероятность того, что модель будет говорить о новых темах.	No	0
stop	строка или массив	До 4 последовательностей, в которых API перестает создавать дополнительные маркеры.	No
store	boolean	Независимо от того, следует ли хранить выходные данные этого запроса на завершение чата для использования в наших продуктах для дистилляции или оценки модели.	No
stream	boolean	Если задано, разностные сообщения отправляются, например в ChatGPT. Маркеры отправляются как события, отправляемые сервером только для данных по мере их доступности, при этом поток завершается сообщением `data: [DONE]` .	No	False
temperature	number	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным. Как правило, мы рекомендуем изменить это или `top_p` не оба.	No	1
top_p	number	Альтернатива выборке с температурой, называемой выборкой ядра, где модель рассматривает результаты маркеров с top_p массой вероятности. Таким образом, 0,1 означает, что рассматриваются только маркеры, состоящие из 10 лучших% массы вероятностей. Как правило, мы рекомендуем изменить это или `temperature` не оба.	No	1
user	string	Уникальный идентификатор, представляющий пользователя, который может помочь Azure OpenAI отслеживать и обнаруживать злоупотребления.	No

createCompletionRequest

Name	Type	Description	Required	Default
best_of	integer	`best_of` Создает завершения на стороне сервера и возвращает "лучший" (один с наибольшей вероятностью журнала на токен). Результаты не могут быть потоковые. При использовании с `n`параметром `best_of` определяет количество завершений кандидатов и `n` указывает, сколько нужно возвращать. `best_of` должно быть больше `n`. Примечание: Так как этот параметр создает множество завершений, он может быстро использовать квоту маркера. Используйте тщательно и убедитесь, что у вас есть разумные параметры для `max_tokens` и `stop`.	No	1
echo	boolean	Обратная обратная копия запроса в дополнение к завершению	No	False
frequency_penalty	number	Число от -2.0 до 2.0. Положительные значения наказывают новые маркеры на основе их существующей частоты в тексте до сих пор, уменьшая вероятность повторения той же строки.	No	0
logit_bias	object	Измените вероятность появления указанных маркеров в завершении. Принимает объект JSON, который сопоставляет маркеры (указанные идентификатором маркера в маркеризаторе GPT) с соответствующим значением предвзятости от -100 до 100. Математически предвзятость добавляется в логиты, созданные моделью до выборки. Точный эффект зависит от модели, но значения между -1 и 1 должны уменьшаться или увеличивать вероятность выбора; такие значения, как -100 или 100, должны привести к запрету или эксклюзивному выбору соответствующего маркера. Например, можно передать `{"50256": -100}` маркер \|endoftext\|< для предотвращения >создания маркера \|endoftext.	No	None
logprobs	integer	Включите вероятности журнала в `logprobs` наиболее вероятные выходные маркеры, а также выбранные маркеры. Например, если `logprobs` значение равно 5, API вернет список из 5 наиболее вероятных маркеров. API всегда возвращает `logprob` пример маркера, поэтому в ответе может быть до `logprobs+1` элементов. Максимальное значение `logprobs` для 5.	No	None
max_tokens	integer	Максимальное количество маркеров может быть создано в завершении. Количество маркеров запроса плюс `max_tokens` не может превышать длину контекста модели.	No	16
n	integer	Сколько завершений для каждого запроса. Примечание: Так как этот параметр создает множество завершений, он может быстро использовать квоту маркера. Используйте тщательно и убедитесь, что у вас есть разумные параметры для `max_tokens` и `stop`.	No	1
presence_penalty	number	Число от -2.0 до 2.0. Положительные значения наказывают новые маркеры на основе того, отображаются ли они в тексте до сих пор, увеличив вероятность того, что модель будет говорить о новых темах.	No	0
prompt	строка или массив	Запросы для создания завершений, закодированных в виде строки, массива строк, массива маркеров или массива массивов маркеров. Обратите внимание, что <\|endoftext\|> — это разделитель документов, который модель видит во время обучения, поэтому если запрос не указан, модель будет создаваться как будто с начала нового документа.	Yes
seed	integer	Если задано, наша система делает все возможное для выборки детерминированного, таким образом, что повторяющиеся запросы с одинаковыми и параметрами должны возвращать тот же `seed` результат. Детерминированность не гарантируется, и вы должны ссылаться на `system_fingerprint` параметр ответа для отслеживания изменений в серверной части.	No
stop	строка или массив	До 4 последовательностей, в которых API перестает создавать дополнительные маркеры. Возвращенный текст не будет содержать последовательность остановки.	No
stream	boolean	Выполняется ли потоковая передача частичного хода выполнения. Если задано, маркеры отправляются как события, отправляемые сервером только для данных по мере их доступности, при этом поток завершается сообщением `data: [DONE]` . Пример кода Python.	No	False
suffix	string	Суффикс, который приходит после завершения вставленного текста. Этот параметр поддерживается только для `gpt-3.5-turbo-instruct`.	No	None
temperature	number	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным. Как правило, мы рекомендуем изменить это или `top_p` не оба.	No	1
top_p	number	Альтернатива выборке с температурой, называемой выборкой ядра, где модель рассматривает результаты маркеров с top_p массой вероятности. Таким образом, 0,1 означает, что рассматриваются только маркеры, состоящие из 10 лучших% массы вероятностей. Как правило, мы рекомендуем изменить это или `temperature` не оба.	No	1
user	string	Уникальный идентификатор, представляющий конечного пользователя, который может помочь в мониторинге и обнаружении злоупотреблений.	No

createCompletionResponse

Представляет ответ завершения из API. Примечание. В отличие от конечной точки чата объекты потокового и непотокового ответа используют одну и ту же фигуру (в отличие от конечной точки чата).

Name	Type	Description	Required
choices	array	Список вариантов завершения модели, созданной для ввода запроса.	Yes
created	integer	Метка времени Unix (в секундах) при создании завершения.	Yes
id	string	Уникальный идентификатор завершения.	Yes
model	string	Модель, используемая для завершения.	Yes
object	enum	Тип объекта, который всегда является "text_completion" Возможные значения: `text_completion`	Yes
prompt_filter_results	promptFilterResults	Результаты фильтрации содержимого для нуля или более запросов в запросе. В запросе потоковой передачи результаты для различных запросов могут поступать в разное время или в разных заказах.	No
system_fingerprint	string	Этот отпечаток представляет конфигурацию серверной части, с которой работает модель. Можно использовать в сочетании с параметром `seed` запроса, чтобы понять, когда внутренние изменения были внесены, что может повлиять на детерминированность.	No
usage	completionUsage	Статистика использования для запроса завершения.	No

createChatCompletionRequest

Name	Type	Description	Required	Default
audio	object	Параметры выходных данных звука. Требуется при запросе выходных данных звука.`modalities: ["audio"]`	No
└─ format	enum	Указывает выходной формат звука. Должен быть одним из `wav`, , `mp3flac`, `opus`или `pcm16`. Возможные значения: `wav`, , `mp3flacopuspcm16`	No
└─ voice	enum	Указывает тип голоса. Поддерживаемые голоса: `alloy`, `echo`, `fable`, `onyx`и `novashimmer`. Возможные значения: `alloy`, , `echofableonyx`, `novashimmer`	No
data_sources	array	Записи конфигурации для расширений чата Azure OpenAI, которые используют их. Эта дополнительная спецификация совместима только с Azure OpenAI.	No
frequency_penalty	number	Число от -2.0 до 2.0. Положительные значения наказывают новые маркеры на основе их существующей частоты в тексте до сих пор, уменьшая вероятность повторения той же строки.	No	0
function_call	string или chatCompletionFunctionCallOption	Не рекомендуется использовать в пользу `tool_choice`. Определяет, какая функция (если есть) вызывается моделью. `none` означает, что модель не вызывает функцию и вместо этого создает сообщение. `auto` означает, что модель может выбирать между созданием сообщения или вызовом функции. Указание определенной функции путем `{"name": "my_function"}` принудительного вызова этой функции моделью. `none` значение по умолчанию, если функции отсутствуют. `auto` значение по умолчанию, если функции присутствуют.	No
functions	array	Не рекомендуется использовать в пользу `tools`. Список функций, для которые модель может создавать входные данные JSON.	No
logit_bias	object	Измените вероятность появления указанных маркеров в завершении. Принимает объект JSON, который сопоставляет маркеры (указанные идентификатором маркера в токенизаторе) со связанным значением предвзятости от -100 до 100. Математически предвзятость добавляется в логиты, созданные моделью до выборки. Точный эффект зависит от модели, но значения между -1 и 1 должны уменьшаться или увеличивать вероятность выбора; такие значения, как -100 или 100, должны привести к запрету или эксклюзивному выбору соответствующего маркера.	No	None
logprobs	boolean	Следует ли возвращать вероятности журналов выходных маркеров или нет. Если значение true, возвращает вероятности журнала каждого выходного маркера, возвращаемого в параметре `contentmessage`.	No	False
max_completion_tokens	integer	Верхняя граница для числа маркеров, которые можно создать для завершения, включая видимые выходные маркеры и маркеры причин.	No
max_tokens	integer	Максимальное количество маркеров, которые можно создать в завершении чата. Общая длина входных маркеров и созданных маркеров ограничена длиной контекста модели.	No
messages	array	Список сообщений, составляющих беседу до сих пор. Пример кода Python.	Yes
metadata	object	Определяемые разработчиком теги и значения, используемые для фильтрации завершений на панели мониторинга хранимых завершений.	No
modalities	ChatCompletionModalities	Типы выходных данных, которые нужно создать для этого запроса. Большинство моделей могут создавать текст, который по умолчанию: `["text"]` Модель `gpt-4o-audio-preview` также может использоваться для создания звука. Чтобы запросить, что эта модель создает как текстовые, так и звуковые ответы, можно использовать: `["text", "audio"]`	No
n	integer	Сколько вариантов завершения чата для каждого входного сообщения. Обратите внимание, что плата будет взиматься на основе количества созданных маркеров во всех вариантах. Имейте в виду `n` , чтобы `1` свести к минимуму затраты.	No	1
parallel_tool_calls	ParallelToolCalls	Следует ли включить параллельные вызовы функций во время использования средства.	No	True
prediction	PredictionContent	Конфигурация прогнозируемых выходных данных, которая может значительно улучшить время отклика, когда большие части ответа модели известны заранее. Это наиболее распространено при повторном создании файла с незначительными изменениями в большинстве содержимого.	No
presence_penalty	number	Число от -2.0 до 2.0. Положительные значения наказывают новые маркеры на основе того, отображаются ли они в тексте до сих пор, увеличив вероятность того, что модель будет говорить о новых темах.	No	0
reasoning_effort	enum	Только модели o1 Ограничивает усилия по рассуждениям моделей. В настоящее время поддерживаются `low`значения , `medium`и `high`. Сокращение усилий по поводу может привести к более быстрым откликам и меньшем количестве маркеров, используемых при рассуждениях в ответе. Возможные значения: `low`, `mediumhigh`	No
response_format	ResponseFormatText или ResponseFormatJsonObject или ResponseFormatJsonSchema	Объект, указывающий формат, который должен выводить модель. Совместим с GPT-4o, GPT-4o mini, GPT-4 Turbo и всеми моделями GPT-3.5 Turbo, чем `gpt-3.5-turbo-1106`более новые. Параметр для `{ "type": "json_schema", "json_schema": {...} }` включения структурированных выходных данных, которые гарантируют соответствие модели предоставленной схеме JSON. Параметр включения `{ "type": "json_object" }` режима JSON, который гарантирует, что модель создает сообщение является допустимым JSON. Важно: при использовании режима JSON необходимо также указать модели создавать JSON самостоятельно с помощью системного или пользовательского сообщения. Без этого модель может создать неуправляемый поток пробелов до тех пор, пока поколение не достигнет предела маркера, в результате чего длительный и, казалось бы, "застрявший" запрос. Кроме того, обратите внимание, что содержимое сообщения может быть частично отрезано, если `finish_reason="length"`, что указывает на превышение поколения `max_tokens` или беседа превысила максимальную длину контекста.	No
seed	integer	Эта функция доступна в бета-версии. Если задано, наша система делает все возможное для выборки детерминированного, таким образом, что повторяющиеся запросы с одинаковыми и параметрами должны возвращать тот же `seed` результат. Детерминированность не гарантируется, и вы должны ссылаться на `system_fingerprint` параметр ответа для отслеживания изменений в серверной части.	No
stop	строка или массив	До 4 последовательностей, в которых API перестает создавать дополнительные маркеры.	No
store	boolean	Независимо от того, следует ли хранить выходные данные этого запроса на завершение чата для использования в наших продуктах для дистилляции или оценки модели.	No
stream	boolean	Если задано, разностные сообщения отправляются, например в ChatGPT. Маркеры отправляются как события, отправляемые сервером только для данных по мере их доступности, при этом поток завершается сообщением `data: [DONE]` . Пример кода Python.	No	False
stream_options	chatCompletionStreamOptions	Параметры потокового ответа. Этот параметр устанавливается только при установке `stream: true`.	No	None
temperature	number	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным. Как правило, мы рекомендуем изменить это или `top_p` не оба.	No	1
tool_choice	chatCompletionToolChoiceOption	Определяет, какое средство (если таковое) вызывается моделью. `none` означает, что модель не будет вызывать какое-либо средство и вместо этого создает сообщение. `auto` означает, что модель может выбирать между созданием сообщения или вызовом одного или нескольких инструментов. `required` означает, что модель должна вызывать один или несколько инструментов. Указание определенного средства с помощью `{"type": "function", "function": {"name": "my_function"}}` принудительного вызова этого средства моделью. `none` значение по умолчанию, если средства отсутствуют. `auto` значение по умолчанию, если существуют средства.	No
tools	array	Список инструментов, которые может вызывать модель. В настоящее время в качестве инструмента поддерживаются только функции. Используйте это для предоставления списка функций, для которые модель может создавать входные данные JSON. Поддерживаются не более 128 функций.	No
top_logprobs	integer	Целое число от 0 до 20, указывающее число наиболее вероятных маркеров, возвращаемых по каждой позиции маркера, каждый из которых имеет связанную вероятность журнала. `logprobs` Необходимо задать значение `true` , если этот параметр используется.	No
top_p	number	Альтернатива выборке с температурой, называемой выборкой ядра, где модель рассматривает результаты маркеров с top_p массой вероятности. Таким образом, 0,1 означает, что рассматриваются только маркеры, состоящие из 10 лучших% массы вероятностей. Как правило, мы рекомендуем изменить это или `temperature` не оба.	No	1
user	string	Уникальный идентификатор, представляющий конечного пользователя, который может помочь в мониторинге и обнаружении злоупотреблений.	No
user_security_context	userSecurityContext	Контекст безопасности пользователей содержит несколько параметров, описывающих само приложение ИИ, и конечный пользователь, взаимодействующий с приложением ИИ. Эти поля помогают группам по операциям безопасности исследовать и устранять инциденты безопасности, предоставляя комплексный подход к защите приложений ИИ. Дополнительные сведения о защите приложений ИИ с помощью Microsoft Defender для облака.	No

userSecurityContext

Контекст безопасности пользователей содержит несколько параметров, описывающих само приложение ИИ, и конечный пользователь, взаимодействующий с приложением ИИ. Эти поля помогают группам по операциям безопасности исследовать и устранять инциденты безопасности, предоставляя комплексный подход к защите приложений ИИ. Дополнительные сведения о защите приложений ИИ с помощью Microsoft Defender для облака.

Name	Type	Description	Required
application_name	string	Имя приложения. Конфиденциальная личная информация не должна быть включена в это поле.	No
end_user_id	string	Этот идентификатор — это идентификатор объекта пользователя Microsoft Entra (ранее Azure Active Directory), используемый для проверки подлинности конечных пользователей в созданном приложении ИИ. Конфиденциальная личная информация не должна быть включена в это поле.	No
end_user_tenant_id	string	Идентификатор клиента Microsoft 365, к которому принадлежит конечный пользователь. Это необходимо, если созданное приложение ИИ является мультитенантным.	No
source_ip	string	Записывает IP-адрес исходного клиента, принимающие форматы IPv4 и IPv6.	No

chatCompletionFunctions

Name	Type	Description	Required
description	string	Описание того, что выполняет функция, используемая моделью для выбора времени и способа вызова функции.	No
name	string	Имя вызываемой функции. Должен быть a-z, A-Z, 0-9 или содержать символы подчеркивания и дефисы с максимальной длиной 64.	Yes
parameters	FunctionParameters	Параметры, которые принимают функции, описаны как объект схемы JSON. Примеры см. в руководстве и справочнике по схеме JSON для документации по формату. Опущение `parameters` определяет функцию с пустым списком параметров.	No

chatCompletionFunctionCallOption

Указание определенной функции путем {"name": "my_function"} принудительного вызова этой функции моделью.

Name	Type	Description	Required	Default
name	string	Имя вызываемой функции.	Yes

chatCompletionFunctionParameters

Параметры, которые принимают функции, описаны как объект схемы JSON. См. руководство или примеры и справочник по схеме JSON для документации по формату.

Для этого компонента не определены свойства.

chatCompletionRequestMessage

Этот компонент может быть одним из следующих компонентов:

ChatCompletionRequestDeveloperMessage
chatCompletionRequestSystemMessage
chatCompletionRequestUserMessage
chatCompletionRequestAssistantMessage
chatCompletionRequestToolMessage
chatCompletionRequestFunctionMessage

ChatCompletionRequestDeveloperMessage

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

Name	Type	Description	Required
content	строка или массив	Содержимое сообщения разработчика.	Yes
name	string	Необязательное имя участника. Предоставляет сведения о модели, чтобы различать участников одной роли.	No
role	enum	Роль автора сообщений в данном случае `developer`. Возможные значения: `developer`	Yes

chatCompletionRequestSystemMessage

Name	Type	Description	Required
content	строка или массив	Содержимое системного сообщения.	Yes
name	string	Необязательное имя участника. Предоставляет сведения о модели, чтобы различать участников одной роли.	No
role	enum	Роль автора сообщений в данном случае `system`. Возможные значения: `system`	Yes

chatCompletionRequestUserMessage

Name	Type	Description	Required
content	строка или массив	Содержимое сообщения пользователя.	Yes
name	string	Необязательное имя участника. Предоставляет сведения о модели, чтобы различать участников одной роли.	No
role	enum	Роль автора сообщений в данном случае `user`. Возможные значения: `user`	Yes

chatCompletionRequestAssistantMessage

Name	Type	Description	Required
content	строка или массив	Содержимое сообщения помощника. Обязательный, если `tool_calls` не указан или `function_call` не указан.	No
function_call	object	Устаревшие и замененные `tool_calls`. Имя и аргументы вызываемой функции, созданной моделью.	No
└─ arguments	string	Аргументы, с которыми вызывается функция, как создается моделью в формате JSON. Обратите внимание, что модель не всегда создает допустимые json и может галлюцинировать параметры, не определенные схемой функции. Перед вызовом функции проверьте аргументы в коде.	No
└─ name	string	Имя вызываемой функции.	No
name	string	Необязательное имя участника. Предоставляет сведения о модели, чтобы различать участников одной роли.	No
refusal	string	Сообщение об отказе помощником.	No
role	enum	Роль автора сообщений в данном случае `assistant`. Возможные значения: `assistant`	Yes
tool_calls	chatCompletionMessageToolCalls	Вызовы средства, созданные моделью, например вызовы функций.	No

chatCompletionRequestToolMessage

Name	Type	Description	Required
content	строка или массив	Содержимое сообщения средства.	Yes
role	enum	Роль автора сообщений в данном случае `tool`. Возможные значения: `tool`	Yes
tool_call_id	string	Вызов средства, на который отвечает это сообщение.	Yes

chatCompletionRequestFunctionMessage

Name	Type	Description	Required
content	string	Содержимое сообщения функции.	Yes
name	string	Имя вызываемой функции.	Yes
role	enum	Роль автора сообщений в данном случае `function`. Возможные значения: `function`	Yes

chatCompletionRequestDeveloperMessageContentPart

Этот компонент может быть одним из следующих компонентов:

chatCompletionRequestMessageContentPartText

chatCompletionRequestSystemMessageContentPart

Этот компонент может быть одним из следующих компонентов:

chatCompletionRequestMessageContentPartText

chatCompletionRequestUserMessageContentPart

Этот компонент может быть одним из следующих компонентов:

chatCompletionRequestMessageContentPartText
chatCompletionRequestMessageContentPartImage
chatCompletionRequestMessageContentPartAudio

chatCompletionRequestAssistantMessageContentPart

Этот компонент может быть одним из следующих компонентов:

chatCompletionRequestMessageContentPartText
chatCompletionRequestMessageContentPartRefusal

chatCompletionRequestToolMessageContentPart

Этот компонент может быть одним из следующих компонентов:

chatCompletionRequestMessageContentPartText

chatCompletionRequestMessageContentPartText

Name	Type	Description	Required	Default
text	string	Текстовое содержимое.	Yes
type	enum	Тип части содержимого. Возможные значения: `text`	Yes

chatCompletionRequestMessageContentPartAudio

Name	Type	Description	Required
input_audio	object		Yes
└─ data	string	Звуковые данные в кодировке Base64.	No
└─ format	enum	Формат закодированных звуковых данных. В настоящее время поддерживается wav и mp3. Возможные значения: `wav`, `mp3`	No
type	enum	Тип части содержимого. Всегда `input_audio`. Возможные значения: `input_audio`	Yes

chatCompletionRequestMessageContentPartImage

Name	Type	Description	Required
image_url	object		Yes
└─ detail	enum	Указывает уровень детализации изображения. Дополнительные сведения см. в руководстве по визуальному представлению. Возможные значения: `auto`, `lowhigh`	No
└─ url	string	URL-адрес изображения или данных в кодировке Base64.	No
type	enum	Тип части содержимого. Возможные значения: `image_url`	Yes

chatCompletionRequestMessageContentPartRefusal

Name	Type	Description	Required	Default
refusal	string	Сообщение об отказе, созданное моделью.	Yes
type	enum	Тип части содержимого. Возможные значения: `refusal`	Yes

azureChatExtensionConfiguration

Представление данных конфигурации для одного расширения чата Azure OpenAI. Это будет использоваться запросом завершения чата, который должен использовать расширения чата Azure OpenAI для расширения поведения ответа. Использование этой конфигурации совместимо только с Azure OpenAI.

###Discriminator для azureChatExtensionConfiguration

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

Type Value	Schema
`azure_search`	azureSearchChatExtensionConfiguration
`azure_cosmos_db`	azureCosmosDBChatExtensionConfiguration
`elasticsearch`	elasticsearchChatExtensionConfiguration
`mongo_db`	mongoDBChatExtensionConfiguration
`pinecone`	pineconeChatExtensionConfiguration

Name	Type	Description	Required	Default
type	azureChatExtensionType	Представление данных конфигурации для одного расширения чата Azure OpenAI. Это будет использоваться запросом завершения чата, который должен использовать расширения чата Azure OpenAI для расширения поведения ответа. Использование этой конфигурации совместимо только с Azure OpenAI.	Yes

azureChatExtensionType

Property	Value
Description	Представление данных конфигурации для одного расширения чата Azure OpenAI. Это будет использоваться запросом завершения чата, который должен использовать расширения чата Azure OpenAI для расширения поведения ответа. Использование этой конфигурации совместимо только с Azure OpenAI.
Type	string
Values	`azure_search` `azure_cosmos_db` `elasticsearch` `mongo_db` `pinecone`

azureSearchChatExtensionConfiguration

Определенное представление настраиваемых параметров поиска Azure при использовании его в качестве расширения чата OpenAI в Azure.

Name	Type	Description	Required	Default
parameters	azureSearchChatExtensionParameters	Параметры поиска Azure при использовании в качестве расширения чата OpenAI в Azure.	No
type	azureChatExtensionType	Представление данных конфигурации для одного расширения чата Azure OpenAI. Это будет использоваться запросом завершения чата, который должен использовать расширения чата Azure OpenAI для расширения поведения ответа. Использование этой конфигурации совместимо только с Azure OpenAI.	Yes

azureSearchChatExtensionParameters

Параметры поиска Azure при использовании в качестве расширения чата OpenAI в Azure.

Name	Type	Description	Required	Default
allow_partial_result	boolean	Если задано значение true, система позволит использовать частичные результаты поиска, и запрос завершается ошибкой, если все запросы завершаются ошибкой. Если запрос не указан или указан как false, запрос завершится ошибкой, если какой-либо поисковый запрос завершается ошибкой.	No	False
authentication	onYourDataApiKeyAuthenticationOptions или onYourDataSystemAssignedManagedIdentityAuthenticationOptions или onYourDataUserAssignedManagedIdentityAuthenticationOptions или onYourDataAccessTokenAuthenticationOptions		Yes
embedding_dependency	onYourDataEndpointVectorizationSource или onYourDataDeploymentNameVectorizationSource или onYourDataIntegratedVectorizationSource		No
endpoint	string	Абсолютный путь конечной точки для используемого ресурса поиска Azure.	Yes
fields_mapping	azureSearchIndexFieldMappingOptions	Необязательные параметры для управления обработкой полей при использовании настроенного ресурса поиска Azure.	No
filter	string	Search filter.	No
in_scope	boolean	Следует ли ограничить запросы использованием индексированных данных.	No
include_contexts	array	Включенные свойства контекста вывода. Если не указано, значение по умолчанию равно `citations` и `intent`.	No
index_name	string	Имя индекса, используемого как доступное в ресурсе поиска Azure.	Yes
max_search_queries	integer	Максимальное количество перезаписных запросов должно отправляться в поставщик поиска для одного сообщения пользователя. Если это не указано, система решит количество запросов для отправки.	No
query_type	azureSearchQueryType	Тип запроса поиска Azure, который должен выполняться при использовании в качестве расширения чата Azure OpenAI.	No
semantic_configuration	string	Дополнительная семантическая конфигурация для запроса.	No
strictness	integer	Настроенная строгость фильтрации релевантности поиска. Чем выше строгость, тем выше точность, но более низкий отзыв ответа.	No
top_n_documents	integer	Настроено первое число документов для функции настроенного запроса.	No

azureSearchIndexFieldMappingOptions

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

Name	Type	Description	Required
content_fields	array	Имена полей индекса, которые следует рассматривать как содержимое.	No
content_fields_separator	string	Шаблон разделителя, который должны использовать поля содержимого.	No
filepath_field	string	Имя поля индекса, используемого в качестве файлового пути.	No
image_vector_fields	array	Имена полей, представляющих векторные данные изображения.	No
title_field	string	Имя поля индекса, используемого в качестве заголовка.	No
url_field	string	Имя поля индекса, используемого в качестве URL-адреса.	No
vector_fields	array	Имена полей, представляющих векторные данные.	No

azureSearchQueryType

Тип запроса поиска Azure, который должен выполняться при использовании в качестве расширения чата Azure OpenAI.

Property	Value
Description	Тип запроса поиска Azure, который должен выполняться при использовании в качестве расширения чата Azure OpenAI.
Type	string
Values	`simple` `semantic` `vector` `vector_simple_hybrid` `vector_semantic_hybrid`

azureCosmosDBChatExtensionConfiguration

Определенное представление настраиваемых параметров для Azure Cosmos DB при использовании в качестве расширения чата OpenAI в Azure.

Name	Type	Description	Required	Default
parameters	azureCosmosDBChatExtensionParameters	Параметры, используемые при настройке расширений чата Azure OpenAI в чате данных при использовании Azure Cosmos DB для виртуальных ядер MongoDB.	No
type	azureChatExtensionType	Представление данных конфигурации для одного расширения чата Azure OpenAI. Это будет использоваться запросом завершения чата, который должен использовать расширения чата Azure OpenAI для расширения поведения ответа. Использование этой конфигурации совместимо только с Azure OpenAI.	Yes

azureCosmosDBChatExtensionParameters

Параметры, используемые при настройке расширений чата Azure OpenAI в чате данных при использовании Azure Cosmos DB для виртуальных ядер MongoDB.

Name	Type	Description	Required	Default
allow_partial_result	boolean	Если задано значение true, система позволит использовать частичные результаты поиска, и запрос завершается ошибкой, если все запросы завершаются ошибкой. Если запрос не указан или указан как false, запрос завершится ошибкой, если какой-либо поисковый запрос завершается ошибкой.	No	False
authentication	onYourDataConnectionStringAuthenticationOptions	Параметры проверки подлинности Azure OpenAI On Your Data при использовании строки подключения.	Yes
container_name	string	Имя контейнера ресурсов Azure Cosmos DB.	Yes
database_name	string	Имя базы данных виртуальных ядер MongoDB для использования с Azure Cosmos DB.	Yes
embedding_dependency	onYourDataEndpointVectorizationSource или onYourDataDeploymentNameVectorizationSource		Yes
fields_mapping	azureCosmosDBFieldMappingOptions	Необязательные параметры для управления обработкой полей при использовании настроенного ресурса Azure Cosmos DB.	Yes
in_scope	boolean	Следует ли ограничить запросы использованием индексированных данных.	No
include_contexts	array	Включенные свойства контекста вывода. Если не указано, значение по умолчанию равно `citations` и `intent`.	No
index_name	string	Имя индекса виртуального ядра MongoDB для использования с Azure Cosmos DB.	Yes
max_search_queries	integer	Максимальное количество перезаписных запросов должно отправляться в поставщик поиска для одного сообщения пользователя. Если это не указано, система решит количество запросов для отправки.	No
strictness	integer	Настроенная строгость фильтрации релевантности поиска. Чем выше строгость, тем выше точность, но более низкий отзыв ответа.	No
top_n_documents	integer	Настроено первое число документов для функции настроенного запроса.	No

azureCosmosDBFieldMappingOptions

Необязательные параметры для управления обработкой полей при использовании настроенного ресурса Azure Cosmos DB.

Name	Type	Description	Required
content_fields	array	Имена полей индекса, которые следует рассматривать как содержимое.	Yes
content_fields_separator	string	Шаблон разделителя, который должны использовать поля содержимого.	No
filepath_field	string	Имя поля индекса, используемого в качестве файлового пути.	No
title_field	string	Имя поля индекса, используемого в качестве заголовка.	No
url_field	string	Имя поля индекса, используемого в качестве URL-адреса.	No
vector_fields	array	Имена полей, представляющих векторные данные.	Yes

elasticsearchChatExtensionConfiguration

Определенное представление настраиваемых параметров для Elasticsearch при использовании в качестве расширения чата OpenAI в Azure.

Name	Type	Description	Required	Default
parameters	elasticsearchChatExtensionParameters	Параметры, используемые при настройке Elasticsearch в® качестве расширения чата Azure OpenAI.	No
type	azureChatExtensionType	Представление данных конфигурации для одного расширения чата Azure OpenAI. Это будет использоваться запросом завершения чата, который должен использовать расширения чата Azure OpenAI для расширения поведения ответа. Использование этой конфигурации совместимо только с Azure OpenAI.	Yes

elasticsearchChatExtensionParameters

Параметры, используемые при настройке Elasticsearch в® качестве расширения чата Azure OpenAI.

Name	Type	Description	Required	Default
allow_partial_result	boolean	Если задано значение true, система позволит использовать частичные результаты поиска, и запрос завершается ошибкой, если все запросы завершаются ошибкой. Если запрос не указан или указан как false, запрос завершится ошибкой, если какой-либо поисковый запрос завершается ошибкой.	No	False
authentication	onYourDataKeyAndKeyIdAuthenticationOptions или onYourDataEncodedApiKeyAuthenticationOptions		Yes
embedding_dependency	onYourDataEndpointVectorizationSource или onYourDataDeploymentNameVectorizationSource или onYourDataModelIdVectorizationSource		No
endpoint	string	Конечная точка Elasticsearch.®	Yes
fields_mapping	elasticsearchIndexFieldMappingOptions	Необязательные параметры для управления обработкой полей при использовании настроенного ресурса Elasticsearch.®	No
in_scope	boolean	Следует ли ограничить запросы использованием индексированных данных.	No
include_contexts	array	Включенные свойства контекста вывода. Если не указано, значение по умолчанию равно `citations` и `intent`.	No
index_name	string	Имя индекса ElasticsearchÂ®.	Yes
max_search_queries	integer	Максимальное количество перезаписных запросов должно отправляться в поставщик поиска для одного сообщения пользователя. Если это не указано, система решит количество запросов для отправки.	No
query_type	elasticsearchQueryType	Тип запроса на получение Elasticsearch,® который должен выполняться при использовании в качестве расширения чата Azure OpenAI.	No
strictness	integer	Настроенная строгость фильтрации релевантности поиска. Чем выше строгость, тем выше точность, но более низкий отзыв ответа.	No
top_n_documents	integer	Настроено первое число документов для функции настроенного запроса.	No

elasticsearchIndexFieldMappingOptions

Необязательные параметры для управления обработкой полей при использовании настроенного ресурса Elasticsearch.®

Name	Type	Description	Required
content_fields	array	Имена полей индекса, которые следует рассматривать как содержимое.	No
content_fields_separator	string	Шаблон разделителя, который должны использовать поля содержимого.	No
filepath_field	string	Имя поля индекса, используемого в качестве файлового пути.	No
title_field	string	Имя поля индекса, используемого в качестве заголовка.	No
url_field	string	Имя поля индекса, используемого в качестве URL-адреса.	No
vector_fields	array	Имена полей, представляющих векторные данные.	No

elasticsearchQueryType

Тип запроса на получение Elasticsearch,® который должен выполняться при использовании в качестве расширения чата Azure OpenAI.

Property	Value
Description	Тип запроса на получение Elasticsearch,® который должен выполняться при использовании в качестве расширения чата Azure OpenAI.
Type	string
Values	`simple` `vector`

mongoDBChatExtensionConfiguration

Определенное представление настраиваемых параметров для Mongo DB при использовании в качестве расширения чата Azure OpenAI.

Name	Type	Description	Required	Default
parameters	mongoDBChatExtensionParameters	Параметры, используемые при настройке расширений чата Azure OpenAI в чате данных при использовании Mongo DB.	No
type	azureChatExtensionType	Представление данных конфигурации для одного расширения чата Azure OpenAI. Это будет использоваться запросом завершения чата, который должен использовать расширения чата Azure OpenAI для расширения поведения ответа. Использование этой конфигурации совместимо только с Azure OpenAI.	Yes

mongoDBChatExtensionParameters

Параметры, используемые при настройке расширений чата Azure OpenAI в чате данных при использовании Mongo DB.

Name	Type	Description	Required	Default
allow_partial_result	boolean	Если задано значение true, система позволит использовать частичные результаты поиска, и запрос завершается ошибкой, если все запросы завершаются ошибкой. Если запрос не указан или указан как false, запрос завершится ошибкой, если какой-либо поисковый запрос завершается ошибкой.	No	False
app_name	string	Имя приложения Mongo DB.	Yes
authentication	onYourDataUsernameAndPasswordAuthenticationOptions	Параметры проверки подлинности Azure OpenAI On Your Data при использовании имени пользователя и пароля.	Yes
collection_name	string	Имя коллекции Базы данных Mongo.	Yes
database_name	string	Имя базы данных Mongo DB.	Yes
embedding_dependency	onYourDataEndpointVectorizationSource или onYourDataDeploymentNameVectorizationSource		Yes
endpoint	string	Имя конечной точки кластера Mongo DB.	Yes
fields_mapping	mongoDBFieldMappingOptions	Необязательные параметры для управления обработкой полей при использовании настроенного ресурса Mongo DB.	Yes
in_scope	boolean	Следует ли ограничить запросы использованием индексированных данных.	No
include_contexts	array	Включенные свойства контекста вывода. Если не указано, значение по умолчанию равно `citations` и `intent`.	No
index_name	string	Имя индекса Mongo DB.	Yes
max_search_queries	integer	Максимальное количество перезаписных запросов должно отправляться в поставщик поиска для одного сообщения пользователя. Если это не указано, система решит количество запросов для отправки.	No
strictness	integer	Настроенная строгость фильтрации релевантности поиска. Чем выше строгость, тем выше точность, но более низкий отзыв ответа.	No
top_n_documents	integer	Настроено первое число документов для функции настроенного запроса.	No

mongoDBFieldMappingOptions

Необязательные параметры для управления обработкой полей при использовании настроенного ресурса Mongo DB.

Name	Type	Description	Required
content_fields	array	Имена полей индекса, которые следует рассматривать как содержимое.	Yes
content_fields_separator	string	Шаблон разделителя, который должны использовать поля содержимого.	No
filepath_field	string	Имя поля индекса, используемого в качестве файлового пути.	No
title_field	string	Имя поля индекса, используемого в качестве заголовка.	No
url_field	string	Имя поля индекса, используемого в качестве URL-адреса.	No
vector_fields	array	Имена полей, представляющих векторные данные.	Yes

pineconeChatExtensionConfiguration

Определенное представление настраиваемых параметров для Pinecone при использовании его в качестве расширения чата Azure OpenAI.

Name	Type	Description	Required	Default
parameters	pineconeChatExtensionParameters	Параметры настройки расширений чата Azure OpenAI Pinecone.	No
type	azureChatExtensionType	Представление данных конфигурации для одного расширения чата Azure OpenAI. Это будет использоваться запросом завершения чата, который должен использовать расширения чата Azure OpenAI для расширения поведения ответа. Использование этой конфигурации совместимо только с Azure OpenAI.	Yes

pineconeChatExtensionParameters

Параметры настройки расширений чата Azure OpenAI Pinecone.

Name	Type	Description	Required	Default
allow_partial_result	boolean	Если задано значение true, система позволит использовать частичные результаты поиска, и запрос завершается ошибкой, если все запросы завершаются ошибкой. Если запрос не указан или указан как false, запрос завершится ошибкой, если какой-либо поисковый запрос завершается ошибкой.	No	False
authentication	onYourDataApiKeyAuthenticationOptions	Параметры проверки подлинности Azure OpenAI On Your Data при использовании ключа API.	Yes
embedding_dependency	onYourDataDeploymentNameVectorizationSource	Сведения о источнике векторизации, используемом Azure OpenAI On Your Data при применении векторного поиска, основанного на имени развертывания модели внутренних внедрения в том же ресурсе Azure OpenAI.	Yes
environment	string	Имя среды Pinecone.	Yes
fields_mapping	pineconeFieldMappingOptions	Необязательные параметры для управления обработкой полей при использовании настроенного ресурса Pinecone.	Yes
in_scope	boolean	Следует ли ограничить запросы использованием индексированных данных.	No
include_contexts	array	Включенные свойства контекста вывода. Если не указано, значение по умолчанию равно `citations` и `intent`.	No
index_name	string	Имя индекса базы данных Pinecone.	Yes
max_search_queries	integer	Максимальное количество перезаписных запросов должно отправляться в поставщик поиска для одного сообщения пользователя. Если это не указано, система решит количество запросов для отправки.	No
strictness	integer	Настроенная строгость фильтрации релевантности поиска. Чем выше строгость, тем выше точность, но более низкий отзыв ответа.	No
top_n_documents	integer	Настроено первое число документов для функции настроенного запроса.	No

pineconeFieldMappingOptions

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

Name	Type	Description	Required
content_fields	array	Имена полей индекса, которые следует рассматривать как содержимое.	Yes
content_fields_separator	string	Шаблон разделителя, который должны использовать поля содержимого.	No
filepath_field	string	Имя поля индекса, используемого в качестве файлового пути.	No
title_field	string	Имя поля индекса, используемого в качестве заголовка.	No
url_field	string	Имя поля индекса, используемого в качестве URL-адреса.	No

onYourDataAuthenticationOptions

Параметры проверки подлинности для Azure OpenAI в данных.

Дискриминация для onYourDataAuthenticationOptions

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

Type Value	Schema
`api_key`	onYourDataApiKeyAuthenticationOptions
`connection_string`	onYourDataConnectionStringAuthenticationOptions
`key_and_key_id`	onYourDataKeyAndKeyIdAuthenticationOptions
`encoded_api_key`	onYourDataEncodedApiKeyAuthenticationOptions
`access_token`	onYourDataAccessTokenAuthenticationOptions
`system_assigned_managed_identity`	onYourDataSystemAssignedManagedIdentityAuthenticationOptions
`user_assigned_managed_identity`	onYourDataUserAssignedManagedIdentityAuthenticationOptions
`username_and_password`	onYourDataUsernameAndPasswordAuthenticationOptions

Name	Type	Description	Required	Default
type	onYourDataAuthenticationType	Типы проверки подлинности, поддерживаемые Azure OpenAI в данных.	Yes

onYourDataContextProperty

Свойство контекста.

Property	Value
Description	Свойство контекста.
Type	string
Values	`citations` `intent` `all_retrieved_documents`

onYourDataAuthenticationType

Типы проверки подлинности, поддерживаемые Azure OpenAI в данных.

Property	Value
Description	Типы проверки подлинности, поддерживаемые Azure OpenAI в данных.
Type	string
Values	`api_key` `connection_string` `key_and_key_id` `encoded_api_key` `access_token` `system_assigned_managed_identity` `user_assigned_managed_identity` `username_and_password`

onYourDataApiKeyAuthenticationOptions

Параметры проверки подлинности Azure OpenAI On Your Data при использовании ключа API.

Name	Type	Description	Required	Default
key	string	Ключ API, используемый для проверки подлинности.	No
type	onYourDataAuthenticationType	Типы проверки подлинности, поддерживаемые Azure OpenAI в данных.	Yes

onYourDataConnectionStringAuthenticationOptions

Параметры проверки подлинности Azure OpenAI On Your Data при использовании строки подключения.

Name	Type	Description	Required	Default
connection_string	string	Строка подключения, используемая для проверки подлинности.	No
type	onYourDataAuthenticationType	Типы проверки подлинности, поддерживаемые Azure OpenAI в данных.	Yes

onYourDataKeyAndKeyIdAuthenticationOptions

Параметры проверки подлинности Azure OpenAI On Your Data при использовании пары идентификаторов elasticsearch и ключа.

Name	Type	Description	Required
key	string	Ключ Elasticsearch, используемый для проверки подлинности.	No
key_id	string	Идентификатор ключа Elasticsearch, используемый для проверки подлинности.	No
type	onYourDataAuthenticationType	Типы проверки подлинности, поддерживаемые Azure OpenAI в данных.	Yes

onYourDataEncodedApiKeyAuthenticationOptions

Параметры проверки подлинности Azure OpenAI On Your Data при использовании ключа API в кодировке Elasticsearch.

Name	Type	Description	Required	Default
encoded_api_key	string	Ключ API в кодировке Elasticsearch, используемый для проверки подлинности.	No
type	onYourDataAuthenticationType	Типы проверки подлинности, поддерживаемые Azure OpenAI в данных.	Yes

onYourDataAccessTokenAuthenticationOptions

Параметры проверки подлинности Azure OpenAI On Your Data при использовании маркера доступа.

Name	Type	Description	Required	Default
access_token	string	Маркер доступа, используемый для проверки подлинности.	No
type	onYourDataAuthenticationType	Типы проверки подлинности, поддерживаемые Azure OpenAI в данных.	Yes

onYourDataSystemAssignedManagedIdentityAuthenticationOptions

Параметры проверки подлинности Azure OpenAI On Your Data при использовании управляемого удостоверения, назначаемого системой.

Name	Type	Description	Required	Default
type	onYourDataAuthenticationType	Типы проверки подлинности, поддерживаемые Azure OpenAI в данных.	Yes

onYourDataUserAssignedManagedIdentityAuthenticationOptions

Параметры проверки подлинности Azure OpenAI On Your Data при использовании управляемого удостоверения, назначаемого пользователем.

Name	Type	Description	Required	Default
managed_identity_resource_id	string	Идентификатор ресурса управляемого удостоверения, назначаемого пользователем, который будет использоваться для проверки подлинности.	No
type	onYourDataAuthenticationType	Типы проверки подлинности, поддерживаемые Azure OpenAI в данных.	Yes

onYourDataUsernameAndPasswordAuthenticationOptions

Параметры проверки подлинности Azure OpenAI On Your Data при использовании имени пользователя и пароля.

Name	Type	Description	Required
password	string	The password. для проверки подлинности.	No
type	onYourDataAuthenticationType	Типы проверки подлинности, поддерживаемые Azure OpenAI в данных.	Yes
username	string	Имя пользователя, используемое для проверки подлинности.	No

onYourDataVectorizationSource

Абстрактное представление источника векторизации для Azure OpenAI On Your Data с помощью векторного поиска.

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

Type Value	Schema
`endpoint`	onYourDataEndpointVectorizationSource
`deployment_name`	onYourDataDeploymentNameVectorizationSource
`integrated`	onYourDataIntegratedVectorizationSource
`model_id`	onYourDataModelIdVectorizationSource

Name	Type	Description	Required	Default
type	onYourDataVectorizationSourceType	Представляет доступные источники Azure OpenAI On Your Data, которые можно использовать для настройки векторизации данных для использования с векторным поиском.	Yes

onYourDataVectorizationSourceType

Представляет доступные источники Azure OpenAI On Your Data, которые можно использовать для настройки векторизации данных для использования с векторным поиском.

Property	Value
Description	Представляет доступные источники Azure OpenAI On Your Data, которые можно использовать для настройки векторизации данных для использования с векторным поиском.
Type	string
Values	`endpoint` `deployment_name` `integrated` `model_id`

onYourDataEndpointVectorizationSource

Сведения о источнике векторизации, используемом Azure OpenAI On Your Data при применении векторного поиска, основанном на вызове общедоступной конечной точки Azure OpenAI для внедрения.

Name	Type	Description	Required
authentication	onYourDataApiKeyAuthenticationOptions или onYourDataAccessTokenAuthenticationOptions		No
dimensions	integer	Количество измерений, которые должны быть внедренными. Поддерживается только в `text-embedding-3` и более поздних моделях.	No
endpoint	string	Указывает URL-адрес конечной точки ресурса, из которого должны быть получены внедренные модули. Он должен быть в формате `https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings`. Параметр запроса версии API не разрешен.	No
type	onYourDataVectorizationSourceType	Представляет доступные источники Azure OpenAI On Your Data, которые можно использовать для настройки векторизации данных для использования с векторным поиском.	Yes

onYourDataDeploymentNameVectorizationSource

Сведения о источнике векторизации, используемом Azure OpenAI On Your Data при применении векторного поиска, основанном на имени развертывания модели внутреннего внедрения в том же ресурсе Azure OpenAI.

Name	Type	Description	Required
deployment_name	string	Указывает имя развертывания модели, используемого для векторизации. Это развертывание модели должно находиться в одном ресурсе Azure OpenAI, но при использовании этого развертывания модели с помощью внутреннего вызова, а не общедоступного, что позволяет выполнять поиск векторов даже в частных сетях.	No
dimensions	integer	Количество измерений, которые должны быть внедренными. Поддерживается только в `text-embedding-3` и более поздних моделях.	No
type	onYourDataVectorizationSourceType	Представляет доступные источники Azure OpenAI On Your Data, которые можно использовать для настройки векторизации данных для использования с векторным поиском.	Yes

onYourDataIntegratedVectorizationSource

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

Name	Type	Description	Required	Default
type	onYourDataVectorizationSourceType	Представляет доступные источники Azure OpenAI On Your Data, которые можно использовать для настройки векторизации данных для использования с векторным поиском.	Yes

onYourDataModelIdVectorizationSource

Сведения о источнике векторизации, используемом Azure OpenAI On Your Data при применении векторного поиска, основанном на идентификаторе модели службы поиска. В настоящее время поддерживается только Elasticsearch.®

Name	Type	Description	Required	Default
model_id	string	Указывает идентификатор модели, используемый для векторизации. Этот идентификатор модели должен быть определен в службе поиска.	No
type	onYourDataVectorizationSourceType	Представляет доступные источники Azure OpenAI On Your Data, которые можно использовать для настройки векторизации данных для использования с векторным поиском.	Yes

azureChatExtensionsMessageContext

Представление дополнительных сведений о контексте, доступных при использовании расширений чата Azure OpenAI в создании соответствующего ответа на завершение чата. Эти сведения контекста заполняются только при использовании запроса Azure OpenAI, настроенного для использования соответствующего расширения.

Name	Type	Description	Required
all_retrieved_documents	array	Все извлеченные документы.	No
citations	array	Результат извлечения источника данных, используемый для создания сообщения помощника в ответе.	No
intent	string	Обнаруженное намерение из журнала чата, используемое для передачи в следующий поворот для переноса контекста.	No

citation

сведения о ссылке для сообщения ответа о завершении чата.

Name	Type	Description	Required
chunk_id	string	Идентификатор фрагмента ссылки.	No
content	string	Содержимое ссылки.	Yes
filepath	string	Путь к файлу ссылки.	No
rerank_score	number	Оценка повторного использования извлеченного документа.	No
title	string	Заголовок ссылки.	No
url	string	URL-адрес ссылки.	No

retrievedDocument

Извлеченный документ.

Name	Type	Description	Required
chunk_id	string	Идентификатор фрагмента ссылки.	No
content	string	Содержимое ссылки.	Yes
data_source_index	integer	Индекс источника данных.	No
filepath	string	Путь к файлу ссылки.	No
filter_reason	filterReason	Причина фильтрации извлеченного документа.	No
original_search_score	number	Исходная оценка поиска извлеченного документа.	No
rerank_score	number	Оценка повторного использования извлеченного документа.	No
search_queries	array	Поисковые запросы, используемые для извлечения документа.	No
title	string	Заголовок ссылки.	No
url	string	URL-адрес ссылки.	No

filterReason

Причина фильтрации извлеченного документа.

Property	Value
Description	Причина фильтрации извлеченного документа.
Type	string
Values	`score` `rerank`

chatCompletionMessageToolCall

Name	Type	Description	Required
function	object	Функция, вызываемая моделью.	Yes
└─ arguments	string	Аргументы, с которыми вызывается функция, как создается моделью в формате JSON. Обратите внимание, что модель не всегда создает допустимые json и может галлюцинировать параметры, не определенные схемой функции. Перед вызовом функции проверьте аргументы в коде.	No
└─ name	string	Имя вызываемой функции.	No
id	string	Идентификатор вызова средства.	Yes
type	toolCallType	Тип вызова средства в данном случае `function`.	Yes

toolCallType

Тип вызова средства в данном случае function.

Property	Value
Description	Тип вызова средства в данном случае `function`.
Type	string
Values	`function`

chatCompletionRequestMessageTool

Name	Type	Description	Required	Default
content	string	Содержимое сообщения.	No
tool_call_id	string	Вызов средства, на который отвечает это сообщение.	No

chatCompletionRequestMessageFunction

Name	Type	Description	Required
content	string	Содержимое сообщения.	No
name	string	Содержимое сообщения.	No
role	enum	Роль автора сообщений в данном случае `function`. Возможные значения: `function`	No

createChatCompletionResponse

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

Name	Type	Description	Required
choices	array	Список вариантов завершения чата. Может быть больше одного, если `n` больше 1.	Yes
created	integer	Метка времени Unix (в секундах) при создании завершения чата.	Yes
id	string	Уникальный идентификатор завершения чата.	Yes
model	string	Модель, используемая для завершения чата.	Yes
object	enum	Тип объекта, который всегда `chat.completion`является . Возможные значения: `chat.completion`	Yes
prompt_filter_results	promptFilterResults	Результаты фильтрации содержимого для нуля или более запросов в запросе. В запросе потоковой передачи результаты для различных запросов могут поступать в разное время или в разных заказах.	No
system_fingerprint	string	Этот отпечаток представляет конфигурацию серверной части, с которой работает модель. Можно использовать в сочетании с параметром `seed` запроса, чтобы понять, когда внутренние изменения были внесены, что может повлиять на детерминированность.	No
usage	completionUsage	Статистика использования для запроса завершения.	No

createChatCompletionStreamResponse

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

Name	Type	Description	Required
choices	array	Список вариантов завершения чата. Может содержать несколько элементов, если `n` больше 1.	Yes
created	integer	Метка времени Unix (в секундах) при создании завершения чата. Каждый блок имеет одинаковую метку времени.	Yes
id	string	Уникальный идентификатор завершения чата. Каждый блок имеет один и тот же идентификатор.	Yes
model	string	Модель для создания завершения.	Yes
object	enum	Тип объекта, который всегда `chat.completion.chunk`является . Возможные значения: `chat.completion.chunk`	Yes
system_fingerprint	string	Этот отпечаток представляет конфигурацию серверной части, с которой работает модель. Можно использовать в сочетании с параметром `seed` запроса, чтобы понять, когда внутренние изменения были внесены, что может повлиять на детерминированность.	No

chatCompletionStreamResponseDelta

Разностное завершение чата, созданное потоковой передачей ответов модели.

Name	Type	Description	Required
content	string	Содержимое сообщения блока.	No
function_call	object	Устаревшие и замененные `tool_calls`. Имя и аргументы вызываемой функции, созданной моделью.	No
└─ arguments	string	Аргументы, с которыми вызывается функция, как создается моделью в формате JSON. Обратите внимание, что модель не всегда создает допустимые json и может галлюцинировать параметры, не определенные схемой функции. Перед вызовом функции проверьте аргументы в коде.	No
└─ name	string	Имя вызываемой функции.	No
refusal	string	Сообщение об отказе, созданное моделью.	No
role	enum	Роль автора этого сообщения. Возможные значения: `system`, , `userassistanttool`	No
tool_calls	array		No

chatCompletionMessageToolCallChunk

Name	Type	Description	Required
function	object		No
└─ arguments	string	Аргументы, с которыми вызывается функция, как создается моделью в формате JSON. Обратите внимание, что модель не всегда создает допустимые json и может галлюцинировать параметры, не определенные схемой функции. Перед вызовом функции проверьте аргументы в коде.	No
└─ name	string	Имя вызываемой функции.	No
id	string	Идентификатор вызова средства.	No
index	integer		Yes
type	enum	Тип средства. В настоящее время поддерживается только `function` . Возможные значения: `function`	No

chatCompletionStreamOptions

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

Name	Type	Description	Required	Default
include_usage	boolean	Если задано, перед сообщением будет передаваться `data: [DONE]` дополнительный блок. Поле `usage` на этом блоке отображает статистику использования маркеров для всего запроса, и `choices` поле всегда будет пустым массивом. Все остальные блоки также будут содержать `usage` поле, но со значением NULL.	No

chatCompletionChoiceLogProbs

Сведения о вероятности журнала для выбора.

Name	Type	Description	Required	Default
content	array	Список маркеров содержимого сообщения с информацией о вероятности журнала.	Yes
refusal	array	Список маркеров отказа сообщения с информацией о вероятности журнала.	No

chatCompletionTokenLogprob

Name	Type	Description	Required
bytes	array	Список целых чисел, представляющих представление маркера UTF-8 байт. Полезно в случаях, когда символы представлены несколькими токенами, а их байтовые представления должны объединяться для создания правильного текстового представления. Может быть `null` , если для маркера нет представления байтов.	Yes
logprob	number	Вероятность этого токена в журнале.	Yes
token	string	The token.	Yes
top_logprobs	array	Список наиболее вероятных маркеров и их вероятности журналов в этой позиции маркера. В редких случаях количество запрошенных `top_logprobs` возвращаемых данных может быть меньше.	Yes

chatCompletionResponseMessage

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

Name	Type	Description	Required
audio	object	Если запрашивается модальность вывода звука, этот объект содержит данные о звуковом ответе модели.	No
└─ data	string	В кодировке Base64 звуковые байты, созданные моделью, в формате, указанном в запросе.	No
└─ expires_at	integer	Метка времени Unix (в секундах), когда этот звуковой ответ больше не будет доступен на сервере для использования в многоэтапных беседах.	No
└─ id	string	Уникальный идентификатор для этого звукового ответа.	No
└─ transcript	string	Расшифровка звука, созданного моделью.	No
content	string	Содержимое сообщения.	Yes
context	azureChatExtensionsMessageContext	Представление дополнительных сведений о контексте, доступных при использовании расширений чата Azure OpenAI в создании соответствующего ответа на завершение чата. Эти сведения контекста заполняются только при использовании запроса Azure OpenAI, настроенного для использования соответствующего расширения.	No
function_call	chatCompletionFunctionCall	Устаревшие и замененные `tool_calls`. Имя и аргументы вызываемой функции, созданной моделью.	No
refusal	string	Сообщение об отказе, созданное моделью.	Yes
role	chatCompletionResponseMessageRole	Роль автора сообщения ответа.	Yes
tool_calls	array	Вызовы средства, созданные моделью, например вызовы функций.	No

chatCompletionResponseMessageRole

Роль автора сообщения ответа.

Property	Value
Description	Роль автора сообщения ответа.
Type	string
Values	`assistant`

chatCompletionToolChoiceOption

Определяет, какое средство (если таковое) вызывается моделью. none означает, что модель не будет вызывать какое-либо средство и вместо этого создает сообщение. auto означает, что модель может выбирать между созданием сообщения или вызовом одного или нескольких инструментов. required означает, что модель должна вызывать один или несколько инструментов. Указание определенного средства с помощью {"type": "function", "function": {"name": "my_function"}} принудительного вызова этого средства моделью. none значение по умолчанию, если средства отсутствуют. auto значение по умолчанию, если существуют средства.

Этот компонент может быть одним из следующих компонентов:

chatCompletionNamedToolChoice

chatCompletionNamedToolChoice

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

Name	Type	Description	Required
function	object		Yes
└─ name	string	Имя вызываемой функции.	No
type	enum	Тип средства. В настоящее время поддерживается только `function` . Возможные значения: `function`	Yes

ParallelToolCalls

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

Для этого компонента не определены свойства.

PredictionContent

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

Name	Type	Description	Required	Default
content	строка или массив	Содержимое, которое должно быть сопоставлено при создании ответа модели. Если созданные маркеры будут соответствовать этому содержимому, можно быстро вернуть весь ответ модели.	Yes
type	enum	Тип прогнозируемого содержимого, который требуется предоставить. Этот тип в настоящее время всегда `content`. Возможные значения: `content`	Yes

chatCompletionMessageToolCalls

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

Для этого компонента не определены свойства.

ChatCompletionModalities

Типы выходных данных, которые нужно создать для этого запроса. Большинство моделей могут создавать текст, который по умолчанию:

["text"]

Модель gpt-4o-audio-preview также может использоваться для создания звука. Чтобы запросить, что эта модель создает как текстовые, так и звуковые ответы, можно использовать:

["text", "audio"]

Для этого компонента не определены свойства.

chatCompletionFunctionCall

Устаревшие и замененные tool_calls. Имя и аргументы вызываемой функции, созданной моделью.

Name	Type	Description	Required	Default
arguments	string	Аргументы, с которыми вызывается функция, как создается моделью в формате JSON. Обратите внимание, что модель не всегда создает допустимые json и может галлюцинировать параметры, не определенные схемой функции. Перед вызовом функции проверьте аргументы в коде.	Yes
name	string	Имя вызываемой функции.	Yes

completionUsage

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

Name	Type	Description	Required
completion_tokens	integer	Количество маркеров в созданном завершении.	Yes
completion_tokens_details	object	Разбивка маркеров, используемых в завершении.	No
└─ accepted_prediction_tokens	integer	При использовании прогнозируемых выходных данных число маркеров в прогнозе, появившемся в завершении.	No
└─ audio_tokens	integer	Маркеры ввода звука, созданные моделью.	No
└─ reasoning_tokens	integer	Маркеры, созданные моделью для рассуждений.	No
└─ rejected_prediction_tokens	integer	При использовании прогнозируемых выходных данных число маркеров в прогнозе, которое не отображалось в завершении. Однако, как и маркеры причин, эти маркеры по-прежнему учитываются в общих маркерах завершения для целей выставления счетов, выходных данных и контекстного окна.	No
prompt_tokens	integer	Количество маркеров в запросе.	Yes
prompt_tokens_details	object	Сведения о маркерах запроса.	No
└─ audio_tokens	integer	Маркеры ввода звука, представленные в запросе.	No
└─ cached_tokens	integer	Количество кэшированных маркеров запроса.	No
total_tokens	integer	Общее количество маркеров, используемых в запросе (запрос + завершение).	Yes

chatCompletionTool

Name	Type	Description	Required	Default
function	FunctionObject		Yes
type	enum	Тип средства. В настоящее время поддерживается только `function` . Возможные значения: `function`	Yes

FunctionParameters

Параметры, которые принимают функции, описаны как объект схемы JSON. Примеры см. в руководстве и справочнике по схеме JSON для документации по формату.

Опущение parameters определяет функцию с пустым списком параметров.

Для этого компонента не определены свойства.

FunctionObject

Name	Type	Description	Required	Default
description	string	Описание того, что выполняет функция, используемая моделью для выбора времени и способа вызова функции.	No
name	string	Имя вызываемой функции. Должен быть a-z, A-Z, 0-9 или содержать символы подчеркивания и дефисы с максимальной длиной 64.	Yes
parameters	FunctionParameters	Параметры, которые принимают функции, описаны как объект схемы JSON. Примеры см. в руководстве и справочнике по схеме JSON для документации по формату. Опущение `parameters` определяет функцию с пустым списком параметров.	No
strict	boolean	Следует ли включить строгое соблюдение схемы при создании вызова функции. Если задано значение true, модель будет соответствовать точной схеме, определенной `parameters` в поле. При этом `strict`поддерживается `true` только подмножество схемы JSON.	No	False

ResponseFormatText

Name	Type	Description	Required	Default
type	enum	Тип формата ответа, который определяется: `text` Возможные значения: `text`	Yes

ResponseFormatJsonObject

Name	Type	Description	Required	Default
type	enum	Тип формата ответа, который определяется: `json_object` Возможные значения: `json_object`	Yes

ResponseFormatJsonSchemaSchema

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

Для этого компонента не определены свойства.

ResponseFormatJsonSchema

Name	Type	Description	Required	Default
json_schema	object		Yes
└─ description	string	Описание формата ответа, используемого моделью для определения того, как реагировать в формате.	No
└─ name	string	Имя формата ответа. Должен быть a-z, A-Z, 0-9 или содержать символы подчеркивания и дефисы с максимальной длиной 64.	No
└─ schema	ResponseFormatJsonSchemaSchema	Схема формата ответа, описанная как объект схемы JSON.	No
└─ strict	boolean	Следует ли включить строгое соблюдение схемы при создании выходных данных. Если задано значение true, модель всегда будет соответствовать точной схеме, определенной `schema` в поле. При этом `strict`поддерживается `true` только подмножество схемы JSON.	No	False
type	enum	Тип формата ответа, который определяется: `json_schema` Возможные значения: `json_schema`	Yes

chatCompletionChoiceCommon

Name	Type	Description	Required	Default
finish_reason	string		No
index	integer		No

createTranslationRequest

Translation request.

Name	Type	Description	Required	Default
file	string	Звуковой файл для перевода.	Yes
prompt	string	Необязательный текст для руководства стилем модели или продолжением предыдущего сегмента звука. Запрос должен находиться на английском языке.	No
response_format	audioResponseFormat	Определяет формат выходных данных.	No
temperature	number	Температура выборки от 0 до 1. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным. Если задано значение 0, модель использует вероятность журнала для автоматического увеличения температуры до тех пор, пока определенные пороговые значения не будут достигнуты.	No	0

audioResponse

Ответ на преобразование или транскрибирование при response_format json

Name	Type	Description	Required	Default
text	string	Переведенный или транскрибированные тексты.	Yes

audioVerboseResponse

Ответ перевода или транскрибирования при verbose_json response_format

Name	Type	Description	Required
duration	number	Duration.	No
language	string	Language.	No
segments	array		No
task	string	Тип звуковой задачи.	No
text	string	Переведенный или транскрибированные тексты.	Yes
words	array		No

audioResponseFormat

Определяет формат выходных данных.

Property	Value
Description	Определяет формат выходных данных.
Type	string
Values	`json` `text` `srt` `verbose_json` `vtt`

createTranscriptionRequest

Transcription request.

Name	Type	Description	Required	Default
file	string	Объект звукового файла для транскрибирования.	Yes
language	string	Язык входного звука. Предоставление языка ввода в формате ISO-639-1 повышает точность и задержку.	No
prompt	string	Необязательный текст для руководства стилем модели или продолжением предыдущего сегмента звука. Запрос должен соответствовать языку звука.	No
response_format	audioResponseFormat	Определяет формат выходных данных.	No
temperature	number	Температура выборки от 0 до 1. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным. Если задано значение 0, модель использует вероятность журнала для автоматического увеличения температуры до тех пор, пока определенные пороговые значения не будут достигнуты.	No	0
timestamp_granularities[]	array	Гранулярность метки времени для заполнения этой транскрибирования. `response_format` необходимо задать `verbose_json` для использования детализации метки времени. Поддерживаются либо оба этих параметра: `word`или `segment`. Примечание. Дополнительная задержка для меток времени сегмента отсутствует, но при создании меток времени слова возникает дополнительная задержка.	No	['segment']

audioSegment

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

Name	Type	Description	Required
avg_logprob	number	Средняя вероятность журнала.	No
compression_ratio	number	Compression ratio.	No
end	number	Смещение конца сегмента.	No
id	integer	Segment identifier.	No
no_speech_prob	number	Вероятность "нет речи".	No
seek	number	Смещение сегмента.	No
start	number	Смещение запуска сегмента.	No
temperature	number	Temperature.	No
text	string	Segment text.	No
tokens	array	Маркеры текста.	No

audioWord

Транскрибирование или перевод слова.

Name	Type	Description	Required
end	number	Смещение конца Word.	No
start	number	Смещение запуска Word.	No
word	string	Word	No

createSpeechRequest

Speech request.

Name	Type	Description	Required	Default
input	string	Текст для синтеза звука. Максимальная длина — 4096 символов.	Yes
response_format	enum	Формат синтеза звука в. Возможные значения: `mp3`, , `opusaacflac`, `wavpcm`	No
speed	number	Скорость синтезированного звука. Выберите значение из `0.254.0`. `1.0` — значение по умолчанию.	No	1.0
voice	enum	Голос, используемый для синтеза речи. Возможные значения: `alloy`, , `echofableonyx`, `novashimmer`	Yes

imageQuality

Качество создаваемого изображения.

Property	Value
Description	Качество создаваемого изображения.
Type	string
Default	auto
Values	`auto` `high` `medium` `low` `hd` `standard`

imagesResponseFormat

Формат, в котором возвращаются созданные изображения.

Property	Value
Description	Формат, в котором возвращаются созданные изображения.
Type	string
Default	url
Values	`url` `b64_json`

imagesOutputFormat

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

Property	Value
Description	Формат файла, в котором возвращаются созданные изображения. Поддерживается только для моделей серии gpt-image-1.
Type	string
Default	png
Values	`png` `jpeg`

imageSize

Размер созданных изображений.

Property	Value
Description	Размер созданных изображений.
Type	string
Default	auto
Values	`auto` `1792x1024` `1024x1792` `1024x1024` `1024x1536` `1536x1024`

imageStyle

Стиль созданных изображений. Поддерживается только для dall-e-3.

Property	Value
Description	Стиль созданных изображений. Поддерживается только для dall-e-3.
Type	string
Default	vivid
Values	`vivid` `natural`

imageBackground

Позволяет задать прозрачность фона созданных образов. Этот параметр поддерживается только для моделей серии gpt-image-1.

Property	Value
Description	Позволяет задать прозрачность фона созданных образов. Этот параметр поддерживается только для моделей серии gpt-image-1.
Type	string
Default	auto
Values	`transparent` `opaque` `auto`

imageGenerationsRequest

Name	Type	Description	Required	Default
background	imageBackground	Позволяет задать прозрачность фона созданных образов. Этот параметр поддерживается только для моделей серии gpt-image-1.	No	auto
n	integer	Количество генерируемых изображений. Для dall-e-3 поддерживается только n=1.	No	1
output_compression	integer	Уровень сжатия (0–100%) для созданных образов. Этот параметр поддерживается только для моделей серии gpt-image-1 с форматом выходных данных JPEG.	No	100
output_format	imagesOutputFormat	Формат файла, в котором возвращаются созданные изображения. Поддерживается только для моделей серии gpt-image-1.	No	png
prompt	string	Текстовое описание требуемых изображений. Максимальная длина — 32000 символов для моделей серии gpt-image-1 и 4000 символов для dall-e-3	Yes
quality	imageQuality	Качество создаваемого изображения.	No	auto
response_format	imagesResponseFormat	Формат, в котором возвращаются созданные изображения. Поддерживается только для dall-e-3.	No	url
size	imageSize	Размер созданных изображений.	No	auto
style	imageStyle	Стиль созданных изображений. Поддерживается только для dall-e-3.	No	vivid
user	string	Уникальный идентификатор, представляющий конечного пользователя, который может помочь в мониторинге и обнаружении злоупотреблений.	No

imageEditsRequest

Name	Type	Description	Required	Default
image	строка или массив	Изображения для редактирования. Должен быть поддерживаемым файлом изображения или массивом изображений. Каждое изображение должно быть png или jpg-файл менее 25 МБ.	Yes
mask	string	Дополнительное изображение с полностью прозрачными областями (например, альфа-нулем) указывает, где следует изменить изображение. Если есть несколько изображений, маска будет применена к первому изображению. Должен быть допустимым PNG-файлом, менее 4 МБ и иметь те же размеры, что и изображение.	No
n	integer	Количество генерируемых изображений.	No	1
prompt	string	Текстовое описание требуемых изображений. Максимальная длина — 32000 символов.	Yes
quality	imageQuality	Качество создаваемого изображения.	No	auto
response_format	imagesResponseFormat	Формат, в котором возвращаются созданные изображения.	No	url
size	imageSize	Размер созданных изображений.	No	auto
user	string	Уникальный идентификатор, представляющий конечного пользователя, который может помочь в мониторинге и обнаружении злоупотреблений.	No

generateImagesResponse

Name	Type	Description	Required
created	integer	Метка времени unix при создании операции.	Yes
data	array	Результат операции при успешном выполнении	Yes
usage	imageGenerationsUsage	Представляет сведения об использовании маркеров для запросов на создание изображений. Только для моделей серии gpt-image-1.	No

imageResult

URL-адрес изображения или закодированный образ в случае успешного выполнения и ошибка в противном случае.

Name	Type	Description	Required
b64_json	string	Изображение в кодировке Base64	No
content_filter_results	dalleContentFilterResults	Сведения о результатах фильтрации содержимого.	No
prompt_filter_results	dalleFilterResults	Сведения о категории фильтрации содержимого (ненавидимая, сексуальность, насилие, self_harm), если она обнаружена, а также уровень серьезности (very_low, низкий, средний, высокомасштабируемый, определяющий интенсивность и уровень риска вредного содержимого) и если он был отфильтрован или нет. Сведения о содержимом и ненормативной лексике, если он обнаружен, и если он был отфильтрован или нет. И сведения о списке блокировок клиента, если он был отфильтрован и его идентификатор.	No
revised_prompt	string	Запрос, который использовался для создания образа, если в запросе была любая редакция.	No
url	string	URL-адрес изображения.	No

imageGenerationsUsage

Представляет сведения об использовании маркеров для запросов на создание изображений. Только для моделей серии gpt-image-1.

Name	Type	Description	Required
input_tokens	integer	Количество входных маркеров.	No
input_tokens_details	object	Подробная разбивка входных маркеров.	No
└─ image_tokens	integer	Количество маркеров изображения.	No
└─ text_tokens	integer	Количество текстовых маркеров.	No
output_tokens	integer	Количество выходных маркеров.	No
total_tokens	integer	Общее количество используемых маркеров.	No

line

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

Name	Type	Description	Required	Default
spans	array	Массив диапазонов, представляющих обнаруженные объекты и сведения о ограничивающем поле.	Yes
text	string		Yes

span

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

Name	Type	Description	Required
length	integer	Длина диапазона в символах, измеряемая в кодовых точках Юникода.	Yes
offset	integer	Смещение символов в тексте, в котором начинается диапазон. Это смещение определяется как позиция первого символа диапазона, подсчитывая от начала текста как кодовые точки Юникода.	Yes
polygon	array	Массив объектов, представляющих точки в многоугольнике, который заключает обнаруженный объект.	Yes
text	string	Текстовое содержимое диапазона, представляющего обнаруженный объект.	Yes

runCompletionUsage

Статистика использования, связанная с выполнением. Это значение будет иметь значение null , если выполнение не в состоянии терминала (т. е. in_progress, queuedи т. д.).

Name	Type	Description	Required
completion_tokens	integer	Количество маркеров завершения, используемых в ходе выполнения.	Yes
prompt_tokens	integer	Количество маркеров запроса, используемых в ходе выполнения.	Yes
total_tokens	integer	Общее количество используемых маркеров (запрос и завершение).	Yes

runStepCompletionUsage

Статистика использования, связанная с шагом выполнения. Это значение будет находиться null в состоянии in_progressшага выполнения.

Name	Type	Description	Required
completion_tokens	integer	Количество маркеров завершения, используемых на этапе выполнения.	Yes
prompt_tokens	integer	Количество маркеров запроса, используемых на этапе выполнения.	Yes
total_tokens	integer	Общее количество используемых маркеров (запрос и завершение).	Yes

assistantsApiResponseFormatOption

Указывает формат, который модель должна выводить. Совместим с GPT-4o, GPT-4 Turbo и всеми моделями GPT-3.5 Turbo с тех пор gpt-3.5-turbo-1106.

{ "type": "json_schema", "json_schema": {...} } Чтобы включить структурированные выходные данные, которые обеспечивают соответствие модели предоставленной схеме JSON. Дополнительные сведения см. в руководстве по структурированным выходным данным.

Параметр включения { "type": "json_object" } режима JSON, который гарантирует, что модель создает сообщение является допустимым JSON.

Важно: при использовании режима JSON необходимо также указать модели создавать JSON самостоятельно с помощью системного или пользовательского сообщения. Без этого модель может создать неуправляемый поток пробелов до тех пор, пока поколение не достигнет предела маркера, в результате чего длительный и, казалось бы, "застрявший" запрос. Кроме того, обратите внимание, что содержимое сообщения может быть частично отрезано, если finish_reason="length", что указывает на превышение поколения max_tokens или беседа превысила максимальную длину контекста.

Этот компонент может быть одним из следующих компонентов:

ResponseFormatText
ResponseFormatJsonObject
ResponseFormatJsonSchema

assistantsApiResponseFormat

Объект, описывающий ожидаемые выходные данные модели. Если json_object в run разрешено передавать только function тип tools . Если text модель может возвращать текст или любое необходимое значение.

Name	Type	Description	Required	Default
type	string	Должен быть одним из `text` или `json_object`.	No	text

тип Enum: AssistantsApiResponseFormat

Value	Description
text
json_object

assistantObject

Представляет объект assistant , который может вызывать модель и использовать средства.

Name	Type	Description	Required	Default
created_at	integer	Метка времени Unix (в секундах) для момента создания помощника.	Yes
description	string	Описание помощника. Максимальная длина — 512 символов.	Yes
id	string	Идентификатор, на который можно ссылаться в конечных точках API.	Yes
instructions	string	Системные инструкции, которые использует помощник. Максимальная длина — 256 000 символов.	Yes
metadata	object	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.	Yes
model	string	Идентификатор используемой модели.	Yes
name	string	Имя помощника. Максимальная длина — 256 символов.	Yes
object	string	Тип объекта, который всегда `assistant`является .	Yes
response_format	assistantsApiResponseFormatOption	Указывает формат, который модель должна выводить. Совместим с GPT-4o, GPT-4 Turbo и всеми моделями GPT-3.5 Turbo с тех пор `gpt-3.5-turbo-1106`. `{ "type": "json_schema", "json_schema": {...} }` Чтобы включить структурированные выходные данные, которые обеспечивают соответствие модели предоставленной схеме JSON. Дополнительные сведения см. в руководстве по структурированным выходным данным. Параметр включения `{ "type": "json_object" }` режима JSON, который гарантирует, что модель создает сообщение является допустимым JSON. Важно: при использовании режима JSON необходимо также указать модели создавать JSON самостоятельно с помощью системного или пользовательского сообщения. Без этого модель может создать неуправляемый поток пробелов до тех пор, пока поколение не достигнет предела маркера, в результате чего длительный и, казалось бы, "застрявший" запрос. Кроме того, обратите внимание, что содержимое сообщения может быть частично отрезано, если `finish_reason="length"`, что указывает на превышение поколения `max_tokens` или беседа превысила максимальную длину контекста.	No
temperature	number	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным.	No	1
tool_resources	object	Набор ресурсов, используемых средствами помощника. Ресурсы относятся к типу инструмента. Например, для `code_interpreter` средства требуется список идентификаторов файлов, а для `file_search` этого средства требуется список идентификаторов векторного хранилища.	No
└─ code_interpreter	object		No
└─ file_ids	array	Список идентификаторов файлов, доступных средству `code_interpreter` . С инструментом может быть не более 20 файлов.	No	[]
└─ file_search	object		No
└─ vector_store_ids	array	Идентификатор хранилища векторов, присоединенного к этому помощнику. К помощнику может быть подключено не более 1 векторного хранилища.	No
tools	array	Список инструментов, включенных помощником. На помощника может быть не более 128 инструментов. Средства могут быть типами `code_interpreter`, `file_search`или `function`.	Yes	[]
top_p	number	Альтернатива выборке с температурой, называемой выборкой ядра, где модель рассматривает результаты маркеров с top_p массой вероятности. Таким образом, 0,1 означает, что рассматриваются только маркеры, состоящие из 10 лучших% массы вероятностей. Как правило, мы рекомендуем изменить это или температуру, но не оба.	No	1

объект Enum: AssistantObjectType

Value	Description
assistant	Тип объекта, который всегда является помощником

createAssistantRequest

Name	Type	Description	Required	Default
description	string	Описание помощника. Максимальная длина — 512 символов.	No
instructions	string	Системные инструкции, которые использует помощник. Максимальная длина — 256 000 символов.	No
metadata	object	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.	No
model	string		Yes
name	string	Имя помощника. Максимальная длина — 256 символов.	No
response_format	assistantsApiResponseFormatOption	Указывает формат, который модель должна выводить. Совместим с GPT-4o, GPT-4 Turbo и всеми моделями GPT-3.5 Turbo с тех пор `gpt-3.5-turbo-1106`. `{ "type": "json_schema", "json_schema": {...} }` Чтобы включить структурированные выходные данные, которые обеспечивают соответствие модели предоставленной схеме JSON. Дополнительные сведения см. в руководстве по структурированным выходным данным. Параметр включения `{ "type": "json_object" }` режима JSON, который гарантирует, что модель создает сообщение является допустимым JSON. Важно: при использовании режима JSON необходимо также указать модели создавать JSON самостоятельно с помощью системного или пользовательского сообщения. Без этого модель может создать неуправляемый поток пробелов до тех пор, пока поколение не достигнет предела маркера, в результате чего длительный и, казалось бы, "застрявший" запрос. Кроме того, обратите внимание, что содержимое сообщения может быть частично отрезано, если `finish_reason="length"`, что указывает на превышение поколения `max_tokens` или беседа превысила максимальную длину контекста.	No
temperature	number	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным.	No	1
tool_resources	object	Набор ресурсов, используемых средствами помощника. Ресурсы относятся к типу инструмента. Например, для `code_interpreter` средства требуется список идентификаторов файлов, а для `file_search` этого средства требуется список идентификаторов векторного хранилища.	No
└─ code_interpreter	object		No
└─ file_ids	array	Список идентификаторов файлов, доступных средству `code_interpreter` . С инструментом может быть не более 20 файлов.	No	[]
└─ file_search	object		No
└─ vector_store_ids	array	Хранилище векторов, присоединенное к этому помощнику. К помощнику может быть подключено не более 1 векторного хранилища.	No
└─ vector_stores	array	Помощник по созданию векторного хранилища с file_ids и присоединению его к этому помощнику. К помощнику может быть подключено не более 1 векторного хранилища.	No
tools	array	Список инструментов, включенных помощником. На помощника может быть не более 128 инструментов. Средства могут быть типами `code_interpreter`, `retrieval`или `function`.	No	[]
top_p	number	Альтернатива выборке с температурой, называемой выборкой ядра, где модель рассматривает результаты маркеров с top_p массой вероятности. Таким образом, 0,1 означает, что рассматриваются только маркеры, состоящие из 10 лучших% массы вероятностей. Как правило, мы рекомендуем изменить это или температуру, но не оба.	No	1

modifyAssistantRequest

Name	Type	Description	Required	Default
description	string	Описание помощника. Максимальная длина — 512 символов.	No
instructions	string	Системные инструкции, которые использует помощник. Максимальная длина — 32768 символов.	No
metadata	object	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.	No
model	string		No
name	string	Имя помощника. Максимальная длина — 256 символов.	No
response_format	assistantsApiResponseFormatOption	Указывает формат, который модель должна выводить. Совместим с GPT-4o, GPT-4 Turbo и всеми моделями GPT-3.5 Turbo с тех пор `gpt-3.5-turbo-1106`. `{ "type": "json_schema", "json_schema": {...} }` Чтобы включить структурированные выходные данные, которые обеспечивают соответствие модели предоставленной схеме JSON. Дополнительные сведения см. в руководстве по структурированным выходным данным. Параметр включения `{ "type": "json_object" }` режима JSON, который гарантирует, что модель создает сообщение является допустимым JSON. Важно: при использовании режима JSON необходимо также указать модели создавать JSON самостоятельно с помощью системного или пользовательского сообщения. Без этого модель может создать неуправляемый поток пробелов до тех пор, пока поколение не достигнет предела маркера, в результате чего длительный и, казалось бы, "застрявший" запрос. Кроме того, обратите внимание, что содержимое сообщения может быть частично отрезано, если `finish_reason="length"`, что указывает на превышение поколения `max_tokens` или беседа превысила максимальную длину контекста.	No
temperature	number	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным.	No	1
tool_resources	object	Набор ресурсов, используемых средствами помощника. Ресурсы относятся к типу инструмента. Например, для `code_interpreter` средства требуется список идентификаторов файлов, а для `file_search` этого средства требуется список идентификаторов векторного хранилища.	No
└─ code_interpreter	object		No
└─ file_ids	array	Переопределяет список идентификаторов файлов, доступных средству `code_interpreter` . С инструментом может быть не более 20 файлов.	No	[]
└─ file_search	object		No
└─ vector_store_ids	array	Переопределяет хранилище векторов, подключенное к этому помощнику. К помощнику может быть подключено не более 1 векторного хранилища.	No
tools	array	Список инструментов, включенных помощником. На помощника может быть не более 128 инструментов. Средства могут быть типами `code_interpreter`, `retrieval`или `function`.	No	[]
top_p	number	Альтернатива выборке с температурой, называемой выборкой ядра, где модель рассматривает результаты маркеров с top_p массой вероятности. Таким образом, 0,1 означает, что рассматриваются только маркеры, состоящие из 10 лучших% массы вероятностей. Как правило, мы рекомендуем изменить это или температуру, но не оба.	No	1

deleteAssistantResponse

Name	Type	Required
deleted	boolean	Yes
id	string	Yes
object	string	Yes

объект Enum: DeleteAssistantResponseState

Value	Description
assistant.deleted

listAssistantsResponse

Name	Type	Required
data	array	Yes
first_id	string	Yes
has_more	boolean	Yes
last_id	string	Yes
object	string	Yes

assistantToolsCode

Name	Type	Description	Required	Default
type	string	Тип определяемого средства: `code_interpreter`	Yes

тип Enum: assistantToolsCodeType

Value	Description
code_interpreter

assistantToolsFileSearch

Name	Type	Description	Required
file_search	object	Переопределяет средство поиска файлов.	No
└─ max_num_results	integer	Максимальное количество результатов, которые должен выводить средство поиска файлов. Значение по умолчанию — 20 для моделей gpt-4* и 5 для gpt-3.5-turbo. Это число должно быть от 1 до 50 включительно. Обратите внимание, что средство поиска файлов может выводить меньше `max_num_results` результатов.	No
type	string	Тип определяемого средства: `file_search`	Yes

type Enum: Тип поиска файлов инструментов ассистента

Value	Description
file_search

assistantToolsFileSearchTypeOnly

Name	Type	Description	Required	Default
type	string	Тип определяемого средства: `file_search`	Yes

type Enum: Тип поиска файлов инструментов ассистента

Value	Description
file_search

assistantToolsFunction

Name	Type	Description	Required
function	object	Определение функции.	Yes
└─ description	string	Описание того, что выполняет функция, используемая моделью для выбора времени и способа вызова функции.	No
└─ name	string	Имя вызываемой функции. Должен быть a-z, A-Z, 0-9 или содержать символы подчеркивания и дефисы с максимальной длиной 64.	No
└─ parameters	chatCompletionFunctionParameters	Параметры, которые принимают функции, описаны как объект схемы JSON. См. руководство или примеры и справочник по схеме JSON для документации по формату.	No
type	string	Тип определяемого средства: `function`	Yes

Type Enum: assistantToolsFunction

Value	Description
function

truncationObject

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

Name	Type	Description	Required	Default
last_messages	integer	Количество последних сообщений из потока при создании контекста для выполнения.	No
type	string	Стратегия усечения, используемая для потока. Значение по умолчанию — `auto`. Если задано значение `last_messages`, поток будет усечен до n последних сообщений в потоке. Если задано значение `auto`, сообщения в середине потока будут удалены, чтобы соответствовать длине контекста модели. `max_prompt_tokens`	Yes

Type Enum: TruncationType

Value	Description
auto
last_messages

assistantsApiToolChoiceOption

Определяет, какое средство (если таковое) вызывается моделью. none означает, что модель не будет вызывать средства и вместо этого создает сообщение. auto является значением по умолчанию и означает, что модель может выбирать между созданием сообщения или вызовом средства. Указание определенного инструмента, например {"type": "file_search"} или {"type": "function", "function": {"name": "my_function"}} принудительное вызов модели.

Этот компонент может быть одним из следующих компонентов:

assistantsNamedToolChoice

assistantsNamedToolChoice

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

Name	Type	Description	Required
function	object		No
└─ name	string	Имя вызываемой функции.	No
type	string	Тип средства. Если тип имеет тип `function`, необходимо задать имя функции.	Yes

тип Enum: AssistantsNamedToolChoiceType

Value	Description
function
code_interpreter
file_search

runObject

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

Name	Type	Description	Required	Default
assistant_id	string	Идентификатор помощника, используемого для выполнения этого запуска.	Yes
cancelled_at	integer	Метка времени Unix (в секундах) для момента отмены выполнения.	Yes
completed_at	integer	Метка времени Unix (в секундах) для завершения выполнения.	Yes
created_at	integer	Метка времени Unix (в секундах) для момента создания запуска.	Yes
expires_at	integer	Метка времени Unix (в секундах) для истечения срока действия выполнения.	Yes
failed_at	integer	Метка времени Unix (в секундах) для момента сбоя выполнения.	Yes
id	string	Идентификатор, на который можно ссылаться в конечных точках API.	Yes
incomplete_details	object	Сведения о том, почему выполнение является неполным. Будет, `null` если выполнение не является неполным.	Yes
└─ reason	string	Причина, по которой выполнение является неполным. Это указывает, какой определенный предел маркера был достигнут в течение выполнения.	No
instructions	string	Инструкции, используемые помощником для этого запуска.	Yes
last_error	object	Последняя ошибка, связанная с этим выполнением. `null` Если ошибок нет.	Yes
└─ code	string	Одно из `server_error` или `rate_limit_exceeded`.	No
└─ message	string	Описание ошибки, доступной для чтения человеком.	No
max_completion_tokens	integer	Максимальное количество маркеров завершения, указанных в ходе выполнения.	Yes
max_prompt_tokens	integer	Максимальное количество маркеров запроса, указанных в ходе выполнения.	Yes
metadata	object	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.	Yes
model	string	Модель, используемая помощником для этого запуска.	Yes
object	string	Тип объекта, который всегда `thread.run`является .	Yes
parallel_tool_calls	ParallelToolCalls	Следует ли включить параллельные вызовы функций во время использования средства.	No	True
required_action	object	Сведения о действии, необходимом для продолжения выполнения. `null` Если никаких действий не требуется.	Yes
└─ submit_tool_outputs	object	Сведения о выходных данных средства, необходимых для продолжения выполнения.	No
└─ tool_calls	array	Список соответствующих вызовов средства.	No
└─ type	enum	На данный момент это всегда `submit_tool_outputs`. Возможные значения: `submit_tool_outputs`	No
response_format	assistantsApiResponseFormatOption	Указывает формат, который модель должна выводить. Совместим с GPT-4o, GPT-4 Turbo и всеми моделями GPT-3.5 Turbo с тех пор `gpt-3.5-turbo-1106`. `{ "type": "json_schema", "json_schema": {...} }` Чтобы включить структурированные выходные данные, которые обеспечивают соответствие модели предоставленной схеме JSON. Дополнительные сведения см. в руководстве по структурированным выходным данным. Параметр включения `{ "type": "json_object" }` режима JSON, который гарантирует, что модель создает сообщение является допустимым JSON. Важно: при использовании режима JSON необходимо также указать модели создавать JSON самостоятельно с помощью системного или пользовательского сообщения. Без этого модель может создать неуправляемый поток пробелов до тех пор, пока поколение не достигнет предела маркера, в результате чего длительный и, казалось бы, "застрявший" запрос. Кроме того, обратите внимание, что содержимое сообщения может быть частично отрезано, если `finish_reason="length"`, что указывает на превышение поколения `max_tokens` или беседа превысила максимальную длину контекста.	Yes
started_at	integer	Метка времени Unix (в секундах) для начала выполнения.	Yes
status	string	Состояние выполнения, которое может быть , , , , , `queued`, `in_progressrequires_action`или `cancelling`. `cancelledfailedcompletedexpired`	Yes
temperature	number	Температура выборки, используемая для этого запуска. Если значение не задано, значение по умолчанию — 1.	No
thread_id	string	Идентификатор потоков, выполняемых в рамках этого запуска.	Yes
tool_choice	assistantsApiToolChoiceOption	Определяет, какое средство (если таковое) вызывается моделью. `none` означает, что модель не будет вызывать средства и вместо этого создает сообщение. `auto` является значением по умолчанию и означает, что модель может выбирать между созданием сообщения или вызовом средства. Указание определенного инструмента, например `{"type": "file_search"}` или `{"type": "function", "function": {"name": "my_function"}}` принудительное вызов модели.	Yes
tools	array	Список инструментов, используемых помощником для этого запуска.	Yes	[]
top_p	number	Значение выборки ядра, используемое для этого запуска. Если значение не задано, значение по умолчанию — 1.	No
truncation_strategy	truncationObject	Определяет, как поток будет усечен до выполнения. Используйте это для управления начальным окном контекста выполнения.	Yes
usage	runCompletionUsage	Статистика использования, связанная с выполнением. Это значение будет иметь значение `null` , если выполнение не в состоянии терминала (т. е. `in_progress`, `queued`и т. д.).	Yes

объект Enum: runObjectType

Value	Description
thread.run	Тип объекта run, который всегда является thread.run

Состояние перечисления: RunObjectStatus

Value	Description
queued	Состояние очереди
in_progress	Состояние in_progress
requires_action	Состояние required_action
cancelling	Состояние отмены
cancelled	Отмененное состояние
failed	Состояние сбоя
completed	Завершенное состояние
expired	Состояние с истекшим сроком действия

createRunRequest

Name	Type	Description	Required	Default
additional_instructions	string	Добавляет дополнительные инструкции в конце инструкций для выполнения. Это полезно для изменения поведения на основе каждого запуска без переопределения других инструкций.	No
additional_messages	array	Добавляет дополнительные сообщения в поток перед созданием запуска.	No
assistant_id	string	Идентификатор помощника, используемого для выполнения этого выполнения.	Yes
instructions	string	Переопределите системное сообщение помощника по умолчанию. Это полезно для изменения поведения на основе каждого запуска.	No
max_completion_tokens	integer	Максимальное количество маркеров завершения, которые могут использоваться в ходе выполнения. Выполнение делает все возможное, чтобы использовать только количество маркеров завершения, указанных в нескольких поворотах выполнения. Если выполнение превышает указанное число маркеров завершения, выполнение завершится состоянием `incomplete`. Дополнительные сведения см. в разделе `incomplete_details` .	No
max_prompt_tokens	integer	Максимальное количество маркеров запроса, которые могут использоваться в ходе выполнения. Выполнение делает все возможное, чтобы использовать только количество маркеров запроса, указанных в нескольких поворотах выполнения. Если выполнение превышает указанное число маркеров запроса, выполнение завершится состоянием `incomplete`. Дополнительные сведения см. в разделе `incomplete_details` .	No
metadata	object	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.	No
model	string	Идентификатор модели, используемой для выполнения этого выполнения. Если здесь указано значение, оно переопределит модель, связанную с помощником. В противном случае будет использоваться модель, связанная с помощником.	No
parallel_tool_calls	ParallelToolCalls	Следует ли включить параллельные вызовы функций во время использования средства.	No	True
response_format	assistantsApiResponseFormatOption	Указывает формат, который модель должна выводить. Совместим с GPT-4o, GPT-4 Turbo и всеми моделями GPT-3.5 Turbo с тех пор `gpt-3.5-turbo-1106`. `{ "type": "json_schema", "json_schema": {...} }` Чтобы включить структурированные выходные данные, которые обеспечивают соответствие модели предоставленной схеме JSON. Дополнительные сведения см. в руководстве по структурированным выходным данным. Параметр включения `{ "type": "json_object" }` режима JSON, который гарантирует, что модель создает сообщение является допустимым JSON. Важно: при использовании режима JSON необходимо также указать модели создавать JSON самостоятельно с помощью системного или пользовательского сообщения. Без этого модель может создать неуправляемый поток пробелов до тех пор, пока поколение не достигнет предела маркера, в результате чего длительный и, казалось бы, "застрявший" запрос. Кроме того, обратите внимание, что содержимое сообщения может быть частично отрезано, если `finish_reason="length"`, что указывает на превышение поколения `max_tokens` или беседа превысила максимальную длину контекста.	No
stream	boolean	Если `true`возвращает поток событий, которые происходят во время событий запуска от имени сервера, завершая выполнение в состоянии терминала с сообщением `data: [DONE]` .	No
temperature	number	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным.	No	1
tool_choice	assistantsApiToolChoiceOption	Определяет, какое средство (если таковое) вызывается моделью. `none` означает, что модель не будет вызывать средства и вместо этого создает сообщение. `auto` является значением по умолчанию и означает, что модель может выбирать между созданием сообщения или вызовом средства. Указание определенного инструмента, например `{"type": "file_search"}` или `{"type": "function", "function": {"name": "my_function"}}` принудительное вызов модели.	No
tools	array	Переопределите средства, которые помощник может использовать для этого запуска. Это полезно для изменения поведения на основе каждого запуска.	No
top_p	number	Альтернатива выборке с температурой, называемой выборкой ядра, где модель рассматривает результаты маркеров с top_p массой вероятности. Таким образом, 0,1 означает, что рассматриваются только маркеры, состоящие из 10 лучших% массы вероятностей. Как правило, мы рекомендуем изменить это или температуру, но не оба.	No	1
truncation_strategy	truncationObject	Определяет, как поток будет усечен до выполнения. Используйте это для управления начальным окном контекста выполнения.	No

listRunsResponse

Name	Type	Required
data	array	Yes
first_id	string	Yes
has_more	boolean	Yes
last_id	string	Yes
object	string	Yes

modifyRunRequest

Name	Type	Description	Required	Default
metadata	object	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.	No

submitToolOutputsRunRequest

Name	Type	Description	Required	Default
stream	boolean	Если `true`возвращает поток событий, которые происходят во время событий запуска от имени сервера, завершая выполнение в состоянии терминала с сообщением `data: [DONE]` .	No
tool_outputs	array	Список инструментов, для которых отправляются выходные данные.	Yes

runToolCallObject

Объекты вызова средства

Name	Type	Description	Required
function	object	Определение функции.	Yes
└─ arguments	string	Аргументы, которые модель ожидает передачи функции.	No
└─ name	string	Имя функции.	No
id	string	Идентификатор вызова средства. Этот идентификатор должен ссылаться при отправке выходных данных средства с помощью выходных данных средства отправки для запуска endpointendpoint.	Yes
type	string	Для вызова выходных данных требуется тип средства. На данный момент это всегда `function`.	Yes

тип Enum: RunToolCallObjectType

Value	Description
function

createThreadAndRunRequest

Name	Type	Description	Required	Default
assistant_id	string	Идентификатор помощника, используемого для выполнения этого выполнения.	Yes
instructions	string	Переопределите системное сообщение помощника по умолчанию. Это полезно для изменения поведения на основе каждого запуска.	No
max_completion_tokens	integer	Максимальное количество маркеров завершения, которые могут использоваться в ходе выполнения. Выполнение делает все возможное, чтобы использовать только количество маркеров завершения, указанных в нескольких поворотах выполнения. Если выполнение превышает указанное число маркеров завершения, выполнение завершится состоянием `incomplete`. Дополнительные сведения см. в разделе `incomplete_details` .	No
max_prompt_tokens	integer	Максимальное количество маркеров запроса, которые могут использоваться в ходе выполнения. Выполнение делает все возможное, чтобы использовать только количество маркеров запроса, указанных в нескольких поворотах выполнения. Если выполнение превышает указанное число маркеров запроса, выполнение завершится состоянием `incomplete`. Дополнительные сведения см. в разделе `incomplete_details` .	No
metadata	object	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.	No
model	string	Идентификатор моделей, используемых для выполнения этого выполнения. Если здесь указано значение, оно переопределит модель, связанную с помощником. В противном случае будет использоваться модель, связанная с помощником.	No
parallel_tool_calls	ParallelToolCalls	Следует ли включить параллельные вызовы функций во время использования средства.	No	True
response_format	assistantsApiResponseFormatOption	Указывает формат, который модель должна выводить. Совместим с GPT-4o, GPT-4 Turbo и всеми моделями GPT-3.5 Turbo с тех пор `gpt-3.5-turbo-1106`. `{ "type": "json_schema", "json_schema": {...} }` Чтобы включить структурированные выходные данные, которые обеспечивают соответствие модели предоставленной схеме JSON. Дополнительные сведения см. в руководстве по структурированным выходным данным. Параметр включения `{ "type": "json_object" }` режима JSON, который гарантирует, что модель создает сообщение является допустимым JSON. Важно: при использовании режима JSON необходимо также указать модели создавать JSON самостоятельно с помощью системного или пользовательского сообщения. Без этого модель может создать неуправляемый поток пробелов до тех пор, пока поколение не достигнет предела маркера, в результате чего длительный и, казалось бы, "застрявший" запрос. Кроме того, обратите внимание, что содержимое сообщения может быть частично отрезано, если `finish_reason="length"`, что указывает на превышение поколения `max_tokens` или беседа превысила максимальную длину контекста.	No
stream	boolean	Если `true`возвращает поток событий, которые происходят во время событий запуска от имени сервера, завершая выполнение в состоянии терминала с сообщением `data: [DONE]` .	No
stream_options	chatCompletionStreamOptions	Параметры потокового ответа. Этот параметр устанавливается только при установке `stream: true`.	No	None
temperature	number	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным.	No	1
thread	createThreadRequest		No
tool_choice	assistantsApiToolChoiceOption	Определяет, какое средство (если таковое) вызывается моделью. `none` означает, что модель не будет вызывать средства и вместо этого создает сообщение. `auto` является значением по умолчанию и означает, что модель может выбирать между созданием сообщения или вызовом средства. Указание определенного инструмента, например `{"type": "file_search"}` или `{"type": "function", "function": {"name": "my_function"}}` принудительное вызов модели.	No
tool_resources	object	Набор ресурсов, используемых средствами помощника. Ресурсы относятся к типу инструмента. Например, для `code_interpreter` средства требуется список идентификаторов файлов, а для `file_search` этого средства требуется список идентификаторов векторного хранилища.	No
└─ code_interpreter	object		No
└─ file_ids	array	Список идентификаторов файлов, доступных средству `code_interpreter` . С инструментом может быть не более 20 файлов.	No	[]
└─ file_search	object		No
└─ vector_store_ids	array	Идентификатор хранилища векторов, присоединенного к этому помощнику. К помощнику может быть подключено не более 1 векторного хранилища.	No
tools	array	Переопределите средства, которые помощник может использовать для этого запуска. Это полезно для изменения поведения на основе каждого запуска.	No
top_p	number	Альтернатива выборке с температурой, называемой выборкой ядра, где модель рассматривает результаты маркеров с top_p массой вероятности. Таким образом, 0,1 означает, что рассматриваются только маркеры, состоящие из 10 лучших% массы вероятностей. Как правило, мы рекомендуем изменить это или температуру, но не оба.	No	1
truncation_strategy	truncationObject	Определяет, как поток будет усечен до выполнения. Используйте это для управления начальным окном контекста выполнения.	No

threadObject

Представляет поток, содержащий сообщения.

Name	Type	Description	Required	Default
created_at	integer	Метка времени Unix (в секундах) для момента создания потока.	Yes
id	string	Идентификатор, на который можно ссылаться в конечных точках API.	Yes
metadata	object	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.	Yes
object	string	Тип объекта, который всегда `thread`является .	Yes
tool_resources	object	Набор ресурсов, доступных средствам помощника в этом потоке. Ресурсы относятся к типу инструмента. Например, для `code_interpreter` средства требуется список идентификаторов файлов, а для `file_search` этого средства требуется список идентификаторов векторного хранилища.	Yes
└─ code_interpreter	object		No
└─ file_ids	array	Список идентификаторов файлов, доступных средству `code_interpreter` . С инструментом может быть не более 20 файлов.	No	[]
└─ file_search	object		No
└─ vector_store_ids	array	Хранилище векторов, присоединенное к этому потоку. К потоку может быть подключено не более 1 векторного хранилища.	No

объект Enum: ThreadObjectType

Value	Description
thread	Тип объекта потока, который всегда является `thread`

createThreadRequest

Name	Type	Description	Required	Default
messages	array	Список сообщений для запуска потока.	No
metadata	object	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.	No
tool_resources	object	Набор ресурсов, доступных средствам помощника в этом потоке. Ресурсы относятся к типу инструмента. Например, для `code_interpreter` средства требуется список идентификаторов файлов, а для `file_search` этого средства требуется список идентификаторов векторного хранилища.	No
└─ code_interpreter	object		No
└─ file_ids	array	Список идентификаторов файлов, доступных средству `code_interpreter` . С инструментом может быть не более 20 файлов.	No	[]
└─ file_search	object		No
└─ vector_store_ids	array	Хранилище векторов, присоединенное к этому потоку. К потоку может быть подключено не более 1 векторного хранилища.	No
└─ vector_stores	array	Вспомогательный объект для создания хранилища векторов с file_ids и присоединения его к этому потоку. К потоку может быть подключено не более 1 векторного хранилища.	No

modifyThreadRequest

Name	Type	Description	Required	Default
metadata	object	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.	No
tool_resources	object	Набор ресурсов, доступных средствам помощника в этом потоке. Ресурсы относятся к типу инструмента. Например, для `code_interpreter` средства требуется список идентификаторов файлов, а для `file_search` этого средства требуется список идентификаторов векторного хранилища.	No
└─ code_interpreter	object		No
└─ file_ids	array	Список идентификаторов файлов, доступных средству `code_interpreter` . С инструментом может быть не более 20 файлов.	No	[]
└─ file_search	object		No
└─ vector_store_ids	array	Хранилище векторов, присоединенное к этому потоку. К потоку может быть подключено не более 1 векторного хранилища.	No

deleteThreadResponse

Name	Type	Required
deleted	boolean	Yes
id	string	Yes
object	string	Yes

объект Enum: DeleteThreadResponseObjectState

Value	Description
thread.deleted	Состояние объекта ответа на поток удаления, которое является `thread.deleted`

listThreadsResponse

Name	Type	Required
data	array	Yes
first_id	string	Yes
has_more	boolean	Yes
last_id	string	Yes
object	string	Yes

messageObject

Представляет сообщение в потоках.

Name	Type	Description	Required
assistant_id	string	Если применимо, идентификатор помощника, создающего это сообщение.	Yes
attachments	array	Список файлов, присоединенных к сообщению, и инструменты, к которому они были добавлены.	Yes
completed_at	integer	Метка времени Unix (в секундах) для завершения сообщения.	Yes
content	array	Содержимое сообщения в массиве текста и(или) изображений.	Yes
created_at	integer	Метка времени Unix (в секундах) для момента создания сообщения.	Yes
id	string	Идентификатор, на который можно ссылаться в конечных точках API.	Yes
incomplete_at	integer	Метка времени Unix (в секундах) для момента, когда сообщение было отмечено как неполное.	Yes
incomplete_details	object	В неполном сообщении сведения о том, почему сообщение является неполным.	Yes
└─ reason	string	Причина, по которой сообщение является неполным.	No
metadata	object	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.	Yes
object	string	Тип объекта, который всегда `thread.message`является .	Yes
role	string	Сущность, создающая сообщение. Одно из `user` или `assistant`.	Yes
run_id	string	Если применимо, идентификатор выполнения, связанный с автором этого сообщения.	Yes
status	string	Состояние сообщения, которое может быть либо `in_progress`, `incomplete`либо `completed`.	Yes
thread_id	string	Идентификатор потока, к которому принадлежит это сообщение.	Yes

объект Enum: MessageObjectType

Value	Description
thread.message	Тип объекта сообщения, который является `thread.message`

Состояние перечисления: MessageObjectStatus

Value	Description
in_progress
incomplete
completed

перечисление роли: MessageObjectRole

Value	Description
user
assistant

messageDeltaObject

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

Name	Type	Description	Required
delta	object	Разностное значение, содержащее поля, измененные в сообщении.	Yes
└─ content	array	Содержимое сообщения в массиве текста и(или) изображений.	No
└─ role	string	Сущность, создающая сообщение. Одно из `user` или `assistant`.	No
id	string	Идентификатор сообщения, на которое можно ссылаться в конечных точках API.	Yes
object	string	Тип объекта, который всегда `thread.message.delta`является .	Yes

объект Enum: MessageDeltaObjectType

Value	Description
thread.message.delta

createMessageRequest

Name	Type	Description	Required
attachments	array	Список файлов, присоединенных к сообщению, и инструменты, к которому они должны быть добавлены.	No
content	string	Содержимое сообщения.	Yes
metadata	object	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.	No
role	string	Роль сущности, создающей сообщение. Допустимые значения: - `user`: указывает, что сообщение отправляется фактическим пользователем и должно использоваться в большинстве случаев для представления сообщений, созданных пользователем. - `assistant`: указывает, что сообщение создается помощником. Используйте это значение для вставки сообщений от помощника в беседу.	Yes

role Enum: CreateMessageRequestRole

Value	Description
user
assistant

modifyMessageRequest

Name	Type	Description	Required	Default
metadata	object	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.	No

deleteMessageResponse

Name	Type	Required
deleted	boolean	Yes
id	string	Yes
object	string	Yes

объект Enum: DeleteMessageResponseObject

Value	Description
thread.message.deleted	Состояние объекта ответа на удаление сообщения

listMessagesResponse

Name	Type	Required
data	array	Yes
first_id	string	Yes
has_more	boolean	Yes
last_id	string	Yes
object	string	Yes

messageContentImageFileObject

Ссылается на файл изображения в содержимом сообщения.

Name	Type	Description	Required
image_file	object		Yes
└─ file_id	string	Идентификатор файла изображения в содержимом сообщения.	No
type	string	Всегда `image_file`.	Yes

Тип Enum: MessageContentImageFileObjectType

Value	Description
image_file	Тип файла изображения содержимого сообщения

messageContentTextObject

Текстовое содержимое, которое входит в сообщение.

Name	Type	Description	Required
text	object		Yes
└─ annotations	array		No
└─ value	string	Данные, составляющие текст.	No
type	string	Всегда `text`.	Yes

тип Enum: messageContentTextObjectType

Value	Description
text	Тип текстового объекта содержимого сообщения

messageContentTextAnnotationsFileCitationObject

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

Name	Type	Description	Required
end_index	integer		Yes
file_citation	object		Yes
└─ file_id	string	Идентификатор конкретного файла, из из который находится ссылка.	No
start_index	integer		Yes
text	string	Текст в содержимом сообщения, который необходимо заменить.	Yes
type	string	Всегда `file_citation`.	Yes

Type Enum: FileCitationObjectType

Value	Description
file_citation	Тип объекта ссылки на файл

messageContentTextAnnotationsFilePathObject

URL-адрес файла, созданного при создании файла помощником, который использовал code_interpreter средство для создания файла.

Name	Type	Description	Required
end_index	integer		Yes
file_path	object		Yes
└─ file_id	string	Идентификатор созданного файла.	No
start_index	integer		Yes
text	string	Текст в содержимом сообщения, который необходимо заменить.	Yes
type	string	Всегда `file_path`.	Yes

тип Enum: FilePathObjectType

Value	Description
file_path	Тип объекта пути к файлу

messageDeltaContentImageFileObject

Ссылается на файл изображения в содержимом сообщения.

Name	Type	Description	Required
image_file	object		No
└─ file_id	string	Идентификатор файла изображения в содержимом сообщения.	No
index	integer	Индекс части содержимого в сообщении.	Yes
type	string	Всегда `image_file`.	Yes

Тип Enum: MessageDeltaContentImageFileObjectType

Value	Description
image_file

messageDeltaContentTextObject

Текстовое содержимое, которое входит в сообщение.

Name	Type	Description	Required
index	integer	Индекс части содержимого в сообщении.	Yes
text	object		No
└─ annotations	array		No
└─ value	string	Данные, составляющие текст.	No
type	string	Всегда `text`.	Yes

тип Enum: MessageDeltaContentTextObjectType

Value	Description
text

messageDeltaContentTextAnnotationsFileCitationObject

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

Name	Type	Description	Required
end_index	integer		No
file_citation	object		No
└─ file_id	string	Идентификатор конкретного файла, из из который находится ссылка.	No
└─ quote	string	Конкретная цитата в файле.	No
index	integer	Индекс заметки в части текстового содержимого.	Yes
start_index	integer		No
text	string	Текст в содержимом сообщения, который необходимо заменить.	No
type	string	Всегда `file_citation`.	Yes

тип Enum: MessageDeltaContentTextAnnotationsFileCitationObjectType

Value	Description
file_citation

messageDeltaContentTextAnnotationsFilePathObject

Name	Type	Description	Required
end_index	integer		No
file_path	object		No
└─ file_id	string	Идентификатор созданного файла.	No
index	integer	Индекс заметки в части текстового содержимого.	Yes
start_index	integer		No
text	string	Текст в содержимом сообщения, который необходимо заменить.	No
type	string	Всегда `file_path`.	Yes

тип Enum: MessageDeltaContentTextAnnotationsFilePathObjectType

Value	Description
file_path

runStepObject

Представляет шаг выполнения выполнения выполнения.

Name	Type	Description	Required
assistant_id	string	Идентификатор помощника, связанного с шагом выполнения.	Yes
cancelled_at	integer	Метка времени Unix (в секундах) для момента отмены шага выполнения.	Yes
completed_at	integer	Метка времени Unix (в секундах) для завершения шага выполнения.	Yes
created_at	integer	Метка времени Unix (в секундах) для момента создания шага выполнения.	Yes
expired_at	integer	Метка времени Unix (в секундах) для истечения срока действия выполнения. Шаг считается истекшим, если срок действия родительского запуска истек.	Yes
failed_at	integer	Метка времени Unix (в секундах) для момента сбоя шага выполнения.	Yes
id	string	Идентификатор шага выполнения, на который можно ссылаться в конечных точках API.	Yes
last_error	object	Последняя ошибка, связанная с этим шагом выполнения. `null` Если ошибок нет.	Yes
└─ code	string	Одно из `server_error` или `rate_limit_exceeded`.	No
└─ message	string	Описание ошибки, доступной для чтения человеком.	No
metadata	object	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.	Yes
object	string	Тип объекта, который всегда `assistant.run.step`является .	Yes
run_id	string	Идентификатор выполнения, на который выполняется этот шаг, является частью.	Yes
status	string	Состояние выполнения, которое может быть либо `in_progress`, либо `cancelledfailedcompletedexpired`.	Yes
step_details	runStepDetailsMessageCreationObject или runStepDetailsToolCallsObject	Сведения о шаге выполнения.	Yes
thread_id	string	Идентификатор выполняемых потоков.	Yes
type	string	Тип шага выполнения, который может быть либо `message_creationtool_calls`.	Yes

объект Enum: RunStepObjectType

Value	Description
assistant.run.step	Тип объекта, который всегда является `assistant.run.step`

Тип Enum: RunStepObjectType

Value	Description
message_creation	Шаг выполнения message_creation
tool_calls	Шаг выполнения tool_calls

состояние Перечисления: RunStepObjectStatus

Value	Description
in_progress	Состояние выполнения in_progress
cancelled	Состояние отмененного выполнения
failed	Состояние отмененного выполнения
completed	Состояние отмененного выполнения
expired	Состояние отмененного выполнения

runStepDeltaObject

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

Name	Type	Description	Required
delta	object	Разностное значение, содержащее поля, измененные на шаге выполнения.	Yes
└─ step_details	runStepDeltaStepDetailsMessageCreationObject или runStepDeltaStepDetailsToolCallsObject	Сведения о шаге выполнения.	No
id	string	Идентификатор шага выполнения, на который можно ссылаться в конечных точках API.	Yes
object	string	Тип объекта, который всегда `thread.run.step.delta`является .	Yes

объект Enum: RunStepDeltaObjectType

Value	Description
thread.run.step.delta

listRunStepsResponse

Name	Type	Required
data	array	Yes
first_id	string	Yes
has_more	boolean	Yes
last_id	string	Yes
object	string	Yes

runStepDetailsMessageCreationObject

Сведения о создании сообщения на шаге выполнения.

Name	Type	Description	Required
message_creation	object		Yes
└─ message_id	string	Идентификатор сообщения, созданного на этом шаге выполнения.	No
type	string	Всегда `message_creation`.	Yes

тип Enum: RunStepDetailsMessageCreationObjectType

Value	Description
message_creation

runStepDeltaStepDetailsMessageCreationObject

Сведения о создании сообщения на шаге выполнения.

Name	Type	Description	Required
message_creation	object		No
└─ message_id	string	Идентификатор сообщения, созданного на этом шаге выполнения.	No
type	string	Всегда `message_creation`.	Yes

type Enum: ШагЗапускаСдвигаШагПодробностиСозданиеСообщенияТипОбъекта

Value	Description
message_creation

runStepDetailsToolCallsObject

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

Name	Type	Description	Required	Default
tool_calls	array	Массив инструментов вызывает этап выполнения. Они могут быть связаны с одним из трех типов инструментов: `code_interpreterretrieval` или `function`.	Yes
type	string	Всегда `tool_calls`.	Yes

тип Enum: RunStepDetailsToolCallsObjectType

Value	Description
tool_calls

runStepDeltaStepDetailsToolCallsObject

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

Name	Type	Description	Required	Default
tool_calls	array	Массив инструментов вызывает этап выполнения. Они могут быть связаны с одним из трех типов инструментов: `code_interpreterfile_search` или `function`.	No
type	string	Всегда `tool_calls`.	Yes

тип Enum: RunStepDeltaStepDetailsToolCallsObjectType

Value	Description
tool_calls

runStepDetailsToolCallsCodeObject

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

Name	Type	Description	Required
code_interpreter	object	Определение вызова средства интерпретатора кода.	Yes
└─ input	string	Входные данные вызова средства интерпретатора кода.	No
└─ outputs	array	Выходные данные вызова средства интерпретатора кода. Интерпретатор кода может выводить один или несколько элементов, включая текст (`logs`) или изображения (`image`). Каждая из них представлена различным типом объекта.	No
id	string	Идентификатор вызова средства.	Yes
type	string	Тип вызова средства. Это всегда будет для `code_interpreter` этого типа вызова средства.	Yes

тип Enum: RunStepDetailsToolCallsCodeObjectType

Value	Description
code_interpreter

runStepDeltaStepDetailsToolCallsCodeObject

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

Name	Type	Description	Required
code_interpreter	object	Определение вызова средства интерпретатора кода.	No
└─ input	string	Входные данные вызова средства интерпретатора кода.	No
└─ outputs	array	Выходные данные вызова средства интерпретатора кода. Интерпретатор кода может выводить один или несколько элементов, включая текст (`logs`) или изображения (`image`). Каждая из них представлена различным типом объекта.	No
id	string	Идентификатор вызова средства.	No
index	integer	Индекс вызова средства в массиве вызовов средства.	Yes
type	string	Тип вызова средства. Это всегда будет для `code_interpreter` этого типа вызова средства.	Yes

тип Enum: RunStepDeltaStepDetailsToolCallsCodeObjectType

Value	Description
code_interpreter

runStepDetailsToolCallsCodeOutputLogsObject

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

Name	Type	Description	Required	Default
logs	string	Вывод текста из вызова средства интерпретатора кода.	Yes
type	string	Всегда `logs`.	Yes

Тип Enum: Объект RunStepDetailsToolCallsCodeOutputLogsObjectType

Value	Description
logs

runStepDeltaStepDetailsToolCallsCodeOutputLogsObject

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

Name	Type	Description	Required
index	integer	Индекс выходных данных в массиве выходных данных.	Yes
logs	string	Вывод текста из вызова средства интерпретатора кода.	No
type	string	Всегда `logs`.	Yes

type Enum: ЗапускШагДельтаШагДеталиВызовыИнструментовКодВыводЛогиТипОбъекта

Value	Description
logs

runStepDetailsToolCallsCodeOutputImageObject

Name	Type	Description	Required
image	object		Yes
└─ file_id	string	Идентификатор файла изображения.	No
type	string	Всегда `image`.	Yes

тип Enum: RunStepDetailsToolCallsCodeOutputImageObjectType

Value	Description
image

runStepDeltaStepDetailsToolCallsCodeOutputImageObject

Name	Type	Description	Required
image	object		No
└─ file_id	string	Идентификатор файла изображения.	No
index	integer	Индекс выходных данных в массиве выходных данных.	Yes
type	string	Всегда `image`.	Yes

тип Enum: RunStepDeltaStepDetailsToolCallsCodeOutputImageObject

Value	Description
image

runStepDetailsToolCallsFileSearchObject

Name	Type	Description	Required
file_search	object	В настоящее время это всегда будет пустым объектом.	Yes
└─ results	array	Результаты поиска файла.	No
id	string	Идентификатор объекта вызова средства.	Yes
type	string	Тип вызова средства. Это всегда будет для `file_search` этого типа вызова средства.	Yes

Тип Enum: RunStepDetailsToolCallsFileSearchObjectType

Value	Description
file_search

runStepDetailsToolCallsFileSearchResultObject

Результирующий экземпляр поиска файла.

Name	Type	Description	Required
content	array	Содержимое найденного результата. Содержимое включается только в том случае, если он запрашивается с помощью параметра запроса include.	No
file_id	string	Идентификатор файла, в который был найден результат.	Yes
file_name	string	Имя файла, в результате в который был найден результат.	Yes
score	number	Оценка результата. Все значения должны быть числом с плавающей запятой от 0 до 1.	Yes

runStepDeltaStepDetailsToolCallsFileSearchObject

Name	Type	Description	Required
file_search	object	В настоящее время это всегда будет пустым объектом.	Yes
id	string	Идентификатор объекта вызова средства.	No
index	integer	Индекс вызова средства в массиве вызовов средства.	Yes
type	string	Тип вызова средства. Это всегда будет для `retrieval` этого типа вызова средства.	Yes

тип Enum: RunStepDeltaStepDetailsToolCallsFileSearchObjectType

Value	Description
file_search

runStepDetailsToolCallsFunctionObject

Name	Type	Description	Required
function	object	Определение вызываемой функции.	Yes
└─ arguments	string	Аргументы, переданные функции.	No
└─ name	string	Имя функции.	No
└─ output	string	Выходные данные функции. Это будет, `null` если выходные данные еще не отправлены.	No
id	string	Идентификатор объекта вызова средства.	Yes
type	string	Тип вызова средства. Это всегда будет для `function` этого типа вызова средства.	Yes

тип Enum: RunStepDetailsToolCallsFunctionObjectType

Value	Description
function

runStepDeltaStepDetailsToolCallsFunctionObject

Name	Type	Description	Required
function	object	Определение вызываемой функции.	No
└─ arguments	string	Аргументы, переданные функции.	No
└─ name	string	Имя функции.	No
└─ output	string	Выходные данные функции. Это будет, `null` если выходные данные еще не отправлены.	No
id	string	Идентификатор объекта вызова средства.	No
index	integer	Индекс вызова средства в массиве вызовов средства.	Yes
type	string	Тип вызова средства. Это всегда будет для `function` этого типа вызова средства.	Yes

тип Enum: RunStepDetailsToolCallsFunctionObjectType

Value	Description
function

vectorStoreExpirationAfter

Политика истечения срока действия для хранилища векторов.

Name	Type	Description	Required	Default
anchor	string	Метка времени привязки, после которой применяется политика истечения срока действия. Поддерживаемые привязки: `last_active_at`.	Yes
days	integer	Количество дней после истечения срока действия привязки хранилища векторов.	Yes

перечисление привязки: VectorStoreExpirationAfterAnchor

Value	Description
last_active_at	Метка времени привязки, после которой применяется политика истечения срока действия.

vectorStoreObject

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

Name	Type	Description	Required
created_at	integer	Метка времени Unix (в секундах) для создания векторного хранилища.	Yes
expires_after	vectorStoreExpirationAfter	Политика истечения срока действия для хранилища векторов.	No
expires_at	integer	Метка времени Unix (в секундах) для истечения срока действия хранилища векторов.	No
file_counts	object		Yes
└─ cancelled	integer	Количество отмененных файлов.	No
└─ completed	integer	Количество успешно обработанных файлов.	No
└─ failed	integer	Количество файлов, которые не удалось обработать.	No
└─ in_progress	integer	Количество обрабатываемых файлов.	No
└─ total	integer	Общее количество файлов.	No
id	string	Идентификатор, на который можно ссылаться в конечных точках API.	Yes
last_active_at	integer	Метка времени Unix (в секундах) для последнего активного хранилища векторов.	Yes
metadata	object	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.	Yes
name	string	Имя векторного хранилища.	Yes
object	enum	Тип объекта, который всегда `vector_store`является . Возможные значения: `vector_store`	Yes
status	string	Состояние векторного хранилища, которое может быть либо `expired`, `in_progress`либо `completed`. Состояние указывает, что хранилище векторов `completed` готово для использования.	Yes
usage_bytes	integer	Общее количество байтов, используемых файлами в хранилище векторов.	Yes

Перечисление состояния: VectorStoreObjectStatus

Value	Description
expired
in_progress
completed

createVectorStoreRequest

Name	Type	Description	Required
chunking_strategy	autoChunkingStrategyRequestParam или staticChunkingStrategyRequestParam	Стратегия блокирования, используемая для блокирования файлов. Если этот параметр не задан, используйте стратегию `auto` . Применимо только в том случае, если `file_ids` он не пуст.	No
expires_after	vectorStoreExpirationAfter	Политика истечения срока действия для хранилища векторов.	No
file_ids	array	Список идентификаторов файлов, которые следует использовать векторным хранилищем. Полезно для таких средств, как `file_search` доступ к файлам.	No
metadata	object	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.	No
name	string	Имя векторного хранилища.	No

updateVectorStoreRequest

Name	Type	Description	Required
expires_after	vectorStoreExpirationAfter	Политика истечения срока действия для хранилища векторов.	No
metadata	object	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.	No
name	string	Имя векторного хранилища.	No

listVectorStoresResponse

Name	Type	Required
data	array	Yes
first_id	string	Yes
has_more	boolean	Yes
last_id	string	Yes
object	string	Yes

deleteVectorStoreResponse

Name	Type	Required
deleted	boolean	Yes
id	string	Yes
object	string	Yes

объект Enum: DeleteVectorStoreResponseObject

Value	Description
vector_store.deleted	Состояние объекта ответа хранилища векторов удаления

vectorStoreFileObject

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

Name	Type	Description	Required
chunking_strategy	autoChunkingStrategyRequestParam или staticChunkingStrategyRequestParam	Стратегия блокирования, используемая для блокирования файлов. Если этот параметр не задан, используйте стратегию `auto` . Применимо только в том случае, если `file_ids` он не пуст.	No
created_at	integer	Метка времени Unix (в секундах) для момента создания файла векторного хранилища.	Yes
id	string	Идентификатор, на который можно ссылаться в конечных точках API.	Yes
last_error	object	Последняя ошибка, связанная с этим файлом хранилища векторов. `null` Если ошибок нет.	Yes
└─ code	string	Одно или `server_errorinvalid_file` или `unsupported_file`.	No
└─ message	string	Описание ошибки, доступной для чтения человеком.	No
object	string	Тип объекта, который всегда `vector_store.file`является .	Yes
status	string	Состояние файла векторного хранилища, который может быть либо `in_progress`, `completedcancelled`либо `failed`. `completed` Состояние указывает, что файл векторного хранилища готов к использованию.	Yes
usage_bytes	integer	Общее использование векторного хранилища в байтах. Обратите внимание, что это может отличаться от исходного размера файла.	Yes
vector_store_id	string	Идентификатор векторного хранилища, к которому подключен файл.	Yes

объект Enum: VectorStoreFileObjectType

Value	Description
vector_store.file

Состояние перечисления: VectorStoreFileObjectStatus

Value	Description
in_progress
completed
cancelled
failed

otherChunkingStrategyResponseParam

Это возвращается, когда стратегия блокирования неизвестна. Как правило, это связано с тем, что файл был индексирован до chunking_strategy появления концепции в API.

Name	Type	Description	Required	Default
type	string	Всегда `other`.	Yes

тип Enum: OtherChunkingStrategyResponseParamType

Value	Description
other

staticChunkingStrategyResponseParam

Name	Type	Description	Required	Default
static	staticChunkingStrategy		Yes
type	string	Всегда `static`.	Yes

тип Enum: StaticChunkingStrategyResponseParamType

Value	Description
static

staticChunkingStrategy

Name	Type	Description	Required	Default
chunk_overlap_tokens	integer	Количество маркеров, перекрывающихся между блоками. Значение по умолчанию — `400`. Обратите внимание, что перекрытие не должно превышать половину `max_chunk_size_tokens`.	Yes
max_chunk_size_tokens	integer	Максимальное количество токенов в каждом блоке. Значение по умолчанию — `800`. Минимальное значение равно `100` , а максимальное — `4096`.	Yes

autoChunkingStrategyRequestParam

Стратегия по умолчанию. В настоящее время эта стратегия использует и max_chunk_size_tokens имеет значение 800chunk_overlap_tokens .400

Name	Type	Description	Required	Default
type	enum	Всегда `auto`. Возможные значения: `auto`	Yes

staticChunkingStrategyRequestParam

Name	Type	Description	Required	Default
static	staticChunkingStrategy		Yes
type	enum	Всегда `static`. Возможные значения: `static`	Yes

chunkingStrategyRequestParam

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

Этот компонент может быть одним из следующих компонентов:

autoChunkingStrategyRequestParam
staticChunkingStrategyRequestParam

createVectorStoreFileRequest

Name	Type	Description	Required	Default
chunking_strategy	chunkingStrategyRequestParam	Стратегия блокирования, используемая для блокирования файлов. Если этот параметр не задан, используйте стратегию `auto` .	No
file_id	string	Идентификатор файла, который должен использовать хранилище векторов. Полезно для таких средств, как `file_search` доступ к файлам.	Yes

listVectorStoreFilesResponse

Name	Type	Required
data	array	Yes
first_id	string	Yes
has_more	boolean	Yes
last_id	string	Yes
object	string	Yes

deleteVectorStoreFileResponse

Name	Type	Required
deleted	boolean	Yes
id	string	Yes
object	string	Yes

объект Enum: DeleteVectorStoreFileResponseObject

Value	Description
vector_store.file.deleted

vectorStoreFileBatchObject

Пакет файлов, присоединенных к хранилищу векторов.

Name	Type	Description	Required
created_at	integer	Метка времени Unix (в секундах) для создания пакета файлов векторного хранилища.	Yes
file_counts	object		Yes
└─ cancelled	integer	Количество отмененных файлов.	No
└─ completed	integer	Количество обработанных файлов.	No
└─ failed	integer	Количество файлов, которые не удалось обработать.	No
└─ in_progress	integer	Количество обрабатываемых файлов.	No
└─ total	integer	Общее количество файлов.	No
id	string	Идентификатор, на который можно ссылаться в конечных точках API.	Yes
object	string	Тип объекта, который всегда `vector_store.file_batch`является .	Yes
status	string	Состояние пакета векторного хранилища файлов, которые могут быть либо `in_progress`, `completedcancelled` либо `failed`.	Yes
vector_store_id	string	Идентификатор векторного хранилища, к которому подключен файл.	Yes

объект Enum: VectorStoreFileBatchObjectType

Value	Description
vector_store.files_batch

состояние перечисления: VectorStoreFileBatchObjectStatus

Value	Description
in_progress
completed
cancelled
failed

createVectorStoreFileBatchRequest

Name	Type	Description	Required	Default
chunking_strategy	chunkingStrategyRequestParam	Стратегия блокирования, используемая для блокирования файлов. Если этот параметр не задан, используйте стратегию `auto` .	No
file_ids	array	Список идентификаторов файлов, которые следует использовать векторном хранилище. Полезно для таких средств, как `file_search` доступ к файлам.	Yes

assistantStreamEvent

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

Каждое событие в потоке событий, отправляемых сервером event , имеет и data свойство:

event: thread.created
data: {"id": "thread_123", "object": "thread", ...}

Мы генерируем события при создании нового объекта, переходе к новому состоянию или потоковой передаче в части (разностные). Например, при создании thread.run.created нового запуска, thread.run.completed при завершении выполнения и т. д. Когда помощник выбирает создание сообщения во время выполнения, мы создадим thread.message.created eventсобытие, thread.message.in_progress много thread.message.delta событий и, наконец thread.message.completed , событие.

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

Этот компонент может быть одним из следующих компонентов:

threadStreamEvent
runStreamEvent
runStepStreamEvent
messageStreamEvent
errorEvent
doneEvent

threadStreamEvent

Этот компонент может быть одним из следующих компонентов:

thread.created

Происходит при создании нового потока.

Name	Type	Description	Required	Default
data	threadObject	Представляет поток, содержащий сообщения.	Yes
event	string		Yes

Data: threadObject

Перечисление событий: ThreadStreamEventEnum

Value	Description
thread.created	Событие создания потока

runStreamEvent

Этот компонент может быть одним из следующих компонентов:

thread.run.created

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

Name	Type	Description	Required	Default
data	runObject	Представляет выполнение в потоках.	Yes
event	string		Yes

Data: runObject

Перечисление событий: RunStreamEventCreated

Value	Description
thread.run.created

thread.run.queued

Происходит при перемещении queued выполнения в состояние.

Name	Type	Description	Required	Default
data	runObject	Представляет выполнение в потоках.	Yes
event	string		Yes

Data: runObject

Перечисление событий: RunStreamEventQueued

Value	Description
thread.run.queued

thread.run.in_progress

Происходит при перемещении in_progress выполнения в состояние.

Name	Type	Description	Required	Default
data	runObject	Представляет выполнение в потоках.	Yes
event	string		Yes

Data: runObject

Перечисление событий: RunStreamEventInProgress

Value	Description
thread.run.in_progress

thread.run.requires_action

Происходит при перемещении requires_action выполнения в состояние.

Name	Type	Description	Required	Default
data	runObject	Представляет выполнение в потоках.	Yes
event	string		Yes

Data: runObject

Перечисление события: RunStreamEventRequiresAction

Value	Description
thread.run.requires_action

thread.run.completed

Происходит при завершении выполнения.

Name	Type	Description	Required	Default
data	runObject	Представляет выполнение в потоках.	Yes
event	string		Yes

Data: runObject

Перечисление события: RunStreamEventCompleted

Value	Description
thread.run.completed

thread.run.failed

Происходит при сбое выполнения.

Name	Type	Description	Required	Default
data	runObject	Представляет выполнение в потоках.	Yes
event	string		Yes

Data: runObject

Перечисление событий: RunStreamEventFailed

Value	Description
thread.run.failed

thread.run.cancelling

Происходит при перемещении cancelling выполнения в состояние.

Name	Type	Description	Required	Default
data	runObject	Представляет выполнение в потоках.	Yes
event	string		Yes

Data: runObject

Перечисление события: RunStreamEventCancelling

Value	Description
thread.run.cancelling

thread.run.cancelled

Происходит при отмене выполнения.

Name	Type	Description	Required	Default
data	runObject	Представляет выполнение в потоках.	Yes
event	string		Yes

Data: runObject

Перечисление событий: RunStreamEventCancelled

Value	Description
thread.run.cancelled

thread.run.expired

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

Name	Type	Description	Required	Default
data	runObject	Представляет выполнение в потоках.	Yes
event	string		Yes

Data: runObject

Перечисление событий: RunStreamEventExpired

Value	Description
thread.run.expired

runStepStreamEvent

Этот компонент может быть одним из следующих компонентов:

thread.run.step.created

Происходит при создании шага выполнения.

Name	Type	Description	Required	Default
data	runStepObject	Представляет шаг выполнения выполнения выполнения.	Yes
event	string		Yes

Data: runStepObject

Перечисление событий: RunStepStreamEventCreated

Value	Description
thread.run.step.created

thread.run.step.in_progress

Происходит при переходе in_progress шага выполнения в состояние.

Name	Type	Description	Required	Default
data	runStepObject	Представляет шаг выполнения выполнения выполнения.	Yes
event	string		Yes

Data: runStepObject

Перечисление событий: RunStepStreamEventInProgress

Value	Description
thread.run.step.in_progress

thread.run.step.delta

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

Name	Type	Description	Required	Default
data	runStepDeltaObject	Представляет разностную смену шага выполнения, т. е. любые измененные поля на шаге выполнения во время потоковой передачи.	Yes
event	string		Yes

Data: runStepDeltaObject

Перечисление события: RunStepStreamEventDelta

Value	Description
thread.run.step.delta

thread.run.step.completed

Происходит при завершении шага выполнения.

Name	Type	Description	Required	Default
data	runStepObject	Представляет шаг выполнения выполнения выполнения.	Yes
event	string		Yes

Data: runStepObject

Перечисление событий: RunStepStreamEventCompleted

Value	Description
thread.run.step.completed

thread.run.step.failed

Происходит при сбое шага выполнения.

Name	Type	Description	Required	Default
data	runStepObject	Представляет шаг выполнения выполнения выполнения.	Yes
event	string		Yes

Data: runStepObject

Перечисление событий: RunStepStreamEventFailed

Value	Description
thread.run.step.failed

thread.run.step.cancelled

Происходит при отмене шага выполнения.

Name	Type	Description	Required	Default
data	runStepObject	Представляет шаг выполнения выполнения выполнения.	Yes
event	string		Yes

Data: runStepObject

Перечисление событий: RunStepStreamEventCancelled

Value	Description
thread.run.step.cancelled

thread.run.step.expired

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

Name	Type	Description	Required	Default
data	runStepObject	Представляет шаг выполнения выполнения выполнения.	Yes
event	string		Yes

Data: runStepObject

Перечисление событий: RunStepStreamEventExpired

Value	Description
thread.run.step.expired

messageStreamEvent

Этот компонент может быть одним из следующих компонентов:

thread.message.created

Происходит при создании сообщения.

Name	Type	Description	Required	Default
data	messageObject	Представляет сообщение в потоках.	Yes
event	string		Yes

Data: messageObject

Перечисление событий: MessageStreamEventCreated

Value	Description
thread.message.created

thread.message.in_progress

Происходит при перемещении in_progress сообщения в состояние.

Name	Type	Description	Required	Default
data	messageObject	Представляет сообщение в потоках.	Yes
event	string		Yes

Data: messageObject

Перечисление события: MessageStreamEventInProgress

Value	Description
thread.message.in_progress

thread.message.delta

Происходит при потоковой передаче частей сообщения.

Name	Type	Description	Required	Default
data	messageDeltaObject	Представляет разностную передачу сообщения, т. е. любые измененные поля в сообщении во время потоковой передачи.	Yes
event	string		Yes

Data: messageDeltaObject

Перечисление события: MessageStreamEventDelta

Value	Description
thread.message.delta

thread.message.completed

Происходит при завершении сообщения.

Name	Type	Description	Required	Default
data	messageObject	Представляет сообщение в потоках.	Yes
event	string		Yes

Data: messageObject

Перечисление событий: MessageStreamEventCompleted

Value	Description
thread.message.completed

thread.message.incomplete

Происходит, когда сообщение заканчивается до завершения.

Name	Type	Description	Required	Default
data	messageObject	Представляет сообщение в потоках.	Yes
event	string		Yes

Data: messageObject

Перечисление событий: MessageStreamEventIncomplete

Value	Description
thread.message.incomplete

Annotation

Этот компонент может быть одним из следующих компонентов:

FileCitation
UrlCitation
FilePath

Click

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

Name	Type	Description	Required
button	enum	Указывает, какая кнопка мыши была нажата во время нажатия кнопки. Один из `left`, , `rightwheel`или `backforward`. Возможные значения: `left`, , `rightwheelbackforward`	Yes
type	enum	Указывает тип события. Для действия щелчка это свойство всегда имеет значение `click`. Возможные значения: `click`	Yes
x	integer	Координата x, в которой произошло нажатие.	Yes
y	integer	Координата y, в которой произошло нажатие.	Yes

CodeInterpreterFileOutput

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

Name	Type	Description	Required	Default
files	array		Yes
type	enum	Тип выходных данных файла интерпретатора кода. Всегда `files`. Возможные значения: `files`	Yes

CodeInterpreterTextOutput

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

Name	Type	Description	Required	Default
logs	string	Журналы вызова средства интерпретатора кода.	Yes
type	enum	Тип вывода текста интерпретатора кода. Всегда `logs`. Возможные значения: `logs`	Yes

CodeInterpreterTool

Средство, выполняющее код.

Name	Type	Description	Required	Default
file_ids	array	Идентификаторы файлов для запуска кода.	Yes
type	enum	Тип средства интерпретатора кода. Всегда `code_interpreter`. Возможные значения: `code_interpreter`	Yes

CodeInterpreterToolCall

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

Name	Type	Description	Required
code	string	Выполняемый код.	Yes
id	string	Уникальный идентификатор вызова средства интерпретатора кода.	Yes
results	array	Результаты вызова средства интерпретатора кода.	Yes
status	enum	Состояние вызова средства интерпретатора кода. Возможные значения: `in_progress`, `interpretingcompleted`	Yes
type	enum	Тип вызова средства интерпретатора кода. Всегда `code_interpreter_call`. Возможные значения: `code_interpreter_call`	Yes

CodeInterpreterToolOutput

Этот компонент может быть одним из следующих компонентов:

CodeInterpreterTextOutput
CodeInterpreterFileOutput

ComparisonFilter

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

Name	Type	Description	Required
key	string	Ключ для сравнения со значением.	Yes
type	enum	Указывает оператор сравнения: `eq`, `ne`, `gt`, `gte`, `lt`. `lte` - `eq`:Равно - `ne`: не равно - `gt`:Больше - `gte`: больше или равно - `lt`:Менее - `lte`: меньше или равно Возможные значения: `eq`, , `negtgte`, `ltlte`	Yes
value	строка или число или логическое значение	Значение для сравнения с ключом атрибута; поддерживает типы строк, чисел или логических типов.	Yes

CompoundFilter

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

Name	Type	Description	Required	Default
filters	array	Массив фильтров для объединения. Элементы могут быть `ComparisonFilter` или `CompoundFilter`.	Yes
type	enum	Тип операции: `and` или `or`. Возможные значения: `and`, `or`	Yes

ComputerAction

Этот компонент может быть одним из следующих компонентов:

Click
DoubleClick
Drag
KeyPress
Move
Screenshot
Scroll
Type
Wait

ComputerScreenshotImage

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

Name	Type	Description	Required
file_id	string	Идентификатор отправленного файла, содержащего снимок экрана.	No
image_url	string	URL-адрес изображения снимка экрана.	No
type	enum	Указывает тип события. Для снимка экрана компьютера это свойство всегда имеет значение `computer_screenshot`. Возможные значения: `computer_screenshot`	Yes

ComputerTool

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

Name	Type	Description	Required
display_height	number	Высота дисплея компьютера.	Yes
display_width	number	Ширина дисплея компьютера.	Yes
environment	enum	Тип управляемой компьютерной среды. Возможные значения: `mac`, , `windowsubuntubrowser`	Yes
type	enum	Тип средства использования компьютера. Всегда `computer_use_preview`. Возможные значения: `computer-use-preview`	Yes

ComputerToolCall

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

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

ComputerToolCallOutput

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

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

ComputerToolCallOutputResource

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

ComputerToolCallSafetyCheck

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

Name	Type	Description	Required
code	string	Тип ожидающей проверки безопасности.	Yes
id	string	Идентификатор ожидающей проверки безопасности.	Yes
message	string	Сведения о ожидающей проверке безопасности.	Yes

Content

Много модальное содержимое входных и выходных данных.

Этот компонент может быть одним из следующих компонентов:

InputContent
OutputContent

Coordinate

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

Name	Type	Description	Required	Default
x	integer	The x-coordinate.	Yes
y	integer	The y-coordinate.	Yes

CreateModelResponseProperties

Name	Type	Description	Required	Default
metadata	Metadata	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате и запроса на объекты через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — это строки с максимальной длиной 512 символов.	No
model	string	Модель, используемая для создания ответов.	No
temperature	number	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным. Как правило, мы рекомендуем изменить это или `top_p` не оба.	No	1
top_p	number	Альтернатива выборке с температурой, называемой выборкой ядра, где модель рассматривает результаты маркеров с top_p массой вероятности. Таким образом, 0,1 означает, что рассматриваются только маркеры, состоящие из 10 лучших% массы вероятностей. Как правило, мы рекомендуем изменить это или `temperature` не оба.	No	1
user	string	Уникальный идентификатор, представляющий пользователя, который может помочь OpenAI отслеживать и обнаруживать злоупотребления. .	No

createResponse

Name	Type	Description	Required	Default
include	array	{"$ref": "#/components/schemas/includable/description"}	No
input	строка или массив	Текстовые, изображения или входные данные файлов в модель, используемые для создания ответа.	Yes
instructions	string	Вставляет сообщение системы (или разработчика) в качестве первого элемента в контексте модели. При использовании вместе с `previous_response_id`этим инструкции из предыдущего ответа не будут перенесены в следующий ответ. Это упрощает переключение системных сообщений (или разработчиков) в новых ответах.	No
max_output_tokens	integer	Верхняя граница для числа маркеров, которые можно создать для ответа, включая видимые выходные маркеры и маркеры причин.	No
parallel_tool_calls	boolean	Следует ли разрешить модели запускать вызовы инструментов параллельно.	No	True
previous_response_id	string	Уникальный идентификатор предыдущего ответа на модель. Используйте эту функцию для создания многоэтапных бесед.	No
reasoning	Reasoning	Параметры конфигурации для моделей причин.	No
store	boolean	Следует ли хранить созданный ответ модели для последующего получения через API.	No	True
stream	boolean	Если задано значение true, данные ответа модели будут передаваться клиенту по мере его создания с помощью событий, отправляемых сервером.	No	False
text	object	Параметры конфигурации для текстового ответа модели. Можно использовать обычный текст или структурированные данные JSON. Learn more: — текстовые входные и выходные данные — структурированные выходные данные	No
└─ format	TextResponseFormatConfiguration	Объект, указывающий формат, который должен выводить модель. Настройка `{ "type": "json_schema" }` включает структурированные выходные данные, что гарантирует соответствие модели предоставленной схеме JSON. Формат по умолчанию не имеет `{ "type": "text" }` дополнительных параметров. Не рекомендуется использовать для gpt-4o и более новых моделей: Параметр для `{ "type": "json_object" }` включения более старого режима JSON, который гарантирует, что сообщение, которое создает модель, является допустимым JSON. Использование `json_schema` предпочтительнее для моделей, поддерживающих его.	No
tool_choice	ToolChoiceOptions или ToolChoiceTypes или ToolChoiceFunction	Как модель должна выбрать средство (или инструменты), которое следует использовать при создании ответа. Просмотрите `tools` параметр, чтобы узнать, как указать, какие средства модель может вызывать.	No
tools	array	Массив инструментов, которые модель может вызывать при создании ответа. Можно указать, какое средство следует использовать, задав `tool_choice` параметр. Ниже приведены две категории инструментов, которые можно предоставить модели: - Встроенные средства	No
truncation	enum	Стратегия усечения, используемая для ответа модели. - `auto`: если контекст этого ответа и предыдущих превышает размер окна контекста модели, модель усетит ответ на соответствие окну контекста путем удаления входных элементов в середине беседы. - `disabled` (по умолчанию): если ответ модели превысит размер окна контекста для модели, запрос завершится ошибкой 400. Возможные значения: `auto`, `disabled`	No

DoubleClick

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

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

Drag

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

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

EasyInputMessage

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

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

FileCitation

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

Name	Type	Description	Required
file_id	string	Идентификатор файла.	Yes
index	integer	Индекс файла в списке файлов.	Yes
type	enum	Тип ссылки на файл. Всегда `file_citation`. Возможные значения: `file_citation`	Yes

FilePath

Путь к файлу.

Name	Type	Description	Required
file_id	string	Идентификатор файла.	Yes
index	integer	Индекс файла в списке файлов.	Yes
type	enum	Тип пути к файлу. Всегда `file_path`. Возможные значения: `file_path`	Yes

FileSearchRanker

Рангер, используемый для поиска файлов. Если не указано, будет использоваться auto рангер.

Property	Value
Description	Рангер, используемый для поиска файлов. Если не указано, будет использоваться `auto` рангер.
Type	string
Values	`auto` `default_2024_08_21`

FileSearchTool

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

Name	Type	Description	Required	Default
filters	ComparisonFilter или CompoundFilter	Фильтр для применения на основе атрибутов файла.	No
max_num_results	integer	Максимальное количество возвращаемых результатов. Это число должно быть от 1 до 50 включительно.	No
ranking_options	object	Параметры ранжирования для поиска.	No
└─ ranker	enum	Рангер, используемый для поиска файлов. Возможные значения: `auto`, `default-2024-11-15`	No
└─ score_threshold	number	Пороговое значение оценки для поиска файлов — от 0 до 1. Числа ближе к 1 будут пытаться вернуть только наиболее релевантные результаты, но могут возвращать меньше результатов.	No	0
type	enum	Тип средства поиска файлов. Всегда `file_search`. Возможные значения: `file_search`	Yes
vector_store_ids	array	Идентификаторы векторных хранилищ для поиска.	Yes

FileSearchToolCall

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

Name	Type	Description	Required
id	string	Уникальный идентификатор вызова средства поиска файлов.	Yes
queries	array	Запросы, используемые для поиска файлов.	Yes
results	array	Результаты вызова средства поиска файлов.	No
status	enum	Состояние вызова средства поиска файлов. Один из `in_progress`, `searchingincomplete` или `failed`, Возможные значения: `in_progress`, , `searchingcompletedincompletefailed`	Yes
type	enum	Тип вызова средства поиска файлов. Всегда `file_search_call`. Возможные значения: `file_search_call`	Yes

FunctionTool

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

Name	Type	Description	Required
description	string	Описание функции. Используется моделью для определения того, следует ли вызывать функцию.	No
name	string	Имя вызываемой функции.	Yes
parameters	object	Объект схемы JSON, описывающий параметры функции.	Yes
strict	boolean	Следует ли применять строгую проверку параметров. По умолчанию `true`.	Yes
type	enum	Тип средства функции. Всегда `function`. Возможные значения: `function`	Yes

FunctionToolCall

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

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

FunctionToolCallOutput

Выходные данные вызова средства функции.

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

FunctionToolCallOutputResource

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

includable

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

file_search_call.results: включите результаты поиска вызова средства поиска файлов.
message.input_image.image_url: включите URL-адреса изображения из входного сообщения.
computer_call_output.output.image_url: включите URL-адреса изображения из выходных данных вызова компьютера.

Property	Value
Description	Укажите дополнительные выходные данные для включения в ответ модели. В настоящее время поддерживаются следующие значения: - `file_search_call.results`: включите результаты поиска вызова средства поиска файлов. - `message.input_image.image_url`: включите URL-адреса изображения из входного сообщения. - `computer_call_output.output.image_url`: включите URL-адреса изображения из выходных данных вызова компьютера.
Type	string
Values	`file_search_call.results` `message.input_image.image_url` `computer_call_output.output.image_url`

InputAudio

Входные данные звука для модели.

Name	Type	Description	Required
data	string	Звуковые данные в кодировке Base64.	Yes
format	enum	Формат звуковых данных. В настоящее время поддерживаются `mp3` форматы и `wav`. Возможные значения: `mp3`, `wav`	Yes
type	enum	Тип входного элемента. Всегда `input_audio`. Возможные значения: `input_audio`	Yes

InputContent

Этот компонент может быть одним из следующих компонентов:

InputText
InputImage
InputFile

InputFile

Входные данные файла в модель.

Name	Type	Description	Required
file_data	string	Содержимое файла, отправляемого в модель.	No
file_id	string	Идентификатор файла, отправляемого в модель.	No
filename	string	Имя файла, отправляемого в модель.	No
type	enum	Тип входного элемента. Всегда `input_file`. Возможные значения: `input_file`	Yes

InputImage

Входные данные изображения для модели.

Name	Type	Description	Required
detail	enum	Уровень детализации изображения, отправляемого в модель. Один из `high`, `low`или `auto`. По умолчанию используется `auto`значение . Возможные значения: `high`, `lowauto`	Yes
file_id	string	Идентификатор файла, отправляемого в модель.	No
image_url	string	URL-адрес изображения, отправляемого в модель. Полный URL-адрес или изображение в кодировке Base64 в URL-адресе данных.	No
type	enum	Тип входного элемента. Всегда `input_image`. Возможные значения: `input_image`	Yes

InputItem

Этот компонент может быть одним из следующих компонентов:

EasyInputMessage
Item
ItemReference

InputMessage

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

InputMessageContentList

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

Для этого компонента не определены свойства.

InputMessageResource

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

InputText

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

Name	Type	Description	Required	Default
text	string	Текстовые входные данные модели.	Yes
type	enum	Тип входного элемента. Всегда `input_text`. Возможные значения: `input_text`	Yes

Item

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

Этот компонент может быть одним из следующих компонентов:

InputMessage
OutputMessage
FileSearchToolCall
ComputerToolCall
ComputerToolCallOutput
FunctionToolCall
FunctionToolCallOutput
ReasoningItem

ItemReference

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

Name	Type	Description	Required	Default
id	string	Идентификатор элемента для ссылки.	Yes
type	enum	Тип элемента для ссылки. Всегда `item_reference`. Возможные значения: `item_reference`	Yes

ItemResource

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

Этот компонент может быть одним из следующих компонентов:

InputMessageResource
OutputMessage
FileSearchToolCall
ComputerToolCall
ComputerToolCallOutputResource
FunctionToolCall
FunctionToolCallOutputResource

KeyPress

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

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

Metadata

Ключи — это строки с максимальной длиной 64 символов. Значения — это строки с максимальной длиной 512 символов.

Для этого компонента не определены свойства.

ModelResponseProperties

Name	Type	Description	Required	Default
metadata	Metadata	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате и запроса на объекты через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — это строки с максимальной длиной 512 символов.	No
model	string	Модель, используемая для создания ответов.	No
temperature	number	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным. Как правило, мы рекомендуем изменить это или `top_p` не оба.	No	1
top_p	number	Альтернатива выборке с температурой, называемой выборкой ядра, где модель рассматривает результаты маркеров с top_p массой вероятности. Таким образом, 0,1 означает, что рассматриваются только маркеры, состоящие из 10 лучших% массы вероятностей. Как правило, мы рекомендуем изменить это или `temperature` не оба.	No	1
user	string	Уникальный идентификатор, представляющий пользователя, который может помочь OpenAI отслеживать и обнаруживать злоупотребления. .	No

Move

Действие перемещения мыши.

Name	Type	Description	Required
type	enum	Указывает тип события. Для действия перемещения это свойство всегда имеет значение `move`. Возможные значения: `move`	Yes
x	integer	Координата x для перемещения.	Yes
y	integer	Координата y для перемещения.	Yes

OutputAudio

Выходные данные звука из модели.

Name	Type	Description	Required
data	string	Звуковые данные в кодировке Base64 из модели.	Yes
transcript	string	Расшифровка звуковых данных из модели.	Yes
type	enum	Тип выходного звука. Всегда `output_audio`. Возможные значения: `output_audio`	Yes

OutputContent

Этот компонент может быть одним из следующих компонентов:

OutputText
Refusal

OutputItem

Name	Type	Description	Required
action	ComputerAction		Yes
arguments	string	Строка JSON аргументов для передачи функции.	Yes
call_id	string	Идентификатор, используемый при реагировании на вызов средства с выходными данными.	Yes
content	array	Обоснование содержимого текста.	Yes
id	string	Уникальный идентификатор содержимого причины.	Yes
name	string	Имя выполняемой функции.	Yes
pending_safety_checks	array	Ожидающие проверки безопасности для вызова компьютера.	Yes
queries	array	Запросы, используемые для поиска файлов.	Yes
results	array	Результаты вызова средства поиска файлов.	No
role	enum	Роль выходного сообщения. Всегда `assistant`. Возможные значения: `assistant`	Yes
status	enum	Состояние элемента. Один из `in_progress`, `completed`или `incomplete`. Заполняется, когда элементы возвращаются через API. Возможные значения: `in_progress`, `completedincomplete`	Yes
type	enum	Тип объекта. Всегда `reasoning`. Возможные значения: `reasoning`	Yes

OutputMessage

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

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

OutputText

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

Name	Type	Description	Required
annotations	array	Заметки к выходным данным текста.	Yes
text	string	Текстовые выходные данные модели.	Yes
type	enum	Тип выходного текста. Всегда `output_text`. Возможные значения: `output_text`	Yes

RealtimeSessionCreateRequest

Конфигурация объекта сеанса в режиме реального времени.

Name	Type	Description	Required	Default
input_audio_format	enum	Формат входного звука. Параметры: `pcm16`, `g711_ulaw`или `g711_alaw`. Для `pcm16`, входной звук должен быть 16-разрядным PCM с частотой выборки 24 кбГц, одним каналом (моно) и байтовой последовательности байтов. Возможные значения: `pcm16`, `g711_ulawg711_alaw`	No
input_audio_noise_reduction	object	Настройка для уменьшения шума входного звука. Это можно установить, чтобы `null` отключить. Уменьшение шума фильтрует звук, добавленный в входной звуковой буфер перед отправкой в VAD и модель. Фильтрация звука может повысить точность обнаружения VAD и поворота (уменьшая ложные срабатывания) и производительность модели, повышая восприятие входного звука.	No
└─ type	enum	Тип уменьшения шума. `near_field` предназначен для микрофонов близкого разговора, таких как наушники, `far_field` предназначен для микрофонов с дальним полем, таких как ноутбук или микрофоны конференц-зала. Возможные значения: `near_field`, `far_field`	No
input_audio_transcription	object	Настройка входного транскрибирования звука, значение по умолчанию отключено и может быть задано, чтобы `null` отключить один раз. Транскрибирование входного звука не является собственным для модели, так как модель использует звук напрямую. Транскрибирование выполняется асинхронно через конечную точку транскрибирования и должно рассматриваться как руководство по входным звуковым содержимым, а не точно то, что слышала модель. Клиент может при необходимости задать язык и запрашивать транскрибирование, они предлагают дополнительные рекомендации для службы транскрибирования.	No
└─ language	string	Язык входного звука. Предоставление языка ввода в формате ISO-639-1 (например `en`, ) повышает точность и задержку.	No
└─ model	string	Модель, используемая для транскрибирования, текущие параметры: `gpt-4o-transcribe`, `gpt-4o-mini-transcribegpt-4o-mini-transcribe-2025-12-15`и `whisper-1`.	No
└─ prompt	string	Необязательный текст для руководства стилем модели или продолжением предыдущего сегмента звука. Для `whisper-1`этого запрос — это список ключевых слов. Для `gpt-4o-transcribe` моделей запрос — это бесплатная текстовая строка, например "ожидает слов, связанных с технологией".	No
instructions	string	Системные инструкции по умолчанию (т. е. системное сообщение) предопределены для вызовов модели. Это поле позволяет клиенту управлять моделью по нужным ответам. Модель может быть указана по содержимому ответа и формату (например, "быть чрезвычайно кратким", "действовать понятно", "вот примеры хороших ответов") и на звуковом поведении (например, "говорить быстро", "вводить эмоции в ваш голос", "смеяться часто"). Инструкции не гарантируются моделью, но они предоставляют рекомендации модели по требуемому поведению. Обратите внимание, что сервер задает инструкции по умолчанию, которые будут использоваться, если это поле не задано и отображается в событии в `session.created` начале сеанса.	No
max_response_output_tokens	целое число или строка	Максимальное количество выходных маркеров для одного ответа помощника, включающее вызовы инструментов. Укажите целое число от 1 до 4096, чтобы ограничить выходные маркеры или `inf` максимальные доступные маркеры для данной модели. По умолчанию используется `inf`значение .	No
modalities		Набор модальностей, с которыми может реагировать модель. Чтобы отключить звук, установите для этого значение ["text"].	No
model	string	Имя развертывания, используемого для этого сеанса.	No
output_audio_format	enum	Формат выходного звука. Параметры: `pcm16`, `g711_ulaw`или `g711_alaw`. Для `pcm16`выходных звуковых данных выборка составляет 24 кбГц. Возможные значения: `pcm16`, `g711_ulawg711_alaw`	No
temperature	number	Температура выборки для модели ограничена [0.6, 1.2]. Для звуковых моделей температура 0,8 настоятельно рекомендуется для оптимальной производительности.	No	0.8
tool_choice	string	Как модель выбирает инструменты. Параметры: `auto`, `nonerequired`или укажите функцию.	No	auto
tools	array	Средства (функции), доступные для модели.	No
turn_detection	object	Конфигурация для обнаружения поворота, VAD или семантического VAD сервера эфира. Это можно задать для `null` отключения, в этом случае клиент должен вручную активировать ответ модели. VaD сервера означает, что модель будет обнаруживать начало и конец речи на основе звукового тома и реагировать на речь пользователя. Семантическая vaD более расширена и использует модель обнаружения поворота (в сочетании с VAD) для семантической оценки того, закончил ли пользователь говорить, а затем динамически задает время ожидания на основе этой вероятности. Например, если пользователь отключает аудиозапись, `uhhm`модель будет оценить низкую вероятность завершения и ждать больше времени, пока пользователь продолжит говорить. Это может быть полезно для более естественных бесед, но может иметь более высокую задержку.	No
└─ create_response	boolean	Следует ли автоматически создавать ответ при возникновении события остановки VAD.	No	True
└─ eagerness	enum	Используется только для `semantic_vad` режима. Стремление модели реагировать. `low` будет ждать, пока пользователь продолжит говорить, `high` будет реагировать быстрее. `auto` значение по умолчанию и эквивалентно `medium`. Возможные значения: `low`, , `mediumhighauto`	No
└─ interrupt_response	boolean	Следует ли автоматически прерывать любой текущий ответ с выходными данными беседы по умолчанию (т. е. `conversationauto`при возникновении события запуска VAD).	No	True
└─ prefix_padding_ms	integer	Используется только для `server_vad` режима. Объем звука, который требуется включить до обнаруженной речи VAD (в миллисекундах). Значение по умолчанию — 300 мс.	No
└─ silence_duration_ms	integer	Используется только для `server_vad` режима. Длительность молчания для обнаружения остановки речи (в миллисекундах). Значение по умолчанию — 500 мс. С более короткими значениями модель будет реагировать быстрее, но может переходить на короткие паузы от пользователя.	No
└─ threshold	number	Используется только для `server_vad` режима. Порог активации для VAD (0.0 до 1.0), по умолчанию используется значение 0.5. Для активации модели требуется более высокий пороговый уровень звука и, таким образом, может улучшиться в шумных средах.	No
└─ type	enum	Тип обнаружения поворота. Возможные значения: `server_vad`, `semantic_vad`	No
voice	VoiceIdsShared		No

RealtimeSessionCreateResponse

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

Name	Type	Description	Required
client_secret	object	Временный ключ, возвращаемый API.	Yes
└─ expires_at	integer	Метка времени окончания срока действия маркера. В настоящее время срок действия всех маркеров истекает через одну минуту.	No
└─ value	string	Временный ключ, доступный в клиентских средах для проверки подлинности подключений к API Realtime. Используйте это в клиентских средах, а не стандартный маркер API, который следует использовать только на стороне сервера.	No
input_audio_format	string	Формат входного звука. Параметры: `pcm16`, `g711_ulaw`или `g711_alaw`.	No
input_audio_transcription	object	Настройка входного транскрибирования звука, значение по умолчанию отключено и может быть задано, чтобы `null` отключить один раз. Транскрибирование входного звука не является собственным для модели, так как модель использует звук напрямую. Транскрибирование выполняется асинхронно через Whisper и должно рассматриваться как грубое руководство, а не представление, понятное моделью.	No
└─ model	string	Модель, используемая для транскрибирования, `whisper-1` является единственной поддерживаемой в настоящее время моделью.	No
instructions	string	Системные инструкции по умолчанию (т. е. системное сообщение) предопределены для вызовов модели. Это поле позволяет клиенту управлять моделью по нужным ответам. Модель может быть указана по содержимому ответа и формату (например, "быть чрезвычайно кратким", "акт дружественным", "вот примеры хороших ответов") и по поведению звука (например, "говорить быстро", "вводить эмоции в ваш голос", "смеяться часто"). Инструкции не гарантируются моделью, но они предоставляют рекомендации модели по требуемому поведению. Обратите внимание, что сервер задает инструкции по умолчанию, которые будут использоваться, если это поле не задано и отображается в событии в `session.created` начале сеанса.	No
max_response_output_tokens	целое число или строка	Максимальное количество выходных маркеров для одного ответа помощника, включающее вызовы инструментов. Укажите целое число от 1 до 4096, чтобы ограничить выходные маркеры или `inf` максимальные доступные маркеры для данной модели. По умолчанию используется `inf`значение .	No
modalities		Набор модальностей, с которыми может реагировать модель. Чтобы отключить звук, установите для этого значение ["text"].	No
output_audio_format	string	Формат выходного звука. Параметры: `pcm16`, `g711_ulaw`или `g711_alaw`.	No
temperature	number	Температура выборки для модели ограничена [0.6, 1.2]. По умолчанию используется значение 0.8.	No
tool_choice	string	Как модель выбирает инструменты. Параметры: `auto`, `nonerequired`или укажите функцию.	No
tools	array	Средства (функции), доступные для модели.	No
turn_detection	object	Конфигурация для обнаружения поворотов. Можно задать для `null` отключения. VaD сервера означает, что модель будет обнаруживать начало и конец речи на основе звукового тома и реагировать на речь пользователя.	No
└─ prefix_padding_ms	integer	Объем звука, который требуется включить до обнаруженной речи VAD (в миллисекундах). Значение по умолчанию — 300 мс.	No
└─ silence_duration_ms	integer	Длительность молчания для обнаружения остановки речи (в миллисекундах). Значение по умолчанию — 500 мс. С более короткими значениями модель будет реагировать быстрее, но может переходить на короткие паузы от пользователя.	No
└─ threshold	number	Порог активации для VAD (0.0 до 1.0), по умолчанию используется значение 0.5. Для активации модели требуется более высокий пороговый уровень звука и, таким образом, может улучшиться в шумных средах.	No
└─ type	string	Тип обнаружения поворота поддерживается только `server_vad` сейчас.	No
voice	VoiceIdsShared		No

RealtimeTranscriptionSessionCreateRequest

Конфигурация объекта сеанса транскрибирования в реальном времени.

Name	Type	Description	Required	Default
include	array	Набор элементов для включения в транскрибирование. Текущие доступные элементы: - `item.input_audio_transcription.logprobs`	No
input_audio_format	enum	Формат входного звука. Параметры: `pcm16`, `g711_ulaw`или `g711_alaw`. Для `pcm16`, входной звук должен быть 16-разрядным PCM с частотой выборки 24 кбГц, одним каналом (моно) и байтовой последовательности байтов. Возможные значения: `pcm16`, `g711_ulawg711_alaw`	No
input_audio_noise_reduction	object	Настройка для уменьшения шума входного звука. Это можно установить, чтобы `null` отключить. Уменьшение шума фильтрует звук, добавленный в входной звуковой буфер перед отправкой в VAD и модель. Фильтрация звука может повысить точность обнаружения VAD и поворота (уменьшая ложные срабатывания) и производительность модели, повышая восприятие входного звука.	No
└─ type	enum	Тип уменьшения шума. `near_field` предназначен для микрофонов близкого разговора, таких как наушники, `far_field` предназначен для микрофонов с дальним полем, таких как ноутбук или микрофоны конференц-зала. Возможные значения: `near_field`, `far_field`	No
input_audio_transcription	object	Конфигурация входного транскрибирования звука. Клиент может при необходимости задать язык и запрашивать транскрибирование, они предлагают дополнительные рекомендации для службы транскрибирования.	No
└─ language	string	Язык входного звука. Предоставление языка ввода в формате ISO-639-1 (например `en`, ) повышает точность и задержку.	No
└─ model	enum	Модель, используемая для транскрибирования, текущие параметры: `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, `gpt-4o-mini-transcribe`и `gpt-4o-mini-transcribe-2025-12-15whisper-1`. Возможные значения: `gpt-4o-transcribe`, , `gpt-4o-transcribe-diarizegpt-4o-mini-transcribegpt-4o-mini-transcribe-2025-12-15whisper-1`	No
└─ prompt	string	Необязательный текст для руководства стилем модели или продолжением предыдущего сегмента звука. Для `whisper-1`этого запрос — это список ключевых слов. Для `gpt-4o-transcribe` моделей запрос — это бесплатная текстовая строка, например "ожидает слов, связанных с технологией".	No
modalities		Набор модальностей, с которыми может реагировать модель. Чтобы отключить звук, установите для этого значение ["text"].	No
turn_detection	object	Конфигурация для обнаружения поворота, VAD или семантического VAD сервера эфира. Это можно задать для `null` отключения, в этом случае клиент должен вручную активировать ответ модели. VaD сервера означает, что модель будет обнаруживать начало и конец речи на основе звукового тома и реагировать на речь пользователя. Семантическая vaD более расширена и использует модель обнаружения поворота (в сочетании с VAD) для семантической оценки того, закончил ли пользователь говорить, а затем динамически задает время ожидания на основе этой вероятности. Например, если пользователь отключает аудиозапись, `uhhm`модель будет оценить низкую вероятность завершения и ждать больше времени, пока пользователь продолжит говорить. Это может быть полезно для более естественных бесед, но может иметь более высокую задержку.	No
└─ create_response	boolean	Следует ли автоматически создавать ответ при возникновении события остановки VAD. Недоступно для сеансов транскрибирования.	No	True
└─ eagerness	enum	Используется только для `semantic_vad` режима. Стремление модели реагировать. `low` будет ждать, пока пользователь продолжит говорить, `high` будет реагировать быстрее. `auto` значение по умолчанию и эквивалентно `medium`. Возможные значения: `low`, , `mediumhighauto`	No
└─ interrupt_response	boolean	Следует ли автоматически прерывать любой текущий ответ с выходными данными беседы по умолчанию (т. е. `conversationauto`при возникновении события запуска VAD). Недоступно для сеансов транскрибирования.	No	True
└─ prefix_padding_ms	integer	Используется только для `server_vad` режима. Объем звука, который требуется включить до обнаруженной речи VAD (в миллисекундах). Значение по умолчанию — 300 мс.	No
└─ silence_duration_ms	integer	Используется только для `server_vad` режима. Длительность молчания для обнаружения остановки речи (в миллисекундах). Значение по умолчанию — 500 мс. С более короткими значениями модель будет реагировать быстрее, но может переходить на короткие паузы от пользователя.	No
└─ threshold	number	Используется только для `server_vad` режима. Порог активации для VAD (0.0 до 1.0), по умолчанию используется значение 0.5. Для активации модели требуется более высокий пороговый уровень звука и, таким образом, может улучшиться в шумных средах.	No
└─ type	enum	Тип обнаружения поворота. Возможные значения: `server_vad`, `semantic_vad`	No

RealtimeTranscriptionSessionCreateResponse

Новая конфигурация сеанса транскрибирования в реальном времени.

При создании сеанса на сервере с помощью REST API объект сеанса также содержит временный ключ. Срок жизни по умолчанию для ключей составляет одну минуту. Это свойство отсутствует при обновлении сеанса через API WebSocket.

Name	Type	Description	Required
client_secret	object	Временный ключ, возвращаемый API. Присутствует только при создании сеанса на сервере с помощью REST API.	Yes
└─ expires_at	integer	Метка времени окончания срока действия маркера. В настоящее время срок действия всех маркеров истекает через одну минуту.	No
└─ value	string	Временный ключ, доступный в клиентских средах для проверки подлинности подключений к API Realtime. Используйте это в клиентских средах, а не стандартный маркер API, который следует использовать только на стороне сервера.	No
input_audio_format	string	Формат входного звука. Параметры: `pcm16`, `g711_ulaw`или `g711_alaw`.	No
input_audio_transcription	object	Настройка модели транскрибирования.	No
└─ language	string	Язык входного звука. Предоставление языка ввода в формате ISO-639-1 (например `en`, ) повышает точность и задержку.	No
└─ model	enum	Модель, используемая для транскрибирования. Может быть`gpt-4o-transcribe`, , `gpt-4o-mini-transcribegpt-4o-mini-transcribe-2025-12-15`или `whisper-1`. Возможные значения: `gpt-4o-transcribe`, , `gpt-4o-mini-transcribegpt-4o-mini-transcribe-2025-12-15whisper-1`	No
└─ prompt	string	Необязательный текст для руководства стилем модели или продолжением предыдущего сегмента звука. Запрос должен соответствовать языку звука.	No
modalities		Набор модальностей, с которыми может реагировать модель. Чтобы отключить звук, установите для этого значение ["text"].	No
turn_detection	object	Конфигурация для обнаружения поворотов. Можно задать для `null` отключения. VaD сервера означает, что модель будет обнаруживать начало и конец речи на основе звукового тома и реагировать на речь пользователя.	No
└─ prefix_padding_ms	integer	Объем звука, который требуется включить до обнаруженной речи VAD (в миллисекундах). Значение по умолчанию — 300 мс.	No
└─ silence_duration_ms	integer	Длительность молчания для обнаружения остановки речи (в миллисекундах). Значение по умолчанию — 500 мс. С более короткими значениями модель будет реагировать быстрее, но может переходить на короткие паузы от пользователя.	No
└─ threshold	number	Порог активации для VAD (0.0 до 1.0), по умолчанию используется значение 0.5. Для активации модели требуется более высокий пороговый уровень звука и, таким образом, может улучшиться в шумных средах.	No
└─ type	string	Тип обнаружения поворота поддерживается только `server_vad` сейчас.	No

Reasoning

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

Name	Type	Description	Required	Default
effort	ReasoningEffort	Ограничивает усилия по рассуждениям моделей. В настоящее время поддерживаются `low`значения , `medium`и `high`. Сокращение усилий по поводу может привести к более быстрым откликам и меньшем количестве маркеров, используемых при рассуждениях в ответе.	Yes	medium
summary	enum	Сводка причин, выполняемых моделью. Это может быть полезно для отладки и понимания процесса рассуждений модели. Одно из `concise` или `detailed`. Возможные значения: `concise`, `detailed`	No

ReasoningItem

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

Name	Type	Description	Required
content	array	Обоснование содержимого текста.	Yes
id	string	Уникальный идентификатор содержимого причины.	Yes
status	enum	Состояние элемента. Один из `in_progress`, `completed`или `incomplete`. Заполняется, когда элементы возвращаются через API. Возможные значения: `in_progress`, `completedincomplete`	No
type	enum	Тип объекта. Всегда `reasoning`. Возможные значения: `reasoning`	Yes

Refusal

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

Name	Type	Description	Required	Default
refusal	string	Объяснение отказа от модели.	Yes
type	enum	Тип отказа. Всегда `refusal`. Возможные значения: `refusal`	Yes

response

Name	Type	Description	Required	Default
created_at	number	Метка времени Unix (в секундах) при создании этого ответа.	Yes
error	ResponseError	Объект ошибки, возвращаемый, когда модель не сможет создать ответ.	Yes
id	string	Уникальный идентификатор для этого ответа.	Yes
incomplete_details	object	Сведения о том, почему ответ неполный.	Yes
└─ reason	enum	Причина, по которой ответ является неполным. Возможные значения: `max_output_tokens`, `content_filter`	No
instructions	string	Вставляет сообщение системы (или разработчика) в качестве первого элемента в контексте модели. При использовании вместе с `previous_response_id`этим инструкции из предыдущего ответа не будут перенесены в следующий ответ. Это упрощает переключение системных сообщений (или разработчиков) в новых ответах.	Yes
max_output_tokens	integer	Верхняя граница для числа маркеров, которые можно создать для ответа, включая видимые выходные маркеры и состояние беседы.	No
metadata	Metadata	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате и запроса на объекты через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — это строки с максимальной длиной 512 символов.	Yes
model	string	Модель, используемая для создания ответов.	Yes
object	enum	Тип объекта этого ресурса — всегда задано `response`значение . Возможные значения: `response`	Yes
output	array	Массив элементов контента, созданных моделью. — длина и порядок элементов в массиве `output` зависит от ответа модели. — Вместо того, чтобы получить доступ к первому элементу в `output` массиве и предположить, что это `assistant` сообщение с содержимым, созданным моделью, можно использовать `output_text` свойство, в котором поддерживается в пакетах SDK.	Yes
output_text	string	Доступное только для пакета SDK свойство, содержащее агрегированные текстовые выходные данные всех `output_text` элементов в массиве `output` , если они присутствуют. Поддерживается в пакетах SDK для Python и JavaScript.	No
parallel_tool_calls	boolean	Следует ли разрешить модели запускать вызовы инструментов параллельно.	Yes	True
previous_response_id	string	Уникальный идентификатор предыдущего ответа на модель. Используйте эту функцию для создания многоэтапных бесед.	No
reasoning	Reasoning	Параметры конфигурации для моделей причин.	No
status	enum	Состояние создания ответа. Один из `completed`, `failedin_progress`или `incomplete`. Возможные значения: `completed`, , `failedin_progressincomplete`	No
temperature	number	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным. Как правило, мы рекомендуем изменить это или `top_p` не оба.	Yes	1
text	object	Параметры конфигурации для текстового ответа модели. Можно использовать обычный текст или структурированные данные JSON. Learn more: — текстовые входные и выходные данные — структурированные выходные данные	No
└─ format	TextResponseFormatConfiguration	Объект, указывающий формат, который должен выводить модель. Настройка `{ "type": "json_schema" }` включает структурированные выходные данные, что гарантирует соответствие модели предоставленной схеме JSON. Формат по умолчанию не имеет `{ "type": "text" }` дополнительных параметров. Не рекомендуется использовать для gpt-4o и более новых моделей: Параметр для `{ "type": "json_object" }` включения более старого режима JSON, который гарантирует, что сообщение, которое создает модель, является допустимым JSON. Использование `json_schema` предпочтительнее для моделей, поддерживающих его.	No
tool_choice	ToolChoiceOptions или ToolChoiceTypes или ToolChoiceFunction	Как модель должна выбрать средство (или инструменты), которое следует использовать при создании ответа. Просмотрите `tools` параметр, чтобы узнать, как указать, какие средства модель может вызывать.	Yes
tools	array	Массив инструментов, которые модель может вызывать при создании ответа. Можно указать, какое средство следует использовать, задав `tool_choice` параметр. Ниже приведены две категории инструментов, которые можно предоставить модели: - Встроенные средства	Yes
top_p	number	Альтернатива выборке с температурой, называемой выборкой ядра, где модель рассматривает результаты маркеров с top_p массой вероятности. Таким образом, 0,1 означает, что рассматриваются только маркеры, состоящие из 10 лучших% массы вероятностей. Как правило, мы рекомендуем изменить это или `temperature` не оба.	Yes	1
truncation	enum	Стратегия усечения, используемая для ответа модели. - `auto`: если контекст этого ответа и предыдущих превышает размер окна контекста модели, модель усетит ответ для соответствия окну контекстного окна путем удаления входных элементов в середине беседы. - `disabled` (по умолчанию): если ответ модели превысит размер окна контекста для модели, запрос завершится ошибкой 400. Возможные значения: `auto`, `disabled`	No
usage	ResponseUsage	Представляет сведения об использовании маркеров, включая входные маркеры, выходные маркеры, разбивку выходных маркеров и общие используемые маркеры.	No
user	string	Уникальный идентификатор, представляющий пользователя, который может помочь OpenAI отслеживать и обнаруживать злоупотребления. .	No

ResponseAudioDeltaEvent

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

Name	Type	Description	Required	Default
delta	string	Блок аудиобайта в кодировке Base64.	Yes
type	enum	Тип события. Всегда `response.audio.delta`. Возможные значения: `response.audio.delta`	Yes

ResponseAudioDoneEvent

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

Name	Type	Description	Required	Default
type	enum	Тип события. Всегда `response.audio.done`. Возможные значения: `response.audio.done`	Yes

ResponseAudioTranscriptDeltaEvent

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

Name	Type	Description	Required	Default
delta	string	Частичное расшифровка звукового ответа.	Yes
type	enum	Тип события. Всегда `response.audio.transcript.delta`. Возможные значения: `response.audio.transcript.delta`	Yes

ResponseAudioTranscriptDoneEvent

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

Name	Type	Description	Required	Default
type	enum	Тип события. Всегда `response.audio.transcript.done`. Возможные значения: `response.audio.transcript.done`	Yes

ResponseCodeInterpreterCallCodeDeltaEvent

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

Name	Type	Description	Required
delta	string	Фрагмент частичного кода, добавленный интерпретатором кода.	Yes
output_index	integer	Индекс выходного элемента, вызываемого интерпретатором кода.	Yes
type	enum	Тип события. Всегда `response.code_interpreter_call.code.delta`. Возможные значения: `response.code_interpreter_call.code.delta`	Yes

ResponseCodeInterpreterCallCodeDoneEvent

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

Name	Type	Description	Required
code	string	Окончательный фрагмент кода выводится интерпретатором кода.	Yes
output_index	integer	Индекс выходного элемента, вызываемого интерпретатором кода.	Yes
type	enum	Тип события. Всегда `response.code_interpreter_call.code.done`. Возможные значения: `response.code_interpreter_call.code.done`	Yes

ResponseCodeInterpreterCallCompletedEvent

Создается при завершении вызова интерпретатора кода.

Name	Type	Description	Required
code_interpreter_call	CodeInterpreterToolCall	Вызов средства для выполнения кода.	Yes
output_index	integer	Индекс выходного элемента, вызываемого интерпретатором кода.	Yes
type	enum	Тип события. Всегда `response.code_interpreter_call.completed`. Возможные значения: `response.code_interpreter_call.completed`	Yes

ResponseCodeInterpreterCallInProgressEvent

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

Name	Type	Description	Required
code_interpreter_call	CodeInterpreterToolCall	Вызов средства для выполнения кода.	Yes
output_index	integer	Индекс выходного элемента, вызываемого интерпретатором кода.	Yes
type	enum	Тип события. Всегда `response.code_interpreter_call.in_progress`. Возможные значения: `response.code_interpreter_call.in_progress`	Yes

ResponseCodeInterpreterCallInterpretingEvent

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

Name	Type	Description	Required
code_interpreter_call	CodeInterpreterToolCall	Вызов средства для выполнения кода.	Yes
output_index	integer	Индекс выходного элемента, вызываемого интерпретатором кода.	Yes
type	enum	Тип события. Всегда `response.code_interpreter_call.interpreting`. Возможные значения: `response.code_interpreter_call.interpreting`	Yes

ResponseCompletedEvent

Создается при завершении ответа модели.

Name	Type	Description	Required	Default
response	response		Yes
type	enum	Тип события. Всегда `response.completed`. Возможные значения: `response.completed`	Yes

ResponseContentPartAddedEvent

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

Name	Type	Description	Required
content_index	integer	Индекс добавленной части содержимого.	Yes
item_id	string	Идентификатор выходного элемента, к которому была добавлена часть содержимого.	Yes
output_index	integer	Индекс выходного элемента, к которому была добавлена часть содержимого.	Yes
part	OutputContent		Yes
type	enum	Тип события. Всегда `response.content_part.added`. Возможные значения: `response.content_part.added`	Yes

ResponseContentPartDoneEvent

Создается при завершении части содержимого.

Name	Type	Description	Required
content_index	integer	Индекс готовой части содержимого.	Yes
item_id	string	Идентификатор выходного элемента, к которому была добавлена часть содержимого.	Yes
output_index	integer	Индекс выходного элемента, к которому была добавлена часть содержимого.	Yes
part	OutputContent		Yes
type	enum	Тип события. Всегда `response.content_part.done`. Возможные значения: `response.content_part.done`	Yes

ResponseCreatedEvent

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

Name	Type	Description	Required	Default
response	response		Yes
type	enum	Тип события. Всегда `response.created`. Возможные значения: `response.created`	Yes

ResponseError

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

Name	Type	Description	Required	Default
code	ResponseErrorCode	Код ошибки для ответа.	Yes
message	string	Описание ошибки, доступной для чтения человеком.	Yes

ResponseErrorCode

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

Property	Value
Description	Код ошибки для ответа.
Type	string
Values	`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`

ResponseErrorEvent

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

Name	Type	Description	Required
code	string	Код ошибки.	Yes
message	string	Сообщение об ошибке.	Yes
param	string	Параметр ошибки.	Yes
type	enum	Тип события. Всегда `error`. Возможные значения: `error`	Yes

ResponseFailedEvent

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

Name	Type	Description	Required	Default
response	response		Yes
type	enum	Тип события. Всегда `response.failed`. Возможные значения: `response.failed`	Yes

ResponseFileSearchCallCompletedEvent

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

Name	Type	Description	Required
item_id	string	Идентификатор выходного элемента, инициируемого вызовом поиска файлов.	Yes
output_index	integer	Индекс выходного элемента, инициируемого вызовом поиска файлов.	Yes
type	enum	Тип события. Всегда `response.file_search_call.completed`. Возможные значения: `response.file_search_call.completed`	Yes

ResponseFileSearchCallInProgressEvent

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

Name	Type	Description	Required
item_id	string	Идентификатор выходного элемента, инициируемого вызовом поиска файлов.	Yes
output_index	integer	Индекс выходного элемента, инициируемого вызовом поиска файлов.	Yes
type	enum	Тип события. Всегда `response.file_search_call.in_progress`. Возможные значения: `response.file_search_call.in_progress`	Yes

ResponseFileSearchCallSearchingEvent

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

Name	Type	Description	Required
item_id	string	Идентификатор выходного элемента, инициируемого вызовом поиска файлов.	Yes
output_index	integer	Индекс выходного элемента, вызываемого вызовом поиска файлов.	Yes
type	enum	Тип события. Всегда `response.file_search_call.searching`. Возможные значения: `response.file_search_call.searching`	Yes

ResponseFunctionCallArgumentsDeltaEvent

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

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

ResponseFunctionCallArgumentsDoneEvent

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

Name	Type	Description	Required
arguments	string	Аргументы вызова функции.	Yes
item_id	string	Идентификатор элемента.	Yes
output_index	integer	Индекс выходного элемента.	Yes
type	enum	Возможные значения: `response.function_call_arguments.done`	Yes

ResponseInProgressEvent

Создается при выполнении ответа.

Name	Type	Description	Required	Default
response	response		Yes
type	enum	Тип события. Всегда `response.in_progress`. Возможные значения: `response.in_progress`	Yes

ResponseIncompleteEvent

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

Name	Type	Description	Required	Default
response	response		Yes
type	enum	Тип события. Всегда `response.incomplete`. Возможные значения: `response.incomplete`	Yes

responseItemList

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

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

ResponseModalities

Типы выходных данных, которые вы хотите создать модель. Большинство моделей могут создавать текст, который по умолчанию:

["text"]

["text", "audio"]

Для этого компонента не определены свойства.

ResponseModalitiesTextOnly

["text"]

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

Для этого компонента не определены свойства.

ResponseOutputItemAddedEvent

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

Name	Type	Description	Required
item	OutputItem		Yes
output_index	integer	Индекс добавленного выходного элемента.	Yes
type	enum	Тип события. Всегда `response.output_item.added`. Возможные значения: `response.output_item.added`	Yes

ResponseOutputItemDoneEvent

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

Name	Type	Description	Required
item	OutputItem		Yes
output_index	integer	Индекс выходного элемента, помеченного как выполненный.	Yes
type	enum	Тип события. Всегда `response.output_item.done`. Возможные значения: `response.output_item.done`	Yes

ResponseProperties

Name	Type	Description	Required
instructions	string	Вставляет сообщение системы (или разработчика) в качестве первого элемента в контексте модели. При использовании вместе с `previous_response_id`этим инструкции из предыдущего ответа не будут перенесены в следующий ответ. Это упрощает переключение системных сообщений (или разработчиков) в новых ответах.	No
max_output_tokens	integer	Верхняя граница для числа маркеров, которые можно создать для ответа, включая видимые выходные маркеры и состояние беседы.	No
previous_response_id	string	Уникальный идентификатор предыдущего ответа на модель. Используйте эту функцию для создания многоэтапных бесед.	No
reasoning	Reasoning	Параметры конфигурации для моделей причин.	No
text	object	Параметры конфигурации для текстового ответа модели. Можно использовать обычный текст или структурированные данные JSON. Learn more: — текстовые входные и выходные данные — структурированные выходные данные	No
└─ format	TextResponseFormatConfiguration	Объект, указывающий формат, который должен выводить модель. Настройка `{ "type": "json_schema" }` включает структурированные выходные данные, что гарантирует соответствие модели предоставленной схеме JSON. Формат по умолчанию не имеет `{ "type": "text" }` дополнительных параметров. Не рекомендуется использовать для gpt-4o и более новых моделей: Параметр для `{ "type": "json_object" }` включения более старого режима JSON, который гарантирует, что сообщение, которое создает модель, является допустимым JSON. Использование `json_schema` предпочтительнее для моделей, поддерживающих его.	No
tool_choice	ToolChoiceOptions или ToolChoiceTypes или ToolChoiceFunction	Как модель должна выбрать средство (или инструменты), которое следует использовать при создании ответа. Просмотрите `tools` параметр, чтобы узнать, как указать, какие средства модель может вызывать.	No
tools	array	Массив инструментов, которые модель может вызывать при создании ответа. Можно указать, какое средство следует использовать, задав `tool_choice` параметр. Ниже приведены две категории инструментов, которые можно предоставить модели: - Встроенные средства	No
truncation	enum	Стратегия усечения, используемая для ответа модели. - `auto`: если контекст этого ответа и предыдущих превышает размер окна контекста модели, модель усетит ответ для соответствия окну контекстного окна путем удаления входных элементов в середине беседы. - `disabled` (по умолчанию): если ответ модели превысит размер окна контекста для модели, запрос завершится ошибкой 400. Возможные значения: `auto`, `disabled`	No

ResponseRefusalDeltaEvent

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

Name	Type	Description	Required
content_index	integer	Индекс части содержимого, в которую добавляется текст отказа.	Yes
delta	string	Добавлен текст отказа.	Yes
item_id	string	Идентификатор выходного элемента, к которому добавляется текст отказа.	Yes
output_index	integer	Индекс выходного элемента, к которому добавляется текст отказа.	Yes
type	enum	Тип события. Всегда `response.refusal.delta`. Возможные значения: `response.refusal.delta`	Yes

ResponseRefusalDoneEvent

Создается при завершении текста отказа.

Name	Type	Description	Required
content_index	integer	Индекс части содержимого, завершаемой текстом отказа.	Yes
item_id	string	Идентификатор выходного элемента, завершаемого текстом отказа.	Yes
output_index	integer	Индекс выходного элемента, завершаемого текстом отказа.	Yes
refusal	string	Текст отказа, завершенный.	Yes
type	enum	Тип события. Всегда `response.refusal.done`. Возможные значения: `response.refusal.done`	Yes

responseStreamEvent

Name	Type	Description	Required
annotation	Annotation		Yes
annotation_index	integer	Индекс добавленной заметки.	Yes
arguments	string	Аргументы вызова функции.	Yes
code	string	Код ошибки.	Yes
code_interpreter_call	CodeInterpreterToolCall	Вызов средства для выполнения кода.	Yes
content_index	integer	Индекс части содержимого, завершенной текстовым содержимым.	Yes
delta	string	Добавлена разностная строка текста.	Yes
item	OutputItem	Выходной элемент, помеченный как выполненный.	Yes
item_id	string	Идентификатор выходного элемента, завершаемого текстовым содержимым.	Yes
message	string	Сообщение об ошибке.	Yes
output_index	integer	Индекс выходного элемента, завершаемого текстовым содержимым.	Yes
param	string	Параметр ошибки.	Yes
part	OutputContent	Выполненная часть содержимого.	Yes
refusal	string	Текст отказа, завершенный.	Yes
response	response	Ответ, который был неполным.	Yes
text	string	Текстовое содержимое, завершенное.	Yes
type	enum	Тип события. Всегда `response.output_text.done`. Возможные значения: `response.output_text.done`	Yes

ResponseTextAnnotationDeltaEvent

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

Name	Type	Description	Required
annotation	Annotation		Yes
annotation_index	integer	Индекс добавленной заметки.	Yes
content_index	integer	Индекс части содержимого, в которую добавлена текстовая заметка.	Yes
item_id	string	Идентификатор выходного элемента, к которому добавлена заметка текста.	Yes
output_index	integer	Индекс выходного элемента, в который был добавлен текстовый заметок.	Yes
type	enum	Тип события. Всегда `response.output_text.annotation.added`. Возможные значения: `response.output_text.annotation.added`	Yes

ResponseTextDeltaEvent

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

Name	Type	Description	Required
content_index	integer	Индекс части содержимого, в которую был добавлен разностный текст.	Yes
delta	string	Добавлена разностная строка текста.	Yes
item_id	string	Идентификатор выходного элемента, к которому был добавлен разностный текст.	Yes
output_index	integer	Индекс выходного элемента, к которому был добавлен разностный текст.	Yes
type	enum	Тип события. Всегда `response.output_text.delta`. Возможные значения: `response.output_text.delta`	Yes

ResponseTextDoneEvent

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

Name	Type	Description	Required
content_index	integer	Индекс части содержимого, завершенной текстовым содержимым.	Yes
item_id	string	Идентификатор выходного элемента, завершаемого текстовым содержимым.	Yes
output_index	integer	Индекс выходного элемента, завершаемого текстовым содержимым.	Yes
text	string	Текстовое содержимое, завершенное.	Yes
type	enum	Тип события. Всегда `response.output_text.done`. Возможные значения: `response.output_text.done`	Yes

ResponseUsage

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

Name	Type	Description	Required
input_tokens	integer	Количество входных маркеров.	Yes
output_tokens	integer	Количество выходных маркеров.	Yes
output_tokens_details	object	Подробный разбивка выходных маркеров.	Yes
└─ reasoning_tokens	integer	Количество маркеров причины.	No
total_tokens	integer	Общее количество используемых маркеров.	Yes

Screenshot

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

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

Scroll

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

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

StopConfiguration

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

Этот компонент может быть одним из следующих компонентов:

TextResponseFormatConfiguration

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

Настройка { "type": "json_schema" } включает структурированные выходные данные, которые обеспечивают соответствие модели предоставленной схеме JSON.

Формат по умолчанию не имеет { "type": "text" } дополнительных параметров.

Не рекомендуется использовать для gpt-4o и более новых моделей:

Параметр для { "type": "json_object" } включения более старого режима JSON, который гарантирует, что сообщение, которое создает модель, является допустимым JSON. Использование json_schema предпочтительнее для моделей, поддерживающих его.

Этот компонент может быть одним из следующих компонентов:

ResponseFormatText
TextResponseFormatJsonSchema
ResponseFormatJsonObject

TextResponseFormatJsonSchema

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

Name	Type	Description	Required	Default
description	string	Описание формата ответа, используемого моделью для определения того, как реагировать в формате.	No
name	string	Имя формата ответа. Должен быть a-z, A-Z, 0-9 или содержать символы подчеркивания и дефисы с максимальной длиной 64.	No
schema	ResponseFormatJsonSchemaSchema	Схема формата ответа, описанная как объект схемы JSON.	Yes
strict	boolean	Следует ли включить строгое соблюдение схемы при создании выходных данных. Если задано значение true, модель всегда будет соответствовать точной схеме, определенной `schema` в поле. При этом `strict`поддерживается `true` только подмножество схемы JSON.	No	False
type	enum	Тип определяемого формата ответа. Всегда `json_schema`. Возможные значения: `json_schema`	Yes

Tool

Этот компонент может быть одним из следующих компонентов:

FileSearchTool
FunctionTool
ComputerTool

ToolChoiceFunction

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

Name	Type	Description	Required	Default
name	string	Имя вызываемой функции.	Yes
type	enum	Для вызова функции всегда используется `function`тип. Возможные значения: `function`	Yes

ToolChoiceOptions

Определяет, какое средство (если таковое) вызывается моделью.

none означает, что модель не будет вызывать какое-либо средство и вместо этого создает сообщение.

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

required означает, что модель должна вызывать один или несколько инструментов.

Property	Value
Description	Определяет, какое средство (если таковое) вызывается моделью. `none` означает, что модель не будет вызывать какое-либо средство и вместо этого создает сообщение. `auto` означает, что модель может выбирать между созданием сообщения или вызовом одного или нескольких инструментов. `required` означает, что модель должна вызывать один или несколько инструментов.
Type	string
Values	`none` `auto` `required`

ToolChoiceTypes

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

Name	Type	Description	Required	Default
type	enum	Тип размещенного инструмента, который должна использовать модель. Допустимые значения: - `file_search` - `computer_use_preview` Возможные значения: `file_search`, `computer_use_preview`	Yes

Type

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

Name	Type	Description	Required	Default
text	string	Текст для типа.	Yes
type	enum	Указывает тип события. Для действия типа это свойство всегда имеет значение `type`. Возможные значения: `type`	Yes

UpdateVectorStoreFileAttributesRequest

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

UrlCitation

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

Name	Type	Description	Required
end_index	integer	Индекс последнего символа ссылки URL-адреса в сообщении.	Yes
start_index	integer	Индекс первого символа ссылки URL-адреса в сообщении.	Yes
title	string	Заголовок веб-ресурса.	Yes
type	enum	Тип ссылки URL-адреса. Всегда `url_citation`. Возможные значения: `url_citation`	Yes
url	string	URL-адрес веб-ресурса.	Yes

VectorStoreFileAttributes

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

Для этого компонента не определены свойства.

VectorStoreFileContentResponse

Представляет проанализированное содержимое файла векторного хранилища.

Name	Type	Description	Required
data	array	Проанализированное содержимое файла.	Yes
has_more	boolean	Указывает, есть ли дополнительные страницы содержимого для получения.	Yes
next_page	string	Маркер для следующей страницы, если таковой есть.	Yes
object	enum	Тип объекта, который всегда является `vector_store.file_content.page` Возможные значения: `vector_store.file_content.page`	Yes

VectorStoreSearchRequest

Name	Type	Description	Required	Default
filters	ComparisonFilter или CompoundFilter	Фильтр для применения на основе атрибутов файла.	No
max_num_results	integer	Максимальное количество возвращаемых результатов. Это число должно быть от 1 до 50 включительно.	No	10
query	строка или массив	Строка запроса для поиска	Yes
ranking_options	object	Параметры ранжирования для поиска.	No
└─ ranker	enum	Возможные значения: `auto`, `default-2024-11-15`	No
└─ score_threshold	number		No	0
rewrite_query	boolean	Следует ли переписать запрос естественного языка для векторного поиска.	No	False

VectorStoreSearchResultContentObject

Name	Type	Description	Required	Default
text	string	Текстовое содержимое, возвращенное из поиска.	Yes
type	enum	Тип содержимого. Возможные значения: `text`	Yes

VectorStoreSearchResultItem

Name	Type	Description	Required
attributes	VectorStoreFileAttributes	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате и запроса на объекты через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — это строки с максимальной длиной 512 символов, логических значений или чисел.	Yes
content	array	Фрагменты содержимого из файла.	Yes
file_id	string	Идентификатор файла векторного хранилища.	Yes
filename	string	Имя файла векторного хранилища.	Yes
score	number	Оценка сходства для результата.	Yes

VectorStoreSearchResultsPage

Name	Type	Description	Required
data	array	Список элементов результатов поиска.	Yes
has_more	boolean	Указывает, есть ли дополнительные результаты для получения.	Yes
next_page	string	Маркер для следующей страницы, если таковой есть.	Yes
object	enum	Тип объекта, который всегда является `vector_store.search_results.page` Возможные значения: `vector_store.search_results.page`	Yes
search_query	array		Yes

VoiceIdsShared

Для этого компонента не определены свойства.

Wait

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

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

ReasoningEffort

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

Property	Value
Description	Ограничивает усилия по рассуждениям моделей. В настоящее время поддерживаются `low`значения , `medium`и `high`. Сокращение усилий по поводу может привести к более быстрым откликам и меньшем количестве маркеров, используемых при рассуждениях в ответе.
Type	string
Default	medium
Values	`low` `medium` `high`

errorEvent

Возникает при возникновении ошибки. Это может произойти из-за ошибки внутреннего сервера или времени ожидания.

Name	Type	Description	Required	Default
data	error		Yes
event	string		Yes

перечисление события: ErrorEventEnum

Value	Description
error

doneEvent

Происходит, когда поток заканчивается.

Name	Type	Description	Required	Default
data	string		Yes
event	string		Yes

перечисление события: DoneEventEnum

Value	Description
done

перечисление данных: DoneEventDataEnum

Value	Description
[DONE]

Next steps

Узнайте о моделях и тонкой настройке с помощью REST API. Дополнительные сведения о базовых моделях, использующих Azure OpenAI.

Обратная связь

Были ли сведения на этой странице полезными?

Last updated on 2026-04-30