Azure AI Discovery client library for JavaScript - verze 1.0.0

Tento balíček obsahuje izomorfní SDK (běží jak v Node.js, tak v prohlížečích) pro službu Azure AI Discovery.

Knihovna představuje dva klienty:

  • WorkspaceClient — pracovat s konverzacemi, vyšetřováními, úkoly a nástroji v pracovním prostoru Discovery.
  • BookshelfClient — spravovat a dotazovat znalostní báze v knihovně Discovery.

Každý klient cílí na svůj vlastní koncový bod služby.

Klíčové odkazy:

Začínáme

Aktuálně podporovaná prostředí

Další podrobnosti najdete v zásadách podpory.

Prerequisites

  • Předplatné služby Azure.

Nainstalujte balíček @azure/ai-discovery.

Nainstalujte knihovnu klienta Discovery pro JavaScript s npm:

npm install @azure/ai-discovery

Vytvořte a ověřte klienty

Pro vytvoření klientského objektu budete potřebovat službu endpoint a .credential Klienti Azure AI Discovery používají přihlašovací údaje Microsoft Entra k autentizaci. WorkspaceClient A BookshelfClient každý cílí na svůj vlastní endpoint, takže si vytvořte klienta(y), které potřebujete, s odpovídajícím endpointem. Endpointy pro vaše zdroje Discovery najdete v Azure Portal.

Můžete se autentizovat pomocí Microsoft Entra ID pomocí přihlašovacích údajů z knihovny @azure/identity nebo existujícího Microsoft Entra tokenu.

Pokud chcete použít poskytovatele DefaultAzureCredential zobrazené níže nebo jiné zprostředkovatele přihlašovacích údajů poskytnuté sadou Azure SDK, nainstalujte balíček @azure/identity:

npm install @azure/identity

Budete také muset zaregistrovat novou aplikaci Microsoft Entra a udělit přístup k Azure AI Discovery přiřazením vhodné role vašemu principálovi služby (poznámka: role jako například "Owner" neudělí potřebná oprávnění).

Pro více informací o tom, jak vytvořit aplikaci Microsoft Entra, si přečtěte tento průvodce.

Pomocí prostředí podobných Node.js a Node můžete třídu DefaultAzureCredential použít k autentizaci klientů.

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

Pro prostředí prohlížeče použijte k ověření InteractiveBrowserCredential z balíčku @azure/identity.

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

JavaScriptový balíček

Pokud chcete tuto klientskou knihovnu použít v prohlížeči, musíte nejprve použít bundler. Podrobnosti o tom, jak to udělat, najdete v naší dokumentaci sdružování.

Klíčové koncepty

WorkspaceClient

WorkspaceClient poskytuje přístup k funkcím pracovního prostoru Discovery: konverzacím, vyšetřováním, úkolům a nástrojům. Prozkoumejte metody na tomto klientovi pro práci se zdroji v Discovery workspace.

BookshelfClient

BookshelfClient poskytuje přístup k funkcím Discovery bookpolice: správa a dotazování znalostních databází. Prozkoumejte metody na tomto klientovi, jak pracovat s databázemi znalostí v knihovně Discovery.

Examples

Seznamy znalostních bází

Uveďte znalostní báze v Discovery Bookshelf zdroji pomocí 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);
}

Seznam úkolů ve vyšetřování

Úkoly patřícími do vyšetřování uveďte pomocí 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);
}

Řešení problémů

Logování

Povolení protokolování může pomoct odhalit užitečné informace o chybách. Pokud chcete zobrazit protokol požadavků a odpovědí HTTP, nastavte proměnnou prostředí AZURE_LOG_LEVEL na info. Případně můžete protokolování povolit za běhu voláním setLogLevel v @azure/logger:

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

setLogLevel("info");

Podrobnější pokyny k povolení protokolů najdete v dokumentaci k @azure/protokolovacímu balíčku.

Další kroky

Podívejte se na složku package samples, která obsahuje plně běžný kód.

Přispění

Pokud chcete přispívat do této knihovny, přečtěte si průvodce přispívání a přečtěte si další informace o vytváření a testování kódu.

  • Last updated on