Поделиться через


OpenAIClient class

Клиент для взаимодействия с Azure OpenAI.

Клиенту требуется конечная точка ресурса OpenAI и метод проверки подлинности, например ключ API или маркер. Ключ API и конечную точку можно найти на странице ресурсов OpenAI. Они будут расположены на странице "Ключи и конечная точка" ресурса.

Примеры проверки подлинности:

Ключ 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);

Конструкторы

OpenAIClient(KeyCredential, OpenAIClientOptions)

Инициализирует экземпляр OpenAIClient для использования с конечной точкой OpenAI, отличной от Azure.

OpenAIClient(string, KeyCredential, OpenAIClientOptions)

Инициализирует экземпляр OpenAIClient для использования с ресурсом Azure OpenAI.

OpenAIClient(string, TokenCredential, OpenAIClientOptions)

Инициализирует экземпляр OpenAIClient для использования с ресурсом Azure OpenAI.

Методы

getAudioTranscription(string, Uint8Array, GetAudioTranscriptionOptions)

Возвращает транскрибирование звукового файла в простом формате JSON.

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

Возвращает транскрибирование звукового файла.

getAudioTranslation(string, Uint8Array, GetAudioTranslationOptions)

Возвращает перевод звукового файла.

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

Возвращает перевод звукового файла.

getChatCompletions(string, ChatRequestMessageUnion[], GetChatCompletionsOptions)

Получает завершения чата для предоставленных сообщений чата. Завершения поддерживают широкий спектр задач и создают текст, который продолжается или "завершает" предоставленные данные запроса.

getCompletions(string, string[], GetCompletionsOptions)

Возвращает завершения для предоставленных входных запросов. Завершения поддерживают широкий спектр задач и создают текст, который продолжается или "завершает" предоставленные данные запроса.

getEmbeddings(string, string[], GetEmbeddingsOptions)

Возвращает встраивание для заданного запроса.

getImages(string, string, GetImagesOptions)

Создает образ в запросе.

streamChatCompletions(string, ChatRequestMessageUnion[], GetChatCompletionsOptions)

Списки маркеры завершения чата по мере их доступности для контекста чата.

streamCompletions(string, string[], GetCompletionsOptions)

Списки маркеры завершения по мере их доступности для заданного запроса.

Сведения о конструкторе

OpenAIClient(KeyCredential, OpenAIClientOptions)

Инициализирует экземпляр OpenAIClient для использования с конечной точкой OpenAI, отличной от Azure.

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

Параметры

openAiApiKey
KeyCredential

Ключ API, используемый при подключении к конечной точке OpenAI, отличной от Azure.

options
OpenAIClientOptions

Параметры для настройки клиента.

Комментарии

Объекты OpenAIClient, инициализированные с помощью этого конструктора, можно использовать только с конечной точкой вывода OpenAI, отличной от Azure. Чтобы использовать OpenAIClient с ресурсом Azure OpenAI, используйте конструктор, который принимает URI ресурса и учетные данные проверки подлинности Azure.

OpenAIClient(string, KeyCredential, OpenAIClientOptions)

Инициализирует экземпляр OpenAIClient для использования с ресурсом Azure OpenAI.

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

Параметры

endpoint

string

URI для ресурса Azure OpenAI, включая протокол и имя узла. Например: https://my-resource.openai.azure.com.

credential
KeyCredential

Учетные данные ключа, используемые для проверки подлинности в ресурсе Azure OpenAI.

options
OpenAIClientOptions

Параметры для настройки клиента.

Комментарии

Этот конструктор инициализирует объект OpenAIClient, который можно использовать только с ресурсами Azure OpenAI. Чтобы использовать OpenAIClient с конечной точкой вывода OpenAI, отличной от Azure, используйте конструктор, который принимает ключ API OpenAI, отличный от Azure.

OpenAIClient(string, TokenCredential, OpenAIClientOptions)

Инициализирует экземпляр OpenAIClient для использования с ресурсом Azure OpenAI.

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

Параметры

endpoint

string

URI для ресурса Azure OpenAI, включая протокол и имя узла. Например: https://my-resource.openai.azure.com.

credential
TokenCredential

Учетные данные маркера, используемые для проверки подлинности в ресурсе Azure OpenAI.

options
OpenAIClientOptions

Параметры для настройки клиента.

Сведения о методе

getAudioTranscription(string, Uint8Array, GetAudioTranscriptionOptions)

