Share via

Azure VectorDb client library for JavaScript - version 1.0.0-beta.1

  • Article

This package contains an isomorphic SDK (runs both in Node.js and in browsers) for Azure VectorDb client.

Key links:

Getting started

Currently supported environments

See our support policy for more details.

Prerequisites

Install the @azure/arm-pineconevectordb package

Install the Azure VectorDb client library for JavaScript with npm:

npm install @azure/arm-pineconevectordb

Create and authenticate a VectorDbClient

To create a client object to access the Azure VectorDb API, you will need the endpoint of your Azure VectorDb resource and a credential. The Azure VectorDb client can use Azure Active Directory credentials to authenticate. You can find the endpoint for your Azure VectorDb resource in the Azure Portal.

You can authenticate with Azure Active Directory using a credential from the @azure/identity library or an existing AAD Token.

To use the DefaultAzureCredential provider shown below, or other credential providers provided with the Azure SDK, please install the @azure/identity package:

npm install @azure/identity

You will also need to register a new AAD application and grant access to Azure VectorDb by assigning the suitable role to your service principal (note: roles such as "Owner" will not grant the necessary permissions).

For more information about how to create an Azure AD Application check out this guide.

Using Node.js and Node-like environments, you can use the DefaultAzureCredential class to authenticate the client.

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

For browser environments, use the InteractiveBrowserCredential from the @azure/identity package to authenticate.

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

JavaScript Bundle

To use this client library in the browser, first you need to use a bundler. For details on how to do this, please refer to our bundling documentation.

Key concepts

VectorDbClient

VectorDbClient is the primary interface for developers using the Azure VectorDb client library. Explore the methods on this client object to understand the different features of the Azure VectorDb service that you can access.

Troubleshooting

Logging

Enabling logging may help uncover useful information about failures. In order to see a log of HTTP requests and responses, set the AZURE_LOG_LEVEL environment variable to info. Alternatively, logging can be enabled at runtime by calling setLogLevel in the @azure/logger:

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

setLogLevel("info");

For more detailed instructions on how to enable logs, you can look at the @azure/logger package docs.

Next steps

Please take a look at the samples directory for detailed examples on how to use this library.

Contributing

If you'd like to contribute to this library, please read the contributing guide to learn more about how to build and test the code.