Справочник по REST Предварительная версия API службы Azure OpenAI

Статья
10/16/2024

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

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

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

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

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

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

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

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

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

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

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

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

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

В остальной части статьи рассматривается последняя предварительная версия спецификации 2024-10-01-previewвывода плоскости данных Azure OpenAI. В этой статье содержится документация для последних возможностей предварительной версии, таких как помощники, потоки и векторные хранилища.

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

Завершение — создание

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

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

Параметры URI

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

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

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

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

Content-Type: application/json

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
prompt	строка или массив	Запросы для создания завершений, закодированных в виде строки, массива строк, массива маркеров или массива массивов маркеров. Обратите внимание, что <\|endoftext\|> — это разделитель документов, который модель видит во время обучения, поэтому если запрос не указан, модель будет создаваться как будто с начала нового документа.	Да
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	объект	Изменяет вероятность появления указанных маркеров в завершении. Принимает объект JSON, который сопоставляет маркеры (указанные идентификатором маркера в маркеризаторе GPT) с соответствующим значением предвзятости от -100 до 100. С математической точки зрения смещение добавляется к логитам, созданным моделью до выборки. Точный эффект зависит от модели, но значения от –1 до 1 должны уменьшать или увеличивать вероятность выбора; такие значения, как –100 или 100, должны приводить к запрету или эксклюзивному выбору соответствующего маркера. Например, можно передать `{"50256": -100}` маркер \|endoftext\|> для предотвращения <создания маркера \|endoftext.	No	нет
logprobs	integer	Включите вероятности журнала в `logprobs` наиболее вероятные выходные маркеры, а также выбранные маркеры. Например, если `logprobs` значение равно 5, API вернет список из пяти наиболее вероятных маркеров. API всегда возвращает `logprob` пример маркера, поэтому в ответе может быть до `logprobs+1` элементов. Максимальное значение `logprobs` для 5.	No	нет
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
потоковая передача	boolean	Потоковая передача частичного хода выполнения. Если задано, маркеры будут отправляться как события, отправленные сервером только для данных, как они становятся доступными, с потоком`data: [DONE]`, завершаемым сообщением.	No	False
suffix	строка	Суффикс, который приходит после завершения вставленного текста. Этот параметр поддерживается только для `gpt-3.5-turbo-instruct`.	No	нет
Температура	number	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным. Как правило, мы рекомендуем изменить это или `top_p` не оба.	No	1
top_p	number	Альтернативой выборке с температурой является так называемая выборка ядра, где модель рассматривает результаты маркеров с top_p всего массива значений вероятности. Таким образом, 0,1 означает, что учитываются только маркеры, входящие в верхние 10% массива значений вероятности. Как правило, мы рекомендуем изменить это или `temperature` не оба.	No	1
Пользователь	строка	Уникальный идентификатор, представляющий конечного пользователя, который может помочь в мониторинге и обнаружении злоупотреблений.	No

Отклики

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

Описание: ОК

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

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

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

Content-Type	Тип	Description
application/json	errorResponse

Примеры

Пример

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

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

{
 "prompt": [
  "tell me a joke about mango"
 ],
 "max_tokens": 32,
 "temperature": 1.0,
 "n": 1
}

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

{
  "body": {
    "id": "cmpl-7QmVI15qgYVllxK0FtxVGG6ywfzaq",
    "created": 1686617332,
    "choices": [
      {
        "text": "es\n\nWhat do you call a mango who's in charge?\n\nThe head mango.",
        "index": 0,
        "finish_reason": "stop",
        "logprobs": null
      }
    ],
    "usage": {
      "completion_tokens": 20,
      "prompt_tokens": 6,
      "total_tokens": 26
    }
  }
}

Внедрение — создание

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

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

Параметры URI

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

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

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

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

Content-Type: application/json

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

Отклики

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

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

prompt_tokens

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

total_tokens

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

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

Описание: ОК

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

Примеры

Пример

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

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

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

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

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

Завершение чата — создание

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

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

Параметры URI

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

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

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

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

Content-Type: application/json

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
Температура	number	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным. Как правило, мы рекомендуем изменить это или `top_p` не оба.	No	1
top_p	number	Альтернативой выборке с температурой является так называемая выборка ядра, где модель рассматривает результаты маркеров с top_p всего массива значений вероятности. Таким образом, 0,1 означает, что учитываются только маркеры, входящие в верхние 10% массива значений вероятности. Как правило, мы рекомендуем изменить это или `temperature` не оба.	No	1
потоковая передача	boolean	Если задано, будут отправляться частичные разностные сообщения, например в ChatGPT. Маркеры будут отправляться как события, отправленные сервером только для данных, как они становятся доступными, при этом поток завершается сообщением`data: [DONE]`.	No	False
stop	строка или массив	До четырех последовательностей, в которых API перестанет создавать дополнительные маркеры.	No
max_tokens	integer	Максимальное количество маркеров, которые можно создать в завершении чата. Общая длина входных маркеров и созданных маркеров ограничена длиной контекста модели.	No
max_completion_tokens	integer	Верхняя граница для числа маркеров, которые можно создать для завершения, включая видимые выходные маркеры и маркеры причин. Это поддерживается только в моделях серии o1. Расширит поддержку других моделей в будущем выпуске API.	No
presence_penalty	number	Значение в диапазоне от –2.0 до 2.0. Положительные значения выбраковывают новые маркеры в зависимости от того, отображаются ли они в тексте на данный момент, увеличивая вероятность обсуждений на новые темы.	No	0
frequency_penalty	number	Значение в диапазоне от –2.0 до 2.0. Положительные значения выбраковывают новые маркеры в зависимости от существующей частоты в тексте на данный момент, уменьшая вероятность повторения той же буквальной строки.	No	0
logit_bias	объект	Изменяет вероятность появления указанных маркеров в завершении. Принимает объект JSON, который сопоставляет маркеры (указанные идентификатором маркера в токенизаторе) со связанным значением предвзятости от -100 до 100. С математической точки зрения смещение добавляется к логитам, созданным моделью до выборки. Точный эффект зависит от модели, но значения от –1 до 1 должны уменьшать или увеличивать вероятность выбора; такие значения, как –100 или 100, должны приводить к запрету или эксклюзивному выбору соответствующего маркера.	No	нет
Пользователь	строка	Уникальный идентификатор, представляющий конечного пользователя, который может помочь в мониторинге и обнаружении злоупотреблений.	No
messages	array	Список сообщений, составляющих беседу до сих пор.	Да
data_sources	array	Записи конфигурации для расширений чата Azure OpenAI, которые используют их. Эта дополнительная спецификация совместима только с Azure OpenAI.	No
logprobs	boolean	Следует ли возвращать вероятности журналов выходных маркеров или нет. Если значение true, возвращает вероятности журнала каждого выходного маркера, возвращаемого в параметре `content` `message`.	No	False
top_logprobs	integer	Целое число от 0 до 20, указывающее число наиболее вероятных маркеров, возвращаемых по каждой позиции маркера, каждый из которых имеет связанную вероятность журнала. `logprobs` Необходимо задать значение `true` , если этот параметр используется.	No
n	integer	Сколько вариантов завершения чата для каждого входного сообщения. Обратите внимание, что плата будет взиматься на основе количества созданных маркеров во всех вариантах. Имейте в виду `n` , чтобы `1` свести к минимуму затраты.	No	1
parallel_tool_calls	ParallelToolCalls	Следует ли включить параллельные вызовы функций во время использования средства.	No	Истина
response_format	ResponseFormatText или ResponseFormatJsonObject или ResponseFormatJsonSchema	Объект, указывающий формат, который должен выводить модель. Совместим с GPT-4o, GPT-4o mini, GPT-4 Turbo и всеми моделями GPT-3.5 Turbo, чем `gpt-3.5-turbo-1106`более новые. Параметр для `{ "type": "json_schema", "json_schema": {...} }` включения структурированных выходных данных, гарантирующих, что модель будет соответствовать предоставленной схеме JSON. Параметр включения `{ "type": "json_object" }` режима JSON, который гарантирует, что модель создает сообщение является допустимым JSON. Важно: при использовании режима JSON необходимо также указать модели создавать JSON самостоятельно с помощью системного или пользовательского сообщения. Без этого модель может создать неуправляемый поток пробелов до тех пор, пока поколение не достигнет предела маркера, в результате чего длительный и, казалось бы, "застрявший" запрос. Кроме того, обратите внимание, что содержимое сообщения может быть частично отрезано, если `finish_reason="length"`, что указывает на превышение поколения `max_tokens` или беседа превысила максимальную длину контекста.	No
seed	integer	Эта функция доступна в бета-версии. Если задано, наша система будет предпринять лучшие усилия для выборки детерминированного, таким образом, что повторяющиеся запросы с одинаковыми и теми же параметрами должны возвращать тот же `seed` результат. Детерминированность не гарантируется, и вы должны ссылаться на `system_fingerprint` параметр ответа для отслеживания изменений в серверной части.	No
stream_options	chatCompletionStreamOptions	Параметры потокового ответа. Этот параметр устанавливается только при установке `stream: true`.	No	нет
средства	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

Отклики

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

Описание: ОК

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

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

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

Content-Type	Тип	Description
application/json	errorResponse

Примеры

Пример

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

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

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

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

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye\u00e2\u20ac\u2122ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' \u00e2\u20ac\u2122bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!"
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Пример

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

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

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_search",
   "parameters": {
    "endpoint": "https://your-search-endpoint.search.windows.net/",
    "index_name": "{index name}",
    "authentication": {
     "type": "system_assigned_managed_identity"
    }
   }
  }
 ]
}

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

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Пример

Создает завершение на основе векторных данных изображения поиска Azure.

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

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_search",
   "parameters": {
    "endpoint": "https://your-search-endpoint.search.windows.net/",
    "index_name": "{index name}",
    "query_type": "vector",
    "fields_mapping": {
     "image_vector_fields": [
      "image_vector"
     ]
    },
    "authentication": {
     "type": "api_key",
     "key": "{api key}"
    }
   }
  }
 ]
}

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

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion."
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Пример

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

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

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a cat?"
  },
  {
   "role": "assistant",
   "content": "Content of the completion [doc1].",
   "context": {
    "intent": "cat care"
   }
  },
  {
   "role": "user",
   "content": "how about dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_search",
   "parameters": {
    "endpoint": "https://your-search-endpoint.search.windows.net/",
    "authentication": {
     "type": "user_assigned_managed_identity",
     "managed_identity_resource_id": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resource-name}"
    },
    "index_name": "{index name}",
    "query_type": "vector",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "in_scope": true,
    "top_n_documents": 5,
    "strictness": 3,
    "role_information": "You are an AI assistant that helps people find information.",
    "fields_mapping": {
     "content_fields_separator": "\\n",
     "content_fields": [
      "content"
     ],
     "filepath_field": "filepath",
     "title_field": "title",
     "url_field": "url",
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

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

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content 2.",
                "title": "Citation Title 2",
                "filepath": "contoso2.txt",
                "url": "https://contoso.blob.windows.net/container/contoso2.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Пример

Создает завершение для предоставленного Azure Cosmos DB.

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

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_cosmos_db",
   "parameters": {
    "authentication": {
     "type": "connection_string",
     "connection_string": "mongodb+srv://rawantest:{password}$@{cluster-name}.mongocluster.cosmos.azure.com/?tls=true&authMechanism=SCRAM-SHA-256&retrywrites=false&maxIdleTimeMS=120000"
    },
    "database_name": "vectordb",
    "container_name": "azuredocs",
    "index_name": "azuredocindex",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "fields_mapping": {
     "content_fields": [
      "content"
     ],
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

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

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Пример

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

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

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "mongo_db",
   "parameters": {
    "authentication": {
     "type": "username_and_password",
     "username": "<username>",
     "password": "<password>"
    },
    "endpoint": "<endpoint_name>",
    "app_name": "<application name>",
    "database_name": "sampledb",
    "collection_name": "samplecollection",
    "index_name": "sampleindex",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "fields_mapping": {
     "content_fields": [
      "content"
     ],
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

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

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Пример

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

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

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "elasticsearch",
   "parameters": {
    "endpoint": "https://your-elasticsearch-endpoint.eastus.azurecontainer.io",
    "index_name": "{index name}",
    "authentication": {
     "type": "key_and_key_id",
     "key": "{key}",
     "key_id": "{key id}"
    }
   }
  }
 ]
}

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

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Пример

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

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

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "pinecone",
   "parameters": {
    "authentication": {
     "type": "api_key",
     "key": "{api key}"
    },
    "environment": "{environment name}",
    "index_name": "{index name}",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "fields_mapping": {
     "title_field": "title",
     "url_field": "url",
     "filepath_field": "filepath",
     "content_fields": [
      "content"
     ],
     "content_fields_separator": "\n"
    }
   }
  }
 ]
}

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

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

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

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

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

Параметры URI

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

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

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

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

Content-Type: multipart/form-data

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

Отклики

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

Описание: ОК

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

Примеры

Пример

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

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

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

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

Пример

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

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

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

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

{
  "type": "string",
  "example": "plain text when requesting text, srt, or vtt"
}

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

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

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

Параметры URI

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

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

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

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

Content-Type: multipart/form-data

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

Отклики

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

Описание: ОК

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

Примеры

Пример

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

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

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

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

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

Пример

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

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

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

{
  "type": "string",
  "example": "plain text when requesting text, srt, or vtt"
}

Речь — создание

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/speech?api-version=2024-10-01-preview

Создает звук из входного текста.

Параметры URI

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

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

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

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

Content-Type: multipart/form-data

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
Входные данные	строка	Текст для синтеза звука. Максимальная длина — 4096 символов.	Да
voice	перечисление	Голос, используемый для синтеза речи. Возможные значения: сплав, эхо, fable, onyx, nova, мерцание	Да
response_format	перечисление	Формат синтеза звука в. Возможные значения: mp3, opus, aac, flac, wav, pcm	No
скорость	number	Скорость синтезированного звука. Выберите значение из `0.25` `4.0`. Значение по умолчанию — `1.0`.	No	1.0

Отклики

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

Описание: ОК

Content-Type	Тип	Description
application/octet-stream	строка

Примеры

Пример

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

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/speech?api-version=2024-10-01-preview

{
 "input": "Hi! What are you going to make?",
 "voice": "fable",
 "response_format": "mp3"
}

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

{
  "body": "101010101"
}

Поколения изображений — создание

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

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

Параметры URI

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

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

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

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

Content-Type: application/json

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

Отклики

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

Описание: ОК

Content-Type	Тип	Description
application/json	generateImagesResponse

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

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

Content-Type	Тип	Description
application/json	dalleErrorResponse

Примеры

Пример

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

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

{
 "prompt": "In the style of WordArt, Microsoft Clippy wearing a cowboy hat.",
 "n": 1,
 "style": "natural",
 "quality": "standard"
}

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

{
  "body": {
    "created": 1698342300,
    "data": [
      {
        "revised_prompt": "A vivid, natural representation of Microsoft Clippy wearing a cowboy hat.",
        "prompt_filter_results": {
          "sexual": {
            "severity": "safe",
            "filtered": false
          },
          "violence": {
            "severity": "safe",
            "filtered": false
          },
          "hate": {
            "severity": "safe",
            "filtered": false
          },
          "self_harm": {
            "severity": "safe",
            "filtered": false
          },
          "profanity": {
            "detected": false,
            "filtered": false
          },
          "custom_blocklists": {
            "filtered": false,
            "details": []
          }
        },
        "url": "https://dalletipusw2.blob.core.windows.net/private/images/e5451cc6-b1ad-4747-bd46-b89a3a3b8bc3/generated_00.png?se=2023-10-27T17%3A45%3A09Z&...",
        "content_filter_results": {
          "sexual": {
            "severity": "safe",
            "filtered": false
          },
          "violence": {
            "severity": "safe",
            "filtered": false
          },
          "hate": {
            "severity": "safe",
            "filtered": false
          },
          "self_harm": {
            "severity": "safe",
            "filtered": false
          }
        }
      }
    ]
  }
}

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

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

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

Параметры URI

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

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

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

Отклики

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

Описание: ОК

Content-Type	Тип	Description
application/json	listAssistantsResponse

Примеры

Пример

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

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

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

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "asst_abc123",
        "object": "assistant",
        "created_at": 1707257477,
        "name": "Stock Analyst",
        "description": null,
        "model": "gpt-4-1106-preview",
        "instructions": "You are a financial analyst that analyzes stock market prices and other financial data present on user uploaded files or by calling external APIs.",
        "tools": [
          {
            "type": "code_interpreter"
          }
        ],
        "tool_resources": {},
        "metadata": {},
        "top_p": 1.0,
        "temperature": 1.0,
        "response_format": "auto"
      },
      {
        "id": "asst_abc456",
        "object": "assistant",
        "created_at": 1698982718,
        "name": "My Assistant",
        "description": null,
        "model": "gpt-4-turbo",
        "instructions": "You are a helpful assistant designed to make me better at coding!",
        "tools": [],
        "tool_resources": {},
        "metadata": {},
        "top_p": 1.0,
        "temperature": 1.0,
        "response_format": "auto"
      },
      {
        "id": "asst_abc789",
        "object": "assistant",
        "created_at": 1698982643,
        "name": null,
        "description": null,
        "model": "gpt-4-turbo",
        "instructions": null,
        "tools": [],
        "tool_resources": {},
        "metadata": {},
        "top_p": 1.0,
        "temperature": 1.0,
        "response_format": "auto"
      }
    ],
    "first_id": "asst_abc123",
    "last_id": "asst_abc789",
    "has_more": false
  }
}

Создание — помощник

POST https://{endpoint}/openai/assistants?api-version=2024-10-01-preview

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

Параметры URI

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

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

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

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

