Udostępnij za pośrednictwem

Biblioteka klienta usługi Azure VectorDb dla języka JavaScript — wersja 1.0.0-beta.1

  • Artykuł

Ten pakiet zawiera izomorficzny zestaw SDK (działa zarówno w Node.js, jak i w przeglądarkach) dla klienta usługi Azure VectorDb.

Kluczowe linki:

Wprowadzenie

Obecnie obsługiwane środowiska

  • wersje Node.js LTS
  • Najnowsze wersje przeglądarek Safari, Chrome, Edge i Firefox.

Aby uzyskać więcej informacji, zobacz nasze zasad pomocy technicznej.

Warunki wstępne

  • Subskrypcja platformy Azure .

Instalowanie pakietu @azure/arm-pineconevectordb

Zainstaluj bibliotekę klienta usługi Azure VectorDb dla języka JavaScript przy użyciu npm:

npm install @azure/arm-pineconevectordb

Tworzenie i uwierzytelnianie VectorDbClient

Aby utworzyć obiekt klienta w celu uzyskania dostępu do interfejsu API usługi Azure VectorDb, będzie potrzebny endpoint zasobu usługi Azure VectorDb i credential. Klient usługi Azure VectorDb może używać poświadczeń usługi Azure Active Directory do uwierzytelniania. Punkt końcowy zasobu usługi Azure VectorDb można znaleźć w witrynie Azure Portal.

Możesz uwierzytelnić się w usłudze Azure Active Directory przy użyciu poświadczeń z biblioteki @azure/tożsamości lub istniejącego tokenu usługi AAD.

Aby użyć dostawcy DefaultAzureCredential pokazanego poniżej lub innych dostawców poświadczeń dostarczonych z zestawem Azure SDK, zainstaluj pakiet @azure/identity:

npm install @azure/identity

Należy również zarejestrować nową aplikację usługi AAD i udzielić dostępu do usługi Azure VectorDb, przypisując odpowiednią rolę do jednostki usługi (uwaga: role, takie jak "Owner", nie będą udzielać niezbędnych uprawnień).

Aby uzyskać więcej informacji na temat tworzenia aplikacji usługi Azure AD, zobacz tym przewodniku.

Korzystając ze środowisk Node.js i środowisk podobnych do węzłów, możesz użyć klasy DefaultAzureCredential do uwierzytelniania klienta.

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

W przypadku środowisk przeglądarki użyj InteractiveBrowserCredential z pakietu @azure/identity do uwierzytelniania.

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

Pakiet JavaScript

Aby użyć tej biblioteki klienta w przeglądarce, najpierw należy użyć pakietu. Aby uzyskać szczegółowe informacje o tym, jak to zrobić, zapoznaj się z naszą dokumentacją dotyczącą tworzenia pakietów .

Kluczowe pojęcia

VectorDbClient

VectorDbClient jest podstawowym interfejsem dla deweloperów korzystających z biblioteki klienta usługi Azure VectorDb. Zapoznaj się z metodami tego obiektu klienta, aby zrozumieć różne funkcje usługi Azure VectorDb, do których można uzyskać dostęp.

Rozwiązywanie problemów

Wyrąb

Włączenie rejestrowania może pomóc odkryć przydatne informacje o błędach. Aby wyświetlić dziennik żądań i odpowiedzi HTTP, ustaw zmienną środowiskową AZURE_LOG_LEVEL na info. Alternatywnie rejestrowanie można włączyć w czasie wykonywania, wywołując setLogLevel w @azure/logger:

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

setLogLevel("info");

Aby uzyskać bardziej szczegółowe instrukcje dotyczące włączania dzienników, zapoznaj się z dokumentami dotyczącymi pakietów @azure/rejestratora.

Następne kroki

Zapoznaj się z przykładami katalogu, aby zapoznać się ze szczegółowymi przykładami dotyczącymi korzystania z tej biblioteki.

Przyczyniając się

Jeśli chcesz współtworzyć tę bibliotekę, przeczytaj przewodnik dotyczący współtworzenia , aby dowiedzieć się więcej na temat tworzenia i testowania kodu.