Справочник по REST API Службы Azure OpenAI

Мақала
07/10/2024

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

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

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

Уровень управления
Плоскость данных — разработка
Плоскость данных — вывод

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

API	Последний предварительный выпуск	Последний выпуск общедоступной версии	Спецификации	Description
Плоскость управления	`2024-04-01-preview`	`2023-05-01`	Файлы спецификаций	Azure OpenAI предоставляет общий уровень управления всеми другими службами ИИ Azure. API уровня управления используется для таких задач, как создание ресурсов Azure OpenAI, развертывание модели и другие задачи управления ресурсами более высокого уровня. Плоскость управления также управляет возможностями, такими как Azure Resource Manager, Bicep, Terraform и Azure CLI.
Плоскость данных — разработка	`2024-05-01-preview`	`2024-06-01`	Файлы спецификаций	API разработки плоскости данных управляет точной настройкой, отправкой файлов, заданиями приема и определенными запросами уровня модели
Плоскость данных — вывод	`2024-05-01-preview`	`2024-06-01`	Файлы спецификаций	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/completions?api-version=2024-06-01

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

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

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

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

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

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

Параметры URI

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

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

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

Текст запроса

Content-Type: application/json

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
prompt	строка или массив	Запросы для создания завершений, закодированные в виде строки или массива строк. Обратите внимание, что <\|endoftext\|> — это разделитель документов, который модель видит во время обучения, поэтому если запрос не определен, модель будет создаваться так, как будто с начала нового документа. Максимальный допустимый размер списка строк — 2048.	No
max_tokens	integer	Количество маркеров запроса плюс max_tokens не может превышать длину контекста модели. Большинство моделей имеют длину контекста 2048 токенов (за исключением новейших моделей, которые поддерживают 4096). Имеет не менее 0.	No	16
Температура	number	Какую температуру выборки следует использовать. Более высокие значения означают, что модель будет брать на себя больше рисков. Попробуйте использовать 0.9 для более творческих приложений и 0 (arg max выборка) для тех, кто имеет четко определенный ответ. Как правило, мы рекомендуем изменить либо это значение, либо top_p, но не оба.	No	1
top_p	number	Альтернативой выборке с температурой является так называемая выборка ядра, где модель рассматривает результаты маркеров с top_p всего массива значений вероятности. Таким образом, 0,1 означает, что учитываются только маркеры, входящие в верхние 10% массива значений вероятности. Как правило, мы рекомендуем изменить либо это значение, либо температуру, но не оба.	No	1
logit_bias	объект	Значение по умолчанию — NULL. Изменяет вероятность появления указанных маркеров в завершении. Принимает объект JSON, который сопоставляет маркеры (указанные идентификатором маркера в создателе маркеров GPT) со связанным значением смещения от –100 до 100. С помощью этого средства создания маркеров (которое работает как для GPT-2, так и для GPT-3) можно преобразовывать текст в идентификаторы маркеров. С математической точки зрения смещение добавляется к логитам, созданным моделью до выборки. Точный эффект зависит от модели, но значения от –1 до 1 должны уменьшать или увеличивать вероятность выбора; такие значения, как –100 или 100, должны приводить к запрету или эксклюзивному выбору соответствующего маркера. Например, можно передать {"50256":-100}, чтобы предотвратить <создание маркера \|endoftext\|> .	No
Пользователь	строка	Уникальный идентификатор, представляющий пользователя, который может помочь в мониторинге и обнаружении злоупотреблений	No
n	integer	Количество завершений, создаваемых для каждого запроса. Не менее 1 и не более 128 разрешено. Примечание. Поскольку данный параметр создает множество завершений, он может быстро исчерпать квоту маркеров. Используйте маркеры продуманно и убедитесь, что у вас заданы разумные значения для параметров max_tokens и stop (остановка).	No	1
потоковая передача	boolean	Потоковая передача частичного хода выполнения. Если потоковая передача задана, маркеры будут отправляться в виде событий, отправляемых сервером только для данных, по мере их доступности, при этом поток завершится данными: сообщение [DONE] (ГОТОВО).	No	False
logprobs	integer	Включает логарифмические вероятности по наиболее вероятным маркерам (logprobs), а также по выбранным маркерам. Например, если значение logprobs равно 5, API вернет список из 5 наиболее вероятных маркеров. API всегда возвращает logprob примера маркера, поэтому в ответе может быть до элементов logprobs+1. Не менее 0 и не более 5 разрешено.	No	нет
suffix	строка	Суффикс, который приходит после завершения вставленного текста.	No
echo	boolean	Возвращает запрос в дополнение к завершению	No	False
stop	строка или массив	До 4 последовательностей, в которых API перестанет создавать дополнительные маркеры. Возвращенный текст не будет содержать последовательность остановки.	No
completion_config	строка		Нет
presence_penalty	number	Значение в диапазоне от –2.0 до 2.0. Положительные значения выбраковывают новые маркеры в зависимости от того, отображаются ли они в тексте на данный момент, увеличивая вероятность обсуждений на новые темы.	No	0
frequency_penalty	number	Значение в диапазоне от –2.0 до 2.0. Положительные значения выбраковывают новые маркеры в зависимости от существующей частоты в тексте на данный момент, уменьшая вероятность повторения той же буквальной строки.	No	0
best_of	integer	Создает best_of завершения на стороне сервера и возвращает "лучший" (определенный как самый высокий уровень вероятности журнала на токен). Потоковую передачу результатов выполнить нельзя. Если используется с n, best_of управляет числом завершения кандидатов и n указывает, сколько возвращаемых - best_of должно быть больше n. Примечание. Поскольку данный параметр создает множество завершений, он может быстро исчерпать квоту маркеров. Используйте маркеры продуманно и убедитесь, что у вас заданы разумные значения для параметров max_tokens и stop (остановка). Имеет максимальное значение 128.	No

