OpenAIClient class

Pakiet:

@azure/openai

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 zasobu OpenAI. Będą one znajdować się 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);

Konstruktory

OpenAIClient(KeyCredential, OpenAIClientOptions)	Inicjuje wystąpienie klasy OpenAIClient do użycia z punktem końcowym innej niż Azure OpenAI.
OpenAIClient(string, KeyCredential, OpenAIClientOptions)	Inicjuje wystąpienie klasy OpenAIClient do użycia z zasobem azure OpenAII.
OpenAIClient(string, TokenCredential, OpenAIClientOptions)	Inicjuje wystąpienie klasy OpenAIClient do użycia z zasobem azure OpenAII.

Metody

getAudioTranscription(string, Uint8Array, GetAudioTranscriptionOptions)	Zwraca transkrypcję pliku audio w prostym formacie JSON.
getAudioTranscription<Format>(string, Uint8Array, Format, GetAudioTranscriptionOptions)	Zwraca transkrypcję pliku audio.
getAudioTranslation(string, Uint8Array, GetAudioTranslationOptions)	Zwraca tłumaczenie pliku audio.
getAudioTranslation<Format>(string, Uint8Array, Format, GetAudioTranslationOptions)	Zwraca tłumaczenie pliku audio.
getChatCompletions(string, ChatRequestMessageUnion[], GetChatCompletionsOptions)	Pobiera uzupełnienia czatu dla podanych wiadomości czatu. Ukończenia obsługują szeroką gamę zadań i generują tekst, który będzie kontynuowany na podstawie lub "ukończonych" dostarczonych danych monitu.
getCompletions(string, string[], GetCompletionsOptions)	Pobiera uzupełnienia dla podanych monitów wejściowych. Ukończenia obsługują szeroką gamę zadań i generują tekst, który będzie kontynuowany na podstawie lub "ukończonych" dostarczonych danych monitu.
getEmbeddings(string, string[], GetEmbeddingsOptions)	Zwróć osadzanie dla danego monitu.
getImages(string, string, GetImagesOptions)	Tworzy obraz z monitem.
streamChatCompletions(string, ChatRequestMessageUnion[], GetChatCompletionsOptions)	Listy tokeny ukończenia czatu, gdy staną się one dostępne dla kontekstu czatu.
streamCompletions(string, string[], GetCompletionsOptions)	Listy tokeny uzupełniania, gdy staną się dostępne dla danego monitu.

Szczegóły konstruktora

OpenAIClient(KeyCredential, OpenAIClientOptions)

Inicjuje wystąpienie klasy OpenAIClient do użycia z punktem końcowym innej niż Azure OpenAI.

new OpenAIClient(openAiApiKey: KeyCredential, options?: OpenAIClientOptions)

Parametry

openAiApiKey

KeyCredential

Klucz interfejsu API do użycia podczas nawiązywania połączenia z punktem końcowym spoza usługi Azure OpenAI.

options

OpenAIClientOptions

Opcje konfigurowania klienta.

Uwagi

Obiekty OpenAIClient zainicjowane za pomocą tego konstruktora mogą być używane tylko z punktem końcowym wnioskowania inferencji platformy Azure. Aby użyć interfejsu OpenAIClient z zasobem usługi Azure OpenAI, użyj konstruktora, który zamiast tego akceptuje identyfikator URI zasobu i poświadczenia uwierzytelniania platformy Azure.

OpenAIClient(string, KeyCredential, OpenAIClientOptions)

Inicjuje wystąpienie klasy OpenAIClient do użycia z zasobem azure OpenAII.

new OpenAIClient(endpoint: string, credential: KeyCredential, options?: OpenAIClientOptions)

Parametry

endpoint

string

Identyfikator URI zasobu usługi Azure OpenAI, w tym protokół i nazwa hosta. Na przykład: https://my-resource.openai.azure.com.

credential

KeyCredential

Poświadczenia klucza używane do uwierzytelniania w zasobie usługi Azure OpenAI.

options

OpenAIClientOptions

Opcje konfigurowania klienta.

Uwagi

