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

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

Спецификации API

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

• Контрольная плоскость
• Плоскость данных — разработка
• Плоскость данных — вывод

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

Это важно

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

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

Authentication

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

• Проверка подлинности ключа API. Для этого типа проверки подлинности все запросы API должны содержать Ключ API в заголовке HTTP api-key. В кратком руководстве показано, как выполнять вызовы с помощью этого типа проверки подлинности.

• Microsoft Entra ID аутентификации. Вы можете пройти проверку подлинности вызова API с помощью токена Microsoft Entra. Маркеры проверки подлинности включаются в запрос в заголовке Authorization. К маркеру следует добавить префикс Bearer, например Bearer YOUR_AUTH_TOKEN. Вы можете ознакомиться с нашим руководством по authenticating с помощью Microsoft Entra ID.

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

Управление версиями API служб осуществляется с использованием параметра запроса api-version. Все версии имеют структуру даты ГГГГ-ММ-ДД. Рассмотрим пример.

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

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

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

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

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

Тело запроса

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

Имя.	Тип	Description	Обязательно	По умолчанию
Лучшее из	целое число	best_of Создает завершения на стороне сервера и возвращает "лучший" (один с наибольшей вероятностью журнала на токен). Потоковую передачу результатов выполнить нельзя. При использовании с n, best_of управляет числом возможных завершений и n указывает, сколько вернуть – best_of должен быть больше n. Примечание. Так как этот параметр создает множество завершений, он может быстро использовать квоту маркера. Используйте тщательно и убедитесь, что у вас есть разумные параметры для max_tokens и stop.	нет	1
echo	булевый	Возвращает запрос в дополнение к завершению	нет	Неправда
штраф за частоту	число/номер	Число от -2.0 до 2.0. Положительные значения наказывают новые маркеры на основе их существующей частоты в тексте до сих пор, уменьшая вероятность повторения модели той же строки дословно.	нет	0
логит_биас	объект	Изменяет вероятность появления указанных маркеров в завершении. Принимает объект JSON, который сопоставляет маркеры (указанные идентификатором маркера в маркеризаторе GPT) с соответствующим значением предвзятости от -100 до 100. Математически предвзятость добавляется в журналы, созданные моделью перед выборкой. Точный эффект зависит от модели, но значения от –1 до 1 должны уменьшаться или увеличивать вероятность выбора; Значения, такие как -100 или 100, должны привести к запрету или эксклюзивному выбору соответствующего маркера. Например, можно передать {"50256": -100} маркер |endoftext|< для предотвращения >создания маркера |endoftext.	нет	None
logprobs	целое число	Включите вероятности журнала в logprobs наиболее вероятные выходные маркеры, а также выбранные маркеры. Например, если logprobs значение равно 5, API возвращает список из 5 наиболее вероятных маркеров. API всегда возвращает logprob взятый образец маркера, поэтому в ответе может быть до logprobs+1 элементов. Максимальное значение logprobs для 5.	нет	None
макс_токены	целое число	Максимальное количество маркеров, которые можно создать в завершении. Количество маркеров запроса плюс max_tokens не может превышать длину контекста модели.	нет	16
н	целое число	Количество завершений, создаваемых для каждого запроса. Примечание. Так как этот параметр создает множество завершений, он может быстро использовать квоту маркера. Используйте тщательно и убедитесь, что у вас есть разумные параметры для max_tokens и stop.	нет	1
штраф за присутствие	число/номер	Число от -2.0 до 2.0. Положительные значения наказывают новые маркеры в зависимости от того, появляются ли они в тексте до сих пор, что повышает вероятность того, что модель будет говорить о новых темах.	нет	0
prompt	строка или массив	Запрос для генерации завершений, кодируется в виде строки, массива строк, массива токенов или массива массивов токенов. Обратите внимание, что <|endoftext|> — это разделитель документов, который модель видит во время обучения, поэтому если запрос не указан, модель создает как будто с начала нового документа.	Да
seed	целое число	Если задано, наша система делает все возможное, чтобы проводила детерминированную выборку, так чтобы повторяющиеся запросы с одинаковыми seed и параметрами должны возвращать тот же результат. Детерминированность не гарантируется, и вы должны обратиться к параметру ответа system_fingerprint для мониторинга изменений на сервере.	нет
stop	строка или массив	До четырех последовательностей, в которых API перестает создавать дополнительные маркеры. Возвращенный текст не будет содержать последовательность остановки.	нет
поток	булевый	Потоковая передача частичного хода выполнения. Если задано, токены отправляются в виде серверных событий, предназначенных исключительно для передачи данных, по мере их появления, при этом поток завершается сообщением . Пример кода Python.	нет	Неправда
Суффикс	струна	Суффикс, который приходит после завершения вставленного текста. Этот параметр поддерживается только для gpt-3.5-turbo-instruct.	нет	None
Температура	число/номер	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным. Как правило, мы рекомендуем изменить это или top_p не оба.	нет	1
top_p	число/номер	Альтернативой выборке с температурой является так называемая выборка ядра, где модель рассматривает результаты маркеров с top_p всего массива значений вероятности. Таким образом, 0,1 означает, что учитываются только маркеры, входящие в верхние 10% массива значений вероятности. Как правило, мы рекомендуем изменить это или temperature не оба.	нет	1
Пользователь	струна	Уникальный идентификатор, представляющий конечного пользователя, который может помочь в мониторинге и обнаружении злоупотреблений.	нет

Responses

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

Описание: ОК

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

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

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

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

Примеры

Пример

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

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

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

Параметры URI

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

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

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

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

Тело запроса

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

Имя.	Тип	Description	Обязательно	По умолчанию
dimensions	целое число	Число измерений, в которых должны быть внедренные выходные данные. Поддерживается только в text-embedding-3 и более поздних моделях.	нет
формат_кодирования	струна	Формат, в который возвращаются встраиваемые элементы. Может быть либо float, либо base64. По умолчанию — float.	нет
ввод	строка или массив	Входной текст для внедрения, закодированный в виде строки или массива маркеров. Чтобы внедрить несколько входных данных в один запрос, передайте массив строк или массив массивов маркеров. Входные данные не должны превышать максимальные входные маркеры для модели (8 192 маркеров для text-embedding-ada-002), не может быть пустой строкой, и любой массив должен быть 2048 измерений или меньше.	Да
тип ввода	струна	тип входных данных для внедрения поиска для использования	нет
Пользователь	струна	Уникальный идентификатор, представляющий пользователя, который может помочь в мониторинге и обнаружении злоупотреблений.	нет

Responses

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

Описание: ОК

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

Примеры

Пример

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

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

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

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

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

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

Тело запроса

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

Имя.	Тип	Description	Обязательно	По умолчанию
audio	объект	Параметры выходных данных звука. Требуется при запросе на вывод звука с modalities: ["audio"].	нет
└─ Формат	перечисление	Указывает выходной формат звука. Должен быть одним из wav, mp3, flac, opus или pcm16. Возможные значения: wav, mp3, flac, opus, pcm16	нет
└️ голос	перечисление	Указывает тип голоса. Поддерживаемые голоса: alloy, echo, fable, onyxи novashimmer. Возможные значения: alloy, echo, fable, onyx, nova, shimmer	нет
источники данных	массив	Записи конфигурации для расширений чата OpenAI Azure, которые используют их. Эта дополнительная спецификация совместима только с Azure OpenAI.	нет
штраф за частоту	число/номер	Число от -2.0 до 2.0. Положительные значения наказывают новые маркеры на основе их существующей частоты в тексте до сих пор, уменьшая вероятность повторения модели той же строки дословно.	нет	0
вызов_функции	string или chatCompletionFunctionCallOption	Не рекомендуется использовать в пользу tool_choice. Определяет, какая функция (если есть) вызывается моделью. none означает, что модель не вызывает функцию и вместо этого создает сообщение. auto означает, что модель может выбирать между созданием сообщения или вызовом функции. Указание определенной функции путем {"name": "my_function"} принудительного вызова этой функции моделью. none значение по умолчанию, если функции отсутствуют. auto значение по умолчанию, если функции присутствуют.	нет
functions	массив	Не рекомендуется использовать в пользу tools. Список функций, для которые модель может создавать входные данные JSON.	нет
логит_биас	объект	Изменяет вероятность появления указанных маркеров в завершении. Принимает объект JSON, который сопоставляет маркеры (указанные идентификатором маркера в токенизаторе) со связанным значением предвзятости от -100 до 100. Математически предвзятость добавляется в журналы, созданные моделью перед выборкой. Точный эффект зависит от модели, но значения от –1 до 1 должны уменьшаться или увеличивать вероятность выбора; Значения, такие как -100 или 100, должны привести к запрету или эксклюзивному выбору соответствующего маркера.	нет	None
logprobs	булевый	Следует ли возвращать вероятности журналов выходных маркеров или нет. Если значение true, возвращает вероятности журнала каждого выходного маркера, возвращаемого в параметре contentmessage.	нет	Неправда
max_completion_tokens (максимальное количество токенов завершения)	целое число	Верхняя граница для числа маркеров, которые можно создать для завершения, включая видимые выходные маркеры и маркеры причин.	нет
макс_токены	целое число	Максимальное количество маркеров, которые можно создать в завершении чата. Общая длина входных маркеров и созданных маркеров ограничена длиной контекста модели.	нет
messages	массив	Список сообщений, составляющих беседу до сих пор. Пример кода Python.	Да
metadata	объект	Определяемые разработчиком теги и значения, используемые для фильтрации завершений на панели мониторинга хранимых завершений.	нет
Условия	ChatCompletionModalities	Типы выходных данных, которые нужно создать для этого запроса. Большинство моделей могут создавать текст, который по умолчанию: ["text"] Модель gpt-4o-audio-preview также может использоваться для создания звука. Чтобы запросить, что эта модель создает как текстовые, так и звуковые ответы, можно использовать: ["text", "audio"]	нет
н	целое число	Сколько вариантов завершения чата для каждого входного сообщения. Плата будет взиматься в зависимости от количества созданных токенов во всех предложенных вариантах. Имейте в виду n , чтобы 1 свести к минимуму затраты.	нет	1
вызовы инструмента в параллельном режиме	ParallelToolCalls	Следует ли включить параллельные вызовы функций во время использования средства.	нет	True
prediction	PredictionContent	Конфигурация прогнозируемых выходных данных, которая может значительно улучшить время отклика, когда большие части ответа модели известны заранее. Это наиболее распространено при повторном создании файла с незначительными изменениями в большинстве содержимого.	нет
штраф за присутствие	число/номер	Число от -2.0 до 2.0. Положительные значения наказывают новые маркеры в зависимости от того, появляются ли они в тексте до сих пор, что повышает вероятность того, что модель будет говорить о новых темах.	нет	0
усилия на рассуждение	перечисление	Только модели o1 Ограничивает усилия по рассуждениям моделей. В настоящее время поддерживаются lowзначения , mediumи high. Сокращение усилий по поводу может привести к более быстрым откликам и меньшем количестве маркеров, используемых при рассуждениях в ответе. Возможные значения: low, mediumhigh	нет
формат_ответа	ResponseFormatText или ResponseFormatJsonObject или ResponseFormatJsonSchema	Объект, указывающий формат, который должен выводить модель. Совместим с GPT-4oGPT-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 или беседа превысила максимальную длину контекста.	нет
seed	целое число	Эта функция доступна в бета-версии. Если задано, наша система делает все возможное, чтобы проводила детерминированную выборку, так чтобы повторяющиеся запросы с одинаковыми seed и параметрами должны возвращать тот же результат. Детерминированность не гарантируется, и вы должны обратиться к параметру ответа system_fingerprint для мониторинга изменений на сервере.	нет
stop	строка или массив	До 4 последовательностей, в которых API перестает генерировать дополнительные токены.	нет
store	булевый	Независимо от того, следует ли хранить выходные данные этого запроса на завершение чата для использования в наших продуктах для дистилляции или оценки модели.	нет
поток	булевый	Если задано, разностные сообщения отправляются, например в ChatGPT. Токены отправляются только как события, отправляемые сервером по мере их поступления, при этом поток завершается сообщением data: [DONE]. Пример кода Python.	нет	Неправда
stream_options	chatCompletionStreamOptions	Параметры потокового ответа. Этот параметр устанавливается только при установке stream: true.	нет	None
Температура	число/номер	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным. Как правило, мы рекомендуем изменить это или top_p не оба.	нет	1
выбор инструмента	chatCompletionToolChoiceOption	Определяет, какое средство (если таковое) вызывается моделью. none означает, что модель не вызывает никаких инструментов и вместо этого создает сообщение. auto означает, что модель может выбирать между созданием сообщения или вызовом одного или нескольких инструментов. required означает, что модель должна вызывать один или несколько инструментов. Указание определенного средства с помощью {"type": "function", "function": {"name": "my_function"}} принудительного вызова этого средства моделью. none значение по умолчанию, если средства отсутствуют. auto значение по умолчанию, если существуют средства.	нет
инструменты	массив	Список инструментов, которые может вызывать модель. В настоящее время в качестве инструмента поддерживаются только функции. Используйте это для предоставления списка функций, для которые модель может создавать входные данные JSON. Поддерживаются не более 128 функций.	нет
top_logprobs	целое число	Целое число от 0 до 20, указывающее число наиболее вероятных маркеров, возвращаемых по каждой позиции маркера, каждый из которых имеет связанную вероятность журнала. logprobs Необходимо задать значение true , если этот параметр используется.	нет
top_p	число/номер	Альтернативой выборке с температурой является так называемая выборка ядра, где модель рассматривает результаты маркеров с top_p всего массива значений вероятности. Таким образом, 0,1 означает, что учитываются только маркеры, входящие в верхние 10% массива значений вероятности. Как правило, мы рекомендуем изменить это или temperature не оба.	нет	1
Пользователь	струна	Уникальный идентификатор, представляющий конечного пользователя, который может помочь в мониторинге и обнаружении злоупотреблений.	нет
user_security_context	userSecurityContext	Контекст безопасности пользователей содержит несколько параметров, описывающих само приложение ИИ, и конечный пользователь, взаимодействующий с приложением ИИ. Эти поля помогают группам по операциям безопасности исследовать и устранять инциденты безопасности, предоставляя комплексный подход к защите приложений ИИ. Learn more о защите приложений ИИ с помощью Microsoft Defender for Cloud.	нет

Responses

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

Описание: ОК

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

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

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

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

Примеры

Пример

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

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
    }
  }
}

Пример

Создает завершение на основе данных поиска 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
    }
  }
}

Пример

Создает завершение на основе векторных данных 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
    }
  }
}

Пример

Создает завершение на основе данных вектора поиска 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
    }
  }
}

Пример

Создает завершение для предоставленного 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
    }
  }
}

Пример

Создает завершение для предоставленной базы данных 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
    }
  }
}

Пример

Создает завершение для предоставленного 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
    }
  }
}

Пример

Создает завершение для предоставленного ресурса 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

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

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

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

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

Тело запроса

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

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

Responses

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

Описание: ОК

Тип содержимого	Тип	Описание
application/json	объект
текст/без форматирования	струна	Транскрибированные тексты в выходном формате (когда response_format был одним из textили vttsrt).

Примеры

Пример

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

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

Пример

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

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

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

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

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

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

Тело запроса

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

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

Responses

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

Описание: ОК

Тип содержимого	Тип	Описание
application/json	объект
текст/без форматирования	струна	Транскрибированный текст в выходном формате (когда response_format был одним из форматов text, vtt или srt).

Примеры

Пример

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

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

Пример

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

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

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

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

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

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

Тело запроса

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

Имя.	Тип	Description	Обязательно	По умолчанию
ввод	струна	Текст для синтеза звука. Максимальная длина — 4096 символов.	Да
формат_ответа	перечисление	Формат синтеза звука в. Возможные значения: mp3, opus, aac, flac, wav, pcm	нет
speed	число/номер	Скорость синтезированного звука. Выберите значение из 0.254.0. 1.0 — это значение по умолчанию.	нет	1.0
голос	перечисление	Голос, используемый для синтеза речи. Возможные значения: alloy, echo, fable, onyx, nova, shimmer	Да

Responses

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

Описание: ОК

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

Примеры

Пример

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

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

Создает партию изображений из текстового описания на заданной модели серии DALL-E или gpt-image-1.

Параметры URI

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

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

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

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

Тело запроса

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

Имя.	Тип	Description	Обязательно	По умолчанию
фон	imageBackground	Позволяет задать прозрачность фона созданных изображений. Этот параметр поддерживается только для моделей серии gpt-image-1.	нет	авто
н	целое число	Количество генерируемых изображений. Для dall-e-3 поддерживается только n=1.	нет	1
сжатие вывода	целое число	Уровень сжатия (0–100%) для созданных образов. Этот параметр поддерживается только для моделей серии gpt-image-1 с форматом выходных данных JPEG.	нет	100
формат_выходных_данных	imagesOutputFormat	Формат файла, в котором возвращаются созданные изображения. Поддерживается только для моделей серии gpt-image-1.	нет	png
prompt	струна	Текстовое описание требуемых изображений. Максимальная длина — 32000 символов для серии gpt-image-1 и 4000 символов для dall-e-3	Да
частичные_изображения	целое число	Количество генерируемых частичных образов. Этот параметр используется для потоковых ответов, возвращающих частичные изображения. Значение должно быть от 0 до 3. Если задано значение 0, ответ будет одним изображением, отправленным в одном событии потоковой передачи. Обратите внимание, что окончательное изображение может быть отправлено до создания полного количества частичных образов, если полный образ создается быстрее.	0
поток	булевый	Измените изображение в режиме потоковой передачи.	нет	false
качество	imageQuality	Качество создаваемого изображения.	нет	авто
формат_ответа	imagesResponseFormat	Формат, в котором возвращаются созданные изображения. Этот параметр не поддерживается для gpt-image-1моделей серии, которые всегда возвращают образы в кодировке Base64. Возможные значения: url, b64_json.	нет	URL-адрес
size	imageSize	Размер созданных изображений.	нет	авто
стиль	imageStyle	Стиль созданных изображений. Поддерживается только для dall-e-3.	нет	vivid
Пользователь	струна	Уникальный идентификатор, представляющий конечного пользователя, который может помочь в мониторинге и обнаружении злоупотреблений.	нет

Responses

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

Описание: ОК

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

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

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

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

Примеры

Пример

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

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

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

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

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

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

Тело запроса

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

Имя.	Тип	Description	Обязательно	По умолчанию
image	строка или массив	Изображения для редактирования. Должен быть поддерживаемым файлом изображения или массивом изображений. Каждое изображение должно быть png или jpg-файл менее 50 МБ.	Да
Входная точность	струна	Контролируйте усилия модели для соответствия стилю и особенностям, в частности, чертам лица, на входных изображениях. Этот параметр поддерживается только для моделей серии gpt-image-1. Поддерживает high и low.	нет	low.
mask	струна	Дополнительное изображение с областями полной прозрачности (например, где альфа-канал равен нулю) указывает, где следует отредактировать изображение. Если есть несколько изображений, маска будет применена к первому изображению. Должен быть допустимым PNG-файлом, менее 4 МБ и иметь те же размеры, что и изображение.	нет
н	целое число	Количество генерируемых изображений. Должно быть от 1 до 10.	нет	1
prompt	струна	Текстовое описание требуемых изображений. Максимальная длина — 32000 символов.	Да
качество	imageQuality	Качество создаваемого изображения.	нет	авто
частичные_изображения	Количество генерируемых частичных образов. Этот параметр используется для потоковых ответов, возвращающих частичные изображения. Значение должно быть от 0 до 3. Если задано значение 0, ответ будет одним изображением, отправленным в одном событии потоковой передачи. Обратите внимание, что окончательное изображение может быть отправлено до создания полного количества частичных образов, если полный образ создается быстрее.
поток	булевый	Измените изображение в режиме потоковой передачи.	нет	false
формат_ответа	imagesResponseFormat	Формат, в котором возвращаются созданные изображения.	нет	URL-адрес
size	imageSize	Размер созданных изображений.	нет	авто
Пользователь	струна	Уникальный идентификатор, представляющий конечного пользователя, который может помочь в мониторинге и обнаружении злоупотреблений.	нет

Responses

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

Описание: ОК

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

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

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

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

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

Замечание

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

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

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

Параметры URI

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

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

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

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

Responses

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

Описание: ОК

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

Примеры

Пример

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

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

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

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

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

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

Тело запроса

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

Имя.	Тип	Description	Обязательно	По умолчанию
описание	струна	Описание помощника. Максимальная длина — 512 символов.	нет
instructions	струна	Системные инструкции, которые использует помощник. Максимальная длина — 256 000 символов.	нет
metadata	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.	нет
модель	струна		Да
имя	струна	Имя помощника. Максимальная длина — 256 символов.	нет
формат_ответа	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 или беседа превысила максимальную длину контекста.	нет
Температура	число/номер	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным.	нет	1
tool_resources	объект	Набор ресурсов, используемых средствами помощника. Ресурсы относятся к типу инструмента. Например, для code_interpreter средства требуется список идентификаторов файлов, а для file_search этого средства требуется список идентификаторов векторного хранилища.	нет
└─ интерпретатор_кода	объект		нет
└ file_ids	массив	Список идентификаторов файлов, доступных средству code_interpreter . С инструментом может быть не более 20 файлов.	нет	[]
└file_search	объект		нет
└️ vector_store_ids	массив	Хранилище векторов, присоединенное к этому помощнику. К помощнику может быть подключено не более 1 векторного хранилища.	нет
└️ vector_stores	массив	Помощник по созданию векторного хранилища с file_ids и присоединению его к этому помощнику. К помощнику может быть подключено не более 1 векторного хранилища.	нет
инструменты	массив	Список инструментов, включенных помощником. На помощника может быть не более 128 инструментов. Средства могут быть типами code_interpreter, retrievalили function.	нет	[]
top_p	число/номер	Альтернативой выборке с температурой является так называемая выборка ядра, где модель рассматривает результаты маркеров с top_p всего массива значений вероятности. Таким образом, 0,1 означает, что учитываются только маркеры, входящие в верхние 10% массива значений вероятности. Как правило, мы рекомендуем изменить либо это значение, либо температуру, но не оба.	нет	1

Responses

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

Описание: ОК

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

Примеры

Пример

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

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

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

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

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

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

Responses

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

Описание: ОК

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

Примеры

Пример

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

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

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

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

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

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

Тело запроса

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

Имя.	Тип	Description	Обязательно	По умолчанию
описание	струна	Описание помощника. Максимальная длина — 512 символов.	нет
instructions	струна	Системные инструкции, которые использует помощник. Максимальная длина — 32768 символов.	нет
metadata	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.	нет
модель	струна		нет
имя	струна	Имя помощника. Максимальная длина — 256 символов.	нет
формат_ответа	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 или беседа превысила максимальную длину контекста.	нет
Температура	число/номер	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным.	нет	1
tool_resources	объект	Набор ресурсов, используемых средствами помощника. Ресурсы относятся к типу инструмента. Например, для code_interpreter средства требуется список идентификаторов файлов, а для file_search этого средства требуется список идентификаторов векторного хранилища.	нет
└─ интерпретатор_кода	объект		нет
└ file_ids	массив	Переопределяет список идентификаторов файлов, доступных средству code_interpreter . С инструментом может быть не более 20 файлов.	нет	[]
└file_search	объект		нет
└️ vector_store_ids	массив	Переопределяет хранилище векторов, подключенное к этому помощнику. К помощнику может быть подключено не более 1 векторного хранилища.	нет
инструменты	массив	Список инструментов, включенных помощником. На помощника может быть не более 128 инструментов. Средства могут быть типами code_interpreter, retrievalили function.	нет	[]
top_p	число/номер	Альтернативой выборке с температурой является так называемая выборка ядра, где модель рассматривает результаты маркеров с top_p всего массива значений вероятности. Таким образом, 0,1 означает, что учитываются только маркеры, входящие в верхние 10% массива значений вероятности. Как правило, мы рекомендуем изменить либо это значение, либо температуру, но не оба.	нет	1

Responses

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

Описание: ОК

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

Примеры

Пример

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

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

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

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

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

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

Responses

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

Описание: ОК

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

Примеры

Пример

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

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

Замечание

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

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

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

Параметры URI

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

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

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

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

Тело запроса

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

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

Responses

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

Описание: ОК

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

Примеры

Пример

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

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

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

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

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

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

Responses

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

Описание: ОК

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

Примеры

Пример

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

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

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

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

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

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

Тело запроса

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

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

Responses

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

Описание: ОК

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

Примеры

Пример

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

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

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

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

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

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

Responses

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

Описание: ОК

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

Примеры

Пример

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

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

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

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

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

Замечание

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

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

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

Параметры URI

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

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

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

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

Responses

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

Описание: ОК

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

Примеры

Пример

Список сообщений

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

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

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

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

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

Тело запроса

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

Имя.	Тип	Description	Обязательно	По умолчанию
attachments	массив	Список файлов, присоединенных к сообщению, и инструменты, к которому они должны быть добавлены.	нет
содержимое	струна	Содержимое сообщения.	Да
metadata	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.	нет
роль	струна	Роль сущности, создающей сообщение. Допустимые значения: - user: указывает, что сообщение отправляется фактическим пользователем и должно использоваться в большинстве случаев для представления сообщений, созданных пользователем. - assistant: указывает, что сообщение создается помощником. Используйте это значение для вставки сообщений от помощника в беседу.	Да

Responses

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

Описание: ОК

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

Примеры

Пример

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

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

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

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

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

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

Responses

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

Описание: ОК

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

Примеры

Пример

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

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

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

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

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

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

Тело запроса

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

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

Responses

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

Описание: ОК

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

Примеры

Пример

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

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

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

Замечание

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

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

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

Параметры URI

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

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

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

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

Тело запроса

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

Имя.	Тип	Description	Обязательно	По умолчанию
assistant_id	струна	Идентификатор помощника, используемого для выполнения этого выполнения.	Да
instructions	струна	Переопределите системное сообщение помощника по умолчанию. Это полезно для изменения поведения на основе каждого запуска.	нет
max_completion_tokens (максимальное количество токенов завершения)	целое число	Максимальное количество маркеров завершения, которые могут использоваться в ходе выполнения. Выполнение старается по возможности использовать только указанное количество маркеров завершения на нескольких этапах выполнения. Если выполнение превышает указанное число маркеров завершения, выполнение завершится состоянием incomplete. Дополнительные сведения см. в incomplete_details.	нет
max_prompt_tokens	целое число	Максимальное количество маркеров запроса, которые могут использоваться в ходе выполнения. Выполняющая программа делает все возможное, чтобы использовать только указанное количество токенов подсказок в нескольких итерациях. Если выполнение превышает указанное число маркеров запроса, выполнение завершится состоянием incomplete. Дополнительные сведения см. в incomplete_details.	нет
metadata	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.	нет
модель	струна	Идентификатор моделей, используемых для выполнения этого выполнения. Если здесь указано значение, оно переопределит модель, связанную с помощником. В противном случае будет использоваться модель, связанная с помощником.	нет
вызовы инструмента в параллельном режиме	ParallelToolCalls	Следует ли включить параллельные вызовы функций во время использования средства.	нет	True
формат_ответа	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 или беседа превысила максимальную длину контекста.	нет
поток	булевый	Если trueвозвращает поток событий, которые происходят во время событий запуска от имени сервера, завершая выполнение в состоянии терминала с сообщением data: [DONE] .	нет
stream_options	chatCompletionStreamOptions	Параметры потокового ответа. Этот параметр устанавливается только при установке stream: true.	нет	None
Температура	число/номер	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным.	нет	1
thread	createThreadRequest		нет
выбор инструмента	assistantsApiToolChoiceOption	Определяет, какое средство (если таковое) вызывается моделью. none означает, что модель не вызывает средства и вместо этого создает сообщение. auto является значением по умолчанию и означает, что модель может выбирать между созданием сообщения или вызовом средства. Указание определенного инструмента, например {"type": "file_search"} или {"type": "function", "function": {"name": "my_function"}} принудительное вызов модели.	нет
tool_resources	объект	Набор ресурсов, используемых средствами помощника. Ресурсы относятся к типу инструмента. Например, для code_interpreter средства требуется список идентификаторов файлов, а для file_search этого средства требуется список идентификаторов векторного хранилища.	нет
└─ интерпретатор_кода	объект		нет
└ file_ids	массив	Список идентификаторов файлов, доступных средству code_interpreter . С инструментом может быть не более 20 файлов.	нет	[]
└file_search	объект		нет
└️ vector_store_ids	массив	Идентификатор хранилища векторов, присоединенного к этому помощнику. К помощнику может быть подключено не более 1 векторного хранилища.	нет
инструменты	массив	Переопределите средства, которые помощник может использовать для этого запуска. Это полезно для изменения поведения на основе каждого запуска.	нет
top_p	число/номер	Альтернативой выборке с температурой является так называемая выборка ядра, где модель рассматривает результаты маркеров с top_p всего массива значений вероятности. Таким образом, 0,1 означает, что учитываются только маркеры, входящие в верхние 10% массива значений вероятности. Как правило, мы рекомендуем изменить либо это значение, либо температуру, но не оба.	нет	1
truncation_strategy	truncationObject	Определяет, как поток будет усечен до выполнения. Используйте это для управления начальным окном контекста выполнения.	нет

Responses

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

Описание: ОК

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

Примеры

