Azure AI Discovery client library for JavaScript - version 1.0.0

Ez a csomag egy izomorf SDK-t tartalmaz (mind Node.js-ben, mind böngészőben fut) a Azure AI Discovery szolgáltatáshoz.

A könyvtár két klienst tár ki:

  • WorkspaceClient — beszélgetésekkel, nyomozókat, feladatokat és eszközöket dolgozni egy Discovery munkaterületen.
  • BookshelfClient — a Discovery könyvespolcban található tudásbázisok kezelése és lekérdezése.

Minden kliens a saját szolgáltatási végpontját célozza meg.

Főbb hivatkozások:

Kezdő lépések

Jelenleg támogatott környezetek

További részletekért tekintse meg támogatási szabályzatunkat.

Előfeltételek

Telepítse a(z) @azure/ai-discovery csomagot

Telepítsd a JavaScript Discovery klienskönyvtárát a következőképpen npma következőket:

npm install @azure/ai-discovery

Hozd létre és hitelesítse az ügyfeleket

Egy kliensobjektum létrehozásához szükséged lesz a szolgáltatásra endpoint és egy credential. Az Azure AI Discovery kliensek Microsoft Entra hitelesítő adatokat használnak hitelesítéshez. WorkspaceClient És BookshelfClient mindegyik a saját végpontját célozza meg, így hozd létre a szükséges kliens(eket) a megfelelő végponttal. A Discovery erőforrásaid végpontjait az Azure Portal-ban találhatod.

Hitelesítést a Microsoft Entra ID-vel lehet a @azure/identity könyvtár vagy egy meglévő Microsoft Entra token hitelesítésével.

Az alább látható DefaultAzureCredential szolgáltató vagy az Azure SDK-hoz biztosított egyéb hitelesítő adatok szolgáltatójának használatához telepítse a @azure/identity csomagot:

npm install @azure/identity

Emellett regisztrálnod kell egy új Microsoft Entra alkalmazást is, és hozzáférést kell adni az Azure AI Discovery-hez azzal, hogy megfelelő szerepet rendelsz a szolgáltatási főnevedhez (megjegyzés: az ilyen "Owner" szerepek nem adják meg a szükséges jogosultságokat).

További információért a Microsoft Entra alkalmazás létrehozásáról nézd meg ezt az útmutatót.

Node.js és Node-szerű környezetek használatával az DefaultAzureCredential osztályt a kliensek hitelesítésére használhatod.

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

Böngészőkörnyezetek esetén a hitelesítéshez használja a InteractiveBrowserCredential csomagból származó @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);

JavaScript-csomag

Ahhoz, hogy ezt az ügyfélkódtárat a böngészőben használhassa, először egy kötegelőt kell használnia. Ennek módjáról további információt a csomagküldő dokumentációbantalál.

főbb fogalmak

WorkspaceClient

WorkspaceClient hozzáférést biztosít a Discovery munkaterület funkcióihoz: beszélgetésekhez, nyomozásokhoz, feladatokhoz és eszközökhöz. Fedezze fel ezen az ügyfél módszereit, hogy az erőforrásokat egy Discovery munkaterületen dolgozhasson fel.

BookshelfClient

BookshelfClient hozzáférést biztosít a Discovery könyvespolc funkcióihoz: tudásbázisok kezelése és lekérdezése. Fedezze fel ennek az ügyfélnek a módszereit, hogy a Discovery könyvespolcban lévő tudásbázisokkal dolgozhass.

Examples

Tudásbázisok listázása

Sorold fel a tudásbázisokat egy Discovery Bookspolf forrásban a 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);
}

Feladatok listázása egy vizsgálatban

Sorold fel a nyomozáshoz tartozó feladatokat a 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

Fakitermelés

A naplózás engedélyezése segíthet a hibákról szóló hasznos információk feltárásában. A HTTP-kérések és válaszok naplójának megtekintéséhez állítsa a környezeti változót a AZURE_LOG_LEVEL következőre info: . Alternatívaként a naplózás futásidőben is engedélyezhető a setLogLevel hívásával a @azure/logger.

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

setLogLevel("info");

A naplók engedélyezésére vonatkozó részletesebb útmutatásért tekintse meg a @azure/logger csomag dokumentációit.

Következő lépések

Nézd meg a package samples mappát, amely teljesen futtatható kódot tartalmaz.

Közreműködés

Ha hozzá szeretne járulni ehhez a kódtárhoz, olvassa el a közreműködői útmutatót, amelyből többet is megtudhat a kód összeállításáról és teszteléséről.

  • Utolsó frissítés időpontja: