@azure/openai package

Referens

Klasser

En statisk nyckelbaserad autentiseringsuppgift som stöder uppdatering av det underliggande nyckelvärdet.

En klient för att interagera med Azure OpenAI.

Klienten behöver slutpunkten för en OpenAI-resurs och en autentiseringsmetod, till exempel en API-nyckel eller token. API-nyckeln och slutpunkten finns på resurssidan för OpenAI. De finns på resursens sida Nycklar och slutpunkt.

Exempel på autentisering:

API-nyckel

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

Klassen OpenAIKeyCredential representerar en OpenAI API-nyckel och används för att autentisera till en OpenAI-klient för en OpenAI-slutpunkt.

Gränssnitt

AudioResultSimpleJson	Enkelt transkriptionssvar
AudioResultVerboseJson	Transkriptionssvar.
AudioSegment	Transkriptionssegment.
AzureChatEnhancementConfiguration	En representation av tillgängliga Azure OpenAI-förbättringskonfigurationer.
AzureChatEnhancements	Representerar utdataresultatet från Azure-förbättringar av chattens slutföranden, enligt konfigurationen via matchande indata som anges i begäran.
AzureChatExtensionConfiguration	En representation av konfigurationsdata för ett enda Azure OpenAI-chatttillägg. Detta används av en begäran om att chatten ska slutföras och använda Azure OpenAI-chatttillägg för att förbättra svarsbeteendet. Användningen av den här konfigurationen är endast kompatibel med Azure OpenAI.
AzureChatExtensionDataSourceResponseCitation	En enda instans av ytterligare kontextinformation som är tillgänglig när Azure OpenAI-chatttillägg ingår i genereringen av ett motsvarande svar om att chatten slutförs. Den här kontextinformationen fylls bara i när du använder en Azure OpenAI-begäran som konfigurerats för att använda ett matchande tillägg.
AzureChatExtensionsMessageContext	En representation av den ytterligare kontextinformation som är tillgänglig när Azure OpenAI-chatttillägg ingår i genereringen av ett motsvarande svar om att chatten slutförs. Den här kontextinformationen fylls bara i när du använder en Azure OpenAI-begäran som konfigurerats för att använda ett matchande tillägg.
AzureChatGroundingEnhancementConfiguration	En representation av de tillgängliga alternativen för azure OpenAI-grundförbättringen.
AzureChatOCREnhancementConfiguration	En representation av de tillgängliga alternativen för förbättringar av optisk teckenigenkänning (OCR) i Azure OpenAI.
AzureCosmosDBChatExtensionConfiguration	En specifik representation av konfigurerbara alternativ för Azure Cosmos DB när du använder det som ett Azure OpenAI-chatttillägg.
AzureCosmosDBFieldMappingOptions	Valfria inställningar för att styra hur fält bearbetas när du använder en konfigurerad Azure Cosmos DB-resurs.
AzureExtensionsOptions	Alternativ för Azure OpenAI-chatttillägg.
AzureGroundingEnhancement	Jordningsförbättringen som returnerar avgränsningsrutan för de objekt som identifieras i bilden.
AzureGroundingEnhancementCoordinatePoint	En representation av en enda polygonpunkt som används av azure-grundförbättringen.
AzureGroundingEnhancementLine	Ett innehållsradsobjekt som består av en intilliggande sekvens med innehållselement, till exempel ord och markeringsmarkeringar.
AzureGroundingEnhancementLineSpan	Ett span-objekt som representerar ett identifierat objekt och dess avgränsningsruta.
AzureMachineLearningIndexChatExtensionConfiguration	En specifik representation av konfigurerbara alternativ för Azure Machine Learning-vektorindex när du använder det som ett Azure OpenAI-chatttillägg.
AzureSearchChatExtensionConfiguration	En specifik representation av konfigurerbara alternativ för Azure Search när du använder det som ett Azure OpenAI-chatttillägg.
AzureSearchIndexFieldMappingOptions	Valfria inställningar för att styra hur fält bearbetas när du använder en konfigurerad Azure-Search resurs.
ChatChoice	Representationen av en enda prompt som en del av en övergripande begäran om slutförande av chattar. `n` I allmänhet genereras alternativ per angivet meddelande med standardvärdet 1. Tokenbegränsningar och andra inställningar kan begränsa antalet val som genereras.
ChatChoiceLogProbabilityInfo	Logga sannolikhetsinformation för ett val, enligt begäran via "logprobs" och "top_logprobs".
ChatCompletions	Representation av svarsdata från en begäran om att chatten ska slutföras. Slutföranden stöder en mängd olika uppgifter och genererar text som fortsätter från eller "slutförs" tillhandahållna promptdata.
ChatCompletionsFunctionToolCall	Ett verktygsanrop till ett funktionsverktyg, utfärdat av modellen i utvärderingen av ett konfigurerat funktionsverktyg, som representerar ett funktionsanrop som krävs för att en efterföljande begäran om chattavslut ska kunna lösas.
ChatCompletionsFunctionToolDefinition	Definitionsinformationen för ett funktionsverktyg för chattavslut som kan anropa en funktion som svar på ett verktygsanrop.
ChatCompletionsFunctionToolSelection	Ett verktygsval av ett specifikt, namngivet funktionsverktyg som begränsar chattens slutföranden till att använda den namngivna funktionen.
ChatCompletionsJsonResponseFormat	Ett svarsformat för chattavslut som begränsar svar till att generera giltiga JSON-objekt.
ChatCompletionsNamedFunctionToolSelection	Ett verktygsval av ett specifikt, namngivet funktionsverktyg som begränsar chattens slutföranden till att använda den namngivna funktionen.
ChatCompletionsNamedToolSelection	En abstrakt representation av ett explicit, namngivet verktygsval som ska användas för en begäran om chattavslut.
ChatCompletionsResponseFormat	En abstrakt representation av en konfiguration av svarsformatet som kan användas av chattens slutföranden. Kan användas för att aktivera JSON-läge.
ChatCompletionsTextResponseFormat	Standardformatet för svar på chattslutpunkter som fritt kan generera text och som inte garanterat skapar svarsinnehåll som följer ett specifikt schema.
ChatCompletionsToolCall	En abstrakt representation av ett verktygsanrop som måste lösas i en efterföljande begäran om att utföra den begärda chatten.
ChatCompletionsToolDefinition	En abstrakt representation av ett verktyg som kan användas av modellen för att förbättra ett svar om chattens slutförande.
ChatFinishDetails	En abstrakt representation av strukturerad information om varför ett chattsvar avslutades.
ChatMessageContentItem	En abstrakt representation av ett strukturerat innehållsobjekt i ett chattmeddelande.
ChatMessageImageContentItem	Ett strukturerat chattinnehållsobjekt som innehåller en bildreferens.
ChatMessageImageUrl	En internetplats från vilken modellen kan hämta en avbildning.
ChatMessageTextContentItem	Ett strukturerat chattinnehållsobjekt som innehåller oformaterad text.
ChatRequestAssistantMessage	Ett begärandechattmeddelande som representerar svar eller åtgärd från assistent.
ChatRequestFunctionMessage	Ett chattmeddelande för begäran som representerar begärda utdata från en konfigurerad funktion.
ChatRequestMessage	En abstrakt representation av ett chattmeddelande enligt en begäran.
ChatRequestSystemMessage	Ett begärandechattmeddelande som innehåller systeminstruktioner som påverkar hur modellen genererar ett svar om att chatten har slutförts.
ChatRequestToolMessage	Ett chattmeddelande för begäran som representerar begärda utdata från ett konfigurerat verktyg.
ChatRequestUserMessage	Ett begärandechattmeddelande som representerar användarindata till assistent.
ChatResponseMessage	En representation av ett chattmeddelande som tas emot i ett svar.
ChatTokenLogProbabilityInfo	En representation av loggens sannolikhetsinformation för en enda meddelandeinnehållstoken.
ChatTokenLogProbabilityResult	En representation av loggens sannolikhetsinformation för en enda innehållstoken, inklusive en lista över mest sannolika token om "top_logprobs" begärdes.
Choice	Återgivningen av en enskild fråga som en del av en övergripande slutförandebegäran. `n` I allmänhet genereras alternativ per angivet meddelande med standardvärdet 1. Tokenbegränsningar och andra inställningar kan begränsa antalet val som genereras.
Completions	Representation av svarsdata från en slutförandebegäran. Slutföranden stöder en mängd olika uppgifter och genererar text som fortsätter från eller "slutförs" tillhandahållna promptdata.
CompletionsLogProbabilityModel	Representation av en logg sannolikhetsmodell för generering av slutföranden.
CompletionsUsage	Representation av antalet token som bearbetats för en slutförandebegäran. Antalet omfattar alla token i fråga, val, alternativ för val, best_of generationer och andra konsumenter.
ContentFilterBlocklistIdResult	Representerar resultatet av en utvärdering mot en anpassad blockeringslista som utförs av innehållsfiltrering.
ContentFilterCitedDetectionResult	Representerar resultatet av en identifieringsåtgärd mot skyddade resurser som utförs av innehållsfiltrering.
ContentFilterDetectionResult	Representerar resultatet av en identifieringsåtgärd som utförs av innehållsfiltrering.
ContentFilterErrorResults	Information om resultatet av innehållsfiltreringsfelet.
ContentFilterResult	Information om allvarlighetsgrad för filtrerat innehåll och om den har filtrerats eller inte.
ContentFilterResultsForPrompt	Innehållsfiltreringsresultat för en enda uppmaning i begäran.
ContentFilterSuccessResultDetailsForPrompt	Information om resultatet av innehållsfiltreringen.
ContentFilterSuccessResultsForChoice	Information om innehållsfiltrering som utvärderas mot genererade modellutdata.
ElasticsearchChatExtensionConfiguration	En specifik representation av konfigurerbara alternativ för Elasticsearch när du använder det som ett Azure OpenAI-chatttillägg.
ElasticsearchIndexFieldMappingOptions	Valfria inställningar för att styra hur fält bearbetas när du använder en konfigurerad Elasticsearch-resurs®.
EmbeddingItem	Representation av en jämförelse av en enda inbäddningsrelateradhet.
Embeddings	Representation av svarsdata från en inbäddningsbegäran. Inbäddningar mäter relaterade textsträngar och används ofta för sökning, klustring, rekommendationer och andra liknande scenarier.
EmbeddingsUsage	Mätning av mängden token som används i den här begäran och det här svaret.
EventStream	En läsbar ström som är iterabel och disponibel.
FunctionCall	Namnet och argumenten för en funktion som ska anropas, som genereras av modellen.
FunctionDefinition	Definitionen av en anropar-angiven funktion som chattens slutförande kan anropa som svar på matchande användarindata.
FunctionName	En struktur som anger det exakta namnet på en specifik funktion som tillhandahålls av begäran och som ska användas vid bearbetning av en chattåtgärd.
GetAudioTranscriptionOptions	Alternativen för en begäran om ljudavskrift
GetAudioTranslationOptions	Alternativen för en begäran om ljudöversättning
GetChatCompletionsOptions	Den här modulen innehåller modeller som vi vill använda sida vid sida med motsvarande genererade modeller. Detta är användbart för att tillhandahålla kundriktade modeller som har andra namn/typer än de genererade modellerna.
GetCompletionsOptions	Konfigurationsinformationen för en slutförandebegäran. Slutföranden stöder en mängd olika uppgifter och genererar text som fortsätter från eller "slutförs" angivna promptdata.
GetEmbeddingsOptions	Alternativ för begäran om anpassade inbäddningar
GetImagesOptions	Representerar de begärandedata som används för att generera bilder.
ImageGenerationContentFilterResults	Beskriver resultatet av innehållsfiltreringen för begäran om bildgenerering.
ImageGenerationData	En representation av en enda genererad bild som tillhandahålls som antingen base64-kodade data eller som en URL som bilden kan hämtas från.
ImageGenerationPromptFilterResults	Beskriver resultatet av innehållsfiltrering för frågan om en begäran om bildgenerering.
ImageGenerations	Resultatet av en lyckad avbildningsgenereringsåtgärd.
MaxTokensFinishDetails	En strukturerad representation av en stopporsak som innebär att en tokengräns uppnåddes innan modellen kunde slutföras naturligt.
OnYourDataAccessTokenAuthenticationOptions	Autentiseringsalternativen för Azure OpenAI på dina data när du använder åtkomsttoken.
OnYourDataApiKeyAuthenticationOptions	Autentiseringsalternativen för Azure OpenAI på dina data när du använder en API-nyckel.
OnYourDataAuthenticationOptions	Autentiseringsalternativen för Azure OpenAI på dina data.
OnYourDataConnectionStringAuthenticationOptions	Autentiseringsalternativen för Azure OpenAI På dina data när du använder en anslutningssträng.
OnYourDataDeploymentNameVectorizationSource	Information om en vektoriseringskälla som används av Azure OpenAI på dina data vid tillämpning av vektorsökning, som baseras på ett internt namn på inbäddningsmodellen i samma Azure OpenAI-resurs.
OnYourDataEncodedApiKeyAuthenticationOptions	Autentiseringsalternativen för Azure OpenAI På dina data när du använder en Elasticsearch-kodad API-nyckel.
OnYourDataEndpointVectorizationSource	Information om en vektoriseringskälla som används av Azure OpenAI På dina data vid tillämpning av vektorsökning, som baseras på ett offentligt Azure OpenAI-slutpunktsanrop för inbäddningar.
OnYourDataKeyAndKeyIdAuthenticationOptions	Autentiseringsalternativen för Azure OpenAI På dina data när du använder en Elasticsearch-nyckel och ett nyckel-ID-par.
OnYourDataModelIdVectorizationSource	Information om en vektoriseringskälla som används av Azure OpenAI På dina data vid tillämpning av vektorsökning, som baseras på ett modell-ID för söktjänsten. Stöds för närvarande endast av Elasticsearch®.
OnYourDataSystemAssignedManagedIdentityAuthenticationOptions	Autentiseringsalternativen för Azure OpenAI På dina data när du använder en systemtilldelad hanterad identitet.
OnYourDataUserAssignedManagedIdentityAuthenticationOptions	Autentiseringsalternativen för Azure OpenAI På dina data när du använder en användartilldelad hanterad identitet.
OnYourDataVectorizationSource	En abstrakt representation av en vektoriseringskälla för Azure OpenAI på dina data med vektorsökning.
OpenAIClientOptions
PineconeChatExtensionConfiguration	En specifik representation av konfigurerbara alternativ för Pinecone när du använder det som ett Azure OpenAI-chatttillägg.
PineconeFieldMappingOptions	Valfria inställningar för att styra hur fält bearbetas när du använder en konfigurerad Pinecone-resurs.
StopFinishDetails	En strukturerad representation av en stopporsak som innebär naturlig avslutning av modellen.

Typalias

AudioResult	Typen av resultatet av transkriptionen baserat på det begärda svarsformatet
AudioResultFormat	Resultatformatet för en ljudaktivitet
AudioTranscriptionTask	"transkribera", "översätta"
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	Information om innehållsfiltreringskategorin, om den har identifierats.
ContentFilterResultsForChoice	Information om resultatet av innehållsfiltreringen, om den har identifierats.
ContentFilterSeverity	"safe", "low", "medium", "high"
ElasticsearchQueryType	"simple", "vector"
FunctionCallPreset	"auto", "none"
ImageGenerationQuality	"standard", "hd"
ImageGenerationResponseFormat	"url", "b64_json"
ImageGenerationStyle	"naturlig", "levande"
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	"slutpunkt", "deployment_name", "model_id"
OnYourDataVectorizationSourceUnion	Alias för OnYourDataVectorizationSourceUnion

Share via