Content-Type: application/json

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
модель			Да
имя	строка	Имя помощника. Максимальная длина составляет 256 символов.	No
описание	строка	Описание помощника. Максимальная длина — 512 символов.	No
инструкции	строка	Системные инструкции, которые использует помощник. Максимальная длина — 256 000 символов.	No
средства	array	Список инструментов, включенных помощником. На помощника может быть не более 128 инструментов. Средства могут быть типами `code_interpreter`, `retrieval`или `function`.	No	[]
tool_resources	объект	Набор ресурсов, используемых средствами помощника. Ресурсы относятся к типу инструмента. Например, для `code_interpreter` средства требуется список идентификаторов файлов, а для `file_search` этого средства требуется список идентификаторов векторного хранилища.	No
metadata	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.	No
Температура	number	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным.	No	1
top_p	number	Альтернативой выборке с температурой является так называемая выборка ядра, где модель рассматривает результаты маркеров с top_p всего массива значений вероятности. Таким образом, 0,1 означает, что учитываются только маркеры, входящие в верхние 10% массива значений вероятности. Как правило, мы рекомендуем изменить либо это значение, либо температуру, но не оба.	No	1
response_format	assistantsApiResponseFormatOption	Указывает формат, который модель должна выводить. Совместим с GPT-4 Turbo и всеми моделями GPT-3.5 Turbo с тех пор `gpt-3.5-turbo-1106`. Параметр включения `{ "type": "json_object" }` режима JSON, который гарантирует, что модель создает сообщение является допустимым JSON. Важно: при использовании режима JSON необходимо также указать модели создавать JSON самостоятельно с помощью системного или пользовательского сообщения. Без этого модель может создать неуправляемый поток пробелов до тех пор, пока поколение не достигнет предела маркера, в результате чего длительный и, казалось бы, "застрявший" запрос. Кроме того, обратите внимание, что содержимое сообщения может быть частично отрезано, если `finish_reason="length"`, что указывает на превышение поколения `max_tokens` или беседа превысила максимальную длину контекста.	No

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

code_interpreter

Имя.	Тип	Описание	По умолч.
file_ids	array	Список идентификаторов файлов, доступных средству `code_interpreter` . С инструментом может быть не более 20 файлов.	[]

file_search

Имя.	Тип	Описание	По умолч.
vector_store_ids	array	Хранилище векторов, присоединенное к этому помощнику. К помощнику может быть подключено не более одного векторного хранилища.
vector_stores	array	Помощник по созданию векторного хранилища с file_ids и присоединению его к этому помощнику. К помощнику может быть подключено не более одного векторного хранилища.

Отклики

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

Описание: ОК

Content-Type	Тип	Description
application/json	assistantObject	Представляет объект `assistant` , который может вызывать модель и использовать средства.

Примеры

Пример

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

POST https://{endpoint}/openai/assistants?api-version=2024-10-01-preview

{
 "name": "Math Tutor",
 "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.",
 "tools": [
  {
   "type": "code_interpreter"
  }
 ],
 "model": "gpt-4-1106-preview"
}

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

{
  "body": {
    "id": "asst_4nsG2qgNzimRPE7MazXTXbU7",
    "object": "assistant",
    "created_at": 1707295707,
    "name": "Math Tutor",
    "description": null,
    "model": "gpt-4-1106-preview",
    "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.",
    "tools": [
      {
        "type": "code_interpreter"
      }
    ],
    "metadata": {},
    "top_p": 1.0,
    "temperature": 1.0,
    "response_format": "auto"
  }
}

Get - Assistant

GET https://{endpoint}/openai/assistants/{assistant_id}?api-version=2024-10-01-preview

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

Параметры URI

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

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

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

Отклики

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

Описание: ОК

Content-Type	Тип	Description
application/json	assistantObject	Представляет объект `assistant` , который может вызывать модель и использовать средства.

Примеры

Пример

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

GET https://{endpoint}/openai/assistants/{assistant_id}?api-version=2024-10-01-preview

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

{
  "body": {
    "id": "asst_abc123",
    "object": "assistant",
    "created_at": 1699009709,
    "name": "HR Helper",
    "description": null,
    "model": "gpt-4-turbo",
    "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies.",
    "tools": [
      {
        "type": "file_search"
      }
    ],
    "metadata": {},
    "top_p": 1.0,
    "temperature": 1.0,
    "response_format": "auto"
  }
}

Изменение — помощник

POST https://{endpoint}/openai/assistants/{assistant_id}?api-version=2024-10-01-preview

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

Параметры URI

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

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

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

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

Content-Type: application/json

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
модель			No
name	строка	Имя помощника. Максимальная длина составляет 256 символов.	No
описание	строка	Описание помощника. Максимальная длина — 512 символов.	No
инструкции	строка	Системные инструкции, которые использует помощник. Максимальная длина — 32 768 символов.	No
средства	array	Список инструментов, включенных помощником. На помощника может быть не более 128 инструментов. Средства могут быть типами `code_interpreter`, `retrieval`или `function`.	No	[]
tool_resources	объект	Набор ресурсов, используемых средствами помощника. Ресурсы относятся к типу инструмента. Например, для `code_interpreter` средства требуется список идентификаторов файлов, а для `file_search` этого средства требуется список идентификаторов векторного хранилища.	No
metadata	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.	No
Температура	number	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным.	No	1
top_p	number	Альтернативой выборке с температурой является так называемая выборка ядра, где модель рассматривает результаты маркеров с top_p всего массива значений вероятности. Таким образом, 0,1 означает, что учитываются только маркеры, входящие в верхние 10% массива значений вероятности. Как правило, мы рекомендуем изменить либо это значение, либо температуру, но не оба.	No	1
response_format	assistantsApiResponseFormatOption	Указывает формат, который модель должна выводить. Совместим с GPT-4 Turbo и всеми моделями GPT-3.5 Turbo с тех пор `gpt-3.5-turbo-1106`. Параметр включения `{ "type": "json_object" }` режима JSON, который гарантирует, что модель создает сообщение является допустимым JSON. Важно: при использовании режима JSON необходимо также указать модели создавать JSON самостоятельно с помощью системного или пользовательского сообщения. Без этого модель может создать неуправляемый поток пробелов до тех пор, пока поколение не достигнет предела маркера, в результате чего длительный и, казалось бы, "застрявший" запрос. Кроме того, обратите внимание, что содержимое сообщения может быть частично отрезано, если `finish_reason="length"`, что указывает на превышение поколения `max_tokens` или беседа превысила максимальную длину контекста.	No

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

code_interpreter

Имя.	Тип	Описание	По умолч.
file_ids	array	Переопределяет список идентификаторов файлов, доступных средству `code_interpreter` . С инструментом может быть не более 20 файлов.	[]

file_search

Имя.	Тип	Описание	По умолч.
vector_store_ids	array	Переопределяет хранилище векторов, подключенное к этому помощнику. К помощнику может быть подключено не более одного векторного хранилища.

Отклики

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

Описание: ОК

Content-Type	Тип	Description
application/json	assistantObject	Представляет объект `assistant` , который может вызывать модель и использовать средства.

Примеры

Пример

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

POST https://{endpoint}/openai/assistants/{assistant_id}?api-version=2024-10-01-preview

{
 "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.",
 "tools": [
  {
   "type": "file_search"
  }
 ],
 "model": "gpt-4-turbo"
}

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

{
  "body": {
    "id": "asst_123",
    "object": "assistant",
    "created_at": 1699009709,
    "name": "HR Helper",
    "description": null,
    "model": "gpt-4-turbo",
    "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.",
    "tools": [
      {
        "type": "file_search"
      }
    ],
    "tool_resources": {
      "file_search": {
        "vector_store_ids": []
      }
    },
    "metadata": {},
    "top_p": 1.0,
    "temperature": 1.0,
    "response_format": "auto"
  }
}

Delete — Помощник

DELETE https://{endpoint}/openai/assistants/{assistant_id}?api-version=2024-10-01-preview

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

Параметры URI

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

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

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

Отклики

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

Описание: ОК

Content-Type	Тип	Description
application/json	deleteAssistantResponse

Примеры

Пример

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

DELETE https://{endpoint}/openai/assistants/{assistant_id}?api-version=2024-10-01-preview

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

{
  "body": {
    "id": "asst_4nsG2qgNzimRPE7MazXTXbU7",
    "object": "assistant.deleted",
    "deleted": true
  }
}

Create — Thread

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

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

Параметры URI

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

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

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

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

Content-Type: application/json

Имя.	Тип	Описание	Обязательное поле
messages	array	Список сообщений для запуска потока.	No
tool_resources	объект	Набор ресурсов, доступных средствам помощника в этом потоке. Ресурсы относятся к типу инструмента. Например, для `code_interpreter` средства требуется список идентификаторов файлов, а для `file_search` этого средства требуется список идентификаторов векторного хранилища.	No
metadata	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.	No

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

code_interpreter

Имя.	Тип	Описание	По умолч.
file_ids	array	Список идентификаторов файлов, доступных средству `code_interpreter` . С инструментом может быть не более 20 файлов.	[]

file_search

Имя.	Тип	Описание	По умолч.
vector_store_ids	array	Хранилище векторов, присоединенное к этому потоку. К потоку может быть подключено не более 1 векторного хранилища.
vector_stores	array	Вспомогательный объект для создания хранилища векторов с file_ids и присоединения его к этому потоку. К потоку может быть подключено не более одного векторного хранилища.

Отклики

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

Описание: ОК

Content-Type	Тип	Description
application/json	threadObject	Представляет поток, содержащий сообщения.

Примеры

Пример

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

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

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

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread",
    "created_at": 1707297136,
    "metadata": {}
  }
}

Get - Thread

GET https://{endpoint}/openai/threads/{thread_id}?api-version=2024-10-01-preview

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

Параметры URI

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

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

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

Отклики

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

Описание: ОК

Content-Type	Тип	Description
application/json	threadObject	Представляет поток, содержащий сообщения.

Примеры

Пример

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

GET https://{endpoint}/openai/threads/{thread_id}?api-version=2024-10-01-preview

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

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread",
    "created_at": 1707297136,
    "metadata": {},
    "tool_resources": {
      "code_interpreter": {
        "file_ids": []
      }
    }
  }
}

Изменение — поток

POST https://{endpoint}/openai/threads/{thread_id}?api-version=2024-10-01-preview

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

Параметры URI

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

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

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

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

Content-Type: application/json

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

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

code_interpreter

Имя.	Тип	Описание	По умолч.
file_ids	array	Список идентификаторов файлов, доступных средству `code_interpreter` . С инструментом может быть не более 20 файлов.	[]

file_search

Имя.	Тип	Описание	По умолч.
vector_store_ids	array	Хранилище векторов, присоединенное к этому потоку. К потоку может быть подключено не более одного векторного хранилища.

Отклики

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

Описание: ОК

Content-Type	Тип	Description
application/json	threadObject	Представляет поток, содержащий сообщения.

Примеры

Пример

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

POST https://{endpoint}/openai/threads/{thread_id}?api-version=2024-10-01-preview

{
 "metadata": {
  "modified": "true",
  "user": "abc123"
 }
}

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

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread",
    "created_at": 1707297136,
    "metadata": {
      "modified": "true",
      "user": "abc123"
    },
    "tool_resources": {}
  }
}

Delete — Thread

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

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

Параметры URI

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

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

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

Отклики

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

Описание: ОК

Content-Type	Тип	Description
application/json	deleteThreadResponse

Примеры

Пример

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

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

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

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

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

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

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

Параметры URI

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

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

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

Отклики

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

Описание: ОК

Content-Type	Тип	Description
application/json	listMessagesResponse

Примеры

Пример

Вывод списка сообщений

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

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

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "msg_abc123",
        "object": "thread.message",
        "created_at": 1699016383,
        "assistant_id": null,
        "thread_id": "thread_abc123",
        "run_id": null,
        "role": "user",
        "content": [
          {
            "type": "text",
            "text": {
              "value": "How does AI work? Explain it in simple terms.",
              "annotations": []
            }
          }
        ],
        "attachments": [],
        "metadata": {}
      },
      {
        "id": "msg_abc456",
        "object": "thread.message",
        "created_at": 1699016383,
        "assistant_id": null,
        "thread_id": "thread_abc123",
        "run_id": null,
        "role": "user",
        "content": [
          {
            "type": "text",
            "text": {
              "value": "Hello, what is AI?",
              "annotations": []
            }
          }
        ],
        "attachments": [],
        "metadata": {}
      }
    ],
    "first_id": "msg_abc123",
    "last_id": "msg_abc456",
    "has_more": false
  }
}

Создание — сообщение

POST https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2024-10-01-preview

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

Параметры URI

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

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

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

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

Content-Type: application/json

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

Отклики

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

Описание: ОК

Content-Type	Тип	Description
application/json	messageObject	Представляет сообщение в потоке.

Примеры

Пример

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

POST https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2024-10-01-preview

{
 "role": "user",
 "content": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces."
}

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

{
  "body": {
    "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4",
    "object": "thread.message",
    "created_at": 1707298421,
    "assistant_id": null,
    "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "run_id": null,
    "role": "user",
    "content": [
      {
        "type": "text",
        "text": {
          "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.",
          "annotations": []
        }
      }
    ],
    "attachments": [],
    "metadata": {}
  }
}

Get - Message

GET https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2024-10-01-preview

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

Параметры URI

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

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

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

Отклики

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

Описание: ОК

Content-Type	Тип	Description
application/json	messageObject	Представляет сообщение в потоке.

Примеры

Пример

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

GET https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2024-10-01-preview

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

{
  "body": {
    "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4",
    "object": "thread.message",
    "created_at": 1707298421,
    "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "role": "user",
    "content": [
      {
        "type": "text",
        "text": {
          "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.",
          "annotations": []
        }
      }
    ],
    "file_ids": [],
    "assistant_id": null,
    "run_id": null,
    "metadata": {}
  }
}

Изменение — сообщение

POST https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2024-10-01-preview

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

Параметры URI

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

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

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

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

Content-Type: application/json

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

Отклики

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

Описание: ОК

Content-Type	Тип	Description
application/json	messageObject	Представляет сообщение в потоке.

Примеры

Пример

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

POST https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2024-10-01-preview

{
 "metadata": {
  "modified": "true",
  "user": "abc123"
 }
}

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

{
  "body": {
    "id": "msg_abc123",
    "object": "thread.message",
    "created_at": 1699017614,
    "assistant_id": null,
    "thread_id": "thread_abc123",
    "run_id": null,
    "role": "user",
    "content": [
      {
        "type": "text",
        "text": {
          "value": "How does AI work? Explain it in simple terms.",
          "annotations": []
        }
      }
    ],
    "file_ids": [],
    "metadata": {
      "modified": "true",
      "user": "abc123"
    }
  }
}

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

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

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

Параметры URI

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

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

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

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

Content-Type: application/json

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
assistant_id	строка	Идентификатор помощника, используемого для выполнения этого выполнения.	Да
среды	createThreadRequest		No
модель	строка	Имя развертывания модели, используемой для выполнения этого запуска. Если здесь указано значение, оно переопределит модель, связанную с помощником. В противном случае будет использоваться модель, связанная с помощником.	No
инструкции	строка	Переопределите системное сообщение помощника по умолчанию. Это полезно для изменения поведения на основе каждого запуска.	No
средства	array	Переопределите средства, которые помощник может использовать для этого запуска. Это полезно для изменения поведения на основе каждого запуска.	No
tool_resources	объект	Набор ресурсов, используемых средствами помощника. Ресурсы относятся к типу инструмента. Например, для `code_interpreter` средства требуется список идентификаторов файлов, а для `file_search` этого средства требуется список идентификаторов векторного хранилища.	No
metadata	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.	No
Температура	number	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным.	No	1
top_p	number	Альтернативой выборке с температурой является так называемая выборка ядра, где модель рассматривает результаты маркеров с top_p всего массива значений вероятности. Таким образом, 0,1 означает, что учитываются только маркеры, входящие в верхние 10% массива значений вероятности. Как правило, мы рекомендуем изменить либо это значение, либо температуру, но не оба.	No	1
потоковая передача	boolean	Если `true`возвращает поток событий, которые происходят во время событий запуска от имени сервера, завершая выполнение в состоянии терминала с сообщением `data: [DONE]` .	No
stream_options	chatCompletionStreamOptions	Параметры потокового ответа. Этот параметр устанавливается только при установке `stream: true`.	No	нет
max_prompt_tokens	integer	Максимальное количество маркеров запроса, которые могут использоваться в ходе выполнения. Выполнение сделает все возможное, чтобы использовать только количество маркеров запроса, указанных в нескольких поворотах выполнения. Если выполнение превышает указанное число маркеров запроса, выполнение завершится состоянием `incomplete`. Дополнительные сведения см. в разделе `incomplete_details` .	No
max_completion_tokens	integer	Максимальное количество маркеров завершения, которые могут использоваться в ходе выполнения. Выполнение сделает все возможное, чтобы использовать только количество маркеров завершения, указанных в нескольких поворотах выполнения. Если выполнение превышает указанное число маркеров завершения, выполнение завершится состоянием `incomplete`. Дополнительные сведения см. в разделе `incomplete_details` .	No
truncation_strategy	усечениеObject	Определяет, как поток будет усечен до выполнения. Используйте это для управления начальным окном контекста выполнения.	No
tool_choice	assistantsApiToolChoiceOption	Определяет, какое средство (если таковое) вызывается моделью. `none` означает, что модель не вызывает средства и вместо этого создает сообщение. `auto` является значением по умолчанию и означает, что модель может выбирать между созданием сообщения или вызовом средства. Указание определенного инструмента, например `{"type": "file_search"}` или `{"type": "function", "function": {"name": "my_function"}}` принудительное вызов модели.	No
parallel_tool_calls	ParallelToolCalls	Следует ли включить параллельные вызовы функций во время использования средства.	No	Истина
response_format	assistantsApiResponseFormatOption	Указывает формат, который модель должна выводить. Совместим с GPT-4 Turbo и всеми моделями GPT-3.5 Turbo с тех пор `gpt-3.5-turbo-1106`. Параметр включения `{ "type": "json_object" }` режима JSON, который гарантирует, что модель создает сообщение является допустимым JSON. Важно: при использовании режима JSON необходимо также указать модели создавать JSON самостоятельно с помощью системного или пользовательского сообщения. Без этого модель может создать неуправляемый поток пробелов до тех пор, пока поколение не достигнет предела маркера, в результате чего длительный и, казалось бы, "застрявший" запрос. Кроме того, обратите внимание, что содержимое сообщения может быть частично отрезано, если `finish_reason="length"`, что указывает на превышение поколения `max_tokens` или беседа превысила максимальную длину контекста.	No

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

