@langchain/classic 1.0.0-alpha.1

package/dist/vectorstores/memory.d.ts

@@ -0,0 +1,216 @@
+import { cosine } from "../util/ml-distance/similarities.js";
+import { Document, DocumentInterface } from "@langchain/core/documents";
+import { EmbeddingsInterface } from "@langchain/core/embeddings";
+import { MaxMarginalRelevanceSearchOptions, VectorStore } from "@langchain/core/vectorstores";
+
+//#region src/vectorstores/memory.d.ts
+
+/**
+ * Interface representing a vector in memory. It includes the content
+ * (text), the corresponding embedding (vector), and any associated
+ * metadata.
+ */
+interface MemoryVector {
+  content: string;
+  embedding: number[];
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  metadata: Record<string, any>;
+  id?: string;
+}
+/**
+ * Interface for the arguments that can be passed to the
+ * `MemoryVectorStore` constructor. It includes an optional `similarity`
+ * function.
+ */
+interface MemoryVectorStoreArgs {
+  similarity?: typeof cosine;
+}
+/**
+ * In-memory, ephemeral vector store.
+ *
+ * Setup:
+ * Install `langchain`:
+ *
+ * ```bash
+ * npm install langchain
+ * ```
+ *
+ * ## [Constructor args](https://api.js.langchain.com/classes/langchain.vectorstores_memory.MemoryVectorStore.html#constructor)
+ *
+ * <details open>
+ * <summary><strong>Instantiate</strong></summary>
+ *
+ * ```typescript
+ * import { MemoryVectorStore } from 'langchain/vectorstores/memory';
+ * // Or other embeddings
+ * import { OpenAIEmbeddings } from '@langchain/openai';
+ *
+ * const embeddings = new OpenAIEmbeddings({
+ *   model: "text-embedding-3-small",
+ * });
+ *
+ * const vectorStore = new MemoryVectorStore(embeddings);
+ * ```
+ * </details>
+ *
+ * <br />
+ *
+ * <details>
+ * <summary><strong>Add documents</strong></summary>
+ *
+ * ```typescript
+ * import type { Document } from '@langchain/core/documents';
+ *
+ * const document1 = { pageContent: "foo", metadata: { baz: "bar" } };
+ * const document2 = { pageContent: "thud", metadata: { bar: "baz" } };
+ * const document3 = { pageContent: "i will be deleted :(", metadata: {} };
+ *
+ * const documents: Document[] = [document1, document2, document3];
+ *
+ * await vectorStore.addDocuments(documents);
+ * ```
+ * </details>
+ *
+ * <br />
+ *
+ * <details>
+ * <summary><strong>Similarity search</strong></summary>
+ *
+ * ```typescript
+ * const results = await vectorStore.similaritySearch("thud", 1);
+ * for (const doc of results) {
+ *   console.log(`* ${doc.pageContent} [${JSON.stringify(doc.metadata, null)}]`);
+ * }
+ * // Output: * thud [{"baz":"bar"}]
+ * ```
+ * </details>
+ *
+ * <br />
+ *
+ *
+ * <details>
+ * <summary><strong>Similarity search with filter</strong></summary>
+ *
+ * ```typescript
+ * const resultsWithFilter = await vectorStore.similaritySearch("thud", 1, { baz: "bar" });
+ *
+ * for (const doc of resultsWithFilter) {
+ *   console.log(`* ${doc.pageContent} [${JSON.stringify(doc.metadata, null)}]`);
+ * }
+ * // Output: * foo [{"baz":"bar"}]
+ * ```
+ * </details>
+ *
+ * <br />
+ *
+ *
+ * <details>
+ * <summary><strong>Similarity search with score</strong></summary>
+ *
+ * ```typescript
+ * const resultsWithScore = await vectorStore.similaritySearchWithScore("qux", 1);
+ * for (const [doc, score] of resultsWithScore) {
+ *   console.log(`* [SIM=${score.toFixed(6)}] ${doc.pageContent} [${JSON.stringify(doc.metadata, null)}]`);
+ * }
+ * // Output: * [SIM=0.000000] qux [{"bar":"baz","baz":"bar"}]
+ * ```
+ * </details>
+ *
+ * <br />
+ *
+ * <details>
+ * <summary><strong>As a retriever</strong></summary>
+ *
+ * ```typescript
+ * const retriever = vectorStore.asRetriever({
+ *   searchType: "mmr", // Leave blank for standard similarity search
+ *   k: 1,
+ * });
+ * const resultAsRetriever = await retriever.invoke("thud");
+ * console.log(resultAsRetriever);
+ *
+ * // Output: [Document({ metadata: { "baz":"bar" }, pageContent: "thud" })]
+ * ```
+ * </details>
+ *
+ * <br />
+ */
+declare class MemoryVectorStore extends VectorStore {
+  FilterType: (doc: Document) => boolean;
+  memoryVectors: MemoryVector[];
+  similarity: typeof cosine;
+  _vectorstoreType(): string;
+  constructor(embeddings: EmbeddingsInterface, {
+    similarity,
+    ...rest
+  }?: MemoryVectorStoreArgs);
+  /**
+   * Method to add documents to the memory vector store. It extracts the
+   * text from each document, generates embeddings for them, and adds the
+   * resulting vectors to the store.
+   * @param documents Array of `Document` instances to be added to the store.
+   * @returns Promise that resolves when all documents have been added.
+   */
+  addDocuments(documents: Document[]): Promise<void>;
+  /**
+   * Method to add vectors to the memory vector store. It creates
+   * `MemoryVector` instances for each vector and document pair and adds
+   * them to the store.
+   * @param vectors Array of vectors to be added to the store.
+   * @param documents Array of `Document` instances corresponding to the vectors.
+   * @returns Promise that resolves when all vectors have been added.
+   */
+  addVectors(vectors: number[][], documents: Document[]): Promise<void>;
+  protected _queryVectors(query: number[], k: number, filter?: this["FilterType"]): Promise<{
+    similarity: number;
+    index: number;
+    metadata: Record<string, any>;
+    content: string;
+    embedding: number[];
+    id: string | undefined;
+  }[]>;
+  /**
+   * Method to perform a similarity search in the memory vector store. It
+   * calculates the similarity between the query vector and each vector in
+   * the store, sorts the results by similarity, and returns the top `k`
+   * results along with their scores.
+   * @param query Query vector to compare against the vectors in the store.
+   * @param k Number of top results to return.
+   * @param filter Optional filter function to apply to the vectors before performing the search.
+   * @returns Promise that resolves with an array of tuples, each containing a `Document` and its similarity score.
+   */
+  similaritySearchVectorWithScore(query: number[], k: number, filter?: this["FilterType"]): Promise<[Document, number][]>;
+  maxMarginalRelevanceSearch(query: string, options: MaxMarginalRelevanceSearchOptions<this["FilterType"]>): Promise<DocumentInterface[]>;
+  /**
+   * Static method to create a `MemoryVectorStore` instance from an array of
+   * texts. It creates a `Document` for each text and metadata pair, and
+   * adds them to the store.
+   * @param texts Array of texts to be added to the store.
+   * @param metadatas Array or single object of metadata corresponding to the texts.
+   * @param embeddings `Embeddings` instance used to generate embeddings for the texts.
+   * @param dbConfig Optional `MemoryVectorStoreArgs` to configure the `MemoryVectorStore` instance.
+   * @returns Promise that resolves with a new `MemoryVectorStore` instance.
+   */
+  static fromTexts(texts: string[], metadatas: object[] | object, embeddings: EmbeddingsInterface, dbConfig?: MemoryVectorStoreArgs): Promise<MemoryVectorStore>;
+  /**
+   * Static method to create a `MemoryVectorStore` instance from an array of
+   * `Document` instances. It adds the documents to the store.
+   * @param docs Array of `Document` instances to be added to the store.
+   * @param embeddings `Embeddings` instance used to generate embeddings for the documents.
+   * @param dbConfig Optional `MemoryVectorStoreArgs` to configure the `MemoryVectorStore` instance.
+   * @returns Promise that resolves with a new `MemoryVectorStore` instance.
+   */
+  static fromDocuments(docs: Document[], embeddings: EmbeddingsInterface, dbConfig?: MemoryVectorStoreArgs): Promise<MemoryVectorStore>;
+  /**
+   * Static method to create a `MemoryVectorStore` instance from an existing
+   * index. It creates a new `MemoryVectorStore` instance without adding any
+   * documents or vectors.
+   * @param embeddings `Embeddings` instance used to generate embeddings for the documents.
+   * @param dbConfig Optional `MemoryVectorStoreArgs` to configure the `MemoryVectorStore` instance.
+   * @returns Promise that resolves with a new `MemoryVectorStore` instance.
+   */
+  static fromExistingIndex(embeddings: EmbeddingsInterface, dbConfig?: MemoryVectorStoreArgs): Promise<MemoryVectorStore>;
+}
+//#endregion
+export { MemoryVectorStore, MemoryVectorStoreArgs };
+//# sourceMappingURL=memory.d.ts.map

