Azure AI Discovery biblioteca cliente para JavaScript - versão 1.0.0

Este pacote contém um SDK isomorfo (roda tanto em Node.js quanto em navegadores) para o serviço Azure AI Discovery.

A biblioteca apresenta dois clientes:

  • WorkspaceClient — trabalhar com conversas, investigações, tarefas e ferramentas em um espaço de trabalho Discovery.
  • BookshelfClient — gerenciar e consultar bases de conhecimento em uma estante Discovery.

Cada cliente tem como alvo seu próprio endpoint de serviço.

Links de chave:

Como começar

Ambientes com suporte no momento

Consulte nossa política de suporte para obter mais detalhes.

Pré-requisitos

Instalar o pacote @azure/ai-discovery

Instale a biblioteca cliente Discovery para JavaScript com npm:

npm install @azure/ai-discovery

Crie e autentice os clientes

Para criar um objeto cliente, você precisará do serviço endpoint e de um credentialobjeto . Os clientes do Azure AI Discovery usam credenciais Microsoft Entra para autenticação. WorkspaceClient E BookshelfClient cada um direciona seu próprio endpoint, então crie o(s) cliente(s) que você precisa com o endpoint correspondente. Você pode encontrar os endpoints para seus recursos do Discovery no portal do Azure.

Você pode autenticar com o Microsoft Entra ID usando uma credencial da biblioteca @azure/identity ou um token Microsoft Entra existente.

Para usar o provedor DefaultAzureCredential mostrado abaixo ou outros provedores de credenciais fornecidos com o SDK do Azure, instale o pacote @azure/identity:

npm install @azure/identity

Você também precisará registrar uma nova aplicação Microsoft Entra e conceder acesso ao Azure AI Discovery atribuindo um papel adequado ao seu principal de serviço (nota: funções como não "Owner" concederão as permissões necessárias).

Para mais informações sobre como criar um aplicativo Microsoft Entra, confira este guia.

Usando ambientes Node.js e semelhantes a Node, você pode usar a DefaultAzureCredential classe para autenticar os clientes.

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

Para ambientes de navegador, use o InteractiveBrowserCredential do pacote @azure/identity para autenticar.

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

Pacote JavaScript

Para usar essa biblioteca de clientes no navegador, primeiro você precisa usar um empacotador. Para obter detalhes sobre como fazer isso, consulte nossa documentação de agrupamento .

Conceitos principais

WorkspaceClient

WorkspaceClient oferece acesso aos recursos do espaço de trabalho do Discovery: conversas, investigações, tarefas e ferramentas. Explore os métodos neste cliente para trabalhar com recursos em um espaço de trabalho Discovery.

EstanteCliente

BookshelfClient oferece acesso aos recursos da estante Discovery: gerenciar e consultar bases de conhecimento. Explore os métodos deste cliente para trabalhar com bases de conhecimento em uma estante Discovery.

Exemplos

Bases de conhecimento de listas

Liste as bases de conhecimento em um recurso da Estante de Descoberta com 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);
}

Liste tarefas em uma investigação

Liste as tarefas que pertencem a uma investigação com 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);
}

Solução de problemas

Registro em log

Habilitar o registro em log pode ajudar a descobrir informações úteis sobre falhas. Para ver um log de solicitações e respostas HTTP, defina a variável de ambiente AZURE_LOG_LEVEL como info. Como alternativa, o registro em log pode ser habilitado em runtime chamando setLogLevel no @azure/logger:

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

setLogLevel("info");

Para obter instruções mais detalhadas sobre como habilitar logs, você pode consultar os documentos do pacote @azure/logger.

Próximas Etapas 

Dê uma olhada na pasta package samples, que contém código totalmente executável.

Contributing

Se você quiser contribuir com essa biblioteca, leia o guia de contribuição para saber mais sobre como criar e testar o código.

  • do SDK do Microsoft Azure para JavaScript
  • Last updated on