@azure/openai package

Odwołanie

Klasy

Poświadczenie oparte na kluczu statycznym, które obsługuje aktualizowanie bazowej wartości klucza.

Klient do interakcji z usługą Azure OpenAI.

Klient potrzebuje punktu końcowego zasobu OpenAI i metody uwierzytelniania, takiej jak klucz interfejsu API lub token. Klucz interfejsu API i punkt końcowy można znaleźć na stronie zasobów OpenAI. Zostaną one umieszczone na stronie Klucze i punkt końcowy zasobu.

Przykłady uwierzytelniania:

Klucz interfejsu 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

Klasa OpenAIKeyCredential reprezentuje klucz interfejsu API OpenAI i służy do uwierzytelniania w kliencie OpenAI dla punktu końcowego openAI.

Interfejsy

AudioResultSimpleJson	Prosta odpowiedź transkrypcji
AudioResultVerboseJson	Odpowiedź na transkrypcję.
AudioSegment	Segment transkrypcji.
AzureChatEnhancementConfiguration	Reprezentacja dostępnych konfiguracji rozszerzeń usługi Azure OpenAI.
AzureChatEnhancements	Reprezentuje wyniki wyjściowe ulepszeń platformy Azure w zakresie uzupełniania czatów zgodnie z konfiguracją za pośrednictwem pasujących danych wejściowych podanych w żądaniu.
AzureChatExtensionConfiguration	Reprezentacja danych konfiguracji dla pojedynczego rozszerzenia czatu usługi Azure OpenAI. Będzie to używane przez żądanie ukończenia czatu, które powinno używać rozszerzeń czatu usługi Azure OpenAI w celu rozszerzenia zachowania odpowiedzi. Użycie tej konfiguracji jest zgodne tylko z usługą Azure OpenAI.
AzureChatExtensionDataSourceResponseCitation	Pojedyncze wystąpienie dodatkowych informacji kontekstowych dostępnych, gdy rozszerzenia czatu usługi Azure OpenAI są zaangażowane w generowanie odpowiedniej odpowiedzi na zakończenie czatu. Te informacje kontekstowe są wypełniane tylko w przypadku korzystania z żądania usługi Azure OpenAI skonfigurowanego do używania zgodnego rozszerzenia.
AzureChatExtensionsMessageContext	Reprezentacja dodatkowych informacji kontekstowych dostępnych, gdy rozszerzenia czatu usługi Azure OpenAI są zaangażowane w generowanie odpowiedniej odpowiedzi na zakończenie czatu. Te informacje kontekstowe są wypełniane tylko w przypadku korzystania z żądania usługi Azure OpenAI skonfigurowanego do używania zgodnego rozszerzenia.
AzureChatGroundingEnhancementConfiguration	Reprezentacja dostępnych opcji ulepszenia obsługi podstaw platformy Azure OpenAI.
AzureChatOCREnhancementConfiguration	Reprezentacja dostępnych opcji rozszerzenia optycznego rozpoznawania znaków (OCR) usługi Azure OpenAI.
AzureCosmosDBChatExtensionConfiguration	Konkretna reprezentacja konfigurowalnych opcji dla usługi Azure Cosmos DB w przypadku korzystania z niej jako rozszerzenia czatu usługi Azure OpenAI.
AzureCosmosDBFieldMappingOptions	Ustawienia opcjonalne umożliwiające kontrolowanie sposobu przetwarzania pól podczas korzystania ze skonfigurowanego zasobu usługi Azure Cosmos DB.
AzureExtensionsOptions	Opcje rozszerzeń czatu usługi Azure OpenAI.
AzureGroundingEnhancement	Ulepszenie uziemania, które zwraca pole ograniczenia obiektów wykrytych na obrazie.
AzureGroundingEnhancementCoordinatePoint	Reprezentacja pojedynczego wielokąta używanego przez ulepszenie uziemania platformy Azure.
AzureGroundingEnhancementLine	Obiekt wiersza zawartości składający się z sąsiedniej sekwencji elementów zawartości, takich jak wyrazy i znaczniki zaznaczenia.
AzureGroundingEnhancementLineSpan	Obiekt span reprezentujący wykryty obiekt i informacje o polu ograniczenia.
AzureMachineLearningIndexChatExtensionConfiguration	Konkretna reprezentacja konfigurowalnych opcji dla indeksu wektora usługi Azure Machine Learning podczas korzystania z niego jako rozszerzenia czatu usługi Azure OpenAI.
AzureSearchChatExtensionConfiguration	Konkretna reprezentacja konfigurowalnych opcji dla usługi Azure Search w przypadku korzystania z niej jako rozszerzenia czatu usługi Azure OpenAI.
AzureSearchIndexFieldMappingOptions	Ustawienia opcjonalne umożliwiające kontrolowanie sposobu przetwarzania pól podczas korzystania ze skonfigurowanego zasobu usługi Azure Search.
ChatChoice	Reprezentacja pojedynczego ukończenia monitu w ramach ogólnego żądania ukończenia czatu. Ogólnie rzecz biorąc, `n` opcje są generowane dla podanego monitu z wartością domyślną 1. Limity tokenów i inne ustawienia mogą ograniczać liczbę wygenerowanych opcji.
ChatChoiceLogProbabilityInfo	Rejestruj informacje o prawdopodobieństwa wyboru zgodnie z żądaniem za pośrednictwem "logprobs" i "top_logprobs".
ChatCompletions	Reprezentacja danych odpowiedzi z żądania ukończenia czatu. Ukończenia obsługują szeroką gamę zadań i generują tekst, który będzie kontynuowany na podstawie lub "ukończonych" dostarczonych danych monitu.
ChatCompletionsFunctionToolCall	Wywołanie narzędzia do narzędzia funkcji, wystawione przez model w ocenie skonfigurowanego narzędzia funkcji, które reprezentuje wywołanie funkcji potrzebne do rozwiązania kolejnego żądania ukończenia czatu.
ChatCompletionsFunctionToolDefinition	Informacje o definicji narzędzia funkcji uzupełniania czatu, które mogą wywołać funkcję w odpowiedzi na wywołanie narzędzia.
ChatCompletionsFunctionToolSelection	Wybór określonego, nazwanego narzędzia funkcji, który ograniczy ukończenie czatu do korzystania z nazwanej funkcji.
ChatCompletionsJsonResponseFormat	Format odpowiedzi dla uzupełniania czatu, który ogranicza odpowiedzi do emitowania prawidłowych obiektów JSON.
ChatCompletionsNamedFunctionToolSelection	Wybór określonego, nazwanego narzędzia funkcji, który ograniczy ukończenie czatu do korzystania z nazwanej funkcji.
ChatCompletionsNamedToolSelection	Abstrakcyjna reprezentacja jawnego, nazwanego wyboru narzędzia do użycia na potrzeby żądania ukończenia czatu.
ChatCompletionsResponseFormat	Abstrakcyjna reprezentacja konfiguracji formatu odpowiedzi, która może być użyteczna przez ukończenie czatu. Może służyć do włączania trybu JSON.
ChatCompletionsTextResponseFormat	Standardowy format odpowiedzi Ukończenie czatu, który może swobodnie generować tekst i nie ma gwarancji, że zawartość odpowiedzi jest zgodna z określonym schematem.
ChatCompletionsToolCall	Abstrakcyjna reprezentacja wywołania narzędzia, które należy rozwiązać w kolejnym żądaniu wykonania żądanego zakończenia czatu.
ChatCompletionsToolDefinition	Abstrakcyjna reprezentacja narzędzia, które może być używane przez model do ulepszania odpowiedzi na zakończenie czatu.
ChatFinishDetails	Abstrakcyjna reprezentacja ustrukturyzowanych informacji o tym, dlaczego zakończenie odpowiedzi na czat zakończyło się.
ChatMessageContentItem	Abstrakcyjna reprezentacja ustrukturyzowanego elementu zawartości w wiadomości czatu.
ChatMessageImageContentItem	Ustrukturyzowany element zawartości czatu zawierający odwołanie do obrazu.
ChatMessageImageUrl	Lokalizacja internetowa, z której model może pobrać obraz.
ChatMessageTextContentItem	Ustrukturyzowany element zawartości czatu zawierający zwykły tekst.
ChatRequestAssistantMessage	Wiadomość czatu żądania reprezentująca odpowiedź lub akcję z asystent.
ChatRequestFunctionMessage	Komunikat czatu żądania reprezentujący żądane dane wyjściowe ze skonfigurowanej funkcji.
ChatRequestMessage	Abstrakcyjna reprezentacja wiadomości czatu podana w żądaniu.
ChatRequestSystemMessage	Wiadomość czatu z żądaniem zawierająca instrukcje systemowe wpływające na sposób generowania odpowiedzi na zakończenie czatu przez model.
ChatRequestToolMessage	Komunikat czatu żądania reprezentujący żądane dane wyjściowe ze skonfigurowanego narzędzia.
ChatRequestUserMessage	Wiadomość czatu żądania reprezentująca dane wejściowe użytkownika w asystent.
ChatResponseMessage	Reprezentacja wiadomości na czacie odebrana w odpowiedzi.
ChatTokenLogProbabilityInfo	Reprezentacja informacji o prawdopodobieństwie dziennika dla tokenu zawartości pojedynczej wiadomości.
ChatTokenLogProbabilityResult	Reprezentacja informacji o prawdopodobieństwie dziennika dla pojedynczego tokenu zawartości, w tym listę najbardziej prawdopodobnych tokenów, jeśli zażądano "top_logprobs".
Choice	Reprezentacja pojedynczego ukończenia monitu w ramach ogólnego żądania ukończenia. Ogólnie rzecz biorąc, `n` opcje są generowane dla podanego monitu z wartością domyślną 1. Limity tokenów i inne ustawienia mogą ograniczać liczbę wygenerowanych opcji.
Completions	Reprezentacja danych odpowiedzi z żądania ukończenia. Ukończenia obsługują szeroką gamę zadań i generują tekst, który będzie kontynuowany na podstawie lub "ukończonych" dostarczonych danych monitu.
CompletionsLogProbabilityModel	Reprezentacja modelu prawdopodobieństwa dziennika dla generowania uzupełniania.
CompletionsUsage	Reprezentacja liczby tokenów przetworzonych dla żądania ukończenia. Liczniki uwzględniają wszystkie tokeny w monitach, wyborach, alternatywnych opcjach, best_of generacjach i innych użytkownikach.
ContentFilterBlocklistIdResult	Reprezentuje wynik oceny względem niestandardowej listy bloków, która jest wykonywana przez filtrowanie zawartości.
ContentFilterCitedDetectionResult	Reprezentuje wynik operacji wykrywania przed chronionymi zasobami, które są wykonywane przez filtrowanie zawartości.
ContentFilterDetectionResult	Reprezentuje wynik operacji wykrywania wykonywanej przez filtrowanie zawartości.
ContentFilterErrorResults	Informacje o wyniku błędu filtrowania zawartości.
ContentFilterResult	Informacje o filtrowanych poziomach ważności zawartości oraz o tym, czy została ona odfiltrowana, czy nie.
ContentFilterResultsForPrompt	Wyniki filtrowania zawartości dla pojedynczego monitu w żądaniu.
ContentFilterSuccessResultDetailsForPrompt	Informacje o wyniku powodzenia filtrowania zawartości.
ContentFilterSuccessResultsForChoice	Informacje o filtrowaniu zawartości oceniane na podstawie wygenerowanych danych wyjściowych modelu.
ElasticsearchChatExtensionConfiguration	Konkretna reprezentacja konfigurowalnych opcji usługi Elasticsearch podczas korzystania z niej jako rozszerzenia czatu usługi Azure OpenAI.
ElasticsearchIndexFieldMappingOptions	Ustawienia opcjonalne umożliwiające kontrolowanie sposobu przetwarzania pól przy użyciu skonfigurowanego zasobu elasticsearch®.
EmbeddingItem	Reprezentacja pojedynczego porównania powiązanych elementów osadzania.
Embeddings	Reprezentacja danych odpowiedzi z żądania osadzania. Osadzanie mierzy pokrewność ciągów tekstowych i są często używane do wyszukiwania, klastrowania, rekomendacji i innych podobnych scenariuszy.
EmbeddingsUsage	Pomiar ilości tokenów używanych w tym żądaniu i odpowiedzi.
EventStream	Czytelny strumień, który jest iterowalny i jednorazowy.
FunctionCall	Nazwa i argumenty funkcji, która powinna być wywoływana, generowane przez model.
FunctionDefinition	Definicja funkcji określonej przez obiekt wywołujący, którą ukończenie czatu może wywołać w odpowiedzi na pasujące dane wejściowe użytkownika.
FunctionName	Struktura określająca dokładną nazwę określonej, dostarczonej przez żądanie funkcji, która ma być używana podczas przetwarzania operacji kończenia czatu.
GetAudioTranscriptionOptions	Opcje żądania transkrypcji audio
GetAudioTranslationOptions	Opcje żądania tłumaczenia audio
GetChatCompletionsOptions	Ten moduł zawiera modele, które chcemy żyć obok odpowiednich wygenerowanych modeli. Jest to przydatne w przypadku udostępniania modeli przeznaczonych dla klientów, które mają różne nazwy/typy niż wygenerowane modele.
GetCompletionsOptions	Informacje o konfiguracji żądania ukończenia. Ukończenia obsługują szeroką gamę zadań i generują tekst, który będzie kontynuowany na podstawie lub "ukończonych" dostarczonych danych monitu.
GetEmbeddingsOptions	Opcje dla niestandardowego żądania osadzania
GetImagesOptions	Reprezentuje dane żądania używane do generowania obrazów.
ImageGenerationContentFilterResults	Opisuje wynik filtrowania zawartości dla żądania generowania obrazu.
ImageGenerationData	Reprezentacja pojedynczego wygenerowanego obrazu podana jako dane zakodowane w formacie Base64 lub jako adres URL, z którego można pobrać obraz.
ImageGenerationPromptFilterResults	Opisuje wyniki filtrowania zawartości dla monitu o żądanie generowania obrazu.
ImageGenerations	Wynik pomyślnej operacji generowania obrazu.
MaxTokensFinishDetails	Ustrukturyzowana reprezentacja przyczyny zatrzymania, która oznacza osiągnięcie limitu tokenów, zanim model będzie mógł w naturalny sposób ukończyć.
OnYourDataAccessTokenAuthenticationOptions	Opcje uwierzytelniania dla usługi Azure OpenAI Na danych podczas korzystania z tokenu dostępu.
OnYourDataApiKeyAuthenticationOptions	Opcje uwierzytelniania dla usługi Azure OpenAI Na danych podczas korzystania z klucza interfejsu API.
OnYourDataAuthenticationOptions	Opcje uwierzytelniania dla usługi Azure OpenAI Na danych.
OnYourDataConnectionStringAuthenticationOptions	Opcje uwierzytelniania dla usługi Azure OpenAI Na danych podczas korzystania z parametry połączenia.
OnYourDataDeploymentNameVectorizationSource	Szczegóły źródła wektoryzacji używanego przez usługę Azure OpenAI On Your Data podczas stosowania wyszukiwania wektorowego opartego na wewnętrznej nazwie wdrożenia modelu osadzania w tym samym zasobie usługi Azure OpenAI.
OnYourDataEncodedApiKeyAuthenticationOptions	Opcje uwierzytelniania dla usługi Azure OpenAI Na danych podczas korzystania z klucza interfejsu API zakodowanego w usłudze Elasticsearch.
OnYourDataEndpointVectorizationSource	Szczegóły źródła wektoryzacji używanego przez usługę Azure OpenAI On Your Data podczas stosowania wyszukiwania wektorowego opartego na publicznym wywołaniu punktu końcowego usługi Azure OpenAI na potrzeby osadzania.
OnYourDataKeyAndKeyIdAuthenticationOptions	Opcje uwierzytelniania dla usługi Azure OpenAI Na danych podczas korzystania z pary kluczy i identyfikatorów kluczy elasticsearch.
OnYourDataModelIdVectorizationSource	Szczegóły źródła wektoryzacji używanego przez usługę Azure OpenAI On Your Data podczas stosowania wyszukiwania wektorowego opartego na identyfikatorze modelu usługi wyszukiwania. Obecnie obsługiwane tylko przez usługę Elasticsearch®.
OnYourDataSystemAssignedManagedIdentityAuthenticationOptions	Opcje uwierzytelniania dla usługi Azure OpenAI Na danych podczas korzystania z przypisanej przez system tożsamości zarządzanej.
OnYourDataUserAssignedManagedIdentityAuthenticationOptions	Opcje uwierzytelniania dla usługi Azure OpenAI Na danych podczas korzystania z tożsamości zarządzanej przypisanej przez użytkownika.
OnYourDataVectorizationSource	Abstrakcyjna reprezentacja źródła wektoryzacji dla usługi Azure OpenAI On Your Data z wyszukiwaniem wektorowym.
OpenAIClientOptions
PineconeChatExtensionConfiguration	Konkretna reprezentacja konfigurowalnych opcji dla aplikacji Pinecone podczas korzystania z niej jako rozszerzenia czatu usługi Azure OpenAI.
PineconeFieldMappingOptions	Opcjonalne ustawienia umożliwiające kontrolowanie sposobu przetwarzania pól podczas korzystania ze skonfigurowanego zasobu Pinecone.
StopFinishDetails	Ustrukturyzowana reprezentacja przyczyny zatrzymania, która oznacza naturalne zakończenie przez model.