package/dist/vectorstores/memory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"memory.d.ts","names":["MaxMarginalRelevanceSearchOptions","VectorStore","EmbeddingsInterface","Document","DocumentInterface","cosine","MemoryVector","Record","MemoryVectorStoreArgs","MemoryVectorStore","similarity","Promise"],"sources":["../../src/vectorstores/memory.d.ts"],"sourcesContent":["import { MaxMarginalRelevanceSearchOptions, VectorStore } from \"@langchain/core/vectorstores\";\nimport type { EmbeddingsInterface } from \"@langchain/core/embeddings\";\nimport { Document, DocumentInterface } from \"@langchain/core/documents\";\nimport { cosine } from \"../util/ml-distance/similarities.js\";\n/**\n * Interface representing a vector in memory. It includes the content\n * (text), the corresponding embedding (vector), and any associated\n * metadata.\n */\ninterface MemoryVector {\n    content: string;\n    embedding: number[];\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    metadata: Record<string, any>;\n    id?: string;\n}\n/**\n * Interface for the arguments that can be passed to the\n * `MemoryVectorStore` constructor. It includes an optional `similarity`\n * function.\n */\nexport interface MemoryVectorStoreArgs {\n    similarity?: typeof cosine;\n}\n/**\n * In-memory, ephemeral vector store.\n *\n * Setup:\n * Install `langchain`:\n *\n * ```bash\n * npm install langchain\n * ```\n *\n * ## [Constructor args](https://api.js.langchain.com/classes/langchain.vectorstores_memory.MemoryVectorStore.html#constructor)\n *\n * <details open>\n * <summary><strong>Instantiate</strong></summary>\n *\n * ```typescript\n * import { MemoryVectorStore } from 'langchain/vectorstores/memory';\n * // Or other embeddings\n * import { OpenAIEmbeddings } from '@langchain/openai';\n *\n * const embeddings = new OpenAIEmbeddings({\n *   model: \"text-embedding-3-small\",\n * });\n *\n * const vectorStore = new MemoryVectorStore(embeddings);\n * ```\n * </details>\n *\n * <br />\n *\n * <details>\n * <summary><strong>Add documents</strong></summary>\n *\n * ```typescript\n * import type { Document } from '@langchain/core/documents';\n *\n * const document1 = { pageContent: \"foo\", metadata: { baz: \"bar\" } };\n * const document2 = { pageContent: \"thud\", metadata: { bar: \"baz\" } };\n * const document3 = { pageContent: \"i will be deleted :(\", metadata: {} };\n *\n * const documents: Document[] = [document1, document2, document3];\n *\n * await vectorStore.addDocuments(documents);\n * ```\n * </details>\n *\n * <br />\n *\n * <details>\n * <summary><strong>Similarity search</strong></summary>\n *\n * ```typescript\n * const results = await vectorStore.similaritySearch(\"thud\", 1);\n * for (const doc of results) {\n *   console.log(`* ${doc.pageContent} [${JSON.stringify(doc.metadata, null)}]`);\n * }\n * // Output: * thud [{\"baz\":\"bar\"}]\n * ```\n * </details>\n *\n * <br />\n *\n *\n * <details>\n * <summary><strong>Similarity search with filter</strong></summary>\n *\n * ```typescript\n * const resultsWithFilter = await vectorStore.similaritySearch(\"thud\", 1, { baz: \"bar\" });\n *\n * for (const doc of resultsWithFilter) {\n *   console.log(`* ${doc.pageContent} [${JSON.stringify(doc.metadata, null)}]`);\n * }\n * // Output: * foo [{\"baz\":\"bar\"}]\n * ```\n * </details>\n *\n * <br />\n *\n *\n * <details>\n * <summary><strong>Similarity search with score</strong></summary>\n *\n * ```typescript\n * const resultsWithScore = await vectorStore.similaritySearchWithScore(\"qux\", 1);\n * for (const [doc, score] of resultsWithScore) {\n *   console.log(`* [SIM=${score.toFixed(6)}] ${doc.pageContent} [${JSON.stringify(doc.metadata, null)}]`);\n * }\n * // Output: * [SIM=0.000000] qux [{\"bar\":\"baz\",\"baz\":\"bar\"}]\n * ```\n * </details>\n *\n * <br />\n *\n * <details>\n * <summary><strong>As a retriever</strong></summary>\n *\n * ```typescript\n * const retriever = vectorStore.asRetriever({\n *   searchType: \"mmr\", // Leave blank for standard similarity search\n *   k: 1,\n * });\n * const resultAsRetriever = await retriever.invoke(\"thud\");\n * console.log(resultAsRetriever);\n *\n * // Output: [Document({ metadata: { \"baz\":\"bar\" }, pageContent: \"thud\" })]\n * ```\n * </details>\n *\n * <br />\n */\nexport declare class MemoryVectorStore extends VectorStore {\n    FilterType: (doc: Document) => boolean;\n    memoryVectors: MemoryVector[];\n    similarity: typeof cosine;\n    _vectorstoreType(): string;\n    constructor(embeddings: EmbeddingsInterface, { similarity, ...rest }?: MemoryVectorStoreArgs);\n    /**\n     * Method to add documents to the memory vector store. It extracts the\n     * text from each document, generates embeddings for them, and adds the\n     * resulting vectors to the store.\n     * @param documents Array of `Document` instances to be added to the store.\n     * @returns Promise that resolves when all documents have been added.\n     */\n    addDocuments(documents: Document[]): Promise<void>;\n    /**\n     * Method to add vectors to the memory vector store. It creates\n     * `MemoryVector` instances for each vector and document pair and adds\n     * them to the store.\n     * @param vectors Array of vectors to be added to the store.\n     * @param documents Array of `Document` instances corresponding to the vectors.\n     * @returns Promise that resolves when all vectors have been added.\n     */\n    addVectors(vectors: number[][], documents: Document[]): Promise<void>;\n    protected _queryVectors(query: number[], k: number, filter?: this[\"FilterType\"]): Promise<{\n        similarity: number;\n        index: number;\n        metadata: Record<string, any>;\n        content: string;\n        embedding: number[];\n        id: string | undefined;\n    }[]>;\n    /**\n     * Method to perform a similarity search in the memory vector store. It\n     * calculates the similarity between the query vector and each vector in\n     * the store, sorts the results by similarity, and returns the top `k`\n     * results along with their scores.\n     * @param query Query vector to compare against the vectors in the store.\n     * @param k Number of top results to return.\n     * @param filter Optional filter function to apply to the vectors before performing the search.\n     * @returns Promise that resolves with an array of tuples, each containing a `Document` and its similarity score.\n     */\n    similaritySearchVectorWithScore(query: number[], k: number, filter?: this[\"FilterType\"]): Promise<[Document, number][]>;\n    maxMarginalRelevanceSearch(query: string, options: MaxMarginalRelevanceSearchOptions<this[\"FilterType\"]>): Promise<DocumentInterface[]>;\n    /**\n     * Static method to create a `MemoryVectorStore` instance from an array of\n     * texts. It creates a `Document` for each text and metadata pair, and\n     * adds them to the store.\n     * @param texts Array of texts to be added to the store.\n     * @param metadatas Array or single object of metadata corresponding to the texts.\n     * @param embeddings `Embeddings` instance used to generate embeddings for the texts.\n     * @param dbConfig Optional `MemoryVectorStoreArgs` to configure the `MemoryVectorStore` instance.\n     * @returns Promise that resolves with a new `MemoryVectorStore` instance.\n     */\n    static fromTexts(texts: string[], metadatas: object[] | object, embeddings: EmbeddingsInterface, dbConfig?: MemoryVectorStoreArgs): Promise<MemoryVectorStore>;\n    /**\n     * Static method to create a `MemoryVectorStore` instance from an array of\n     * `Document` instances. It adds the documents to the store.\n     * @param docs Array of `Document` instances to be added to the store.\n     * @param embeddings `Embeddings` instance used to generate embeddings for the documents.\n     * @param dbConfig Optional `MemoryVectorStoreArgs` to configure the `MemoryVectorStore` instance.\n     * @returns Promise that resolves with a new `MemoryVectorStore` instance.\n     */\n    static fromDocuments(docs: Document[], embeddings: EmbeddingsInterface, dbConfig?: MemoryVectorStoreArgs): Promise<MemoryVectorStore>;\n    /**\n     * Static method to create a `MemoryVectorStore` instance from an existing\n     * index. It creates a new `MemoryVectorStore` instance without adding any\n     * documents or vectors.\n     * @param embeddings `Embeddings` instance used to generate embeddings for the documents.\n     * @param dbConfig Optional `MemoryVectorStoreArgs` to configure the `MemoryVectorStore` instance.\n     * @returns Promise that resolves with a new `MemoryVectorStore` instance.\n     */\n    static fromExistingIndex(embeddings: EmbeddingsInterface, dbConfig?: MemoryVectorStoreArgs): Promise<MemoryVectorStore>;\n}\nexport {};\n"],"mappings":";;;;;;;;;AAG6D;AAkB7D;AAiHA;UA7HUM,YAAAA,CA6H4B;EAAA,OAChBH,EAAAA,MAAAA;EAAQ,SACXG,EAAAA,MAAAA,EAAAA;EAAY;EACF,QAEDJ,EA9HdK,MA8HcL,CAAAA,MAAAA,EAAAA,GAAAA,CAAAA;EAAmB,EAAA,CAAIQ,EAAAA,MAAAA;;;;;;;AAkBmCC,UAxIrEH,qBAAAA,CAwIqEG;EAAO,UAkBUR,CAAAA,EAAAA,OAzJ/EE,MAyJ+EF;;;;;;;;;;;;;;;;;;;AAzC7C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cAArCM,iBAAAA,SAA0BR,WAAAA;oBACzBE;iBACHG;qBACID;;0BAEKH;;;MAA+CM;;;;;;;;0BAQ/CL,aAAaQ;;;;;;;;;6CASMR,aAAaQ;oFAC0BA;;;cAGpEJ;;;;;;;;;;;;;;;4FAe4EI,SAASR;qDAChDH,wDAAwDW,QAAQP;;;;;;;;;;;8EAWvCF,gCAAgCM,wBAAwBG,QAAQF;;;;;;;;;6BASjHN,wBAAwBD,gCAAgCM,wBAAwBG,QAAQF;;;;;;;;;uCAS9EP,gCAAgCM,wBAAwBG,QAAQF"}

