@azure/openai package

Riferimento

Classi

Credenziali basate su chiavi statiche che supportano l'aggiornamento del valore della chiave sottostante.

Un client per interagire con Azure OpenAI.

Il client richiede l'endpoint di una risorsa OpenAI e un metodo di autenticazione, ad esempio una chiave API o un token. La chiave API e l'endpoint sono disponibili nella pagina delle risorse OpenAI. Si trovano nella pagina Chiavi e endpoint della risorsa.

Esempi di autenticazione:

Chiave 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

La classe OpenAIKeyCredential rappresenta una chiave API OpenAI e viene usata per eseguire l'autenticazione in un client OpenAI per un endpoint OpenAI.

Interfacce

AudioResultSimpleJson	Risposta di trascrizione semplice
AudioResultVerboseJson	Risposta di trascrizione.
AudioSegment	Segmento di trascrizione.
AzureChatEnhancementConfiguration	Rappresentazione delle configurazioni di miglioramento di Azure OpenAI disponibili.
AzureChatEnhancements	Rappresenta i risultati dell'output dei miglioramenti di Azure per i completamento della chat, come configurato tramite l'input corrispondente fornito nella richiesta.
AzureChatExtensionConfiguration	Rappresentazione dei dati di configurazione per un'unica estensione chat di Azure OpenAI. Verrà usato da una richiesta di completamento della chat che deve usare le estensioni chat openAI di Azure per aumentare il comportamento della risposta. L'uso di questa configurazione è compatibile solo con Azure OpenAI.
AzureChatExtensionDataSourceResponseCitation	Un'unica istanza di informazioni di contesto aggiuntive disponibili quando le estensioni chat OpenAI di Azure sono coinvolte nella generazione di una risposta di completamento della chat corrispondente. Queste informazioni di contesto vengono popolate solo quando si usa una richiesta OpenAI di Azure configurata per l'uso di un'estensione corrispondente.
AzureChatExtensionsMessageContext	Rappresentazione delle informazioni di contesto aggiuntive disponibili quando le estensioni chat openAI di Azure sono coinvolte nella generazione di una risposta di completamento della chat corrispondente. Queste informazioni di contesto vengono popolate solo quando si usa una richiesta OpenAI di Azure configurata per l'uso di un'estensione corrispondente.
AzureChatGroundingEnhancementConfiguration	Rappresentazione delle opzioni disponibili per il miglioramento di base di Azure OpenAI.
AzureChatOCREnhancementConfiguration	Rappresentazione delle opzioni disponibili per il miglioramento del riconoscimento ottico dei caratteri openAI di Azure.
AzureCosmosDBChatExtensionConfiguration	Rappresentazione specifica delle opzioni configurabili per Azure Cosmos DB quando viene usata come estensione chat di Azure OpenAI.
AzureCosmosDBFieldMappingOptions	Impostazioni facoltative per controllare la modalità di elaborazione dei campi quando si usa una risorsa Azure Cosmos DB configurata.
AzureExtensionsOptions	Opzioni per le estensioni chat di Azure OpenAI.
AzureGroundingEnhancement	Miglioramento del suolo che restituisce il rettangolo di selezione degli oggetti rilevati nell'immagine.
AzureGroundingEnhancementCoordinatePoint	Rappresentazione di un singolo punto poligono usato dal miglioramento del terreno di Azure.
AzureGroundingEnhancementLine	Oggetto linea contenuto costituito da una sequenza adiacente di elementi del contenuto, ad esempio parole e contrassegni di selezione.
AzureGroundingEnhancementLineSpan	Oggetto span che rappresenta un oggetto rilevato e le relative informazioni sui rettangoli di selezione.
AzureMachineLearningIndexChatExtensionConfiguration	Rappresentazione specifica delle opzioni configurabili per l'indice vettoriale di Azure Machine Learning quando viene usata come estensione chat di Azure OpenAI.
AzureSearchChatExtensionConfiguration	Rappresentazione specifica delle opzioni configurabili per Azure Search quando viene usata come estensione chat di Azure OpenAI.
AzureSearchIndexFieldMappingOptions	Impostazioni facoltative per controllare la modalità di elaborazione dei campi quando si usa una risorsa di Azure Search configurata.
ChatChoice	Rappresentazione di un singolo completamento del prompt come parte di una richiesta di completamento generale della chat. In genere, `n` le scelte vengono generate per ogni prompt fornito con un valore predefinito pari a 1. I limiti dei token e altre impostazioni possono limitare il numero di scelte generate.
ChatChoiceLogProbabilityInfo	Informazioni sulla probabilità di log per una scelta, come richiesto tramite 'logprobs' e 'top_logprobs'.
ChatCompletions	Rappresentazione dei dati della risposta da una richiesta di completamento della chat. I completamento supportano un'ampia gamma di attività e generano testo che continua da o "completa" i dati del prompt forniti.
ChatCompletionsFunctionToolCall	Una chiamata di strumento a uno strumento di funzione, rilasciata dal modello nella valutazione di uno strumento di funzione configurato, che rappresenta una chiamata di funzione necessaria per una richiesta di completamento della chat successiva da risolvere.
ChatCompletionsFunctionToolDefinition	Informazioni sulla definizione per uno strumento di funzione di completamento della chat che può chiamare una funzione in risposta a una chiamata di strumento.
ChatCompletionsFunctionToolSelection	Selezione di uno strumento specifico, denominato strumento di funzione che limita i completamento della chat all'uso della funzione denominata.
ChatCompletionsJsonResponseFormat	Formato di risposta per i completamento chat che limita le risposte all'emissione di oggetti JSON validi.
ChatCompletionsNamedFunctionToolSelection	Selezione di uno strumento specifico, denominato strumento di funzione che limita i completamento della chat all'uso della funzione denominata.
ChatCompletionsNamedToolSelection	Rappresentazione astratta di una selezione di strumenti esplicita e denominata da usare per una richiesta di completamento della chat.
ChatCompletionsResponseFormat	Rappresentazione astratta di una configurazione del formato di risposta utilizzabile dai completamento chat. Può essere usato per abilitare la modalità JSON.
ChatCompletionsTextResponseFormat	Il formato di risposta di completamento chat standard che può generare liberamente testo e non è garantito per produrre contenuto di risposta conforme a uno schema specifico.
ChatCompletionsToolCall	Rappresentazione astratta di una chiamata di strumento che deve essere risolta in una richiesta successiva per eseguire il completamento della chat richiesta.
ChatCompletionsToolDefinition	Rappresentazione astratta di uno strumento che può essere usato dal modello per migliorare una risposta di completamento della chat.
ChatFinishDetails	Rappresentazione astratta delle informazioni strutturate sul motivo per cui viene terminata una risposta di completamento della chat.
ChatMessageContentItem	Rappresentazione astratta di un elemento di contenuto strutturato all'interno di un messaggio di chat.
ChatMessageImageContentItem	Elemento del contenuto della chat strutturato contenente un riferimento all'immagine.
ChatMessageImageUrl	Posizione Internet da cui il modello può recuperare un'immagine.
ChatMessageTextContentItem	Elemento contenuto della chat strutturato contenente testo normale.
ChatRequestAssistantMessage	Messaggio di chat di richiesta che rappresenta la risposta o l'azione del assistente.
ChatRequestFunctionMessage	Messaggio di chat di richiesta che rappresenta l'output richiesto da una funzione configurata.
ChatRequestMessage	Rappresentazione astratta di un messaggio di chat, come specificato in una richiesta.
ChatRequestSystemMessage	Messaggio di chat di richiesta contenente istruzioni di sistema che influiscono sul modo in cui il modello genererà una risposta di completamento della chat.
ChatRequestToolMessage	Messaggio di chat di richiesta che rappresenta l'output richiesto da uno strumento configurato.
ChatRequestUserMessage	Messaggio di chat di richiesta che rappresenta l'input dell'utente al assistente.
ChatResponseMessage	Rappresentazione di un messaggio di chat come ricevuto in una risposta.
ChatTokenLogProbabilityInfo	Rappresentazione delle informazioni sulla probabilità del log per un singolo token di contenuto del messaggio.
ChatTokenLogProbabilityResult	Rappresentazione delle informazioni sulla probabilità del log per un singolo token di contenuto, incluso un elenco di token più probabili se sono stati richiesti "top_logprobs".
Choice	Rappresentazione di un singolo completamento del prompt come parte di una richiesta di completamento generale. In genere, `n` le scelte vengono generate per ogni prompt fornito con un valore predefinito pari a 1. I limiti dei token e altre impostazioni possono limitare il numero di scelte generate.
Completions	Rappresentazione dei dati della risposta da una richiesta di completamento. I completamento supportano un'ampia gamma di attività e generano testo che continua da o "completa" i dati del prompt forniti.
CompletionsLogProbabilityModel	Rappresentazione di un modello di probabilità di log per una generazione di completamento.
CompletionsUsage	Rappresentazione dei conteggi dei token elaborati per una richiesta di completamento. I conteggi considerano tutti i token tra prompt, scelte, alternative scelte, best_of generazioni e altri consumer.
ContentFilterBlocklistIdResult	Rappresenta il risultato di una valutazione rispetto a un elenco di blocchi personalizzato come eseguito dal filtro del contenuto.
ContentFilterCitedDetectionResult	Rappresenta il risultato di un'operazione di rilevamento rispetto alle risorse protette eseguite dal filtro del contenuto.
ContentFilterDetectionResult	Rappresenta il risultato di un'operazione di rilevamento eseguita dal filtro del contenuto.
ContentFilterErrorResults	Informazioni sul risultato dell'errore di filtro del contenuto.
ContentFilterResult	Informazioni sul livello di gravità del contenuto filtrato e se è stato filtrato o meno.
ContentFilterResultsForPrompt	Filtro dei contenuti per una singola richiesta nella richiesta.
ContentFilterSuccessResultDetailsForPrompt	Informazioni sul risultato del filtro del contenuto.
ContentFilterSuccessResultsForChoice	Informazioni sul filtro del contenuto valutato in base all'output del modello generato.
ElasticsearchChatExtensionConfiguration	Rappresentazione specifica delle opzioni configurabili per Elasticsearch quando viene usata come estensione chat di Azure OpenAI.
ElasticsearchIndexFieldMappingOptions	Impostazioni facoltative per controllare la modalità di elaborazione dei campi quando si usa una risorsa Elasticsearch® configurata.
EmbeddingItem	Rappresentazione di un singolo confronto di correlazione tra incorporamenti.
Embeddings	Rappresentazione dei dati della risposta da una richiesta di incorporamento. Gli incorporamenti misurano la correlazione delle stringhe di testo e vengono comunemente usati per la ricerca, il clustering, le raccomandazioni e altri scenari simili.
EmbeddingsUsage	Misurazione della quantità di token usati in questa richiesta e risposta.
EventStream	Flusso leggibile che è iterabile e monouso.
FunctionCall	Nome e argomenti di una funzione che deve essere chiamata, come generato dal modello.
FunctionDefinition	Definizione di una funzione specificata dal chiamante che i completamento della chat possono richiamare in risposta all'input utente corrispondente.
FunctionName	Struttura che specifica il nome esatto di una funzione specifica e fornita dalla richiesta da usare durante l'elaborazione di un'operazione di completamento della chat.
GetAudioTranscriptionOptions	Opzioni per una richiesta di trascrizione audio
GetAudioTranslationOptions	Opzioni per una richiesta di traduzione audio
GetChatCompletionsOptions	Questo modulo contiene modelli che si desidera usare side-by-side con i modelli generati corrispondenti. Ciò è utile per fornire modelli con interfaccia utente con nomi/tipi diversi rispetto ai modelli generati.
GetCompletionsOptions	Informazioni di configurazione per una richiesta di completamento. I completamento supportano un'ampia gamma di attività e generano testo che continua da o "completa" i dati del prompt forniti.
GetEmbeddingsOptions	Opzioni per le richieste di incorporamento personalizzate
GetImagesOptions	Rappresenta i dati della richiesta usati per generare immagini.
ImageGenerationContentFilterResults	Descrive il risultato del filtro del contenuto per la richiesta di generazione di immagini.
ImageGenerationData	Rappresentazione di una singola immagine generata, fornita come dati con codifica base64 o come URL da cui è possibile recuperare l'immagine.
ImageGenerationPromptFilterResults	Descrive i risultati del filtro del contenuto per la richiesta di una richiesta di generazione di immagini.
ImageGenerations	Risultato di un'operazione di generazione di immagini riuscita.
MaxTokensFinishDetails	Rappresentazione strutturata di un motivo di arresto che indica che è stato raggiunto un limite di token prima che il modello possa essere completato naturalmente.
OnYourDataAccessTokenAuthenticationOptions	Opzioni di autenticazione per Azure OpenAI Nei dati quando si usa il token di accesso.
OnYourDataApiKeyAuthenticationOptions	Opzioni di autenticazione per Azure OpenAI Nei dati quando si usa una chiave API.
OnYourDataAuthenticationOptions	Opzioni di autenticazione per Azure OpenAI nei dati.
OnYourDataConnectionStringAuthenticationOptions	Opzioni di autenticazione per Azure OpenAI Nei dati quando si usa un stringa di connessione.
OnYourDataDeploymentNameVectorizationSource	I dettagli di un'origine di vettorializzazione, usati da Azure OpenAI On Your Data durante l'applicazione della ricerca vettoriale, basata su un nome di distribuzione del modello di incorporamento interno nella stessa risorsa OpenAI di Azure.
OnYourDataEncodedApiKeyAuthenticationOptions	Opzioni di autenticazione per Azure OpenAI Nei dati quando si usa una chiave API con codifica Elasticsearch.
OnYourDataEndpointVectorizationSource	I dettagli di un'origine di vettorizzazione, usati da Azure OpenAI On Your Data durante l'applicazione della ricerca vettoriale, basata su una chiamata di endpoint OpenAI di Azure pubblica per l'incorporamento.
OnYourDataKeyAndKeyIdAuthenticationOptions	Opzioni di autenticazione per Azure OpenAI On Your Data quando si usa una chiave Elasticsearch e una coppia ID chiave.
OnYourDataModelIdVectorizationSource	I dettagli di un'origine di vettorializzazione, usati da Azure OpenAI On Your Data durante l'applicazione della ricerca vettoriale, basata su un ID modello di servizio di ricerca. Attualmente supportato solo da Elasticsearch®.
OnYourDataSystemAssignedManagedIdentityAuthenticationOptions	Opzioni di autenticazione per Azure OpenAI Nei dati quando si usa un'identità gestita assegnata dal sistema.
OnYourDataUserAssignedManagedIdentityAuthenticationOptions	Opzioni di autenticazione per Azure OpenAI Nei dati quando si usa un'identità gestita assegnata dall'utente.
OnYourDataVectorizationSource	Rappresentazione astratta di un'origine di vettore per Azure OpenAI On Your Data con ricerca vettoriale.
OpenAIClientOptions
PineconeChatExtensionConfiguration	Rappresentazione specifica delle opzioni configurabili per Pinecone quando viene usata come estensione chat di Azure OpenAI.
PineconeFieldMappingOptions	Impostazioni facoltative per controllare la modalità di elaborazione dei campi quando si usa una risorsa Pinecone configurata.
StopFinishDetails	Rappresentazione strutturata di un motivo di arresto che indica la terminazione naturale dal modello.

