@azure/openai package

Referência

Classes

Uma credencial baseada em chave estática que dá suporte à atualização do valor da chave subjacente.

Um cliente para interagir com o OpenAI do Azure.

O cliente precisa do ponto de extremidade de um recurso OpenAI e de um método de autenticação, como uma chave de API ou um token. A chave de API e o ponto de extremidade podem ser encontrados na página de recursos do OpenAI. Eles estarão localizados na página Chaves e Ponto de Extremidade do recurso.

Exemplos de autenticação:

Chave de API

import { OpenAIClient } from "@azure/openai";
import { AzureKeyCredential } from "@azure/core-auth";

const endpoint = "<azure endpoint>";
const credential = new AzureKeyCredential("<api key>");

const client = new OpenAIClient(endpoint, credential);

Azure Active Directory

import { OpenAIClient } from "@azure/openai";
import { DefaultAzureCredential } from "@azure/identity";

const endpoint = "<azure endpoint>";
const credential = new DefaultAzureCredential();

const client = new OpenAIClient(endpoint, credential);

OpenAIKeyCredential

A classe OpenAIKeyCredential representa uma chave de API OpenAI e é usada para autenticar em um cliente OpenAI para um ponto de extremidade OpenAI.

Interfaces

AudioResultSimpleJson	Resposta de transcrição simples
AudioResultVerboseJson	Resposta de transcrição.
AudioSegment	Segmento de transcrição.
AzureChatEnhancementConfiguration	Uma representação das configurações de aprimoramento do Azure OpenAI disponíveis.
AzureChatEnhancements	Representa os resultados de saída dos aprimoramentos do Azure para conclusões de chat, conforme configurado por meio da entrada correspondente fornecida na solicitação.
AzureChatExtensionConfiguration	Uma representação dos dados de configuração para uma única extensão de chat do Azure OpenAI. Isso será usado por uma solicitação de conclusão de chat que deve usar extensões de chat do Azure OpenAI para aumentar o comportamento da resposta. O uso dessa configuração é compatível apenas com o OpenAI do Azure.
AzureChatExtensionDataSourceResponseCitation	Uma única instância de informações de contexto adicionais disponíveis quando as extensões de chat do Azure OpenAI estão envolvidas na geração de uma resposta de conclusão de chat correspondente. Essas informações de contexto só são preenchidas ao usar uma solicitação OpenAI do Azure configurada para usar uma extensão correspondente.
AzureChatExtensionsMessageContext	Uma representação das informações de contexto adicionais disponíveis quando as extensões de chat do Azure OpenAI estão envolvidas na geração de uma resposta de conclusão de chat correspondente. Essas informações de contexto só são preenchidas ao usar uma solicitação OpenAI do Azure configurada para usar uma extensão correspondente.
AzureChatGroundingEnhancementConfiguration	Uma representação das opções disponíveis para o aprimoramento de aterramento do Azure OpenAI.
AzureChatOCREnhancementConfiguration	Uma representação das opções disponíveis para o aprimoramento do OCR (reconhecimento óptico de caracteres) do Azure OpenAI.
AzureCosmosDBChatExtensionConfiguration	Uma representação específica de opções configuráveis para o Azure Cosmos DB ao usá-la como uma extensão de chat openai do Azure.
AzureCosmosDBFieldMappingOptions	Configurações opcionais para controlar como os campos são processados ao usar um recurso do Azure Cosmos DB configurado.
AzureExtensionsOptions	Opções para extensões de chat do Azure OpenAI.
AzureGroundingEnhancement	O aprimoramento de aterramento que retorna a caixa delimitadora dos objetos detectados na imagem.
AzureGroundingEnhancementCoordinatePoint	Uma representação de um único ponto de polígono, conforme usado pelo aprimoramento de aterramento do Azure.
AzureGroundingEnhancementLine	Um objeto de linha de conteúdo que consiste em uma sequência adjacente de elementos de conteúdo, como palavras e marcas de seleção.
AzureGroundingEnhancementLineSpan	Um objeto span que representa um objeto detectado e suas informações de caixa delimitadora.
AzureMachineLearningIndexChatExtensionConfiguration	Uma representação específica de opções configuráveis para o índice de vetor do Azure Machine Learning ao usá-lo como uma extensão de chat do Azure OpenAI.
AzureSearchChatExtensionConfiguration	Uma representação específica de opções configuráveis para o Azure Pesquisa ao usá-la como uma extensão de chat do Azure OpenAI.
AzureSearchIndexFieldMappingOptions	Configurações opcionais para controlar como os campos são processados ao usar um recurso de Pesquisa do Azure configurado.
ChatChoice	A representação de uma única conclusão de prompt como parte de uma solicitação geral de conclusões de chat. Geralmente, `n` as opções são geradas por prompt fornecido com um valor padrão de 1. Limites de token e outras configurações podem limitar o número de opções geradas.
ChatChoiceLogProbabilityInfo	Registrar informações de probabilidade para uma escolha, conforme solicitado por meio de 'logprobs' e 'top_logprobs'.
ChatCompletions	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.
ChatCompletionsFunctionToolCall	Uma chamada de ferramenta para uma ferramenta de função, emitida pelo modelo na avaliação de uma ferramenta de função configurada, que representa uma invocação de função necessária para uma solicitação de conclusão de chat subsequente para resolve.
ChatCompletionsFunctionToolDefinition	As informações de definição de uma ferramenta de função de conclusão de chat que pode chamar uma função em resposta a uma chamada de ferramenta.
ChatCompletionsFunctionToolSelection	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.
ChatCompletionsJsonResponseFormat	Um formato de resposta para Conclusões de Chat que restringe as respostas à emissão de objetos JSON válidos.
ChatCompletionsNamedFunctionToolSelection	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.
ChatCompletionsNamedToolSelection	Uma representação abstrata de uma seleção de ferramenta nomeada explícita a ser usada para uma solicitação de conclusão de chat.
ChatCompletionsResponseFormat	Uma representação abstrata de uma configuração de formato de resposta utilizável por Preenchimentos de Chat. Pode ser usado para habilitar o modo JSON.
ChatCompletionsTextResponseFormat	O formato de resposta de Conclusões de Chat padrão que pode gerar texto livremente e não tem garantia de produzir conteúdo de resposta que adere a um esquema específico.
ChatCompletionsToolCall	Uma representação abstrata de uma chamada de ferramenta que deve ser resolvida em uma solicitação subsequente para executar a conclusão do chat solicitada.
ChatCompletionsToolDefinition	Uma representação abstrata de uma ferramenta que pode ser usada pelo modelo para melhorar uma resposta de conclusões de chat.
ChatFinishDetails	Uma representação abstrata de informações estruturadas sobre por que uma resposta de conclusão de chat foi encerrada.
ChatMessageContentItem	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 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.
ChatRequestFunctionMessage	Uma mensagem de chat de solicitação que representa a saída solicitada de uma função configurada.
ChatRequestMessage	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 no assistente.
ChatResponseMessage	Uma representação de uma mensagem de chat recebida em uma resposta.
ChatTokenLogProbabilityInfo	Uma representação das informações de probabilidade do log para um único token de conteúdo de mensagem.
ChatTokenLogProbabilityResult	Uma representação das informações de probabilidade de log para um único token de conteúdo, incluindo uma lista dos tokens mais prováveis se 'top_logprobs' tiverem sido solicitados.
Choice	A representação de uma única conclusão de prompt como parte de uma solicitação de conclusão geral. Geralmente, `n` as opções são geradas por prompt fornecido com um valor padrão de 1. Limites de token e outras configurações podem limitar o número de opções geradas.
Completions	Representação dos dados de resposta de uma solicitação de conclusão. As conclusões dão suporte a uma ampla variedade de tarefas e geram texto que continua de ou "conclui" dados de prompt fornecidos.
CompletionsLogProbabilityModel	Representação de um modelo de probabilidades de log para uma geração de conclusões.
CompletionsUsage	Representação das contagens de token 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.
ContentFilterBlocklistIdResult	Representa o resultado de uma avaliação em relação a uma lista de bloqueios personalizada, conforme executado pela filtragem de conteúdo.
ContentFilterCitedDetectionResult	Representa o resultado de uma operação de detecção contra recursos protegidos, conforme executado pela filtragem de conteúdo.
ContentFilterDetectionResult	Representa o resultado de uma operação de detecção executada pela filtragem de conteúdo.
ContentFilterErrorResults	Informações sobre o resultado do erro de filtragem de conteúdo.
ContentFilterResult	Informações sobre o nível de gravidade do conteúdo filtrado e se ele foi filtrado ou não.
ContentFilterResultsForPrompt	Os resultados da filtragem de conteúdo para um único prompt na solicitação.
ContentFilterSuccessResultDetailsForPrompt	Informações sobre o resultado de êxito da filtragem de conteúdo.
ContentFilterSuccessResultsForChoice	Informações sobre a filtragem de conteúdo avaliada em relação à saída do modelo gerada.
ElasticsearchChatExtensionConfiguration	Uma representação específica das opções configuráveis para o Elasticsearch ao usá-la como uma extensão de chat openai do Azure.
ElasticsearchIndexFieldMappingOptions	Configurações opcionais para controlar como os campos são processados ao usar um recurso Elasticsearch® configurado.
EmbeddingItem	Representação de uma única comparação de relação de inserções.
Embeddings	Representação dos dados de resposta de uma solicitação de inserções. As inserções medem a relação das cadeias de caracteres de texto e são comumente usadas para pesquisa, clustering, recomendações e outros cenários semelhantes.
EmbeddingsUsage	Medição da quantidade de tokens usados nesta solicitação e resposta.
EventStream	Um fluxo legível que é iterável e descartável.
FunctionCall	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 os preenchimentos de chat podem invocar em resposta à entrada do usuário correspondente.
FunctionName	Uma estrutura que especifica o nome exato de uma função específica fornecida pela solicitação a ser usada ao processar uma operação de conclusão de chat.
GetAudioTranscriptionOptions	As opções para uma solicitação de transcrição de áudio
GetAudioTranslationOptions	As opções para uma solicitação de tradução de áudio
GetChatCompletionsOptions	Este módulo contém modelos que queremos viver lado a lado com os modelos gerados correspondentes. Isso é útil para fornecer modelos voltados para o cliente que têm nomes/tipos diferentes dos modelos gerados.
GetCompletionsOptions	As informações de configuração de uma solicitação de conclusão. As conclusões dão suporte a uma ampla variedade de tarefas e geram texto que continua ou "conclui" dados de prompt fornecidos.
GetEmbeddingsOptions	Opções para solicitação de inserções personalizadas
GetImagesOptions	Representa os dados de solicitação usados para gerar imagens.
ImageGenerationContentFilterResults	Descreve o resultado da filtragem de conteúdo para a solicitação de geração de imagem.
ImageGenerationData	Uma representação de uma única imagem gerada, fornecida como dados codificados em base64 ou como uma URL da qual a imagem pode ser recuperada.
ImageGenerationPromptFilterResults	Descreve os resultados da filtragem de conteúdo para o prompt de uma solicitação de geração de imagem.
ImageGenerations	O resultado de uma operação de geração de imagem bem-sucedida.
MaxTokensFinishDetails	Uma representação estruturada de um motivo de parada que significa que um limite de token foi atingido antes que o modelo pudesse ser concluído naturalmente.
OnYourDataAccessTokenAuthenticationOptions	As opções de autenticação para o OpenAI do Azure em seus dados ao usar o token de acesso.
OnYourDataApiKeyAuthenticationOptions	As opções de autenticação para o OpenAI do Azure em seus dados ao usar uma chave de API.
OnYourDataAuthenticationOptions	As opções de autenticação do Azure OpenAI em seus dados.
OnYourDataConnectionStringAuthenticationOptions	As opções de autenticação para o OpenAI do Azure em seus dados ao usar um cadeia de conexão.
OnYourDataDeploymentNameVectorizationSource	Os detalhes de uma fonte de vetorização, usada pelo OpenAI do Azure em seus dados ao aplicar a pesquisa de vetor, que se baseia em um nome de implantação de modelo de inserções internas no mesmo recurso openAI do Azure.
OnYourDataEncodedApiKeyAuthenticationOptions	As opções de autenticação para o OpenAI do Azure em seus dados ao usar uma chave de API codificada do Elasticsearch.
OnYourDataEndpointVectorizationSource	Os detalhes de uma fonte de vetorização, usada pelo OpenAI do Azure em seus dados ao aplicar a pesquisa de vetor, que se baseia em uma chamada pública de ponto de extremidade openAI do Azure para inserções.
OnYourDataKeyAndKeyIdAuthenticationOptions	As opções de autenticação para o OpenAI do Azure em seus dados ao usar um par de IDs de chave e chave do Elasticsearch.
OnYourDataModelIdVectorizationSource	Os detalhes de uma fonte de vetorização, usada pelo OpenAI do Azure em seus dados ao aplicar a pesquisa de vetor, que se baseia em uma ID de modelo de serviço de pesquisa. Atualmente, há suporte apenas para Elasticsearch®.
OnYourDataSystemAssignedManagedIdentityAuthenticationOptions	As opções de autenticação para o OpenAI do Azure em seus dados ao usar uma identidade gerenciada atribuída pelo sistema.
OnYourDataUserAssignedManagedIdentityAuthenticationOptions	As opções de autenticação do Azure OpenAI em seus dados ao usar uma identidade gerenciada atribuída pelo usuário.
OnYourDataVectorizationSource	Uma representação abstrata de uma fonte de vetorização para o OpenAI do Azure em seus dados com pesquisa de vetor.
OpenAIClientOptions
PineconeChatExtensionConfiguration	Uma representação específica de opções configuráveis para Pinecone ao usá-lo como uma extensão de chat do OpenAI do Azure.
PineconeFieldMappingOptions	Configurações opcionais para controlar como os campos são processados ao usar um recurso pinecone configurado.
StopFinishDetails	Uma representação estruturada de um motivo de parada que significa encerramento natural pelo modelo.

