@azure/openai package

Référence

Classes

Informations d’identification basées sur une clé statique qui prend en charge la mise à jour de la valeur de clé sous-jacente.

OpenAIClient

Un client pour interagir avec Azure OpenAI.

Le client a besoin du point de terminaison d’une ressource OpenAI et d’une méthode d’authentification telle qu’une clé ou un jeton API. La clé d’API et le point de terminaison se trouvent dans la page de ressources OpenAI. Ils se trouvent dans la page Clés et point de terminaison de la ressource.

Exemples d’authentification :

Clé d’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 classe OpenAIKeyCredential représente une clé API OpenAI et est utilisée pour s’authentifier dans un client OpenAI pour un point de terminaison OpenAI.

Interfaces

AudioResultSimpleJson	Réponse de transcription simple
AudioResultVerboseJson	Réponse de transcription.
AudioSegment	Segment de transcription.
AzureChatEnhancementConfiguration	Représentation des configurations d’amélioration Azure OpenAI disponibles.
AzureChatEnhancements	Représente les résultats de sortie des améliorations d’Azure apportées aux achèvements de conversation, tels que configurés via l’entrée correspondante fournie dans la demande.
AzureChatExtensionConfiguration	Représentation des données de configuration pour une seule extension de conversation Azure OpenAI. Cela sera utilisé par une demande de complétion de conversation qui doit utiliser des extensions de conversation Azure OpenAI pour augmenter le comportement de la réponse. L’utilisation de cette configuration est uniquement compatible avec Azure OpenAI.
AzureChatExtensionDataSourceResponseCitation	Une seule instance d’informations de contexte supplémentaires disponibles lorsque les extensions de conversation Azure OpenAI sont impliquées dans la génération d’une réponse de saisie semi-automatique de conversation correspondante. Ces informations de contexte sont renseignées uniquement lors de l’utilisation d’une demande Azure OpenAI configurée pour utiliser une extension correspondante.
AzureChatExtensionsMessageContext	Représentation des informations de contexte supplémentaires disponibles lorsque les extensions de conversation Azure OpenAI sont impliquées dans la génération d’une réponse de saisie semi-automatique de conversation correspondante. Ces informations de contexte sont renseignées uniquement lors de l’utilisation d’une demande Azure OpenAI configurée pour utiliser une extension correspondante.
AzureChatGroundingEnhancementConfiguration	Représentation des options disponibles pour l’amélioration de la base d’Azure OpenAI.
AzureChatOCREnhancementConfiguration	Représentation des options disponibles pour l’amélioration de la reconnaissance optique de caractères (OCR) Azure OpenAI.
AzureCosmosDBChatExtensionConfiguration	Représentation spécifique des options configurables pour Azure Cosmos DB lors de son utilisation en tant qu’extension de conversation Azure OpenAI.
AzureCosmosDBFieldMappingOptions	Paramètres facultatifs pour contrôler la façon dont les champs sont traités lors de l’utilisation d’une ressource Azure Cosmos DB configurée.
AzureExtensionsOptions	Options pour les extensions de conversation Azure OpenAI.
AzureGroundingEnhancement	Amélioration de la mise à la base qui retourne le cadre englobant des objets détectés dans l’image.
AzureGroundingEnhancementCoordinatePoint	Représentation d’un point de polygone unique tel qu’utilisé par l’amélioration de la mise à l’terre Azure.
AzureGroundingEnhancementLine	Objet de ligne de contenu constitué d’une séquence adjacente d’éléments de contenu, tels que des mots et des marques de sélection.
AzureGroundingEnhancementLineSpan	Objet span qui représente un objet détecté et ses informations de cadre englobant.
AzureMachineLearningIndexChatExtensionConfiguration	Représentation spécifique des options configurables pour l’index vectoriel Azure Machine Learning lors de son utilisation en tant qu’extension de conversation Azure OpenAI.
AzureSearchChatExtensionConfiguration	Représentation spécifique des options configurables pour Azure Recherche lors de son utilisation en tant qu’extension de conversation Azure OpenAI.
AzureSearchIndexFieldMappingOptions	Paramètres facultatifs pour contrôler la façon dont les champs sont traités lors de l’utilisation d’une ressource Azure Recherche configurée.
ChatChoice	Représentation d’une saisie semi-automatique d’invite unique dans le cadre d’une demande de complétion de conversation globale. En règle générale, `n` les choix sont générés par invite fournie avec une valeur par défaut de 1. Les limites de jetons et d’autres paramètres peuvent limiter le nombre de choix générés.
ChatChoiceLogProbabilityInfo	Informations de probabilité de journal pour un choix, comme demandé via « logprobs » et « top_logprobs ».
ChatCompletions	Représentation des données de réponse d’une demande de complétion de conversation. Les complétions prennent en charge un large éventail de tâches et génèrent du texte qui continue à partir ou « termine » les données d’invite fournies.
ChatCompletionsFunctionToolCall	Appel d’outil à un outil de fonction, émis par le modèle dans l’évaluation d’un outil de fonction configuré, qui représente un appel de fonction nécessaire à la résolution d’une demande d’achèvement de conversation ultérieure.
ChatCompletionsFunctionToolDefinition	Informations de définition d’un outil de fonction de saisie semi-automatique de conversation qui peut appeler une fonction en réponse à un appel d’outil.
ChatCompletionsFunctionToolSelection	Sélection d’outil d’un outil de fonction nommé spécifique qui limite les achèvements de conversation à l’utilisation de la fonction nommée.
ChatCompletionsJsonResponseFormat	Format de réponse pour les achèvements de conversation qui limite les réponses à l’émission d’objets JSON valides.
ChatCompletionsNamedFunctionToolSelection	Sélection d’outil d’un outil de fonction nommé spécifique qui limite les achèvements de conversation à l’utilisation de la fonction nommée.
ChatCompletionsNamedToolSelection	Représentation abstraite d’une sélection explicite et nommée d’outil à utiliser pour une demande d’achèvement de conversation.
ChatCompletionsResponseFormat	Représentation abstraite d’une configuration de format de réponse utilisable par les achèvements de conversation. Peut être utilisé pour activer le mode JSON.
ChatCompletionsTextResponseFormat	Format de réponse de saisie semi-automatique de conversation standard qui peut générer librement du texte et qui n’est pas garanti pour produire un contenu de réponse conforme à un schéma spécifique.
ChatCompletionsToolCall	Représentation abstraite d’un appel d’outil qui doit être résolu dans une demande ultérieure pour effectuer l’achèvement de la conversation demandée.
ChatCompletionsToolDefinition	Représentation abstraite d’un outil qui peut être utilisé par le modèle pour améliorer une réponse de fin de conversation.
ChatFinishDetails	Représentation abstraite d’informations structurées sur la raison pour laquelle une réponse d’achèvement de conversation s’est terminée.
ChatMessageContentItem	Représentation abstraite d’un élément de contenu structuré dans un message de conversation.
ChatMessageImageContentItem	Élément de contenu de conversation structuré contenant une référence d’image.
ChatMessageImageUrl	Emplacement Internet à partir duquel le modèle peut récupérer une image.
ChatMessageTextContentItem	Élément de contenu de conversation structuré contenant du texte brut.
ChatRequestAssistantMessage	Message de conversation de demande représentant la réponse ou l’action du assistant.
ChatRequestFunctionMessage	Message de conversation de demande représentant la sortie demandée d’une fonction configurée.
ChatRequestMessage	Représentation abstraite d’un message de conversation fournie dans une demande.
ChatRequestSystemMessage	Message de conversation de demande contenant des instructions système qui influencent la façon dont le modèle génère une réponse de fin de conversation.
ChatRequestToolMessage	Message de conversation de demande représentant la sortie demandée à partir d’un outil configuré.
ChatRequestUserMessage	Message de conversation de demande représentant l’entrée utilisateur dans le assistant.
ChatResponseMessage	Représentation d’un message de conversation tel qu’il a été reçu dans une réponse.
ChatTokenLogProbabilityInfo	Représentation des informations de probabilité de journal pour un jeton de contenu de message unique.
ChatTokenLogProbabilityResult	Représentation des informations de probabilité de journal pour un jeton de contenu unique, y compris une liste de jetons les plus probables si des « top_logprobs » ont été demandés.
Choice	Représentation d’une saisie semi-automatique à une seule invite dans le cadre d’une demande de saisie semi-automatique globale. En règle générale, `n` les choix sont générés par invite fournie avec une valeur par défaut de 1. Les limites de jetons et d’autres paramètres peuvent limiter le nombre de choix générés.
Completions	Représentation des données de réponse d’une demande d’achèvement. Les complétions prennent en charge un large éventail de tâches et génèrent du texte qui continue à partir ou « termine » les données d’invite fournies.
CompletionsLogProbabilityModel	Représentation d’un modèle de probabilités de journal pour une génération d’achèvements.
CompletionsUsage	Représentation des nombres de jetons traités pour une demande d’achèvement. Les nombres prennent en compte tous les jetons dans les invites, les choix, les alternatives de choix, les générations best_of et d’autres consommateurs.
ContentFilterBlocklistIdResult	Représente le résultat d’une évaluation par rapport à une liste de blocage personnalisée, telle qu’elle est effectuée par le filtrage de contenu.
ContentFilterCitedDetectionResult	Représente le résultat d’une opération de détection sur des ressources protégées, comme effectué par le filtrage de contenu.
ContentFilterDetectionResult	Représente le résultat d’une opération de détection effectuée par le filtrage de contenu.
ContentFilterErrorResults	Informations sur le résultat de l’erreur de filtrage de contenu.
ContentFilterResult	Informations sur le niveau de gravité du contenu filtré et s’il a été filtré ou non.
ContentFilterResultsForPrompt	Résultats du filtrage du contenu pour une seule invite dans la demande.
ContentFilterSuccessResultDetailsForPrompt	Informations sur le résultat de réussite du filtrage de contenu.
ContentFilterSuccessResultsForChoice	Informations sur le filtrage du contenu évalué par rapport à la sortie du modèle généré.
ElasticsearchChatExtensionConfiguration	Représentation spécifique des options configurables pour Elasticsearch lors de son utilisation en tant qu’extension de conversation Azure OpenAI.
ElasticsearchIndexFieldMappingOptions	Paramètres facultatifs pour contrôler la façon dont les champs sont traités lors de l’utilisation d’une ressource Elasticsearch® configurée.
EmbeddingItem	Représentation d’une comparaison de la relation d’incorporations uniques.
Embeddings	Représentation des données de réponse d’une demande d’incorporations. Les incorporations mesurent la relation entre les chaînes de texte et sont couramment utilisées pour la recherche, les clustering, les recommandations et d’autres scénarios similaires.
EmbeddingsUsage	Mesure de la quantité de jetons utilisés dans cette demande et cette réponse.
EventStream	Flux lisible, itérable et jetable.
FunctionCall	Nom et arguments d’une fonction qui doit être appelée, comme généré par le modèle.
FunctionDefinition	Définition d’une fonction spécifiée par l’appelant que les complétions de conversation peuvent appeler en réponse à une entrée utilisateur correspondante.
FunctionName	Structure qui spécifie le nom exact d’une fonction spécifique fournie par la demande à utiliser lors du traitement d’une opération de fin de conversation.
GetAudioTranscriptionOptions	Options pour une demande de transcription audio
GetAudioTranslationOptions	Options pour une demande de traduction audio
GetChatCompletionsOptions	Ce module contient des modèles que nous voulons vivre côte à côte avec les modèles générés correspondants. Cela est utile pour fournir des modèles orientés client qui ont des noms/types différents des modèles générés.
GetCompletionsOptions	Informations de configuration pour une demande d’achèvement. Les complétions prennent en charge une grande variété de tâches et génèrent du texte qui continue à partir ou « termine » les données d’invite fournies.
GetEmbeddingsOptions	Options pour la demande d’incorporations personnalisées
GetImagesOptions	Représente les données de requête utilisées pour générer des images.
ImageGenerationContentFilterResults	Décrit le résultat du filtrage de contenu pour la demande de génération d’images.
ImageGenerationData	Représentation d’une image générée unique, fournie sous forme de données encodées en base64 ou d’URL à partir de laquelle l’image peut être récupérée.
ImageGenerationPromptFilterResults	Décrit les résultats du filtrage de contenu pour l’invite d’une demande de génération d’image.
ImageGenerations	Résultat d’une opération de génération d’image réussie.
MaxTokensFinishDetails	Une représentation structurée d’une raison d’arrêt qui signifie qu’une limite de jeton a été atteinte avant que le modèle puisse naturellement se terminer.
OnYourDataAccessTokenAuthenticationOptions	Options d’authentification pour Azure OpenAI sur vos données lors de l’utilisation d’un jeton d’accès.
OnYourDataApiKeyAuthenticationOptions	Options d’authentification pour Azure OpenAI sur vos données lors de l’utilisation d’une clé API.
OnYourDataAuthenticationOptions	Options d’authentification pour Azure OpenAI sur vos données.
OnYourDataConnectionStringAuthenticationOptions	Options d’authentification pour Azure OpenAI sur vos données lors de l’utilisation d’un chaîne de connexion.
OnYourDataDeploymentNameVectorizationSource	Détails d’une source de vectorisation, utilisée par Azure OpenAI On Your Data lors de l’application de la recherche vectorielle, basée sur un nom de déploiement de modèle d’incorporation interne dans la même ressource Azure OpenAI.
OnYourDataEncodedApiKeyAuthenticationOptions	Options d’authentification pour Azure OpenAI Sur vos données lors de l’utilisation d’une clé API encodée Elasticsearch.
OnYourDataEndpointVectorizationSource	Détails d’une source de vectorisation, utilisée par Azure OpenAI On Your Data lors de l’application de la recherche vectorielle, basée sur un appel de point de terminaison Azure OpenAI public pour les incorporations.
OnYourDataKeyAndKeyIdAuthenticationOptions	Options d’authentification pour Azure OpenAI Sur vos données lors de l’utilisation d’une clé Elasticsearch et d’une paire d’ID de clé.
OnYourDataModelIdVectorizationSource	Détails d’une source de vectorisation, utilisée par Azure OpenAI Sur vos données lors de l’application de la recherche vectorielle, basées sur un ID de modèle de service de recherche. Actuellement pris en charge uniquement par Elasticsearch®.
OnYourDataSystemAssignedManagedIdentityAuthenticationOptions	Options d’authentification pour Azure OpenAI Sur vos données lors de l’utilisation d’une identité managée affectée par le système.
OnYourDataUserAssignedManagedIdentityAuthenticationOptions	Options d’authentification pour Azure OpenAI Sur vos données lors de l’utilisation d’une identité managée affectée par l’utilisateur.
OnYourDataVectorizationSource	Représentation abstraite d’une source de vectorisation pour Azure OpenAI Sur vos données avec recherche vectorielle.
OpenAIClientOptions
PineconeChatExtensionConfiguration	Représentation spécifique des options configurables pour Pinecone lors de son utilisation en tant qu’extension de conversation Azure OpenAI.
PineconeFieldMappingOptions	Paramètres facultatifs pour contrôler le traitement des champs lors de l’utilisation d’une ressource Pinecone configurée.
StopFinishDetails	Représentation structurée d’une raison d’arrêt qui signifie l’arrêt naturel par le modèle.

