@azure-rest/ai-inference package
Interfaces
| ChatChoiceOutput |
A representação de uma única conclusão de prompt como parte de uma solicitação geral de conclusões de chat.
Geralmente, |
| ChatCompletionsNamedToolChoice |
Uma seleção de ferramenta de uma ferramenta de função nomeada específica que limitará as conclusões do chat ao uso da função nomeada. |
| ChatCompletionsNamedToolChoiceFunction |
Uma seleção de ferramenta de uma ferramenta de função nomeada específica que limitará as conclusões do chat ao uso da função nomeada. |
| ChatCompletionsOutput |
Representação dos dados de resposta de uma solicitação de conclusão de chat. As conclusões dão suporte a uma ampla variedade de tarefas e geram texto que continua de ou "conclui" dados de prompt fornecidos. |
| ChatCompletionsResponseFormatJsonObject |
Um formato de resposta para Conclusões de Chat que restringe as respostas à emissão de objetos JSON válidos. Observe que, para habilitar o modo JSON, alguns modelos de IA também podem exigir que você instrua o modelo a produzir JSON por meio de um sistema ou mensagem de usuário. |
| ChatCompletionsResponseFormatJsonSchema |
Um formato de resposta para Conclusões de Chat que restringe as respostas à emissão de objetos JSON válidos, com um esquema JSON especificado pelo chamador. |
| ChatCompletionsResponseFormatJsonSchemaDefinition |
Define o formato de resposta para conclusões de chat como JSON com um determinado esquema. O modelo de IA precisará aderir a esse esquema ao gerar conclusões. |
| ChatCompletionsResponseFormatParent |
Representa o formato que o modelo deve gerar. Use isso para habilitar o modo JSON em vez do modo de texto padrão. Observe que, para habilitar o modo JSON, alguns modelos de IA também podem exigir que você instrua o modelo a produzir JSON por meio de um sistema ou mensagem de usuário. |
| ChatCompletionsResponseFormatText |
Um formato de resposta para Conclusões de Chat que emite respostas de texto. Esse é o formato de resposta padrão. |
| ChatCompletionsToolCall |
Uma chamada de ferramenta de função solicitada pelo modelo de IA. |
| ChatCompletionsToolCallOutput |
Uma chamada de ferramenta de função solicitada pelo modelo de IA. |
| ChatCompletionsToolDefinition |
A definição de uma ferramenta de conclusão de chat que pode chamar uma função. |
| ChatMessageContentItemParent |
Uma representação abstrata de um item de conteúdo estruturado em uma mensagem de chat. |
| ChatMessageImageContentItem |
Um item de conteúdo de chat estruturado que contém uma referência de imagem. |
| ChatMessageImageUrl |
Um local da Internet do qual o modelo pode recuperar uma imagem. |
| ChatMessageTextContentItem |
Um item de conteúdo de chat estruturado que contém texto sem formatação. |
| ChatRequestAssistantMessage |
Uma mensagem de chat de solicitação que representa a resposta ou a ação do assistente. |
| ChatRequestMessageParent |
Uma representação abstrata de uma mensagem de chat, conforme fornecido em uma solicitação. |
| ChatRequestSystemMessage |
Uma mensagem de chat de solicitação que contém instruções do sistema que influenciam como o modelo gerará uma resposta de conclusões de chat. |
| ChatRequestToolMessage |
Uma mensagem de chat de solicitação que representa a saída solicitada de uma ferramenta configurada. |
| ChatRequestUserMessage |
Uma mensagem de chat de solicitação que representa a entrada do usuário para o assistente. |
| ChatResponseMessageOutput |
Uma representação de uma mensagem de chat como recebida em uma resposta. |
| CompletionsUsageOutput |
Representação das contagens de tokens processadas para uma solicitação de conclusão. As contagens consideram todos os tokens entre prompts, opções, alternativas de escolha, best_of gerações e outros consumidores. |
| EmbeddingItemOutput |
Representação de uma única comparação de relação de inserções. |
| EmbeddingsResultOutput |
Representação dos dados de resposta de uma solicitação de inserção. As inserções medem a relação das cadeias de caracteres de texto e geralmente são usadas para pesquisa, clustering, recomendações e outros cenários semelhantes. |
| EmbeddingsUsageOutput |
Medição da quantidade de tokens usados nesta solicitação e resposta. |
| FunctionCall |
O nome e os argumentos de uma função que deve ser chamada, conforme gerado pelo modelo. |
| FunctionCallOutput |
O nome e os argumentos de uma função que deve ser chamada, conforme gerado pelo modelo. |
| FunctionDefinition |
A definição de uma função especificada pelo chamador que as conclusões do chat podem invocar em resposta à entrada do usuário correspondente. |
| GetChatCompletions | |
| GetChatCompletions200Response |
A solicitação foi bem-sucedida. |
| GetChatCompletionsBodyParam | |
| GetChatCompletionsDefaultHeaders | |
| GetChatCompletionsDefaultResponse | |
| GetChatCompletionsHeaderParam | |
| GetChatCompletionsHeaders | |
| GetEmbeddings | |
| GetEmbeddings200Response |
A solicitação foi bem-sucedida. |
| GetEmbeddingsBodyParam | |
| GetEmbeddingsDefaultHeaders | |
| GetEmbeddingsDefaultResponse | |
| GetEmbeddingsHeaderParam | |
| GetEmbeddingsHeaders | |
| GetImageEmbeddings | |
| GetImageEmbeddings200Response |
A solicitação foi bem-sucedida. |
| GetImageEmbeddingsBodyParam | |
| GetImageEmbeddingsDefaultHeaders | |
| GetImageEmbeddingsDefaultResponse | |
| GetImageEmbeddingsHeaderParam | |
| GetImageEmbeddingsHeaders | |
| GetModelInfo | |
| GetModelInfo200Response |
A solicitação foi bem-sucedida. |
| GetModelInfoDefaultHeaders | |
| GetModelInfoDefaultResponse | |
| ImageEmbeddingInput |
Representa uma imagem com texto opcional. |
| ModelClientOptions |
Os parâmetros opcionais para o cliente |
| ModelInfoOutput |
Representa algumas informações básicas sobre o modelo de IA. |
| Routes | |
Aliases de tipo
| ChatCompletionsResponseFormat |
Representa o formato que o modelo deve gerar. Use isso para habilitar o modo JSON em vez do modo de texto padrão. Observe que, para habilitar o modo JSON, alguns modelos de IA também podem exigir que você instrua o modelo a produzir JSON por meio de um sistema ou mensagem de usuário. |
| ChatCompletionsToolChoicePreset |
Alias para ChatCompletionsToolChoicePreset |
| ChatMessageContentItem |
Uma representação abstrata de um item de conteúdo estruturado em uma mensagem de chat. |
| ChatMessageImageDetailLevel |
Alias para ChatMessageImageDetailLevel |
| ChatRequestMessage |
Uma representação abstrata de uma mensagem de chat, conforme fornecido em uma solicitação. |
| ChatRole |
Alias para ChatRole |
| ChatRoleOutput |
Alias para ChatRoleOutput |
| CompletionsFinishReasonOutput |
Alias para CompletionsFinishReasonOutput |
| EmbeddingEncodingFormat |
Alias para EmbeddingEncodingFormat |
| EmbeddingInputType |
Alias para EmbeddingInputType |
| ExtraParameters |
Alias para ExtraParameters |
| GetChatCompletionsParameters | |
| GetEmbeddingsParameters | |
| GetImageEmbeddingsParameters | |
| GetModelInfoParameters | |
| ModelClient | |
| ModelTypeOutput |
Alias para ModelTypeOutput |
Funções
Detalhes da função
default(string, TokenCredential | KeyCredential, ModelClientOptions)
Inicializar uma nova instância de ModelClient
function default(endpointParam: string, credentials: TokenCredential | KeyCredential, options?: ModelClientOptions): ModelClientParâmetros
- endpointParam
-
string
O parâmetro endpointParam
- credentials
identificar exclusivamente a credencial do cliente
- options
- ModelClientOptions
o parâmetro para todos os parâmetros opcionais
Retornos
isUnexpected(GetChatCompletions200Response | GetChatCompletionsDefaultResponse)
function isUnexpected(response: GetChatCompletions200Response | GetChatCompletionsDefaultResponse): responseParâmetros
Retornos
response
isUnexpected(GetModelInfo200Response | GetModelInfoDefaultResponse)
function isUnexpected(response: GetModelInfo200Response | GetModelInfoDefaultResponse): responseParâmetros
Retornos
response
isUnexpected(GetEmbeddings200Response | GetEmbeddingsDefaultResponse)
function isUnexpected(response: GetEmbeddings200Response | GetEmbeddingsDefaultResponse): responseParâmetros
Retornos
response
isUnexpected(GetImageEmbeddings200Response | GetImageEmbeddingsDefaultResponse)
function isUnexpected(response: GetImageEmbeddings200Response | GetImageEmbeddingsDefaultResponse): responseParâmetros
Retornos
response
Azure SDK for JavaScript