Bibliothèque de client Azure OpenAI pour JavaScript - version 1.0.0-beta.12

Article
04/02/2024

La bibliothèque de client Azure OpenAI pour JavaScript est une adaptation des API REST d’OpenAI qui fournit une interface idiomatique et une intégration riche avec le reste de l’écosystème du KIT de développement logiciel (SDK) Azure. Il peut se connecter à des ressources Azure OpenAI ou au point de terminaison d’inférence OpenAI non Azure, ce qui en fait un excellent choix pour le développement même non Azure OpenAI.

Utilisez la bibliothèque cliente pour Azure OpenAI pour :

Azure OpenAI est un service managé qui permet aux développeurs de déployer, d’ajuster et de générer du contenu à partir de modèles OpenAI sur des ressources Azure.

Consultez les exemples suivants :

Saisies multiples
Chatbot
Résumer le texte
Utiliser les outils de conversation
Générer des images
Analyser les données métier
Transcrire et traduire des fichiers audio
Conversation avec des images à l’aide de gpt-4-vision-preview

Liens clés :

Prise en main

const { OpenAIClient, AzureKeyCredential } = require("@azure/openai");

const client = new OpenAIClient(
  "https://<resource name>.openai.azure.com/", 
  new AzureKeyCredential("<Azure API key>")
);
const { id, created, choices, usage } = await client.getCompletions("<deployment ID>", ["YOUR PROMPT HERE"]);

Environnements actuellement pris en charge

Versions LTS de Node.js
Dernières versions de Safari, Chrome, Edge et Firefox.

Prérequis

Si vous souhaitez utiliser une ressource Azure OpenAI, vous devez disposer d’un abonnement Azure et d’un accès Azure OpenAI. Cela vous permet de créer une ressource Azure OpenAI et d’obtenir à la fois une URL de connexion et des clés API. Pour plus d’informations, consultez Démarrage rapide : Prise en main de la génération de texte à l’aide d’Azure OpenAI Service.

Si vous souhaitez utiliser la bibliothèque de client JS Azure OpenAI pour vous connecter à des éléments non Azure OpenAI, vous aurez besoin d’une clé API à partir d’un compte de développeur à l’adresse https://platform.openai.com/.

Installez le package `@azure/openai`

Installez la bibliothèque cliente Azure OpenAI pour JavaScript avec npm:

npm install @azure/openai

Créez et authentifiez un`OpenAIClient`

Pour configurer un client à utiliser avec Azure OpenAI, fournissez un URI de point de terminaison valide à une ressource Azure OpenAI, ainsi qu’une clé d’identification, des informations d’identification de jeton ou des informations d’identification d’identité Azure autorisées à utiliser la ressource Azure OpenAI. Pour configurer le client pour qu’il se connecte au service d’OpenAI, fournissez une clé API à partir du portail des développeurs d’OpenAI.

Utilisation d’une clé API à partir d’Azure

Utilisez le portail Azure pour accéder à votre ressource OpenAI et récupérer une clé API, ou utilisez l’extrait de code Azure CLI ci-dessous :

Note: Parfois, la clé API est appelée « clé d’abonnement » ou « clé API d’abonnement ».

az cognitiveservices account keys list --resource-group <your-resource-group-name> --name <your-resource-name>

Une fois que vous avez une clé API et un point de terminaison, vous pouvez utiliser la AzureKeyCredential classe pour authentifier le client comme suit :

const { OpenAIClient, AzureKeyCredential } = require("@azure/openai");

const client = new OpenAIClient("<endpoint>", new AzureKeyCredential("<API key>"));

Utilisation d’informations d’identification Azure Active Directory

L’authentification par clé API cliente est utilisée dans la plupart des exemples, mais vous pouvez également vous authentifier auprès d’Azure Active Directory à l’aide de la bibliothèque Azure Identity. Pour utiliser le fournisseur DefaultAzureCredential indiqué ci-dessous ou d’autres fournisseurs d’informations d’identification fournis avec le kit de développement logiciel (SDK) Azure, installez le package @azure/identity :

