Azure OpenAI Chat

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

Server:{endpoint}/openai/v1 — Azure AI Foundry API моделей

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

Variable По умолчанию Description
endpoint Поддерживаемый Azure AI Foundry моделирует конечную точку API, включая протокол и имя хоста.
Рассмотрим пример.
https://westus.api.cognitive.microsoft.com).

Authentication

ApiKeyAuth (ключ API)

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

ApiKeyAuth_ (Ключ API)

Передайте свой API в authorization заголовок.

OAuth2Auth (OAuth 2.0)

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

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

Области:

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

Требования к безопасности

Конечные точки принимают любой из следующих методов аутентификации:

  1. ApiKeyAuth
  2. ApiKeyAuth_
  3. OAuth2Auth (прицелы: https://cognitiveservices.azure.com/.default)

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

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

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

Параметры URI

Name In Обязательный Type Description
endpoint server Да строка Поддерживаемый Azure AI Foundry моделирует конечную точку API, включая протокол и имя хоста.
Рассмотрим пример.
https://westus.api.cognitive.microsoft.com).
версия API query Нет строка
Возможные значения: v1, preview		 Явная версия API Azure AI Foundry Models, используемая для этого запроса.
v1, если не указано иначе.

Тело запроса

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

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

Это значение теперь устарело и заменено на max_completion_tokens.
несовместимы с моделями серии o1.		 Нет
messages массив OpenAI.ChatCompletionRequestMessage Список сообщений, составляющих беседу до сих пор. В зависимости от
Модель, которую вы используете, поддерживает различные типы сообщений и модальности.
например текст, изображения и звук.
Ограничения: minItems: 1		 Да
metadata OpenAI.Metadata или NULL Нет
Условия OpenAI.ResponseModalities Типы выходных данных, которые вы хотите, чтобы модель генерировала.
Большинство моделей могут создавать текст, который по умолчанию:
["text"]
Модель gpt-4o-audio-preview также можно использовать для
создайте звук. Чтобы запросить у этой модели выполнение задачи
Можно использовать как текстовые, так и звуковые ответы:
["text", "audio"]		 Нет
модель строка Идентификатор модели, используемый для создания ответа, например gpt-4o или o3. OpenAI
предлагает широкий спектр моделей с разными возможностями, производительностью
характеристики и цены. См. руководство по модели
для просмотра и сравнения доступных моделей.		 Да
н целое число или null Сколько вариантов завершения чата для каждого входного сообщения. Обратите внимание, что плата будет взиматься на основе количества созданных токенов во всех вариантах. Сохраняйте n как 1, чтобы свести к минимуму затраты.
Ограничения: минимум: 1, максимум: 128		 Нет
вызовы инструмента в параллельном режиме OpenAI.ParallelToolCalls Следует ли включить параллельные вызовы функций во время использования средства. Нет
прогноз OpenAI.PredictionContent Статическое прогнозируемое выходное содержимое, например содержимое текстового файла, которое является
повторное создание.		 Нет
└─ Содержимое строка или массив OpenAI.ChatCompletionRequestMessageContentPartText Содержимое, которое должно быть сопоставлено при создании ответа модели.
Если созданные маркеры соответствуют этому содержимому, весь ответ модели
можно вернуть гораздо быстрее.		 Да
└─ Тип enum Тип прогнозируемого содержимого, который требуется предоставить. Этот тип является
в настоящее время всегда content.
Возможные значения: content		 Да
штраф_за_присутствие число или null Число от -2.0 до 2.0. Положительные значения штрафуют новые токены в зависимости от
Появляются ли они в тексте до этого момента, увеличивая вероятность модели
обсуждать новые темы.
Ограничения: min: -2, max: 2		 Нет
prompt_cache_key строка Используется OpenAI для кэширования ответов для аналогичных запросов для оптимизации частоты попаданий кэша. Заменяет user поле. Подробнее. Нет
prompt_cache_retention строка или null Нет
усилия на рассуждение OpenAI.ReasoningEffort Ограничение усилий в процессе обоснования
модели рассуждений.
В настоящее время поддерживаются noneзначения , , minimal, lowmedium, highи xhigh. Уменьшение
Усилия рассуждения могут привести к более быстрым ответам и меньшему использованию маркеров.
о рассуждении в ответе.
- gpt-5.1 по умолчанию используется noneзначение , которое не выполняет причину. Поддерживаемые значения gpt-5.1 аргументов: none, lowmediumи high. Вызовы инструментов поддерживаются для всех значений причин в gpt-5.1.
— Все модели до выполнения действий по gpt-5.1 умолчанию medium и не поддерживаются none.
— Модель gpt-5-pro по умолчанию используется (и поддерживает только) high усилия по поводу.
- xhigh поддерживается для всех моделей после gpt-5.1-codex-max.		 Нет
формат_ответа OpenAI.CreateChatCompletionRequestResponseFormat Объект, указывающий формат, который должен выводить модель.
Параметр включения { "type": "json_schema", "json_schema": {...} }
Структурированные выходы, которые гарантируют, что модель будет совпадать с вашим JSON
Схемы. Дополнительные сведения см. в разделе "Структурированные выходные данные"
руководство.
Установка { "type": "json_object" } включает старый режим JSON, который
гарантирует, что сообщение, которое создает модель, является допустимым JSON. С использованием json_schema
предпочтителен для моделей, поддерживающих его.		 Нет
└─ Тип OpenAI.CreateChatCompletionRequestResponseFormatType Да
safety_identifier строка Стабильный идентификатор, используемый для обнаружения пользователей приложения, которые могут нарушать политики использования OpenAI.
Идентификаторы должны быть строкой, которая однозначно идентифицирует каждого пользователя. Мы рекомендуем хэшировать имя пользователя или адрес электронной почты, чтобы избежать отправки нам каких-либо сведений об идентификации. Подробнее.		 Нет
seed целое число или null (устарело) Эта функция доступна в бета-версии.
Если это указано, наша система постарается осуществлять детерминированную выборку, так что повторяющиеся запросы с одним и тем же seed и параметрами должны возвращать тот же результат.
Детерминизм не гарантируется, и вам следует обращаться к параметру ответа system_fingerprint, чтобы отслеживать изменения на сервере.		 Нет
stop OpenAI.StopConfiguration Не поддерживается с последними моделями рассуждений o3 и o4-mini.
До 4 последовательностей, в которых API перестанет генерировать дополнительные токены. Компонент
Текст, который будет возвращен, не будет содержать стоп-последовательность.		 Нет
store логический или null Следует ли сохранять выходные данные этого запроса завершения чата?
используйте для сжатия моделей или продуктов для оценки.		 Нет
stream логический или null Если задано значение true, данные ответа модели будут передаваться клиенту.
при создании с помощью событий, отправленных сервером.		 Нет
stream_options OpenAI.ChatCompletionStreamOptions или null Нет
Температура число или null Нет
выбор инструмента OpenAI.ChatCompletionToolChoiceOption Определяет, какое средство (если таковое) вызывается моделью.
none означает, что модель не будет вызывать какое-либо средство и вместо этого создает сообщение.
auto означает, что модель может выбирать между созданием сообщения или вызовом одного или нескольких инструментов.
required означает, что модель должна вызывать один или несколько инструментов.
Указание конкретного инструмента через {"type": "function", "function": {"name": "my_function"}} заставляет модель вызвать этот инструмент.
none значение по умолчанию, если средства отсутствуют. auto является значением по умолчанию, если имеются инструменты.		 Нет
tools массив OpenAI.ChatCompletionTool или OpenAI.CustomToolChatCompletions Список инструментов, которые может вызывать модель. Вы можете указать любой из этих вариантов.
пользовательские средства или
средства функции.		 Нет
top_logprobs целое число или null Нет
top_p число или null Нет
user string (не рекомендуется) Уникальный идентификатор, представляющий конечного пользователя, который может помочь в этом.
мониторинг и обнаружение злоупотреблений.		 Нет
user_security_context AzureUserSecurityContext Контекст безопасности пользователя содержит несколько параметров, описывающих само приложение, и конечный пользователь, взаимодействующий с приложением. Эти поля помогают группам по операциям безопасности исследовать и устранять инциденты безопасности, предоставляя комплексный подход к защите приложений ИИ. Узнайте больше о защите приложений ИИ с помощью Microsoft Defender для облака. Нет
Детализации OpenAI.Verbosity Ограничивает детализацию ответа модели. Более низкие значения будут приводить к
более краткие ответы, в то время как более высокие значения приводят к более подробным ответам.
В настоящее время поддерживаются lowзначения , mediumи high.		 Нет

Responses

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

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

Тип содержимого Type Description
application/json объект или объект

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

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

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

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

Тип содержимого Type Description
application/json object
Name Type Description Обязательный По умолчанию
code строка или null Да
внутренняя ошибка Нет
message строка Да
параметр строка или null Да
type строка Да

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

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

Примеры

Пример

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

POST {endpoint}/openai/v1/chat/completions?api-version=latest&azure-beta=v1=preview

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

Ответы:

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

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

Components

AzureAIFoundryModelsApiVersion

Property Ценность
Type строка
Значения v1
preview

AzureContentFilterBlocklistResult

Коллекция результатов фильтрации true/false для настроенных настраиваемых списков блокировок.

Name Type Description Обязательный По умолчанию
details массив объекта Пары отдельных идентификаторов черных списков и привели ли они к действию фильтрации. Нет
Отфильтрованный boolean Значение, указывающее, приводит ли любой из подробных списков блокировок к действию фильтрации. Да

AzureContentFilterCompletionTextSpan

Представление текста завершённого сегмента, используемого результатами фильтрации содержимого Azure OpenAI.

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

AzureContentFilterCompletionTextSpanDetectionResult

Name Type Description Обязательный По умолчанию
details массив AzureContentFilterCompletionTextSpan Подробные сведения об обнаруженных диапазонах текста завершения. Да
Обнаружено boolean Обнаружена ли в содержимом категория отмеченного контента. Да
Отфильтрованный boolean Приведет ли обнаружение содержимого к действию фильтрации содержимого. Да

РезультатНастраиваемойТемыФильтраКонтентаAzure

Коллекция результатов фильтрации true/false для настроенных пользовательских разделов.

Name Type Description Обязательный По умолчанию
details массив объекта Пары идентификаторов отдельных тем и информация об их обнаружении. Нет
Отфильтрованный boolean Значение, указывающее, приводит ли любой из подробных разделов к действию фильтрации. Да

AzureContentFilterDetectionResult

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

Name Type Description Обязательный По умолчанию
Обнаружено boolean Обнаружена ли в содержимом категория отмеченного контента. Да
Отфильтрованный boolean Приведет ли обнаружение содержимого к действию фильтрации содержимого. Да

Azure Фильтр контента: Результат для Личной Идентифицируемой Информации

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

Name Type Description Обязательный По умолчанию
Обнаружено boolean Обнаружена ли в содержимом категория отмеченного контента. Да
Отфильтрованный boolean Приведет ли обнаружение содержимого к действию фильтрации содержимого. Да
redacted_text строка Отредактированные тексты с информацией piI удалены или маскированы. Нет
подкатегории массив AzurePiiSubCategoryResult Подробные результаты для отдельных PIIHarmSubCategory. Нет

AzureContentFilterResultForChoice

Результат фильтра содержимого для одного элемента ответа, созданного системой создания искусственного интеллекта.

Name Type Description Обязательный По умолчанию
custom_blocklists AzureContentFilterBlocklistResult Коллекция результатов фильтрации true/false для настроенных настраиваемых списков блокировок. Нет
└️ подробности массив объекта Пары отдельных идентификаторов черных списков и привели ли они к действию фильтрации. Нет
└️ отфильтрован boolean Значение, указывающее, был ли блок-список создан действие фильтрации. Да
Идентификатор └️ строка Идентификатор настраиваемого списка блоков, вычисляемого. Да
└️ отфильтрован boolean Значение, указывающее, приводит ли любой из подробных списков блокировок к действию фильтрации. Да
пользовательские_темы AzureContentFilterCustomTopicResult Коллекция результатов фильтрации true/false для настроенных пользовательских разделов. Нет
└️ подробности массив объекта Пары идентификаторов отдельных тем и информация об их обнаружении. Нет
└─ Обнаружено boolean Значение, указывающее, обнаружен ли раздел. Да
Идентификатор └️ строка Идентификатор вычисляемого пользовательского раздела. Да
└️ отфильтрован boolean Значение, указывающее, приводит ли любой из подробных разделов к действию фильтрации. Да
error object Если имеются, подробные сведения об ошибке, которая помешала завершить оценку фильтрации содержимого. Нет
└─ Код целое число (int32) Отдельный удобочитаемый компьютером код, связанный с ошибкой. Да
Сообщение └️ строка Сообщение, доступное для чтения человеком, связанное с ошибкой. Да
Ненавижу AzureContentFilterSeverityResult Результат фильтрации содержимого с обозначениями, указывающий, было ли отфильтровано содержимое и каково его качественное состояние.
Уровень серьезности содержимого был оценен по конфигурации фильтра содержимого для категории.		 Нет
└️ отфильтрован boolean Является ли серьезность содержимого результатом действия фильтрации содержимого. Да
└─ серьезность enum Заданный уровень серьезности содержимого.
Возможные значения: safe, , lowmediumhigh		 Да
персонально идентифицируемая информация AzureContentFilterPersonallyIdentifiableInformationResult Результат обнаружения фильтра контента для персонально идентифицируемой информации, включая расширения, связанные с потенциальным вредом. Нет
└️ redacted_text строка Отредактированные тексты с информацией piI удалены или маскированы. Нет
└─ подкатегории массив AzurePiiSubCategoryResult Подробные результаты для отдельных PIIHarmSubCategory. Нет
Ненормативной лексики AzureContentFilterDetectionResult Элемент результата фильтра содержимого с меткой, указывающий, было ли содержимое обнаружено и было ли оно выявлено.
отфильтрованный.		 Нет
└─ Обнаружено boolean Обнаружена ли в содержимом категория отмеченного контента. Да
└️ отфильтрован boolean Приведет ли обнаружение содержимого к действию фильтрации содержимого. Да
код_защищённого_материала object Результат обнаружения, описывающий совпадение с лицензированным кодом или другим защищенным исходным материалом. Нет
└─ цитирование object Если возможно, детали цитирования, описывающие связанную лицензию и место их расположения. Нет
URL-адрес string (URI) URL-адрес, связанный с лицензией. Нет
Лицензия строка Имя или идентификатор лицензии, связанной с обнаружением. Нет
└─ Обнаружено boolean Обнаружена ли в содержимом категория отмеченного контента. Да
└️ отфильтрован boolean Приведет ли обнаружение содержимого к действию фильтрации содержимого. Да
защищённый_текст_материала AzureContentFilterDetectionResult Элемент результата фильтра содержимого с меткой, указывающий, было ли содержимое обнаружено и было ли оно выявлено.
отфильтрованный.		 Нет
└─ Обнаружено boolean Обнаружена ли в содержимом категория отмеченного контента. Да
└️ отфильтрован boolean Приведет ли обнаружение содержимого к действию фильтрации содержимого. Да
самоповреждение AzureContentFilterSeverityResult Результат фильтрации содержимого с обозначениями, указывающий, было ли отфильтровано содержимое и каково его качественное состояние.
Уровень серьезности содержимого был оценен по конфигурации фильтра содержимого для категории.		 Нет
└️ отфильтрован boolean Является ли серьезность содержимого результатом действия фильтрации содержимого. Да
└─ серьезность enum Заданный уровень серьезности содержимого.
Возможные значения: safe, , lowmediumhigh		 Да
Сексуальной AzureContentFilterSeverityResult Результат фильтрации содержимого с обозначениями, указывающий, было ли отфильтровано содержимое и каково его качественное состояние.
Уровень серьезности содержимого был оценен по конфигурации фильтра содержимого для категории.		 Нет
└️ отфильтрован boolean Является ли серьезность содержимого результатом действия фильтрации содержимого. Да
└─ серьезность enum Заданный уровень серьезности содержимого.
Возможные значения: safe, , lowmediumhigh		 Да
ungrounded_material AzureContentFilterCompletionTextSpanDetectionResult Нет
Насилия AzureContentFilterSeverityResult Результат фильтрации содержимого с обозначениями, указывающий, было ли отфильтровано содержимое и каково его качественное состояние.
Уровень серьезности содержимого был оценен по конфигурации фильтра содержимого для категории.		 Нет
└️ отфильтрован boolean Является ли серьезность содержимого результатом действия фильтрации содержимого. Да
└─ серьезность enum Заданный уровень серьезности содержимого.
Возможные значения: safe, , lowmediumhigh		 Да

AzureContentFilterResultForPrompt

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

Name Type Description Обязательный По умолчанию
результаты фильтрации контента object Сведения о категории фильтрации содержимого для результата. Нет
└─ настраиваемые черные списки AzureContentFilterBlocklistResult Коллекция результатов фильтрации true/false для настроенных настраиваемых списков блокировок. Нет
└️ подробности массив объекта Пары отдельных идентификаторов черных списков и привели ли они к действию фильтрации. Нет
└️ отфильтрован boolean Значение, указывающее, был ли блок-список создан действие фильтрации. Да
Идентификатор └️ строка Идентификатор настраиваемого списка блоков, вычисляемого. Да
└️ отфильтрован boolean Значение, указывающее, приводит ли любой из подробных списков блокировок к действию фильтрации. Да
└темы_настроек AzureContentFilterCustomTopicResult Коллекция результатов фильтрации true/false для настроенных пользовательских разделов. Нет
└️ подробности массив объекта Пары идентификаторов отдельных тем и информация об их обнаружении. Нет
└─ Обнаружено boolean Значение, указывающее, обнаружен ли раздел. Да
Идентификатор └️ строка Идентификатор вычисляемого пользовательского раздела. Да
└️ отфильтрован boolean Значение, указывающее, приводит ли любой из подробных разделов к действию фильтрации. Да
└─ Ошибка object Если имеются, подробные сведения об ошибке, которая помешала завершить оценку фильтрации содержимого. Нет
└─ Код целое число (int32) Отдельный удобочитаемый компьютером код, связанный с ошибкой. Да
Сообщение └️ строка Сообщение, доступное для чтения человеком, связанное с ошибкой. Да
└️ ненависть AzureContentFilterSeverityResult Результат фильтрации содержимого с обозначениями, указывающий, было ли отфильтровано содержимое и каково его качественное состояние.
Уровень серьезности содержимого был оценен по конфигурации фильтра содержимого для категории.		 Нет
└️ отфильтрован boolean Является ли серьезность содержимого результатом действия фильтрации содержимого. Да
└─ серьезность enum Заданный уровень серьезности содержимого.
Возможные значения: safe, , lowmediumhigh		 Да
└─ косвенная_атака AzureContentFilterDetectionResult Элемент результата фильтра содержимого с меткой, указывающий, было ли содержимое обнаружено и было ли оно выявлено.
отфильтрованный.		 Да
└─ Обнаружено boolean Обнаружена ли в содержимом категория отмеченного контента. Да
└️ отфильтрован boolean Приведет ли обнаружение содержимого к действию фильтрации содержимого. Да
└️ джейл-брейк AzureContentFilterDetectionResult Элемент результата фильтра содержимого с меткой, указывающий, было ли содержимое обнаружено и было ли оно выявлено.
отфильтрованный.		 Да
└─ Обнаружено boolean Обнаружена ли в содержимом категория отмеченного контента. Да
└️ отфильтрован boolean Приведет ли обнаружение содержимого к действию фильтрации содержимого. Да
└️ ненормативная лексика AzureContentFilterDetectionResult Элемент результата фильтра содержимого с меткой, указывающий, было ли содержимое обнаружено и было ли оно выявлено.
отфильтрованный.		 Нет
└─ Обнаружено boolean Обнаружена ли в содержимом категория отмеченного контента. Да
└️ отфильтрован boolean Приведет ли обнаружение содержимого к действию фильтрации содержимого. Да
└─ членовредительство AzureContentFilterSeverityResult Результат фильтрации содержимого с обозначениями, указывающий, было ли отфильтровано содержимое и каково его качественное состояние.
Уровень серьезности содержимого был оценен по конфигурации фильтра содержимого для категории.		 Нет
└️ отфильтрован boolean Является ли серьезность содержимого результатом действия фильтрации содержимого. Да
└─ серьезность enum Заданный уровень серьезности содержимого.
Возможные значения: safe, , lowmediumhigh		 Да
└️ сексуальный AzureContentFilterSeverityResult Результат фильтрации содержимого с обозначениями, указывающий, было ли отфильтровано содержимое и каково его качественное состояние.
Уровень серьезности содержимого был оценен по конфигурации фильтра содержимого для категории.		 Нет
└️ отфильтрован boolean Является ли серьезность содержимого результатом действия фильтрации содержимого. Да
└─ серьезность enum Заданный уровень серьезности содержимого.
Возможные значения: safe, , lowmediumhigh		 Да
└️ насилие AzureContentFilterSeverityResult Результат фильтрации содержимого с обозначениями, указывающий, было ли отфильтровано содержимое и каково его качественное состояние.
Уровень серьезности содержимого был оценен по конфигурации фильтра содержимого для категории.		 Нет
└️ отфильтрован boolean Является ли серьезность содержимого результатом действия фильтрации содержимого. Да
└─ серьезность enum Заданный уровень серьезности содержимого.
Возможные значения: safe, , lowmediumhigh		 Да
индекс_подсказки целое число (int32) Индекс входного запроса, связанного с сопутствующими категориями результатов фильтра содержимого. Нет

AzureContentFilterSeverityResult

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

Name Type Description Обязательный По умолчанию
Отфильтрованный boolean Является ли серьезность содержимого результатом действия фильтрации содержимого. Да
Тяжести enum Заданный уровень серьезности содержимого.
Возможные значения: safe, , lowmediumhigh		 Да

AzurePiiSubCategoryResult

Сведения о результатах для отдельных категорий PIIHarmSubCategory.

Name Type Description Обязательный По умолчанию
Обнаружено boolean Обнаружена ли в содержимом подкатегория помеченного содержимого. Да
Отфильтрованный boolean Является ли обнаружение контента результатом действия фильтрации содержимого для этой подкатегории. Да
отредактировано boolean Редактируется ли содержимое для этой подкатегории. Да
подкатегория строка Была оценена PIIHarmSubCategory. Да

AzureUserSecurityContext

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

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

OpenAI.ChatCompletionAllowedTools

Разрешенные средства

Ограничивает средства, доступные для модели, предварительно определенным набором.

Name Type Description Обязательный По умолчанию
mode enum Ограничивает средства, доступные для модели, предварительно определенным набором.
auto позволяет модели выбирать из разрешенных средств и создавать
сообщение.
required требуется, чтобы модель вызывала один или несколько разрешенных средств.
Возможные значения: auto, required		 Да
tools массив объекта Список определений инструментов, которые модель должна быть разрешена для вызова.
Для API завершения чата список определений инструментов может выглядеть следующим образом:
json<br> [<br> { "type": "function", "function": { "name": "get_weather" } },<br> { "type": "function", "function": { "name": "get_time" } }<br> ]<br> 		Да

OpenAI.ChatCompletionAllowedToolsChoice

Разрешенные средства

Ограничивает средства, доступные для модели, предварительно определенным набором.

Name Type Description Обязательный По умолчанию
разрешённые_инструменты OpenAI.ChatCompletionAllowedTools Ограничивает средства, доступные для модели, предварительно определенным набором. Да
type enum Разрешенный тип конфигурации средства. Всегда allowed_tools.
Возможные значения: allowed_tools		 Да

OpenAI.ChatCompletionFunctionCallOption

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

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

OpenAI.ChatCompletionFunctions

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

OpenAI.ChatCompletionMessageCustomToolCall

Пользовательский вызов инструмента

Вызов пользовательского средства, созданного моделью.

Name Type Description Обязательный По умолчанию
Пользовательские OpenAI.ChatCompletionMessageCustomToolCallCustom Да
└─ Входные данные строка Да
└️ имя строка Да
id строка Идентификатор вызова инструмента. Да
type enum Тип средства. Всегда custom.
Возможные значения: custom		 Да

OpenAI.ChatCompletionMessageCustomToolCallCustom

Name Type Description Обязательный По умолчанию
input строка Да
имя строка Да

OpenAI.ChatCompletionMessageToolCall

Вызов функционального инструмента

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

Name Type Description Обязательный По умолчанию
function OpenAI.ChatCompletionMessageToolCallFunction Да
└─ аргументы строка Да
└️ имя строка Да
id строка Идентификатор вызова инструмента. Да
type enum Тип средства. В настоящее время поддерживается только function .
Возможные значения: function		 Да

OpenAI.ChatCompletionMessageToolCallChunk

Name Type Description Обязательный По умолчанию
function OpenAI.ChatCompletionMessageToolCallChunkFunction Нет
id строка Идентификатор вызова инструмента. Нет
index целое число Да
type enum Тип средства. В настоящее время поддерживается только function .
Возможные значения: function		 Нет

OpenAI.ChatCompletionMessageToolCallChunkFunction

Name Type Description Обязательный По умолчанию
arguments строка Нет
имя строка Нет

OpenAI.ChatCompletionMessageToolCallFunction

Name Type Description Обязательный По умолчанию
arguments строка Да
имя строка Да

OpenAI.ChatCompletionMessageToolCalls

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

OpenAI.ChatCompletionMessageToolCallsItem

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

OpenAI.ChatCompletionNamedToolChoice

Выбор функционального инструмента

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

Name Type Description Обязательный По умолчанию
function OpenAI.ChatCompletionNamedToolChoiceFunction Да
type enum Для вызова функции тип всегда function.
Возможные значения: function		 Да

OpenAI.ChatCompletionNamedToolChoiceCustom

Выбор пользовательского инструмента

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

Name Type Description Обязательный По умолчанию
Пользовательские OpenAI.ChatCompletionNamedToolChoiceCustomCustomCustom Да
type enum Для вызова пользовательского инструмента всегда используется customтип.
Возможные значения: custom		 Да

OpenAI.ChatCompletionNamedToolChoiceCustomCustomCustom

Name Type Description Обязательный По умолчанию
имя строка Да

OpenAI.ChatCompletionNamedToolChoiceFunction

Name Type Description Обязательный По умолчанию
имя строка Да

OpenAI.ChatCompletionRequestAssistantMessage

Сообщение ассистента

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

Name Type Description Обязательный По умолчанию
audio OpenAI.ChatCompletionRequestAssistantMessageAudio или null Данные о предыдущем звуковом ответе модели. Нет
содержимое строка или массив OpenAI.ChatCompletionRequestAssistantMessageContentPart или null Нет
вызов_функции OpenAI.ChatCompletionRequestAssistantMessageFunctionCall или null Нет
имя строка Необязательное имя участника. Предоставляет сведения о модели, чтобы различать участников одной роли. Нет
отказ строка или null Нет
role enum Роль автора сообщений в данном случае assistant.
Возможные значения: assistant		 Да
вызовы инструментов OpenAI.ChatCompletionMessageToolCalls Вызовы инструментов, сгенерированные моделью, например вызовы функций. Нет

OpenAI.ChatCompletionRequestAssistantMessageAudio

Name Type Description Обязательный По умолчанию
id строка Да

OpenAI.ChatCompletionRequestAssistantMessageContentPart

Дискриминация для OpenAI.ChatCompletionRequestAssistantMessageContentPart

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

Значение типа Schema
refusal OpenAI.ChatCompletionRequestMessageContentPartRefusal
text OpenAI.ChatCompletionRequestAssistantMessageContentPartChatCompletionRequestMessageContentPartText
Name Type Description Обязательный По умолчанию
type OpenAI.ChatCompletionRequestAssistantMessageContentPartType Да

OpenAI.ChatCompletionRequestAssistantMessageContentPartChatCompletionRequestMessageContentPartText

Текстовая часть

Узнайте о входных данных текста.

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

OpenAI.ChatCompletionRequestAssistantMessageContentPartType

Property Ценность
Type строка
Значения text
refusal

OpenAI.ChatCompletionRequestAssistantMessageFunctionCall

Name Type Description Обязательный По умолчанию
arguments строка Да
имя строка Да

OpenAI.ChatCompletionRequestDeveloperMessage

Сообщение разработчика

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

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

OpenAI.ChatCompletionRequestFunctionMessage

Сообщение функции

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

OpenAI.ChatCompletionRequestMessage

Дискриминатор для OpenAI.ChatCompletionRequestMessage

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

Значение типа Schema
assistant OpenAI.ChatCompletionRequestAssistantMessage
developer OpenAI.ChatCompletionRequestDeveloperMessage
function OpenAI.ChatCompletionRequestFunctionMessage
system OpenAI.ChatCompletionRequestSystemMessage
user OpenAI.ChatCompletionRequestUserMessage
tool OpenAI.ChatCompletionRequestToolMessage
Name Type Description Обязательный По умолчанию
role OpenAI.ChatCompletionRequestMessageType Да

OpenAI.ChatCompletionRequestMessageContentPartAudio

Аудиоконтент

Name Type Description Обязательный По умолчанию
input_audio OpenAI.ChatCompletionRequestMessageContentPartAudioInputAudioAudio Да
type enum Тип части содержимого. Всегда input_audio.
Возможные значения: input_audio		 Да

OpenAI.ChatCompletionRequestMessageContentPartAudioInputAudioAudio

Name Type Description Обязательный По умолчанию
data строка Да
format enum
Возможные значения: wav, mp3		 Да

OpenAI.ChatCompletionRequestMessageContentPartFile

Часть содержимого файла

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

Name Type Description Обязательный По умолчанию
file OpenAI.ChatCompletionRequestMessageContentPartFileFile Да
└ file_data строка Нет
└ file_id строка Нет
└️ имя файла строка Нет
type enum Тип части содержимого. Всегда file.
Возможные значения: file		 Да

OpenAI.ChatCompletionRequestMessageContentPartFileFile

Name Type Description Обязательный По умолчанию
file_data строка Нет
идентификатор_файла строка Нет
filename строка Нет

OpenAI.ChatCompletionRequestMessageContentPartImage

Часть содержимого изображения

Name Type Description Обязательный По умолчанию
ссылка_на_изображение OpenAI.ChatCompletionRequestMessageContentPartImageImageUrl Да
type enum Тип части содержимого.
Возможные значения: image_url		 Да

OpenAI.ChatCompletionRequestMessageContentPartImageImageUrl

Name Type Description Обязательный По умолчанию
detail enum
Возможные значения: auto, lowhigh		 Нет авто
url string (URI) Да

OpenAI.ChatCompletionRequestMessageContentPartRefusal

Часть с содержанием отказа

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

OpenAI.ChatCompletionRequestMessageContentPartText

Текстовая часть

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

OpenAI.ChatCompletionRequestMessageType

Property Ценность
Type строка
Значения developer
system
user
assistant
tool
function

OpenAI.ChatCompletionRequestSystemMessage

Системное сообщение

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

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

OpenAI.ChatCompletionRequestSystemMessageContentPart

Ссылки: OpenAI.ChatCompletionRequestMessageContentPartText

OpenAI.ChatCompletionRequestToolMessage

Сообщение инструмента

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

OpenAI.ChatCompletionRequestToolMessageContentPart

Ссылки: OpenAI.ChatCompletionRequestMessageContentPartText

OpenAI.ChatCompletionRequestUserMessage

Сообщение пользователя

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

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

OpenAI.ChatCompletionRequestUserMessageContentPart

Дискриминация для OpenAI.ChatCompletionRequestUserMessageContentPart

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

Значение типа Schema
image_url OpenAI.ChatCompletionRequestMessageContentPartImage
input_audio OpenAI.ChatCompletionRequestMessageContentPartAudio
file OpenAI.ChatCompletionRequestMessageContentPartFile
text OpenAI.ChatCompletionRequestUserMessageContentPartChatCompletionRequestMessageContentPartText
Name Type Description Обязательный По умолчанию
type OpenAI.ChatCompletionRequestUserMessageContentPartType Да

OpenAI.ChatCompletionRequestUserMessageContentPartChatCompletionRequestMessageContentPartText

Текстовая часть

Узнайте о входных данных текста.

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

OpenAI.ChatCompletionRequestUserMessageContentPartType

Property Ценность
Type строка
Значения text
image_url
input_audio
file

OpenAI.ChatCompletionResponseMessage

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

Name Type Description Обязательный По умолчанию
annotations массив OpenAI.ChatCompletionResponseMessageAnnotations Заметки для сообщения, если это применимо, как при использовании
Средство поиска в Интернете.		 Нет
audio OpenAI.ChatCompletionResponseMessageAudio или null Нет
содержимое строка или null Да
вызов_функции OpenAI.ChatCompletionResponseMessageFunctionCall (устарело) Нет
└─ аргументы строка Да
└️ имя строка Да
reasoning_content строка Свойство расширения, специфичное для Azure, содержащее сгенерированное содержание логических выводов из поддерживаемых моделей. Нет
отказ строка или null Да
role enum Роль автора этого сообщения.
Возможные значения: assistant		 Да
вызовы инструментов OpenAI.ChatCompletionMessageToolCallsItem Вызовы инструментов, сгенерированные моделью, например вызовы функций. Нет

OpenAI.ChatCompletionResponseMessageAnnotations

Name Type Description Обязательный По умолчанию
type enum
Возможные значения: url_citation		 Да
url_citation OpenAI.ChatCompletionResponseMessageAnnotationsUrlCitation Да

OpenAI.ChatCompletionResponseMessageAnnotationsUrlCitation

Name Type Description Обязательный По умолчанию
end_index целое число Да
start_index целое число Да
title строка Да
url строка Да

OpenAI.ChatCompletionResponseMessageAudio

Name Type Description Обязательный По умолчанию
data строка Да
срок_действия_до целое число (UnixTime) Да
id строка Да
Стенограмма строка Да

OpenAI.ChatCompletionResponseMessageFunctionCall

Name Type Description Обязательный По умолчанию
arguments строка Да
имя строка Да

OpenAI.ChatCompletionStreamOptions

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

Name Type Description Обязательный По умолчанию
include_obfuscation boolean Если задано значение true, будет включена обфускация потока. Добавляется скрытие потока
случайные символы в поле потоковой передачи obfuscation событий разностных событий в
нормализованные размеры полезных данных в качестве устранения определенных атак на стороне канала.
Эти поля маскировки включены по умолчанию, но добавьте небольшое количество.
затраты на поток данных. Можно задать include_obfuscation значение
False для оптимизации пропускной способности, если вы доверяете сетевым каналам между
приложение и API OpenAI.		 Нет
включить_использование boolean Если задано, до этого будет передаваться дополнительный блок. data: [DONE]
сообщение. Поле на этом сегменте usage отображает статистику использования токенов.
для всего запроса, и choices поле всегда будет пустым
массив.
Все остальные блоки также будут включать usage поле, но с значением NULL
ценность. ЗАМЕТКА: Если поток прерван, возможно, вы не получите
финальный блок использования, содержащий общее использование токенов для запроса.		 Нет

OpenAI.ChatCompletionStreamResponseDelta

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

Name Type Description Обязательный По умолчанию
содержимое строка или null Нет
вызов_функции OpenAI.ChatCompletionStreamResponseDeltaFunctionCall (устарело) Нет
└─ аргументы строка Нет
└️ имя строка Нет
reasoning_content строка Свойство расширения, специфичное для Azure, содержащее сгенерированное содержание логических выводов из поддерживаемых моделей. Нет
отказ строка или null Нет
role enum Роль автора этого сообщения.
Возможные значения: developer, system, user, assistant, tool		 Нет
вызовы инструментов массив OpenAI.ChatCompletionMessageToolCallChunk Нет

OpenAI.ChatCompletionStreamResponseDeltaFunctionCall

Name Type Description Обязательный По умолчанию
arguments строка Нет
имя строка Нет

OpenAI.ChatCompletionTokenLogprob

Name Type Description Обязательный По умолчанию
байт массив целочисленных или null Да
logprob number Логарифмическая вероятность этого токена, если он находится среди 20 самых вероятных токенов. В противном случае значение -9999.0 используется для обозначения того, что вероятность токена очень мала. Да
token строка Токен. Да
top_logprobs массив OpenAI.ChatCompletionTokenLogprobTopLogprobTopLogprobs Список наиболее вероятных токенов и их логарифмической вероятности в этой позиции токена. В редких случаях количество возвращаемых top_logprobs может быть меньше запрошенного. Да

OpenAI.ChatCompletionTokenLogprobTopLogprobs

Name Type Description Обязательный По умолчанию
байт массив целочисленных или null Да
logprob number Да
token строка Да

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

Функциональный инструмент

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

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

OpenAI.ChatCompletionToolChoiceOption

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

Тип: string или OpenAI.ChatCompletionAllowedToolsChoice или OpenAI.ChatCompletionNamedToolChoice или OpenAI.ChatCompletionNamedToolChoiceCustom

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

OpenAI.CompletionUsage

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

Name Type Description Обязательный По умолчанию
токены завершения целое число Количество токенов в созданном завершении. Да
детали_токенов_завершения OpenAI.CompletionUsageCompletionTokensDetails Нет
└️ accepted_prediction_tokens целое число Нет
└audio_tokens целое число Нет
└️ reasoning_tokens целое число Нет
└─ отклонённые_токены_предсказания целое число Нет
подсказывающие токены целое число Количество токенов в запросе. Да
prompt_tokens_details OpenAI.CompletionUsagePromptTokensDetails Нет
└audio_tokens целое число Нет
└ cached_tokens целое число Нет
общее количество токенов целое число Общее количество токенов, используемых в запросе (подсказка + завершение). Да

OpenAI.CompletionUsageCompletionTokensDetails

Name Type Description Обязательный По умолчанию
accepted_prediction_tokens целое число Нет
аудио_токены целое число Нет
токены рассуждений целое число Нет
rejected_prediction_tokens целое число Нет

OpenAI.CompletionUsagePromptTokensDetails

Name Type Description Обязательный По умолчанию
аудио_токены целое число Нет
cached_tokens целое число Нет

OpenAI.CreateChatCompletionRequestAudio

Name Type Description Обязательный По умолчанию
format enum
Возможные значения: wav, aac, mp3, flac, opus, pcm16		 Да
голос OpenAI.VoiceIdsShared Да

OpenAI.CreateChatCompletionRequestResponseFormat

Объект, указывающий формат, который должен выводить модель. Параметр для { "type": "json_schema", "json_schema": {...} } включения структурированных выходных данных, которые гарантируют, что модель будет соответствовать предоставленной схеме JSON. Дополнительные сведения см. в руководстве по структурированным выходным данным. Настройка для { "type": "json_object" } включает старый режим JSON, который гарантирует, что создаваемое моделью сообщение является допустимым JSON. Использование json_schema предпочтительнее для моделей, поддерживающих его.

Дискриминация для OpenAI.CreateChatCompletionRequestResponseFormat

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

Значение типа Schema
json_schema OpenAI.ResponseFormatJsonSchema
text OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatText
json_object OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject
Name Type Description Обязательный По умолчанию
type OpenAI.CreateChatCompletionRequestResponseFormatType Да

OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject

Объект JSON

Формат отклика объекта JSON. Старый метод создания ответов JSON. Рекомендуется использовать json_schema для моделей, поддерживающих его. Обратите внимание, что модель не будет создавать JSON без системного или пользовательского сообщения, которое дает ей соответствующую команду.

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

OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatText

Текст

Формат ответа по умолчанию. Используется для создания текстовых ответов.

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

OpenAI.CreateChatCompletionRequestResponseFormatType

Property Ценность
Type строка
Значения text
json_schema
json_object

OpenAI.CreateChatCompletionResponseChoices

Name Type Description Обязательный По умолчанию
результаты фильтрации контента AzureContentFilterResultForChoice Результат фильтра содержимого для одного элемента ответа, созданного системой создания искусственного интеллекта. Нет
причина окончания enum
Возможные значения: stop, length, tool_calls, content_filter, function_call		 Да
index целое число Да
logprobs OpenAI.CreateChatCompletionResponseChoicesLogprobs или null Да
message OpenAI.ChatCompletionResponseMessage Если запрашивается модальность вывода звука, этот объект содержит данные
о звуковом ответе модели.		 Да

OpenAI.CreateChatCompletionResponseChoicesLogprobs

Name Type Description Обязательный По умолчанию
содержимое массив OpenAI.ChatCompletionTokenLogprob или null Да
отказ массив OpenAI.ChatCompletionTokenLogprob или null Да

OpenAI.CreateChatCompletionStreamResponseChoices

Name Type Description Обязательный По умолчанию
delta OpenAI.ChatCompletionStreamResponseDelta Изменение завершения чата, созданное потоковыми ответами модели. Да
причина окончания строка или null Да
index целое число Да
logprobs OpenAI.CreateChatCompletionStreamResponseChoicesLogprobs или null Нет

OpenAI.CreateChatCompletionStreamResponseChoicesLogprobs

Name Type Description Обязательный По умолчанию
содержимое массив OpenAI.ChatCompletionTokenLogprob или null Да
отказ массив OpenAI.ChatCompletionTokenLogprob или null Да

OpenAI.CustomToolChatCompletions

Пользовательский инструмент

Пользовательское средство, обрабатывающее входные данные с помощью указанного формата.

Name Type Description Обязательный По умолчанию
Пользовательские OpenAI.CustomToolChatCompletionsCustom Да
└─ Описание строка Нет
└─ Формат OpenAI.CustomToolChatCompletionsCustomFormatText или OpenAI.CustomToolChatCompletionsCustomFormatGrammar Нет
└️ имя строка Да
type enum Тип пользовательского средства. Всегда custom.
Возможные значения: custom		 Да

OpenAI.CustomToolChatCompletionsCustom

Name Type Description Обязательный По умолчанию
описание строка Нет
format OpenAI.CustomToolChatCompletionsCustomFormatText или OpenAI.CustomToolChatCompletionsCustomFormatGrammar Нет
имя строка Да

OpenAI.CustomToolChatCompletionsCustomFormatGrammar

Name Type Description Обязательный По умолчанию
Грамматики OpenAI.CustomToolChatCompletionsCustomFormatGrammarGrammar Да
Определение └️ строка Да
Синтаксис └️ enum
Возможные значения: lark, regex		 Да
type enum
Возможные значения: grammar		 Да

OpenAI.CustomToolChatCompletionsCustomFormatGrammarGrammar

Name Type Description Обязательный По умолчанию
Определение строка Да
Синтаксис enum
Возможные значения: lark, regex		 Да

OpenAI.CustomToolChatCompletionsCustomFormatText

Name Type Description Обязательный По умолчанию
type enum
Возможные значения: text		 Да

OpenAI.FunctionObject

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

OpenAI.FunctionParameters

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

Тип: объект

OpenAI.Metadata

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

Тип: объект

OpenAI.ParallelToolCalls

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

Тип: логический

OpenAI.PredictionContent

Статическое содержимое

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

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

OpenAI.ReasoningEffort

Ограничивает усилия, направленные на модели рассуждений. В настоящее время поддерживаются noneзначения , , minimal, lowmedium, highи xhigh. Сокращение усилий на рассуждение может привести к более быстрым ответам и меньшему количеству токенов, используемых при рассуждениях в ответе.

  • gpt-5.1 по умолчанию используется noneзначение , которое не выполняет причину. Поддерживаемые значения gpt-5.1 аргументов: none, lowmediumи high. Вызовы инструментов поддерживаются для всех значений причин в gpt-5.1.
  • Все модели до выполнения gpt-5.1 действий по умолчанию и medium не поддерживаются none.
  • Модель gpt-5-pro по умолчанию используется (и поддерживает только) high усилия по соображениям.
  • xhigh поддерживается для всех моделей после gpt-5.1-codex-max.
Property Ценность
Description Ограничивает усилия, направленные на модели рассуждений. В настоящее время поддерживаются noneзначения , , minimal, lowmedium, highи xhigh. Сокращение усилий на рассуждение может привести к более быстрым ответам и меньшему количеству токенов, используемых при рассуждениях в ответе.
- gpt-5.1 по умолчанию используется noneзначение , которое не выполняет причину. Поддерживаемые значения gpt-5.1 аргументов: none, lowmediumи high. Вызовы инструментов поддерживаются для всех значений причин в gpt-5.1.
— Все модели до выполнения действий по gpt-5.1 умолчанию medium и не поддерживаются none.
— Модель gpt-5-pro по умолчанию используется (и поддерживает только) high усилия по поводу.
- xhigh поддерживается для всех моделей после gpt-5.1-codex-max.
Type строка
Значения none
minimal
low
medium
high
xhigh

OpenAI.ResponseFormatJsonSchema

Схема JSON

Формат ответа схемы JSON. Используется для создания структурированных ответов JSON. Дополнительные сведения о структурированных выходных данных.

Name Type Description Обязательный По умолчанию
JSON-схема OpenAI.ResponseFormatJsonSchemaJsonSchemaSchema Да
└─ Описание строка Нет
└️ имя строка Да
└─ Схема OpenAI.ResponseFormatJsonSchema Схема формата ответа, описанная как объект схемы JSON.
Узнайте, как создать схемы JSON здесь.		 Нет
└─ строгий логический или null Нет
type enum Тип определяемого формата ответа. Всегда json_schema.
Возможные значения: json_schema		 Да

OpenAI.ResponseFormatJsonSchemaJsonSchemaSchema

Name Type Description Обязательный По умолчанию
описание строка Нет
имя строка Да
schema OpenAI.ResponseFormatJsonSchema Схема формата ответа, описанная как объект схемы JSON.
Узнайте, как создать схемы JSON здесь.		 Нет
строгий логический или null Нет

OpenAI.ResponseFormatJsonSchema

Схема JSON

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

Тип: объект

OpenAI.ResponseModalities

Типы выходных данных, которые вы хотите, чтобы модель генерировала. Большинство моделей могут создавать текст, который по умолчанию: ["text"] Модель gpt-4o-audio-preview также может использоваться для создания звука. Чтобы запросить, что эта модель создает как текстовые, так и звуковые ответы, можно использовать: ["text", "audio"]

Эта схема принимает один из следующих типов:

  • array
  • null

OpenAI.StopConfiguration

Не поддерживается с последними моделями рассуждений o3 и o4-mini. До 4 последовательностей, в которых API перестанет генерировать дополнительные токены. Возвращаемый текст не будет содержать последовательность остановки.

Эта схема принимает один из следующих типов:

  • array
  • null

OpenAI.Verbosity

Ограничивает детализацию ответа модели. Более низкие значения приводят к более кратким ответам, в то время как более подробные значения приводят к более подробным ответам. В настоящее время поддерживаются lowзначения , mediumи high.

Property Ценность
Description Ограничивает детализацию ответа модели. Более низкие значения приводят к более кратким ответам, в то время как более подробные значения приводят к более подробным ответам. В настоящее время поддерживаются lowзначения , mediumи high.
Type строка
Значения low
medium
high

OpenAI.VoiceIdsShared

Property Ценность
Type строка
Значения alloy
ash
ballad
coral
echo
sage
shimmer
verse
marin
cedar
  • Last updated on