Возвращает транскрибирование звукового файла в простом формате JSON.

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

Параметры

deploymentName

string

Имя развертывания модели (при использовании Azure OpenAI) или имя модели (при использовании, отличной от Azure OpenAI), используемой для этого запроса.

fileContent

Uint8Array

Содержимое звукового файла для транскрибирования.

options
GetAudioTranscriptionOptions

Параметры для этого запроса на транскрибирование аудио.

Возвращаемое значение

Транскрибирование звука приводит к простому формату JSON.

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

Возвращает транскрибирование звукового файла.

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

Параметры

deploymentName

string

Имя развертывания модели (при использовании Azure OpenAI) или имя модели (при использовании, отличной от Azure OpenAI), используемой для этого запроса.

fileContent

Uint8Array

Содержимое звукового файла для транскрибирования.

format

Format

Формат результирующих объектов. Возможные значения см. в разделе AudioResultFormat .

options
GetAudioTranscriptionOptions

Параметры для этого запроса на транскрибирование аудио.

Возвращаемое значение

Promise<AudioResult<Format>>

Транскрибирование звука приводит к выбранному формату.

getAudioTranslation(string, Uint8Array, GetAudioTranslationOptions)

Возвращает перевод звукового файла.

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

Параметры

deploymentName

string

Имя развертывания модели (при использовании Azure OpenAI) или имя модели (при использовании, отличной от Azure OpenAI), используемой для этого запроса.

fileContent

Uint8Array

Содержимое звукового файла для перевода.

options
GetAudioTranslationOptions

Параметры для этого запроса на перевод звука.

Возвращаемое значение

Результат перевода звука.

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

Возвращает перевод звукового файла.

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

Параметры

deploymentName

string

Имя развертывания модели (при использовании Azure OpenAI) или имя модели (при использовании, отличной от Azure OpenAI), используемой для этого запроса.

fileContent

Uint8Array

Содержимое звукового файла для перевода.

format

Format

Формат результирующих объектов. Возможные значения см. в разделе AudioResultFormat .

options
GetAudioTranslationOptions

Параметры для этого запроса на перевод звука.

Возвращаемое значение

Promise<AudioResult<Format>>

Результат перевода звука.

getChatCompletions(string, ChatRequestMessageUnion[], GetChatCompletionsOptions)

Получает завершения чата для предоставленных сообщений чата. Завершения поддерживают широкий спектр задач и создают текст, который продолжается или "завершает" предоставленные данные запроса.

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

Параметры

deploymentName

string

Возвращаемое значение

Promise<ChatCompletions>

getCompletions(string, string[], GetCompletionsOptions)

Возвращает завершения для предоставленных входных запросов. Завершения поддерживают широкий спектр задач и создают текст, который продолжается или "завершает" предоставленные данные запроса.

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

Параметры

deploymentName

string

prompt

string[]

Возвращаемое значение

Promise<Completions>

getEmbeddings(string, string[], GetEmbeddingsOptions)

Возвращает встраивание для заданного запроса.

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

Параметры

deploymentName

string

input

string[]

Возвращаемое значение

Promise<Embeddings>

getImages(string, string, GetImagesOptions)

Создает образ в запросе.

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

Параметры

deploymentName

string

prompt

string

Возвращаемое значение

Promise<ImageGenerations>

streamChatCompletions(string, ChatRequestMessageUnion[], GetChatCompletionsOptions)

Списки маркеры завершения чата по мере их доступности для контекста чата.

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

Параметры

deploymentName

string

Имя развертывания модели (при использовании Azure OpenAI) или имя модели (при использовании, отличной от Azure OpenAI), используемой для этого запроса.

messages

ChatRequestMessageUnion[]

Сообщения контекста чата, используемые для этого запроса.

options
GetChatCompletionsOptions

Параметры завершения чата для этого запроса завершения чата.

Возвращаемое значение

Асинхронный итератор маркеров завершения чата.

streamCompletions(string, string[], GetCompletionsOptions)

Списки маркеры завершения по мере их доступности для заданного запроса.

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

Параметры

deploymentName

string

Имя развертывания модели (при использовании Azure OpenAI) или имя модели (при использовании, отличной от Azure OpenAI), используемой для этого запроса.

prompt

string[]

Запрос, используемый для этого запроса.

options
GetCompletionsOptions

Параметры завершения для этого запроса завершения.

Возвращаемое значение

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

Асинхронный итератор маркеров завершения.