Azure AI Discovery client library for JavaScript - versie 1.0.0

Dit pakket bevat een isomorfe SDK (draait zowel in Node.js als in browsers) voor de Azure AI Discovery-service.

De bibliotheek biedt twee clients beschikbaar:

  • WorkspaceClient — werken met gesprekken, onderzoeken, taken en tools in een Discovery-werkruimte.
  • BookshelfClient — het beheren en zoeken naar kennisbases in een Discovery-boekenkast.

Elke client richt zich op zijn eigen service-endpoint.

Sleutelkoppelingen:

Aan de slag

Momenteel ondersteunde omgevingen

Zie ons ondersteuningsbeleid voor meer informatie.

Prerequisites

Het @azure/ai-discovery-pakket installeren

Installeer de Discovery-clientbibliotheek voor JavaScript met npm:

npm install @azure/ai-discovery

Maak en authenticeer de cliënten

Om een clientobject te maken, heb je de service endpoint en een credential. De Azure AI Discovery-clients gebruiken Microsoft Entra-inloggegevens om te authenticeren. WorkspaceClient BookshelfClient en elk doelwit is hun eigen eindpunt, dus maak de client(en) die je nodig hebt met het bijbehorende eindpunt. Je kunt de eindpunten voor je ontdekkingsbronnen vinden in het Azure Portal.

Je kunt authenticeren met Microsoft Entra ID met een inloggegevens uit de @azure/identity-bibliotheek of een bestaand Microsoft Entra-token.

Als u de DefaultAzureCredential- provider wilt gebruiken die hieronder wordt weergegeven, of andere referentieproviders die zijn opgegeven bij de Azure SDK, installeert u het @azure/identity-pakket:

npm install @azure/identity

Je moet ook een nieuwe Microsoft Entra-applicatie registreren en toegang verlenen tot Azure AI Discovery door een geschikte rol toe te wijzen aan je servicehoofd (let op: rollen zoals "Owner" geven niet de benodigde rechten).

Voor meer informatie over hoe je een Microsoft Entra-applicatie maakt, bekijk deze gids.

Met Node.js en Node-achtige omgevingen kun je de DefaultAzureCredential klasse gebruiken om de clients te authenticeren.

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

Gebruik voor browseromgevingen de InteractiveBrowserCredential uit het @azure/identity-pakket om te verifiëren.

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

JavaScript-bundel

Als u deze clientbibliotheek in de browser wilt gebruiken, moet u eerst een bundelaar gebruiken. Raadpleeg onze bundeldocumentatievoor meer informatie over hoe u dit doet.

belangrijke concepten

WorkspaceClient

WorkspaceClient biedt toegang tot Discovery workspace-functies: gesprekken, onderzoeken, taken en tools. Verken de methoden op deze client om met bronnen in een Discovery-werkruimte te werken.

BoekenplankClient

BookshelfClient biedt toegang tot Discovery-boekenplankfuncties: het beheren en doorzoeken van kennisbanken. Verken de methoden op deze klant om met kennisbases in een Discovery-boekenkast te werken.

Examples

Lijst kennisbases

Vermeld de kennisbases in een Discovery Bookshelf-bron met 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);
}

Lijst taken in een onderzoek

Vermeld de taken die tot een onderzoek behoren met 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);
}

Troubleshooting

Loggen

Het inschakelen van logboekregistratie kan helpen nuttige informatie over fouten te ontdekken. Als u een logboek met HTTP-aanvragen en -antwoorden wilt zien, stelt u de omgevingsvariabele AZURE_LOG_LEVEL in op info. U kunt logboekregistratie ook tijdens runtime inschakelen door setLogLevel aan te roepen in de @azure/logger:

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

setLogLevel("info");

Voor meer gedetailleerde instructies over het inschakelen van logboeken, kunt u de @azure/logger pakketdocumentenbekijken.

Volgende stappen 

Bekijk de map package samples, die volledig uitvoerbare code bevat.

Bijdragen

Als u een bijdrage wilt leveren aan deze bibliotheek, leest u de gids voor bijdragen voor meer informatie over het bouwen en testen van de code.

  • Laatst bijgewerkt om