langchain 0.0.167 → 0.0.169

package/dist/vectorstores/closevector/node.d.ts

@@ -0,0 +1,83 @@
+import { CloseVectorHNSWNode, HierarchicalNSWT, CloseVectorHNSWLibArgs, CloseVectorCredentials } from "closevector-node";
+import { CloseVector } from "./common.js";
+import { Embeddings } from "../../embeddings/base.js";
+import { Document } from "../../document.js";
+/**
+ * package closevector-node is largely based on hnswlib.ts in the current folder with the following exceptions:
+ * 1. It uses a modified version of hnswlib-node to ensure the generated index can be loaded by closevector_web.ts.
+ * 2. It adds features to upload and download the index to/from the CDN provided by CloseVector.
+ *
+ * For more information, check out https://closevector-docs.getmegaportal.com/
+ */
+/**
+ * Arguments for creating a CloseVectorNode instance, extending CloseVectorHNSWLibArgs.
+ */
+export interface CloseVectorNodeArgs extends CloseVectorHNSWLibArgs<HierarchicalNSWT> {
+    instance?: CloseVectorHNSWNode;
+}
+/**
+ * Class that implements a vector store using Hierarchical Navigable Small
+ * World (HNSW) graphs. It extends the SaveableVectorStore class and
+ * provides methods for adding documents and vectors, performing
+ * similarity searches, and saving and loading the vector store.
+ */
+export declare class CloseVectorNode extends CloseVector<CloseVectorHNSWNode> {
+    FilterType: (doc: Document) => boolean;
+    constructor(embeddings: Embeddings, args: CloseVectorNodeArgs, credentials?: CloseVectorCredentials);
+    /**
+     * Method to save the index to the CloseVector CDN.
+     * @param options
+     * @param options.description A description of the index.
+     * @param options.public Whether the index should be public or private. Defaults to false.
+     * @param options.uuid A UUID for the index. If not provided, a new index will be created.
+     * @param options.onProgress A callback function that will be called with the progress of the upload.
+     */
+    saveToCloud(options: Parameters<CloseVectorHNSWNode["saveToCloud"]>[0]): Promise<void>;
+    /**
+     * Method to load the index from the CloseVector CDN.
+     * @param options
+     * @param options.uuid The UUID of the index to be downloaded.
+     * @param options.credentials The credentials to be used by the CloseVectorNode instance.
+     * @param options.embeddings The embeddings to be used by the CloseVectorNode instance.
+     * @param options.onProgress A callback function that will be called with the progress of the download.
+     */
+    static loadFromCloud(options: Omit<Parameters<(typeof CloseVectorHNSWNode)["loadFromCloud"]>[0] & {
+        embeddings: Embeddings;
+        credentials: CloseVectorCredentials;
+    }, "accessKey" | "secret">): Promise<CloseVectorNode>;
+    /**
+     * Static method to load a vector store from a directory. It reads the
+     * HNSW index, the arguments, and the document store from the directory,
+     * then creates a new HNSWLib instance with these values.
+     * @param directory The directory from which to load the vector store.
+     * @param embeddings The embeddings to be used by the CloseVectorNode instance.
+     * @returns A Promise that resolves to a new CloseVectorNode instance.
+     */
+    static load(directory: string, embeddings: Embeddings, credentials?: CloseVectorCredentials): Promise<CloseVectorNode>;
+    /**
+     * Static method to create a new CloseVectorWeb instance from texts and metadata.
+     * It creates a new Document instance for each text and metadata, then
+     * calls the fromDocuments method to create the CloseVectorWeb instance.
+     * @param texts The texts to be used to create the documents.
+     * @param metadatas The metadata to be used to create the documents.
+     * @param embeddings The embeddings to be used by the CloseVectorWeb instance.
+     * @param args An optional configuration object for the CloseVectorWeb instance.
+     * @param credential An optional credential object for the CloseVector API.
+     * @returns A Promise that resolves to a new CloseVectorWeb instance.
+     */
+    static fromTexts(texts: string[], metadatas: object[] | object, embeddings: Embeddings, args?: Record<string, unknown>, credential?: CloseVectorCredentials): Promise<CloseVectorNode>;
+    /**
+     * Static method to create a new CloseVectorNode instance from documents. It
+     * creates a new CloseVectorNode instance, adds the documents to it, then returns
+     * the instance.
+     * @param docs The documents to be added to the HNSWLib instance.
+     * @param embeddings The embeddings to be used by the HNSWLib instance.
+     * @param args An optional configuration object for the HNSWLib instance.
+     * @param credentials An optional credential object for the CloseVector API.
+     * @returns A Promise that resolves to a new CloseVectorNode instance.
+     */
+    static fromDocuments(docs: Document[], embeddings: Embeddings, args?: Record<string, unknown>, credentials?: CloseVectorCredentials): Promise<CloseVectorNode>;
+    static imports(): Promise<{
+        HierarchicalNSW: typeof HierarchicalNSWT;
+    }>;
+}