Alias de type

AudioResult	Type du résultat de la transcription en fonction du format de réponse demandé
AudioResultFormat	Format de résultat d’une tâche audio
AudioTranscriptionTask	« transscribe », « translate »
AzureChatExtensionConfigurationUnion	Alias pour AzureChatExtensionConfigurationUnion
AzureChatExtensionType	« azure_search », « azure_ml_index », « azure_cosmos_db », « elasticsearch », « pinecone »
AzureSearchQueryType	« simple », « semantic », « vector », « vector_simple_hybrid », « vector_semantic_hybrid »
ChatCompletionsNamedToolSelectionUnion	Alias pour ChatCompletionsNamedToolSelectionUnion
ChatCompletionsResponseFormatUnion	Alias pour ChatCompletionsResponseFormatUnion
ChatCompletionsToolCallUnion	Alias pour ChatCompletionsToolCallUnion
ChatCompletionsToolDefinitionUnion	Alias pour ChatCompletionsToolDefinitionUnion
ChatCompletionsToolSelectionPreset	« auto », « none »
ChatFinishDetailsUnion	Alias pour ChatFinishDetailsUnion
ChatMessageContentItemUnion	Alias pour ChatMessageContentItemUnion
ChatMessageImageDetailLevel	« auto », « low », « high »
ChatRequestMessageUnion	Alias pour ChatRequestMessageUnion
ChatRole	« system », « assistant », « user », « function », « tool »
CompletionsFinishReason	« stop », « length », « content_filter », « function_call », « tool_calls »
ContentFilterResultDetailsForPrompt	Informations sur la catégorie de filtrage de contenu, si elle a été détectée.
ContentFilterResultsForChoice	Informations sur les résultats du filtrage de contenu, si elles ont été détectées.
ContentFilterSeverity	« safe », « low », « medium », « high »
ElasticsearchQueryType	« simple », « vector »
FunctionCallPreset	« auto », « none »
ImageGenerationQuality	« standard », « hd »
ImageGenerationResponseFormat	« url », « b64_json »
ImageGenerationStyle	« natural », « vivid »
ImageSize	« 256x256 », « 512x512 », « 1024x1024 », « 1792x1024 », « 1024x1792 »
OnYourDataAuthenticationOptionsUnion	Alias pour 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 pour OnYourDataVectorizationSourceUnion

Partager via