package/dist/vectorstores/memory.js

@@ -0,0 +1,259 @@
+import { __export } from "../_virtual/rolldown_runtime.js";
+import { cosine } from "../util/ml-distance/similarities.js";
+import { Document } from "@langchain/core/documents";
+import { VectorStore } from "@langchain/core/vectorstores";
+import { maximalMarginalRelevance } from "@langchain/core/utils/math";
+
+//#region src/vectorstores/memory.ts
+var memory_exports = {};
+__export(memory_exports, { MemoryVectorStore: () => MemoryVectorStore });
+/**
+* In-memory, ephemeral vector store.
+*
+* Setup:
+* Install `langchain`:
+*
+* ```bash
+* npm install langchain
+* ```
+*
+* ## [Constructor args](https://api.js.langchain.com/classes/langchain.vectorstores_memory.MemoryVectorStore.html#constructor)
+*
+* <details open>
+* <summary><strong>Instantiate</strong></summary>
+*
+* ```typescript
+* import { MemoryVectorStore } from 'langchain/vectorstores/memory';
+* // Or other embeddings
+* import { OpenAIEmbeddings } from '@langchain/openai';
+*
+* const embeddings = new OpenAIEmbeddings({
+*   model: "text-embedding-3-small",
+* });
+*
+* const vectorStore = new MemoryVectorStore(embeddings);
+* ```
+* </details>
+*
+* <br />
+*
+* <details>
+* <summary><strong>Add documents</strong></summary>
+*
+* ```typescript
+* import type { Document } from '@langchain/core/documents';
+*
+* const document1 = { pageContent: "foo", metadata: { baz: "bar" } };
+* const document2 = { pageContent: "thud", metadata: { bar: "baz" } };
+* const document3 = { pageContent: "i will be deleted :(", metadata: {} };
+*
+* const documents: Document[] = [document1, document2, document3];
+*
+* await vectorStore.addDocuments(documents);
+* ```
+* </details>
+*
+* <br />
+*
+* <details>
+* <summary><strong>Similarity search</strong></summary>
+*
+* ```typescript
+* const results = await vectorStore.similaritySearch("thud", 1);
+* for (const doc of results) {
+*   console.log(`* ${doc.pageContent} [${JSON.stringify(doc.metadata, null)}]`);
+* }
+* // Output: * thud [{"baz":"bar"}]
+* ```
+* </details>
+*
+* <br />
+*
+*
+* <details>
+* <summary><strong>Similarity search with filter</strong></summary>
+*
+* ```typescript
+* const resultsWithFilter = await vectorStore.similaritySearch("thud", 1, { baz: "bar" });
+*
+* for (const doc of resultsWithFilter) {
+*   console.log(`* ${doc.pageContent} [${JSON.stringify(doc.metadata, null)}]`);
+* }
+* // Output: * foo [{"baz":"bar"}]
+* ```
+* </details>
+*
+* <br />
+*
+*
+* <details>
+* <summary><strong>Similarity search with score</strong></summary>
+*
+* ```typescript
+* const resultsWithScore = await vectorStore.similaritySearchWithScore("qux", 1);
+* for (const [doc, score] of resultsWithScore) {
+*   console.log(`* [SIM=${score.toFixed(6)}] ${doc.pageContent} [${JSON.stringify(doc.metadata, null)}]`);
+* }
+* // Output: * [SIM=0.000000] qux [{"bar":"baz","baz":"bar"}]
+* ```
+* </details>
+*
+* <br />
+*
+* <details>
+* <summary><strong>As a retriever</strong></summary>
+*
+* ```typescript
+* const retriever = vectorStore.asRetriever({
+*   searchType: "mmr", // Leave blank for standard similarity search
+*   k: 1,
+* });
+* const resultAsRetriever = await retriever.invoke("thud");
+* console.log(resultAsRetriever);
+*
+* // Output: [Document({ metadata: { "baz":"bar" }, pageContent: "thud" })]
+* ```
+* </details>
+*
+* <br />
+*/
+var MemoryVectorStore = class MemoryVectorStore extends VectorStore {
+	memoryVectors = [];
+	similarity;
+	_vectorstoreType() {
+		return "memory";
+	}
+	constructor(embeddings, { similarity,...rest } = {}) {
+		super(embeddings, rest);
+		this.similarity = similarity ?? cosine;
+	}
+	/**
+	* Method to add documents to the memory vector store. It extracts the
+	* text from each document, generates embeddings for them, and adds the
+	* resulting vectors to the store.
+	* @param documents Array of `Document` instances to be added to the store.
+	* @returns Promise that resolves when all documents have been added.
+	*/
+	async addDocuments(documents) {
+		const texts = documents.map(({ pageContent }) => pageContent);
+		return this.addVectors(await this.embeddings.embedDocuments(texts), documents);
+	}
+	/**
+	* Method to add vectors to the memory vector store. It creates
+	* `MemoryVector` instances for each vector and document pair and adds
+	* them to the store.
+	* @param vectors Array of vectors to be added to the store.
+	* @param documents Array of `Document` instances corresponding to the vectors.
+	* @returns Promise that resolves when all vectors have been added.
+	*/
+	async addVectors(vectors, documents) {
+		const memoryVectors = vectors.map((embedding, idx) => ({
+			content: documents[idx].pageContent,
+			embedding,
+			metadata: documents[idx].metadata,
+			id: documents[idx].id
+		}));
+		this.memoryVectors = this.memoryVectors.concat(memoryVectors);
+	}
+	async _queryVectors(query, k, filter) {
+		const filterFunction = (memoryVector) => {
+			if (!filter) return true;
+			const doc = new Document({
+				metadata: memoryVector.metadata,
+				pageContent: memoryVector.content,
+				id: memoryVector.id
+			});
+			return filter(doc);
+		};
+		const filteredMemoryVectors = this.memoryVectors.filter(filterFunction);
+		return filteredMemoryVectors.map((vector, index) => ({
+			similarity: this.similarity(query, vector.embedding),
+			index,
+			metadata: vector.metadata,
+			content: vector.content,
+			embedding: vector.embedding,
+			id: vector.id
+		})).sort((a, b) => a.similarity > b.similarity ? -1 : 0).slice(0, k);
+	}
+	/**
+	* Method to perform a similarity search in the memory vector store. It
+	* calculates the similarity between the query vector and each vector in
+	* the store, sorts the results by similarity, and returns the top `k`
+	* results along with their scores.
+	* @param query Query vector to compare against the vectors in the store.
+	* @param k Number of top results to return.
+	* @param filter Optional filter function to apply to the vectors before performing the search.
+	* @returns Promise that resolves with an array of tuples, each containing a `Document` and its similarity score.
+	*/
+	async similaritySearchVectorWithScore(query, k, filter) {
+		const searches = await this._queryVectors(query, k, filter);
+		const result = searches.map((search) => [new Document({
+			metadata: search.metadata,
+			pageContent: search.content,
+			id: search.id
+		}), search.similarity]);
+		return result;
+	}
+	async maxMarginalRelevanceSearch(query, options) {
+		const queryEmbedding = await this.embeddings.embedQuery(query);
+		const searches = await this._queryVectors(queryEmbedding, options.fetchK ?? 20, options.filter);
+		const embeddingList = searches.map((searchResp) => searchResp.embedding);
+		const mmrIndexes = maximalMarginalRelevance(queryEmbedding, embeddingList, options.lambda, options.k);
+		return mmrIndexes.map((idx) => new Document({
+			metadata: searches[idx].metadata,
+			pageContent: searches[idx].content,
+			id: searches[idx].id
+		}));
+	}
+	/**
+	* Static method to create a `MemoryVectorStore` instance from an array of
+	* texts. It creates a `Document` for each text and metadata pair, and
+	* adds them to the store.
+	* @param texts Array of texts to be added to the store.
+	* @param metadatas Array or single object of metadata corresponding to the texts.
+	* @param embeddings `Embeddings` instance used to generate embeddings for the texts.
+	* @param dbConfig Optional `MemoryVectorStoreArgs` to configure the `MemoryVectorStore` instance.
+	* @returns Promise that resolves with a new `MemoryVectorStore` instance.
+	*/
+	static async fromTexts(texts, metadatas, embeddings, dbConfig) {
+		const docs = [];
+		for (let i = 0; i < texts.length; i += 1) {
+			const metadata = Array.isArray(metadatas) ? metadatas[i] : metadatas;
+			const newDoc = new Document({
+				pageContent: texts[i],
+				metadata
+			});
+			docs.push(newDoc);
+		}
+		return MemoryVectorStore.fromDocuments(docs, embeddings, dbConfig);
+	}
+	/**
+	* Static method to create a `MemoryVectorStore` instance from an array of
+	* `Document` instances. It adds the documents to the store.
+	* @param docs Array of `Document` instances to be added to the store.
+	* @param embeddings `Embeddings` instance used to generate embeddings for the documents.
+	* @param dbConfig Optional `MemoryVectorStoreArgs` to configure the `MemoryVectorStore` instance.
+	* @returns Promise that resolves with a new `MemoryVectorStore` instance.
+	*/
+	static async fromDocuments(docs, embeddings, dbConfig) {
+		const instance = new this(embeddings, dbConfig);
+		await instance.addDocuments(docs);
+		return instance;
+	}
+	/**
+	* Static method to create a `MemoryVectorStore` instance from an existing
+	* index. It creates a new `MemoryVectorStore` instance without adding any
+	* documents or vectors.
+	* @param embeddings `Embeddings` instance used to generate embeddings for the documents.
+	* @param dbConfig Optional `MemoryVectorStoreArgs` to configure the `MemoryVectorStore` instance.
+	* @returns Promise that resolves with a new `MemoryVectorStore` instance.
+	*/
+	static async fromExistingIndex(embeddings, dbConfig) {
+		const instance = new this(embeddings, dbConfig);
+		return instance;
+	}
+};
+
+//#endregion
+export { MemoryVectorStore, memory_exports };
+//# sourceMappingURL=memory.js.map

