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

Get Chat Completions - Get Chat Completions

  • Ссылка
Служба:
AI Foundry
Версия API:
2024-05-01-preview

Возвращает завершения чата для предоставленных сообщений чата. Завершение поддерживает широкий спектр задач и создает текст, который продолжается или завершается с предоставленными данными запроса. Метод выполняет вызов REST API к маршруту /chat/completions на заданной конечной точке.

POST https:///chat/completions?api-version=2024-05-01-preview

Параметры URI

Имя В Обязательно Тип Описание
api-version
 query True

string

minLength: 1

Версия API, используемая для этой операции.

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

Имя Обязательно Тип Описание
extra-parameters

ExtraParameters

Управляет тем, что происходит, если дополнительные параметры, неопределенные REST API, передаются в полезные данные запроса JSON. Это задает заголовок HTTP-запроса extra-parameters.

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

Имя Обязательно Тип Описание
messages True ChatRequestMessage[]:

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

number (float)

minimum: -2
maximum: 2

Значение, влияющее на вероятность появления созданных маркеров на основе их совокупной частоты в созданном тексте. Положительные значения делают маркеры менее вероятными при увеличении частоты и уменьшении вероятности повторения одной и той же инструкции модели. Поддерживаемый диапазон — [-2, 2].
max_tokens

integer (int32)

minimum: 0

Максимальное количество генерируемых маркеров.
modalities

ChatCompletionsModality[]

Модальности, которые модель может использовать для ответа на завершение чата. Модальность по умолчанию — text. Указание неподдерживаемой комбинации модальности приводит к ошибке 422.
model

string

Идентификатор используемой модели ИИ, если на конечной точке доступно несколько моделей.
presence_penalty

number (float)

minimum: -2
maximum: 2

Значение, влияющее на вероятность появления созданных маркеров на основе существующего присутствия в созданном тексте. Положительные значения делают маркеры менее вероятными, когда они уже существуют и повышают вероятность вывода новых разделов модели. Поддерживаемый диапазон — [-2, 2].
response_format ChatCompletionsResponseFormat:

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

Параметр { "type": "json_schema", "json_schema": {...} } включает структурированные выходные данные, которые гарантируют, что модель будет соответствовать предоставленной схеме JSON.

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

Важно: при использовании режима JSON также необходимо указать модели создавать JSON самостоятельно с помощью системного или пользовательского сообщения. Без этого модель может создать неуправляемый поток пробелов до тех пор, пока поколение не достигнет предела маркера, в результате чего длительный и, казалось бы, "застрявший" запрос. Кроме того, обратите внимание, что содержимое сообщения может быть частично отрезано, если finish_reason="length", что означает превышение поколения max_tokens или беседа превысила максимальную длину контекста.
seed

integer (int64)

Если задано, система будет предпринять наилучшие усилия для выборки детерминированного типа, чтобы повторяющиеся запросы с одинаковым начальным значением и параметрами возвращали тот же результат. Детерминированность не гарантируется.
stop

string[]

Коллекция текстовых последовательностей, которая завершит создание завершений.
stream

boolean

Значение, указывающее, следует ли выполнять потоковую передачу завершения чата для этого запроса.
temperature

number (float)

minimum: 0
maximum: 1

Температура выборки, используемая для управления очевидным творчеством созданных завершений. Более высокие значения делают выходные данные более случайными, а более низкие значения делают результаты более ориентированными и детерминированными. Не рекомендуется изменять температуру и top_p для того же запроса завершения, так как взаимодействие этих двух параметров трудно прогнозировать. Поддерживаемый диапазон — [0, 1].
tool_choice

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

ChatCompletionsToolDefinition[]

Список инструментов, которые модель может запрашивать для вызова. В настоящее время в качестве инструмента поддерживаются только функции. Модель может ответить запросом вызова функции и предоставить входные аргументы в формате JSON для этой функции.
top_p

number (float)

minimum: 0
maximum: 1

