langchain 0.0.131 → 0.0.132

package/dist/vectorstores/prisma.d.ts

@@ -43,6 +43,11 @@ type SimilarityModel<TModel extends Record<string, unknown> = Record<string, unk
     _distance: number | null;
 };
 type DefaultPrismaVectorStore = PrismaVectorStore<Record<string, unknown>, string, ModelColumns<Record<string, unknown>>, PrismaSqlFilter<Record<string, unknown>>>;
+/**
+ * A specific implementation of the VectorStore class that is designed to
+ * work with Prisma. It provides methods for adding models, documents, and
+ * vectors, as well as for performing similarity searches.
+ */
 export declare class PrismaVectorStore<TModel extends Record<string, unknown>, TModelName extends string, TSelectModel extends ModelColumns<TModel>, TFilterModel extends PrismaSqlFilter<TModel>> extends VectorStore {
     protected tableName: string;
     protected vectorColumnName: string;
@@ -63,6 +68,11 @@ export declare class PrismaVectorStore<TModel extends Record<string, unknown>, T
         columns: TSelectModel;
         filter?: TFilterModel;
     });
+    /**
+     * Creates a new PrismaVectorStore with the specified model.
+     * @param db The PrismaClient instance.
+     * @returns An object with create, fromTexts, and fromDocuments methods.
+     */
     static withModel<TModel extends Record<string, unknown>>(db: PrismaClient): {
         create: <TPrisma extends PrismaNamespace, TColumns extends ModelColumns<TModel>, TFilters extends PrismaSqlFilter<TModel>>(embeddings: Embeddings, config: {
             prisma: TPrisma;
@@ -84,14 +94,63 @@ export declare class PrismaVectorStore<TModel extends Record<string, unknown>, T
             columns: TColumns_2;
         }) => Promise<PrismaVectorStore<TModel, keyof TPrisma_2["ModelName"] & string, TColumns_2, TFilters_1>>;
     };
+    /**
+     * Adds the specified models to the store.
+     * @param models The models to add.
+     * @returns A promise that resolves when the models have been added.
+     */
     addModels(models: TModel[]): Promise<void>;
+    /**
+     * Adds the specified documents to the store.
+     * @param documents The documents to add.
+     * @returns A promise that resolves when the documents have been added.
+     */
     addDocuments(documents: Document<TModel>[]): Promise<void>;
+    /**
+     * Adds the specified vectors to the store.
+     * @param vectors The vectors to add.
+     * @param documents The documents associated with the vectors.
+     * @returns A promise that resolves when the vectors have been added.
+     */
     addVectors(vectors: number[][], documents: Document<TModel>[]): Promise<void>;
+    /**
+     * Performs a similarity search with the specified query.
+     * @param query The query to use for the similarity search.
+     * @param k The number of results to return.
+     * @param _filter The filter to apply to the results.
+     * @param _callbacks The callbacks to use during the search.
+     * @returns A promise that resolves with the search results.
+     */
     similaritySearch(query: string, k?: number, _filter?: this["FilterType"] | undefined, // not used. here to make the interface compatible with the other stores
     _callbacks?: Callbacks | undefined): Promise<Document<SimilarityModel<TModel, TSelectModel>>[]>;
+    /**
+     * Performs a similarity search with the specified query and returns the
+     * results along with their scores.
+     * @param query The query to use for the similarity search.
+     * @param k The number of results to return.
+     * @param filter The filter to apply to the results.
+     * @param _callbacks The callbacks to use during the search.
+     * @returns A promise that resolves with the search results and their scores.
+     */
     similaritySearchWithScore(query: string, k?: number, filter?: TFilterModel, _callbacks?: Callbacks | undefined): Promise<[Document<Record<string, any>>, number][]>;