package/dist/vectorstores/closevector/node.js

@@ -0,0 +1,105 @@
+import { CloseVectorHNSWNode, } from "closevector-node";
+import { CloseVector } from "./common.js";
+/**
+ * Class that implements a vector store using Hierarchical Navigable Small
+ * World (HNSW) graphs. It extends the SaveableVectorStore class and
+ * provides methods for adding documents and vectors, performing
+ * similarity searches, and saving and loading the vector store.
+ */
+export class CloseVectorNode extends CloseVector {
+    constructor(embeddings, args, credentials) {
+        super(embeddings, args, credentials);
+        if (args.instance) {
+            this.instance = args.instance;
+        }
+        else {
+            this.instance = new CloseVectorHNSWNode(embeddings, args);
+        }
+        if (this.credentials?.key) {
+            this.instance.accessKey = this.credentials.key;
+        }
+        if (this.credentials?.secret) {
+            this.instance.secret = this.credentials.secret;
+        }
+    }
+    /**
+     * Method to save the index to the CloseVector CDN.
+     * @param options
+     * @param options.description A description of the index.
+     * @param options.public Whether the index should be public or private. Defaults to false.
+     * @param options.uuid A UUID for the index. If not provided, a new index will be created.
+     * @param options.onProgress A callback function that will be called with the progress of the upload.
+     */
+    async saveToCloud(options) {
+        await this.instance.saveToCloud(options);
+    }
+    /**
+     * Method to load the index from the CloseVector CDN.
+     * @param options
+     * @param options.uuid The UUID of the index to be downloaded.
+     * @param options.credentials The credentials to be used by the CloseVectorNode instance.
+     * @param options.embeddings The embeddings to be used by the CloseVectorNode instance.
+     * @param options.onProgress A callback function that will be called with the progress of the download.
+     */
+    static async loadFromCloud(options) {
+        if (!options.credentials.key || !options.credentials.secret) {
+            throw new Error("key and secret must be provided");
+        }
+        const instance = await CloseVectorHNSWNode.loadFromCloud({
+            ...options,
+            accessKey: options.credentials.key,
+            secret: options.credentials.secret,
+        });
+        const vectorstore = new this(options.embeddings, instance.args, options.credentials);
+        return vectorstore;
+    }
+    /**
+     * Static method to load a vector store from a directory. It reads the
+     * HNSW index, the arguments, and the document store from the directory,
+     * then creates a new HNSWLib instance with these values.
+     * @param directory The directory from which to load the vector store.
+     * @param embeddings The embeddings to be used by the CloseVectorNode instance.
+     * @returns A Promise that resolves to a new CloseVectorNode instance.
+     */
+    static async load(directory, embeddings, credentials) {
+        const instance = await CloseVectorHNSWNode.load(directory, embeddings);
+        const vectorstore = new this(embeddings, instance.args, credentials);
+        return vectorstore;
+    }
+    /**
+     * Static method to create a new CloseVectorWeb instance from texts and metadata.
+     * It creates a new Document instance for each text and metadata, then
+     * calls the fromDocuments method to create the CloseVectorWeb instance.
+     * @param texts The texts to be used to create the documents.
+     * @param metadatas The metadata to be used to create the documents.
+     * @param embeddings The embeddings to be used by the CloseVectorWeb instance.
+     * @param args An optional configuration object for the CloseVectorWeb instance.
+     * @param credential An optional credential object for the CloseVector API.
+     * @returns A Promise that resolves to a new CloseVectorWeb instance.
+     */
+    static async fromTexts(texts, metadatas, embeddings, args, credential) {
+        const docs = CloseVector.textsToDocuments(texts, metadatas);
+        return await CloseVectorNode.fromDocuments(docs, embeddings, args, credential);
+    }
+    /**
+     * Static method to create a new CloseVectorNode instance from documents. It
+     * creates a new CloseVectorNode instance, adds the documents to it, then returns
+     * the instance.
+     * @param docs The documents to be added to the HNSWLib instance.
+     * @param embeddings The embeddings to be used by the HNSWLib instance.
+     * @param args An optional configuration object for the HNSWLib instance.
+     * @param credentials An optional credential object for the CloseVector API.
+     * @returns A Promise that resolves to a new CloseVectorNode instance.
+     */
+    static async fromDocuments(docs, embeddings, args, credentials) {
+        const _args = args || {
+            space: "cosine",
+        };
+        const instance = new this(embeddings, _args, credentials);
+        await instance.addDocuments(docs);
+        return instance;
+    }
+    static async imports() {
+        return CloseVectorHNSWNode.imports();
+    }
+}

