@azure/openai package

Referência

Classes

Uma credencial baseada em chave estática que suporta a atualização do valor da chave subjacente.

Um cliente para interagir com o Azure OpenAI.

O cliente precisa do ponto final 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 final podem ser encontrados na página de recursos OpenAI. Estarão localizadas na página Chaves e Ponto Final 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 é utilizada para autenticar num cliente OpenAI para um ponto final 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 melhoramento do Azure OpenAI disponíveis.
AzureChatEnhancements	Representa os resultados de saída das melhorias do Azure às conclusões de chat, conforme configurado através da entrada correspondente fornecida no pedido.
AzureChatExtensionConfiguration	Uma representação dos dados de configuração para uma única extensão de chat do Azure OpenAI. Isto será utilizado por um pedido de conclusão de chat que deve utilizar extensões de chat do Azure OpenAI para aumentar o comportamento da resposta. A utilização desta configuração é compatível apenas com o Azure OpenAI.
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. Estas informações de contexto só são preenchidas ao utilizar um pedido do Azure OpenAI configurado para utilizar 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. Estas informações de contexto só são preenchidas ao utilizar um pedido do Azure OpenAI configurado para utilizar uma extensão correspondente.
AzureChatGroundingEnhancementConfiguration	Uma representação das opções disponíveis para o melhoramento da base do Azure OpenAI.
AzureChatOCREnhancementConfiguration	Uma representação das opções disponíveis para o melhoramento do reconhecimento ótico de carateres (OCR) do Azure OpenAI.
AzureCosmosDBChatExtensionConfiguration	Uma representação específica das opções configuráveis para o Azure Cosmos DB ao utilizá-la como uma extensão de chat do Azure OpenAI.
AzureCosmosDBFieldMappingOptions	Definições opcionais para controlar a forma como os campos são processados ao utilizar um recurso do Azure Cosmos DB configurado.
AzureExtensionsOptions	Opções para extensões de chat do Azure OpenAI.
AzureGroundingEnhancement	O melhoramento da ligação à terra que devolve a caixa delimitadora dos objetos detetados na imagem.
AzureGroundingEnhancementCoordinatePoint	Uma representação de um único ponto de polígono, conforme utilizado pelo melhoramento de terra do Azure.
AzureGroundingEnhancementLine	Um objeto de linha de conteúdo que consiste numa sequência adjacente de elementos de conteúdo, como palavras e marcas de seleção.
AzureGroundingEnhancementLineSpan	Um objeto span que representa um objeto detetado e as respetivas informações da caixa delimitadora.
AzureMachineLearningIndexChatExtensionConfiguration	Uma representação específica das opções configuráveis para o índice de vetores do Azure Machine Learning ao utilizá-lo como uma extensão de chat do Azure OpenAI.
AzureSearchChatExtensionConfiguration	Uma representação específica das opções configuráveis para o Azure Pesquisa ao utilizá-la como uma extensão de chat do Azure OpenAI.
AzureSearchIndexFieldMappingOptions	Definições opcionais para controlar a forma como os campos são processados ao utilizar um recurso do Azure Pesquisa configurado.
ChatChoice	A representação de uma conclusão de pedido único como parte de um pedido geral de conclusão de chat. Geralmente, `n` as escolhas são geradas por pedido fornecido com um valor predefinido de 1. Os limites de tokens e outras definições podem limitar o número de opções geradas.
ChatChoiceLogProbabilityInfo	Registe as informações de probabilidade de uma escolha, conforme pedido através de "logprobs" e "top_logprobs".
ChatCompletions	Representação dos dados de resposta de um pedido de conclusão de chat. As conclusões suportam uma grande variedade de tarefas e geram texto que continua a partir dos dados de pedido fornecidos ou "concluídos".
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 um pedido de conclusão de chat subsequente para resolver.
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 ferramentas de uma ferramenta de função específica com o nome que irá limitar as conclusões de chat à utilização 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 ferramentas de uma ferramenta de função específica com o nome que irá limitar as conclusões de chat à utilização da função nomeada.
ChatCompletionsNamedToolSelection	Uma representação abstrata de uma seleção explícita de ferramentas com nome para utilizar para um pedido de conclusão de chat.
ChatCompletionsResponseFormat	Uma representação abstrata de uma configuração de formato de resposta utilizável pelas Conclusões de Chat. Pode ser utilizado para ativar o modo JSON.
ChatCompletionsTextResponseFormat	O formato de resposta Preenchimentos de Chat padrão que pode gerar texto livremente e não é garantido que produz conteúdo de resposta que cumpra um esquema específico.
ChatCompletionsToolCall	Uma representação abstrata de uma chamada de ferramenta que tem de ser resolvida num pedido subsequente para efetuar a conclusão de chat pedida.
ChatCompletionsToolDefinition	Uma representação abstrata de uma ferramenta que pode ser utilizada pelo modelo para melhorar uma resposta de conclusão de chat.
ChatFinishDetails	Uma representação abstrata de informações estruturadas sobre o motivo pelo qual uma resposta de conclusão de chat terminou.
ChatMessageContentItem	Uma representação abstrata de um item de conteúdo estruturado numa mensagem de chat.
ChatMessageImageContentItem	Um item de conteúdo de chat estruturado que contém uma referência de imagem.
ChatMessageImageUrl	Uma localização na Internet a partir da qual o modelo pode obter uma imagem.
ChatMessageTextContentItem	Um item de conteúdo de chat estruturado que contém texto simples.
ChatRequestAssistantMessage	Uma mensagem de chat de pedido que representa a resposta ou ação do assistente.
ChatRequestFunctionMessage	Uma mensagem de chat de pedido que representa a saída pedida de uma função configurada.
ChatRequestMessage	Uma representação abstrata de uma mensagem de chat, conforme fornecido num pedido.
ChatRequestSystemMessage	Uma mensagem de chat de pedido que contém instruções do sistema que influenciam a forma como o modelo irá gerar uma resposta de conclusão de chat.
ChatRequestToolMessage	Uma mensagem de chat de pedido que representa o resultado pedido de uma ferramenta configurada.
ChatRequestUserMessage	Uma mensagem de chat de pedido que representa a entrada do utilizador no assistente.
ChatResponseMessage	Uma representação de uma mensagem de chat, conforme recebido numa resposta.
ChatTokenLogProbabilityInfo	Uma representação das informações de probabilidade de registo de um token de conteúdo de mensagem única.
ChatTokenLogProbabilityResult	Uma representação das informações de probabilidade de registo de um token de conteúdo único, incluindo uma lista dos tokens mais prováveis se forem pedidos "top_logprobs".
Choice	A representação de uma conclusão de pedido único como parte de um pedido de conclusão geral. Geralmente, `n` as escolhas são geradas por pedido fornecido com um valor predefinido de 1. Os limites de tokens e outras definições podem limitar o número de opções geradas.
Completions	Representação dos dados de resposta de um pedido de conclusão. As conclusões suportam uma grande variedade de tarefas e geram texto que continua a partir dos dados de pedido fornecidos ou "concluídos".
CompletionsLogProbabilityModel	Representação de um modelo de probabilidades de registo para uma geração de conclusões.
CompletionsUsage	Representação das contagens de tokens processadas para um pedido de conclusão. As contagens consideram todos os tokens entre pedidos, escolhas, alternativas de escolha, gerações best_of e outros consumidores.
ContentFilterBlocklistIdResult	Representa o resultado de uma avaliação relativamente a uma lista de bloqueios personalizada, conforme realizado pela filtragem de conteúdos.
ContentFilterCitedDetectionResult	Representa o resultado de uma operação de deteção contra recursos protegidos, conforme realizado pela filtragem de conteúdos.
ContentFilterDetectionResult	Representa o resultado de uma operação de deteção realizada pela filtragem de conteúdos.
ContentFilterErrorResults	Informações sobre o resultado do erro de filtragem de conteúdos.
ContentFilterResult	Informações sobre o nível de gravidade do conteúdo filtrado e se foi filtrado ou não.
ContentFilterResultsForPrompt	Resultados da filtragem de conteúdo para um único pedido no pedido.
ContentFilterSuccessResultDetailsForPrompt	Informações sobre o resultado de êxito da filtragem de conteúdos.
ContentFilterSuccessResultsForChoice	Informações sobre a filtragem de conteúdos avaliadas relativamente à saída do modelo gerado.
ElasticsearchChatExtensionConfiguration	Uma representação específica das opções configuráveis para Elasticsearch ao utilizá-la como uma extensão de chat do Azure OpenAI.
ElasticsearchIndexFieldMappingOptions	Definições opcionais para controlar a forma como os campos são processados ao utilizar um recurso do Elasticsearch® configurado.
EmbeddingItem	Representação de uma única comparação de relacionados com incorporações.
Embeddings	Representação dos dados de resposta de um pedido de incorporação. As incorporações medem a relação das cadeias de texto e são frequentemente utilizadas para pesquisa, clustering, recomendações e outros cenários semelhantes.
EmbeddingsUsage	Medição da quantidade de tokens utilizados neste pedido 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 autor da chamada que as conclusões do chat podem invocar em resposta à entrada do utilizador correspondente.
FunctionName	Uma estrutura que especifica o nome exato de uma função específica fornecida pelo pedido para utilizar ao processar uma operação de conclusão de chat.
GetAudioTranscriptionOptions	As opções para um pedido de transcrição de áudio
GetAudioTranslationOptions	As opções para um pedido de tradução de áudio
GetChatCompletionsOptions	Este módulo contém modelos que queremos viver lado a lado com os modelos gerados correspondentes. Isto é útil para fornecer modelos destinados ao cliente com nomes/tipos diferentes dos modelos gerados.
GetCompletionsOptions	As informações de configuração de um pedido de conclusão. As conclusões suportam uma grande variedade de tarefas e geram texto que continua a partir dos dados de pedido fornecidos ou "concluídos".
GetEmbeddingsOptions	Opções para o pedido de incorporações personalizadas
GetImagesOptions	Representa os dados do pedido utilizados para gerar imagens.
ImageGenerationContentFilterResults	Descreve o resultado da filtragem de conteúdos para o pedido de geração de imagens.
ImageGenerationData	Uma representação de uma única imagem gerada, fornecida como dados codificados com base64 ou como um URL a partir do qual a imagem pode ser obtida.
ImageGenerationPromptFilterResults	Descreve os resultados da filtragem de conteúdos para o pedido de geração de imagens.
ImageGenerations	O resultado de uma operação de geração de imagens com êxito.
MaxTokensFinishDetails	Uma representação estruturada de uma razão de paragem que significa que foi atingido um limite de tokens antes de o modelo poder ser naturalmente concluído.
OnYourDataAccessTokenAuthenticationOptions	As opções de autenticação do Azure OpenAI Nos Seus Dados ao utilizar o token de acesso.
OnYourDataApiKeyAuthenticationOptions	As opções de autenticação do Azure OpenAI Nos Seus Dados ao utilizar uma chave de API.
OnYourDataAuthenticationOptions	As opções de autenticação do Azure OpenAI Nos Seus Dados.
OnYourDataConnectionStringAuthenticationOptions	As opções de autenticação do Azure OpenAI Nos Seus Dados ao utilizar um cadeia de ligação.
OnYourDataDeploymentNameVectorizationSource	Os detalhes de uma origem de vetorização, utilizada pelo Azure OpenAI Nos Seus Dados ao aplicar a pesquisa de vetores, que se baseia num nome de implementação do modelo de incorporação interno no mesmo recurso do Azure OpenAI.
OnYourDataEncodedApiKeyAuthenticationOptions	As opções de autenticação do Azure OpenAI Nos Seus Dados ao utilizar uma chave de API codificada do Elasticsearch.
OnYourDataEndpointVectorizationSource	Os detalhes de uma origem de vetorização, utilizada pelo Azure OpenAI Nos Seus Dados ao aplicar a pesquisa de vetores, que se baseia numa chamada de ponto final público do Azure OpenAI para incorporações.
OnYourDataKeyAndKeyIdAuthenticationOptions	As opções de autenticação do Azure OpenAI Nos Seus Dados ao utilizar uma chave Elasticsearch e um par de IDs de chave.
OnYourDataModelIdVectorizationSource	Os detalhes de uma origem de vetorização, utilizada pelo Azure OpenAI Nos Seus Dados ao aplicar a pesquisa de vetores, que se baseia num ID de modelo de serviço de pesquisa. Atualmente, apenas é suportado pelo Elasticsearch®.
OnYourDataSystemAssignedManagedIdentityAuthenticationOptions	As opções de autenticação do Azure OpenAI Nos Seus Dados ao utilizar uma identidade gerida atribuída pelo sistema.
OnYourDataUserAssignedManagedIdentityAuthenticationOptions	As opções de autenticação do Azure OpenAI Nos Seus Dados ao utilizar uma identidade gerida atribuída pelo utilizador.
OnYourDataVectorizationSource	Uma representação abstrata de uma origem de vetorização para o Azure OpenAI Nos Seus Dados com pesquisa de vetor.
OpenAIClientOptions
PineconeChatExtensionConfiguration	Uma representação específica das opções configuráveis do Pinecone ao utilizá-la como uma extensão de chat do Azure OpenAI.
PineconeFieldMappingOptions	Definições opcionais para controlar a forma como os campos são processados ao utilizar um recurso do Pinecone configurado.
StopFinishDetails	Uma representação estruturada de um motivo fatal que significa terminação natural pelo modelo.

