langchain 0.0.130 → 0.0.132

package/dist/vectorstores/analyticdb.d.ts

@@ -2,12 +2,22 @@ import { PoolConfig } from "pg";
 import { VectorStore } from "./base.js";
 import { Embeddings } from "../embeddings/base.js";
 import { Document } from "../document.js";
+/**
+ * Interface defining the arguments required to create an instance of
+ * `AnalyticDBVectorStore`.
+ */
 export interface AnalyticDBArgs {
     connectionOptions: PoolConfig;
     embeddingDimension?: number;
     collectionName?: string;
     preDeleteCollection?: boolean;
 }
+/**
+ * Class that provides methods for creating and managing a collection of
+ * documents in an AnalyticDB, adding documents or vectors to the
+ * collection, performing similarity search on vectors, and creating an
+ * instance of `AnalyticDBVectorStore` from texts or documents.
+ */
 export declare class AnalyticDBVectorStore extends VectorStore {
     FilterType: Record<string, any>;
     private pool;
@@ -17,14 +27,84 @@ export declare class AnalyticDBVectorStore extends VectorStore {
     private isCreateCollection;
     _vectorstoreType(): string;
     constructor(embeddings: Embeddings, args: AnalyticDBArgs);
+    /**
+     * Closes all the clients in the pool and terminates the pool.
+     * @returns Promise that resolves when all clients are closed and the pool is terminated.
+     */
     end(): Promise<void>;
+    /**
+     * Creates a new table in the database if it does not already exist. The
+     * table is created with columns for id, embedding, document, and
+     * metadata. An index is also created on the embedding column if it does
+     * not already exist.
+     * @returns Promise that resolves when the table and index are created.
+     */
     createTableIfNotExists(): Promise<void>;
+    /**
+     * Deletes the collection from the database if it exists.
+     * @returns Promise that resolves when the collection is deleted.
+     */
     deleteCollection(): Promise<void>;
+    /**
+     * Creates a new collection in the database. If `preDeleteCollection` is
+     * true, any existing collection with the same name is deleted before the
+     * new collection is created.
+     * @returns Promise that resolves when the collection is created.
+     */
     createCollection(): Promise<void>;
+    /**
+     * Adds an array of documents to the collection. The documents are first
+     * converted to vectors using the `embedDocuments` method of the
+     * `embeddings` instance.
+     * @param documents Array of Document instances to be added to the collection.
+     * @returns Promise that resolves when the documents are added.
+     */
     addDocuments(documents: Document[]): Promise<void>;
+    /**
+     * Adds an array of vectors and corresponding documents to the collection.
+     * The vectors and documents are batch inserted into the database.
+     * @param vectors Array of vectors to be added to the collection.
+     * @param documents Array of Document instances corresponding to the vectors.
+     * @returns Promise that resolves when the vectors and documents are added.
+     */
     addVectors(vectors: number[][], documents: Document[]): Promise<void>;
+    /**
+     * Performs a similarity search on the vectors in the collection. The
+     * search is performed using the given query vector and returns the top k
+     * most similar vectors along with their corresponding documents and
+     * similarity scores.
+     * @param query Query vector for the similarity search.
+     * @param k Number of top similar vectors to return.
+     * @param filter Optional. Filter to apply on the metadata of the documents.
+     * @returns Promise that resolves to an array of tuples, each containing a Document instance and its similarity score.
+     */
     similaritySearchVectorWithScore(query: number[], k: number, filter?: this["FilterType"]): Promise<[Document, number][]>;
+    /**
+     * Creates an instance of `AnalyticDBVectorStore` from an array of texts
+     * and corresponding metadata. The texts are first converted to Document
+     * instances before being added to the collection.
+     * @param texts Array of texts to be added to the collection.
+     * @param metadatas Array or object of metadata corresponding to the texts.
+     * @param embeddings Embeddings instance used to convert the texts to vectors.
+     * @param dbConfig Configuration for the AnalyticDB.
+     * @returns Promise that resolves to an instance of `AnalyticDBVectorStore`.
+     */
     static fromTexts(texts: string[], metadatas: object[] | object, embeddings: Embeddings, dbConfig: AnalyticDBArgs): Promise<AnalyticDBVectorStore>;
+    /**
+     * Creates an instance of `AnalyticDBVectorStore` from an array of
+     * Document instances. The documents are added to the collection.
+     * @param docs Array of Document instances to be added to the collection.
+     * @param embeddings Embeddings instance used to convert the documents to vectors.
+     * @param dbConfig Configuration for the AnalyticDB.
+     * @returns Promise that resolves to an instance of `AnalyticDBVectorStore`.
+     */
     static fromDocuments(docs: Document[], embeddings: Embeddings, dbConfig: AnalyticDBArgs): Promise<AnalyticDBVectorStore>;
+    /**
+     * Creates an instance of `AnalyticDBVectorStore` from an existing index
+     * in the database. A new collection is created in the database.
+     * @param embeddings Embeddings instance used to convert the documents to vectors.
+     * @param dbConfig Configuration for the AnalyticDB.
+     * @returns Promise that resolves to an instance of `AnalyticDBVectorStore`.
+     */
     static fromExistingIndex(embeddings: Embeddings, dbConfig: AnalyticDBArgs): Promise<AnalyticDBVectorStore>;
 }

package/dist/vectorstores/analyticdb.js

@@ -7,6 +7,12 @@ import { VectorStore } from "./base.js";
 import { Document } from "../document.js";
 const _LANGCHAIN_DEFAULT_EMBEDDING_DIM = 1536;
 const _LANGCHAIN_DEFAULT_COLLECTION_NAME = "langchain_document";
+/**
+ * Class that provides methods for creating and managing a collection of
+ * documents in an AnalyticDB, adding documents or vectors to the
+ * collection, performing similarity search on vectors, and creating an
+ * instance of `AnalyticDBVectorStore` from texts or documents.
+ */
 export class AnalyticDBVectorStore extends VectorStore {
     _vectorstoreType() {
         return "analyticdb";
@@ -56,9 +62,20 @@ export class AnalyticDBVectorStore extends VectorStore {
             args.collectionName || _LANGCHAIN_DEFAULT_COLLECTION_NAME;
         this.preDeleteCollection = args.preDeleteCollection || false;
     }
+    /**
+     * Closes all the clients in the pool and terminates the pool.
+     * @returns Promise that resolves when all clients are closed and the pool is terminated.
+     */
     async end() {
         return this.pool.end();
     }
+    /**
+     * Creates a new table in the database if it does not already exist. The
+     * table is created with columns for id, embedding, document, and
+     * metadata. An index is also created on the embedding column if it does
+     * not already exist.
+     * @returns Promise that resolves when the table and index are created.
+     */
     async createTableIfNotExists() {
         const client = await this.pool.connect();
         try {
@@ -102,10 +119,20 @@ export class AnalyticDBVectorStore extends VectorStore {
             client.release();
         }
     }
+    /**
+     * Deletes the collection from the database if it exists.
+     * @returns Promise that resolves when the collection is deleted.
+     */
     async deleteCollection() {
         const dropStatement = `DROP TABLE IF EXISTS ${this.collectionName};`;
         await this.pool.query(dropStatement);
     }
+    /**
+     * Creates a new collection in the database. If `preDeleteCollection` is
+     * true, any existing collection with the same name is deleted before the
+     * new collection is created.
+     * @returns Promise that resolves when the collection is created.
+     */
     async createCollection() {
         if (this.preDeleteCollection) {
             await this.deleteCollection();
@@ -113,10 +140,24 @@ export class AnalyticDBVectorStore extends VectorStore {
         await this.createTableIfNotExists();
         this.isCreateCollection = true;
     }
+    /**
+     * Adds an array of documents to the collection. The documents are first
+     * converted to vectors using the `embedDocuments` method of the
+     * `embeddings` instance.
+     * @param documents Array of Document instances to be added to the collection.
+     * @returns Promise that resolves when the documents are added.
+     */
     async addDocuments(documents) {
         const texts = documents.map(({ pageContent }) => pageContent);
         return this.addVectors(await this.embeddings.embedDocuments(texts), documents);
     }
+    /**
+     * Adds an array of vectors and corresponding documents to the collection.
+     * The vectors and documents are batch inserted into the database.
+     * @param vectors Array of vectors to be added to the collection.
+     * @param documents Array of Document instances corresponding to the vectors.
+     * @returns Promise that resolves when the vectors and documents are added.
+     */
     async addVectors(vectors, documents) {
         if (vectors.length === 0) {
             return;
@@ -183,6 +224,16 @@ export class AnalyticDBVectorStore extends VectorStore {
             client.release();
         }
     }
+    /**
+     * Performs a similarity search on the vectors in the collection. The
+     * search is performed using the given query vector and returns the top k
+     * most similar vectors along with their corresponding documents and
+     * similarity scores.
+     * @param query Query vector for the similarity search.
+     * @param k Number of top similar vectors to return.
+     * @param filter Optional. Filter to apply on the metadata of the documents.
+     * @returns Promise that resolves to an array of tuples, each containing a Document instance and its similarity score.
+     */
     async similaritySearchVectorWithScore(query, k, filter) {
         if (!this.isCreateCollection) {
             await this.createCollection();
@@ -212,6 +263,16 @@ export class AnalyticDBVectorStore extends VectorStore {
         ]);
         return result;
     }
+    /**
+     * Creates an instance of `AnalyticDBVectorStore` from an array of texts
+     * and corresponding metadata. The texts are first converted to Document
+     * instances before being added to the collection.
+     * @param texts Array of texts to be added to the collection.
+     * @param metadatas Array or object of metadata corresponding to the texts.
+     * @param embeddings Embeddings instance used to convert the texts to vectors.
+     * @param dbConfig Configuration for the AnalyticDB.
+     * @returns Promise that resolves to an instance of `AnalyticDBVectorStore`.
+     */
     static async fromTexts(texts, metadatas, embeddings, dbConfig) {
         const docs = [];
         for (let i = 0; i < texts.length; i += 1) {
@@ -224,11 +285,26 @@ export class AnalyticDBVectorStore extends VectorStore {
         }
         return AnalyticDBVectorStore.fromDocuments(docs, embeddings, dbConfig);
     }
+    /**
+     * Creates an instance of `AnalyticDBVectorStore` from an array of
+     * Document instances. The documents are added to the collection.
+     * @param docs Array of Document instances to be added to the collection.
+     * @param embeddings Embeddings instance used to convert the documents to vectors.
+     * @param dbConfig Configuration for the AnalyticDB.
+     * @returns Promise that resolves to an instance of `AnalyticDBVectorStore`.
+     */
     static async fromDocuments(docs, embeddings, dbConfig) {
         const instance = new this(embeddings, dbConfig);
         await instance.addDocuments(docs);
         return instance;
     }
+    /**
+     * Creates an instance of `AnalyticDBVectorStore` from an existing index
+     * in the database. A new collection is created in the database.
+     * @param embeddings Embeddings instance used to convert the documents to vectors.
+     * @param dbConfig Configuration for the AnalyticDB.
+     * @returns Promise that resolves to an instance of `AnalyticDBVectorStore`.
+     */
     static async fromExistingIndex(embeddings, dbConfig) {
         const instance = new this(embeddings, dbConfig);
         await instance.createCollection();

package/dist/vectorstores/base.cjs

@@ -3,7 +3,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.SaveableVectorStore = exports.VectorStore = exports.VectorStoreRetriever = void 0;
 const retriever_js_1 = require("../schema/retriever.cjs");
 const serializable_js_1 = require("../load/serializable.cjs");
+/**
+ * Class for performing document retrieval from a VectorStore. Can perform
+ * similarity search or maximal marginal relevance search.
+ */
 class VectorStoreRetriever extends retriever_js_1.BaseRetriever {
+    static lc_name() {
+        return "VectorStoreRetriever";
+    }
     get lc_namespace() {
         return ["langchain", "retrievers", "base"];
     }
@@ -68,6 +75,11 @@ class VectorStoreRetriever extends retriever_js_1.BaseRetriever {
     }
 }
 exports.VectorStoreRetriever = VectorStoreRetriever;
+/**
+ * Abstract class representing a store of vectors. Provides methods for
+ * adding vectors and documents, deleting from the store, and searching
+ * the store.
+ */
 class VectorStore extends serializable_js_1.Serializable {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     constructor(embeddings, dbConfig) {
@@ -143,6 +155,10 @@ class VectorStore extends serializable_js_1.Serializable {
     }
 }
 exports.VectorStore = VectorStore;
+/**
+ * Abstract class extending VectorStore with functionality for saving and
+ * loading the vector store.
+ */
 class SaveableVectorStore extends VectorStore {
     static load(_directory, _embeddings) {
         throw new Error("Not implemented");

package/dist/vectorstores/base.d.ts

@@ -3,17 +3,30 @@ import { Document } from "../document.js";
 import { BaseRetriever, BaseRetrieverInput } from "../schema/retriever.js";
 import { Serializable } from "../load/serializable.js";
 import { CallbackManagerForRetrieverRun, Callbacks } from "../callbacks/manager.js";
+/**
+ * Type for options when adding a document to the VectorStore.
+ */
 type AddDocumentOptions = Record<string, any>;
+/**
+ * Type for options when performing a maximal marginal relevance search.
+ */
 export type MaxMarginalRelevanceSearchOptions<FilterType> = {
     k: number;
     fetchK?: number;
     lambda?: number;
     filter?: FilterType;
 };
+/**
+ * Type for options when performing a maximal marginal relevance search
+ * with the VectorStoreRetriever.
+ */
 export type VectorStoreRetrieverMMRSearchKwargs = {
     fetchK?: number;
     lambda?: number;
 };
+/**
+ * Type for input when creating a VectorStoreRetriever instance.
+ */
 export type VectorStoreRetrieverInput<V extends VectorStore> = BaseRetrieverInput & ({
     vectorStore: V;
     k?: number;
@@ -26,7 +39,12 @@ export type VectorStoreRetrieverInput<V extends VectorStore> = BaseRetrieverInpu
     searchType: "mmr";
     searchKwargs?: VectorStoreRetrieverMMRSearchKwargs;
 });
+/**
+ * Class for performing document retrieval from a VectorStore. Can perform
+ * similarity search or maximal marginal relevance search.
+ */
 export declare class VectorStoreRetriever<V extends VectorStore = VectorStore> extends BaseRetriever {
+    static lc_name(): string;
     get lc_namespace(): string[];
     vectorStore: V;
     k: number;
@@ -38,6 +56,11 @@ export declare class VectorStoreRetriever<V extends VectorStore = VectorStore> e
     _getRelevantDocuments(query: string, runManager?: CallbackManagerForRetrieverRun): Promise<Document[]>;
     addDocuments(documents: Document[], options?: AddDocumentOptions): Promise<string[] | void>;
 }
+/**
+ * Abstract class representing a store of vectors. Provides methods for
+ * adding vectors and documents, deleting from the store, and searching
+ * the store.
+ */
 export declare abstract class VectorStore extends Serializable {
     FilterType: object | string;
     lc_namespace: string[];
@@ -70,6 +93,10 @@ export declare abstract class VectorStore extends Serializable {
     static fromDocuments(_docs: Document[], _embeddings: Embeddings, _dbConfig: Record<string, any>): Promise<VectorStore>;
     asRetriever(kOrFields?: number | Partial<VectorStoreRetrieverInput<this>>, filter?: this["FilterType"], callbacks?: Callbacks, tags?: string[], metadata?: Record<string, unknown>, verbose?: boolean): VectorStoreRetriever<this>;
 }
+/**
+ * Abstract class extending VectorStore with functionality for saving and
+ * loading the vector store.
+ */
 export declare abstract class SaveableVectorStore extends VectorStore {
     abstract save(directory: string): Promise<void>;
     static load(_directory: string, _embeddings: Embeddings): Promise<SaveableVectorStore>;

package/dist/vectorstores/base.js

@@ -1,6 +1,13 @@
 import { BaseRetriever } from "../schema/retriever.js";
 import { Serializable } from "../load/serializable.js";
+/**
+ * Class for performing document retrieval from a VectorStore. Can perform
+ * similarity search or maximal marginal relevance search.
+ */
 export class VectorStoreRetriever extends BaseRetriever {
+    static lc_name() {
+        return "VectorStoreRetriever";
+    }
     get lc_namespace() {
         return ["langchain", "retrievers", "base"];
     }
@@ -64,6 +71,11 @@ export class VectorStoreRetriever extends BaseRetriever {
         return this.vectorStore.addDocuments(documents, options);
     }
 }
+/**
+ * Abstract class representing a store of vectors. Provides methods for
+ * adding vectors and documents, deleting from the store, and searching
+ * the store.
+ */
 export class VectorStore extends Serializable {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     constructor(embeddings, dbConfig) {
@@ -138,6 +150,10 @@ export class VectorStore extends Serializable {
         }
     }
 }
+/**
+ * Abstract class extending VectorStore with functionality for saving and
+ * loading the vector store.
+ */
 export class SaveableVectorStore extends VectorStore {
     static load(_directory, _embeddings) {
         throw new Error("Not implemented");

package/dist/vectorstores/chroma.cjs

@@ -27,6 +27,11 @@ exports.Chroma = void 0;
 const uuid = __importStar(require("uuid"));
 const base_js_1 = require("./base.cjs");
 const document_js_1 = require("../document.cjs");
+/**
+ * The main class that extends the `VectorStore` class. It provides
+ * methods for interacting with the Chroma database, such as adding
+ * documents, deleting documents, and searching for similar vectors.
+ */
 class Chroma extends base_js_1.VectorStore {
     _vectorstoreType() {
         return "chroma";
@@ -80,10 +85,23 @@ class Chroma extends base_js_1.VectorStore {
         }
         this.filter = args.filter;
     }
+    /**
+     * Adds documents to the Chroma database. The documents are first
+     * converted to vectors using the `embeddings` instance, and then added to
+     * the database.
+     * @param documents An array of `Document` instances to be added to the database.
+     * @param options Optional. An object containing an array of `ids` for the documents.
+     * @returns A promise that resolves when the documents have been added to the database.
+     */
     async addDocuments(documents, options) {
         const texts = documents.map(({ pageContent }) => pageContent);
         return this.addVectors(await this.embeddings.embedDocuments(texts), documents, options);
     }
+    /**
+     * Ensures that a collection exists in the Chroma database. If the
+     * collection does not exist, it is created.
+     * @returns A promise that resolves with the `Collection` instance.
+     */
     async ensureCollection() {
         if (!this.collection) {
             if (!this.index) {
@@ -101,6 +119,14 @@ class Chroma extends base_js_1.VectorStore {
         }
         return this.collection;
     }
+    /**
+     * Adds vectors to the Chroma database. The vectors are associated with
+     * the provided documents.
+     * @param vectors An array of vectors to be added to the database.
+     * @param documents An array of `Document` instances associated with the vectors.
+     * @param options Optional. An object containing an array of `ids` for the vectors.
+     * @returns A promise that resolves with an array of document IDs when the vectors have been added to the database.
+     */
     async addVectors(vectors, documents, options) {
         if (vectors.length === 0) {
             return [];
@@ -142,6 +168,12 @@ class Chroma extends base_js_1.VectorStore {
         });
         return documentIds;
     }
+    /**
+     * Deletes documents from the Chroma database. The documents to be deleted
+     * can be specified by providing an array of `ids` or a `filter` object.
+     * @param params An object containing either an array of `ids` of the documents to be deleted or a `filter` object to specify the documents to be deleted.
+     * @returns A promise that resolves when the specified documents have been deleted from the database.
+     */
     async delete(params) {
         const collection = await this.ensureCollection();
         if (Array.isArray(params.ids)) {
@@ -156,6 +188,15 @@ class Chroma extends base_js_1.VectorStore {
             throw new Error(`You must provide one of "ids or "filter".`);
         }
     }
+    /**
+     * Searches for vectors in the Chroma database that are similar to the
+     * provided query vector. The search can be filtered using the provided
+     * `filter` object or the `filter` property of the `Chroma` instance.
+     * @param query The query vector.
+     * @param k The number of similar vectors to return.
+     * @param filter Optional. A `filter` object to filter the search results.
+     * @returns A promise that resolves with an array of tuples, each containing a `Document` instance and a similarity score.
+     */
     async similaritySearchVectorWithScore(query, k, filter) {
         if (filter && this.filter) {
             throw new Error("cannot provide both `filter` and `this.filter`");
@@ -204,6 +245,16 @@ class Chroma extends base_js_1.VectorStore {
         }
         return results;
     }
+    /**
+     * Creates a new `Chroma` instance from an array of text strings. The text
+     * strings are converted to `Document` instances and added to the Chroma
+     * database.
+     * @param texts An array of text strings.
+     * @param metadatas An array of metadata objects or a single metadata object. If an array is provided, it must have the same length as the `texts` array.
+     * @param embeddings An `Embeddings` instance used to generate embeddings for the documents.
+     * @param dbConfig A `ChromaLibArgs` object containing the configuration for the Chroma database.
+     * @returns A promise that resolves with a new `Chroma` instance.
+     */
     static async fromTexts(texts, metadatas, embeddings, dbConfig) {
         const docs = [];
         for (let i = 0; i < texts.length; i += 1) {
@@ -216,16 +267,35 @@ class Chroma extends base_js_1.VectorStore {
         }
         return this.fromDocuments(docs, embeddings, dbConfig);
     }
+    /**
+     * Creates a new `Chroma` instance from an array of `Document` instances.
+     * The documents are added to the Chroma database.
+     * @param docs An array of `Document` instances.
+     * @param embeddings An `Embeddings` instance used to generate embeddings for the documents.
+     * @param dbConfig A `ChromaLibArgs` object containing the configuration for the Chroma database.
+     * @returns A promise that resolves with a new `Chroma` instance.
+     */
     static async fromDocuments(docs, embeddings, dbConfig) {
         const instance = new this(embeddings, dbConfig);
         await instance.addDocuments(docs);
         return instance;
     }
+    /**
+     * Creates a new `Chroma` instance from an existing collection in the
+     * Chroma database.
+     * @param embeddings An `Embeddings` instance used to generate embeddings for the documents.
+     * @param dbConfig A `ChromaLibArgs` object containing the configuration for the Chroma database.
+     * @returns A promise that resolves with a new `Chroma` instance.
+     */
     static async fromExistingCollection(embeddings, dbConfig) {
         const instance = new this(embeddings, dbConfig);
         await instance.ensureCollection();
         return instance;
     }
+    /**
+     * Imports the `ChromaClient` from the `chromadb` module.
+     * @returns A promise that resolves with an object containing the `ChromaClient` constructor.
+     */
     static async imports() {
         try {
             const { ChromaClient } = await import("chromadb");
@@ -237,6 +307,9 @@ class Chroma extends base_js_1.VectorStore {
     }
 }
 exports.Chroma = Chroma;
+/**
+ * Generates a unique collection name if none is provided.
+ */
 function ensureCollectionName(collectionName) {
     if (!collectionName) {
         return `langchain-${uuid.v4()}`;

package/dist/vectorstores/chroma.d.ts

@@ -3,6 +3,15 @@ import type { Where } from "chromadb/dist/main/types.js";
 import { Embeddings } from "../embeddings/base.js";
 import { VectorStore } from "./base.js";
 import { Document } from "../document.js";
+/**
+ * Defines the arguments that can be passed to the `Chroma` class
+ * constructor. It can either contain a `url` for the Chroma database, the
+ * number of dimensions for the vectors (`numDimensions`), a
+ * `collectionName` for the collection to be used in the database, and a
+ * `filter` object; or it can contain an `index` which is an instance of
+ * `ChromaClientT`, along with the `numDimensions`, `collectionName`, and
+ * `filter`.
+ */
 export type ChromaLibArgs = {
     url?: string;
     numDimensions?: number;
@@ -14,10 +23,20 @@ export type ChromaLibArgs = {
     collectionName?: string;
     filter?: object;
 };
+/**
+ * Defines the parameters for the `delete` method in the `Chroma` class.
+ * It can either contain an array of `ids` of the documents to be deleted
+ * or a `filter` object to specify the documents to be deleted.
+ */
 export interface ChromaDeleteParams<T> {
     ids?: string[];
     filter?: T;
 }
+/**
+ * The main class that extends the `VectorStore` class. It provides
+ * methods for interacting with the Chroma database, such as adding
+ * documents, deleting documents, and searching for similar vectors.
+ */
 export declare class Chroma extends VectorStore {
     FilterType: Where;
     index?: ChromaClientT;
@@ -28,18 +47,83 @@ export declare class Chroma extends VectorStore {
     filter?: object;
     _vectorstoreType(): string;
     constructor(embeddings: Embeddings, args: ChromaLibArgs);
+    /**
+     * Adds documents to the Chroma database. The documents are first
+     * converted to vectors using the `embeddings` instance, and then added to
+     * the database.
+     * @param documents An array of `Document` instances to be added to the database.
+     * @param options Optional. An object containing an array of `ids` for the documents.
+     * @returns A promise that resolves when the documents have been added to the database.
+     */
     addDocuments(documents: Document[], options?: {
         ids?: string[];
     }): Promise<string[]>;
+    /**
+     * Ensures that a collection exists in the Chroma database. If the
+     * collection does not exist, it is created.
+     * @returns A promise that resolves with the `Collection` instance.
+     */
     ensureCollection(): Promise<Collection>;
+    /**
+     * Adds vectors to the Chroma database. The vectors are associated with
+     * the provided documents.
+     * @param vectors An array of vectors to be added to the database.
+     * @param documents An array of `Document` instances associated with the vectors.
+     * @param options Optional. An object containing an array of `ids` for the vectors.
+     * @returns A promise that resolves with an array of document IDs when the vectors have been added to the database.
+     */
     addVectors(vectors: number[][], documents: Document[], options?: {
         ids?: string[];
     }): Promise<string[]>;
+    /**
+     * Deletes documents from the Chroma database. The documents to be deleted
+     * can be specified by providing an array of `ids` or a `filter` object.
+     * @param params An object containing either an array of `ids` of the documents to be deleted or a `filter` object to specify the documents to be deleted.
+     * @returns A promise that resolves when the specified documents have been deleted from the database.
+     */
     delete(params: ChromaDeleteParams<this["FilterType"]>): Promise<void>;
+    /**
+     * Searches for vectors in the Chroma database that are similar to the
+     * provided query vector. The search can be filtered using the provided
+     * `filter` object or the `filter` property of the `Chroma` instance.
+     * @param query The query vector.
+     * @param k The number of similar vectors to return.
+     * @param filter Optional. A `filter` object to filter the search results.
+     * @returns A promise that resolves with an array of tuples, each containing a `Document` instance and a similarity score.
+     */
     similaritySearchVectorWithScore(query: number[], k: number, filter?: this["FilterType"]): Promise<[Document<Record<string, any>>, number][]>;
+    /**
+     * Creates a new `Chroma` instance from an array of text strings. The text
+     * strings are converted to `Document` instances and added to the Chroma
+     * database.
+     * @param texts An array of text strings.
+     * @param metadatas An array of metadata objects or a single metadata object. If an array is provided, it must have the same length as the `texts` array.
+     * @param embeddings An `Embeddings` instance used to generate embeddings for the documents.
+     * @param dbConfig A `ChromaLibArgs` object containing the configuration for the Chroma database.
+     * @returns A promise that resolves with a new `Chroma` instance.
+     */
     static fromTexts(texts: string[], metadatas: object[] | object, embeddings: Embeddings, dbConfig: ChromaLibArgs): Promise<Chroma>;
+    /**
+     * Creates a new `Chroma` instance from an array of `Document` instances.
+     * The documents are added to the Chroma database.
+     * @param docs An array of `Document` instances.
+     * @param embeddings An `Embeddings` instance used to generate embeddings for the documents.
+     * @param dbConfig A `ChromaLibArgs` object containing the configuration for the Chroma database.
+     * @returns A promise that resolves with a new `Chroma` instance.
+     */
     static fromDocuments(docs: Document[], embeddings: Embeddings, dbConfig: ChromaLibArgs): Promise<Chroma>;
+    /**
+     * Creates a new `Chroma` instance from an existing collection in the
+     * Chroma database.
+     * @param embeddings An `Embeddings` instance used to generate embeddings for the documents.
+     * @param dbConfig A `ChromaLibArgs` object containing the configuration for the Chroma database.
+     * @returns A promise that resolves with a new `Chroma` instance.
+     */
     static fromExistingCollection(embeddings: Embeddings, dbConfig: ChromaLibArgs): Promise<Chroma>;
+    /**
+     * Imports the `ChromaClient` from the `chromadb` module.
+     * @returns A promise that resolves with an object containing the `ChromaClient` constructor.
+     */
     static imports(): Promise<{
         ChromaClient: typeof ChromaClientT;
     }>;