package/dist/vectorstores/closevector/web.cjs

@@ -0,0 +1,109 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CloseVectorWeb = void 0;
+const closevector_web_1 = require("closevector-web");
+const common_js_1 = require("./common.cjs");
+const document_js_1 = require("../../document.cjs");
+/**
+ * Class that implements a vector store using CloseVector, It extends the SaveableVectorStore class and
+ * provides methods for adding documents and vectors, performing
+ * similarity searches, and saving and loading the vector store.
+ */
+class CloseVectorWeb extends common_js_1.CloseVector {
+    constructor(embeddings, args, credentials) {
+        super(embeddings, args, credentials);
+        if (args.instance) {
+            this.instance = args.instance;
+        }
+        else {
+            this.instance = new closevector_web_1.CloseVectorHNSWWeb(embeddings, args);
+        }
+    }
+    /**
+     * Method to save the index to the CloseVector CDN.
+     * @param options
+     * @param options.url the upload url generated by the CloseVector API: https://closevector-docs.getmegaportal.com/docs/api/http-api/file-url
+     * @param options.onProgress a callback function to track the upload progress
+     */
+    async saveToCloud(options) {
+        if (!this.instance.uuid && !options.uuid) {
+            throw new Error("No uuid provided");
+        }
+        if (!this.instance.uuid) {
+            this.instance._uuid = options.uuid;
+        }
+        await this.save(this.instance.uuid);
+        await this.instance.saveToCloud(options);
+    }
+    /**
+     * Method to load the index from the CloseVector CDN.
+     * @param options
+     * @param options.url the upload url generated by the CloseVector API: https://closevector-docs.getmegaportal.com/docs/api/http-api/file-url
+     * @param options.onProgress a callback function to track the upload progress
+     * @param options.uuid the uuid of the index to be downloaded
+     * @param options.embeddings the embeddings to be used by the CloseVectorWeb instance
+     */
+    static async loadFromCloud(options) {
+        const instance = await closevector_web_1.CloseVectorHNSWWeb.loadFromCloud(options);
+        const vectorstore = new this(options.embeddings, instance.args, options.credentials);
+        return vectorstore;
+    }
+    /**
+     * Static method to load a vector store from a directory. It reads the
+     * HNSW index, the arguments, and the document store from the directory,
+     * then creates a new CloseVectorWeb instance with these values.
+     * @param directory The directory from which to load the vector store.
+     * @param embeddings The embeddings to be used by the CloseVectorWeb instance.
+     * @returns A Promise that resolves to a new CloseVectorWeb instance.
+     */
+    static async load(directory, embeddings, credentials) {
+        const instance = await closevector_web_1.CloseVectorHNSWWeb.load(directory, embeddings);
+        const vectorstore = new this(embeddings, instance.args, credentials);
+        return vectorstore;
+    }
+    /**
+     * Static method to create a new CloseVectorWeb instance from texts and metadata.
+     * It creates a new Document instance for each text and metadata, then
+     * calls the fromDocuments method to create the CloseVectorWeb instance.
+     * @param texts The texts to be used to create the documents.
+     * @param metadatas The metadata to be used to create the documents.
+     * @param embeddings The embeddings to be used by the CloseVectorWeb instance.
+     * @param args An optional configuration object for the CloseVectorWeb instance.
+     * @param credential An optional credential object for the CloseVector API.
+     * @returns A Promise that resolves to a new CloseVectorWeb instance.
+     */
+    static async fromTexts(texts, metadatas, embeddings, args, credential) {
+        const docs = [];
+        for (let i = 0; i < texts.length; i += 1) {
+            const metadata = Array.isArray(metadatas) ? metadatas[i] : metadatas;
+            const newDoc = new document_js_1.Document({
+                pageContent: texts[i],
+                metadata,
+            });
+            docs.push(newDoc);
+        }
+        return await CloseVectorWeb.fromDocuments(docs, embeddings, args, credential);
+    }
+    /**
+     * Static method to create a new CloseVectorWeb instance from documents. It
+     * creates a new CloseVectorWeb instance, adds the documents to it, then returns
+     * the instance.
+     * @param docs The documents to be added to the CloseVectorWeb instance.
+     * @param embeddings The embeddings to be used by the CloseVectorWeb instance.
+     * @param args An optional configuration object for the CloseVectorWeb instance.
+     * @param credentials An optional credential object for the CloseVector API.
+     * @returns A Promise that resolves to a new CloseVectorWeb instance.
+     */
+    static async fromDocuments(docs, embeddings, args, credentials) {
+        const _args = args || {
+            space: "cosine",
+        };
+        const instance = new this(embeddings, _args, credentials);
+        await instance.addDocuments(docs);
+        return instance;
+    }
+    static async imports() {
+        return closevector_web_1.CloseVectorHNSWWeb.imports();
+    }
+}
+exports.CloseVectorWeb = CloseVectorWeb;

