langchain 0.0.130 → 0.0.132

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

package/dist/vectorstores/redis.d.ts

@@ -3,19 +3,37 @@ import { VectorAlgorithms } from "redis";
 import { Embeddings } from "../embeddings/base.js";
 import { VectorStore } from "./base.js";
 import { Document } from "../document.js";
+/**
+ * Type for creating a schema vector field. It includes the algorithm,
+ * distance metric, and initial capacity.
+ */
 export type CreateSchemaVectorField<T extends VectorAlgorithms, A extends Record<string, unknown>> = {
     ALGORITHM: T;
     DISTANCE_METRIC: "L2" | "IP" | "COSINE";
     INITIAL_CAP?: number;
 } & A;
+/**
+ * Type for creating a flat schema vector field. It extends
+ * CreateSchemaVectorField with a block size property.
+ */
 export type CreateSchemaFlatVectorField = CreateSchemaVectorField<VectorAlgorithms.FLAT, {
     BLOCK_SIZE?: number;
 }>;
+/**
+ * Type for creating a HNSW schema vector field. It extends
+ * CreateSchemaVectorField with M, EF_CONSTRUCTION, and EF_RUNTIME
+ * properties.
+ */
 export type CreateSchemaHNSWVectorField = CreateSchemaVectorField<VectorAlgorithms.HNSW, {
     M?: number;
     EF_CONSTRUCTION?: number;
     EF_RUNTIME?: number;
 }>;
