Azure AI Discovery biblioteka klienta dla JavaScript - wersja 1.0.0

Ten pakiet zawiera izomorficzne SDK (działające zarówno w Node.js, jak i w przeglądarkach) dla usługi Azure AI Discovery.

Biblioteka udostępnia dwóch klientów:

  • WorkspaceClient — pracować z rozmowami, śledztwami, zadaniami i narzędziami w przestrzeni roboczej Discovery.
  • BookshelfClient — zarządzać i zapytywać bazy wiedzy na półce Discovery.

Każdy klient celuje w swój własny punkt końcowy usługi.

Kluczowe linki:

Rozpoczęcie pracy

Obecnie obsługiwane środowiska

  • Wersje LTS systemu Node.js
  • Najnowsze wersje przeglądarek Safari, Chrome, Edge i Firefox.

Aby uzyskać więcej informacji, zobacz nasze zasad pomocy technicznej.

Prerequisites

Instalowanie pakietu @azure/ai-discovery

Zainstaluj bibliotekę klienta Discovery dla JavaScript za pomocą npm:

npm install @azure/ai-discovery

Stwórz i uwierzytelnij klientów

Aby utworzyć obiekt klienta, potrzebujesz usługi endpoint oraz credential. Klienci Azure AI Discovery używają poświadczeń Microsoft Entra do uwierzytelniania. WorkspaceClient Każdy BookshelfClient z nich celuje w swój własny punkt końcowy, więc stwórz klienta(-y), którego potrzebujesz, z odpowiednim punktem. Punkty końcowe dla zasobów Discovery znajdziesz w Azure Portal.

Możesz uwierzytelnić się za pomocą Microsoft Entra ID, używając poświadczenia z biblioteki @azure/identity lub istniejącego tokena Microsoft Entra.

Aby użyć domyślnego dostawcyAzureCredential pokazanego poniżej lub innych dostawców poświadczeń dostarczonych z zestawem Azure SDK, zainstaluj @azure/identity pakiet:

npm install @azure/identity

Będziesz także musiał zarejestrować nową aplikację Microsoft Entra i przydzielić dostęp do Azure AI Discovery, przypisując odpowiednią rolę swojemu podmiotowi usługowemu (uwaga: role takie jak nie "Owner" przyznają niezbędnych uprawnień).

Aby dowiedzieć się więcej o tym, jak stworzyć aplikację Microsoft Entra, sprawdź ten przewodnik.

Korzystając z środowisk podobnych do Node.js i Node, możesz użyć DefaultAzureCredential klasy do uwierzytelniania klientów.

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

W przypadku środowisk przeglądarki użyj InteractiveBrowserCredential z pakietu @azure/identity do uwierzytelniania.

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

Pakiet JavaScript

Aby użyć tej biblioteki klienta w przeglądarce, najpierw należy użyć pakietu. Aby uzyskać szczegółowe informacje o tym, jak to zrobić, zapoznaj się z naszą dokumentacją dotyczącą tworzenia pakietów .

Kluczowe pojęcia

WorkspaceClient

WorkspaceClient zapewnia dostęp do funkcji przestrzeni roboczej Discovery: rozmów, dochodzeń, zadań i narzędzi. Poznaj metody pracy z zasobami w przestrzeni roboczej Discovery, które są stosowane na tym kliencie.

BookshelfClient

BookshelfClient zapewnia dostęp do funkcji regału Discovery: zarządzanie i wysyłanie zapytań do baz wiedzy. Poznaj metody pracy na tym kliencie z bazami wiedzy na półce Discovery.

Przykłady

Bazy wiedzy na liście

Wypisz bazy wiedzy w zasobie Discovery Bookshelf wraz z 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 zadań w śledztwie

Wypisz zadania należące do badania za 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);
}

Troubleshooting

Przemysł drzewny

Włączenie rejestrowania może pomóc odkryć przydatne informacje o błędach. Aby wyświetlić dziennik żądań i odpowiedzi HTTP, ustaw zmienną środowiskową AZURE_LOG_LEVEL na info. Alternatywnie rejestrowanie można włączyć w czasie wykonywania, wywołując setLogLevel w @azure/logger:

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

setLogLevel("info");

Aby uzyskać bardziej szczegółowe instrukcje dotyczące włączania dzienników, zapoznaj się z dokumentacją pakietu @azure/logger.

Następne kroki

Spójrz na folder package samples, zawierający w pełni uruchomiony kod.

Contributing

Jeśli chcesz współtworzyć tę bibliotekę, przeczytaj przewodnik dotyczący współtworzenia , aby dowiedzieć się więcej na temat tworzenia i testowania kodu.

  • Last updated on