Azure OpenAI в справочнике по REST API моделей Microsoft Foundry

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

API specs

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

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

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

Important

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

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

Authentication

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

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

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

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

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

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

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

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

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

Completions

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

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

URI Parameters

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

Request Header

Name	Required	Type	Description
api-key	True	string	Укажите здесь ключ API OpenAI Azure

Request Body

Content-Type: application/json

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

Responses

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

Description: OK

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

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

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

Content-Type	Type	Description
application/json	errorResponse

Examples

Example

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

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

Embeddings

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

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

URI Parameters

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

Request Header

Name	Required	Type	Description
api-key	True	string	Укажите здесь ключ API OpenAI Azure

Request Body

Content-Type: application/json

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

Responses

Name	Type	Description	Required	Default
object	string		Yes
model	string		Yes
data	array		Yes
usage	object		Yes

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

prompt_tokens

Name	Type	Description	Default
prompt_tokens	integer

total_tokens

Name	Type	Description	Default
total_tokens	integer

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

Description: OK

Content-Type	Type	Description
application/json	object

Examples

Example

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

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

Chat completions

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

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

URI Parameters

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

Request Header

Name	Required	Type	Description
api-key	True	string	Укажите здесь ключ API OpenAI Azure

Request Body

Content-Type: application/json

Name	Type	Description	Required	Default
temperature	number	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным. Как правило, мы рекомендуем изменить это или top_p не оба.	No	1
top_p	number	Альтернатива выборке с температурой, называемой выборкой ядра, где модель рассматривает результаты маркеров с top_p массой вероятности. Таким образом, 0,1 означает, что рассматриваются только маркеры, состоящие из 10 лучших% массы вероятностей. Как правило, мы рекомендуем изменить это или temperature не оба.	No	1
stream	boolean	Если задано, будут отправляться частичные разностные сообщения, например в ChatGPT. Маркеры будут отправляться как события, отправленные сервером только для данных, как они становятся доступными, при этом поток завершается сообщением data: [DONE] .	No	False
stop	строка или массив	До четырех последовательностей, в которых API перестанет создавать дополнительные маркеры.	No
max_tokens	integer	Максимальное количество маркеров, которые можно создать в завершении чата. Общая длина входных маркеров и созданных маркеров ограничена длиной контекста модели.	No
max_completion_tokens	integer	Верхняя граница для числа маркеров, которые можно создать для завершения, включая видимые выходные маркеры и маркеры причин.	No
presence_penalty	number	Число от -2.0 до 2.0. Положительные значения наказывают новые маркеры на основе того, отображаются ли они в тексте до сих пор, увеличив вероятность того, что модель будет говорить о новых темах.	No	0
frequency_penalty	number	Число от -2.0 до 2.0. Положительные значения наказывают новые маркеры на основе их существующей частоты в тексте до сих пор, уменьшая вероятность повторения той же строки.	No	0
logit_bias	object	Измените вероятность появления указанных маркеров в завершении. Принимает объект JSON, который сопоставляет маркеры (указанные идентификатором маркера в токенизаторе) со связанным значением предвзятости от -100 до 100. Математически предвзятость добавляется в логиты, созданные моделью до выборки. Точный эффект зависит от модели, но значения между -1 и 1 должны уменьшить или увеличить вероятность выбора; такие значения, как -100 или 100, должны привести к запрету или эксклюзивному выбору соответствующего маркера.	No	None
user	string	Уникальный идентификатор, представляющий конечного пользователя, который может помочь в мониторинге и обнаружении злоупотреблений.	No
messages	array	Список сообщений, составляющих беседу до сих пор.	Yes
data_sources	array	Записи конфигурации для расширений чата OpenAI Azure, которые используют их. Эта дополнительная спецификация совместима только с Azure OpenAI.	No
logprobs	boolean	Следует ли возвращать вероятности журналов выходных маркеров или нет. Если значение true, возвращает вероятности журнала каждого выходного маркера, возвращаемого в параметре contentmessage.	No	False
top_logprobs	integer	Целое число от 0 до 20, указывающее число наиболее вероятных маркеров, возвращаемых по каждой позиции маркера, каждый из которых имеет связанную вероятность журнала. logprobs Необходимо задать значение true , если этот параметр используется.	No
n	integer	Сколько вариантов завершения чата для каждого входного сообщения. Обратите внимание, что плата будет взиматься на основе количества созданных маркеров во всех вариантах. Имейте в виду n , чтобы 1 свести к минимуму затраты.	No	1
parallel_tool_calls	ParallelToolCalls	Следует ли включить параллельные вызовы функций во время использования средства.	No	True
response_format	ResponseFormatText или ResponseFormatJsonObject или ResponseFormatJsonSchema	Объект, указывающий формат, который должен выводить модель. Совместим с GPT-4o, GPT-4o mini, GPT-4 Turbo и всеми моделями GPT-3.5Turbo, чем gpt-3.5-turbo-1106более новые. Параметр для { "type": "json_schema", "json_schema": {...} } включения структурированных выходных данных, гарантирующих, что модель будет соответствовать предоставленной схеме JSON. Параметр включения { "type": "json_object" } режима JSON, который гарантирует, что модель создает сообщение является допустимым JSON. Важно: при использовании режима JSON необходимо также указать модели создавать JSON самостоятельно с помощью системного или пользовательского сообщения. Без этого модель может создать неуправляемый поток пробелов до тех пор, пока поколение не достигнет предела маркера, в результате чего длительный и, казалось бы, "застрявший" запрос. Кроме того, обратите внимание, что содержимое сообщения может быть частично отрезано, если finish_reason="length", что указывает на превышение поколения max_tokens или беседа превысила максимальную длину контекста.	No
seed	integer	Эта функция доступна в бета-версии. Если задано, наша система будет предпринять лучшие усилия для выборки детерминированного, таким образом, что повторяющиеся запросы с одинаковыми и теми же параметрами должны возвращать тот же seed результат. Детерминированность не гарантируется, и вы должны ссылаться на system_fingerprint параметр ответа для отслеживания изменений в серверной части.	No
tools	array	Список инструментов, которые может вызывать модель. В настоящее время в качестве инструмента поддерживаются только функции. Используйте это для предоставления списка функций, для которые модель может создавать входные данные JSON. Поддерживаются не более 128 функций.	No
tool_choice	chatCompletionToolChoiceOption	Определяет, какое средство (если таковое) вызывается моделью. none означает, что модель не вызывает никаких инструментов и вместо этого создает сообщение. auto означает, что модель может выбирать между созданием сообщения или вызовом одного или нескольких инструментов. required означает, что модель должна вызывать один или несколько инструментов. Указание определенного средства с помощью {"type": "function", "function": {"name": "my_function"}} принудительного вызова этого средства моделью. none значение по умолчанию, если средства отсутствуют. auto значение по умолчанию, если существуют средства.	No
function_call	string или chatCompletionFunctionCallOption	Не рекомендуется использовать в пользу tool_choice. Определяет, какая функция (если есть) вызывается моделью. none означает, что модель не вызывает функцию и вместо этого создает сообщение. auto означает, что модель может выбирать между созданием сообщения или вызовом функции. Указание определенной функции путем {"name": "my_function"} принудительного вызова этой функции моделью. none значение по умолчанию, если функции отсутствуют. auto значение по умолчанию, если функции присутствуют.	No
functions	array	Не рекомендуется использовать в пользу tools. Список функций, для которые модель может создавать входные данные JSON.	No

Responses

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

Description: OK

Content-Type	Type	Description
application/json	createChatCompletionResponse или createChatCompletionStreamResponse

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

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

Content-Type	Type	Description
application/json	errorResponse

Examples

Example

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

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

Example

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

Example

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

Example

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

Name	In	Required	Type	Description
endpoint	path	Yes	string url	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например https://aoairesource.openai.azure.com. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai.azure.com
deployment-id	path	Yes	string	Идентификатор развертывания речи в текстовой модели. Сведения о поддерживаемых моделях см. в статье [/azure/ai-foundry/openai/concepts/models#audio-models].
api-version	query	Yes	string	API version

Request Header

Name	Required	Type	Description
api-key	True	string	Укажите здесь ключ API OpenAI Azure

Request Body

Content-Type: multipart/form-data

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

Responses

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

Description: OK

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

Examples

Example

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

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

Example

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

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 Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	Поддерживаемые конечные точки OpenAI Azure (протокол и имя узла, например https://aoairesource.openai.azure.com. Замените "aoairesource" именем ресурса OpenAI Azure). https://{your-resource-name}.openai.azure.com
deployment-id	path	Yes	string	Идентификатор развертывания модели whisper, которая была развернута. Сведения о поддерживаемых моделях см. в статье [/azure/ai-foundry/openai/concepts/models#audio-models].
api-version	query	Yes	string	API version

Request Header

Name	Required	Type	Description
api-key	True	string	Укажите здесь ключ API OpenAI Azure

Request Body

Content-Type: multipart/form-data

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

Responses

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

Description: OK

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

Examples

Example

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

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

Example

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

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

Image generation

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

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

URI Parameters

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

Request Header

Name	Required	Type	Description
api-key	True	string	Укажите здесь ключ API OpenAI Azure

Request Body

Content-Type: application/json

Name	Type	Description	Required	Default
prompt	string	Текстовое описание требуемых изображений. Максимальная длина — 4000 символов.	Yes
n	integer	Количество генерируемых изображений.	No	1
size	imageSize	Размер созданных изображений.	No	1024x1024
response_format	imagesResponseFormat	Формат, в котором возвращаются созданные изображения.	No	url
user	string	Уникальный идентификатор, представляющий конечного пользователя, который может помочь в мониторинге и обнаружении злоупотреблений.	No
quality	imageQuality	Качество создаваемого изображения.	No	standard
style	imageStyle	Стиль созданных изображений.	No	vivid

Responses

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

Description: Ok

Content-Type	Type	Description
application/json	generateImagesResponse

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

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

Content-Type	Type	Description
application/json	dalleErrorResponse

Examples

Example

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

POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=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
          }
        }
      }
    ]
  }
}

