langchain 0.0.130 → 0.0.132

package/dist/vectorstores/myscale.js

@@ -2,6 +2,12 @@ import * as uuid from "uuid";
 import { createClient } from "@clickhouse/client";
 import { VectorStore } from "./base.js";
 import { Document } from "../document.js";
+/**
+ * Class for interacting with the MyScale database. It extends the
+ * VectorStore class and provides methods for adding vectors and
+ * documents, searching for similar vectors, and creating instances from
+ * texts or documents.
+ */
 export class MyScaleStore extends VectorStore {
     _vectorstoreType() {
         return "myscale";
@@ -74,6 +80,12 @@ export class MyScaleStore extends VectorStore {
             session_id: uuid.v4(),
         });
     }
+    /**
+     * Method to add vectors to the MyScale database.
+     * @param vectors The vectors to add.
+     * @param documents The documents associated with the vectors.
+     * @returns Promise that resolves when the vectors have been added.
+     */
     async addVectors(vectors, documents) {
         if (vectors.length === 0) {
             return;
@@ -84,9 +96,21 @@ export class MyScaleStore extends VectorStore {
         const queryStr = this.buildInsertQuery(vectors, documents);
         await this.client.exec({ query: queryStr });
     }
+    /**
+     * Method to add documents to the MyScale database.
+     * @param documents The documents to add.
+     * @returns Promise that resolves when the documents have been added.
+     */
     async addDocuments(documents) {
         return this.addVectors(await this.embeddings.embedDocuments(documents.map((d) => d.pageContent)), documents);
     }
+    /**
+     * Method to search for vectors that are similar to a given query vector.
+     * @param query The query vector.
+     * @param k The number of similar vectors to return.
+     * @param filter Optional filter for the search results.
+     * @returns Promise that resolves with an array of tuples, each containing a Document and a score.
+     */
     async similaritySearchVectorWithScore(query, k, filter) {
         if (!this.isInitialized) {
             await this.initialize(query.length);
@@ -100,6 +124,14 @@ export class MyScaleStore extends VectorStore {
         ]);
         return result;
     }
+    /**
+     * Static method to create an instance of MyScaleStore from texts.
+     * @param texts The texts to use.
+     * @param metadatas The metadata associated with the texts.
+     * @param embeddings The embeddings to use.
+     * @param args The arguments for the MyScaleStore.
+     * @returns Promise that resolves with a new instance of MyScaleStore.
+     */
     static async fromTexts(texts, metadatas, embeddings, args) {
         const docs = [];
         for (let i = 0; i < texts.length; i += 1) {
@@ -112,16 +144,35 @@ export class MyScaleStore extends VectorStore {
         }
         return MyScaleStore.fromDocuments(docs, embeddings, args);
     }
+    /**
+     * Static method to create an instance of MyScaleStore from documents.
+     * @param docs The documents to use.
+     * @param embeddings The embeddings to use.
+     * @param args The arguments for the MyScaleStore.
+     * @returns Promise that resolves with a new instance of MyScaleStore.
+     */
     static async fromDocuments(docs, embeddings, args) {
         const instance = new this(embeddings, args);
         await instance.addDocuments(docs);
         return instance;
     }
+    /**
+     * Static method to create an instance of MyScaleStore from an existing
+     * index.
+     * @param embeddings The embeddings to use.
+     * @param args The arguments for the MyScaleStore.
+     * @returns Promise that resolves with a new instance of MyScaleStore.
+     */
     static async fromExistingIndex(embeddings, args) {
         const instance = new this(embeddings, args);
         await instance.initialize();
         return instance;
     }
+    /**
+     * Method to initialize the MyScale database.
+     * @param dimension Optional dimension of the vectors.
+     * @returns Promise that resolves when the database has been initialized.
+     */
     async initialize(dimension) {
         const dim = dimension ?? (await this.embeddings.embedQuery("test")).length;
         let indexParamStr = "";
@@ -145,6 +196,13 @@ export class MyScaleStore extends VectorStore {
         await this.client.exec({ query });
         this.isInitialized = true;
     }
+    /**
+     * Method to build an SQL query for inserting vectors and documents into
+     * the MyScale database.
+     * @param vectors The vectors to insert.
+     * @param documents The documents to insert.
+     * @returns The SQL query string.
+     */
     buildInsertQuery(vectors, documents) {
         const columnsStr = Object.values(this.columnMap).join(", ");
         const data = [];
@@ -170,6 +228,14 @@ export class MyScaleStore extends VectorStore {
     escapeString(str) {
         return str.replace(/\\/g, "\\\\").replace(/'/g, "\\'");
     }
+    /**
+     * Method to build an SQL query for searching for similar vectors in the
+     * MyScale database.
+     * @param query The query vector.
+     * @param k The number of similar vectors to return.
+     * @param filter Optional filter for the search results.
+     * @returns The SQL query string.
+     */
     buildSearchQuery(query, k, filter) {
         const order = this.metric === "ip" ? "DESC" : "ASC";
         const whereStr = filter ? `PREWHERE ${filter.whereStr}` : "";

package/dist/vectorstores/opensearch.cjs

@@ -28,6 +28,12 @@ const opensearch_1 = require("@opensearch-project/opensearch");
 const uuid = __importStar(require("uuid"));
 const document_js_1 = require("../document.cjs");
 const base_js_1 = require("./base.cjs");
+/**
+ * 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.
+ */
 class OpenSearchVectorStore extends base_js_1.VectorStore {
     _vectorstoreType() {
         return "opensearch";
@@ -84,10 +90,24 @@ class OpenSearchVectorStore extends base_js_1.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) => [
@@ -106,6 +126,14 @@ class OpenSearchVectorStore extends base_js_1.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,
@@ -135,6 +163,15 @@ class OpenSearchVectorStore extends base_js_1.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;
@@ -142,11 +179,26 @@ class OpenSearchVectorStore extends base_js_1.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 });
@@ -202,6 +254,10 @@ class OpenSearchVectorStore extends base_js_1.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 });
@@ -215,6 +271,10 @@ class OpenSearchVectorStore extends base_js_1.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/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 {};