@azure/openai package

Reference

Třídy

Přihlašovací údaje založené na statickém klíči, které podporují aktualizaci hodnoty podkladového klíče.

Klient pro interakci s Azure OpenAI.

Klient potřebuje koncový bod prostředku OpenAI a metodu ověřování, jako je klíč rozhraní API nebo token. Klíč rozhraní API a koncový bod najdete na stránce prostředku OpenAI. Budou umístěné na stránce Klíče a koncový bod prostředku.

Příklady ověřování:

Klíč rozhraní 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

Třída OpenAIKeyCredential představuje klíč rozhraní API OpenAI a používá se k ověření do klienta OpenAI pro koncový bod OpenAI.

Rozhraní

AudioResultSimpleJson	Jednoduchá odpověď přepisu
AudioResultVerboseJson	Odpověď přepisu.
AudioSegment	Segment přepisu.
AzureChatEnhancementConfiguration	Reprezentace dostupných konfigurací vylepšení Azure OpenAI
AzureChatEnhancements	Představuje výstupní výsledky vylepšení azure pro dokončování chatu nakonfigurovaných prostřednictvím odpovídajícího vstupu zadaného v požadavku.
AzureChatExtensionConfiguration	Reprezentace konfiguračních dat pro jedno rozšíření chatu Azure OpenAI. Použije se v žádosti o dokončení chatu, která by měla používat rozšíření chatu Azure OpenAI k rozšíření chování odpovědi. Použití této konfigurace je kompatibilní pouze s Azure OpenAI.
AzureChatExtensionDataSourceResponseCitation	Jedna instance dalších kontextových informací, které jsou k dispozici, když jsou rozšíření chatu Azure OpenAI zapojená do generování odpovídající odpovědi na dokončení chatu. Tyto informace o kontextu se vyplní pouze při použití požadavku Azure OpenAI nakonfigurovaného tak, aby používal odpovídající rozšíření.
AzureChatExtensionsMessageContext	Reprezentace dalších kontextových informací, které jsou k dispozici, když se rozšíření chatu Azure OpenAI podílejí na generování odpovídající odpovědi na dokončení chatu. Tyto informace o kontextu se vyplní pouze při použití požadavku Azure OpenAI nakonfigurovaného tak, aby používal odpovídající rozšíření.
AzureChatGroundingEnhancementConfiguration	Reprezentace dostupných možností pro vylepšení uzemnění Azure OpenAI
AzureChatOCREnhancementConfiguration	Reprezentace dostupných možností pro vylepšení optického rozpoznávání znaků (OCR) v Azure OpenAI.
AzureCosmosDBChatExtensionConfiguration	Specifická reprezentace konfigurovatelných možností pro službu Azure Cosmos DB při jejím použití jako rozšíření chatu Azure OpenAI
AzureCosmosDBFieldMappingOptions	Volitelná nastavení pro řízení způsobu zpracování polí při použití nakonfigurovaného prostředku Azure Cosmos DB
AzureExtensionsOptions	Možnosti pro rozšíření chatu Azure OpenAI
AzureGroundingEnhancement	Vylepšení uzemnění, které vrací ohraničující rámeček objektů zjištěných na obrázku.
AzureGroundingEnhancementCoordinatePoint	Reprezentace jednoho mnohoúhelníku používaná vylepšením uzemnění Azure.
AzureGroundingEnhancementLine	Objekt řádku obsahu skládající se ze sousední sekvence prvků obsahu, jako jsou slova a výběrové značky.
AzureGroundingEnhancementLineSpan	Span objekt, který představuje rozpoznaný objekt a informace o jeho ohraničující rámeček.
AzureMachineLearningIndexChatExtensionConfiguration	Specifická reprezentace konfigurovatelných možností vektorového indexu služby Azure Machine Learning při jeho použití jako rozšíření chatu Azure OpenAI
AzureSearchChatExtensionConfiguration	Specifická reprezentace konfigurovatelných možností pro Azure Search při jeho použití jako rozšíření chatu Azure OpenAI.
AzureSearchIndexFieldMappingOptions	Volitelná nastavení pro řízení způsobu zpracování polí při použití nakonfigurovaného prostředku Azure Search.
ChatChoice	Vyjádření jednoho rychlého dokončení v rámci celkové žádosti o dokončení chatu. Obecně platí, že `n` volby se generují podle zadané výzvy s výchozí hodnotou 1. Limity tokenů a další nastavení můžou omezit počet vygenerovaných voleb.
ChatChoiceLogProbabilityInfo	Protokolovat informace o pravděpodobnosti volby požadované prostřednictvím protokolů logprobs a top_logprobs.
ChatCompletions	Znázornění dat odpovědi na žádost o dokončení chatu Dokončení podporují širokou škálu úkolů a generují text, který pokračuje od zadaných dat výzvy nebo je "dokončí".
ChatCompletionsFunctionToolCall	Volání nástroje do nástroje funkce vydané modelem při vyhodnocení nakonfigurovaného nástroje funkce, které představuje vyvolání funkce potřebné k vyřešení následné žádosti o dokončení chatu.
ChatCompletionsFunctionToolDefinition	Informace o definici nástroje pro funkci dokončování chatu, který může volat funkci v reakci na volání nástroje.
ChatCompletionsFunctionToolSelection	Výběr konkrétního nástroje pojmenované funkce, který omezí dokončení chatu na použití pojmenované funkce.
ChatCompletionsJsonResponseFormat	Formát odpovědi pro dokončování chatu, který omezuje odpovědi na generování platných objektů JSON.
ChatCompletionsNamedFunctionToolSelection	Výběr konkrétního nástroje pojmenované funkce, který omezí dokončení chatu na použití pojmenované funkce.
ChatCompletionsNamedToolSelection	Abstraktní znázornění explicitního a pojmenovaného výběru nástroje, který se má použít pro žádost o dokončení chatu.
ChatCompletionsResponseFormat	Abstraktní reprezentace konfigurace formátu odpovědi použitelná dokončením chatu. Dá se použít k povolení režimu JSON.
ChatCompletionsTextResponseFormat	Standardní formát odpovědi dokončení chatu, který může volně generovat text a není zaručeno, že vytvoří obsah odpovědi, který odpovídá konkrétnímu schématu.
ChatCompletionsToolCall	Abstraktní reprezentace volání nástroje, které musí být vyřešeno v následném požadavku na provedení požadovaného dokončení chatu.
ChatCompletionsToolDefinition	Abstraktní reprezentace nástroje, kterou model může použít ke zlepšení odpovědi na dokončení chatu.
ChatFinishDetails	Abstraktní znázornění strukturovaných informací o tom, proč se odpověď dokončení chatu ukončila.
ChatMessageContentItem	Abstraktní reprezentace položky strukturovaného obsahu v rámci zprávy chatu.
ChatMessageImageContentItem	Položka strukturovaného obsahu chatu obsahující odkaz na obrázek.
ChatMessageImageUrl	Umístění na internetu, ze kterého může model načíst obrázek.
ChatMessageTextContentItem	Položka strukturovaného obsahu chatu obsahující prostý text
ChatRequestAssistantMessage	Žádost o chatovou zprávu představující odpověď nebo akci z asistent.
ChatRequestFunctionMessage	Žádost o chatovou zprávu představující požadovaný výstup z nakonfigurované funkce.
ChatRequestMessage	Abstraktní znázornění zprávy chatu, jak je uvedeno v žádosti.
ChatRequestSystemMessage	Žádost o chatovou zprávu obsahující systémové instrukce, které ovlivňují způsob, jakým model vygeneruje odpověď na dokončení chatu.
ChatRequestToolMessage	Žádost o chatovou zprávu představující požadovaný výstup z nakonfigurovaného nástroje.
ChatRequestUserMessage	Žádost o chatovou zprávu představující vstup uživatele do asistent.
ChatResponseMessage	Znázornění zprávy chatu přijaté v odpovědi
ChatTokenLogProbabilityInfo	Reprezentace informací o pravděpodobnosti protokolu pro jeden token obsahu zprávy.
ChatTokenLogProbabilityResult	Reprezentace informací o pravděpodobnosti protokolu pro jeden token obsahu, včetně seznamu nejpravděpodobnějších tokenů, pokud byly požadovány "top_logprobs".
Choice	Reprezentace jednoho rychlého dokončení v rámci celkové žádosti o dokončení. Obecně platí, že `n` volby se generují podle zadané výzvy s výchozí hodnotou 1. Limity tokenů a další nastavení můžou omezit počet vygenerovaných voleb.
Completions	Reprezentace dat odpovědi na žádost o dokončení Dokončení podporují širokou škálu úkolů a generují text, který pokračuje od zadaných dat výzvy nebo je "dokončí".
CompletionsLogProbabilityModel	Reprezentace modelu pravděpodobností protokolu pro generování dokončení.
CompletionsUsage	Reprezentace počtu tokenů zpracovaných pro požadavek na dokončení Počty berou v úvahu všechny tokeny napříč výzvami, volbami, alternativními volbami, generacemi best_of a dalšími příjemci.
ContentFilterBlocklistIdResult	Představuje výsledek vyhodnocení proti vlastnímu seznamu blokovaných, jak je provedeno filtrováním obsahu.
ContentFilterCitedDetectionResult	Představuje výsledek operace detekce proti chráněným prostředkům prováděný filtrováním obsahu.
ContentFilterDetectionResult	Představuje výsledek operace detekce prováděné filtrováním obsahu.
ContentFilterErrorResults	Informace o výsledku chyby filtrování obsahu
ContentFilterResult	Informace o úrovni závažnosti filtrovaného obsahu a o tom, jestli byl filtrovaný nebo ne.
ContentFilterResultsForPrompt	Výsledkem filtrování obsahu je jedna výzva v požadavku.
ContentFilterSuccessResultDetailsForPrompt	Informace o úspěšném výsledku filtrování obsahu
ContentFilterSuccessResultsForChoice	Informace o filtrování obsahu vyhodnoceného podle vygenerovaného výstupu modelu.
ElasticsearchChatExtensionConfiguration	Konkrétní reprezentace konfigurovatelných možností pro Elasticsearch při jeho použití jako rozšíření chatu Azure OpenAI
ElasticsearchIndexFieldMappingOptions	Volitelná nastavení pro řízení způsobu zpracování polí při použití nakonfigurovaného prostředku Elasticsearch®
EmbeddingItem	Reprezentace porovnání souvisejícího vztahu s jedním vkládáním
Embeddings	Reprezentace dat odpovědi z požadavku embeddings Vkládání měří souvislost textových řetězců a běžně se používají pro vyhledávání, clustering, doporučení a další podobné scénáře.
EmbeddingsUsage	Měření počtu tokenů použitých v tomto požadavku a odpovědi
EventStream	Čitelný datový proud, který je iterovatelný a jednorázový.
FunctionCall	Název a argumenty funkce, která se má volat, vygenerovaná modelem.
FunctionDefinition	Definice funkce zadané volajícím, kterou může dokončení chatu vyvolat v reakci na odpovídající vstup uživatele.
FunctionName	Struktura, která určuje přesný název konkrétní funkce poskytnuté požadavkem, která se má použít při zpracování operace dokončení chatu.
GetAudioTranscriptionOptions	Možnosti žádosti o přepis zvuku
GetAudioTranslationOptions	Možnosti žádosti o zvukový překlad
GetChatCompletionsOptions	Tento modul obsahuje modely, které chceme mít souběžně s odpovídajícími vygenerovanými modely. To je užitečné k poskytování modelů určených pro zákazníky, které mají jiné názvy a typy než vygenerované modely.
GetCompletionsOptions	Informace o konfiguraci žádosti o dokončení. Dokončení podporují širokou škálu úkolů a generují text, který pokračuje od zadaných dat výzvy nebo je "dokončí".
GetEmbeddingsOptions	Možnosti pro vlastní požadavek na vložení
GetImagesOptions	Představuje data požadavku používaná ke generování obrázků.
ImageGenerationContentFilterResults	Popisuje výsledek filtrování obsahu pro požadavek na generování obrázků.
ImageGenerationData	Reprezentace jednoho vygenerovaného obrázku, poskytovaná buď jako data s kódováním Base64, nebo jako adresa URL, ze které lze obrázek načíst.
ImageGenerationPromptFilterResults	Popisuje výsledky filtrování obsahu pro výzvu požadavku na generování image.
ImageGenerations	Výsledek úspěšné operace generování image.
MaxTokensFinishDetails	Strukturované znázornění důvodu zastavení, které značí limit tokenu, bylo dosaženo před přirozeným dokončením modelu.
OnYourDataAccessTokenAuthenticationOptions	Možnosti ověřování pro Azure OpenAI ve vašich datech při použití přístupového tokenu
OnYourDataApiKeyAuthenticationOptions	Možnosti ověřování pro Azure OpenAI u vašich dat při použití klíče rozhraní API.
OnYourDataAuthenticationOptions	Možnosti ověřování pro Azure OpenAI u vašich dat.
OnYourDataConnectionStringAuthenticationOptions	Možnosti ověřování pro Azure OpenAI ve vašich datech při použití připojovací řetězec.
OnYourDataDeploymentNameVectorizationSource	Podrobnosti o zdroji vektorizace, který používá Azure OpenAI On Your Data při použití vektorového vyhledávání, který je založený na interním názvu nasazení modelu vkládání ve stejném prostředku Azure OpenAI.
OnYourDataEncodedApiKeyAuthenticationOptions	Možnosti ověřování pro Azure OpenAI ve vašich datech při použití klíče rozhraní API s kódováním Elasticsearch.
OnYourDataEndpointVectorizationSource	Podrobnosti o zdroji vektorizace, který používá Azure OpenAI on Your Data při použití vektorového vyhledávání, který je založený na veřejném koncovém bodu Azure OpenAI volání pro vkládání.
OnYourDataKeyAndKeyIdAuthenticationOptions	Možnosti ověřování pro Azure OpenAI ve vašich datech při použití páru klíč a ID klíče Elasticsearch.
OnYourDataModelIdVectorizationSource	Podrobnosti o zdroji vektorizace, který používá Azure OpenAI on Your Data při použití vektorového vyhledávání, který je založený na ID modelu vyhledávací služby. Aktuálně podporuje pouze Elasticsearch®.
OnYourDataSystemAssignedManagedIdentityAuthenticationOptions	Možnosti ověřování pro Azure OpenAI u vašich dat při použití spravované identity přiřazené systémem
OnYourDataUserAssignedManagedIdentityAuthenticationOptions	Možnosti ověřování pro Azure OpenAI u vašich dat při použití spravované identity přiřazené uživatelem
OnYourDataVectorizationSource	Abstraktní reprezentace zdroje vektorizace pro Azure OpenAI on Your Data s vektorovým vyhledáváním.
OpenAIClientOptions
PineconeChatExtensionConfiguration	Specifická reprezentace konfigurovatelných možností pro Pinecone při jeho použití jako rozšíření chatu Azure OpenAI.
PineconeFieldMappingOptions	Volitelná nastavení pro řízení způsobu zpracování polí při použití nakonfigurovaného prostředku Pinecone
StopFinishDetails	Strukturovaná reprezentace důvodu zastavení, která značí přirozené ukončení modelem.

