Feat: Weaviate delete with filter (langchain-ai#2093)

* Feature: Weaviate delete with filter

* remove redundancy in delete function

* create deleteIndex static method in weaviate

* removed deleteIndex static method

* Skip test, add fallthrough case

---------

Co-authored-by: jacoblee93 <[email protected]>

Author: neebdev

examples/src/indexes/vector_stores/weaviate_delete.ts

@@ -32,11 +32,51 @@ export async function run() {
   [ Document { pageContent: 'see ya!', metadata: { foo: 'bar' } } ]
   */
 
+  // Delete documents with ids
   await store.delete({ ids });
 
   const results2 = await store.similaritySearch("see ya!", 1);
   console.log(results2);
   /*
   []
   */
+
+  const docs2 = [
+    { pageContent: "hello world", metadata: { foo: "bar" } },
+    { pageContent: "hi there", metadata: { foo: "baz" } },
+    { pageContent: "how are you", metadata: { foo: "qux" } },
+    { pageContent: "hello world", metadata: { foo: "bar" } },
+    { pageContent: "bye now", metadata: { foo: "bar" } },
+  ];
+
+  await store.addDocuments(docs2);
+
+  const results3 = await store.similaritySearch("hello world", 1);
+  console.log(results3);
+  /*
+  [ Document { pageContent: 'hello world', metadata: { foo: 'bar' } } ]
+  */
+
+  // delete documents with filter
+  await store.delete({
+    filter: {
+      where: {
+        operator: "Equal",
+        path: ["foo"],
+        valueText: "bar",
+      },
+    },
+  });
+
+  const results4 = await store.similaritySearch("hello world", 1, {
+    where: {
+      operator: "Equal",
+      path: ["foo"],
+      valueText: "bar",
+    },
+  });
+  console.log(results4);
+  /*
+  []
+  */
 }

langchain/src/vectorstores/tests/weaviate.int.test.ts

@@ -108,14 +108,14 @@ test.skip("WeaviateStore upsert + delete", async () => {
     [
       new Document({
         pageContent: "testing",
-        metadata: { deletionTest: createdAt },
+        metadata: { deletionTest: createdAt.toString() },
       }),
     ],
     new OpenAIEmbeddings(),
     {
       client,
       indexName: "DocumentTest",
-      textKey: "text",
+      textKey: "pageContent",
       metadataKeys: ["deletionTest"],
     }
   );
@@ -199,3 +199,49 @@ test.skip("WeaviateStore upsert + delete", async () => {
     }),
   ]);
 });
+
+test.skip("WeaviateStore delete with filter", async () => {
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  const client = (weaviate as any).client({
+    scheme:
+      process.env.WEAVIATE_SCHEME ||
+      (process.env.WEAVIATE_HOST ? "https" : "http"),
+    host: process.env.WEAVIATE_HOST || "localhost:8080",
+    apiKey: process.env.WEAVIATE_API_KEY
+      ? // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        new (weaviate as any).ApiKey(process.env.WEAVIATE_API_KEY)
+      : undefined,
+  });
+  const store = await WeaviateStore.fromTexts(
+    ["hello world", "hi there", "how are you", "bye now"],
+    [{ foo: "bar" }, { foo: "baz" }, { foo: "qux" }, { foo: "bar" }],
+    new OpenAIEmbeddings(),
+    {
+      client,
+      indexName: "FilterDeletionTest",
+      textKey: "text",
+      metadataKeys: ["foo"],
+    }
+  );
+  const results = await store.similaritySearch("hello world", 1);
+  expect(results).toEqual([
+    new Document({ pageContent: "hello world", metadata: { foo: "bar" } }),
+  ]);
+  await store.delete({
+    filter: {
+      where: {
+        operator: "Equal",
+        path: ["foo"],
+        valueText: "bar",
+      },
+    },
+  });
+  const results2 = await store.similaritySearch("hello world", 1, {
+    where: {
+      operator: "Equal",
+      path: ["foo"],
+      valueText: "bar",
+    },
+  });
+  expect(results2).toEqual([]);
+});

langchain/src/vectorstores/weaviate.ts

@@ -155,14 +155,30 @@ export class WeaviateStore extends VectorStore {
     );
   }
 
-  async delete(params: { ids: string[] }): Promise<void> {
-    const { ids } = params;
-    for (const id of ids) {
-      await this.client.data
-        .deleter()
+  async delete(params: {
+    ids?: string[];
+    filter?: WeaviateFilter;
+  }): Promise<void> {
+    const { ids, filter } = params;
+
+    if (ids && ids.length > 0) {
+      for (const id of ids) {
+        await this.client.data
+          .deleter()
+          .withClassName(this.indexName)
+          .withId(id)
+          .do();
+      }
+    } else if (filter) {
+      await this.client.batch
+        .objectsBatchDeleter()
         .withClassName(this.indexName)
-        .withId(id)
+        .withWhere(filter.where)
         .do();
+    } else {
+      throw new Error(
+        `This method requires either "ids" or "filter" to be set in the input object`
+      );
     }
   }