langchain 0.0.173 → 0.0.174

package/dist/callbacks/manager.cjs

@@ -504,7 +504,8 @@ class CallbackManager extends BaseCallbackManager {
                 ? localHandlers.map(ensureHandler)
                 : localHandlers?.handlers, false);
         }
-        const verboseEnabled = (0, env_js_1.getEnvironmentVariable)("LANGCHAIN_VERBOSE") || options?.verbose;
+        const verboseEnabled = (0, env_js_1.getEnvironmentVariable)("LANGCHAIN_VERBOSE") === "true" ||
+            options?.verbose;
         const tracingV2Enabled = (0, env_js_1.getEnvironmentVariable)("LANGCHAIN_TRACING_V2") === "true";
         const tracingEnabled = tracingV2Enabled ||
             ((0, env_js_1.getEnvironmentVariable)("LANGCHAIN_TRACING") ?? false);

package/dist/callbacks/manager.js

@@ -495,7 +495,8 @@ export class CallbackManager extends BaseCallbackManager {
                 ? localHandlers.map(ensureHandler)
                 : localHandlers?.handlers, false);
         }
-        const verboseEnabled = getEnvironmentVariable("LANGCHAIN_VERBOSE") || options?.verbose;
+        const verboseEnabled = getEnvironmentVariable("LANGCHAIN_VERBOSE") === "true" ||
+            options?.verbose;
         const tracingV2Enabled = getEnvironmentVariable("LANGCHAIN_TRACING_V2") === "true";
         const tracingEnabled = tracingV2Enabled ||
             (getEnvironmentVariable("LANGCHAIN_TRACING") ?? false);

package/dist/memory/index.cjs

@@ -1,11 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ConversationSummaryBufferMemory = exports.CombinedMemory = exports.ENTITY_MEMORY_CONVERSATION_TEMPLATE = exports.EntityMemory = exports.VectorStoreRetrieverMemory = exports.MotorheadMemory = exports.ChatMessageHistory = exports.BaseChatMemory = exports.BufferWindowMemory = exports.BaseConversationSummaryMemory = exports.ConversationSummaryMemory = exports.getBufferString = exports.getInputValue = exports.BaseMemory = exports.BufferMemory = void 0;
+exports.ConversationSummaryBufferMemory = exports.CombinedMemory = exports.ENTITY_MEMORY_CONVERSATION_TEMPLATE = exports.EntityMemory = exports.VectorStoreRetrieverMemory = exports.MotorheadMemory = exports.ChatMessageHistory = exports.BaseChatMemory = exports.BufferWindowMemory = exports.BaseConversationSummaryMemory = exports.ConversationSummaryMemory = exports.getBufferString = exports.getOutputValue = exports.getInputValue = exports.BaseMemory = exports.BufferMemory = void 0;
 var buffer_memory_js_1 = require("./buffer_memory.cjs");
 Object.defineProperty(exports, "BufferMemory", { enumerable: true, get: function () { return buffer_memory_js_1.BufferMemory; } });
 var base_js_1 = require("./base.cjs");
 Object.defineProperty(exports, "BaseMemory", { enumerable: true, get: function () { return base_js_1.BaseMemory; } });
 Object.defineProperty(exports, "getInputValue", { enumerable: true, get: function () { return base_js_1.getInputValue; } });
+Object.defineProperty(exports, "getOutputValue", { enumerable: true, get: function () { return base_js_1.getOutputValue; } });
 Object.defineProperty(exports, "getBufferString", { enumerable: true, get: function () { return base_js_1.getBufferString; } });
 var summary_js_1 = require("./summary.cjs");
 Object.defineProperty(exports, "ConversationSummaryMemory", { enumerable: true, get: function () { return summary_js_1.ConversationSummaryMemory; } });

package/dist/memory/index.d.ts

@@ -1,5 +1,5 @@
 export { BufferMemory, type BufferMemoryInput } from "./buffer_memory.js";
