OpenAIClient class
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é 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);
Constructeurs
| Open |
Initialise une instance d’OpenAIClient pour une utilisation avec le point de terminaison OpenAI non Azure. |
| Open |
Initialise une instance d’OpenAIClient pour une utilisation avec une ressource Azure OpenAI. |
| Open |
Initialise une instance d’OpenAIClient pour une utilisation avec une ressource Azure OpenAI. |
Méthodes
| get |
Retourne la transcription d’un fichier audio dans un format JSON simple. |
| get |
Retourne la transcription d’un fichier audio. |
| get |
Retourne la traduction d’un fichier audio. |
| get |
Retourne la traduction d’un fichier audio. |
| get |
Obtient les achèvements de conversation pour les messages de conversation fournis. 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. |
| get |
Obtient les achèvements pour les invites d’entrée fournies. 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. |
| get |
Retourne les incorporations pour une invite donnée. |
| get |
Crée une image à l’invite. |
| stream |
Listes les jetons de fin de conversation à mesure qu’ils deviennent disponibles pour un contexte de conversation. |
| stream |
Listes les jetons d’achèvement à mesure qu’ils deviennent disponibles pour une invite donnée. |
Détails du constructeur
OpenAIClient(KeyCredential, OpenAIClientOptions)
Initialise une instance d’OpenAIClient pour une utilisation avec le point de terminaison OpenAI non Azure.
new OpenAIClient(openAiApiKey: KeyCredential, options?: OpenAIClientOptions)Paramètres
- openAiApiKey
- KeyCredential
Clé API à utiliser lors de la connexion au point de terminaison OpenAI non Azure.
- options
- OpenAIClientOptions
Options de configuration du client.
Remarques
Les objets OpenAIClient initialisés avec ce constructeur ne peuvent être utilisés qu’avec le point de terminaison d’inférence OpenAI non Azure. Pour utiliser OpenAIClient avec une ressource Azure OpenAI, utilisez un constructeur qui accepte plutôt un URI de ressource et des informations d’identification d’authentification Azure.
OpenAIClient(string, KeyCredential, OpenAIClientOptions)
Initialise une instance d’OpenAIClient pour une utilisation avec une ressource Azure OpenAI.
new OpenAIClient(endpoint: string, credential: KeyCredential, options?: OpenAIClientOptions)Paramètres
- endpoint
-
string
URI d’une ressource Azure OpenAI, y compris le protocole et le nom d’hôte. Par exemple : https://my-resource.openai.azure.com.
- credential
- KeyCredential
Informations d’identification de clé utilisées pour l’authentification auprès d’une ressource Azure OpenAI.
- options
- OpenAIClientOptions
Options de configuration du client.
Remarques
Ce constructeur initialise un objet OpenAIClient qui ne peut être utilisé qu’avec des ressources Azure OpenAI. Pour utiliser OpenAIClient avec un point de terminaison d’inférence Non-Azure OpenAI, utilisez un constructeur qui accepte une clé API OpenAI non Azure à la place.
OpenAIClient(string, TokenCredential, OpenAIClientOptions)
Initialise une instance d’OpenAIClient pour une utilisation avec une ressource Azure OpenAI.
new OpenAIClient(endpoint: string, credential: TokenCredential, options?: OpenAIClientOptions)Paramètres
- endpoint
-
string
URI d’une ressource Azure OpenAI, y compris le protocole et le nom d’hôte. Par exemple : https://my-resource.openai.azure.com.
- credential
- TokenCredential
Informations d’identification de jeton utilisées pour l’authentification auprès d’une ressource Azure OpenAI.
- options
- OpenAIClientOptions
Options de configuration du client.
Détails de la méthode
getAudioTranscription(string, Uint8Array, GetAudioTranscriptionOptions)
Retourne la transcription d’un fichier audio dans un format JSON simple.
function getAudioTranscription(deploymentName: string, fileContent: Uint8Array, options?: GetAudioTranscriptionOptions): Promise<AudioResultSimpleJson>Paramètres
- deploymentName
-
string
Nom du déploiement du modèle (lors de l’utilisation d’Azure OpenAI) ou nom du modèle (lors de l’utilisation de non-Azure OpenAI) à utiliser pour cette demande.
- fileContent
-
Uint8Array
Contenu du fichier audio à transcrire.
- options
- GetAudioTranscriptionOptions
Options pour cette demande de transcription audio.
Retours
Promise<AudioResultSimpleJson>
La transcription audio se traduit par un format JSON simple.
getAudioTranscription<Format>(string, Uint8Array, Format, GetAudioTranscriptionOptions)
Retourne la transcription d’un fichier audio.
function getAudioTranscription<Format>(deploymentName: string, fileContent: Uint8Array, format: Format, options?: GetAudioTranscriptionOptions): Promise<AudioResult<Format>>Paramètres
- deploymentName
-
string
Nom du déploiement du modèle (lors de l’utilisation d’Azure OpenAI) ou nom du modèle (lors de l’utilisation de non-Azure OpenAI) à utiliser pour cette demande.
- fileContent
-
Uint8Array
Contenu du fichier audio à transcrire.
- format
-
Format
Format de l’objet de résultat. Pour connaître les valeurs possibles, consultez AudioResultFormat .
- options
- GetAudioTranscriptionOptions
Options pour cette demande de transcription audio.
Retours
Promise<AudioResult<Format>>
La transcription audio aboutissent au format de votre choix.
getAudioTranslation(string, Uint8Array, GetAudioTranslationOptions)
Retourne la traduction d’un fichier audio.
function getAudioTranslation(deploymentName: string, fileContent: Uint8Array, options?: GetAudioTranslationOptions): Promise<AudioResultSimpleJson>Paramètres
- deploymentName
-
string
Nom du déploiement du modèle (lors de l’utilisation d’Azure OpenAI) ou nom du modèle (lors de l’utilisation de non-Azure OpenAI) à utiliser pour cette demande.
- fileContent
-
Uint8Array
Contenu du fichier audio à traduire.
- options
- GetAudioTranslationOptions
Options de cette demande de traduction audio.
Retours
Promise<AudioResultSimpleJson>
Résultat de la traduction audio.
getAudioTranslation<Format>(string, Uint8Array, Format, GetAudioTranslationOptions)
Retourne la traduction d’un fichier audio.
function getAudioTranslation<Format>(deploymentName: string, fileContent: Uint8Array, format: Format, options?: GetAudioTranslationOptions): Promise<AudioResult<Format>>Paramètres
- deploymentName
-
string
Nom du déploiement du modèle (lors de l’utilisation d’Azure OpenAI) ou nom du modèle (lors de l’utilisation de non-Azure OpenAI) à utiliser pour cette demande.
- fileContent
-
Uint8Array
Contenu du fichier audio à traduire.
- format
-
Format
Format de l’objet de résultat. Pour connaître les valeurs possibles, consultez AudioResultFormat .
- options
- GetAudioTranslationOptions
Options de cette demande de traduction audio.
Retours
Promise<AudioResult<Format>>
Résultat de la traduction audio.
getChatCompletions(string, ChatRequestMessageUnion[], GetChatCompletionsOptions)
Obtient les achèvements de conversation pour les messages de conversation fournis. 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.
function getChatCompletions(deploymentName: string, messages: ChatRequestMessageUnion[], options?: GetChatCompletionsOptions): Promise<ChatCompletions>Paramètres
- deploymentName
-
string
- messages
- options
- GetChatCompletionsOptions
Retours
Promise<ChatCompletions>
getCompletions(string, string[], GetCompletionsOptions)
Obtient les achèvements pour les invites d’entrée fournies. 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.
function getCompletions(deploymentName: string, prompt: string[], options?: GetCompletionsOptions): Promise<Completions>Paramètres
- deploymentName
-
string
- prompt
-
string[]
- options
- GetCompletionsOptions
Retours
Promise<Completions>
getEmbeddings(string, string[], GetEmbeddingsOptions)
Retourne les incorporations pour une invite donnée.
function getEmbeddings(deploymentName: string, input: string[], options?: GetEmbeddingsOptions): Promise<Embeddings>Paramètres
- deploymentName
-
string
- input
-
string[]
- options
- GetEmbeddingsOptions
Retours
Promise<Embeddings>
getImages(string, string, GetImagesOptions)
Crée une image à l’invite.
function getImages(deploymentName: string, prompt: string, options?: GetImagesOptions): Promise<ImageGenerations>Paramètres
- deploymentName
-
string
- prompt
-
string
- options
- GetImagesOptions
Retours
Promise<ImageGenerations>
streamChatCompletions(string, ChatRequestMessageUnion[], GetChatCompletionsOptions)
Listes les jetons de fin de conversation à mesure qu’ils deviennent disponibles pour un contexte de conversation.
function streamChatCompletions(deploymentName: string, messages: ChatRequestMessageUnion[], options?: GetChatCompletionsOptions): Promise<EventStream<ChatCompletions>>Paramètres
- deploymentName
-
string
Nom du déploiement du modèle (lors de l’utilisation d’Azure OpenAI) ou nom du modèle (lors de l’utilisation de non-Azure OpenAI) à utiliser pour cette demande.
- messages
Messages de contexte de conversation à utiliser pour cette demande.
- options
- GetChatCompletionsOptions
Options d’achèvement de conversation pour cette demande d’achèvement de conversation.
Retours
Promise<EventStream<ChatCompletions>>
Un itérable asynchrone des jetons d’achèvement de conversation.
streamCompletions(string, string[], GetCompletionsOptions)
Listes les jetons d’achèvement à mesure qu’ils deviennent disponibles pour une invite donnée.
function streamCompletions(deploymentName: string, prompt: string[], options?: GetCompletionsOptions): Promise<EventStream<Omit<Completions, "usage">>>Paramètres
- deploymentName
-
string
Nom du déploiement du modèle (lors de l’utilisation d’Azure OpenAI) ou nom du modèle (lors de l’utilisation de non-Azure OpenAI) à utiliser pour cette demande.
- prompt
-
string[]
Invite à utiliser pour cette demande.
- options
- GetCompletionsOptions
Options de saisie semi-automatique pour cette demande d’achèvement.
Retours
Promise<EventStream<Omit<Completions, "usage">>>
Itérable asynchrone de jetons d’achèvement.
Azure SDK for JavaScript
Commentaires
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultez https://aka.ms/ContentUserFeedback.
Envoyer et afficher des commentaires pour