npm install @azure/identity

Vous devrez également inscrire une nouvelle application AAD et accorder l’accès à OpenAI en attribuant le "Cognitive Services User" rôle à votre principal de service (remarque : d’autres rôles tels que n’accorderont "Owner" pas les autorisations nécessaires, suffiront uniquement "Cognitive Services User" pour exécuter les exemples et l’exemple de code).

Définissez les valeurs de l’ID client, de l’ID de locataire et de la clé secrète client de l’application AAD en tant que variables d’environnement : AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET.

const { OpenAIClient } = require("@azure/openai");
const { DefaultAzureCredential } = require("@azure/identity");

const client = new OpenAIClient("<endpoint>", new DefaultAzureCredential());

Utilisation d’une clé API d’OpenAI

Pour configurer le client pour qu’il se connecte au service d’OpenAI, fournissez une clé API à partir du portail des développeurs d’OpenAI. Une fois que vous avez une clé API, vous pouvez utiliser la OpenAIKeyCredential classe pour authentifier le client comme suit :

const { OpenAIClient, OpenAIKeyCredential } = require("@azure/openai");

const client = new OpenAIClient(new OpenAIKeyCredential("<API key>"));

Concepts clés

Le concept main à comprendre est Achèvements. Expliqué brièvement, les complétions fournissent ses fonctionnalités sous la forme d’une invite de texte, qui, à l’aide d’un modèle spécifique, tente ensuite de faire correspondre le contexte et les modèles, en fournissant un texte de sortie. L’extrait de code suivant fournit une vue d’ensemble approximative :

const { OpenAIClient, AzureKeyCredential } = require("@azure/openai");

async function main(){
  const client = new OpenAIClient(
  "https://your-azure-openai-resource.com/",
  new AzureKeyCredential("your-azure-openai-resource-api-key"));

  const { choices } = await client.getCompletions(
    "text-davinci-003", // assumes a matching model deployment or model name
    ["Hello, world!"]);

  for (const choice of choices) {
    console.log(choice.text);
  }
}

main().catch((err) => {
  console.error("The sample encountered an error:", err);
});

Exemples

Vous pouvez vous familiariser avec différentes API à l’aide d’exemples.

Générer une réponse de chatbot

Cet exemple s’authentifie à l’aide d’un defaultAzureCredential, puis génère des réponses de conversation pour entrer des questions et des messages de conversation.

const { OpenAIClient } = require("@azure/openai");
const { DefaultAzureCredential } = require("@azure/identity");

async function main(){
  const endpoint = "https://myaccount.openai.azure.com/";
  const client = new OpenAIClient(endpoint, new DefaultAzureCredential());

  const deploymentId = "gpt-35-turbo";

  const messages = [
    { role: "system", content: "You are a helpful assistant. You will talk like a pirate." },
    { role: "user", content: "Can you help me?" },
    { role: "assistant", content: "Arrrr! Of course, me hearty! What can I do for ye?" },
    { role: "user", content: "What's the best way to train a parrot?" },
  ];

  console.log(`Messages: ${messages.map((m) => m.content).join("\n")}`);

  const events = await client.streamChatCompletions(deploymentId, messages, { maxTokens: 128 });
  for await (const event of events) {
    for (const choice of event.choices) {
      const delta = choice.delta?.content;
      if (delta !== undefined) {
        console.log(`Chatbot: ${delta}`);
      }
    }
  }
}

main().catch((err) => {
  console.error("The sample encountered an error:", err);
});

Générer plusieurs saisies avec une clé d’abonnement

Cet exemple génère des réponses textuelles aux invites d’entrée à l’aide d’une clé d’abonnement Azure

const { OpenAIClient, AzureKeyCredential } = require("@azure/openai");