Components

errorResponse

Name	Type	Description	Required	Default
error	error		No

errorBase

Name	Type	Description	Required	Default
code	string		No
message	string		No

error

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

innerError

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

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

innerErrorCode

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

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

Type: string

Default:

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

Enum Values:

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

dalleErrorResponse

Name	Type	Description	Required	Default
error	dalleError		No

dalleError

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

dalleInnerError

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

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

contentFilterResultBase

Name	Type	Description	Required	Default
filtered	boolean		Yes

contentFilterSeverityResult

Name	Type	Description	Required	Default
filtered	boolean		Yes
severity	string		No

contentFilterDetectedResult

Name	Type	Description	Required	Default
filtered	boolean		Yes
detected	boolean		No

contentFilterDetectedWithCitationResult

Name	Type	Description	Required	Default
citation	object		No

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

URL

Name	Type	Description	Default
URL	string

license

Name	Type	Description	Default
license	string

contentFilterResultsBase

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

Name	Type	Description	Required	Default
sexual	contentFilterSeverityResult		No
violence	contentFilterSeverityResult		No
hate	contentFilterSeverityResult		No
self_harm	contentFilterSeverityResult		No
profanity	contentFilterDetectedResult		No
error	errorBase		No

contentFilterPromptResults

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

Name	Type	Description	Required	Default
sexual	contentFilterSeverityResult		No
violence	contentFilterSeverityResult		No
hate	contentFilterSeverityResult		No
self_harm	contentFilterSeverityResult		No
profanity	contentFilterDetectedResult		No
error	errorBase		No
jailbreak	contentFilterDetectedResult		No

