Sdílet prostřednictvím


Klientská knihovna Azure VectorDb pro JavaScript – verze 1.0.0-beta.1

Tento balíček obsahuje izomorfní sadu SDK (spouští se v Node.js i v prohlížečích) pro klienta Azure VectorDb.

Klíčové odkazy:

Začínáme

Aktuálně podporovaná prostředí

Další podrobnosti najdete v našich zásadách podpory .

Požadavky

Instalace balíčku @azure/arm-pineconevectordb

Nainstalujte klientskou knihovnu Azure VectorDb pro JavaScript pomocí npm:

npm install @azure/arm-pineconevectordb

Vytvoření a ověření VectorDbClient

K vytvoření objektu klienta pro přístup k rozhraní API Azure VectorDb budete potřebovat endpoint prostředku Azure VectorDb a credential. Klient Azure VectorDb může k ověření použít přihlašovací údaje Azure Active Directory. Koncový bod prostředku Azure VectorDb najdete na webu Azure Portal.

Pomocí Azure Active Directory se můžete ověřit pomocí přihlašovacích údajů z knihovny @azure/identity nebo existujícího tokenu AAD.

Pokud chcete použít poskytovatele DefaultAzureCredential zobrazené níže nebo jiné zprostředkovatele přihlašovacích údajů poskytnuté sadou Azure SDK, nainstalujte balíček @azure/identity:

npm install @azure/identity

Budete také muset zaregistrovat novou aplikaci AAD a udělit přístup ke službě Azure VectorDb přiřazením vhodné role instančnímu objektu (poznámka: role, jako je "Owner", neudělí potřebná oprávnění).

Další informace o tom, jak vytvořit aplikaci Azure AD, najdete této příručce.

Pomocí Node.js a prostředí podobných uzlům můžete k ověření klienta použít třídu DefaultAzureCredential.

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

Pro prostředí prohlížeče použijte k ověření InteractiveBrowserCredential z balíčku @azure/identity.

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

Pokud chcete tuto klientskou knihovnu použít v prohlížeči, musíte nejprve použít bundler. Podrobnosti o tom, jak to udělat, najdete v naší dokumentaci sdružování.

Klíčové koncepty

VectorDbClient

VectorDbClient je primárním rozhraním pro vývojáře, kteří používají klientskou knihovnu Azure VectorDb. Prozkoumejte metody tohoto klientského objektu, abyste porozuměli různým funkcím služby Azure VectorDb, ke které máte přístup.

Řešení problémů

Protokolování

Povolení protokolování může pomoct odhalit užitečné informace o chybách. Pokud chcete zobrazit protokol požadavků a odpovědí HTTP, nastavte proměnnou prostředí AZURE_LOG_LEVEL na info. Případně můžete protokolování povolit za běhu voláním setLogLevel v @azure/logger:

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

setLogLevel("info");

Podrobnější pokyny k povolení protokolů najdete v dokumentaci k @azure/protokolovacímu balíčku.

Další kroky

Podrobné příklady použití této knihovny najdete v ukázkách adresáři.

Přispívající

Pokud chcete přispívat do této knihovny, přečtěte si průvodce přispívání a přečtěte si další informace o vytváření a testování kódu.