langchain 0.0.131 → 0.0.132

package/dist/vectorstores/faiss.js

@@ -2,6 +2,11 @@ import * as uuid from "uuid";
 import { SaveableVectorStore } from "./base.js";
 import { Document } from "../document.js";
 import { SynchronousInMemoryDocstore } from "../stores/doc/in_memory.js";
+/**
+ * A class that wraps the FAISS (Facebook AI Similarity Search) vector
+ * database for efficient similarity search and clustering of dense
+ * vectors.
+ */
 export class FaissStore extends SaveableVectorStore {
     _vectorstoreType() {
         return "faiss";
@@ -44,6 +49,11 @@ export class FaissStore extends SaveableVectorStore {
         this.embeddings = embeddings;
         this.docstore = args?.docstore ?? new 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);
@@ -57,6 +67,13 @@ export class FaissStore extends 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 [];
@@ -85,6 +102,13 @@ export class FaissStore extends 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) {
@@ -102,6 +126,11 @@ export class FaissStore extends 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");
@@ -114,6 +143,11 @@ export class FaissStore extends 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) {
@@ -140,6 +174,12 @@ export class FaissStore extends 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");
@@ -217,6 +257,15 @@ export class FaissStore extends 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) {
@@ -229,6 +278,14 @@ export class FaissStore extends 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,
@@ -237,6 +294,14 @@ export class FaissStore extends 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/hnswlib.cjs

@@ -4,6 +4,12 @@ exports.HNSWLib = void 0;
 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");
+/**
+ * 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.
+ */
 class HNSWLib extends base_js_1.SaveableVectorStore {
     _vectorstoreType() {
         return "hnswlib";
@@ -33,6 +39,13 @@ class HNSWLib extends base_js_1.SaveableVectorStore {
         this.embeddings = embeddings;
         this.docstore = args?.docstore ?? new in_memory_js_1.SynchronousInMemoryDocstore();
     }
+    /**
+     * Method to add documents to the vector store. It first converts the
+     * documents to vectors using the embeddings, then adds the vectors to the
+     * vector store.
+     * @param documents The documents to be added to the vector store.
+     * @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);
@@ -67,6 +80,14 @@ class HNSWLib extends base_js_1.SaveableVectorStore {
     set index(index) {
         this._index = index;
     }
+    /**
+     * Method to add vectors to the vector store. It first initializes the
+     * index if it hasn't been initialized yet, then adds the vectors to the
+     * index and the documents to the document store.
+     * @param vectors The vectors to be added to the vector store.
+     * @param documents The documents corresponding to the vectors.
+     * @returns A Promise that resolves when the vectors and documents have been added.
+     */
     async addVectors(vectors, documents) {
         if (vectors.length === 0) {
             return;
@@ -95,6 +116,16 @@ class HNSWLib extends base_js_1.SaveableVectorStore {
         }
         this.docstore.add(toSave);
     }
+    /**
+     * Method to perform a similarity search in the vector store using a query
+     * vector. It returns the k most similar documents along with their
+     * similarity scores. An optional filter function can be provided to
+     * filter the documents.
+     * @param query The query vector.
+     * @param k The number of most similar documents to return.
+     * @param filter An optional filter function to filter the documents.
+     * @returns A Promise that resolves to an array of tuples, where each tuple contains a document and its similarity score.
+     */
     async similaritySearchVectorWithScore(query, k, filter) {
         if (this.args.numDimensions && !this._index) {
             await this.initIndex([[]]);
@@ -125,6 +156,13 @@ class HNSWLib extends base_js_1.SaveableVectorStore {
             result.distances[resultIndex],
         ]);
     }
+    /**
+     * Method to delete the vector store from a directory. It deletes the
+     * hnswlib.index file, the docstore.json file, and the args.json file from
+     * the directory.
+     * @param params An object with a directory property that specifies the directory from which to delete the vector store.
+     * @returns A Promise that resolves when the vector store has been deleted.
+     */
     async delete(params) {
         const fs = await import("node:fs/promises");
         const path = await import("node:path");
@@ -144,6 +182,12 @@ class HNSWLib extends base_js_1.SaveableVectorStore {
             await fs.rm(path.join(params.directory, "args.json"), { force: true }),
         ]);
     }
+    /**
+     * Method to save the vector store to a directory. It saves the HNSW
+     * index, the arguments, and the document store to the directory.
+     * @param directory The directory to which to save the vector store.
+     * @returns A Promise that resolves when the vector store has been saved.
+     */
     async save(directory) {
         const fs = await import("node:fs/promises");
         const path = await import("node:path");
@@ -154,6 +198,14 @@ class HNSWLib extends base_js_1.SaveableVectorStore {
             await fs.writeFile(path.join(directory, "docstore.json"), JSON.stringify(Array.from(this.docstore._docs.entries()))),
         ]);
     }
+    /**
+     * 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 HNSWLib instance.
+     * @returns A Promise that resolves to a new HNSWLib instance.
+     */
     static async load(directory, embeddings) {
         const fs = await import("node:fs/promises");
         const path = await import("node:path");
@@ -169,6 +221,16 @@ class HNSWLib extends base_js_1.SaveableVectorStore {
         args.index = index;
         return new HNSWLib(embeddings, args);
     }
+    /**
+     * Static method to create a new HNSWLib instance from texts and metadata.
+     * It creates a new Document instance for each text and metadata, then
+     * calls the fromDocuments method to create the HNSWLib 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 HNSWLib instance.
+     * @param dbConfig An optional configuration object for the document store.
+     * @returns A Promise that resolves to a new HNSWLib instance.
+     */
     static async fromTexts(texts, metadatas, embeddings, dbConfig) {
         const docs = [];
         for (let i = 0; i < texts.length; i += 1) {
@@ -181,6 +243,15 @@ class HNSWLib extends base_js_1.SaveableVectorStore {
         }
         return HNSWLib.fromDocuments(docs, embeddings, dbConfig);
     }
+    /**
+     * Static method to create a new HNSWLib instance from documents. It
+     * creates a new HNSWLib 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 dbConfig An optional configuration object for the document store.
+     * @returns A Promise that resolves to a new HNSWLib instance.
+     */
     static async fromDocuments(docs, embeddings, dbConfig) {
         const args = {
             docstore: dbConfig?.docstore,

package/dist/vectorstores/hnswlib.d.ts

@@ -3,14 +3,29 @@ 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 base configuration of HNSWLib. It includes the space
+ * name and the number of dimensions.
+ */
 export interface HNSWLibBase {
     space: SpaceName;
     numDimensions?: number;
 }
+/**
+ * Interface for the arguments that can be passed to the HNSWLib
+ * constructor. It extends HNSWLibBase and includes properties for the
+ * document store and HNSW index.
+ */
 export interface HNSWLibArgs extends HNSWLibBase {
     docstore?: SynchronousInMemoryDocstore;
     index?: HierarchicalNSWT;
 }
+/**
+ * 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 HNSWLib extends SaveableVectorStore {
     FilterType: (doc: Document) => boolean;
     _index?: HierarchicalNSWT;
@@ -18,21 +33,86 @@ export declare class HNSWLib extends SaveableVectorStore {
     args: HNSWLibBase;
     _vectorstoreType(): string;
     constructor(embeddings: Embeddings, args: HNSWLibArgs);
+    /**
+     * Method to add documents to the vector store. It first converts the
+     * documents to vectors using the embeddings, then adds the vectors to the
+     * vector store.
+     * @param documents The documents to be added to the vector store.
+     * @returns A Promise that resolves when the documents have been added.
+     */
     addDocuments(documents: Document[]): Promise<void>;
     private static getHierarchicalNSW;
     private initIndex;
     get index(): HierarchicalNSWT;
     private set index(value);
+    /**
+     * Method to add vectors to the vector store. It first initializes the
+     * index if it hasn't been initialized yet, then adds the vectors to the
+     * index and the documents to the document store.
+     * @param vectors The vectors to be added to the vector store.
+     * @param documents The documents corresponding to the vectors.
+     * @returns A Promise that resolves when the vectors and documents have been added.
+     */
     addVectors(vectors: number[][], documents: Document[]): Promise<void>;
+    /**
+     * Method to perform a similarity search in the vector store using a query
+     * vector. It returns the k most similar documents along with their
+     * similarity scores. An optional filter function can be provided to
+     * filter the documents.
+     * @param query The query vector.
+     * @param k The number of most similar documents to return.
+     * @param filter An optional filter function to filter the documents.
+     * @returns A Promise that resolves to an array of tuples, where each tuple contains a document and its similarity score.
+     */
     similaritySearchVectorWithScore(query: number[], k: number, filter?: this["FilterType"]): Promise<[Document<Record<string, any>>, number][]>;
+    /**
+     * Method to delete the vector store from a directory. It deletes the
+     * hnswlib.index file, the docstore.json file, and the args.json file from
+     * the directory.
+     * @param params An object with a directory property that specifies the directory from which to delete the vector store.
+     * @returns A Promise that resolves when the vector store has been deleted.
+     */
     delete(params: {
         directory: string;
     }): Promise<void>;
+    /**
+     * Method to save the vector store to a directory. It saves the HNSW
+     * index, the arguments, and the document store to the directory.
+     * @param directory The directory to which to save the vector store.
+     * @returns A Promise that resolves when the vector store has been saved.
+     */
     save(directory: string): Promise<void>;
+    /**
+     * 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 HNSWLib instance.
+     * @returns A Promise that resolves to a new HNSWLib instance.
+     */
     static load(directory: string, embeddings: Embeddings): Promise<HNSWLib>;
+    /**
+     * Static method to create a new HNSWLib instance from texts and metadata.
+     * It creates a new Document instance for each text and metadata, then
+     * calls the fromDocuments method to create the HNSWLib 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 HNSWLib instance.
+     * @param dbConfig An optional configuration object for the document store.
+     * @returns A Promise that resolves to a new HNSWLib instance.
+     */
     static fromTexts(texts: string[], metadatas: object[] | object, embeddings: Embeddings, dbConfig?: {
         docstore?: SynchronousInMemoryDocstore;
     }): Promise<HNSWLib>;
+    /**
+     * Static method to create a new HNSWLib instance from documents. It
+     * creates a new HNSWLib 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 dbConfig An optional configuration object for the document store.
+     * @returns A Promise that resolves to a new HNSWLib instance.
+     */
     static fromDocuments(docs: Document[], embeddings: Embeddings, dbConfig?: {
         docstore?: SynchronousInMemoryDocstore;
     }): Promise<HNSWLib>;

package/dist/vectorstores/hnswlib.js

@@ -1,6 +1,12 @@
 import { SaveableVectorStore } from "./base.js";
 import { Document } from "../document.js";
 import { SynchronousInMemoryDocstore } from "../stores/doc/in_memory.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 HNSWLib extends SaveableVectorStore {
     _vectorstoreType() {
         return "hnswlib";
@@ -30,6 +36,13 @@ export class HNSWLib extends SaveableVectorStore {
         this.embeddings = embeddings;
         this.docstore = args?.docstore ?? new SynchronousInMemoryDocstore();
     }
+    /**
+     * Method to add documents to the vector store. It first converts the
+     * documents to vectors using the embeddings, then adds the vectors to the
+     * vector store.
+     * @param documents The documents to be added to the vector store.
+     * @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);
@@ -64,6 +77,14 @@ export class HNSWLib extends SaveableVectorStore {
     set index(index) {
         this._index = index;
     }
+    /**
+     * Method to add vectors to the vector store. It first initializes the
+     * index if it hasn't been initialized yet, then adds the vectors to the
+     * index and the documents to the document store.
+     * @param vectors The vectors to be added to the vector store.
+     * @param documents The documents corresponding to the vectors.
+     * @returns A Promise that resolves when the vectors and documents have been added.
+     */
     async addVectors(vectors, documents) {
         if (vectors.length === 0) {
             return;
@@ -92,6 +113,16 @@ export class HNSWLib extends SaveableVectorStore {
         }
         this.docstore.add(toSave);
     }
+    /**
+     * Method to perform a similarity search in the vector store using a query
+     * vector. It returns the k most similar documents along with their
+     * similarity scores. An optional filter function can be provided to
+     * filter the documents.
+     * @param query The query vector.
+     * @param k The number of most similar documents to return.
+     * @param filter An optional filter function to filter the documents.
+     * @returns A Promise that resolves to an array of tuples, where each tuple contains a document and its similarity score.
+     */
     async similaritySearchVectorWithScore(query, k, filter) {
         if (this.args.numDimensions && !this._index) {
             await this.initIndex([[]]);
@@ -122,6 +153,13 @@ export class HNSWLib extends SaveableVectorStore {
             result.distances[resultIndex],
         ]);
     }
+    /**
+     * Method to delete the vector store from a directory. It deletes the
+     * hnswlib.index file, the docstore.json file, and the args.json file from
+     * the directory.
+     * @param params An object with a directory property that specifies the directory from which to delete the vector store.
+     * @returns A Promise that resolves when the vector store has been deleted.
+     */
     async delete(params) {
         const fs = await import("node:fs/promises");
         const path = await import("node:path");
@@ -141,6 +179,12 @@ export class HNSWLib extends SaveableVectorStore {
             await fs.rm(path.join(params.directory, "args.json"), { force: true }),
         ]);
     }
+    /**
+     * Method to save the vector store to a directory. It saves the HNSW
+     * index, the arguments, and the document store to the directory.
+     * @param directory The directory to which to save the vector store.
+     * @returns A Promise that resolves when the vector store has been saved.
+     */
     async save(directory) {
         const fs = await import("node:fs/promises");
         const path = await import("node:path");
@@ -151,6 +195,14 @@ export class HNSWLib extends SaveableVectorStore {
             await fs.writeFile(path.join(directory, "docstore.json"), JSON.stringify(Array.from(this.docstore._docs.entries()))),
         ]);
     }
+    /**
+     * 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 HNSWLib instance.
+     * @returns A Promise that resolves to a new HNSWLib instance.
+     */
     static async load(directory, embeddings) {
         const fs = await import("node:fs/promises");
         const path = await import("node:path");
@@ -166,6 +218,16 @@ export class HNSWLib extends SaveableVectorStore {
         args.index = index;
         return new HNSWLib(embeddings, args);
     }
+    /**
+     * Static method to create a new HNSWLib instance from texts and metadata.
+     * It creates a new Document instance for each text and metadata, then
+     * calls the fromDocuments method to create the HNSWLib 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 HNSWLib instance.
+     * @param dbConfig An optional configuration object for the document store.
+     * @returns A Promise that resolves to a new HNSWLib instance.
+     */
     static async fromTexts(texts, metadatas, embeddings, dbConfig) {
         const docs = [];
         for (let i = 0; i < texts.length; i += 1) {
@@ -178,6 +240,15 @@ export class HNSWLib extends SaveableVectorStore {
         }
         return HNSWLib.fromDocuments(docs, embeddings, dbConfig);
     }
+    /**
+     * Static method to create a new HNSWLib instance from documents. It
+     * creates a new HNSWLib 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 dbConfig An optional configuration object for the document store.
+     * @returns A Promise that resolves to a new HNSWLib instance.
+     */
     static async fromDocuments(docs, embeddings, dbConfig) {
         const args = {
             docstore: dbConfig?.docstore,

package/dist/vectorstores/lancedb.cjs

@@ -3,6 +3,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.LanceDB = void 0;
 const base_js_1 = require("./base.cjs");
 const document_js_1 = require("../document.cjs");
+/**
+ * A wrapper for an open-source database for vector-search with persistent
+ * storage. It simplifies retrieval, filtering, and management of
+ * embeddings.
+ */
 class LanceDB extends base_js_1.VectorStore {
     constructor(embeddings, args) {
         super(embeddings, args);
@@ -22,6 +27,11 @@ class LanceDB extends base_js_1.VectorStore {
         this.embeddings = embeddings;
         this.textKey = args.textKey || "text";
     }
+    /**
+     * Adds documents to the database.
+     * @param documents The documents to be added.
+     * @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);
@@ -29,6 +39,12 @@ class LanceDB extends base_js_1.VectorStore {
     _vectorstoreType() {
         return "lancedb";
     }
+    /**
+     * Adds vectors and their corresponding documents to the database.
+     * @param vectors The vectors to be added.
+     * @param documents The corresponding documents to be added.
+     * @returns A Promise that resolves when the vectors and documents have been added.
+     */
     async addVectors(vectors, documents) {
         if (vectors.length === 0) {
             return;
@@ -49,6 +65,13 @@ class LanceDB extends base_js_1.VectorStore {
         }
         await this.table.add(data);
     }
+    /**
+     * Performs a similarity search on the vectors in the database and returns
+     * the documents and their scores.
+     * @param query The query vector.
+     * @param k The number of results to return.
+     * @returns A Promise that resolves with an array of tuples, each containing a Document and its score.
+     */
     async similaritySearchVectorWithScore(query, k) {
         const results = await this.table.search(query).limit(k).execute();
         const docsAndScore = [];
@@ -69,6 +92,14 @@ class LanceDB extends base_js_1.VectorStore {
         });
         return docsAndScore;
     }
+    /**
+     * Creates a new instance of LanceDB from texts.
+     * @param texts The texts to be converted into documents.
+     * @param metadatas The metadata for the texts.
+     * @param embeddings The embeddings to be managed.
+     * @param dbConfig The configuration for the LanceDB instance.
+     * @returns A Promise that resolves with a new instance of LanceDB.
+     */
     static async fromTexts(texts, metadatas, embeddings, dbConfig) {
         const docs = [];
         for (let i = 0; i < texts.length; i += 1) {
@@ -81,6 +112,13 @@ class LanceDB extends base_js_1.VectorStore {
         }
         return LanceDB.fromDocuments(docs, embeddings, dbConfig);
     }
+    /**
+     * Creates a new instance of LanceDB from documents.
+     * @param docs The documents to be added to the database.
+     * @param embeddings The embeddings to be managed.
+     * @param dbConfig The configuration for the LanceDB instance.
+     * @returns A Promise that resolves with a new instance of LanceDB.
+     */
     static async fromDocuments(docs, embeddings, dbConfig) {
         const instance = new this(embeddings, dbConfig);
         await instance.addDocuments(docs);

package/dist/vectorstores/lancedb.d.ts

@@ -2,18 +2,60 @@ import { Table } from "vectordb";
 import { VectorStore } from "./base.js";
 import { Embeddings } from "../embeddings/base.js";
 import { Document } from "../document.js";
+/**
+ * Defines the arguments for the LanceDB class constructor. It includes a
+ * table and an optional textKey.
+ */
 export type LanceDBArgs = {
     table: Table;
     textKey?: string;
 };
+/**
+ * A wrapper for an open-source database for vector-search with persistent
+ * storage. It simplifies retrieval, filtering, and management of
+ * embeddings.
+ */
 export declare class LanceDB extends VectorStore {
     private table;
     private textKey;
     constructor(embeddings: Embeddings, args: LanceDBArgs);
+    /**
+     * Adds documents to the database.
+     * @param documents The documents to be added.
+     * @returns A Promise that resolves when the documents have been added.
+     */
     addDocuments(documents: Document[]): Promise<void>;
     _vectorstoreType(): string;
+    /**
+     * Adds vectors and their corresponding documents to the database.
+     * @param vectors The vectors to be added.
+     * @param documents The corresponding documents to be added.
+     * @returns A Promise that resolves when the vectors and documents have been added.
+     */
     addVectors(vectors: number[][], documents: Document[]): Promise<void>;
+    /**
+     * Performs a similarity search on the vectors in the database and returns
+     * the documents and their scores.
+     * @param query The query vector.
+     * @param k The number of results to return.
+     * @returns A Promise that resolves with an array of tuples, each containing a Document and its score.
+     */
     similaritySearchVectorWithScore(query: number[], k: number): Promise<[Document, number][]>;
+    /**
+     * Creates a new instance of LanceDB from texts.
+     * @param texts The texts to be converted into documents.
+     * @param metadatas The metadata for the texts.
+     * @param embeddings The embeddings to be managed.
+     * @param dbConfig The configuration for the LanceDB instance.
+     * @returns A Promise that resolves with a new instance of LanceDB.
+     */
     static fromTexts(texts: string[], metadatas: object[] | object, embeddings: Embeddings, dbConfig: LanceDBArgs): Promise<LanceDB>;
+    /**
+     * Creates a new instance of LanceDB from documents.
+     * @param docs The documents to be added to the database.
+     * @param embeddings The embeddings to be managed.
+     * @param dbConfig The configuration for the LanceDB instance.
+     * @returns A Promise that resolves with a new instance of LanceDB.
+     */
     static fromDocuments(docs: Document[], embeddings: Embeddings, dbConfig: LanceDBArgs): Promise<LanceDB>;
 }