Клиентская библиотека Azure AI Discovery для JavaScript — версия 1.0.0

Этот пакет содержит изоморфный SDK (работает как в Node.js, так и в браузерах) для сервиса AI Discovery Azure.

Библиотека предлагает два клиента:

  • WorkspaceClient — работать с разговорами, расследованиями, задачами и инструментами в рабочем пространстве Discovery.
  • BookshelfClient — управлять и отправлять запросы в базы знаний на книжной полке Discovery.

Каждый клиент ориентируется на свою конечную точку сервиса.

Ключевые ссылки:

Начало работы

Поддерживаемые в настоящее время среды

Чтобы получить дополнительные сведения, ознакомьтесь с нашей политикой поддержки.

Необходимые условия

Установите пакет @azure/ai-discovery.

Установите клиентскую библиотеку Discovery для JavaScript с помощью npm:

npm install @azure/ai-discovery

Создавайте и аутентифицируйте клиентов

Для создания клиентского объекта вам понадобится сервис endpoint и .credential Клиенты Azure AI Discovery используют учетные данные Microsoft Entra для аутентификации. WorkspaceClient И BookshelfClient каждый из них нацелен на свой конечный конец, поэтому создайте нужные клиенты с соответствующим конечным объектом. Вы можете найти конечные точки для ваших ресурсов Discovery в портал Azure.

Вы можете аутентифицироваться с помощью Microsoft Entra ID, используя учетные данные из библиотеки @azure/identity или имея существующий токен Microsoft Entra.

Чтобы использовать поставщик defaultAzureCredential, показанный ниже, или другие поставщики учетных данных, предоставленные пакетом Azure SDK, установите пакет :

npm install @azure/identity

Вам также потребуется зарегистрировать новое приложение Microsoft Entra и предоставить доступ к Azure AI Discovery, назначив соответствующую роль вашему руководителю сервиса (примечание: такие роли"Owner", которые не предоставляют необходимые права).

Для получения дополнительной информации о том, как создать приложение Microsoft Entra, ознакомьтесь с этим руководством.

Используя Node.js и Node-подобные среды, вы можете использовать класс DefaultAzureCredential для аутентификации клиентов.

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

Для сред браузера используйте InteractiveBrowserCredential из пакета @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

Чтобы использовать эту клиентную библиотеку в браузере, сначала необходимо использовать пакет. Дополнительные сведения о том, как это сделать, см. в нашей документации по .

Ключевые понятия

WorkspaceClient

WorkspaceClient предоставляет доступ к функциям рабочего пространства Discovery: разговорам, расследованиям, задачам и инструментам. Изучите методы работы с ресурсами на этом клиенте в рабочем пространстве Discovery.

BookhelfClient

BookshelfClient предоставляет доступ к функциям Discovery: управлению и запросам баз знаний. Изучите методы работы с базами знаний на полке Discovery.

Примеры

Список баз знаний

Перечислите базы знаний в ресурсе Discovery Bookshelf с .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);
}

Список задач в расследовании

Перечислите задачи, относящиеся к расследованию, с 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

Лесозаготовка

Включение ведения журнала может помочь выявить полезные сведения о сбоях. Чтобы просмотреть журнал HTTP-запросов и ответов, задайте для переменной среды AZURE_LOG_LEVEL значение info. В альтернативном порядке, логирование можно включить во время выполнения, вызвав setLogLevel в @azure/logger:

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

setLogLevel("info");

Дополнительные инструкции по включению журналов см. в документации по пакету @azure/loger.

Дальнейшие действия

Посмотрите папку package samples с полностью загруженным кодом.

Вклад

Если вы хотите внести свой вклад в эту библиотеку, ознакомьтесь с руководством по вкладу, чтобы узнать больше о том, как создавать и тестировать код.

  • Last updated on