code_interpreter

Имя.	Тип	Описание	По умолч.
file_ids	array	Список идентификаторов файлов, доступных средству `code_interpreter` . С инструментом может быть не более 20 файлов.	[]

file_search

Имя.	Тип	Описание	По умолч.
vector_store_ids	array	Идентификатор хранилища векторов, присоединенного к этому помощнику. К помощнику может быть подключено не более одного векторного хранилища.

Отклики

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

Описание: ОК

Content-Type	Тип	Description
application/json	runObject	Представляет выполнение в потоке.

Примеры

Пример

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

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

{
 "assistant_id": "asst_abc123",
 "thread": {
  "messages": [
   {
    "role": "user",
    "content": "Explain deep learning to a 5 year old."
   }
  ]
 }
}

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

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699076792,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "queued",
    "started_at": null,
    "expires_at": 1699077392,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": null,
    "required_action": null,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": "You are a helpful assistant.",
    "tools": [],
    "tool_resources": {},
    "metadata": {},
    "temperature": 1.0,
    "top_p": 1.0,
    "max_completion_tokens": null,
    "max_prompt_tokens": null,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "incomplete_details": null,
    "usage": null,
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

Список — запуски

GET https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2024-10-01-preview

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

Параметры URI

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

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

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

Отклики

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

Описание: ОК

Content-Type	Тип	Description
application/json	listRunsResponse

Примеры

Пример

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

GET https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2024-10-01-preview

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

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "run_abc123",
        "object": "thread.run",
        "created_at": 1699075072,
        "assistant_id": "asst_abc123",
        "thread_id": "thread_abc123",
        "status": "completed",
        "started_at": 1699075072,
        "expires_at": null,
        "cancelled_at": null,
        "failed_at": null,
        "completed_at": 1699075073,
        "last_error": null,
        "model": "gpt-4-turbo",
        "instructions": null,
        "incomplete_details": null,
        "tools": [
          {
            "type": "code_interpreter"
          }
        ],
        "tool_resources": {
          "code_interpreter": {
            "file_ids": [
              "file-abc123",
              "file-abc456"
            ]
          }
        },
        "metadata": {},
        "usage": {
          "prompt_tokens": 123,
          "completion_tokens": 456,
          "total_tokens": 579
        },
        "temperature": 1.0,
        "top_p": 1.0,
        "max_prompt_tokens": 1000,
        "max_completion_tokens": 1000,
        "truncation_strategy": {
          "type": "auto",
          "last_messages": null
        },
        "response_format": "auto",
        "tool_choice": "auto"
      },
      {
        "id": "run_abc456",
        "object": "thread.run",
        "created_at": 1699063290,
        "assistant_id": "asst_abc123",
        "thread_id": "thread_abc123",
        "status": "completed",
        "started_at": 1699063290,
        "expires_at": null,
        "cancelled_at": null,
        "failed_at": null,
        "completed_at": 1699063291,
        "last_error": null,
        "model": "gpt-4-turbo",
        "instructions": null,
        "incomplete_details": null,
        "tools": [
          {
            "type": "code_interpreter"
          }
        ],
        "tool_resources": {
          "code_interpreter": {
            "file_ids": [
              "file-abc123",
              "file-abc456"
            ]
          }
        },
        "metadata": {},
        "usage": {
          "prompt_tokens": 123,
          "completion_tokens": 456,
          "total_tokens": 579
        },
        "temperature": 1.0,
        "top_p": 1.0,
        "max_prompt_tokens": 1000,
        "max_completion_tokens": 1000,
        "truncation_strategy": {
          "type": "auto",
          "last_messages": null
        },
        "response_format": "auto",
        "tool_choice": "auto"
      }
    ],
    "first_id": "run_abc123",
    "last_id": "run_abc456",
    "has_more": false
  }
}

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

POST https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2024-10-01-preview

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

Параметры URI

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

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

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

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

Content-Type: application/json

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
assistant_id	строка	Идентификатор помощника, используемого для выполнения этого выполнения.	Да
модель	строка	Идентификатор модели, используемой для выполнения этого выполнения. Если здесь указано значение, оно переопределит модель, связанную с помощником. В противном случае будет использоваться модель, связанная с помощником.	No
инструкции	строка	Переопределите системное сообщение помощника по умолчанию. Это полезно для изменения поведения на основе каждого запуска.	No
additional_instructions	строка	Добавляет дополнительные инструкции в конце инструкций для выполнения. Это полезно для изменения поведения на основе каждого запуска без переопределения других инструкций.	No
additional_messages	array	Добавляет дополнительные сообщения в поток перед созданием запуска.	No
средства	array	Переопределите средства, которые помощник может использовать для этого запуска. Это полезно для изменения поведения на основе каждого запуска.	No
metadata	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.	No
Температура	number	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным.	No	1
top_p	number	Альтернативой выборке с температурой является так называемая выборка ядра, где модель рассматривает результаты маркеров с top_p всего массива значений вероятности. Таким образом, 0,1 означает, что учитываются только маркеры, входящие в верхние 10% массива значений вероятности. Как правило, мы рекомендуем изменить либо это значение, либо температуру, но не оба.	No	1
потоковая передача	boolean	Если `true`возвращает поток событий, которые происходят во время событий запуска от имени сервера, завершая выполнение в состоянии терминала с сообщением `data: [DONE]` .	No
max_prompt_tokens	integer	Максимальное количество маркеров запроса, которые могут использоваться в ходе выполнения. Выполнение сделает все возможное, чтобы использовать только количество маркеров запроса, указанных в нескольких поворотах выполнения. Если выполнение превышает указанное число маркеров запроса, выполнение завершится состоянием `incomplete`. Дополнительные сведения см. в разделе `incomplete_details` .	No
max_completion_tokens	integer	Максимальное количество маркеров завершения, которые могут использоваться в ходе выполнения. Выполнение сделает все возможное, чтобы использовать только количество маркеров завершения, указанных в нескольких поворотах выполнения. Если выполнение превышает указанное число маркеров завершения, выполнение завершится состоянием `incomplete`. Дополнительные сведения см. в разделе `incomplete_details` .	No
truncation_strategy	усечениеObject	Определяет, как поток будет усечен до выполнения. Используйте это для управления начальным окном контекста выполнения.	No
tool_choice	assistantsApiToolChoiceOption	Определяет, какое средство (если таковое) вызывается моделью. `none` означает, что модель не вызывает средства и вместо этого создает сообщение. `auto` является значением по умолчанию и означает, что модель может выбирать между созданием сообщения или вызовом средства. Указание определенного инструмента, например `{"type": "file_search"}` или `{"type": "function", "function": {"name": "my_function"}}` принудительное вызов модели.	No
parallel_tool_calls	ParallelToolCalls	Следует ли включить параллельные вызовы функций во время использования средства.	No	Истина
response_format	assistantsApiResponseFormatOption	Указывает формат, который модель должна выводить. Совместим с GPT-4 Turbo и всеми моделями GPT-3.5 Turbo с тех пор `gpt-3.5-turbo-1106`. Параметр включения `{ "type": "json_object" }` режима JSON, который гарантирует, что модель создает сообщение является допустимым JSON. Важно: при использовании режима JSON необходимо также указать модели создавать JSON самостоятельно с помощью системного или пользовательского сообщения. Без этого модель может создать неуправляемый поток пробелов до тех пор, пока поколение не достигнет предела маркера, в результате чего длительный и, казалось бы, "застрявший" запрос. Кроме того, обратите внимание, что содержимое сообщения может быть частично отрезано, если `finish_reason="length"`, что указывает на превышение поколения `max_tokens` или беседа превысила максимальную длину контекста.	No

Отклики

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

Описание: ОК

Content-Type	Тип	Description
application/json	runObject	Представляет выполнение в потоке.

Примеры

Пример

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

POST https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2024-10-01-preview

{
 "assistant_id": "asst_abc123"
}

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

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699063290,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "queued",
    "started_at": 1699063290,
    "expires_at": null,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": 1699063291,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": null,
    "incomplete_details": null,
    "tools": [
      {
        "type": "code_interpreter"
      }
    ],
    "metadata": {},
    "usage": null,
    "temperature": 1.0,
    "top_p": 1.0,
    "max_prompt_tokens": 1000,
    "max_completion_tokens": 1000,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

Get - Run

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2024-10-01-preview

Извлекает запуск.

Параметры URI

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

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

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

Отклики

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

Описание: ОК

Content-Type	Тип	Description
application/json	runObject	Представляет выполнение в потоке.

Примеры

Пример

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

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2024-10-01-preview

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

{
  "body": {
    "id": "run_HsO8tYM4K5AAMAHgK0J3om8Q",
    "object": "thread.run",
    "created_at": 1707303196,
    "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl",
    "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh",
    "status": "completed",
    "started_at": 1707303197,
    "expires_at": null,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": 1707303201,
    "last_error": null,
    "model": "gpt-4-1106-preview",
    "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.",
    "tools": [],
    "file_ids": [],
    "metadata": {}
  }
}

Изменение — запуск

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2024-10-01-preview

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

Параметры URI

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

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

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

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

Content-Type: application/json

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

Отклики

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

Описание: ОК

Content-Type	Тип	Description
application/json	runObject	Представляет выполнение в потоке.

Примеры

Пример

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

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2024-10-01-preview

{
 "metadata": {
  "user_id": "user_abc123"
 }
}

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

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699075072,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "completed",
    "started_at": 1699075072,
    "expires_at": null,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": 1699075073,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": null,
    "incomplete_details": null,
    "tools": [
      {
        "type": "code_interpreter"
      }
    ],
    "tool_resources": {
      "code_interpreter": {
        "file_ids": [
          "file-abc123",
          "file-abc456"
        ]
      }
    },
    "metadata": {
      "user_id": "user_abc123"
    },
    "usage": {
      "prompt_tokens": 123,
      "completion_tokens": 456,
      "total_tokens": 579
    },
    "temperature": 1.0,
    "top_p": 1.0,
    "max_prompt_tokens": 1000,
    "max_completion_tokens": 1000,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

Отправка — выходные данные средства для запуска

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/submit_tool_outputs?api-version=2024-10-01-preview

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

Параметры URI

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

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

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

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

Content-Type: application/json

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

Отклики

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

Описание: ОК

Content-Type	Тип	Description
application/json	runObject	Представляет выполнение в потоке.

Примеры

Пример

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/submit_tool_outputs?api-version=2024-10-01-preview

{
 "tool_outputs": [
  {
   "tool_call_id": "call_001",
   "output": "70 degrees and sunny."
  }
 ]
}

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

{
  "body": {
    "id": "run_123",
    "object": "thread.run",
    "created_at": 1699075592,
    "assistant_id": "asst_123",
    "thread_id": "thread_123",
    "status": "queued",
    "started_at": 1699075592,
    "expires_at": 1699076192,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": null,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": null,
    "tools": [
      {
        "type": "function",
        "function": {
          "name": "get_current_weather",
          "description": "Get the current weather in a given location",
          "parameters": {
            "type": "object",
            "properties": {
              "location": {
                "type": "string",
                "description": "The city and state, e.g. San Francisco, CA"
              },
              "unit": {
                "type": "string",
                "enum": [
                  "celsius",
                  "fahrenheit"
                ]
              }
            },
            "required": [
              "location"
            ]
          }
        }
      }
    ],
    "metadata": {},
    "usage": null,
    "temperature": 1.0,
    "top_p": 1.0,
    "max_prompt_tokens": 1000,
    "max_completion_tokens": 1000,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

Отмена — запуск

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/cancel?api-version=2024-10-01-preview

Отменяет запуск, который является in_progress.

Параметры URI

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

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

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

Отклики

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

Описание: ОК

Content-Type	Тип	Description
application/json	runObject	Представляет выполнение в потоке.

Примеры

Пример

Отменяет запуск, который является in_progress.

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/cancel?api-version=2024-10-01-preview

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

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699076126,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "cancelling",
    "started_at": 1699076126,
    "expires_at": 1699076726,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": null,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": "You summarize books.",
    "tools": [
      {
        "type": "file_search"
      }
    ],
    "tool_resources": {
      "file_search": {
        "vector_store_ids": [
          "vs_123"
        ]
      }
    },
    "metadata": {},
    "usage": null,
    "temperature": 1.0,
    "top_p": 1.0,
    "response_format": "auto"
  }
}

Список — шаги выполнения

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps?api-version=2024-10-01-preview

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

Параметры URI

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

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

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

Отклики

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

Описание: ОК

Content-Type	Тип	Description
application/json	listRunStepsResponse

Примеры

Пример

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

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps?api-version=2024-10-01-preview

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

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "step_abc123",
        "object": "thread.run.step",
        "created_at": 1699063291,
        "run_id": "run_abc123",
        "assistant_id": "asst_abc123",
        "thread_id": "thread_abc123",
        "type": "message_creation",
        "status": "completed",
        "cancelled_at": null,
        "completed_at": 1699063291,
        "expired_at": null,
        "failed_at": null,
        "last_error": null,
        "step_details": {
          "type": "message_creation",
          "message_creation": {
            "message_id": "msg_abc123"
          }
        },
        "usage": {
          "prompt_tokens": 123,
          "completion_tokens": 456,
          "total_tokens": 579
        }
      }
    ],
    "first_id": "step_abc123",
    "last_id": "step_abc456",
    "has_more": false
  }
}

Получение — шаг выполнения

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps/{step_id}?api-version=2024-10-01-preview

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

Параметры URI

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

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

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

Отклики

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

Описание: ОК

Content-Type	Тип	Description
application/json	runStepObject	Представляет шаг выполнения выполнения выполнения.

Примеры

Пример

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

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps/{step_id}?api-version=2024-10-01-preview

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

{
  "body": {
    "id": "step_abc123",
    "object": "thread.run.step",
    "created_at": 1699063291,
    "run_id": "run_abc123",
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "type": "message_creation",
    "status": "completed",
    "cancelled_at": null,
    "completed_at": 1699063291,
    "expired_at": null,
    "failed_at": null,
    "last_error": null,
    "step_details": {
      "type": "message_creation",
      "message_creation": {
        "message_id": "msg_abc123"
      }
    },
    "usage": {
      "prompt_tokens": 123,
      "completion_tokens": 456,
      "total_tokens": 579
    }
  }
}

Список — векторные хранилища

GET https://{endpoint}/openai/vector_stores?api-version=2024-10-01-preview

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

Параметры URI

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

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

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

Отклики

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

Описание: ОК

Content-Type	Тип	Description
application/json	listVectorStoresResponse

Примеры

Пример

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

GET https://{endpoint}/openai/vector_stores?api-version=2024-10-01-preview

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

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "vs_abc123",
        "object": "vector_store",
        "created_at": 1699061776,
        "name": "Support FAQ",
        "bytes": 139920,
        "file_counts": {
          "in_progress": 0,
          "completed": 3,
          "failed": 0,
          "cancelled": 0,
          "total": 3
        }
      },
      {
        "id": "vs_abc456",
        "object": "vector_store",
        "created_at": 1699061776,
        "name": "Support FAQ v2",
        "bytes": 139920,
        "file_counts": {
          "in_progress": 0,
          "completed": 3,
          "failed": 0,
          "cancelled": 0,
          "total": 3
        }
      }
    ],
    "first_id": "vs_abc123",
    "last_id": "vs_abc456",
    "has_more": false
  }
}

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

POST https://{endpoint}/openai/vector_stores?api-version=2024-10-01-preview

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

Параметры URI

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

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

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

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

Content-Type: application/json

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

Отклики

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

Описание: ОК

Content-Type	Тип	Description
application/json	vectorStoreObject	Векторное хранилище — это коллекция обработанных файлов, которые можно использовать `file_search` средством.

Примеры

Пример

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

POST https://{endpoint}/openai/vector_stores?api-version=2024-10-01-preview

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

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store",
    "created_at": 1699061776,
    "name": "Support FAQ",
    "bytes": 139920,
    "file_counts": {
      "in_progress": 0,
      "completed": 3,
      "failed": 0,
      "cancelled": 0,
      "total": 3
    }
  }
}

Get — Vector Store

GET https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2024-10-01-preview

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

Параметры URI

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

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

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

Отклики

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

Описание: ОК

Content-Type	Тип	Description
application/json	vectorStoreObject	Векторное хранилище — это коллекция обработанных файлов, которые можно использовать `file_search` средством.

Примеры

Пример

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

GET https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2024-10-01-preview

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

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store",
    "created_at": 1699061776
  }
}

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

POST https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2024-10-01-preview

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

Параметры URI

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

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

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

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

Content-Type: application/json

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

Отклики

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

Описание: ОК

Content-Type	Тип	Description
application/json	vectorStoreObject	Векторное хранилище — это коллекция обработанных файлов, которые можно использовать `file_search` средством.

Примеры

Пример

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

POST https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2024-10-01-preview

{
 "name": "Support FAQ"
}

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

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store",
    "created_at": 1699061776,
    "name": "Support FAQ",
    "bytes": 139920,
    "file_counts": {
      "in_progress": 0,
      "completed": 3,
      "failed": 0,
      "cancelled": 0,
      "total": 3
    }
  }
}

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

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2024-10-01-preview

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