package/dist/vectorstores/closevector/web.d.ts

@@ -0,0 +1,80 @@
+import { CloseVectorHNSWWeb, HierarchicalNSWT, CloseVectorHNSWLibArgs, CloseVectorCredentials, HnswlibModule } from "closevector-web";
+import { CloseVector } from "./common.js";
+import { Embeddings } from "../../embeddings/base.js";
+import { Document } from "../../document.js";
+/**
+ * package closevector-node is largely based on hnswlib.ts in the current folder with the following exceptions:
+ * 1. It uses a modified version of hnswlib-node to ensure the generated index can be loaded by closevector_web.ts.
+ * 2. It adds features to upload and download the index to/from the CDN provided by CloseVector.
+ *
+ * For more information, check out https://closevector-docs.getmegaportal.com/
+ */
+/**
+ * Arguments for creating a CloseVectorWeb instance, extending CloseVectorHNSWLibArgs.
+ */
+export interface CloseVectorWebArgs extends CloseVectorHNSWLibArgs<HierarchicalNSWT> {
+    instance?: CloseVectorHNSWWeb;
+}
+/**
+ * Class that implements a vector store using CloseVector, It extends the SaveableVectorStore class and
+ * provides methods for adding documents and vectors, performing
+ * similarity searches, and saving and loading the vector store.
+ */
+export declare class CloseVectorWeb extends CloseVector<CloseVectorHNSWWeb> {
+    FilterType: (doc: Document) => boolean;
+    constructor(embeddings: Embeddings, args: CloseVectorWebArgs, credentials?: CloseVectorCredentials);
+    /**
+     * Method to save the index to the CloseVector CDN.
+     * @param options
+     * @param options.url the upload url generated by the CloseVector API: https://closevector-docs.getmegaportal.com/docs/api/http-api/file-url
+     * @param options.onProgress a callback function to track the upload progress
+     */
+    saveToCloud(options: Parameters<typeof this.instance.saveToCloud>[0] & {
+        uuid?: string;
+    }): Promise<void>;
+    /**
+     * Method to load the index from the CloseVector CDN.
+     * @param options
+     * @param options.url the upload url generated by the CloseVector API: https://closevector-docs.getmegaportal.com/docs/api/http-api/file-url
+     * @param options.onProgress a callback function to track the upload progress
+     * @param options.uuid the uuid of the index to be downloaded
+     * @param options.embeddings the embeddings to be used by the CloseVectorWeb instance
+     */
+    static loadFromCloud(options: Parameters<typeof CloseVectorHNSWWeb.loadFromCloud>[0] & {
+        embeddings: Embeddings;
+        credentials?: CloseVectorCredentials;
+    }): Promise<CloseVectorWeb>;
+    /**
+     * Static method to load a vector store from a directory. It reads the
+     * HNSW index, the arguments, and the document store from the directory,
+     * then creates a new CloseVectorWeb instance with these values.
+     * @param directory The directory from which to load the vector store.
+     * @param embeddings The embeddings to be used by the CloseVectorWeb instance.
+     * @returns A Promise that resolves to a new CloseVectorWeb instance.
+     */
+    static load(directory: string, embeddings: Embeddings, credentials?: CloseVectorCredentials): Promise<CloseVectorWeb>;
+    /**
+     * Static method to create a new CloseVectorWeb instance from texts and metadata.
+     * It creates a new Document instance for each text and metadata, then
+     * calls the fromDocuments method to create the CloseVectorWeb instance.
+     * @param texts The texts to be used to create the documents.
+     * @param metadatas The metadata to be used to create the documents.
+     * @param embeddings The embeddings to be used by the CloseVectorWeb instance.
+     * @param args An optional configuration object for the CloseVectorWeb instance.
+     * @param credential An optional credential object for the CloseVector API.
+     * @returns A Promise that resolves to a new CloseVectorWeb instance.
+     */
+    static fromTexts(texts: string[], metadatas: object[] | object, embeddings: Embeddings, args?: Record<string, unknown>, credential?: CloseVectorCredentials): Promise<CloseVectorWeb>;
+    /**
+     * Static method to create a new CloseVectorWeb instance from documents. It
+     * creates a new CloseVectorWeb instance, adds the documents to it, then returns
+     * the instance.
+     * @param docs The documents to be added to the CloseVectorWeb instance.
+     * @param embeddings The embeddings to be used by the CloseVectorWeb instance.
+     * @param args An optional configuration object for the CloseVectorWeb instance.
+     * @param credentials An optional credential object for the CloseVector API.
+     * @returns A Promise that resolves to a new CloseVectorWeb instance.
+     */
+    static fromDocuments(docs: Document[], embeddings: Embeddings, args?: Record<string, unknown>, credentials?: CloseVectorCredentials): Promise<CloseVectorWeb>;
+    static imports(): Promise<HnswlibModule>;
+}