Альтернатива выборке с температурой, называемой выборкой ядра. Это значение приводит к тому, что модель рассматривает результаты маркеров с предоставленной массой вероятности. Например, значение 0,15 приведет только к тому, что маркеры, состоящие из первых 15% массы вероятностей, будут считаться. Не рекомендуется изменять температуру и top_p для того же запроса завершения, так как взаимодействие этих двух параметров трудно прогнозировать. Поддерживаемый диапазон — [0, 1].

Ответы

Имя Тип Описание
200 OK

ChatCompletions

Запрос выполнен успешно.
Other Status Codes

Azure.Core.Foundations.ErrorResponse

Непредвиденное сообщение об ошибке.

Заголовки

x-ms-error-code: string

Безопасность

api-key

Тип: apiKey
В: header

OAuth2Auth

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

Области

Имя Описание
https://ml.azure.com/.default

Примеры

Audio modality chat completion
maximum set chat completion
minimum set chat completion

Audio modality chat completion

Образец запроса

POST https:///chat/completions?api-version=2024-05-01-preview


{
  "modalities": [
    "text",
    "audio"
  ],
  "messages": [
    {
      "role": "system",
      "content": "You are a helpful assistant"
    },
    {
      "role": "user",
      "content": [
        {
          "type": "input_audio",
          "input_audio": {
            "data": "<base64 encoded audio data>",
            "format": "wav"
          }
        }
      ]
    },
    {
      "role": "assistant",
      "content": null,
      "audio": {
        "id": "abcdef1234"
      }
    },
    {
      "role": "user",
      "content": [
        {
          "type": "input_audio",
          "input_audio": {
            "data": "<base64 encoded audio data>",
            "format": "wav"
          }
        }
      ]
    }
  ],
  "frequency_penalty": 0,
  "presence_penalty": 0,
  "temperature": 0,
  "top_p": 0,
  "seed": 21,
  "model": "my-model-name"
}

Пример ответа

Код состояния:
200 
{
  "id": "kgousajxgzyhugvqekuswuqbk",
  "object": "chat.completion",
  "created": 1696522361,
  "model": "my-model-name",
  "usage": {
    "completion_tokens": 19,
    "prompt_tokens": 28,
    "total_tokens": 16,
    "completion_tokens_details": {
      "audio_tokens": 5,
      "total_tokens": 5
    },
    "prompt_tokens_details": {
      "audio_tokens": 10,
      "cached_tokens": 0
    }
  },
  "choices": [
    {
      "index": 0,
      "finish_reason": "stop",
      "message": {
        "role": "assistant",
        "content": null,
        "tool_calls": null,
        "audio": {
          "id": "abcdef1234",
          "format": "wav",
          "data": "<base64 encoded audio data>",
          "expires_at": 1896522361,
          "transcript": "This is a sample transcript"
        }
      }
    }
  ]
}

maximum set chat completion

Образец запроса

POST https:///chat/completions?api-version=2024-05-01-preview


{
  "modalities": [
    "text"
  ],
  "messages": [
    {
      "role": "system",
      "content": "You are a helpful assistant"
    },
    {
      "role": "user",
      "content": "Explain Riemann's conjecture"
    },
    {
      "role": "assistant",
      "content": "The Riemann Conjecture is a deep mathematical conjecture around prime numbers and how they can be predicted. It was first published in Riemann's groundbreaking 1859 paper. The conjecture states that the Riemann zeta function has its zeros only at the negative even integers and complex numbers with real part 1/21. Many consider it to be the most important unsolved problem in pure mathematics. The Riemann hypothesis is a way to predict the probability that numbers in a certain range are prime that was also devised by German mathematician Bernhard Riemann in 18594."
    },
    {
      "role": "user",
      "content": "Ist it proved?"
    }
  ],
  "frequency_penalty": 0,
  "stream": true,
  "presence_penalty": 0,
  "temperature": 0,
  "top_p": 0,
  "max_tokens": 255,
  "response_format": {
    "type": "text"
  },
  "stop": [
    "<|endoftext|>"
  ],
  "tools": [
    {
      "type": "function",
      "function": {
        "name": "my-function-name",
        "description": "A function useful to know if a theroem is proved or not"
      }
    }
  ],
  "seed": 21,
  "model": "my-model-name"
}

