@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ão de chat.
Geralmente, |
ChatCompletionsNamedToolChoice |
Uma seleção de ferramentas de uma ferramenta de função nomeada específica que limitará a conclusão do bate-papo ao uso da função nomeada. |
ChatCompletionsNamedToolChoiceFunction |
Uma seleção de ferramentas de uma ferramenta de função nomeada específica que limitará a conclusão do bate-papo ao uso da função nomeada. |
ChatCompletionsOutput |
Representação dos dados de resposta de uma solicitação de conclusão de chat. As finalizações suportam uma ampla variedade de tarefas e geram texto que continua a partir ou "completa" os dados de prompt fornecidos. |
ChatCompletionsResponseFormatJsonObject |
Um formato de resposta para Conclusão 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 do usuário. |
ChatCompletionsResponseFormatJsonSchema |
Um formato de resposta para Conclusão 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ão de chat como JSON com um determinado esquema. O modelo de IA precisará aderir a esse esquema ao gerar conclusão. |
ChatCompletionsResponseFormatParent |
Representa o formato que o modelo deve produzir. 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 do usuário. |
ChatCompletionsResponseFormatText |
Um formato de resposta para Conclusão de Chat que emite respostas de texto. Este é 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 dentro de uma mensagem de chat. |
ChatMessageImageContentItem |
Um item de conteúdo de chat estruturado contendo uma referência de imagem. |
ChatMessageImageUrl |
Um local na Internet a partir do qual o modelo pode recuperar uma imagem. |
ChatMessageTextContentItem |
Um item de conteúdo de chat estruturado contendo texto sem formatação. |
ChatRequestAssistantMessage |
Uma mensagem de chat de solicitação que representa a resposta ou ação do assistente. |
ChatRequestMessageParent |
Uma representação abstrata de uma mensagem de bate-papo, conforme fornecido em uma solicitação. |
ChatRequestSystemMessage |
Uma mensagem de chat de solicitação contendo instruções do sistema que influenciam como o modelo gerará uma resposta de conclusão 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 bate-papo recebida em uma resposta. |
CompletionsUsageOutput |
Representação das contagens de token processadas para uma solicitação de conclusão. As contagens consideram todos os tokens em prompts, escolhas, alternativas de escolha, gerações best_of e outros consumidores. |
EmbeddingItemOutput |
Representação de uma única comparação de parentesco incorporado. |
EmbeddingsResultOutput |
Representação dos dados de resposta de uma solicitação de incorporação. As incorporações medem a relação de cadeias de caracteres de texto e são comumente 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 finalizações de chat podem invocar em resposta à entrada do usuário correspondente. |
GetChatCompletions | |
GetChatCompletions200Response |
O pedido foi bem-sucedido. |
GetChatCompletionsBodyParam | |
GetChatCompletionsDefaultHeaders | |
GetChatCompletionsDefaultResponse | |
GetChatCompletionsHeaderParam | |
GetChatCompletionsHeaders | |
GetEmbeddings | |
GetEmbeddings200Response |
O pedido foi bem-sucedido. |
GetEmbeddingsBodyParam | |
GetEmbeddingsDefaultHeaders | |
GetEmbeddingsDefaultResponse | |
GetEmbeddingsHeaderParam | |
GetEmbeddingsHeaders | |
GetImageEmbeddings | |
GetImageEmbeddings200Response |
O pedido foi bem-sucedido. |
GetImageEmbeddingsBodyParam | |
GetImageEmbeddingsDefaultHeaders | |
GetImageEmbeddingsDefaultResponse | |
GetImageEmbeddingsHeaderParam | |
GetImageEmbeddingsHeaders | |
GetModelInfo | |
GetModelInfo200Response |
O pedido foi bem-sucedido. |
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 produzir. 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 do usuário. |
ChatCompletionsToolChoicePreset |
Alias para ChatCompletionsToolChoicePreset |
ChatMessageContentItem |
Uma representação abstrata de um item de conteúdo estruturado dentro de uma mensagem de chat. |
ChatMessageImageDetailLevel |
Alias para ChatMessageImageDetailLevel |
ChatRequestMessage |
Uma representação abstrata de uma mensagem de bate-papo, conforme fornecido em uma solicitação. |
ChatRole |
Alias para ChatRole |
ChatRoleOutput |
Alias para ChatRoleOutput |
CompletionsFinishReasonOutput |
Alias for 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 de Função
default(string, TokenCredential | KeyCredential, ModelClientOptions)
Inicializar uma nova instância do ModelClient
function default(endpointParam: string, credentials: TokenCredential | KeyCredential, options?: ModelClientOptions): ModelClient
Parâ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
Devoluções
isUnexpected(GetChatCompletions200Response | GetChatCompletionsDefaultResponse)
function isUnexpected(response: GetChatCompletions200Response | GetChatCompletionsDefaultResponse): response
Parâmetros
Devoluções
response
isUnexpected(GetModelInfo200Response | GetModelInfoDefaultResponse)
function isUnexpected(response: GetModelInfo200Response | GetModelInfoDefaultResponse): response
Parâmetros
Devoluções
response
isUnexpected(GetEmbeddings200Response | GetEmbeddingsDefaultResponse)
function isUnexpected(response: GetEmbeddings200Response | GetEmbeddingsDefaultResponse): response
Parâmetros
Devoluções
response
isUnexpected(GetImageEmbeddings200Response | GetImageEmbeddingsDefaultResponse)
function isUnexpected(response: GetImageEmbeddings200Response | GetImageEmbeddingsDefaultResponse): response
Parâmetros
Devoluções
response
Azure SDK for JavaScript