community[patch]: Upstash Vector Store Namespace Feature

examples/package.json

@@ -67,7 +67,7 @@
     "@supabase/supabase-js": "^2.10.0",
     "@tensorflow/tfjs-backend-cpu": "^4.4.0",
     "@upstash/redis": "^1.20.6",
-    "@upstash/vector": "^1.0.7",
+    "@upstash/vector": "^1.1.1",
     "@vercel/kv": "^0.2.3",
     "@xata.io/client": "^0.28.0",
     "@zilliz/milvus2-sdk-node": "^2.2.7",

libs/langchain-community/package.json

@@ -127,7 +127,7 @@
     "@typescript-eslint/parser": "^5.58.0",
     "@upstash/ratelimit": "^1.1.3",
     "@upstash/redis": "^1.20.6",
-    "@upstash/vector": "^1.0.7",
+    "@upstash/vector": "^1.1.1",
     "@vercel/kv": "^0.2.3",
     "@vercel/postgres": "^0.5.0",
     "@writerai/writer-sdk": "^0.40.2",
@@ -266,7 +266,7 @@
     "@tensorflow/tfjs-core": "*",
     "@upstash/ratelimit": "^1.1.3",
     "@upstash/redis": "^1.20.6",
-    "@upstash/vector": "^1.0.7",
+    "@upstash/vector": "^1.1.1",
     "@vercel/kv": "^0.2.3",
     "@vercel/postgres": "^0.5.0",
     "@writerai/writer-sdk": "^0.40.2",

libs/langchain-community/src/vectorstores/tests/upstash.int.test.ts

@@ -172,4 +172,89 @@ describe("UpstashVectorStore", () => {
 
     expect(results3).toHaveLength(2);
   });
+
+  test("Should upsert the documents to target namespace", async () => {
+    index = new Index({
+      url: process.env.UPSTASH_VECTOR_REST_URL,
+      token: process.env.UPSTASH_VECTOR_REST_TOKEN,
+    });
+
+    await index.reset();
+
+    embeddings = new SyntheticEmbeddings({
+      vectorSize: 384,
+    });
+
+    const storeNamespace1 = new UpstashVectorStore(embeddings, {
+      index,
+      namespace: "namespace-1",
+    });
+    const storeNamespace2 = new UpstashVectorStore(embeddings, {
+      index,
+      namespace: "namespace-2",
+    });
+
+
+    await storeNamespace1.addDocuments([
+      { pageContent: "namespace-test-original", metadata: { namespace: "namespace-1" } },
+    ]);
+
+    // Sleeping for a second to make sure that all the indexing operations are finished.
+    await sleep(1000);
+
+    const resultsNamespace2 = await storeNamespace2.similaritySearchWithScore("namespace-test-original", 1, "namespace = 'namespace-1'");
+    expect(resultsNamespace2).toHaveLength(0);
+
+    const resultsNamespace1 = await storeNamespace1.similaritySearchWithScore("namespace-test-original", 1, "namespace = 'namespace-1'");
+    expect(resultsNamespace1).toHaveLength(1);
+
+    expect([resultsNamespace1[0][0]]).toEqual([
+      new Document({ metadata: { namespace: "namespace-1" }, pageContent: "namespace-test-original" }),
+    ]);
+  })
+
+  test("Should delete the documents from target namespace", async () => {
+    index = new Index({
+      url: process.env.UPSTASH_VECTOR_REST_URL,
+      token: process.env.UPSTASH_VECTOR_REST_TOKEN,
+    });
+
+    await index.reset();
+
+    embeddings = new SyntheticEmbeddings({
+      vectorSize: 384,
+    });
+
+    const storeNamespace1 = new UpstashVectorStore(embeddings, {
+      index,
+      namespace: "namespace-1",
+    });
+    const storeNamespace2 = new UpstashVectorStore(embeddings, {
+      index,
+      namespace: "namespace-2",
+    });
+
+
+    const idNamespace1 = await storeNamespace1.addDocuments([
+      { pageContent: "namespace-test-original", metadata: { namespace: "namespace-test" } },
+    ]);
+    await storeNamespace2.addDocuments([
+      { pageContent: "namespace-test-original", metadata: { namespace: "namespace-test" } },
+    ]);
+
+    // Sleeping for a second to make sure that all the indexing operations are finished.
+    await sleep(1000);
+
+    await storeNamespace1.delete({ ids: idNamespace1 });
+
+    const resultsNamespace1 = await storeNamespace1.similaritySearchWithScore("namespace-test-original", 1, "namespace = 'namespace-test'");
+    expect(resultsNamespace1).toHaveLength(0);
+
+    const resultsNamespace2 = await storeNamespace2.similaritySearchWithScore("namespace-test-original", 1, "namespace = 'namespace-test'");
+    expect(resultsNamespace2).toHaveLength(1);
+
+    expect([resultsNamespace2[0][0]]).toEqual([
+      new Document({ metadata: { namespace: "namespace-test" }, pageContent: "namespace-test-original" }),
+    ]);
+  })
 });

libs/langchain-community/src/vectorstores/upstash.ts