Пример

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

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

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

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

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

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

Responses

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

Описание: ОК

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

Примеры

Пример

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

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

Имя.	In	Обязательно	Тип	Description
endpoint	путь	Да	URL-адрес строки	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например https://aoairesource.openai.azure.com. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai. azure.com
thread_id	путь	Да	струна	Идентификатор выполняемого потока.
include[]	query	нет	массив	Список дополнительных полей для включения в ответ. В настоящее время единственным поддерживаемым значением для получения содержимого результатов поиска файлов является step_details.tool_calls[*].file_search.results[*].content.
версия API	query	Да	струна

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

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

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

Тело запроса

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

Имя.	Тип	Description	Обязательно	По умолчанию
additional_instructions	струна	Добавляет дополнительные инструкции в конце инструкций для выполнения. Это полезно для изменения поведения на основе каждого запуска без переопределения других инструкций.	нет
additional_messages	массив	Добавляет дополнительные сообщения в поток перед созданием запуска.	нет
assistant_id	струна	Идентификатор помощника, используемого для выполнения этого выполнения.	Да
instructions	струна	Переопределите системное сообщение помощника по умолчанию. Это полезно для изменения поведения на основе каждого запуска.	нет
max_completion_tokens (максимальное количество токенов завершения)	целое число	Максимальное количество маркеров завершения, которые могут использоваться в ходе выполнения. Выполнение старается по возможности использовать только указанное количество маркеров завершения на нескольких этапах выполнения. Если выполнение превышает указанное число маркеров завершения, выполнение завершится состоянием incomplete. Дополнительные сведения см. в incomplete_details.	нет
max_prompt_tokens	целое число	Максимальное количество маркеров запроса, которые могут использоваться в ходе выполнения. Выполняющая программа делает все возможное, чтобы использовать только указанное количество токенов подсказок в нескольких итерациях. Если выполнение превышает указанное число маркеров запроса, выполнение завершится состоянием incomplete. Дополнительные сведения см. в incomplete_details.	нет
metadata	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.	нет
модель	струна	Идентификатор модели, используемой для выполнения этого выполнения. Если здесь указано значение, оно переопределит модель, связанную с помощником. В противном случае будет использоваться модель, связанная с помощником.	нет
вызовы инструмента в параллельном режиме	ParallelToolCalls	Следует ли включить параллельные вызовы функций во время использования средства.	нет	True
формат_ответа	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 или беседа превысила максимальную длину контекста.	нет
поток	булевый	Если trueвозвращает поток событий, которые происходят во время событий запуска от имени сервера, завершая выполнение в состоянии терминала с сообщением data: [DONE] .	нет
Температура	число/номер	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным.	нет	1
выбор инструмента	assistantsApiToolChoiceOption	Определяет, какое средство (если таковое) вызывается моделью. none означает, что модель не вызывает средства и вместо этого создает сообщение. auto является значением по умолчанию и означает, что модель может выбирать между созданием сообщения или вызовом средства. Указание определенного инструмента, например {"type": "file_search"} или {"type": "function", "function": {"name": "my_function"}} принудительное вызов модели.	нет
инструменты	массив	Переопределите средства, которые помощник может использовать для этого запуска. Это полезно для изменения поведения на основе каждого запуска.	нет
top_p	число/номер	Альтернативой выборке с температурой является так называемая выборка ядра, где модель рассматривает результаты маркеров с top_p всего массива значений вероятности. Таким образом, 0,1 означает, что учитываются только маркеры, входящие в верхние 10% массива значений вероятности. Как правило, мы рекомендуем изменить либо это значение, либо температуру, но не оба.	нет	1
truncation_strategy	truncationObject	Определяет, как поток будет усечен до выполнения. Используйте это для управления начальным окном контекста выполнения.	нет

Responses

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

Описание: ОК

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

Примеры

Пример

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

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

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

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

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

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

Responses

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

Описание: ОК

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

Примеры

Пример

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

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

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

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

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

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

Тело запроса

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

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

Responses

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

Описание: ОК

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

Примеры

Пример

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

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

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

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

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

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

Тело запроса

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

Имя.	Тип	Description	Обязательно	По умолчанию
поток	булевый	Если trueвозвращает поток событий, которые происходят во время событий запуска от имени сервера, завершая выполнение в состоянии терминала с сообщением data: [DONE] .	нет
tool_outputs	массив	Список инструментов, для которых отправляются выходные данные.	Да

Responses

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

Описание: ОК

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

Примеры

Пример

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

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

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

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

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

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

Responses

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

Описание: ОК

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

Примеры

Пример

Отменяет запуск, который является 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

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

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

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

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

Responses

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

Описание: ОК

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

Примеры

Пример

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

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

Имя.	In	Обязательно	Тип	Description
endpoint	путь	Да	URL-адрес строки	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например https://aoairesource.openai.azure.com. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai. azure.com
thread_id	путь	Да	струна	Идентификатор потока, к которому относятся выполнение и шаг выполнения.
run_id	путь	Да	струна	Идентификатор выполнения, к которому принадлежит шаг выполнения.
step_id	путь	Да	струна	Идентификатор шага выполнения, который требуется получить.
include[]	query	нет	массив	Список дополнительных полей для включения в ответ. В настоящее время единственным поддерживаемым значением для получения содержимого результатов поиска файлов является step_details.tool_calls[*].file_search.results[*].content.
версия API	query	Да	струна

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

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

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

Responses

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

Описание: ОК

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

Примеры

Пример

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

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

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

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

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

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

Responses

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

Описание: ОК

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

Примеры

Пример

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

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

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

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

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

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

Тело запроса

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

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

Responses

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

Описание: ОК

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

Примеры

Пример

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

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

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

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

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

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

Responses

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

Описание: ОК

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

Примеры

Пример

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

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

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

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

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

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

Тело запроса

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

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

Responses

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

Описание: ОК

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

Примеры

Пример

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

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

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

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

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

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

Responses

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

Описание: ОК

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

Примеры

Пример

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

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

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

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

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

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

Responses

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

Описание: ОК

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

Примеры

Пример

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

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

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

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

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

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

Тело запроса

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

Имя.	Тип	Description	Обязательно	По умолчанию
chunking_strategy	chunkingStrategyRequestParam	Стратегия блокирования, используемая для блокирования файлов. Если этот параметр не задан, используйте стратегию auto .	нет
идентификатор_файла	струна	Идентификатор файла, который должен использовать хранилище векторов. Полезно для таких средств, как file_search, которые могут access файлов.	Да

Responses

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

Описание: ОК

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

Примеры

Пример

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

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

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

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

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

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

Responses

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

Описание: ОК

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

Примеры

Пример

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

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

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

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

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

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

Responses

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

Описание: ОК

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

Примеры

Пример

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

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

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

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

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

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

Тело запроса

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

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

Responses

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

Описание: ОК

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

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

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

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

Параметры URI

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

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

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

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

Responses

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

Описание: ОК

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

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

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

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

Параметры URI

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

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

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

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

Тело запроса

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

Имя.	Тип	Description	Обязательно	По умолчанию
filters	ComparisonFilter или CompoundFilter	Фильтр для применения на основе атрибутов файла.	нет
максимальное_количество_результатов	целое число	Максимальное количество отображаемых результатов. Это число должно быть от 1 до 50 включительно.	нет	10
query	строка или массив	Строка запроса для поиска	Да
опции рейтинга	объект	Параметры ранжирования для поиска.	нет
Рангер └️	перечисление	Возможные значения: auto, default-2024-11-15	нет
└─ порог оценки	число/номер		нет	0
rewrite_query	булевый	Следует ли переписать запрос естественного языка для векторного поиска.	нет	Неправда

Responses

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

Описание: ОК

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

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

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

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

Параметры URI

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

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

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

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

Тело запроса

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

Имя.	Тип	Description	Обязательно	По умолчанию
chunking_strategy	chunkingStrategyRequestParam	Стратегия блокирования, используемая для блокирования файлов. Если этот параметр не задан, используйте стратегию auto .	нет
идентификаторы_файлов	массив	Список идентификаторов файлов, которые следует использовать векторном хранилище. Полезно для таких средств, как file_search, которые могут access файлов.	Да

Responses

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

Описание: ОК

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

Примеры

Пример

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

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

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

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

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

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

Responses

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

Описание: ОК

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

Примеры

Пример

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

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

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

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

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

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

Responses

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

Описание: ОК

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

Примеры

Пример

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

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

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

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

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

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

Responses

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

Описание: ОК

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

Примеры

Пример

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

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 Реального времени.

Тело запроса

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

Имя.	Тип	Description	Обязательно	По умолчанию
input_audio_format	перечисление	Формат входного звука. Параметры: pcm16, g711_ulawили g711_alaw. Для pcm16 входной звук должен быть 16-разрядным PCM с частотой выборки 24 кГц, одним каналом (моно) и младшим порядком байтов. Возможные значения: pcm16, g711_ulawg711_alaw	нет
input_audio_noise_reduction	объект	Настройка для уменьшения шума входного звука. Чтобы отключить, это можно установить на null. Фильтры для уменьшения шума обрабатывают звук, добавленный во входной звуковой буфер перед отправкой в VAD и модель. Фильтрация звука может повысить точность обнаружения VAD и поворота (уменьшая ложные срабатывания) и производительность модели, повышая восприятие входного звука.	нет
└─ Тип	перечисление	Тип уменьшения шума. near_field предназначен для микрофонов близкого разговора, таких как наушники, far_field предназначен для микрофонов с дальним полем, таких как ноутбук или микрофоны конференц-зала. Возможные значения: near_field, far_field	нет
input_audio_transcription	объект	Настройка транскрибирования входного аудио, по умолчанию отключена и может быть установлена на null, чтобы отключить аудиотранскрибирование после включения. Транскрибирование входного звука не является собственным для модели, так как модель использует звук напрямую. Транскрибирование выполняется асинхронно через конечную точку транскрибирования и следует рассматривать как руководство по входной звуковой информации, а не точно тому, что слышала модель. Клиент может при необходимости задать язык и запрашивать транскрибирование, они предлагают дополнительные рекомендации для службы транскрибирования.	нет
└─ Язык	струна	Язык входного звука. Предоставление языка ввода в формате ISO-639-1 (например en, ) повышает точность и задержку.	нет
└─ Модель	струна	Модель, используемая для транскрибирования, текущие параметры: gpt-4o-transcribe, gpt-4o-transcribe-diarize, gpt-4o-mini-transcribeи gpt-4o-mini-transcribe-2025-12-15whisper-1.	нет
└─ Запрос	струна	Необязательный текст для руководства стилем модели или продолжением предыдущего сегмента звука. Для whisper-1этого запрос — это список ключевых слов. Для gpt-4o-transcribe моделей запрос — это произвольная текстовая строка (например, "ожидайте слова, связанные с технологией").	нет
instructions	струна	Системные инструкции по умолчанию (т. е. системное сообщение) предопределены для вызовов модели. Это поле позволяет клиенту управлять моделью по нужным ответам. Модель может быть настроена по формату и содержанию ответа (например, "быть чрезвычайно кратким", "вести себя дружелюбно", "вот примеры хороших ответов") и на звуковое поведение (например, "говорить быстро", "вносить в голос эмоции", "смеяться часто"). Нет гарантии, что модель будет следовать инструкциям, но они служат для нее руководством по желаемому поведению. Обратите внимание, что сервер задает инструкции по умолчанию, которые будут использоваться, если это поле не задано, и которые видны в событии session.created в начале сеанса.	нет
max_response_output_tokens	целое число или строка	Максимальное количество выходных маркеров для одного ответа помощника, включающее вызовы инструментов. Укажите целое число от 1 до 4096, чтобы ограничить выходные маркеры или inf максимальные доступные маркеры для данной модели. По умолчанию — inf.	нет
Условия		Набор модальностей, с которыми может реагировать модель. Чтобы отключить звук, установите для этого значение ["text"].	нет
модель	струна	Имя развертывания, используемого для этого сеанса.	нет
output_audio_format	перечисление	Формат выходного звука. Параметры: pcm16, g711_ulawили g711_alaw. Для pcm16 выходного аудио частота дискретизации составляет 24 кГц. Возможные значения: pcm16, g711_ulawg711_alaw	нет
Температура	число/номер	Температура выборки для модели ограничена [0.6, 1.2]. Для звуковых моделей температура 0,8 настоятельно рекомендуется для оптимальной производительности.	нет	0.8
выбор инструмента	струна	Как модель выбирает инструменты. Параметры: auto, nonerequiredили укажите функцию.	нет	авто
инструменты	массив	Средства (функции), доступные для модели.	нет
turn_detection	объект	Конфигурация для обнаружения поворота, VAD или семантического VAD сервера эфира. Это можно установить в null для отключения, в этом случае клиент должен вручную активировать реакцию модели. VAD на сервере означает, что модель будет обнаруживать начало и конец речи на основе громкости звука и отвечать в конце речи пользователя. Семантическая VAD более совершенная и использует модель обнаружения смены реплик (в сочетании с VAD), чтобы семантически оценить, закончил ли пользователь говорить, а затем динамически устанавливает тайм-аут на основе этой вероятности. Например, если пользователь отключает аудиозапись, uhhmмодель будет оценить низкую вероятность завершения и ждать больше времени, пока пользователь продолжит говорить. Это может быть полезно для более естественных бесед, но может иметь более высокую задержку.	нет
└create_response	булевый	Следует ли автоматически создавать ответ при возникновении события остановки VAD.	нет	True
└️ рвение	перечисление	Только для режима semantic_vad используется. Стремление модели реагировать. low будет ждать, пока пользователь продолжит говорить, high будет реагировать быстрее. auto значение по умолчанию и эквивалентно medium. Возможные значения: low, , mediumhighauto	нет
└─ интеррапт_респонс	булевый	Следует ли автоматически прерывать любой текущий ответ с выходными данными беседы по умолчанию (т. е. conversationautoпри возникновении события запуска VAD).	нет	True
└prefix_padding_ms	целое число	Только для режима server_vad используется. Длительность звука, которую нужно включить до речи, обнаруженной VAD (в миллисекундах). Значение по умолчанию — 300 мс.	нет
└─ длительность_тишины_мс	целое число	Только для режима server_vad используется. Длительность молчания для обнаружения остановки речи (в миллисекундах). Значение по умолчанию — 500 мс. С более короткими значениями модель будет реагировать быстрее, но может вмешиваться при коротких паузах пользователя.	нет
Пороговое значение └️	число/номер	Только для режима server_vad используется. Порог активации для VAD (0.0 до 1.0), по умолчанию используется значение 0.5. Более высокий пороговый уровень потребует более громкого звука для активации модели, и таким образом модель может работать лучше в шумных средах.	нет
└─ Тип	перечисление	Тип обнаружения поворота. Возможные значения: server_vad, semantic_vad	нет
голос	VoiceIdsShared		нет

Responses

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

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

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

Создание — транскрипция сессии в реальном времени

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

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

Тело запроса

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

Имя.	Тип	Description	Обязательно	По умолчанию
include	массив	Набор элементов для включения в транскрибирование. Текущие доступные элементы: - item.input_audio_transcription.logprobs	нет
input_audio_format	перечисление	Формат входного звука. Параметры: pcm16, g711_ulawили g711_alaw. Для pcm16 входной звук должен быть 16-разрядным PCM с частотой выборки 24 кГц, одним каналом (моно) и младшим порядком байтов. Возможные значения: pcm16, g711_ulawg711_alaw	нет
input_audio_noise_reduction	объект	Настройка для уменьшения шума входного звука. Чтобы отключить, это можно установить на null. Фильтры для уменьшения шума обрабатывают звук, добавленный во входной звуковой буфер перед отправкой в VAD и модель. Фильтрация звука может повысить точность обнаружения VAD и поворота (уменьшая ложные срабатывания) и производительность модели, повышая восприятие входного звука.	нет
└─ Тип	перечисление	Тип уменьшения шума. near_field предназначен для микрофонов близкого разговора, таких как наушники, far_field предназначен для микрофонов с дальним полем, таких как ноутбук или микрофоны конференц-зала. Возможные значения: near_field, far_field	нет
input_audio_transcription	объект	Конфигурация входного транскрибирования звука. Клиент может при необходимости задать язык и запрашивать транскрибирование, они предлагают дополнительные рекомендации для службы транскрибирования.	нет
└─ Язык	струна	Язык входного звука. Предоставление языка ввода в формате ISO-639-1 (например en, ) повышает точность и задержку.	нет
└─ Модель	перечисление	Модель, используемая для транскрибирования, текущие параметры: 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	нет
└─ Запрос	струна	Необязательный текст для руководства стилем модели или продолжением предыдущего сегмента звука. Для whisper-1этого запрос — это список ключевых слов. Для gpt-4o-transcribe моделей запрос — это произвольная текстовая строка (например, "ожидайте слова, связанные с технологией").	нет
Условия		Набор модальностей, с которыми может реагировать модель. Чтобы отключить звук, установите для этого значение ["text"].	нет
turn_detection	объект	Конфигурация для обнаружения поворота, VAD или семантического VAD сервера эфира. Это можно установить в null для отключения, в этом случае клиент должен вручную активировать реакцию модели. VAD на сервере означает, что модель будет обнаруживать начало и конец речи на основе громкости звука и отвечать в конце речи пользователя. Семантическая VAD более совершенная и использует модель обнаружения смены реплик (в сочетании с VAD), чтобы семантически оценить, закончил ли пользователь говорить, а затем динамически устанавливает тайм-аут на основе этой вероятности. Например, если пользователь отключает аудиозапись, uhhmмодель будет оценить низкую вероятность завершения и ждать больше времени, пока пользователь продолжит говорить. Это может быть полезно для более естественных бесед, но может иметь более высокую задержку.	нет
└create_response	булевый	Следует ли автоматически создавать ответ при возникновении события остановки VAD. Недоступно для сеансов транскрибирования.	нет	True
└️ рвение	перечисление	Только для режима semantic_vad используется. Стремление модели реагировать. low будет ждать, пока пользователь продолжит говорить, high будет реагировать быстрее. auto значение по умолчанию и эквивалентно medium. Возможные значения: low, , mediumhighauto	нет
└─ интеррапт_респонс	булевый	Следует ли автоматически прерывать любой текущий ответ с выходными данными беседы по умолчанию (т. е. conversationautoпри возникновении события запуска VAD). Недоступно для сеансов транскрибирования.	нет	True
└prefix_padding_ms	целое число	Только для режима server_vad используется. Длительность звука, которую нужно включить до речи, обнаруженной VAD (в миллисекундах). Значение по умолчанию — 300 мс.	нет
└─ длительность_тишины_мс	целое число	Только для режима server_vad используется. Длительность молчания для обнаружения остановки речи (в миллисекундах). Значение по умолчанию — 500 мс. С более короткими значениями модель будет реагировать быстрее, но может вмешиваться при коротких паузах пользователя.	нет
Пороговое значение └️	число/номер	Только для режима server_vad используется. Порог активации для VAD (0.0 до 1.0), по умолчанию используется значение 0.5. Более высокий пороговый уровень потребует более громкого звука для активации модели, и таким образом модель может работать лучше в шумных средах.	нет
└─ Тип	перечисление	Тип обнаружения поворота. Возможные значения: server_vad, semantic_vad	нет

Responses

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

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

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

Responses

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

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

Тело запроса

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

Имя.	Тип	Description	Обязательно	По умолчанию
include	массив		нет
ввод	строка или массив	Входные данные модели	Да
instructions	струна	Вставляет сообщение системы (или разработчика) в качестве первого элемента в контексте модели. При использовании вместе с previous_response_idэтим инструкции из предыдущего ответа не будут перенесены в следующий ответ. Это упрощает замену системных сообщений (или сообщений разработчиками) в новых ответах.	нет
max_output_tokens	целое число	Верхняя граница для числа маркеров, которые можно создать для ответа, включая видимые выходные маркеры и состояние беседы.	нет
вызовы инструмента в параллельном режиме	булевый	Следует ли разрешить модели запускать вызовы инструментов параллельно.	нет	True
previous_response_id	струна	Уникальный идентификатор предыдущего ответа на модель. Используйте эту функцию для создания многоэтапных бесед. Узнайте больше о состоянии беседы.	нет
reasoning	Reasoning	Параметры конфигурации для моделей рассуждений.	нет
store	булевый	Следует ли хранить созданный ответ модели для последующего получения через API.	нет	True
поток	булевый	Если задано значение true, данные ответа модели будут передаваться клиенту по мере его создания с помощью событий, отправляемых сервером. См. ниже раздел "Потоковая передача" для получения дополнительной информации.	нет	Неправда
текст	объект	Параметры конфигурации для текстового ответа модели. Можно использовать обычный текст или структурированные данные JSON. Подробнее: — текстовые входные и выходные данные — структурированные выходные данные	нет
└─ Формат	TextResponseFormatConfiguration	Объект, указывающий формат, который должен выводить модель. Настройка { "type": "json_schema" } включает структурированные выходные данные, что гарантирует соответствие модели предоставленной схеме JSON. Формат по умолчанию — это { "type": "text" } без дополнительных параметров. Не рекомендуется использовать для gpt-4o и более новых моделей: Настройка для { "type": "json_object" } включает старый режим JSON, который гарантирует, что создаваемое моделью сообщение является допустимым JSON. Использование json_schema предпочтительнее для моделей, поддерживающих его.	нет
выбор инструмента	ToolChoiceOptions или ToolChoiceTypes или ToolChoiceFunction	Как модель должна выбрать средство (или инструменты), которое следует использовать при создании ответа. Просмотрите tools параметр, чтобы узнать, как указать, какие средства модель может вызывать.	нет
инструменты	массив	Массив инструментов, которые модель может вызывать при создании ответа. Можно указать, какое средство следует использовать, задав tool_choice параметр. Ниже приведены две категории инструментов, которые можно предоставить модели: - Встроенные инструменты: инструменты, предоставляемые OpenAI для расширения Возможности модели	нет
truncation	перечисление	Стратегия усечения, которую следует использовать для генерирования ответа модели. - auto: если контекст этого ответа и предыдущих превышает размер окна контекста модели, модель усечет ответ, чтобы он соответствовал этому окну, удаляя элементы ввода в середине беседы. - disabled (по умолчанию): если ответ модели превысит размер окна контекста для модели, запрос завершится ошибкой 400. Возможные значения: auto, disabled	нет

Responses

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

Описание: ОК

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

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

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

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

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

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

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

Параметры URI

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

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

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

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

Responses

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

Описание: ОК

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

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

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

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

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

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

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

Параметры URI

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

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

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

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

Responses

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

Описание: ОК

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

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

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

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

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

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

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

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

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

Параметры URI

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

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

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

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

Responses

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

Описание: ОК

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

Components

ответ ошибки

Имя.	Тип	Description	Обязательно	По умолчанию
ошибка	error		нет

errorBase

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

ошибка

Имя.	Тип	Description	Обязательно	По умолчанию
внутренняя ошибка	innerError	Внутренняя ошибка с дополнительными сведениями.	нет
параметр	струна		нет
type	струна		нет

внутренняя ошибка

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

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

внутреннийКодОшибки

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

Недвижимость	Ценность
Описание	Коды ошибок для внутреннего объекта ошибки.
Тип	струна
Значения	ResponsibleAIPolicyViolation

dalleErrorResponse

Имя.	Тип	Description	Обязательно	По умолчанию
ошибка	ошибка Dalle		нет

dalleError

Имя.	Тип	Description	Обязательно	По умолчанию
внутренняя ошибка	dalleInnerError	Внутренняя ошибка с дополнительными сведениями.	нет
параметр	струна		нет
type	струна		нет

dalleInnerError

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

Имя.	Тип	Description	Обязательно	По умолчанию
код	innerErrorCode	Коды ошибок для внутреннего объекта ошибки.	нет
результаты фильтрации контента	dalleFilterResults	Сведения о категории фильтрации содержимого (ненавидимая, сексуальность, насилие, self_harm), если она обнаружена, а также уровень серьезности (very_low, низкий, средний, высокомасштабируемый, определяющий интенсивность и уровень риска вредного содержимого) и если он был отфильтрован или нет. Сведения о содержимом и ненормативной лексике, если он обнаружен, и если он был отфильтрован или нет. И сведения о списке блокировок клиента, если он был отфильтрован и его идентификатор.	нет
пересмотренный_запрос	струна	Запрос, который использовался для создания образа, если в запросе была любая редакция.	нет

contentFilterCompletionTextSpan

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

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

базовыйРезультатФильтрацииКонтента

Имя.	Тип	Description	Обязательно	По умолчанию
Фильтруется	булевый		Да

Результат фильтрации по степени тяжести

Имя.	Тип	Description	Обязательно	По умолчанию
Фильтруется	булевый		Да
severity	струна		нет

Обнаружен результат фильтра контента

Имя.	Тип	Description	Обязательно	По умолчанию
Обнаружены	булевый		нет
Фильтруется	булевый		Да

Обнаружен фильтр контента с результатом цитирования

Имя.	Тип	Description	Обязательно	По умолчанию
citation	объект		нет
URL-адрес	струна		нет
Лицензия	струна		нет

contentFilterDetectedWithCompletionTextSpansResult

Имя.	Тип	Description	Обязательно	По умолчанию
details	массив		нет

contentFilterIdResult

Имя.	Тип	Description	Обязательно	По умолчанию
Фильтруется	булевый		Да
id	струна		нет

основаРезультатовФильтраКонтента

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

Имя.	Тип	Description	Обязательно	По умолчанию
custom_blocklists	contentFilterDetailedResults	Результаты фильтрации содержимого с подробными сведениями о идентификаторах фильтра содержимого для отфильтрованных сегментов.	нет
ошибка	errorBase		нет
hate	результат тяжести фильтрации контента		нет
profanity	Результат обнаружения фильтра контента		нет
самоповреждение	результат тяжести фильтрации контента		нет
sexual	результат тяжести фильтрации контента		нет
violence	результат тяжести фильтрации контента		нет

результаты контентного фильтра запроса

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

Имя.	Тип	Description	Обязательно	По умолчанию
custom_blocklists	contentFilterDetailedResults	Результаты фильтрации содержимого с подробными сведениями о идентификаторах фильтра содержимого для отфильтрованных сегментов.	нет
ошибка	errorBase		нет
hate	результат тяжести фильтрации контента		нет
indirect_attack	Результат обнаружения фильтра контента		нет
jailbreak	Результат обнаружения фильтра контента		нет
profanity	Результат обнаружения фильтра контента		нет
самоповреждение	результат тяжести фильтрации контента		нет
sexual	результат тяжести фильтрации контента		нет
violence	результат тяжести фильтрации контента		нет

результатыВыбораФильтраКонтента

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

Имя.	Тип	Description	Обязательно	По умолчанию
custom_blocklists	contentFilterDetailedResults	Результаты фильтрации содержимого с подробными сведениями о идентификаторах фильтра содержимого для отфильтрованных сегментов.	нет
ошибка	errorBase		нет
hate	результат тяжести фильтрации контента		нет
profanity	Результат обнаружения фильтра контента		нет
код_защищённого_материала	Обнаружен фильтр контента с результатом цитирования		нет
защищённый_текст_материала	Результат обнаружения фильтра контента		нет
самоповреждение	результат тяжести фильтрации контента		нет
sexual	результат тяжести фильтрации контента		нет
ungrounded_material	contentFilterDetectedWithCompletionTextSpansResult		нет
violence	результат тяжести фильтрации контента		нет

contentFilterDetailedResults

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

Имя.	Тип	Description	Обязательно	По умолчанию
details	массив		нет
Фильтруется	булевый		Да

результат фильтрации запроса

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

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

фильтрация результатов

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

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

РезультатыФильтрацииКонтентаDalle

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

Имя.	Тип	Description	Обязательно	По умолчанию
hate	результат тяжести фильтрации контента		нет
самоповреждение	результат тяжести фильтрации контента		нет
sexual	результат тяжести фильтрации контента		нет
violence	результат тяжести фильтрации контента		нет

Результаты фильтрации dalle

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

Имя.	Тип	Description	Обязательно	По умолчанию
custom_blocklists	contentFilterDetailedResults	Результаты фильтрации содержимого с подробными сведениями о идентификаторах фильтра содержимого для отфильтрованных сегментов.	нет
hate	результат тяжести фильтрации контента		нет
jailbreak	Результат обнаружения фильтра контента		нет
profanity	Результат обнаружения фильтра контента		нет
самоповреждение	результат тяжести фильтрации контента		нет
sexual	результат тяжести фильтрации контента		нет
violence	результат тяжести фильтрации контента		нет

Общий запрос на завершение чата