Alias tipo

AudioResult	Tipo del risultato della trascrizione in base al formato di risposta richiesto
AudioResultFormat	Formato del risultato di un'attività audio
AudioTranscriptionTask	"trascrivere", "translate"
AzureChatExtensionConfigurationUnion	Alias per AzureChatExtensionConfigurationUnion
AzureChatExtensionType	"azure_search", "azure_ml_index", "azure_cosmos_db", "elasticsearch", "pinecone"
AzureSearchQueryType	"simple", "semantic", "vector", "vector_simple_hybrid", "vector_semantic_hybrid"
ChatCompletionsNamedToolSelectionUnion	Alias per ChatCompletionsNamedToolSelectionUnion
ChatCompletionsResponseFormatUnion	Alias per ChatCompletionsResponseFormatUnion
ChatCompletionsToolCallUnion	Alias per ChatCompletionsToolCallUnion
ChatCompletionsToolDefinitionUnion	Alias per ChatCompletionsToolDefinitionUnion
ChatCompletionsToolSelectionPreset	"auto", "nessuno"
ChatFinishDetailsUnion	Alias per ChatFinishDetailsUnion
ChatMessageContentItemUnion	Alias per ChatMessageContentItemUnion
ChatMessageImageDetailLevel	"auto", "low", "high"
ChatRequestMessageUnion	Alias per ChatRequestMessageUnion
ChatRole	"system", "assistente", "user", "function", "tool"
CompletionsFinishReason	"stop", "length", "content_filter", "function_call", "tool_calls"
ContentFilterResultDetailsForPrompt	Informazioni sulla categoria di filtro del contenuto, se è stata rilevata.
ContentFilterResultsForChoice	Informazioni sui risultati del filtro del contenuto, se è stato rilevato.
ContentFilterSeverity	"safe", "low", "medium", "high"
ElasticsearchQueryType	"simple", "vector"
FunctionCallPreset	"auto", "nessuno"
ImageGenerationQuality	"standard", "hd"
ImageGenerationResponseFormat	"url", "b64_json"
ImageGenerationStyle	"naturale", "vivido"
ImageSize	"256x256", "512x512", "1024x1024", "1792x1024", "1024x1792"
OnYourDataAuthenticationOptionsUnion	Alias per 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 per OnYourDataVectorizationSourceUnion

Condividi tramite