Параметры URI

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

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

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

Отклики

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

Описание: ОК

Content-Type	Тип	Description
application/json	deleteVectorStoreResponse

Примеры

Пример

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

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2024-10-01-preview

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

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store.deleted",
    "deleted": true
  }
}

Список — файлы векторного хранилища

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2024-10-01-preview

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

Параметры URI

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

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

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

Отклики

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

Описание: ОК

Content-Type	Тип	Description
application/json	listVectorStoreFilesResponse

Примеры

Пример

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

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2024-10-01-preview

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

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "file-abc123",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      },
      {
        "id": "file-abc456",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      }
    ],
    "first_id": "file-abc123",
    "last_id": "file-abc456",
    "has_more": false
  }
}

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

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2024-10-01-preview

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

Параметры URI

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

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

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

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

Content-Type: application/json

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

Отклики

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

Описание: ОК

Content-Type	Тип	Description
application/json	vectorStoreFileObject	Список файлов, подключенных к хранилищу векторов.

Примеры

Пример

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

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2024-10-01-preview

{
 "file_id": "file-abc123"
}

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

{
  "body": {
    "id": "file-abc123",
    "object": "vector_store.file",
    "created_at": 1699061776,
    "usage_bytes": 1234,
    "vector_store_id": "vs_abcd",
    "status": "completed",
    "last_error": null
  }
}

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

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2024-10-01-preview

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

Параметры URI

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

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

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

Отклики

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

Описание: ОК

Content-Type	Тип	Description
application/json	vectorStoreFileObject	Список файлов, подключенных к хранилищу векторов.

Примеры

Пример

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

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2024-10-01-preview

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

{
  "body": {
    "id": "file-abc123",
    "object": "vector_store.file",
    "created_at": 1699061776,
    "vector_store_id": "vs_abcd",
    "status": "completed",
    "last_error": null
  }
}

Delete — векторный файл хранилища

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2024-10-01-preview

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

Параметры URI

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

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

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

Отклики

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

Описание: ОК

Content-Type	Тип	Description
application/json	deleteVectorStoreFileResponse

Примеры

Пример

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2024-10-01-preview

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

{
  "body": {
    "id": "file_abc123",
    "object": "vector_store.file.deleted",
    "deleted": true
  }
}

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

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

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

Параметры URI

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

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

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

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

Content-Type: application/json

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

Отклики

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

Описание: ОК

Content-Type	Тип	Description
application/json	vectorStoreFileBatchObject	Пакет файлов, присоединенных к хранилищу векторов.

Примеры

Пример

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

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

{
 "file_ids": [
  "file-abc123",
  "file-abc456"
 ]
}

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

{
  "id": "vsfb_abc123",
  "object": "vector_store.file_batch",
  "created_at": 1699061776,
  "vector_store_id": "vs_abc123",
  "status": "in_progress",
  "file_counts": {
    "in_progress": 1,
    "completed": 1,
    "failed": 0,
    "cancelled": 0,
    "total": 0
  }
}

Получение пакета файлов векторного хранилища

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}?api-version=2024-10-01-preview

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

Параметры URI

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

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

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

Отклики

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

Описание: ОК

Content-Type	Тип	Description
application/json	vectorStoreFileBatchObject	Пакет файлов, присоединенных к хранилищу векторов.

Примеры

Пример

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

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}?api-version=2024-10-01-preview

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

{
  "body": {
    "id": "vsfb_abc123",
    "object": "vector_store.file_batch",
    "created_at": 1699061776,
    "vector_store_id": "vs_abc123",
    "status": "in_progress",
    "file_counts": {
      "in_progress": 1,
      "completed": 1,
      "failed": 0,
      "cancelled": 0,
      "total": 0
    }
  }
}

Отмена — пакет файла векторного хранилища

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel?api-version=2024-10-01-preview

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

Параметры URI

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

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

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

Отклики

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

Описание: ОК

Content-Type	Тип	Description
application/json	vectorStoreFileBatchObject	Пакет файлов, присоединенных к хранилищу векторов.

Примеры

Пример

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel?api-version=2024-10-01-preview

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

{
  "body": {
    "id": "vsfb_abc123",
    "object": "vector_store.file_batch",
    "created_at": 1699061776,
    "vector_store_id": "vs_abc123",
    "status": "cancelling",
    "file_counts": {
      "in_progress": 12,
      "completed": 3,
      "failed": 0,
      "cancelled": 0,
      "total": 15
    }
  }
}

Список — пакетные файлы векторного хранилища

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/files?api-version=2024-10-01-preview

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

Параметры URI

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

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

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

Отклики

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

Описание: ОК

Content-Type	Тип	Description
application/json	listVectorStoreFilesResponse

Примеры

Пример

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

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/files?api-version=2024-10-01-preview

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

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "file-abc123",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      },
      {
        "id": "file-abc456",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      }
    ],
    "first_id": "file-abc123",
    "last_id": "file-abc456",
    "has_more": false
  }
}

Компоненты

errorResponse

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

errorBase

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

error

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

innerError

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

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

innerErrorCode

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

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

Тип: string.

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

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

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

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

dalleErrorResponse

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

dalleError

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

dalleInnerError

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

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

contentFilterCompletionTextSpan

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

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

contentFilterResultBase

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

contentFilterSeverityResult

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

contentFilterDetectedResult

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

contentFilterDetectedWithCitationResult

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

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

URL

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

лицензия

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

contentFilterDetectedWithCompletionTextSpansResult

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

contentFilterIdResult

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

contentFilterResultsBase

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

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

contentFilterPromptResults

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

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

contentFilterChoiceResults

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

Имя.	Тип	Описание	Обязательное поле
половой	contentFilterSeverityResult		No
насилие	contentFilterSeverityResult		No
ненавидеть	contentFilterSeverityResult		No
self_harm	contentFilterSeverityResult		No
богохульство	contentFilterDetectedResult		No
custom_blocklists	contentFilterDetailedResults	Результаты фильтрации содержимого с подробными сведениями о идентификаторах фильтра содержимого для отфильтрованных сегментов.	No
error	errorBase		No
protected_material_text	contentFilterDetectedResult		No
protected_material_code	contentFilterDetectedWithCitationResult		No
ungrounded_material	contentFilterDetectedWithCompletionTextSpansResult		No

contentFilterDetailedResults

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

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

promptFilterResult

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

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

promptFilterResults

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

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

dalleContentFilterResults

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

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

dalleFilterResults

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

chatCompletionsRequestCommon

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

createCompletionRequest

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
prompt	строка или массив	Запросы для создания завершений, закодированных в виде строки, массива строк, массива маркеров или массива массивов маркеров. Обратите внимание, что <\|endoftext\|> — это разделитель документов, который модель видит во время обучения, поэтому если запрос не указан, модель будет создаваться как будто с начала нового документа.	Да
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	объект	Изменяет вероятность появления указанных маркеров в завершении. Принимает объект JSON, который сопоставляет маркеры (указанные идентификатором маркера в маркеризаторе GPT) с соответствующим значением предвзятости от -100 до 100. С математической точки зрения смещение добавляется к логитам, созданным моделью до выборки. Точный эффект зависит от модели, но значения от –1 до 1 должны уменьшать или увеличивать вероятность выбора; такие значения, как –100 или 100, должны приводить к запрету или эксклюзивному выбору соответствующего маркера. Например, можно передать `{"50256": -100}` маркер \|endoftext\|> для предотвращения <создания маркера \|endoftext.	No	нет
logprobs	integer	Включите вероятности журнала в `logprobs` наиболее вероятные выходные маркеры, а также выбранные маркеры. Например, если `logprobs` значение равно 5, API вернет список из 5 наиболее вероятных маркеров. API всегда возвращает `logprob` пример маркера, поэтому в ответе может быть до `logprobs+1` элементов. Максимальное значение `logprobs` для 5.	No	нет
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	строка или массив	До 4 последовательностей, в которых API перестанет создавать дополнительные маркеры. Возвращенный текст не будет содержать последовательность остановки.	No
потоковая передача	boolean	Потоковая передача частичного хода выполнения. Если задано, маркеры будут отправляться как события, отправленные сервером только для данных, как они становятся доступными, с потоком`data: [DONE]`, завершаемым сообщением.	No	False
suffix	строка	Суффикс, который приходит после завершения вставленного текста. Этот параметр поддерживается только для `gpt-3.5-turbo-instruct`.	No	нет
Температура	number	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным. Как правило, мы рекомендуем изменить это или `top_p` не оба.	No	1
top_p	number	Альтернативой выборке с температурой является так называемая выборка ядра, где модель рассматривает результаты маркеров с top_p всего массива значений вероятности. Таким образом, 0,1 означает, что учитываются только маркеры, входящие в верхние 10% массива значений вероятности. Как правило, мы рекомендуем изменить это или `temperature` не оба.	No	1
Пользователь	строка	Уникальный идентификатор, представляющий конечного пользователя, который может помочь в мониторинге и обнаружении злоупотреблений.	No

createCompletionResponse

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

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

createChatCompletionRequest

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
Температура	number	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным. Как правило, мы рекомендуем изменить это или `top_p` не оба.	No	1
top_p	number	Альтернативой выборке с температурой является так называемая выборка ядра, где модель рассматривает результаты маркеров с top_p всего массива значений вероятности. Таким образом, 0,1 означает, что учитываются только маркеры, входящие в верхние 10% массива значений вероятности. Как правило, мы рекомендуем изменить это или `temperature` не оба.	No	1
потоковая передача	boolean	Если задано, будут отправляться частичные разностные сообщения, например в ChatGPT. Маркеры будут отправляться как события, отправленные сервером только для данных, как они становятся доступными, при этом поток завершается сообщением`data: [DONE]`.	No	False
stop	строка или массив	До 4 последовательностей, в которых API перестанет создавать дополнительные маркеры.	No
max_tokens	integer	Максимальное количество маркеров, которые можно создать в завершении чата. Общая длина входных маркеров и созданных маркеров ограничена длиной контекста модели.	No
max_completion_tokens	integer	Верхняя граница для числа маркеров, которые можно создать для завершения, включая видимые выходные маркеры и маркеры причин. Это поддерживается только в моделях серии o1. Расширит поддержку других моделей в будущем выпуске API.	No
presence_penalty	number	Значение в диапазоне от –2.0 до 2.0. Положительные значения выбраковывают новые маркеры в зависимости от того, отображаются ли они в тексте на данный момент, увеличивая вероятность обсуждений на новые темы.	No	0
frequency_penalty	number	Значение в диапазоне от –2.0 до 2.0. Положительные значения выбраковывают новые маркеры в зависимости от существующей частоты в тексте на данный момент, уменьшая вероятность повторения той же буквальной строки.	No	0
logit_bias	объект	Изменяет вероятность появления указанных маркеров в завершении. Принимает объект JSON, который сопоставляет маркеры (указанные идентификатором маркера в токенизаторе) со связанным значением предвзятости от -100 до 100. С математической точки зрения смещение добавляется к логитам, созданным моделью до выборки. Точный эффект зависит от модели, но значения от –1 до 1 должны уменьшать или увеличивать вероятность выбора; такие значения, как –100 или 100, должны приводить к запрету или эксклюзивному выбору соответствующего маркера.	No	нет
Пользователь	строка	Уникальный идентификатор, представляющий конечного пользователя, который может помочь в мониторинге и обнаружении злоупотреблений.	No
messages	array	Список сообщений, составляющих беседу до сих пор.	Да
data_sources	array	Записи конфигурации для расширений чата Azure OpenAI, которые используют их. Эта дополнительная спецификация совместима только с Azure OpenAI.	No
logprobs	boolean	Следует ли возвращать вероятности журналов выходных маркеров или нет. Если значение true, возвращает вероятности журнала каждого выходного маркера, возвращаемого в параметре `content` `message`.	No	False
top_logprobs	integer	Целое число от 0 до 20, указывающее число наиболее вероятных маркеров, возвращаемых по каждой позиции маркера, каждый из которых имеет связанную вероятность журнала. `logprobs` Необходимо задать значение `true` , если этот параметр используется.	No
n	integer	Сколько вариантов завершения чата для каждого входного сообщения. Обратите внимание, что плата будет взиматься на основе количества созданных маркеров во всех вариантах. Имейте в виду `n` , чтобы `1` свести к минимуму затраты.	No	1
parallel_tool_calls	ParallelToolCalls	Следует ли включить параллельные вызовы функций во время использования средства.	No	Истина
response_format	ResponseFormatText или ResponseFormatJsonObject или ResponseFormatJsonSchema	Объект, указывающий формат, который должен выводить модель. Совместим с GPT-4o, GPT-4o mini, GPT-4 Turbo и всеми моделями GPT-3.5 Turbo, чем `gpt-3.5-turbo-1106`более новые. Параметр для `{ "type": "json_schema", "json_schema": {...} }` включения структурированных выходных данных, гарантирующих, что модель будет соответствовать предоставленной схеме JSON. Параметр включения `{ "type": "json_object" }` режима JSON, который гарантирует, что модель создает сообщение является допустимым JSON. Важно: при использовании режима JSON необходимо также указать модели создавать JSON самостоятельно с помощью системного или пользовательского сообщения. Без этого модель может создать неуправляемый поток пробелов до тех пор, пока поколение не достигнет предела маркера, в результате чего длительный и, казалось бы, "застрявший" запрос. Кроме того, обратите внимание, что содержимое сообщения может быть частично отрезано, если `finish_reason="length"`, что указывает на превышение поколения `max_tokens` или беседа превысила максимальную длину контекста.	No
seed	integer	Эта функция доступна в бета-версии. Если задано, наша система будет предпринять лучшие усилия для выборки детерминированного, таким образом, что повторяющиеся запросы с одинаковыми и теми же параметрами должны возвращать тот же `seed` результат. Детерминированность не гарантируется, и вы должны ссылаться на `system_fingerprint` параметр ответа для отслеживания изменений в серверной части.	No
stream_options	chatCompletionStreamOptions	Параметры потокового ответа. Этот параметр устанавливается только при установке `stream: true`.	No	нет
средства	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

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

chatCompletionFunctionCallOption

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

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

chatCompletionFunctionParameters

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

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

chatCompletionRequestMessage

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

chatCompletionRequestSystemMessage

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

chatCompletionRequestUserMessage

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

chatCompletionRequestAssistantMessage

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

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

аргументы

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

name

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

chatCompletionRequestToolMessage

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

chatCompletionRequestFunctionMessage

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

chatCompletionRequestSystemMessageContentPart

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

chatCompletionRequestUserMessageContentPart

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

chatCompletionRequestAssistantMessageContentPart

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

chatCompletionRequestToolMessageContentPart

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

chatCompletionRequestMessageContentPartText

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

chatCompletionRequestMessageContentPartImage

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

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

URL-адрес

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

detail

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

chatCompletionRequestMessageContentPartRefusal

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

azureChatExtensionConfiguration

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

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

azureChatExtensionType

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

Тип: string.

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

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

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

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

azureSearchChatExtensionConfiguration

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

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

azureSearchChatExtensionParameters

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

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
проверка подлинности	onYourDataApiKeyAuthenticationOptions или onYourDataSystemAssignedManagedIdentityAuthenticationOptions или onYourDataUserAssignedManagedIdentityAuthenticationOptions или onYourDataAccessTokenAuthenticationOptions		Да
top_n_documents	integer	Настроено первое число документов для функции настроенного запроса.	No
max_search_queries	integer	Максимальное количество перезаписных запросов, которые должны отправляться поставщику поиска для одного сообщения пользователя. Если это не указано, система решит количество запросов для отправки.	No
allow_partial_result	boolean	Если задано значение true, система позволит использовать частичные результаты поиска, и запрос завершается ошибкой, если все запросы завершаются ошибкой. Если запрос не указан или указан как false, запрос завершится ошибкой, если какой-либо поисковый запрос завершается ошибкой.	No	False
in_scope	boolean	Следует ли ограничить запросы использованием индексированных данных.	No
строгость	integer	Настроенная строгость фильтрации релевантности поиска. Чем выше строгость, тем выше точность, но более низкий отзыв ответа.	No
конечная точка	строка	Абсолютный путь конечной точки для используемого ресурса поиска Azure.	Да
index_name	строка	Имя индекса, используемого как доступное в ресурсе поиска Azure.	Да
fields_mapping	azureSearchIndexFieldMappingOptions	Необязательные параметры для управления обработкой полей при использовании настроенного ресурса поиска Azure.	No
query_type	azureSearchQueryType	Тип запроса поиска Azure, который должен выполняться при использовании в качестве расширения чата Azure OpenAI.	No
semantic_configuration	строка	Дополнительная семантическая конфигурация для запроса.	No
Фильтр	строка	Фильтр поиска.	No
embedding_dependency	onYourDataEndpointVectorizationSource или onYourDataDeploymentNameVectorizationSource или onYourDataIntegratedVectorizationSource		No
include_contexts	array	Включенные свойства контекста вывода. Если не указано, значение по умолчанию равно `citations` и `intent`.	No

azureSearchIndexFieldMappingOptions

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

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

azureSearchQueryType

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

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

Тип: string.

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

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

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

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

azureCosmosDBChatExtensionConfiguration

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

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

azureCosmosDBChatExtensionParameters

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

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

azureCosmosDBFieldMappingOptions

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

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

elasticsearchChatExtensionConfiguration

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

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