Имя.	Тип	Description	Обязательно	По умолчанию
штраф за частоту	число/номер	Число от -2.0 до 2.0. Положительные значения наказывают новые маркеры на основе их существующей частоты в тексте до сих пор, уменьшая вероятность повторения модели той же строки дословно.	нет	0
логит_биас	объект	Изменяет вероятность появления указанных маркеров в завершении. Принимает объект JSON, который сопоставляет маркеры (указанные идентификатором маркера в токенизаторе) со связанным значением предвзятости от -100 до 100. С математической точки зрения смещение добавляется к логитам, созданным моделью до выборки. Точный эффект зависит от модели, но значения от –1 до 1 должны уменьшаться или увеличивать вероятность выбора; Значения, такие как -100 или 100, должны привести к запрету или эксклюзивному выбору соответствующего маркера.	нет
max_completion_tokens (максимальное количество токенов завершения)	целое число	Верхняя граница для числа маркеров, которые можно создать для завершения, включая видимые выходные маркеры и маркеры причин.	нет
макс_токены	целое число	Максимальное количество маркеров, разрешенных для созданного ответа. По умолчанию число маркеров, возвращаемых моделью, будет (4096 — маркеры запроса). Это несовместимо с моделями серии o1.	нет	4096
metadata	объект	Определяемые разработчиком теги и значения, используемые для фильтрации завершений на панели мониторинга хранимых завершений.	нет
штраф за присутствие	число/номер	Число от -2.0 до 2.0. Положительные значения наказывают новые маркеры в зависимости от того, появляются ли они в тексте до сих пор, что повышает вероятность того, что модель будет говорить о новых темах.	нет	0
stop	строка или массив	До 4 последовательностей, в которых API перестает генерировать дополнительные токены.	нет
store	булевый	Независимо от того, следует ли хранить выходные данные этого запроса на завершение чата для использования в наших продуктах для дистилляции или оценки модели.	нет
поток	булевый	Если задано, разностные сообщения отправляются, например в ChatGPT. Токены отправляются в виде событий, отправляемых сервером и содержащих только данные, по мере их появления, где поток завершается сообщением data: [DONE].	нет	Неправда
Температура	число/номер	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным. Как правило, мы рекомендуем изменить это или top_p не оба.	нет	1
top_p	число/номер	Альтернативой выборке с температурой является так называемая выборка ядра, где модель рассматривает результаты маркеров с top_p всего массива значений вероятности. Таким образом, 0,1 означает, что учитываются только маркеры, входящие в верхние 10% массива значений вероятности. Как правило, мы рекомендуем изменить это или temperature не оба.	нет	1
Пользователь	струна	Уникальный идентификатор, представляющий пользователя, который может помочь Azure OpenAI для мониторинга и обнаружения злоупотреблений.	нет

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

Имя.	Тип	Description	Обязательно	По умолчанию
Лучшее из	целое число	best_of Создает завершения на стороне сервера и возвращает "лучший" (один с наибольшей вероятностью журнала на токен). Потоковую передачу результатов выполнить нельзя. При использовании с n, параметр best_of определяет количество возможных завершений, а n указывает, сколько следует вернуть. best_of должно быть больше n. Примечание. Так как этот параметр создает множество завершений, он может быстро использовать квоту маркера. Используйте тщательно и убедитесь, что у вас есть разумные параметры для max_tokens и stop.	нет	1
echo	булевый	Возвращает запрос в дополнение к завершению	нет	Неправда
штраф за частоту	число/номер	Число от -2.0 до 2.0. Положительные значения наказывают новые маркеры на основе их существующей частоты в тексте до сих пор, уменьшая вероятность повторения модели той же строки дословно.	нет	0
логит_биас	объект	Изменяет вероятность появления указанных маркеров в завершении. Принимает объект JSON, который сопоставляет маркеры (указанные идентификатором маркера в маркеризаторе GPT) с соответствующим значением предвзятости от -100 до 100. С математической точки зрения смещение добавляется к логитам, созданным моделью до выборки. Точный эффект зависит от модели, но значения от –1 до 1 должны уменьшаться или увеличивать вероятность выбора; Значения, такие как -100 или 100, должны привести к запрету или эксклюзивному выбору соответствующего маркера. Например, можно передать {"50256": -100} маркер |endoftext|< для предотвращения >создания маркера |endoftext.	нет	None
logprobs	целое число	Включите вероятности журнала в logprobs наиболее вероятные выходные маркеры, а также выбранные маркеры. Например, если logprobs значение равно 5, API вернет список из 5 наиболее вероятных маркеров. API всегда возвращает logprob пример маркера, поэтому в ответе может быть до logprobs+1 элементов. Максимальное значение logprobs для 5.	нет	None
макс_токены	целое число	Максимальное количество токенов, которые могут быть сгенерированы в ходе завершения. Количество маркеров запроса плюс max_tokens не может превышать длину контекста модели.	нет	16
н	целое число	Количество завершений, создаваемых для каждого запроса. Примечание. Так как этот параметр создает множество завершений, он может быстро использовать квоту маркера. Используйте тщательно и убедитесь, что у вас есть разумные параметры для max_tokens и stop.	нет	1
штраф за присутствие	число/номер	Число от -2.0 до 2.0. Положительные значения наказывают новые маркеры в зависимости от того, появляются ли они в тексте до сих пор, что повышает вероятность того, что модель будет говорить о новых темах.	нет	0
prompt	строка или массив	Запросы для создания завершений, закодированных в виде строки, массива строк, массива маркеров или массива массивов маркеров. Обратите внимание, что <|endoftext|> — это разделитель документов, который модель видит во время обучения, поэтому если запрос не указан, модель будет создаваться как будто с начала нового документа.	Да
seed	целое число	Если задано, наша система делает все возможное, чтобы проводила детерминированную выборку, так чтобы повторяющиеся запросы с одинаковыми seed и параметрами должны возвращать тот же результат. Детерминированность не гарантируется, и вы должны обратиться к параметру ответа system_fingerprint для мониторинга изменений на сервере.	нет
stop	строка или массив	До 4 последовательностей, в которых API перестает генерировать дополнительные токены. Возвращенный текст не будет содержать последовательность остановки.	нет
поток	булевый	Потоковая передача частичного хода выполнения. Если задано, токены отправляются в виде серверных событий, предназначенных исключительно для передачи данных, по мере их появления, при этом поток завершается сообщением . Пример кода Python.	нет	Неправда
Суффикс	струна	Суффикс, который приходит после завершения вставленного текста. Этот параметр поддерживается только для gpt-3.5-turbo-instruct.	нет	None
Температура	число/номер	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным. Как правило, мы рекомендуем изменить это или top_p не оба.	нет	1
top_p	число/номер	Альтернативой выборке с температурой является так называемая выборка ядра, где модель рассматривает результаты маркеров с top_p всего массива значений вероятности. Таким образом, 0,1 означает, что учитываются только маркеры, входящие в верхние 10% массива значений вероятности. Как правило, мы рекомендуем изменить это или temperature не оба.	нет	1
Пользователь	струна	Уникальный идентификатор, представляющий конечного пользователя, который может помочь в мониторинге и обнаружении злоупотреблений.	нет

создатьОтветНаЗавершение

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

Имя.	Тип	Description	Обязательно	По умолчанию
choices	массив	Список вариантов завершения модели, созданной для ввода запроса.	Да
создано	целое число	Метка времени Unix (в секундах) при создании завершения.	Да
id	струна	Уникальный идентификатор завершения.	Да
модель	струна	Модель, используемая для завершения.	Да
объект	перечисление	Тип объекта, который всегда является "text_completion" Возможные значения: text_completion	Да
результаты_фильтрации_запросов	promptFilterResults	Результаты фильтрации содержимого для нуля или более запросов в запросе. В запросе потоковой передачи результаты для различных запросов могут поступать в разное время или в разных заказах.	нет
системный отпечаток	струна	Этот отпечаток представляет конфигурацию серверной части, с которой работает модель. Можно использовать в сочетании с параметром seed запроса, чтобы понять, когда внутренние изменения были внесены, что может повлиять на детерминированность.	нет
использование	completionUsage	Статистика использования для запроса завершения.	нет

создатьЗапросНаЗаполнениеЧата

Имя.	Тип	Description	Обязательно	По умолчанию
audio	объект	Параметры выходных данных звука. Требуется при запросе на вывод звука с modalities: ["audio"].	нет
└─ Формат	перечисление	Указывает выходной формат звука. Должен быть одним из wav, mp3, flac, opus или pcm16. Возможные значения: wav, mp3, flac, opus, pcm16	нет
└️ голос	перечисление	Указывает тип голоса. Поддерживаемые голоса: alloy, echo, fable, onyxи novashimmer. Возможные значения: alloy, echo, fable, onyx, nova, shimmer	нет
источники данных	массив	Записи конфигурации для расширений чата OpenAI Azure, которые используют их. Эта дополнительная спецификация совместима только с Azure OpenAI.	нет
штраф за частоту	число/номер	Число от -2.0 до 2.0. Положительные значения наказывают новые маркеры на основе их существующей частоты в тексте до сих пор, уменьшая вероятность повторения модели той же строки дословно.	нет	0
вызов_функции	string или chatCompletionFunctionCallOption	Не рекомендуется использовать в пользу tool_choice. Определяет, какая функция (если есть) вызывается моделью. none означает, что модель не вызывает функцию и вместо этого создает сообщение. auto означает, что модель может выбирать между созданием сообщения или вызовом функции. Указание определенной функции путем {"name": "my_function"} принудительного вызова этой функции моделью. none значение по умолчанию, если функции отсутствуют. auto значение по умолчанию, если функции присутствуют.	нет
functions	массив	Не рекомендуется использовать в пользу tools. Список функций, для которые модель может создавать входные данные JSON.	нет
логит_биас	объект	Изменяет вероятность появления указанных маркеров в завершении. Принимает объект JSON, который сопоставляет маркеры (указанные идентификатором маркера в токенизаторе) со связанным значением предвзятости от -100 до 100. С математической точки зрения смещение добавляется к логитам, созданным моделью до выборки. Точный эффект зависит от модели, но значения от –1 до 1 должны уменьшаться или увеличивать вероятность выбора; Значения, такие как -100 или 100, должны привести к запрету или эксклюзивному выбору соответствующего маркера.	нет	None
logprobs	булевый	Следует ли возвращать вероятности журналов выходных маркеров или нет. Если значение true, возвращает вероятности журнала каждого выходного маркера, возвращаемого в параметре contentmessage.	нет	Неправда
max_completion_tokens (максимальное количество токенов завершения)	целое число	Верхняя граница для числа маркеров, которые можно создать для завершения, включая видимые выходные маркеры и маркеры причин.	нет
макс_токены	целое число	Максимальное количество маркеров, которые можно создать в завершении чата. Общая длина входных маркеров и созданных маркеров ограничена длиной контекста модели.	нет
messages	массив	Список сообщений, составляющих беседу до сих пор. Пример кода Python.	Да
metadata	объект	Определяемые разработчиком теги и значения, используемые для фильтрации завершений на панели мониторинга хранимых завершений.	нет
Условия	ChatCompletionModalities	Типы выходных данных, которые нужно создать для этого запроса. Большинство моделей могут создавать текст, который по умолчанию: ["text"] Модель gpt-4o-audio-preview также может использоваться для создания звука. Чтобы запросить, что эта модель создает как текстовые, так и звуковые ответы, можно использовать: ["text", "audio"]	нет
н	целое число	Сколько вариантов завершения чата для каждого входного сообщения. Обратите внимание, что плата будет взиматься на основе количества созданных маркеров во всех вариантах. Имейте в виду n , чтобы 1 свести к минимуму затраты.	нет	1
вызовы инструмента в параллельном режиме	ParallelToolCalls	Следует ли включить параллельные вызовы функций во время использования средства.	нет	True
prediction	PredictionContent	Конфигурация прогнозируемых выходных данных, которая может значительно улучшить время отклика, когда большие части ответа модели известны заранее. Это наиболее распространено при повторном создании файла с незначительными изменениями в большинстве содержимого.	нет
штраф за присутствие	число/номер	Число от -2.0 до 2.0. Положительные значения наказывают новые маркеры в зависимости от того, появляются ли они в тексте до сих пор, что повышает вероятность того, что модель будет говорить о новых темах.	нет	0
усилия на рассуждение	перечисление	Только модели o1 Ограничивает усилия по рассуждениям моделей. В настоящее время поддерживаются lowзначения , mediumи high. Сокращение усилий по поводу может привести к более быстрым откликам и меньшем количестве маркеров, используемых при рассуждениях в ответе. Возможные значения: low, mediumhigh	нет
формат_ответа	ResponseFormatText или ResponseFormatJsonObject или ResponseFormatJsonSchema	Объект, указывающий формат, который должен выводить модель. Совместим с GPT-4oGPT-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 или беседа превысила максимальную длину контекста.	нет
seed	целое число	Эта функция доступна в бета-версии. Если задано, наша система делает все возможное, чтобы проводила детерминированную выборку, так чтобы повторяющиеся запросы с одинаковыми seed и параметрами должны возвращать тот же результат. Детерминированность не гарантируется, и вы должны обратиться к параметру ответа system_fingerprint для мониторинга изменений на сервере.	нет
stop	строка или массив	До 4 последовательностей, в которых API перестает генерировать дополнительные токены.	нет
store	булевый	Независимо от того, следует ли хранить выходные данные этого запроса на завершение чата для использования в наших продуктах для дистилляции или оценки модели.	нет
поток	булевый	Если задано, разностные сообщения отправляются, например в ChatGPT. Токены отправляются только как события, отправляемые сервером по мере их поступления, при этом поток завершается сообщением data: [DONE]. Пример кода Python.	нет	Неправда
stream_options	chatCompletionStreamOptions	Параметры потокового ответа. Этот параметр устанавливается только при установке stream: true.	нет	None
Температура	число/номер	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным. Как правило, мы рекомендуем изменить это или top_p не оба.	нет	1
выбор инструмента	chatCompletionToolChoiceOption	Определяет, какое средство (если таковое) вызывается моделью. none означает, что модель не будет вызывать какое-либо средство и вместо этого создает сообщение. auto означает, что модель может выбирать между созданием сообщения или вызовом одного или нескольких инструментов. required означает, что модель должна вызывать один или несколько инструментов. Указание определенного средства с помощью {"type": "function", "function": {"name": "my_function"}} принудительного вызова этого средства моделью. none значение по умолчанию, если средства отсутствуют. auto значение по умолчанию, если существуют средства.	нет
инструменты	массив	Список инструментов, которые может вызывать модель. В настоящее время в качестве инструмента поддерживаются только функции. Используйте это для предоставления списка функций, для которые модель может создавать входные данные JSON. Поддерживаются не более 128 функций.	нет
top_logprobs	целое число	Целое число от 0 до 20, указывающее число наиболее вероятных маркеров, возвращаемых по каждой позиции маркера, каждый из которых имеет связанную вероятность журнала. logprobs Необходимо задать значение true , если этот параметр используется.	нет
top_p	число/номер	Альтернативой выборке с температурой является так называемая выборка ядра, где модель рассматривает результаты маркеров с top_p всего массива значений вероятности. Таким образом, 0,1 означает, что учитываются только маркеры, входящие в верхние 10% массива значений вероятности. Как правило, мы рекомендуем изменить это или temperature не оба.	нет	1
Пользователь	струна	Уникальный идентификатор, представляющий конечного пользователя, который может помочь в мониторинге и обнаружении злоупотреблений.	нет
user_security_context	userSecurityContext	Контекст безопасности пользователей содержит несколько параметров, описывающих само приложение ИИ, и конечный пользователь, взаимодействующий с приложением ИИ. Эти поля помогают группам по операциям безопасности исследовать и устранять инциденты безопасности, предоставляя комплексный подход к защите приложений ИИ. Learn more о защите приложений ИИ с помощью Microsoft Defender for Cloud.	нет

userSecurityContext

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

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

функции завершения чата

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

опция вызова функции завершения чата

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

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

chatCompletionFunctionParameters

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

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

сообщение-запрос завершения чата

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

• ChatCompletionRequestDeveloperMessage
• chatCompletionRequestSystemMessage
• chatCompletionRequestUserMessage
• chatCompletionRequestAssistantMessage
• chatCompletionRequestToolMessage
• chatCompletionRequestFunctionMessage

ChatCompletionRequestDeveloperMessage

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

Имя.	Тип	Description	Обязательно	По умолчанию
содержимое	строка или массив	Содержимое сообщения разработчика.	Да
имя	струна	Необязательное имя участника. Предоставляет сведения о модели, чтобы различать участников одной роли.	нет
роль	перечисление	Роль автора сообщений в данном случае developer. Возможные значения: developer	Да

системное сообщение запроса завершения чата

Имя.	Тип	Description	Обязательно	По умолчанию
содержимое	строка или массив	Содержимое системного сообщения.	Да
имя	струна	Необязательное имя участника. Предоставляет сведения о модели, чтобы различать участников одной роли.	нет
роль	перечисление	Роль автора сообщений в данном случае system. Возможные значения: system	Да

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

Имя.	Тип	Description	Обязательно	По умолчанию
содержимое	строка или массив	Содержимое сообщения пользователя.	Да
имя	струна	Необязательное имя участника. Предоставляет сведения о модели, чтобы различать участников одной роли.	нет
роль	перечисление	Роль автора сообщений в данном случае user. Возможные значения: user	Да

ЗапросЗавершенияЧатаПомощника

Имя.	Тип	Description	Обязательно	По умолчанию
содержимое	строка или массив	Содержимое сообщения помощника. Обязательный, если tool_calls не указан или function_call не указан.	нет
вызов_функции	объект	Устаревшие и замененные tool_calls. Имя и аргументы вызываемой функции, созданной моделью.	нет
└─ аргументы	струна	Аргументы, с которыми вызывается функция, как создается моделью в формате JSON. Обратите внимание, что модель не всегда создает допустимые json и может галлюцинировать параметры, не определенные схемой функции. Перед вызовом функции проверьте аргументы в коде.	нет
└️ имя	струна	Имя вызываемой функции.	нет
имя	струна	Необязательное имя участника. Предоставляет сведения о модели, чтобы различать участников одной роли.	нет
отказ	струна	Сообщение об отказе помощником.	нет
роль	перечисление	Роль автора сообщений в данном случае assistant. Возможные значения: assistant	Да
вызовы инструментов	chatCompletionMessageToolCalls	Вызовы средства, созданные моделью, например вызовы функций.	нет

Сообщение инструмента запроса завершения чата

Имя.	Тип	Description	Обязательно	По умолчанию
содержимое	строка или массив	Содержимое сообщения средства.	Да
роль	перечисление	Роль автора сообщений в данном случае tool. Возможные значения: tool	Да
идентификатор вызова инструмента	струна	Вызов средства, на который отвечает это сообщение.	Да

сообщение функции запроса завершения чата

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

chatCompletionRequestDeveloperMessageContentPart

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

• chatCompletionRequestMessageContentPartText

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

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

• chatCompletionRequestMessageContentPartText

содержимое сообщения пользователя в запросе на завершение чата

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

• chatCompletionRequestMessageContentPartText
• chatCompletionRequestMessageContentPartImage
• chatCompletionRequestMessageContentPartAudio

ЧастьСообщенияПомощникаЗапросаЗавершенияЧата

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

• chatCompletionRequestMessageContentPartText
• chatCompletionRequestMessageContentPartRefusal

ИнструментЗапросаСообщенияЧатаСодержание

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

• chatCompletionRequestMessageContentPartText

Часть текста содержимого запроса на завершение чата

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

chatCompletionRequestMessageContentPartAudio

Имя.	Тип	Description	Обязательно	По умолчанию
input_audio	объект		Да
└─ Данные	струна	Звуковые данные в кодировке Base64.	нет
└─ Формат	перечисление	Формат закодированных звуковых данных. В настоящее время поддерживается wav и mp3. Возможные значения: wav, mp3	нет
type	перечисление	Тип части содержимого. Всегда input_audio. Возможные значения: input_audio	Да

сообщениеЗапросаЗавершенияЧатаКонтентЧастиИзображение

Имя.	Тип	Description	Обязательно	По умолчанию
ссылка_на_изображение	объект		Да
└️ подробные сведения	перечисление	Указывает уровень детализации изображения. Дополнительные сведения см. в руководстве Vision. Возможные значения: auto, lowhigh	нет
└─ URL	струна	URL-адрес изображения или данных в кодировке Base64.	нет
type	перечисление	Тип части содержимого. Возможные значения: image_url	Да

Запрос отклонен: сообщение не завершено

Имя.	Тип	Description	Обязательно	По умолчанию
отказ	струна	Сообщение об отказе, созданное моделью.	Да
type	перечисление	Тип части содержимого. Возможные значения: refusal	Да

конфигурация расширения чата Azure

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

###Discriminator для azureChatExtensionConfiguration

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

Значение типа	Схема
azure_search	azureSearchChatExtensionConfiguration
azure_cosmos_db	azureCosmosDBChatExtensionConfiguration
elasticsearch	elasticsearchChatExtensionConfiguration
mongo_db	mongoDBChatExtensionConfiguration
pinecone	pineconeChatExtensionConfiguration

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

ТипРасширенияAzureChat

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

Недвижимость	Ценность
Описание	Представление данных конфигурации для одного расширения чата OpenAI Azure. Это будет использоваться запросом завершения чата, который должен использовать Azure расширения чата OpenAI для расширения поведения ответа. Использование этой конфигурации совместимо только с Azure OpenAI.
Тип	струна
Значения	azure_search azure_cosmos_db elasticsearch mongo_db pinecone

Настройка расширения чата для поиска в Azure

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

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

параметрыРасширенияЧатаAzureSearch

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

Имя.	Тип	Description	Обязательно	По умолчанию
allow_partial_result	булевый	Если задано значение true, система позволит использовать частичные результаты поиска, и запрос завершается ошибкой, если все запросы завершаются ошибкой. Если запрос не указан или указан как false, запрос завершится ошибкой, если какой-либо поисковый запрос завершается ошибкой.	нет	Неправда
аутентификация	onYourDataApiKeyAuthenticationOptions или onYourDataSystemAssignedManagedIdentityAuthenticationOptions или onYourDataUserAssignedManagedIdentityAuthenticationOptions или onYourDataAccessTokenAuthenticationOptions		Да
встраивание_зависимости	onYourDataEndpointVectorizationSource или onYourDataDeploymentNameVectorizationSource или onYourDataIntegratedVectorizationSource		нет
endpoint	струна	Абсолютный путь конечной точки для используемого ресурса поиска Azure.	Да
соответствие полей	Опции настройки полей индекса в AzureSearch	Необязательные параметры для управления обработкой полей при использовании настроенного ресурса поиска Azure.	нет
фильтр	струна	Фильтр поиска.	нет
в пределах области	булевый	Следует ли ограничить запросы использованием индексированных данных.	нет
include_contexts	массив	Включенные свойства контекста вывода. Если не указано, значение по умолчанию равно citations и intent.	нет
имя_индекса	струна	Имя индекса, используемого как доступное в ресурсе поиска Azure.	Да
max_search_queries	целое число	Максимальное количество перезаписных запросов должно отправляться в поставщик поиска для одного сообщения пользователя. Если это не указано, система решит количество запросов для отправки.	нет
тип_запроса	azureSearchQueryType	Тип запроса Azure поиска, который должен выполняться при использовании в Azure качестве расширения чата OpenAI.	нет
семантическая конфигурация	струна	Дополнительная семантическая конфигурация для запроса.	нет
strictness	целое число	Настроенная строгость фильтрации релевантности поиска. Чем выше строгость, тем выше точность, но более низкий отзыв ответа.	нет
топ_n_документы	целое число	Настроено первое число документов для функции настроенного запроса.	нет

опции сопоставления полей индекса Azure Search

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

Имя.	Тип	Description	Обязательно	По умолчанию
поля_контента	массив	Имена полей индекса, которые следует рассматривать как содержимое.	нет
разделитель полей содержания	струна	Шаблон разделителя, который должны использовать поля содержимого.	нет
поле_пути_к_файлу	струна	Имя поля индекса, используемого в качестве файлового пути.	нет
image_vector_fields	массив	Имена полей, представляющих векторные данные изображения.	нет
поле_название	струна	Имя поля индекса, используемого в качестве заголовка.	нет
поле_ссылки	струна	Имя поля индекса, используемого в качестве URL-адреса.	нет
векторные поля	массив	Имена полей, представляющих векторные данные.	нет

Тип запроса Azure Search

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

Недвижимость	Ценность
Описание	Тип запроса Azure поиска, который должен выполняться при использовании в Azure качестве расширения чата OpenAI.
Тип	струна
Значения	simple semantic vector vector_simple_hybrid vector_semantic_hybrid

Конфигурация расширения чата Azure Cosmos DB

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

Имя.	Тип	Description	Обязательно	По умолчанию
параметры	azureCosmosDBChatExtensionParameters	Параметры, используемые при настройке расширений чата OpenAI для Azure OpenAI при использовании Azure Cosmos DB для виртуальных ядер MongoDB.	нет
type	azureChatExtensionType	Представление данных конфигурации для одного расширения чата OpenAI Azure. Это будет использоваться запросом завершения чата, который должен использовать Azure расширения чата OpenAI для расширения поведения ответа. Использование этой конфигурации совместимо только с Azure OpenAI.	Да

azureCosmosDBПараметрыРасширенияЧата

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

Имя.	Тип	Description	Обязательно	По умолчанию
allow_partial_result	булевый	Если задано значение true, система позволит использовать частичные результаты поиска, и запрос завершается ошибкой, если все запросы завершаются ошибкой. Если запрос не указан или указан как false, запрос завершится ошибкой, если какой-либо поисковый запрос завершается ошибкой.	нет	Неправда
аутентификация	onYourDataConnectionStringПараметрыАутентификации	Параметры проверки подлинности Azure OpenAI On Your Data при использовании connection string.	Да
имя_контейнера	струна	Имя контейнера ресурсов Azure Cosmos DB.	Да
название_базы_данных	струна	Имя базы данных виртуальных ядер MongoDB для использования с Azure Cosmos DB.	Да
встраивание_зависимости	onYourDataEndpointVectorizationSource или onYourDataDeploymentNameVectorizationSource		Да
соответствие полей	azureCosmosDBFieldMappingOptions	Необязательные параметры для управления обработкой полей при использовании настроенного ресурса Azure Cosmos DB.	Да
в пределах области	булевый	Следует ли ограничить запросы использованием индексированных данных.	нет
include_contexts	массив	Включенные свойства контекста вывода. Если не указано, значение по умолчанию равно citations и intent.	нет
имя_индекса	струна	Имя индекса виртуального ядра MongoDB для использования с Azure Cosmos DB.	Да
max_search_queries	целое число	Максимальное количество перезаписных запросов должно отправляться в поставщик поиска для одного сообщения пользователя. Если это не указано, система решит количество запросов для отправки.	нет
strictness	целое число	Настроенная строгость фильтрации релевантности поиска. Чем выше строгость, тем выше точность, но более низкий отзыв ответа.	нет
топ_n_документы	целое число	Настроено первое число документов для функции настроенного запроса.	нет

Опции отображения полей в Azure Cosmos DB

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

Имя.	Тип	Description	Обязательно	По умолчанию
поля_контента	массив	Имена полей индекса, которые следует рассматривать как содержимое.	Да
разделитель полей содержания	струна	Шаблон разделителя, который должны использовать поля содержимого.	нет
поле_пути_к_файлу	струна	Имя поля индекса, используемого в качестве файлового пути.	нет
поле_название	струна	Имя поля индекса, используемого в качестве заголовка.	нет
поле_ссылки	струна	Имя поля индекса, используемого в качестве URL-адреса.	нет
векторные поля	массив	Имена полей, представляющих векторные данные.	Да

elasticsearchChatExtensionConfiguration

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

Имя.	Тип	Description	Обязательно	По умолчанию
параметры	elasticsearchChatExtensionParameters	Параметры, используемые при настройке Elasticsearch в® качестве расширения чата OpenAI Azure.	нет
type	azureChatExtensionType	Представление данных конфигурации для одного расширения чата OpenAI Azure. Это будет использоваться запросом завершения чата, который должен использовать Azure расширения чата OpenAI для расширения поведения ответа. Использование этой конфигурации совместимо только с Azure OpenAI.	Да

elasticsearchChatExtensionParameters

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

Имя.	Тип	Description	Обязательно	По умолчанию
allow_partial_result	булевый	Если задано значение true, система позволит использовать частичные результаты поиска, и запрос завершается ошибкой, если все запросы завершаются ошибкой. Если запрос не указан или указан как false, запрос завершится ошибкой, если какой-либо поисковый запрос завершается ошибкой.	нет	Неправда
аутентификация	onYourDataKeyAndKeyIdAuthenticationOptions или onYourDataEncodedApiKeyAuthenticationOptions		Да
встраивание_зависимости	onYourDataEndpointVectorizationSource или onYourDataDeploymentNameVectorizationSource или onYourDataModelIdVectorizationSource		нет
endpoint	струна	Конечная точка Elasticsearch®.	Да
соответствие полей	elasticsearchIndexFieldMappingOptions	Необязательные параметры для управления обработкой полей при использовании настроенного ресурса Elasticsearch.®	нет
в пределах области	булевый	Следует ли ограничить запросы использованием индексированных данных.	нет
include_contexts	массив	Включенные свойства контекста вывода. Если не указано, значение по умолчанию равно citations и intent.	нет
имя_индекса	струна	Имя индекса Elasticsearch®.	Да
max_search_queries	целое число	Максимальное количество перезаписных запросов должно отправляться в поставщик поиска для одного сообщения пользователя. Если это не указано, система решит количество запросов для отправки.	нет
тип_запроса	elasticsearchQueryType	Тип запроса на получение Elasticsearch,® который должен выполняться при использовании в качестве расширения чата OpenAI Azure.	нет
strictness	целое число	Настроенная строгость фильтрации релевантности поиска. Чем выше строгость, тем выше точность, но более низкий отзыв ответа.	нет
топ_n_документы	целое число	Настроено первое число документов для функции настроенного запроса.	нет

elasticsearchIndexFieldMappingOptions

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

