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

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

A biblioteca apresenta dois clientes:

  • WorkspaceClient — trabalhar com conversas, investigações, tarefas e ferramentas num espaço de trabalho Discovery.
  • BookshelfClient — gerir e consultar bases de conhecimento numa estante Discovery.

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

Ligações principais:

Como Começar

Ambientes atualmente suportados

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

Pré-requisitos

  • Uma assinatura do Azure.

Instalar o pacote @azure/ai-discovery

Instale a biblioteca cliente Discovery para JavaScript com npm:

npm install @azure/ai-discovery

Criar e autenticar os clientes

Para criar um objeto cliente, vai precisar do serviço endpoint e de um credentialobjeto . Os clientes do Azure AI Discovery utilizam credenciais Microsoft Entra para autenticação. WorkspaceClient E BookshelfClient cada um direciona o seu próprio endpoint, por isso cria o(s) cliente(s) de que precisas com o endpoint correspondente. Pode encontrar os endpoints dos seus recursos Discovery no portal do Azure.

Pode autenticar-se com o Microsoft Entra ID usando uma credencial da biblioteca @azure/identity ou um token Microsoft Entra existente.

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

npm install @azure/identity

Também terá de registar 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" concedem as permissões necessárias).

Para mais informações sobre como criar uma aplicação Microsoft Entra, consulte este guia.

Usando Node.js e ambientes semelhantes ao Node, 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 cliente no navegador, primeiro você precisa usar um bundler. Para obter detalhes sobre como fazer isso, consulte nossa documentação de agregação de .

Conceitos-chave

WorkspaceClient

WorkspaceClient fornece acesso a funcionalidades do espaço de trabalho do Discovery: conversas, investigações, tarefas e ferramentas. Explore os métodos neste cliente para trabalhar com recursos num espaço de trabalho Discovery.

EstanteCliente

BookshelfClient fornece acesso às funcionalidades da estante Discovery: gestão e consulta de bases de conhecimento. Explore os métodos deste cliente para trabalhar com bases de conhecimento numa estante Discovery.

Examples

Listas de bases de conhecimento

Liste as bases de conhecimento num recurso Discovery Bookshelf 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);
}

Listar tarefas numa 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);
}

Troubleshooting

Registo

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 tempo de execução 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.

Passos seguintes

Dá uma vista de olhos na pasta package samples, que contém código totalmente executável.

Contributing

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

  • Last updated on