langchain 0.0.131 → 0.0.132

package/dist/vectorstores/elasticsearch.cjs

@@ -27,6 +27,12 @@ exports.ElasticVectorSearch = void 0;
 const uuid = __importStar(require("uuid"));
 const document_js_1 = require("../document.cjs");
 const base_js_1 = require("./base.cjs");
+/**
+ * Class for interacting with an Elasticsearch database. It extends the
+ * VectorStore base class and provides methods for adding documents and
+ * vectors to the Elasticsearch database, performing similarity searches,
+ * deleting documents, and more.
+ */
 class ElasticVectorSearch extends base_js_1.VectorStore {
     _vectorstoreType() {
         return "elasticsearch";
@@ -83,10 +89,27 @@ class ElasticVectorSearch extends base_js_1.VectorStore {
         this.client = args.client;
         this.indexName = args.indexName ?? "documents";
     }
+    /**
+     * Method to add documents to the Elasticsearch database. It first
+     * converts the documents to vectors using the embeddings, then adds the
+     * vectors to the database.
+     * @param documents The documents to add to the database.
+     * @param options Optional parameter that can contain the IDs for the documents.
+     * @returns A promise that resolves with the IDs of the added documents.
+     */
     async addDocuments(documents, options) {
         const texts = documents.map(({ pageContent }) => pageContent);
         return this.addVectors(await this.embeddings.embedDocuments(texts), documents, options);
     }
+    /**
+     * Method to add vectors to the Elasticsearch database. It ensures the
+     * index exists, then adds the vectors and their corresponding documents
+     * to the database.
+     * @param vectors The vectors to add to the database.
+     * @param documents The documents corresponding to the vectors.
+     * @param options Optional parameter that can contain the IDs for the documents.
+     * @returns A promise that resolves with the IDs of the added documents.
+     */
     async addVectors(vectors, documents, options) {
         await this.ensureIndexExists(vectors[0].length, this.engine, this.similarity, this.efConstruction, this.m);
         const documentIds = options?.ids ?? Array.from({ length: vectors.length }, () => uuid.v4());
@@ -106,6 +129,15 @@ class ElasticVectorSearch extends base_js_1.VectorStore {
         await this.client.bulk({ refresh: true, operations });
         return documentIds;
     }
+    /**
+     * Method to perform a similarity search in the Elasticsearch database
+     * using a vector. It returns the k most similar documents along with
+     * their similarity scores.
+     * @param query The query vector.
+     * @param k The number of most similar documents to return.
+     * @param filter Optional filter to apply to the search.
+     * @returns A promise that resolves with an array of tuples, where each tuple contains a Document and its similarity score.
+     */
     async similaritySearchVectorWithScore(query, k, filter) {
         const result = await this.client.search({
             index: this.indexName,
@@ -127,6 +159,11 @@ class ElasticVectorSearch extends base_js_1.VectorStore {
             hit._score,
         ]);
     }
+    /**
+     * Method to delete documents from the Elasticsearch database.
+     * @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 operations = params.ids.map((id) => ({
             delete: {
@@ -136,6 +173,17 @@ class ElasticVectorSearch extends base_js_1.VectorStore {
         }));
         await this.client.bulk({ refresh: true, operations });
     }
+    /**
+     * Static method to create an ElasticVectorSearch instance from texts. It
+     * creates Document instances from the texts and their corresponding
+     * metadata, then calls the fromDocuments method to create the
+     * ElasticVectorSearch instance.
+     * @param texts The texts to create the ElasticVectorSearch instance from.
+     * @param metadatas The metadata corresponding to the texts.
+     * @param embeddings The embeddings to use for the documents.
+     * @param args The arguments to create the Elasticsearch client.
+     * @returns A promise that resolves with the created ElasticVectorSearch instance.
+     */
     static fromTexts(texts, metadatas, embeddings, args) {
         const documents = texts.map((text, idx) => {
             const metadata = Array.isArray(metadatas) ? metadatas[idx] : metadatas;
@@ -143,11 +191,28 @@ class ElasticVectorSearch extends base_js_1.VectorStore {
         });
         return ElasticVectorSearch.fromDocuments(documents, embeddings, args);
     }
+    /**
+     * Static method to create an ElasticVectorSearch instance from Document
+     * instances. It adds the documents to the Elasticsearch database, then
+     * returns the ElasticVectorSearch instance.
+     * @param docs The Document instances to create the ElasticVectorSearch instance from.
+     * @param embeddings The embeddings to use for the documents.
+     * @param dbConfig The configuration for the Elasticsearch database.
+     * @returns A promise that resolves with the created ElasticVectorSearch instance.
+     */
     static async fromDocuments(docs, embeddings, dbConfig) {
         const store = new ElasticVectorSearch(embeddings, dbConfig);
         await store.addDocuments(docs).then(() => store);
         return store;
     }
+    /**
+     * Static method to create an ElasticVectorSearch instance from an
+     * existing index in the Elasticsearch database. It checks if the index
+     * exists, then returns the ElasticVectorSearch instance if it does.
+     * @param embeddings The embeddings to use for the documents.
+     * @param dbConfig The configuration for the Elasticsearch database.
+     * @returns A promise that resolves with the created ElasticVectorSearch instance if the index exists, otherwise it throws an error.
+     */
     static async fromExistingIndex(embeddings, dbConfig) {
         const store = new ElasticVectorSearch(embeddings, dbConfig);
         const exists = await store.doesIndexExist();
@@ -200,9 +265,17 @@ class ElasticVectorSearch extends base_js_1.VectorStore {
         }
         return result;
     }
+    /**
+     * Method to check if an index exists in the Elasticsearch database.
+     * @returns A promise that resolves with a boolean indicating whether the index exists.
+     */
     async doesIndexExist() {
         return await this.client.indices.exists({ index: this.indexName });
     }
+    /**
+     * Method to delete an index from the Elasticsearch database if it exists.
+     * @returns A promise that resolves when the deletion is complete.
+     */
     async deleteIfExists() {
         const indexExists = await this.doesIndexExist();
         if (!indexExists)

package/dist/vectorstores/elasticsearch.d.ts

@@ -2,8 +2,18 @@ import { Client } from "@elastic/elasticsearch";
 import { Embeddings } from "../embeddings/base.js";
 import { Document } from "../document.js";
 import { VectorStore } from "./base.js";
+/**
+ * Type representing the k-nearest neighbors (k-NN) engine used in
+ * Elasticsearch.
+ */
 type ElasticKnnEngine = "hnsw";
+/**
+ * Type representing the similarity measure used in Elasticsearch.
+ */
 type ElasticSimilarity = "l2_norm" | "dot_product" | "cosine";
+/**
+ * Interface defining the options for vector search in Elasticsearch.
+ */
 interface VectorSearchOptions {
     readonly engine?: ElasticKnnEngine;
     readonly similarity?: ElasticSimilarity;
@@ -11,12 +21,25 @@ interface VectorSearchOptions {
     readonly efConstruction?: number;
     readonly candidates?: number;
 }
+/**
+ * Interface defining the arguments required to create an Elasticsearch
+ * client.
+ */
 export interface ElasticClientArgs {
     readonly client: Client;
     readonly indexName?: string;
     readonly vectorSearchOptions?: VectorSearchOptions;
 }
+/**
+ * Type representing a filter object in Elasticsearch.
+ */
 type ElasticFilter = object;
+/**
+ * Class for interacting with an Elasticsearch database. It extends the
+ * VectorStore base class and provides methods for adding documents and
+ * vectors to the Elasticsearch database, performing similarity searches,
+ * deleting documents, and more.
+ */
 export declare class ElasticVectorSearch extends VectorStore {
     FilterType: ElasticFilter;
     private readonly client;
@@ -28,22 +51,89 @@ export declare class ElasticVectorSearch extends VectorStore {
     private readonly candidates;
     _vectorstoreType(): string;
     constructor(embeddings: Embeddings, args: ElasticClientArgs);
+    /**
+     * Method to add documents to the Elasticsearch database. It first
+     * converts the documents to vectors using the embeddings, then adds the
+     * vectors to the database.
+     * @param documents The documents to add to the database.
+     * @param options Optional parameter that can contain the IDs for the documents.
+     * @returns A promise that resolves with the IDs of the added documents.
+     */
     addDocuments(documents: Document[], options?: {
         ids?: string[];
     }): Promise<string[]>;
+    /**
+     * Method to add vectors to the Elasticsearch database. It ensures the
+     * index exists, then adds the vectors and their corresponding documents
+     * to the database.
+     * @param vectors The vectors to add to the database.
+     * @param documents The documents corresponding to the vectors.
+     * @param options Optional parameter that can contain the IDs for the documents.
+     * @returns A promise that resolves with the IDs of the added documents.
+     */
     addVectors(vectors: number[][], documents: Document[], options?: {
         ids?: string[];
     }): Promise<string[]>;
+    /**
+     * Method to perform a similarity search in the Elasticsearch database
+     * using a vector. It returns the k most similar documents along with
+     * their similarity scores.
+     * @param query The query vector.
+     * @param k The number of most similar documents to return.
+     * @param filter Optional filter to apply to the search.
+     * @returns A promise that resolves with an array of tuples, where each tuple contains a Document and its similarity score.
+     */
     similaritySearchVectorWithScore(query: number[], k: number, filter?: ElasticFilter | undefined): Promise<[Document, number][]>;
+    /**
+     * Method to delete documents from the Elasticsearch database.
+     * @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>;
+    /**
+     * Static method to create an ElasticVectorSearch instance from texts. It
+     * creates Document instances from the texts and their corresponding
+     * metadata, then calls the fromDocuments method to create the
+     * ElasticVectorSearch instance.
+     * @param texts The texts to create the ElasticVectorSearch instance from.
+     * @param metadatas The metadata corresponding to the texts.
+     * @param embeddings The embeddings to use for the documents.
+     * @param args The arguments to create the Elasticsearch client.
+     * @returns A promise that resolves with the created ElasticVectorSearch instance.
+     */
     static fromTexts(texts: string[], metadatas: object[] | object, embeddings: Embeddings, args: ElasticClientArgs): Promise<ElasticVectorSearch>;
+    /**
+     * Static method to create an ElasticVectorSearch instance from Document
+     * instances. It adds the documents to the Elasticsearch database, then
+     * returns the ElasticVectorSearch instance.
+     * @param docs The Document instances to create the ElasticVectorSearch instance from.
+     * @param embeddings The embeddings to use for the documents.
+     * @param dbConfig The configuration for the Elasticsearch database.
+     * @returns A promise that resolves with the created ElasticVectorSearch instance.
+     */
     static fromDocuments(docs: Document[], embeddings: Embeddings, dbConfig: ElasticClientArgs): Promise<ElasticVectorSearch>;
+    /**
+     * Static method to create an ElasticVectorSearch instance from an
+     * existing index in the Elasticsearch database. It checks if the index
+     * exists, then returns the ElasticVectorSearch instance if it does.
+     * @param embeddings The embeddings to use for the documents.
+     * @param dbConfig The configuration for the Elasticsearch database.
+     * @returns A promise that resolves with the created ElasticVectorSearch instance if the index exists, otherwise it throws an error.
+     */
     static fromExistingIndex(embeddings: Embeddings, dbConfig: ElasticClientArgs): Promise<ElasticVectorSearch>;
     private ensureIndexExists;
     private buildMetadataTerms;
+    /**
+     * Method to check if an index exists in the Elasticsearch database.
+     * @returns A promise that resolves with a boolean indicating whether the index exists.
+     */
     doesIndexExist(): Promise<boolean>;
+    /**
+     * Method to delete an index from the Elasticsearch database if it exists.
+     * @returns A promise that resolves when the deletion is complete.
+     */
     deleteIfExists(): Promise<void>;
 }
 export {};

package/dist/vectorstores/elasticsearch.js

@@ -1,6 +1,12 @@
 import * as uuid from "uuid";
 import { Document } from "../document.js";
 import { VectorStore } from "./base.js";
+/**
+ * Class for interacting with an Elasticsearch database. It extends the
+ * VectorStore base class and provides methods for adding documents and
+ * vectors to the Elasticsearch database, performing similarity searches,
+ * deleting documents, and more.
+ */
 export class ElasticVectorSearch extends VectorStore {
     _vectorstoreType() {
         return "elasticsearch";
@@ -57,10 +63,27 @@ export class ElasticVectorSearch extends VectorStore {
         this.client = args.client;
         this.indexName = args.indexName ?? "documents";
     }
+    /**
+     * Method to add documents to the Elasticsearch database. It first
+     * converts the documents to vectors using the embeddings, then adds the
+     * vectors to the database.
+     * @param documents The documents to add to the database.
+     * @param options Optional parameter that can contain the IDs for the documents.
+     * @returns A promise that resolves with the IDs of the added documents.
+     */
     async addDocuments(documents, options) {
         const texts = documents.map(({ pageContent }) => pageContent);
         return this.addVectors(await this.embeddings.embedDocuments(texts), documents, options);
     }
+    /**
+     * Method to add vectors to the Elasticsearch database. It ensures the
+     * index exists, then adds the vectors and their corresponding documents
+     * to the database.
+     * @param vectors The vectors to add to the database.
+     * @param documents The documents corresponding to the vectors.
+     * @param options Optional parameter that can contain the IDs for the documents.
+     * @returns A promise that resolves with the IDs of the added documents.
+     */
     async addVectors(vectors, documents, options) {
         await this.ensureIndexExists(vectors[0].length, this.engine, this.similarity, this.efConstruction, this.m);
         const documentIds = options?.ids ?? Array.from({ length: vectors.length }, () => uuid.v4());
@@ -80,6 +103,15 @@ export class ElasticVectorSearch extends VectorStore {
         await this.client.bulk({ refresh: true, operations });
         return documentIds;
     }
+    /**
+     * Method to perform a similarity search in the Elasticsearch database
+     * using a vector. It returns the k most similar documents along with
+     * their similarity scores.
+     * @param query The query vector.
+     * @param k The number of most similar documents to return.
+     * @param filter Optional filter to apply to the search.
+     * @returns A promise that resolves with an array of tuples, where each tuple contains a Document and its similarity score.
+     */
     async similaritySearchVectorWithScore(query, k, filter) {
         const result = await this.client.search({
             index: this.indexName,
@@ -101,6 +133,11 @@ export class ElasticVectorSearch extends VectorStore {
             hit._score,
         ]);
     }
+    /**
+     * Method to delete documents from the Elasticsearch database.
+     * @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 operations = params.ids.map((id) => ({
             delete: {
@@ -110,6 +147,17 @@ export class ElasticVectorSearch extends VectorStore {
         }));
         await this.client.bulk({ refresh: true, operations });
     }
+    /**
+     * Static method to create an ElasticVectorSearch instance from texts. It
+     * creates Document instances from the texts and their corresponding
+     * metadata, then calls the fromDocuments method to create the
+     * ElasticVectorSearch instance.
+     * @param texts The texts to create the ElasticVectorSearch instance from.
+     * @param metadatas The metadata corresponding to the texts.
+     * @param embeddings The embeddings to use for the documents.
+     * @param args The arguments to create the Elasticsearch client.
+     * @returns A promise that resolves with the created ElasticVectorSearch instance.
+     */
     static fromTexts(texts, metadatas, embeddings, args) {
         const documents = texts.map((text, idx) => {
             const metadata = Array.isArray(metadatas) ? metadatas[idx] : metadatas;
@@ -117,11 +165,28 @@ export class ElasticVectorSearch extends VectorStore {
         });
         return ElasticVectorSearch.fromDocuments(documents, embeddings, args);
     }
+    /**
+     * Static method to create an ElasticVectorSearch instance from Document
+     * instances. It adds the documents to the Elasticsearch database, then
+     * returns the ElasticVectorSearch instance.
+     * @param docs The Document instances to create the ElasticVectorSearch instance from.
+     * @param embeddings The embeddings to use for the documents.
+     * @param dbConfig The configuration for the Elasticsearch database.
+     * @returns A promise that resolves with the created ElasticVectorSearch instance.
+     */
     static async fromDocuments(docs, embeddings, dbConfig) {
         const store = new ElasticVectorSearch(embeddings, dbConfig);
         await store.addDocuments(docs).then(() => store);
         return store;
     }
+    /**
+     * Static method to create an ElasticVectorSearch instance from an
+     * existing index in the Elasticsearch database. It checks if the index
+     * exists, then returns the ElasticVectorSearch instance if it does.
+     * @param embeddings The embeddings to use for the documents.
+     * @param dbConfig The configuration for the Elasticsearch database.
+     * @returns A promise that resolves with the created ElasticVectorSearch instance if the index exists, otherwise it throws an error.
+     */
     static async fromExistingIndex(embeddings, dbConfig) {
         const store = new ElasticVectorSearch(embeddings, dbConfig);
         const exists = await store.doesIndexExist();
@@ -174,9 +239,17 @@ export class ElasticVectorSearch extends VectorStore {
         }
         return result;
     }
+    /**
+     * Method to check if an index exists in the Elasticsearch database.
+     * @returns A promise that resolves with a boolean indicating whether the index exists.
+     */
     async doesIndexExist() {
         return await this.client.indices.exists({ index: this.indexName });
     }
+    /**
+     * Method to delete an index from the Elasticsearch database if it exists.
+     * @returns A promise that resolves when the deletion is complete.
+     */
     async deleteIfExists() {
         const indexExists = await this.doesIndexExist();
         if (!indexExists)

package/dist/vectorstores/faiss.cjs

@@ -28,6 +28,11 @@ const uuid = __importStar(require("uuid"));
 const base_js_1 = require("./base.cjs");
 const document_js_1 = require("../document.cjs");
 const in_memory_js_1 = require("../stores/doc/in_memory.cjs");
+/**
+ * A class that wraps the FAISS (Facebook AI Similarity Search) vector
+ * database for efficient similarity search and clustering of dense
+ * vectors.
+ */
 class FaissStore extends base_js_1.SaveableVectorStore {
     _vectorstoreType() {
         return "faiss";
@@ -70,6 +75,11 @@ class FaissStore extends base_js_1.SaveableVectorStore {
         this.embeddings = embeddings;
         this.docstore = args?.docstore ?? new in_memory_js_1.SynchronousInMemoryDocstore();
     }
+    /**
+     * Adds an array of Document objects to the store.
+     * @param documents An array of Document objects.
+     * @returns A Promise that resolves when the documents have been added.
+     */
     async addDocuments(documents) {
         const texts = documents.map(({ pageContent }) => pageContent);
         return this.addVectors(await this.embeddings.embedDocuments(texts), documents);
@@ -83,6 +93,13 @@ class FaissStore extends base_js_1.SaveableVectorStore {
     set index(index) {
         this._index = index;
     }
+    /**
+     * Adds an array of vectors and their corresponding Document objects to
+     * the store.
+     * @param vectors An array of vectors.
+     * @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) {
         if (vectors.length === 0) {
             return [];
@@ -111,6 +128,13 @@ class FaissStore extends base_js_1.SaveableVectorStore {
         }
         return documentIds;
     }
+    /**
+     * Performs a similarity search in the vector store using a query vector
+     * and returns the top k results along with their scores.
+     * @param query A query vector.
+     * @param k The number of top results to return.
+     * @returns A Promise that resolves with an array of tuples, each containing a Document and its corresponding score.
+     */
     async similaritySearchVectorWithScore(query, k) {
         const d = this.index.getDimension();
         if (query.length !== d) {
@@ -128,6 +152,11 @@ class FaissStore extends base_js_1.SaveableVectorStore {
             return [this.docstore.search(uuid), result.distances[index]];
         });
     }
+    /**
+     * Saves the current state of the FaissStore to a specified directory.
+     * @param directory The directory to save the state to.
+     * @returns A Promise that resolves when the state has been saved.
+     */
     async save(directory) {
         const fs = await import("node:fs/promises");
         const path = await import("node:path");
@@ -140,6 +169,11 @@ class FaissStore extends base_js_1.SaveableVectorStore {
             ])),
         ]);
     }
+    /**
+     * Merges the current FaissStore with another FaissStore.
+     * @param targetIndex The FaissStore to merge with.
+     * @returns A Promise that resolves with an array of document IDs when the merge is complete.
+     */
     async mergeFrom(targetIndex) {
         const targetIndexDimensions = targetIndex.index.getDimension();
         if (!this._index) {
@@ -166,6 +200,12 @@ class FaissStore extends base_js_1.SaveableVectorStore {
         this.index.mergeFrom(targetIndex.index);
         return documentIds;
     }
+    /**
+     * Loads a FaissStore from a specified directory.
+     * @param directory The directory to load the FaissStore from.
+     * @param embeddings An Embeddings object.
+     * @returns A Promise that resolves with a new FaissStore instance.
+     */
     static async load(directory, embeddings) {
         const fs = await import("node:fs/promises");
         const path = await import("node:path");
@@ -243,6 +283,15 @@ class FaissStore extends base_js_1.SaveableVectorStore {
             mapping: store.mapping,
         });
     }
+    /**
+     * Creates a new FaissStore from an array of texts, their corresponding
+     * metadata, and an Embeddings object.
+     * @param texts An array of texts.
+     * @param metadatas An array of metadata corresponding to the texts, or a single metadata object to be used for all texts.
+     * @param embeddings An Embeddings object.
+     * @param dbConfig An optional configuration object for the document store.
+     * @returns A Promise that resolves with a new FaissStore instance.
+     */
     static async fromTexts(texts, metadatas, embeddings, dbConfig) {
         const docs = [];
         for (let i = 0; i < texts.length; i += 1) {
@@ -255,6 +304,14 @@ class FaissStore extends base_js_1.SaveableVectorStore {
         }
         return this.fromDocuments(docs, embeddings, dbConfig);
     }
+    /**
+     * Creates a new FaissStore from an array of Document objects and an
+     * Embeddings object.
+     * @param docs An array of Document objects.
+     * @param embeddings An Embeddings object.
+     * @param dbConfig An optional configuration object for the document store.
+     * @returns A Promise that resolves with a new FaissStore instance.
+     */
     static async fromDocuments(docs, embeddings, dbConfig) {
         const args = {
             docstore: dbConfig?.docstore,
@@ -263,6 +320,14 @@ class FaissStore extends base_js_1.SaveableVectorStore {
         await instance.addDocuments(docs);
         return instance;
     }
+    /**
+     * Creates a new FaissStore from an existing FaissStore and an Embeddings
+     * object.
+     * @param targetIndex An existing FaissStore.
+     * @param embeddings An Embeddings object.
+     * @param dbConfig An optional configuration object for the document store.
+     * @returns A Promise that resolves with a new FaissStore instance.
+     */
     static async fromIndex(targetIndex, embeddings, dbConfig) {
         const args = {
             docstore: dbConfig?.docstore,

package/dist/vectorstores/faiss.d.ts

@@ -4,11 +4,20 @@ import { Embeddings } from "../embeddings/base.js";
 import { SaveableVectorStore } from "./base.js";
 import { Document } from "../document.js";
 import { SynchronousInMemoryDocstore } from "../stores/doc/in_memory.js";
+/**
+ * Interface for the arguments required to initialize a FaissStore
+ * instance.
+ */
 export interface FaissLibArgs {
     docstore?: SynchronousInMemoryDocstore;
     index?: IndexFlatL2;
     mapping?: Record<number, string>;
 }
+/**
+ * A class that wraps the FAISS (Facebook AI Similarity Search) vector
+ * database for efficient similarity search and clustering of dense
+ * vectors.
+ */
 export declare class FaissStore extends SaveableVectorStore {
     _index?: IndexFlatL2;
     _mapping: Record<number, string>;
@@ -18,21 +27,81 @@ export declare class FaissStore extends SaveableVectorStore {
     getMapping(): Record<number, string>;
     getDocstore(): SynchronousInMemoryDocstore;
     constructor(embeddings: Embeddings, args: FaissLibArgs);
+    /**
+     * Adds an array of Document objects to the store.
+     * @param documents An array of Document objects.
+     * @returns A Promise that resolves when the documents have been added.
+     */
     addDocuments(documents: Document[]): Promise<string[]>;
     get index(): IndexFlatL2;
     private set index(value);
+    /**
+     * Adds an array of vectors and their corresponding Document objects to
+     * the store.
+     * @param vectors An array of vectors.
+     * @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[]>;
+    /**
+     * Performs a similarity search in the vector store using a query vector
+     * and returns the top k results along with their scores.
+     * @param query A query vector.
+     * @param k The number of top results to return.
+     * @returns A Promise that resolves with an array of tuples, each containing a Document and its corresponding score.
+     */
     similaritySearchVectorWithScore(query: number[], k: number): Promise<[Document<Record<string, any>>, number][]>;
+    /**
+     * Saves the current state of the FaissStore to a specified directory.
+     * @param directory The directory to save the state to.
+     * @returns A Promise that resolves when the state has been saved.
+     */
     save(directory: string): Promise<void>;
+    /**
+     * Merges the current FaissStore with another FaissStore.
+     * @param targetIndex The FaissStore to merge with.
+     * @returns A Promise that resolves with an array of document IDs when the merge is complete.
+     */
     mergeFrom(targetIndex: FaissStore): Promise<string[]>;
+    /**
+     * Loads a FaissStore from a specified directory.
+     * @param directory The directory to load the FaissStore from.
+     * @param embeddings An Embeddings object.
+     * @returns A Promise that resolves with a new FaissStore instance.
+     */
     static load(directory: string, embeddings: Embeddings): Promise<FaissStore>;
     static loadFromPython(directory: string, embeddings: Embeddings): Promise<FaissStore>;
+    /**
+     * Creates a new FaissStore from an array of texts, their corresponding
+     * metadata, and an Embeddings object.
+     * @param texts An array of texts.
+     * @param metadatas An array of metadata corresponding to the texts, or a single metadata object to be used for all texts.
+     * @param embeddings An Embeddings object.
+     * @param dbConfig An optional configuration object for the document store.
+     * @returns A Promise that resolves with a new FaissStore instance.
+     */
     static fromTexts(texts: string[], metadatas: object[] | object, embeddings: Embeddings, dbConfig?: {
         docstore?: SynchronousInMemoryDocstore;
     }): Promise<FaissStore>;
+    /**
+     * Creates a new FaissStore from an array of Document objects and an
+     * Embeddings object.
+     * @param docs An array of Document objects.
+     * @param embeddings An Embeddings object.
+     * @param dbConfig An optional configuration object for the document store.
+     * @returns A Promise that resolves with a new FaissStore instance.
+     */
     static fromDocuments(docs: Document[], embeddings: Embeddings, dbConfig?: {
         docstore?: SynchronousInMemoryDocstore;
     }): Promise<FaissStore>;
+    /**
+     * Creates a new FaissStore from an existing FaissStore and an Embeddings
+     * object.
+     * @param targetIndex An existing FaissStore.
+     * @param embeddings An Embeddings object.
+     * @param dbConfig An optional configuration object for the document store.
+     * @returns A Promise that resolves with a new FaissStore instance.
+     */
     static fromIndex(targetIndex: FaissStore, embeddings: Embeddings, dbConfig?: {
         docstore?: SynchronousInMemoryDocstore;
     }): Promise<FaissStore>;