Azure AI Discovery client library per JavaScript - versione 1.0.0

Questo pacchetto contiene un SDK isomorfo (che funziona sia in Node.js che nei browser) per il servizio Azure AI Discovery.

La biblioteca espone due clienti:

  • WorkspaceClient — lavorare con conversazioni, indagini, compiti e strumenti in uno spazio di lavoro Discovery.
  • BookshelfClient — gestire e interrogare le basi di conoscenza in una libreria Discovery.

Ogni client prende di mira il proprio endpoint di servizio.

Collegamenti chiave:

Come iniziare

Ambienti attualmente supportati

Per altri dettagli, vedere i criteri di supporto .

Prerequisiti

Installare il pacchetto @azure/ai-discovery

Installa la libreria client Discovery per JavaScript con:npm

npm install @azure/ai-discovery

Crea e autentica i clienti

Per creare un oggetto client, avrai bisogno del servizio endpoint e di un credential. I client Azure AI Discovery utilizzano le credenziali Microsoft Entra per autenticarsi. WorkspaceClient e BookshelfClient ognuno mira al proprio endpoint, quindi crea il/i client/i di cui hai bisogno con l'endpoint corrispondente. Puoi trovare gli endpoint per le tue risorse Discovery nell'portale di Azure.

Puoi autenticarti con Microsoft Entra ID usando una credenziale dalla libreria @azure/identity o da un token Microsoft Entra esistente.

Per usare il provider DefaultAzureCredential illustrato di seguito o altri provider di credenziali forniti con Azure SDK, installare il pacchetto :

npm install @azure/identity

Dovrai anche registrare una nuova applicazione Microsoft Entra e concedere l'accesso ad Azure AI Discovery assegnando un ruolo adeguato al tuo responsabile di servizio (nota: ruoli come non "Owner" concederanno i permessi necessari).

Per maggiori informazioni su come creare un'applicazione Microsoft Entra, consulta questa guida.

Utilizzando ambienti Node.js e simili a Node, puoi usare la DefaultAzureCredential classe per autenticare i client.

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

Per gli ambienti del browser, usare il InteractiveBrowserCredential dal pacchetto di @azure/identity per l'autenticazione.

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

Pacchetto JavaScript

Per usare questa libreria client nel browser, è prima necessario usare un bundler. Per informazioni dettagliate su come eseguire questa operazione, vedere la documentazione di creazione di bundle .

Concetti chiave

WorkspaceClient

WorkspaceClient fornisce accesso alle funzionalità dello spazio di lavoro Discovery: conversazioni, indagini, attività e strumenti. Esplora i metodi su questo client per lavorare con le risorse in uno spazio di lavoro Discovery.

Cliente della libreria

BookshelfClient fornisce accesso alle funzionalità della libreria Discovery: gestione e interaczione di knowledge base. Esplora i metodi su questo cliente per lavorare con le knowledge base in una libreria Discovery.

Examples

Liste delle basi di conoscenza

Elenca le knowledge base in una risorsa Discovery Bookshelf con 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);
}

Elenca i compiti in un'indagine

Elencare i compiti che appartengono a un'indagine con 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);
}

Risoluzione dei problemi

Registrazione

L'abilitazione della registrazione può aiutare a individuare informazioni utili sugli errori. Per visualizzare un log di richieste e risposte HTTP, impostare la variabile di ambiente AZURE_LOG_LEVEL su info. In alternativa, la registrazione può essere abilitata in fase di esecuzione chiamando setLogLevel nel @azure/logger:

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

setLogLevel("info");

Per istruzioni più dettagliate su come abilitare i log, è possibile esaminare la documentazione del pacchetto @azure/logger.

Passaggi successivi

Dai un'occhiata alla cartella package samples, che contiene codice completamente eseguibile.

Contribuire

Per contribuire a questa libreria, leggere la guida contribuire per altre informazioni su come compilare e testare il codice.

  • Last updated on