Пример ответа

Код состояния:
200 
{
  "id": "kgousajxgzyhugvqekuswuqbk",
  "object": "chat.completion",
  "created": 18,
  "model": "my-model-name",
  "usage": {
    "completion_tokens": 19,
    "prompt_tokens": 28,
    "total_tokens": 16
  },
  "choices": [
    {
      "index": 7,
      "finish_reason": "stop",
      "message": {
        "role": "assistant",
        "content": null,
        "tool_calls": [
          {
            "id": "yrobmilsrugmbwukmzo",
            "type": "function",
            "function": {
              "name": "my-function-name",
              "arguments": "{ \"arg1\": \"value1\", \"arg2\": \"value2\" }"
            }
          }
        ]
      }
    }
  ]
}

minimum set chat completion

Образец запроса

POST https:///chat/completions?api-version=2024-05-01-preview

{
  "messages": [
    {
      "role": "user",
      "content": "Explain Riemann's conjecture"
    }
  ]
}

Пример ответа

Код состояния:
200 
{
  "id": "kgousajxgzyhugvqekuswuqbk",
  "object": "chat.completion",
  "created": 1234567890,
  "model": "my-model-name",
  "usage": {
    "prompt_tokens": 205,
    "completion_tokens": 5,
    "total_tokens": 210
  },
  "choices": [
    {
      "index": 0,
      "finish_reason": "stop",
      "message": {
        "role": "assistant",
        "content": "The Riemann Conjecture is a deep mathematical conjecture around prime numbers and how they can be predicted. It was first published in Riemann's groundbreaking 1859 paper. The conjecture states that the Riemann zeta function has its zeros only at the negative even integers and complex numbers with real part 1/21. Many consider it to be the most important unsolved problem in pure mathematics. The Riemann hypothesis is a way to predict the probability that numbers in a certain range are prime that was also devised by German mathematician Bernhard Riemann in 18594"
      }
    }
  ]
}

Определения

Имя Описание
AudioContentFormat

Представление возможных форматов звука для звука.
Azure.Core.Foundations.Error

Объект ошибки.
Azure.Core.Foundations.ErrorResponse

Ответ, содержащий сведения об ошибке.
Azure.Core.Foundations.InnerError

Объект, содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по API Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ChatChoice

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

Представление данных ответа из запроса завершения чата. Завершение поддерживает широкий спектр задач и создает текст, который продолжается или завершается с предоставленными данными запроса.
ChatCompletionsAudio

Представление звука, созданного моделью.
ChatCompletionsModality

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

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

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

Формат ответа для завершения чата, который ограничивает ответы на создание допустимых объектов JSON с схемой JSON, указанной вызывающим оператором.
ChatCompletionsResponseFormatJsonSchemaDefinition

Определение требуемой схемы JSON в ответе и связанных метаданных.
ChatCompletionsResponseFormatText

Формат ответа для завершения чата, который выдает текстовые ответы. Это формат ответа по умолчанию.
ChatCompletionsToolCall

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

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

Сообщение чата запроса, представляющее ответ или действие от помощника.
ChatRequestAudioReference

Ссылка на звуковой ответ, созданный моделью.
ChatRequestSystemMessage

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

Сообщение чата запроса, представляющее запрошенные выходные данные из настроенного средства.
ChatRequestUserMessage

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

Представление сообщения чата, полученного в ответе.
ChatRole

Описание целевой цели сообщения в взаимодействии с завершением чата.
CompletionsFinishReason

Представление способа завершения ответа.
CompletionsUsage

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

Разбивка маркеров, используемых в завершении.
ExtraParameters

Управляет тем, что происходит, если дополнительные параметры, неопределенные REST API, передаются в полезные данные запроса JSON.
FunctionCall

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

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

Разбивка маркеров, используемых в журнале запросов и чата.