-export { BaseMemory, getInputValue, getBufferString, type InputValues, type OutputValues, type MemoryVariables, } from "./base.js";
+export { BaseMemory, getInputValue, getOutputValue, getBufferString, type InputValues, type OutputValues, type MemoryVariables, } from "./base.js";
 export { ConversationSummaryMemory, type ConversationSummaryMemoryInput, BaseConversationSummaryMemory, type BaseConversationSummaryMemoryInput, } from "./summary.js";
 export { BufferWindowMemory, type BufferWindowMemoryInput, } from "./buffer_window_memory.js";
 export { BaseChatMemory, type BaseChatMemoryInput } from "./chat_memory.js";

package/dist/memory/index.js

@@ -1,5 +1,5 @@
 export { BufferMemory } from "./buffer_memory.js";
-export { BaseMemory, getInputValue, getBufferString, } from "./base.js";
+export { BaseMemory, getInputValue, getOutputValue, getBufferString, } from "./base.js";
 export { ConversationSummaryMemory, BaseConversationSummaryMemory, } from "./summary.js";
 export { BufferWindowMemory, } from "./buffer_window_memory.js";
 export { BaseChatMemory } from "./chat_memory.js";

package/dist/prompts/selectors/SemanticSimilarityExampleSelector.cjs

@@ -15,18 +15,12 @@ function sortedValues(values) {
 class SemanticSimilarityExampleSelector extends base_js_1.BaseExampleSelector {
     constructor(data) {
         super(data);
-        Object.defineProperty(this, "vectorStore", {
+        Object.defineProperty(this, "vectorStoreRetriever", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
-        Object.defineProperty(this, "k", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: 4
-        });
         Object.defineProperty(this, "exampleKeys", {
             enumerable: true,
             configurable: true,
@@ -39,17 +33,20 @@ class SemanticSimilarityExampleSelector extends base_js_1.BaseExampleSelector {
             writable: true,
             value: void 0
         });
-        Object.defineProperty(this, "filter", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        this.vectorStore = data.vectorStore;
-        this.k = data.k ?? 4;
         this.exampleKeys = data.exampleKeys;
         this.inputKeys = data.inputKeys;
-        this.filter = data.filter;
+        if (data.vectorStore !== undefined) {
+            this.vectorStoreRetriever = data.vectorStore.asRetriever({
+                k: data.k ?? 4,
+                filter: data.filter,
+            });
+        }
+        else if (data.vectorStoreRetriever) {
+            this.vectorStoreRetriever = data.vectorStoreRetriever;
+        }
+        else {
+            throw new Error(`You must specify one of "vectorStore" and "vectorStoreRetriever".`);
+        }
     }
     /**
      * Method that adds a new example to the vectorStore. The example is
@@ -60,7 +57,7 @@ class SemanticSimilarityExampleSelector extends base_js_1.BaseExampleSelector {
     async addExample(example) {
         const inputKeys = this.inputKeys ?? Object.keys(example);
         const stringExample = sortedValues(inputKeys.reduce((acc, key) => ({ ...acc, [key]: example[key] }), {})).join(" ");
-        await this.vectorStore.addDocuments([
+        await this.vectorStoreRetriever.addDocuments([
             new document_js_1.Document({
                 pageContent: stringExample,
                 metadata: example,
@@ -77,7 +74,7 @@ class SemanticSimilarityExampleSelector extends base_js_1.BaseExampleSelector {
     async selectExamples(inputVariables) {
         const inputKeys = this.inputKeys ?? Object.keys(inputVariables);
         const query = sortedValues(inputKeys.reduce((acc, key) => ({ ...acc, [key]: inputVariables[key] }), {})).join(" ");
-        const exampleDocs = await this.vectorStore.similaritySearch(query, this.k, this.filter);
+        const exampleDocs = await this.vectorStoreRetriever.invoke(query);
         const examples = exampleDocs.map((doc) => doc.metadata);
         if (this.exampleKeys) {
             // If example keys are provided, filter examples to those keys.

package/dist/prompts/selectors/SemanticSimilarityExampleSelector.d.ts

@@ -1,28 +1,34 @@
 import { Embeddings } from "../../embeddings/base.js";
-import { VectorStore } from "../../vectorstores/base.js";
+import { VectorStore, VectorStoreRetriever } from "../../vectorstores/base.js";
 import { Example } from "../../schema/index.js";
 import { BaseExampleSelector } from "../base.js";
 /**
  * Interface for the input data of the SemanticSimilarityExampleSelector
  * class.
  */
-export interface SemanticSimilarityExampleSelectorInput<V extends VectorStore = VectorStore> {
+export type SemanticSimilarityExampleSelectorInput<V extends VectorStore = VectorStore> = {
     vectorStore: V;
     k?: number;
     filter?: V["FilterType"];
     exampleKeys?: string[];
     inputKeys?: string[];
-}
+    vectorStoreRetriever?: never;
+} | {
+    vectorStoreRetriever: VectorStoreRetriever<V>;
+    exampleKeys?: string[];
+    inputKeys?: string[];
+    vectorStore?: never;
+    k?: never;
+    filter?: never;
+};
 /**
  * Class that selects examples based on semantic similarity. It extends
  * the BaseExampleSelector class.
  */
 export declare class SemanticSimilarityExampleSelector<V extends VectorStore = VectorStore> extends BaseExampleSelector {
-    vectorStore: V;
-    k: number;
+    vectorStoreRetriever: VectorStoreRetriever<V>;
     exampleKeys?: string[];
     inputKeys?: string[];
-    filter?: V["FilterType"];
     constructor(data: SemanticSimilarityExampleSelectorInput<V>);
     /**
      * Method that adds a new example to the vectorStore. The example is

package/dist/prompts/selectors/SemanticSimilarityExampleSelector.js

@@ -12,18 +12,12 @@ function sortedValues(values) {
 export class SemanticSimilarityExampleSelector extends BaseExampleSelector {
     constructor(data) {
         super(data);
-        Object.defineProperty(this, "vectorStore", {
+        Object.defineProperty(this, "vectorStoreRetriever", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
-        Object.defineProperty(this, "k", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: 4
-        });
         Object.defineProperty(this, "exampleKeys", {
             enumerable: true,
             configurable: true,
@@ -36,17 +30,20 @@ export class SemanticSimilarityExampleSelector extends BaseExampleSelector {
             writable: true,
             value: void 0
         });
-        Object.defineProperty(this, "filter", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        this.vectorStore = data.vectorStore;
-        this.k = data.k ?? 4;
         this.exampleKeys = data.exampleKeys;
         this.inputKeys = data.inputKeys;
-        this.filter = data.filter;
+        if (data.vectorStore !== undefined) {
+            this.vectorStoreRetriever = data.vectorStore.asRetriever({
+                k: data.k ?? 4,
+                filter: data.filter,
+            });
+        }
+        else if (data.vectorStoreRetriever) {
+            this.vectorStoreRetriever = data.vectorStoreRetriever;
+        }
+        else {
+            throw new Error(`You must specify one of "vectorStore" and "vectorStoreRetriever".`);
+        }
     }
     /**
      * Method that adds a new example to the vectorStore. The example is
@@ -57,7 +54,7 @@ export class SemanticSimilarityExampleSelector extends BaseExampleSelector {
     async addExample(example) {
         const inputKeys = this.inputKeys ?? Object.keys(example);
         const stringExample = sortedValues(inputKeys.reduce((acc, key) => ({ ...acc, [key]: example[key] }), {})).join(" ");
-        await this.vectorStore.addDocuments([
+        await this.vectorStoreRetriever.addDocuments([
             new Document({
                 pageContent: stringExample,
                 metadata: example,
@@ -74,7 +71,7 @@ export class SemanticSimilarityExampleSelector extends BaseExampleSelector {
     async selectExamples(inputVariables) {
         const inputKeys = this.inputKeys ?? Object.keys(inputVariables);
         const query = sortedValues(inputKeys.reduce((acc, key) => ({ ...acc, [key]: inputVariables[key] }), {})).join(" ");
-        const exampleDocs = await this.vectorStore.similaritySearch(query, this.k, this.filter);
+        const exampleDocs = await this.vectorStoreRetriever.invoke(query);
         const examples = exampleDocs.map((doc) => doc.metadata);
         if (this.exampleKeys) {
             // If example keys are provided, filter examples to those keys.

package/dist/vectorstores/pinecone.cjs

@@ -33,6 +33,7 @@ const flat_1 = __importDefault(require("flat"));
 const base_js_1 = require("./base.cjs");
 const document_js_1 = require("../document.cjs");
 const async_caller_js_1 = require("../util/async_caller.cjs");
+const math_js_1 = require("../util/math.cjs");
 /**
  * Class that extends the VectorStore class and provides methods to
  * interact with the Pinecone vector database.
@@ -166,15 +167,7 @@ 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) {
+    async _runPineconeQuery(query, k, filter, options) {
         if (filter && this.filter) {
             throw new Error("cannot provide both `filter` and `this.filter`");
         }
@@ -185,7 +178,20 @@ class PineconeStore extends base_js_1.VectorStore {
             topK: k,
             vector: query,
             filter: _filter,
+            ...options,
         });
+        return results;
+    }
+    /**
+     * 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) {
+        const results = await this._runPineconeQuery(query, k, filter);
         const result = [];
         if (results.matches) {
             for (const res of results.matches) {
@@ -198,6 +204,37 @@ class PineconeStore extends base_js_1.VectorStore {
         }
         return result;
     }
+    /**
+     * Return documents selected using the maximal marginal relevance.
+     * Maximal marginal relevance optimizes for similarity to the query AND diversity
+     * among selected documents.
+     *
+     * @param {string} query - Text to look up documents similar to.
+     * @param {number} options.k - Number of documents to return.
+     * @param {number} options.fetchK=20 - Number of documents to fetch before passing to the MMR algorithm.
+     * @param {number} options.lambda=0.5 - Number between 0 and 1 that determines the degree of diversity among the results,
+     *                 where 0 corresponds to maximum diversity and 1 to minimum diversity.
+     * @param {PineconeMetadata} options.filter - Optional filter to apply to the search.
+     *
+     * @returns {Promise<Document[]>} - List of documents selected by maximal marginal relevance.
+     */
+    async maxMarginalRelevanceSearch(query, options) {
+        const queryEmbedding = await this.embeddings.embedQuery(query);
+        const results = await this._runPineconeQuery(queryEmbedding, options.fetchK ?? 20, options.filter, { includeValues: true });
+        const matches = results?.matches ?? [];
+        const embeddingList = matches.map((match) => match.values);
+        const mmrIndexes = (0, math_js_1.maximalMarginalRelevance)(queryEmbedding, embeddingList, options.lambda, options.k);
+        const topMmrMatches = mmrIndexes.map((idx) => matches[idx]);
+        const finalResult = [];
+        for (const res of topMmrMatches) {
+            const { [this.textKey]: pageContent, ...metadata } = (res.metadata ??
+                {});
+            if (res.score) {
+                finalResult.push(new document_js_1.Document({ metadata, pageContent }));
+            }
+        }
+        return finalResult;
+    }
     /**
      * Static method that creates a new instance of the PineconeStore class
      * from texts.

package/dist/vectorstores/pinecone.d.ts

@@ -1,5 +1,5 @@
-import { Index as PineconeIndex } from "@pinecone-database/pinecone";
-import { VectorStore } from "./base.js";
+import { RecordMetadata, Index as PineconeIndex } from "@pinecone-database/pinecone";
+import { MaxMarginalRelevanceSearchOptions, VectorStore } from "./base.js";
 import { Embeddings } from "../embeddings/base.js";
 import { Document } from "../document.js";
 import { AsyncCaller } from "../util/async_caller.js";
@@ -57,6 +57,9 @@ export declare class PineconeStore extends VectorStore {
      * @returns Promise that resolves when the delete operation is complete.
      */
     delete(params: PineconeDeleteParams): Promise<void>;
+    protected _runPineconeQuery(query: number[], k: number, filter?: PineconeMetadata, options?: {
+        includeValues: boolean;
+    }): Promise<import("@pinecone-database/pinecone").QueryResponse<RecordMetadata>>;
     /**
      * Method that performs a similarity search in the Pinecone database and
      * returns the results along with their scores.
@@ -66,6 +69,21 @@ export declare class PineconeStore extends VectorStore {
      * @returns Promise that resolves with an array of documents and their scores.
      */
     similaritySearchVectorWithScore(query: number[], k: number, filter?: PineconeMetadata): Promise<[Document, number][]>;
+    /**
+     * Return documents selected using the maximal marginal relevance.
+     * Maximal marginal relevance optimizes for similarity to the query AND diversity
+     * among selected documents.
+     *
+     * @param {string} query - Text to look up documents similar to.
+     * @param {number} options.k - Number of documents to return.
+     * @param {number} options.fetchK=20 - Number of documents to fetch before passing to the MMR algorithm.
+     * @param {number} options.lambda=0.5 - Number between 0 and 1 that determines the degree of diversity among the results,
+     *                 where 0 corresponds to maximum diversity and 1 to minimum diversity.
+     * @param {PineconeMetadata} options.filter - Optional filter to apply to the search.
+     *
+     * @returns {Promise<Document[]>} - List of documents selected by maximal marginal relevance.
+     */
+    maxMarginalRelevanceSearch(query: string, options: MaxMarginalRelevanceSearchOptions<this["FilterType"]>): Promise<Document[]>;
     /**
      * Static method that creates a new instance of the PineconeStore class
      * from texts.

package/dist/vectorstores/pinecone.js

@@ -4,6 +4,7 @@ import flatten from "flat";
 import { VectorStore } from "./base.js";
 import { Document } from "../document.js";
 import { AsyncCaller } from "../util/async_caller.js";
+import { maximalMarginalRelevance } from "../util/math.js";
 /**
  * Class that extends the VectorStore class and provides methods to
  * interact with the Pinecone vector database.
@@ -137,15 +138,7 @@ export class PineconeStore extends VectorStore {
             throw new Error("Either ids or delete_all must be provided.");
         }
     }
-    /**
-     * Method that performs a similarity search in the Pinecone database and
-     * returns the results along with their scores.
-     * @param query Query vector for the similarity search.
-     * @param k Number of top results to return.
-     * @param filter Optional filter to apply to the search.
-     * @returns Promise that resolves with an array of documents and their scores.
-     */
-    async similaritySearchVectorWithScore(query, k, filter) {
+    async _runPineconeQuery(query, k, filter, options) {
         if (filter && this.filter) {
             throw new Error("cannot provide both `filter` and `this.filter`");
         }
@@ -156,7 +149,20 @@ export class PineconeStore extends VectorStore {
             topK: k,
             vector: query,
             filter: _filter,
+            ...options,
         });
+        return results;
+    }
+    /**
+     * 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) {
+        const results = await this._runPineconeQuery(query, k, filter);
         const result = [];
         if (results.matches) {
             for (const res of results.matches) {
@@ -169,6 +175,37 @@ export class PineconeStore extends VectorStore {
         }
         return result;
     }
+    /**
+     * Return documents selected using the maximal marginal relevance.
+     * Maximal marginal relevance optimizes for similarity to the query AND diversity
+     * among selected documents.
+     *
+     * @param {string} query - Text to look up documents similar to.
+     * @param {number} options.k - Number of documents to return.
+     * @param {number} options.fetchK=20 - Number of documents to fetch before passing to the MMR algorithm.
+     * @param {number} options.lambda=0.5 - Number between 0 and 1 that determines the degree of diversity among the results,
+     *                 where 0 corresponds to maximum diversity and 1 to minimum diversity.
+     * @param {PineconeMetadata} options.filter - Optional filter to apply to the search.
+     *
+     * @returns {Promise<Document[]>} - List of documents selected by maximal marginal relevance.
+     */
+    async maxMarginalRelevanceSearch(query, options) {
+        const queryEmbedding = await this.embeddings.embedQuery(query);
+        const results = await this._runPineconeQuery(queryEmbedding, options.fetchK ?? 20, options.filter, { includeValues: true });
+        const matches = results?.matches ?? [];
+        const embeddingList = matches.map((match) => match.values);
+        const mmrIndexes = maximalMarginalRelevance(queryEmbedding, embeddingList, options.lambda, options.k);
+        const topMmrMatches = mmrIndexes.map((idx) => matches[idx]);
+        const finalResult = [];
+        for (const res of topMmrMatches) {
+            const { [this.textKey]: pageContent, ...metadata } = (res.metadata ??
+                {});
+            if (res.score) {
+                finalResult.push(new Document({ metadata, pageContent }));
+            }
+        }
+        return finalResult;
+    }
     /**
      * Static method that creates a new instance of the PineconeStore class
      * from texts.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "langchain",
-  "version": "0.0.173",
+  "version": "0.0.174",
   "description": "Typescript bindings for langchain",
   "type": "module",
   "engines": {