Aliases de tipo

AudioResult	O tipo do resultado da transcrição com base no formato de resposta solicitado
AudioResultFormat	O formato de resultado de uma tarefa de áudio
AudioTranscriptionTask	"transcrever", "traduzir"
AzureChatExtensionConfigurationUnion	Alias para AzureChatExtensionConfigurationUnion
AzureChatExtensionType	"azure_search", "azure_ml_index", "azure_cosmos_db", "elasticsearch", "pinecone"
AzureSearchQueryType	"simples", "semântico", "vetor", "vector_simple_hybrid", "vector_semantic_hybrid"
ChatCompletionsNamedToolSelectionUnion	Alias para ChatCompletionsNamedToolSelectionUnion
ChatCompletionsResponseFormatUnion	Alias para ChatCompletionsResponseFormatUnion
ChatCompletionsToolCallUnion	Alias para ChatCompletionsToolCallUnion
ChatCompletionsToolDefinitionUnion	Alias para ChatCompletionsToolDefinitionUnion
ChatCompletionsToolSelectionPreset	"auto", "none"
ChatFinishDetailsUnion	Alias para ChatFinishDetailsUnion
ChatMessageContentItemUnion	Alias para ChatMessageContentItemUnion
ChatMessageImageDetailLevel	"auto", "low", "high"
ChatRequestMessageUnion	Alias para ChatRequestMessageUnion
ChatRole	"system", "assistente", "user", "function", "tool"
CompletionsFinishReason	"stop", "length", "content_filter", "function_call", "tool_calls"
ContentFilterResultDetailsForPrompt	Informações sobre a categoria de filtragem de conteúdo, se ela tiver sido detectada.
ContentFilterResultsForChoice	Informações sobre os resultados da filtragem de conteúdo, se ele tiver sido detectado.
ContentFilterSeverity	"safe", "low", "medium", "high"
ElasticsearchQueryType	"simples", "vetor"
FunctionCallPreset	"auto", "none"
ImageGenerationQuality	"standard", "hd"
ImageGenerationResponseFormat	"url", "b64_json"
ImageGenerationStyle	"natural", "vivid"
ImageSize	"256x256", "512x512", "1024x1024", "1792x1024", "1024x1792"
OnYourDataAuthenticationOptionsUnion	Alias para OnYourDataAuthenticationOptionsUnion
OnYourDataAuthenticationType	"api_key", "connection_string", "key_and_key_id", "encoded_api_key", "access_token", "system_assigned_managed_identity", "user_assigned_managed_identity"
OnYourDataVectorizationSourceType	"endpoint", "deployment_name", "model_id"
OnYourDataVectorizationSourceUnion	Alias para OnYourDataVectorizationSourceUnion

Compartilhar via