Aliasy typu

AudioResult	Typ výsledku přepisu na základě požadovaného formátu odpovědi
AudioResultFormat	Formát výsledku zvukové úlohy
AudioTranscriptionTask	"přepis", "přeložit"
AzureChatExtensionConfigurationUnion	Alias pro AzureChatExtensionConfigurationUnion
AzureChatExtensionType	"azure_search", "azure_ml_index", "azure_cosmos_db", "elasticsearch", "pinecone"
AzureSearchQueryType	"simple", "sémantic", "vector", "vector_simple_hybrid", "vector_semantic_hybrid"
ChatCompletionsNamedToolSelectionUnion	Alias pro ChatCompletionsNamedToolSelectionUnion
ChatCompletionsResponseFormatUnion	Alias pro ChatCompletionsResponseFormatUnion
ChatCompletionsToolCallUnion	Alias pro ChatCompletionsToolCallUnion
ChatCompletionsToolDefinitionUnion	Alias pro ChatCompletionsToolDefinitionUnion
ChatCompletionsToolSelectionPreset	"auto", "none"
ChatFinishDetailsUnion	Alias pro ChatFinishDetailsUnion
ChatMessageContentItemUnion	Alias pro ChatMessageContentItemUnion
ChatMessageImageDetailLevel	"auto", "low", "high"
ChatRequestMessageUnion	Alias pro ChatRequestMessageUnion
ChatRole	"system", "asistent", "user", "function", "tool"
CompletionsFinishReason	"stop", "length", "content_filter", "function_call", "tool_calls"
ContentFilterResultDetailsForPrompt	Informace o kategorii filtrování obsahu, pokud byla zjištěna.
ContentFilterResultsForChoice	Informace o výsledcích filtrování obsahu, pokud byl zjištěn.
ContentFilterSeverity	"safe", "low", "medium", "high"
ElasticsearchQueryType	"simple", "vector"
FunctionCallPreset	"auto", "none"
ImageGenerationQuality	"standard", "hd"
ImageGenerationResponseFormat	"url", "b64_json"
ImageGenerationStyle	"přirozené", "živé"
ImageSize	"256x256", "512x512", "1024x1024", "1792x1024", "1024x1792"
OnYourDataAuthenticationOptionsUnion	Alias pro OnYourDataAuthenticationOptionsUnion
OnYourDataAuthenticationType	"api_key", "connection_string", "key_and_key_id", "encoded_api_key", "access_token", "system_assigned_managed_identity", "user_assigned_managed_identity"
OnYourDataVectorizationSourceType	"koncový bod", "deployment_name", "model_id"
OnYourDataVectorizationSourceUnion	Alias pro OnYourDataVectorizationSourceUnion

Sdílet prostřednictvím