Azure AI Discovery client library for JavaScript - version 1.0.0

Ce paquet contient un SDK isomorphe (exécuté à la fois dans Node.js et dans les navigateurs) pour le service Azure AI Discovery.

La bibliothèque expose deux clients :

  • WorkspaceClient — travailler avec des conversations, enquêtes, tâches et outils dans un espace de travail Discovery.
  • BookshelfClient — gérer et interroger des bases de connaissances dans une bibliothèque Discovery.

Chaque client cible son propre point de terminaison de service.

Liens clés :

Premiers pas

Environnements actuellement pris en charge

Pour plus d’informations, consultez notre de stratégie de support .

Prerequisites

Installer le package @azure/ai-discovery

Installez la bibliothèque client Discovery pour JavaScript avec npm:

npm install @azure/ai-discovery

Créer et authentifier les clients

Pour créer un objet client, vous aurez besoin du service endpoint et d’un credentialfichier . Les clients Azure AI Discovery utilisent les identifiants Microsoft Entra pour s’authentifier. WorkspaceClient Et BookshelfClient chacun cible son propre point de terminaison, donc créez le(s) client(s) dont vous avez besoin avec le point de terminaison correspondant. Vous pouvez trouver les points de terminaison de vos ressources Discovery dans le Portail Azure.

Vous pouvez vous authentifier avec Microsoft Entra ID en utilisant un identifiant de la bibliothèque @azure/identity ou un jeton Microsoft Entra existant.

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 :

npm install @azure/identity

Vous devrez également enregistrer une nouvelle application Microsoft Entra et accorder l’accès à Azure AI Discovery en attribuant un rôle approprié à votre principal de service (note : des rôles tels "Owner" que ne délivreront pas les autorisations nécessaires).

Pour plus d’informations sur la création d’une application Microsoft Entra, consultez ce guide.

En utilisant des environnements Node.js et de type Node, vous pouvez utiliser la DefaultAzureCredential classe pour authentifier les clients.

import { DefaultAzureCredential } from "@azure/identity";
import { WorkspaceClient, BookshelfClient } from "@azure/ai-discovery";

const credential = new DefaultAzureCredential();
// WorkspaceClient exposes conversations, investigations, tasks, and tools.
const workspaceClient = new WorkspaceClient("<workspace-endpoint>", credential);
// BookshelfClient exposes knowledge bases.
const bookshelfClient = new BookshelfClient("<bookshelf-endpoint>", credential);

Pour les environnements de navigateur, utilisez le InteractiveBrowserCredential à partir du package @azure/identity pour l’authentification.

import { InteractiveBrowserCredential } from "@azure/identity";
import { WorkspaceClient, BookshelfClient } from "@azure/ai-discovery";

const credential = new InteractiveBrowserCredential({
  tenantId: "<YOUR_TENANT_ID>",
  clientId: "<YOUR_CLIENT_ID>",
});
const workspaceClient = new WorkspaceClient("<workspace-endpoint>", credential);
const bookshelfClient = new BookshelfClient("<bookshelf-endpoint>", credential);

Offre groupée JavaScript

Pour utiliser cette bibliothèque cliente dans le navigateur, vous devez d’abord utiliser un bundler. Pour plus d’informations sur la procédure à suivre, reportez-vous à notre documentation de regroupement .

Concepts clés

WorkspaceClient

WorkspaceClient donne accès aux fonctionnalités de l’espace de travail Découverte : conversations, enquêtes, tâches et outils. Explorez les méthodes de ce client pour travailler avec les ressources dans un espace de travail Discovery.

ClientBibliothèque

BookshelfClient donne accès aux fonctionnalités de la bibliothèque Discovery : gestion et requête de bases de connaissances. Explorez les méthodes sur ce client pour travailler avec des bases de connaissances dans une bibliothèque Discovery.

Exemples

Listes de bases de connaissances

Listez les bases de connaissances dans une ressource Discovery Bookshelf avec BookshelfClient.

import { BookshelfClient } from "@azure/ai-discovery";
import { DefaultAzureCredential } from "@azure/identity";

const client = new BookshelfClient("<bookshelf-endpoint>", new DefaultAzureCredential());
for await (const knowledgeBase of client.knowledgeBases.list()) {
  console.log(knowledgeBase.name);
}

Listez les tâches dans une enquête

Listez les tâches qui font partie d’une enquête avec WorkspaceClient.

import { WorkspaceClient } from "@azure/ai-discovery";
import { DefaultAzureCredential } from "@azure/identity";

const client = new WorkspaceClient("<workspace-endpoint>", new DefaultAzureCredential());
for await (const task of client.tasks.list("<project-name>", "<investigation-name>")) {
  console.log(task.name);
}

Résolution des problèmes

Logging

L’activation de la journalisation peut vous aider à découvrir des informations utiles sur les échecs. Pour afficher 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 la @azure/logger:

import { setLogLevel } from "@azure/logger";

setLogLevel("info");

Pour obtenir des instructions plus détaillées sur l’activation des journaux, vous pouvez consulter la documentationdu package @azure/enregistreur d’événements.

Étapes suivantes

Jetez un œil au dossier package samples, contenant du code entièrement exécutable.

Contribuer

Si vous souhaitez contribuer à cette bibliothèque, lisez le guide de contribution pour en savoir plus sur la génération et le test du code.

  • Dernière mise à jour :