Имя.	Тип	Description	Обязательно	По умолчанию
поля_контента	массив	Имена полей индекса, которые следует рассматривать как содержимое.	нет
разделитель полей содержания	струна	Шаблон разделителя, который должны использовать поля содержимого.	нет
поле_пути_к_файлу	струна	Имя поля индекса, используемого в качестве файлового пути.	нет
поле_название	струна	Имя поля индекса, используемого в качестве заголовка.	нет
поле_ссылки	струна	Имя поля индекса, используемого в качестве URL-адреса.	нет
векторные поля	массив	Имена полей, представляющих векторные данные.	нет

elasticsearchQueryType

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

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

mongoDBChatExtensionConfiguration

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

Имя.	Тип	Description	Обязательно	По умолчанию
параметры	mongoDBChatExtensionParameters	Параметры, которые следует использовать при настройке расширений чата данных Azure OpenAI при использовании Mongo DB.	нет
type	azureChatExtensionType	Представление данных конфигурации для одного расширения чата OpenAI Azure. Это будет использоваться запросом завершения чата, который должен использовать Azure расширения чата OpenAI для расширения поведения ответа. Использование этой конфигурации совместимо только с Azure OpenAI.	Да

mongoDBChatExtensionParameters

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

Имя.	Тип	Description	Обязательно	По умолчанию
allow_partial_result	булевый	Если задано значение true, система позволит использовать частичные результаты поиска, и запрос завершается ошибкой, если все запросы завершаются ошибкой. Если запрос не указан или указан как false, запрос завершится ошибкой, если какой-либо поисковый запрос завершается ошибкой.	нет	Неправда
app_name	струна	Имя приложения Mongo DB.	Да
аутентификация	onYourDataUsernameAndPasswordAuthenticationOptions	Параметры проверки подлинности для Azure OpenAI On Your Data при использовании имени пользователя и пароля.	Да
collection_name	струна	Имя коллекции Базы данных Mongo.	Да
название_базы_данных	струна	Имя базы данных Mongo DB.	Да
встраивание_зависимости	onYourDataEndpointVectorizationSource или onYourDataDeploymentNameVectorizationSource		Да
endpoint	струна	Имя конечной точки кластера Mongo DB.	Да
соответствие полей	mongoDBFieldMappingOptions	Необязательные параметры для управления обработкой полей при использовании настроенного ресурса Mongo DB.	Да
в пределах области	булевый	Следует ли ограничить запросы использованием индексированных данных.	нет
include_contexts	массив	Включенные свойства контекста вывода. Если не указано, значение по умолчанию равно citations и intent.	нет
имя_индекса	струна	Имя индекса MongoDB.	Да
max_search_queries	целое число	Максимальное количество перезаписных запросов должно отправляться в поставщик поиска для одного сообщения пользователя. Если это не указано, система решит количество запросов для отправки.	нет
strictness	целое число	Настроенная строгость фильтрации релевантности поиска. Чем выше строгость, тем выше точность, но более низкий отзыв ответа.	нет
топ_n_документы	целое число	Настроено первое число документов для функции настроенного запроса.	нет

mongoDBFieldMappingOptions

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

Имя.	Тип	Description	Обязательно	По умолчанию
поля_контента	массив	Имена полей индекса, которые следует рассматривать как содержимое.	Да
разделитель полей содержания	струна	Шаблон разделителя, который должны использовать поля содержимого.	нет
поле_пути_к_файлу	струна	Имя поля индекса, используемого в качестве файлового пути.	нет
поле_название	струна	Имя поля индекса, используемого в качестве заголовка.	нет
поле_ссылки	струна	Имя поля индекса, используемого в качестве URL-адреса.	нет
векторные поля	массив	Имена полей, представляющих векторные данные.	Да

pineconeChatExtensionConfiguration

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

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

pineconeChatExtensionParameters

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

Имя.	Тип	Description	Обязательно	По умолчанию
allow_partial_result	булевый	Если задано значение true, система позволит использовать частичные результаты поиска, и запрос завершается ошибкой, если все запросы завершаются ошибкой. Если запрос не указан или указан как false, запрос завершится ошибкой, если какой-либо поисковый запрос завершается ошибкой.	нет	Неправда
аутентификация	Параметры проверки подлинности с использованием ключа API для onYourData	Параметры проверки подлинности Azure OpenAI On Your Data при использовании ключа API.	Да
встраивание_зависимости	onYourDataDeploymentNameVectorizationSource	Сведения о источнике векторизации, используемом Azure OpenAI On Your Data при применении векторного поиска, основанном на имени развертывания модели внутренних внедрения в том же Azure ресурсе OpenAI.	Да
environment	струна	Имя среды Pinecone.	Да
соответствие полей	pineconeFieldMappingOptions	Необязательные параметры для управления обработкой полей при использовании настроенного ресурса Pinecone.	Да
в пределах области	булевый	Следует ли ограничить запросы использованием индексированных данных.	нет
include_contexts	массив	Включенные свойства контекста вывода. Если не указано, значение по умолчанию равно citations и intent.	нет
имя_индекса	струна	Имя индекса базы данных Pinecone.	Да
max_search_queries	целое число	Максимальное количество перезаписных запросов должно отправляться в поставщик поиска для одного сообщения пользователя. Если это не указано, система решит количество запросов для отправки.	нет
strictness	целое число	Настроенная строгость фильтрации релевантности поиска. Чем выше строгость, тем выше точность, но более низкий отзыв ответа.	нет
топ_n_документы	целое число	Настроено первое число документов для функции настроенного запроса.	нет

pineconeFieldMappingOptions

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

Имя.	Тип	Description	Обязательно	По умолчанию
поля_контента	массив	Имена полей индекса, которые следует рассматривать как содержимое.	Да
разделитель полей содержания	струна	Шаблон разделителя, который должны использовать поля содержимого.	нет
поле_пути_к_файлу	струна	Имя поля индекса, используемого в качестве файлового пути.	нет
поле_название	струна	Имя поля индекса, используемого в качестве заголовка.	нет
поле_ссылки	струна	Имя поля индекса, используемого в качестве URL-адреса.	нет

варианты аутентификации вашей информации

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

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

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

Значение типа	Схема
api_key	Параметры проверки подлинности с использованием ключа API для onYourData
connection_string	onYourDataConnectionStringПараметрыАутентификации
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

Имя.	Тип	Description	Обязательно	По умолчанию
type	типАутентификацииВашихДанных	Типы проверки подлинности, поддерживаемые Azure OpenAI в данных.	Да

onYourDataContextProperty

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

Недвижимость	Ценность
Описание	Свойство контекста.
Тип	струна
Значения	citations intent all_retrieved_documents

Тип аутентификации ваших данных

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

Недвижимость	Ценность
Описание	Типы проверки подлинности, поддерживаемые Azure OpenAI в данных.
Тип	струна
Значения	api_key connection_string key_and_key_id encoded_api_key access_token system_assigned_managed_identity user_assigned_managed_identity username_and_password

параметры аутентификации ключа API для ваших данных

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

Имя.	Тип	Description	Обязательно	По умолчанию
ключ	струна	Ключ API, используемый для проверки подлинности.	нет
type	типАутентификацииВашихДанных	Типы проверки подлинности, поддерживаемые Azure OpenAI в данных.	Да

параметрыАутентификацииВашегоСтрокиПодключенияДанных

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

Имя.	Тип	Description	Обязательно	По умолчанию
строка подключения	струна	Connection string для проверки подлинности.	нет
type	типАутентификацииВашихДанных	Типы проверки подлинности, поддерживаемые Azure OpenAI в данных.	Да

onYourDataKeyAndKeyIdAuthenticationOptions

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

Имя.	Тип	Description	Обязательно	По умолчанию
ключ	струна	Ключ Elasticsearch, используемый для проверки подлинности.	нет
key_id	струна	Идентификатор ключа Elasticsearch, используемый для проверки подлинности.	нет
type	типАутентификацииВашихДанных	Типы проверки подлинности, поддерживаемые Azure OpenAI в данных.	Да

onYourDataEncodedApiKeyAuthenticationOptions

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

Имя.	Тип	Description	Обязательно	По умолчанию
encoded_api_key	струна	Ключ API в кодировке Elasticsearch, используемый для проверки подлинности.	нет
type	типАутентификацииВашихДанных	Типы проверки подлинности, поддерживаемые Azure OpenAI в данных.	Да

onYourDataAccessTokenAuthenticationOptions

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

Имя.	Тип	Description	Обязательно	По умолчанию
access_token	струна	Маркер access, используемый для проверки подлинности.	нет
type	типАутентификацииВашихДанных	Типы проверки подлинности, поддерживаемые Azure OpenAI в данных.	Да

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

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

Имя.	Тип	Description	Обязательно	По умолчанию
type	типАутентификацииВашихДанных	Типы проверки подлинности, поддерживаемые Azure OpenAI в данных.	Да

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

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

Имя.	Тип	Description	Обязательно	По умолчанию
идентификатор ресурса управляемой идентификации	струна	Идентификатор ресурса управляемого удостоверения, назначаемого пользователем, который будет использоваться для проверки подлинности.	нет
type	типАутентификацииВашихДанных	Типы проверки подлинности, поддерживаемые Azure OpenAI в данных.	Да

onYourDataUsernameAndPasswordAuthenticationOptions

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

Имя.	Тип	Description	Обязательно	По умолчанию
пароль	струна	Пароль. для проверки подлинности.	нет
type	типАутентификацииВашихДанных	Типы проверки подлинности, поддерживаемые Azure OpenAI в данных.	Да
username	струна	Имя пользователя, используемое для проверки подлинности.	нет

onYourDataVectorizationSource

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

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

Значение типа	Схема
endpoint	onYourDataEndpointVectorizationSource
deployment_name	onYourDataDeploymentNameVectorizationSource
integrated	onYourDataIntegratedVectorizationSource
model_id	onYourDataModelIdVectorizationSource

Имя.	Тип	Description	Обязательно	По умолчанию
type	ВашТипИсточникаДанныхДляВекторизации	Представляет доступные источники, Azure OpenAI On Your Data можно использовать для настройки векторизации данных для использования с векторным поиском.	Да

ВашТипИсточникВекториазцииДанных

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

Недвижимость	Ценность
Описание	Представляет доступные источники, Azure OpenAI On Your Data можно использовать для настройки векторизации данных для использования с векторным поиском.
Тип	струна
Значения	endpoint deployment_name integrated model_id

наВашемDataEndpointVectorizationSource

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

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

onYourDataDeploymentNameВекторизацияИсточник

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

Имя.	Тип	Description	Обязательно	По умолчанию
имя_развертывания	струна	Указывает имя развертывания модели, используемого для векторизации. Это развертывание модели должно находиться в том же Azure ресурсе OpenAI, но при использовании этого развертывания модели с помощью внутреннего вызова, а не общедоступного, что позволяет выполнять поиск векторов даже в частных сетях.	нет
dimensions	целое число	Количество измерений, которые должны быть внедренными. Поддерживается только в text-embedding-3 и более поздних моделях.	нет
type	ВашТипИсточникаДанныхДляВекторизации	Представляет доступные источники, Azure OpenAI On Your Data можно использовать для настройки векторизации данных для использования с векторным поиском.	Да

onYourDataIntegratedVectorizationSource

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

Имя.	Тип	Description	Обязательно	По умолчанию
type	ВашТипИсточникаДанныхДляВекторизации	Представляет доступные источники, Azure OpenAI On Your Data можно использовать для настройки векторизации данных для использования с векторным поиском.	Да

onYourDataModelIdVectorizationSource

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

Имя.	Тип	Description	Обязательно	По умолчанию
model_id	струна	Указывает идентификатор модели, используемый для векторизации. Этот идентификатор модели должен быть определен в search service.	нет
type	ВашТипИсточникаДанныхДляВекторизации	Представляет доступные источники, Azure OpenAI On Your Data можно использовать для настройки векторизации данных для использования с векторным поиском.	Да

azureChatExtensionsСообщениеКонтекст

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

Имя.	Тип	Description	Обязательно	По умолчанию
all_retrieved_documents	массив	Все извлеченные документы.	нет
citations	массив	Результат извлечения источника данных, используемый для создания сообщения помощника в ответе.	нет
намерение	струна	Обнаруженное намерение из журнала чата, используемое для передачи в следующий поворот для переноса контекста.	нет

citation

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

Имя.	Тип	Description	Обязательно	По умолчанию
идентификатор_блока	струна	Идентификатор фрагмента ссылки.	нет
содержимое	струна	Содержимое ссылки.	Да
filepath	струна	Путь к файлу ссылки.	нет
rerank_score	число/номер	Оценка повторного использования извлеченного документа.	нет
title	струна	Заголовок ссылки.	нет
URL-адрес	струна	URL-адрес ссылки.	нет

retrievedDocument

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

Имя.	Тип	Description	Обязательно	По умолчанию
идентификатор_блока	струна	Идентификатор фрагмента ссылки.	нет
содержимое	струна	Содержимое ссылки.	Да
data_source_index	целое число	Индекс источника данных.	нет
filepath	струна	Путь к файлу ссылки.	нет
filter_reason	filterReason	Причина фильтрации извлеченного документа.	нет
original_search_score	число/номер	Исходная оценка поиска извлеченного документа.	нет
rerank_score	число/номер	Оценка повторного использования извлеченного документа.	нет
search_queries	массив	Поисковые запросы, используемые для извлечения документа.	нет
title	струна	Заголовок ссылки.	нет
URL-адрес	струна	URL-адрес ссылки.	нет

filterReason

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

Недвижимость	Ценность
Описание	Причина фильтрации извлеченного документа.
Тип	струна
Значения	score rerank

вызов инструмента завершения чата

Имя.	Тип	Description	Обязательно	По умолчанию
function	объект	Функция, вызываемая моделью.	Да
└─ аргументы	струна	Аргументы, с которыми вызывается функция, как создается моделью в формате JSON. Обратите внимание, что модель не всегда создает допустимые json и может галлюцинировать параметры, не определенные схемой функции. Перед вызовом функции проверьте аргументы в коде.	нет
└️ имя	струна	Имя вызываемой функции.	нет
id	струна	Идентификатор вызова средства.	Да
type	тип вызова инструмента	Тип вызова средства в данном случае function.	Да

Тип вызова инструмента

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

Недвижимость	Ценность
Описание	Тип вызова средства в данном случае function.
Тип	струна
Значения	function

инструмент для обработки запросов завершения чата

Имя.	Тип	Description	Обязательно	По умолчанию
содержимое	струна	Содержимое сообщения.	нет
идентификатор вызова инструмента	струна	Вызов средства, на который отвечает это сообщение.	нет

Функция запроса сообщения для завершения чата

Имя.	Тип	Description	Обязательно	По умолчанию
содержимое	струна	Содержимое сообщения.	нет
имя	струна	Содержимое сообщения.	нет
роль	перечисление	Роль автора сообщений в данном случае function. Возможные значения: function	нет

createChatCompletionResponse

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

Имя.	Тип	Description	Обязательно	По умолчанию
choices	массив	Список вариантов завершения чата. Может быть больше одного, если n больше 1.	Да
создано	целое число	Метка времени Unix (в секундах) при создании завершения чата.	Да
id	струна	Уникальный идентификатор завершения чата.	Да
модель	струна	Модель, используемая для завершения чата.	Да
объект	перечисление	Тип объекта, который всегда chat.completionявляется . Возможные значения: chat.completion	Да
результаты_фильтрации_запросов	promptFilterResults	Результаты фильтрации содержимого для нуля или более запросов в запросе. В запросе потоковой передачи результаты для различных запросов могут поступать в разное время или в разных заказах.	нет
системный отпечаток	струна	Этот отпечаток представляет конфигурацию серверной части, с которой работает модель. Можно использовать в сочетании с параметром seed запроса, чтобы понять, когда внутренние изменения были внесены, что может повлиять на детерминированность.	нет
использование	completionUsage	Статистика использования для запроса завершения.	нет

createChatCompletionStreamResponse

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

Имя.	Тип	Description	Обязательно	По умолчанию
choices	массив	Список вариантов завершения чата. Может содержать несколько элементов, если n больше 1.	Да
создано	целое число	Метка времени Unix (в секундах) при создании завершения чата. Каждый блок имеет одинаковую метку времени.	Да
id	струна	Уникальный идентификатор завершения чата. Каждый блок имеет один и тот же идентификатор.	Да
модель	струна	Модель для создания завершения.	Да
объект	перечисление	Тип объекта, который всегда chat.completion.chunkявляется . Возможные значения: chat.completion.chunk	Да
системный отпечаток	струна	Этот отпечаток представляет конфигурацию серверной части, с которой работает модель. Можно использовать в сочетании с параметром seed запроса, чтобы понять, когда внутренние изменения были внесены, что может повлиять на детерминированность.	нет

chatCompletionStreamResponseDelta

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

Имя.	Тип	Description	Обязательно	По умолчанию
содержимое	струна	Содержимое сообщения блока.	нет
вызов_функции	объект	Устаревшие и замененные tool_calls. Имя и аргументы вызываемой функции, созданной моделью.	нет
└─ аргументы	струна	Аргументы, с которыми вызывается функция, как создается моделью в формате JSON. Обратите внимание, что модель не всегда создает допустимые json и может галлюцинировать параметры, не определенные схемой функции. Перед вызовом функции проверьте аргументы в коде.	нет
└️ имя	струна	Имя вызываемой функции.	нет
отказ	струна	Сообщение об отказе, созданное моделью.	нет
роль	перечисление	Роль автора этого сообщения. Возможные значения: system, , userassistanttool	нет
вызовы инструментов	массив		нет

чатКомплитМесседжТулКолЧанк

Имя.	Тип	Description	Обязательно	По умолчанию
function	объект		нет
└─ аргументы	струна	Аргументы, с которыми вызывается функция, как создается моделью в формате JSON. Обратите внимание, что модель не всегда создает допустимые json и может галлюцинировать параметры, не определенные схемой функции. Перед вызовом функции проверьте аргументы в коде.	нет
└️ имя	струна	Имя вызываемой функции.	нет
id	струна	Идентификатор вызова средства.	нет
index	целое число		Да
type	перечисление	Тип средства. В настоящее время поддерживается только function . Возможные значения: function	нет

Опции потока завершения чата (chatCompletionStreamOptions)

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

Имя.	Тип	Description	Обязательно	По умолчанию
включить_использование	булевый	Если задано, перед сообщением будет передаваться data: [DONE] дополнительный блок. Поле usage на этом блоке отображает статистику использования маркеров для всего запроса, и choices поле всегда будет пустым массивом. Все остальные блоки также будут содержать usage поле, но со значением NULL.	нет

Параметр chatCompletionChoiceLogProbs

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

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

вероятностная логарифмическая оценка токена завершения чата

Имя.	Тип	Description	Обязательно	По умолчанию
байт	массив	Список целых чисел, представляющих представление маркера UTF-8 байт. Полезно в случаях, когда символы представлены несколькими токенами, а их байтовые представления должны объединяться для создания правильного текстового представления. Может быть null , если для маркера нет представления байтов.	Да
logprob	число/номер	Вероятность этого токена в журнале.	Да
token	струна	Маркер.	Да
top_logprobs	массив	Список наиболее вероятных маркеров и их вероятности журналов в этой позиции маркера. В редких случаях количество запрошенных top_logprobs возвращаемых данных может быть меньше.	Да

сообщениеОтветОб окончанииЧата

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

Имя.	Тип	Description	Обязательно	По умолчанию
audio	объект	Если запрашивается модальность вывода звука, этот объект содержит данные о звуковом ответе модели.	нет
└─ Данные	струна	Звуковые байты в кодировке Base64, созданные моделью, в формате, указанном в запросе.	нет
└ истекает_в	целое число	Метка времени Unix (в секундах), когда этот звуковой ответ больше не будет доступен на сервере для использования в многоэтапных беседах.	нет
Идентификатор └️	струна	Уникальный идентификатор для этого звукового ответа.	нет
└─ Расшифровка	струна	Расшифровка звука, созданного моделью.	нет
содержимое	струна	Содержимое сообщения.	Да
context	azureChatExtensionsMessageContext	Представление дополнительных сведений о контексте, доступных при Azure расширениях чата OpenAI, участвует в создании соответствующего ответа на завершение чата. Эти сведения контекста заполняются только при использовании запроса OpenAI Azure, настроенного для использования соответствующего расширения.	нет
вызов_функции	вызов функции завершения чата	Устаревшие и замененные tool_calls. Имя и аргументы вызываемой функции, созданной моделью.	нет
отказ	струна	Сообщение об отказе, созданное моделью.	Да
роль	chatCompletionResponseMessageRole	Роль автора сообщения ответа.	Да
вызовы инструментов	массив	Вызовы средства, созданные моделью, например вызовы функций.	нет

рольСообщенияОтветаЗавершенияЧата

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

Недвижимость	Ценность
Описание	Роль автора сообщения ответа.
Тип	струна
Значения	assistant

Опция выбора инструмента завершения чата

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

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

• chatCompletionNamedToolChoice

выборИменованногоИнструментаЗавершенияЧата

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

Имя.	Тип	Description	Обязательно	По умолчанию
function	объект		Да
└️ имя	струна	Имя вызываемой функции.	нет
type	перечисление	Тип средства. В настоящее время поддерживается только function . Возможные значения: function	Да

ParallelToolCalls

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

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

PredictionContent

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

Имя.	Тип	Description	Обязательно	По умолчанию
содержимое	строка или массив	Содержимое, которое должно быть сопоставлено при создании ответа модели. Если созданные маркеры будут соответствовать этому содержимому, можно быстро вернуть весь ответ модели.	Да
type	перечисление	Тип прогнозируемого содержимого, который требуется предоставить. Этот тип в настоящее время всегда content. Возможные значения: content	Да

чатCompletionMessageToolCalls

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

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

ChatCompletionModalities

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

["text"]

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

["text", "audio"]

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

chatCompletionFunctionCall

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

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

Использование завершения

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

Имя.	Тип	Description	Обязательно	По умолчанию
токены завершения	целое число	Количество маркеров в созданном завершении.	Да
детали_токенов_завершения	объект	Разбивка маркеров, используемых в завершении.	нет
└️ accepted_prediction_tokens	целое число	При использовании прогнозируемых выходных данных число маркеров в прогнозе, появившемся в завершении.	нет
└audio_tokens	целое число	Маркеры ввода звука, созданные моделью.	нет
└️ reasoning_tokens	целое число	Маркеры, созданные моделью для рассуждений.	нет
└─ отклонённые_токены_предсказания	целое число	При использовании прогнозируемых выходных данных число маркеров в прогнозе, которое не отображалось в завершении. Однако, как и маркеры причин, эти маркеры по-прежнему учитываются в общих маркерах завершения для целей выставления счетов, выходных данных и контекстного окна.	нет
подсказывающие токены	целое число	Количество маркеров в запросе.	Да
prompt_tokens_details	объект	Сведения о маркерах запроса.	нет
└audio_tokens	целое число	Маркеры ввода звука, представленные в запросе.	нет
└ cached_tokens	целое число	Количество кэшированных маркеров запроса.	нет
общее количество токенов	целое число	Общее количество маркеров, используемых в запросе (запрос + завершение).	Да

инструмент завершения чата

Имя.	Тип	Description	Обязательно	По умолчанию
function	FunctionObject		Да
type	перечисление	Тип средства. В настоящее время поддерживается только function . Возможные значения: function	Да

ПараметрыФункции

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

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

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

FunctionObject

Имя.	Тип	Description	Обязательно	По умолчанию
описание	струна	Описание того, что выполняет функция, используемая моделью для выбора времени и способа вызова функции.	нет
имя	струна	Имя вызываемой функции. Должен быть a-z, A-Z, 0-9 или содержать символы подчеркивания и дефисы с максимальной длиной 64.	Да
параметры	FunctionParameters	Параметры, которые принимают функции, описаны как объект схемы JSON. See руководство например, и справочник по схеме JSON Schema для документации по формату. Опущение parameters определяет функцию с пустым списком параметров.	нет
строгий	булевый	Следует ли включить строгое соблюдение схемы при создании вызова функции. Если задано значение true, модель будет соответствовать точной схеме, определенной parameters в поле. Только подмножество схемы JSON поддерживается, если stricttrue.	нет	Неправда

ФорматОтветаТекст

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

ФорматОтветаJsonObject

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

ResponseFormatJsonSchemaSchema

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

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

ФорматОтветаJSONСхема

Имя.	Тип	Description	Обязательно	По умолчанию
JSON-схема	объект		Да
└─ Описание	струна	Описание формата ответа, которое используется моделью для определения того, как отвечать в этом формате.	нет
└️ имя	струна	Имя формата ответа. Должен быть a-z, A-Z, 0-9 или содержать символы подчеркивания и дефисы с максимальной длиной 64.	нет
└─ Схема	ResponseFormatJsonSchemaSchema	Схема формата ответа, описанная как объект схемы JSON.	нет
└─ строгий	булевый	Следует ли включить строгое соблюдение схемы при создании выходных данных. Если задано значение true, модель всегда будет соответствовать точной схеме, определенной schema в поле. Только подмножество схемы JSON поддерживается, если stricttrue.	нет	Неправда
type	перечисление	Тип формата ответа, который определяется: json_schema Возможные значения: json_schema	Да

общий выбор завершения чата

Имя.	Тип	Description	Обязательно	По умолчанию
причина окончания	струна		нет
index	целое число		нет

создатьЗапросНаПеревод

Запрос на перевод.

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

аудиоОтвет

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

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

audioVerboseResponse

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

Имя.	Тип	Description	Обязательно	По умолчанию
duration	число/номер	Длительность.	нет
язык	струна	Язык.	нет
segments	массив		нет
Задача	струна	Тип звуковой задачи.	нет
текст	струна	Переведенный или транскрибированные тексты.	Да
words	массив		нет

формат аудиоответа

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

Недвижимость	Ценность
Описание	Определяет формат выходных данных.
Тип	струна
Значения	json text srt verbose_json vtt

запрос на создание транскрипции

Запрос транскрибирования.

Имя.	Тип	Description	Обязательно	По умолчанию
файл	струна	Объект звукового файла для транскрибирования.	Да
язык	струна	Язык входного звука. Предоставление языка ввода в формате ISO-639-1 повышает точность и задержку.	нет
prompt	струна	Необязательный текст для руководства стилем модели или продолжением предыдущего сегмента звука. Запрос должен соответствовать языку звука.	нет
формат_ответа	audioResponseFormat	Определяет формат выходных данных.	нет
Температура	число/номер	Температура выборки от 0 до 1. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным. Если задано значение 0, модель использует логарифмическую вероятность для автоматического повышения температуры до тех пор, пока не будут достигнуты определенные пороговые значения.	нет	0
timestamp_granularities[]	массив	Гранулярность метки времени для заполнения этой транскрибирования. response_format необходимо задать verbose_json для использования детализации метки времени. Поддерживаются либо оба этих параметра: wordили segment. Примечание. Дополнительная задержка для меток времени сегмента отсутствует, но при создании меток времени слова возникает дополнительная задержка.	нет	['segment']

аудиосегмент

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

Имя.	Тип	Description	Обязательно	По умолчанию
avg_logprob	число/номер	Средняя вероятность журнала.	нет
коэффициент сжатия	число/номер	Коэффициент уплотнения.	нет
конец	число/номер	Смещение конца сегмента.	нет
id	целое число	Идентификатор сегмента.	нет
вероятность_отсутствия_речи	число/номер	Вероятность "нет речи".	нет
seek	число/номер	Смещение сегмента.	нет
начало	число/номер	Смещение запуска сегмента.	нет
Температура	число/номер	Temperature.	нет
текст	струна	Сегментирование текста.	нет
tokens	массив	Маркеры текста.	нет

audioWord

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

Имя.	Тип	Description	Обязательно	По умолчанию
конец	число/номер	Смещение конца Word.	нет
начало	число/номер	Смещение запуска Word.	нет
word	струна	Слово	нет

createSpeechRequest

Запрос речи.

Имя.	Тип	Description	Обязательно	По умолчанию
ввод	струна	Текст для синтеза звука. Максимальная длина — 4096 символов.	Да
формат_ответа	перечисление	Формат синтеза звука в. Возможные значения: mp3, opus, aac, flac, wav, pcm	нет
speed	число/номер	Скорость синтезированного звука. Выберите значение из 0.254.0. 1.0 — это значение по умолчанию.	нет	1.0
голос	перечисление	Голос, используемый для синтеза речи. Возможные значения: alloy, echo, fable, onyx, nova, shimmer	Да

качество изображения

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

Недвижимость	Ценность
Описание	Качество создаваемого изображения.
Тип	струна
По умолчанию	авто
Значения	auto high medium low hd standard

форматОтветаИзображений (imagesResponseFormat)

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

Недвижимость	Ценность
Описание	Формат, в котором возвращаются созданные изображения.
Тип	струна
По умолчанию	URL-адрес
Значения	url b64_json

imagesOutputFormat

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

Недвижимость	Ценность
Описание	Формат файла, в котором возвращаются созданные изображения. Поддерживается только для моделей серии gpt-image-1.
Тип	струна
По умолчанию	png
Значения	png jpeg

размер изображения

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

Недвижимость	Ценность
Описание	Размер созданных изображений.
Тип	струна
По умолчанию	авто
Значения	auto 1792x1024 1024x1792 1024x1024 1024x1536 1536x1024

