langchain 0.0.130 → 0.0.132

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>;
 }

package/dist/vectorstores/lancedb.js

@@ -1,5 +1,10 @@
 import { VectorStore } from "./base.js";
 import { Document } from "../document.js";
+/**
+ * A wrapper for an open-source database for vector-search with persistent
+ * storage. It simplifies retrieval, filtering, and management of
+ * embeddings.
+ */
 export class LanceDB extends VectorStore {
     constructor(embeddings, args) {
         super(embeddings, args);
@@ -19,6 +24,11 @@ export class LanceDB extends 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);
@@ -26,6 +36,12 @@ export class LanceDB extends 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;
@@ -46,6 +62,13 @@ export class LanceDB extends 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 = [];
@@ -66,6 +89,14 @@ export class LanceDB extends 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) {
@@ -78,6 +109,13 @@ export class LanceDB extends 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/memory.cjs

@@ -4,6 +4,11 @@ exports.MemoryVectorStore = void 0;
 const ml_distance_1 = require("ml-distance");
 const base_js_1 = require("./base.cjs");
 const document_js_1 = require("../document.cjs");
+/**
+ * Class that extends `VectorStore` to store vectors in memory. Provides
+ * methods for adding documents, performing similarity searches, and
+ * creating instances from texts, documents, or an existing index.
+ */
 class MemoryVectorStore extends base_js_1.VectorStore {
     _vectorstoreType() {
         return "memory";
@@ -24,10 +29,25 @@ class MemoryVectorStore extends base_js_1.VectorStore {
         });
         this.similarity = similarity ?? ml_distance_1.similarity.cosine;
     }
+    /**
+     * Method to add documents to the memory vector store. It extracts the
+     * text from each document, generates embeddings for them, and adds the
+     * resulting vectors to the store.
+     * @param documents Array of `Document` instances to be added to the store.
+     * @returns Promise that resolves when all documents have been added.
+     */
     async addDocuments(documents) {
         const texts = documents.map(({ pageContent }) => pageContent);
         return this.addVectors(await this.embeddings.embedDocuments(texts), documents);
     }
+    /**
+     * Method to add vectors to the memory vector store. It creates
+     * `MemoryVector` instances for each vector and document pair and adds
+     * them to the store.
+     * @param vectors Array of vectors to be added to the store.
+     * @param documents Array of `Document` instances corresponding to the vectors.
+     * @returns Promise that resolves when all vectors have been added.
+     */
     async addVectors(vectors, documents) {
         const memoryVectors = vectors.map((embedding, idx) => ({
             content: documents[idx].pageContent,
@@ -36,6 +56,16 @@ class MemoryVectorStore extends base_js_1.VectorStore {
         }));
         this.memoryVectors = this.memoryVectors.concat(memoryVectors);
     }
+    /**
+     * Method to perform a similarity search in the memory vector store. It
+     * calculates the similarity between the query vector and each vector in
+     * the store, sorts the results by similarity, and returns the top `k`
+     * results along with their scores.
+     * @param query Query vector to compare against the vectors in the store.
+     * @param k Number of top results to return.
+     * @param filter Optional filter function to apply to the vectors before performing the search.
+     * @returns Promise that resolves with an array of tuples, each containing a `Document` and its similarity score.
+     */
     async similaritySearchVectorWithScore(query, k, filter) {
         const filterFunction = (memoryVector) => {
             if (!filter) {
@@ -64,6 +94,16 @@ class MemoryVectorStore extends base_js_1.VectorStore {
         ]);
         return result;
     }
+    /**
+     * Static method to create a `MemoryVectorStore` instance from an array of
+     * texts. It creates a `Document` for each text and metadata pair, and
+     * adds them to the store.
+     * @param texts Array of texts to be added to the store.
+     * @param metadatas Array or single object of metadata corresponding to the texts.
+     * @param embeddings `Embeddings` instance used to generate embeddings for the texts.
+     * @param dbConfig Optional `MemoryVectorStoreArgs` to configure the `MemoryVectorStore` instance.
+     * @returns Promise that resolves with a new `MemoryVectorStore` instance.
+     */
     static async fromTexts(texts, metadatas, embeddings, dbConfig) {
         const docs = [];
         for (let i = 0; i < texts.length; i += 1) {
@@ -76,11 +116,27 @@ class MemoryVectorStore extends base_js_1.VectorStore {
         }
         return MemoryVectorStore.fromDocuments(docs, embeddings, dbConfig);
     }
+    /**
+     * Static method to create a `MemoryVectorStore` instance from an array of
+     * `Document` instances. It adds the documents to the store.
+     * @param docs Array of `Document` instances to be added to the store.
+     * @param embeddings `Embeddings` instance used to generate embeddings for the documents.
+     * @param dbConfig Optional `MemoryVectorStoreArgs` to configure the `MemoryVectorStore` instance.
+     * @returns Promise that resolves with a new `MemoryVectorStore` instance.
+     */
     static async fromDocuments(docs, embeddings, dbConfig) {
         const instance = new this(embeddings, dbConfig);
         await instance.addDocuments(docs);
         return instance;
     }
+    /**
+     * Static method to create a `MemoryVectorStore` instance from an existing
+     * index. It creates a new `MemoryVectorStore` instance without adding any
+     * documents or vectors.
+     * @param embeddings `Embeddings` instance used to generate embeddings for the documents.
+     * @param dbConfig Optional `MemoryVectorStoreArgs` to configure the `MemoryVectorStore` instance.
+     * @returns Promise that resolves with a new `MemoryVectorStore` instance.
+     */
     static async fromExistingIndex(embeddings, dbConfig) {
         const instance = new this(embeddings, dbConfig);
         return instance;

package/dist/vectorstores/memory.d.ts

@@ -2,25 +2,91 @@ import { similarity as ml_distance_similarity } from "ml-distance";
 import { VectorStore } from "./base.js";
 import { Embeddings } from "../embeddings/base.js";
 import { Document } from "../document.js";
+/**
+ * Interface representing a vector in memory. It includes the content
+ * (text), the corresponding embedding (vector), and any associated
+ * metadata.
+ */
 interface MemoryVector {
     content: string;
     embedding: number[];
     metadata: Record<string, any>;
 }
+/**
+ * Interface for the arguments that can be passed to the
+ * `MemoryVectorStore` constructor. It includes an optional `similarity`
+ * function.
+ */
 export interface MemoryVectorStoreArgs {
     similarity?: typeof ml_distance_similarity.cosine;
 }
+/**
+ * Class that extends `VectorStore` to store vectors in memory. Provides
+ * methods for adding documents, performing similarity searches, and
+ * creating instances from texts, documents, or an existing index.
+ */
 export declare class MemoryVectorStore extends VectorStore {
     FilterType: (doc: Document) => boolean;
     memoryVectors: MemoryVector[];
     similarity: typeof ml_distance_similarity.cosine;
     _vectorstoreType(): string;
     constructor(embeddings: Embeddings, { similarity, ...rest }?: MemoryVectorStoreArgs);
+    /**
+     * Method to add documents to the memory vector store. It extracts the
+     * text from each document, generates embeddings for them, and adds the
+     * resulting vectors to the store.
+     * @param documents Array of `Document` instances to be added to the store.
+     * @returns Promise that resolves when all documents have been added.
+     */
     addDocuments(documents: Document[]): Promise<void>;
+    /**
+     * Method to add vectors to the memory vector store. It creates
+     * `MemoryVector` instances for each vector and document pair and adds
+     * them to the store.
+     * @param vectors Array of vectors to be added to the store.
+     * @param documents Array of `Document` instances corresponding to the vectors.
+     * @returns Promise that resolves when all vectors have been added.
+     */
     addVectors(vectors: number[][], documents: Document[]): Promise<void>;
+    /**
+     * Method to perform a similarity search in the memory vector store. It
+     * calculates the similarity between the query vector and each vector in
+     * the store, sorts the results by similarity, and returns the top `k`
+     * results along with their scores.
+     * @param query Query vector to compare against the vectors in the store.
+     * @param k Number of top results to return.
+     * @param filter Optional filter function to apply to the vectors before performing the search.
+     * @returns Promise that resolves with an array of tuples, each containing a `Document` and its similarity score.
+     */
     similaritySearchVectorWithScore(query: number[], k: number, filter?: this["FilterType"]): Promise<[Document, number][]>;
+    /**
+     * Static method to create a `MemoryVectorStore` instance from an array of
+     * texts. It creates a `Document` for each text and metadata pair, and
+     * adds them to the store.
+     * @param texts Array of texts to be added to the store.
+     * @param metadatas Array or single object of metadata corresponding to the texts.
+     * @param embeddings `Embeddings` instance used to generate embeddings for the texts.
+     * @param dbConfig Optional `MemoryVectorStoreArgs` to configure the `MemoryVectorStore` instance.
+     * @returns Promise that resolves with a new `MemoryVectorStore` instance.
+     */
     static fromTexts(texts: string[], metadatas: object[] | object, embeddings: Embeddings, dbConfig?: MemoryVectorStoreArgs): Promise<MemoryVectorStore>;
+    /**
+     * Static method to create a `MemoryVectorStore` instance from an array of
+     * `Document` instances. It adds the documents to the store.
+     * @param docs Array of `Document` instances to be added to the store.
+     * @param embeddings `Embeddings` instance used to generate embeddings for the documents.
+     * @param dbConfig Optional `MemoryVectorStoreArgs` to configure the `MemoryVectorStore` instance.
+     * @returns Promise that resolves with a new `MemoryVectorStore` instance.
+     */
     static fromDocuments(docs: Document[], embeddings: Embeddings, dbConfig?: MemoryVectorStoreArgs): Promise<MemoryVectorStore>;
+    /**
+     * Static method to create a `MemoryVectorStore` instance from an existing
+     * index. It creates a new `MemoryVectorStore` instance without adding any
+     * documents or vectors.
+     * @param embeddings `Embeddings` instance used to generate embeddings for the documents.
+     * @param dbConfig Optional `MemoryVectorStoreArgs` to configure the `MemoryVectorStore` instance.
+     * @returns Promise that resolves with a new `MemoryVectorStore` instance.
+     */
     static fromExistingIndex(embeddings: Embeddings, dbConfig?: MemoryVectorStoreArgs): Promise<MemoryVectorStore>;
 }
 export {};

package/dist/vectorstores/memory.js

@@ -1,6 +1,11 @@
 import { similarity as ml_distance_similarity } from "ml-distance";
 import { VectorStore } from "./base.js";
 import { Document } from "../document.js";
+/**
+ * Class that extends `VectorStore` to store vectors in memory. Provides
+ * methods for adding documents, performing similarity searches, and
+ * creating instances from texts, documents, or an existing index.
+ */
 export class MemoryVectorStore extends VectorStore {
     _vectorstoreType() {
         return "memory";
@@ -21,10 +26,25 @@ export class MemoryVectorStore extends VectorStore {
         });
         this.similarity = similarity ?? ml_distance_similarity.cosine;
     }
+    /**
+     * Method to add documents to the memory vector store. It extracts the
+     * text from each document, generates embeddings for them, and adds the
+     * resulting vectors to the store.
+     * @param documents Array of `Document` instances to be added to the store.
+     * @returns Promise that resolves when all documents have been added.
+     */
     async addDocuments(documents) {
         const texts = documents.map(({ pageContent }) => pageContent);
         return this.addVectors(await this.embeddings.embedDocuments(texts), documents);
     }
+    /**
+     * Method to add vectors to the memory vector store. It creates
+     * `MemoryVector` instances for each vector and document pair and adds
+     * them to the store.
+     * @param vectors Array of vectors to be added to the store.
+     * @param documents Array of `Document` instances corresponding to the vectors.
+     * @returns Promise that resolves when all vectors have been added.
+     */
     async addVectors(vectors, documents) {
         const memoryVectors = vectors.map((embedding, idx) => ({
             content: documents[idx].pageContent,
@@ -33,6 +53,16 @@ export class MemoryVectorStore extends VectorStore {
         }));
         this.memoryVectors = this.memoryVectors.concat(memoryVectors);
     }
+    /**
+     * Method to perform a similarity search in the memory vector store. It
+     * calculates the similarity between the query vector and each vector in
+     * the store, sorts the results by similarity, and returns the top `k`
+     * results along with their scores.
+     * @param query Query vector to compare against the vectors in the store.
+     * @param k Number of top results to return.
+     * @param filter Optional filter function to apply to the vectors before performing the search.
+     * @returns Promise that resolves with an array of tuples, each containing a `Document` and its similarity score.
+     */
     async similaritySearchVectorWithScore(query, k, filter) {
         const filterFunction = (memoryVector) => {
             if (!filter) {
@@ -61,6 +91,16 @@ export class MemoryVectorStore extends VectorStore {
         ]);
         return result;
     }
+    /**
+     * Static method to create a `MemoryVectorStore` instance from an array of
+     * texts. It creates a `Document` for each text and metadata pair, and
+     * adds them to the store.
+     * @param texts Array of texts to be added to the store.
+     * @param metadatas Array or single object of metadata corresponding to the texts.
+     * @param embeddings `Embeddings` instance used to generate embeddings for the texts.
+     * @param dbConfig Optional `MemoryVectorStoreArgs` to configure the `MemoryVectorStore` instance.
+     * @returns Promise that resolves with a new `MemoryVectorStore` instance.
+     */
     static async fromTexts(texts, metadatas, embeddings, dbConfig) {
         const docs = [];
         for (let i = 0; i < texts.length; i += 1) {
@@ -73,11 +113,27 @@ export class MemoryVectorStore extends VectorStore {
         }
         return MemoryVectorStore.fromDocuments(docs, embeddings, dbConfig);
     }
+    /**
+     * Static method to create a `MemoryVectorStore` instance from an array of
+     * `Document` instances. It adds the documents to the store.
+     * @param docs Array of `Document` instances to be added to the store.
+     * @param embeddings `Embeddings` instance used to generate embeddings for the documents.
+     * @param dbConfig Optional `MemoryVectorStoreArgs` to configure the `MemoryVectorStore` instance.
+     * @returns Promise that resolves with a new `MemoryVectorStore` instance.
+     */
     static async fromDocuments(docs, embeddings, dbConfig) {
         const instance = new this(embeddings, dbConfig);
         await instance.addDocuments(docs);
         return instance;
     }
+    /**
+     * Static method to create a `MemoryVectorStore` instance from an existing
+     * index. It creates a new `MemoryVectorStore` instance without adding any
+     * documents or vectors.
+     * @param embeddings `Embeddings` instance used to generate embeddings for the documents.
+     * @param dbConfig Optional `MemoryVectorStoreArgs` to configure the `MemoryVectorStore` instance.
+     * @returns Promise that resolves with a new `MemoryVectorStore` instance.
+     */
     static async fromExistingIndex(embeddings, dbConfig) {
         const instance = new this(embeddings, dbConfig);
         return instance;