AudioContentFormat

Перечисление

Представление возможных форматов звука для звука.

Значение Описание
mp3

Задает звук в формате MP3.
wav

Задает звук в формате WAV.

Azure.Core.Foundations.Error

Object

Объект ошибки.

Имя Тип Описание
code

string

Один из определяемых сервером кодов ошибок.
details

Azure.Core.Foundations.Error[]

Массив сведений об определенных ошибках, которые привели к этой сообщаемой ошибке.
innererror

Azure.Core.Foundations.InnerError

Объект, содержащий более конкретные сведения, чем текущий объект об ошибке.
message

string

Читаемое пользователем представление ошибки.
target

string

Целевой объект ошибки.

Azure.Core.Foundations.ErrorResponse

Object

Ответ, содержащий сведения об ошибке.

Имя Тип Описание
error

Azure.Core.Foundations.Error

Объект ошибки.

Azure.Core.Foundations.InnerError

Object

Объект, содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по API Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Имя Тип Описание
code

string

Один из определяемых сервером кодов ошибок.
innererror

Azure.Core.Foundations.InnerError

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

ChatChoice

Object

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

Имя Тип Описание
finish_reason

CompletionsFinishReason

Причина того, что этот выбор завершения чата завершился его созданным.
index

integer (int32)

Упорядоченный индекс, связанный с этим выбором завершения чата.
message

ChatResponseMessage

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

ChatCompletions

Object

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

Имя Тип Описание
choices

ChatChoice[]

Коллекция вариантов завершения, связанных с ответом завершения. Как правило, n варианты создаются для каждого предоставленного запроса со значением по умолчанию 1. Ограничения маркеров и другие параметры могут ограничить количество созданных вариантов.
created

integer (unixtime)

Первая метка времени, связанная с действием создания для этого ответа завершения, представленная как секунды с начала эпохи Unix 00:00 1 января 1970 года.
id

string

Уникальный идентификатор, связанный с ответом завершения чата.
model

string

Модель, используемая для завершения чата.
object enum:

chat.completion

Тип объекта ответа, который всегда chat.completion.
usage

CompletionsUsage

Сведения об использовании маркеров, обработанных и созданных в рамках этой операции завершения.

ChatCompletionsAudio

Object

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

Имя Тип Описание
data

string

Звуковые данные в кодировке Base64
expires_at

integer (unixtime)

Метка времени Unix (в секундах), в которой истекает срок действия звукового элемента и не может быть больше ссылаться на его идентификатор в многоэтапных беседах.
format

AudioContentFormat

Формат звукового содержимого. Если формат не указан, он будет соответствовать формату, используемому в входном звуковом запросе.
id

string

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

string

Расшифровка звукового файла.

ChatCompletionsModality

Перечисление

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

Значение Описание
audio

Модель может создавать звук.
text

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

ChatCompletionsOptions

Object

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

Имя Тип Default value Описание
frequency_penalty

number (float)

minimum: -2
maximum: 2 		0

Значение, влияющее на вероятность появления созданных маркеров на основе их совокупной частоты в созданном тексте. Положительные значения делают маркеры менее вероятными при увеличении частоты и уменьшении вероятности повторения одной и той же инструкции модели. Поддерживаемый диапазон — [-2, 2].
max_tokens

integer (int32)

minimum: 0

Максимальное количество генерируемых маркеров.
messages ChatRequestMessage[]:

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

ChatCompletionsModality[]

Модальности, которые модель может использовать для ответа на завершение чата. Модальность по умолчанию — text. Указание неподдерживаемой комбинации модальности приводит к ошибке 422.
model

string

Идентификатор используемой модели ИИ, если на конечной точке доступно несколько моделей.
presence_penalty

number (float)

minimum: -2
maximum: 2 		0

Значение, влияющее на вероятность появления созданных маркеров на основе существующего присутствия в созданном тексте. Положительные значения делают маркеры менее вероятными, когда они уже существуют и повышают вероятность вывода новых разделов модели. Поддерживаемый диапазон — [-2, 2].
response_format ChatCompletionsResponseFormat:

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