async function main(){
  // Replace with your Azure OpenAI key
  const key = "YOUR_AZURE_OPENAI_KEY";
  const endpoint = "https://myaccount.openai.azure.com/";
  const client = new OpenAIClient(endpoint, new AzureKeyCredential(key));

  const examplePrompts = [
    "How are you today?",
    "What is Azure OpenAI?",
    "Why do children love dinosaurs?",
    "Generate a proof of Euler's identity",
    "Describe in single words only the good things that come into your mind about your mother.",
  ];

  const deploymentName = "text-davinci-003";

  let promptIndex = 0;
  const { choices } = await client.getCompletions(deploymentName, examplePrompts);
  for (const choice of choices) {
    const completion = choice.text;
    console.log(`Input: ${examplePrompts[promptIndex++]}`);
    console.log(`Chatbot: ${completion}`);
  }
}

main().catch((err) => {
  console.error("The sample encountered an error:", err);
});

Résumer le texte avec la saisie semi-automatique

Cet exemple génère un résumé de l’invite d’entrée donnée.

const { OpenAIClient } = require("@azure/openai");
const { DefaultAzureCredential } = require("@azure/identity")

async function main(){
  const endpoint = "https://myaccount.openai.azure.com/";
  const client = new OpenAIClient(endpoint, new DefaultAzureCredential());

  const textToSummarize = `
    Two independent experiments reported their results this morning at CERN, Europe's high-energy physics laboratory near Geneva in Switzerland. Both show convincing evidence of a new boson particle weighing around 125 gigaelectronvolts, which so far fits predictions of the Higgs previously made by theoretical physicists.

    ""As a layman I would say: 'I think we have it'. Would you agree?"" Rolf-Dieter Heuer, CERN's director-general, asked the packed auditorium. The physicists assembled there burst into applause.
  :`;

  const summarizationPrompt = [`
    Summarize the following text.

    Text:
    """"""
    ${textToSummarize}
    """"""

    Summary:
  `];

  console.log(`Input: ${summarizationPrompt}`);

  const deploymentName = "text-davinci-003";

  const { choices } = await client.getCompletions(deploymentName, summarizationPrompt, {
    maxTokens: 64
  });
  const completion = choices[0].text;
  console.log(`Summarization: ${completion}`);
}

main().catch((err) => {
  console.error("The sample encountered an error:", err);
});

Utiliser les outils de conversation

Les outils étendent les achèvements de conversation en permettant à un assistant d’appeler des fonctions définies et d’autres fonctionnalités dans le processus de traitement d’une demande d’achèvement de conversation. Pour utiliser les outils de conversation, commencez par définir un outil de fonction :

const getCurrentWeather = {
    name: "get_current_weather",
    description: "Get the current weather in a given location",
    parameters: {
      type: "object",
      properties: {
        location: {
          type: "string",
          description: "The city and state, e.g. San Francisco, CA",
        },
        unit: {
          type: "string",
          enum: ["celsius", "fahrenheit"],
        },
      },
      required: ["location"],
    },
  };

Une fois l’outil défini, incluez cette nouvelle définition dans les options d’une demande de fin de conversation :

const deploymentName = "gpt-35-turbo-1106";
const messages = [{ role: "user", content: "What is the weather like in Boston?" }];
const options = {
    tools: [
      {
        type: "function",
        function: getCurrentWeather,
      },
    ],
  };
const events = client.getChatCompletions(deploymentId, messages, options);

Lorsque le assistant décide qu’un ou plusieurs outils doivent être utilisés, le message de réponse inclut un ou plusieurs « appels d’outils » qui doivent tous être résolus via des « messages d’outil » sur la demande suivante. Cette résolution des appels d’outils dans les nouveaux messages de requête peut être considérée comme une sorte de « rappel » pour les achèvements de conversation.

// Purely for convenience and clarity, this function handles tool call responses.
function applyToolCall({ function: call, id }) {
    if (call.name === "get_current_weather") {
      const { location, unit } = JSON.parse(call.arguments);
      // In a real application, this would be a call to a weather API with location and unit parameters
      return {
        role: "tool",
        content: `The weather in ${location} is 72 degrees ${unit} and sunny.`,
        toolCallId: id,
      }
    }
    throw new Error(`Unknown tool call: ${call.name}`);
}