+/**
+ * Interface for the configuration of the RedisVectorStore. It includes
+ * the Redis client, index name, index options, key prefix, content key,
+ * metadata key, vector key, and filter.
+ */
 export interface RedisVectorStoreConfig {
     redisClient: ReturnType<typeof createClient> | ReturnType<typeof createCluster>;
     indexName: string;
@@ -26,11 +44,24 @@ export interface RedisVectorStoreConfig {
     vectorKey?: string;
     filter?: RedisVectorStoreFilterType;
 }
+/**
+ * Interface for the options when adding documents to the
+ * RedisVectorStore. It includes keys and batch size.
+ */
 export interface RedisAddOptions {
     keys?: string[];
     batchSize?: number;
 }
+/**
+ * Type for the filter used in the RedisVectorStore. It is an array of
+ * strings.
+ */
 export type RedisVectorStoreFilterType = string[];
+/**
+ * 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.
+ */
 export declare class RedisVectorStore extends VectorStore {
     FilterType: RedisVectorStoreFilterType;
     private redisClient;
@@ -43,13 +74,70 @@ export declare class RedisVectorStore extends VectorStore {
     filter?: RedisVectorStoreFilterType;
     _vectorstoreType(): string;
     constructor(embeddings: Embeddings, _dbConfig: RedisVectorStoreConfig);
+    /**
+     * 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.
+     */
     addDocuments(documents: Document[], options?: RedisAddOptions): Promise<void>;
+    /**
+     * 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.
+     */
     addVectors(vectors: number[][], documents: Document[], { keys, batchSize }?: RedisAddOptions): Promise<void>;
+    /**
+     * 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.
+     */
     similaritySearchVectorWithScore(query: number[], k: number, filter?: RedisVectorStoreFilterType): Promise<[Document, number][]>;
+    /**
+     * 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: string[], metadatas: object[] | object, embeddings: Embeddings, dbConfig: RedisVectorStoreConfig): Promise<RedisVectorStore>;
+    /**
+     * 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 fromDocuments(docs: Document[], embeddings: Embeddings, dbConfig: RedisVectorStoreConfig): Promise<RedisVectorStore>;
+    /**
+     * Method for checking if an index exists in the RedisVectorStore.
+     * @returns A promise that resolves to a boolean indicating whether the index exists.
+     */
     checkIndexExists(): Promise<boolean>;
+    /**
+     * 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.
+     */
     createIndex(dimensions?: number): Promise<void>;
+    /**
+     * Method for dropping an index from the RedisVectorStore.
+     * @returns A promise that resolves to a boolean indicating whether the index was dropped.
+     */
     dropIndex(): Promise<boolean>;
     private buildQuery;
     private prepareFilter;

package/dist/vectorstores/redis.js

@@ -1,6 +1,11 @@
 import { SchemaFieldTypes, VectorAlgorithms } from "redis";
 import { VectorStore } from "./base.js";
 import { Document } from "../document.js";
+/**
+ * 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.
+ */
 export class RedisVectorStore extends VectorStore {
     _vectorstoreType() {
         return "redis";
@@ -67,10 +72,27 @@ export class RedisVectorStore extends 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);
@@ -93,6 +115,14 @@ export class RedisVectorStore extends 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`");
@@ -118,6 +148,16 @@ export class RedisVectorStore extends 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) {
@@ -130,11 +170,23 @@ export class RedisVectorStore extends 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);
@@ -145,6 +197,12 @@ export class RedisVectorStore extends 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;
@@ -164,6 +222,10 @@ export class RedisVectorStore extends 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);

package/dist/vectorstores/singlestore.cjs

@@ -38,6 +38,11 @@ function withConnectAttributes(config) {
     };
     return result;
 }
+/**
+ * Class for interacting with SingleStoreDB, a high-performance
+ * distributed SQL database. It provides vector storage and vector
+ * functions.
+ */
 class SingleStoreVectorStore extends base_js_1.VectorStore {
     _vectorstoreType() {
         return "singlestore";
@@ -87,6 +92,10 @@ class SingleStoreVectorStore extends base_js_1.VectorStore {
         this.metadataColumnName = config.metadataColumnName ?? "metadata";
         this.distanceMetric = config.distanceMetric ?? "DOT_PRODUCT";
     }
+    /**
+     * Creates a new table in the SingleStoreDB database if it does not
+     * already exist.
+     */
     async createTableIfNotExists() {
         await this.connectionPool
             .execute(`CREATE TABLE IF NOT EXISTS ${this.tableName} (
@@ -94,14 +103,26 @@ class SingleStoreVectorStore extends base_js_1.VectorStore {
       ${this.vectorColumnName} BLOB,
       ${this.metadataColumnName} JSON);`);
     }
+    /**
+     * Ends the connection to the SingleStoreDB database.
+     */
     async end() {
         return this.connectionPool.end();
     }
+    /**
+     * Adds new documents to the SingleStoreDB database.
+     * @param documents An array of Document objects.
+     */
     async addDocuments(documents) {
         const texts = documents.map(({ pageContent }) => pageContent);
         const vectors = await this.embeddings.embedDocuments(texts);
         return this.addVectors(vectors, documents);
     }
+    /**
+     * Adds new vectors to the SingleStoreDB database.
+     * @param vectors An array of vectors.
+     * @param documents An array of Document objects.
+     */
     async addVectors(vectors, documents) {
         await this.createTableIfNotExists();
         const { tableName } = this;
@@ -118,6 +139,14 @@ class SingleStoreVectorStore extends base_js_1.VectorStore {
             }
         }));
     }
+    /**
+     * Performs a similarity search on the vectors stored in the SingleStoreDB
+     * database.
+     * @param query An array of numbers representing the query vector.
+     * @param k The number of nearest neighbors to return.
+     * @param filter Optional metadata to filter the vectors by.
+     * @returns Top matching vectors with score
+     */
     async similaritySearchVectorWithScore(query, k, filter) {
         // build the where clause from filter
         const whereArgs = [];
@@ -157,6 +186,15 @@ class SingleStoreVectorStore extends base_js_1.VectorStore {
         }
         return result;
     }
+    /**
+     * Creates a new instance of the SingleStoreVectorStore class from a list
+     * of texts.
+     * @param texts An array of strings.
+     * @param metadatas An array of metadata objects.
+     * @param embeddings An Embeddings object.
+     * @param dbConfig A SingleStoreVectorStoreConfig object.
+     * @returns A new SingleStoreVectorStore instance
+     */
     static async fromTexts(texts, metadatas, embeddings, dbConfig) {
         const docs = texts.map((text, idx) => {
             const metadata = Array.isArray(metadatas) ? metadatas[idx] : metadatas;
@@ -167,6 +205,14 @@ class SingleStoreVectorStore extends base_js_1.VectorStore {
         });
         return SingleStoreVectorStore.fromDocuments(docs, embeddings, dbConfig);
     }
+    /**
+     * Creates a new instance of the SingleStoreVectorStore class from a list
+     * of Document objects.
+     * @param docs An array of Document objects.
+     * @param embeddings An Embeddings object.
+     * @param dbConfig A SingleStoreVectorStoreConfig object.
+     * @returns A new SingleStoreVectorStore instance
+     */
     static async fromDocuments(docs, embeddings, dbConfig) {
         const instance = new this(embeddings, dbConfig);
         await instance.addDocuments(docs);

package/dist/vectorstores/singlestore.d.ts

@@ -22,6 +22,11 @@ export type SingleStoreVectorStoreConfig = ConnectionConfig & {
     metadataColumnName?: string;
     distanceMetric?: DistanceMetrics;
 };
+/**
+ * Class for interacting with SingleStoreDB, a high-performance
+ * distributed SQL database. It provides vector storage and vector
+ * functions.
+ */
 export declare class SingleStoreVectorStore extends VectorStore {
     connectionPool: Pool;
     tableName: string;
@@ -31,12 +36,53 @@ export declare class SingleStoreVectorStore extends VectorStore {
     distanceMetric: DistanceMetrics;
     _vectorstoreType(): string;
     constructor(embeddings: Embeddings, config: SingleStoreVectorStoreConfig);
+    /**
+     * Creates a new table in the SingleStoreDB database if it does not
+     * already exist.
+     */
     createTableIfNotExists(): Promise<void>;
+    /**
+     * Ends the connection to the SingleStoreDB database.
+     */
     end(): Promise<void>;
+    /**
+     * Adds new documents to the SingleStoreDB database.
+     * @param documents An array of Document objects.
+     */
     addDocuments(documents: Document[]): Promise<void>;
+    /**
+     * Adds new vectors to the SingleStoreDB database.
+     * @param vectors An array of vectors.
+     * @param documents An array of Document objects.
+     */
     addVectors(vectors: number[][], documents: Document[]): Promise<void>;
+    /**
+     * Performs a similarity search on the vectors stored in the SingleStoreDB
+     * database.
+     * @param query An array of numbers representing the query vector.
+     * @param k The number of nearest neighbors to return.
+     * @param filter Optional metadata to filter the vectors by.
+     * @returns Top matching vectors with score
+     */
     similaritySearchVectorWithScore(query: number[], k: number, filter?: Metadata): Promise<[Document, number][]>;
+    /**
+     * Creates a new instance of the SingleStoreVectorStore class from a list
+     * of texts.
+     * @param texts An array of strings.
+     * @param metadatas An array of metadata objects.
+     * @param embeddings An Embeddings object.
+     * @param dbConfig A SingleStoreVectorStoreConfig object.
+     * @returns A new SingleStoreVectorStore instance
+     */
     static fromTexts(texts: string[], metadatas: object[], embeddings: Embeddings, dbConfig: SingleStoreVectorStoreConfig): Promise<SingleStoreVectorStore>;
+    /**
+     * Creates a new instance of the SingleStoreVectorStore class from a list
+     * of Document objects.
+     * @param docs An array of Document objects.
+     * @param embeddings An Embeddings object.
+     * @param dbConfig A SingleStoreVectorStoreConfig object.
+     * @returns A new SingleStoreVectorStore instance
+     */
     static fromDocuments(docs: Document[], embeddings: Embeddings, dbConfig: SingleStoreVectorStoreConfig): Promise<SingleStoreVectorStore>;
 }
 export {};