Параметр { "type": "json_schema", "json_schema": {...} } включает структурированные выходные данные, которые гарантируют, что модель будет соответствовать предоставленной схеме JSON.

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

Важно: при использовании режима JSON также необходимо указать модели создавать JSON самостоятельно с помощью системного или пользовательского сообщения. Без этого модель может создать неуправляемый поток пробелов до тех пор, пока поколение не достигнет предела маркера, в результате чего длительный и, казалось бы, "застрявший" запрос. Кроме того, обратите внимание, что содержимое сообщения может быть частично отрезано, если finish_reason="length", что означает превышение поколения max_tokens или беседа превысила максимальную длину контекста.
seed

integer (int64)

Если задано, система будет предпринять наилучшие усилия для выборки детерминированного типа, чтобы повторяющиеся запросы с одинаковым начальным значением и параметрами возвращали тот же результат. Детерминированность не гарантируется.
stop

string[]

Коллекция текстовых последовательностей, которая завершит создание завершений.
stream

boolean

Значение, указывающее, следует ли выполнять потоковую передачу завершения чата для этого запроса.
temperature

number (float)

minimum: 0
maximum: 1 		0.7

Температура выборки, используемая для управления очевидным творчеством созданных завершений. Более высокие значения делают выходные данные более случайными, а более низкие значения делают результаты более ориентированными и детерминированными. Не рекомендуется изменять температуру и top_p для того же запроса завершения, так как взаимодействие этих двух параметров трудно прогнозировать. Поддерживаемый диапазон — [0, 1].
tool_choice

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

ChatCompletionsToolDefinition[]

Список инструментов, которые модель может запрашивать для вызова. В настоящее время в качестве инструмента поддерживаются только функции. Модель может ответить запросом вызова функции и предоставить входные аргументы в формате JSON для этой функции.
top_p

number (float)

minimum: 0
maximum: 1 		1

Альтернатива выборке с температурой, называемой выборкой ядра. Это значение приводит к тому, что модель рассматривает результаты маркеров с предоставленной массой вероятности. Например, значение 0,15 приведет только к тому, что маркеры, состоящие из первых 15% массы вероятностей, будут считаться. Не рекомендуется изменять температуру и top_p для того же запроса завершения, так как взаимодействие этих двух параметров трудно прогнозировать. Поддерживаемый диапазон — [0, 1].

ChatCompletionsResponseFormatJsonObject

Object

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

Имя Тип Описание
type string:

json_object

Тип формата ответа, используемый для завершения чата.

ChatCompletionsResponseFormatJsonSchema

Object

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

Имя Тип Описание
json_schema

ChatCompletionsResponseFormatJsonSchemaDefinition

Определение требуемой схемы JSON в ответе и связанных метаданных.
type string:

json_schema

Тип формата ответа, используемый для завершения чата.

ChatCompletionsResponseFormatJsonSchemaDefinition

Object

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

Имя Тип Default value Описание
description

string

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

string

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

Определение схемы JSON
strict

boolean

False

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

ChatCompletionsResponseFormatText

Object

Формат ответа для завершения чата, который выдает текстовые ответы. Это формат ответа по умолчанию.

Имя Тип Описание
type string:

text

Тип формата ответа, используемый для завершения чата.

ChatCompletionsToolCall

Object

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

Имя Тип Описание
function

FunctionCall

Сведения о вызове функции, запрашиваемом моделью ИИ.
id

string

Идентификатор вызова средства.
type enum:

function

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

ChatCompletionsToolDefinition

Object

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

Имя Тип Описание
function

FunctionDefinition

Сведения о определении функции для средства функции.
type enum:

function

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

ChatRequestAssistantMessage

Object

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

Имя Тип Описание
audio

ChatRequestAudioReference

Звук, созданный предыдущим ответом в многоэтапной беседе.
content

string

Содержимое сообщения.
role string:

assistant

Роль чата, связанная с этим сообщением.
tool_calls

