Compartir a través de

Biblioteca cliente de Azure VectorDb para JavaScript: versión 1.0.0-beta.1

Este paquete contiene un SDK isomórfico (se ejecuta tanto en Node.js como en exploradores) para el cliente de Azure VectorDb.

Vínculos clave:

Empezar

Entornos admitidos actualmente

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

Prerrequisitos

  • Una suscripción de Azure .

Instalación del paquete @azure/arm-pineconevectordb

Instale la biblioteca cliente de Azure VectorDb para JavaScript con npm:

npm install @azure/arm-pineconevectordb

Creación y autenticación de un VectorDbClient

Para crear un objeto de cliente para acceder a la API de Azure VectorDb, necesitará el endpoint del recurso de Azure VectorDb y un credential. El cliente de Azure VectorDb puede usar credenciales de Azure Active Directory para autenticarse. Puede encontrar el punto de conexión del recurso de Azure VectorDb en el Azure Portal.

Puede autenticarse con Azure Active Directory mediante una credencial de la biblioteca de de @azure/identidad o un token de AAD 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 deberá registrar una nueva aplicación de AAD y conceder acceso a Azure VectorDb asignando el rol adecuado a la entidad de servicio (nota: los roles como "Owner" no concederán los permisos necesarios).

Para más información sobre cómo crear una aplicación de Azure AD, consulte esta guía.

Con Node.js y entornos similares a nodos, puede usar la clase DefaultAzureCredential para autenticar al cliente.

import { VectorDbClient } from "../src/index.js";
import { DefaultAzureCredential } from "@azure/identity";

const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new VectorDbClient(new DefaultAzureCredential(), subscriptionId);

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

import { InteractiveBrowserCredential } from "@azure/identity";
import { VectorDbClient } from "../src/index.js";

const subscriptionId = "00000000-0000-0000-0000-000000000000";
const credential = new InteractiveBrowserCredential({
  tenantId: "<YOUR_TENANT_ID>",
  clientId: "<YOUR_CLIENT_ID>",
});
const client = new VectorDbClient(credential, subscriptionId);

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

VectorDbClient

VectorDbClient es la interfaz principal para los desarrolladores que usan la biblioteca cliente de Azure VectorDb. Explore los métodos de este objeto de cliente para comprender las distintas características del servicio Azure VectorDb al que puede acceder.

Solución de problemas

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

Eche un vistazo al directorio ejemplos para obtener ejemplos detallados sobre cómo usar esta biblioteca.

Contribuyendo

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.