@azure/openai package

Referencia

Clases

Una credencial basada en clave estática que admite la actualización del valor de clave subyacente.

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);

OpenAIKeyCredential

La clase OpenAIKeyCredential representa una clave de API de OpenAI y se usa para autenticarse en un cliente de OpenAI para un punto de conexión de OpenAI.

Interfaces

AudioResultSimpleJson	Respuesta de transcripción sencilla
AudioResultVerboseJson	Respuesta de transcripción.
AudioSegment	Segmento de transcripción.
AzureChatEnhancementConfiguration	Representación de las configuraciones de mejoras de Azure OpenAI disponibles.
AzureChatEnhancements	Representa los resultados de salida de las mejoras de Azure para las finalizaciones de chat, tal y como se configura a través de la entrada coincidente proporcionada en la solicitud.
AzureChatExtensionConfiguration	Representación de los datos de configuración para una única extensión de chat de Azure OpenAI. Esto se usará mediante una solicitud de finalizaciones de chat que debe usar extensiones de chat de Azure OpenAI para aumentar el comportamiento de respuesta. El uso de esta configuración solo es compatible con Azure OpenAI.
AzureChatExtensionDataSourceResponseCitation	Una única instancia de información de contexto adicional disponible cuando las extensiones de chat de Azure OpenAI intervienen en la generación de una respuesta de finalizaciones de chat correspondiente. Esta información de contexto solo se rellena cuando se usa una solicitud de Azure OpenAI configurada para usar una extensión coincidente.
AzureChatExtensionsMessageContext	Representación de la información de contexto adicional disponible cuando las extensiones de chat de Azure OpenAI participan en la generación de una respuesta de finalizaciones de chat correspondiente. Esta información de contexto solo se rellena cuando se usa una solicitud de Azure OpenAI configurada para usar una extensión coincidente.
AzureChatGroundingEnhancementConfiguration	Representación de las opciones disponibles para la mejora de la base de Azure OpenAI.
AzureChatOCREnhancementConfiguration	Representación de las opciones disponibles para la mejora del reconocimiento óptico de caracteres (OCR) de Azure OpenAI.
AzureCosmosDBChatExtensionConfiguration	Representación específica de opciones configurables para Azure Cosmos DB cuando se usa como una extensión de chat de Azure OpenAI.
AzureCosmosDBFieldMappingOptions	Opciones opcionales para controlar cómo se procesan los campos cuando se usa un recurso de Azure Cosmos DB configurado.
AzureExtensionsOptions	Opciones para las extensiones de chat de Azure OpenAI.
AzureGroundingEnhancement	Mejora de la base que devuelve el rectángulo delimitador de los objetos detectados en la imagen.
AzureGroundingEnhancementCoordinatePoint	Representación de un único punto de polígono tal y como lo usa la mejora de la base de Azure.
AzureGroundingEnhancementLine	Objeto de línea de contenido que consta de una secuencia adyacente de elementos de contenido, como palabras y marcas de selección.
AzureGroundingEnhancementLineSpan	Objeto span que representa un objeto detectado y su información de cuadro de límite.
AzureMachineLearningIndexChatExtensionConfiguration	Representación específica de opciones configurables para el índice vectorial de Azure Machine Learning cuando se usa como una extensión de chat de Azure OpenAI.
AzureSearchChatExtensionConfiguration	Representación específica de opciones configurables para Azure Búsqueda cuando se usa como una extensión de chat de Azure OpenAI.
AzureSearchIndexFieldMappingOptions	Opciones opcionales para controlar cómo se procesan los campos al usar un recurso de Azure Búsqueda configurado.
ChatChoice	Representación de una única finalización de solicitud como parte de una solicitud general de finalización de chat. Por lo general, `n` las opciones se generan por mensaje proporcionado con un valor predeterminado de 1. Los límites de token y otras opciones pueden limitar el número de opciones generadas.
ChatChoiceLogProbabilityInfo	Registre la información de probabilidad de una opción, tal como se solicita a través de "logprobs" y "top_logprobs".
ChatCompletions	Representación de los datos de respuesta de una solicitud de finalización de chat. Las finalizaciones admiten una amplia variedad de tareas y generan texto que continúa a partir de o "completa" datos de aviso proporcionados.
ChatCompletionsFunctionToolCall	Una llamada de herramienta a una herramienta de función, emitida por el modelo en evaluación de una herramienta de función configurada, que representa una invocación de función necesaria para que se resuelva una solicitud de finalización de chat posterior.
ChatCompletionsFunctionToolDefinition	La información de definición de una herramienta de función de finalizaciones de chat que puede llamar a una función en respuesta a una llamada de herramienta.
ChatCompletionsFunctionToolSelection	Una selección de herramientas de una herramienta específica con nombre que limitará las finalizaciones de chat al uso de la función con nombre.
ChatCompletionsJsonResponseFormat	Formato de respuesta para finalizaciones de chat que restringe las respuestas a la emisión de objetos JSON válidos.
ChatCompletionsNamedFunctionToolSelection	Una selección de herramientas de una herramienta específica con nombre que limitará las finalizaciones de chat al uso de la función con nombre.
ChatCompletionsNamedToolSelection	Representación abstracta de una selección de herramientas explícita y con nombre que se usará para una solicitud de finalización de chat.
ChatCompletionsResponseFormat	Representación abstracta de una configuración de formato de respuesta utilizable por finalizaciones de chat. Se puede usar para habilitar el modo JSON.
ChatCompletionsTextResponseFormat	El formato de respuesta de finalizaciones de chat estándar que puede generar texto libremente y no se garantiza que genere contenido de respuesta que se ajuste a un esquema específico.
ChatCompletionsToolCall	Representación abstracta de una llamada a herramienta que se debe resolver en una solicitud posterior para realizar la finalización del chat solicitada.
ChatCompletionsToolDefinition	Representación abstracta de una herramienta que el modelo puede usar para mejorar una respuesta de finalizaciones de chat.
ChatFinishDetails	Representación abstracta de información estructurada sobre por qué una respuesta de finalizaciones de chat finalizó.
ChatMessageContentItem	Representación abstracta de un elemento de contenido estructurado dentro de un mensaje de chat.
ChatMessageImageContentItem	Elemento de contenido de chat estructurado que contiene una referencia de imagen.
ChatMessageImageUrl	Una ubicación de Internet desde la que el modelo puede recuperar una imagen.
ChatMessageTextContentItem	Elemento de contenido de chat estructurado que contiene texto sin formato.
ChatRequestAssistantMessage	Mensaje de chat de solicitud que representa la respuesta o acción del asistente.
ChatRequestFunctionMessage	Mensaje de chat de solicitud que representa la salida solicitada de una función configurada.
ChatRequestMessage	Representación abstracta de un mensaje de chat tal como se proporciona en una solicitud.
ChatRequestSystemMessage	Mensaje de chat de solicitud que contiene instrucciones del sistema que influyen en cómo el modelo generará una respuesta de finalizaciones de chat.
ChatRequestToolMessage	Mensaje de chat de solicitud que representa la salida solicitada de una herramienta configurada.
ChatRequestUserMessage	Mensaje de chat de solicitud que representa la entrada del usuario en el asistente.
ChatResponseMessage	Representación de un mensaje de chat tal como se recibió en una respuesta.
ChatTokenLogProbabilityInfo	Representación de la información de probabilidad de registro para un único token de contenido de mensaje.
ChatTokenLogProbabilityResult	Representación de la información de probabilidad de registro para un único token de contenido, incluida una lista de tokens más probables si se solicitó "top_logprobs".
Choice	Representación de una única finalización de solicitud como parte de una solicitud de finalización general. Por lo general, `n` las opciones se generan por mensaje proporcionado con un valor predeterminado de 1. Los límites de token y otras opciones pueden limitar el número de opciones generadas.
Completions	Representación de los datos de respuesta a partir de una solicitud de finalización. Las finalizaciones admiten una amplia variedad de tareas y generan texto que continúa a partir de o "completa" datos de aviso proporcionados.
CompletionsLogProbabilityModel	Representación de un modelo de probabilidades de registro para una generación de finalizaciones.
CompletionsUsage	Representación de los recuentos de tokens procesados para una solicitud de finalización. Los recuentos tienen en cuenta todos los tokens en mensajes, opciones, alternativas de elección, generaciones de best_of y otros consumidores.
ContentFilterBlocklistIdResult	Representa el resultado de una evaluación en una lista de bloques personalizada, tal y como se realiza mediante el filtrado de contenido.
ContentFilterCitedDetectionResult	Representa el resultado de una operación de detección en los recursos protegidos, tal como se realiza mediante el filtrado de contenido.
ContentFilterDetectionResult	Representa el resultado de una operación de detección realizada por el filtrado de contenido.
ContentFilterErrorResults	Información sobre el resultado del error de filtrado de contenido.
ContentFilterResult	Información sobre el nivel de gravedad del contenido filtrado y si se ha filtrado o no.
ContentFilterResultsForPrompt	Resultados de filtrado de contenido para un único mensaje en la solicitud.
ContentFilterSuccessResultDetailsForPrompt	Información sobre el resultado correcto del filtrado de contenido.
ContentFilterSuccessResultsForChoice	Información sobre el filtrado de contenido evaluado con respecto a la salida del modelo generado.
ElasticsearchChatExtensionConfiguration	Representación específica de opciones configurables para Elasticsearch cuando se usa como una extensión de chat de Azure OpenAI.
ElasticsearchIndexFieldMappingOptions	Opciones opcionales para controlar cómo se procesan los campos al usar un recurso de Elasticsearch® configurado.
EmbeddingItem	Representación de una sola comparación de la relación de incrustaciones.
Embeddings	Representación de los datos de respuesta de una solicitud de inserción. Las incrustaciones miden la relación de las cadenas de texto y se usan normalmente para la búsqueda, agrupación en clústeres, recomendaciones y otros escenarios similares.
EmbeddingsUsage	Medición de la cantidad de tokens usados en esta solicitud y respuesta.
EventStream	Secuencia legible que se puede iterable y descartable.
FunctionCall	Nombre y argumentos de una función a la que se debe llamar, según lo generado por el modelo.
FunctionDefinition	La definición de una función especificada por el autor de la llamada que las finalizaciones de chat pueden invocar en respuesta a la entrada del usuario coincidente.
FunctionName	Estructura que especifica el nombre exacto de una función específica proporcionada por la solicitud que se usará al procesar una operación de finalización de chat.
GetAudioTranscriptionOptions	Las opciones de una solicitud de transcripción de audio
GetAudioTranslationOptions	Las opciones de una solicitud de traducción de audio
GetChatCompletionsOptions	Este módulo contiene modelos que queremos vivir en paralelo con los modelos generados correspondientes. Esto resulta útil para proporcionar modelos orientados al cliente que tienen nombres o tipos diferentes a los modelos generados.
GetCompletionsOptions	Información de configuración de una solicitud de finalización. Las finalizaciones admiten una amplia variedad de tareas y generan texto que continúa a partir de o "completa" datos de aviso proporcionados.
GetEmbeddingsOptions	Opciones para la solicitud de incrustaciones personalizadas
GetImagesOptions	Representa los datos de solicitud usados para generar imágenes.
ImageGenerationContentFilterResults	Describe el resultado del filtrado de contenido para la solicitud de generación de imágenes.
ImageGenerationData	Representación de una sola imagen generada, proporcionada como datos codificados en base64 o como una dirección URL desde la que se puede recuperar la imagen.
ImageGenerationPromptFilterResults	Describe los resultados del filtrado de contenido para la solicitud de generación de imágenes.
ImageGenerations	Resultado de una operación correcta de generación de imágenes.
MaxTokensFinishDetails	Representación estructurada de una razón de detención que indica que se alcanzó un límite de tokens antes de que el modelo se completara de forma natural.
OnYourDataAccessTokenAuthenticationOptions	Las opciones de autenticación de Azure OpenAI en los datos al usar el token de acceso.
OnYourDataApiKeyAuthenticationOptions	Las opciones de autenticación de Azure OpenAI en los datos al usar una clave de API.
OnYourDataAuthenticationOptions	Las opciones de autenticación de Azure OpenAI en los datos.
OnYourDataConnectionStringAuthenticationOptions	Las opciones de autenticación de Azure OpenAI en los datos al usar una cadena de conexión.
OnYourDataDeploymentNameVectorizationSource	Los detalles de un origen de vectorización, que usa Azure OpenAI en los datos al aplicar la búsqueda de vectores, que se basa en un nombre de implementación de modelo de incrustaciones interna en el mismo recurso de Azure OpenAI.
OnYourDataEncodedApiKeyAuthenticationOptions	Las opciones de autenticación de Azure OpenAI en los datos al usar una clave de API codificada en Elasticsearch.
OnYourDataEndpointVectorizationSource	Los detalles de un origen de vectorización, que usa Azure OpenAI en los datos al aplicar la búsqueda de vectores, que se basa en una llamada pública de punto de conexión de Azure OpenAI para insertar.
OnYourDataKeyAndKeyIdAuthenticationOptions	Las opciones de autenticación de Azure OpenAI en los datos al usar un par de claves e identificadores de clave elástica.
OnYourDataModelIdVectorizationSource	Los detalles de un origen de vectorización, que usa Azure OpenAI en los datos al aplicar la búsqueda de vectores, que se basa en un identificador de modelo de servicio de búsqueda. Actualmente solo es compatible con Elasticsearch®.
OnYourDataSystemAssignedManagedIdentityAuthenticationOptions	Las opciones de autenticación de Azure OpenAI en los datos al usar una identidad administrada asignada por el sistema.
OnYourDataUserAssignedManagedIdentityAuthenticationOptions	Las opciones de autenticación de Azure OpenAI en los datos al usar una identidad administrada asignada por el usuario.
OnYourDataVectorizationSource	Representación abstracta de un origen de vectorización para Azure OpenAI en los datos con búsqueda vectorial.
OpenAIClientOptions
PineconeChatExtensionConfiguration	Representación específica de las opciones configurables para Pinecone cuando se usa como una extensión de chat de Azure OpenAI.
PineconeFieldMappingOptions	Opciones opcionales para controlar cómo se procesan los campos al usar un recurso Pinecone configurado.
StopFinishDetails	Representación estructurada de una razón de detención que significa la terminación natural por parte del modelo.