Ten konstruktor inicjuje obiekt OpenAIClient, który może być używany tylko z zasobami usługi Azure OpenAI. Aby użyć klasy OpenAIClient z punktem końcowym wnioskowania innego niż Azure OpenAI, użyj konstruktora, który zamiast tego akceptuje klucz interfejsu API innej niż Azure OpenAI.

OpenAIClient(string, TokenCredential, OpenAIClientOptions)

Inicjuje wystąpienie klasy OpenAIClient do użycia z zasobem azure OpenAII.

new OpenAIClient(endpoint: string, credential: TokenCredential, options?: OpenAIClientOptions)

Parametry

endpoint

string

Identyfikator URI zasobu usługi Azure OpenAI, w tym protokół i nazwa hosta. Na przykład: https://my-resource.openai.azure.com.

credential

TokenCredential

Poświadczenia tokenu używane do uwierzytelniania za pomocą zasobu usługi Azure OpenAI.

options

OpenAIClientOptions

Opcje konfigurowania klienta.

Szczegóły metody

getAudioTranscription(string, Uint8Array, GetAudioTranscriptionOptions)

Zwraca transkrypcję pliku audio w prostym formacie JSON.

function getAudioTranscription(deploymentName: string, fileContent: Uint8Array, options?: GetAudioTranscriptionOptions): Promise<AudioResultSimpleJson>

Parametry

deploymentName

string

Nazwa wdrożenia modelu (w przypadku korzystania z usługi Azure OpenAI) lub nazwy modelu (w przypadku używania spoza usługi Azure OpenAI) do użycia dla tego żądania.

fileContent

Uint8Array

Zawartość pliku audio do transkrypcji.

options

GetAudioTranscriptionOptions

Opcje tego żądania transkrypcji audio.

Zwraca

Promise<AudioResultSimpleJson>

Transkrypcja audio powoduje prosty format JSON.

getAudioTranscription<Format>(string, Uint8Array, Format, GetAudioTranscriptionOptions)

Zwraca transkrypcję pliku audio.

function getAudioTranscription<Format>(deploymentName: string, fileContent: Uint8Array, format: Format, options?: GetAudioTranscriptionOptions): Promise<AudioResult<Format>>

Parametry

deploymentName

string

Nazwa wdrożenia modelu (w przypadku korzystania z usługi Azure OpenAI) lub nazwy modelu (w przypadku używania spoza usługi Azure OpenAI) do użycia dla tego żądania.

fileContent

Uint8Array

Zawartość pliku audio do transkrypcji.

format

Format

Format obiektu wyniku. Aby uzyskać możliwe wartości, zobacz AudioResultFormat .

options

GetAudioTranscriptionOptions

Opcje tego żądania transkrypcji audio.

Zwraca

Promise<AudioResult<Format>>

Transkrypcja audio powoduje wybór formatu.

getAudioTranslation(string, Uint8Array, GetAudioTranslationOptions)

Zwraca tłumaczenie pliku audio.

function getAudioTranslation(deploymentName: string, fileContent: Uint8Array, options?: GetAudioTranslationOptions): Promise<AudioResultSimpleJson>

Parametry

deploymentName

string

Nazwa wdrożenia modelu (w przypadku korzystania z usługi Azure OpenAI) lub nazwy modelu (w przypadku używania spoza usługi Azure OpenAI) do użycia dla tego żądania.

fileContent

Uint8Array

Zawartość pliku audio do przetłumaczenia.

options

GetAudioTranslationOptions

Opcje tego żądania tłumaczenia audio.

Zwraca

Promise<AudioResultSimpleJson>

Wynik tłumaczenia audio.

getAudioTranslation<Format>(string, Uint8Array, Format, GetAudioTranslationOptions)

Zwraca tłumaczenie pliku audio.

function getAudioTranslation<Format>(deploymentName: string, fileContent: Uint8Array, format: Format, options?: GetAudioTranslationOptions): Promise<AudioResult<Format>>

Parametry

deploymentName

string

Nazwa wdrożenia modelu (w przypadku korzystania z usługi Azure OpenAI) lub nazwy modelu (w przypadku używania spoza usługi Azure OpenAI) do użycia dla tego żądania.