package/dist/vectorstores/closevector/web.js

@@ -0,0 +1,105 @@
+import { CloseVectorHNSWWeb, } from "closevector-web";
+import { CloseVector } from "./common.js";
+import { Document } from "../../document.js";
+/**
+ * Class that implements a vector store using CloseVector, It extends the SaveableVectorStore class and
+ * provides methods for adding documents and vectors, performing
+ * similarity searches, and saving and loading the vector store.
+ */
+export class CloseVectorWeb extends CloseVector {
+    constructor(embeddings, args, credentials) {
+        super(embeddings, args, credentials);
+        if (args.instance) {
+            this.instance = args.instance;
+        }
+        else {
+            this.instance = new CloseVectorHNSWWeb(embeddings, args);
+        }
+    }
+    /**
+     * Method to save the index to the CloseVector CDN.
+     * @param options
+     * @param options.url the upload url generated by the CloseVector API: https://closevector-docs.getmegaportal.com/docs/api/http-api/file-url
+     * @param options.onProgress a callback function to track the upload progress
+     */
+    async saveToCloud(options) {
+        if (!this.instance.uuid && !options.uuid) {
+            throw new Error("No uuid provided");
+        }
+        if (!this.instance.uuid) {
+            this.instance._uuid = options.uuid;
+        }
+        await this.save(this.instance.uuid);
+        await this.instance.saveToCloud(options);
+    }
+    /**
+     * Method to load the index from the CloseVector CDN.
+     * @param options
+     * @param options.url the upload url generated by the CloseVector API: https://closevector-docs.getmegaportal.com/docs/api/http-api/file-url
+     * @param options.onProgress a callback function to track the upload progress
+     * @param options.uuid the uuid of the index to be downloaded
+     * @param options.embeddings the embeddings to be used by the CloseVectorWeb instance
+     */
+    static async loadFromCloud(options) {
+        const instance = await CloseVectorHNSWWeb.loadFromCloud(options);
+        const vectorstore = new this(options.embeddings, instance.args, options.credentials);
+        return vectorstore;
+    }
+    /**
+     * Static method to load a vector store from a directory. It reads the
+     * HNSW index, the arguments, and the document store from the directory,
+     * then creates a new CloseVectorWeb instance with these values.
+     * @param directory The directory from which to load the vector store.
+     * @param embeddings The embeddings to be used by the CloseVectorWeb instance.
+     * @returns A Promise that resolves to a new CloseVectorWeb instance.
+     */
+    static async load(directory, embeddings, credentials) {
+        const instance = await CloseVectorHNSWWeb.load(directory, embeddings);
+        const vectorstore = new this(embeddings, instance.args, credentials);
+        return vectorstore;
+    }
+    /**
+     * Static method to create a new CloseVectorWeb instance from texts and metadata.
+     * It creates a new Document instance for each text and metadata, then
+     * calls the fromDocuments method to create the CloseVectorWeb instance.
+     * @param texts The texts to be used to create the documents.
+     * @param metadatas The metadata to be used to create the documents.
+     * @param embeddings The embeddings to be used by the CloseVectorWeb instance.
+     * @param args An optional configuration object for the CloseVectorWeb instance.
+     * @param credential An optional credential object for the CloseVector API.
+     * @returns A Promise that resolves to a new CloseVectorWeb instance.
+     */
+    static async fromTexts(texts, metadatas, embeddings, args, credential) {
+        const docs = [];
+        for (let i = 0; i < texts.length; i += 1) {
+            const metadata = Array.isArray(metadatas) ? metadatas[i] : metadatas;
+            const newDoc = new Document({
+                pageContent: texts[i],
+                metadata,
+            });
+            docs.push(newDoc);
+        }
+        return await CloseVectorWeb.fromDocuments(docs, embeddings, args, credential);
+    }
+    /**
+     * Static method to create a new CloseVectorWeb instance from documents. It
+     * creates a new CloseVectorWeb instance, adds the documents to it, then returns
+     * the instance.
+     * @param docs The documents to be added to the CloseVectorWeb instance.
+     * @param embeddings The embeddings to be used by the CloseVectorWeb instance.
+     * @param args An optional configuration object for the CloseVectorWeb instance.
+     * @param credentials An optional credential object for the CloseVector API.
+     * @returns A Promise that resolves to a new CloseVectorWeb instance.
+     */
+    static async fromDocuments(docs, embeddings, args, credentials) {
+        const _args = args || {
+            space: "cosine",
+        };
+        const instance = new this(embeddings, _args, credentials);
+        await instance.addDocuments(docs);
+        return instance;
+    }
+    static async imports() {
+        return CloseVectorHNSWWeb.imports();
+    }
+}