Alias de tipos

AudioResult	Tipo del resultado de la transcripción en función del formato de respuesta solicitado.
AudioResultFormat	Formato de resultado de una tarea de audio
AudioTranscriptionTask	"transcribir", "traducir"
AzureChatExtensionConfigurationUnion	Alias para AzureChatExtensionConfigurationUnion
AzureChatExtensionType	"azure_search", "azure_ml_index", "azure_cosmos_db", "elasticsearch", "pinecone"
AzureSearchQueryType	"simple", "semantic", "vector", "vector_simple_hybrid", "vector_semantic_hybrid"
ChatCompletionsNamedToolSelectionUnion	Alias para ChatCompletionsNamedToolSelectionUnion
ChatCompletionsResponseFormatUnion	Alias para ChatCompletionsResponseFormatUnion
ChatCompletionsToolCallUnion	Alias para ChatCompletionsToolCallUnion
ChatCompletionsToolDefinitionUnion	Alias para ChatCompletionsToolDefinitionUnion
ChatCompletionsToolSelectionPreset	"auto", "none"
ChatFinishDetailsUnion	Alias para ChatFinishDetailsUnion
ChatMessageContentItemUnion	Alias para ChatMessageContentItemUnion
ChatMessageImageDetailLevel	"auto", "low", "high"
ChatRequestMessageUnion	Alias para ChatRequestMessageUnion
ChatRole	"system", "asistente", "user", "function", "tool"
CompletionsFinishReason	"stop", "length", "content_filter", "function_call", "tool_calls"
ContentFilterResultDetailsForPrompt	Información sobre la categoría de filtrado de contenido, si se ha detectado.
ContentFilterResultsForChoice	Información sobre los resultados de filtrado de contenido, si se ha detectado.
ContentFilterSeverity	"safe", "low", "medium", "high"
ElasticsearchQueryType	"simple", "vector"
FunctionCallPreset	"auto", "none"
ImageGenerationQuality	"standard", "hd"
ImageGenerationResponseFormat	"url", "b64_json"
ImageGenerationStyle	"natural", "vivo"
ImageSize	"256x256", "512x512", "1024x1024", "1792x1024", "1024x1792"
OnYourDataAuthenticationOptionsUnion	Alias para OnYourDataAuthenticationOptionsUnion
OnYourDataAuthenticationType	"api_key", "connection_string", "key_and_key_id", "encoded_api_key", "access_token", "system_assigned_managed_identity", "user_assigned_managed_identity"
OnYourDataVectorizationSourceType	"endpoint", "deployment_name", "model_id"
OnYourDataVectorizationSourceUnion	Alias para OnYourDataVectorizationSourceUnion

Compartir a través de