contentFilterChoiceResults

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

Name	Type	Description	Required	Default
sexual	contentFilterSeverityResult		No
violence	contentFilterSeverityResult		No
hate	contentFilterSeverityResult		No
self_harm	contentFilterSeverityResult		No
profanity	contentFilterDetectedResult		No
error	errorBase		No
protected_material_text	contentFilterDetectedResult		No
protected_material_code	contentFilterDetectedWithCitationResult		No

promptFilterResult

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

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

promptFilterResults

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

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

dalleContentFilterResults

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

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

dalleFilterResults

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

Name	Type	Description	Required	Default
sexual	contentFilterSeverityResult		No
violence	contentFilterSeverityResult		No
hate	contentFilterSeverityResult		No
self_harm	contentFilterSeverityResult		No
profanity	contentFilterDetectedResult		No
jailbreak	contentFilterDetectedResult		No

chatCompletionsRequestCommon

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

createCompletionRequest

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

createCompletionResponse

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

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

createChatCompletionRequest

Name	Type	Description	Required	Default
temperature	number	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным. Как правило, мы рекомендуем изменить это или top_p не оба.	No	1
top_p	number	Альтернатива выборке с температурой, называемой выборкой ядра, где модель рассматривает результаты маркеров с top_p массой вероятности. Таким образом, 0,1 означает, что рассматриваются только маркеры, состоящие из 10 лучших% массы вероятностей. Как правило, мы рекомендуем изменить это или temperature не оба.	No	1
stream	boolean	Если задано, будут отправляться частичные разностные сообщения, например в ChatGPT. Маркеры будут отправляться как события, отправленные сервером только для данных, как они становятся доступными, при этом поток завершается сообщением data: [DONE] .	No	False
stop	строка или массив	До четырех последовательностей, в которых API перестанет создавать дополнительные маркеры.	No
max_tokens	integer	Максимальное количество маркеров, которые можно создать в завершении чата. Общая длина входных маркеров и созданных маркеров ограничена длиной контекста модели.	No
max_completion_tokens	integer	Верхняя граница для числа маркеров, которые можно создать для завершения, включая видимые выходные маркеры и маркеры причин.	No
presence_penalty	number	Число от -2.0 до 2.0. Положительные значения наказывают новые маркеры на основе того, отображаются ли они в тексте до сих пор, увеличив вероятность того, что модель будет говорить о новых темах.	No	0
frequency_penalty	number	Число от -2.0 до 2.0. Положительные значения наказывают новые маркеры на основе их существующей частоты в тексте до сих пор, уменьшая вероятность повторения той же строки.	No	0
logit_bias	object	Измените вероятность появления указанных маркеров в завершении. Принимает объект JSON, который сопоставляет маркеры (указанные идентификатором маркера в токенизаторе) со связанным значением предвзятости от -100 до 100. Математически предвзятость добавляется в логиты, созданные моделью до выборки. Точный эффект зависит от модели, но значения между -1 и 1 должны уменьшить или увеличить вероятность выбора; такие значения, как -100 или 100, должны привести к запрету или эксклюзивному выбору соответствующего маркера.	No	None
user	string	Уникальный идентификатор, представляющий конечного пользователя, который может помочь в мониторинге и обнаружении злоупотреблений.	No
messages	array	Список сообщений, составляющих беседу до сих пор.	Yes
data_sources	array	Записи конфигурации для расширений чата OpenAI Azure, которые используют их. Эта дополнительная спецификация совместима только с Azure OpenAI.	No
logprobs	boolean	Следует ли возвращать вероятности журналов выходных маркеров или нет. Если значение true, возвращает вероятности журнала каждого выходного маркера, возвращаемого в параметре contentmessage.	No	False
top_logprobs	integer	Целое число от 0 до 20, указывающее число наиболее вероятных маркеров, возвращаемых по каждой позиции маркера, каждый из которых имеет связанную вероятность журнала. logprobs Необходимо задать значение true , если этот параметр используется.	No
n	integer	Сколько вариантов завершения чата для каждого входного сообщения. Обратите внимание, что плата будет взиматься на основе количества созданных маркеров во всех вариантах. Имейте в виду n , чтобы 1 свести к минимуму затраты.	No	1
parallel_tool_calls	ParallelToolCalls	Следует ли включить параллельные вызовы функций во время использования средства.	No	True
response_format	ResponseFormatText или ResponseFormatJsonObject или ResponseFormatJsonSchema	Объект, указывающий формат, который должен выводить модель. Совместим с GPT-4o, GPT-4o mini, GPT-4 Turbo и всеми моделями GPT-3.5Turbo, чем gpt-3.5-turbo-1106более новые. Параметр для { "type": "json_schema", "json_schema": {...} } включения структурированных выходных данных, гарантирующих, что модель будет соответствовать предоставленной схеме JSON. Параметр включения { "type": "json_object" } режима JSON, который гарантирует, что модель создает сообщение является допустимым JSON. Важно: при использовании режима JSON необходимо также указать модели создавать JSON самостоятельно с помощью системного или пользовательского сообщения. Без этого модель может создать неуправляемый поток пробелов до тех пор, пока поколение не достигнет предела маркера, в результате чего длительный и, казалось бы, "застрявший" запрос. Кроме того, обратите внимание, что содержимое сообщения может быть частично отрезано, если finish_reason="length", что указывает на превышение поколения max_tokens или беседа превысила максимальную длину контекста.	No
seed	integer	Эта функция доступна в бета-версии. Если задано, наша система будет предпринять лучшие усилия для выборки детерминированного, таким образом, что повторяющиеся запросы с одинаковыми и теми же параметрами должны возвращать тот же seed результат. Детерминированность не гарантируется, и вы должны ссылаться на system_fingerprint параметр ответа для отслеживания изменений в серверной части.	No
tools	array	Список инструментов, которые может вызывать модель. В настоящее время в качестве инструмента поддерживаются только функции. Используйте это для предоставления списка функций, для которые модель может создавать входные данные JSON. Поддерживаются не более 128 функций.	No
tool_choice	chatCompletionToolChoiceOption	Определяет, какое средство (если таковое) вызывается моделью. none означает, что модель не вызывает никаких инструментов и вместо этого создает сообщение. auto означает, что модель может выбирать между созданием сообщения или вызовом одного или нескольких инструментов. required означает, что модель должна вызывать один или несколько инструментов. Указание определенного средства с помощью {"type": "function", "function": {"name": "my_function"}} принудительного вызова этого средства моделью. none значение по умолчанию, если средства отсутствуют. auto значение по умолчанию, если существуют средства.	No
function_call	string или chatCompletionFunctionCallOption	Не рекомендуется использовать в пользу tool_choice. Определяет, какая функция (если есть) вызывается моделью. none означает, что модель не вызывает функцию и вместо этого создает сообщение. auto означает, что модель может выбирать между созданием сообщения или вызовом функции. Указание определенной функции путем {"name": "my_function"} принудительного вызова этой функции моделью. none значение по умолчанию, если функции отсутствуют. auto значение по умолчанию, если функции присутствуют.	No
functions	array	Не рекомендуется использовать в пользу tools. Список функций, для которые модель может создавать входные данные JSON.	No