стиль изображения

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

Недвижимость	Ценность
Описание	Стиль созданных изображений. Поддерживается только для dall-e-3.
Тип	струна
По умолчанию	vivid
Значения	vivid natural

imageBackground

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

Недвижимость	Ценность
Описание	Позволяет задать прозрачность фона созданных образов. Этот параметр поддерживается только для моделей серии gpt-image-1.
Тип	струна
По умолчанию	авто
Значения	transparent opaque auto

Запрос на генерацию изображений

Имя.	Тип	Description	Обязательно	По умолчанию
фон	imageBackground	Позволяет задать прозрачность фона созданных образов. Этот параметр поддерживается только для моделей серии gpt-image-1.	нет	авто
н	целое число	Количество генерируемых изображений. Для dall-e-3 поддерживается только n=1.	нет	1
сжатие вывода	целое число	Уровень сжатия (0–100%) для созданных образов. Этот параметр поддерживается только для моделей серии gpt-image-1 с форматом выходных данных JPEG.	нет	100
формат_выходных_данных	imagesOutputFormat	Формат файла, в котором возвращаются созданные изображения. Поддерживается только для моделей серии gpt-image-1.	нет	png
prompt	струна	Текстовое описание требуемых изображений. Максимальная длина — 32000 символов для моделей серии gpt-image-1 и 4000 символов для dall-e-3	Да
качество	imageQuality	Качество создаваемого изображения.	нет	авто
формат_ответа	imagesResponseFormat	Формат, в котором возвращаются созданные изображения. Поддерживается только для dall-e-3.	нет	URL-адрес
size	imageSize	Размер созданных изображений.	нет	авто
стиль	imageStyle	Стиль созданных изображений. Поддерживается только для dall-e-3.	нет	vivid
Пользователь	струна	Уникальный идентификатор, представляющий конечного пользователя, который может помочь в мониторинге и обнаружении злоупотреблений.	нет

imageEditsRequest

Имя.	Тип	Description	Обязательно	По умолчанию
image	строка или массив	Изображения для редактирования. Должен быть поддерживаемым файлом изображения или массивом изображений. Каждое изображение должно быть png или jpg-файл менее 25 МБ.	Да
mask	струна	Дополнительное изображение с областями полной прозрачности (например, где альфа-канал равен нулю) указывает, где следует отредактировать изображение. Если есть несколько изображений, маска будет применена к первому изображению. Должен быть допустимым PNG-файлом, менее 4 МБ и иметь те же размеры, что и изображение.	нет
н	целое число	Количество генерируемых изображений.	нет	1
prompt	струна	Текстовое описание требуемых изображений. Максимальная длина — 32000 символов.	Да
качество	imageQuality	Качество создаваемого изображения.	нет	авто
формат_ответа	imagesResponseFormat	Формат, в котором возвращаются созданные изображения.	нет	URL-адрес
size	imageSize	Размер созданных изображений.	нет	авто
Пользователь	струна	Уникальный идентификатор, представляющий конечного пользователя, который может помочь в мониторинге и обнаружении злоупотреблений.	нет

generateImagesResponse

Имя.	Тип	Description	Обязательно	По умолчанию
создано	целое число	Метка времени unix при создании операции.	Да
данные	массив	Результат операции при успешном выполнении	Да
использование	imageGenerationsUsage	Представляет сведения об использовании токенов для запросов на создание изображений. Только для моделей серии gpt-image-1.	нет

результат изображения

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

Имя.	Тип	Description	Обязательно	По умолчанию
b64_json	струна	Изображение в кодировке Base64	нет
результаты фильтрации контента	РезультатыФильтрацииКонтентаDalle	Сведения о результатах фильтрации содержимого.	нет
результаты_фильтрации_запросов	dalleFilterResults	Сведения о категории фильтрации содержимого (ненавидимая, сексуальность, насилие, self_harm), если она обнаружена, а также уровень серьезности (very_low, низкий, средний, высокомасштабируемый, определяющий интенсивность и уровень риска вредного содержимого) и если он был отфильтрован или нет. Сведения о содержимом и ненормативной лексике, если он обнаружен, и если он был отфильтрован или нет. И сведения о списке блокировок клиента, если он был отфильтрован и его идентификатор.	нет
пересмотренный_запрос	струна	Запрос, который использовался для создания образа, если в запросе была любая редакция.	нет
URL-адрес	струна	URL-адрес изображения.	нет

imageGenerationsUsage

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

Имя.	Тип	Description	Обязательно	По умолчанию
input_tokens	целое число	Количество входных токенов.	нет
input_tokens_details	объект	Подробная разбивка входных токенов.	нет
└─image_tokens	целое число	Количество токенов изображения.	нет
└️ текст_токены	целое число	Количество текстовых маркеров.	нет
output_tokens	целое число	Количество выходных токенов.	нет
общее количество токенов	целое число	Общее количество используемых токенов.	нет

линия

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

Имя.	Тип	Description	Обязательно	По умолчанию
spans	массив	Массив диапазонов, представляющих обнаруженные объекты и сведения о ограничивающем поле.	Да
текст	струна		Да

span

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

Имя.	Тип	Description	Обязательно	По умолчанию
length	целое число	Длина диапазона в символах, измеряемая в кодовых точках Юникода.	Да
offset	целое число	Смещение символов в тексте, в котором начинается диапазон. Это смещение определяется как позиция первого символа диапазона, подсчитывая от начала текста как кодовые точки Юникода.	Да
polygon	массив	Массив объектов, представляющих точки в многоугольнике, который заключает обнаруженный объект.	Да
текст	струна	Текстовое содержимое диапазона, представляющего обнаруженный объект.	Да

runCompletionUsage

Статистика использования, связанная с выполнением. Это значение будет иметь значение null , если выполнение не в состоянии терминала (т. е. in_progress, queuedи т. д.).

Имя.	Тип	Description	Обязательно	По умолчанию
токены завершения	целое число	Количество маркеров завершения, используемых в ходе выполнения.	Да
подсказывающие токены	целое число	Количество маркеров запроса, используемых в ходе выполнения.	Да
общее количество токенов	целое число	Общее количество используемых маркеров (запрос и завершение).	Да

runStepCompletionUsage

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

Имя.	Тип	Description	Обязательно	По умолчанию
токены завершения	целое число	Количество маркеров завершения, используемых на этапе выполнения.	Да
подсказывающие токены	целое число	Количество маркеров запроса, используемых на этапе выполнения.	Да
общее количество токенов	целое число	Общее количество используемых маркеров (запрос и завершение).	Да

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 модель может возвращать текст или любое необходимое значение.

Имя.	Тип	Description	Обязательно	По умолчанию
type	струна	Должен быть одним из text или json_object.	нет	текст

тип Enum: AssistantsApiResponseFormat

Ценность	Description
текст
json_object

assistantObject

Представляет объект assistant , который может вызывать модель и использовать средства.

Имя.	Тип	Description	Обязательно	По умолчанию
создано_в	целое число	Метка времени Unix (в секундах) для момента создания помощника.	Да
описание	струна	Описание помощника. Максимальная длина — 512 символов.	Да
id	струна	Идентификатор, на который можно ссылаться в конечных точках API.	Да
instructions	струна	Системные инструкции, которые использует помощник. Максимальная длина — 256 000 символов.	Да
metadata	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.	Да
модель	струна	Идентификатор используемой модели.	Да
имя	струна	Имя помощника. Максимальная длина — 256 символов.	Да
объект	струна	Тип объекта, который всегда assistantявляется .	Да
формат_ответа	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 или беседа превысила максимальную длину контекста.	нет
Температура	число/номер	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным.	нет	1
tool_resources	объект	Набор ресурсов, используемых средствами помощника. Ресурсы относятся к типу инструмента. Например, для code_interpreter средства требуется список идентификаторов файлов, а для file_search этого средства требуется список идентификаторов векторного хранилища.	нет
└─ интерпретатор_кода	объект		нет
└ file_ids	массив	Список идентификаторов файлов, доступных средству code_interpreter . С инструментом может быть не более 20 файлов.	нет	[]
└file_search	объект		нет
└️ vector_store_ids	массив	Идентификатор хранилища векторов, присоединенного к этому помощнику. К помощнику может быть подключено не более 1 векторного хранилища.	нет
инструменты	массив	Список инструментов, включенных помощником. На помощника может быть не более 128 инструментов. Средства могут быть типами code_interpreter, file_searchили function.	Да	[]
top_p	число/номер	Альтернативой выборке с температурой является так называемая выборка ядра, где модель рассматривает результаты маркеров с top_p всего массива значений вероятности. Таким образом, 0,1 означает, что учитываются только маркеры, входящие в верхние 10% массива значений вероятности. Как правило, мы рекомендуем изменить либо это значение, либо температуру, но не оба.	нет	1

объект Enum: AssistantObjectType

Ценность	Description
помощник	Тип объекта, который всегда является помощником

createAssistantRequest

Имя.	Тип	Description	Обязательно	По умолчанию
описание	струна	Описание помощника. Максимальная длина — 512 символов.	нет
instructions	струна	Системные инструкции, которые использует помощник. Максимальная длина — 256 000 символов.	нет
metadata	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.	нет
модель	струна		Да
имя	струна	Имя помощника. Максимальная длина — 256 символов.	нет
формат_ответа	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 или беседа превысила максимальную длину контекста.	нет
Температура	число/номер	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным.	нет	1
tool_resources	объект	Набор ресурсов, используемых средствами помощника. Ресурсы относятся к типу инструмента. Например, для code_interpreter средства требуется список идентификаторов файлов, а для file_search этого средства требуется список идентификаторов векторного хранилища.	нет
└─ интерпретатор_кода	объект		нет
└ file_ids	массив	Список идентификаторов файлов, доступных средству code_interpreter . С инструментом может быть не более 20 файлов.	нет	[]
└file_search	объект		нет
└️ vector_store_ids	массив	Хранилище векторов, присоединенное к этому помощнику. К помощнику может быть подключено не более 1 векторного хранилища.	нет
└️ vector_stores	массив	Помощник по созданию векторного хранилища с file_ids и присоединению его к этому помощнику. К помощнику может быть подключено не более 1 векторного хранилища.	нет
инструменты	массив	Список инструментов, включенных помощником. На помощника может быть не более 128 инструментов. Средства могут быть типами code_interpreter, retrievalили function.	нет	[]
top_p	число/номер	Альтернативой выборке с температурой является так называемая выборка ядра, где модель рассматривает результаты маркеров с top_p всего массива значений вероятности. Таким образом, 0,1 означает, что учитываются только маркеры, входящие в верхние 10% массива значений вероятности. Как правило, мы рекомендуем изменить либо это значение, либо температуру, но не оба.	нет	1

modifyAssistantRequest

Имя.	Тип	Description	Обязательно	По умолчанию
описание	струна	Описание помощника. Максимальная длина — 512 символов.	нет
instructions	струна	Системные инструкции, которые использует помощник. Максимальная длина — 32768 символов.	нет
metadata	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.	нет
модель	струна		нет
имя	струна	Имя помощника. Максимальная длина — 256 символов.	нет
формат_ответа	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 или беседа превысила максимальную длину контекста.	нет
Температура	число/номер	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным.	нет	1
tool_resources	объект	Набор ресурсов, используемых средствами помощника. Ресурсы относятся к типу инструмента. Например, для code_interpreter средства требуется список идентификаторов файлов, а для file_search этого средства требуется список идентификаторов векторного хранилища.	нет
└─ интерпретатор_кода	объект		нет
└ file_ids	массив	Переопределяет список идентификаторов файлов, доступных средству code_interpreter . С инструментом может быть не более 20 файлов.	нет	[]
└file_search	объект		нет
└️ vector_store_ids	массив	Переопределяет хранилище векторов, подключенное к этому помощнику. К помощнику может быть подключено не более 1 векторного хранилища.	нет
инструменты	массив	Список инструментов, включенных помощником. На помощника может быть не более 128 инструментов. Средства могут быть типами code_interpreter, retrievalили function.	нет	[]
top_p	число/номер	Альтернативой выборке с температурой является так называемая выборка ядра, где модель рассматривает результаты маркеров с top_p всего массива значений вероятности. Таким образом, 0,1 означает, что учитываются только маркеры, входящие в верхние 10% массива значений вероятности. Как правило, мы рекомендуем изменить либо это значение, либо температуру, но не оба.	нет	1

deleteAssistantResponse

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

объект Enum: DeleteAssistantResponseState

Ценность	Description
assistant.deleted

listAssistantsResponse

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

assistantToolsCode

Имя.	Тип	Description	Обязательно	По умолчанию
type	струна	Тип определяемого средства: code_interpreter	Да

тип Enum: assistantToolsCodeType

Ценность	Description
code_interpreter

assistantToolsFileSearch

Имя.	Тип	Description	Обязательно	По умолчанию
file_search	объект	Переопределяет средство поиска файлов.	нет
└️ max_num_results	целое число	Максимальное количество результатов, которые должен выводить средство поиска файлов. Значение по умолчанию — 20 для моделей gpt-4* и 5 для gpt-3.5-turbo. Это число должно быть от 1 до 50 включительно. Обратите внимание, что средство поиска файлов может выводить меньше max_num_results результатов.	нет
type	струна	Тип определяемого средства: file_search	Да

type Enum: Тип поиска файлов инструментов ассистента

Ценность	Description
file_search

assistantToolsFileSearchTypeOnly

Имя.	Тип	Description	Обязательно	По умолчанию
type	струна	Тип определяемого средства: file_search	Да

type Enum: Тип поиска файлов инструментов ассистента

Ценность	Description
file_search

assistantToolsFunction

Имя.	Тип	Description	Обязательно	По умолчанию
function	объект	Определение функции.	Да
└─ Описание	струна	Описание того, что выполняет функция, используемая моделью для выбора времени и способа вызова функции.	нет
└️ имя	струна	Имя вызываемой функции. Должен быть a-z, A-Z, 0-9 или содержать символы подчеркивания и дефисы с максимальной длиной 64.	нет
└️ Параметры	chatCompletionFunctionParameters	Параметры, которые принимают функции, описаны как объект схемы JSON. Примеры см. в guide/ и справочнике по схеме JSON schema документации по формату.	нет
type	струна	Тип определяемого средства: function	Да

Type Enum: assistantToolsFunction

Ценность	Description
function

truncationObject

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

Имя.	Тип	Description	Обязательно	По умолчанию
last_messages	целое число	Количество последних сообщений из потока при создании контекста для выполнения.	нет
type	струна	Стратегия усечения, используемая для потока. Значение по умолчанию — auto. Если задано значение last_messages, поток будет усечен до n последних сообщений в потоке. Если задано значение auto, сообщения в середине потока будут удалены, чтобы соответствовать длине контекста модели. max_prompt_tokens	Да

Type Enum: TruncationType

Ценность	Description
авто
last_messages

assistantsApiToolChoiceOption

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

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

• assistantsNamedToolChoice

assistantsNamedToolChoice

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

Имя.	Тип	Description	Обязательно	По умолчанию
function	объект		нет
└️ имя	струна	Имя вызываемой функции.	нет
type	струна	Тип средства. Если тип имеет тип function, необходимо задать имя функции.	Да

тип Enum: AssistantsNamedToolChoiceType

Ценность	Description
function
code_interpreter
file_search

runObject

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

Имя.	Тип	Description	Обязательно	По умолчанию
assistant_id	струна	Идентификатор помощника, используемого для выполнения этого запуска.	Да
отменено_в	целое число	Метка времени Unix (в секундах) для момента отмены выполнения.	Да
завершено_в	целое число	Метка времени Unix (в секундах) для завершения выполнения.	Да
создано_в	целое число	Метка времени Unix (в секундах) для момента создания запуска.	Да
срок_действия_до	целое число	Метка времени Unix (в секундах) для истечения срока действия выполнения.	Да
не удалось в	целое число	Метка времени Unix (в секундах) для момента сбоя выполнения.	Да
id	струна	Идентификатор, на который можно ссылаться в конечных точках API.	Да
incomplete_details	объект	Сведения о том, почему выполнение является неполным. Будет, null если выполнение не является неполным.	Да
└─ Причина	струна	Причина, по которой выполнение является неполным. Это указывает, какой определенный предел маркера был достигнут в течение выполнения.	нет
instructions	струна	Инструкции, используемые помощником для этого запуска.	Да
last_error	объект	Последняя ошибка, связанная с этим выполнением. null Если ошибок нет.	Да
└─ Код	струна	Один из server_error или rate_limit_exceeded.	нет
Сообщение └️	струна	Описание ошибки, доступной для чтения человеком.	нет
max_completion_tokens (максимальное количество токенов завершения)	целое число	Максимальное количество маркеров завершения, указанных в ходе выполнения.	Да
max_prompt_tokens	целое число	Максимальное количество маркеров запроса, указанных в ходе выполнения.	Да
metadata	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.	Да
модель	струна	Модель, используемая помощником для этого запуска.	Да
объект	струна	Тип объекта, который всегда thread.runявляется .	Да
вызовы инструмента в параллельном режиме	ParallelToolCalls	Следует ли включить параллельные вызовы функций во время использования средства.	нет	True
required_action	объект	Сведения о действии, необходимом для продолжения выполнения. null Если никаких действий не требуется.	Да
└submit_tool_outputs	объект	Сведения о выходных данных средства, необходимых для продолжения выполнения.	нет
└️ вызовы_инструмента	массив	Список соответствующих вызовов средства.	нет
└─ Тип	перечисление	На данный момент это всегда submit_tool_outputs. Возможные значения: submit_tool_outputs	нет
формат_ответа	assistantsApiResponseFormatOption	Указывает формат, который модель должна выводить. Совместим с GPT-4o, GPT-4 Turbo и всеми моделями GPT-3.5 Turbo с тех пор gpt-3.5-turbo-1106. Установка на { "type": "json_schema", "json_schema": {...} } включает структурированные выходные данные, которые обеспечивают соответствие модели вашей предоставленной схеме JSON. Дополнительные сведения см. в руководстве по структурированным выходным данным. Параметр включения { "type": "json_object" } режима JSON, который гарантирует, что модель создает сообщение является допустимым JSON. Важно: при использовании режима JSON необходимо также указать модели создавать JSON самостоятельно с помощью системного или пользовательского сообщения. Без этого модель может создать неуправляемый поток пробелов до тех пор, пока поколение не достигнет предела маркера, в результате чего длительный и, казалось бы, "застрявший" запрос. Кроме того, обратите внимание, что содержимое сообщения может быть частично отрезано, если finish_reason="length", что указывает на превышение поколения max_tokens или беседа превысила максимальную длину контекста.	Да
started_at	целое число	Метка времени Unix (в секундах) для начала выполнения.	Да
статус	струна	Состояние выполнения, которое может быть , , , , , queued, in_progressrequires_actionили cancelling. cancelledfailedcompletedexpired	Да
Температура	число/номер	Температура выборки, используемая для этого запуска. Если значение не задано, значение по умолчанию — 1.	нет
thread_id	струна	Идентификатор потока, на котором выполнялось выполнение в рамках этого запуска.	Да
выбор инструмента	assistantsApiToolChoiceOption	Определяет, какое средство (если таковое) вызывается моделью. none означает, что модель не будет вызывать средства и вместо этого создает сообщение. auto является значением по умолчанию и означает, что модель может выбирать между созданием сообщения или вызовом средства. Указание определенного инструмента, например {"type": "file_search"} или {"type": "function", "function": {"name": "my_function"}} принудительное вызов модели.	Да
инструменты	массив	Список инструментов, используемых помощником для этого запуска.	Да	[]
top_p	число/номер	Значение выборки ядра, используемое для этого запуска. Если значение не задано, значение по умолчанию — 1.	нет
truncation_strategy	truncationObject	Определяет, как поток будет усечен до выполнения. Используйте это для управления начальным окном контекста выполнения.	Да
использование	runCompletionUsage	Статистика использования, связанная с выполнением. Это значение будет иметь значение null , если выполнение не в состоянии терминала (т. е. in_progress, queuedи т. д.).	Да

объект Enum: runObjectType

Ценность	Description
thread.run	Тип объекта run, который всегда является thread.run

Состояние перечисления: RunObjectStatus

Ценность	Description
queued	Состояние очереди
in_progress	Состояние in_progress
requires_action	Состояние required_action
cancelling	Состояние отмены
cancelled	Отмененное состояние
ошибка	Состояние сбоя
завершено	Завершенное состояние
Истек	Состояние с истекшим сроком действия

createRunRequest

Имя.	Тип	Description	Обязательно	По умолчанию
additional_instructions	струна	Добавляет дополнительные инструкции в конце инструкций для выполнения. Это полезно для изменения поведения на основе каждого запуска без переопределения других инструкций.	нет
additional_messages	массив	Добавляет дополнительные сообщения в поток перед созданием запуска.	нет
assistant_id	струна	Идентификатор помощника, используемого для выполнения этого выполнения.	Да
instructions	струна	Переопределите системное сообщение помощника по умолчанию. Это полезно для изменения поведения на основе каждого запуска.	нет
max_completion_tokens (максимальное количество токенов завершения)	целое число	Максимальное количество маркеров завершения, которые могут использоваться в ходе выполнения. Выполнение старается по возможности использовать только указанное количество маркеров завершения на нескольких этапах выполнения. Если выполнение превышает указанное число маркеров завершения, выполнение завершится состоянием incomplete. Дополнительные сведения см. в incomplete_details.	нет
max_prompt_tokens	целое число	Максимальное количество маркеров запроса, которые могут использоваться в ходе выполнения. Выполняющая программа делает все возможное, чтобы использовать только указанное количество токенов подсказок в нескольких итерациях. Если выполнение превышает указанное число маркеров запроса, выполнение завершится состоянием incomplete. Дополнительные сведения см. в incomplete_details.	нет
metadata	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.	нет
модель	струна	Идентификатор модели, используемой для выполнения этого выполнения. Если здесь указано значение, оно переопределит модель, связанную с помощником. В противном случае будет использоваться модель, связанная с помощником.	нет
вызовы инструмента в параллельном режиме	ParallelToolCalls	Следует ли включить параллельные вызовы функций во время использования средства.	нет	True
формат_ответа	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 или беседа превысила максимальную длину контекста.	нет
поток	булевый	Если trueвозвращает поток событий, которые происходят во время событий запуска от имени сервера, завершая выполнение в состоянии терминала с сообщением data: [DONE] .	нет
Температура	число/номер	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным.	нет	1
выбор инструмента	assistantsApiToolChoiceOption	Определяет, какое средство (если таковое) вызывается моделью. none означает, что модель не будет вызывать средства и вместо этого создает сообщение. auto является значением по умолчанию и означает, что модель может выбирать между созданием сообщения или вызовом средства. Указание определенного инструмента, например {"type": "file_search"} или {"type": "function", "function": {"name": "my_function"}} принудительное вызов модели.	нет
инструменты	массив	Переопределите средства, которые помощник может использовать для этого запуска. Это полезно для изменения поведения на основе каждого запуска.	нет
top_p	число/номер	Альтернативой выборке с температурой является так называемая выборка ядра, где модель рассматривает результаты маркеров с top_p всего массива значений вероятности. Таким образом, 0,1 означает, что учитываются только маркеры, входящие в верхние 10% массива значений вероятности. Как правило, мы рекомендуем изменить либо это значение, либо температуру, но не оба.	нет	1
truncation_strategy	truncationObject	Определяет, как поток будет усечен до выполнения. Используйте это для управления начальным окном контекста выполнения.	нет

listRunsResponse

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

modifyRunRequest

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

submitToolOutputsRunRequest

Имя.	Тип	Description	Обязательно	По умолчанию
поток	булевый	Если trueвозвращает поток событий, которые происходят во время событий запуска от имени сервера, завершая выполнение в состоянии терминала с сообщением data: [DONE] .	нет
tool_outputs	массив	Список инструментов, для которых отправляются выходные данные.	Да

runToolCallObject

Объекты вызова средства

Имя.	Тип	Description	Обязательно	По умолчанию
function	объект	Определение функции.	Да
└─ аргументы	струна	Аргументы, которые модель ожидает передачи функции.	нет
└️ имя	струна	Имя функции.	нет
id	струна	Идентификатор вызова средства. Этот идентификатор должен ссылаться при отправке выходных данных средства с помощью выходных данных средства отправки для запуска endpointendpoint.	Да
type	струна	Для вызова выходных данных требуется тип средства. На данный момент это всегда function.	Да

тип Enum: RunToolCallObjectType

Ценность	Description
function

createThreadAndRunRequest

Имя.	Тип	Description	Обязательно	По умолчанию
assistant_id	струна	Идентификатор помощника, используемого для выполнения этого выполнения.	Да
instructions	струна	Переопределите системное сообщение помощника по умолчанию. Это полезно для изменения поведения на основе каждого запуска.	нет
max_completion_tokens (максимальное количество токенов завершения)	целое число	Максимальное количество маркеров завершения, которые могут использоваться в ходе выполнения. Выполнение старается по возможности использовать только указанное количество маркеров завершения на нескольких этапах выполнения. Если выполнение превышает указанное число маркеров завершения, выполнение завершится состоянием incomplete. Дополнительные сведения см. в incomplete_details.	нет
max_prompt_tokens	целое число	Максимальное количество маркеров запроса, которые могут использоваться в ходе выполнения. Выполняющая программа делает все возможное, чтобы использовать только указанное количество токенов подсказок в нескольких итерациях. Если выполнение превышает указанное число маркеров запроса, выполнение завершится состоянием incomplete. Дополнительные сведения см. в incomplete_details.	нет
metadata	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.	нет
модель	струна	Идентификатор моделей, используемых для выполнения этого выполнения. Если здесь указано значение, оно переопределит модель, связанную с помощником. В противном случае будет использоваться модель, связанная с помощником.	нет
вызовы инструмента в параллельном режиме	ParallelToolCalls	Следует ли включить параллельные вызовы функций во время использования средства.	нет	True
формат_ответа	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 или беседа превысила максимальную длину контекста.	нет
поток	булевый	Если trueвозвращает поток событий, которые происходят во время событий запуска от имени сервера, завершая выполнение в состоянии терминала с сообщением data: [DONE] .	нет
stream_options	chatCompletionStreamOptions	Параметры потокового ответа. Этот параметр устанавливается только при установке stream: true.	нет	None
Температура	число/номер	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным.	нет	1
thread	createThreadRequest		нет
выбор инструмента	assistantsApiToolChoiceOption	Определяет, какое средство (если таковое) вызывается моделью. none означает, что модель не будет вызывать средства и вместо этого создает сообщение. auto является значением по умолчанию и означает, что модель может выбирать между созданием сообщения или вызовом средства. Указание определенного инструмента, например {"type": "file_search"} или {"type": "function", "function": {"name": "my_function"}} принудительное вызов модели.	нет
tool_resources	объект	Набор ресурсов, используемых средствами помощника. Ресурсы относятся к типу инструмента. Например, для code_interpreter средства требуется список идентификаторов файлов, а для file_search этого средства требуется список идентификаторов векторного хранилища.	нет
└─ интерпретатор_кода	объект		нет
└ file_ids	массив	Список идентификаторов файлов, доступных средству code_interpreter . С инструментом может быть не более 20 файлов.	нет	[]
└file_search	объект		нет
└️ vector_store_ids	массив	Идентификатор хранилища векторов, присоединенного к этому помощнику. К помощнику может быть подключено не более 1 векторного хранилища.	нет
инструменты	массив	Переопределите средства, которые помощник может использовать для этого запуска. Это полезно для изменения поведения на основе каждого запуска.	нет
top_p	число/номер	Альтернативой выборке с температурой является так называемая выборка ядра, где модель рассматривает результаты маркеров с top_p всего массива значений вероятности. Таким образом, 0,1 означает, что учитываются только маркеры, входящие в верхние 10% массива значений вероятности. Как правило, мы рекомендуем изменить либо это значение, либо температуру, но не оба.	нет	1
truncation_strategy	truncationObject	Определяет, как поток будет усечен до выполнения. Используйте это для управления начальным окном контекста выполнения.	нет

threadObject

Представляет поток, содержащий сообщения.

Имя.	Тип	Description	Обязательно	По умолчанию
создано_в	целое число	Метка времени Unix (в секундах) для момента создания потока.	Да
id	струна	Идентификатор, на который можно ссылаться в конечных точках API.	Да
metadata	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.	Да
объект	струна	Тип объекта, который всегда threadявляется .	Да
tool_resources	объект	Набор ресурсов, доступных средствам помощника в этом потоке. Ресурсы относятся к типу инструмента. Например, для code_interpreter средства требуется список идентификаторов файлов, а для file_search этого средства требуется список идентификаторов векторного хранилища.	Да
└─ интерпретатор_кода	объект		нет
└ file_ids	массив	Список идентификаторов файлов, доступных средству code_interpreter . С инструментом может быть не более 20 файлов.	нет	[]
└file_search	объект		нет
└️ vector_store_ids	массив	Хранилище векторов, присоединенное к этому потоку. К потоку может быть подключено не более 1 векторного хранилища.	нет

объект Enum: ThreadObjectType

Ценность	Description
thread	Тип объекта потока, который всегда является thread

createThreadRequest

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

modifyThreadRequest

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

deleteThreadResponse

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

объект Enum: DeleteThreadResponseObjectState

Ценность	Description
thread.deleted	Состояние объекта ответа на поток удаления, которое является thread.deleted

