@azure/openai package

Referenz

Klassen

Eine auf statischen Schlüsseln basierende Anmeldeinformationen, die das Aktualisieren des zugrunde liegenden Schlüsselwerts unterstützen.

OpenAIClient

Ein Client für die Interaktion mit Azure OpenAI.

Der Client benötigt den Endpunkt einer OpenAI-Ressource und eine Authentifizierungsmethode, z. B. einen API-Schlüssel oder ein Token. Der API-Schlüssel und -Endpunkt finden Sie auf der OpenAI-Ressourcenseite. Sie befinden sich auf der Seite Schlüssel und Endpunkt der Ressource.

Beispiele für die Authentifizierung:

API-Schlüssel

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

Die OpenAIKeyCredential-Klasse stellt einen OpenAI-API-Schlüssel dar und wird zur Authentifizierung bei einem OpenAI-Client für einen OpenAI-Endpunkt verwendet.

Schnittstellen

AudioResultSimpleJson	Einfache Transkriptionsantwort
AudioResultVerboseJson	Transkriptionsantwort.
AudioSegment	Transkriptionssegment.
AzureChatEnhancementConfiguration	Eine Darstellung der verfügbaren Azure OpenAI-Erweiterungskonfigurationen.
AzureChatEnhancements	Stellt die Ausgabeergebnisse der Azure-Erweiterungen für Chatabschlusse dar, wie sie über die in der Anforderung bereitgestellte übereinstimmende Eingabe konfiguriert wurden.
AzureChatExtensionConfiguration	Eine Darstellung der Konfigurationsdaten für eine einzelne Azure OpenAI-Chaterweiterung. Dies wird von einer Chatabschlussanforderung verwendet, die Azure OpenAI-Chaterweiterungen verwenden soll, um das Antwortverhalten zu verbessern. Die Verwendung dieser Konfiguration ist nur mit Azure OpenAI kompatibel.
AzureChatExtensionDataSourceResponseCitation	Eine einzelne instance zusätzlicher Kontextinformationen, die verfügbar sind, wenn Azure OpenAI-Chaterweiterungen an der Generierung einer entsprechenden Chatabschlussantwort beteiligt sind. Diese Kontextinformationen werden nur ausgefüllt, wenn eine Azure OpenAI-Anforderung verwendet wird, die für die Verwendung einer übereinstimmenden Erweiterung konfiguriert ist.
AzureChatExtensionsMessageContext	Eine Darstellung der zusätzlichen Kontextinformationen, die verfügbar sind, wenn Azure OpenAI-Chaterweiterungen an der Generierung einer entsprechenden Chatabschlussantwort beteiligt sind. Diese Kontextinformationen werden nur ausgefüllt, wenn eine Azure OpenAI-Anforderung verwendet wird, die für die Verwendung einer übereinstimmenden Erweiterung konfiguriert ist.
AzureChatGroundingEnhancementConfiguration	Eine Darstellung der verfügbaren Optionen für die Azure OpenAI-Erdungserweiterung.
AzureChatOCREnhancementConfiguration	Eine Darstellung der verfügbaren Optionen für die OcR-Erweiterung (Optical Character Recognition, optische Zeichenerkennung) von Azure OpenAI.
AzureCosmosDBChatExtensionConfiguration	Eine spezifische Darstellung konfigurierbarer Optionen für Azure Cosmos DB, wenn sie als Azure OpenAI-Chaterweiterung verwendet wird.
AzureCosmosDBFieldMappingOptions	Optionale Einstellungen zum Steuern der Verarbeitung von Feldern bei Verwendung einer konfigurierten Azure Cosmos DB-Ressource.
AzureExtensionsOptions	Optionen für Azure OpenAI-Chaterweiterungen.
AzureGroundingEnhancement	Die Erdungserweiterung, die den Begrenzungsrahmen der im Bild erkannten Objekte zurückgibt.
AzureGroundingEnhancementCoordinatePoint	Eine Darstellung eines einzelnen Polygonpunkts, wie sie von der Azure-Erdungserweiterung verwendet wird.
AzureGroundingEnhancementLine	Ein Inhaltszeilenobjekt, das aus einer angrenzenden Sequenz von Inhaltselementen wie Wörtern und Auswahlzeichen besteht.
AzureGroundingEnhancementLineSpan	Ein span-Objekt, das ein erkanntes Objekt und dessen Begrenzungsrahmeninformationen darstellt.
AzureMachineLearningIndexChatExtensionConfiguration	Eine spezifische Darstellung konfigurierbarer Optionen für den Azure Machine Learning-Vektorindex, wenn er als Azure OpenAI-Chaterweiterung verwendet wird.
AzureSearchChatExtensionConfiguration	Eine spezifische Darstellung konfigurierbarer Optionen für Azure Search, wenn sie als Azure OpenAI-Chaterweiterung verwendet wird.
AzureSearchIndexFieldMappingOptions	Optionale Einstellungen zum Steuern der Verarbeitung von Feldern bei Verwendung einer konfigurierten Azure Search-Ressource.
ChatChoice	Die Darstellung einer einzelnen Eingabeaufforderung als Teil einer gesamten Chatabschlussanforderung. `n` Im Allgemeinen werden Auswahlmöglichkeiten pro bereitgestellter Eingabeaufforderung mit dem Standardwert 1 generiert. Tokenlimits und andere Einstellungen können die Anzahl der generierten Optionen einschränken.
ChatChoiceLogProbabilityInfo	Protokollieren Sie Wahrscheinlichkeitsinformationen für eine Auswahl, wie sie über "logprobs" und "top_logprobs" angefordert werden.
ChatCompletions	Darstellung der Antwortdaten aus einer Chatabschlussanforderung. Vervollständigungen unterstützen eine Vielzahl von Aufgaben und generieren Text, der aus den bereitgestellten Eingabeaufforderungsdaten fortgesetzt oder "abgeschlossen" wird.
ChatCompletionsFunctionToolCall	Ein Toolaufruf an ein Funktionstool, das vom Modell bei der Auswertung eines konfigurierten Funktionstools ausgegeben wird und einen Funktionsaufruf darstellt, der für die Auflösung einer nachfolgenden Chatvervollständigungsanforderung erforderlich ist.
ChatCompletionsFunctionToolDefinition	Die Definitionsinformationen für ein Tool zur Funktion "Chatabschluss", das eine Funktion als Reaktion auf einen Toolaufruf aufrufen kann.
ChatCompletionsFunctionToolSelection	Eine Toolauswahl eines bestimmten, benannten Funktionstools, das Chat-Vervollständigungen auf die Verwendung der benannten Funktion beschränkt.
ChatCompletionsJsonResponseFormat	Ein Antwortformat für Chat-Vervollständigungen, das Antworten auf die Ausgabe gültiger JSON-Objekte einschränkt.
ChatCompletionsNamedFunctionToolSelection	Eine Toolauswahl eines bestimmten, benannten Funktionstools, das Chat-Vervollständigungen auf die Verwendung der benannten Funktion beschränkt.
ChatCompletionsNamedToolSelection	Eine abstrakte Darstellung einer expliziten, benannten Toolauswahl, die für eine Chatabschlussanforderung verwendet werden soll.
ChatCompletionsResponseFormat	Eine abstrakte Darstellung einer Antwortformatkonfiguration, die von Chatvervollständigungen verwendet werden kann. Kann verwendet werden, um den JSON-Modus zu aktivieren.
ChatCompletionsTextResponseFormat	Das Standardmäßige Antwortformat für Chatabschlusse, das Text frei generieren kann und nicht garantiert Antwortinhalte erzeugt, die einem bestimmten Schema entsprechen.
ChatCompletionsToolCall	Eine abstrakte Darstellung eines Toolaufrufs, der in einer nachfolgenden Anforderung aufgelöst werden muss, um den angeforderten Chatabschluss auszuführen.
ChatCompletionsToolDefinition	Eine abstrakte Darstellung eines Tools, das vom Modell verwendet werden kann, um eine Chatabschlussantwort zu verbessern.
ChatFinishDetails	Eine abstrakte Darstellung strukturierter Informationen darüber, warum eine Chatabschlussantwort beendet wurde.
ChatMessageContentItem	Eine abstrakte Darstellung eines strukturierten Inhaltselements in einer Chatnachricht.
ChatMessageImageContentItem	Ein strukturiertes Chatinhaltselement, das einen Bildverweis enthält.
ChatMessageImageUrl	Ein Internetspeicherort, von dem das Modell ein Bild abrufen kann.
ChatMessageTextContentItem	Ein strukturiertes Chatinhaltselement, das Nur-Text enthält.
ChatRequestAssistantMessage	Eine Anforderungschatnachricht, die die Antwort oder Aktion des Assistent darstellt.
ChatRequestFunctionMessage	Eine Anforderungschatnachricht, die die angeforderte Ausgabe einer konfigurierten Funktion darstellt.
ChatRequestMessage	Eine abstrakte Darstellung einer Chatnachricht, wie in einer Anforderung angegeben.
ChatRequestSystemMessage	Eine Anforderungschatnachricht mit Systemanweisungen, die beeinflussen, wie das Modell eine Chatabschlussantwort generiert.
ChatRequestToolMessage	Eine Anforderungschatnachricht, die die angeforderte Ausgabe eines konfigurierten Tools darstellt.
ChatRequestUserMessage	Eine Anforderungschatnachricht, die die Benutzereingabe für die Assistent darstellt.
ChatResponseMessage	Eine Darstellung einer Chatnachricht, wie sie in einer Antwort empfangen wurde.
ChatTokenLogProbabilityInfo	Eine Darstellung der Protokollwahrscheinlichkeitsinformationen für ein einzelnes Nachrichteninhaltstoken.
ChatTokenLogProbabilityResult	Eine Darstellung der Protokollwahrscheinlichkeitsinformationen für ein einzelnes Inhaltstoken, einschließlich einer Liste der wahrscheinlichsten Token, wenn "top_logprobs" angefordert wurden.
Choice	Die Darstellung einer einzelnen Eingabeaufforderung als Teil einer gesamter Vervollständigungsanforderung. `n` Im Allgemeinen werden Auswahlmöglichkeiten pro bereitgestellter Eingabeaufforderung mit dem Standardwert 1 generiert. Tokenlimits und andere Einstellungen können die Anzahl der generierten Optionen einschränken.
Completions	Darstellung der Antwortdaten aus einer Vervollständigungsanforderung. Vervollständigungen unterstützen eine Vielzahl von Aufgaben und generieren Text, der aus den bereitgestellten Eingabeaufforderungsdaten fortgesetzt oder "abgeschlossen" wird.
CompletionsLogProbabilityModel	Darstellung eines Protokollwahrscheinlichkeitsmodells für eine Vervollständigungsgenerierung.
CompletionsUsage	Darstellung der Tokenanzahl, die für eine Vervollständigungsanforderung verarbeitet wird. Die Anzahl berücksichtigt alle Token zwischen Eingabeaufforderungen, Auswahlmöglichkeiten, Alternativen zur Auswahl, best_of Generationen und anderen Consumern.
ContentFilterBlocklistIdResult	Stellt das Ergebnis einer Auswertung für eine benutzerdefinierte Blockliste dar, wie dies durch die Inhaltsfilterung durchgeführt wird.
ContentFilterCitedDetectionResult	Stellt das Ergebnis eines Erkennungsvorgangs für geschützte Ressourcen dar, wie er von der Inhaltsfilterung ausgeführt wird.
ContentFilterDetectionResult	Stellt das Ergebnis eines Erkennungsvorgangs dar, der von der Inhaltsfilterung ausgeführt wird.
ContentFilterErrorResults	Informationen zum Ergebnis des Inhaltsfilterfehlers.
ContentFilterResult	Informationen zum Schweregrad von gefilterten Inhalten und ob er gefiltert wurde oder nicht.
ContentFilterResultsForPrompt	Inhaltsfilterungsergebnisse für eine einzelne Eingabeaufforderung in der Anforderung.
ContentFilterSuccessResultDetailsForPrompt	Informationen zum Ergebnis des Inhaltsfilterungserfolgs.
ContentFilterSuccessResultsForChoice	Informationen zur Inhaltsfilterung, die anhand der generierten Modellausgabe ausgewertet werden.
ElasticsearchChatExtensionConfiguration	Eine spezifische Darstellung konfigurierbarer Optionen für Elasticsearch, wenn sie als Azure OpenAI-Chaterweiterung verwendet wird.
ElasticsearchIndexFieldMappingOptions	Optionale Einstellungen zum Steuern der Verarbeitung von Feldern bei Verwendung einer konfigurierten Elasticsearch-Ressource®.
EmbeddingItem	Darstellung eines Vergleichs zwischen einzelnen Einbettungen.
Embeddings	Darstellung der Antwortdaten aus einer Einbettungsanforderung. Einbettungen messen die Verwandtschaft von Textzeichenfolgen und werden häufig für Suche, Clustering, Empfehlungen und andere ähnliche Szenarien verwendet.
EmbeddingsUsage	Messung der Menge der Token, die in dieser Anforderung und Antwort verwendet werden.
EventStream	Ein lesbarer Stream, der iterierbar und verwerfbar ist.
FunctionCall	Der Name und die Argumente einer Funktion, die aufgerufen werden soll, wie sie vom Modell generiert werden.
FunctionDefinition	Die Definition einer vom Aufrufer angegebenen Funktion, die Chatvervollständigungen als Reaktion auf übereinstimmende Benutzereingaben aufrufen können.
FunctionName	Eine Struktur, die den genauen Namen einer bestimmten, von einer Anforderung bereitgestellten Funktion angibt, die bei der Verarbeitung eines Chatvervollständigungsvorgangs verwendet werden soll.
GetAudioTranscriptionOptions	Optionen für eine Audiotranskriptionsanforderung
GetAudioTranslationOptions	Optionen für eine Audioübersetzungsanforderung
GetChatCompletionsOptions	Dieses Modul enthält Modelle, die parallel zu den entsprechenden generierten Modellen ausgeführt werden sollen. Dies ist nützlich, um kundenorientierte Modelle bereitzustellen, die andere Namen/Typen als die generierten Modelle aufweisen.
GetCompletionsOptions	Die Konfigurationsinformationen für eine Vervollständigungsanforderung. Vervollständigungen unterstützen eine Vielzahl von Aufgaben und generieren Text, der von bereitgestellten Eingabeaufforderungsdaten fortgesetzt oder "abgeschlossen" wird.
GetEmbeddingsOptions	Optionen für die Anforderung benutzerdefinierter Einbettungen
GetImagesOptions	Stellt die Anforderungsdaten dar, die zum Generieren von Images verwendet werden.
ImageGenerationContentFilterResults	Beschreibt das Ergebnis der Inhaltsfilterung für die Anforderung zur Bildgenerierung.
ImageGenerationData	Eine Darstellung eines einzelnen generierten Bilds, das entweder als Base64-codierte Daten oder als URL bereitgestellt wird, aus der das Bild abgerufen werden kann.
ImageGenerationPromptFilterResults	Beschreibt die Inhaltsfilterungsergebnisse für die Eingabeaufforderung einer Imagegenerierungsanforderung.
ImageGenerations	Das Ergebnis eines erfolgreichen Vorgangs zur Imagegenerierung.
MaxTokensFinishDetails	Eine strukturierte Darstellung eines Stoppgrunds, der bedeutet, dass ein Tokenlimit erreicht wurde, bevor das Modell auf natürliche Weise abgeschlossen werden konnte.
OnYourDataAccessTokenAuthenticationOptions	Die Authentifizierungsoptionen für Azure OpenAI On Your Data bei Verwendung des Zugriffstokens.
OnYourDataApiKeyAuthenticationOptions	Die Authentifizierungsoptionen für Azure OpenAI On Your Data bei Verwendung eines API-Schlüssels.
OnYourDataAuthenticationOptions	Die Authentifizierungsoptionen für Azure OpenAI On Your Data.
OnYourDataConnectionStringAuthenticationOptions	Die Authentifizierungsoptionen für Azure OpenAI On Your Data bei Verwendung eines Verbindungszeichenfolge.
OnYourDataDeploymentNameVectorizationSource	Die Details einer Vektorisierungsquelle, die von Azure OpenAI On Your Data beim Anwenden der Vektorsuche verwendet wird und auf einem internen Einbettungsmodellbereitstellungsnamen in derselben Azure OpenAI-Ressource basiert.
OnYourDataEncodedApiKeyAuthenticationOptions	Die Authentifizierungsoptionen für Azure OpenAI On Your Data bei Verwendung eines Elasticsearch-codierten API-Schlüssels.
OnYourDataEndpointVectorizationSource	Die Details einer Vektorisierungsquelle, die von Azure OpenAI On Your Data beim Anwenden der Vektorsuche verwendet wird und auf einem öffentlichen Azure OpenAI-Endpunktaufruf für Einbettungen basiert.
OnYourDataKeyAndKeyIdAuthenticationOptions	Die Authentifizierungsoptionen für Azure OpenAI On Your Data bei Verwendung eines Elasticsearch-Schlüssel-ID-Paares.
OnYourDataModelIdVectorizationSource	Die Details einer Vektorisierungsquelle, die von Azure OpenAI On Your Data beim Anwenden der Vektorsuche verwendet wird und auf einer Suchdienstmodell-ID basiert. Derzeit nur von Elasticsearch® unterstützt.
OnYourDataSystemAssignedManagedIdentityAuthenticationOptions	Die Authentifizierungsoptionen für Azure OpenAI On Your Data bei Verwendung einer systemseitig zugewiesenen verwalteten Identität.
OnYourDataUserAssignedManagedIdentityAuthenticationOptions	Die Authentifizierungsoptionen für Azure OpenAI On Your Data bei Verwendung einer benutzerseitig zugewiesenen verwalteten Identität.
OnYourDataVectorizationSource	Eine abstrakte Darstellung einer Vektorisierungsquelle für Azure OpenAI On Your Data mit Vektorsuche.
OpenAIClientOptions
PineconeChatExtensionConfiguration	Eine spezifische Darstellung konfigurierbarer Optionen für Pinecone, wenn sie als Azure OpenAI-Chaterweiterung verwendet wird.
PineconeFieldMappingOptions	Optionale Einstellungen zum Steuern der Verarbeitung von Feldern bei Verwendung einer konfigurierten Pinecone-Ressource.
StopFinishDetails	Eine strukturierte Darstellung eines Stoppgrunds, der eine natürliche Beendigung durch das Modell bedeutet.