fileContent

Uint8Array

Zawartość pliku audio do przetłumaczenia.

format

Format

Format obiektu wyniku. Aby uzyskać możliwe wartości, zobacz AudioResultFormat .

options

GetAudioTranslationOptions

Opcje tego żądania tłumaczenia audio.

Zwraca

Promise<AudioResult<Format>>

Wynik tłumaczenia audio.

getChatCompletions(string, ChatRequestMessageUnion[], GetChatCompletionsOptions)

Pobiera uzupełnienia czatu dla podanych wiadomości czatu. Ukończenia obsługują szeroką gamę zadań i generują tekst, który będzie kontynuowany na podstawie lub "ukończonych" dostarczonych danych monitu.

function getChatCompletions(deploymentName: string, messages: ChatRequestMessageUnion[], options?: GetChatCompletionsOptions): Promise<ChatCompletions>

Parametry

deploymentName

string

messages

ChatRequestMessageUnion[]

options

GetChatCompletionsOptions

Zwraca

Promise<ChatCompletions>

getCompletions(string, string[], GetCompletionsOptions)

Pobiera uzupełnienia dla podanych monitów wejściowych. Ukończenia obsługują szeroką gamę zadań i generują tekst, który będzie kontynuowany na podstawie lub "ukończonych" dostarczonych danych monitu.

function getCompletions(deploymentName: string, prompt: string[], options?: GetCompletionsOptions): Promise<Completions>

Parametry

deploymentName

string

prompt

string[]

options

GetCompletionsOptions

Zwraca

Promise<Completions>

getEmbeddings(string, string[], GetEmbeddingsOptions)

Zwróć osadzanie dla danego monitu.

function getEmbeddings(deploymentName: string, input: string[], options?: GetEmbeddingsOptions): Promise<Embeddings>

Parametry

deploymentName

string

input

string[]

options

GetEmbeddingsOptions

Zwraca

Promise<Embeddings>

getImages(string, string, GetImagesOptions)

Tworzy obraz z monitem.

function getImages(deploymentName: string, prompt: string, options?: GetImagesOptions): Promise<ImageGenerations>

Parametry

deploymentName

string

prompt

string

options

GetImagesOptions

Zwraca

Promise<ImageGenerations>

streamChatCompletions(string, ChatRequestMessageUnion[], GetChatCompletionsOptions)

Listy tokeny ukończenia czatu, gdy staną się one dostępne dla kontekstu czatu.

function streamChatCompletions(deploymentName: string, messages: ChatRequestMessageUnion[], options?: GetChatCompletionsOptions): Promise<EventStream<ChatCompletions>>

Parametry

deploymentName

string

Nazwa wdrożenia modelu (w przypadku korzystania z usługi Azure OpenAI) lub nazwy modelu (w przypadku używania spoza usługi Azure OpenAI) do użycia dla tego żądania.

messages

ChatRequestMessageUnion[]

Wiadomości kontekstowe czatu do użycia dla tego żądania.

options

GetChatCompletionsOptions

Opcje ukończenia czatu dla tego żądania ukończenia czatu.

Zwraca

Promise<EventStream<ChatCompletions>>

Asynchroniczna iterowa liczba tokenów ukończenia czatu.

streamCompletions(string, string[], GetCompletionsOptions)

Listy tokeny uzupełniania, gdy staną się dostępne dla danego monitu.

function streamCompletions(deploymentName: string, prompt: string[], options?: GetCompletionsOptions): Promise<EventStream<Omit<Completions, "usage">>>

Parametry

deploymentName

string

Nazwa wdrożenia modelu (w przypadku korzystania z usługi Azure OpenAI) lub nazwy modelu (w przypadku używania spoza usługi Azure OpenAI) do użycia dla tego żądania.

prompt

string[]

Monit o użycie dla tego żądania.

options

GetCompletionsOptions

Opcje uzupełniania dla tego żądania ukończenia.

Zwraca

Promise<EventStream<Omit<Completions, "usage">>>

Asynchroniczna iterowa liczba tokenów uzupełniania.