@azure/openai package

Başvuru

Sınıflar

Temel anahtar değerinin güncelleştirilmesini destekleyen statik anahtar tabanlı kimlik bilgileri.

Azure OpenAI ile etkileşime yönelik bir istemci.

İstemci bir OpenAI kaynağının uç noktasına ve API anahtarı veya belirteci gibi bir kimlik doğrulama yöntemine ihtiyaç duyar. API anahtarı ve uç noktası OpenAI kaynak sayfasında bulunabilir. Bunlar kaynağın Anahtarlar ve Uç Nokta sayfasında bulunur.

Kimlik doğrulaması örnekleri:

API Anahtarı

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

OpenAIKeyCredential sınıfı bir OpenAI API anahtarını temsil eder ve OpenAI uç noktası için OpenAI istemcisinde kimlik doğrulaması yapmak için kullanılır.

Arabirimler

AudioResultSimpleJson	Basit transkripsiyon yanıtı
AudioResultVerboseJson	Transkripsiyon yanıtı.
AudioSegment	Transkripsiyon segmenti.
AzureChatEnhancementConfiguration	Kullanılabilir Azure OpenAI geliştirme yapılandırmalarının bir gösterimi.
AzureChatEnhancements	İstekte sağlanan eşleşen giriş aracılığıyla yapılandırıldığı gibi, Sohbet tamamlamalarına yönelik Azure geliştirmelerinin çıkış sonuçlarını temsil eder.
AzureChatExtensionConfiguration	Tek bir Azure OpenAI sohbet uzantısı için yapılandırma verilerinin gösterimi. Bu, yanıt davranışını artırmak için Azure OpenAI sohbet uzantılarını kullanması gereken bir sohbet tamamlama isteği tarafından kullanılır. Bu yapılandırmanın kullanımı yalnızca Azure OpenAI ile uyumludur.
AzureChatExtensionDataSourceResponseCitation	Azure OpenAI sohbet uzantıları, ilgili sohbet tamamlama yanıtının oluşturulmasına dahil edildiğinde sağlanan ek bağlam bilgilerinin tek bir örneği. Bu bağlam bilgileri yalnızca eşleşen bir uzantı kullanmak üzere yapılandırılmış bir Azure OpenAI isteği kullanılırken doldurulur.
AzureChatExtensionsMessageContext	Azure OpenAI sohbet uzantıları, ilgili sohbet tamamlama yanıtının oluşturulmasına dahil edildiğinde sağlanan ek bağlam bilgilerinin gösterimi. Bu bağlam bilgileri yalnızca eşleşen bir uzantı kullanmak üzere yapılandırılmış bir Azure OpenAI isteği kullanılırken doldurulur.
AzureChatGroundingEnhancementConfiguration	Azure OpenAI topraklama geliştirmesi için kullanılabilir seçeneklerin gösterimi.
AzureChatOCREnhancementConfiguration	Azure OpenAI optik karakter tanıma (OCR) geliştirmesi için kullanılabilir seçeneklerin gösterimi.
AzureCosmosDBChatExtensionConfiguration	Azure OpenAI sohbet uzantısı olarak kullanılırken Azure Cosmos DB için yapılandırılabilir seçeneklerin belirli bir gösterimi.
AzureCosmosDBFieldMappingOptions	Yapılandırılmış bir Azure Cosmos DB kaynağı kullanılırken alanların nasıl işlendiğini denetlemek için isteğe bağlı ayarlar.
AzureExtensionsOptions	Azure OpenAI sohbet uzantıları için seçenekler.
AzureGroundingEnhancement	Görüntüde algılanan nesnelerin sınırlayıcı kutusunu döndüren topraklama geliştirmesi.
AzureGroundingEnhancementCoordinatePoint	Azure topraklama geliştirmesi tarafından kullanılan tek bir çokgen noktasının gösterimi.
AzureGroundingEnhancementLine	Sözcükler ve seçim işaretleri gibi bitişik bir içerik öğesi dizisini içeren bir içerik satırı nesnesi.
AzureGroundingEnhancementLineSpan	Algılanan bir nesneyi ve sınırlayıcı kutu bilgilerini temsil eden bir span nesnesi.
AzureMachineLearningIndexChatExtensionConfiguration	Azure OpenAI sohbet uzantısı olarak kullanılırken Azure Machine Learning vektör dizini için yapılandırılabilir seçeneklerin belirli bir gösterimi.
AzureSearchChatExtensionConfiguration	Azure OpenAI sohbet uzantısı olarak kullanılırken Azure Arama için yapılandırılabilir seçeneklerin belirli bir gösterimi.
AzureSearchIndexFieldMappingOptions	Yapılandırılmış bir Azure Arama kaynağı kullanılırken alanların nasıl işlendiğini denetlemek için isteğe bağlı ayarlar.
ChatChoice	Genel sohbet tamamlama isteklerinin bir parçası olarak tek bir istem tamamlamanın gösterimi. Genellikle, `n` varsayılan değer 1 olan sağlanan istem başına seçimler oluşturulur. Belirteç sınırları ve diğer ayarlar, oluşturulan seçenek sayısını sınırlayabilir.
ChatChoiceLogProbabilityInfo	'logprobs' ve 'top_logprobs' aracılığıyla istenen seçenek için olasılık bilgilerini günlüğe kaydedin.
ChatCompletions	Sohbet tamamlama isteğinden gelen yanıt verilerinin gösterimi. Tamamlamalar çok çeşitli görevleri destekler ve sağlanan istem verilerinden devam eden veya "tamamlayan" metinler oluşturur.
ChatCompletionsFunctionToolCall	Model tarafından yapılandırılmış bir işlev aracının değerlendirilmesinde verilen ve sonraki sohbet tamamlama isteklerinin çözümlenmesi için gereken işlev çağrısını temsil eden bir işlev aracı çağrısı.
ChatCompletionsFunctionToolDefinition	Bir araç çağrısına yanıt olarak işlev çağırabilen sohbet tamamlamaları işlev aracının tanım bilgileri.
ChatCompletionsFunctionToolSelection	Sohbet tamamlamalarını adlandırılmış işlevin kullanımıyla sınırlayacak belirli, adlandırılmış bir işlev aracının araç seçimi.
ChatCompletionsJsonResponseFormat	Yanıtların geçerli JSON nesneleri yaymalarını kısıtlayan Sohbet Tamamlamaları için bir yanıt biçimi.
ChatCompletionsNamedFunctionToolSelection	Sohbet tamamlamalarını adlandırılmış işlevin kullanımıyla sınırlayacak belirli, adlandırılmış bir işlev aracının araç seçimi.
ChatCompletionsNamedToolSelection	Sohbet tamamlama isteği için kullanılacak açık, adlandırılmış bir araç seçiminin soyut gösterimi.
ChatCompletionsResponseFormat	Sohbet Tamamlamaları tarafından kullanılabilen yanıt biçimi yapılandırmasının soyut gösterimi. JSON modunu etkinleştirmek için kullanılabilir.
ChatCompletionsTextResponseFormat	Serbestçe metin oluşturabilen ve belirli bir şemaya uygun yanıt içeriği üretmesi garanti edilmeyen standart Sohbet Tamamlamaları yanıt biçimi.
ChatCompletionsToolCall	İstenen sohbet tamamlama işlemini gerçekleştirmek için sonraki bir istekte çözümlenmesi gereken araç çağrısının soyut bir gösterimi.
ChatCompletionsToolDefinition	Model tarafından sohbet tamamlama yanıtını geliştirmek için kullanılabilecek bir aracın soyut gösterimi.
ChatFinishDetails	Sohbet tamamlama yanıtının neden sonlandırıldığına ilişkin yapılandırılmış bilgilerin soyut bir gösterimi.
ChatMessageContentItem	Bir sohbet iletisi içindeki yapılandırılmış içerik öğesinin soyut gösterimi.
ChatMessageImageContentItem	Görüntü başvurusu içeren yapılandırılmış bir sohbet içerik öğesi.
ChatMessageImageUrl	Modelin görüntü alabileceği İnternet konumu.
ChatMessageTextContentItem	Düz metin içeren yapılandırılmış bir sohbet içerik öğesi.
ChatRequestAssistantMessage	yardımcı yanıtı veya eylemi temsil eden bir istek sohbeti iletisi.
ChatRequestFunctionMessage	Yapılandırılmış bir işlevden istenen çıkışı temsil eden bir istek sohbeti iletisi.
ChatRequestMessage	İstekte sağlanan sohbet iletisinin soyut gösterimi.
ChatRequestSystemMessage	Modelin sohbet tamamlama yanıtı oluşturma şeklini etkileyen sistem yönergelerini içeren bir istek sohbeti iletisi.
ChatRequestToolMessage	Yapılandırılmış bir araçtan istenen çıkışı temsil eden bir istek sohbeti iletisi.
ChatRequestUserMessage	yardımcı kullanıcı girişini temsil eden bir istek sohbeti iletisi.
ChatResponseMessage	Bir yanıtta alınan sohbet iletisinin gösterimi.
ChatTokenLogProbabilityInfo	Tek bir ileti içerik belirteci için günlük olasılık bilgilerinin gösterimi.
ChatTokenLogProbabilityResult	'top_logprobs' istendiyse en olası belirteçlerin listesi de dahil olmak üzere tek bir içerik belirtecinin günlük olasılığı bilgilerinin gösterimi.
Choice	Genel tamamlama isteğinin bir parçası olarak tek bir istem tamamlamanın gösterimi. Genellikle, `n` varsayılan değer 1 olan sağlanan istem başına seçimler oluşturulur. Belirteç sınırları ve diğer ayarlar, oluşturulan seçenek sayısını sınırlayabilir.
Completions	Tamamlama isteğinden gelen yanıt verilerinin gösterimi. Tamamlamalar çok çeşitli görevleri destekler ve sağlanan istem verilerinden devam eden veya "tamamlayan" metinler oluşturur.
CompletionsLogProbabilityModel	Tamamlama oluşturma için günlük olasılıkları modelinin gösterimi.
CompletionsUsage	Tamamlama isteği için işlenen belirteç sayılarının gösterimi. Sayımlar istemler, seçenekler, seçim alternatifleri, best_of nesiller ve diğer tüketiciler arasındaki tüm belirteçleri dikkate alır.
ContentFilterBlocklistIdResult	İçerik filtreleme tarafından gerçekleştirilen özel bir blok listesine karşı yapılan değerlendirmenin sonucunu temsil eder.
ContentFilterCitedDetectionResult	İçerik filtreleme tarafından gerçekleştirilen korumalı kaynaklara karşı algılama işleminin sonucunu temsil eder.
ContentFilterDetectionResult	İçerik filtreleme tarafından gerçekleştirilen algılama işleminin sonucunu temsil eder.
ContentFilterErrorResults	İçerik filtreleme hatası sonucu hakkında bilgi.
ContentFilterResult	Filtrelenmiş içerik önem düzeyi ve filtrelenip filtrelenmediği hakkında bilgi.
ContentFilterResultsForPrompt	İstekteki tek bir istem için içerik filtreleme sonuçları.
ContentFilterSuccessResultDetailsForPrompt	İçerik filtreleme başarı sonucu hakkında bilgi.
ContentFilterSuccessResultsForChoice	Oluşturulan model çıkışına göre değerlendirilen içerik filtreleme hakkında bilgi.
ElasticsearchChatExtensionConfiguration	Elasticsearch'i Azure OpenAI sohbet uzantısı olarak kullanırken yapılandırılabilir seçeneklerin belirli bir gösterimi.
ElasticsearchIndexFieldMappingOptions	Yapılandırılmış bir Elasticsearch® kaynağı kullanılırken alanların nasıl işlendiğini denetlemek için isteğe bağlı ayarlar.
EmbeddingItem	Tek bir eklemeler ilgililik karşılaştırmasının gösterimi.
Embeddings	Bir ekleme isteğinden gelen yanıt verilerinin gösterimi. Eklemeler, metin dizelerinin ilgililiğini ölçer ve genellikle arama, kümeleme, öneriler ve diğer benzer senaryolar için kullanılır.
EmbeddingsUsage	Bu istekte ve yanıtta kullanılan belirteç miktarının ölçümü.
EventStream	Yinelenebilir ve tek kullanımlık okunabilir bir akış.
FunctionCall	Model tarafından oluşturulduğu gibi çağrılması gereken bir işlevin adı ve bağımsız değişkenleri.
FunctionDefinition	Sohbet tamamlamalarının eşleşen kullanıcı girişine yanıt olarak çağırabileceği arayan tarafından belirtilen işlevin tanımı.
FunctionName	Sohbet tamamlama işlemi işlenirken kullanılacak belirli bir istek tarafından sağlanan işlevin tam adını belirten yapı.
GetAudioTranscriptionOptions	Ses transkripsiyonu isteği seçenekleri
GetAudioTranslationOptions	Ses çevirisi isteği seçenekleri
GetChatCompletionsOptions	Bu modül, karşılık gelen oluşturulan modellerle yan yana yaşamak istediğimiz modelleri içerir. Bu, oluşturulan modellerden farklı adlara/türlere sahip müşteriye yönelik modeller sağlamak için kullanışlıdır.
GetCompletionsOptions	Tamamlama isteği için yapılandırma bilgileri. Tamamlamalar çok çeşitli görevleri destekler ve sağlanan istem verilerinden devam eden veya "tamamlayan" metinler oluşturur.
GetEmbeddingsOptions	Özel ekleme isteği seçenekleri
GetImagesOptions	Görüntü oluşturmak için kullanılan istek verilerini temsil eder.
ImageGenerationContentFilterResults	Görüntü oluşturma isteği için içerik filtreleme sonucunu açıklar.
ImageGenerationData	Oluşturulan tek bir görüntünün gösterimi, base64 ile kodlanmış veriler veya görüntünün alınabileceği bir URL olarak sağlanır.
ImageGenerationPromptFilterResults	Görüntü oluşturma isteğinin istemi için içerik filtreleme sonuçlarını açıklar.
ImageGenerations	Başarılı bir görüntü oluşturma işleminin sonucu.
MaxTokensFinishDetails	Model doğal olarak tamamlanmadan önce bir belirteç sınırına ulaşıldığını belirten bir durdurma nedeninin yapılandırılmış gösterimi.
OnYourDataAccessTokenAuthenticationOptions	Erişim belirteci kullanırken Verilerinizde Azure OpenAI için kimlik doğrulama seçenekleri.
OnYourDataApiKeyAuthenticationOptions	API anahtarı kullanırken Verilerinizde Azure OpenAI kimlik doğrulama seçenekleri.
OnYourDataAuthenticationOptions	Verilerinizde Azure OpenAI için kimlik doğrulama seçenekleri.
OnYourDataConnectionStringAuthenticationOptions	bağlantı dizesi kullanırken Verilerinizde Azure OpenAI kimlik doğrulama seçenekleri.
OnYourDataDeploymentNameVectorizationSource	Vektör araması uygularken Verilerinizde Azure OpenAI tarafından kullanılan ve aynı Azure OpenAI kaynağındaki iç ekleme modeli dağıtım adını temel alan bir vektörleştirme kaynağının ayrıntıları.
OnYourDataEncodedApiKeyAuthenticationOptions	Elasticsearch kodlanmış API anahtarı kullanılırken Verilerinizde Azure OpenAI kimlik doğrulama seçenekleri.
OnYourDataEndpointVectorizationSource	Vektör araması uygularken Verilerinizde Azure OpenAI tarafından kullanılan ve eklemeler için genel bir Azure OpenAI uç nokta çağrısına dayanan vektörleştirme kaynağının ayrıntıları.
OnYourDataKeyAndKeyIdAuthenticationOptions	Elasticsearch anahtarı ve anahtar kimliği çifti kullanılırken Verilerinizde Azure OpenAI kimlik doğrulama seçenekleri.
OnYourDataModelIdVectorizationSource	Vektör araması uygularken Verilerinizde Azure OpenAI tarafından kullanılan ve arama hizmeti model kimliğini temel alan bir vektörleştirme kaynağının ayrıntıları. Şu anda yalnızca Elasticsearch tarafından desteklenmektedir®.
OnYourDataSystemAssignedManagedIdentityAuthenticationOptions	Sistem tarafından atanan yönetilen kimlik kullanılırken Verilerinizde Azure OpenAI kimlik doğrulama seçenekleri.
OnYourDataUserAssignedManagedIdentityAuthenticationOptions	Kullanıcı tarafından atanan yönetilen kimlik kullanılırken Verilerinizde Azure OpenAI kimlik doğrulama seçenekleri.
OnYourDataVectorizationSource	Vektör araması ile Verilerinizde Azure OpenAI için vektörleştirme kaynağının soyut gösterimi.
OpenAIClientOptions
PineconeChatExtensionConfiguration	Pinecone için Azure OpenAI sohbet uzantısı olarak kullanılırken yapılandırılabilir seçeneklerin belirli bir gösterimi.
PineconeFieldMappingOptions	Yapılandırılmış bir Pinecone kaynağı kullanılırken alanların nasıl işlendiğini denetlemek için isteğe bağlı ayarlar.
StopFinishDetails	Modelin doğal sonlandırmasını gösteren bir durdurma nedeninin yapılandırılmış gösterimi.