chatCompletionFunctions

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

chatCompletionFunctionCallOption

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

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

chatCompletionRequestMessage

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

chatCompletionRequestSystemMessage

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

chatCompletionRequestUserMessage

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

chatCompletionRequestAssistantMessage

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

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

arguments

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

name

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

chatCompletionRequestToolMessage

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

chatCompletionRequestFunctionMessage

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

chatCompletionRequestSystemMessageContentPart

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

chatCompletionRequestUserMessageContentPart

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

chatCompletionRequestAssistantMessageContentPart

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

chatCompletionRequestToolMessageContentPart

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

chatCompletionRequestMessageContentPartText

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

chatCompletionRequestMessageContentPartImage

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

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

url

Name	Type	Description	Default
url	string	URL-адрес изображения или данных в кодировке Base64.

detail

Name	Type	Description	Default
detail	string	Указывает уровень детализации изображения. Дополнительные сведения см. в руководстве по визуальному представлению.	auto

chatCompletionRequestMessageContentPartRefusal

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

azureChatExtensionConfiguration

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

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

azureChatExtensionType

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

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

Type: string

Default:

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

Enum Values:

Value	Description
azure_search	Представляет использование Azure поиска в качестве расширения чата OpenAI Azure.
azure_cosmos_db	Представляет использование Azure Cosmos DB в качестве расширения чата OpenAI Azure.

