OpenAIClient class
Un cliente para interactuar con Azure OpenAI.
El cliente necesita el punto de conexión de un recurso de OpenAI y un método de autenticación, como una clave de API o un token. La clave de API y el punto de conexión se pueden encontrar en la página de recursos de OpenAI. Se ubicarán en la página Claves y punto de conexión del recurso.
Ejemplos de autenticación:
Clave 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);
Constructores
Open |
Inicializa una instancia de OpenAIClient para su uso con el punto de conexión que no es de Azure OpenAI. |
Open |
Inicializa una instancia de OpenAIClient para su uso con un recurso de Azure OpenAI. |
Open |
Inicializa una instancia de OpenAIClient para su uso con un recurso de Azure OpenAI. |
Métodos
get |
Devuelve la transcripción de un archivo de audio en un formato JSON simple. |
get |
Devuelve la transcripción de un archivo de audio. |
get |
Devuelve la traducción de un archivo de audio. |
get |
Devuelve la traducción de un archivo de audio. |
get |
Obtiene finalizaciones de chat para los mensajes de chat proporcionados. Las finalizaciones admiten una amplia variedad de tareas y generan texto que continúa a partir de o "completa" datos de aviso proporcionados. |
get |
Obtiene las finalizaciones de los mensajes de entrada proporcionados. Las finalizaciones admiten una amplia variedad de tareas y generan texto que continúa a partir de o "completa" datos de aviso proporcionados. |
get |
Devuelve las incrustaciones de un mensaje determinado. |
get |
Crea una imagen dada una solicitud. |
stream |
Listas los tokens de finalizaciones de chat a medida que están disponibles para un contexto de chat. |
stream |
Listas los tokens de finalizaciones a medida que están disponibles para un aviso determinado. |
Detalles del constructor
OpenAIClient(KeyCredential, OpenAIClientOptions)
Inicializa una instancia de OpenAIClient para su uso con el punto de conexión que no es de Azure OpenAI.
new OpenAIClient(openAiApiKey: KeyCredential, options?: OpenAIClientOptions)
Parámetros
- openAiApiKey
- KeyCredential
Clave de API que se va a usar al conectarse al punto de conexión de OpenAI que no es de Azure.
- options
- OpenAIClientOptions
Las opciones para configurar el cliente.
Comentarios
Los objetos OpenAIClient inicializados con este constructor solo se pueden usar con el punto de conexión de inferencia de OpenAI que no es de Azure. Para usar OpenAIClient con un recurso de Azure OpenAI, use un constructor que acepte un URI de recurso y una credencial de autenticación de Azure en su lugar.
OpenAIClient(string, KeyCredential, OpenAIClientOptions)
Inicializa una instancia de OpenAIClient para su uso con un recurso de Azure OpenAI.
new OpenAIClient(endpoint: string, credential: KeyCredential, options?: OpenAIClientOptions)
Parámetros
- endpoint
-
string
El URI de un recurso de Azure OpenAI, incluido el protocolo y el nombre de host. Por ejemplo: https://my-resource.openai.azure.com.
- credential
- KeyCredential
Credencial de clave usada para autenticarse en un recurso de Azure OpenAI.
- options
- OpenAIClientOptions
Las opciones para configurar el cliente.
Comentarios
Este constructor inicializa un objeto OpenAIClient que solo se puede usar con recursos de Azure OpenAI. Para usar OpenAIClient con un punto de conexión de inferencia de OpenAI que no sea de Azure, use un constructor que acepte una clave de API de OpenAI que no sea de Azure.
OpenAIClient(string, TokenCredential, OpenAIClientOptions)
Inicializa una instancia de OpenAIClient para su uso con un recurso de Azure OpenAI.
new OpenAIClient(endpoint: string, credential: TokenCredential, options?: OpenAIClientOptions)
Parámetros
- endpoint
-
string
El URI de un recurso de Azure OpenAI, incluido el protocolo y el nombre de host. Por ejemplo: https://my-resource.openai.azure.com.
- credential
- TokenCredential
Credencial de token usada para autenticarse con un recurso de Azure OpenAI.
- options
- OpenAIClientOptions
Las opciones para configurar el cliente.
Detalles del método
getAudioTranscription(string, Uint8Array, GetAudioTranscriptionOptions)
Devuelve la transcripción de un archivo de audio en un formato JSON simple.
function getAudioTranscription(deploymentName: string, fileContent: Uint8Array, options?: GetAudioTranscriptionOptions): Promise<AudioResultSimpleJson>
Parámetros
- deploymentName
-
string
Nombre de la implementación del modelo (cuando se usa Azure OpenAI) o nombre del modelo (cuando se usa OpenAI que no es de Azure) para usar para esta solicitud.
- fileContent
-
Uint8Array
Contenido del archivo de audio que se va a transcribir.
- options
- GetAudioTranscriptionOptions
Las opciones de esta solicitud de transcripción de audio.
Devoluciones
Promise<AudioResultSimpleJson>
La transcripción de audio da como resultado un formato JSON simple.
getAudioTranscription<Format>(string, Uint8Array, Format, GetAudioTranscriptionOptions)
Devuelve la transcripción de un archivo de audio.
function getAudioTranscription<Format>(deploymentName: string, fileContent: Uint8Array, format: Format, options?: GetAudioTranscriptionOptions): Promise<AudioResult<Format>>
Parámetros
- deploymentName
-
string
Nombre de la implementación del modelo (cuando se usa Azure OpenAI) o nombre del modelo (cuando se usa OpenAI que no es de Azure) para usar para esta solicitud.
- fileContent
-
Uint8Array
Contenido del archivo de audio que se va a transcribir.
- format
-
Format
Formato del objeto de resultado. Consulte AudioResultFormat para conocer los valores posibles.
- options
- GetAudioTranscriptionOptions
Las opciones de esta solicitud de transcripción de audio.
Devoluciones
Promise<AudioResult<Format>>
La transcripción de audio da como resultado un formato de su elección.
getAudioTranslation(string, Uint8Array, GetAudioTranslationOptions)
Devuelve la traducción de un archivo de audio.
function getAudioTranslation(deploymentName: string, fileContent: Uint8Array, options?: GetAudioTranslationOptions): Promise<AudioResultSimpleJson>
Parámetros
- deploymentName
-
string
Nombre de la implementación del modelo (cuando se usa Azure OpenAI) o nombre del modelo (cuando se usa OpenAI que no es de Azure) para usar para esta solicitud.
- fileContent
-
Uint8Array
Contenido del archivo de audio que se va a traducir.
- options
- GetAudioTranslationOptions
Las opciones de esta solicitud de traducción de audio.
Devoluciones
Promise<AudioResultSimpleJson>
Resultado de la traducción de audio.
getAudioTranslation<Format>(string, Uint8Array, Format, GetAudioTranslationOptions)
Devuelve la traducción de un archivo de audio.
function getAudioTranslation<Format>(deploymentName: string, fileContent: Uint8Array, format: Format, options?: GetAudioTranslationOptions): Promise<AudioResult<Format>>
Parámetros
- deploymentName
-
string
Nombre de la implementación del modelo (cuando se usa Azure OpenAI) o nombre del modelo (cuando se usa OpenAI que no es de Azure) para usar para esta solicitud.
- fileContent
-
Uint8Array
Contenido del archivo de audio que se va a traducir.
- format
-
Format
Formato del objeto de resultado. Consulte AudioResultFormat para conocer los valores posibles.
- options
- GetAudioTranslationOptions
Las opciones de esta solicitud de traducción de audio.
Devoluciones
Promise<AudioResult<Format>>
Resultado de la traducción de audio.
getChatCompletions(string, ChatRequestMessageUnion[], GetChatCompletionsOptions)
Obtiene finalizaciones de chat para los mensajes de chat proporcionados. Las finalizaciones admiten una amplia variedad de tareas y generan texto que continúa a partir de o "completa" datos de aviso proporcionados.
function getChatCompletions(deploymentName: string, messages: ChatRequestMessageUnion[], options?: GetChatCompletionsOptions): Promise<ChatCompletions>
Parámetros
- deploymentName
-
string
- messages
- options
- GetChatCompletionsOptions
Devoluciones
Promise<ChatCompletions>
getCompletions(string, string[], GetCompletionsOptions)
Obtiene las finalizaciones de los mensajes de entrada proporcionados. Las finalizaciones admiten una amplia variedad de tareas y generan texto que continúa a partir de o "completa" datos de aviso proporcionados.
function getCompletions(deploymentName: string, prompt: string[], options?: GetCompletionsOptions): Promise<Completions>
Parámetros
- deploymentName
-
string
- prompt
-
string[]
- options
- GetCompletionsOptions
Devoluciones
Promise<Completions>
getEmbeddings(string, string[], GetEmbeddingsOptions)
Devuelve las incrustaciones de un mensaje determinado.
function getEmbeddings(deploymentName: string, input: string[], options?: GetEmbeddingsOptions): Promise<Embeddings>
Parámetros
- deploymentName
-
string
- input
-
string[]
- options
- GetEmbeddingsOptions
Devoluciones
Promise<Embeddings>
getImages(string, string, GetImagesOptions)
Crea una imagen dada una solicitud.
function getImages(deploymentName: string, prompt: string, options?: GetImagesOptions): Promise<ImageGenerations>
Parámetros
- deploymentName
-
string
- prompt
-
string
- options
- GetImagesOptions
Devoluciones
Promise<ImageGenerations>
streamChatCompletions(string, ChatRequestMessageUnion[], GetChatCompletionsOptions)
Listas los tokens de finalizaciones de chat a medida que están disponibles para un contexto de chat.
function streamChatCompletions(deploymentName: string, messages: ChatRequestMessageUnion[], options?: GetChatCompletionsOptions): Promise<EventStream<ChatCompletions>>
Parámetros
- deploymentName
-
string
Nombre de la implementación del modelo (cuando se usa Azure OpenAI) o nombre del modelo (cuando se usa OpenAI que no es de Azure) para usar para esta solicitud.
- messages
Los mensajes de contexto de chat que se van a usar para esta solicitud.
- options
- GetChatCompletionsOptions
Las opciones de finalizaciones de chat para esta solicitud de finalizaciones de chat.
Devoluciones
Promise<EventStream<ChatCompletions>>
Un iterable asincrónico de tokens de finalizaciones de chat.
streamCompletions(string, string[], GetCompletionsOptions)
Listas los tokens de finalizaciones a medida que están disponibles para un aviso determinado.
function streamCompletions(deploymentName: string, prompt: string[], options?: GetCompletionsOptions): Promise<EventStream<Omit<Completions, "usage">>>
Parámetros
- deploymentName
-
string
Nombre de la implementación del modelo (cuando se usa Azure OpenAI) o nombre del modelo (cuando se usa OpenAI que no es de Azure) para usar para esta solicitud.
- prompt
-
string[]
Solicitud que se va a usar para esta solicitud.
- options
- GetCompletionsOptions
Las opciones de finalización de esta solicitud de finalización.
Devoluciones
Promise<EventStream<Omit<Completions, "usage">>>
Iteración asincrónica de tokens de finalizaciones.
Azure SDK for JavaScript