langchain 0.1.22 → 0.1.24

package/dist/agents/agent.cjs

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Agent = exports.LLMSingleActionAgent = exports.RunnableAgent = exports.BaseMultiActionAgent = exports.BaseSingleActionAgent = exports.BaseAgent = void 0;
 const serializable_1 = require("@langchain/core/load/serializable");
+const runnables_1 = require("@langchain/core/runnables");
 /**
  * Error class for parse errors in LangChain. Contains information about
  * the error message and the output that caused the error.
@@ -119,12 +120,12 @@ class RunnableAgent extends BaseMultiActionAgent {
         this.runnable = fields.runnable;
         this.stop = fields.stop;
     }
-    async plan(steps, inputs, callbackManager) {
+    async plan(steps, inputs, callbackManager, config) {
         const invokeInput = { ...inputs, steps };
-        const output = await this.runnable.invoke(invokeInput, {
+        const output = await this.runnable.invoke(invokeInput, (0, runnables_1.patchConfig)(config, {
             callbacks: callbackManager,
             runName: "RunnableAgent",
-        });
+        }));
         if (isAgentAction(output)) {
             return [output];
         }

package/dist/agents/agent.d.ts

@@ -6,7 +6,7 @@ import { AgentAction, AgentFinish, AgentStep } from "@langchain/core/agents";
 import { BaseMessage } from "@langchain/core/messages";
 import { ChainValues } from "@langchain/core/utils/types";
 import { Serializable } from "@langchain/core/load/serializable";
-import { Runnable } from "@langchain/core/runnables";
+import { Runnable, type RunnableConfig } from "@langchain/core/runnables";
 import { LLMChain } from "../chains/llm_chain.js";
 import { AgentActionOutputParser, AgentInput, RunnableAgentInput, SerializedAgent, StoppingMethod } from "./types.js";
 /**
@@ -55,7 +55,7 @@ export declare abstract class BaseSingleActionAgent extends BaseAgent {
      *
      * @returns Action specifying what tool to use.
      */
-    abstract plan(steps: AgentStep[], inputs: ChainValues, callbackManager?: CallbackManager): Promise<AgentAction | AgentFinish>;
+    abstract plan(steps: AgentStep[], inputs: ChainValues, callbackManager?: CallbackManager, config?: RunnableConfig): Promise<AgentAction | AgentFinish>;
 }
 /**
  * Abstract base class for multi-action agents in LangChain. Extends the
@@ -73,7 +73,7 @@ export declare abstract class BaseMultiActionAgent extends BaseAgent {
      *
      * @returns Actions specifying what tools to use.
      */