+    /**
+     * Performs a similarity search with the specified vector and returns the
+     * results along with their scores.
+     * @param query The vector to use for the similarity search.
+     * @param k The number of results to return.
+     * @param filter The filter to apply to the results.
+     * @returns A promise that resolves with the search results and their scores.
+     */
     similaritySearchVectorWithScore(query: number[], k: number, filter?: TFilterModel): Promise<[Document<SimilarityModel<TModel, TSelectModel>>, number][]>;
     buildSqlFilterStr(filter?: TFilterModel): Sql | null;
+    /**
+     * Creates a new PrismaVectorStore from the specified texts.
+     * @param texts The texts to use to create the store.
+     * @param metadatas The metadata for the texts.
+     * @param embeddings The embeddings to use.
+     * @param dbConfig The database configuration.
+     * @returns A promise that resolves with the new PrismaVectorStore.
+     */
     static fromTexts(texts: string[], metadatas: object[], embeddings: Embeddings, dbConfig: {
         db: PrismaClient;
         prisma: PrismaNamespace;
@@ -99,6 +158,13 @@ export declare class PrismaVectorStore<TModel extends Record<string, unknown>, T
         vectorColumnName: string;
         columns: ModelColumns<Record<string, unknown>>;
     }): Promise<DefaultPrismaVectorStore>;
