Azure AI Discovery client library for JavaScript - versión 1.0.0

Este paquete contiene un SDK isomorfo (que se ejecuta tanto en Node.js como en navegadores) para el servicio Azure AI Discovery.

La biblioteca expone a dos clientes:

  • WorkspaceClient — trabajar con conversaciones, investigaciones, tareas y herramientas en un espacio de trabajo de Descubrimiento.
  • BookshelfClient — gestionar y consultar bases de conocimiento en una estantería Discovery.

Cada cliente apunta a su propio punto final de servicio.

Vínculos clave:

Cómo empezar

Entornos admitidos actualmente

Consulte nuestra de directiva de soporte técnico de para obtener más información.

Prerequisites

Instalación del paquete @azure/ai-discovery

Instala la biblioteca cliente Discovery para JavaScript con npm:

npm install @azure/ai-discovery

Crea y autentica a los clientes

Para crear un objeto cliente, necesitarás el servicio endpoint y un credentialarchivo . Los clientes de Azure AI Discovery utilizan credenciales de Microsoft Entra para autenticarse. WorkspaceClient y BookshelfClient cada uno apunta a su propio endpoint, así que crea el(los) cliente(s) que necesites con el endpoint correspondiente. Puedes encontrar los puntos finales de tus recursos de Discovery en el Azure Portal.

Puedes autenticarte con Microsoft Entra ID usando una credencial de la biblioteca @azure/identity o un token Microsoft Entra existente.

Para usar el proveedor de de DefaultAzureCredential que se muestra a continuación u otros proveedores de credenciales proporcionados con el SDK de Azure, instale el paquete de @azure/identity:

npm install @azure/identity

También tendrás que registrar una nueva aplicación Microsoft Entra y conceder acceso a Azure AI Discovery asignando un rol adecuado a tu principal de servicio (nota: roles como no "Owner" concederán los permisos necesarios).

Para más información sobre cómo crear una aplicación Microsoft Entra, consulta esta guía.

Usando entornos Node.js y similares a Node, puedes usar la DefaultAzureCredential clase para autenticar a los 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);

En el caso de los entornos del explorador, use el InteractiveBrowserCredential del paquete de @azure/identity para autenticarse.

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

Paquete de JavaScript

Para usar esta biblioteca cliente en el explorador, primero debe usar un agrupador. Para obtener más información sobre cómo hacerlo, consulte nuestra documentación de agrupación de .

Conceptos clave

Cliente de Espacio de Trabajo

WorkspaceClient proporciona acceso a funciones del espacio de trabajo de Descubrimiento: conversaciones, investigaciones, tareas y herramientas. Explora los métodos en este cliente para trabajar con recursos en un espacio de trabajo de Descubrimiento.

Cliente de estantería

BookshelfClient proporciona acceso a las funciones de la estantería Discovery: gestión y consulta de bases de conocimiento. Explora los métodos de este cliente para trabajar con bases de conocimiento en una estantería Discovery.

Ejemplos

Bases de conocimiento de listas

Enumera las bases de conocimiento en un recurso de Discovery Bookshelf con 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);
}

Enumera tareas en una investigación

Enumera las tareas que pertenecen a una investigación con 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

Registro

Habilitar el registro puede ayudar a descubrir información útil sobre errores. Para ver un registro de solicitudes y respuestas HTTP, establezca la variable de entorno AZURE_LOG_LEVEL en info. Como alternativa, el registro se puede habilitar en tiempo de ejecución llamando a setLogLevel en el @azure/logger:

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

setLogLevel("info");

Para obtener instrucciones más detalladas sobre cómo habilitar los registros, puede consultar los documentos del paquete de @azure/registrador.

Pasos siguientes

Echa un vistazo a la carpeta package samples, que contiene código completamente ejecutable.

Contributing

Si desea contribuir a esta biblioteca, lea la guía de contribución de para obtener más información sobre cómo compilar y probar el código.

  • Last updated on