elasticsearchChatExtensionParameters

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

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
проверка подлинности	onYourDataKeyAndKeyIdAuthenticationOptions или onYourDataEncodedApiKeyAuthenticationOptions		Да
top_n_documents	integer	Настроено первое число документов для функции настроенного запроса.	No
max_search_queries	integer	Максимальное количество перезаписных запросов должно отправляться в поставщик поиска для одного сообщения пользователя. Если это не указано, система решит количество запросов для отправки.	No
allow_partial_result	boolean	Если задано значение true, система позволит использовать частичные результаты поиска, и запрос завершается ошибкой, если все запросы завершаются ошибкой. Если запрос не указан или указан как false, запрос завершится ошибкой, если какой-либо поисковый запрос завершается ошибкой.	No	False
in_scope	boolean	Следует ли ограничить запросы использованием индексированных данных.	No
строгость	integer	Настроенная строгость фильтрации релевантности поиска. Чем выше строгость, тем выше точность, но более низкий отзыв ответа.	No
конечная точка	строка	Конечная точка Elasticsearch®.	Да
index_name	строка	Имя индекса Elasticsearch®.	Да
fields_mapping	elasticsearchIndexFieldMappingOptions	Необязательные параметры для управления обработкой полей при использовании настроенного ресурса Elasticsearch®.	No
query_type	elasticsearchQueryType	Тип запроса извлечения Elasticsearch®, который должен выполняться при использовании в качестве расширения чата Azure OpenAI.	No
embedding_dependency	onYourDataEndpointVectorizationSource или onYourDataDeploymentNameVectorizationSource или onYourDataModelIdVectorizationSource		No
include_contexts	array	Включенные свойства контекста вывода. Если не указано, значение по умолчанию равно `citations` и `intent`.	No

elasticsearchIndexFieldMappingOptions

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

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

elasticsearchQueryType

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

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

Тип: string.

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

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

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

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

mongoDBChatExtensionConfiguration

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

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

mongoDBChatExtensionParameters

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

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
проверка подлинности	onYourDataUsernameAndPasswordAuthenticationOptions	Параметры проверки подлинности Azure OpenAI On Your Data при использовании имени пользователя и пароля.	Да
top_n_documents	integer	Настроено первое число документов для функции настроенного запроса.	No
max_search_queries	integer	Максимальное количество перезаписных запросов должно отправляться в поставщик поиска для одного сообщения пользователя. Если это не указано, система решит количество запросов для отправки.	No
allow_partial_result	boolean	Если задано значение true, система позволит использовать частичные результаты поиска, и запрос завершается ошибкой, если все запросы завершаются ошибкой. Если запрос не указан или указан как false, запрос завершится ошибкой, если какой-либо поисковый запрос завершается ошибкой.	No	False
in_scope	boolean	Следует ли ограничить запросы использованием индексированных данных.	No
строгость	integer	Настроенная строгость фильтрации релевантности поиска. Чем выше строгость, тем выше точность, но более низкий отзыв ответа.	No
конечная точка	строка	Имя конечной точки кластера Mongo DB.	Да
database_name	строка	Имя базы данных Mongo DB.	Да
collection_name	строка	Имя коллекции Базы данных Mongo.	Да
app_name	строка	Имя приложения Mongo DB.	Да
index_name	строка	Имя индекса Mongo DB.	Да
fields_mapping	mongoDBFieldMappingOptions	Необязательные параметры для управления обработкой полей при использовании настроенного ресурса Mongo DB.	Да
embedding_dependency	onYourDataEndpointVectorizationSource или onYourDataDeploymentNameVectorizationSource		Да
include_contexts	array	Включенные свойства контекста вывода. Если не указано, значение по умолчанию равно `citations` и `intent`.	No

mongoDBFieldMappingOptions

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

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

pineconeChatExtensionConfiguration

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

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

pineconeChatExtensionParameters

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

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
проверка подлинности	onYourDataApiKeyAuthenticationOptions	Параметры проверки подлинности Azure OpenAI On Your Data при использовании ключа API.	Да
top_n_documents	integer	Настроено первое число документов для функции настроенного запроса.	No
max_search_queries	integer	Максимальное количество перезаписных запросов должно отправляться в поставщик поиска для одного сообщения пользователя. Если это не указано, система решит количество запросов для отправки.	No
allow_partial_result	boolean	Если задано значение true, система позволит использовать частичные результаты поиска, и запрос завершается ошибкой, если все запросы завершаются ошибкой. Если запрос не указан или указан как false, запрос завершится ошибкой, если какой-либо поисковый запрос завершается ошибкой.	No	False
in_scope	boolean	Следует ли ограничить запросы использованием индексированных данных.	No
строгость	integer	Настроенная строгость фильтрации релевантности поиска. Чем выше строгость, тем выше точность, но более низкий отзыв ответа.	No
environment	строка	Имя среды Pinecone.	Да
index_name	строка	Имя индекса базы данных Pinecone.	Да
fields_mapping	pineconeFieldMappingOptions	Необязательные параметры для управления обработкой полей при использовании настроенного ресурса Pinecone.	Да
embedding_dependency	onYourDataDeploymentNameVectorizationSource	Сведения о источнике векторизации, используемом Azure OpenAI On Your Data при применении векторного поиска, основанного на в имени развертывания модели внутреннего внедрения в том же ресурсе Azure OpenAI.	Да
include_contexts	array	Включенные свойства контекста вывода. Если не указано, значение по умолчанию равно `citations` и `intent`.	No

pineconeFieldMappingOptions

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

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

onYourDataAuthenticationOptions

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

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

onYourDataContextProperty

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

Описание: свойство контекста.

Тип: string.

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

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

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

значение	Описание
Цитаты	Свойство `citations`.
намерение	Свойство `intent`.
all_retrieved_documents	Свойство `all_retrieved_documents`.

onYourDataAuthenticationType

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

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

Тип: string.

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

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

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

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

onYourDataApiKeyAuthenticationOptions

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

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

onYourDataConnectionStringAuthenticationOptions

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

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

onYourDataKeyAndKeyIdAuthenticationOptions

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

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

onYourDataEncodedApiKeyAuthenticationOptions

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

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

onYourDataAccessTokenAuthenticationOptions

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

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

onYourDataSystemAssignedManagedIdentityAuthenticationOptions

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

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

onYourDataUserAssignedManagedIdentityAuthenticationOptions

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

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

onYourDataUsernameAndPasswordAuthenticationOptions

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

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

onYourDataVectorizationSource

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

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

onYourDataVectorizationSourceType

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

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

Тип: string.

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

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

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

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

onYourDataEndpointVectorizationSource

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

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

onYourDataDeploymentNameVectorizationSource

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

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

onYourDataIntegratedVectorizationSource

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

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

onYourDataModelIdVectorizationSource

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

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

azureChatExtensionsMessageContext

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

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

цитата

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

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

retrievedDocument

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

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

filterReason

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

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

Тип: string.

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

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

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

значение	Описание
score	Документ фильтруется по исходному порогу оценки поиска, определенному с помощью `strictness` настройки.
повторная ранговая	Документ не фильтруется по исходному порогу оценки поиска, но фильтруется по оценке повторного использования и `top_n_documents` настройке.

chatCompletionMessageToolCall

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

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

name

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

аргументы

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

toolCallType

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

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

Тип: string.

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

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

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

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

chatCompletionRequestMessageTool

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

chatCompletionRequestMessageFunction

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

createChatCompletionResponse

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

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

createChatCompletionStreamResponse

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

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

chatCompletionStreamResponseDelta

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

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

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

аргументы

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

name

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

chatCompletionMessageToolCallChunk

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

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

name

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

аргументы

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

chatCompletionStreamOptions

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

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

chatCompletionChoiceLogProbs

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

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

chatCompletionTokenLogprob

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

chatCompletionResponseMessage

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

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

chatCompletionResponseMessageRole

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

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

Тип: string.

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

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

assistant

chatCompletionToolChoiceOption

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

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

chatCompletionNamedToolChoice

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

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

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

name

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

ParallelToolCalls

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

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

chatCompletionMessageToolCalls

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

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

chatCompletionFunctionCall

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

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

completionUsage

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

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

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

cached_tokens

Имя.	Тип	Описание	По умолч.
cached_tokens	integer	Количество кэшированных маркеров запроса.

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

reasoning_tokens

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

chatCompletionTool

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

FunctionParameters

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

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

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

FunctionObject

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

ResponseFormatText

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

ResponseFormatJsonObject

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

ResponseFormatJsonSchemaSchemaSchema

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

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

ResponseFormatJsonSchema

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

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

описание

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

name

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

schema

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

strict

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

chatCompletionChoiceCommon

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

createTranslationRequest

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

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

audioResponse

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

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

audioVerboseResponse

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

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

audioResponseFormat

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

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

Тип: string.

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

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

json
text
srt
verbose_json
vtt

createTranscriptionRequest

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

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

audioSegment

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

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

audioWord

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

Имя.	Тип	Описание	Обязательное поле
слово	строка	Word	No
start	number	Смещение запуска Word.	No
end	number	Смещение конца Word.	No

createSpeechRequest

Запрос речи.

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
Входные данные	строка	Текст для синтеза звука. Максимальная длина — 4096 символов.	Да
voice	перечисление	Голос, используемый для синтеза речи. Возможные значения: сплав, эхо, fable, onyx, nova, мерцание	Да
response_format	перечисление	Формат синтеза звука в. Возможные значения: mp3, opus, aac, flac, wav, pcm	No
скорость	number	Скорость синтезированного звука. Выберите значение из `0.25` `4.0`. Значение по умолчанию — `1.0`.	No	1.0

imageQuality

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

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

Тип: string.

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

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

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

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

imagesResponseFormat

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

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

Тип: string.

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

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

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

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

imageSize

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

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

Тип: string.

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

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

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

значение	Описание
256x256	Требуемый размер созданного изображения составляет 256x256 пикселей. Поддерживается только для dall-e-2.
512 x 512	Требуемый размер созданного изображения составляет 512x512 пикселей. Поддерживается только для dall-e-2.
1792x1024	Требуемый размер созданного изображения составляет 1792x1024 пикселя. Поддерживается только для dall-e-3.
1024x1792	Требуемый размер созданного изображения составляет 1024x1792 пикселя. Поддерживается только для dall-e-3.
1024 x 1024	Требуемый размер созданного изображения составляет 1024x1024 пикселя.

imageStyle

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

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

Тип: string.

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

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

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

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

imageGenerationsRequest

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

generateImagesResponse

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

imageResult

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

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

line

Объект строки содержимого, состоящий из соседней последовательности элементов содержимого, таких как слова и знаки выделения.

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
text	строка		Да
Охватывает	array	Массив диапазонов, представляющих обнаруженные объекты и сведения о ограничивающем поле.	Да

пядь

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

Имя.	Тип	Описание	Обязательное поле
text	строка	Текстовое содержимое диапазона, представляющего обнаруженный объект.	Да
offset	integer	Смещение символов в тексте, в котором начинается диапазон. Это смещение определяется как позиция первого символа диапазона, подсчитывая от начала текста как кодовые точки Юникода.	Да
length	integer	Длина диапазона в символах, измеряемая в кодовых точках Юникода.	Да
polygon	array	Массив объектов, представляющих точки в многоугольнике, который заключает обнаруженный объект.	Да

runCompletionUsage

Статистика использования, связанная с выполнением. Это значение будет иметь значение null , если выполнение не в состоянии терминала (т. е. in_progress, queuedи т. д.).

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

runStepCompletionUsage

Статистика использования, связанная с шагом выполнения. Это значение будет находиться null в состоянии in_progressшага выполнения.

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

assistantsApiResponseFormatOption

Указывает формат, который модель должна выводить. Совместим с GPT-4 Turbo и всеми моделями GPT-3.5 Turbo с тех пор gpt-3.5-turbo-1106.

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

Важно: при использовании режима JSON необходимо также указать модели создавать JSON самостоятельно с помощью системного или пользовательского сообщения. Без этого модель может создать неуправляемый поток пробелов до тех пор, пока поколение не достигнет предела маркера, в результате чего длительный и, казалось бы, "застрявший" запрос. Кроме того, обратите внимание, что содержимое сообщения может быть частично отрезано, если finish_reason="length", что указывает на превышение поколения max_tokens или беседа превысила максимальную длину контекста.

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

assistantsApiResponseFormat

Объект, описывающий ожидаемые выходные данные модели. Если json_object в run разрешено передавать только function тип tools . Если text модель может возвращать текст или любое необходимое значение.

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

type Enum: AssistantsApiResponseFormat

значение	Описание
text
json_object

assistantObject

Представляет объект assistant , который может вызывать модель и использовать средства.

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
id	строка	Идентификатор, на который можно ссылаться в конечных точках API.	Да
объект	строка	Тип объекта, который всегда `assistant`является .	Да
created_at	integer	Метка времени Unix (в секундах) для момента создания помощника.	Да
имя	строка	Имя помощника. Максимальная длина составляет 256 символов.	Да
описание	строка	Описание помощника. Максимальная длина — 512 символов.	Да
модель	строка	Идентификатор используемой модели. API моделей списка можно использовать для просмотра всех доступных моделей.	Да
инструкции	строка	Системные инструкции, которые использует помощник. Максимальная длина — 256 000 символов.	Да
средства	array	Список инструментов, включенных помощником. На помощника может быть не более 128 инструментов. Средства могут быть типами `code_interpreter`, `file_search`или `function`.	Да	[]
tool_resources	объект	Набор ресурсов, используемых средствами помощника. Ресурсы относятся к типу инструмента. Например, для `code_interpreter` средства требуется список идентификаторов файлов, а для `file_search` этого средства требуется список идентификаторов векторного хранилища.	No
metadata	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.	Да
Температура	number	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным.	No	1
top_p	number	Альтернативой выборке с температурой является так называемая выборка ядра, где модель рассматривает результаты маркеров с top_p всего массива значений вероятности. Таким образом, 0,1 означает, что учитываются только маркеры, входящие в верхние 10% массива значений вероятности. Как правило, мы рекомендуем изменить либо это значение, либо температуру, но не оба.	No	1
response_format	assistantsApiResponseFormatOption	Указывает формат, который модель должна выводить. Совместим с GPT-4 Turbo и всеми моделями GPT-3.5 Turbo с тех пор `gpt-3.5-turbo-1106`. Параметр включения `{ "type": "json_object" }` режима JSON, который гарантирует, что модель создает сообщение является допустимым JSON. Важно: при использовании режима JSON необходимо также указать модели создавать JSON самостоятельно с помощью системного или пользовательского сообщения. Без этого модель может создать неуправляемый поток пробелов до тех пор, пока поколение не достигнет предела маркера, в результате чего длительный и, казалось бы, "застрявший" запрос. Кроме того, обратите внимание, что содержимое сообщения может быть частично отрезано, если `finish_reason="length"`, что указывает на превышение поколения `max_tokens` или беседа превысила максимальную длину контекста.	No

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

code_interpreter

Имя.	Тип	Описание	По умолч.
file_ids	array	Список идентификаторов файлов, доступных средству `code_interpreter` . С инструментом может быть не более 20 файлов.	[]

file_search

Имя.	Тип	Описание	По умолч.
vector_store_ids	array	Идентификатор хранилища векторов, присоединенного к этому помощнику. К помощнику может быть подключено не более 1 векторного хранилища.

объект Enum: AssistantObjectType

значение	Описание
assistant	Тип объекта, который всегда является помощником

createAssistantRequest

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
модель			Да
имя	строка	Имя помощника. Максимальная длина составляет 256 символов.	No
описание	строка	Описание помощника. Максимальная длина — 512 символов.	No
инструкции	строка	Системные инструкции, которые использует помощник. Максимальная длина — 256 000 символов.	No
средства	array	Список инструментов, включенных помощником. На помощника может быть не более 128 инструментов. Средства могут быть типами `code_interpreter`, `retrieval`или `function`.	No	[]
tool_resources	объект	Набор ресурсов, используемых средствами помощника. Ресурсы относятся к типу инструмента. Например, для `code_interpreter` средства требуется список идентификаторов файлов, а для `file_search` этого средства требуется список идентификаторов векторного хранилища.	No
metadata	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.	No
Температура	number	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным.	No	1
top_p	number	Альтернативой выборке с температурой является так называемая выборка ядра, где модель рассматривает результаты маркеров с top_p всего массива значений вероятности. Таким образом, 0,1 означает, что учитываются только маркеры, входящие в верхние 10% массива значений вероятности. Как правило, мы рекомендуем изменить либо это значение, либо температуру, но не оба.	No	1
response_format	assistantsApiResponseFormatOption	Указывает формат, который модель должна выводить. Совместим с GPT-4 Turbo и всеми моделями GPT-3.5 Turbo с тех пор `gpt-3.5-turbo-1106`. Параметр включения `{ "type": "json_object" }` режима JSON, который гарантирует, что модель создает сообщение является допустимым JSON. Важно: при использовании режима JSON необходимо также указать модели создавать JSON самостоятельно с помощью системного или пользовательского сообщения. Без этого модель может создать неуправляемый поток пробелов до тех пор, пока поколение не достигнет предела маркера, в результате чего длительный и, казалось бы, "застрявший" запрос. Кроме того, обратите внимание, что содержимое сообщения может быть частично отрезано, если `finish_reason="length"`, что указывает на превышение поколения `max_tokens` или беседа превысила максимальную длину контекста.	No

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

code_interpreter

Имя.	Тип	Описание	По умолч.
file_ids	array	Список идентификаторов файлов, доступных средству `code_interpreter` . С инструментом может быть не более 20 файлов.	[]

file_search

Имя.	Тип	Описание	По умолч.
vector_store_ids	array	Хранилище векторов, присоединенное к этому помощнику. К помощнику может быть подключено не более 1 векторного хранилища.
vector_stores	array	Помощник по созданию векторного хранилища с file_ids и присоединению его к этому помощнику. К помощнику может быть подключено не более 1 векторного хранилища.