Отклики

Имя.	Тип	Описание	Обязательное поле
id	string		Да
объект	строка		Да
создаются	integer		Да
модель	строка		Да
prompt_filter_results	promptFilterResults	Результаты фильтрации содержимого для нуля или более запросов в запросе. В запросе потоковой передачи результаты для различных запросов могут поступать в разное время или в разных заказах.	No
choices	array		Да
использование	объект		No

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

completion_tokens

Имя.	Тип	Описание	По умолч.
completion_tokens	number
prompt_tokens	number
total_tokens	number

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

Описание: ОК

Content-Type	Тип	Description
application/json	объект

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

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

Content-Type	Тип	Description
application/json	errorResponse

Примеры

Пример

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

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

{
 "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-06-01

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

Параметры URI

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

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

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

Текст запроса

Content-Type: application/json

Имя.	Тип	Описание	Обязательное поле
input	строка или массив	Входной текст для получения внедренных значений, закодированных в виде строки. Чтобы получить внедрение для нескольких входных данных в одном запросе, передайте массив строк. Длина каждого входного параметра не должна превышать 2048 маркеров. Кроме случаев внедрения кода, мы рекомендуем заменять новые строки (\n) во входных данных одним пробелом, поскольку при наличии новых строк могут наблюдаться результаты более низкого качества.	Да
Пользователь	строка	Уникальный идентификатор, представляющий пользователя, который может помочь в мониторинге и обнаружении злоупотреблений.	No
input_type	строка	тип входных данных для внедрения поиска для использования	No
encoding_format	строка	Формат, в который возвращаются встраиваемые элементы. Может быть либо `float`, либо `base64`. По умолчанию — `float`.	No
dimensions	integer	Число измерений, в которых должны быть внедренные выходные данные. Поддерживается только в `text-embedding-3` и более поздних моделях.	No

Отклики

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

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

prompt_tokens

Имя.	Тип	Описание	По умолч.
prompt_tokens	integer

total_tokens

Имя.	Тип	Описание	По умолч.
total_tokens	integer

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

Описание: ОК

Content-Type	Тип	Description
application/json	объект

Примеры

Пример

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

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

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

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

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

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

Параметры URI

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

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

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

Текст запроса

Content-Type: application/json

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
Температура	number	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным. Как правило, мы рекомендуем изменить это или `top_p` не оба.	No	1
top_p	number	Альтернативой выборке с температурой является так называемая выборка ядра, где модель рассматривает результаты маркеров с top_p всего массива значений вероятности. Таким образом, 0,1 означает, что учитываются только маркеры, входящие в верхние 10% массива значений вероятности. Как правило, мы рекомендуем изменить это или `temperature` не оба.	No	1
потоковая передача	boolean	Если задано, будут отправляться частичные разностные сообщения, например в ChatGPT. Маркеры будут отправляться как события, отправленные сервером только для данных, как они становятся доступными, при этом поток завершается сообщением `data: [DONE]` .	No	False
stop	строка или массив	До 4 последовательностей, в которых API перестанет создавать дополнительные маркеры.	No
max_tokens	integer	Максимальное количество маркеров, разрешенных для созданного ответа. По умолчанию число маркеров, возвращаемых моделью, будет (4096 — маркеры запроса).	No	4096
presence_penalty	number	Значение в диапазоне от –2.0 до 2.0. Положительные значения выбраковывают новые маркеры в зависимости от того, отображаются ли они в тексте на данный момент, увеличивая вероятность обсуждений на новые темы.	No	0
frequency_penalty	number	Значение в диапазоне от –2.0 до 2.0. Положительные значения выбраковывают новые маркеры в зависимости от существующей частоты в тексте на данный момент, уменьшая вероятность повторения той же буквальной строки.	No	0
logit_bias	объект	Изменяет вероятность появления указанных маркеров в завершении. Принимает объект JSON, который сопоставляет маркеры (указанные идентификатором маркера в токенизаторе) со связанным значением предвзятости от -100 до 100. С математической точки зрения смещение добавляется к логитам, созданным моделью до выборки. Точный эффект зависит от модели, но значения от –1 до 1 должны уменьшать или увеличивать вероятность выбора; такие значения, как –100 или 100, должны приводить к запрету или эксклюзивному выбору соответствующего маркера.	No
Пользователь	строка	Уникальный идентификатор, представляющий пользователя, который может помочь Azure OpenAI отслеживать и обнаруживать злоупотребления.	No
messages	array	Список сообщений, составляющих беседу до сих пор. Пример кода Python.	No
data_sources	array	Записи конфигурации для расширений чата Azure OpenAI, которые используют их. Эта дополнительная спецификация совместима только с Azure OpenAI.	No
n	integer	Сколько вариантов завершения чата для каждого входного сообщения.	No	1
seed	integer	Если задано, наша система будет предпринять лучшие усилия для выборки детерминированного, таким образом, что повторяющиеся запросы с одинаковыми и теми же параметрами должны возвращать тот же `seed` результат. Детерминированность не являетсяguaranteed, и вы должны ссылаться на `system_fingerprint` параметр ответа, чтобы отслеживать изменения в серверной части.	No	0
logprobs	boolean	Следует ли возвращать вероятности журналов выходных маркеров или нет. Если значение true, возвращает вероятности журнала каждого выходного маркера, возвращаемого в параметре `content` `message`. Этот параметр в настоящее время недоступен в `gpt-4-vision-preview` модели.	No	False
top_logprobs	integer	Целое число от 0 до 5, указывающее число наиболее вероятных маркеров, возвращаемых по каждой позиции маркера, каждый из которых имеет связанную вероятность журнала. `logprobs` Необходимо задать значение `true` , если этот параметр используется.	No
response_format	объект	Объект, указывающий формат, который должен выводить модель. Используется для включения режима JSON.	No
средства	array	Список инструментов, которые может вызывать модель. В настоящее время в качестве инструмента поддерживаются только функции. Используйте это для предоставления списка функций, для которые модель может создавать входные данные JSON.	No
tool_choice	chatCompletionToolChoiceOption	Определяет, какая функция (если есть) вызывается моделью. `none` означает, что модель не вызывает функцию и вместо этого создает сообщение. `auto` означает, что модель может выбирать между созданием сообщения или вызовом функции. Указание определенной функции путем `{"type": "function", "function": {"name": "my_function"}}` принудительного вызова этой функции моделью.	No
functions	array	Не рекомендуется использовать в пользу `tools`. Список функций, для которые модель может создавать входные данные JSON.	No
function_call	Строка или объект	Не рекомендуется использовать в пользу `tool_choice`. Определяет, как модель реагирует на вызовы функций. "none" означает, что модель не вызывает функцию и реагирует на пользователя. "auto" означает, что модель может выбирать между конечным пользователем или вызовом функции. Указание определенной функции путем `{"name":\ "my_function"}` принудительного вызова этой функции моделью. Значение "none" — это значение по умолчанию, если функции отсутствуют. "auto" — это значение по умолчанию, если функции присутствуют.	No

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

Тип

Имя.	Тип	Описание	По умолч.
type	chatCompletionResponseFormat	Параметр включения `json_object` режима JSON. Это гарантирует, что сообщение, которое создает модель, является допустимым JSON.	text

Отклики

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

Описание: ОК

Content-Type	Тип	Description
application/json	createChatCompletionResponse

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

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

Content-Type	Тип	Description
application/json	errorResponse

Примеры

Пример

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

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

{
 "messages": [
  {
   "role": "system",
   "content": "you're 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-06-01

{
 "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-06-01

{
 "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're 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-06-01

{
 "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-06-01

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

Параметры URI

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

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

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

Текст запроса

Content-Type: multipart/form-data

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

Отклики

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

Описание: ОК

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

Примеры

Пример

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

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

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

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

Пример

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

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

"---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-06-01

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

Параметры URI

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

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

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

Текст запроса

Content-Type: multipart/form-data

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

Отклики

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

Описание: ОК

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

Примеры

Пример

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

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

"---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-06-01

"---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-06-01

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

Параметры URI

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

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

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

Текст запроса

Content-Type: application/json

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
prompt	строка	Текстовое описание требуемых изображений. Максимальная длина — 4000 символов.	Да
n	integer	Количество генерируемых изображений.	No	1
size	imageSize	Размер созданных изображений.	No	1024 x 1024
response_format	imagesResponseFormat	Формат, в котором возвращаются созданные изображения.	No	URL-адрес
Пользователь	строка	Уникальный идентификатор, представляющий конечного пользователя, который может помочь в мониторинге и обнаружении злоупотреблений.	No
quality	imageQuality	Качество создаваемого изображения.	No	standard
style	imageStyle	Стиль созданных изображений.	No	яркий

Отклики

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

Описание: ОК

Content-Type	Тип	Description
application/json	generateImagesResponse

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

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

Content-Type	Тип	Description
application/json	dalleErrorResponse

Примеры

Пример

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

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

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

Компоненты

errorResponse

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

errorBase

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

Ошибка

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

innerError

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

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

innerErrorCode

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

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

Тип: string.

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

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

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

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

dalleErrorResponse

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
error	dalleError		No

dalleError

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

dalleInnerError

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

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

contentFilterResultBase

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
filtered	boolean		Да

contentFilterSeverityResult

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
filtered	boolean		Да
severity	строка		Нет

contentFilterDetectedResult

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
filtered	boolean		Да
обнаружено	boolean		No

contentFilterDetectedWithCitationResult

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

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

URL

Имя.	Тип	Описание	По умолч.
URL	строка

Лицензия

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

contentFilterResultsBase

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

Имя.	Тип	Обязательное поле
половой	contentFilterSeverityResult	No
насилие	contentFilterSeverityResult	No
ненавидеть	contentFilterSeverityResult	No
self_harm	contentFilterSeverityResult	No
богохульство	contentFilterDetectedResult	No
error	errorBase	No

contentFilterPromptResults

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

Имя.	Тип	Обязательное поле
половой	contentFilterSeverityResult	No
насилие	contentFilterSeverityResult	No
ненавидеть	contentFilterSeverityResult	No
self_harm	contentFilterSeverityResult	No
богохульство	contentFilterDetectedResult	No
error	errorBase	No
Джейлбрейк	contentFilterDetectedResult	No

contentFilterChoiceResults

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

Имя.	Тип	Обязательное поле
половой	contentFilterSeverityResult	No
насилие	contentFilterSeverityResult	No
ненавидеть	contentFilterSeverityResult	No
self_harm	contentFilterSeverityResult	No
богохульство	contentFilterDetectedResult	No
error	errorBase	No
protected_material_text	contentFilterDetectedResult	No
protected_material_code	contentFilterDetectedWithCitationResult	No

promptFilterResult

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

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

promptFilterResults

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

dalleContentFilterResults

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

Имя.	Тип	Обязательное поле
половой	contentFilterSeverityResult	No
насилие	contentFilterSeverityResult	No
ненавидеть	contentFilterSeverityResult	No
self_harm	contentFilterSeverityResult	No

dalleFilterResults

Имя.	Тип	Обязательное поле
половой	contentFilterSeverityResult	No
насилие	contentFilterSeverityResult	No
ненавидеть	contentFilterSeverityResult	No
self_harm	contentFilterSeverityResult	No
богохульство	contentFilterDetectedResult	No
Джейлбрейк	contentFilterDetectedResult	No

chatCompletionsRequestCommon

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
Температура	number	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным. Как правило, мы рекомендуем изменить это или `top_p` не оба.	No	1
top_p	number	Альтернативой выборке с температурой является так называемая выборка ядра, где модель рассматривает результаты маркеров с top_p всего массива значений вероятности. Таким образом, 0,1 означает, что учитываются только маркеры, входящие в верхние 10% массива значений вероятности. Как правило, мы рекомендуем изменить это или `temperature` не оба.	No	1
потоковая передача	boolean	Если задано, будут отправляться частичные разностные сообщения, например в ChatGPT. Маркеры будут отправляться как события, отправленные сервером только для данных, как они становятся доступными, при этом поток завершается сообщением `data: [DONE]` .	No	False
stop	строка или массив	До 4 последовательностей, в которых API перестанет создавать дополнительные маркеры.	No
max_tokens	integer	Максимальное количество маркеров, разрешенных для созданного ответа. По умолчанию число маркеров, возвращаемых моделью, будет (4096 — маркеры запроса).	No	4096
presence_penalty	number	Значение в диапазоне от –2.0 до 2.0. Положительные значения выбраковывают новые маркеры в зависимости от того, отображаются ли они в тексте на данный момент, увеличивая вероятность обсуждений на новые темы.	No	0
frequency_penalty	number	Значение в диапазоне от –2.0 до 2.0. Положительные значения выбраковывают новые маркеры в зависимости от существующей частоты в тексте на данный момент, уменьшая вероятность повторения той же буквальной строки.	No	0
logit_bias	объект	Изменяет вероятность появления указанных маркеров в завершении. Принимает объект JSON, который сопоставляет маркеры (указанные идентификатором маркера в токенизаторе) со связанным значением предвзятости от -100 до 100. С математической точки зрения смещение добавляется к логитам, созданным моделью до выборки. Точный эффект зависит от модели, но значения от –1 до 1 должны уменьшать или увеличивать вероятность выбора; такие значения, как –100 или 100, должны приводить к запрету или эксклюзивному выбору соответствующего маркера.	No
Пользователь	строка	Уникальный идентификатор, представляющий пользователя, который может помочь Azure OpenAI отслеживать и обнаруживать злоупотребления.	No

createChatCompletionRequest

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
Температура	number	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным. Как правило, мы рекомендуем изменить это или `top_p` не оба.	No	1
top_p	number	Альтернативой выборке с температурой является так называемая выборка ядра, где модель рассматривает результаты маркеров с top_p всего массива значений вероятности. Таким образом, 0,1 означает, что учитываются только маркеры, входящие в верхние 10% массива значений вероятности. Как правило, мы рекомендуем изменить это или `temperature` не оба.	No	1
потоковая передача	boolean	Если задано, будут отправляться частичные разностные сообщения, например в ChatGPT. Маркеры будут отправляться как события, отправленные сервером только для данных, как они становятся доступными, при этом поток завершается сообщением `data: [DONE]` .	No	False
stop	строка или массив	До 4 последовательностей, в которых API перестанет создавать дополнительные маркеры.	No
max_tokens	integer	Максимальное количество маркеров, разрешенных для созданного ответа. По умолчанию число маркеров, возвращаемых моделью, будет (4096 — маркеры запроса).	No	4096
presence_penalty	number	Значение в диапазоне от –2.0 до 2.0. Положительные значения выбраковывают новые маркеры в зависимости от того, отображаются ли они в тексте на данный момент, увеличивая вероятность обсуждений на новые темы.	No	0
frequency_penalty	number	Значение в диапазоне от –2.0 до 2.0. Положительные значения выбраковывают новые маркеры в зависимости от существующей частоты в тексте на данный момент, уменьшая вероятность повторения той же буквальной строки.	No	0
logit_bias	объект	Изменяет вероятность появления указанных маркеров в завершении. Принимает объект JSON, который сопоставляет маркеры (указанные идентификатором маркера в токенизаторе) со связанным значением предвзятости от -100 до 100. С математической точки зрения смещение добавляется к логитам, созданным моделью до выборки. Точный эффект зависит от модели, но значения от –1 до 1 должны уменьшать или увеличивать вероятность выбора; такие значения, как –100 или 100, должны приводить к запрету или эксклюзивному выбору соответствующего маркера.	No
Пользователь	строка	Уникальный идентификатор, представляющий пользователя, который может помочь Azure OpenAI отслеживать и обнаруживать злоупотребления.	No
messages	array	Список сообщений, составляющих беседу до сих пор. Пример кода Python.	No
data_sources	array	Записи конфигурации для расширений чата Azure OpenAI, которые используют их. Эта дополнительная спецификация совместима только с Azure OpenAI.	No
n	integer	Сколько вариантов завершения чата для каждого входного сообщения.	No	1
seed	integer	Если задано, наша система будет предпринять лучшие усилия для выборки детерминированного, таким образом, что повторяющиеся запросы с одинаковыми и теми же параметрами должны возвращать тот же `seed` результат. Детерминированность не являетсяguaranteed, и вы должны ссылаться на `system_fingerprint` параметр ответа, чтобы отслеживать изменения в серверной части.	No	0
logprobs	boolean	Следует ли возвращать вероятности журналов выходных маркеров или нет. Если значение true, возвращает вероятности журнала каждого выходного маркера, возвращаемого в параметре `content` `message`. Этот параметр в настоящее время недоступен в `gpt-4-vision-preview` модели.	No	False
top_logprobs	integer	Целое число от 0 до 5, указывающее число наиболее вероятных маркеров, возвращаемых по каждой позиции маркера, каждый из которых имеет связанную вероятность журнала. `logprobs` Необходимо задать значение `true` , если этот параметр используется.	No
response_format	объект	Объект, указывающий формат, который должен выводить модель. Используется для включения режима JSON.	No
средства	array	Список инструментов, которые может вызывать модель. В настоящее время в качестве инструмента поддерживаются только функции. Используйте это для предоставления списка функций, для которые модель может создавать входные данные JSON.	No
tool_choice	chatCompletionToolChoiceOption	Определяет, какая функция (если есть) вызывается моделью. `none` означает, что модель не вызывает функцию и вместо этого создает сообщение. `auto` означает, что модель может выбирать между созданием сообщения или вызовом функции. Указание определенной функции путем `{"type": "function", "function": {"name": "my_function"}}` принудительного вызова этой функции моделью.	No
functions	array	Не рекомендуется использовать в пользу `tools`. Список функций, для которые модель может создавать входные данные JSON.	No
function_call	Строка или объект	Не рекомендуется использовать в пользу `tool_choice`. Определяет, как модель реагирует на вызовы функций. "none" означает, что модель не вызывает функцию и реагирует на пользователя. "auto" означает, что модель может выбирать между конечным пользователем или вызовом функции. Указание определенной функции путем `{"name":\ "my_function"}` принудительного вызова этой функции моделью. Значение "none" — это значение по умолчанию, если функции отсутствуют. "auto" — это значение по умолчанию, если функции присутствуют.	No

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

Тип

Имя.	Тип	Описание	По умолч.
type	chatCompletionResponseFormat	Параметр включения `json_object` режима JSON. Это гарантирует, что сообщение, которое создает модель, является допустимым JSON.	text

chatCompletionResponseFormat

Параметр включения json_object режима JSON. Это гарантирует, что сообщение, которое создает модель, является допустимым JSON.

Описание. Параметр включения json_object режима JSON. Это гарантирует, что сообщение, которое создает модель, является допустимым JSON.

Тип: string.

Значение по умолчанию: текст

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

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

значение	Описание
text	Формат ответа — это строка обычного текста.
json_object	Формат ответа — это объект JSON.

chatCompletionFunction

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

chatCompletionFunctionParameters

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

chatCompletionRequestMessage

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

chatCompletionRequestMessageRole

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

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

Тип: string.

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

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

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

значение	Описание
доступом	Роль автора сообщения — это система.
Пользователь	Роль автора сообщения — это пользователь.
assistant	Роль автора сообщения — помощник.
планирования	Роль автора сообщения — это средство.
function	Устарело. Роль автора сообщения — это функция.

chatCompletionRequestMessageSystem

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

chatCompletionRequestMessageUser

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
роль	chatCompletionRequestMessageRole	Роль автора сообщений.	Да
content	строка или массив		No

chatCompletionRequestMessageContentPart

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
type	chatCompletionRequestMessageContentPartType	Тип части содержимого.	Да

chatCompletionRequestMessageContentPartType

Тип части содержимого.

Описание: тип части содержимого.

Тип: string.

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

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

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

значение	Описание
text	Тип части контента — текст.
image_url	Тип части содержимого — image_url.

chatCompletionRequestMessageContentPartText

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

chatCompletionRequestMessageContentPartImage

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
type	chatCompletionRequestMessageContentPartType	Тип части содержимого.	Да
URL-адрес	строка	URL-адрес изображения или данных в кодировке Base64.	No
detail	imageDetailLevel	Указывает уровень детализации изображения.	No	авто

imageDetailLevel

Указывает уровень детализации изображения.

Описание. Указывает уровень детализации изображения.

Тип: string.

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

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

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

значение	Описание
авто	Уровень детализации изображения является автоматическим.
Низкий	Уровень детализации изображения низкий.
high	Уровень детализации изображения высок.

chatCompletionRequestMessageAssistant

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

azureChatExtensionConfiguration

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

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

azureChatExtensionType

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

Тип: string.

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

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

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

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

azureSearchChatExtensionConfiguration

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

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

azureSearchChatExtensionParameters

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

Имя.	Тип	Описание	Обязательное поле
проверка подлинности	onYourDataApiKeyAuthenticationOptions или onYourDataSystemAssignedManagedIdentityAuthenticationOptions или onYourDataUserAssignedManagedIdentityAuthenticationOptions		Да
top_n_documents	integer	Настроено первое число документов для функции настроенного запроса.	No
in_scope	boolean	Следует ли ограничить запросы использованием индексированных данных.	No
строгость	integer	Настроенная строгость фильтрации релевантности поиска. Чем выше строгость, тем выше точность, но более низкий отзыв ответа.	No
role_information	строка	Дайте модели инструкции о том, как он должен вести себя и какой-либо контекст, на который он должен ссылаться при создании ответа. Вы можете описать личность помощника и рассказать о том, как отформатировать ответы. Существует ограничение на 100 маркеров, и он учитывается в отношении общего ограничения маркера.	No
конечная точка	строка	Абсолютный путь конечной точки для используемого ресурса поиска Azure.	Да
index_name	строка	Имя индекса, используемого как доступное в ресурсе поиска Azure.	Да
fields_mapping	azureSearchIndexFieldMappingOptions	Необязательные параметры для управления обработкой полей при использовании настроенного ресурса поиска Azure.	No
query_type	azureSearchQueryType	Тип запроса поиска Azure, который должен выполняться при использовании в качестве расширения чата Azure OpenAI.	No
semantic_configuration	строка	Дополнительная семантическая конфигурация для запроса.	No
Фильтр	строка	Фильтр поиска.	No
embedding_dependency	onYourDataEndpointVectorizationSource или onYourDataDeploymentNameVectorizationSource		No

azureSearchIndexFieldMappingOptions

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

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

azureSearchQueryType

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

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

Тип: string.

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

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

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

значение	Описание
простой	Представляет средство синтаксического анализа простых запросов по умолчанию.
семантических	Представляет средство синтаксического анализа семантического запроса для расширенного семантического моделирования.
vector	Представляет векторный поиск по вычисляемых данных.
vector_simple_hybrid	Представляет сочетание простой стратегии запроса с векторными данными.
vector_semantic_hybrid	Представляет сочетание семантического поиска и запросов к векторным данным.

azureCosmosDBChatExtensionConfiguration

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

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

azureCosmosDBChatExtensionParameters

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

Имя.	Тип	Описание	Обязательное поле
проверка подлинности	onYourDataConnectionStringAuthenticationOptions	Параметры проверки подлинности Azure OpenAI On Your Data при использовании строка подключения.	Да
top_n_documents	integer	Настроено первое число документов для функции настроенного запроса.	No
in_scope	boolean	Следует ли ограничить запросы использованием индексированных данных.	No
строгость	integer	Настроенная строгость фильтрации релевантности поиска. Чем выше строгость, тем выше точность, но более низкий отзыв ответа.	No
role_information	строка	Дайте модели инструкции о том, как он должен вести себя и какой-либо контекст, на который он должен ссылаться при создании ответа. Вы можете описать личность помощника и рассказать о том, как отформатировать ответы. Существует ограничение на 100 маркеров, и он учитывается в отношении общего ограничения маркера.	No
database_name	строка	Имя базы данных виртуальных ядер MongoDB для использования с Azure Cosmos DB.	Да
container_name	строка	Имя контейнера ресурсов Azure Cosmos DB.	Да
index_name	строка	Имя индекса виртуального ядра MongoDB для использования с Azure Cosmos DB.	Да
fields_mapping	azureCosmosDBFieldMappingOptions	Необязательные параметры для управления обработкой полей при использовании настроенного ресурса Azure Cosmos DB.	Да
embedding_dependency	onYourDataEndpointVectorizationSource или onYourDataDeploymentNameVectorizationSource		Да

azureCosmosDBFieldMappingOptions

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

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

onYourDataAuthenticationOptions

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

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

onYourDataAuthenticationType

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

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

Тип: string.

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

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

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

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

onYourDataApiKeyAuthenticationOptions

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

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

onYourDataConnectionStringAuthenticationOptions

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

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
type	onYourDataAuthenticationType	Типы проверки подлинности, поддерживаемые Azure OpenAI в данных.	Да
connection_string	строка	Строка подключения, используемый для проверки подлинности.	No

onYourDataSystemAssignedManagedIdentityAuthenticationOptions

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

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

onYourDataUserAssignedManagedIdentityAuthenticationOptions

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

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

onYourDataVectorizationSource

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

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

onYourDataVectorizationSourceType

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

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

Тип: string.

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

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

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

значение

Описание

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

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

deployment_name

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

onYourDataDeploymentNameVectorizationSource

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

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

onYourDataEndpointVectorizationSource

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

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

azureChatExtensionsMessageContext

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

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

Источник

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

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

chatCompletionMessageToolCall

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

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

Имя.

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

Аргументы

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

toolCallType

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

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

Тип: string.

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

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

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

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

chatCompletionRequestMessageTool

Имя.	Тип	Описание	Обязательное поле
роль	chatCompletionRequestMessageRole	Роль автора сообщений.	Да
tool_call_id	строка	Вызов средства, на который отвечает это сообщение.	No
content	строка	Содержимое сообщения.	No

chatCompletionRequestMessageFunction

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

createChatCompletionResponse

Имя.	Тип	Описание	Обязательное поле
id	строка	Уникальный идентификатор завершения чата.	Да
объект	chatCompletionResponseObject	Тип объекта.	Да
создаются	integer	Метка времени Unix (в секундах) при создании завершения чата.	Да
модель	строка	Модель, используемая для завершения чата.	Да
использование	completionUsage	Статистика использования для запроса завершения.	No
system_fingerprint	строка	Можно использовать в сочетании с параметром `seed` запроса, чтобы понять, когда внутренние изменения были внесены, что может повлиять на детерминированность.	No
prompt_filter_results	promptFilterResults	Результаты фильтрации содержимого для нуля или более запросов в запросе. В запросе потоковой передачи результаты для различных запросов могут поступать в разное время или в разных заказах.	No
choices	array		No

chatCompletionChoiceLogProbs

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

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

chatCompletionTokenLogprob

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

chatCompletionResponseMessage

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

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

chatCompletionResponseMessageRole

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

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

Тип: string.

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

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

assistant

chatCompletionToolChoiceOption

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

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

chatCompletionNamedToolChoice

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

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

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

Имя.

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

chatCompletionFunctionCall

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

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

chatCompletionsResponseCommon

Имя.	Тип	Описание	Обязательное поле
id	строка	Уникальный идентификатор завершения чата.	Да
объект	chatCompletionResponseObject	Тип объекта.	Да
создаются	integer	Метка времени Unix (в секундах) при создании завершения чата.	Да
модель	строка	Модель, используемая для завершения чата.	Да
использование	completionUsage	Статистика использования для запроса завершения.	No
system_fingerprint	строка	Можно использовать в сочетании с параметром `seed` запроса, чтобы понять, когда внутренние изменения были внесены, что может повлиять на детерминированность.	No

chatCompletionResponseObject

Тип объекта.

Описание: тип объекта.

Тип: string.

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

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

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

значение	Описание
chat.completion	Тип объекта — завершение чата.

completionUsage

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

Имя.	Тип	Описание	Обязательное поле
prompt_tokens	integer	Количество маркеров в запросе.	Да
completion_tokens	integer	Количество маркеров в созданном завершении.	Да
total_tokens	integer	Общее количество маркеров, используемых в запросе (запрос + завершение).	Да

chatCompletionTool

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

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

Description

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

Имя.

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

Параметры

Имя (название)	Тип	Описание	По умолч.
parameters	chatCompletionFunctionParameters	Параметры, которые принимают функции, описаны как объект схемы JSON. Дополнительные сведения о формате см. в справочнике по схеме JSON.

chatCompletionToolType

Тип средства. В настоящее время поддерживается только function .

Описание: тип средства. В настоящее время поддерживается только function .

Тип: string.

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

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

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

значение	Описание
function	Тип инструмента — функция.

chatCompletionChoiceCommon

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

createTranslationRequest

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

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

audioResponse

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

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

audioVerboseResponse

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

Имя.	Тип	Описание	Обязательное поле
text	строка	Переведенный или транскрибированные тексты.	Да
SqlAzureDacpacDeployment	строка	Тип звуковой задачи.	No
язык	string	Язык.	No
duration	number	Длительность.	No
сегменты	array		No

audioResponseFormat

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

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

Тип: string.

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

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

json
text
srt
verbose_json
vtt

createTranscriptionRequest

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

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

audioSegment

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

Имя.	Тип	Описание	Обязательное поле
id	integer	Идентификатор сегмента.	No
искать	number	Смещение сегмента.	No
start	number	Смещение начала сегмента.	No
end	number	Смещение конца сегмента.	No
text	строка	Сегментирование текста.	No
Маркеры	array	Маркеры текста.	No
Температура	number	Температура.	No
avg_logprob	number	Средняя вероятность журнала.	No
compression_ratio	number	Коэффициент уплотнения.	No
no_speech_prob	number	Вероятность "нет речи".	No

imageQuality

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

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

Тип: string.

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

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

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

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

imagesResponseFormat

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

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

Тип: string.

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

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

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

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

imageSize

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

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

Тип: string.

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

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

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

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

imageStyle

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

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

Тип: string.

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

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

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

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

imageGenerationsRequest

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
prompt	строка	Текстовое описание требуемых изображений. Максимальная длина — 4000 символов.	Да
n	integer	Количество генерируемых изображений.	No	1
size	imageSize	Размер созданных изображений.	No	1024 x 1024
response_format	imagesResponseFormat	Формат, в котором возвращаются созданные изображения.	No	URL-адрес
Пользователь	строка	Уникальный идентификатор, представляющий конечного пользователя, который может помочь в мониторинге и обнаружении злоупотреблений.	No
quality	imageQuality	Качество создаваемого изображения.	No	standard
style	imageStyle	Стиль созданных изображений.	No	яркий

generateImagesResponse

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

imageResult

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

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

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

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

Chatmessage

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

Преобразование текста в речь

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

Следующие шаги

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

Бөлісу құралы:

Справочник по REST API Службы Azure OpenAI

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

Проверка подлинности

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

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

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

Параметры URI

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

Текст запроса

Отклики

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

completion_tokens

Примеры

Пример

Внедрение

Параметры URI

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

Текст запроса

Отклики

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

prompt_tokens

total_tokens

Примеры

Пример

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

Параметры URI

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

Текст запроса

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

Тип

Отклики

Примеры

Пример

Пример

Пример

Пример

Расшифровки

Параметры URI

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

Текст запроса

Отклики

Примеры

Пример

Пример

Переводы

Параметры URI

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

Текст запроса

Отклики

Примеры

Пример

Пример

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

Параметры URI

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

Текст запроса

Отклики

Примеры

Пример

Компоненты

errorResponse

errorBase

Ошибка

innerError

innerErrorCode

dalleErrorResponse

dalleError

dalleInnerError

contentFilterResultBase

contentFilterSeverityResult

contentFilterDetectedResult

contentFilterDetectedWithCitationResult

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

URL

Лицензия

contentFilterResultsBase

contentFilterPromptResults

contentFilterChoiceResults

promptFilterResult