OpenAIClient class
Azure OpenAI ile etkileşime yönelik bir istemci.
İstemcinin bir OpenAI kaynağının uç noktasına ve API anahtarı veya belirteç gibi bir kimlik doğrulama yöntemine ihtiyacı vardır. 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);
Oluşturucular
| Open |
Azure OpenAI olmayan uç noktasıyla kullanmak üzere bir OpenAIClient örneği başlatır. |
| Open |
Azure OpenAI kaynağıyla kullanmak üzere openAIClient örneğini başlatır. |
| Open |
Azure OpenAI kaynağıyla kullanmak üzere openAIClient örneğini başlatır. |
Yöntemler
| get |
Ses dosyasının transkripsiyonunu basit bir JSON biçiminde döndürür. |
| get |
Ses dosyasının dökümünü döndürür. |
| get |
Ses dosyasının çevirisini döndürür. |
| get |
Ses dosyasının çevirisini döndürür. |
| get |
Sağlanan sohbet iletileri için sohbet tamamlamalarını alır. Tamamlamalar çok çeşitli görevleri destekler ve sağlanan istem verilerinden devam eden veya "tamamlayan" metinler oluşturur. |
| get |
Sağlanan giriş istemleri için tamamlamaları alır. Tamamlamalar çok çeşitli görevleri destekler ve sağlanan istem verilerinden devam eden veya "tamamlayan" metinler oluşturur. |
| get |
Belirli bir istem için eklemeleri döndür. |
| get |
İstem verilen bir görüntü oluşturur. |
| stream |
Sohbet bağlamı için kullanılabilir hale gelen sohbet tamamlama belirteçlerini Listeler. |
| stream |
Belirli bir istem için kullanılabilir duruma gelen tamamlama belirteçlerini Listeler. |
Oluşturucu Ayrıntıları
OpenAIClient(KeyCredential, OpenAIClientOptions)
Azure OpenAI olmayan uç noktasıyla kullanmak üzere bir OpenAIClient örneği başlatır.
new OpenAIClient(openAiApiKey: KeyCredential, options?: OpenAIClientOptions)Parametreler
- openAiApiKey
- KeyCredential
Azure dışı OpenAI uç noktasına bağlanırken kullanılacak API anahtarı.
- options
- OpenAIClientOptions
İstemciyi yapılandırma seçenekleri.
Açıklamalar
Bu oluşturucuyla başlatılan OpenAIClient nesneleri yalnızca Azure dışı OpenAI çıkarım uç noktasıyla kullanılabilir. OpenAIClient'ı bir Azure OpenAI kaynağıyla kullanmak için, bunun yerine kaynak URI'si ve Azure kimlik doğrulaması kimlik bilgilerini kabul eden bir oluşturucu kullanın.
OpenAIClient(string, KeyCredential, OpenAIClientOptions)
Azure OpenAI kaynağıyla kullanmak üzere openAIClient örneğini başlatır.
new OpenAIClient(endpoint: string, credential: KeyCredential, options?: OpenAIClientOptions)Parametreler
- endpoint
-
string
Protokol ve konak adı da dahil olmak üzere bir Azure OpenAI kaynağının URI'si. Örneğin: https://my-resource.openai.azure.com.
- credential
- KeyCredential
Azure OpenAI kaynağında kimlik doğrulaması yapmak için kullanılan anahtar kimlik bilgileri.
- options
- OpenAIClientOptions
İstemciyi yapılandırma seçenekleri.
Açıklamalar
Bu oluşturucu, yalnızca Azure OpenAI kaynaklarıyla kullanılabilen bir OpenAIClient nesnesi başlatır. OpenAIClient'ı Azure dışı bir OpenAI çıkarım uç noktasıyla kullanmak için, bunun yerine Azure OpenAI API'si olmayan bir anahtarı kabul eden bir oluşturucu kullanın.
OpenAIClient(string, TokenCredential, OpenAIClientOptions)
Azure OpenAI kaynağıyla kullanmak üzere openAIClient örneğini başlatır.
new OpenAIClient(endpoint: string, credential: TokenCredential, options?: OpenAIClientOptions)Parametreler
- endpoint
-
string
Protokol ve konak adı da dahil olmak üzere bir Azure OpenAI kaynağının URI'si. Örneğin: https://my-resource.openai.azure.com.
- credential
- TokenCredential
Azure OpenAI kaynağıyla kimlik doğrulaması yapmak için kullanılan belirteç kimlik bilgileri.
- options
- OpenAIClientOptions
İstemciyi yapılandırma seçenekleri.
Yöntem Ayrıntıları
getAudioTranscription(string, Uint8Array, GetAudioTranscriptionOptions)
Ses dosyasının transkripsiyonunu basit bir JSON biçiminde döndürür.
function getAudioTranscription(deploymentName: string, fileContent: Uint8Array, options?: GetAudioTranscriptionOptions): Promise<AudioResultSimpleJson>Parametreler
- deploymentName
-
string
Bu istek için kullanılacak model dağıtımının adı (Azure OpenAI kullanılırken) veya model adı (Azure OpenAI olmayan bir ad kullanılırken).
- fileContent
-
Uint8Array
Dökümü yapılan ses dosyasının içeriği.
- options
- GetAudioTranscriptionOptions
Bu ses transkripsiyonu isteğinin seçenekleri.
Döndürülenler
Promise<AudioResultSimpleJson>
Ses transkripsiyonu basit bir JSON biçiminde sonuç verir.
getAudioTranscription<Format>(string, Uint8Array, Format, GetAudioTranscriptionOptions)
Ses dosyasının dökümünü döndürür.
function getAudioTranscription<Format>(deploymentName: string, fileContent: Uint8Array, format: Format, options?: GetAudioTranscriptionOptions): Promise<AudioResult<Format>>Parametreler
- deploymentName
-
string
Bu istek için kullanılacak model dağıtımının adı (Azure OpenAI kullanılırken) veya model adı (Azure OpenAI olmayan bir ad kullanılırken).
- fileContent
-
Uint8Array
Dökümü yapılan ses dosyasının içeriği.
- format
-
Format
Sonuç nesnesinin biçimi. Olası değerler için bkz. AudioResultFormat .
- options
- GetAudioTranscriptionOptions
Bu ses transkripsiyonu isteğinin seçenekleri.
Döndürülenler
Promise<AudioResult<Format>>
Ses transkripsiyonu, seçtiğiniz bir biçimde sonuç verir.
getAudioTranslation(string, Uint8Array, GetAudioTranslationOptions)
Ses dosyasının çevirisini döndürür.
function getAudioTranslation(deploymentName: string, fileContent: Uint8Array, options?: GetAudioTranslationOptions): Promise<AudioResultSimpleJson>Parametreler
- deploymentName
-
string
Bu istek için kullanılacak model dağıtımının adı (Azure OpenAI kullanılırken) veya model adı (Azure OpenAI olmayan bir ad kullanılırken).
- fileContent
-
Uint8Array
Çevrilecek ses dosyasının içeriği.
- options
- GetAudioTranslationOptions
Bu ses çevirisi isteği için seçenekler.
Döndürülenler
Promise<AudioResultSimpleJson>
Ses çevirisi sonucu.
getAudioTranslation<Format>(string, Uint8Array, Format, GetAudioTranslationOptions)
Ses dosyasının çevirisini döndürür.
function getAudioTranslation<Format>(deploymentName: string, fileContent: Uint8Array, format: Format, options?: GetAudioTranslationOptions): Promise<AudioResult<Format>>Parametreler
- deploymentName
-
string
Bu istek için kullanılacak model dağıtımının adı (Azure OpenAI kullanılırken) veya model adı (Azure OpenAI olmayan bir ad kullanılırken).
- fileContent
-
Uint8Array
Çevrilecek ses dosyasının içeriği.
- format
-
Format
Sonuç nesnesinin biçimi. Olası değerler için bkz. AudioResultFormat .
- options
- GetAudioTranslationOptions
Bu ses çevirisi isteği için seçenekler.
Döndürülenler
Promise<AudioResult<Format>>
Ses çevirisi sonucu.
getChatCompletions(string, ChatRequestMessageUnion[], GetChatCompletionsOptions)
Sağlanan sohbet iletileri için sohbet tamamlamalarını alır. Tamamlamalar çok çeşitli görevleri destekler ve sağlanan istem verilerinden devam eden veya "tamamlayan" metinler oluşturur.
function getChatCompletions(deploymentName: string, messages: ChatRequestMessageUnion[], options?: GetChatCompletionsOptions): Promise<ChatCompletions>Parametreler
- deploymentName
-
string
- messages
- options
- GetChatCompletionsOptions
Döndürülenler
Promise<ChatCompletions>
getCompletions(string, string[], GetCompletionsOptions)
Sağlanan giriş istemleri için tamamlamaları alır. Tamamlamalar çok çeşitli görevleri destekler ve sağlanan istem verilerinden devam eden veya "tamamlayan" metinler oluşturur.
function getCompletions(deploymentName: string, prompt: string[], options?: GetCompletionsOptions): Promise<Completions>Parametreler
- deploymentName
-
string
- prompt
-
string[]
- options
- GetCompletionsOptions
Döndürülenler
Promise<Completions>
getEmbeddings(string, string[], GetEmbeddingsOptions)
Belirli bir istem için eklemeleri döndür.
function getEmbeddings(deploymentName: string, input: string[], options?: GetEmbeddingsOptions): Promise<Embeddings>Parametreler
- deploymentName
-
string
- input
-
string[]
- options
- GetEmbeddingsOptions
Döndürülenler
Promise<Embeddings>
getImages(string, string, GetImagesOptions)
İstem verilen bir görüntü oluşturur.
function getImages(deploymentName: string, prompt: string, options?: GetImagesOptions): Promise<ImageGenerations>Parametreler
- deploymentName
-
string
- prompt
-
string
- options
- GetImagesOptions
Döndürülenler
Promise<ImageGenerations>
streamChatCompletions(string, ChatRequestMessageUnion[], GetChatCompletionsOptions)
Sohbet bağlamı için kullanılabilir hale gelen sohbet tamamlama belirteçlerini Listeler.
function streamChatCompletions(deploymentName: string, messages: ChatRequestMessageUnion[], options?: GetChatCompletionsOptions): Promise<EventStream<ChatCompletions>>Parametreler
- deploymentName
-
string
Bu istek için kullanılacak model dağıtımının adı (Azure OpenAI kullanılırken) veya model adı (Azure OpenAI olmayan bir ad kullanılırken).
- messages
Bu istek için kullanılacak sohbet bağlamı iletileri.
- options
- GetChatCompletionsOptions
Bu sohbet tamamlama isteği için sohbet tamamlama seçenekleri.
Döndürülenler
Promise<EventStream<ChatCompletions>>
Sohbet tamamlama belirteçlerinin zaman uyumsuz yinelenebilirliği.
streamCompletions(string, string[], GetCompletionsOptions)
Belirli bir istem için kullanılabilir duruma gelen tamamlama belirteçlerini Listeler.
function streamCompletions(deploymentName: string, prompt: string[], options?: GetCompletionsOptions): Promise<EventStream<Omit<Completions, "usage">>>Parametreler
- deploymentName
-
string
Bu istek için kullanılacak model dağıtımının adı (Azure OpenAI kullanılırken) veya model adı (Azure OpenAI olmayan bir ad kullanılırken).
- prompt
-
string[]
Bu istek için kullanılacak istem.
- options
- GetCompletionsOptions
Bu tamamlama isteği için tamamlama seçenekleri.
Döndürülenler
Promise<EventStream<Omit<Completions, "usage">>>
Tamamlama belirteçlerinin zaman uyumsuz yinelenebilirliği.
Azure SDK for JavaScript
Geri Bildirim
Çok yakında: 2024 boyunca, içerik için geri bildirim mekanizması olarak GitHub Sorunları’nı kullanımdan kaldıracak ve yeni bir geri bildirim sistemiyle değiştireceğiz. Daha fazla bilgi için bkz. https://aka.ms/ContentUserFeedback.
Gönderin ve geri bildirimi görüntüleyin