Azure AI Discovery client library for JavaScript - version 1.0.0

Detta paket innehåller ett isomorft SDK (körs både i Node.js och i webbläsare) för Azure AI Discovery-tjänsten.

Biblioteket exponerar två klienter:

  • WorkspaceClient — arbeta med samtal, undersökningar, uppgifter och verktyg i en Discovery-arbetsyta.
  • BookshelfClient — hantera och söka kunskapsbaser i en Discovery-bokhylla.

Varje klient riktar in sig på sin egen service-endpoint.

Nyckellänkar:

Komma igång

Miljöer som stöds för närvarande

Mer information finns i vår supportprincip.

Prerequisites

Installera @azure/ai-discovery-paketet

Installera Discovery-klientbiblioteket för JavaScript med npm:

npm install @azure/ai-discovery

Skapa och autentisera klienterna

För att skapa ett klientobjekt behöver du tjänsten endpoint och en credential. Azure AI Discovery-klienterna använder Microsoft Entra-inloggningsuppgifter för autentisering. WorkspaceClient BookshelfClient och varje mål sin egen endpoint, så skapa de klienter du behöver med motsvarande endpoint. Du kan hitta endpoints för dina Discovery-resurser i Azure Portal.

Du kan autentisera dig med Microsoft Entra ID med en legitimation från @azure/identity-biblioteket eller en befintlig Microsoft Entra-token.

Installera -paketet om du vill använda @azure/identity som visas nedan eller andra leverantörer av autentiseringsuppgifter som tillhandahålls med Azure SDKs:

npm install @azure/identity

Du måste också registrera en ny Microsoft Entra-applikation och ge tillgång till Azure AI Discovery genom att tilldela en lämplig roll till din tjänstehuvudman (notera: roller som "Owner" ger inte nödvändiga behörigheter).

För mer information om hur du skapar en Microsoft Entra-applikation, kolla in denna guide.

Med Node.js och nodliknande miljöer kan du använda DefaultAzureCredential klassen för att autentisera klienterna.

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

För webbläsarmiljöer använder du InteractiveBrowserCredential från @azure/identity-paketet för att autentisera.

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-paket

Om du vill använda det här klientbiblioteket i webbläsaren måste du först använda en bundler. Mer information om hur du gör detta finns i vår paketeringsdokumentation.

Viktiga begrepp

WorkspaceClient

WorkspaceClient ger tillgång till Discovery-arbetsytans funktioner: konversationer, undersökningar, uppgifter och verktyg. Utforska metoderna på denna klient för att arbeta med resurser i en Discovery-arbetsyta.

BokhyllaClient

BookshelfClient ger tillgång till Discovery-bokhyllfunktioner: hantering och sökning i kunskapsbaser. Utforska metoderna på denna klient för att arbeta med kunskapsbaser i en Discovery-bokhylla.

Examples

Lista kunskapsbaser

Lista kunskapsbaserna i en Discovery Bookshelf-resurs med 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);
}

Lista uppgifter i en undersökning

Lista de uppgifter som tillhör en undersökning med 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

Loggar

Aktivering av loggning kan hjälpa dig att hitta användbar information om fel. Om du vill se en logg med HTTP-begäranden och svar anger du AZURE_LOG_LEVEL miljövariabeln till info. Du kan också aktivera loggning vid körning genom att anropa setLogLevel i @azure/logger:

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

setLogLevel("info");

Mer detaljerade anvisningar om hur du aktiverar loggar finns i dokument för @azure/logger-paket.

Nästa steg

Titta på mappen package samples, som innehåller fullt körbar kod.

Contributing

Om du vill bidra till det här biblioteket kan du läsa bidragsguide för att lära dig mer om hur du skapar och testar koden.

  • Uppdaterades senast