Pour fournir des résolutions d’appel d’outils au assistant permettre à la demande de continuer, fournissez tous les contextes historiques antérieurs, y compris les messages système et utilisateur d’origine, la réponse du assistant qui comprenait les appels d’outils et les messages d’outil qui ont résolu chacun de ces outils , lors d’une demande suivante.

const choice = result.choices[0];
const responseMessage = choice.message;
if (responseMessage?.role === "assistant") {
  const requestedToolCalls = responseMessage?.toolCalls;
  if (requestedToolCalls?.length) {
    const toolCallResolutionMessages = [
      ...messages,
      responseMessage,
      ...requestedToolCalls.map(applyToolCall),
    ];
    const result = await client.getChatCompletions(deploymentName, toolCallResolutionMessages);
    // continue handling the response as normal
  }
}

Générer des images avec DALL-E modèles de génération d’images

Cet exemple génère des images de lot à partir d’une invite d’entrée donnée.

const { OpenAIClient, AzureKeyCredential } = require("@azure/openai");

async function main() {
  const endpoint = "https://myaccount.openai.azure.com/";
  const client = new OpenAIClient(endpoint, new AzureKeyCredential(azureApiKey));

  const deploymentName = "dalle-3";
  const prompt = "a monkey eating a banana";
  const size = "1024x1024";
  const n = 1;
  
  const results = await client.getImages(deploymentName, prompt, { n, size });

  for (const image of results.data) {
    console.log(`Image generation result URL: ${image.url}`);
  }
}

main().catch((err) => {
  console.error("The sample encountered an error:", err);
});

Analyser les données métier

Cet exemple génère des réponses de conversation pour entrer des questions de conversation sur vos données métier. Les données métier sont fournies par le biais d’un index Recherche cognitive Azure. Pour en savoir plus sur la configuration d’un index Recherche cognitive Azure en tant que source de données, consultez Démarrage rapide : Conversation avec des modèles Azure OpenAI à l’aide de vos propres données.

const { OpenAIClient } = require("@azure/openai");
const { DefaultAzureCredential } = require("@azure/identity");

async function main(){
  const endpoint = "https://myaccount.openai.azure.com/";
  const client = new OpenAIClient(endpoint, new DefaultAzureCredential());

  const deploymentId = "gpt-35-turbo";

  const messages = [
    { role: "user", content: "What's the most common customer feedback about our product?" },
  ];

  console.log(`Messages: ${messages.map((m) => m.content).join("\n")}`);

  const events = await client.streamChatCompletions(deploymentId, messages, { 
    maxTokens: 128,
    azureExtensionOptions: {
      extensions: [
        {
          type: "AzureCognitiveSearch",
          endpoint: "<Azure Cognitive Search endpoint>",
          key: "<Azure Cognitive Search admin key>",
          indexName: "<Azure Cognitive Search index name>",
        },
      ],
    },
  });
  for await (const event of events) {
    for (const choice of event.choices) {
      const delta = choice.delta?.content;
      if (delta !== undefined) {
        console.log(`Chatbot: ${delta}`);
      }
    }
  }
}

main().catch((err) => {
  console.error("The sample encountered an error:", err);
});

Transcrire et traduire des fichiers audio

Les fonctionnalités de reconnaissance vocale et de traduction d’Azure OpenAI peuvent être utilisées pour transcrire et traduire un large éventail de formats de fichiers audio. L’exemple suivant montre comment utiliser la getAudioTranscription méthode pour transcrire l’audio dans la langue dans laquelle se trouve l’audio. Vous pouvez également traduire et transcrire l’audio en anglais à l’aide de la getAudioTranslation méthode .

Le fichier audio peut être chargé en mémoire à l’aide des API de système de fichiers NodeJS. Dans le navigateur, le fichier peut être chargé à l’aide de l’API FileReader et la sortie de arrayBuffer instance méthode peut être passée à la getAudioTranscription méthode.