azureSearchChatExtensionConfiguration

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

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

azureSearchChatExtensionParameters

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

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

azureSearchIndexFieldMappingOptions

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

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

azureSearchQueryType

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

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

Type: string

Default:

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

Enum Values:

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

azureCosmosDBChatExtensionConfiguration

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

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

azureCosmosDBChatExtensionParameters

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

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

azureCosmosDBFieldMappingOptions

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

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

onYourDataAuthenticationOptions

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

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

onYourDataAuthenticationType

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

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

Type: string

Default:

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

Enum Values:

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

onYourDataApiKeyAuthenticationOptions

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

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

onYourDataConnectionStringAuthenticationOptions

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

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

onYourDataSystemAssignedManagedIdentityAuthenticationOptions

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

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

onYourDataUserAssignedManagedIdentityAuthenticationOptions

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

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

onYourDataVectorizationSource

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

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

onYourDataVectorizationSourceType

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

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

Type: string

Default:

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

Enum Values:

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

onYourDataDeploymentNameVectorizationSource

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

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

onYourDataEndpointVectorizationSource

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

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

azureChatExtensionsMessageContext

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

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

citation

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

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

chatCompletionMessageToolCall

Name	Type	Description	Required	Default
id	string	Идентификатор вызова средства.	Yes
type	toolCallType	Тип вызова средства в данном случае function.	Yes
function	object	Функция, вызываемая моделью.	Yes

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

name

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

arguments

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

toolCallType

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

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

Type: string

Default:

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

Enum Values:

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

chatCompletionRequestMessageTool

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

chatCompletionRequestMessageFunction

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

createChatCompletionResponse

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

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

createChatCompletionStreamResponse

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

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

chatCompletionStreamResponseDelta

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

Name	Type	Description	Required	Default
content	string	Содержимое сообщения блока.	No
function_call	object	Устаревшие и замененные tool_calls. Имя и аргументы вызываемой функции, созданной моделью.	No
tool_calls	array		No
role	enum	Роль автора этого сообщения. Возможные значения: система, пользователь, помощник, инструмент	No
refusal	string	Сообщение об отказе, созданное моделью.	No

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

arguments

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

name

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

chatCompletionMessageToolCallChunk

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

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

name

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

arguments

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

chatCompletionStreamOptions

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

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

chatCompletionChoiceLogProbs

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

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

chatCompletionTokenLogprob

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

chatCompletionResponseMessage

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

Name	Type	Description	Required	Default
role	chatCompletionResponseMessageRole	Роль автора сообщения ответа.	Yes
refusal	string	Сообщение об отказе, созданное моделью.	Yes
content	string	Содержимое сообщения.	Yes
tool_calls	array	Вызовы средства, созданные моделью, например вызовы функций.	No
function_call	chatCompletionFunctionCall	Устаревшие и замененные tool_calls. Имя и аргументы вызываемой функции, созданной моделью.	No
context	azureChatExtensionsMessageContext	Представление дополнительных сведений о контексте, доступных при Azure расширениях чата OpenAI в создании соответствующего ответа на завершение чата. Эти сведения о контексте заполняются только в том случае, если с помощью запроса OpenAI Azure, настроенного для использования соответствующего расширения.	No