Tür Diğer Adları

AudioResult	İstenen yanıt biçimine göre transkripsiyon sonucunun türü
AudioResultFormat	Ses görevinin sonuç biçimi
AudioTranscriptionTask	"transcribe", "translate"
AzureChatExtensionConfigurationUnion	AzureChatExtensionConfigurationUnion diğer adı
AzureChatExtensionType	"azure_search", "azure_ml_index", "azure_cosmos_db", "elasticsearch", "pinecone"
AzureSearchQueryType	"simple", "semantic", "vector", "vector_simple_hybrid", "vector_semantic_hybrid"
ChatCompletionsNamedToolSelectionUnion	ChatCompletionsNamedToolSelectionUnion diğer adı
ChatCompletionsResponseFormatUnion	ChatCompletionsResponseFormatUnion için diğer ad
ChatCompletionsToolCallUnion	ChatCompletionsToolCallUnion diğer adı
ChatCompletionsToolDefinitionUnion	ChatCompletionsToolDefinitionUnion için Diğer Ad
ChatCompletionsToolSelectionPreset	"auto", "none"
ChatFinishDetailsUnion	ChatFinishDetailsUnion diğer adı
ChatMessageContentItemUnion	ChatMessageContentItemUnion diğer adı
ChatMessageImageDetailLevel	"auto", "low", "high"
ChatRequestMessageUnion	ChatRequestMessageUnion diğer adı
ChatRole	"system", "yardımcı", "user", "function", "tool"
CompletionsFinishReason	"stop", "length", "content_filter", "function_call", "tool_calls"
ContentFilterResultDetailsForPrompt	Algılandıysa, içerik filtreleme kategorisi hakkındaki bilgiler.
ContentFilterResultsForChoice	algılandıysa, içerik filtreleme sonuçları hakkındaki bilgiler.
ContentFilterSeverity	"safe", "low", "medium", "high"
ElasticsearchQueryType	"simple", "vector"
FunctionCallPreset	"auto", "none"
ImageGenerationQuality	"standard", "hd"
ImageGenerationResponseFormat	"url", "b64_json"
ImageGenerationStyle	"doğal", "canlı"
ImageSize	"256x256", "512x512", "1024x1024", "1792x1024", "1024x1792"
OnYourDataAuthenticationOptionsUnion	OnYourDataAuthenticationOptionsUnion için Diğer Ad
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	OnYourDataVectorizationSourceUnion için Diğer Ad

Aracılığıyla paylaş