langchain 0.0.131 → 0.0.132

package/dist/vectorstores/opensearch.d.ts

@@ -4,6 +4,11 @@ import { Document } from "../document.js";
 import { VectorStore } from "./base.js";
 type OpenSearchEngine = "nmslib" | "hnsw";
 type OpenSearchSpaceType = "l2" | "cosinesimil" | "ip";
+/**
+ * Interface defining the options for vector search in OpenSearch. It
+ * includes the engine type, space type, and parameters for the HNSW
+ * algorithm.
+ */
 interface VectorSearchOptions {
     readonly engine?: OpenSearchEngine;
     readonly spaceType?: OpenSearchSpaceType;
@@ -11,12 +16,27 @@ interface VectorSearchOptions {
     readonly efConstruction?: number;
     readonly efSearch?: number;
 }
+/**
+ * Interface defining the arguments required to create an instance of the
+ * OpenSearchVectorStore class. It includes the OpenSearch client, index
+ * name, and vector search options.
+ */
 export interface OpenSearchClientArgs {
     readonly client: Client;
     readonly indexName?: string;
     readonly vectorSearchOptions?: VectorSearchOptions;
 }
+/**
+ * Type alias for an object. It's used to define filters for OpenSearch
+ * queries.
+ */
 type OpenSearchFilter = object;
+/**
+ * Class that provides a wrapper around the OpenSearch service for vector
+ * search. It provides methods for adding documents and vectors to the
+ * OpenSearch index, searching for similar vectors, and managing the
+ * OpenSearch index.
+ */
 export declare class OpenSearchVectorStore extends VectorStore {
     FilterType: OpenSearchFilter;
     private readonly client;
@@ -28,15 +48,69 @@ export declare class OpenSearchVectorStore extends VectorStore {
     private readonly m;
     _vectorstoreType(): string;
     constructor(embeddings: Embeddings, args: OpenSearchClientArgs);
+    /**
+     * Method to add documents to the OpenSearch index. It first converts the
+     * documents to vectors using the embeddings, then adds the vectors to the
+     * index.
+     * @param documents The documents to be added to the OpenSearch index.
+     * @returns Promise resolving to void.
+     */
     addDocuments(documents: Document[]): Promise<void>;
+    /**
+     * Method to add vectors to the OpenSearch index. It ensures the index
+     * exists, then adds the vectors and associated documents to the index.
+     * @param vectors The vectors to be added to the OpenSearch index.
+     * @param documents The documents associated with the vectors.
+     * @returns Promise resolving to void.
+     */
     addVectors(vectors: number[][], documents: Document[]): Promise<void>;
+    /**
+     * Method to perform a similarity search on the OpenSearch index using a
+     * query vector. It returns the k most similar documents and their scores.
+     * @param query The query vector.
+     * @param k The number of similar documents to return.
+     * @param filter Optional filter for the OpenSearch query.
+     * @returns Promise resolving to an array of tuples, each containing a Document and its score.
+     */
     similaritySearchVectorWithScore(query: number[], k: number, filter?: OpenSearchFilter | undefined): Promise<[Document, number][]>;
+    /**
+     * Static method to create a new OpenSearchVectorStore from an array of
+     * texts, their metadata, embeddings, and OpenSearch client arguments.
+     * @param texts The texts to be converted into documents and added to the OpenSearch index.
+     * @param metadatas The metadata associated with the texts. Can be an array of objects or a single object.
+     * @param embeddings The embeddings used to convert the texts into vectors.
+     * @param args The OpenSearch client arguments.
+     * @returns Promise resolving to a new instance of OpenSearchVectorStore.
+     */
     static fromTexts(texts: string[], metadatas: object[] | object, embeddings: Embeddings, args: OpenSearchClientArgs): Promise<OpenSearchVectorStore>;
+    /**
+     * Static method to create a new OpenSearchVectorStore from an array of
+     * Documents, embeddings, and OpenSearch client arguments.
+     * @param docs The documents to be added to the OpenSearch index.
+     * @param embeddings The embeddings used to convert the documents into vectors.
+     * @param dbConfig The OpenSearch client arguments.
+     * @returns Promise resolving to a new instance of OpenSearchVectorStore.
+     */
     static fromDocuments(docs: Document[], embeddings: Embeddings, dbConfig: OpenSearchClientArgs): Promise<OpenSearchVectorStore>;
+    /**
+     * Static method to create a new OpenSearchVectorStore from an existing
+     * OpenSearch index, embeddings, and OpenSearch client arguments.
+     * @param embeddings The embeddings used to convert the documents into vectors.
+     * @param dbConfig The OpenSearch client arguments.
+     * @returns Promise resolving to a new instance of OpenSearchVectorStore.
+     */
     static fromExistingIndex(embeddings: Embeddings, dbConfig: OpenSearchClientArgs): Promise<OpenSearchVectorStore>;
     private ensureIndexExists;
     private buildMetadataTerms;
+    /**
+     * Method to check if the OpenSearch index exists.
+     * @returns Promise resolving to a boolean indicating whether the index exists.
+     */
     doesIndexExist(): Promise<boolean>;
+    /**
+     * Method to delete the OpenSearch index if it exists.
+     * @returns Promise resolving to void.
+     */
     deleteIfExists(): Promise<void>;
 }
 export {};

package/dist/vectorstores/opensearch.js

@@ -2,6 +2,12 @@ import { errors } from "@opensearch-project/opensearch";
 import * as uuid from "uuid";
 import { Document } from "../document.js";
 import { VectorStore } from "./base.js";
+/**
+ * Class that provides a wrapper around the OpenSearch service for vector
+ * search. It provides methods for adding documents and vectors to the
+ * OpenSearch index, searching for similar vectors, and managing the
+ * OpenSearch index.
+ */
 export class OpenSearchVectorStore extends VectorStore {
     _vectorstoreType() {
         return "opensearch";
@@ -58,10 +64,24 @@ export class OpenSearchVectorStore extends VectorStore {
         this.client = args.client;
         this.indexName = args.indexName ?? "documents";
     }
+    /**
+     * Method to add documents to the OpenSearch index. It first converts the
+     * documents to vectors using the embeddings, then adds the vectors to the
+     * index.
+     * @param documents The documents to be added to the OpenSearch index.
+     * @returns Promise resolving to void.
+     */
     async addDocuments(documents) {
         const texts = documents.map(({ pageContent }) => pageContent);
         return this.addVectors(await this.embeddings.embedDocuments(texts), documents);
     }
+    /**
+     * Method to add vectors to the OpenSearch index. It ensures the index
+     * exists, then adds the vectors and associated documents to the index.
+     * @param vectors The vectors to be added to the OpenSearch index.
+     * @param documents The documents associated with the vectors.
+     * @returns Promise resolving to void.
+     */
     async addVectors(vectors, documents) {
         await this.ensureIndexExists(vectors[0].length, this.engine, this.spaceType, this.efSearch, this.efConstruction, this.m);
         const operations = vectors.flatMap((embedding, idx) => [
@@ -80,6 +100,14 @@ export class OpenSearchVectorStore extends VectorStore {
         await this.client.bulk({ body: operations });
         await this.client.indices.refresh({ index: this.indexName });
     }
+    /**
+     * Method to perform a similarity search on the OpenSearch index using a
+     * query vector. It returns the k most similar documents and their scores.
+     * @param query The query vector.
+     * @param k The number of similar documents to return.
+     * @param filter Optional filter for the OpenSearch query.
+     * @returns Promise resolving to an array of tuples, each containing a Document and its score.
+     */
     async similaritySearchVectorWithScore(query, k, filter) {
         const search = {
             index: this.indexName,
@@ -109,6 +137,15 @@ export class OpenSearchVectorStore extends VectorStore {
             hit._score,
         ]);
     }
+    /**
+     * Static method to create a new OpenSearchVectorStore from an array of
+     * texts, their metadata, embeddings, and OpenSearch client arguments.
+     * @param texts The texts to be converted into documents and added to the OpenSearch index.
+     * @param metadatas The metadata associated with the texts. Can be an array of objects or a single object.
+     * @param embeddings The embeddings used to convert the texts into vectors.
+     * @param args The OpenSearch client arguments.
+     * @returns Promise resolving to a new instance of OpenSearchVectorStore.
+     */
     static fromTexts(texts, metadatas, embeddings, args) {
         const documents = texts.map((text, idx) => {
             const metadata = Array.isArray(metadatas) ? metadatas[idx] : metadatas;
@@ -116,11 +153,26 @@ export class OpenSearchVectorStore extends VectorStore {
         });
         return OpenSearchVectorStore.fromDocuments(documents, embeddings, args);
     }
+    /**
+     * Static method to create a new OpenSearchVectorStore from an array of
+     * Documents, embeddings, and OpenSearch client arguments.
+     * @param docs The documents to be added to the OpenSearch index.
+     * @param embeddings The embeddings used to convert the documents into vectors.
+     * @param dbConfig The OpenSearch client arguments.
+     * @returns Promise resolving to a new instance of OpenSearchVectorStore.
+     */
     static async fromDocuments(docs, embeddings, dbConfig) {
         const store = new OpenSearchVectorStore(embeddings, dbConfig);
         await store.addDocuments(docs).then(() => store);
         return store;
     }
+    /**
+     * Static method to create a new OpenSearchVectorStore from an existing
+     * OpenSearch index, embeddings, and OpenSearch client arguments.
+     * @param embeddings The embeddings used to convert the documents into vectors.
+     * @param dbConfig The OpenSearch client arguments.
+     * @returns Promise resolving to a new instance of OpenSearchVectorStore.
+     */
     static async fromExistingIndex(embeddings, dbConfig) {
         const store = new OpenSearchVectorStore(embeddings, dbConfig);
         await store.client.cat.indices({ index: store.indexName });
@@ -176,6 +228,10 @@ export class OpenSearchVectorStore extends VectorStore {
         }
         return result;
     }
+    /**
+     * Method to check if the OpenSearch index exists.
+     * @returns Promise resolving to a boolean indicating whether the index exists.
+     */
     async doesIndexExist() {
         try {
             await this.client.cat.indices({ index: this.indexName });
@@ -189,6 +245,10 @@ export class OpenSearchVectorStore extends VectorStore {
             throw err;
         }
     }
+    /**
+     * Method to delete the OpenSearch index if it exists.
+     * @returns Promise resolving to void.
+     */
     async deleteIfExists() {
         const indexExists = await this.doesIndexExist();
         if (!indexExists)

package/dist/vectorstores/pinecone.cjs

@@ -31,6 +31,10 @@ const uuid = __importStar(require("uuid"));
 const flat_1 = __importDefault(require("flat"));
 const base_js_1 = require("./base.cjs");
 const document_js_1 = require("../document.cjs");
+/**
+ * Class that extends the VectorStore class and provides methods to
+ * interact with the Pinecone vector database.
+ */
 class PineconeStore extends base_js_1.VectorStore {
     _vectorstoreType() {
         return "pinecone";
@@ -67,10 +71,23 @@ class PineconeStore extends base_js_1.VectorStore {
         this.textKey = args.textKey ?? "text";
         this.filter = args.filter;
     }
+    /**
+     * Method that adds documents to the Pinecone database.
+     * @param documents Array of documents to add to the Pinecone database.
+     * @param options Optional ids for the documents.
+     * @returns Promise that resolves with the ids of the added documents.
+     */
     async addDocuments(documents, options) {
         const texts = documents.map(({ pageContent }) => pageContent);
         return this.addVectors(await this.embeddings.embedDocuments(texts), documents, options);
     }
+    /**
+     * Method that adds vectors to the Pinecone database.
+     * @param vectors Array of vectors to add to the Pinecone database.
+     * @param documents Array of documents associated with the vectors.
+     * @param options Optional ids for the vectors.
+     * @returns Promise that resolves with the ids of the added vectors.
+     */
     async addVectors(vectors, documents, options) {
         const ids = Array.isArray(options) ? options : options?.ids;
         const documentIds = ids == null ? documents.map(() => uuid.v4()) : ids;
@@ -121,6 +138,11 @@ class PineconeStore extends base_js_1.VectorStore {
         }
         return documentIds;
     }
+    /**
+     * Method that deletes vectors from the Pinecone database.
+     * @param params Parameters for the delete operation.
+     * @returns Promise that resolves when the delete operation is complete.
+     */
     async delete(params) {
         const { namespace = this.namespace, deleteAll, ids, ...rest } = params;
         if (deleteAll) {
@@ -145,6 +167,14 @@ class PineconeStore extends base_js_1.VectorStore {
             throw new Error("Either ids or delete_all must be provided.");
         }
     }
+    /**
+     * Method that performs a similarity search in the Pinecone database and
+     * returns the results along with their scores.
+     * @param query Query vector for the similarity search.
+     * @param k Number of top results to return.
+     * @param filter Optional filter to apply to the search.
+     * @returns Promise that resolves with 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`");
@@ -171,6 +201,15 @@ class PineconeStore extends base_js_1.VectorStore {
         }
         return result;
     }
+    /**
+     * Static method that creates a new instance of the PineconeStore class
+     * from texts.
+     * @param texts Array of texts to add to the Pinecone database.
+     * @param metadatas Metadata associated with the texts.
+     * @param embeddings Embeddings to use for the texts.
+     * @param dbConfig Configuration for the Pinecone database.
+     * @returns Promise that resolves with a new instance of the PineconeStore class.
+     */
     static async fromTexts(texts, metadatas, embeddings, dbConfig) {
         const docs = [];
         for (let i = 0; i < texts.length; i += 1) {
@@ -190,6 +229,14 @@ class PineconeStore extends base_js_1.VectorStore {
         };
         return PineconeStore.fromDocuments(docs, embeddings, args);
     }
+    /**
+     * Static method that creates a new instance of the PineconeStore class
+     * from documents.
+     * @param docs Array of documents to add to the Pinecone database.
+     * @param embeddings Embeddings to use for the documents.
+     * @param dbConfig Configuration for the Pinecone database.
+     * @returns Promise that resolves with a new instance of the PineconeStore class.
+     */
     static async fromDocuments(docs, embeddings, dbConfig) {
         const args = dbConfig;
         args.textKey = dbConfig.textKey ?? "text";
@@ -197,6 +244,13 @@ class PineconeStore extends base_js_1.VectorStore {
         await instance.addDocuments(docs);
         return instance;
     }
+    /**
+     * Static method that creates a new instance of the PineconeStore class
+     * from an existing index.
+     * @param embeddings Embeddings to use for the documents.
+     * @param dbConfig Configuration for the Pinecone database.
+     * @returns Promise that resolves with a new instance of the PineconeStore class.
+     */
     static async fromExistingIndex(embeddings, dbConfig) {
         const instance = new this(embeddings, dbConfig);
         return instance;

package/dist/vectorstores/pinecone.d.ts

@@ -9,11 +9,19 @@ export interface PineconeLibArgs {
     namespace?: string;
     filter?: PineconeMetadata;
 }
+/**
+ * Type that defines the parameters for the delete operation in the
+ * PineconeStore class. It includes ids, deleteAll flag, and namespace.
+ */
 export type PineconeDeleteParams = {
     ids?: string[];
     deleteAll?: boolean;
     namespace?: string;
 };
+/**
+ * Class that extends the VectorStore class and provides methods to
+ * interact with the Pinecone vector database.
+ */
 export declare class PineconeStore extends VectorStore {
     FilterType: PineconeMetadata;
     textKey: string;
@@ -22,14 +30,49 @@ export declare class PineconeStore extends VectorStore {
     filter?: PineconeMetadata;
     _vectorstoreType(): string;
     constructor(embeddings: Embeddings, args: PineconeLibArgs);
+    /**
+     * Method that adds documents to the Pinecone database.
+     * @param documents Array of documents to add to the Pinecone database.
+     * @param options Optional ids for the documents.
+     * @returns Promise that resolves with the ids of the added documents.
+     */
     addDocuments(documents: Document[], options?: {
         ids?: string[];
     } | string[]): Promise<string[]>;
+    /**
+     * Method that adds vectors to the Pinecone database.
+     * @param vectors Array of vectors to add to the Pinecone database.
+     * @param documents Array of documents associated with the vectors.
+     * @param options Optional ids for the vectors.
+     * @returns Promise that resolves with the ids of the added vectors.
+     */
     addVectors(vectors: number[][], documents: Document[], options?: {
         ids?: string[];
     } | string[]): Promise<string[]>;
+    /**
+     * Method that deletes vectors from the Pinecone database.
+     * @param params Parameters for the delete operation.
+     * @returns Promise that resolves when the delete operation is complete.
+     */
     delete(params: PineconeDeleteParams): Promise<void>;
+    /**
+     * Method that performs a similarity search in the Pinecone database and
+     * returns the results along with their scores.
+     * @param query Query vector for the similarity search.
+     * @param k Number of top results to return.
+     * @param filter Optional filter to apply to the search.
+     * @returns Promise that resolves with an array of documents and their scores.
+     */
     similaritySearchVectorWithScore(query: number[], k: number, filter?: PineconeMetadata): Promise<[Document, number][]>;
+    /**
+     * Static method that creates a new instance of the PineconeStore class
+     * from texts.
+     * @param texts Array of texts to add to the Pinecone database.
+     * @param metadatas Metadata associated with the texts.
+     * @param embeddings Embeddings to use for the texts.
+     * @param dbConfig Configuration for the Pinecone database.
+     * @returns Promise that resolves with a new instance of the PineconeStore class.
+     */
     static fromTexts(texts: string[], metadatas: object[] | object, embeddings: Embeddings, dbConfig: {
         /**
          * @deprecated Use pineconeIndex instead
@@ -38,7 +81,22 @@ export declare class PineconeStore extends VectorStore {
         textKey?: string;
         namespace?: string | undefined;
     } | PineconeLibArgs): Promise<PineconeStore>;
+    /**
+     * Static method that creates a new instance of the PineconeStore class
+     * from documents.
+     * @param docs Array of documents to add to the Pinecone database.
+     * @param embeddings Embeddings to use for the documents.
+     * @param dbConfig Configuration for the Pinecone database.
+     * @returns Promise that resolves with a new instance of the PineconeStore class.
+     */
     static fromDocuments(docs: Document[], embeddings: Embeddings, dbConfig: PineconeLibArgs): Promise<PineconeStore>;
+    /**
+     * Static method that creates a new instance of the PineconeStore class
+     * from an existing index.
+     * @param embeddings Embeddings to use for the documents.
+     * @param dbConfig Configuration for the Pinecone database.
+     * @returns Promise that resolves with a new instance of the PineconeStore class.
+     */
     static fromExistingIndex(embeddings: Embeddings, dbConfig: PineconeLibArgs): Promise<PineconeStore>;
 }
 export {};

package/dist/vectorstores/pinecone.js

@@ -2,6 +2,10 @@ import * as uuid from "uuid";
 import flatten from "flat";
 import { VectorStore } from "./base.js";
 import { Document } from "../document.js";
+/**
+ * Class that extends the VectorStore class and provides methods to
+ * interact with the Pinecone vector database.
+ */
 export class PineconeStore extends VectorStore {
     _vectorstoreType() {
         return "pinecone";
@@ -38,10 +42,23 @@ export class PineconeStore extends VectorStore {
         this.textKey = args.textKey ?? "text";
         this.filter = args.filter;
     }
+    /**
+     * Method that adds documents to the Pinecone database.
+     * @param documents Array of documents to add to the Pinecone database.
+     * @param options Optional ids for the documents.
+     * @returns Promise that resolves with the ids of the added documents.
+     */
     async addDocuments(documents, options) {
         const texts = documents.map(({ pageContent }) => pageContent);
         return this.addVectors(await this.embeddings.embedDocuments(texts), documents, options);
     }
+    /**
+     * Method that adds vectors to the Pinecone database.
+     * @param vectors Array of vectors to add to the Pinecone database.
+     * @param documents Array of documents associated with the vectors.
+     * @param options Optional ids for the vectors.
+     * @returns Promise that resolves with the ids of the added vectors.
+     */
     async addVectors(vectors, documents, options) {
         const ids = Array.isArray(options) ? options : options?.ids;
         const documentIds = ids == null ? documents.map(() => uuid.v4()) : ids;
@@ -92,6 +109,11 @@ export class PineconeStore extends VectorStore {
         }
         return documentIds;
     }
+    /**
+     * Method that deletes vectors from the Pinecone database.
+     * @param params Parameters for the delete operation.
+     * @returns Promise that resolves when the delete operation is complete.
+     */
     async delete(params) {
         const { namespace = this.namespace, deleteAll, ids, ...rest } = params;
         if (deleteAll) {
@@ -116,6 +138,14 @@ export class PineconeStore extends VectorStore {
             throw new Error("Either ids or delete_all must be provided.");
         }
     }
+    /**
+     * Method that performs a similarity search in the Pinecone database and
+     * returns the results along with their scores.
+     * @param query Query vector for the similarity search.
+     * @param k Number of top results to return.
+     * @param filter Optional filter to apply to the search.
+     * @returns Promise that resolves with 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`");
@@ -142,6 +172,15 @@ export class PineconeStore extends VectorStore {
         }
         return result;
     }
+    /**
+     * Static method that creates a new instance of the PineconeStore class
+     * from texts.
+     * @param texts Array of texts to add to the Pinecone database.
+     * @param metadatas Metadata associated with the texts.
+     * @param embeddings Embeddings to use for the texts.
+     * @param dbConfig Configuration for the Pinecone database.
+     * @returns Promise that resolves with a new instance of the PineconeStore class.
+     */
     static async fromTexts(texts, metadatas, embeddings, dbConfig) {
         const docs = [];
         for (let i = 0; i < texts.length; i += 1) {
@@ -161,6 +200,14 @@ export class PineconeStore extends VectorStore {
         };
         return PineconeStore.fromDocuments(docs, embeddings, args);
     }
+    /**
+     * Static method that creates a new instance of the PineconeStore class
+     * from documents.
+     * @param docs Array of documents to add to the Pinecone database.
+     * @param embeddings Embeddings to use for the documents.
+     * @param dbConfig Configuration for the Pinecone database.
+     * @returns Promise that resolves with a new instance of the PineconeStore class.
+     */
     static async fromDocuments(docs, embeddings, dbConfig) {
         const args = dbConfig;
         args.textKey = dbConfig.textKey ?? "text";
@@ -168,6 +215,13 @@ export class PineconeStore extends VectorStore {
         await instance.addDocuments(docs);
         return instance;
     }
+    /**
+     * Static method that creates a new instance of the PineconeStore class
+     * from an existing index.
+     * @param embeddings Embeddings to use for the documents.
+     * @param dbConfig Configuration for the Pinecone database.
+     * @returns Promise that resolves with a new instance of the PineconeStore class.
+     */
     static async fromExistingIndex(embeddings, dbConfig) {
         const instance = new this(embeddings, dbConfig);
         return instance;

package/dist/vectorstores/prisma.cjs

@@ -13,6 +13,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 base_js_1.VectorStore {
     _vectorstoreType() {
         return "prisma";
@@ -87,6 +92,11 @@ class PrismaVectorStore extends base_js_1.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 });
@@ -113,6 +123,11 @@ class PrismaVectorStore extends base_js_1.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];
@@ -121,10 +136,21 @@ class PrismaVectorStore extends base_js_1.VectorStore {
             return new document_js_1.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
@@ -137,16 +163,41 @@ class PrismaVectorStore extends base_js_1.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
@@ -190,6 +241,14 @@ class PrismaVectorStore extends base_js_1.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) {
@@ -202,6 +261,13 @@ class PrismaVectorStore extends base_js_1.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);