chore: rename options.credentials to options.credential

run-llama · Nov 18, 2024 · d2177bd · d2177bd
1 parent 8e7c154
commit d2177bd
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 25 deletions.
diff --git a/examples/vector-store/azure/index.ts b/examples/vector-store/azure/index.ts
@@ -60,8 +60,9 @@ function processResults(response: NodeWithScore[], mode: VectorStoreQueryMode) {
 (async () => {
   // ---------------------------------------------------------
   // 1- Setup Azure OpenAI
+  const credential = new DefaultAzureCredential();
   const azureADTokenProvider = getBearerTokenProvider(
-    new DefaultAzureCredential(),
+    credential,
     "https://cognitiveservices.azure.com/.default",
   );
   // You need to deploy your own embedding model as well as your own chat completion model
@@ -116,6 +117,7 @@ function processResults(response: NodeWithScore[], mode: VectorStoreQueryMode) {
   // - IndexManagement.CREATE_IF_NOT_EXISTS: will create the index if it does not exist
 
   const vectorStore = new AzureAISearchVectorStore({
+    credential,
     filterableMetadataFieldKeys:
       metadataFields as unknown as FilterableMetadataFieldKeysType,
     indexName,
@@ -148,7 +150,6 @@ function processResults(response: NodeWithScore[], mode: VectorStoreQueryMode) {
     await vectorStore.delete(ids[0]);
     nodes = await vectorStore.getNodes(ids);
     console.log({ nodes });
-    return;
   }
 
   // ---------------------------------------------------------

diff --git a/packages/llamaindex/src/vector-store/azure/AzureAISearchVectorStore.ts b/packages/llamaindex/src/vector-store/azure/AzureAISearchVectorStore.ts
@@ -22,7 +22,7 @@ import {
   type VectorSearchCompression,
 } from "@azure/search-documents";
 
-import type { DefaultAzureCredential } from "@azure/identity";
+import { DefaultAzureCredential } from "@azure/identity";
 import { type BaseNode, MetadataMode } from "@llamaindex/core/schema";
 import { consoleLogger, getEnv } from "@llamaindex/env";
 import {
@@ -96,7 +96,7 @@ const createSearchRequest = <T extends R>(
  */
 export interface AzureAISearchOptions<T extends R> {
   userAgent?: string;
-  credentials?: AzureKeyCredential | DefaultAzureCredential;
+  credential?: AzureKeyCredential | DefaultAzureCredential;
   endpoint?: string;
   key?: string;
   serviceApiVersion?: string;
@@ -787,28 +787,33 @@ export class AzureAISearchVectorStore<T extends R> extends BaseVectorStore {
   }
 
   #buildCredentials(options: AzureAISearchOptions<T>) {
-    let { credentials, key, endpoint, indexName } = options;
+    let { credential: credential, key, endpoint, indexName } = options;
 
-    // validate and use credentials
-    if (credentials) {
-      // if credentials are provided, ensure they are an instance of AzureKeyCredential
-      if (!(credentials instanceof AzureKeyCredential)) {
+    // validate and use credential
+    if (credential) {
+      // if credential are provided, ensure they are an instance of AzureKeyCredential
+      if (
+        !(
+          credential instanceof AzureKeyCredential ||
+          credential instanceof DefaultAzureCredential
+        )
+      ) {
         throw new Error(
-          "options.credentials must be an instance of AzureKeyCredential",
+          "options.credential must be an instance of AzureKeyCredential or DefaultAzureCredential",
         );
       }
     }
-    // if credentials are not provided, instantiate AzureKeyCredential with key
+    // if credential are not provided, instantiate AzureKeyCredential with key
     else {
       key ??= getEnv("AZURE_AI_SEARCH_KEY");
-      if (!key) {
-        throw new Error(
-          "options.key must be provided or set as an environment variable: AZURE_AI_SEARCH_KEY",
-        );
+      if (key) {
+        consoleLogger.log("Using provided Azure Search key");
+        credential = new AzureKeyCredential(key);
+      } else {
+        // if key wasn't provided, try using DefaultAzureCredential
+        consoleLogger.log("Using Azure Managed identity");
+        credential = new DefaultAzureCredential();
       }
-
-      consoleLogger.log("Using provided Azure Search key");
-      credentials = new AzureKeyCredential(key);
     }
 
     // validate and use endpoint
@@ -825,19 +830,18 @@ export class AzureAISearchVectorStore<T extends R> extends BaseVectorStore {
       throw new Error("options.indexName must be provided");
     }
 
-    return { credentials, endpoint, indexName };
+    return { credential, endpoint, indexName };
   }
 
   #createSearchIndexClient(options: AzureAISearchOptions<T>): void {
-    const { credentials, endpoint, indexName } =
-      this.#buildCredentials(options);
+    const { credential, endpoint, indexName } = this.#buildCredentials(options);
 
     consoleLogger.log(
       `Creating Azure Search index client for index ${indexName}`,
     );
     this.#indexClient = new SearchIndexClient(
       endpoint,
-      credentials as AzureKeyCredential,
+      credential as AzureKeyCredential | DefaultAzureCredential,
       {
         serviceVersion: this.#serviceApiVersion as string,
         userAgentOptions: {
@@ -850,14 +854,13 @@ export class AzureAISearchVectorStore<T extends R> extends BaseVectorStore {
   }
 
   #createSearchClient(options: AzureAISearchOptions<T>): void {
-    const { credentials, endpoint, indexName } =
-      this.#buildCredentials(options);
+    const { credential, endpoint, indexName } = this.#buildCredentials(options);
 
     consoleLogger.log(`Creating Azure Search client for index ${indexName}`);
     this.searchClient = new SearchClient<T>(
       endpoint,
       indexName,
-      credentials as AzureKeyCredential,
+      credential as AzureKeyCredential | DefaultAzureCredential,
       {
         serviceVersion: this.#serviceApiVersion as string,
         userAgentOptions: {