-    abstract plan(steps: AgentStep[], inputs: ChainValues, callbackManager?: CallbackManager): Promise<AgentAction[] | AgentFinish>;
+    abstract plan(steps: AgentStep[], inputs: ChainValues, callbackManager?: CallbackManager, config?: RunnableConfig): Promise<AgentAction[] | AgentFinish>;
 }
 /**
  * Class representing a single action agent which accepts runnables.
@@ -89,7 +89,7 @@ export declare class RunnableAgent extends BaseMultiActionAgent {
     stop?: string[];
     get inputKeys(): string[];
     constructor(fields: RunnableAgentInput);
-    plan(steps: AgentStep[], inputs: ChainValues, callbackManager?: CallbackManager): Promise<AgentAction[] | AgentFinish>;
+    plan(steps: AgentStep[], inputs: ChainValues, callbackManager?: CallbackManager, config?: RunnableConfig): Promise<AgentAction[] | AgentFinish>;
 }
 /**
  * Interface for input data for creating a LLMSingleActionAgent.

package/dist/agents/agent.js

@@ -1,4 +1,5 @@
 import { Serializable } from "@langchain/core/load/serializable";
+import { patchConfig, } from "@langchain/core/runnables";
 /**
  * Error class for parse errors in LangChain. Contains information about
  * the error message and the output that caused the error.
@@ -113,12 +114,12 @@ export class RunnableAgent extends BaseMultiActionAgent {
         this.runnable = fields.runnable;
         this.stop = fields.stop;
     }
-    async plan(steps, inputs, callbackManager) {
+    async plan(steps, inputs, callbackManager, config) {
         const invokeInput = { ...inputs, steps };
-        const output = await this.runnable.invoke(invokeInput, {
+        const output = await this.runnable.invoke(invokeInput, patchConfig(config, {
             callbacks: callbackManager,
             runName: "RunnableAgent",
-        });
+        }));
         if (isAgentAction(output)) {
             return [output];
         }

package/dist/agents/executor.cjs

@@ -46,24 +46,34 @@ class AgentExecutorIterator extends serializable_1.Serializable {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "config", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /** @deprecated Use "config" */
         Object.defineProperty(this, "callbacks", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** @deprecated Use "config" */
         Object.defineProperty(this, "tags", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** @deprecated Use "config" */
         Object.defineProperty(this, "metadata", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** @deprecated Use "config" */
         Object.defineProperty(this, "runName", {
             enumerable: true,
             configurable: true,
@@ -101,6 +111,7 @@ class AgentExecutorIterator extends serializable_1.Serializable {
         this.metadata = fields.metadata;
         this.runName = fields.runName;
         this.runManager = fields.runManager;
+        this.config = fields.config;
     }
     /**
      * Reset the iterator to its initial state, clearing intermediate steps,
@@ -158,7 +169,7 @@ class AgentExecutorIterator extends serializable_1.Serializable {
      * AgentExecutor's _takeNextStep method.
      */
     async _executeNextStep(runManager) {
-        return this.agentExecutor._takeNextStep(this.nameToToolMap, this.inputs, this.intermediateSteps, runManager);
+        return this.agentExecutor._takeNextStep(this.nameToToolMap, this.inputs, this.intermediateSteps, runManager, this.config);
     }
     /**
      * Process the output of the next step,
@@ -390,7 +401,7 @@ class AgentExecutor extends base_js_1.BaseChain {
         while (this.shouldContinue(iterations)) {
             let output;
             try {
-                output = await this.agent.plan(steps, inputs, runManager?.getChild());
+                output = await this.agent.plan(steps, inputs, runManager?.getChild(), config);
             }
             catch (e) {
                 // eslint-disable-next-line no-instanceof/no-instanceof
@@ -483,10 +494,10 @@ class AgentExecutor extends base_js_1.BaseChain {
         const finish = await this.agent.returnStoppedResponse(this.earlyStoppingMethod, steps, inputs);
         return getOutput(finish);
     }
-    async _takeNextStep(nameToolMap, inputs, intermediateSteps, runManager) {
+    async _takeNextStep(nameToolMap, inputs, intermediateSteps, runManager, config) {
         let output;
         try {
-            output = await this.agent.plan(intermediateSteps, inputs, runManager?.getChild());
+            output = await this.agent.plan(intermediateSteps, inputs, runManager?.getChild(), config);
         }
         catch (e) {
             // eslint-disable-next-line no-instanceof/no-instanceof
@@ -614,6 +625,8 @@ class AgentExecutor extends base_js_1.BaseChain {
         const agentExecutorIterator = new AgentExecutorIterator({
             inputs,
             agentExecutor: this,
+            config: options,
+            // TODO: Deprecate these other parameters
             metadata: options?.metadata,
             tags: options?.tags,
             callbacks: options?.callbacks,

package/dist/agents/executor.d.ts

@@ -12,8 +12,12 @@ import { BaseChain, ChainInputs } from "../chains/base.js";
 interface AgentExecutorIteratorInput {
     agentExecutor: AgentExecutor;
     inputs: Record<string, string>;
+    config?: RunnableConfig;
+    /** @deprecated Use "config" */
     callbacks?: Callbacks;
+    /** @deprecated Use "config" */
     tags?: string[];
+    /** @deprecated Use "config" */
     metadata?: Record<string, unknown>;
     runName?: string;
     runManager?: CallbackManagerForChainRun;
@@ -22,9 +26,14 @@ export declare class AgentExecutorIterator extends Serializable implements Agent
     lc_namespace: string[];
     agentExecutor: AgentExecutor;
     inputs: Record<string, string>;
+    config?: RunnableConfig;
+    /** @deprecated Use "config" */
     callbacks?: Callbacks;
+    /** @deprecated Use "config" */
     tags: string[] | undefined;
+    /** @deprecated Use "config" */
     metadata: Record<string, unknown> | undefined;
+    /** @deprecated Use "config" */
     runName: string | undefined;
     private _finalOutputs;
     get finalOutputs(): Record<string, unknown> | undefined;
@@ -141,7 +150,7 @@ export declare class AgentExecutor extends BaseChain<ChainValues, AgentExecutorO
     private shouldContinue;
     /** @ignore */
     _call(inputs: ChainValues, runManager?: CallbackManagerForChainRun, config?: RunnableConfig): Promise<AgentExecutorOutput>;
-    _takeNextStep(nameToolMap: Record<string, ToolInterface>, inputs: ChainValues, intermediateSteps: AgentStep[], runManager?: CallbackManagerForChainRun): Promise<AgentFinish | AgentStep[]>;
+    _takeNextStep(nameToolMap: Record<string, ToolInterface>, inputs: ChainValues, intermediateSteps: AgentStep[], runManager?: CallbackManagerForChainRun, config?: RunnableConfig): Promise<AgentFinish | AgentStep[]>;
     _return(output: AgentFinish, intermediateSteps: AgentStep[], runManager?: CallbackManagerForChainRun): Promise<AgentExecutorOutput>;
     _getToolReturn(nextStepOutput: AgentStep): Promise<AgentFinish | null>;
     _returnStoppedResponse(earlyStoppingMethod: StoppingMethod): AgentFinish;

package/dist/agents/executor.js

@@ -43,24 +43,34 @@ export class AgentExecutorIterator extends Serializable {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "config", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /** @deprecated Use "config" */
         Object.defineProperty(this, "callbacks", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** @deprecated Use "config" */
         Object.defineProperty(this, "tags", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** @deprecated Use "config" */
         Object.defineProperty(this, "metadata", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** @deprecated Use "config" */
         Object.defineProperty(this, "runName", {
             enumerable: true,
             configurable: true,
@@ -98,6 +108,7 @@ export class AgentExecutorIterator extends Serializable {
         this.metadata = fields.metadata;
         this.runName = fields.runName;
         this.runManager = fields.runManager;
+        this.config = fields.config;
     }
     /**
      * Reset the iterator to its initial state, clearing intermediate steps,
@@ -155,7 +166,7 @@ export class AgentExecutorIterator extends Serializable {
      * AgentExecutor's _takeNextStep method.
      */
     async _executeNextStep(runManager) {
-        return this.agentExecutor._takeNextStep(this.nameToToolMap, this.inputs, this.intermediateSteps, runManager);
+        return this.agentExecutor._takeNextStep(this.nameToToolMap, this.inputs, this.intermediateSteps, runManager, this.config);
     }
     /**
      * Process the output of the next step,
@@ -385,7 +396,7 @@ export class AgentExecutor extends BaseChain {
         while (this.shouldContinue(iterations)) {
             let output;
             try {
-                output = await this.agent.plan(steps, inputs, runManager?.getChild());
+                output = await this.agent.plan(steps, inputs, runManager?.getChild(), config);
             }
             catch (e) {
                 // eslint-disable-next-line no-instanceof/no-instanceof
@@ -478,10 +489,10 @@ export class AgentExecutor extends BaseChain {
         const finish = await this.agent.returnStoppedResponse(this.earlyStoppingMethod, steps, inputs);
         return getOutput(finish);
     }
-    async _takeNextStep(nameToolMap, inputs, intermediateSteps, runManager) {
+    async _takeNextStep(nameToolMap, inputs, intermediateSteps, runManager, config) {
         let output;
         try {
-            output = await this.agent.plan(intermediateSteps, inputs, runManager?.getChild());
+            output = await this.agent.plan(intermediateSteps, inputs, runManager?.getChild(), config);
         }
         catch (e) {
             // eslint-disable-next-line no-instanceof/no-instanceof
@@ -609,6 +620,8 @@ export class AgentExecutor extends BaseChain {
         const agentExecutorIterator = new AgentExecutorIterator({
             inputs,
             agentExecutor: this,
+            config: options,
+            // TODO: Deprecate these other parameters
             metadata: options?.metadata,
             tags: options?.tags,
             callbacks: options?.callbacks,

package/dist/chains/base.cjs

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.BaseChain = void 0;
 const outputs_1 = require("@langchain/core/outputs");
 const manager_1 = require("@langchain/core/callbacks/manager");
+const runnables_1 = require("@langchain/core/runnables");
 const base_1 = require("@langchain/core/language_models/base");
 /**
  * Base interface that all chains must implement.
@@ -48,7 +49,7 @@ class BaseChain extends base_1.BaseLangChain {
      * @returns Promise that resolves with the output of the chain run.
      */
     async invoke(input, options) {
-        const [config] = this._getOptionsList(options ?? {}, 1);
+        const config = (0, runnables_1.ensureConfig)(options);
         const fullValues = await this._formatValues(input);
         const callbackManager_ = await manager_1.CallbackManager.configure(config?.callbacks, this.callbacks, config?.tags, this.tags, config?.metadata, this.metadata, { verbose: this.verbose });
         const runManager = await callbackManager_?.handleChainStart(this.toJSON(), fullValues, undefined, undefined, undefined, undefined, config?.runName);

package/dist/chains/base.js

@@ -1,5 +1,6 @@
 import { RUN_KEY } from "@langchain/core/outputs";
 import { CallbackManager, parseCallbackConfigArg, } from "@langchain/core/callbacks/manager";
+import { ensureConfig } from "@langchain/core/runnables";
 import { BaseLangChain, } from "@langchain/core/language_models/base";
 /**
  * Base interface that all chains must implement.
@@ -45,7 +46,7 @@ export class BaseChain extends BaseLangChain {
      * @returns Promise that resolves with the output of the chain run.
      */
     async invoke(input, options) {
-        const [config] = this._getOptionsList(options ?? {}, 1);
+        const config = ensureConfig(options);
         const fullValues = await this._formatValues(input);
         const callbackManager_ = await CallbackManager.configure(config?.callbacks, this.callbacks, config?.tags, this.tags, config?.metadata, this.metadata, { verbose: this.verbose });
         const runManager = await callbackManager_?.handleChainStart(this.toJSON(), fullValues, undefined, undefined, undefined, undefined, config?.runName);

package/dist/embeddings/fake.cjs

@@ -14,10 +14,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const entrypoint_deprecation_js_1 = require("../util/entrypoint_deprecation.cjs");
 __exportStar(require("@langchain/core/utils/testing"), exports);
-/* #__PURE__ */ (0, entrypoint_deprecation_js_1.logVersion010MigrationWarning)({
-    oldEntrypointName: "embeddings/fake",
-    newEntrypointName: "utils/testing",
-    newPackageName: "@langchain/core",
-});

package/dist/embeddings/fake.js

@@ -1,7 +1 @@
-import { logVersion010MigrationWarning } from "../util/entrypoint_deprecation.js";
 export * from "@langchain/core/utils/testing";
-/* #__PURE__ */ logVersion010MigrationWarning({
-    oldEntrypointName: "embeddings/fake",
-    newEntrypointName: "utils/testing",
-    newPackageName: "@langchain/core",
-});

package/dist/load/import_map.cjs

@@ -24,8 +24,8 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.storage__in_memory = exports.storage__encoder_backed = exports.stores__message__in_memory = exports.stores__file__in_memory = exports.stores__doc__in_memory = exports.retrievers__vespa = exports.retrievers__score_threshold = exports.retrievers__hyde = exports.retrievers__document_compressors__embeddings_filter = exports.retrievers__document_compressors__chain_extract = exports.retrievers__time_weighted = exports.retrievers__parent_document = exports.retrievers__multi_vector = exports.retrievers__multi_query = exports.retrievers__document_compressors = exports.retrievers__contextual_compression = exports.retrievers__remote = exports.output_parsers = exports.schema__query_constructor = exports.schema__prompt_template = exports.chat_models__anthropic = exports.document_transformers__openai_functions = exports.document_loaders__web__sort_xyz_blockchain = exports.document_loaders__web__serpapi = exports.document_loaders__web__searchapi = exports.document_loaders__base = exports.text_splitter = exports.vectorstores__memory = exports.llms__fake = exports.embeddings__fake = exports.embeddings__cache_backed = exports.chains__retrieval = exports.chains__openai_functions = exports.chains__history_aware_retriever = exports.chains__combine_documents__reduce = exports.chains__combine_documents = exports.chains = exports.tools__retriever = exports.tools__render = exports.tools__chain = exports.agents__openai__output_parser = exports.agents__xml__output_parser = exports.agents__react__output_parser = exports.agents__format_scratchpad__log_to_message = exports.agents__format_scratchpad__xml = exports.agents__format_scratchpad__log = exports.agents__format_scratchpad__openai_tools = exports.agents__format_scratchpad = exports.agents__toolkits = exports.agents = void 0;
-exports.llms__fireworks = exports.chat_models__fireworks = exports.schema__output = exports.schema__output_parser = exports.schema__runnable = exports.prompts__base = exports.prompts__pipeline = exports.prompts__image = exports.prompts__chat = exports.schema = exports.schema__messages = exports.prompts__prompt = exports.embeddings__openai = exports.llms__openai = exports.chat_models__openai = exports.indexes = exports.runnables__remote = exports.smith = exports.evaluation = exports.experimental__prompts__custom_format = exports.experimental__masking = exports.experimental__chains__violation_of_expectations = exports.experimental__chat_models__bittensor = exports.experimental__plan_and_execute = exports.experimental__generative_agents = exports.experimental__babyagi = exports.experimental__openai_files = exports.experimental__openai_assistant = exports.experimental__autogpt = exports.util__time = exports.util__math = exports.util__document = void 0;
+exports.storage__encoder_backed = exports.stores__message__in_memory = exports.stores__file__in_memory = exports.stores__doc__in_memory = exports.retrievers__matryoshka_retriever = exports.retrievers__vespa = exports.retrievers__score_threshold = exports.retrievers__hyde = exports.retrievers__document_compressors__embeddings_filter = exports.retrievers__document_compressors__chain_extract = exports.retrievers__time_weighted = exports.retrievers__parent_document = exports.retrievers__multi_vector = exports.retrievers__multi_query = exports.retrievers__document_compressors = exports.retrievers__contextual_compression = exports.retrievers__remote = exports.output_parsers = exports.schema__query_constructor = exports.schema__prompt_template = exports.chat_models__anthropic = exports.document_transformers__openai_functions = exports.document_loaders__web__sort_xyz_blockchain = exports.document_loaders__web__serpapi = exports.document_loaders__web__searchapi = exports.document_loaders__base = exports.text_splitter = exports.vectorstores__memory = exports.llms__fake = exports.embeddings__fake = exports.embeddings__cache_backed = exports.chains__retrieval = exports.chains__openai_functions = exports.chains__history_aware_retriever = exports.chains__combine_documents__reduce = exports.chains__combine_documents = exports.chains = exports.tools__retriever = exports.tools__render = exports.tools__chain = exports.agents__openai__output_parser = exports.agents__xml__output_parser = exports.agents__react__output_parser = exports.agents__format_scratchpad__log_to_message = exports.agents__format_scratchpad__xml = exports.agents__format_scratchpad__log = exports.agents__format_scratchpad__openai_tools = exports.agents__format_scratchpad = exports.agents__toolkits = exports.agents = void 0;
+exports.llms__fireworks = exports.chat_models__fireworks = exports.schema__output = exports.schema__output_parser = exports.schema__runnable = exports.prompts__base = exports.prompts__pipeline = exports.prompts__image = exports.prompts__chat = exports.schema = exports.schema__messages = exports.prompts__prompt = exports.embeddings__openai = exports.llms__openai = exports.chat_models__openai = exports.indexes = exports.runnables__remote = exports.smith = exports.evaluation = exports.experimental__prompts__custom_format = exports.experimental__masking = exports.experimental__chains__violation_of_expectations = exports.experimental__chat_models__bittensor = exports.experimental__plan_and_execute = exports.experimental__generative_agents = exports.experimental__babyagi = exports.experimental__openai_files = exports.experimental__openai_assistant = exports.experimental__autogpt = exports.util__time = exports.util__math = exports.util__document = exports.storage__in_memory = void 0;
 exports.agents = __importStar(require("../agents/index.cjs"));
 exports.agents__toolkits = __importStar(require("../agents/toolkits/index.cjs"));
 exports.agents__format_scratchpad = __importStar(require("../agents/format_scratchpad/openai_functions.cjs"));
@@ -71,6 +71,7 @@ exports.retrievers__document_compressors__embeddings_filter = __importStar(requi
 exports.retrievers__hyde = __importStar(require("../retrievers/hyde.cjs"));
 exports.retrievers__score_threshold = __importStar(require("../retrievers/score_threshold.cjs"));
 exports.retrievers__vespa = __importStar(require("../retrievers/vespa.cjs"));
+exports.retrievers__matryoshka_retriever = __importStar(require("../retrievers/matryoshka_retriever.cjs"));
 exports.stores__doc__in_memory = __importStar(require("../stores/doc/in_memory.cjs"));
 exports.stores__file__in_memory = __importStar(require("../stores/file/in_memory.cjs"));
 exports.stores__message__in_memory = __importStar(require("../stores/message/in_memory.cjs"));

package/dist/load/import_map.d.ts

@@ -43,6 +43,7 @@ export * as retrievers__document_compressors__embeddings_filter from "../retriev
 export * as retrievers__hyde from "../retrievers/hyde.js";
 export * as retrievers__score_threshold from "../retrievers/score_threshold.js";
 export * as retrievers__vespa from "../retrievers/vespa.js";
+export * as retrievers__matryoshka_retriever from "../retrievers/matryoshka_retriever.js";
 export * as stores__doc__in_memory from "../stores/doc/in_memory.js";
 export * as stores__file__in_memory from "../stores/file/in_memory.js";
 export * as stores__message__in_memory from "../stores/message/in_memory.js";

package/dist/load/import_map.js

@@ -44,6 +44,7 @@ export * as retrievers__document_compressors__embeddings_filter from "../retriev
 export * as retrievers__hyde from "../retrievers/hyde.js";
 export * as retrievers__score_threshold from "../retrievers/score_threshold.js";
 export * as retrievers__vespa from "../retrievers/vespa.js";
+export * as retrievers__matryoshka_retriever from "../retrievers/matryoshka_retriever.js";
 export * as stores__doc__in_memory from "../stores/doc/in_memory.js";
 export * as stores__file__in_memory from "../stores/file/in_memory.js";
 export * as stores__message__in_memory from "../stores/message/in_memory.js";

package/dist/retrievers/matryoshka_retriever.cjs

@@ -0,0 +1,148 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MatryoshkaRetriever = void 0;
+const math_1 = require("@langchain/core/utils/math");
+const vectorstores_1 = require("@langchain/core/vectorstores");
+/**
+ * A retriever that uses two sets of embeddings to perform adaptive retrieval. Based
+ * off of the "Matryoshka embeddings: faster OpenAI vector search using Adaptive Retrieval"
+ * blog post {@link https://supabase.com/blog/matryoshka-embeddings}.
+ *
+ *
+ * This class performs "Adaptive Retrieval" for searching text embeddings efficiently using the
+ * Matryoshka Representation Learning (MRL) technique. It retrieves documents similar to a query
+ * embedding in two steps:
+ *
+ * First-pass: Uses a lower dimensional sub-vector from the MRL embedding for an initial, fast,
+ * but less accurate search.
+ *
+ * Second-pass: Re-ranks the top results from the first pass using the full, high-dimensional
+ * embedding for higher accuracy.
+ *
+ *
+ * This code implements MRL embeddings for efficient vector search by combining faster,
+ * lower-dimensional initial search with accurate, high-dimensional re-ranking.
+ */
+class MatryoshkaRetriever extends vectorstores_1.VectorStoreRetriever {
+    constructor(fields) {
+        super(fields);
+        Object.defineProperty(this, "smallK", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 50
+        });
+        Object.defineProperty(this, "largeK", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 8
+        });
+        Object.defineProperty(this, "largeEmbeddingKey", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: "lc_large_embedding"
+        });
+        Object.defineProperty(this, "largeEmbeddingModel", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "searchType", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: "cosine"
+        });
+        /**
+         * Override the default `addDocuments` method to embed the documents twice,
+         * once using the larger embeddings model, and then again using the default
+         * embedding model linked to the vector store.
+         *
+         * @param {DocumentInterface[]} documents - An array of documents to add to the vector store.
+         * @param {AddDocumentOptions} options - An optional object containing additional options for adding documents.
+         * @returns {Promise<string[] | void>} A promise that resolves to an array of the document IDs that were added to the vector store.
+         */
+        Object.defineProperty(this, "addDocuments", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: async (documents, options) => {
+                // Insure documents metadata does not contain the large embedding key
+                if (documents.some((doc) => this.largeEmbeddingKey in doc.metadata)) {
+                    throw new Error(`All documents must not contain the large embedding key: ${this.largeEmbeddingKey} in their metadata.`);
+                }
+                const allDocPageContent = documents.map((doc) => doc.pageContent);
+                const allDocLargeEmbeddings = await this.largeEmbeddingModel.embedDocuments(allDocPageContent);
+                const newDocuments = documents.map((doc, idx) => ({
+                    ...doc,
+                    metadata: {
+                        ...doc.metadata,
+                        [this.largeEmbeddingKey]: JSON.stringify(allDocLargeEmbeddings[idx]),
+                    },
+                }));
+                return this.vectorStore.addDocuments(newDocuments, options);
+            }
+        });
+        this.smallK = fields.smallK ?? this.smallK;
+        this.largeK = fields.largeK ?? this.largeK;
+        this.largeEmbeddingKey = fields.largeEmbeddingKey ?? this.largeEmbeddingKey;
+        this.largeEmbeddingModel = fields.largeEmbeddingModel;
+        this.searchType = fields.searchType ?? this.searchType;
+    }
+    /**
+     * Ranks documents based on their similarity to a query embedding using larger embeddings.
+     *
+     * This method takes a query embedding and a list of documents (smallResults) as input. Each document
+     * in the smallResults array has previously been associated with a large embedding stored in its metadata.
+     * Depending on the `searchType` (cosine, innerProduct, or euclidean), it calculates the similarity scores
+     * between the query embedding and each document's large embedding. It then ranks the documents based on
+     * these similarity scores, from the most similar to the least similar.
+     *
+     * The method returns a promise that resolves to an array of the top `largeK` documents, where `largeK`
+     * is a class property defining the number of documents to return. This subset of documents is determined
+     * by sorting the entire list of documents based on their similarity scores and then selecting the top
+     * `largeK` documents.
+     *
+     * @param {number[]} embeddedQuery The embedding of the query, represented as an array of numbers.
+     * @param {DocumentInterface[]} smallResults An array of documents, each with metadata that includes a large embedding for similarity comparison.
+     * @returns {Promise<DocumentInterface[]>} A promise that resolves to an array of the top `largeK` ranked documents based on their similarity to the query embedding.
+     */
+    _rankByLargeEmbeddings(embeddedQuery, smallResults) {
+        const largeEmbeddings = smallResults.map((doc) => JSON.parse(doc.metadata[this.largeEmbeddingKey]));
+        let func;
+        switch (this.searchType) {
+            case "cosine":
+                func = () => (0, math_1.cosineSimilarity)([embeddedQuery], largeEmbeddings);
+                break;
+            case "innerProduct":
+                func = () => (0, math_1.innerProduct)([embeddedQuery], largeEmbeddings);
+                break;
+            case "euclidean":
+                func = () => (0, math_1.euclideanDistance)([embeddedQuery], largeEmbeddings);
+                break;
+            default:
+                throw new Error(`Unknown search type: ${this.searchType}`);
+        }
+        // Calculate the similarity scores between the query embedding and the large embeddings
+        const [similarityScores] = func();
+        // Create an array of indices from 0 to N-1, where N is the number of documents
+        let indices = Array.from({ length: smallResults.length }, (_, index) => index);
+        indices = indices
+            .map((v, i) => [similarityScores[i], v])
+            .sort(([a], [b]) => b - a)
+            .slice(0, this.largeK)
+            .map(([, i]) => i);
+        return indices.map((i) => smallResults[i]);
+    }
+    async _getRelevantDocuments(query) {
+        const [embeddedQuery, smallResults] = await Promise.all([
+            this.largeEmbeddingModel.embedQuery(query),
+            this.vectorStore.similaritySearch(query, this.smallK, this.filter),
+        ]);
+        return this._rankByLargeEmbeddings(embeddedQuery, smallResults);
+    }
+}
+exports.MatryoshkaRetriever = MatryoshkaRetriever;

package/dist/retrievers/matryoshka_retriever.d.ts

@@ -0,0 +1,93 @@
+import { DocumentInterface } from "@langchain/core/documents";
+import { Embeddings } from "@langchain/core/embeddings";
+import { VectorStore, VectorStoreRetriever, VectorStoreRetrieverInput } from "@langchain/core/vectorstores";
+/**
+ * Type for options when adding a document to the VectorStore.
+ */
+type AddDocumentOptions = Record<string, any>;
+export interface MatryoshkaRetrieverFields {
+    /**
+     * The number of documents to retrieve from the small store.
+     * @default 50
+     */
+    smallK?: number;
+    /**
+     * The number of documents to retrieve from the large store.
+     * @default 8
+     */
+    largeK?: number;
+    /**
+     * The metadata key to store the larger embeddings.
+     * @default "lc_large_embedding"
+     */
+    largeEmbeddingKey?: string;
+    /**
+     * The embedding model to use when generating the large
+     * embeddings.
+     */
+    largeEmbeddingModel: Embeddings;
+    /**
+     * The type of search to perform using the large embeddings.
+     * @default "cosine"
+     */
+    searchType?: "cosine" | "innerProduct" | "euclidean";
+}
+/**
+ * A retriever that uses two sets of embeddings to perform adaptive retrieval. Based
+ * off of the "Matryoshka embeddings: faster OpenAI vector search using Adaptive Retrieval"
+ * blog post {@link https://supabase.com/blog/matryoshka-embeddings}.
+ *
+ *
+ * This class performs "Adaptive Retrieval" for searching text embeddings efficiently using the
+ * Matryoshka Representation Learning (MRL) technique. It retrieves documents similar to a query
+ * embedding in two steps:
+ *
+ * First-pass: Uses a lower dimensional sub-vector from the MRL embedding for an initial, fast,
+ * but less accurate search.
+ *
+ * Second-pass: Re-ranks the top results from the first pass using the full, high-dimensional
+ * embedding for higher accuracy.
+ *
+ *
+ * This code implements MRL embeddings for efficient vector search by combining faster,
+ * lower-dimensional initial search with accurate, high-dimensional re-ranking.
+ */
+export declare class MatryoshkaRetriever<Store extends VectorStore = VectorStore> extends VectorStoreRetriever<Store> {
+    smallK: number;
+    largeK: number;
+    largeEmbeddingKey: string;
+    largeEmbeddingModel: Embeddings;
+    searchType: "cosine" | "innerProduct" | "euclidean";
+    constructor(fields: MatryoshkaRetrieverFields & VectorStoreRetrieverInput<Store>);
+    /**
+     * Ranks documents based on their similarity to a query embedding using larger embeddings.
+     *
+     * This method takes a query embedding and a list of documents (smallResults) as input. Each document
+     * in the smallResults array has previously been associated with a large embedding stored in its metadata.
+     * Depending on the `searchType` (cosine, innerProduct, or euclidean), it calculates the similarity scores
+     * between the query embedding and each document's large embedding. It then ranks the documents based on
+     * these similarity scores, from the most similar to the least similar.
+     *
+     * The method returns a promise that resolves to an array of the top `largeK` documents, where `largeK`
+     * is a class property defining the number of documents to return. This subset of documents is determined
+     * by sorting the entire list of documents based on their similarity scores and then selecting the top
+     * `largeK` documents.
+     *
+     * @param {number[]} embeddedQuery The embedding of the query, represented as an array of numbers.
+     * @param {DocumentInterface[]} smallResults An array of documents, each with metadata that includes a large embedding for similarity comparison.
+     * @returns {Promise<DocumentInterface[]>} A promise that resolves to an array of the top `largeK` ranked documents based on their similarity to the query embedding.
+     */
+    private _rankByLargeEmbeddings;
+    _getRelevantDocuments(query: string): Promise<DocumentInterface[]>;
+    /**
+     * Override the default `addDocuments` method to embed the documents twice,
+     * once using the larger embeddings model, and then again using the default
+     * embedding model linked to the vector store.
+     *
+     * @param {DocumentInterface[]} documents - An array of documents to add to the vector store.
+     * @param {AddDocumentOptions} options - An optional object containing additional options for adding documents.
+     * @returns {Promise<string[] | void>} A promise that resolves to an array of the document IDs that were added to the vector store.
+     */
+    addDocuments: (documents: DocumentInterface[], options?: AddDocumentOptions) => Promise<string[] | void>;
+}
+export {};

package/dist/retrievers/matryoshka_retriever.js

@@ -0,0 +1,144 @@
+import { cosineSimilarity, euclideanDistance, innerProduct, } from "@langchain/core/utils/math";
+import { VectorStoreRetriever, } from "@langchain/core/vectorstores";
+/**
+ * A retriever that uses two sets of embeddings to perform adaptive retrieval. Based
+ * off of the "Matryoshka embeddings: faster OpenAI vector search using Adaptive Retrieval"
+ * blog post {@link https://supabase.com/blog/matryoshka-embeddings}.
+ *
+ *
+ * This class performs "Adaptive Retrieval" for searching text embeddings efficiently using the
+ * Matryoshka Representation Learning (MRL) technique. It retrieves documents similar to a query
+ * embedding in two steps:
+ *
+ * First-pass: Uses a lower dimensional sub-vector from the MRL embedding for an initial, fast,
+ * but less accurate search.
+ *
+ * Second-pass: Re-ranks the top results from the first pass using the full, high-dimensional
+ * embedding for higher accuracy.
+ *
+ *
+ * This code implements MRL embeddings for efficient vector search by combining faster,
+ * lower-dimensional initial search with accurate, high-dimensional re-ranking.
+ */
+export class MatryoshkaRetriever extends VectorStoreRetriever {
+    constructor(fields) {
+        super(fields);
+        Object.defineProperty(this, "smallK", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 50
+        });
+        Object.defineProperty(this, "largeK", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 8
+        });
+        Object.defineProperty(this, "largeEmbeddingKey", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: "lc_large_embedding"
+        });
+        Object.defineProperty(this, "largeEmbeddingModel", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "searchType", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: "cosine"
+        });
+        /**
+         * Override the default `addDocuments` method to embed the documents twice,
+         * once using the larger embeddings model, and then again using the default
+         * embedding model linked to the vector store.
+         *
+         * @param {DocumentInterface[]} documents - An array of documents to add to the vector store.
+         * @param {AddDocumentOptions} options - An optional object containing additional options for adding documents.
+         * @returns {Promise<string[] | void>} A promise that resolves to an array of the document IDs that were added to the vector store.
+         */
+        Object.defineProperty(this, "addDocuments", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: async (documents, options) => {
+                // Insure documents metadata does not contain the large embedding key
+                if (documents.some((doc) => this.largeEmbeddingKey in doc.metadata)) {
+                    throw new Error(`All documents must not contain the large embedding key: ${this.largeEmbeddingKey} in their metadata.`);
+                }
+                const allDocPageContent = documents.map((doc) => doc.pageContent);
+                const allDocLargeEmbeddings = await this.largeEmbeddingModel.embedDocuments(allDocPageContent);
+                const newDocuments = documents.map((doc, idx) => ({
+                    ...doc,
+                    metadata: {
+                        ...doc.metadata,
+                        [this.largeEmbeddingKey]: JSON.stringify(allDocLargeEmbeddings[idx]),
+                    },
+                }));
+                return this.vectorStore.addDocuments(newDocuments, options);
+            }
+        });
+        this.smallK = fields.smallK ?? this.smallK;
+        this.largeK = fields.largeK ?? this.largeK;
+        this.largeEmbeddingKey = fields.largeEmbeddingKey ?? this.largeEmbeddingKey;
+        this.largeEmbeddingModel = fields.largeEmbeddingModel;
+        this.searchType = fields.searchType ?? this.searchType;
+    }
+    /**
+     * Ranks documents based on their similarity to a query embedding using larger embeddings.
+     *
+     * This method takes a query embedding and a list of documents (smallResults) as input. Each document
+     * in the smallResults array has previously been associated with a large embedding stored in its metadata.
+     * Depending on the `searchType` (cosine, innerProduct, or euclidean), it calculates the similarity scores
+     * between the query embedding and each document's large embedding. It then ranks the documents based on
+     * these similarity scores, from the most similar to the least similar.
+     *
+     * The method returns a promise that resolves to an array of the top `largeK` documents, where `largeK`
+     * is a class property defining the number of documents to return. This subset of documents is determined
+     * by sorting the entire list of documents based on their similarity scores and then selecting the top
+     * `largeK` documents.
+     *
+     * @param {number[]} embeddedQuery The embedding of the query, represented as an array of numbers.
+     * @param {DocumentInterface[]} smallResults An array of documents, each with metadata that includes a large embedding for similarity comparison.
+     * @returns {Promise<DocumentInterface[]>} A promise that resolves to an array of the top `largeK` ranked documents based on their similarity to the query embedding.
+     */
+    _rankByLargeEmbeddings(embeddedQuery, smallResults) {
+        const largeEmbeddings = smallResults.map((doc) => JSON.parse(doc.metadata[this.largeEmbeddingKey]));
+        let func;
+        switch (this.searchType) {
+            case "cosine":
+                func = () => cosineSimilarity([embeddedQuery], largeEmbeddings);
+                break;
+            case "innerProduct":
+                func = () => innerProduct([embeddedQuery], largeEmbeddings);
+                break;
+            case "euclidean":
+                func = () => euclideanDistance([embeddedQuery], largeEmbeddings);
+                break;
+            default:
+                throw new Error(`Unknown search type: ${this.searchType}`);
+        }
+        // Calculate the similarity scores between the query embedding and the large embeddings
+        const [similarityScores] = func();
+        // Create an array of indices from 0 to N-1, where N is the number of documents
+        let indices = Array.from({ length: smallResults.length }, (_, index) => index);
+        indices = indices
+            .map((v, i) => [similarityScores[i], v])
+            .sort(([a], [b]) => b - a)
+            .slice(0, this.largeK)
+            .map(([, i]) => i);
+        return indices.map((i) => smallResults[i]);
+    }
+    async _getRelevantDocuments(query) {
+        const [embeddedQuery, smallResults] = await Promise.all([
+            this.largeEmbeddingModel.embedQuery(query),
+            this.vectorStore.similaritySearch(query, this.smallK, this.filter),
+        ]);
+        return this._rankByLargeEmbeddings(embeddedQuery, smallResults);
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "langchain",
-  "version": "0.1.22",
+  "version": "0.1.24",
   "description": "Typescript bindings for langchain",
   "type": "module",
   "engines": {
@@ -942,6 +942,10 @@
     "retrievers/vespa.js",
     "retrievers/vespa.d.ts",
     "retrievers/vespa.d.cts",
+    "retrievers/matryoshka_retriever.cjs",
+    "retrievers/matryoshka_retriever.js",
+    "retrievers/matryoshka_retriever.d.ts",
+    "retrievers/matryoshka_retriever.d.cts",
     "cache.cjs",
     "cache.js",
     "cache.d.ts",
@@ -1508,8 +1512,8 @@
   },
   "dependencies": {
     "@anthropic-ai/sdk": "^0.9.1",
-    "@langchain/community": "~0.0.32",
-    "@langchain/core": "~0.1.34",
+    "@langchain/community": "~0.0.33",
+    "@langchain/core": "~0.1.36",
     "@langchain/openai": "~0.0.14",
     "binary-extensions": "^2.2.0",
     "expr-eval": "^2.0.2",
@@ -1517,7 +1521,7 @@
     "js-yaml": "^4.1.0",
     "jsonpointer": "^5.0.1",
     "langchainhub": "~0.0.8",
-    "langsmith": "~0.1.1",
+    "langsmith": "~0.1.7",
     "ml-distance": "^4.0.0",
     "openapi-types": "^12.1.3",
     "p-retry": "4",
@@ -3641,6 +3645,15 @@
       "import": "./retrievers/vespa.js",
       "require": "./retrievers/vespa.cjs"
     },
+    "./retrievers/matryoshka_retriever": {
+      "types": {
+        "import": "./retrievers/matryoshka_retriever.d.ts",
+        "require": "./retrievers/matryoshka_retriever.d.cts",
+        "default": "./retrievers/matryoshka_retriever.d.ts"
+      },
+      "import": "./retrievers/matryoshka_retriever.js",
+      "require": "./retrievers/matryoshka_retriever.cjs"
+    },
     "./cache": {
       "types": {
         "import": "./cache.d.ts",

package/retrievers/matryoshka_retriever.cjs

@@ -0,0 +1 @@
+module.exports = require('../dist/retrievers/matryoshka_retriever.cjs');

package/retrievers/matryoshka_retriever.d.cts

@@ -0,0 +1 @@
+export * from '../dist/retrievers/matryoshka_retriever.js'

package/retrievers/matryoshka_retriever.d.ts

@@ -0,0 +1 @@
+export * from '../dist/retrievers/matryoshka_retriever.js'

package/retrievers/matryoshka_retriever.js

@@ -0,0 +1 @@
+export * from '../dist/retrievers/matryoshka_retriever.js'