@@ -17,6 +17,7 @@ import {
 export interface UpstashVectorLibArgs extends AsyncCallerParams {
   index: UpstashIndex;
   filter?: string;
+  namespace?: string;
 }
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -33,9 +34,9 @@ export type UpstashQueryMetadata = UpstashMetadata & {
  */
 export type UpstashDeleteParams =
   | {
-      ids: string | string[];
-      deleteAll?: never;
-    }
+    ids: string | string[];
+    deleteAll?: never;
+  }
   | { deleteAll: boolean; ids?: never };
 
 const CONCURRENT_UPSERT_LIMIT = 1000;
@@ -56,6 +57,8 @@ export class UpstashVectorStore extends VectorStore {
 
   filter?: this["FilterType"];
 
+  namespace?: string;
+
   _vectorstoreType(): string {
     return "upstash";
   }
@@ -68,11 +71,12 @@ export class UpstashVectorStore extends VectorStore {
       this.useUpstashEmbeddings = true;
     }
 
-    const { index, ...asyncCallerArgs } = args;
+    const { index, namespace, ...asyncCallerArgs } = args;
 
     this.index = index;
     this.caller = new AsyncCaller(asyncCallerArgs);
     this.filter = args.filter;
+    this.namespace = namespace;
   }
 
   /**
@@ -127,10 +131,12 @@ export class UpstashVectorStore extends VectorStore {
       };
     });
 
+    const namespace = this.index.namespace(this.namespace ?? "")
+
     const vectorChunks = chunkArray(upstashVectors, CONCURRENT_UPSERT_LIMIT);
 
     const batchRequests = vectorChunks.map((chunk) =>
-      this.caller.call(async () => this.index.upsert(chunk))
+      this.caller.call(async () => namespace.upsert(chunk))
     );
 
     await Promise.all(batchRequests);
@@ -166,13 +172,14 @@ export class UpstashVectorStore extends VectorStore {
       };
     });
 
+    const namespace = this.index.namespace(this.namespace ?? "")
     const vectorChunks = chunkArray(
       upstashVectorsWithData,
       CONCURRENT_UPSERT_LIMIT
     );
 
     const batchRequests = vectorChunks.map((chunk) =>
-      this.caller.call(async () => this.index.upsert(chunk))
+      this.caller.call(async () => namespace.upsert(chunk))
     );
 
     await Promise.all(batchRequests);
@@ -187,10 +194,11 @@ export class UpstashVectorStore extends VectorStore {
    * @returns Promise that resolves when the specified documents have been deleted from the database.
    */
   async delete(params: UpstashDeleteParams): Promise<void> {
+    const namespace = this.index.namespace(this.namespace ?? "")
     if (params.deleteAll) {
-      await this.index.reset();
+      await namespace.reset();
     } else if (params.ids) {
-      await this.index.delete(params.ids);
+      await namespace.delete(params.ids);
     }
   }
 
@@ -202,16 +210,18 @@ export class UpstashVectorStore extends VectorStore {
   ) {
     let queryResult: QueryResult<UpstashQueryMetadata>[] = [];
 
+    const namespace = this.index.namespace(this.namespace ?? "")
+
     if (typeof query === "string") {
-      queryResult = await this.index.query<UpstashQueryMetadata>({
+      queryResult = await namespace.query<UpstashQueryMetadata>({
         data: query,
         topK: k,
         includeMetadata: true,
         filter,
         ...options,
       });
     } else {
-      queryResult = await this.index.query<UpstashQueryMetadata>({
+      queryResult = await namespace.query<UpstashQueryMetadata>({
         vector: query,
         topK: k,
         includeMetadata: true,

yarn.lock

@@ -9140,7 +9140,7 @@ __metadata:
     "@typescript-eslint/parser": ^5.58.0
     "@upstash/ratelimit": ^1.1.3
     "@upstash/redis": ^1.20.6
-    "@upstash/vector": ^1.0.7
+    "@upstash/vector": ^1.1.1
     "@vercel/kv": ^0.2.3
     "@vercel/postgres": ^0.5.0
     "@writerai/writer-sdk": ^0.40.2
@@ -9287,7 +9287,7 @@ __metadata:
     "@tensorflow/tfjs-core": "*"
     "@upstash/ratelimit": ^1.1.3
     "@upstash/redis": ^1.20.6
-    "@upstash/vector": ^1.0.7
+    "@upstash/vector": ^1.1.1
     "@vercel/kv": ^0.2.3
     "@vercel/postgres": ^0.5.0
     "@writerai/writer-sdk": ^0.40.2
@@ -16131,10 +16131,10 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@upstash/vector@npm:^1.0.7":
-  version: 1.0.7
-  resolution: "@upstash/vector@npm:1.0.7"
-  checksum: 38d6ef4fd8cd970e3b83e39cf90e0f57622ac032afc409fa6782911ec2452d19decb0184c5a8f7849b8fb06c865c9397f142633a31cea49e82dd6fc4b43e8484
+"@upstash/vector@npm:^1.1.1":
+  version: 1.1.1
+  resolution: "@upstash/vector@npm:1.1.1"
+  checksum: 2eeaa655b46d9182dfdb5e12ff58654e820df18e7b03e8cfff2795cbdb370cc7652a198638f36e8f29dab3e6a67004cda693b62e0885dc87472a08f908ffe0e6
   languageName: node
   linkType: hard
 
@@ -22526,7 +22526,7 @@ __metadata:
     "@typescript-eslint/eslint-plugin": ^5.51.0
     "@typescript-eslint/parser": ^5.51.0
     "@upstash/redis": ^1.20.6
-    "@upstash/vector": ^1.0.7
+    "@upstash/vector": ^1.1.1
     "@vercel/kv": ^0.2.3
     "@xata.io/client": ^0.28.0
     "@zilliz/milvus2-sdk-node": ^2.2.7