Partilhar via


Biblioteca de cliente do Azure VectorDb para JavaScript - versão 1.0.0-beta.1

Este pacote contém um SDK isomórfico (executado em Node.js e em navegadores) para o cliente Azure VectorDb.

Ligações principais:

Primeiros passos

Ambientes atualmente suportados

Consulte o nosso de política de suporte para obter mais detalhes.

Pré-requisitos

  • Uma assinatura do Azure.

Instalar o pacote @azure/arm-pineconevectordb

Instale a biblioteca de cliente do Azure VectorDb para JavaScript com npm:

npm install @azure/arm-pineconevectordb

Criar e autenticar um VectorDbClient

Para criar um objeto de cliente para acessar a API do Azure VectorDb, você precisará do endpoint do recurso VectorDb do Azure e de um credential. O cliente Azure VectorDb pode usar credenciais do Azure Ative Directory para autenticar. Você pode encontrar o ponto de extremidade para seu recurso Azure VectorDb no Portal do Azure.

Você pode autenticar com o Azure Ative Directory usando uma credencial da biblioteca de @azure/identidade ou umde token AAD 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

Você também precisará registrar um novo aplicativo AAD e conceder acesso ao Azure VectorDb atribuindo a função adequada à sua entidade de serviço (observação: funções como "Owner" não concederão as permissões necessárias).

Para obter mais informações sobre como criar um Aplicativo do Azure AD, confira este guia.

Usando ambientes Node.js e Node-like, você pode usar a classe DefaultAzureCredential para autenticar o 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);

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

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

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

VectorDbClient

VectorDbClient é a interface principal para desenvolvedores que usam a biblioteca de cliente do Azure VectorDb. Explore os métodos neste objeto de cliente para entender os diferentes recursos do serviço Azure VectorDb que você pode acessar.

Solução de problemas

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.

Próximos passos

Por favor, dê uma olhada no exemplos diretório para obter exemplos detalhados sobre como usar esta biblioteca.

Contribuição

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