+    /**
+     * Creates a new PrismaVectorStore from the specified documents.
+     * @param docs The documents to use to create the store.
+     * @param embeddings The embeddings to use.
+     * @param dbConfig The database configuration.
+     * @returns A promise that resolves with the new PrismaVectorStore.
+     */
     static fromDocuments(docs: Document[], embeddings: Embeddings, dbConfig: {
         db: PrismaClient;
         prisma: PrismaNamespace;

package/dist/vectorstores/prisma.js

@@ -10,6 +10,11 @@ const OpMap = {
     gte: ">=",
     not: "<>",
 };
+/**
+ * A specific implementation of the VectorStore class that is designed to
+ * work with Prisma. It provides methods for adding models, documents, and
+ * vectors, as well as for performing similarity searches.
+ */
 class PrismaVectorStore extends VectorStore {
     _vectorstoreType() {
         return "prisma";
@@ -84,6 +89,11 @@ class PrismaVectorStore extends VectorStore {
             this.filter = config.filter;
         }
     }
+    /**
+     * Creates a new PrismaVectorStore with the specified model.
+     * @param db The PrismaClient instance.
+     * @returns An object with create, fromTexts, and fromDocuments methods.
+     */
     static withModel(db) {
         function create(embeddings, config) {
             return new PrismaVectorStore(embeddings, { ...config, db });
@@ -110,6 +120,11 @@ class PrismaVectorStore extends VectorStore {
         }
         return { create, fromTexts, fromDocuments };
     }
+    /**
+     * Adds the specified models to the store.
+     * @param models The models to add.
+     * @returns A promise that resolves when the models have been added.
+     */
     async addModels(models) {
         return this.addDocuments(models.map((metadata) => {
             const pageContent = metadata[this.contentColumn];
@@ -118,10 +133,21 @@ class PrismaVectorStore extends VectorStore {
             return new Document({ pageContent, metadata });
         }));
     }
+    /**
+     * Adds the specified documents to the store.
+     * @param documents The documents to add.
+     * @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);
     }
+    /**
+     * Adds the specified vectors to the store.
+     * @param vectors The vectors to add.
+     * @param documents The documents associated with the vectors.
+     * @returns A promise that resolves when the vectors have been added.
+     */
     async addVectors(vectors, documents) {
         // table name, column name cannot be parametrised
         // these fields are thus not escaped by Prisma and can be dangerous if user input is used
@@ -134,16 +160,41 @@ class PrismaVectorStore extends VectorStore {
           WHERE ${idColumnRaw} = ${documents[idx].metadata[this.idColumn]}
         `));
     }
+    /**
+     * Performs a similarity search with the specified query.
+     * @param query The query to use for the similarity search.
+     * @param k The number of results to return.
+     * @param _filter The filter to apply to the results.
+     * @param _callbacks The callbacks to use during the search.
+     * @returns A promise that resolves with the search results.
+     */
     async similaritySearch(query, k = 4, _filter = undefined, // not used. here to make the interface compatible with the other stores
     _callbacks = undefined // implement passing to embedQuery later
     ) {
         const results = await this.similaritySearchVectorWithScore(await this.embeddings.embedQuery(query), k);
         return results.map((result) => result[0]);
     }
+    /**
+     * Performs a similarity search with the specified query and returns the
+     * results along with their scores.
+     * @param query The query to use for the similarity search.
+     * @param k The number of results to return.
+     * @param filter The filter to apply to the results.
+     * @param _callbacks The callbacks to use during the search.
+     * @returns A promise that resolves with the search results and their scores.
+     */
     async similaritySearchWithScore(query, k, filter, _callbacks = undefined // implement passing to embedQuery later
     ) {
         return super.similaritySearchWithScore(query, k, filter);
     }
+    /**
+     * Performs a similarity search with the specified vector and returns the
+     * results along with their scores.
+     * @param query The vector to use for the similarity search.
+     * @param k The number of results to return.
+     * @param filter The filter to apply to the results.
+     * @returns A promise that resolves with the search results and their scores.
+     */
     async similaritySearchVectorWithScore(query, k, filter) {
         // table name, column names cannot be parametrised
         // these fields are thus not escaped by Prisma and can be dangerous if user input is used
@@ -187,6 +238,14 @@ class PrismaVectorStore extends VectorStore {
             return this.Prisma.sql `${colRaw} ${opRaw} ${value}`;
         })), " AND ", " WHERE ");
     }
+    /**
+     * Creates a new PrismaVectorStore from the specified texts.
+     * @param texts The texts to use to create the store.
+     * @param metadatas The metadata for the texts.
+     * @param embeddings The embeddings to use.
+     * @param dbConfig The database configuration.
+     * @returns A promise that resolves with the new PrismaVectorStore.
+     */
     static async fromTexts(texts, metadatas, embeddings, dbConfig) {
         const docs = [];
         for (let i = 0; i < texts.length; i += 1) {
@@ -199,6 +258,13 @@ class PrismaVectorStore extends VectorStore {
         }
         return PrismaVectorStore.fromDocuments(docs, embeddings, dbConfig);
     }
+    /**
+     * Creates a new PrismaVectorStore from the specified documents.
+     * @param docs The documents to use to create the store.
+     * @param embeddings The embeddings to use.
+     * @param dbConfig The database configuration.
+     * @returns A promise that resolves with the new PrismaVectorStore.
+     */
     static async fromDocuments(docs, embeddings, dbConfig) {
         const instance = new PrismaVectorStore(embeddings, dbConfig);
         await instance.addDocuments(docs);

package/dist/vectorstores/qdrant.cjs

@@ -6,6 +6,12 @@ const uuid_1 = require("uuid");
 const base_js_1 = require("./base.cjs");
 const document_js_1 = require("../document.cjs");
 const env_js_1 = require("../util/env.cjs");
+/**
+ * Class that extends the `VectorStore` base class to interact with a
+ * Qdrant database. It includes methods for adding documents and vectors
+ * to the Qdrant database, searching for similar vectors, and ensuring the
+ * existence of a collection in the database.
+ */
 class QdrantVectorStore extends base_js_1.VectorStore {
     get lc_secrets() {
         return {
@@ -55,10 +61,25 @@ class QdrantVectorStore extends base_js_1.VectorStore {
             },
         };
     }
+    /**
+     * Method to add documents to the Qdrant database. It generates vectors
+     * from the documents using the `Embeddings` instance and then adds the
+     * vectors to the database.
+     * @param documents Array of `Document` instances to be added to the Qdrant database.
+     * @returns Promise that resolves when the documents have been added to the database.
+     */
     async addDocuments(documents) {
         const texts = documents.map(({ pageContent }) => pageContent);
         await this.addVectors(await this.embeddings.embedDocuments(texts), documents);
     }
+    /**
+     * Method to add vectors to the Qdrant database. Each vector is associated
+     * with a document, which is stored as the payload for a point in the
+     * database.
+     * @param vectors Array of vectors to be added to the Qdrant database.
+     * @param documents Array of `Document` instances associated with the vectors.
+     * @returns Promise that resolves when the vectors have been added to the database.
+     */
     async addVectors(vectors, documents) {
         if (vectors.length === 0) {
             return;
@@ -77,6 +98,15 @@ class QdrantVectorStore extends base_js_1.VectorStore {
             points,
         });
     }
+    /**
+     * Method to search for vectors in the Qdrant database that are similar to
+     * a given query vector. The search results include the score and payload
+     * (metadata and content) for each similar vector.
+     * @param query Query vector to search for similar vectors in the Qdrant database.
+     * @param k Optional number of similar vectors to return. If not specified, all similar vectors are returned.
+     * @param filter Optional filter to apply to the search results.
+     * @returns Promise that resolves with an array of tuples, where each tuple includes a `Document` instance and a score for a similar vector.
+     */
     async similaritySearchVectorWithScore(query, k, filter) {
         if (!query) {
             return [];
@@ -96,6 +126,11 @@ class QdrantVectorStore extends base_js_1.VectorStore {
         ]);
         return result;
     }
+    /**
+     * Method to ensure the existence of a collection in the Qdrant database.
+     * If the collection does not exist, it is created.
+     * @returns Promise that resolves when the existence of the collection has been ensured.
+     */
     async ensureCollection() {
         const response = await this.client.getCollections();
         const collectionNames = response.collections.map((collection) => collection.name);
@@ -103,6 +138,16 @@ class QdrantVectorStore extends base_js_1.VectorStore {
             await this.client.createCollection(this.collectionName, this.collectionConfig);
         }
     }
+    /**
+     * Static method to create a `QdrantVectorStore` instance from texts. Each
+     * text is associated with metadata and converted to a `Document`
+     * instance, which is then added to the Qdrant database.
+     * @param texts Array of texts to be converted to `Document` instances and added to the Qdrant database.
+     * @param metadatas Array or single object of metadata to be associated with the texts.
+     * @param embeddings `Embeddings` instance used to generate vectors from the texts.
+     * @param dbConfig `QdrantLibArgs` instance specifying the configuration for the Qdrant database.
+     * @returns Promise that resolves with a new `QdrantVectorStore` instance.
+     */
     static async fromTexts(texts, metadatas, embeddings, dbConfig) {
         const docs = [];
         for (let i = 0; i < texts.length; i += 1) {
@@ -115,11 +160,26 @@ class QdrantVectorStore extends base_js_1.VectorStore {
         }
         return QdrantVectorStore.fromDocuments(docs, embeddings, dbConfig);
     }
+    /**
+     * Static method to create a `QdrantVectorStore` instance from `Document`
+     * instances. The documents are added to the Qdrant database.
+     * @param docs Array of `Document` instances to be added to the Qdrant database.
+     * @param embeddings `Embeddings` instance used to generate vectors from the documents.
+     * @param dbConfig `QdrantLibArgs` instance specifying the configuration for the Qdrant database.
+     * @returns Promise that resolves with a new `QdrantVectorStore` instance.
+     */
     static async fromDocuments(docs, embeddings, dbConfig) {
         const instance = new this(embeddings, dbConfig);
         await instance.addDocuments(docs);
         return instance;
     }
+    /**
+     * Static method to create a `QdrantVectorStore` instance from an existing
+     * collection in the Qdrant database.
+     * @param embeddings `Embeddings` instance used to generate vectors from the documents in the collection.
+     * @param dbConfig `QdrantLibArgs` instance specifying the configuration for the Qdrant database.
+     * @returns Promise that resolves with a new `QdrantVectorStore` instance.
+     */
     static async fromExistingCollection(embeddings, dbConfig) {
         const instance = new this(embeddings, dbConfig);
         await instance.ensureCollection();

package/dist/vectorstores/qdrant.d.ts

@@ -3,6 +3,12 @@ import type { Schemas as QdrantSchemas } from "@qdrant/js-client-rest";
 import { Embeddings } from "../embeddings/base.js";
 import { VectorStore } from "./base.js";
 import { Document } from "../document.js";
+/**
+ * Interface for the arguments that can be passed to the
+ * `QdrantVectorStore` constructor. It includes options for specifying a
+ * `QdrantClient` instance, the URL and API key for a Qdrant database, and
+ * the name and configuration for a collection.
+ */
 export interface QdrantLibArgs {
     client?: QdrantClient;
     url?: string;
@@ -10,6 +16,12 @@ export interface QdrantLibArgs {
     collectionName?: string;
     collectionConfig?: QdrantSchemas["CreateCollection"];
 }
+/**
+ * Class that extends the `VectorStore` base class to interact with a
+ * Qdrant database. It includes methods for adding documents and vectors
+ * to the Qdrant database, searching for similar vectors, and ensuring the
+ * existence of a collection in the database.
+ */
 export declare class QdrantVectorStore extends VectorStore {
     get lc_secrets(): {
         [key: string]: string;
@@ -19,11 +31,65 @@ export declare class QdrantVectorStore extends VectorStore {
     collectionConfig: QdrantSchemas["CreateCollection"];
     _vectorstoreType(): string;
     constructor(embeddings: Embeddings, args: QdrantLibArgs);
+    /**
+     * Method to add documents to the Qdrant database. It generates vectors
+     * from the documents using the `Embeddings` instance and then adds the
+     * vectors to the database.
+     * @param documents Array of `Document` instances to be added to the Qdrant database.
+     * @returns Promise that resolves when the documents have been added to the database.
+     */
     addDocuments(documents: Document[]): Promise<void>;
+    /**
+     * Method to add vectors to the Qdrant database. Each vector is associated
+     * with a document, which is stored as the payload for a point in the
+     * database.
+     * @param vectors Array of vectors to be added to the Qdrant database.
+     * @param documents Array of `Document` instances associated with the vectors.
+     * @returns Promise that resolves when the vectors have been added to the database.
+     */
     addVectors(vectors: number[][], documents: Document[]): Promise<void>;
+    /**
+     * Method to search for vectors in the Qdrant database that are similar to
+     * a given query vector. The search results include the score and payload
+     * (metadata and content) for each similar vector.
+     * @param query Query vector to search for similar vectors in the Qdrant database.
+     * @param k Optional number of similar vectors to return. If not specified, all similar vectors are returned.
+     * @param filter Optional filter to apply to the search results.
+     * @returns Promise that resolves with an array of tuples, where each tuple includes a `Document` instance and a score for a similar vector.
+     */
     similaritySearchVectorWithScore(query: number[], k?: number, filter?: QdrantSchemas["Filter"]): Promise<[Document, number][]>;
+    /**
+     * Method to ensure the existence of a collection in the Qdrant database.
+     * If the collection does not exist, it is created.
+     * @returns Promise that resolves when the existence of the collection has been ensured.
+     */
     ensureCollection(): Promise<void>;
+    /**
+     * Static method to create a `QdrantVectorStore` instance from texts. Each
+     * text is associated with metadata and converted to a `Document`
+     * instance, which is then added to the Qdrant database.
+     * @param texts Array of texts to be converted to `Document` instances and added to the Qdrant database.
+     * @param metadatas Array or single object of metadata to be associated with the texts.
+     * @param embeddings `Embeddings` instance used to generate vectors from the texts.
+     * @param dbConfig `QdrantLibArgs` instance specifying the configuration for the Qdrant database.
+     * @returns Promise that resolves with a new `QdrantVectorStore` instance.
+     */
     static fromTexts(texts: string[], metadatas: object[] | object, embeddings: Embeddings, dbConfig: QdrantLibArgs): Promise<QdrantVectorStore>;
+    /**
+     * Static method to create a `QdrantVectorStore` instance from `Document`
+     * instances. The documents are added to the Qdrant database.
+     * @param docs Array of `Document` instances to be added to the Qdrant database.
+     * @param embeddings `Embeddings` instance used to generate vectors from the documents.
+     * @param dbConfig `QdrantLibArgs` instance specifying the configuration for the Qdrant database.
+     * @returns Promise that resolves with a new `QdrantVectorStore` instance.
+     */
     static fromDocuments(docs: Document[], embeddings: Embeddings, dbConfig: QdrantLibArgs): Promise<QdrantVectorStore>;
+    /**
+     * Static method to create a `QdrantVectorStore` instance from an existing
+     * collection in the Qdrant database.
+     * @param embeddings `Embeddings` instance used to generate vectors from the documents in the collection.
+     * @param dbConfig `QdrantLibArgs` instance specifying the configuration for the Qdrant database.
+     * @returns Promise that resolves with a new `QdrantVectorStore` instance.
+     */
     static fromExistingCollection(embeddings: Embeddings, dbConfig: QdrantLibArgs): Promise<QdrantVectorStore>;
 }

package/dist/vectorstores/qdrant.js

@@ -3,6 +3,12 @@ import { v4 as uuid } from "uuid";
 import { VectorStore } from "./base.js";
 import { Document } from "../document.js";
 import { getEnvironmentVariable } from "../util/env.js";
+/**
+ * Class that extends the `VectorStore` base class to interact with a
+ * Qdrant database. It includes methods for adding documents and vectors
+ * to the Qdrant database, searching for similar vectors, and ensuring the
+ * existence of a collection in the database.
+ */
 export class QdrantVectorStore extends VectorStore {
     get lc_secrets() {
         return {
@@ -52,10 +58,25 @@ export class QdrantVectorStore extends VectorStore {
             },
         };
     }
+    /**
+     * Method to add documents to the Qdrant database. It generates vectors
+     * from the documents using the `Embeddings` instance and then adds the
+     * vectors to the database.
+     * @param documents Array of `Document` instances to be added to the Qdrant database.
+     * @returns Promise that resolves when the documents have been added to the database.
+     */
     async addDocuments(documents) {
         const texts = documents.map(({ pageContent }) => pageContent);
         await this.addVectors(await this.embeddings.embedDocuments(texts), documents);
     }
+    /**
+     * Method to add vectors to the Qdrant database. Each vector is associated
+     * with a document, which is stored as the payload for a point in the
+     * database.
+     * @param vectors Array of vectors to be added to the Qdrant database.
+     * @param documents Array of `Document` instances associated with the vectors.
+     * @returns Promise that resolves when the vectors have been added to the database.
+     */
     async addVectors(vectors, documents) {
         if (vectors.length === 0) {
             return;
@@ -74,6 +95,15 @@ export class QdrantVectorStore extends VectorStore {
             points,
         });
     }
+    /**
+     * Method to search for vectors in the Qdrant database that are similar to
+     * a given query vector. The search results include the score and payload
+     * (metadata and content) for each similar vector.
+     * @param query Query vector to search for similar vectors in the Qdrant database.
+     * @param k Optional number of similar vectors to return. If not specified, all similar vectors are returned.
+     * @param filter Optional filter to apply to the search results.
+     * @returns Promise that resolves with an array of tuples, where each tuple includes a `Document` instance and a score for a similar vector.
+     */
     async similaritySearchVectorWithScore(query, k, filter) {
         if (!query) {
             return [];
@@ -93,6 +123,11 @@ export class QdrantVectorStore extends VectorStore {
         ]);
         return result;
     }
+    /**
+     * Method to ensure the existence of a collection in the Qdrant database.
+     * If the collection does not exist, it is created.
+     * @returns Promise that resolves when the existence of the collection has been ensured.
+     */
     async ensureCollection() {
         const response = await this.client.getCollections();
         const collectionNames = response.collections.map((collection) => collection.name);
@@ -100,6 +135,16 @@ export class QdrantVectorStore extends VectorStore {
             await this.client.createCollection(this.collectionName, this.collectionConfig);
         }
     }
+    /**
+     * Static method to create a `QdrantVectorStore` instance from texts. Each
+     * text is associated with metadata and converted to a `Document`
+     * instance, which is then added to the Qdrant database.
+     * @param texts Array of texts to be converted to `Document` instances and added to the Qdrant database.
+     * @param metadatas Array or single object of metadata to be associated with the texts.
+     * @param embeddings `Embeddings` instance used to generate vectors from the texts.
+     * @param dbConfig `QdrantLibArgs` instance specifying the configuration for the Qdrant database.
+     * @returns Promise that resolves with a new `QdrantVectorStore` instance.
+     */
     static async fromTexts(texts, metadatas, embeddings, dbConfig) {
         const docs = [];
         for (let i = 0; i < texts.length; i += 1) {
@@ -112,11 +157,26 @@ export class QdrantVectorStore extends VectorStore {
         }
         return QdrantVectorStore.fromDocuments(docs, embeddings, dbConfig);
     }
+    /**
+     * Static method to create a `QdrantVectorStore` instance from `Document`
+     * instances. The documents are added to the Qdrant database.
+     * @param docs Array of `Document` instances to be added to the Qdrant database.
+     * @param embeddings `Embeddings` instance used to generate vectors from the documents.
+     * @param dbConfig `QdrantLibArgs` instance specifying the configuration for the Qdrant database.
+     * @returns Promise that resolves with a new `QdrantVectorStore` instance.
+     */
     static async fromDocuments(docs, embeddings, dbConfig) {
         const instance = new this(embeddings, dbConfig);
         await instance.addDocuments(docs);
         return instance;
     }
+    /**
+     * Static method to create a `QdrantVectorStore` instance from an existing
+     * collection in the Qdrant database.
+     * @param embeddings `Embeddings` instance used to generate vectors from the documents in the collection.
+     * @param dbConfig `QdrantLibArgs` instance specifying the configuration for the Qdrant database.
+     * @returns Promise that resolves with a new `QdrantVectorStore` instance.
+     */
     static async fromExistingCollection(embeddings, dbConfig) {
         const instance = new this(embeddings, dbConfig);
         await instance.ensureCollection();

package/dist/vectorstores/redis.cjs

@@ -4,6 +4,11 @@ exports.RedisVectorStore = void 0;
 const redis_1 = require("redis");
 const base_js_1 = require("./base.cjs");
 const document_js_1 = require("../document.cjs");
+/**
+ * Class representing a RedisVectorStore. It extends the VectorStore class
+ * and includes methods for adding documents and vectors, performing
+ * similarity searches, managing the index, and more.
+ */
 class RedisVectorStore extends base_js_1.VectorStore {
     _vectorstoreType() {
         return "redis";
@@ -70,10 +75,27 @@ class RedisVectorStore extends base_js_1.VectorStore {
         this.vectorKey = _dbConfig.vectorKey ?? "content_vector";
         this.filter = _dbConfig.filter;
     }
+    /**
+     * Method for adding documents to the RedisVectorStore. It first converts
+     * the documents to texts and then adds them as vectors.
+     * @param documents The documents to add.
+     * @param options Optional parameters for adding the documents.
+     * @returns A promise that resolves when the documents have been added.
+     */
     async addDocuments(documents, options) {
         const texts = documents.map(({ pageContent }) => pageContent);
         return this.addVectors(await this.embeddings.embedDocuments(texts), documents, options);
     }
+    /**
+     * Method for adding vectors to the RedisVectorStore. It checks if the
+     * index exists and creates it if it doesn't, then adds the vectors in
+     * batches.
+     * @param vectors The vectors to add.
+     * @param documents The documents associated with the vectors.
+     * @param keys Optional keys for the vectors.
+     * @param batchSize The size of the batches in which to add the vectors. Defaults to 1000.
+     * @returns A promise that resolves when the vectors have been added.
+     */
     async addVectors(vectors, documents, { keys, batchSize = 1000 } = {}) {
         // check if the index exists and create it if it doesn't
         await this.createIndex(vectors[0].length);
@@ -96,6 +118,14 @@ class RedisVectorStore extends base_js_1.VectorStore {
         // insert final batch
         await multi.exec();
     }
+    /**
+     * Method for performing a similarity search in the RedisVectorStore. It
+     * returns the documents and their scores.
+     * @param query The query vector.
+     * @param k The number of nearest neighbors to return.
+     * @param filter Optional filter to apply to the search.
+     * @returns A promise that resolves to an array of documents and their scores.
+     */
     async similaritySearchVectorWithScore(query, k, filter) {
         if (filter && this.filter) {
             throw new Error("cannot provide both `filter` and `this.filter`");
@@ -121,6 +151,16 @@ class RedisVectorStore extends base_js_1.VectorStore {
         }
         return result;
     }
+    /**
+     * Static method for creating a new instance of RedisVectorStore from
+     * texts. It creates documents from the texts and metadata, then adds them
+     * to the RedisVectorStore.
+     * @param texts The texts to add.
+     * @param metadatas The metadata associated with the texts.
+     * @param embeddings The embeddings to use.
+     * @param dbConfig The configuration for the RedisVectorStore.
+     * @returns A promise that resolves to a new instance of RedisVectorStore.
+     */
     static fromTexts(texts, metadatas, embeddings, dbConfig) {
         const docs = [];
         for (let i = 0; i < texts.length; i += 1) {
@@ -133,11 +173,23 @@ class RedisVectorStore extends base_js_1.VectorStore {
         }
         return RedisVectorStore.fromDocuments(docs, embeddings, dbConfig);
     }
+    /**
+     * Static method for creating a new instance of RedisVectorStore from
+     * documents. It adds the documents to the RedisVectorStore.
+     * @param docs The documents to add.
+     * @param embeddings The embeddings to use.
+     * @param dbConfig The configuration for the RedisVectorStore.
+     * @returns A promise that resolves to a new instance of RedisVectorStore.
+     */
     static async fromDocuments(docs, embeddings, dbConfig) {
         const instance = new this(embeddings, dbConfig);
         await instance.addDocuments(docs);
         return instance;
     }
+    /**
+     * Method for checking if an index exists in the RedisVectorStore.
+     * @returns A promise that resolves to a boolean indicating whether the index exists.
+     */
     async checkIndexExists() {
         try {
             await this.redisClient.ft.info(this.indexName);
@@ -148,6 +200,12 @@ class RedisVectorStore extends base_js_1.VectorStore {
         }
         return true;
     }
+    /**
+     * Method for creating an index in the RedisVectorStore. If the index
+     * already exists, it does nothing.
+     * @param dimensions The dimensions of the index. Defaults to 1536.
+     * @returns A promise that resolves when the index has been created.
+     */
     async createIndex(dimensions = 1536) {
         if (await this.checkIndexExists()) {
             return;
@@ -167,6 +225,10 @@ class RedisVectorStore extends base_js_1.VectorStore {
             PREFIX: this.keyPrefix,
         });
     }
+    /**
+     * Method for dropping an index from the RedisVectorStore.
+     * @returns A promise that resolves to a boolean indicating whether the index was dropped.
+     */
     async dropIndex() {
         try {
             await this.redisClient.ft.dropIndex(this.indexName);