listThreadsResponse

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

messageObject

Представляет сообщение в потоке.

Имя.	Тип	Description	Обязательно	По умолчанию
assistant_id	струна	Если применимо, идентификатор помощника, создающего это сообщение.	Да
attachments	массив	Список файлов, присоединенных к сообщению, и инструменты, к которому они были добавлены.	Да
завершено_в	целое число	Метка времени Unix (в секундах) для завершения сообщения.	Да
содержимое	массив	Содержимое сообщения в массиве текста и(или) изображений.	Да
создано_в	целое число	Метка времени Unix (в секундах) для момента создания сообщения.	Да
id	струна	Идентификатор, на который можно ссылаться в конечных точках API.	Да
incomplete_at	целое число	Метка времени Unix (в секундах) для момента, когда сообщение было отмечено как неполное.	Да
incomplete_details	объект	В неполном сообщении сведения о том, почему сообщение является неполным.	Да
└─ Причина	струна	Причина, по которой сообщение является неполным.	нет
metadata	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.	Да
объект	струна	Тип объекта, который всегда thread.messageявляется .	Да
роль	струна	Сущность, создающая сообщение. Один из user или assistant.	Да
run_id	струна	Если применимо, идентификатор выполнения, связанный с автором этого сообщения.	Да
статус	струна	Состояние сообщения, которое может быть либо in_progress, incompleteлибо completed.	Да
thread_id	струна	Идентификатор потока, к которому принадлежит это сообщение.	Да

объект Enum: MessageObjectType

Ценность	Description
thread.message	Тип объекта сообщения, который является thread.message

Состояние перечисления: MessageObjectStatus

Ценность	Description
in_progress
incomplete
завершено

перечисление роли: MessageObjectRole

Ценность	Description
Пользователь
помощник

messageDeltaObject

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

Имя.	Тип	Description	Обязательно	По умолчанию
delta	объект	Разностное значение, содержащее поля, измененные в сообщении.	Да
└─ Содержимое	массив	Содержимое сообщения в массиве текста и(или) изображений.	нет
└─ роль	струна	Сущность, создающая сообщение. Один из user или assistant.	нет
id	струна	Идентификатор сообщения, на которое можно ссылаться в конечных точках API.	Да
объект	струна	Тип объекта, который всегда thread.message.deltaявляется .	Да

объект Enum: MessageDeltaObjectType

Ценность	Description
thread.message.delta

createMessageRequest

Имя.	Тип	Description	Обязательно	По умолчанию
attachments	массив	Список файлов, присоединенных к сообщению, и инструменты, к которому они должны быть добавлены.	нет
содержимое	струна	Содержимое сообщения.	Да
metadata	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.	нет
роль	струна	Роль сущности, создающей сообщение. Допустимые значения: - user: указывает, что сообщение отправляется фактическим пользователем и должно использоваться в большинстве случаев для представления сообщений, созданных пользователем. - assistant: указывает, что сообщение создается помощником. Используйте это значение для вставки сообщений от помощника в беседу.	Да

role Enum: CreateMessageRequestRole

Ценность	Description
Пользователь
помощник

modifyMessageRequest

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

deleteMessageResponse

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

объект Enum: DeleteMessageResponseObject

Ценность	Description
thread.message.deleted	Состояние объекта ответа на удаление сообщения

listMessagesResponse

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

messageContentImageFileObject

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

Имя.	Тип	Description	Обязательно	По умолчанию
image_file	объект		Да
└ file_id	струна	Идентификатор файла изображения в содержимом сообщения.	нет
type	струна	Всегда image_file.	Да

Тип Enum: MessageContentImageFileObjectType

Ценность	Description
image_file	Тип файла изображения содержимого сообщения

messageContentTextObject

Текстовое содержимое, которое входит в сообщение.

Имя.	Тип	Description	Обязательно	По умолчанию
текст	объект		Да
Заметки └️	массив		нет
└─ Значение	струна	Данные, составляющие текст.	нет
type	струна	Всегда text.	Да

тип Enum: messageContentTextObjectType

Ценность	Description
текст	Тип текстового объекта содержимого сообщения

messageContentTextAnnotationsFileCitationObject

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

Имя.	Тип	Description	Обязательно	По умолчанию
end_index	целое число		Да
file_citation	объект		Да
└ file_id	струна	Идентификатор конкретного файла, из из который находится ссылка.	нет
start_index	целое число		Да
текст	струна	Текст в содержимом сообщения, который необходимо заменить.	Да
type	струна	Всегда file_citation.	Да

Type Enum: FileCitationObjectType

Ценность	Description
file_citation	Тип объекта ссылки на файл

messageContentTextAnnotationsFilePathObject

URL-адрес файла, созданного при создании файла помощником, который использовал code_interpreter средство для создания файла.

Имя.	Тип	Description	Обязательно	По умолчанию
end_index	целое число		Да
file_path	объект		Да
└ file_id	струна	Идентификатор созданного файла.	нет
start_index	целое число		Да
текст	струна	Текст в содержимом сообщения, который необходимо заменить.	Да
type	струна	Всегда file_path.	Да

тип Enum: FilePathObjectType

Ценность	Description
file_path	Тип объекта пути к файлу

messageDeltaContentImageFileObject

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

Имя.	Тип	Description	Обязательно	По умолчанию
image_file	объект		нет
└ file_id	струна	Идентификатор файла изображения в содержимом сообщения.	нет
index	целое число	Индекс части содержимого в сообщении.	Да
type	струна	Всегда image_file.	Да

Тип Enum: MessageDeltaContentImageFileObjectType

Ценность	Description
image_file

messageDeltaContentTextObject

Текстовое содержимое, которое входит в сообщение.

Имя.	Тип	Description	Обязательно	По умолчанию
index	целое число	Индекс части содержимого в сообщении.	Да
текст	объект		нет
Заметки └️	массив		нет
└─ Значение	струна	Данные, составляющие текст.	нет
type	струна	Всегда text.	Да

тип Enum: MessageDeltaContentTextObjectType

Ценность	Description
текст

messageDeltaContentTextAnnotationsFileCitationObject

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

Имя.	Тип	Description	Обязательно	По умолчанию
end_index	целое число		нет
file_citation	объект		нет
└ file_id	струна	Идентификатор конкретного файла, из из который находится ссылка.	нет
цитата	струна	Конкретная цитата в файле.	нет
index	целое число	Индекс заметки в части текстового содержимого.	Да
start_index	целое число		нет
текст	струна	Текст в содержимом сообщения, который необходимо заменить.	нет
type	струна	Всегда file_citation.	Да

тип Enum: MessageDeltaContentTextAnnotationsFileCitationObjectType

Ценность	Description
file_citation

messageDeltaContentTextAnnotationsFilePathObject

URL-адрес файла, созданного при создании файла помощником, который использовал code_interpreter средство для создания файла.

Имя.	Тип	Description	Обязательно	По умолчанию
end_index	целое число		нет
file_path	объект		нет
└ file_id	струна	Идентификатор созданного файла.	нет
index	целое число	Индекс заметки в части текстового содержимого.	Да
start_index	целое число		нет
текст	струна	Текст в содержимом сообщения, который необходимо заменить.	нет
type	струна	Всегда file_path.	Да

тип Enum: MessageDeltaContentTextAnnotationsFilePathObjectType

Ценность	Description
file_path

runStepObject

Представляет шаг выполнения выполнения выполнения.

Имя.	Тип	Description	Обязательно	По умолчанию
assistant_id	струна	Идентификатор помощника, связанного с шагом выполнения.	Да
отменено_в	целое число	Метка времени Unix (в секундах) для момента отмены шага выполнения.	Да
завершено_в	целое число	Метка времени Unix (в секундах) для завершения шага выполнения.	Да
создано_в	целое число	Метка времени Unix (в секундах) для момента создания шага выполнения.	Да
истекло_в	целое число	Метка времени Unix (в секундах) для истечения срока действия выполнения. Шаг считается истекшим, если срок действия родительского запуска истек.	Да
не удалось в	целое число	Метка времени Unix (в секундах) для момента сбоя шага выполнения.	Да
id	струна	Идентификатор шага выполнения, на который можно ссылаться в конечных точках API.	Да
last_error	объект	Последняя ошибка, связанная с этим шагом выполнения. null Если ошибок нет.	Да
└─ Код	струна	Один из server_error или rate_limit_exceeded.	нет
Сообщение └️	струна	Описание ошибки, доступной для чтения человеком.	нет
metadata	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.	Да
объект	струна	Тип объекта, который всегда assistant.run.stepявляется .	Да
run_id	струна	Идентификатор выполнения, на который выполняется этот шаг, является частью.	Да
статус	струна	Состояние выполнения, которое может быть либо in_progress, либо cancelledfailedcompletedexpired.	Да
step_details	runStepDetailsMessageCreationObject или runStepDetailsToolCallsObject	Сведения о шаге выполнения.	Да
thread_id	струна	Идентификатор выполняемых потоков.	Да
type	струна	Тип шага выполнения, который может быть либо message_creationtool_calls.	Да

объект Enum: RunStepObjectType

Ценность	Description
assistant.run.step	Тип объекта, который всегда является assistant.run.step

Тип Enum: RunStepObjectType

Ценность	Description
message_creation	Шаг выполнения message_creation
вызовы инструментов	Шаг выполнения tool_calls

состояние Перечисления: RunStepObjectStatus

Ценность	Description
in_progress	Состояние выполнения in_progress
cancelled	Состояние отмененного выполнения
ошибка	Состояние отмененного выполнения
завершено	Состояние отмененного выполнения
Истек	Состояние отмененного выполнения

runStepDeltaObject

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

Имя.	Тип	Description	Обязательно	По умолчанию
delta	объект	Разностное значение, содержащее поля, измененные на шаге выполнения.	Да
└─детали_шага	runStepDeltaStepDetailsMessageCreationObject или runStepDeltaStepDetailsToolCallsObject	Сведения о шаге выполнения.	нет
id	струна	Идентификатор шага выполнения, на который можно ссылаться в конечных точках API.	Да
объект	струна	Тип объекта, который всегда thread.run.step.deltaявляется .	Да

объект Enum: RunStepDeltaObjectType

Ценность	Description
thread.run.step.delta

listRunStepsResponse

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

runStepDetailsMessageCreationObject

Сведения о создании сообщения на шаге выполнения.

Имя.	Тип	Description	Обязательно	По умолчанию
message_creation	объект		Да
└message_id	струна	Идентификатор сообщения, созданного на этом шаге выполнения.	нет
type	струна	Всегда message_creation.	Да

тип Enum: RunStepDetailsMessageCreationObjectType

Ценность	Description
message_creation

runStepDeltaStepDetailsMessageCreationObject

Сведения о создании сообщения на шаге выполнения.

Имя.	Тип	Description	Обязательно	По умолчанию
message_creation	объект		нет
└message_id	струна	Идентификатор сообщения, созданного на этом шаге выполнения.	нет
type	струна	Всегда message_creation.	Да

type Enum: ШагЗапускаСдвигаШагПодробностиСозданиеСообщенияТипОбъекта

Ценность	Description
message_creation

runStepDetailsToolCallsObject

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

Имя.	Тип	Description	Обязательно	По умолчанию
вызовы инструментов	массив	Массив инструментов вызывает этап выполнения. Они могут быть связаны с одним из трех типов инструментов: code_interpreterretrieval или function.	Да
type	струна	Всегда tool_calls.	Да

тип Enum: RunStepDetailsToolCallsObjectType

Ценность	Description
вызовы инструментов

runStepDeltaStepDetailsToolCallsObject

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

Имя.	Тип	Description	Обязательно	По умолчанию
вызовы инструментов	массив	Массив инструментов вызывает этап выполнения. Они могут быть связаны с одним из трех типов инструментов: code_interpreterfile_search или function.	нет
type	струна	Всегда tool_calls.	Да

тип Enum: RunStepDeltaStepDetailsToolCallsObjectType

Ценность	Description
вызовы инструментов

runStepDetailsToolCallsCodeObject

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

Имя.	Тип	Description	Обязательно	По умолчанию
code_interpreter	объект	Определение вызова средства интерпретатора кода.	Да
└─ Входные данные	струна	Входные данные вызова средства интерпретатора кода.	нет
└─ Выходные данные	массив	Выходные данные вызова средства интерпретатора кода. Интерпретатор кода может выводить один или несколько элементов, включая текст (logs) или изображения (image). Каждая из них представлена различным типом объекта.	нет
id	струна	Идентификатор вызова средства.	Да
type	струна	Тип вызова средства. Это всегда будет для code_interpreter этого типа вызова средства.	Да

тип Enum: RunStepDetailsToolCallsCodeObjectType

Ценность	Description
code_interpreter

runStepDeltaStepDetailsToolCallsCodeObject

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

Имя.	Тип	Description	Обязательно	По умолчанию
code_interpreter	объект	Определение вызова средства интерпретатора кода.	нет
└─ Входные данные	струна	Входные данные вызова средства интерпретатора кода.	нет
└─ Выходные данные	массив	Выходные данные вызова средства интерпретатора кода. Интерпретатор кода может выводить один или несколько элементов, включая текст (logs) или изображения (image). Каждая из них представлена различным типом объекта.	нет
id	струна	Идентификатор вызова средства.	нет
index	целое число	Индекс вызова средства в массиве вызовов средства.	Да
type	струна	Тип вызова средства. Это всегда будет для code_interpreter этого типа вызова средства.	Да

тип Enum: RunStepDeltaStepDetailsToolCallsCodeObjectType

Ценность	Description
code_interpreter

runStepDetailsToolCallsCodeOutputLogsObject

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

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

Тип Enum: Объект RunStepDetailsToolCallsCodeOutputLogsObjectType

Ценность	Description
logs

runStepDeltaStepDetailsToolCallsCodeOutputLogsObject

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

Имя.	Тип	Description	Обязательно	По умолчанию
index	целое число	Индекс выходных данных в массиве выходных данных.	Да
logs	струна	Вывод текста из вызова средства интерпретатора кода.	нет
type	струна	Всегда logs.	Да

type Enum: ЗапускШагДельтаШагДеталиВызовыИнструментовКодВыводЛогиТипОбъекта

Ценность	Description
logs

runStepDetailsToolCallsCodeOutputImageObject

Имя.	Тип	Description	Обязательно	По умолчанию
image	объект		Да
└ file_id	струна	Идентификатор файла изображения.	нет
type	струна	Всегда image.	Да

тип Enum: RunStepDetailsToolCallsCodeOutputImageObjectType

Ценность	Description
image

runStepDeltaStepDetailsToolCallsCodeOutputImageObject

Имя.	Тип	Description	Обязательно	По умолчанию
image	объект		нет
└ file_id	струна	Идентификатор файла изображения.	нет
index	целое число	Индекс выходных данных в массиве выходных данных.	Да
type	струна	Всегда image.	Да

тип Enum: RunStepDeltaStepDetailsToolCallsCodeOutputImageObject

Ценность	Description
image

runStepDetailsToolCallsFileSearchObject

Имя.	Тип	Description	Обязательно	По умолчанию
file_search	объект	В настоящее время это всегда будет пустым объектом.	Да
└ Результаты	массив	Результаты поиска файла.	нет
id	струна	Идентификатор объекта вызова средства.	Да
type	струна	Тип вызова средства. Это всегда будет для file_search этого типа вызова средства.	Да

Тип Enum: RunStepDetailsToolCallsFileSearchObjectType

Ценность	Description
file_search

runStepDetailsToolCallsFileSearchResultObject

Результирующий экземпляр поиска файла.

Имя.	Тип	Description	Обязательно	По умолчанию
содержимое	массив	Содержимое найденного результата. Содержимое включается только в том случае, если он запрашивается с помощью параметра запроса include.	нет
идентификатор_файла	струна	Идентификатор файла, в который был найден результат.	Да
file_name	струна	Имя файла, в результате в который был найден результат.	Да
счёт	число/номер	Оценка результата. Все значения должны быть числом с плавающей запятой от 0 до 1.	Да

runStepDeltaStepDetailsToolCallsFileSearchObject

Имя.	Тип	Description	Обязательно	По умолчанию
file_search	объект	В настоящее время это всегда будет пустым объектом.	Да
id	струна	Идентификатор объекта вызова средства.	нет
index	целое число	Индекс вызова средства в массиве вызовов средства.	Да
type	струна	Тип вызова средства. Это всегда будет для retrieval этого типа вызова средства.	Да

тип Enum: RunStepDeltaStepDetailsToolCallsFileSearchObjectType

Ценность	Description
file_search

runStepDetailsToolCallsFunctionObject

Имя.	Тип	Description	Обязательно	По умолчанию
function	объект	Определение вызываемой функции.	Да
└─ аргументы	струна	Аргументы, переданные функции.	нет
└️ имя	струна	Имя функции.	нет
вывод └─	струна	Выходные данные функции. Это будет, null если выходные данные еще не отправлены.	нет
id	струна	Идентификатор объекта вызова средства.	Да
type	струна	Тип вызова средства. Это всегда будет для function этого типа вызова средства.	Да

тип Enum: RunStepDetailsToolCallsFunctionObjectType

Ценность	Description
function

runStepDeltaStepDetailsToolCallsFunctionObject

Имя.	Тип	Description	Обязательно	По умолчанию
function	объект	Определение вызываемой функции.	нет
└─ аргументы	струна	Аргументы, переданные функции.	нет
└️ имя	струна	Имя функции.	нет
вывод └─	струна	Выходные данные функции. Это будет, null если выходные данные еще не отправлены.	нет
id	струна	Идентификатор объекта вызова средства.	нет
index	целое число	Индекс вызова средства в массиве вызовов средства.	Да
type	струна	Тип вызова средства. Это всегда будет для function этого типа вызова средства.	Да

тип Enum: RunStepDetailsToolCallsFunctionObjectType

Ценность	Description
function

vectorStoreExpirationAfter

Политика истечения срока действия для хранилища векторов.

Имя.	Тип	Description	Обязательно	По умолчанию
anchor	струна	Метка времени привязки, после которой применяется политика истечения срока действия. Поддерживаемые привязки: last_active_at.	Да
Дни	целое число	Количество дней после истечения срока действия привязки хранилища векторов.	Да

перечисление привязки: VectorStoreExpirationAfterAnchor

Ценность	Description
last_active_at	Метка времени привязки, после которой применяется политика истечения срока действия.

vectorStoreObject

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

Имя.	Тип	Description	Обязательно	По умолчанию
создано_в	целое число	Метка времени Unix (в секундах) для создания векторного хранилища.	Да
истекает через	vectorStoreExpirationAfter	Политика истечения срока действия для хранилища векторов.	нет
срок_действия_до	целое число	Метка времени Unix (в секундах) для истечения срока действия хранилища векторов.	нет
file_counts	объект		Да
└️ отменено	целое число	Количество отмененных файлов.	нет
└️ завершено	целое число	Количество успешно обработанных файлов.	нет
└─ Ошибка	целое число	Количество файлов, которые не удалось обработать.	нет
└─ в процессе	целое число	Количество обрабатываемых файлов.	нет
└─ всего	целое число	Общее количество файлов.	нет
id	струна	Идентификатор, на который можно ссылаться в конечных точках API.	Да
last_active_at	целое число	Метка времени Unix (в секундах) для последнего активного хранилища векторов.	Да
metadata	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.	Да
имя	струна	Имя векторного хранилища.	Да
объект	перечисление	Тип объекта, который всегда vector_storeявляется . Возможные значения: vector_store	Да
статус	струна	Состояние векторного хранилища, которое может быть либо expired, in_progressлибо completed. Состояние указывает, что хранилище векторов completed готово для использования.	Да
usage_bytes	целое число	Общее количество байтов, используемых файлами в хранилище векторов.	Да

Перечисление состояния: VectorStoreObjectStatus

Ценность	Description
Истек
in_progress
завершено

createVectorStoreRequest

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

updateVectorStoreRequest

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

listVectorStoresResponse

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

deleteVectorStoreResponse

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

объект Enum: DeleteVectorStoreResponseObject

Ценность	Description
vector_store.deleted	Состояние объекта ответа хранилища векторов удаления

vectorStoreFileObject

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

Имя.	Тип	Description	Обязательно	По умолчанию
chunking_strategy	autoChunkingStrategyRequestParam или staticChunkingStrategyRequestParam	Стратегия блокирования, используемая для блокирования файлов. Если этот параметр не задан, используйте стратегию auto . Применимо только в том случае, если file_ids не пуст.	нет
создано_в	целое число	Метка времени Unix (в секундах) для момента создания файла векторного хранилища.	Да
id	струна	Идентификатор, на который можно ссылаться в конечных точках API.	Да
last_error	объект	Последняя ошибка, связанная с этим файлом хранилища векторов. null Если ошибок нет.	Да
└─ Код	струна	Одно или server_errorinvalid_file или unsupported_file.	нет
Сообщение └️	струна	Описание ошибки, доступной для чтения человеком.	нет
объект	струна	Тип объекта, который всегда vector_store.fileявляется .	Да
статус	струна	Состояние файла векторного хранилища, который может быть либо in_progress, completedcancelledлибо failed. completed Состояние указывает, что файл векторного хранилища готов к использованию.	Да
usage_bytes	целое число	Общее использование векторного хранилища в байтах. Обратите внимание, что это может отличаться от исходного размера файла.	Да
vector_store_id	струна	Идентификатор векторного хранилища, к которому подключен файл.	Да

объект Enum: VectorStoreFileObjectType

Ценность	Description
vector_store.file

Состояние перечисления: VectorStoreFileObjectStatus

Ценность	Description
in_progress
завершено
cancelled
ошибка

otherChunkingStrategyResponseParam

Это возвращается, когда стратегия блокирования неизвестна. Как правило, это связано с тем, что файл был индексирован до chunking_strategy появления концепции в API.

Имя.	Тип	Description	Обязательно	По умолчанию
type	струна	Всегда other.	Да

тип Enum: OtherChunkingStrategyResponseParamType

Ценность	Description
other

staticChunkingStrategyResponseParam

Имя.	Тип	Description	Обязательно	По умолчанию
статичный	staticChunkingStrategy		Да
type	струна	Всегда static.	Да

тип Enum: StaticChunkingStrategyResponseParamType

Ценность	Description
статичный

staticChunkingStrategy

Имя.	Тип	Description	Обязательно	По умолчанию
chunk_overlap_tokens	целое число	Количество маркеров, перекрывающихся между блоками. Значение по умолчанию — 400. Обратите внимание, что перекрытие не должно превышать половину max_chunk_size_tokens.	Да
max_chunk_size_tokens	целое число	Максимальное количество токенов в каждом блоке. Значение по умолчанию — 800. Минимальное значение равно 100 , а максимальное — 4096.	Да

autoChunkingStrategyRequestParam

Стратегия по умолчанию. В настоящее время эта стратегия использует и max_chunk_size_tokens имеет значение 800chunk_overlap_tokens .400

Имя.	Тип	Description	Обязательно	По умолчанию
type	перечисление	Всегда auto. Возможные значения: auto	Да

staticChunkingStrategyRequestParam

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

chunkingStrategyRequestParam

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

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

• autoChunkingStrategyRequestParam
• staticChunkingStrategyRequestParam

createVectorStoreFileRequest

Имя.	Тип	Description	Обязательно	По умолчанию
chunking_strategy	chunkingStrategyRequestParam	Стратегия блокирования, используемая для блокирования файлов. Если этот параметр не задан, используйте стратегию auto .	нет
идентификатор_файла	струна	Идентификатор файла, который должен использовать хранилище векторов. Полезно для таких средств, как file_search, которые могут access файлов.	Да

listVectorStoreFilesResponse

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

deleteVectorStoreFileResponse

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

объект Enum: DeleteVectorStoreFileResponseObject

Ценность	Description
vector_store.file.deleted

vectorStoreFileBatchObject

Пакет файлов, присоединенных к хранилищу векторов.

Имя.	Тип	Description	Обязательно	По умолчанию
создано_в	целое число	Метка времени Unix (в секундах) для создания пакета файлов векторного хранилища.	Да
file_counts	объект		Да
└️ отменено	целое число	Количество отмененных файлов.	нет
└️ завершено	целое число	Количество обработанных файлов.	нет
└─ Ошибка	целое число	Количество файлов, которые не удалось обработать.	нет
└─ в процессе	целое число	Количество обрабатываемых файлов.	нет
└─ всего	целое число	Общее количество файлов.	нет
id	струна	Идентификатор, на который можно ссылаться в конечных точках API.	Да
объект	струна	Тип объекта, который всегда vector_store.file_batchявляется .	Да
статус	струна	Состояние пакета векторного хранилища файлов, которые могут быть либо in_progress, completedcancelled либо failed.	Да
vector_store_id	струна	Идентификатор векторного хранилища, к которому подключен файл.	Да

объект Enum: VectorStoreFileBatchObjectType

Ценность	Description
vector_store.files_batch

состояние перечисления: VectorStoreFileBatchObjectStatus

Ценность	Description
in_progress
завершено
cancelled
ошибка

createVectorStoreFileBatchRequest

Имя.	Тип	Description	Обязательно	По умолчанию
chunking_strategy	chunkingStrategyRequestParam	Стратегия блокирования, используемая для блокирования файлов. Если этот параметр не задан, используйте стратегию auto .	нет
идентификаторы_файлов	массив	Список идентификаторов файлов, которые следует использовать векторном хранилище. Полезно для таких средств, как file_search, которые могут access файлов.	Да

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

Происходит при создании нового потока.

Имя.	Тип	Description	Обязательно	По умолчанию
данные	threadObject	Представляет поток, содержащий сообщения.	Да
событие	струна		Да

Данные: threadObject

Перечисление событий: ThreadStreamEventEnum

Ценность	Description
thread.created	Событие создания потока

---

runStreamEvent

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

thread.run.created

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

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

Данные: runObject

Перечисление событий: RunStreamEventCreated

Ценность	Description
thread.run.created

---

thread.run.queued

Происходит при перемещении queued выполнения в состояние.

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

Данные: runObject

Перечисление событий: RunStreamEventQueued

Ценность	Description
thread.run.queued

---

thread.run.in_progress

Происходит при перемещении in_progress выполнения в состояние.

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

Данные: runObject

Перечисление событий: RunStreamEventInProgress

Ценность	Description
thread.run.in_progress

---

thread.run.requires_action

Происходит при перемещении requires_action выполнения в состояние.

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

Данные: runObject

Перечисление события: RunStreamEventRequiresAction

Ценность	Description
thread.run.requires_action

---

thread.run.completed

Происходит при завершении выполнения.

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

Данные: runObject

Перечисление события: RunStreamEventCompleted

Ценность	Description
thread.run.completed

---

thread.run.failed

Происходит при сбое выполнения.

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

Данные: runObject

Перечисление событий: RunStreamEventFailed

Ценность	Description
thread.run.failed

---

thread.run.cancelling

Происходит при перемещении cancelling выполнения в состояние.

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

Данные: runObject

Перечисление события: RunStreamEventCancelling

Ценность	Description
thread.run.cancelling

---

thread.run.cancelled

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

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

Данные: runObject

Перечисление событий: RunStreamEventCancelled

Ценность	Description
thread.run.cancelled

---

thread.run.expired

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

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

Данные: runObject

Перечисление событий: RunStreamEventExpired

Ценность	Description
thread.run.expired

---

runStepStreamEvent

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

thread.run.step.created

Происходит при создании шага выполнения.

Имя.	Тип	Description	Обязательно	По умолчанию
данные	runStepObject	Представляет шаг выполнения выполнения выполнения.	Да
событие	струна		Да

Данные: runStepObject

Перечисление событий: RunStepStreamEventCreated

Ценность	Description
thread.run.step.created

---

thread.run.step.in_progress

Происходит при переходе in_progress шага выполнения в состояние.

Имя.	Тип	Description	Обязательно	По умолчанию
данные	runStepObject	Представляет шаг выполнения выполнения выполнения.	Да
событие	струна		Да

Данные: runStepObject

Перечисление событий: RunStepStreamEventInProgress

Ценность	Description
thread.run.step.in_progress

---

thread.run.step.delta

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

Имя.	Тип	Description	Обязательно	По умолчанию
данные	runStepDeltaObject	Представляет разностную смену шага выполнения, т. е. любые измененные поля на шаге выполнения во время потоковой передачи.	Да
событие	струна		Да

Данные: runStepDeltaObject

Перечисление события: RunStepStreamEventDelta

Ценность	Description
thread.run.step.delta

---

thread.run.step.completed

Происходит при завершении шага выполнения.

Имя.	Тип	Description	Обязательно	По умолчанию
данные	runStepObject	Представляет шаг выполнения выполнения выполнения.	Да
событие	струна		Да

Данные: runStepObject

Перечисление событий: RunStepStreamEventCompleted

Ценность	Description
thread.run.step.completed

---

thread.run.step.failed

Происходит при сбое шага выполнения.

Имя.	Тип	Description	Обязательно	По умолчанию
данные	runStepObject	Представляет шаг выполнения выполнения выполнения.	Да
событие	струна		Да

Данные: runStepObject

Перечисление событий: RunStepStreamEventFailed

Ценность	Description
thread.run.step.failed

---

thread.run.step.cancelled

Происходит при отмене шага выполнения.

Имя.	Тип	Description	Обязательно	По умолчанию
данные	runStepObject	Представляет шаг выполнения выполнения выполнения.	Да
событие	струна		Да

