Справочник по REST API Azure OpenAI в моделях Azure AI Foundry

2025-07-02

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

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

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

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

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

Это важно

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

API (Интерфейс программирования приложений)	Последний предварительный выпуск	Последний выпуск общедоступной версии	Спецификации	Описание
Плоскость управления	`2024-06-01-preview`	`2024-10-01`	Файлы спецификаций	Azure OpenAI предоставляет общий уровень управления всем остальным службам. API уровня управления используется для таких задач, как создание ресурсов Azure OpenAI, развертывание модели и другие задачи управления ресурсами более высокого уровня. Плоскость управления также управляет возможностями, такими как Azure Resource Manager, Bicep, Terraform и Azure CLI.
Плоскость данных — разработка	`2025-04-01-preview`	`2024-10-21`	Файлы спецификаций	API разработки плоскости данных управляет точной настройкой, отправкой файлов, заданиями приема, пакетными и определенными запросами уровня модели
Плоскость данных — вывод	`2025-04-01-preview`	`2024-10-21`	Файлы спецификаций	API обработки данных предоставляет возможности вывода и API-эндоинтерфейсы для таких функций, как автозаполнение, завершение чата, встраивания, звуковые данные, анализ ваших данных, Dall-e, ассистенты и т. д.

Аутентификация

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

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

Управление версиями 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

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

Остальная часть статьи охватывает последний выпуск общедоступной версии спецификации 2024-10-21вывода плоскости данных Azure OpenAI.

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

Автозавершения

POST https://{endpoint}/openai/deployments/{deployment-id}/completions?api-version=2024-10-21

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

Параметры URI

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

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

Имя	Обязательно	Тип	Описание
API-ключ	Верно	струна	Укажите здесь ключ API OpenAI для Azure

Тело запроса

Content-Type: application/json

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

Ответы

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

Описание: ОК

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

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

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

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

Примеры

Пример

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

POST https://{endpoint}/openai/deployments/{deployment-id}/completions?api-version=2024-10-21