modifyAssistantRequest

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
модель			No
name	строка	Имя помощника. Максимальная длина составляет 256 символов.	No
описание	строка	Описание помощника. Максимальная длина — 512 символов.	No
инструкции	строка	Системные инструкции, которые использует помощник. Максимальная длина — 32768 символов.	No
средства	array	Список инструментов, включенных помощником. На помощника может быть не более 128 инструментов. Средства могут быть типами `code_interpreter`, `retrieval`или `function`.	No	[]
tool_resources	объект	Набор ресурсов, используемых средствами помощника. Ресурсы относятся к типу инструмента. Например, для `code_interpreter` средства требуется список идентификаторов файлов, а для `file_search` этого средства требуется список идентификаторов векторного хранилища.	No
metadata	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.	No
Температура	number	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным.	No	1
top_p	number	Альтернативой выборке с температурой является так называемая выборка ядра, где модель рассматривает результаты маркеров с top_p всего массива значений вероятности. Таким образом, 0,1 означает, что учитываются только маркеры, входящие в верхние 10% массива значений вероятности. Как правило, мы рекомендуем изменить либо это значение, либо температуру, но не оба.	No	1
response_format	assistantsApiResponseFormatOption	Указывает формат, который модель должна выводить. Совместим с GPT-4 Turbo и всеми моделями GPT-3.5 Turbo с тех пор `gpt-3.5-turbo-1106`. Параметр включения `{ "type": "json_object" }` режима JSON, который гарантирует, что модель создает сообщение является допустимым JSON. Важно: при использовании режима JSON необходимо также указать модели создавать JSON самостоятельно с помощью системного или пользовательского сообщения. Без этого модель может создать неуправляемый поток пробелов до тех пор, пока поколение не достигнет предела маркера, в результате чего длительный и, казалось бы, "застрявший" запрос. Кроме того, обратите внимание, что содержимое сообщения может быть частично отрезано, если `finish_reason="length"`, что указывает на превышение поколения `max_tokens` или беседа превысила максимальную длину контекста.	No

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

code_interpreter

Имя.	Тип	Описание	По умолч.
file_ids	array	Переопределяет список идентификаторов файлов, доступных средству `code_interpreter` . С инструментом может быть не более 20 файлов.	[]

file_search

Имя.	Тип	Описание	По умолч.
vector_store_ids	array	Переопределяет хранилище векторов, подключенное к этому помощнику. К помощнику может быть подключено не более 1 векторного хранилища.

deleteAssistantResponse

Имя.	Тип	Обязательное поле
id	string	Да
deleted	boolean	Да
объект	строка	Да

объект Enum: DeleteAssistantResponseState

значение	Описание
assistant.deleted

listAssistantsResponse

Имя.	Тип	Обязательное поле
объект	строка	Да
.	array	Да
first_id	строка	Да
last_id	строка	Да
has_more	boolean	Да

assistantToolsCode

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

type Enum: assistantToolsCodeType

значение	Описание
code_interpreter

assistantToolsFileSearch

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
type	строка	Тип определяемого средства: `file_search`	Да
file_search	объект	Переопределяет средство поиска файлов.	No

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

max_num_results

Имя.	Тип	Описание	По умолч.
max_num_results	integer	Максимальное количество результатов, которые должен выводить средство поиска файлов. Значение по умолчанию — 20 для моделей gpt-4* и 5 для gpt-3.5-turbo. Это число должно быть от 1 до 50 включительно. Обратите внимание, что средство поиска файлов может выводить меньше `max_num_results` результатов.

type Enum: assistantToolsFileSearchType

значение	Описание
file_search

assistantToolsFileSearchTypeOnly

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

type Enum: assistantToolsFileSearchType

значение	Описание
file_search

assistantToolsFunction

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

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

описание

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

name

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

parameters

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

Type Enum: assistantToolsFunction

значение	Описание
function

усечениеObject

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

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
type	строка	Стратегия усечения, используемая для потока. Значение по умолчанию — `auto`. Если задано значение `last_messages`, поток будет усечен до n последних сообщений в потоке. Если задано значение `auto`, сообщения в середине потока будут удалены, чтобы соответствовать длине контекста модели. `max_prompt_tokens`	Да
last_messages	integer	Количество последних сообщений из потока при создании контекста для выполнения.	No

Type Enum: TruncationType

значение	Описание
авто
last_messages

assistantsApiToolChoiceOption

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

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

assistantsNamedToolChoice

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

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

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

name

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

type Enum: AssistantsNamedToolChoiceType

значение	Описание
function
code_interpreter
file_search

runObject

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

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
id	строка	Идентификатор, на который можно ссылаться в конечных точках API.	Да
объект	строка	Тип объекта, который всегда `thread.run`является .	Да
created_at	integer	Метка времени Unix (в секундах) для момента создания запуска.	Да
thread_id	строка	Идентификатор потока, выполняемого в рамках этого запуска.	Да
assistant_id	строка	Идентификатор помощника, используемого для выполнения этого запуска.	Да
статус	строка	Состояние выполнения, которое может быть , , , , , `cancelled`, `completedfailed`или `expired`. `cancellingrequires_actionin_progressqueued`	Да
required_action	объект	Сведения о действии, необходимом для продолжения выполнения. `null` Если никаких действий не требуется.	Да
last_error	объект	Последняя ошибка, связанная с этим выполнением. `null` Если ошибок нет.	Да
expires_at	integer	Метка времени Unix (в секундах) для истечения срока действия выполнения.	Да
started_at	integer	Метка времени Unix (в секундах) для начала выполнения.	Да
cancelled_at	integer	Метка времени Unix (в секундах) для момента отмены выполнения.	Да
failed_at	integer	Метка времени Unix (в секундах) для момента сбоя выполнения.	Да
completed_at	integer	Метка времени Unix (в секундах) для завершения выполнения.	Да
incomplete_details	объект	Сведения о том, почему выполнение является неполным. Будет, `null` если выполнение не является неполным.	Да
модель	строка	Модель, используемая помощником для этого запуска.	Да
инструкции	строка	Инструкции, используемые помощником для этого запуска.	Да
средства	array	Список инструментов, используемых помощником для этого запуска.	Да	[]
metadata	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.	Да
использование	runCompletionUsage	Статистика использования, связанная с выполнением. Это значение будет иметь значение `null` , если выполнение не в состоянии терминала (т. е. `in_progress`, `queued`и т. д.).	Да
Температура	number	Температура выборки, используемая для этого запуска. Если значение не задано, значение по умолчанию — 1.	No
top_p	number	Значение выборки ядра, используемое для этого запуска. Если значение не задано, значение по умолчанию — 1.	No
max_prompt_tokens	integer	Максимальное количество маркеров запроса, указанных в ходе выполнения.	Да
max_completion_tokens	integer	Максимальное количество маркеров завершения, указанных в ходе выполнения.	Да
truncation_strategy	усечениеObject	Определяет, как поток будет усечен до выполнения. Используйте это для управления начальным окном контекста выполнения.	Да
tool_choice	assistantsApiToolChoiceOption	Определяет, какое средство (если таковое) вызывается моделью. `none` означает, что модель не вызывает средства и вместо этого создает сообщение. `auto` является значением по умолчанию и означает, что модель может выбирать между созданием сообщения или вызовом средства. Указание определенного инструмента, например `{"type": "file_search"}` или `{"type": "function", "function": {"name": "my_function"}}` принудительное вызов модели.	Да
parallel_tool_calls	ParallelToolCalls	Следует ли включить параллельные вызовы функций во время использования средства.	No	Истина
response_format	assistantsApiResponseFormatOption	Указывает формат, который модель должна выводить. Совместим с GPT-4 Turbo и всеми моделями GPT-3.5 Turbo с тех пор `gpt-3.5-turbo-1106`. Параметр включения `{ "type": "json_object" }` режима JSON, который гарантирует, что модель создает сообщение является допустимым JSON. Важно: при использовании режима JSON необходимо также указать модели создавать JSON самостоятельно с помощью системного или пользовательского сообщения. Без этого модель может создать неуправляемый поток пробелов до тех пор, пока поколение не достигнет предела маркера, в результате чего длительный и, казалось бы, "застрявший" запрос. Кроме того, обратите внимание, что содержимое сообщения может быть частично отрезано, если `finish_reason="length"`, что указывает на превышение поколения `max_tokens` или беседа превысила максимальную длину контекста.	Да

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

type

Имя.	Тип	Описание	По умолч.
type	строка	На данный момент это всегда `submit_tool_outputs`.

submit_tool_outputs

Имя.	Тип	Описание	По умолч.
tool_calls	array	Список соответствующих вызовов средства.

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

кодом

Имя.	Тип	Описание	По умолч.
кодом	строка	Возможные значения: `server_error` или `rate_limit_exceeded`.

message

Имя.	Тип	Описание	По умолч.
message	строка	Описание ошибки, доступной для чтения человеком.

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

reason

Имя.	Тип	Описание	По умолч.
reason	строка	Причина, по которой выполнение является неполным. Это указывает, какой определенный предел маркера был достигнут в течение выполнения.

объект Enum: runObjectType

значение	Описание
thread.run	Тип объекта run, который всегда является thread.run

Состояние перечисления: RunObjectStatus

значение	Описание
Очереди	Состояние очереди
in_progress	Состояние in_progress
requires_action	Состояние required_action
Отмена	Состояние отмены
cancelled	Отмененное состояние
ошибка	Состояние сбоя
Завершено	Завершенное состояние
срок действия истек	Состояние с истекшим сроком действия

createRunRequest

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
assistant_id	строка	Идентификатор помощника, используемого для выполнения этого выполнения.	Да
модель	строка	Идентификатор развертывания модели, используемой для выполнения этого запуска. Если здесь указано значение, оно переопределит модель, связанную с помощником. В противном случае будет использоваться модель, связанная с помощником.	No
инструкции	строка	Переопределите системное сообщение помощника по умолчанию. Это полезно для изменения поведения на основе каждого запуска.	No
additional_instructions	строка	Добавляет дополнительные инструкции в конце инструкций для выполнения. Это полезно для изменения поведения на основе каждого запуска без переопределения других инструкций.	No
additional_messages	array	Добавляет дополнительные сообщения в поток перед созданием запуска.	No
средства	array	Переопределите средства, которые помощник может использовать для этого запуска. Это полезно для изменения поведения на основе каждого запуска.	No
metadata	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.	No
Температура	number	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным.	No	1
top_p	number	Альтернативой выборке с температурой является так называемая выборка ядра, где модель рассматривает результаты маркеров с top_p всего массива значений вероятности. Таким образом, 0,1 означает, что учитываются только маркеры, входящие в верхние 10% массива значений вероятности. Как правило, мы рекомендуем изменить либо это значение, либо температуру, но не оба.	No	1
потоковая передача	boolean	Если `true`возвращает поток событий, которые происходят во время событий запуска от имени сервера, завершая выполнение в состоянии терминала с сообщением `data: [DONE]` .	No
max_prompt_tokens	integer	Максимальное количество маркеров запроса, которые могут использоваться в ходе выполнения. Выполнение сделает все возможное, чтобы использовать только количество маркеров запроса, указанных в нескольких поворотах выполнения. Если выполнение превышает указанное число маркеров запроса, выполнение завершится состоянием `incomplete`. Дополнительные сведения см. в разделе `incomplete_details` .	No
max_completion_tokens	integer	Максимальное количество маркеров завершения, которые могут использоваться в ходе выполнения. Выполнение сделает все возможное, чтобы использовать только количество маркеров завершения, указанных в нескольких поворотах выполнения. Если выполнение превышает указанное число маркеров завершения, выполнение завершится состоянием `incomplete`. Дополнительные сведения см. в разделе `incomplete_details` .	No
truncation_strategy	усечениеObject	Определяет, как поток будет усечен до выполнения. Используйте это для управления начальным окном контекста выполнения.	No
tool_choice	assistantsApiToolChoiceOption	Определяет, какое средство (если таковое) вызывается моделью. `none` означает, что модель не вызывает средства и вместо этого создает сообщение. `auto` является значением по умолчанию и означает, что модель может выбирать между созданием сообщения или вызовом средства. Указание определенного инструмента, например `{"type": "file_search"}` или `{"type": "function", "function": {"name": "my_function"}}` принудительное вызов модели.	No
parallel_tool_calls	ParallelToolCalls	Следует ли включить параллельные вызовы функций во время использования средства.	No	Истина
response_format	assistantsApiResponseFormatOption	Указывает формат, который модель должна выводить. Совместим с GPT-4 Turbo и всеми моделями GPT-3.5 Turbo с тех пор `gpt-3.5-turbo-1106`. Параметр включения `{ "type": "json_object" }` режима JSON, который гарантирует, что модель создает сообщение является допустимым JSON. Важно: при использовании режима JSON необходимо также указать модели создавать JSON самостоятельно с помощью системного или пользовательского сообщения. Без этого модель может создать неуправляемый поток пробелов до тех пор, пока поколение не достигнет предела маркера, в результате чего длительный и, казалось бы, "застрявший" запрос. Кроме того, обратите внимание, что содержимое сообщения может быть частично отрезано, если `finish_reason="length"`, что указывает на превышение поколения `max_tokens` или беседа превысила максимальную длину контекста.	No

listRunsResponse

Имя.	Тип	Обязательное поле
объект	строка	Да
.	array	Да
first_id	строка	Да
last_id	строка	Да
has_more	boolean	Да

modifyRunRequest

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

submitToolOutputsRunRequest

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

runToolCallObject

Объекты вызова средства

Имя.	Тип	Описание	Обязательное поле
id	строка	Идентификатор вызова средства. Этот идентификатор должен ссылаться при отправке выходных данных средства с помощью выходных данных средства отправки для запуска конечной точки.	Да
type	строка	Для вызова выходных данных требуется тип средства. На данный момент это всегда `function`.	Да
function	объект	Определение функции.	Да

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

name

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

аргументы

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

type Enum: RunToolCallObjectType

значение	Описание
function

createThreadAndRunRequest

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
assistant_id	строка	Идентификатор помощника, используемого для выполнения этого выполнения.	Да
среды	createThreadRequest		No
модель	строка	Имя развертывания модели, используемой для выполнения этого запуска. Если здесь указано значение, оно переопределит модель, связанную с помощником. В противном случае будет использоваться модель, связанная с помощником.	No
инструкции	строка	Переопределите системное сообщение помощника по умолчанию. Это полезно для изменения поведения на основе каждого запуска.	No
средства	array	Переопределите средства, которые помощник может использовать для этого запуска. Это полезно для изменения поведения на основе каждого запуска.	No
tool_resources	объект	Набор ресурсов, используемых средствами помощника. Ресурсы относятся к типу инструмента. Например, для `code_interpreter` средства требуется список идентификаторов файлов, а для `file_search` этого средства требуется список идентификаторов векторного хранилища.	No
metadata	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.	No
Температура	number	Какая температура выборки используется в диапазоне от 0 до 2. Более высокие значения, такие как 0,8, делают выходные данные более случайными, а более низкие значения, такие как 0,2, делают его более ориентированным и детерминированным.	No	1
top_p	number	Альтернативой выборке с температурой является так называемая выборка ядра, где модель рассматривает результаты маркеров с top_p всего массива значений вероятности. Таким образом, 0,1 означает, что учитываются только маркеры, входящие в верхние 10% массива значений вероятности. Как правило, мы рекомендуем изменить либо это значение, либо температуру, но не оба.	No	1
потоковая передача	boolean	Если `true`возвращает поток событий, которые происходят во время событий запуска от имени сервера, завершая выполнение в состоянии терминала с сообщением `data: [DONE]` .	No
stream_options	chatCompletionStreamOptions	Параметры потокового ответа. Этот параметр устанавливается только при установке `stream: true`.	No	нет
max_prompt_tokens	integer	Максимальное количество маркеров запроса, которые могут использоваться в ходе выполнения. Выполнение сделает все возможное, чтобы использовать только количество маркеров запроса, указанных в нескольких поворотах выполнения. Если выполнение превышает указанное число маркеров запроса, выполнение завершится состоянием `incomplete`. Дополнительные сведения см. в разделе `incomplete_details` .	No
max_completion_tokens	integer	Максимальное количество маркеров завершения, которые могут использоваться в ходе выполнения. Выполнение сделает все возможное, чтобы использовать только количество маркеров завершения, указанных в нескольких поворотах выполнения. Если выполнение превышает указанное число маркеров завершения, выполнение завершится состоянием `incomplete`. Дополнительные сведения см. в разделе `incomplete_details` .	No
truncation_strategy	усечениеObject	Определяет, как поток будет усечен до выполнения. Используйте это для управления начальным окном контекста выполнения.	No
tool_choice	assistantsApiToolChoiceOption	Определяет, какое средство (если таковое) вызывается моделью. `none` означает, что модель не вызывает средства и вместо этого создает сообщение. `auto` является значением по умолчанию и означает, что модель может выбирать между созданием сообщения или вызовом средства. Указание определенного инструмента, например `{"type": "file_search"}` или `{"type": "function", "function": {"name": "my_function"}}` принудительное вызов модели.	No
parallel_tool_calls	ParallelToolCalls	Следует ли включить параллельные вызовы функций во время использования средства.	No	Истина
response_format	assistantsApiResponseFormatOption	Указывает формат, который модель должна выводить. Совместим с GPT-4 Turbo и всеми моделями GPT-3.5 Turbo с тех пор `gpt-3.5-turbo-1106`. Параметр включения `{ "type": "json_object" }` режима JSON, который гарантирует, что модель создает сообщение является допустимым JSON. Важно: при использовании режима JSON необходимо также указать модели создавать JSON самостоятельно с помощью системного или пользовательского сообщения. Без этого модель может создать неуправляемый поток пробелов до тех пор, пока поколение не достигнет предела маркера, в результате чего длительный и, казалось бы, "застрявший" запрос. Кроме того, обратите внимание, что содержимое сообщения может быть частично отрезано, если `finish_reason="length"`, что указывает на превышение поколения `max_tokens` или беседа превысила максимальную длину контекста.	No

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

code_interpreter

Имя.	Тип	Описание	По умолч.
file_ids	array	Список идентификаторов файлов, доступных средству `code_interpreter` . С инструментом может быть не более 20 файлов.	[]