Данные: runStepObject

Перечисление событий: RunStepStreamEventCancelled

Ценность	Description
thread.run.step.cancelled

---

thread.run.step.expired

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

Имя.	Тип	Description	Обязательно	По умолчанию
данные	runStepObject	Представляет шаг выполнения выполнения выполнения.	Да
событие	струна		Да

Данные: runStepObject

Перечисление событий: RunStepStreamEventExpired

Ценность	Description
thread.run.step.expired

---

messageStreamEvent

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

thread.message.created

Происходит при создании сообщения.

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

Данные: messageObject

Перечисление событий: MessageStreamEventCreated

Ценность	Description
thread.message.created

---

thread.message.in_progress

Происходит при перемещении in_progress сообщения в состояние.

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

Данные: messageObject

Перечисление события: MessageStreamEventInProgress

Ценность	Description
thread.message.in_progress

---

thread.message.delta

Происходит при потоковой передаче частей сообщения.

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

Данные: messageDeltaObject

Перечисление события: MessageStreamEventDelta

Ценность	Description
thread.message.delta

---

thread.message.completed

Происходит при завершении сообщения.

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

Данные: messageObject

Перечисление событий: MessageStreamEventCompleted

Ценность	Description
thread.message.completed

---

thread.message.incomplete

Происходит, когда сообщение заканчивается до завершения.

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

Данные: messageObject

Перечисление событий: MessageStreamEventIncomplete

Ценность	Description
thread.message.incomplete

---

Аннотация

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

• FileCitation
• UrlCitation
• FilePath

Click

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

Имя.	Тип	Description	Обязательно	По умолчанию
button	перечисление	Указывает, какая кнопка мыши была нажата во время нажатия кнопки. Одно из значений left, right, wheel, back или forward. Возможные значения: left, right, wheel, back, forward	Да
type	перечисление	Указывает тип события. Для действия щелчка это свойство всегда имеет значение click. Возможные значения: click	Да
x	целое число	Координата x, в которой произошло нажатие.	Да
и	целое число	Координата y, в которой произошло нажатие.	Да

CodeInterpreterFileOutput

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

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

CodeInterpreterTextOutput

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

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

CodeInterpreterTool

Средство, выполняющее код.

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

CodeInterpreterToolCall

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

Имя.	Тип	Description	Обязательно	По умолчанию
код	струна	Код для выполнения.	Да
id	струна	Уникальный идентификатор вызова средства интерпретатора кода.	Да
results	массив	Результаты вызова средства интерпретатора кода.	Да
статус	перечисление	Состояние вызова средства интерпретатора кода. Возможные значения: in_progress, interpretingcompleted	Да
type	перечисление	Тип вызова средства интерпретатора кода. Всегда code_interpreter_call. Возможные значения: code_interpreter_call	Да

CodeInterpreterToolOutput

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

• CodeInterpreterTextOutput
• CodeInterpreterFileOutput

ComparisonFilter

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

Имя.	Тип	Description	Обязательно	По умолчанию
ключ	струна	Ключ для сопоставления со значением.	Да
type	перечисление	Указывает оператор сравнения: eq, ne, gt, gte, lt. lte - eq: Равно - ne: не равно - gt: больше чем - gte: больше или равно - lt:Менее - lte: меньше или равно Возможные значения: eq, ne, gt, gte, lt, lte	Да
value	строка или число или логическое значение	Значение для сравнения с ключом атрибута; поддерживает типы строк, чисел или логических типов.	Да

CompoundFilter

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

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

ComputerAction

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

• Click
• DoubleClick
• Drag
• KeyPress
• Move
• Screenshot
• Scroll
• Тип
• Ожидание

ComputerScreenshotImage

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

Имя.	Тип	Description	Обязательно	По умолчанию
идентификатор_файла	струна	Идентификатор отправленного файла, содержащего снимок экрана.	нет
ссылка_на_изображение	струна	URL-адрес изображения снимка экрана.	нет
type	перечисление	Указывает тип события. Для снимка экрана компьютера это свойство всегда имеет значение computer_screenshot. Возможные значения: computer_screenshot	Да

ComputerTool

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

Имя.	Тип	Description	Обязательно	По умолчанию
высота дисплея	число/номер	Высота дисплея компьютера.	Да
ширина дисплея	число/номер	Ширина дисплея компьютера.	Да
environment	перечисление	Тип управляемой компьютерной среды. Возможные значения: mac, , windowsubuntubrowser	Да
type	перечисление	Тип средства использования компьютера. Всегда computer_use_preview. Возможные значения: computer-use-preview	Да

ComputerToolCall

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

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

ComputerToolCallOutput

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

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

ComputerToolCallOutputResource

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

ComputerToolCallSafetyCheck

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

Имя.	Тип	Description	Обязательно	По умолчанию
код	струна	Тип ожидающей проверки безопасности.	Да
id	струна	Идентификатор ожидающей проверки безопасности.	Да
сообщение	струна	Сведения об этой ожидающейся проверке безопасности.	Да

Content

Много модальное содержимое входных и выходных данных.

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

• InputContent
• OutputContent

Coordinate

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

Имя.	Тип	Description	Обязательно	По умолчанию
x	целое число	Координата x.	Да
и	целое число	Координата y.	Да

CreateModelResponseProperties

Имя.	Тип	Description	Обязательно	По умолчанию
metadata	Метаданные	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате и запроса на объекты через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — это строки с максимальной длиной 512 символов.	нет
модель	струна	Модель, используемая для создания ответов.	нет
Температура	число/номер	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным. Как правило, мы рекомендуем изменить это или top_p не оба.	нет	1
top_p	число/номер	Альтернативой выборке с температурой является так называемая выборка ядра, где модель рассматривает результаты маркеров с top_p всего массива значений вероятности. Таким образом, 0,1 означает, что учитываются только маркеры, входящие в верхние 10% массива значений вероятности. Как правило, мы рекомендуем изменить это или temperature не оба.	нет	1
Пользователь	струна	Уникальный идентификатор, представляющий пользователя, который может помочь OpenAI отслеживать и обнаруживать злоупотребления. .	нет

createResponse

Имя.	Тип	Description	Обязательно	По умолчанию
include	массив	{"$ref": "#/components/schemas/includable/description"}	нет
ввод	строка или массив	Входные данные, такие как текст, изображения или файлы, в модель, используемые для генерации ответа.	Да
instructions	струна	Вставляет сообщение системы (или разработчика) в качестве первого элемента в контексте модели. При использовании вместе с previous_response_idэтим инструкции из предыдущего ответа не будут перенесены в следующий ответ. Это упрощает замену системных сообщений (или сообщений разработчиками) в новых ответах.	нет
max_output_tokens	целое число	Верхняя граница для числа маркеров, которые можно создать для ответа, включая видимые выходные маркеры и маркеры причин.	нет
вызовы инструмента в параллельном режиме	булевый	Следует ли разрешить модели запускать вызовы инструментов параллельно.	нет	True
previous_response_id	струна	Уникальный идентификатор предыдущего ответа на модель. Используйте эту функцию для создания многоэтапных бесед.	нет
reasoning	Reasoning	Параметры конфигурации для моделей рассуждений.	нет
store	булевый	Следует ли хранить созданный ответ модели для последующего получения через API.	нет	True
поток	булевый	Если задано значение true, данные ответа модели будут передаваться клиенту по мере его создания с помощью событий, отправляемых сервером.	нет	Неправда
текст	объект	Параметры конфигурации для текстового ответа модели. Можно использовать обычный текст или структурированные данные JSON. Подробнее: — текстовые входные и выходные данные — структурированные выходные данные	нет
└─ Формат	TextResponseFormatConfiguration	Объект, указывающий формат, который должен выводить модель. Настройка { "type": "json_schema" } включает структурированные выходные данные, что гарантирует соответствие модели предоставленной схеме JSON. Формат по умолчанию — это { "type": "text" } без дополнительных параметров. Не рекомендуется использовать для gpt-4o и более новых моделей: Настройка для { "type": "json_object" } включает старый режим JSON, который гарантирует, что создаваемое моделью сообщение является допустимым JSON. Использование json_schema предпочтительнее для моделей, поддерживающих его.	нет
выбор инструмента	ToolChoiceOptions или ToolChoiceTypes или ToolChoiceFunction	Как модель должна выбрать средство (или инструменты), которое следует использовать при создании ответа. Просмотрите tools параметр, чтобы узнать, как указать, какие средства модель может вызывать.	нет
инструменты	массив	Массив инструментов, которые модель может вызывать при создании ответа. Можно указать, какое средство следует использовать, задав tool_choice параметр. Ниже приведены две категории инструментов, которые можно предоставить модели: - Встроенные средства	нет
truncation	перечисление	Стратегия усечения, которую следует использовать для генерирования ответа модели. - auto: если контекст этого ответа и предыдущих превышает размер окна контекста модели, модель усечет ответ на соответствие окну контекста путем удаления входных элементов в середине беседы. - disabled (по умолчанию): если ответ модели превысит размер окна контекста для модели, запрос завершится ошибкой 400. Возможные значения: auto, disabled	нет

DoubleClick

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

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

Drag

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

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

EasyInputMessage

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

Имя.	Тип	Description	Обязательно	По умолчанию
содержимое	string или InputMessageContentList	Текст, изображение или звуковой вход в модель, используемый для создания ответа. Также может содержать предыдущие ответы помощника.	Да
роль	перечисление	Роль входных данных сообщения. Один из user, assistantsystemили developer. Возможные значения: user, , assistantsystemdeveloper	Да
type	перечисление	Тип входных данных сообщения. Всегда message. Возможные значения: message	нет

FileCitation

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

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

FilePath

Путь к файлу.

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

FileSearchRanker

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

Недвижимость	Ценность
Описание	Рангер, используемый для поиска файлов. Если не указано иное, будет использоваться ранжировщик auto.
Тип	струна
Значения	auto default_2024_08_21

FileSearchTool

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

Имя.	Тип	Description	Обязательно	По умолчанию
filters	ComparisonFilter или CompoundFilter	Фильтр для применения на основе атрибутов файла.	нет
максимальное_количество_результатов	целое число	Максимальное количество отображаемых результатов. Это число должно быть от 1 до 50 включительно.	нет
опции рейтинга	объект	Параметры ранжирования для поиска.	нет
Рангер └️	перечисление	Рангер, используемый для поиска файлов. Возможные значения: auto, default-2024-11-15	нет
└─ порог оценки	число/номер	Пороговое значение оценки для поиска файлов — от 0 до 1. Числа ближе к 1 будут пытаться вернуть только наиболее релевантные результаты, но могут возвращать меньше результатов.	нет	0
type	перечисление	Тип средства поиска файлов. Всегда file_search. Возможные значения: file_search	Да
vector_store_ids	массив	Идентификаторы векторных хранилищ для поиска.	Да

FileSearchToolCall

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

Имя.	Тип	Description	Обязательно	По умолчанию
id	струна	Уникальный идентификатор вызова средства поиска файлов.	Да
queries	массив	Запросы, используемые для поиска файлов.	Да
results	массив	Результаты вызова средства поиска файлов.	нет
статус	перечисление	Состояние вызова средства поиска файлов. Один из in_progress, searchingincomplete или failed, Возможные значения: in_progress, searching, completed, incomplete, failed	Да
type	перечисление	Тип вызова средства поиска файлов. Всегда file_search_call. Возможные значения: file_search_call	Да

FunctionTool

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

Имя.	Тип	Description	Обязательно	По умолчанию
описание	струна	Описание функции. Используется моделью для определения того, следует ли вызывать функцию.	нет
имя	струна	Имя вызываемой функции.	Да
параметры	объект	Объект схемы JSON, описывающий параметры функции.	Да
строгий	булевый	Следует ли применять строгую проверку параметров. trueпо умолчанию.	Да
type	перечисление	Тип средства функции. Всегда function. Возможные значения: function	Да

FunctionToolCall

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

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

FunctionToolCallOutput

Выходные данные вызова инструмента функции.

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

FunctionToolCallOutputResource

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

includable

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

• file_search_call.results: включите результаты поиска запроса средства поиска файлов.
• message.input_image.image_url: включите URL-адреса изображения из входного сообщения.
• computer_call_output.output.image_url: добавьте URL-адреса изображения из результата выполнения команды на компьютере.

Недвижимость	Ценность
Описание	Укажите дополнительные выходные данные для включения в ответ модели. В настоящее время поддерживаются следующие значения: - file_search_call.results: включите результаты поиска вызова средства поиска файлов. - message.input_image.image_url: включите URL-адреса изображения из входного сообщения. - computer_call_output.output.image_url: добавьте URL-адреса изображений из выходных данных компьютерного вызова.
Тип	струна
Значения	file_search_call.results message.input_image.image_url computer_call_output.output.image_url

InputAudio

Аудиовход для модели.

Имя.	Тип	Description	Обязательно	По умолчанию
данные	струна	Звуковые данные в кодировке Base64.	Да
format	перечисление	Формат звуковых данных. В настоящее время поддерживаются mp3 форматы и wav. Возможные значения: mp3, wav	Да
type	перечисление	Тип входного элемента. Всегда input_audio. Возможные значения: input_audio	Да

InputContent

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

• InputText
• InputImage
• InputFile

InputFile

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

Имя.	Тип	Description	Обязательно	По умолчанию
file_data	струна	Содержимое файла, отправляемого в модель.	нет
идентификатор_файла	струна	Идентификатор файла, отправляемого в модель.	нет
filename	струна	Имя файла, отправляемого в модель.	нет
type	перечисление	Тип входного элемента. Всегда input_file. Возможные значения: input_file	Да

InputImage

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

Имя.	Тип	Description	Обязательно	По умолчанию
detail	перечисление	Уровень детализации изображения, отправляемого в модель. Один из high, low, или auto. По умолчанию — auto. Возможные значения: high, lowauto	Да
идентификатор_файла	струна	Идентификатор файла, отправляемого в модель.	нет
ссылка_на_изображение	струна	URL-адрес изображения, отправляемого в модель. Полностью квалифицированный URL-адрес или изображение, закодированное в формате Base64 в URL-адресе данных.	нет
type	перечисление	Тип входного элемента. Всегда input_image. Возможные значения: input_image	Да

InputItem

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

• EasyInputMessage
• Элемент
• ItemReference

ВходящееСообщение

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

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

InputMessageContentList

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

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

InputMessageResource

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

InputText

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

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

Item

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

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

• InputMessage
• OutputMessage
• FileSearchToolCall
• ComputerToolCall
• ComputerToolCallOutput
• FunctionToolCall
• FunctionToolCallOutput
• ReasoningItem

ItemReference

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

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

ItemResource

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

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

• InputMessageResource
• OutputMessage
• FileSearchToolCall
• ComputerToolCall
• ComputerToolCallOutputResource
• FunctionToolCall
• FunctionToolCallOutputResource

KeyPress

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

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

Метаданные

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

Ключи — это строки с максимальной длиной 64 символов. Значения — это строки с максимальной длиной 512 символов.

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

ModelResponseProperties

Имя.	Тип	Description	Обязательно	По умолчанию
metadata	Метаданные	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате и запроса на объекты через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — это строки с максимальной длиной 512 символов.	нет
модель	струна	Модель, используемая для создания ответов.	нет
Температура	число/номер	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным. Как правило, мы рекомендуем изменить это или top_p не оба.	нет	1
top_p	число/номер	Альтернативой выборке с температурой является так называемая выборка ядра, где модель рассматривает результаты маркеров с top_p всего массива значений вероятности. Таким образом, 0,1 означает, что учитываются только маркеры, входящие в верхние 10% массива значений вероятности. Как правило, мы рекомендуем изменить это или temperature не оба.	нет	1
Пользователь	струна	Уникальный идентификатор, представляющий пользователя, который может помочь OpenAI отслеживать и обнаруживать злоупотребления. .	нет

Move

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

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

OutputAudio

Выходные данные звука из модели.

Имя.	Тип	Description	Обязательно	По умолчанию
данные	струна	Звуковые данные в кодировке Base64 из модели.	Да
transcript	струна	Расшифровка звуковых данных из модели.	Да
type	перечисление	Тип выходного звука. Всегда output_audio. Возможные значения: output_audio	Да

OutputContent

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

• OutputText
• Refusal

OutputItem

Имя.	Тип	Description	Обязательно	По умолчанию
действие	ComputerAction		Да
arguments	струна	Строка JSON аргументов для передачи функции.	Да
call_id	струна	Идентификатор, используемый при реагировании на вызов инструмента с выходными данными.	Да
содержимое	массив	Обоснование содержимого текста.	Да
id	струна	Уникальный идентификатор контента рассуждений.	Да
имя	струна	Имя выполняемой функции.	Да
pending_safety_checks	массив	Ожидающие проверки безопасности для компьютеризированного процесса.	Да
queries	массив	Запросы, используемые для поиска файлов.	Да
results	массив	Результаты вызова средства поиска файлов.	нет
роль	перечисление	Роль выходного сообщения. Всегда assistant. Возможные значения: assistant	Да
статус	перечисление	Состояние элемента. Один из in_progress, completed, или incomplete. Заполняется, когда элементы возвращаются через API. Возможные значения: in_progress, completedincomplete	Да
type	перечисление	Тип объекта . Всегда reasoning. Возможные значения: reasoning	Да

OutputMessage

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

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

OutputText

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

Имя.	Тип	Description	Обязательно	По умолчанию
аннотации	массив	Заметки к выходным данным текста.	Да
текст	струна	Текстовые выходные данные модели.	Да
type	перечисление	Тип выходного текста. Всегда output_text. Возможные значения: output_text	Да

RealtimeSessionCreateRequest

Конфигурация объекта сеанса в режиме реального времени.

Имя.	Тип	Description	Обязательно	По умолчанию
input_audio_format	перечисление	Формат входного звука. Параметры: pcm16, g711_ulawили g711_alaw. Для pcm16 входной звук должен быть 16-разрядным PCM с частотой выборки 24 кГц, одним каналом (моно) и младшим порядком байтов. Возможные значения: pcm16, g711_ulawg711_alaw	нет
input_audio_noise_reduction	объект	Настройка для уменьшения шума входного звука. Чтобы отключить, это можно установить на null. Фильтры для уменьшения шума обрабатывают звук, добавленный во входной звуковой буфер перед отправкой в VAD и модель. Фильтрация звука может повысить точность обнаружения VAD и поворота (уменьшая ложные срабатывания) и производительность модели, повышая восприятие входного звука.	нет
└─ Тип	перечисление	Тип уменьшения шума. near_field предназначен для микрофонов близкого разговора, таких как наушники, far_field предназначен для микрофонов с дальним полем, таких как ноутбук или микрофоны конференц-зала. Возможные значения: near_field, far_field	нет
input_audio_transcription	объект	Настройка транскрибирования входного аудио, по умолчанию отключена и может быть установлена на null, чтобы отключить аудиотранскрибирование после включения. Транскрибирование входного звука не является собственным для модели, так как модель использует звук напрямую. Транскрибирование выполняется асинхронно через конечную точку транскрибирования и следует рассматривать как руководство по входной звуковой информации, а не точно тому, что слышала модель. Клиент может при необходимости задать язык и запрашивать транскрибирование, они предлагают дополнительные рекомендации для службы транскрибирования.	нет
└─ Язык	струна	Язык входного звука. Предоставление языка ввода в формате ISO-639-1 (например en, ) повышает точность и задержку.	нет
└─ Модель	струна	Модель, используемая для транскрибирования, текущие параметры: gpt-4o-transcribe, gpt-4o-mini-transcribegpt-4o-mini-transcribe-2025-12-15и whisper-1.	нет
└─ Запрос	струна	Необязательный текст для руководства стилем модели или продолжением предыдущего сегмента звука. Для whisper-1этого запрос — это список ключевых слов. Для gpt-4o-transcribe моделей запрос — это произвольная текстовая строка (например, "ожидайте слова, связанные с технологией").	нет
instructions	струна	Системные инструкции по умолчанию (т. е. системное сообщение) предопределены для вызовов модели. Это поле позволяет клиенту управлять моделью по нужным ответам. Модель может быть настроена по формату и содержанию ответа (например, "быть чрезвычайно кратким", "вести себя дружелюбно", "вот примеры хороших ответов") и на звуковое поведение (например, "говорить быстро", "вносить в голос эмоции", "смеяться часто"). Нет гарантии, что модель будет следовать инструкциям, но они служат для нее руководством по желаемому поведению. Обратите внимание, что сервер задает инструкции по умолчанию, которые будут использоваться, если это поле не задано, и которые видны в событии session.created в начале сеанса.	нет
max_response_output_tokens	целое число или строка	Максимальное количество выходных маркеров для одного ответа помощника, включающее вызовы инструментов. Укажите целое число от 1 до 4096, чтобы ограничить выходные маркеры или inf максимальные доступные маркеры для данной модели. По умолчанию — inf.	нет
Условия		Набор модальностей, с которыми может реагировать модель. Чтобы отключить звук, установите для этого значение ["text"].	нет
модель	струна	Имя развертывания, используемого для этого сеанса.	нет
output_audio_format	перечисление	Формат выходного звука. Параметры: pcm16, g711_ulawили g711_alaw. Для pcm16 выходного аудио частота дискретизации составляет 24 кГц. Возможные значения: pcm16, g711_ulawg711_alaw	нет
Температура	число/номер	Температура выборки для модели ограничена [0.6, 1.2]. Для звуковых моделей температура 0,8 настоятельно рекомендуется для оптимальной производительности.	нет	0.8
выбор инструмента	струна	Как модель выбирает инструменты. Параметры: auto, nonerequiredили укажите функцию.	нет	авто
инструменты	массив	Средства (функции), доступные для модели.	нет
turn_detection	объект	Конфигурация для обнаружения поворота, VAD или семантического VAD сервера эфира. Это можно установить в null для отключения, в этом случае клиент должен вручную активировать реакцию модели. VAD на сервере означает, что модель будет обнаруживать начало и конец речи на основе громкости звука и отвечать в конце речи пользователя. Семантическая VAD более совершенная и использует модель обнаружения смены реплик (в сочетании с VAD), чтобы семантически оценить, закончил ли пользователь говорить, а затем динамически устанавливает тайм-аут на основе этой вероятности. Например, если пользователь отключает аудиозапись, uhhmмодель будет оценить низкую вероятность завершения и ждать больше времени, пока пользователь продолжит говорить. Это может быть полезно для более естественных бесед, но может иметь более высокую задержку.	нет
└create_response	булевый	Следует ли автоматически создавать ответ при возникновении события остановки VAD.	нет	True
└️ рвение	перечисление	Только для режима semantic_vad используется. Стремление модели реагировать. low будет ждать, пока пользователь продолжит говорить, high будет реагировать быстрее. auto значение по умолчанию и эквивалентно medium. Возможные значения: low, , mediumhighauto	нет
└─ интеррапт_респонс	булевый	Следует ли автоматически прерывать любой текущий ответ с выходными данными беседы по умолчанию (т. е. conversationautoпри возникновении события запуска VAD).	нет	True
└prefix_padding_ms	целое число	Только для режима server_vad используется. Длительность звука, которую нужно включить до речи, обнаруженной VAD (в миллисекундах). Значение по умолчанию — 300 мс.	нет
└─ длительность_тишины_мс	целое число	Только для режима server_vad используется. Длительность молчания для обнаружения остановки речи (в миллисекундах). Значение по умолчанию — 500 мс. С более короткими значениями модель будет реагировать быстрее, но может вмешиваться при коротких паузах пользователя.	нет
Пороговое значение └️	число/номер	Только для режима server_vad используется. Порог активации для VAD (0.0 до 1.0), по умолчанию используется значение 0.5. Более высокий пороговый уровень потребует более громкого звука для активации модели, и таким образом модель может работать лучше в шумных средах.	нет
└─ Тип	перечисление	Тип обнаружения поворота. Возможные значения: server_vad, semantic_vad	нет
голос	VoiceIdsShared		нет

RealtimeSessionCreateResponse

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

Имя.	Тип	Description	Обязательно	По умолчанию
секрет_клиента	объект	Временный ключ, возвращаемый API.	Да
└ истекает_в	целое число	Метка времени окончания срока действия токена. В настоящее время срок действия всех токенов истекает через одну минуту.	нет
└─ Значение	струна	Временный ключ, доступный в клиентских средах для проверки подлинности подключений к API Realtime. Используйте это в клиентских средах, а не стандартный маркер API, который следует использовать только на стороне сервера.	нет
input_audio_format	струна	Формат входного звука. Параметры: pcm16, g711_ulawили g711_alaw.	нет
input_audio_transcription	объект	Настройка транскрибирования входного аудио, по умолчанию отключена и может быть установлена на null, чтобы отключить аудиотранскрибирование после включения. Транскрибирование входного звука не является собственным для модели, так как модель использует звук напрямую. Транскрибирование выполняется асинхронно через Whisper и должно рассматриваться как грубое руководство, а не представление, понятное моделью.	нет
└─ Модель	струна	Модель, используемая для транскрибирования, whisper-1 является единственной поддерживаемой в настоящее время моделью.	нет
instructions	струна	Системные инструкции по умолчанию (т. е. системное сообщение) предопределены для вызовов модели. Это поле позволяет клиенту управлять моделью по нужным ответам. Модель можно настроить по содержанию и формату ответов (например, "быть чрезвычайно кратким", "вести себя дружелюбно", "вот примеры хороших ответов"), а также по поведению в аудио (например, "говорить быстро", "вводить эмоции в свой голос", "часто смеяться"). Нет гарантии, что модель будет следовать инструкциям, но они служат для нее руководством по желаемому поведению. Обратите внимание, что сервер задает инструкции по умолчанию, которые будут использоваться, если это поле не задано, и которые видны в событии session.created в начале сеанса.	нет
max_response_output_tokens	целое число или строка	Максимальное количество выходных маркеров для одного ответа помощника, включающее вызовы инструментов. Укажите целое число от 1 до 4096, чтобы ограничить выходные маркеры или inf максимальные доступные маркеры для данной модели. По умолчанию — inf.	нет
Условия		Набор модальностей, с которыми может реагировать модель. Чтобы отключить звук, установите для этого значение ["text"].	нет
output_audio_format	струна	Формат выходного звука. Параметры: pcm16, g711_ulawили g711_alaw.	нет
Температура	число/номер	Температура выборки для модели ограничена [0.6, 1.2]. По умолчанию используется значение 0.8.	нет
выбор инструмента	струна	Как модель выбирает инструменты. Параметры: auto, nonerequiredили укажите функцию.	нет
инструменты	массив	Средства (функции), доступные для модели.	нет
turn_detection	объект	Конфигурация для обнаружения поворотов. Можно установить значение null, чтобы отключить. VAD на сервере означает, что модель будет обнаруживать начало и конец речи на основе громкости звука и отвечать в конце речи пользователя.	нет
└prefix_padding_ms	целое число	Длительность звука, которую нужно включить до речи, обнаруженной VAD (в миллисекундах). Значение по умолчанию — 300 мс.	нет
└─ длительность_тишины_мс	целое число	Длительность молчания для обнаружения остановки речи (в миллисекундах). Значение по умолчанию — 500 мс. С более короткими значениями модель будет реагировать быстрее, но может вмешиваться при коротких паузах пользователя.	нет
Пороговое значение └️	число/номер	Порог активации для VAD (0.0 до 1.0), по умолчанию используется значение 0.5. Более высокий пороговый уровень потребует более громкого звука для активации модели, и таким образом модель может работать лучше в шумных средах.	нет
└─ Тип	струна	В настоящий момент поддерживается только тип обнаружения поворота server_vad.	нет
голос	VoiceIdsShared		нет

RealtimeTranscriptionSessionCreateRequest

Конфигурация объекта сеанса транскрибирования в реальном времени.