Aliases de Tipo

AudioResult	O tipo do resultado da transcrição com base no formato de resposta pedido
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 for ChatCompletionsNamedToolSelectionUnion
ChatCompletionsResponseFormatUnion	Alias for ChatCompletionsResponseFormatUnion
ChatCompletionsToolCallUnion	Alias para ChatCompletionsToolCallUnion
ChatCompletionsToolDefinitionUnion	Alias for ChatCompletionsToolDefinitionUnion
ChatCompletionsToolSelectionPreset	"auto", "none"
ChatFinishDetailsUnion	Alias para ChatFinishDetailsUnion
ChatMessageContentItemUnion	Alias para ChatMessageContentItemUnion
ChatMessageImageDetailLevel	"auto", "low", "high"
ChatRequestMessageUnion	Alias for 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údos, se tiver sido detetada.
ContentFilterResultsForChoice	Informações sobre os resultados da filtragem de conteúdos, se tiverem sido detetados.
ContentFilterSeverity	"safe", "low", "medium", "high"
ElasticsearchQueryType	"simple", "vector"
FunctionCallPreset	"auto", "none"
ImageGenerationQuality	"standard", "hd"
ImageGenerationResponseFormat	"URL", "b64_json"
ImageGenerationStyle	"natural", "vívido"
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	"ponto final", "deployment_name", "model_id"
OnYourDataVectorizationSourceUnion	Alias para OnYourDataVectorizationSourceUnion

Partilhar via