{
 "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=2024-10-21

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

Параметры URI

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

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

Имя	Обязательно	Тип	Описание
API-ключ	Верно	струна	Укажите здесь ключ API OpenAI для Azure

Тело запроса

Content-Type: application/json

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

Ответы

Имя	Тип	Обязательно
объект	струна	Да
модель	струна	Да
данные	массив	Да
использование	объект	Да

Свойства для использования

подсказывающие токены

Имя	Тип	Описание	По умолчанию
подсказывающие токены	целое число

общее количество токенов

Имя	Тип	Описание	По умолчанию
общее количество токенов	целое число

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

Описание: ОК

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

Примеры

Пример

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

POST https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2024-10-21

{
 "input": [
  "this is a test"
 ]
}

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

{
  "body": {
    "data": [
      {
        "index": 0,
        "embedding": [
          -0.012838088,
          -0.007421397,
          -0.017617522,
          -0.028278312,
          -0.018666342,
          0.01737855,
          -0.01821495,
          -0.006950092,
          -0.009937238,
          -0.038580645,
          0.010674067,
          0.02412286,
          -0.013647936,
          0.013189907,
          0.0021125758,
          0.012406612,
          0.020790534,
          0.00074595667,
          0.008397198,
          -0.00535031,
          0.008968075,
          0.014351576,
          -0.014086051,
          0.015055214,
          -0.022211088,
          -0.025198232,
          0.0065186154,
          -0.036350243,
          0.009180495,
          -0.009698266,
          0.009446018,
          -0.008463579,
          -0.0040426035,
          -0.03443847,
          -0.00091273896,
          -0.0019217303,
          0.002349888,
          -0.021560553,
          0.016515596,
          -0.015572986,
          0.0038666942,
          -8.432463e-05
        ]
      }
    ],
    "usage": {
      "prompt_tokens": 4,
      "total_tokens": 4
    }
  }
}

Завершение чата

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-21

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

Параметры URI

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

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

Имя	Обязательно	Тип	Описание
API-ключ	Верно	струна	Укажите здесь ключ API OpenAI для Azure

Тело запроса

Content-Type: application/json

Имя	Тип	Описание	Обязательно	По умолчанию
Температура	число/номер	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным. Как правило, мы рекомендуем изменить это или `top_p` не оба.	нет	1
top_p	число/номер	Альтернативой выборке с температурой является так называемая выборка ядра, где модель рассматривает результаты маркеров с top_p всего массива значений вероятности. Таким образом, 0,1 означает, что учитываются только маркеры, входящие в верхние 10% массива значений вероятности. Как правило, мы рекомендуем изменить это или `temperature` не оба.	нет	1
поток	булевый	Если задано, будут отправляться частичные разностные сообщения, например в ChatGPT. Маркеры будут отправляться как события, отправленные сервером только для данных, как они становятся доступными, при этом поток завершается сообщением`data: [DONE]`.	нет	Неправда
остановка	строка или массив	До четырех последовательностей, в которых API перестанет создавать дополнительные маркеры.	нет
макс_токены	целое число	Максимальное количество маркеров, которые можно создать в завершении чата. Общая длина входных маркеров и созданных маркеров ограничена длиной контекста модели.	нет
max_completion_tokens (максимальное количество токенов завершения)	целое число	Верхняя граница для числа маркеров, которые можно создать для завершения, включая видимые выходные маркеры и маркеры причин.	нет
штраф за присутствие	число/номер	Число от -2.0 до 2.0. Положительные значения наказывают новые маркеры в зависимости от того, появляются ли они в тексте до сих пор, что повышает вероятность того, что модель будет говорить о новых темах.	нет	0
штраф за частоту	число/номер	Число от -2.0 до 2.0. Положительные значения наказывают новые маркеры на основе их существующей частоты в тексте до сих пор, уменьшая вероятность повторения модели той же строки дословно.	нет	0
логит_биас	объект	Изменяет вероятность появления указанных маркеров в завершении. Принимает объект JSON, который сопоставляет маркеры (указанные идентификатором маркера в токенизаторе) со связанным значением предвзятости от -100 до 100. С математической точки зрения смещение добавляется к логитам, созданным моделью до выборки. Точный эффект зависит от модели, но значения от –1 до 1 должны уменьшать или увеличивать вероятность выбора; такие значения, как –100 или 100, должны приводить к запрету или эксклюзивному выбору соответствующего маркера.	нет	Отсутствует
Пользователь	струна	Уникальный идентификатор, представляющий конечного пользователя, который может помочь в мониторинге и обнаружении злоупотреблений.	нет
сообщения	массив	Список сообщений, составляющих беседу до сих пор.	Да
источники данных	массив	Записи конфигурации для расширений чата Azure OpenAI, которые используют их. Эта дополнительная спецификация совместима только с Azure OpenAI.	нет
logprobs	булевый	Следует ли возвращать вероятности журналов выходных маркеров или нет. Если значение true, возвращает вероятности журнала каждого выходного маркера, возвращаемого в параметре `contentmessage`.	нет	Неправда
top_logprobs	целое число	Целое число от 0 до 20, указывающее число наиболее вероятных маркеров, возвращаемых по каждой позиции маркера, каждый из которых имеет связанную вероятность журнала. `logprobs` Необходимо задать значение `true` , если этот параметр используется.	нет
н	целое число	Сколько вариантов завершения чата для каждого входного сообщения. Обратите внимание, что плата будет взиматься на основе количества созданных маркеров во всех вариантах. Имейте в виду `n` , чтобы `1` свести к минимуму затраты.	нет	1
вызовы инструмента в параллельном режиме	ParallelToolCalls	Следует ли включить параллельные вызовы функций во время использования средства.	нет	Верно
формат_ответа	ResponseFormatText или ResponseFormatJsonObject или ResponseFormatJsonSchema	Объект, указывающий формат, который должен выводить модель. Совместим с GPT-4o, GPT-4o mini, GPT-4 Turbo и всеми моделями GPT-3.5 Turbo, чем `gpt-3.5-turbo-1106`более новые. Параметр для `{ "type": "json_schema", "json_schema": {...} }` включения структурированных выходных данных, гарантирующих, что модель будет соответствовать предоставленной схеме JSON. Параметр включения `{ "type": "json_object" }` режима JSON, который гарантирует, что модель создает сообщение является допустимым JSON. Важно: при использовании режима JSON необходимо также указать модели создавать JSON самостоятельно с помощью системного или пользовательского сообщения. Без этого модель может создать неуправляемый поток пробелов до тех пор, пока поколение не достигнет предела маркера, в результате чего длительный и, казалось бы, "застрявший" запрос. Кроме того, обратите внимание, что содержимое сообщения может быть частично отрезано, если `finish_reason="length"`, что указывает на превышение поколения `max_tokens` или беседа превысила максимальную длину контекста.	нет
семя	целое число	Эта функция доступна в бета-версии. Если задано, наша система будет предпринять лучшие усилия для выборки детерминированного, таким образом, что повторяющиеся запросы с одинаковыми и теми же параметрами должны возвращать тот же `seed` результат. Детерминированность не гарантируется, и вы должны обратиться к параметру ответа `system_fingerprint` для мониторинга изменений на сервере.	нет
инструменты	массив	Список инструментов, которые может вызывать модель. В настоящее время в качестве инструмента поддерживаются только функции. Используйте это для предоставления списка функций, для которые модель может создавать входные данные JSON. Поддерживаются не более 128 функций.	нет
выбор инструмента	chatCompletionToolChoiceOption	Определяет, какое средство (если таковое) вызывается моделью. `none` означает, что модель не вызывает никаких инструментов и вместо этого создает сообщение. `auto` означает, что модель может выбирать между созданием сообщения или вызовом одного или нескольких инструментов. `required` означает, что модель должна вызывать один или несколько инструментов. Указание определенного средства с помощью `{"type": "function", "function": {"name": "my_function"}}` принудительного вызова этого средства моделью. `none` значение по умолчанию, если средства отсутствуют. `auto` значение по умолчанию, если существуют средства.	нет
вызов_функции	string или chatCompletionFunctionCallOption	Не рекомендуется использовать в пользу `tool_choice`. Определяет, какая функция (если есть) вызывается моделью. `none` означает, что модель не вызывает функцию и вместо этого создает сообщение. `auto` означает, что модель может выбирать между созданием сообщения или вызовом функции. Указание определенной функции путем `{"name": "my_function"}` принудительного вызова этой функции моделью. `none` значение по умолчанию, если функции отсутствуют. `auto` значение по умолчанию, если функции присутствуют.	нет
функции	массив	Не рекомендуется использовать в пользу `tools`. Список функций, для которые модель может создавать входные данные JSON.	нет

Ответы

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

Описание: ОК

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

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

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

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

Примеры

Пример

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

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-21

{
 "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=2024-10-21

{
 "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=2024-10-21

{
 "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=2024-10-21

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

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

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2024-10-21

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
конечная точка	путь	Да	струна URL-адрес	Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: `https://aoairesource.openai.azure.com` Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
идентификатор развертывания	путь	Да	струна	Идентификатор развертывания модели преобразования речи в текст. Сведения о поддерживаемых моделях см. в статье [/azure/ai-services/openai/concepts/models#audio-models].
версия API	запрос	Да	струна	Версия API

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

Имя	Обязательно	Тип	Описание
API-ключ	Верно	струна	Укажите здесь ключ API OpenAI для Azure

Тело запроса

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

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

Ответы

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

Описание: ОК

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

Примеры

Пример

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

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2024-10-21

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

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

Пример

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

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2024-10-21

"---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=2024-10-21

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
конечная точка	путь	Да	струна URL-адрес	Поддерживаемые конечные точки Azure OpenAI (протокол и имя узла, например: `https://aoairesource.openai.azure.com` Замените aoairesource именем ресурса Azure OpenAI. https://{your-resource-name}.openai.azure.com
идентификатор развертывания	путь	Да	струна	Идентификатор развертывания модели whisper, которая была развернута. Сведения о поддерживаемых моделях см. в статье [/azure/ai-services/openai/concepts/models#audio-models].
версия API	запрос	Да	струна	Версия API

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

Имя	Обязательно	Тип	Описание
API-ключ	Верно	струна	Укажите здесь ключ API OpenAI для Azure

Тело запроса

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

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

Ответы

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

Описание: ОК

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

Примеры

Пример

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

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2024-10-21

"---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=2024-10-21

"---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}/images/generations?api-version=2024-10-21

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

Параметры URI

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

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

Имя	Обязательно	Тип	Описание
API-ключ	Верно	струна	Укажите здесь ключ API OpenAI для Azure

Тело запроса

Content-Type: application/json

Имя	Тип	Описание	Обязательно	По умолчанию
подсказка	струна	Текстовое описание требуемых изображений. Максимальная длина — 4000 символов.	Да
н	целое число	Количество генерируемых изображений.	нет	1
размер	imageSize	Размер созданных изображений.	нет	1024x1024
формат_ответа	imagesResponseFormat	Формат, в котором возвращаются созданные изображения.	нет	URL-адрес
Пользователь	струна	Уникальный идентификатор, представляющий конечного пользователя, который может помочь в мониторинге и обнаружении злоупотреблений.	нет
качество	imageQuality	Качество создаваемого изображения.	нет	стандарт
стиль	imageStyle	Стиль созданных изображений.	нет	яркий

Ответы

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

Описание: ОК

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

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

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

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

Примеры

Пример

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

POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2024-10-21

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

Компоненты

ответ ошибки

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

errorBase

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

ошибка

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

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

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

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

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

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

Описание: коды ошибок для внутреннего объекта ошибки.

Тип: string.

По умолчанию:

Имя перечисления: InnerErrorCode

Значения перечисления:

Ценность	Описание
Нарушение политики ответственного ИИ	Запрос нарушил одно из нескольких правил фильтрации содержимого.

dalleErrorResponse

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

dalleError

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

dalleInnerError

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

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

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

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

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

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

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

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

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

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

Свойства для ссылки

URL-адрес

Имя	Тип	Описание	По умолчанию
URL-адрес	струна

лицензия

Имя	Тип	Описание	По умолчанию
лицензия	струна

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

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

Имя	Тип	Обязательно
половой	результат тяжести фильтрации контента	нет
насилие	результат тяжести фильтрации контента	нет
ненавидеть	результат тяжести фильтрации контента	нет
самоповреждение	результат тяжести фильтрации контента	нет
богохульство	Результат обнаружения фильтра контента	нет
ошибка	errorBase	нет

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

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

Имя	Тип	Обязательно
половой	результат тяжести фильтрации контента	нет
насилие	результат тяжести фильтрации контента	нет
ненавидеть	результат тяжести фильтрации контента	нет
самоповреждение	результат тяжести фильтрации контента	нет
богохульство	Результат обнаружения фильтра контента	нет
ошибка	errorBase	нет
Джейлбрейк	Результат обнаружения фильтра контента	нет

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

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

Имя	Тип	Обязательно
половой	результат тяжести фильтрации контента	нет
насилие	результат тяжести фильтрации контента	нет
ненавидеть	результат тяжести фильтрации контента	нет
самоповреждение	результат тяжести фильтрации контента	нет
богохульство	Результат обнаружения фильтра контента	нет
ошибка	errorBase	нет
защищённый_текст_материала	Результат обнаружения фильтра контента	нет
код_защищённого_материала	Обнаружен фильтр контента с результатом цитирования	нет

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

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

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

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

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

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

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

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

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

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

Имя	Тип	Обязательно
половой	результат тяжести фильтрации контента	нет
насилие	результат тяжести фильтрации контента	нет
ненавидеть	результат тяжести фильтрации контента	нет
самоповреждение	результат тяжести фильтрации контента	нет
богохульство	Результат обнаружения фильтра контента	нет
Джейлбрейк	Результат обнаружения фильтра контента	нет

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

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

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

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

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

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

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

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

Имя	Тип	Описание	Обязательно	По умолчанию
Температура	число/номер	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным. Как правило, мы рекомендуем изменить это или `top_p` не оба.	нет	1
top_p	число/номер	Альтернативой выборке с температурой является так называемая выборка ядра, где модель рассматривает результаты маркеров с top_p всего массива значений вероятности. Таким образом, 0,1 означает, что учитываются только маркеры, входящие в верхние 10% массива значений вероятности. Как правило, мы рекомендуем изменить это или `temperature` не оба.	нет	1
поток	булевый	Если задано, будут отправляться частичные разностные сообщения, например в ChatGPT. Маркеры будут отправляться как события, отправленные сервером только для данных, как они становятся доступными, при этом поток завершается сообщением`data: [DONE]`.	нет	Неправда
остановка	строка или массив	До четырех последовательностей, в которых API перестанет создавать дополнительные маркеры.	нет
макс_токены	целое число	Максимальное количество маркеров, которые можно создать в завершении чата. Общая длина входных маркеров и созданных маркеров ограничена длиной контекста модели.	нет
max_completion_tokens (максимальное количество токенов завершения)	целое число	Верхняя граница для числа маркеров, которые можно создать для завершения, включая видимые выходные маркеры и маркеры причин.	нет
штраф за присутствие	число/номер	Число от -2.0 до 2.0. Положительные значения наказывают новые маркеры в зависимости от того, появляются ли они в тексте до сих пор, что повышает вероятность того, что модель будет говорить о новых темах.	нет	0
штраф за частоту	число/номер	Число от -2.0 до 2.0. Положительные значения наказывают новые маркеры на основе их существующей частоты в тексте до сих пор, уменьшая вероятность повторения модели той же строки дословно.	нет	0
логит_биас	объект	Изменяет вероятность появления указанных маркеров в завершении. Принимает объект JSON, который сопоставляет маркеры (указанные идентификатором маркера в токенизаторе) со связанным значением предвзятости от -100 до 100. С математической точки зрения смещение добавляется к логитам, созданным моделью до выборки. Точный эффект зависит от модели, но значения от –1 до 1 должны уменьшать или увеличивать вероятность выбора; такие значения, как –100 или 100, должны приводить к запрету или эксклюзивному выбору соответствующего маркера.	нет	Отсутствует
Пользователь	струна	Уникальный идентификатор, представляющий конечного пользователя, который может помочь в мониторинге и обнаружении злоупотреблений.	нет
сообщения	массив	Список сообщений, составляющих беседу до сих пор.	Да
источники данных	массив	Записи конфигурации для расширений чата Azure OpenAI, которые используют их. Эта дополнительная спецификация совместима только с Azure OpenAI.	нет
logprobs	булевый	Следует ли возвращать вероятности журналов выходных маркеров или нет. Если значение true, возвращает вероятности журнала каждого выходного маркера, возвращаемого в параметре `contentmessage`.	нет	Неправда
top_logprobs	целое число	Целое число от 0 до 20, указывающее число наиболее вероятных маркеров, возвращаемых по каждой позиции маркера, каждый из которых имеет связанную вероятность журнала. `logprobs` Необходимо задать значение `true` , если этот параметр используется.	нет
н	целое число	Сколько вариантов завершения чата для каждого входного сообщения. Обратите внимание, что плата будет взиматься на основе количества созданных маркеров во всех вариантах. Имейте в виду `n` , чтобы `1` свести к минимуму затраты.	нет	1
вызовы инструмента в параллельном режиме	ParallelToolCalls	Следует ли включить параллельные вызовы функций во время использования средства.	нет	Верно
формат_ответа	ResponseFormatText или ResponseFormatJsonObject или ResponseFormatJsonSchema	Объект, указывающий формат, который должен выводить модель. Совместим с GPT-4o, GPT-4o mini, GPT-4 Turbo и всеми моделями GPT-3.5 Turbo, чем `gpt-3.5-turbo-1106`более новые. Параметр для `{ "type": "json_schema", "json_schema": {...} }` включения структурированных выходных данных, гарантирующих, что модель будет соответствовать предоставленной схеме JSON. Параметр включения `{ "type": "json_object" }` режима JSON, который гарантирует, что модель создает сообщение является допустимым JSON. Важно: при использовании режима JSON необходимо также указать модели создавать JSON самостоятельно с помощью системного или пользовательского сообщения. Без этого модель может создать неуправляемый поток пробелов до тех пор, пока поколение не достигнет предела маркера, в результате чего длительный и, казалось бы, "застрявший" запрос. Кроме того, обратите внимание, что содержимое сообщения может быть частично отрезано, если `finish_reason="length"`, что указывает на превышение поколения `max_tokens` или беседа превысила максимальную длину контекста.	нет
семя	целое число	Эта функция доступна в бета-версии. Если задано, наша система будет предпринять лучшие усилия для выборки детерминированного, таким образом, что повторяющиеся запросы с одинаковыми и теми же параметрами должны возвращать тот же `seed` результат. Детерминированность не гарантируется, и вы должны обратиться к параметру ответа `system_fingerprint` для мониторинга изменений на сервере.	нет
инструменты	массив	Список инструментов, которые может вызывать модель. В настоящее время в качестве инструмента поддерживаются только функции. Используйте это для предоставления списка функций, для которые модель может создавать входные данные JSON. Поддерживаются не более 128 функций.	нет
выбор инструмента	chatCompletionToolChoiceOption	Определяет, какое средство (если таковое) вызывается моделью. `none` означает, что модель не вызывает никаких инструментов и вместо этого создает сообщение. `auto` означает, что модель может выбирать между созданием сообщения или вызовом одного или нескольких инструментов. `required` означает, что модель должна вызывать один или несколько инструментов. Указание определенного средства с помощью `{"type": "function", "function": {"name": "my_function"}}` принудительного вызова этого средства моделью. `none` значение по умолчанию, если средства отсутствуют. `auto` значение по умолчанию, если существуют средства.	нет
вызов_функции	string или chatCompletionFunctionCallOption	Не рекомендуется использовать в пользу `tool_choice`. Определяет, какая функция (если есть) вызывается моделью. `none` означает, что модель не вызывает функцию и вместо этого создает сообщение. `auto` означает, что модель может выбирать между созданием сообщения или вызовом функции. Указание определенной функции путем `{"name": "my_function"}` принудительного вызова этой функции моделью. `none` значение по умолчанию, если функции отсутствуют. `auto` значение по умолчанию, если функции присутствуют.	нет
функции	массив	Не рекомендуется использовать в пользу `tools`. Список функций, для которые модель может создавать входные данные JSON.	нет

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

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

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

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

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

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

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

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

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

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

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

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

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

Свойства для function_call

аргументы

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

имя

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Свойства для image_url

URL-адрес

Имя	Тип	Описание	По умолчанию
URL-адрес	струна	URL-адрес изображения или данных в кодировке Base64.

подробность

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

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

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

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

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

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

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

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

Тип: string.

По умолчанию:

Имя перечисления: AzureChatExtensionType

Значения перечисления:

Ценность	Описание
поиск Azure	Представляет использование службы "Поиск Azure" в качестве расширения чата Azure OpenAI.
База данных Azure Cosmos	Представляет использование Azure Cosmos DB в качестве расширения чата Azure OpenAI.

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

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

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

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

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

Имя	Тип	Описание	Обязательно
аутентификация	onYourDataApiKeyAuthenticationOptions или onYourDataSystemAssignedManagedIdentityAuthenticationOptions или onYourDataUserAssignedManagedIdentityAuthenticationOptions		Да
топ_n_документы	целое число	Настроено первое число документов для функции настроенного запроса.	нет
в пределах области	булевый	Следует ли ограничить запросы использованием индексированных данных.	нет
строгость	целое число	Настроенная строгость фильтрации релевантности поиска. Чем выше строгость, тем выше точность, но более низкий отзыв ответа.	нет
информация_о_роли	струна	Дайте модели инструкции о том, как он должен вести себя и какой-либо контекст, на который он должен ссылаться при создании ответа. Вы можете описать личность помощника и рассказать о том, как отформатировать ответы. Существует ограничение на 100 маркеров, и он учитывается в отношении общего ограничения маркера.	нет
конечная точка	струна	Абсолютный путь конечной точки для используемого ресурса поиска Azure.	Да
имя_индекса	струна	Имя индекса, используемого как доступное в ресурсе поиска Azure.	Да
соответствие полей	Опции настройки полей индекса в AzureSearch	Необязательные параметры для управления обработкой полей при использовании настроенного ресурса поиска Azure.	нет
тип_запроса	azureSearchQueryType	Тип запроса поиска Azure, который должен выполняться при использовании в качестве расширения чата Azure OpenAI.	нет
семантическая конфигурация	струна	Дополнительная семантическая конфигурация для запроса.	нет
фильтр	струна	Фильтр поиска.	нет
встраивание_зависимости	onYourDataEndpointVectorizationSource или onYourDataDeploymentNameVectorizationSource		нет

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

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

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

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

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

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

Тип: string.

По умолчанию:

Имя перечисления: AzureSearchQueryType

Значения перечисления:

Ценность	Описание
простой	Представляет средство синтаксического анализа простых запросов по умолчанию.
семантических	Представляет средство синтаксического анализа семантического запроса для расширенного семантического моделирования.
вектор	Представляет векторный поиск по вычисляемых данных.
вектор_простой_гибрид	Представляет сочетание простой стратегии запроса с векторными данными.
векторно-семантический гибрид	Представляет сочетание семантического поиска и запросов к векторным данным.

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

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

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

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

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

Имя	Тип	Описание	Обязательно
аутентификация	onYourDataConnectionStringПараметрыАутентификации	Параметры проверки подлинности Azure OpenAI On Your Data при использовании строка подключения.	Да
топ_n_документы	целое число	Настроено первое число документов для функции настроенного запроса.	нет
в пределах области	булевый	Следует ли ограничить запросы использованием индексированных данных.	нет
строгость	целое число	Настроенная строгость фильтрации релевантности поиска. Чем выше строгость, тем выше точность, но более низкий отзыв ответа.	нет
информация_о_роли	струна	Дайте модели инструкции о том, как он должен вести себя и какой-либо контекст, на который он должен ссылаться при создании ответа. Вы можете описать личность помощника и рассказать о том, как отформатировать ответы. Существует ограничение на 100 маркеров, и он учитывается в отношении общего ограничения маркера.	нет
название_базы_данных	струна	Имя базы данных виртуальных ядер MongoDB для использования с Azure Cosmos DB.	Да
имя_контейнера	струна	Имя контейнера ресурсов Azure Cosmos DB.	Да
имя_индекса	струна	Имя индекса виртуального ядра MongoDB для использования с Azure Cosmos DB.	Да
соответствие полей	azureCosmosDBFieldMappingOptions	Необязательные параметры для управления обработкой полей при использовании настроенного ресурса Azure Cosmos DB.	Да
встраивание_зависимости	onYourDataEndpointVectorizationSource или onYourDataDeploymentNameVectorizationSource		Да

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

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

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

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

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

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

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

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

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

Тип: string.

По умолчанию:

Имя перечисления: OnYourDataAuthenticationType

Значения перечисления:

Ценность	Описание
ключ API	Проверка подлинности с помощью ключа API.
строка подключения	Проверка подлинности с помощью строка подключения.
системно назначенная управляемая идентичность	Проверка подлинности с помощью управляемого удостоверения, назначаемого системой.
пользовательски_назначенная_управляемая_идентичность	Проверка подлинности с помощью управляемого удостоверения, назначаемого пользователем.

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

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

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

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

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

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

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

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

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

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

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

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

onYourDataVectorizationSource

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

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

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

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

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

Тип: string.

По умолчанию:

Имя перечисления: OnYourDataVectorizationSourceType

Значения перечисления:

Ценность

Описание

конечная точка

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

имя_развертывания

Представляет имя развертывания модели Ada для использования. Это развертывание модели должно находиться в одном ресурсе Azure OpenAI, но
В данных будет использоваться это развертывание модели с помощью внутреннего вызова, а не общедоступного, что позволяет вектору
поиск даже в частных сетях.

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

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

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

наВашемDataEndpointVectorizationSource

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

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

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

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

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

цитата

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

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

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

Имя	Тип	Описание	Обязательно
идентификатор	струна	Идентификатор вызова средства.	Да
тип	тип вызова инструмента	Тип вызова средства в данном случае `function`.	Да
функция	объект	Функция, вызываемая моделью.	Да

Свойства функции

имя

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

аргументы

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

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

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

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

Тип: string.

По умолчанию:

Имя перечисления: ToolCallType

Значения перечисления:

Ценность	Описание
функция	Тип вызова средства — функция.

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

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

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

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

createChatCompletionResponse

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

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

createChatCompletionStreamResponse

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

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

chatCompletionStreamResponseDelta

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

Имя	Тип	Описание	Обязательно
содержимое	струна	Содержимое сообщения блока.	нет
вызов_функции	объект	Устаревшие и замененные `tool_calls`. Имя и аргументы вызываемой функции, созданной моделью.	нет
вызовы инструментов	массив		нет
роль	перечисление	Роль автора этого сообщения. Возможные значения: система, пользователь, помощник, инструмент	нет
отказ	струна	Сообщение об отказе, созданное моделью.	нет

Свойства для function_call

аргументы

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

имя

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

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

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

Свойства функции

имя

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

аргументы

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

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

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

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

Параметр chatCompletionChoiceLogProbs

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

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

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

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

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

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

Имя	Тип	Описание	Обязательно
роль	chatCompletionResponseMessageRole	Роль автора сообщения ответа.	Да
отказ	струна	Сообщение об отказе, созданное моделью.	Да
содержимое	струна	Содержимое сообщения.	Да
вызовы инструментов	массив	Вызовы средства, созданные моделью, например вызовы функций.	нет
вызов_функции	вызов функции завершения чата	Устаревшие и замененные `tool_calls`. Имя и аргументы вызываемой функции, созданной моделью.	нет
контекст	azureChatExtensionsMessageContext	Представление дополнительных сведений о контексте, доступных при использовании расширений чата Azure OpenAI в создании соответствующего ответа на завершение чата. Эти сведения о контексте заполняются только в том случае, если с помощью запроса Azure OpenAI, настроенного для использования соответствующего расширения.	нет

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

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

Описание: роль автора сообщения ответа.

Тип: string.

По умолчанию:

Значения перечисления:

помощник

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

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

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

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

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

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

Свойства функции

имя

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

ParallelToolCalls

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

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

чатCompletionMessageToolCalls

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

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

chatCompletionFunctionCall

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

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

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

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

Имя	Тип	Описание	Обязательно
подсказывающие токены	целое число	Количество маркеров в запросе.	Да
токены завершения	целое число	Количество маркеров в созданном завершении.	Да
общее количество токенов	целое число	Общее количество маркеров, используемых в запросе (запрос + завершение).	Да
детали_токенов_завершения	объект	Разбивка маркеров, используемых в завершении.	нет

Свойства для completion_tokens_details

токены рассуждений

Имя	Тип	Описание	По умолчанию
токены рассуждений	целое число	Маркеры, созданные моделью для рассуждений.

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

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

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

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

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

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

FunctionObject

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

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

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

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

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

ResponseFormatJsonSchemaSchemaSchema

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

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

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

Имя	Тип	Описание	Обязательно	По умолчанию
тип	перечисление	Тип формата ответа, который определяется: `json_schema` Возможные значения: json_schema	Да
JSON-схема	объект		Да

Свойства для json_schema

описание

Имя	Тип	Описание	По умолчанию
описание	струна	Описание формата ответа, которое используется моделью для определения того, как отвечать в этом формате.

имя

Имя	Тип	Описание	По умолчанию
имя	струна	Имя формата ответа. Должен быть a-z, A-Z, 0-9 или содержать символы подчеркивания и дефисы с максимальной длиной 64.

схема

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

строгий

Имя	Тип	Описание	По умолчанию
строгий	булевый	Следует ли включить строгое соблюдение схемы при создании выходных данных. Если задано значение true, модель всегда будет соответствовать точной схеме, определенной `schema` в поле. Только подмножество схемы JSON поддерживается, если `stricttrue`.	Неправда

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

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

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

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

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

аудиоОтвет

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

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

audioVerboseResponse

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

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

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

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

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

Тип: string.

По умолчанию:

Значения перечисления:

JSON (формат обмена данными JavaScript)
текст
srt
verbose_json
vtt

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

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

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

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

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

Имя	Тип	Описание	Обязательно
идентификатор	целое число	Идентификатор сегмента.	нет
искать	число/номер	Смещение сегмента.	нет
начало	число/номер	Смещение запуска сегмента.	нет
конец	число/номер	Смещение конца сегмента.	нет
текст	струна	Сегментирование текста.	нет
Маркеры	массив	Маркеры текста.	нет
Температура	число/номер	Температура.	нет
avg_logprob	число/номер	Средняя вероятность журнала.	нет
коэффициент сжатия	число/номер	Коэффициент уплотнения.	нет
вероятность_отсутствия_речи	число/номер	`no speech`Вероятность .	нет

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

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

Описание: качество создаваемого изображения.

Тип: string.

По умолчанию: стандартный

Имя перечисления: качество

Значения перечисления:

Ценность	Описание
стандарт	Стандартное качество создает изображения со стандартным качеством.
высокая четкость	Качество HD создает изображения с более подробными сведениями и большей согласованности на изображении.

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

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

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

Тип: string.

По умолчанию: URL-адрес

Имя перечисления: ImagesResponseFormat

Значения перечисления:

Ценность	Описание
URL-адрес	URL-адрес, предоставляющий временный доступ для скачивания созданных образов.
b64_json	Созданные изображения возвращаются в виде строки в кодировке Base64.

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

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

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

Тип: string.

По умолчанию: 1024x1024

Имя перечисления: размер

Значения перечисления:

Ценность	Описание
1792x1024	Требуемый размер созданного изображения составляет 1792x1024 пикселя.
1024x1792	Требуемый размер созданного изображения составляет 1024x1792 пикселя.
1024x1024	Требуемый размер созданного изображения составляет 1024x1024 пикселя.

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

Стиль созданных изображений.

Описание: стиль созданных изображений.

Тип: string.

По умолчанию: яркий

Имя перечисления: стиль

Значения перечисления:

Ценность	Описание
яркий	Яркие создают изображения, которые являются гиперреалистическими и драматическими.
естественный	Естественные создают изображения, которые являются более естественными и менее гиперреалистическими.

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

Имя	Тип	Описание	Обязательно	По умолчанию
подсказка	струна	Текстовое описание требуемых изображений. Максимальная длина — 4000 символов.	Да
н	целое число	Количество генерируемых изображений.	нет	1
размер	imageSize	Размер созданных изображений.	нет	1024x1024
формат_ответа	imagesResponseFormat	Формат, в котором возвращаются созданные изображения.	нет	URL-адрес
Пользователь	струна	Уникальный идентификатор, представляющий конечного пользователя, который может помочь в мониторинге и обнаружении злоупотреблений.	нет
качество	imageQuality	Качество создаваемого изображения.	нет	стандарт
стиль	imageStyle	Стиль созданных изображений.	нет	яркий

generateImagesResponse

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

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

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

Имя	Тип	Описание	Обязательно
URL-адрес	струна	URL-адрес изображения.	нет
b64_json	струна	Изображение в кодировке Base64	нет
результаты фильтрации контента	РезультатыФильтрацииКонтентаDalle	Сведения о результатах фильтрации содержимого.	нет
пересмотренный_запрос	струна	Запрос, который использовался для создания образа, если в запросе была любая редакция.	нет
результаты_фильтрации_запросов	dalleFilterResults	Сведения о категории фильтрации содержимого (ненавидимая, сексуальность, насилие, self_harm), если она обнаружена, а также уровень серьезности (very_low, низкий, средний, высокомасштабируемый, определяющий интенсивность и уровень риска вредного содержимого) и если он был отфильтрован или нет. Сведения о содержимом и ненормативной лексике, если он обнаружен, и если он был отфильтрован или нет. И сведения о списке блокировок клиентов, если он был отфильтрован и его идентификатор.	нет

Расширения завершения

Расширения завершения не являются частью последней общедоступной версии спецификации вывода плоскости данных Azure OpenAI.

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

Объект сообщения чата не является частью последней версии общедоступной версии определения плоскости данных Azure OpenAI.

Текст для речи (предварительная версия)

В настоящее время не является частью последней версии Azure OpenAI GA в спецификации вывода плоскости данных Azure. Ознакомьтесь с последней предварительной версией этой возможности.

Дальнейшие шаги

Узнайте о моделях и тонкой настройке с помощью REST API. Ознакомьтесь с дополнительными сведениями о базовых моделях, лежащих в основе Azure OpenAI.

Поделиться через

Справочник по REST API Azure OpenAI в моделях Azure AI Foundry

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

Аутентификация

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

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

Автозавершения

Параметры URI

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

Тело запроса

Ответы

Примеры

Пример

Встраивания

Параметры URI

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

Тело запроса

Ответы

Свойства для использования

подсказывающие токены

общее количество токенов

Примеры

Пример

Завершение чата

Параметры URI

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

Тело запроса

Ответы

Примеры

Пример

Пример

Пример

Пример

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

Параметры URI

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

Тело запроса

Ответы

Примеры

Пример

Пример

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

Параметры URI

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

Тело запроса

Ответы

Примеры

Пример

Пример

Генерирование изображений

Параметры URI

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

Тело запроса

Ответы

Примеры

Пример

Компоненты

ответ ошибки

errorBase

ошибка

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

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

dalleErrorResponse

dalleError

dalleInnerError

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

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

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

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

Свойства для ссылки

URL-адрес

лицензия

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

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

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

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

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

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

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

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