OpenAIClient class
Um cliente para interagir com o OpenAI do Azure.
O cliente precisa do ponto de extremidade de um recurso OpenAI e de um método de autenticação, como uma chave de API ou um token. A chave de API e o ponto de extremidade podem ser encontrados na página de recursos do OpenAI. Eles estarão localizados na página Chaves e Ponto de Extremidade do recurso.
Exemplos de autenticação:
Chave de 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);
Construtores
| Open |
Inicializa uma instância do OpenAIClient para uso com o ponto de extremidade OpenAI não Azure. |
| Open |
Inicializa uma instância do OpenAIClient para uso com um recurso openAI do Azure. |
| Open |
Inicializa uma instância do OpenAIClient para uso com um recurso openAI do Azure. |
Métodos
| get |
Retorna a transcrição de um arquivo de áudio em um formato JSON simples. |
| get |
Retorna a transcrição de um arquivo de áudio. |
| get |
Retorna a tradução de um arquivo de áudio. |
| get |
Retorna a tradução de um arquivo de áudio. |
| get |
Obtém conclusões de chat para as mensagens de chat fornecidas. As conclusões dão suporte a uma ampla variedade de tarefas e geram texto que continua ou "conclui" dados de prompt fornecidos. |
| get |
Obtém conclusões para os prompts de entrada fornecidos. As conclusões dão suporte a uma ampla variedade de tarefas e geram texto que continua ou "conclui" dados de prompt fornecidos. |
| get |
Retorne as inserções para um determinado prompt. |
| get |
Cria uma imagem dada uma solicitação. |
| stream |
Listas os tokens de conclusão de chat à medida que ficam disponíveis para um contexto de chat. |
| stream |
Listas os tokens de conclusão conforme eles ficam disponíveis para um determinado prompt. |
Detalhes do construtor
OpenAIClient(KeyCredential, OpenAIClientOptions)
Inicializa uma instância do OpenAIClient para uso com o ponto de extremidade OpenAI não Azure.
new OpenAIClient(openAiApiKey: KeyCredential, options?: OpenAIClientOptions)Parâmetros
- openAiApiKey
- KeyCredential
A chave de API a ser usada ao se conectar ao ponto de extremidade openAI não Azure.
- options
- OpenAIClientOptions
As opções para configurar o cliente.
Comentários
Objetos OpenAIClient inicializados com esse construtor só podem ser usados com o ponto de extremidade de inferência OpenAI não Azure. Para usar o OpenAIClient com um recurso openAI do Azure, use um construtor que aceite um URI de recurso e uma credencial de autenticação do Azure.
OpenAIClient(string, KeyCredential, OpenAIClientOptions)
Inicializa uma instância do OpenAIClient para uso com um recurso openAI do Azure.
new OpenAIClient(endpoint: string, credential: KeyCredential, options?: OpenAIClientOptions)Parâmetros
- endpoint
-
string
O URI de um recurso openAI do Azure, incluindo o protocolo e o nome do host. Por exemplo: https://my-resource.openai.azure.com.
- credential
- KeyCredential
Uma credencial de chave usada para autenticar em um recurso do OpenAI do Azure.
- options
- OpenAIClientOptions
As opções para configurar o cliente.
Comentários
Esse construtor inicializa um objeto OpenAIClient que só pode ser usado com recursos do OpenAI do Azure. Para usar o OpenAIClient com um ponto de extremidade de inferência OpenAI não Azure, use um construtor que aceite uma chave de API OpenAI que não seja do Azure.
OpenAIClient(string, TokenCredential, OpenAIClientOptions)
Inicializa uma instância do OpenAIClient para uso com um recurso openAI do Azure.
new OpenAIClient(endpoint: string, credential: TokenCredential, options?: OpenAIClientOptions)Parâmetros
- endpoint
-
string
O URI de um recurso openAI do Azure, incluindo o protocolo e o nome do host. Por exemplo: https://my-resource.openai.azure.com.
- credential
- TokenCredential
Uma credencial de token usada para autenticar com um recurso openAI do Azure.
- options
- OpenAIClientOptions
As opções para configurar o cliente.
Detalhes do método
getAudioTranscription(string, Uint8Array, GetAudioTranscriptionOptions)
Retorna a transcrição de um arquivo de áudio em um formato JSON simples.
function getAudioTranscription(deploymentName: string, fileContent: Uint8Array, options?: GetAudioTranscriptionOptions): Promise<AudioResultSimpleJson>Parâmetros
- deploymentName
-
string
O nome da implantação do modelo (ao usar o OpenAI do Azure) ou o nome do modelo (ao usar o OpenAI não Azure) a ser usado para essa solicitação.
- fileContent
-
Uint8Array
O conteúdo do arquivo de áudio a ser transcrito.
- options
- GetAudioTranscriptionOptions
As opções para essa solicitação de transcrição de áudio.
Retornos
Promise<AudioResultSimpleJson>
A transcrição de áudio resulta em um formato JSON simples.
getAudioTranscription<Format>(string, Uint8Array, Format, GetAudioTranscriptionOptions)
Retorna a transcrição de um arquivo de áudio.
function getAudioTranscription<Format>(deploymentName: string, fileContent: Uint8Array, format: Format, options?: GetAudioTranscriptionOptions): Promise<AudioResult<Format>>Parâmetros
- deploymentName
-
string
O nome da implantação do modelo (ao usar o OpenAI do Azure) ou o nome do modelo (ao usar o OpenAI não Azure) a ser usado para essa solicitação.
- fileContent
-
Uint8Array
O conteúdo do arquivo de áudio a ser transcrito.
- format
-
Format
O formato do objeto de resultado. Consulte AudioResultFormat para obter valores possíveis.
- options
- GetAudioTranscriptionOptions
As opções para essa solicitação de transcrição de áudio.
Retornos
Promise<AudioResult<Format>>
A transcrição de áudio resulta em um formato de sua escolha.
getAudioTranslation(string, Uint8Array, GetAudioTranslationOptions)
Retorna a tradução de um arquivo de áudio.
function getAudioTranslation(deploymentName: string, fileContent: Uint8Array, options?: GetAudioTranslationOptions): Promise<AudioResultSimpleJson>Parâmetros
- deploymentName
-
string
O nome da implantação do modelo (ao usar o OpenAI do Azure) ou o nome do modelo (ao usar o OpenAI não Azure) a ser usado para essa solicitação.
- fileContent
-
Uint8Array
O conteúdo do arquivo de áudio a ser traduzido.
- options
- GetAudioTranslationOptions
As opções para esta solicitação de tradução de áudio.
Retornos
Promise<AudioResultSimpleJson>
O resultado da tradução de áudio.
getAudioTranslation<Format>(string, Uint8Array, Format, GetAudioTranslationOptions)
Retorna a tradução de um arquivo de áudio.
function getAudioTranslation<Format>(deploymentName: string, fileContent: Uint8Array, format: Format, options?: GetAudioTranslationOptions): Promise<AudioResult<Format>>Parâmetros
- deploymentName
-
string
O nome da implantação do modelo (ao usar o OpenAI do Azure) ou o nome do modelo (ao usar o OpenAI não Azure) a ser usado para essa solicitação.
- fileContent
-
Uint8Array
O conteúdo do arquivo de áudio a ser traduzido.
- format
-
Format
O formato do objeto de resultado. Consulte AudioResultFormat para obter valores possíveis.
- options
- GetAudioTranslationOptions
As opções para esta solicitação de tradução de áudio.
Retornos
Promise<AudioResult<Format>>
O resultado da tradução de áudio.
getChatCompletions(string, ChatRequestMessageUnion[], GetChatCompletionsOptions)
Obtém conclusões de chat para as mensagens de chat fornecidas. As conclusões dão suporte a uma ampla variedade de tarefas e geram texto que continua ou "conclui" dados de prompt fornecidos.
function getChatCompletions(deploymentName: string, messages: ChatRequestMessageUnion[], options?: GetChatCompletionsOptions): Promise<ChatCompletions>Parâmetros
- deploymentName
-
string
- messages
- options
- GetChatCompletionsOptions
Retornos
Promise<ChatCompletions>
getCompletions(string, string[], GetCompletionsOptions)
Obtém conclusões para os prompts de entrada fornecidos. As conclusões dão suporte a uma ampla variedade de tarefas e geram texto que continua ou "conclui" dados de prompt fornecidos.
function getCompletions(deploymentName: string, prompt: string[], options?: GetCompletionsOptions): Promise<Completions>Parâmetros
- deploymentName
-
string
- prompt
-
string[]
- options
- GetCompletionsOptions
Retornos
Promise<Completions>
getEmbeddings(string, string[], GetEmbeddingsOptions)
Retorne as inserções para um determinado prompt.
function getEmbeddings(deploymentName: string, input: string[], options?: GetEmbeddingsOptions): Promise<Embeddings>Parâmetros
- deploymentName
-
string
- input
-
string[]
- options
- GetEmbeddingsOptions
Retornos
Promise<Embeddings>
getImages(string, string, GetImagesOptions)
Cria uma imagem dada uma solicitação.
function getImages(deploymentName: string, prompt: string, options?: GetImagesOptions): Promise<ImageGenerations>Parâmetros
- deploymentName
-
string
- prompt
-
string
- options
- GetImagesOptions
Retornos
Promise<ImageGenerations>
streamChatCompletions(string, ChatRequestMessageUnion[], GetChatCompletionsOptions)
Listas os tokens de conclusão de chat à medida que ficam disponíveis para um contexto de chat.
function streamChatCompletions(deploymentName: string, messages: ChatRequestMessageUnion[], options?: GetChatCompletionsOptions): Promise<EventStream<ChatCompletions>>Parâmetros
- deploymentName
-
string
O nome da implantação do modelo (ao usar o OpenAI do Azure) ou o nome do modelo (ao usar o OpenAI não Azure) a ser usado para essa solicitação.
- messages
As mensagens de contexto de chat a serem usadas para essa solicitação.
- options
- GetChatCompletionsOptions
As opções de conclusão de chat para esta solicitação de conclusões de chat.
Retornos
Promise<EventStream<ChatCompletions>>
Um iterável assíncrono de tokens de conclusão de chat.
streamCompletions(string, string[], GetCompletionsOptions)
Listas os tokens de conclusão conforme eles ficam disponíveis para um determinado prompt.
function streamCompletions(deploymentName: string, prompt: string[], options?: GetCompletionsOptions): Promise<EventStream<Omit<Completions, "usage">>>Parâmetros
- deploymentName
-
string
O nome da implantação do modelo (ao usar o OpenAI do Azure) ou o nome do modelo (ao usar o OpenAI não Azure) a ser usado para essa solicitação.
- prompt
-
string[]
O prompt a ser usado para essa solicitação.
- options
- GetCompletionsOptions
As opções de conclusão para essa solicitação de conclusão.
Retornos
Promise<EventStream<Omit<Completions, "usage">>>
Um iterável assíncrono de tokens de conclusão.
Azure SDK for JavaScript