const { OpenAIClient, AzureKeyCredential } = require("@azure/openai");
const fs = require("fs/promises");

async function main() {
  console.log("== Transcribe Audio Sample ==");

  const client = new OpenAIClient(endpoint, new AzureKeyCredential(azureApiKey));
  const deploymentName = "whisper";
  const audio = await fs.readFile("< path to an audio file >");
  const result = await client.getAudioTranscription(deploymentName, audio);

  console.log(`Transcription: ${result.text}`);
}

main().catch((err) => {
  console.error("The sample encountered an error:", err);
});

Conversation avec des images à l’aide de gpt-4-vision-preview

Le gpt-4-vision-preview modèle vous permet d’utiliser des images comme composants d’entrée dans les achèvements de conversation.

Pour ce faire, fournissez des éléments de contenu distincts sur le ou les messages utilisateur pour la demande de fin de conversation :

const url = "https://upload.wikimedia.org/wikipedia/commons/thumb/d/dd/Gfp-wisconsin-madison-the-nature-boardwalk.jpg/2560px-Gfp-wisconsin-madison-the-nature-boardwalk.jpg",
const deploymentName = "gpt-4-1106-preview";
const messages: ChatRequestMessage[] = [{role: "user", content: [{
  type: "image_url",
  imageUrl: {
    url,
    detail: "auto"
  }
}]}];

Les achèvements de conversation se poursuivent ensuite comme d’habitude, bien que le modèle puisse signaler le plus informatif finish_details au lieu de finish_reason:

const result = await client.getChatCompletions(deploymentName, messages);
console.log(`Chatbot: ${result.choices[0].message?.content}`);

Résolution des problèmes

Journalisation

L’activation de la journalisation peut vous aider à mieux comprendre les échecs. Pour avoir un journal des requêtes et réponses HTTP, définissez la variable d’environnement AZURE_LOG_LEVEL sur info. Vous pouvez également activer la journalisation au moment de l’exécution en appelant setLogLevel dans @azure/logger :

const { setLogLevel } = require("@azure/logger");

setLogLevel("info");

Pour obtenir des instructions plus détaillées sur l’activation des journaux, consultez les documents relatifs au package @azure/logger.

Partager via

Bibliothèque de client Azure OpenAI pour JavaScript - version 1.0.0-beta.12

Prise en main

Environnements actuellement pris en charge

Prérequis

Installez le package `@azure/openai`

Créez et authentifiez un`OpenAIClient`

Utilisation d’une clé API à partir d’Azure

Utilisation d’informations d’identification Azure Active Directory

Utilisation d’une clé API d’OpenAI

Concepts clés

Exemples

Générer une réponse de chatbot

Générer plusieurs saisies avec une clé d’abonnement

Résumer le texte avec la saisie semi-automatique

Utiliser les outils de conversation

Générer des images avec DALL-E modèles de génération d’images

Analyser les données métier

Transcrire et traduire des fichiers audio

Conversation avec des images à l’aide de gpt-4-vision-preview

Résolution des problèmes

Journalisation

Ressources supplémentaires

Partager via

Bibliothèque de client Azure OpenAI pour JavaScript - version 1.0.0-beta.12

Prise en main

Environnements actuellement pris en charge

Prérequis

Installez le package @azure/openai

Créez et authentifiez unOpenAIClient

Utilisation d’une clé API à partir d’Azure

Utilisation d’informations d’identification Azure Active Directory

Utilisation d’une clé API d’OpenAI

Concepts clés

Exemples

Générer une réponse de chatbot

Générer plusieurs saisies avec une clé d’abonnement

Résumer le texte avec la saisie semi-automatique

Utiliser les outils de conversation

Générer des images avec DALL-E modèles de génération d’images

Analyser les données métier

Transcrire et traduire des fichiers audio

Conversation avec des images à l’aide de gpt-4-vision-preview

Résolution des problèmes

Journalisation

Ressources supplémentaires

Installez le package `@azure/openai`

Créez et authentifiez un`OpenAIClient`