Имя.	Тип	Description	Обязательно	По умолчанию
include	массив	Набор элементов для включения в транскрибирование. Текущие доступные элементы: - item.input_audio_transcription.logprobs	нет
input_audio_format	перечисление	Формат входного звука. Параметры: pcm16, g711_ulawили g711_alaw. Для pcm16 входной звук должен быть 16-разрядным PCM с частотой выборки 24 кГц, одним каналом (моно) и младшим порядком байтов. Возможные значения: pcm16, g711_ulawg711_alaw	нет
input_audio_noise_reduction	объект	Настройка для уменьшения шума входного звука. Чтобы отключить, это можно установить на null. Фильтры для уменьшения шума обрабатывают звук, добавленный во входной звуковой буфер перед отправкой в VAD и модель. Фильтрация звука может повысить точность обнаружения VAD и поворота (уменьшая ложные срабатывания) и производительность модели, повышая восприятие входного звука.	нет
└─ Тип	перечисление	Тип уменьшения шума. near_field предназначен для микрофонов близкого разговора, таких как наушники, far_field предназначен для микрофонов с дальним полем, таких как ноутбук или микрофоны конференц-зала. Возможные значения: near_field, far_field	нет
input_audio_transcription	объект	Конфигурация входного транскрибирования звука. Клиент может при необходимости задать язык и запрашивать транскрибирование, они предлагают дополнительные рекомендации для службы транскрибирования.	нет
└─ Язык	струна	Язык входного звука. Предоставление языка ввода в формате ISO-639-1 (например en, ) повышает точность и задержку.	нет
└─ Модель	перечисление	Модель, используемая для транскрибирования, текущие параметры: 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-diarize, gpt-4o-mini-transcribe, gpt-4o-mini-transcribe-2025-12-15, whisper-1	нет
└─ Запрос	струна	Необязательный текст для руководства стилем модели или продолжением предыдущего сегмента звука. Для whisper-1этого запрос — это список ключевых слов. Для gpt-4o-transcribe моделей запрос — это произвольная текстовая строка (например, "ожидайте слова, связанные с технологией").	нет
Условия		Набор модальностей, с которыми может реагировать модель. Чтобы отключить звук, установите для этого значение ["text"].	нет
turn_detection	объект	Конфигурация для обнаружения поворота, VAD или семантического VAD сервера эфира. Это можно установить в null для отключения, в этом случае клиент должен вручную активировать реакцию модели. VAD на сервере означает, что модель будет обнаруживать начало и конец речи на основе громкости звука и отвечать в конце речи пользователя. Семантическая VAD более совершенная и использует модель обнаружения смены реплик (в сочетании с VAD), чтобы семантически оценить, закончил ли пользователь говорить, а затем динамически устанавливает тайм-аут на основе этой вероятности. Например, если пользователь отключает аудиозапись, uhhmмодель будет оценить низкую вероятность завершения и ждать больше времени, пока пользователь продолжит говорить. Это может быть полезно для более естественных бесед, но может иметь более высокую задержку.	нет
└create_response	булевый	Следует ли автоматически создавать ответ при возникновении события остановки VAD. Недоступно для сеансов транскрибирования.	нет	True
└️ рвение	перечисление	Только для режима semantic_vad используется. Стремление модели реагировать. low будет ждать, пока пользователь продолжит говорить, high будет реагировать быстрее. auto значение по умолчанию и эквивалентно medium. Возможные значения: low, , mediumhighauto	нет
└─ интеррапт_респонс	булевый	Следует ли автоматически прерывать любой текущий ответ с выходными данными беседы по умолчанию (т. е. conversationautoпри возникновении события запуска VAD). Недоступно для сеансов транскрибирования.	нет	True
└prefix_padding_ms	целое число	Только для режима server_vad используется. Длительность звука, которую нужно включить до речи, обнаруженной VAD (в миллисекундах). Значение по умолчанию — 300 мс.	нет
└─ длительность_тишины_мс	целое число	Только для режима server_vad используется. Длительность молчания для обнаружения остановки речи (в миллисекундах). Значение по умолчанию — 500 мс. С более короткими значениями модель будет реагировать быстрее, но может вмешиваться при коротких паузах пользователя.	нет
Пороговое значение └️	число/номер	Только для режима server_vad используется. Порог активации для VAD (0.0 до 1.0), по умолчанию используется значение 0.5. Более высокий пороговый уровень потребует более громкого звука для активации модели, и таким образом модель может работать лучше в шумных средах.	нет
└─ Тип	перечисление	Тип обнаружения поворота. Возможные значения: server_vad, semantic_vad	нет

RealtimeTranscriptionSessionCreateResponse

Новая конфигурация сеанса транскрибирования в реальном времени.

При создании сеанса на сервере с помощью REST API объект сеанса также содержит временный ключ. Срок жизни по умолчанию для ключей составляет одну минуту. Это свойство отсутствует при обновлении сеанса через API WebSocket.

Имя.	Тип	Description	Обязательно	По умолчанию
секрет_клиента	объект	Временный ключ, возвращаемый API. Присутствует только при создании сеанса на сервере с помощью REST API.	Да
└ истекает_в	целое число	Метка времени окончания срока действия токена. В настоящее время срок действия всех токенов истекает через одну минуту.	нет
└─ Значение	струна	Временный ключ, доступный в клиентских средах для проверки подлинности подключений к API Realtime. Используйте это в клиентских средах, а не стандартный маркер API, который следует использовать только на стороне сервера.	нет
input_audio_format	струна	Формат входного звука. Параметры: pcm16, g711_ulawили g711_alaw.	нет
input_audio_transcription	объект	Настройка модели транскрибирования.	нет
└─ Язык	струна	Язык входного звука. Предоставление языка ввода в формате ISO-639-1 (например en, ) повышает точность и задержку.	нет
└─ Модель	перечисление	Модель, используемая для транскрибирования. Может иметь значение gpt-4o-transcribe, gpt-4o-mini-transcribe, gpt-4o-mini-transcribe-2025-12-15 или whisper-1. Возможные значения: gpt-4o-transcribe, , gpt-4o-mini-transcribegpt-4o-mini-transcribe-2025-12-15whisper-1	нет
└─ Запрос	струна	Необязательный текст для руководства стилем модели или продолжением предыдущего сегмента звука. Запрос должен соответствовать языку звука.	нет
Условия		Набор модальностей, с которыми может реагировать модель. Чтобы отключить звук, установите для этого значение ["text"].	нет
turn_detection	объект	Конфигурация для обнаружения поворотов. Можно установить значение null, чтобы отключить. VAD на сервере означает, что модель будет обнаруживать начало и конец речи на основе громкости звука и отвечать в конце речи пользователя.	нет
└prefix_padding_ms	целое число	Длительность звука, которую нужно включить до речи, обнаруженной VAD (в миллисекундах). Значение по умолчанию — 300 мс.	нет
└─ длительность_тишины_мс	целое число	Длительность молчания для обнаружения остановки речи (в миллисекундах). Значение по умолчанию — 500 мс. С более короткими значениями модель будет реагировать быстрее, но может вмешиваться при коротких паузах пользователя.	нет
Пороговое значение └️	число/номер	Порог активации для VAD (0.0 до 1.0), по умолчанию используется значение 0.5. Более высокий пороговый уровень потребует более громкого звука для активации модели, и таким образом модель может работать лучше в шумных средах.	нет
└─ Тип	струна	В настоящий момент поддерживается только тип обнаружения поворота server_vad.	нет

Рассуждение

Параметры конфигурации для моделей рассуждений.

Имя.	Тип	Description	Обязательно	По умолчанию
effort	ReasoningEffort	Ограничивает усилия по рассуждениям моделей. В настоящее время поддерживаются lowзначения , mediumи high. Сокращение усилий по поводу может привести к более быстрым откликам и меньшем количестве маркеров, используемых при рассуждениях в ответе.	Да	medium
summary	перечисление	Сводка умозаключений, сделанных моделью. Это может быть полезно для отладки и понимания процесса рассуждений модели. Один из concise или detailed. Возможные значения: concise, detailed	нет

ReasoningItem

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

Имя.	Тип	Description	Обязательно	По умолчанию
содержимое	массив	Обоснование содержимого текста.	Да
id	струна	Уникальный идентификатор контента рассуждений.	Да
статус	перечисление	Состояние элемента. Один из in_progress, completed, или incomplete. Заполняется, когда элементы возвращаются через API. Возможные значения: in_progress, completedincomplete	нет
type	перечисление	Тип объекта . Всегда reasoning. Возможные значения: reasoning	Да

Refusal

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

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

response

Имя.	Тип	Description	Обязательно	По умолчанию
создано_в	число/номер	Метка времени в формате Unix (в секундах), когда был создан этот ответ.	Да
ошибка	ResponseError	Объект ошибки, возвращаемый, когда модель не сможет создать ответ.	Да
id	струна	Уникальный идентификатор для этого ответа.	Да
incomplete_details	объект	Сведения о том, почему ответ неполный.	Да
└─ Причина	перечисление	Причина, по которой ответ является неполным. Возможные значения: max_output_tokens, content_filter	нет
instructions	струна	Вставляет сообщение системы (или разработчика) в качестве первого элемента в контексте модели. При использовании вместе с previous_response_idэтим инструкции из предыдущего ответа не будут перенесены в следующий ответ. Это упрощает замену системных сообщений (или сообщений разработчиками) в новых ответах.	Да
max_output_tokens	целое число	Верхняя граница для числа маркеров, которые можно создать для ответа, включая видимые выходные маркеры и состояние беседы.	нет
metadata	Метаданные	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате и запроса на объекты через API или панель мониторинга. Ключи — это строки с максимальной длиной 64 символов. Значения — это строки с максимальной длиной 512 символов.	Да
модель	струна	Модель, используемая для создания ответов.	Да
объект	перечисление	Тип объекта этого ресурса — всегда установлено response. Возможные значения: response	Да
output	массив	Массив элементов контента, созданных моделью. — длина и порядок элементов в массиве output зависит от ответа модели. — Вместо доступа к первому элементу output массива и предположения, что это assistant сообщение с содержимым, созданным моделью, попробуйте использовать свойство output_text, где это поддержано в пакетах SDK.	Да
output_text	струна	Доступное только для пакета SDK свойство, содержащее агрегированные текстовые выходные данные всех output_text элементов в массиве output , если они присутствуют. Поддерживается в пакетах SDK для Python и JavaScript.	нет
вызовы инструмента в параллельном режиме	булевый	Следует ли разрешить модели запускать вызовы инструментов параллельно.	Да	True
previous_response_id	струна	Уникальный идентификатор предыдущего ответа на модель. Используйте эту функцию для создания многоэтапных бесед.	нет
reasoning	Reasoning	Параметры конфигурации для моделей рассуждений.	нет
статус	перечисление	Статус формирования ответа. Один из completed, failedin_progressили incomplete. Возможные значения: completed, , failedin_progressincomplete	нет
Температура	число/номер	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным. Как правило, мы рекомендуем изменить это или top_p не оба.	Да	1
текст	объект	Параметры конфигурации для текстового ответа модели. Можно использовать обычный текст или структурированные данные JSON. Подробнее: — текстовые входные и выходные данные — структурированные выходные данные	нет
└─ Формат	TextResponseFormatConfiguration	Объект, указывающий формат, который должен выводить модель. Настройка { "type": "json_schema" } включает структурированные выходные данные, что гарантирует соответствие модели предоставленной схеме JSON. Формат по умолчанию — это { "type": "text" } без дополнительных параметров. Не рекомендуется использовать для gpt-4o и более новых моделей: Настройка для { "type": "json_object" } включает старый режим JSON, который гарантирует, что создаваемое моделью сообщение является допустимым JSON. Использование json_schema предпочтительнее для моделей, поддерживающих его.	нет
выбор инструмента	ToolChoiceOptions или ToolChoiceTypes или ToolChoiceFunction	Как модель должна выбрать средство (или инструменты), которое следует использовать при создании ответа. Просмотрите tools параметр, чтобы узнать, как указать, какие средства модель может вызывать.	Да
инструменты	массив	Массив инструментов, которые модель может вызывать при создании ответа. Можно указать, какое средство следует использовать, задав tool_choice параметр. Ниже приведены две категории инструментов, которые можно предоставить модели: - Встроенные средства	Да
top_p	число/номер	Альтернативой выборке с температурой является так называемая выборка ядра, где модель рассматривает результаты маркеров с top_p всего массива значений вероятности. Таким образом, 0,1 означает, что учитываются только маркеры, входящие в верхние 10% массива значений вероятности. Как правило, мы рекомендуем изменить это или temperature не оба.	Да	1
truncation	перечисление	Стратегия усечения, которую следует использовать для генерирования ответа модели. - auto: если контекст этого ответа и предыдущих превышает размер окна контекста модели, модель усечет ответ, чтобы он соответствовал этому окну, удаляя элементы ввода в середине беседы. - disabled (по умолчанию): если ответ модели превысит размер окна контекста для модели, запрос завершится ошибкой 400. Возможные значения: auto, disabled	нет
использование	ResponseUsage	Представляет сведения об использовании маркеров, включая входные маркеры, выходные маркеры, разбивку выходных маркеров и общие используемые маркеры.	нет
Пользователь	струна	Уникальный идентификатор, представляющий пользователя, который может помочь OpenAI отслеживать и обнаруживать злоупотребления. .	нет

ResponseAudioDeltaEvent

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

Имя.	Тип	Description	Обязательно	По умолчанию
delta	струна	Блок аудиобайтов, закодированных в формате Base64.	Да
type	перечисление	тип события; Всегда response.audio.delta. Возможные значения: response.audio.delta	Да

ResponseAudioDoneEvent

Излучается при завершении аудиоответа.

Имя.	Тип	Description	Обязательно	По умолчанию
type	перечисление	тип события; Всегда response.audio.done. Возможные значения: response.audio.done	Да

ResponseAudioTranscriptDeltaEvent

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

Имя.	Тип	Description	Обязательно	По умолчанию
delta	струна	Частичная расшифровка аудиоответа.	Да
type	перечисление	тип события; Всегда response.audio.transcript.delta. Возможные значения: response.audio.transcript.delta	Да

ResponseAudioTranscriptDoneEvent

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

Имя.	Тип	Description	Обязательно	По умолчанию
type	перечисление	тип события; Всегда response.audio.transcript.done. Возможные значения: response.audio.transcript.done	Да

ResponseCodeInterpreterCallCodeDeltaEvent

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

Имя.	Тип	Description	Обязательно	По умолчанию
delta	струна	Фрагмент частичного кода, добавленный интерпретатором кода.	Да
output_index	целое число	Индекс выходного элемента, для которого вызов интерпретатора кода находится в процессе выполнения.	Да
type	перечисление	тип события; Всегда response.code_interpreter_call.code.delta. Возможные значения: response.code_interpreter_call.code.delta	Да

ResponseCodeInterpreterCallCodeDoneEvent

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

Имя.	Тип	Description	Обязательно	По умолчанию
код	струна	Окончательный фрагмент кода выводится интерпретатором кода.	Да
output_index	целое число	Индекс выходного элемента, для которого вызов интерпретатора кода находится в процессе выполнения.	Да
type	перечисление	тип события; Всегда response.code_interpreter_call.code.done. Возможные значения: response.code_interpreter_call.code.done	Да

ResponseCodeInterpreterCallCompletedEvent

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

Имя.	Тип	Description	Обязательно	По умолчанию
code_interpreter_call	CodeInterpreterToolCall	Вызов инструмента для выполнения кода.	Да
output_index	целое число	Индекс выходного элемента, для которого вызов интерпретатора кода находится в процессе выполнения.	Да
type	перечисление	тип события; Всегда response.code_interpreter_call.completed. Возможные значения: response.code_interpreter_call.completed	Да

ResponseCodeInterpreterCallInProgressEvent

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

Имя.	Тип	Description	Обязательно	По умолчанию
code_interpreter_call	CodeInterpreterToolCall	Вызов инструмента для выполнения кода.	Да
output_index	целое число	Индекс выходного элемента, для которого вызов интерпретатора кода находится в процессе выполнения.	Да
type	перечисление	тип события; Всегда response.code_interpreter_call.in_progress. Возможные значения: response.code_interpreter_call.in_progress	Да

ResponseCodeInterpreterCallInterpretingEvent

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

Имя.	Тип	Description	Обязательно	По умолчанию
code_interpreter_call	CodeInterpreterToolCall	Вызов инструмента для выполнения кода.	Да
output_index	целое число	Индекс выходного элемента, для которого вызов интерпретатора кода находится в процессе выполнения.	Да
type	перечисление	тип события; Всегда response.code_interpreter_call.interpreting. Возможные значения: response.code_interpreter_call.interpreting	Да

ResponseCompletedEvent

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

Имя.	Тип	Description	Обязательно	По умолчанию
response	response		Да
type	перечисление	тип события; Всегда response.completed. Возможные значения: response.completed	Да

ResponseContentPartAddedEvent

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

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

ResponseContentPartDoneEvent

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

Имя.	Тип	Description	Обязательно	По умолчанию
content_index	целое число	Индекс завершенной части содержимого.	Да
item_id	струна	Идентификатор выходного элемента, к которому была добавлена часть содержимого.	Да
output_index	целое число	Индекс выходного элемента, к которому была добавлена часть содержимого.	Да
part	OutputContent		Да
type	перечисление	тип события; Всегда response.content_part.done. Возможные значения: response.content_part.done	Да

ResponseCreatedEvent

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

Имя.	Тип	Description	Обязательно	По умолчанию
response	response		Да
type	перечисление	тип события; Всегда response.created. Возможные значения: response.created	Да

ResponseError

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

Имя.	Тип	Description	Обязательно	По умолчанию
код	ResponseErrorCode	Код ошибки для ответа.	Да
сообщение	струна	Описание ошибки, доступной для чтения человеком.	Да

ResponseErrorCode

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

Недвижимость	Ценность
Описание	Код ошибки для ответа.
Тип	струна
Значения	server_error rate_limit_exceeded invalid_prompt vector_store_timeout invalid_image invalid_image_format invalid_base64_image invalid_image_url image_too_large image_too_small image_parse_error image_content_policy_violation invalid_image_mode image_file_too_large unsupported_image_media_type empty_image_file failed_to_download_image image_file_not_found

ResponseErrorEvent

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

Имя.	Тип	Description	Обязательно	По умолчанию
код	струна	Код ошибки.	Да
сообщение	струна	Сообщение об ошибке.	Да
параметр	струна	Параметр ошибки.	Да
type	перечисление	тип события; Всегда error. Возможные значения: error	Да

ResponseFailedEvent

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

Имя.	Тип	Description	Обязательно	По умолчанию
response	response		Да
type	перечисление	тип события; Всегда response.failed. Возможные значения: response.failed	Да

ResponseFileSearchCallCompletedEvent

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

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

ResponseFileSearchCallInProgressEvent

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

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

ResponseFileSearchCallSearchingEvent

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

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

ResponseFunctionCallArgumentsDeltaEvent

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

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

ResponseFunctionCallArgumentsDoneEvent

Вызывается, когда аргументы вызова функции завершены.

Имя.	Тип	Description	Обязательно	По умолчанию
arguments	струна	Аргументы вызова функции.	Да
item_id	струна	Идентификатор элемента.	Да
output_index	целое число	Индекс выходного элемента.	Да
type	перечисление	Возможные значения: response.function_call_arguments.done	Да

ResponseInProgressEvent

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

Имя.	Тип	Description	Обязательно	По умолчанию
response	response		Да
type	перечисление	тип события; Всегда response.in_progress. Возможные значения: response.in_progress	Да

ResponseIncompleteEvent

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

Имя.	Тип	Description	Обязательно	По умолчанию
response	response		Да
type	перечисление	тип события; Всегда response.incomplete. Возможные значения: response.incomplete	Да

responseItemList

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

Имя.	Тип	Description	Обязательно	По умолчанию
данные	массив	Список элементов, используемых для создания этого ответа.	Да
первый_идентификатор	струна	Идентификатор первого элемента в списке.	Да
есть_еще	булевый	Доступны ли дополнительные элементы.	Да
last_id	струна	Идентификатор последнего элемента в списке.	Да
объект	перечисление	Тип возвращаемого объекта должен быть list. Возможные значения: list	Да

ResponseModalities

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

["text"]

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

["text", "audio"]

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

ResponseModalitiesTextOnly

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

["text"]

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

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

ResponseOutputItemAddedEvent

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

Имя.	Тип	Description	Обязательно	По умолчанию
item	OutputItem		Да
output_index	целое число	Индекс добавленного выходного элемента.	Да
type	перечисление	тип события; Всегда response.output_item.added. Возможные значения: response.output_item.added	Да

ResponseOutputItemDoneEvent

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

Имя.	Тип	Description	Обязательно	По умолчанию
item	OutputItem		Да
output_index	целое число	Индекс выходного элемента, помеченного как выполненный.	Да
type	перечисление	тип события; Всегда response.output_item.done. Возможные значения: response.output_item.done	Да

ResponseProperties

Имя.	Тип	Description	Обязательно	По умолчанию
instructions	струна	Вставляет сообщение системы (или разработчика) в качестве первого элемента в контексте модели. При использовании вместе с previous_response_idэтим инструкции из предыдущего ответа не будут перенесены в следующий ответ. Это упрощает замену системных сообщений (или сообщений разработчиками) в новых ответах.	нет
max_output_tokens	целое число	Верхняя граница для числа маркеров, которые можно создать для ответа, включая видимые выходные маркеры и состояние беседы.	нет
previous_response_id	струна	Уникальный идентификатор предыдущего ответа на модель. Используйте эту функцию для создания многоэтапных бесед.	нет
reasoning	Reasoning	Параметры конфигурации для моделей рассуждений.	нет
текст	объект	Параметры конфигурации для текстового ответа модели. Можно использовать обычный текст или структурированные данные JSON. Подробнее: — текстовые входные и выходные данные — структурированные выходные данные	нет
└─ Формат	TextResponseFormatConfiguration	Объект, указывающий формат, который должен выводить модель. Настройка { "type": "json_schema" } включает структурированные выходные данные, что гарантирует соответствие модели предоставленной схеме JSON. Формат по умолчанию — это { "type": "text" } без дополнительных параметров. Не рекомендуется использовать для gpt-4o и более новых моделей: Настройка для { "type": "json_object" } включает старый режим JSON, который гарантирует, что создаваемое моделью сообщение является допустимым JSON. Использование json_schema предпочтительнее для моделей, поддерживающих его.	нет
выбор инструмента	ToolChoiceOptions или ToolChoiceTypes или ToolChoiceFunction	Как модель должна выбрать средство (или инструменты), которое следует использовать при создании ответа. Просмотрите tools параметр, чтобы узнать, как указать, какие средства модель может вызывать.	нет
инструменты	массив	Массив инструментов, которые модель может вызывать при создании ответа. Можно указать, какое средство следует использовать, задав tool_choice параметр. Ниже приведены две категории инструментов, которые можно предоставить модели: - Встроенные средства	нет
truncation	перечисление	Стратегия усечения, которую следует использовать для генерирования ответа модели. - auto: если контекст этого ответа и предыдущих превышает размер окна контекста модели, модель усечет ответ, чтобы он соответствовал этому окну, удаляя элементы ввода в середине беседы. - disabled (по умолчанию): если ответ модели превысит размер окна контекста для модели, запрос завершится ошибкой 400. Возможные значения: auto, disabled	нет

ResponseRefusalDeltaEvent

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

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

ResponseRefusalDoneEvent

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

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

responseStreamEvent

Имя.	Тип	Description	Обязательно	По умолчанию
annotation	Annotation		Да
annotation_index	целое число	Индекс добавленной заметки.	Да
arguments	струна	Аргументы вызова функции.	Да
код	струна	Код ошибки.	Да
code_interpreter_call	CodeInterpreterToolCall	Вызов инструмента для выполнения кода.	Да
content_index	целое число	Индекс части содержимого, где завершается текстовое содержимое.	Да
delta	струна	Добавлена разностная строка текста.	Да
item	OutputItem	Выходной элемент, помеченный как выполненный.	Да
item_id	струна	Идентификатор выходного элемента, для которого завершается текстовое содержимое.	Да
сообщение	струна	Сообщение об ошибке.	Да
output_index	целое число	Индекс выходного элемента, в котором завершается текстовое содержимое.	Да
параметр	струна	Параметр ошибки.	Да
part	OutputContent	Часть содержимого, которая выполнена.	Да
отказ	струна	Текст отказа, завершенный.	Да
response	response	Неполный ответ.	Да
текст	струна	Текстовое содержимое, завершенное.	Да
type	перечисление	тип события; Всегда response.output_text.done. Возможные значения: response.output_text.done	Да

ResponseTextAnnotationDeltaEvent

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

Имя.	Тип	Description	Обязательно	По умолчанию
annotation	Annotation		Да
annotation_index	целое число	Индекс добавленной заметки.	Да
content_index	целое число	Индекс части содержимого, в которую добавлена текстовая заметка.	Да
item_id	струна	Идентификатор выходного элемента, к которому добавлена заметка текста.	Да
output_index	целое число	Индекс выходного элемента, в который добавлена текстовая аннотация.	Да
type	перечисление	тип события; Всегда response.output_text.annotation.added. Возможные значения: response.output_text.annotation.added	Да

ResponseTextDeltaEvent

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

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

ResponseTextDoneEvent

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

Имя.	Тип	Description	Обязательно	По умолчанию
content_index	целое число	Индекс части содержимого, где завершается текстовое содержимое.	Да
item_id	струна	Идентификатор выходного элемента, для которого завершается текстовое содержимое.	Да
output_index	целое число	Индекс выходного элемента, в котором завершается текстовое содержимое.	Да
текст	струна	Текстовое содержимое, завершенное.	Да
type	перечисление	тип события; Всегда response.output_text.done. Возможные значения: response.output_text.done	Да

ResponseUsage

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

Имя.	Тип	Description	Обязательно	По умолчанию
input_tokens	целое число	Количество входных токенов.	Да
output_tokens	целое число	Количество выходных токенов.	Да
output_tokens_details	объект	Подробная разбивка выходных маркеров.	Да
└️ reasoning_tokens	целое число	Количество токенов рассуждения.	нет
общее количество токенов	целое число	Общее количество используемых токенов.	Да

Screenshot

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

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

Scroll

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

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

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. Дополнительные сведения о структурированных выходных данных.

Имя.	Тип	Description	Обязательно	По умолчанию
описание	струна	Описание формата ответа, которое используется моделью для определения того, как отвечать в этом формате.	нет
имя	струна	Имя формата ответа. Должен быть a-z, A-Z, 0-9 или содержать символы подчеркивания и дефисы с максимальной длиной 64.	нет
schema	ResponseFormatJsonSchemaSchema	Схема формата ответа, описанная как объект схемы JSON.	Да
строгий	булевый	Следует ли включить строгое соблюдение схемы при создании выходных данных. Если задано значение true, модель всегда будет соответствовать точной схеме, определенной schema в поле. Только подмножество схемы JSON поддерживается, если stricttrue.	нет	Неправда
type	перечисление	Тип определяемого формата ответа. Всегда json_schema. Возможные значения: json_schema	Да

Инструмент

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

• FileSearchTool
• FunctionTool
• ComputerTool

ToolChoiceFunction

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

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

ToolChoiceOptions

Определяет, какое средство (если таковое) вызывается моделью.

none означает, что модель не будет вызывать какое-либо средство и вместо этого создает сообщение.

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

required означает, что модель должна вызывать один или несколько инструментов.

Недвижимость	Ценность
Описание	Определяет, какое средство (если таковое) вызывается моделью. none означает, что модель не будет вызывать какое-либо средство и вместо этого создает сообщение. auto означает, что модель может выбирать между созданием сообщения или вызовом одного или нескольких инструментов. required означает, что модель должна вызывать один или несколько инструментов.
Тип	струна
Значения	none auto required

ToolChoiceTypes

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

Имя.	Тип	Description	Обязательно	По умолчанию
type	перечисление	Тип размещенного инструмента, который должна использовать модель. Допустимые значения: - file_search - computer_use_preview Возможные значения: file_search, computer_use_preview	Да

Тип

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

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

UpdateVectorStoreFileAttributesRequest

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

UrlCitation

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

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

VectorStoreFileAttributes

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

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

VectorStoreFileContentResponse

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

Имя.	Тип	Description	Обязательно	По умолчанию
данные	массив	Проанализированное содержимое файла.	Да
есть_еще	булевый	Указывает, есть ли еще страницы содержимого для загрузки.	Да
next_page	струна	Маркер для следующей страницы, если таковой есть.	Да
объект	перечисление	Тип объекта, который всегда является vector_store.file_content.page Возможные значения: vector_store.file_content.page	Да

VectorStoreSearchRequest

Имя.	Тип	Description	Обязательно	По умолчанию
filters	ComparisonFilter или CompoundFilter	Фильтр для применения на основе атрибутов файла.	нет
максимальное_количество_результатов	целое число	Максимальное количество отображаемых результатов. Это число должно быть от 1 до 50 включительно.	нет	10
query	строка или массив	Строка запроса для поиска	Да
опции рейтинга	объект	Параметры ранжирования для поиска.	нет
Рангер └️	перечисление	Возможные значения: auto, default-2024-11-15	нет
└─ порог оценки	число/номер		нет	0
rewrite_query	булевый	Следует ли переписать запрос естественного языка для векторного поиска.	нет	Неправда

VectorStoreSearchResultContentObject

Имя.	Тип	Description	Обязательно	По умолчанию
текст	струна	Текстовое содержимое, возвращенное из поиска.	Да
type	перечисление	Тип содержимого. Возможные значения: text	Да

VectorStoreSearchResultItem

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

VectorStoreSearchResultsPage

Имя.	Тип	Description	Обязательно	По умолчанию
данные	массив	Список элементов результатов поиска.	Да
есть_еще	булевый	Указывает, есть ли дополнительные результаты для получения.	Да
next_page	струна	Маркер для следующей страницы, если таковой есть.	Да
объект	перечисление	Тип объекта, который всегда является vector_store.search_results.page Возможные значения: vector_store.search_results.page	Да
search_query	массив		Да

VoiceIdsShared

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

Wait

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

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

ReasoningEffort

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

Недвижимость	Ценность
Описание	Ограничивает усилия по рассуждениям моделей. В настоящее время поддерживаются lowзначения , mediumи high. Сокращение усилий по поводу может привести к более быстрым откликам и меньшем количестве маркеров, используемых при рассуждениях в ответе.
Тип	струна
По умолчанию	medium
Значения	low medium high

errorEvent

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

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

перечисление события: ErrorEventEnum

Ценность	Description
ошибка

doneEvent

Происходит, когда поток заканчивается.

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

перечисление события: DoneEventEnum

Ценность	Description
done

перечисление данных: DoneEventDataEnum

Ценность	Description
[DONE]

Дальнейшие шаги

Узнайте о моделях и тонкой настройке с помощью REST API. Узнайте больше о недоумение моделей, которые Azure OpenAI.