file_search

Имя.	Тип	Описание	По умолч.
vector_store_ids	array	Идентификатор хранилища векторов, присоединенного к этому помощнику. К помощнику может быть подключено не более 1 векторного хранилища.

threadObject

Представляет поток, содержащий сообщения.

Имя.	Тип	Описание	Обязательное поле
id	строка	Идентификатор, на который можно ссылаться в конечных точках API.	Да
объект	строка	Тип объекта, который всегда `thread`является .	Да
created_at	integer	Метка времени Unix (в секундах) для момента создания потока.	Да
tool_resources	объект	Набор ресурсов, доступных средствам помощника в этом потоке. Ресурсы относятся к типу инструмента. Например, для `code_interpreter` средства требуется список идентификаторов файлов, а для `file_search` этого средства требуется список идентификаторов векторного хранилища.	Да
metadata	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.	Да

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

code_interpreter

Имя.	Тип	Описание	По умолч.
file_ids	array	Список идентификаторов файлов, доступных средству `code_interpreter` . С инструментом может быть не более 20 файлов.	[]

file_search

Имя.	Тип	Описание	По умолч.
vector_store_ids	array	Хранилище векторов, присоединенное к этому потоку. К потоку может быть подключено не более 1 векторного хранилища.

объект Enum: ThreadObjectType

значение	Описание
среды	Тип объекта потока, который всегда является `thread`

createThreadRequest

Имя.	Тип	Описание	Обязательное поле
messages	array	Список сообщений для запуска потока.	No
tool_resources	объект	Набор ресурсов, доступных средствам помощника в этом потоке. Ресурсы относятся к типу инструмента. Например, для `code_interpreter` средства требуется список идентификаторов файлов, а для `file_search` этого средства требуется список идентификаторов векторного хранилища.	No
metadata	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.	No

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

code_interpreter

Имя.	Тип	Описание	По умолч.
file_ids	array	Список идентификаторов файлов, доступных средству `code_interpreter` . С инструментом может быть не более 20 файлов.	[]

file_search

Имя.	Тип	Описание	По умолч.
vector_store_ids	array	Хранилище векторов, присоединенное к этому потоку. К потоку может быть подключено не более 1 векторного хранилища.
vector_stores	array	Вспомогательный объект для создания хранилища векторов с file_ids и присоединения его к этому потоку. К потоку может быть подключено не более 1 векторного хранилища.

modifyThreadRequest

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

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

code_interpreter

Имя.	Тип	Описание	По умолч.
file_ids	array	Список идентификаторов файлов, доступных средству `code_interpreter` . С инструментом может быть не более 20 файлов.	[]

file_search

Имя.	Тип	Описание	По умолч.
vector_store_ids	array	Хранилище векторов, присоединенное к этому потоку. К потоку может быть подключено не более 1 векторного хранилища.

deleteThreadResponse

Имя.	Тип	Обязательное поле
id	string	Да
deleted	boolean	Да
объект	строка	Да

объект Enum: DeleteThreadResponseObjectState

значение	Описание
thread.deleted	Состояние объекта ответа на поток удаления, которое является `thread.deleted`

listThreadsResponse

Имя.	Тип	Обязательное поле
объект	строка	Да
.	array	Да
first_id	строка	Да
last_id	строка	Да
has_more	boolean	Да

messageObject

Представляет сообщение в потоке.

Имя.	Тип	Описание	Обязательное поле
id	строка	Идентификатор, на который можно ссылаться в конечных точках API.	Да
объект	строка	Тип объекта, который всегда `thread.message`является .	Да
created_at	integer	Метка времени Unix (в секундах) для момента создания сообщения.	Да
thread_id	строка	идентификатор потока, к которому принадлежит это сообщение.	Да
статус	строка	Состояние сообщения, которое может быть либо `in_progress`, `incomplete`либо `completed`.	Да
incomplete_details	объект	В неполном сообщении сведения о том, почему сообщение является неполным.	Да
completed_at	integer	Метка времени Unix (в секундах) для завершения сообщения.	Да
incomplete_at	integer	Метка времени Unix (в секундах) для момента, когда сообщение было отмечено как неполное.	Да
роль	строка	Сущность, создающая сообщение. Возможные значения: `user` или `assistant`.	Да
content	array	Содержимое сообщения в массиве текста и(или) изображений.	Да
assistant_id	строка	Если применимо, идентификатор помощника, создающего это сообщение.	Да
run_id	строка	Если применимо, идентификатор выполнения, связанный с автором этого сообщения.	Да
attachments	array	Список файлов, присоединенных к сообщению, и инструменты, к которому они были добавлены.	Да
metadata	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.	Да

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

reason

Имя.	Тип	Описание	По умолч.
reason	строка	Причина, по которой сообщение является неполным.

объект Enum: MessageObjectType

значение	Описание
thread.message	Тип объекта сообщения, который является `thread.message`

Состояние перечисления: MessageObjectStatus

значение	Описание
in_progress
неполный
Завершено

перечисление роли: MessageObjectRole

значение	Описание
Пользователь
assistant

messageDeltaObject

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

Имя.	Тип	Описание	Обязательное поле
id	строка	Идентификатор сообщения, на которое можно ссылаться в конечных точках API.	Да
объект	строка	Тип объекта, который всегда `thread.message.delta`является .	Да
delta	объект	Разностное значение, содержащее поля, измененные в сообщении.	Да

Свойства для разностной области

роль

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

content

Имя.	Тип	Описание	По умолч.
content	array	Содержимое сообщения в массиве текста и(или) изображений.

объект Enum: MessageDeltaObjectType

значение	Описание
thread.message.delta

createMessageRequest

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

role Enum: CreateMessageRequestRole

значение	Описание
Пользователь
assistant

modifyMessageRequest

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

deleteMessageResponse

Имя.	Тип	Обязательное поле
id	string	Да
deleted	boolean	Да
объект	строка	Да

объект Enum: DeleteMessageResponseObject

значение	Описание
thread.message.deleted	Состояние объекта ответа на удаление сообщения

listMessagesResponse

Имя.	Тип	Обязательное поле
объект	строка	Да
.	array	Да
first_id	строка	Да
last_id	строка	Да
has_more	boolean	Да

messageContentImageFileObject

Ссылается на файл изображения в содержимом сообщения.

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

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

file_id

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

type Enum: MessageContentImageFileObjectType

значение	Описание
image_file	Тип файла изображения содержимого сообщения

messageContentTextObject

Текстовое содержимое, которое входит в сообщение.

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

Свойства для текста

значение

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

annotations

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

type Enum: messageContentTextObjectType

значение	Описание
text	Тип текстового объекта содержимого сообщения

messageContentTextAnnotationsFileCitationObject

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

Имя.	Тип	Описание	Обязательное поле
type	строка	Всегда`file_citation`.	Да
text	строка	Текст в содержимом сообщения, который необходимо заменить.	Да
file_citation	объект		Да
start_index	integer		Да
end_index	integer		Да

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

file_id

Имя.	Тип	Описание	По умолч.
file_id	строка	Идентификатор конкретного файла, из из который находится ссылка.

Type Enum: FileCitationObjectType

значение	Описание
file_citation	Тип объекта ссылки на файл

messageContentTextAnnotationsFilePathObject

URL-адрес файла, созданного при создании файла помощником, который использовал code_interpreter средство для создания файла.

Имя.	Тип	Описание	Обязательное поле
type	строка	Всегда`file_path`.	Да
text	строка	Текст в содержимом сообщения, который необходимо заменить.	Да
file_path	объект		Да
start_index	integer		Да
end_index	integer		Да

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

file_id

Имя.	Тип	Описание	По умолч.
file_id	строка	Идентификатор созданного файла.

type Enum: FilePathObjectType

значение	Описание
file_path	Тип объекта пути к файлу

messageDeltaContentImageFileObject

Ссылается на файл изображения в содержимом сообщения.

Имя.	Тип	Описание	Обязательное поле
index	integer	Индекс части содержимого в сообщении.	Да
type	строка	Всегда`image_file`.	Да
image_file	объект		No

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

file_id

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

type Enum: MessageDeltaContentImageFileObjectType

значение	Описание
image_file

messageDeltaContentTextObject

Текстовое содержимое, которое входит в сообщение.

Имя.	Тип	Описание	Обязательное поле
index	integer	Индекс части содержимого в сообщении.	Да
type	строка	Всегда`text`.	Да
text	объект		No

Свойства для текста

значение

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

annotations

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

type Enum: MessageDeltaContentTextObjectType

значение	Описание
text

messageDeltaContentTextAnnotationsFileCitationObject

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

Имя.	Тип	Описание	Обязательное поле
index	integer	Индекс заметки в части текстового содержимого.	Да
type	строка	Всегда`file_citation`.	Да
text	строка	Текст в содержимом сообщения, который необходимо заменить.	No
file_citation	объект		No
start_index	integer		No
end_index	integer		No

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

file_id

Имя.	Тип	Описание	По умолч.
file_id	строка	Идентификатор конкретного файла, из из который находится ссылка.

quote

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

type Enum: MessageDeltaContentTextAnnotationsFileCitationObjectType

значение	Описание
file_citation

messageDeltaContentTextAnnotationsFilePathObject

Имя.	Тип	Описание	Обязательное поле
index	integer	Индекс заметки в части текстового содержимого.	Да
type	строка	Всегда`file_path`.	Да
text	строка	Текст в содержимом сообщения, который необходимо заменить.	No
file_path	объект		No
start_index	integer		No
end_index	integer		No

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

file_id

Имя.	Тип	Описание	По умолч.
file_id	строка	Идентификатор созданного файла.

type Enum: MessageDeltaContentTextAnnotationsFilePathObjectType

значение	Описание
file_path

runStepObject

Представляет шаг выполнения выполнения выполнения.

Имя.	Тип	Описание	Обязательное поле
id	строка	Идентификатор шага выполнения, на который можно ссылаться в конечных точках API.	Да
объект	строка	Тип объекта, который всегда `assistant.run.step`является .	Да
created_at	integer	Метка времени Unix (в секундах) для момента создания шага выполнения.	Да
assistant_id	строка	Идентификатор помощника, связанного с шагом выполнения.	Да
thread_id	строка	Идентификатор выполняемого потока.	Да
run_id	строка	Идентификатор выполнения, на который выполняется этот шаг, является частью.	Да
type	строка	Тип шага выполнения, который может быть либо `message_creation` `tool_calls`.	Да
статус	строка	Состояние выполнения, которое может быть либо `in_progress`, либо `expiredcancelledfailedcompleted`.	Да
step_details	runStepDetailsMessageCreationObject или runStepDetailsToolCallsObject	Сведения о шаге выполнения.	Да
last_error	объект	Последняя ошибка, связанная с этим шагом выполнения. `null` Если ошибок нет.	Да
expired_at	integer	Метка времени Unix (в секундах) для истечения срока действия выполнения. Шаг считается истекшим, если срок действия родительского запуска истек.	Да
cancelled_at	integer	Метка времени Unix (в секундах) для момента отмены шага выполнения.	Да
failed_at	integer	Метка времени Unix (в секундах) для момента сбоя шага выполнения.	Да
completed_at	integer	Метка времени Unix (в секундах) для завершения шага выполнения.	Да
metadata	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.	Да

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

кодом

Имя.	Тип	Описание	По умолч.
кодом	строка	Возможные значения: `server_error` или `rate_limit_exceeded`.

message

Имя.	Тип	Описание	По умолч.
message	строка	Описание ошибки, доступной для чтения человеком.

объект Enum: RunStepObjectType

значение	Описание
assistant.run.step	Тип объекта, который всегда является `assistant.run.step`

type Enum: RunStepObjectType

значение	Описание
message_creation	Шаг выполнения message_creation
tool_calls	Шаг выполнения tool_calls

состояние Перечисления: RunStepObjectStatus

значение	Описание
in_progress	Состояние выполнения in_progress
cancelled	Состояние отмененного выполнения
ошибка	Состояние отмененного выполнения
Завершено	Состояние отмененного выполнения
срок действия истек	Состояние отмененного выполнения

runStepDeltaObject

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

Имя.	Тип	Описание	Обязательное поле
id	строка	Идентификатор шага выполнения, на который можно ссылаться в конечных точках API.	Да
объект	строка	Тип объекта, который всегда `thread.run.step.delta`является .	Да
delta	объект	Разностное значение, содержащее поля, измененные на шаге выполнения.	Да

Свойства для разностной области

step_details

Имя.	Тип	Описание	По умолч.
step_details	runStepDeltaStepDetailsMessageCreationObject или runStepDeltaStepDetailsToolCallsObject	Сведения о шаге выполнения.

объект Enum: RunStepDeltaObjectType

значение	Описание
thread.run.step.delta

listRunStepsResponse

Имя.	Тип	Обязательное поле
объект	строка	Да
.	array	Да
first_id	строка	Да
last_id	строка	Да
has_more	boolean	Да

runStepDetailsMessageCreationObject

Сведения о создании сообщения на шаге выполнения.

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

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

message_id

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

type Enum: RunStepDetailsMessageCreationObjectType

значение	Описание
message_creation

runStepDeltaStepDetailsMessageCreationObject

Сведения о создании сообщения на шаге выполнения.

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
type	строка	Всегда`message_creation`.	Да
message_creation	объект		No

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

message_id

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

type Enum: RunStepDeltaStepDetailsMessageCreationObjectType

значение	Описание
message_creation

runStepDetailsToolCallsObject

Сведения о вызове средства.

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
type	строка	Всегда`tool_calls`.	Да
tool_calls	array	Массив инструментов вызывает этап выполнения. Они могут быть связаны с одним из трех типов инструментов: `code_interpreterretrieval` или `function`.	Да

type Enum: RunStepDetailsToolCallsObjectType

значение	Описание
tool_calls

runStepDeltaStepDetailsToolCallsObject

Сведения о вызове средства.

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
type	строка	Всегда`tool_calls`.	Да
tool_calls	array	Массив инструментов вызывает этап выполнения. Они могут быть связаны с одним из трех типов инструментов: `code_interpreterfile_search` или `function`.	No

type Enum: RunStepDeltaStepDetailsToolCallsObjectType

значение	Описание
tool_calls

runStepDetailsToolCallsCodeObject

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

Имя.	Тип	Описание	Обязательное поле
id	строка	Идентификатор вызова средства.	Да
type	строка	Тип вызова средства. Это всегда будет для `code_interpreter` этого типа вызова средства.	Да
code_interpreter	объект	Определение вызова средства интерпретатора кода.	Да

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

input

Имя.	Тип	Описание	По умолч.
Входные данные	строка	Входные данные вызова средства интерпретатора кода.

выходные данные

Имя.	Тип	Описание	По умолч.
выходные данные	array	Выходные данные вызова средства интерпретатора кода. Интерпретатор кода может выводить один или несколько элементов, включая текст (`logs`) или изображения (`image`). Каждая из них представлена различным типом объекта.

type Enum: RunStepDetailsToolCallsCodeObjectType

значение	Описание
code_interpreter

runStepDeltaStepDetailsToolCallsCodeObject

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

Имя.	Тип	Описание	Обязательное поле
index	integer	Индекс вызова средства в массиве вызовов средства.	Да
id	строка	Идентификатор вызова средства.	No
type	строка	Тип вызова средства. Это всегда будет для `code_interpreter` этого типа вызова средства.	Да
code_interpreter	объект	Определение вызова средства интерпретатора кода.	No

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

input

Имя.	Тип	Описание	По умолч.
Входные данные	строка	Входные данные вызова средства интерпретатора кода.

выходные данные

Имя.	Тип	Описание	По умолч.
выходные данные	array	Выходные данные вызова средства интерпретатора кода. Интерпретатор кода может выводить один или несколько элементов, включая текст (`logs`) или изображения (`image`). Каждая из них представлена различным типом объекта.

type Enum: RunStepDeltaStepDetailsToolCallsCodeObjectType

значение	Описание
code_interpreter

runStepDetailsToolCallsCodeOutputLogsObject

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

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

type Enum: RunStepDetailsToolCallsCodeOutputLogsObjectType

значение	Описание
журналы

runStepDeltaStepDetailsToolCallsCodeOutputLogsObject

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

Имя.	Тип	Описание	Обязательное поле
index	integer	Индекс выходных данных в массиве выходных данных.	Да
type	строка	Всегда`logs`.	Да
журналы	строка	Вывод текста из вызова средства интерпретатора кода.	No

type Enum: RunStepDeltaStepDetailsToolCallsCodeOutputLogsObjectType

значение	Описание
журналы

runStepDetailsToolCallsCodeOutputImageObject

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

Свойства изображения

file_id

Имя.	Тип	Описание	По умолч.
file_id	строка	Идентификатор файла изображения.

type Enum: RunStepDetailsToolCallsCodeOutputImageObjectType

значение	Описание
Изображение

runStepDeltaStepDetailsToolCallsCodeOutputImageObject

Имя.	Тип	Описание	Обязательное поле
index	integer	Индекс выходных данных в массиве выходных данных.	Да
type	строка	Всегда`image`.	Да
Изображение	объект		No

Свойства изображения

file_id

Имя.	Тип	Описание	По умолч.
file_id	строка	Идентификатор файла изображения.

type Enum: RunStepDeltaStepDetailsToolCallsCodeOutputImageObject

значение	Описание
Изображение

runStepDetailsToolCallsFileSearchObject

Имя.	Тип	Описание	Обязательное поле
id	строка	Идентификатор объекта вызова средства.	Да
type	строка	Тип вызова средства. Это всегда будет для `file_search` этого типа вызова средства.	Да
file_search	объект	В настоящее время это всегда будет пустым объектом.	Да

type Enum: RunStepDetailsToolCallsFileSearchObjectType

значение	Описание
file_search

runStepDeltaStepDetailsToolCallsFileSearchObject