chatCompletionResponseMessageRole

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

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

Type: string

Default:

Enum Values:

• assistant

chatCompletionToolChoiceOption

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

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

chatCompletionNamedToolChoice

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

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

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

name

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

ParallelToolCalls

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

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

chatCompletionMessageToolCalls

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

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

chatCompletionFunctionCall

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

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

completionUsage

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

Name	Type	Description	Required	Default
prompt_tokens	integer	Количество маркеров в запросе.	Yes
completion_tokens	integer	Количество маркеров в созданном завершении.	Yes
total_tokens	integer	Общее количество маркеров, используемых в запросе (запрос + завершение).	Yes
completion_tokens_details	object	Разбивка маркеров, используемых в завершении.	No

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

reasoning_tokens

Name	Type	Description	Default
reasoning_tokens	integer	Маркеры, созданные моделью для рассуждений.

chatCompletionTool

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

FunctionParameters

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

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

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

FunctionObject

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

ResponseFormatText

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

ResponseFormatJsonObject

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

ResponseFormatJsonSchemaSchema

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

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

ResponseFormatJsonSchema

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

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

description

Name	Type	Description	Default
description	string	Описание формата ответа, используемого моделью для определения того, как реагировать в формате.

name

Name	Type	Description	Default
name	string	Имя формата ответа. Должен быть a-z, A-Z, 0-9 или содержать символы подчеркивания и дефисы с максимальной длиной 64.

schema

Name	Type	Description	Default
schema	ResponseFormatJsonSchemaSchema	Схема формата ответа, описанная как объект схемы JSON.

strict

Name	Type	Description	Default
strict	boolean	Следует ли включить строгое соблюдение схемы при создании выходных данных. Если задано значение true, модель всегда будет соответствовать точной схеме, определенной schema в поле. При этом strictподдерживается true только подмножество схемы JSON.	False

chatCompletionChoiceCommon

Name	Type	Description	Required	Default
index	integer		No
finish_reason	string		No

createTranslationRequest

Translation request.

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

audioResponse

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

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

audioVerboseResponse

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

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

audioResponseFormat

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

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

Type: string

Default:

Enum Values:

• json
• text
• srt
• verbose_json
• vtt

createTranscriptionRequest

Transcription request.

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

audioSegment

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

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

imageQuality

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

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

Type: string

Default: standard

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

Enum Values:

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

imagesResponseFormat

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

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

Type: string

Default: url

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

Enum Values:

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

imageSize

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

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

Type: string

Default: 1024x1024

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

Enum Values:

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

imageStyle

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

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

Type: string

Default: vivid

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

Enum Values:

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

imageGenerationsRequest

Name	Type	Description	Required	Default
prompt	string	Текстовое описание требуемых изображений. Максимальная длина — 4000 символов.	Yes
n	integer	Количество генерируемых изображений.	No	1
size	imageSize	Размер созданных изображений.	No	1024x1024
response_format	imagesResponseFormat	Формат, в котором возвращаются созданные изображения.	No	url
user	string	Уникальный идентификатор, представляющий конечного пользователя, который может помочь в мониторинге и обнаружении злоупотреблений.	No
quality	imageQuality	Качество создаваемого изображения.	No	standard
style	imageStyle	Стиль созданных изображений.	No	vivid

generateImagesResponse

Name	Type	Description	Required	Default
created	integer	Метка времени unix при создании операции.	Yes
data	array	Результат операции при успешном выполнении	Yes

imageResult

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

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

Completions extensions

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

Chatmessage

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

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

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

Next steps

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