Aliasy typu

AudioResult	Typ wyniku transkrypcji na podstawie żądanego formatu odpowiedzi
AudioResultFormat	Format wyniku zadania audio
AudioTranscriptionTask	"transkrypcja", "translate"
AzureChatExtensionConfigurationUnion	Alias dla azureChatExtensionConfigurationUnion
AzureChatExtensionType	"azure_search", "azure_ml_index", "azure_cosmos_db", "elasticsearch", "pinecone"
AzureSearchQueryType	"simple", "semantic", "vector", "vector_simple_hybrid", "vector_semantic_hybrid"
ChatCompletionsNamedToolSelectionUnion	Alias dla ChatCompletionsNamedToolSelectionUnion
ChatCompletionsResponseFormatUnion	Alias dla ChatCompletionsResponseFormatUnion
ChatCompletionsToolCallUnion	Alias dla ChatCompletionsToolCallUnion
ChatCompletionsToolDefinitionUnion	Alias dla ChatCompletionsToolDefinitionUnion
ChatCompletionsToolSelectionPreset	"auto", "none"
ChatFinishDetailsUnion	Alias dla ChatFinishDetailsUnion
ChatMessageContentItemUnion	Alias dla ChatMessageContentItemUnion
ChatMessageImageDetailLevel	"auto", "low", "high"
ChatRequestMessageUnion	Alias dla ChatRequestMessageUnion
ChatRole	"system", "asystent", "user", "function", "tool"
CompletionsFinishReason	"stop", "length", "content_filter", "function_call", "tool_calls"
ContentFilterResultDetailsForPrompt	Informacje o kategorii filtrowania zawartości, jeśli zostały wykryte.
ContentFilterResultsForChoice	Informacje o wynikach filtrowania zawartości, jeśli zostały wykryte.
ContentFilterSeverity	"safe", "low", "medium", "high"
ElasticsearchQueryType	"simple", "vector"
FunctionCallPreset	"auto", "none"
ImageGenerationQuality	"standard", "hd"
ImageGenerationResponseFormat	"url", "b64_json"
ImageGenerationStyle	"naturalne", "żywe"
ImageSize	"256x256", "512x512", "1024x1024", "1792x1024", "1024x1792"
OnYourDataAuthenticationOptionsUnion	Alias dla 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 dla OnYourDataVectorizationSourceUnion

Udostępnij za pośrednictwem