langchain 0.0.131 → 0.0.132

package/dist/vectorstores/typeorm.d.ts

@@ -3,16 +3,31 @@ import { DataSource, DataSourceOptions, EntitySchema } from "typeorm";
 import { VectorStore } from "./base.js";
 import { Embeddings } from "../embeddings/base.js";
 import { Document } from "../document.js";
+/**
+ * Interface that defines the arguments required to create a
+ * `TypeORMVectorStore` instance. It includes Postgres connection options,
+ * table name, filter, and verbosity level.
+ */
 export interface TypeORMVectorStoreArgs {
     postgresConnectionOptions: DataSourceOptions;
     tableName?: string;
     filter?: Metadata;
     verbose?: boolean;
 }
+/**
+ * Class that extends the `Document` base class and adds an `embedding`
+ * property. It represents a document in the vector store.
+ */
 export declare class TypeORMVectorStoreDocument extends Document {
     embedding: string;
     id?: string;
 }
+/**
+ * Class that provides an interface to a Postgres vector database. It
+ * extends the `VectorStore` base class and implements methods for adding
+ * documents and vectors, performing similarity searches, and ensuring the
+ * existence of a table in the database.
+ */
 export declare class TypeORMVectorStore extends VectorStore {
     FilterType: Metadata;
     tableName: string;
@@ -22,12 +37,73 @@ export declare class TypeORMVectorStore extends VectorStore {
     _verbose?: boolean;
     _vectorstoreType(): string;
     private constructor();
+    /**
+     * Static method to create a new `TypeORMVectorStore` instance from a
+     * `DataSource`. It initializes the `DataSource` if it is not already
+     * initialized.
+     * @param embeddings Embeddings instance.
+     * @param fields `TypeORMVectorStoreArgs` instance.
+     * @returns A new instance of `TypeORMVectorStore`.
+     */
     static fromDataSource(embeddings: Embeddings, fields: TypeORMVectorStoreArgs): Promise<TypeORMVectorStore>;
+    /**
+     * Method to add documents to the vector store. It ensures the existence
+     * of the table in the database, converts the documents into vectors, and
+     * adds them to the store.
+     * @param documents Array of `Document` instances.
+     * @returns Promise that resolves when the documents have been added.
+     */
     addDocuments(documents: Document[]): Promise<void>;
+    /**
+     * Method to add vectors to the vector store. It converts the vectors into
+     * rows and inserts them into the database.
+     * @param vectors Array of vectors.
+     * @param documents Array of `Document` instances.
+     * @returns Promise that resolves when the vectors have been added.
+     */
     addVectors(vectors: number[][], documents: Document[]): Promise<void>;
+    /**
+     * Method to perform a similarity search in the vector store. It returns
+     * the `k` most similar documents to the query vector, along with their
+     * similarity scores.
+     * @param query Query vector.
+     * @param k Number of most similar documents to return.
+     * @param filter Optional filter to apply to the search.
+     * @returns Promise that resolves with an array of tuples, each containing a `TypeORMVectorStoreDocument` and its similarity score.
+     */
     similaritySearchVectorWithScore(query: number[], k: number, filter?: this["FilterType"]): Promise<[TypeORMVectorStoreDocument, number][]>;
+    /**
+     * Method to ensure the existence of the table in the database. It creates
+     * the table if it does not already exist.
+     * @returns Promise that resolves when the table has been ensured.
+     */
     ensureTableInDatabase(): Promise<void>;
+    /**
+     * Static method to create a new `TypeORMVectorStore` instance from an
+     * array of texts and their metadata. It converts the texts into
+     * `Document` instances and adds them to the store.
+     * @param texts Array of texts.
+     * @param metadatas Array of metadata objects or a single metadata object.
+     * @param embeddings Embeddings instance.
+     * @param dbConfig `TypeORMVectorStoreArgs` instance.
+     * @returns Promise that resolves with a new instance of `TypeORMVectorStore`.
+     */
     static fromTexts(texts: string[], metadatas: object[] | object, embeddings: Embeddings, dbConfig: TypeORMVectorStoreArgs): Promise<TypeORMVectorStore>;
+    /**
+     * Static method to create a new `TypeORMVectorStore` instance from an
+     * array of `Document` instances. It adds the documents to the store.
+     * @param docs Array of `Document` instances.
+     * @param embeddings Embeddings instance.
+     * @param dbConfig `TypeORMVectorStoreArgs` instance.
+     * @returns Promise that resolves with a new instance of `TypeORMVectorStore`.
+     */
     static fromDocuments(docs: Document[], embeddings: Embeddings, dbConfig: TypeORMVectorStoreArgs): Promise<TypeORMVectorStore>;
+    /**
+     * Static method to create a new `TypeORMVectorStore` instance from an
+     * existing index.
+     * @param embeddings Embeddings instance.
+     * @param dbConfig `TypeORMVectorStoreArgs` instance.
+     * @returns Promise that resolves with a new instance of `TypeORMVectorStore`.
+     */
     static fromExistingIndex(embeddings: Embeddings, dbConfig: TypeORMVectorStoreArgs): Promise<TypeORMVectorStore>;
 }

package/dist/vectorstores/typeorm.js

@@ -2,6 +2,10 @@ import { DataSource, EntitySchema } from "typeorm";
 import { VectorStore } from "./base.js";
 import { Document } from "../document.js";
 import { getEnvironmentVariable } from "../util/env.js";
+/**
+ * Class that extends the `Document` base class and adds an `embedding`
+ * property. It represents a document in the vector store.
+ */
 export class TypeORMVectorStoreDocument extends Document {
     constructor() {
         super(...arguments);
@@ -20,6 +24,12 @@ export class TypeORMVectorStoreDocument extends Document {
     }
 }
 const defaultDocumentTableName = "documents";
+/**
+ * Class that provides an interface to a Postgres vector database. It
+ * extends the `VectorStore` base class and implements methods for adding
+ * documents and vectors, performing similarity searches, and ensuring the
+ * existence of a table in the database.
+ */
 export class TypeORMVectorStore extends VectorStore {
     _vectorstoreType() {
         return "typeorm";
@@ -88,6 +98,14 @@ export class TypeORMVectorStore extends VectorStore {
                 fields.verbose ??
                 false;
     }
+    /**
+     * Static method to create a new `TypeORMVectorStore` instance from a
+     * `DataSource`. It initializes the `DataSource` if it is not already
+     * initialized.
+     * @param embeddings Embeddings instance.
+     * @param fields `TypeORMVectorStoreArgs` instance.
+     * @returns A new instance of `TypeORMVectorStore`.
+     */
     static async fromDataSource(embeddings, fields) {
         const postgresqlVectorStore = new TypeORMVectorStore(embeddings, fields);
         if (!postgresqlVectorStore.appDataSource.isInitialized) {
@@ -95,6 +113,13 @@ export class TypeORMVectorStore extends VectorStore {
         }
         return postgresqlVectorStore;
     }
+    /**
+     * Method to add documents to the vector store. It ensures the existence
+     * of the table in the database, converts the documents into vectors, and
+     * adds them to the store.
+     * @param documents Array of `Document` instances.
+     * @returns Promise that resolves when the documents have been added.
+     */
     async addDocuments(documents) {
         const texts = documents.map(({ pageContent }) => pageContent);
         // This will create the table if it does not exist. We can call it every time as it doesn't
@@ -102,6 +127,13 @@ export class TypeORMVectorStore extends VectorStore {
         await this.ensureTableInDatabase();
         return this.addVectors(await this.embeddings.embedDocuments(texts), documents);
     }
+    /**
+     * Method to add vectors to the vector store. It converts the vectors into
+     * rows and inserts them into the database.
+     * @param vectors Array of vectors.
+     * @param documents Array of `Document` instances.
+     * @returns Promise that resolves when the vectors have been added.
+     */
     async addVectors(vectors, documents) {
         const rows = vectors.map((embedding, idx) => {
             const embeddingString = `[${embedding.join(",")}]`;
@@ -125,6 +157,15 @@ export class TypeORMVectorStore extends VectorStore {
             }
         }
     }
+    /**
+     * Method to perform a similarity search in the vector store. It returns
+     * the `k` most similar documents to the query vector, along with their
+     * similarity scores.
+     * @param query Query vector.
+     * @param k Number of most similar documents to return.
+     * @param filter Optional filter to apply to the search.
+     * @returns Promise that resolves with an array of tuples, each containing a `TypeORMVectorStoreDocument` and its similarity score.
+     */
     async similaritySearchVectorWithScore(query, k, filter) {
         const embeddingString = `[${query.join(",")}]`;
         const _filter = filter ?? "{}";
@@ -149,6 +190,11 @@ export class TypeORMVectorStore extends VectorStore {
         }
         return results;
     }
+    /**
+     * Method to ensure the existence of the table in the database. It creates
+     * the table if it does not already exist.
+     * @returns Promise that resolves when the table has been ensured.
+     */
     async ensureTableInDatabase() {
         await this.appDataSource.query("CREATE EXTENSION IF NOT EXISTS vector;");
         await this.appDataSource.query('CREATE EXTENSION IF NOT EXISTS "uuid-ossp";');
@@ -161,6 +207,16 @@ export class TypeORMVectorStore extends VectorStore {
       );
     `);
     }
+    /**
+     * Static method to create a new `TypeORMVectorStore` instance from an
+     * array of texts and their metadata. It converts the texts into
+     * `Document` instances and adds them to the store.
+     * @param texts Array of texts.
+     * @param metadatas Array of metadata objects or a single metadata object.
+     * @param embeddings Embeddings instance.
+     * @param dbConfig `TypeORMVectorStoreArgs` instance.
+     * @returns Promise that resolves with a new instance of `TypeORMVectorStore`.
+     */
     static async fromTexts(texts, metadatas, embeddings, dbConfig) {
         const docs = [];
         for (let i = 0; i < texts.length; i += 1) {
@@ -173,11 +229,26 @@ export class TypeORMVectorStore extends VectorStore {
         }
         return TypeORMVectorStore.fromDocuments(docs, embeddings, dbConfig);
     }
+    /**
+     * Static method to create a new `TypeORMVectorStore` instance from an
+     * array of `Document` instances. It adds the documents to the store.
+     * @param docs Array of `Document` instances.
+     * @param embeddings Embeddings instance.
+     * @param dbConfig `TypeORMVectorStoreArgs` instance.
+     * @returns Promise that resolves with a new instance of `TypeORMVectorStore`.
+     */
     static async fromDocuments(docs, embeddings, dbConfig) {
         const instance = await TypeORMVectorStore.fromDataSource(embeddings, dbConfig);
         await instance.addDocuments(docs);
         return instance;
     }
+    /**
+     * Static method to create a new `TypeORMVectorStore` instance from an
+     * existing index.
+     * @param embeddings Embeddings instance.
+     * @param dbConfig `TypeORMVectorStoreArgs` instance.
+     * @returns Promise that resolves with a new instance of `TypeORMVectorStore`.
+     */
     static async fromExistingIndex(embeddings, dbConfig) {
         const instance = await TypeORMVectorStore.fromDataSource(embeddings, dbConfig);
         return instance;

package/dist/vectorstores/typesense.cjs

@@ -143,6 +143,11 @@ class Typesense extends base_js_1.VectorStore {
         const typesenseDocuments = this._documentsToTypesenseRecords(documents, await this.embeddings.embedDocuments(documents.map((doc) => doc.pageContent)));
         await this.import(typesenseDocuments, this.schemaName);
     }
+    /**
+     * Adds vectors to the vector store.
+     * @param vectors Vectors to add.
+     * @param documents Documents associated with the vectors.
+     */
     async addVectors(vectors, documents) {
         const typesenseDocuments = this._documentsToTypesenseRecords(documents, vectors);
         await this.import(typesenseDocuments, this.schemaName);

package/dist/vectorstores/typesense.d.ts

@@ -92,6 +92,11 @@ export declare class Typesense extends VectorStore {
      * @param documents Documents to add.
      */
     addDocuments(documents: Document[]): Promise<void>;
+    /**
+     * Adds vectors to the vector store.
+     * @param vectors Vectors to add.
+     * @param documents Documents associated with the vectors.
+     */
     addVectors(vectors: number[][], documents: Document[]): Promise<void>;
     /**
      * Search for similar documents with their similarity score.

package/dist/vectorstores/typesense.js

@@ -140,6 +140,11 @@ export class Typesense extends VectorStore {
         const typesenseDocuments = this._documentsToTypesenseRecords(documents, await this.embeddings.embedDocuments(documents.map((doc) => doc.pageContent)));
         await this.import(typesenseDocuments, this.schemaName);
     }
+    /**
+     * Adds vectors to the vector store.
+     * @param vectors Vectors to add.
+     * @param documents Documents associated with the vectors.
+     */
     async addVectors(vectors, documents) {
         const typesenseDocuments = this._documentsToTypesenseRecords(documents, vectors);
         await this.import(typesenseDocuments, this.schemaName);

package/dist/vectorstores/usearch.cjs

@@ -32,6 +32,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");
+/**
+ * Class that extends `SaveableVectorStore` and provides methods for
+ * adding documents and vectors to a `usearch` index, performing
+ * similarity searches, and saving the index.
+ */
 class USearch extends base_js_1.SaveableVectorStore {
     _vectorstoreType() {
         return "usearch";
@@ -68,6 +73,12 @@ class USearch extends base_js_1.SaveableVectorStore {
         this.embeddings = embeddings;
         this.docstore = args?.docstore ?? new in_memory_js_1.SynchronousInMemoryDocstore();
     }
+    /**
+     * Method that adds documents to the `usearch` index. It generates
+     * embeddings for the documents and adds them to the index.
+     * @param documents An array of `Document` instances to be added to the index.
+     * @returns A promise that resolves with an array of document IDs.
+     */
     async addDocuments(documents) {
         const texts = documents.map(({ pageContent }) => pageContent);
         return this.addVectors(await this.embeddings.embedDocuments(texts), documents);
@@ -81,6 +92,13 @@ class USearch extends base_js_1.SaveableVectorStore {
     set index(index) {
         this._index = index;
     }
+    /**
+     * Method that adds vectors to the `usearch` index. It also updates the
+     * mapping between vector IDs and document IDs.
+     * @param vectors An array of vectors to be added to the index.
+     * @param documents An array of `Document` instances corresponding to the vectors.
+     * @returns A promise that resolves with an array of document IDs.
+     */
     async addVectors(vectors, documents) {
         if (vectors.length === 0) {
             return [];
@@ -112,6 +130,14 @@ class USearch extends base_js_1.SaveableVectorStore {
         }
         return documentIds;
     }
+    /**
+     * Method that performs a similarity search in the `usearch` index. It
+     * returns the `k` most similar documents to a given query vector, along
+     * with their similarity scores.
+     * @param query The query vector.
+     * @param k The number of most similar documents to return.
+     * @returns A promise that resolves with an array of tuples, each containing a `Document` and its similarity score.
+     */
     async similaritySearchVectorWithScore(query, k) {
         const d = this.index.dimensions();
         if (BigInt(query.length) !== d) {
@@ -131,6 +157,11 @@ class USearch extends base_js_1.SaveableVectorStore {
         }
         return return_list;
     }
+    /**
+     * Method that saves the `usearch` index and the document store to disk.
+     * @param directory The directory where the index and document store should be saved.
+     * @returns A promise that resolves when the save operation is complete.
+     */
     async save(directory) {
         const fs = await import("node:fs/promises");
         const path = await import("node:path");
@@ -143,6 +174,16 @@ class USearch extends base_js_1.SaveableVectorStore {
             ])),
         ]);
     }
+    /**
+     * Static method that creates a new `USearch` instance from a list of
+     * texts. It generates embeddings for the texts and adds them to the
+     * `usearch` index.
+     * @param texts An array of texts to be added to the index.
+     * @param metadatas Metadata associated with the texts.
+     * @param embeddings An instance of `Embeddings` used to generate embeddings for the texts.
+     * @param dbConfig Optional configuration for the document store.
+     * @returns A promise that resolves with a new `USearch` instance.
+     */
     static async fromTexts(texts, metadatas, embeddings, dbConfig) {
         const docs = [];
         for (let i = 0; i < texts.length; i += 1) {
@@ -155,6 +196,15 @@ class USearch extends base_js_1.SaveableVectorStore {
         }
         return this.fromDocuments(docs, embeddings, dbConfig);
     }
+    /**
+     * Static method that creates a new `USearch` instance from a list of
+     * documents. It generates embeddings for the documents and adds them to
+     * the `usearch` index.
+     * @param docs An array of `Document` instances to be added to the index.
+     * @param embeddings An instance of `Embeddings` used to generate embeddings for the documents.
+     * @param dbConfig Optional configuration for the document store.
+     * @returns A promise that resolves with a new `USearch` instance.
+     */
     static async fromDocuments(docs, embeddings, dbConfig) {
         const args = {
             docstore: dbConfig?.docstore,

package/dist/vectorstores/usearch.d.ts

@@ -3,11 +3,21 @@ 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 that defines the arguments that can be passed to the
+ * `USearch` constructor. It includes optional properties for a
+ * `docstore`, `index`, and `mapping`.
+ */
 export interface USearchArgs {
     docstore?: SynchronousInMemoryDocstore;
     index?: usearch.Index;
     mapping?: Record<number, string>;
 }
+/**
+ * Class that extends `SaveableVectorStore` and provides methods for
+ * adding documents and vectors to a `usearch` index, performing
+ * similarity searches, and saving the index.
+ */
 export declare class USearch extends SaveableVectorStore {
     _index?: usearch.Index;
     _mapping: Record<number, string>;
@@ -15,15 +25,60 @@ export declare class USearch extends SaveableVectorStore {
     args: USearchArgs;
     _vectorstoreType(): string;
     constructor(embeddings: Embeddings, args: USearchArgs);
+    /**
+     * Method that adds documents to the `usearch` index. It generates
+     * embeddings for the documents and adds them to the index.
+     * @param documents An array of `Document` instances to be added to the index.
+     * @returns A promise that resolves with an array of document IDs.
+     */
     addDocuments(documents: Document[]): Promise<string[]>;
     get index(): usearch.Index;
     private set index(value);
+    /**
+     * Method that adds vectors to the `usearch` index. It also updates the
+     * mapping between vector IDs and document IDs.
+     * @param vectors An array of vectors to be added to the index.
+     * @param documents An array of `Document` instances corresponding to the vectors.
+     * @returns A promise that resolves with an array of document IDs.
+     */
     addVectors(vectors: number[][], documents: Document[]): Promise<string[]>;
+    /**
+     * Method that performs a similarity search in the `usearch` index. It
+     * returns the `k` most similar documents to a given query vector, along
+     * with their similarity scores.
+     * @param query The query vector.
+     * @param k The number of most similar documents to return.
+     * @returns A promise that resolves with an array of tuples, each containing a `Document` and its similarity score.
+     */
     similaritySearchVectorWithScore(query: number[], k: number): Promise<[Document<Record<string, any>>, number][]>;
+    /**
+     * Method that saves the `usearch` index and the document store to disk.
+     * @param directory The directory where the index and document store should be saved.
+     * @returns A promise that resolves when the save operation is complete.
+     */
     save(directory: string): Promise<void>;
+    /**
+     * Static method that creates a new `USearch` instance from a list of
+     * texts. It generates embeddings for the texts and adds them to the
+     * `usearch` index.
+     * @param texts An array of texts to be added to the index.
+     * @param metadatas Metadata associated with the texts.
+     * @param embeddings An instance of `Embeddings` used to generate embeddings for the texts.
+     * @param dbConfig Optional configuration for the document store.
+     * @returns A promise that resolves with a new `USearch` instance.
+     */
     static fromTexts(texts: string[], metadatas: object[] | object, embeddings: Embeddings, dbConfig?: {
         docstore?: SynchronousInMemoryDocstore;
     }): Promise<USearch>;
+    /**
+     * Static method that creates a new `USearch` instance from a list of
+     * documents. It generates embeddings for the documents and adds them to
+     * the `usearch` index.
+     * @param docs An array of `Document` instances to be added to the index.
+     * @param embeddings An instance of `Embeddings` used to generate embeddings for the documents.
+     * @param dbConfig Optional configuration for the document store.
+     * @returns A promise that resolves with a new `USearch` instance.
+     */
     static fromDocuments(docs: Document[], embeddings: Embeddings, dbConfig?: {
         docstore?: SynchronousInMemoryDocstore;
     }): Promise<USearch>;

package/dist/vectorstores/usearch.js

@@ -3,6 +3,11 @@ import * as uuid from "uuid";
 import { SaveableVectorStore } from "./base.js";
 import { Document } from "../document.js";
 import { SynchronousInMemoryDocstore } from "../stores/doc/in_memory.js";
+/**
+ * Class that extends `SaveableVectorStore` and provides methods for
+ * adding documents and vectors to a `usearch` index, performing
+ * similarity searches, and saving the index.
+ */
 export class USearch extends SaveableVectorStore {
     _vectorstoreType() {
         return "usearch";
@@ -39,6 +44,12 @@ export class USearch extends SaveableVectorStore {
         this.embeddings = embeddings;
         this.docstore = args?.docstore ?? new SynchronousInMemoryDocstore();
     }
+    /**
+     * Method that adds documents to the `usearch` index. It generates
+     * embeddings for the documents and adds them to the index.
+     * @param documents An array of `Document` instances to be added to the index.
+     * @returns A promise that resolves with an array of document IDs.
+     */
     async addDocuments(documents) {
         const texts = documents.map(({ pageContent }) => pageContent);
         return this.addVectors(await this.embeddings.embedDocuments(texts), documents);
@@ -52,6 +63,13 @@ export class USearch extends SaveableVectorStore {
     set index(index) {
         this._index = index;
     }
+    /**
+     * Method that adds vectors to the `usearch` index. It also updates the
+     * mapping between vector IDs and document IDs.
+     * @param vectors An array of vectors to be added to the index.
+     * @param documents An array of `Document` instances corresponding to the vectors.
+     * @returns A promise that resolves with an array of document IDs.
+     */
     async addVectors(vectors, documents) {
         if (vectors.length === 0) {
             return [];
@@ -83,6 +101,14 @@ export class USearch extends SaveableVectorStore {
         }
         return documentIds;
     }
+    /**
+     * Method that performs a similarity search in the `usearch` index. It
+     * returns the `k` most similar documents to a given query vector, along
+     * with their similarity scores.
+     * @param query The query vector.
+     * @param k The number of most similar documents to return.
+     * @returns A promise that resolves with an array of tuples, each containing a `Document` and its similarity score.
+     */
     async similaritySearchVectorWithScore(query, k) {
         const d = this.index.dimensions();
         if (BigInt(query.length) !== d) {
@@ -102,6 +128,11 @@ export class USearch extends SaveableVectorStore {
         }
         return return_list;
     }
+    /**
+     * Method that saves the `usearch` index and the document store to disk.
+     * @param directory The directory where the index and document store should be saved.
+     * @returns A promise that resolves when the save operation is complete.
+     */
     async save(directory) {
         const fs = await import("node:fs/promises");
         const path = await import("node:path");
@@ -114,6 +145,16 @@ export class USearch extends SaveableVectorStore {
             ])),
         ]);
     }
+    /**
+     * Static method that creates a new `USearch` instance from a list of
+     * texts. It generates embeddings for the texts and adds them to the
+     * `usearch` index.
+     * @param texts An array of texts to be added to the index.
+     * @param metadatas Metadata associated with the texts.
+     * @param embeddings An instance of `Embeddings` used to generate embeddings for the texts.
+     * @param dbConfig Optional configuration for the document store.
+     * @returns A promise that resolves with a new `USearch` instance.
+     */
     static async fromTexts(texts, metadatas, embeddings, dbConfig) {
         const docs = [];
         for (let i = 0; i < texts.length; i += 1) {
@@ -126,6 +167,15 @@ export class USearch extends SaveableVectorStore {
         }
         return this.fromDocuments(docs, embeddings, dbConfig);
     }
+    /**
+     * Static method that creates a new `USearch` instance from a list of
+     * documents. It generates embeddings for the documents and adds them to
+     * the `usearch` index.
+     * @param docs An array of `Document` instances to be added to the index.
+     * @param embeddings An instance of `Embeddings` used to generate embeddings for the documents.
+     * @param dbConfig Optional configuration for the document store.
+     * @returns A promise that resolves with a new `USearch` instance.
+     */
     static async fromDocuments(docs, embeddings, dbConfig) {
         const args = {
             docstore: dbConfig?.docstore,