@azure-rest/ai-inference package
Интерфейсы
| ChatChoiceOutput |
Представление единого запроса запроса на завершение чата в рамках общего запроса на завершение чата.
Как правило, |
| ChatCompletionsNamedToolChoice |
Выбор определенного именованного средства функции, ограничивающего завершение чата с помощью именованной функции. |
| ChatCompletionsNamedToolChoiceFunction |
Выбор определенного именованного средства функции, ограничивающего завершение чата с помощью именованной функции. |
| ChatCompletionsOutput |
Представление данных ответа из запроса завершения чата. Завершение поддерживает широкий спектр задач и создает текст, который продолжается или завершается с предоставленными данными запроса. |
| ChatCompletionsResponseFormatJsonObject |
Формат ответа для завершения чата, ограничивающий ответы на создание допустимых объектов JSON. Обратите внимание, что для включения режима JSON некоторые модели ИИ также могут потребовать указать модели создавать JSON через системное или пользовательское сообщение. |
| ChatCompletionsResponseFormatJsonSchema |
Формат ответа для завершения чата, который ограничивает ответы на создание допустимых объектов JSON с схемой JSON, указанной вызывающим оператором. |
| ChatCompletionsResponseFormatJsonSchemaDefinition |
Определяет формат ответа для завершения чата в формате JSON с заданной схемой. Модель искусственного интеллекта должна соответствовать этой схеме при создании завершений. |
| ChatCompletionsResponseFormatParent |
Представляет формат, который модель должна выводить. Используйте это для включения режима JSON вместо текстового режима по умолчанию. Обратите внимание, что для включения режима JSON некоторые модели ИИ также могут потребовать указать модели создавать JSON через системное или пользовательское сообщение. |
| ChatCompletionsResponseFormatText |
Формат ответа для завершения чата, который выдает текстовые ответы. Это формат ответа по умолчанию. |
| ChatCompletionsToolCall |
Вызов средства функции, запрошенный моделью ИИ. |
| ChatCompletionsToolCallOutput |
Вызов средства функции, запрошенный моделью ИИ. |
| ChatCompletionsToolDefinition |
Определение средства завершения чата, которое может вызывать функцию. |
| ChatMessageAudioDataContentItem |
Структурированный элемент содержимого чата для звукового содержимого, передаваемого в кодировке Base64. |
| ChatMessageAudioUrlContentItem |
Структурированный элемент содержимого чата для звукового содержимого, переданного в качестве URL-адреса. |
| ChatMessageContentItemParent |
Абстрактное представление структурированного элемента содержимого в сообщении чата. |
| ChatMessageImageContentItem |
Структурированный элемент содержимого чата, содержащий ссылку на изображение. |
| ChatMessageImageUrl |
Расположение в Интернете, из которого модель может получить изображение. |
| ChatMessageInputAudio |
Сведения о входных звуковых данных. |
| ChatMessageInputAudioUrl |
Сведения о звуковом URL-адресе. |
| ChatMessageTextContentItem |
Структурированный элемент содержимого чата, содержащий обычный текст. |
| ChatRequestAssistantMessage |
Сообщение чата запроса, представляющее ответ или действие от помощника. |
| ChatRequestDeveloperMessage |
Сообщение чата запроса, содержащее инструкции разработчика, влияющие на то, как модель создаст ответ на завершение чата. Некоторые модели искусственного интеллекта поддерживают сообщение разработчика вместо системного сообщения. |
| ChatRequestMessageParent |
Абстрактное представление сообщения чата, как указано в запросе. |
| ChatRequestSystemMessage |
Сообщение чата запроса, содержащее системные инструкции, влияющие на то, как модель создаст ответ на завершение чата. |
| ChatRequestToolMessage |
Сообщение чата запроса, представляющее запрошенные выходные данные из настроенного средства. |
| ChatRequestUserMessage |
Сообщение чата запроса, представляющее входные данные пользователя помощнику. |
| ChatResponseMessageOutput |
Представление сообщения чата, полученного в ответе. |
| CompletionsUsageOutput |
Представление количества маркеров, обработанных для запроса завершения. Счетчики учитывают все маркеры в запросах, вариантах выбора, альтернативных вариантах, best_of поколениях и других потребителях. |
| EmbeddingItemOutput |
Представление сравнения связанности с одним внедрением. |
| EmbeddingsResultOutput |
Представление данных ответа из запроса внедрения. Внедрение измеряет связанность текстовых строк и часто используется для поиска, кластеризации, рекомендаций и других аналогичных сценариев. |
| EmbeddingsUsageOutput |
Измерение количества маркеров, используемых в этом запросе и ответе. |
| ErrorModel |
Объект ошибки. |
| FunctionCall |
Имя и аргументы вызываемой функции, созданной моделью. |
| FunctionCallOutput |
Имя и аргументы вызываемой функции, созданной моделью. |
| FunctionDefinition |
Определение указанной вызывающим функцией, которая завершает чат, может вызываться в ответ на соответствующие входные данные пользователя. |
| GetChatCompletions | |
| GetChatCompletions200Response |
Запрос выполнен успешно. |
| GetChatCompletionsBodyParam | |
| GetChatCompletionsDefaultHeaders | |
| GetChatCompletionsDefaultResponse | |
| GetChatCompletionsHeaderParam | |
| GetChatCompletionsHeaders | |
| GetEmbeddings | |
| GetEmbeddings200Response |
Запрос выполнен успешно. |
| GetEmbeddingsBodyParam | |
| GetEmbeddingsDefaultHeaders | |
| GetEmbeddingsDefaultResponse | |
| GetEmbeddingsHeaderParam | |
| GetEmbeddingsHeaders | |
| GetImageEmbeddings | |
| GetImageEmbeddings200Response |
Запрос выполнен успешно. |
| GetImageEmbeddingsBodyParam | |
| GetImageEmbeddingsDefaultHeaders | |
| GetImageEmbeddingsDefaultResponse | |
| GetImageEmbeddingsHeaderParam | |
| GetImageEmbeddingsHeaders | |
| GetModelInfo | |
| GetModelInfo200Response |
Запрос выполнен успешно. |
| GetModelInfoDefaultHeaders | |
| GetModelInfoDefaultResponse | |
| ImageEmbeddingInput |
Представляет изображение с необязательным текстом. |
| ModelClientOptions |
Необязательные параметры для клиента |
| ModelInfoOutput |
Представляет некоторые основные сведения о модели искусственного интеллекта. |
| Routes | |
Псевдонимы типа
| AudioContentFormat |
Псевдоним для AudioContentFormat |
| ChatCompletionsResponseFormat |
Представляет формат, который модель должна выводить. Используйте это для включения режима JSON вместо текстового режима по умолчанию. Обратите внимание, что для включения режима JSON некоторые модели ИИ также могут потребовать указать модели создавать JSON через системное или пользовательское сообщение. |
| ChatCompletionsToolChoicePreset |
Псевдоним для ChatCompletionsToolChoicePreset |
| ChatMessageContentItem |
Абстрактное представление структурированного элемента содержимого в сообщении чата. |
| ChatMessageImageDetailLevel |
Псевдоним для ChatMessageImageDetailLevel |
| ChatRequestMessage |
Абстрактное представление сообщения чата, как указано в запросе. |
| ChatRole |
Псевдоним для ChatRole |
| ChatRoleOutput |
Псевдоним для ChatRoleOutput |
| CompletionsFinishReasonOutput |
Псевдоним для завершенияFinishReasonOutput |
| EmbeddingEncodingFormat |
Псевдоним для EmbeddingEncodingFormat |
| EmbeddingInputType |
Псевдоним для EmbeddingInputType |
| ExtraParameters |
Псевдоним для ЭкстраПараметров |
| GetChatCompletionsParameters | |
| GetEmbeddingsParameters | |
| GetImageEmbeddingsParameters | |
| GetModelInfoParameters | |
| ModelClient | |
| ModelTypeOutput |
Псевдоним для ModelTypeOutput |
Функции
Сведения о функции
default(string, TokenCredential | KeyCredential, ModelClientOptions)
Инициализация нового экземпляра ModelClient
function default(endpointParam: string, credentials: TokenCredential | KeyCredential, options?: ModelClientOptions): ModelClientПараметры
- endpointParam
-
string
Конечная точка параметраParam
- credentials
уникально идентификация учетных данных клиента
- options
- ModelClientOptions
параметр для всех необязательных параметров
Возвращаемое значение
isUnexpected(GetChatCompletions200Response | GetChatCompletionsDefaultResponse)
function isUnexpected(response: GetChatCompletions200Response | GetChatCompletionsDefaultResponse): responseПараметры
Возвращаемое значение
response
isUnexpected(GetModelInfo200Response | GetModelInfoDefaultResponse)
function isUnexpected(response: GetModelInfo200Response | GetModelInfoDefaultResponse): responseПараметры
Возвращаемое значение
response
isUnexpected(GetEmbeddings200Response | GetEmbeddingsDefaultResponse)
function isUnexpected(response: GetEmbeddings200Response | GetEmbeddingsDefaultResponse): responseПараметры
Возвращаемое значение
response
isUnexpected(GetImageEmbeddings200Response | GetImageEmbeddingsDefaultResponse)
function isUnexpected(response: GetImageEmbeddings200Response | GetImageEmbeddingsDefaultResponse): responseПараметры
Возвращаемое значение
response