Typaliase

AudioResult	Der Typ des Ergebnisses der Transkription basierend auf dem angeforderten Antwortformat
AudioResultFormat	Das Ergebnisformat eines Audiotasks
AudioTranscriptionTask	"transcribe", "translate"
AzureChatExtensionConfigurationUnion	Alias für AzureChatExtensionConfigurationUnion
AzureChatExtensionType	"azure_search", "azure_ml_index", "azure_cosmos_db", "elasticsearch", "pinecone"
AzureSearchQueryType	"simple", "semantic", "vector", "vector_simple_hybrid", "vector_semantic_hybrid"
ChatCompletionsNamedToolSelectionUnion	Alias für ChatCompletionsNamedToolSelectionUnion
ChatCompletionsResponseFormatUnion	Alias für ChatCompletionsResponseFormatUnion
ChatCompletionsToolCallUnion	Alias für ChatCompletionsToolCallUnion
ChatCompletionsToolDefinitionUnion	Alias für ChatCompletionsToolDefinitionUnion
ChatCompletionsToolSelectionPreset	"auto", "none"
ChatFinishDetailsUnion	Alias für ChatFinishDetailsUnion
ChatMessageContentItemUnion	Alias für ChatMessageContentItemUnion
ChatMessageImageDetailLevel	"auto", "low", "high"
ChatRequestMessageUnion	Alias für ChatRequestMessageUnion
ChatRole	"system", "Assistent", "user", "function", "tool"
CompletionsFinishReason	"stop", "length", "content_filter", "function_call", "tool_calls"
ContentFilterResultDetailsForPrompt	Informationen zur Kategorie "Inhaltsfilterung", falls sie erkannt wurde.
ContentFilterResultsForChoice	Informationen zu den Ergebnissen der Inhaltsfilterung, falls sie erkannt wurden.
ContentFilterSeverity	"sicher", "niedrig", "mittel", "hoch"
ElasticsearchQueryType	"simple", "vector"
FunctionCallPreset	"auto", "none"
ImageGenerationQuality	"standard", "hd"
ImageGenerationResponseFormat	"url", "b64_json"
ImageGenerationStyle	"natürlich", "lebendig"
ImageSize	"256x256", "512x512", "1024x1024", "1792x1024", "1024x1792"
OnYourDataAuthenticationOptionsUnion	Alias für OnYourDataAuthenticationOptionsUnion
OnYourDataAuthenticationType	"api_key", "connection_string", "key_and_key_id", "encoded_api_key", "access_token", "system_assigned_managed_identity", "user_assigned_managed_identity"
OnYourDataVectorizationSourceType	"endpunkt", "deployment_name", "model_id"
OnYourDataVectorizationSourceUnion	Alias für OnYourDataVectorizationSourceUnion

Share via