package/dist/vectorstores/faiss.cjs

@@ -80,9 +80,9 @@ class FaissStore extends base_js_1.SaveableVectorStore {
      * @param documents An array of Document objects.
      * @returns A Promise that resolves when the documents have been added.
      */
-    async addDocuments(documents) {
+    async addDocuments(documents, options) {
         const texts = documents.map(({ pageContent }) => pageContent);
-        return this.addVectors(await this.embeddings.embedDocuments(texts), documents);
+        return this.addVectors(await this.embeddings.embedDocuments(texts), documents, options);
     }
     get index() {
         if (!this._index) {
@@ -100,7 +100,7 @@ class FaissStore extends base_js_1.SaveableVectorStore {
      * @param documents An array of Document objects corresponding to the vectors.
      * @returns A Promise that resolves with an array of document IDs when the vectors and documents have been added.
      */
-    async addVectors(vectors, documents) {
+    async addVectors(vectors, documents, options) {
         if (vectors.length === 0) {
             return [];
         }
@@ -117,10 +117,9 @@ class FaissStore extends base_js_1.SaveableVectorStore {
             throw new Error(`Vectors must have the same length as the number of dimensions (${d})`);
         }
         const docstoreSize = this.index.ntotal();
-        const documentIds = [];
+        const documentIds = options?.ids ?? documents.map(() => uuid.v4());
         for (let i = 0; i < vectors.length; i += 1) {
-            const documentId = uuid.v4();
-            documentIds.push(documentId);
+            const documentId = documentIds[i];
             const id = docstoreSize + i;
             this.index.add(vectors[i]);
             this._mapping[id] = documentId;
@@ -169,6 +168,39 @@ class FaissStore extends base_js_1.SaveableVectorStore {
             ])),
         ]);
     }
+    /**
+     * Method to delete documents.
+     * @param params Object containing the IDs of the documents to delete.
+     * @returns A promise that resolves when the deletion is complete.
+     */
+    async delete(params) {
+        const documentIds = params.ids;
+        if (documentIds == null) {
+            throw new Error("No documentIds provided to delete.");
+        }
+        const mappings = new Map(Object.entries(this._mapping).map(([key, value]) => [
+            parseInt(key, 10),
+            value,
+        ]));
+        const reversedMappings = new Map(Array.from(mappings, (entry) => [entry[1], entry[0]]));
+        const missingIds = new Set(documentIds.filter((id) => !reversedMappings.has(id)));
+        if (missingIds.size > 0) {
+            throw new Error(`Some specified documentIds do not exist in the current store. DocumentIds not found: ${Array.from(missingIds).join(", ")}`);
+        }
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        const indexIdToDelete = documentIds.map((id) => reversedMappings.get(id));
+        // remove from index
+        this.index.removeIds(indexIdToDelete);
+        // remove from docstore
+        documentIds.forEach((id) => {
+            this.docstore._docs.delete(id);
+        });
+        // remove from mappings
+        indexIdToDelete.forEach((id) => {
+            mappings.delete(id);
+        });
+        this._mapping = { ...Array.from(mappings.values()) };
+    }
     /**
      * Merges the current FaissStore with another FaissStore.
      * @param targetIndex The FaissStore to merge with.

package/dist/vectorstores/faiss.d.ts

@@ -32,7 +32,9 @@ export declare class FaissStore extends SaveableVectorStore {
      * @param documents An array of Document objects.
      * @returns A Promise that resolves when the documents have been added.
      */
-    addDocuments(documents: Document[]): Promise<string[]>;
+    addDocuments(documents: Document[], options?: {
+        ids?: string[];
+    }): Promise<string[]>;
     get index(): IndexFlatL2;
     private set index(value);
     /**
@@ -42,7 +44,9 @@ export declare class FaissStore extends SaveableVectorStore {
      * @param documents An array of Document objects corresponding to the vectors.
      * @returns A Promise that resolves with an array of document IDs when the vectors and documents have been added.
      */
-    addVectors(vectors: number[][], documents: Document[]): Promise<string[]>;
+    addVectors(vectors: number[][], documents: Document[], options?: {
+        ids?: string[];
+    }): Promise<string[]>;
     /**
      * Performs a similarity search in the vector store using a query vector
      * and returns the top k results along with their scores.
@@ -57,6 +61,14 @@ export declare class FaissStore extends SaveableVectorStore {
      * @returns A Promise that resolves when the state has been saved.
      */
     save(directory: string): Promise<void>;
+    /**
+     * Method to delete documents.
+     * @param params Object containing the IDs of the documents to delete.
+     * @returns A promise that resolves when the deletion is complete.
+     */
+    delete(params: {
+        ids: string[];
+    }): Promise<void>;
     /**
      * Merges the current FaissStore with another FaissStore.
      * @param targetIndex The FaissStore to merge with.

package/dist/vectorstores/faiss.js

@@ -54,9 +54,9 @@ export class FaissStore extends SaveableVectorStore {
      * @param documents An array of Document objects.
      * @returns A Promise that resolves when the documents have been added.
      */
-    async addDocuments(documents) {
+    async addDocuments(documents, options) {
         const texts = documents.map(({ pageContent }) => pageContent);
-        return this.addVectors(await this.embeddings.embedDocuments(texts), documents);
+        return this.addVectors(await this.embeddings.embedDocuments(texts), documents, options);
     }
     get index() {
         if (!this._index) {
@@ -74,7 +74,7 @@ export class FaissStore extends SaveableVectorStore {
      * @param documents An array of Document objects corresponding to the vectors.
      * @returns A Promise that resolves with an array of document IDs when the vectors and documents have been added.
      */
-    async addVectors(vectors, documents) {
+    async addVectors(vectors, documents, options) {
         if (vectors.length === 0) {
             return [];
         }
@@ -91,10 +91,9 @@ export class FaissStore extends SaveableVectorStore {
             throw new Error(`Vectors must have the same length as the number of dimensions (${d})`);
         }
         const docstoreSize = this.index.ntotal();
-        const documentIds = [];
+        const documentIds = options?.ids ?? documents.map(() => uuid.v4());
         for (let i = 0; i < vectors.length; i += 1) {
-            const documentId = uuid.v4();
-            documentIds.push(documentId);
+            const documentId = documentIds[i];
             const id = docstoreSize + i;
             this.index.add(vectors[i]);
             this._mapping[id] = documentId;
@@ -143,6 +142,39 @@ export class FaissStore extends SaveableVectorStore {
             ])),
         ]);
     }
+    /**
+     * Method to delete documents.
+     * @param params Object containing the IDs of the documents to delete.
+     * @returns A promise that resolves when the deletion is complete.
+     */
+    async delete(params) {
+        const documentIds = params.ids;
+        if (documentIds == null) {
+            throw new Error("No documentIds provided to delete.");
+        }
+        const mappings = new Map(Object.entries(this._mapping).map(([key, value]) => [
+            parseInt(key, 10),
+            value,
+        ]));
+        const reversedMappings = new Map(Array.from(mappings, (entry) => [entry[1], entry[0]]));
+        const missingIds = new Set(documentIds.filter((id) => !reversedMappings.has(id)));
+        if (missingIds.size > 0) {
+            throw new Error(`Some specified documentIds do not exist in the current store. DocumentIds not found: ${Array.from(missingIds).join(", ")}`);
+        }
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        const indexIdToDelete = documentIds.map((id) => reversedMappings.get(id));
+        // remove from index
+        this.index.removeIds(indexIdToDelete);
+        // remove from docstore
+        documentIds.forEach((id) => {
+            this.docstore._docs.delete(id);
+        });
+        // remove from mappings
+        indexIdToDelete.forEach((id) => {
+            mappings.delete(id);
+        });
+        this._mapping = { ...Array.from(mappings.values()) };
+    }
     /**
      * Merges the current FaissStore with another FaissStore.
      * @param targetIndex The FaissStore to merge with.