OpenAIClient class
Klien untuk berinteraksi dengan Azure OpenAI.
Klien memerlukan titik akhir sumber daya OpenAI dan metode autentikasi seperti kunci API atau token. Kunci API dan titik akhir dapat ditemukan di halaman sumber daya OpenAI. Mereka akan terletak di halaman Kunci dan Titik Akhir sumber daya.
Contoh untuk autentikasi:
Kunci 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);
Konstruktor
| Open |
Menginisialisasi instans OpenAIClient untuk digunakan dengan titik akhir OpenAI non-Azure. |
| Open |
Menginisialisasi instans OpenAIClient untuk digunakan dengan sumber daya Azure OpenAI. |
| Open |
Menginisialisasi instans OpenAIClient untuk digunakan dengan sumber daya Azure OpenAI. |
Metode
| get |
Mengembalikan transkripsi file audio dalam format JSON sederhana. |
| get |
Mengembalikan transkripsi file audio. |
| get |
Mengembalikan terjemahan file audio. |
| get |
Mengembalikan terjemahan file audio. |
| get |
Mendapatkan penyelesaian obrolan untuk pesan obrolan yang disediakan. Penyelesaian mendukung berbagai tugas dan menghasilkan teks yang berlanjut dari atau "menyelesaikan" data prompt yang disediakan. |
| get |
Mendapatkan penyelesaian untuk perintah input yang disediakan. Penyelesaian mendukung berbagai tugas dan menghasilkan teks yang berlanjut dari atau "menyelesaikan" data prompt yang disediakan. |
| get |
Mengembalikan penyematan untuk perintah tertentu. |
| get |
Membuat gambar yang diberikan perintah. |
| stream |
Lists token penyelesaian obrolan saat tersedia untuk konteks obrolan. |
| stream |
Lists token penyelesaian saat tersedia untuk perintah tertentu. |
Detail Konstruktor
OpenAIClient(KeyCredential, OpenAIClientOptions)
Menginisialisasi instans OpenAIClient untuk digunakan dengan titik akhir OpenAI non-Azure.
new OpenAIClient(openAiApiKey: KeyCredential, options?: OpenAIClientOptions)Parameter
- openAiApiKey
- KeyCredential
Kunci API yang digunakan saat menyambungkan ke titik akhir OpenAI non-Azure.
- options
- OpenAIClientOptions
Opsi untuk mengonfigurasi klien.
Keterangan
Objek OpenAIClient yang diinisialisasi dengan konstruktor ini hanya dapat digunakan dengan titik akhir inferensi OpenAI non-Azure. Untuk menggunakan OpenAIClient dengan sumber daya Azure OpenAI, gunakan konstruktor yang menerima URI sumber daya dan kredensial autentikasi Azure sebagai gantinya.
OpenAIClient(string, KeyCredential, OpenAIClientOptions)
Menginisialisasi instans OpenAIClient untuk digunakan dengan sumber daya Azure OpenAI.
new OpenAIClient(endpoint: string, credential: KeyCredential, options?: OpenAIClientOptions)Parameter
- endpoint
-
string
URI untuk sumber daya Azure OpenAI, termasuk protokol dan nama host. Misalnya: https://my-resource.openai.azure.com.
- credential
- KeyCredential
Kredensial kunci yang digunakan untuk mengautentikasi ke sumber daya Azure OpenAI.
- options
- OpenAIClientOptions
Opsi untuk mengonfigurasi klien.
Keterangan
Konstruktor ini menginisialisasi objek OpenAIClient yang hanya dapat digunakan dengan sumber daya Azure OpenAI. Untuk menggunakan OpenAIClient dengan titik akhir inferensi OpenAI non-Azure, gunakan konstruktor yang menerima kunci API OpenAI non-Azure sebagai gantinya.
OpenAIClient(string, TokenCredential, OpenAIClientOptions)
Menginisialisasi instans OpenAIClient untuk digunakan dengan sumber daya Azure OpenAI.
new OpenAIClient(endpoint: string, credential: TokenCredential, options?: OpenAIClientOptions)Parameter
- endpoint
-
string
URI untuk sumber daya Azure OpenAI, termasuk protokol dan nama host. Misalnya: https://my-resource.openai.azure.com.
- credential
- TokenCredential
Kredensial token yang digunakan untuk mengautentikasi dengan sumber daya Azure OpenAI.
- options
- OpenAIClientOptions
Opsi untuk mengonfigurasi klien.
Detail Metode
getAudioTranscription(string, Uint8Array, GetAudioTranscriptionOptions)
Mengembalikan transkripsi file audio dalam format JSON sederhana.
function getAudioTranscription(deploymentName: string, fileContent: Uint8Array, options?: GetAudioTranscriptionOptions): Promise<AudioResultSimpleJson>Parameter
- deploymentName
-
string
Nama penyebaran model (saat menggunakan Azure OpenAI) atau nama model (saat menggunakan non-Azure OpenAI) untuk digunakan untuk permintaan ini.
- fileContent
-
Uint8Array
Konten file audio yang akan ditranskripsikan.
- options
- GetAudioTranscriptionOptions
Opsi untuk permintaan transkripsi audio ini.
Mengembalikan
Promise<AudioResultSimpleJson>
Transkripsi audio menghasilkan format JSON sederhana.
getAudioTranscription<Format>(string, Uint8Array, Format, GetAudioTranscriptionOptions)
Mengembalikan transkripsi file audio.
function getAudioTranscription<Format>(deploymentName: string, fileContent: Uint8Array, format: Format, options?: GetAudioTranscriptionOptions): Promise<AudioResult<Format>>Parameter
- deploymentName
-
string
Nama penyebaran model (saat menggunakan Azure OpenAI) atau nama model (saat menggunakan non-Azure OpenAI) untuk digunakan untuk permintaan ini.
- fileContent
-
Uint8Array
Konten file audio yang akan ditranskripsikan.
- format
-
Format
Format objek hasil. Lihat AudioResultFormat untuk nilai yang mungkin.
- options
- GetAudioTranscriptionOptions
Opsi untuk permintaan transkripsi audio ini.
Mengembalikan
Promise<AudioResult<Format>>
Transkripsi audio menghasilkan format pilihan Anda.
getAudioTranslation(string, Uint8Array, GetAudioTranslationOptions)
Mengembalikan terjemahan file audio.
function getAudioTranslation(deploymentName: string, fileContent: Uint8Array, options?: GetAudioTranslationOptions): Promise<AudioResultSimpleJson>Parameter
- deploymentName
-
string
Nama penyebaran model (saat menggunakan Azure OpenAI) atau nama model (saat menggunakan non-Azure OpenAI) untuk digunakan untuk permintaan ini.
- fileContent
-
Uint8Array
Konten file audio yang akan diterjemahkan.
- options
- GetAudioTranslationOptions
Opsi untuk permintaan terjemahan audio ini.
Mengembalikan
Promise<AudioResultSimpleJson>
Hasil terjemahan audio.
getAudioTranslation<Format>(string, Uint8Array, Format, GetAudioTranslationOptions)
Mengembalikan terjemahan file audio.
function getAudioTranslation<Format>(deploymentName: string, fileContent: Uint8Array, format: Format, options?: GetAudioTranslationOptions): Promise<AudioResult<Format>>Parameter
- deploymentName
-
string
Nama penyebaran model (saat menggunakan Azure OpenAI) atau nama model (saat menggunakan non-Azure OpenAI) untuk digunakan untuk permintaan ini.
- fileContent
-
Uint8Array
Konten file audio yang akan diterjemahkan.
- format
-
Format
Format objek hasil. Lihat AudioResultFormat untuk nilai yang mungkin.
- options
- GetAudioTranslationOptions
Opsi untuk permintaan terjemahan audio ini.
Mengembalikan
Promise<AudioResult<Format>>
Hasil terjemahan audio.
getChatCompletions(string, ChatRequestMessageUnion[], GetChatCompletionsOptions)
Mendapatkan penyelesaian obrolan untuk pesan obrolan yang disediakan. Penyelesaian mendukung berbagai tugas dan menghasilkan teks yang berlanjut dari atau "menyelesaikan" data prompt yang disediakan.
function getChatCompletions(deploymentName: string, messages: ChatRequestMessageUnion[], options?: GetChatCompletionsOptions): Promise<ChatCompletions>Parameter
- deploymentName
-
string
- messages
- options
- GetChatCompletionsOptions
Mengembalikan
Promise<ChatCompletions>
getCompletions(string, string[], GetCompletionsOptions)
Mendapatkan penyelesaian untuk perintah input yang disediakan. Penyelesaian mendukung berbagai tugas dan menghasilkan teks yang berlanjut dari atau "menyelesaikan" data prompt yang disediakan.
function getCompletions(deploymentName: string, prompt: string[], options?: GetCompletionsOptions): Promise<Completions>Parameter
- deploymentName
-
string
- prompt
-
string[]
- options
- GetCompletionsOptions
Mengembalikan
Promise<Completions>
getEmbeddings(string, string[], GetEmbeddingsOptions)
Mengembalikan penyematan untuk perintah tertentu.
function getEmbeddings(deploymentName: string, input: string[], options?: GetEmbeddingsOptions): Promise<Embeddings>Parameter
- deploymentName
-
string
- input
-
string[]
- options
- GetEmbeddingsOptions
Mengembalikan
Promise<Embeddings>
getImages(string, string, GetImagesOptions)
Membuat gambar yang diberikan perintah.
function getImages(deploymentName: string, prompt: string, options?: GetImagesOptions): Promise<ImageGenerations>Parameter
- deploymentName
-
string
- prompt
-
string
- options
- GetImagesOptions
Mengembalikan
Promise<ImageGenerations>
streamChatCompletions(string, ChatRequestMessageUnion[], GetChatCompletionsOptions)
Lists token penyelesaian obrolan saat tersedia untuk konteks obrolan.
function streamChatCompletions(deploymentName: string, messages: ChatRequestMessageUnion[], options?: GetChatCompletionsOptions): Promise<EventStream<ChatCompletions>>Parameter
- deploymentName
-
string
Nama penyebaran model (saat menggunakan Azure OpenAI) atau nama model (saat menggunakan non-Azure OpenAI) untuk digunakan untuk permintaan ini.
- messages
Pesan konteks obrolan yang digunakan untuk permintaan ini.
- options
- GetChatCompletionsOptions
Opsi penyelesaian obrolan untuk permintaan penyelesaian obrolan ini.
Mengembalikan
Promise<EventStream<ChatCompletions>>
Token penyelesaian obrolan yang dapat diulang secara asinkron.
streamCompletions(string, string[], GetCompletionsOptions)
Lists token penyelesaian saat tersedia untuk perintah tertentu.
function streamCompletions(deploymentName: string, prompt: string[], options?: GetCompletionsOptions): Promise<EventStream<Omit<Completions, "usage">>>Parameter
- deploymentName
-
string
Nama penyebaran model (saat menggunakan Azure OpenAI) atau nama model (saat menggunakan non-Azure OpenAI) untuk digunakan untuk permintaan ini.
- prompt
-
string[]
Perintah untuk digunakan untuk permintaan ini.
- options
- GetCompletionsOptions
Opsi penyelesaian untuk permintaan penyelesaian ini.
Mengembalikan
Promise<EventStream<Omit<Completions, "usage">>>
Iterasi asinkron dari token penyelesaian.
Azure SDK for JavaScript
Saran dan Komentar
Segera hadir: Sepanjang tahun 2024 kami akan menghentikan penggunaan GitHub Issues sebagai mekanisme umpan balik untuk konten dan menggantinya dengan sistem umpan balik baru. Untuk mengetahui informasi selengkapnya, lihat: https://aka.ms/ContentUserFeedback.
Kirim dan lihat umpan balik untuk