Имя.	Тип	Описание	Обязательное поле
index	integer	Индекс вызова средства в массиве вызовов средства.	Да
id	строка	Идентификатор объекта вызова средства.	No
type	строка	Тип вызова средства. Это всегда будет для `retrieval` этого типа вызова средства.	Да
file_search	объект	В настоящее время это всегда будет пустым объектом.	Да

type Enum: RunStepDeltaStepDetailsToolCallsFileSearchObjectType

значение	Описание
file_search

runStepDetailsToolCallsFunctionObject

Имя.	Тип	Описание	Обязательное поле
id	строка	Идентификатор объекта вызова средства.	Да
type	строка	Тип вызова средства. Это всегда будет для `function` этого типа вызова средства.	Да
function	объект	Определение вызываемой функции.	Да

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

name

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

аргументы

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

output

Имя.	Тип	Описание	По умолч.
output	строка	Выходные данные функции. Это будет, `null` если выходные данные еще не отправлены.

type Enum: RunStepDetailsToolCallsFunctionObjectType

значение	Описание
function

runStepDeltaStepDetailsToolCallsFunctionObject

Имя.	Тип	Описание	Обязательное поле
index	integer	Индекс вызова средства в массиве вызовов средства.	Да
id	строка	Идентификатор объекта вызова средства.	No
type	строка	Тип вызова средства. Это всегда будет для `function` этого типа вызова средства.	Да
function	объект	Определение вызываемой функции.	No

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

name

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

аргументы

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

output

Имя.	Тип	Описание	По умолч.
output	строка	Выходные данные функции. Это будет, `null` если выходные данные еще не отправлены.

type Enum: RunStepDetailsToolCallsFunctionObjectType

значение	Описание
function

vectorStoreExpirationAfter

Политика истечения срока действия для хранилища векторов.

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
привязка	строка	Метка времени привязки, после которой применяется политика истечения срока действия. Поддерживаемые привязки: `last_active_at`.	Да
days	integer	Количество дней после истечения срока действия привязки хранилища векторов.	Да

перечисление привязки: VectorStoreExpirationAfterAnchor

значение	Описание
last_active_at	Метка времени привязки, после которой применяется политика истечения срока действия.

vectorStoreObject

Векторное хранилище — это коллекция обработанных файлов, которые можно использовать file_search средством.

Имя.	Тип	Описание	Обязательное поле
id	строка	Идентификатор, на который можно ссылаться в конечных точках API.	Да
объект	перечисление	Тип объекта, который всегда `vector_store`является . Возможные значения: vector_store	Да
created_at	integer	Метка времени Unix (в секундах) для создания векторного хранилища.	Да
имя	строка	Имя векторного хранилища.	Да
usage_bytes	integer	Общее количество байтов, используемых файлами в хранилище векторов.	Да
file_counts	объект		Да
статус	строка	Состояние векторного хранилища, которое может быть либо `expired`, `in_progress`либо `completed`. Состояние указывает, что хранилище векторов `completed` готово для использования.	Да
expires_after	vectorStoreExpirationAfter	Политика истечения срока действия для хранилища векторов.	No
expires_at	integer	Метка времени Unix (в секундах) для истечения срока действия хранилища векторов.	No
last_active_at	integer	Метка времени Unix (в секундах) для последнего активного хранилища векторов.	Да
metadata	объект	Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.	Да

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

in_progress

Имя.	Тип	Описание	По умолч.
in_progress	integer	Количество обрабатываемых файлов.

Завершено

Имя.	Тип	Описание	По умолч.
Завершено	integer	Количество успешно обработанных файлов.

ошибка

Имя.	Тип	Описание	По умолч.
ошибка	integer	Количество файлов, которые не удалось обработать.

cancelled

Имя.	Тип	Описание	По умолч.
cancelled	integer	Количество отмененных файлов.

итог

Имя.	Тип	Описание	По умолч.
итог	integer	Общее количество файлов.

Перечисление состояния: VectorStoreObjectStatus

значение	Описание
срок действия истек
in_progress
Завершено

createVectorStoreRequest

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

updateVectorStoreRequest

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

listVectorStoresResponse

Имя.	Тип	Обязательное поле
объект	строка	Да
.	array	Да
first_id	строка	Да
last_id	строка	Да
has_more	boolean	Да

deleteVectorStoreResponse

Имя.	Тип	Обязательное поле
id	string	Да
deleted	boolean	Да
объект	строка	Да

объект Enum: DeleteVectorStoreResponseObject

значение	Описание
vector_store.deleted	Состояние объекта ответа хранилища векторов удаления

vectorStoreFileObject

Список файлов, подключенных к хранилищу векторов.

Имя.	Тип	Описание	Обязательное поле
id	строка	Идентификатор, на который можно ссылаться в конечных точках API.	Да
объект	строка	Тип объекта, который всегда `vector_store.file`является .	Да
usage_bytes	integer	Общее использование векторного хранилища в байтах. Обратите внимание, что это может отличаться от исходного размера файла.	Да
created_at	integer	Метка времени Unix (в секундах) для момента создания файла векторного хранилища.	Да
vector_store_id	строка	Идентификатор векторного хранилища, к которому подключен файл.	Да
статус	строка	Состояние файла векторного хранилища, который может быть либо `in_progress`, `completedcancelled`либо `failed`. `completed` Состояние указывает, что файл векторного хранилища готов к использованию.	Да
last_error	объект	Последняя ошибка, связанная с этим файлом хранилища векторов. `null` Если ошибок нет.	Да
chunking_strategy	autoChunkingStrategyRequestParam или staticChunkingStrategyRequestParam	Стратегия блокирования, используемая для блокирования файлов. Если этот параметр не задан, используйте стратегию `auto` . Применимо только в том случае, если `file_ids` это непустимый.	No

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

кодом

Имя.	Тип	Описание	По умолч.
кодом	строка	Возможные значения: `server_error` или `rate_limit_exceeded`.

message

Имя.	Тип	Описание	По умолч.
message	строка	Описание ошибки, доступной для чтения человеком.

объект Enum: VectorStoreFileObjectType

значение	Описание
vector_store.file

Состояние перечисления: VectorStoreFileObjectStatus

значение	Описание
in_progress
Завершено
cancelled
ошибка

otherChunkingStrategyResponseParam

Это возвращается, когда стратегия блокирования неизвестна. Как правило, это связано с тем, что файл был индексирован до chunking_strategy появления концепции в API.

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

type Enum: OtherChunkingStrategyResponseParamType

значение	Описание
иное

staticChunkingStrategyResponseParam

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
type	строка	Всегда`static`.	Да
static	staticChunkingStrategy		Да

type Enum: StaticChunkingStrategyResponseParamType

значение	Описание
static

staticChunkingStrategy

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
max_chunk_size_tokens	integer	Максимальное количество токенов в каждом блоке. Значение по умолчанию — `800`. Минимальное значение равно `100` , а максимальное — `4096`.	Да
chunk_overlap_tokens	integer	Количество маркеров, перекрывающихся между блоками. Значение по умолчанию — `400`. Обратите внимание, что перекрытие не должно превышать половину `max_chunk_size_tokens`.	Да

autoChunkingStrategyRequestParam

Стратегия по умолчанию. В настоящее время эта стратегия использует и chunk_overlap_tokens имеет значение max_chunk_size_tokens 800 .400

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

staticChunkingStrategyRequestParam

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

chunkingStrategyRequestParam

Стратегия блокирования, используемая для блокирования файлов. Если этот параметр не задан, используйте стратегию auto .

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

createVectorStoreFileRequest

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

listVectorStoreFilesResponse

Имя.	Тип	Обязательное поле
объект	строка	Да
.	array	Да
first_id	строка	Да
last_id	строка	Да
has_more	boolean	Да

deleteVectorStoreFileResponse

Имя.	Тип	Обязательное поле
id	string	Да
deleted	boolean	Да
объект	строка	Да

объект Enum: DeleteVectorStoreFileResponseObject

значение	Описание
vector_store.file.deleted

vectorStoreFileBatchObject

Пакет файлов, присоединенных к хранилищу векторов.

Имя.	Тип	Описание	Обязательное поле
id	строка	Идентификатор, на который можно ссылаться в конечных точках API.	Да
объект	строка	Тип объекта, который всегда `vector_store.file_batch`является .	Да
created_at	integer	Метка времени Unix (в секундах) для создания пакета файлов векторного хранилища.	Да
vector_store_id	строка	Идентификатор векторного хранилища, к которому подключен файл.	Да
статус	строка	Состояние пакета векторного хранилища файлов, которые могут быть либо `in_progress`, `completedcancelled` либо `failed`.	Да
file_counts	объект		Да

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

in_progress

Имя.	Тип	Описание	По умолч.
in_progress	integer	Количество обрабатываемых файлов.

Завершено

Имя.	Тип	Описание	По умолч.
Завершено	integer	Количество обработанных файлов.

ошибка

Имя.	Тип	Описание	По умолч.
ошибка	integer	Количество файлов, которые не удалось обработать.

cancelled

Имя.	Тип	Описание	По умолч.
cancelled	integer	Количество файлов, которые были отменены.

итог

Имя.	Тип	Описание	По умолч.
итог	integer	Общее количество файлов.

объект Enum: VectorStoreFileBatchObjectType

значение	Описание
vector_store.files_batch

состояние перечисления: VectorStoreFileBatchObjectStatus

значение	Описание
in_progress
Завершено
cancelled
ошибка

createVectorStoreFileBatchRequest

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

assistantStreamEvent

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

Каждое событие в потоке событий, отправляемых сервером event , имеет и data свойство:

event: thread.created
data: {"id": "thread_123", "object": "thread", ...}

Мы генерируем события при создании нового объекта, переходе к новому состоянию или потоковой передаче в части (разностные). Например, при создании thread.run.completed нового запуска, thread.run.created при завершении выполнения и т. д. Когда помощник выбирает создание сообщения во время выполнения, мы создадим thread.message.created eventсобытие, thread.message.in_progress много thread.message.delta событий и, наконец thread.message.completed , событие.

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

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

threadStreamEvent

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

thread.created

Происходит при создании нового потока.

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

Данные: threadObject

Перечисление событий: ThreadStreamEventEnum

значение	Описание
thread.created	Событие создания потока

runStreamEvent

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

thread.run.created

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

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

Данные: runObject

Перечисление событий: RunStreamEventCreated

значение	Описание
thread.run.created

thread.run.queued

Происходит при перемещении queued выполнения в состояние.

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

Данные: runObject

Перечисление событий: RunStreamEventQueued

значение	Описание
thread.run.queued

thread.run.in_progress

Происходит при перемещении in_progress выполнения в состояние.

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

Данные: runObject

Перечисление событий: RunStreamEventInProgress

значение	Описание
thread.run.in_progress

thread.run.requires_action

Происходит при перемещении requires_action выполнения в состояние.

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
события	строка		Да
.	runObject	Представляет выполнение в потоке.	Да

Данные: runObject

Перечисление события: RunStreamEventRequiresAction

значение	Описание
thread.run.requires_action

thread.run.completed

Происходит при завершении выполнения.

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
события	строка		Да
.	runObject	Представляет выполнение в потоке.	Да

Данные: runObject

Перечисление события: RunStreamEventCompleted

значение	Описание
thread.run.completed

thread.run.failed

Происходит при сбое выполнения.

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
события	строка		Да
.	runObject	Представляет выполнение в потоке.	Да

Данные: runObject

Перечисление событий: RunStreamEventFailed

значение	Описание
thread.run.failed

thread.run.cancelling

Происходит при перемещении cancelling выполнения в состояние.

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
события	строка		Да
.	runObject	Представляет выполнение в потоке.	Да

Данные: runObject

Перечисление события: RunStreamEventCancelling

значение	Описание
thread.run.cancelling

thread.run.cancelled

Происходит при отмене выполнения.

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
события	строка		Да
.	runObject	Представляет выполнение в потоке.	Да

Данные: runObject

Перечисление событий: RunStreamEventCancelled

значение	Описание
thread.run.cancelled

thread.run.expired

Происходит при истечении срока действия выполнения.

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
события	строка		Да
.	runObject	Представляет выполнение в потоке.	Да

Данные: runObject

Перечисление событий: RunStreamEventExpired

значение	Описание
thread.run.expired

runStepStreamEvent

Этот компонент может быть одним из следующих компонентов:

thread.run.step.created

Происходит при создании шага выполнения.

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
события	строка		Да
.	runStepObject	Представляет шаг выполнения выполнения выполнения.	Да

Данные: runStepObject

Перечисление событий: RunStepStreamEventCreated

значение	Описание
thread.run.step.created

thread.run.step.in_progress

Происходит при переходе in_progress шага выполнения в состояние.

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
события	строка		Да
.	runStepObject	Представляет шаг выполнения выполнения выполнения.	Да

Данные: runStepObject

Перечисление событий: RunStepStreamEventInProgress

значение	Описание
thread.run.step.in_progress

thread.run.step.delta

Происходит при потоковой передаче частей шага выполнения.

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
события	строка		Да
.	runStepDeltaObject	Представляет разностную смену шага выполнения, т. е. любые измененные поля на шаге выполнения во время потоковой передачи.	Да

Данные: runStepDeltaObject

Перечисление события: RunStepStreamEventDelta

значение	Описание
thread.run.step.delta

thread.run.step.completed

Происходит при завершении шага выполнения.

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
события	строка		Да
.	runStepObject	Представляет шаг выполнения выполнения выполнения.	Да

Данные: runStepObject

Перечисление событий: RunStepStreamEventCompleted

значение	Описание
thread.run.step.completed

thread.run.step.failed

Происходит при сбое шага выполнения.

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
события	строка		Да
.	runStepObject	Представляет шаг выполнения выполнения выполнения.	Да

Данные: runStepObject

Перечисление событий: RunStepStreamEventFailed

значение	Описание
thread.run.step.failed

thread.run.step.cancelled

Происходит при отмене шага выполнения.

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
события	строка		Да
.	runStepObject	Представляет шаг выполнения выполнения выполнения.	Да

Данные: runStepObject

Перечисление событий: RunStepStreamEventCancelled

значение	Описание
thread.run.step.cancelled

thread.run.step.expired

Происходит при истечении срока действия выполнения.

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
события	строка		Да
.	runStepObject	Представляет шаг выполнения выполнения выполнения.	Да

Данные: runStepObject

Перечисление событий: RunStepStreamEventExpired

значение	Описание
thread.run.step.expired

messageStreamEvent

Этот компонент может быть одним из следующих компонентов:

thread.message.created

Происходит при создании сообщения.

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
события	строка		Да
.	messageObject	Представляет сообщение в потоке.	Да

Данные: messageObject

Перечисление событий: MessageStreamEventCreated

значение	Описание
thread.message.created

thread.message.in_progress

Происходит при перемещении in_progress сообщения в состояние.

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
события	строка		Да
.	messageObject	Представляет сообщение в потоке.	Да

Данные: messageObject

Перечисление события: MessageStreamEventInProgress

значение	Описание
thread.message.in_progress

thread.message.delta

Происходит при потоковой передаче частей сообщения.

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
события	строка		Да
.	messageDeltaObject	Представляет разностную передачу сообщения, т. е. любые измененные поля в сообщении во время потоковой передачи.	Да

Данные: messageDeltaObject

Перечисление события: MessageStreamEventDelta

значение	Описание
thread.message.delta

thread.message.completed

Происходит при завершении сообщения.

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
события	строка		Да
.	messageObject	Представляет сообщение в потоке.	Да

Данные: messageObject

Перечисление событий: MessageStreamEventCompleted

значение	Описание
thread.message.completed

thread.message.incomplete

Происходит, когда сообщение заканчивается до завершения.

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
события	строка		Да
.	messageObject	Представляет сообщение в потоке.	Да

Данные: messageObject

Перечисление событий: MessageStreamEventIncomplete

значение	Описание
thread.message.incomplete

errorEvent

Возникает при возникновении ошибки. Это может произойти из-за ошибки внутреннего сервера или времени ожидания.

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
события	строка		Да
.	error		Да

перечисление события: ErrorEventEnum

значение	Описание
error

doneEvent

Происходит, когда поток заканчивается.

Имя.	Тип	Описание	Обязательное поле	По умолчанию.
события	строка		Да
.	строка		Да

перечисление события: DoneEventEnum

значение	Описание
выполнено

перечисление данных: DoneEventDataEnum

значение	Описание
[ГОТОВО]

Следующие шаги

Узнайте о моделях и тонкой настройке с помощью REST API. Ознакомьтесь с дополнительными сведениями о базовых моделях, лежащих в основе Azure OpenAI.

Поделиться через

Справочник по REST Предварительная версия API службы Azure OpenAI

Спецификации API

Проверка подлинности

Управление версиями REST API

Вывод плоскости данных

Завершение — создание

Параметры URI

Заголовок запроса

Текст запроса

Отклики

Примеры

Пример

Внедрение — создание

Параметры URI

Заголовок запроса

Текст запроса

Отклики

Свойства для использования

prompt_tokens

total_tokens

Примеры

Пример

Завершение чата — создание

Параметры URI

Заголовок запроса

Текст запроса

Отклики

Примеры

Пример

Пример

Пример

Пример

Пример

Пример

Пример

Пример

Транскрибирование — создание

Параметры URI

Заголовок запроса

Текст запроса

Отклики

Примеры

Пример

Пример

Переводы — создание

Параметры URI

Заголовок запроса

Текст запроса

Отклики

Примеры

Пример

Пример

Речь — создание

Параметры URI

Заголовок запроса

Текст запроса

Отклики

Примеры

Пример

Поколения изображений — создание

Параметры URI

Заголовок запроса

Текст запроса

Отклики

Примеры

Пример

Список — помощники

Параметры URI

Заголовок запроса

Отклики

Примеры

Пример

Создание — помощник

Параметры URI

Заголовок запроса

Текст запроса

Свойства для tool_resources

code_interpreter

file_search