ChatCompletionsToolCall[]

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

ChatRequestAudioReference

Object

Ссылка на звуковой ответ, созданный моделью.

Имя Тип Описание
id

string

Уникальный идентификатор для звукового ответа. Это значение соответствует идентификатору предыдущего завершения звука.

ChatRequestSystemMessage

Object

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

Имя Тип Описание
content

string

Содержимое системного сообщения.
role string:

system

Роль чата, связанная с этим сообщением.

ChatRequestToolMessage

Object

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

Имя Тип Описание
content

string

Содержимое сообщения.
role string:

tool

Роль чата, связанная с этим сообщением.
tool_call_id

string

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

ChatRequestUserMessage

Object

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

Имя Тип Описание
content

Содержимое сообщения пользователя с доступными типами входных данных, разными по выбранной модели.
role string:

user

Роль чата, связанная с этим сообщением.

ChatResponseMessage

Object

Представление сообщения чата, полученного в ответе.

Имя Тип Описание
audio

ChatCompletionsAudio

Звук, созданный моделью в качестве ответа на сообщения, если модель настроена для создания звука.
content

string

Содержимое сообщения.
role

ChatRole

Роль чата, связанная с сообщением.
tool_calls

ChatCompletionsToolCall[]

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

ChatRole

Перечисление

Описание целевой цели сообщения в взаимодействии с завершением чата.

Значение Описание
assistant

Роль, которая предоставляет ответы на системные, запрашиваемые пользователем входные данные.
developer

Роль, которая предоставляет инструкции для модели, приоритетом в преддверии сообщений пользователей.
system

Роль, которая указывает или задает поведение помощника.
tool

Роль, представляющая действие средства расширения в ходе операции завершения чата.
user

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

CompletionsFinishReason

Перечисление

Представление способа завершения ответа.

Значение Описание
content_filter

Завершение создало ответ, который был определен как потенциально конфиденциальный для политик модерации контента.
length

Завершения исчерпаны доступными ограничениями маркеров до завершения создания.
stop

Завершение завершилось обычно и достигло конца создания токенов.
tool_calls

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

CompletionsUsage

Object

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

Имя Тип Описание
completion_tokens

integer (int32)

Количество маркеров, созданных во всех выбросов завершения.
completion_tokens_details

CompletionsUsageDetails

Разбивка маркеров, используемых в завершении.
prompt_tokens

integer (int32)

Количество маркеров в предоставленных запросах на завершение.
prompt_tokens_details

PromptUsageDetails

Разбивка маркеров, используемых в журнале запросов или чата.
total_tokens

integer (int32)

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

CompletionsUsageDetails

Object

Разбивка маркеров, используемых в завершении.

Имя Тип Описание
audio_tokens

integer (int32)

Количество маркеров, соответствующих звуковому входу.
total_tokens

integer (int32)

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

ExtraParameters

Перечисление

Управляет тем, что происходит, если дополнительные параметры, неопределенные REST API, передаются в полезные данные запроса JSON.

Значение Описание
drop

Служба будет игнорировать дополнительные параметры (удалить) в полезных данных запроса. Он передает только известные параметры в модель внутреннего ИИ.
error

Служба будет ошибаться, если она обнаружила дополнительные параметры в полезных данных запроса. Это служба по умолчанию.
pass-through

Служба передает дополнительные параметры в модель внутреннего ИИ.

FunctionCall

Object

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

Имя Тип Описание
arguments

string

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

string

Имя вызываемой функции.

FunctionDefinition

Object

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

Имя Тип Описание
description

string

Описание того, что делает функция. Модель будет использовать это описание при выборе функции и интерпретации его параметров.
name

string

Имя вызываемой функции.
parameters

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

PromptUsageDetails

Object

Разбивка маркеров, используемых в журнале запросов и чата.

Имя Тип Описание
audio_tokens

integer (int32)

Количество маркеров, соответствующих звуковому входу.
cached_tokens

integer (int32)

Общее количество кэшированных маркеров.