package/dist/vectorstores/memory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"memory.js","names":["embeddings: EmbeddingsInterface","documents: Document[]","vectors: number[][]","query: number[]","k: number","filter?: this[\"FilterType\"]","memoryVector: MemoryVector","result: [Document, number][]","query: string","options: MaxMarginalRelevanceSearchOptions<this[\"FilterType\"]>","texts: string[]","metadatas: object[] | object","dbConfig?: MemoryVectorStoreArgs","docs: Document[]"],"sources":["../../src/vectorstores/memory.ts"],"sourcesContent":["import {\n  MaxMarginalRelevanceSearchOptions,\n  VectorStore,\n} from \"@langchain/core/vectorstores\";\nimport type { EmbeddingsInterface } from \"@langchain/core/embeddings\";\nimport { Document, DocumentInterface } from \"@langchain/core/documents\";\nimport { maximalMarginalRelevance } from \"@langchain/core/utils/math\";\nimport { cosine } from \"../util/ml-distance/similarities.js\";\n\n/**\n * Interface representing a vector in memory. It includes the content\n * (text), the corresponding embedding (vector), and any associated\n * metadata.\n */\ninterface MemoryVector {\n  content: string;\n  embedding: number[];\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  metadata: Record<string, any>;\n  id?: string;\n}\n\n/**\n * Interface for the arguments that can be passed to the\n * `MemoryVectorStore` constructor. It includes an optional `similarity`\n * function.\n */\nexport interface MemoryVectorStoreArgs {\n  similarity?: typeof cosine;\n}\n\n/**\n * In-memory, ephemeral vector store.\n *\n * Setup:\n * Install `langchain`:\n *\n * ```bash\n * npm install langchain\n * ```\n *\n * ## [Constructor args](https://api.js.langchain.com/classes/langchain.vectorstores_memory.MemoryVectorStore.html#constructor)\n *\n * <details open>\n * <summary><strong>Instantiate</strong></summary>\n *\n * ```typescript\n * import { MemoryVectorStore } from 'langchain/vectorstores/memory';\n * // Or other embeddings\n * import { OpenAIEmbeddings } from '@langchain/openai';\n *\n * const embeddings = new OpenAIEmbeddings({\n *   model: \"text-embedding-3-small\",\n * });\n *\n * const vectorStore = new MemoryVectorStore(embeddings);\n * ```\n * </details>\n *\n * <br />\n *\n * <details>\n * <summary><strong>Add documents</strong></summary>\n *\n * ```typescript\n * import type { Document } from '@langchain/core/documents';\n *\n * const document1 = { pageContent: \"foo\", metadata: { baz: \"bar\" } };\n * const document2 = { pageContent: \"thud\", metadata: { bar: \"baz\" } };\n * const document3 = { pageContent: \"i will be deleted :(\", metadata: {} };\n *\n * const documents: Document[] = [document1, document2, document3];\n *\n * await vectorStore.addDocuments(documents);\n * ```\n * </details>\n *\n * <br />\n *\n * <details>\n * <summary><strong>Similarity search</strong></summary>\n *\n * ```typescript\n * const results = await vectorStore.similaritySearch(\"thud\", 1);\n * for (const doc of results) {\n *   console.log(`* ${doc.pageContent} [${JSON.stringify(doc.metadata, null)}]`);\n * }\n * // Output: * thud [{\"baz\":\"bar\"}]\n * ```\n * </details>\n *\n * <br />\n *\n *\n * <details>\n * <summary><strong>Similarity search with filter</strong></summary>\n *\n * ```typescript\n * const resultsWithFilter = await vectorStore.similaritySearch(\"thud\", 1, { baz: \"bar\" });\n *\n * for (const doc of resultsWithFilter) {\n *   console.log(`* ${doc.pageContent} [${JSON.stringify(doc.metadata, null)}]`);\n * }\n * // Output: * foo [{\"baz\":\"bar\"}]\n * ```\n * </details>\n *\n * <br />\n *\n *\n * <details>\n * <summary><strong>Similarity search with score</strong></summary>\n *\n * ```typescript\n * const resultsWithScore = await vectorStore.similaritySearchWithScore(\"qux\", 1);\n * for (const [doc, score] of resultsWithScore) {\n *   console.log(`* [SIM=${score.toFixed(6)}] ${doc.pageContent} [${JSON.stringify(doc.metadata, null)}]`);\n * }\n * // Output: * [SIM=0.000000] qux [{\"bar\":\"baz\",\"baz\":\"bar\"}]\n * ```\n * </details>\n *\n * <br />\n *\n * <details>\n * <summary><strong>As a retriever</strong></summary>\n *\n * ```typescript\n * const retriever = vectorStore.asRetriever({\n *   searchType: \"mmr\", // Leave blank for standard similarity search\n *   k: 1,\n * });\n * const resultAsRetriever = await retriever.invoke(\"thud\");\n * console.log(resultAsRetriever);\n *\n * // Output: [Document({ metadata: { \"baz\":\"bar\" }, pageContent: \"thud\" })]\n * ```\n * </details>\n *\n * <br />\n */\nexport class MemoryVectorStore extends VectorStore {\n  declare FilterType: (doc: Document) => boolean;\n\n  memoryVectors: MemoryVector[] = [];\n\n  similarity: typeof cosine;\n\n  _vectorstoreType(): string {\n    return \"memory\";\n  }\n\n  constructor(\n    embeddings: EmbeddingsInterface,\n    { similarity, ...rest }: MemoryVectorStoreArgs = {}\n  ) {\n    super(embeddings, rest);\n\n    this.similarity = similarity ?? cosine;\n  }\n\n  /**\n   * Method to add documents to the memory vector store. It extracts the\n   * text from each document, generates embeddings for them, and adds the\n   * resulting vectors to the store.\n   * @param documents Array of `Document` instances to be added to the store.\n   * @returns Promise that resolves when all documents have been added.\n   */\n  async addDocuments(documents: Document[]): Promise<void> {\n    const texts = documents.map(({ pageContent }) => pageContent);\n    return this.addVectors(\n      await this.embeddings.embedDocuments(texts),\n      documents\n    );\n  }\n\n  /**\n   * Method to add vectors to the memory vector store. It creates\n   * `MemoryVector` instances for each vector and document pair and adds\n   * them to the store.\n   * @param vectors Array of vectors to be added to the store.\n   * @param documents Array of `Document` instances corresponding to the vectors.\n   * @returns Promise that resolves when all vectors have been added.\n   */\n  async addVectors(vectors: number[][], documents: Document[]): Promise<void> {\n    const memoryVectors = vectors.map((embedding, idx) => ({\n      content: documents[idx].pageContent,\n      embedding,\n      metadata: documents[idx].metadata,\n      id: documents[idx].id,\n    }));\n\n    this.memoryVectors = this.memoryVectors.concat(memoryVectors);\n  }\n\n  protected async _queryVectors(\n    query: number[],\n    k: number,\n    filter?: this[\"FilterType\"]\n  ) {\n    const filterFunction = (memoryVector: MemoryVector) => {\n      if (!filter) {\n        return true;\n      }\n\n      const doc = new Document({\n        metadata: memoryVector.metadata,\n        pageContent: memoryVector.content,\n        id: memoryVector.id,\n      });\n      return filter(doc);\n    };\n    const filteredMemoryVectors = this.memoryVectors.filter(filterFunction);\n    return filteredMemoryVectors\n      .map((vector, index) => ({\n        similarity: this.similarity(query, vector.embedding),\n        index,\n        metadata: vector.metadata,\n        content: vector.content,\n        embedding: vector.embedding,\n        id: vector.id,\n      }))\n      .sort((a, b) => (a.similarity > b.similarity ? -1 : 0))\n      .slice(0, k);\n  }\n\n  /**\n   * Method to perform a similarity search in the memory vector store. It\n   * calculates the similarity between the query vector and each vector in\n   * the store, sorts the results by similarity, and returns the top `k`\n   * results along with their scores.\n   * @param query Query vector to compare against the vectors in the store.\n   * @param k Number of top results to return.\n   * @param filter Optional filter function to apply to the vectors before performing the search.\n   * @returns Promise that resolves with an array of tuples, each containing a `Document` and its similarity score.\n   */\n  async similaritySearchVectorWithScore(\n    query: number[],\n    k: number,\n    filter?: this[\"FilterType\"]\n  ): Promise<[Document, number][]> {\n    const searches = await this._queryVectors(query, k, filter);\n    const result: [Document, number][] = searches.map((search) => [\n      new Document({\n        metadata: search.metadata,\n        pageContent: search.content,\n        id: search.id,\n      }),\n      search.similarity,\n    ]);\n\n    return result;\n  }\n\n  async maxMarginalRelevanceSearch(\n    query: string,\n    options: MaxMarginalRelevanceSearchOptions<this[\"FilterType\"]>\n  ): Promise<DocumentInterface[]> {\n    const queryEmbedding = await this.embeddings.embedQuery(query);\n\n    const searches = await this._queryVectors(\n      queryEmbedding,\n      options.fetchK ?? 20,\n      options.filter\n    );\n\n    const embeddingList = searches.map((searchResp) => searchResp.embedding);\n\n    const mmrIndexes = maximalMarginalRelevance(\n      queryEmbedding,\n      embeddingList,\n      options.lambda,\n      options.k\n    );\n\n    return mmrIndexes.map(\n      (idx) =>\n        new Document({\n          metadata: searches[idx].metadata,\n          pageContent: searches[idx].content,\n          id: searches[idx].id,\n        })\n    );\n  }\n\n  /**\n   * Static method to create a `MemoryVectorStore` instance from an array of\n   * texts. It creates a `Document` for each text and metadata pair, and\n   * adds them to the store.\n   * @param texts Array of texts to be added to the store.\n   * @param metadatas Array or single object of metadata corresponding to the texts.\n   * @param embeddings `Embeddings` instance used to generate embeddings for the texts.\n   * @param dbConfig Optional `MemoryVectorStoreArgs` to configure the `MemoryVectorStore` instance.\n   * @returns Promise that resolves with a new `MemoryVectorStore` instance.\n   */\n  static async fromTexts(\n    texts: string[],\n    metadatas: object[] | object,\n    embeddings: EmbeddingsInterface,\n    dbConfig?: MemoryVectorStoreArgs\n  ): Promise<MemoryVectorStore> {\n    const docs: Document[] = [];\n    for (let i = 0; i < texts.length; i += 1) {\n      const metadata = Array.isArray(metadatas) ? metadatas[i] : metadatas;\n      const newDoc = new Document({\n        pageContent: texts[i],\n        metadata,\n      });\n      docs.push(newDoc);\n    }\n    return MemoryVectorStore.fromDocuments(docs, embeddings, dbConfig);\n  }\n\n  /**\n   * Static method to create a `MemoryVectorStore` instance from an array of\n   * `Document` instances. It adds the documents to the store.\n   * @param docs Array of `Document` instances to be added to the store.\n   * @param embeddings `Embeddings` instance used to generate embeddings for the documents.\n   * @param dbConfig Optional `MemoryVectorStoreArgs` to configure the `MemoryVectorStore` instance.\n   * @returns Promise that resolves with a new `MemoryVectorStore` instance.\n   */\n  static async fromDocuments(\n    docs: Document[],\n    embeddings: EmbeddingsInterface,\n    dbConfig?: MemoryVectorStoreArgs\n  ): Promise<MemoryVectorStore> {\n    const instance = new this(embeddings, dbConfig);\n    await instance.addDocuments(docs);\n    return instance;\n  }\n\n  /**\n   * Static method to create a `MemoryVectorStore` instance from an existing\n   * index. It creates a new `MemoryVectorStore` instance without adding any\n   * documents or vectors.\n   * @param embeddings `Embeddings` instance used to generate embeddings for the documents.\n   * @param dbConfig Optional `MemoryVectorStoreArgs` to configure the `MemoryVectorStore` instance.\n   * @returns Promise that resolves with a new `MemoryVectorStore` instance.\n   */\n  static async fromExistingIndex(\n    embeddings: EmbeddingsInterface,\n    dbConfig?: MemoryVectorStoreArgs\n  ): Promise<MemoryVectorStore> {\n    const instance = new this(embeddings, dbConfig);\n    return instance;\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6IA,IAAa,oBAAb,MAAa,0BAA0B,YAAY;CAGjD,gBAAgC,CAAE;CAElC;CAEA,mBAA2B;AACzB,SAAO;CACR;CAED,YACEA,YACA,EAAE,WAAY,GAAG,MAA6B,GAAG,CAAE,GACnD;EACA,MAAM,YAAY,KAAK;EAEvB,KAAK,aAAa,cAAc;CACjC;;;;;;;;CASD,MAAM,aAAaC,WAAsC;EACvD,MAAM,QAAQ,UAAU,IAAI,CAAC,EAAE,aAAa,KAAK,YAAY;AAC7D,SAAO,KAAK,WACV,MAAM,KAAK,WAAW,eAAe,MAAM,EAC3C,UACD;CACF;;;;;;;;;CAUD,MAAM,WAAWC,SAAqBD,WAAsC;EAC1E,MAAM,gBAAgB,QAAQ,IAAI,CAAC,WAAW,SAAS;GACrD,SAAS,UAAU,KAAK;GACxB;GACA,UAAU,UAAU,KAAK;GACzB,IAAI,UAAU,KAAK;EACpB,GAAE;EAEH,KAAK,gBAAgB,KAAK,cAAc,OAAO,cAAc;CAC9D;CAED,MAAgB,cACdE,OACAC,GACAC,QACA;EACA,MAAM,iBAAiB,CAACC,iBAA+B;AACrD,OAAI,CAAC,OACH,QAAO;GAGT,MAAM,MAAM,IAAI,SAAS;IACvB,UAAU,aAAa;IACvB,aAAa,aAAa;IAC1B,IAAI,aAAa;GAClB;AACD,UAAO,OAAO,IAAI;EACnB;EACD,MAAM,wBAAwB,KAAK,cAAc,OAAO,eAAe;AACvE,SAAO,sBACJ,IAAI,CAAC,QAAQ,WAAW;GACvB,YAAY,KAAK,WAAW,OAAO,OAAO,UAAU;GACpD;GACA,UAAU,OAAO;GACjB,SAAS,OAAO;GAChB,WAAW,OAAO;GAClB,IAAI,OAAO;EACZ,GAAE,CACF,KAAK,CAAC,GAAG,MAAO,EAAE,aAAa,EAAE,aAAa,KAAK,EAAG,CACtD,MAAM,GAAG,EAAE;CACf;;;;;;;;;;;CAYD,MAAM,gCACJH,OACAC,GACAC,QAC+B;EAC/B,MAAM,WAAW,MAAM,KAAK,cAAc,OAAO,GAAG,OAAO;EAC3D,MAAME,SAA+B,SAAS,IAAI,CAAC,WAAW,CAC5D,IAAI,SAAS;GACX,UAAU,OAAO;GACjB,aAAa,OAAO;GACpB,IAAI,OAAO;EACZ,IACD,OAAO,UACR,EAAC;AAEF,SAAO;CACR;CAED,MAAM,2BACJC,OACAC,SAC8B;EAC9B,MAAM,iBAAiB,MAAM,KAAK,WAAW,WAAW,MAAM;EAE9D,MAAM,WAAW,MAAM,KAAK,cAC1B,gBACA,QAAQ,UAAU,IAClB,QAAQ,OACT;EAED,MAAM,gBAAgB,SAAS,IAAI,CAAC,eAAe,WAAW,UAAU;EAExE,MAAM,aAAa,yBACjB,gBACA,eACA,QAAQ,QACR,QAAQ,EACT;AAED,SAAO,WAAW,IAChB,CAAC,QACC,IAAI,SAAS;GACX,UAAU,SAAS,KAAK;GACxB,aAAa,SAAS,KAAK;GAC3B,IAAI,SAAS,KAAK;EACnB,GACJ;CACF;;;;;;;;;;;CAYD,aAAa,UACXC,OACAC,WACAX,YACAY,UAC4B;EAC5B,MAAMC,OAAmB,CAAE;AAC3B,OAAK,IAAI,IAAI,GAAG,IAAI,MAAM,QAAQ,KAAK,GAAG;GACxC,MAAM,WAAW,MAAM,QAAQ,UAAU,GAAG,UAAU,KAAK;GAC3D,MAAM,SAAS,IAAI,SAAS;IAC1B,aAAa,MAAM;IACnB;GACD;GACD,KAAK,KAAK,OAAO;EAClB;AACD,SAAO,kBAAkB,cAAc,MAAM,YAAY,SAAS;CACnE;;;;;;;;;CAUD,aAAa,cACXA,MACAb,YACAY,UAC4B;EAC5B,MAAM,WAAW,IAAI,KAAK,YAAY;EACtC,MAAM,SAAS,aAAa,KAAK;AACjC,SAAO;CACR;;;;;;;;;CAUD,aAAa,kBACXZ,YACAY,UAC4B;EAC5B,MAAM,WAAW,IAAI,KAAK,YAAY;AACtC,SAAO;CACR;AACF"}