@langchain/classic 1.0.0-alpha.1

package/dist/chains/router/multi_retrieval_qa.cjs

@@ -0,0 +1,137 @@
+const require_rolldown_runtime = require('../../_virtual/rolldown_runtime.cjs');
+const require_conversation = require('../conversation.cjs');
+const require_retrieval_qa = require('../retrieval_qa.cjs');
+const require_multi_route = require('./multi_route.cjs');
+const require_llm_router = require('./llm_router.cjs');
+const require_utils = require('./utils.cjs');
+const require_router = require('../../output_parsers/router.cjs');
+const require_multi_retrieval_prompt = require('./multi_retrieval_prompt.cjs');
+const __langchain_core_prompts = require_rolldown_runtime.__toESM(require("@langchain/core/prompts"));
+const zod_v3 = require_rolldown_runtime.__toESM(require("zod/v3"));
+
+//#region src/chains/router/multi_retrieval_qa.ts
+/**
+* A class that represents a multi-retrieval question answering chain in
+* the LangChain framework. It extends the MultiRouteChain class and
+* provides additional functionality specific to multi-retrieval QA
+* chains.
+* @example
+* ```typescript
+* const multiRetrievalQAChain = MultiRetrievalQAChain.fromLLMAndRetrievers(
+*   new ChatOpenAI({ model: "gpt-4o-mini" }),
+*   {
+*     retrieverNames: ["aqua teen", "mst3k", "animaniacs"],
+*     retrieverDescriptions: [
+*       "Good for answering questions about Aqua Teen Hunger Force theme song",
+*       "Good for answering questions about Mystery Science Theater 3000 theme song",
+*       "Good for answering questions about Animaniacs theme song",
+*     ],
+*     retrievers: [
+*       new MemoryVectorStore().asRetriever(3),
+*       new MemoryVectorStore().asRetriever(3),
+*       new MemoryVectorStore().asRetriever(3),
+*     ],
+*     retrievalQAChainOpts: {
+*       returnSourceDocuments: true,
+*     },
+*   },
+* );
+*
+* const result = await multiRetrievalQAChain.call({
+*   input:
+*     "In the Aqua Teen Hunger Force theme song, who calls himself the mike rula?",
+* });
+*
+* console.log(result.sourceDocuments, result.text);
+* ```
+*/
+var MultiRetrievalQAChain = class MultiRetrievalQAChain extends require_multi_route.MultiRouteChain {
+	get outputKeys() {
+		return ["result"];
+	}
+	/**
+	* @deprecated Use `fromRetrieversAndPrompts` instead
+	*/
+	static fromRetrievers(llm, retrieverNames, retrieverDescriptions, retrievers, retrieverPrompts, defaults, options) {
+		return MultiRetrievalQAChain.fromLLMAndRetrievers(llm, {
+			retrieverNames,
+			retrieverDescriptions,
+			retrievers,
+			retrieverPrompts,
+			defaults,
+			multiRetrievalChainOpts: options
+		});
+	}
+	/**
+	* A static method that creates an instance of MultiRetrievalQAChain from
+	* a BaseLanguageModel and a set of retrievers. It takes in optional
+	* parameters for the retriever names, descriptions, prompts, defaults,
+	* and additional options. It is an alternative method to fromRetrievers
+	* and provides more flexibility in configuring the underlying chains.
+	* @param llm A BaseLanguageModel instance.
+	* @param retrieverNames An array of retriever names.
+	* @param retrieverDescriptions An array of retriever descriptions.
+	* @param retrievers An array of BaseRetrieverInterface instances.
+	* @param retrieverPrompts An optional array of PromptTemplate instances for the retrievers.
+	* @param defaults An optional MultiRetrievalDefaults instance.
+	* @param multiRetrievalChainOpts Additional optional parameters for the multi-retrieval chain.
+	* @param retrievalQAChainOpts Additional optional parameters for the retrieval QA chain.
+	* @returns A new instance of MultiRetrievalQAChain.
+	*/
+	static fromLLMAndRetrievers(llm, { retrieverNames, retrieverDescriptions, retrievers, retrieverPrompts, defaults, multiRetrievalChainOpts, retrievalQAChainOpts }) {
+		const { defaultRetriever, defaultPrompt, defaultChain } = defaults ?? {};
+		if (defaultPrompt && !defaultRetriever) throw new Error("`default_retriever` must be specified if `default_prompt` is \nprovided. Received only `default_prompt`.");
+		const destinations = require_utils.zipEntries(retrieverNames, retrieverDescriptions).map(([name, desc]) => `${name}: ${desc}`);
+		const structuredOutputParserSchema = zod_v3.z.object({
+			destination: zod_v3.z.string().optional().describe("name of the question answering system to use or \"DEFAULT\""),
+			next_inputs: zod_v3.z.object({ query: zod_v3.z.string().describe("a potentially modified version of the original input") }).describe("input to be fed to the next model")
+		});
+		const outputParser = new require_router.RouterOutputParser(structuredOutputParserSchema);
+		const destinationsStr = destinations.join("\n");
+		const routerTemplate = (0, __langchain_core_prompts.interpolateFString)(require_multi_retrieval_prompt.STRUCTURED_MULTI_RETRIEVAL_ROUTER_TEMPLATE(outputParser.getFormatInstructions({ interpolationDepth: 4 })), { destinations: destinationsStr });
+		const routerPrompt = new __langchain_core_prompts.PromptTemplate({
+			template: routerTemplate,
+			inputVariables: ["input"],
+			outputParser
+		});
+		const routerChain = require_llm_router.LLMRouterChain.fromLLM(llm, routerPrompt);
+		const prompts = retrieverPrompts ?? retrievers.map(() => null);
+		const destinationChains = require_utils.zipEntries(retrieverNames, retrievers, prompts).reduce((acc, [name, retriever, prompt]) => {
+			const opt = retrievalQAChainOpts ?? {};
+			if (prompt) opt.prompt = prompt;
+			acc[name] = require_retrieval_qa.RetrievalQAChain.fromLLM(llm, retriever, opt);
+			return acc;
+		}, {});
+		let _defaultChain;
+		if (defaultChain) _defaultChain = defaultChain;
+		else if (defaultRetriever) _defaultChain = require_retrieval_qa.RetrievalQAChain.fromLLM(llm, defaultRetriever, {
+			...retrievalQAChainOpts,
+			prompt: defaultPrompt
+		});
+		else {
+			const promptTemplate = require_conversation.DEFAULT_TEMPLATE.replace("input", "query");
+			const prompt = new __langchain_core_prompts.PromptTemplate({
+				template: promptTemplate,
+				inputVariables: ["history", "query"]
+			});
+			_defaultChain = new require_conversation.ConversationChain({
+				llm,
+				prompt,
+				outputKey: "result"
+			});
+		}
+		return new MultiRetrievalQAChain({
+			...multiRetrievalChainOpts,
+			routerChain,
+			destinationChains,
+			defaultChain: _defaultChain
+		});
+	}
+	_chainType() {
+		return "multi_retrieval_qa_chain";
+	}
+};
+
+//#endregion
+exports.MultiRetrievalQAChain = MultiRetrievalQAChain;
+//# sourceMappingURL=multi_retrieval_qa.cjs.map

package/dist/chains/router/multi_retrieval_qa.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"multi_retrieval_qa.cjs","names":["MultiRouteChain","llm: BaseLanguageModelInterface","retrieverNames: string[]","retrieverDescriptions: string[]","retrievers: BaseRetrieverInterface[]","retrieverPrompts?: PromptTemplate[]","defaults?: MultiRetrievalDefaults","options?: Omit<MultiRouteChainInput, \"defaultChain\">","zipEntries","z","RouterOutputParser","STRUCTURED_MULTI_RETRIEVAL_ROUTER_TEMPLATE","PromptTemplate","LLMRouterChain","opt: Partial<RetrievalQAChainInput> & {\n          prompt?: PromptTemplate;\n        }","RetrievalQAChain","DEFAULT_TEMPLATE","ConversationChain"],"sources":["../../../src/chains/router/multi_retrieval_qa.ts"],"sourcesContent":["import { z } from \"zod/v3\";\nimport type { BaseLanguageModelInterface } from \"@langchain/core/language_models/base\";\nimport type { BaseRetrieverInterface } from \"@langchain/core/retrievers\";\nimport { interpolateFString, PromptTemplate } from \"@langchain/core/prompts\";\nimport { MultiRouteChain, MultiRouteChainInput } from \"./multi_route.js\";\nimport { BaseChain } from \"../../chains/base.js\";\nimport { LLMRouterChain } from \"./llm_router.js\";\nimport {\n  ConversationChain,\n  DEFAULT_TEMPLATE,\n} from \"../../chains/conversation.js\";\nimport { STRUCTURED_MULTI_RETRIEVAL_ROUTER_TEMPLATE } from \"./multi_retrieval_prompt.js\";\nimport { zipEntries } from \"./utils.js\";\nimport {\n  RetrievalQAChain,\n  RetrievalQAChainInput,\n} from \"../../chains/retrieval_qa.js\";\nimport { RouterOutputParser } from \"../../output_parsers/router.js\";\n\n/**\n * A type that represents the default values for the MultiRetrievalQAChain\n * class. It includes optional properties for the default retriever,\n * default prompt, and default chain.\n */\nexport type MultiRetrievalDefaults = {\n  defaultRetriever?: BaseRetrieverInterface;\n  defaultPrompt?: PromptTemplate;\n  defaultChain?: BaseChain;\n};\n\n/**\n * A class that represents a multi-retrieval question answering chain in\n * the LangChain framework. It extends the MultiRouteChain class and\n * provides additional functionality specific to multi-retrieval QA\n * chains.\n * @example\n * ```typescript\n * const multiRetrievalQAChain = MultiRetrievalQAChain.fromLLMAndRetrievers(\n *   new ChatOpenAI({ model: \"gpt-4o-mini\" }),\n *   {\n *     retrieverNames: [\"aqua teen\", \"mst3k\", \"animaniacs\"],\n *     retrieverDescriptions: [\n *       \"Good for answering questions about Aqua Teen Hunger Force theme song\",\n *       \"Good for answering questions about Mystery Science Theater 3000 theme song\",\n *       \"Good for answering questions about Animaniacs theme song\",\n *     ],\n *     retrievers: [\n *       new MemoryVectorStore().asRetriever(3),\n *       new MemoryVectorStore().asRetriever(3),\n *       new MemoryVectorStore().asRetriever(3),\n *     ],\n *     retrievalQAChainOpts: {\n *       returnSourceDocuments: true,\n *     },\n *   },\n * );\n *\n * const result = await multiRetrievalQAChain.call({\n *   input:\n *     \"In the Aqua Teen Hunger Force theme song, who calls himself the mike rula?\",\n * });\n *\n * console.log(result.sourceDocuments, result.text);\n * ```\n */\nexport class MultiRetrievalQAChain extends MultiRouteChain {\n  get outputKeys(): string[] {\n    return [\"result\"];\n  }\n\n  /**\n   * @deprecated Use `fromRetrieversAndPrompts` instead\n   */\n  static fromRetrievers(\n    llm: BaseLanguageModelInterface,\n    retrieverNames: string[],\n    retrieverDescriptions: string[],\n    retrievers: BaseRetrieverInterface[],\n    retrieverPrompts?: PromptTemplate[],\n    defaults?: MultiRetrievalDefaults,\n    options?: Omit<MultiRouteChainInput, \"defaultChain\">\n  ) {\n    return MultiRetrievalQAChain.fromLLMAndRetrievers(llm, {\n      retrieverNames,\n      retrieverDescriptions,\n      retrievers,\n      retrieverPrompts,\n      defaults,\n      multiRetrievalChainOpts: options,\n    });\n  }\n\n  /**\n   * A static method that creates an instance of MultiRetrievalQAChain from\n   * a BaseLanguageModel and a set of retrievers. It takes in optional\n   * parameters for the retriever names, descriptions, prompts, defaults,\n   * and additional options. It is an alternative method to fromRetrievers\n   * and provides more flexibility in configuring the underlying chains.\n   * @param llm A BaseLanguageModel instance.\n   * @param retrieverNames An array of retriever names.\n   * @param retrieverDescriptions An array of retriever descriptions.\n   * @param retrievers An array of BaseRetrieverInterface instances.\n   * @param retrieverPrompts An optional array of PromptTemplate instances for the retrievers.\n   * @param defaults An optional MultiRetrievalDefaults instance.\n   * @param multiRetrievalChainOpts Additional optional parameters for the multi-retrieval chain.\n   * @param retrievalQAChainOpts Additional optional parameters for the retrieval QA chain.\n   * @returns A new instance of MultiRetrievalQAChain.\n   */\n  static fromLLMAndRetrievers(\n    llm: BaseLanguageModelInterface,\n    {\n      retrieverNames,\n      retrieverDescriptions,\n      retrievers,\n      retrieverPrompts,\n      defaults,\n      multiRetrievalChainOpts,\n      retrievalQAChainOpts,\n    }: {\n      retrieverNames: string[];\n      retrieverDescriptions: string[];\n      retrievers: BaseRetrieverInterface[];\n      retrieverPrompts?: PromptTemplate[];\n      defaults?: MultiRetrievalDefaults;\n      multiRetrievalChainOpts?: Omit<MultiRouteChainInput, \"defaultChain\">;\n      retrievalQAChainOpts?: Partial<\n        Omit<RetrievalQAChainInput, \"retriever\" | \"combineDocumentsChain\">\n      > & {\n        prompt?: PromptTemplate;\n      };\n    }\n  ): MultiRetrievalQAChain {\n    const { defaultRetriever, defaultPrompt, defaultChain } = defaults ?? {};\n    if (defaultPrompt && !defaultRetriever) {\n      throw new Error(\n        \"`default_retriever` must be specified if `default_prompt` is \\nprovided. Received only `default_prompt`.\"\n      );\n    }\n    const destinations = zipEntries<[string, string]>(\n      retrieverNames,\n      retrieverDescriptions\n    ).map(([name, desc]) => `${name}: ${desc}`);\n\n    const structuredOutputParserSchema = z.object({\n      destination: z\n        .string()\n        .optional()\n        .describe('name of the question answering system to use or \"DEFAULT\"'),\n      next_inputs: z\n        .object({\n          query: z\n            .string()\n            .describe(\"a potentially modified version of the original input\"),\n        })\n        .describe(\"input to be fed to the next model\"),\n    });\n\n    const outputParser = new RouterOutputParser<\n      typeof structuredOutputParserSchema\n    >(structuredOutputParserSchema);\n\n    const destinationsStr = destinations.join(\"\\n\");\n    const routerTemplate = interpolateFString(\n      STRUCTURED_MULTI_RETRIEVAL_ROUTER_TEMPLATE(\n        outputParser.getFormatInstructions({ interpolationDepth: 4 })\n      ),\n      {\n        destinations: destinationsStr,\n      }\n    );\n    const routerPrompt = new PromptTemplate({\n      template: routerTemplate,\n      inputVariables: [\"input\"],\n      outputParser,\n    });\n\n    const routerChain = LLMRouterChain.fromLLM(llm, routerPrompt);\n    const prompts = retrieverPrompts ?? retrievers.map(() => null);\n    const destinationChains = zipEntries<\n      [string, BaseRetrieverInterface, PromptTemplate | null]\n    >(retrieverNames, retrievers, prompts).reduce(\n      (acc, [name, retriever, prompt]) => {\n        const opt: Partial<RetrievalQAChainInput> & {\n          prompt?: PromptTemplate;\n        } = retrievalQAChainOpts ?? {};\n        if (prompt) {\n          opt.prompt = prompt;\n        }\n        acc[name] = RetrievalQAChain.fromLLM(llm, retriever, opt);\n        return acc;\n      },\n      {} as { [name: string]: RetrievalQAChain }\n    );\n\n    let _defaultChain;\n    if (defaultChain) {\n      _defaultChain = defaultChain;\n    } else if (defaultRetriever) {\n      _defaultChain = RetrievalQAChain.fromLLM(llm, defaultRetriever, {\n        ...retrievalQAChainOpts,\n        prompt: defaultPrompt,\n      });\n    } else {\n      const promptTemplate = DEFAULT_TEMPLATE.replace(\"input\", \"query\");\n      const prompt = new PromptTemplate({\n        template: promptTemplate,\n        inputVariables: [\"history\", \"query\"],\n      });\n      _defaultChain = new ConversationChain({\n        llm,\n        prompt,\n        outputKey: \"result\",\n      });\n    }\n\n    return new MultiRetrievalQAChain({\n      ...multiRetrievalChainOpts,\n      routerChain,\n      destinationChains,\n      defaultChain: _defaultChain,\n    });\n  }\n\n  _chainType(): string {\n    return \"multi_retrieval_qa_chain\";\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiEA,IAAa,wBAAb,MAAa,8BAA8BA,oCAAgB;CACzD,IAAI,aAAuB;AACzB,SAAO,CAAC,QAAS;CAClB;;;;CAKD,OAAO,eACLC,KACAC,gBACAC,uBACAC,YACAC,kBACAC,UACAC,SACA;AACA,SAAO,sBAAsB,qBAAqB,KAAK;GACrD;GACA;GACA;GACA;GACA;GACA,yBAAyB;EAC1B,EAAC;CACH;;;;;;;;;;;;;;;;;CAkBD,OAAO,qBACLN,KACA,EACE,gBACA,uBACA,YACA,kBACA,UACA,yBACA,sBAaD,EACsB;EACvB,MAAM,EAAE,kBAAkB,eAAe,cAAc,GAAG,YAAY,CAAE;AACxE,MAAI,iBAAiB,CAAC,iBACpB,OAAM,IAAI,MACR;EAGJ,MAAM,eAAeO,yBACnB,gBACA,sBACD,CAAC,IAAI,CAAC,CAAC,MAAM,KAAK,KAAK,GAAG,KAAK,EAAE,EAAE,MAAM,CAAC;EAE3C,MAAM,+BAA+BC,SAAE,OAAO;GAC5C,aAAaA,SACV,QAAQ,CACR,UAAU,CACV,SAAS,8DAA4D;GACxE,aAAaA,SACV,OAAO,EACN,OAAOA,SACJ,QAAQ,CACR,SAAS,uDAAuD,CACpE,EAAC,CACD,SAAS,oCAAoC;EACjD,EAAC;EAEF,MAAM,eAAe,IAAIC,kCAEvB;EAEF,MAAM,kBAAkB,aAAa,KAAK,KAAK;EAC/C,MAAM,kEACJC,0EACE,aAAa,sBAAsB,EAAE,oBAAoB,EAAG,EAAC,CAC9D,EACD,EACE,cAAc,gBACf,EACF;EACD,MAAM,eAAe,IAAIC,wCAAe;GACtC,UAAU;GACV,gBAAgB,CAAC,OAAQ;GACzB;EACD;EAED,MAAM,cAAcC,kCAAe,QAAQ,KAAK,aAAa;EAC7D,MAAM,UAAU,oBAAoB,WAAW,IAAI,MAAM,KAAK;EAC9D,MAAM,oBAAoBL,yBAExB,gBAAgB,YAAY,QAAQ,CAAC,OACrC,CAAC,KAAK,CAAC,MAAM,WAAW,OAAO,KAAK;GAClC,MAAMM,MAEF,wBAAwB,CAAE;AAC9B,OAAI,QACF,IAAI,SAAS;GAEf,IAAI,QAAQC,sCAAiB,QAAQ,KAAK,WAAW,IAAI;AACzD,UAAO;EACR,GACD,CAAE,EACH;EAED,IAAI;AACJ,MAAI,cACF,gBAAgB;WACP,kBACT,gBAAgBA,sCAAiB,QAAQ,KAAK,kBAAkB;GAC9D,GAAG;GACH,QAAQ;EACT,EAAC;OACG;GACL,MAAM,iBAAiBC,sCAAiB,QAAQ,SAAS,QAAQ;GACjE,MAAM,SAAS,IAAIJ,wCAAe;IAChC,UAAU;IACV,gBAAgB,CAAC,WAAW,OAAQ;GACrC;GACD,gBAAgB,IAAIK,uCAAkB;IACpC;IACA;IACA,WAAW;GACZ;EACF;AAED,SAAO,IAAI,sBAAsB;GAC/B,GAAG;GACH;GACA;GACA,cAAc;EACf;CACF;CAED,aAAqB;AACnB,SAAO;CACR;AACF"}

package/dist/chains/router/multi_retrieval_qa.d.cts

@@ -0,0 +1,100 @@
+import { BaseChain } from "../base.cjs";
+import { RetrievalQAChainInput } from "../retrieval_qa.cjs";
+import { MultiRouteChain, MultiRouteChainInput } from "./multi_route.cjs";
+import { PromptTemplate } from "@langchain/core/prompts";
+import { BaseLanguageModelInterface } from "@langchain/core/language_models/base";
+import { BaseRetrieverInterface } from "@langchain/core/retrievers";
+
+//#region src/chains/router/multi_retrieval_qa.d.ts
+
+/**
+ * A type that represents the default values for the MultiRetrievalQAChain
+ * class. It includes optional properties for the default retriever,
+ * default prompt, and default chain.
+ */
+type MultiRetrievalDefaults = {
+  defaultRetriever?: BaseRetrieverInterface;
+  defaultPrompt?: PromptTemplate;
+  defaultChain?: BaseChain;
+};
+/**
+ * A class that represents a multi-retrieval question answering chain in
+ * the LangChain framework. It extends the MultiRouteChain class and
+ * provides additional functionality specific to multi-retrieval QA
+ * chains.
+ * @example
+ * ```typescript
+ * const multiRetrievalQAChain = MultiRetrievalQAChain.fromLLMAndRetrievers(
+ *   new ChatOpenAI({ model: "gpt-4o-mini" }),
+ *   {
+ *     retrieverNames: ["aqua teen", "mst3k", "animaniacs"],
+ *     retrieverDescriptions: [
+ *       "Good for answering questions about Aqua Teen Hunger Force theme song",
+ *       "Good for answering questions about Mystery Science Theater 3000 theme song",
+ *       "Good for answering questions about Animaniacs theme song",
+ *     ],
+ *     retrievers: [
+ *       new MemoryVectorStore().asRetriever(3),
+ *       new MemoryVectorStore().asRetriever(3),
+ *       new MemoryVectorStore().asRetriever(3),
+ *     ],
+ *     retrievalQAChainOpts: {
+ *       returnSourceDocuments: true,
+ *     },
+ *   },
+ * );
+ *
+ * const result = await multiRetrievalQAChain.call({
+ *   input:
+ *     "In the Aqua Teen Hunger Force theme song, who calls himself the mike rula?",
+ * });
+ *
+ * console.log(result.sourceDocuments, result.text);
+ * ```
+ */
+declare class MultiRetrievalQAChain extends MultiRouteChain {
+  get outputKeys(): string[];
+  /**
+   * @deprecated Use `fromRetrieversAndPrompts` instead
+   */
+  static fromRetrievers(llm: BaseLanguageModelInterface, retrieverNames: string[], retrieverDescriptions: string[], retrievers: BaseRetrieverInterface[], retrieverPrompts?: PromptTemplate[], defaults?: MultiRetrievalDefaults, options?: Omit<MultiRouteChainInput, "defaultChain">): MultiRetrievalQAChain;
+  /**
+   * A static method that creates an instance of MultiRetrievalQAChain from
+   * a BaseLanguageModel and a set of retrievers. It takes in optional
+   * parameters for the retriever names, descriptions, prompts, defaults,
+   * and additional options. It is an alternative method to fromRetrievers
+   * and provides more flexibility in configuring the underlying chains.
+   * @param llm A BaseLanguageModel instance.
+   * @param retrieverNames An array of retriever names.
+   * @param retrieverDescriptions An array of retriever descriptions.
+   * @param retrievers An array of BaseRetrieverInterface instances.
+   * @param retrieverPrompts An optional array of PromptTemplate instances for the retrievers.
+   * @param defaults An optional MultiRetrievalDefaults instance.
+   * @param multiRetrievalChainOpts Additional optional parameters for the multi-retrieval chain.
+   * @param retrievalQAChainOpts Additional optional parameters for the retrieval QA chain.
+   * @returns A new instance of MultiRetrievalQAChain.
+   */
+  static fromLLMAndRetrievers(llm: BaseLanguageModelInterface, {
+    retrieverNames,
+    retrieverDescriptions,
+    retrievers,
+    retrieverPrompts,
+    defaults,
+    multiRetrievalChainOpts,
+    retrievalQAChainOpts
+  }: {
+    retrieverNames: string[];
+    retrieverDescriptions: string[];
+    retrievers: BaseRetrieverInterface[];
+    retrieverPrompts?: PromptTemplate[];
+    defaults?: MultiRetrievalDefaults;
+    multiRetrievalChainOpts?: Omit<MultiRouteChainInput, "defaultChain">;
+    retrievalQAChainOpts?: Partial<Omit<RetrievalQAChainInput, "retriever" | "combineDocumentsChain">> & {
+      prompt?: PromptTemplate;
+    };
+  }): MultiRetrievalQAChain;
+  _chainType(): string;
+}
+//#endregion
+export { MultiRetrievalQAChain };
+//# sourceMappingURL=multi_retrieval_qa.d.cts.map

package/dist/chains/router/multi_retrieval_qa.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"multi_retrieval_qa.d.cts","names":["BaseLanguageModelInterface","BaseRetrieverInterface","PromptTemplate","MultiRouteChain","MultiRouteChainInput","BaseChain","RetrievalQAChainInput","MultiRetrievalDefaults","MultiRetrievalQAChain","Omit","retrieverNames","retrieverDescriptions","retrievers","retrieverPrompts","defaults","multiRetrievalChainOpts","retrievalQAChainOpts","Partial"],"sources":["../../../src/chains/router/multi_retrieval_qa.d.ts"],"sourcesContent":["import type { BaseLanguageModelInterface } from \"@langchain/core/language_models/base\";\nimport type { BaseRetrieverInterface } from \"@langchain/core/retrievers\";\nimport { PromptTemplate } from \"@langchain/core/prompts\";\nimport { MultiRouteChain, MultiRouteChainInput } from \"./multi_route.js\";\nimport { BaseChain } from \"../../chains/base.js\";\nimport { RetrievalQAChainInput } from \"../../chains/retrieval_qa.js\";\n/**\n * A type that represents the default values for the MultiRetrievalQAChain\n * class. It includes optional properties for the default retriever,\n * default prompt, and default chain.\n */\nexport type MultiRetrievalDefaults = {\n    defaultRetriever?: BaseRetrieverInterface;\n    defaultPrompt?: PromptTemplate;\n    defaultChain?: BaseChain;\n};\n/**\n * A class that represents a multi-retrieval question answering chain in\n * the LangChain framework. It extends the MultiRouteChain class and\n * provides additional functionality specific to multi-retrieval QA\n * chains.\n * @example\n * ```typescript\n * const multiRetrievalQAChain = MultiRetrievalQAChain.fromLLMAndRetrievers(\n *   new ChatOpenAI({ model: \"gpt-4o-mini\" }),\n *   {\n *     retrieverNames: [\"aqua teen\", \"mst3k\", \"animaniacs\"],\n *     retrieverDescriptions: [\n *       \"Good for answering questions about Aqua Teen Hunger Force theme song\",\n *       \"Good for answering questions about Mystery Science Theater 3000 theme song\",\n *       \"Good for answering questions about Animaniacs theme song\",\n *     ],\n *     retrievers: [\n *       new MemoryVectorStore().asRetriever(3),\n *       new MemoryVectorStore().asRetriever(3),\n *       new MemoryVectorStore().asRetriever(3),\n *     ],\n *     retrievalQAChainOpts: {\n *       returnSourceDocuments: true,\n *     },\n *   },\n * );\n *\n * const result = await multiRetrievalQAChain.call({\n *   input:\n *     \"In the Aqua Teen Hunger Force theme song, who calls himself the mike rula?\",\n * });\n *\n * console.log(result.sourceDocuments, result.text);\n * ```\n */\nexport declare class MultiRetrievalQAChain extends MultiRouteChain {\n    get outputKeys(): string[];\n    /**\n     * @deprecated Use `fromRetrieversAndPrompts` instead\n     */\n    static fromRetrievers(llm: BaseLanguageModelInterface, retrieverNames: string[], retrieverDescriptions: string[], retrievers: BaseRetrieverInterface[], retrieverPrompts?: PromptTemplate[], defaults?: MultiRetrievalDefaults, options?: Omit<MultiRouteChainInput, \"defaultChain\">): MultiRetrievalQAChain;\n    /**\n     * A static method that creates an instance of MultiRetrievalQAChain from\n     * a BaseLanguageModel and a set of retrievers. It takes in optional\n     * parameters for the retriever names, descriptions, prompts, defaults,\n     * and additional options. It is an alternative method to fromRetrievers\n     * and provides more flexibility in configuring the underlying chains.\n     * @param llm A BaseLanguageModel instance.\n     * @param retrieverNames An array of retriever names.\n     * @param retrieverDescriptions An array of retriever descriptions.\n     * @param retrievers An array of BaseRetrieverInterface instances.\n     * @param retrieverPrompts An optional array of PromptTemplate instances for the retrievers.\n     * @param defaults An optional MultiRetrievalDefaults instance.\n     * @param multiRetrievalChainOpts Additional optional parameters for the multi-retrieval chain.\n     * @param retrievalQAChainOpts Additional optional parameters for the retrieval QA chain.\n     * @returns A new instance of MultiRetrievalQAChain.\n     */\n    static fromLLMAndRetrievers(llm: BaseLanguageModelInterface, { retrieverNames, retrieverDescriptions, retrievers, retrieverPrompts, defaults, multiRetrievalChainOpts, retrievalQAChainOpts }: {\n        retrieverNames: string[];\n        retrieverDescriptions: string[];\n        retrievers: BaseRetrieverInterface[];\n        retrieverPrompts?: PromptTemplate[];\n        defaults?: MultiRetrievalDefaults;\n        multiRetrievalChainOpts?: Omit<MultiRouteChainInput, \"defaultChain\">;\n        retrievalQAChainOpts?: Partial<Omit<RetrievalQAChainInput, \"retriever\" | \"combineDocumentsChain\">> & {\n            prompt?: PromptTemplate;\n        };\n    }): MultiRetrievalQAChain;\n    _chainType(): string;\n}\n"],"mappings":";;;;;;;;;;;AAWA;;;AAEoBE,KAFRK,sBAAAA,GAEQL;EAAc,gBACfG,CAAAA,EAFIJ,sBAEJI;EAAS,aAAA,CAAA,EADRH,cACQ;EAqCPM,YAAAA,CAAAA,EArCFH,SAqCuB;CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAwB;;;;;;;;;cAA7CG,qBAAAA,SAA8BL,eAAAA;;;;;6BAKpBH,mGAAmGC,6CAA6CC,6BAA6BK,kCAAkCE,KAAKL,wCAAwCI;;;;;;;;;;;;;;;;;mCAiBtPR;;;;;;;;;;;gBAGjBC;uBACOC;eACRK;8BACeE,KAAKL;2BACRa,QAAQR,KAAKH;eACvBJ;;MAEbM"}

package/dist/chains/router/multi_retrieval_qa.d.ts

@@ -0,0 +1,100 @@
+import { BaseChain } from "../base.js";
+import { RetrievalQAChainInput } from "../retrieval_qa.js";
+import { MultiRouteChain, MultiRouteChainInput } from "./multi_route.js";
+import { PromptTemplate } from "@langchain/core/prompts";
+import { BaseLanguageModelInterface } from "@langchain/core/language_models/base";
+import { BaseRetrieverInterface } from "@langchain/core/retrievers";
+
+//#region src/chains/router/multi_retrieval_qa.d.ts
+
+/**
+ * A type that represents the default values for the MultiRetrievalQAChain
+ * class. It includes optional properties for the default retriever,
+ * default prompt, and default chain.
+ */
+type MultiRetrievalDefaults = {
+  defaultRetriever?: BaseRetrieverInterface;
+  defaultPrompt?: PromptTemplate;
+  defaultChain?: BaseChain;
+};
+/**
+ * A class that represents a multi-retrieval question answering chain in
+ * the LangChain framework. It extends the MultiRouteChain class and
+ * provides additional functionality specific to multi-retrieval QA
+ * chains.
+ * @example
+ * ```typescript
+ * const multiRetrievalQAChain = MultiRetrievalQAChain.fromLLMAndRetrievers(
+ *   new ChatOpenAI({ model: "gpt-4o-mini" }),
+ *   {
+ *     retrieverNames: ["aqua teen", "mst3k", "animaniacs"],
+ *     retrieverDescriptions: [
+ *       "Good for answering questions about Aqua Teen Hunger Force theme song",
+ *       "Good for answering questions about Mystery Science Theater 3000 theme song",
+ *       "Good for answering questions about Animaniacs theme song",
+ *     ],
+ *     retrievers: [
+ *       new MemoryVectorStore().asRetriever(3),
+ *       new MemoryVectorStore().asRetriever(3),
+ *       new MemoryVectorStore().asRetriever(3),
+ *     ],
+ *     retrievalQAChainOpts: {
+ *       returnSourceDocuments: true,
+ *     },
+ *   },
+ * );
+ *
+ * const result = await multiRetrievalQAChain.call({
+ *   input:
+ *     "In the Aqua Teen Hunger Force theme song, who calls himself the mike rula?",
+ * });
+ *
+ * console.log(result.sourceDocuments, result.text);
+ * ```
+ */
+declare class MultiRetrievalQAChain extends MultiRouteChain {
+  get outputKeys(): string[];
+  /**
+   * @deprecated Use `fromRetrieversAndPrompts` instead
+   */
+  static fromRetrievers(llm: BaseLanguageModelInterface, retrieverNames: string[], retrieverDescriptions: string[], retrievers: BaseRetrieverInterface[], retrieverPrompts?: PromptTemplate[], defaults?: MultiRetrievalDefaults, options?: Omit<MultiRouteChainInput, "defaultChain">): MultiRetrievalQAChain;
+  /**
+   * A static method that creates an instance of MultiRetrievalQAChain from
+   * a BaseLanguageModel and a set of retrievers. It takes in optional
+   * parameters for the retriever names, descriptions, prompts, defaults,
+   * and additional options. It is an alternative method to fromRetrievers
+   * and provides more flexibility in configuring the underlying chains.
+   * @param llm A BaseLanguageModel instance.
+   * @param retrieverNames An array of retriever names.
+   * @param retrieverDescriptions An array of retriever descriptions.
+   * @param retrievers An array of BaseRetrieverInterface instances.
+   * @param retrieverPrompts An optional array of PromptTemplate instances for the retrievers.
+   * @param defaults An optional MultiRetrievalDefaults instance.
+   * @param multiRetrievalChainOpts Additional optional parameters for the multi-retrieval chain.
+   * @param retrievalQAChainOpts Additional optional parameters for the retrieval QA chain.
+   * @returns A new instance of MultiRetrievalQAChain.
+   */
+  static fromLLMAndRetrievers(llm: BaseLanguageModelInterface, {
+    retrieverNames,
+    retrieverDescriptions,
+    retrievers,
+    retrieverPrompts,
+    defaults,
+    multiRetrievalChainOpts,
+    retrievalQAChainOpts
+  }: {
+    retrieverNames: string[];
+    retrieverDescriptions: string[];
+    retrievers: BaseRetrieverInterface[];
+    retrieverPrompts?: PromptTemplate[];
+    defaults?: MultiRetrievalDefaults;
+    multiRetrievalChainOpts?: Omit<MultiRouteChainInput, "defaultChain">;
+    retrievalQAChainOpts?: Partial<Omit<RetrievalQAChainInput, "retriever" | "combineDocumentsChain">> & {
+      prompt?: PromptTemplate;
+    };
+  }): MultiRetrievalQAChain;
+  _chainType(): string;
+}
+//#endregion
+export { MultiRetrievalQAChain };
+//# sourceMappingURL=multi_retrieval_qa.d.ts.map

package/dist/chains/router/multi_retrieval_qa.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"multi_retrieval_qa.d.ts","names":["BaseLanguageModelInterface","BaseRetrieverInterface","PromptTemplate","MultiRouteChain","MultiRouteChainInput","BaseChain","RetrievalQAChainInput","MultiRetrievalDefaults","MultiRetrievalQAChain","Omit","retrieverNames","retrieverDescriptions","retrievers","retrieverPrompts","defaults","multiRetrievalChainOpts","retrievalQAChainOpts","Partial"],"sources":["../../../src/chains/router/multi_retrieval_qa.d.ts"],"sourcesContent":["import type { BaseLanguageModelInterface } from \"@langchain/core/language_models/base\";\nimport type { BaseRetrieverInterface } from \"@langchain/core/retrievers\";\nimport { PromptTemplate } from \"@langchain/core/prompts\";\nimport { MultiRouteChain, MultiRouteChainInput } from \"./multi_route.js\";\nimport { BaseChain } from \"../../chains/base.js\";\nimport { RetrievalQAChainInput } from \"../../chains/retrieval_qa.js\";\n/**\n * A type that represents the default values for the MultiRetrievalQAChain\n * class. It includes optional properties for the default retriever,\n * default prompt, and default chain.\n */\nexport type MultiRetrievalDefaults = {\n    defaultRetriever?: BaseRetrieverInterface;\n    defaultPrompt?: PromptTemplate;\n    defaultChain?: BaseChain;\n};\n/**\n * A class that represents a multi-retrieval question answering chain in\n * the LangChain framework. It extends the MultiRouteChain class and\n * provides additional functionality specific to multi-retrieval QA\n * chains.\n * @example\n * ```typescript\n * const multiRetrievalQAChain = MultiRetrievalQAChain.fromLLMAndRetrievers(\n *   new ChatOpenAI({ model: \"gpt-4o-mini\" }),\n *   {\n *     retrieverNames: [\"aqua teen\", \"mst3k\", \"animaniacs\"],\n *     retrieverDescriptions: [\n *       \"Good for answering questions about Aqua Teen Hunger Force theme song\",\n *       \"Good for answering questions about Mystery Science Theater 3000 theme song\",\n *       \"Good for answering questions about Animaniacs theme song\",\n *     ],\n *     retrievers: [\n *       new MemoryVectorStore().asRetriever(3),\n *       new MemoryVectorStore().asRetriever(3),\n *       new MemoryVectorStore().asRetriever(3),\n *     ],\n *     retrievalQAChainOpts: {\n *       returnSourceDocuments: true,\n *     },\n *   },\n * );\n *\n * const result = await multiRetrievalQAChain.call({\n *   input:\n *     \"In the Aqua Teen Hunger Force theme song, who calls himself the mike rula?\",\n * });\n *\n * console.log(result.sourceDocuments, result.text);\n * ```\n */\nexport declare class MultiRetrievalQAChain extends MultiRouteChain {\n    get outputKeys(): string[];\n    /**\n     * @deprecated Use `fromRetrieversAndPrompts` instead\n     */\n    static fromRetrievers(llm: BaseLanguageModelInterface, retrieverNames: string[], retrieverDescriptions: string[], retrievers: BaseRetrieverInterface[], retrieverPrompts?: PromptTemplate[], defaults?: MultiRetrievalDefaults, options?: Omit<MultiRouteChainInput, \"defaultChain\">): MultiRetrievalQAChain;\n    /**\n     * A static method that creates an instance of MultiRetrievalQAChain from\n     * a BaseLanguageModel and a set of retrievers. It takes in optional\n     * parameters for the retriever names, descriptions, prompts, defaults,\n     * and additional options. It is an alternative method to fromRetrievers\n     * and provides more flexibility in configuring the underlying chains.\n     * @param llm A BaseLanguageModel instance.\n     * @param retrieverNames An array of retriever names.\n     * @param retrieverDescriptions An array of retriever descriptions.\n     * @param retrievers An array of BaseRetrieverInterface instances.\n     * @param retrieverPrompts An optional array of PromptTemplate instances for the retrievers.\n     * @param defaults An optional MultiRetrievalDefaults instance.\n     * @param multiRetrievalChainOpts Additional optional parameters for the multi-retrieval chain.\n     * @param retrievalQAChainOpts Additional optional parameters for the retrieval QA chain.\n     * @returns A new instance of MultiRetrievalQAChain.\n     */\n    static fromLLMAndRetrievers(llm: BaseLanguageModelInterface, { retrieverNames, retrieverDescriptions, retrievers, retrieverPrompts, defaults, multiRetrievalChainOpts, retrievalQAChainOpts }: {\n        retrieverNames: string[];\n        retrieverDescriptions: string[];\n        retrievers: BaseRetrieverInterface[];\n        retrieverPrompts?: PromptTemplate[];\n        defaults?: MultiRetrievalDefaults;\n        multiRetrievalChainOpts?: Omit<MultiRouteChainInput, \"defaultChain\">;\n        retrievalQAChainOpts?: Partial<Omit<RetrievalQAChainInput, \"retriever\" | \"combineDocumentsChain\">> & {\n            prompt?: PromptTemplate;\n        };\n    }): MultiRetrievalQAChain;\n    _chainType(): string;\n}\n"],"mappings":";;;;;;;;;;;AAWA;;;AAEoBE,KAFRK,sBAAAA,GAEQL;EAAc,gBACfG,CAAAA,EAFIJ,sBAEJI;EAAS,aAAA,CAAA,EADRH,cACQ;EAqCPM,YAAAA,CAAAA,EArCFH,SAqCuB;CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAwB;;;;;;;;;cAA7CG,qBAAAA,SAA8BL,eAAAA;;;;;6BAKpBH,mGAAmGC,6CAA6CC,6BAA6BK,kCAAkCE,KAAKL,wCAAwCI;;;;;;;;;;;;;;;;;mCAiBtPR;;;;;;;;;;;gBAGjBC;uBACOC;eACRK;8BACeE,KAAKL;2BACRa,QAAQR,KAAKH;eACvBJ;;MAEbM"}

package/dist/chains/router/multi_retrieval_qa.js

@@ -0,0 +1,136 @@
+import { ConversationChain, DEFAULT_TEMPLATE } from "../conversation.js";
+import { RetrievalQAChain } from "../retrieval_qa.js";
+import { MultiRouteChain } from "./multi_route.js";
+import { LLMRouterChain } from "./llm_router.js";
+import { zipEntries } from "./utils.js";
+import { RouterOutputParser } from "../../output_parsers/router.js";
+import { STRUCTURED_MULTI_RETRIEVAL_ROUTER_TEMPLATE } from "./multi_retrieval_prompt.js";
+import { PromptTemplate, interpolateFString } from "@langchain/core/prompts";
+import { z } from "zod/v3";
+
+//#region src/chains/router/multi_retrieval_qa.ts
+/**
+* A class that represents a multi-retrieval question answering chain in
+* the LangChain framework. It extends the MultiRouteChain class and
+* provides additional functionality specific to multi-retrieval QA
+* chains.
+* @example
+* ```typescript
+* const multiRetrievalQAChain = MultiRetrievalQAChain.fromLLMAndRetrievers(
+*   new ChatOpenAI({ model: "gpt-4o-mini" }),
+*   {
+*     retrieverNames: ["aqua teen", "mst3k", "animaniacs"],
+*     retrieverDescriptions: [
+*       "Good for answering questions about Aqua Teen Hunger Force theme song",
+*       "Good for answering questions about Mystery Science Theater 3000 theme song",
+*       "Good for answering questions about Animaniacs theme song",
+*     ],
+*     retrievers: [
+*       new MemoryVectorStore().asRetriever(3),
+*       new MemoryVectorStore().asRetriever(3),
+*       new MemoryVectorStore().asRetriever(3),
+*     ],
+*     retrievalQAChainOpts: {
+*       returnSourceDocuments: true,
+*     },
+*   },
+* );
+*
+* const result = await multiRetrievalQAChain.call({
+*   input:
+*     "In the Aqua Teen Hunger Force theme song, who calls himself the mike rula?",
+* });
+*
+* console.log(result.sourceDocuments, result.text);
+* ```
+*/
+var MultiRetrievalQAChain = class MultiRetrievalQAChain extends MultiRouteChain {
+	get outputKeys() {
+		return ["result"];
+	}
+	/**
+	* @deprecated Use `fromRetrieversAndPrompts` instead
+	*/
+	static fromRetrievers(llm, retrieverNames, retrieverDescriptions, retrievers, retrieverPrompts, defaults, options) {
+		return MultiRetrievalQAChain.fromLLMAndRetrievers(llm, {
+			retrieverNames,
+			retrieverDescriptions,
+			retrievers,
+			retrieverPrompts,
+			defaults,
+			multiRetrievalChainOpts: options
+		});
+	}
+	/**
+	* A static method that creates an instance of MultiRetrievalQAChain from
+	* a BaseLanguageModel and a set of retrievers. It takes in optional
+	* parameters for the retriever names, descriptions, prompts, defaults,
+	* and additional options. It is an alternative method to fromRetrievers
+	* and provides more flexibility in configuring the underlying chains.
+	* @param llm A BaseLanguageModel instance.
+	* @param retrieverNames An array of retriever names.
+	* @param retrieverDescriptions An array of retriever descriptions.
+	* @param retrievers An array of BaseRetrieverInterface instances.
+	* @param retrieverPrompts An optional array of PromptTemplate instances for the retrievers.
+	* @param defaults An optional MultiRetrievalDefaults instance.
+	* @param multiRetrievalChainOpts Additional optional parameters for the multi-retrieval chain.
+	* @param retrievalQAChainOpts Additional optional parameters for the retrieval QA chain.
+	* @returns A new instance of MultiRetrievalQAChain.
+	*/
+	static fromLLMAndRetrievers(llm, { retrieverNames, retrieverDescriptions, retrievers, retrieverPrompts, defaults, multiRetrievalChainOpts, retrievalQAChainOpts }) {
+		const { defaultRetriever, defaultPrompt, defaultChain } = defaults ?? {};
+		if (defaultPrompt && !defaultRetriever) throw new Error("`default_retriever` must be specified if `default_prompt` is \nprovided. Received only `default_prompt`.");
+		const destinations = zipEntries(retrieverNames, retrieverDescriptions).map(([name, desc]) => `${name}: ${desc}`);
+		const structuredOutputParserSchema = z.object({
+			destination: z.string().optional().describe("name of the question answering system to use or \"DEFAULT\""),
+			next_inputs: z.object({ query: z.string().describe("a potentially modified version of the original input") }).describe("input to be fed to the next model")
+		});
+		const outputParser = new RouterOutputParser(structuredOutputParserSchema);
+		const destinationsStr = destinations.join("\n");
+		const routerTemplate = interpolateFString(STRUCTURED_MULTI_RETRIEVAL_ROUTER_TEMPLATE(outputParser.getFormatInstructions({ interpolationDepth: 4 })), { destinations: destinationsStr });
+		const routerPrompt = new PromptTemplate({
+			template: routerTemplate,
+			inputVariables: ["input"],
+			outputParser
+		});
+		const routerChain = LLMRouterChain.fromLLM(llm, routerPrompt);
+		const prompts = retrieverPrompts ?? retrievers.map(() => null);
+		const destinationChains = zipEntries(retrieverNames, retrievers, prompts).reduce((acc, [name, retriever, prompt]) => {
+			const opt = retrievalQAChainOpts ?? {};
+			if (prompt) opt.prompt = prompt;
+			acc[name] = RetrievalQAChain.fromLLM(llm, retriever, opt);
+			return acc;
+		}, {});
+		let _defaultChain;
+		if (defaultChain) _defaultChain = defaultChain;
+		else if (defaultRetriever) _defaultChain = RetrievalQAChain.fromLLM(llm, defaultRetriever, {
+			...retrievalQAChainOpts,
+			prompt: defaultPrompt
+		});
+		else {
+			const promptTemplate = DEFAULT_TEMPLATE.replace("input", "query");
+			const prompt = new PromptTemplate({
+				template: promptTemplate,
+				inputVariables: ["history", "query"]
+			});
+			_defaultChain = new ConversationChain({
+				llm,
+				prompt,
+				outputKey: "result"
+			});
+		}
+		return new MultiRetrievalQAChain({
+			...multiRetrievalChainOpts,
+			routerChain,
+			destinationChains,
+			defaultChain: _defaultChain
+		});
+	}
+	_chainType() {
+		return "multi_retrieval_qa_chain";
+	}
+};
+
+//#endregion
+export { MultiRetrievalQAChain };
+//# sourceMappingURL=multi_retrieval_qa.js.map

package/dist/chains/router/multi_retrieval_qa.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"multi_retrieval_qa.js","names":["llm: BaseLanguageModelInterface","retrieverNames: string[]","retrieverDescriptions: string[]","retrievers: BaseRetrieverInterface[]","retrieverPrompts?: PromptTemplate[]","defaults?: MultiRetrievalDefaults","options?: Omit<MultiRouteChainInput, \"defaultChain\">","opt: Partial<RetrievalQAChainInput> & {\n          prompt?: PromptTemplate;\n        }"],"sources":["../../../src/chains/router/multi_retrieval_qa.ts"],"sourcesContent":["import { z } from \"zod/v3\";\nimport type { BaseLanguageModelInterface } from \"@langchain/core/language_models/base\";\nimport type { BaseRetrieverInterface } from \"@langchain/core/retrievers\";\nimport { interpolateFString, PromptTemplate } from \"@langchain/core/prompts\";\nimport { MultiRouteChain, MultiRouteChainInput } from \"./multi_route.js\";\nimport { BaseChain } from \"../../chains/base.js\";\nimport { LLMRouterChain } from \"./llm_router.js\";\nimport {\n  ConversationChain,\n  DEFAULT_TEMPLATE,\n} from \"../../chains/conversation.js\";\nimport { STRUCTURED_MULTI_RETRIEVAL_ROUTER_TEMPLATE } from \"./multi_retrieval_prompt.js\";\nimport { zipEntries } from \"./utils.js\";\nimport {\n  RetrievalQAChain,\n  RetrievalQAChainInput,\n} from \"../../chains/retrieval_qa.js\";\nimport { RouterOutputParser } from \"../../output_parsers/router.js\";\n\n/**\n * A type that represents the default values for the MultiRetrievalQAChain\n * class. It includes optional properties for the default retriever,\n * default prompt, and default chain.\n */\nexport type MultiRetrievalDefaults = {\n  defaultRetriever?: BaseRetrieverInterface;\n  defaultPrompt?: PromptTemplate;\n  defaultChain?: BaseChain;\n};\n\n/**\n * A class that represents a multi-retrieval question answering chain in\n * the LangChain framework. It extends the MultiRouteChain class and\n * provides additional functionality specific to multi-retrieval QA\n * chains.\n * @example\n * ```typescript\n * const multiRetrievalQAChain = MultiRetrievalQAChain.fromLLMAndRetrievers(\n *   new ChatOpenAI({ model: \"gpt-4o-mini\" }),\n *   {\n *     retrieverNames: [\"aqua teen\", \"mst3k\", \"animaniacs\"],\n *     retrieverDescriptions: [\n *       \"Good for answering questions about Aqua Teen Hunger Force theme song\",\n *       \"Good for answering questions about Mystery Science Theater 3000 theme song\",\n *       \"Good for answering questions about Animaniacs theme song\",\n *     ],\n *     retrievers: [\n *       new MemoryVectorStore().asRetriever(3),\n *       new MemoryVectorStore().asRetriever(3),\n *       new MemoryVectorStore().asRetriever(3),\n *     ],\n *     retrievalQAChainOpts: {\n *       returnSourceDocuments: true,\n *     },\n *   },\n * );\n *\n * const result = await multiRetrievalQAChain.call({\n *   input:\n *     \"In the Aqua Teen Hunger Force theme song, who calls himself the mike rula?\",\n * });\n *\n * console.log(result.sourceDocuments, result.text);\n * ```\n */\nexport class MultiRetrievalQAChain extends MultiRouteChain {\n  get outputKeys(): string[] {\n    return [\"result\"];\n  }\n\n  /**\n   * @deprecated Use `fromRetrieversAndPrompts` instead\n   */\n  static fromRetrievers(\n    llm: BaseLanguageModelInterface,\n    retrieverNames: string[],\n    retrieverDescriptions: string[],\n    retrievers: BaseRetrieverInterface[],\n    retrieverPrompts?: PromptTemplate[],\n    defaults?: MultiRetrievalDefaults,\n    options?: Omit<MultiRouteChainInput, \"defaultChain\">\n  ) {\n    return MultiRetrievalQAChain.fromLLMAndRetrievers(llm, {\n      retrieverNames,\n      retrieverDescriptions,\n      retrievers,\n      retrieverPrompts,\n      defaults,\n      multiRetrievalChainOpts: options,\n    });\n  }\n\n  /**\n   * A static method that creates an instance of MultiRetrievalQAChain from\n   * a BaseLanguageModel and a set of retrievers. It takes in optional\n   * parameters for the retriever names, descriptions, prompts, defaults,\n   * and additional options. It is an alternative method to fromRetrievers\n   * and provides more flexibility in configuring the underlying chains.\n   * @param llm A BaseLanguageModel instance.\n   * @param retrieverNames An array of retriever names.\n   * @param retrieverDescriptions An array of retriever descriptions.\n   * @param retrievers An array of BaseRetrieverInterface instances.\n   * @param retrieverPrompts An optional array of PromptTemplate instances for the retrievers.\n   * @param defaults An optional MultiRetrievalDefaults instance.\n   * @param multiRetrievalChainOpts Additional optional parameters for the multi-retrieval chain.\n   * @param retrievalQAChainOpts Additional optional parameters for the retrieval QA chain.\n   * @returns A new instance of MultiRetrievalQAChain.\n   */\n  static fromLLMAndRetrievers(\n    llm: BaseLanguageModelInterface,\n    {\n      retrieverNames,\n      retrieverDescriptions,\n      retrievers,\n      retrieverPrompts,\n      defaults,\n      multiRetrievalChainOpts,\n      retrievalQAChainOpts,\n    }: {\n      retrieverNames: string[];\n      retrieverDescriptions: string[];\n      retrievers: BaseRetrieverInterface[];\n      retrieverPrompts?: PromptTemplate[];\n      defaults?: MultiRetrievalDefaults;\n      multiRetrievalChainOpts?: Omit<MultiRouteChainInput, \"defaultChain\">;\n      retrievalQAChainOpts?: Partial<\n        Omit<RetrievalQAChainInput, \"retriever\" | \"combineDocumentsChain\">\n      > & {\n        prompt?: PromptTemplate;\n      };\n    }\n  ): MultiRetrievalQAChain {\n    const { defaultRetriever, defaultPrompt, defaultChain } = defaults ?? {};\n    if (defaultPrompt && !defaultRetriever) {\n      throw new Error(\n        \"`default_retriever` must be specified if `default_prompt` is \\nprovided. Received only `default_prompt`.\"\n      );\n    }\n    const destinations = zipEntries<[string, string]>(\n      retrieverNames,\n      retrieverDescriptions\n    ).map(([name, desc]) => `${name}: ${desc}`);\n\n    const structuredOutputParserSchema = z.object({\n      destination: z\n        .string()\n        .optional()\n        .describe('name of the question answering system to use or \"DEFAULT\"'),\n      next_inputs: z\n        .object({\n          query: z\n            .string()\n            .describe(\"a potentially modified version of the original input\"),\n        })\n        .describe(\"input to be fed to the next model\"),\n    });\n\n    const outputParser = new RouterOutputParser<\n      typeof structuredOutputParserSchema\n    >(structuredOutputParserSchema);\n\n    const destinationsStr = destinations.join(\"\\n\");\n    const routerTemplate = interpolateFString(\n      STRUCTURED_MULTI_RETRIEVAL_ROUTER_TEMPLATE(\n        outputParser.getFormatInstructions({ interpolationDepth: 4 })\n      ),\n      {\n        destinations: destinationsStr,\n      }\n    );\n    const routerPrompt = new PromptTemplate({\n      template: routerTemplate,\n      inputVariables: [\"input\"],\n      outputParser,\n    });\n\n    const routerChain = LLMRouterChain.fromLLM(llm, routerPrompt);\n    const prompts = retrieverPrompts ?? retrievers.map(() => null);\n    const destinationChains = zipEntries<\n      [string, BaseRetrieverInterface, PromptTemplate | null]\n    >(retrieverNames, retrievers, prompts).reduce(\n      (acc, [name, retriever, prompt]) => {\n        const opt: Partial<RetrievalQAChainInput> & {\n          prompt?: PromptTemplate;\n        } = retrievalQAChainOpts ?? {};\n        if (prompt) {\n          opt.prompt = prompt;\n        }\n        acc[name] = RetrievalQAChain.fromLLM(llm, retriever, opt);\n        return acc;\n      },\n      {} as { [name: string]: RetrievalQAChain }\n    );\n\n    let _defaultChain;\n    if (defaultChain) {\n      _defaultChain = defaultChain;\n    } else if (defaultRetriever) {\n      _defaultChain = RetrievalQAChain.fromLLM(llm, defaultRetriever, {\n        ...retrievalQAChainOpts,\n        prompt: defaultPrompt,\n      });\n    } else {\n      const promptTemplate = DEFAULT_TEMPLATE.replace(\"input\", \"query\");\n      const prompt = new PromptTemplate({\n        template: promptTemplate,\n        inputVariables: [\"history\", \"query\"],\n      });\n      _defaultChain = new ConversationChain({\n        llm,\n        prompt,\n        outputKey: \"result\",\n      });\n    }\n\n    return new MultiRetrievalQAChain({\n      ...multiRetrievalChainOpts,\n      routerChain,\n      destinationChains,\n      defaultChain: _defaultChain,\n    });\n  }\n\n  _chainType(): string {\n    return \"multi_retrieval_qa_chain\";\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiEA,IAAa,wBAAb,MAAa,8BAA8B,gBAAgB;CACzD,IAAI,aAAuB;AACzB,SAAO,CAAC,QAAS;CAClB;;;;CAKD,OAAO,eACLA,KACAC,gBACAC,uBACAC,YACAC,kBACAC,UACAC,SACA;AACA,SAAO,sBAAsB,qBAAqB,KAAK;GACrD;GACA;GACA;GACA;GACA;GACA,yBAAyB;EAC1B,EAAC;CACH;;;;;;;;;;;;;;;;;CAkBD,OAAO,qBACLN,KACA,EACE,gBACA,uBACA,YACA,kBACA,UACA,yBACA,sBAaD,EACsB;EACvB,MAAM,EAAE,kBAAkB,eAAe,cAAc,GAAG,YAAY,CAAE;AACxE,MAAI,iBAAiB,CAAC,iBACpB,OAAM,IAAI,MACR;EAGJ,MAAM,eAAe,WACnB,gBACA,sBACD,CAAC,IAAI,CAAC,CAAC,MAAM,KAAK,KAAK,GAAG,KAAK,EAAE,EAAE,MAAM,CAAC;EAE3C,MAAM,+BAA+B,EAAE,OAAO;GAC5C,aAAa,EACV,QAAQ,CACR,UAAU,CACV,SAAS,8DAA4D;GACxE,aAAa,EACV,OAAO,EACN,OAAO,EACJ,QAAQ,CACR,SAAS,uDAAuD,CACpE,EAAC,CACD,SAAS,oCAAoC;EACjD,EAAC;EAEF,MAAM,eAAe,IAAI,mBAEvB;EAEF,MAAM,kBAAkB,aAAa,KAAK,KAAK;EAC/C,MAAM,iBAAiB,mBACrB,2CACE,aAAa,sBAAsB,EAAE,oBAAoB,EAAG,EAAC,CAC9D,EACD,EACE,cAAc,gBACf,EACF;EACD,MAAM,eAAe,IAAI,eAAe;GACtC,UAAU;GACV,gBAAgB,CAAC,OAAQ;GACzB;EACD;EAED,MAAM,cAAc,eAAe,QAAQ,KAAK,aAAa;EAC7D,MAAM,UAAU,oBAAoB,WAAW,IAAI,MAAM,KAAK;EAC9D,MAAM,oBAAoB,WAExB,gBAAgB,YAAY,QAAQ,CAAC,OACrC,CAAC,KAAK,CAAC,MAAM,WAAW,OAAO,KAAK;GAClC,MAAMO,MAEF,wBAAwB,CAAE;AAC9B,OAAI,QACF,IAAI,SAAS;GAEf,IAAI,QAAQ,iBAAiB,QAAQ,KAAK,WAAW,IAAI;AACzD,UAAO;EACR,GACD,CAAE,EACH;EAED,IAAI;AACJ,MAAI,cACF,gBAAgB;WACP,kBACT,gBAAgB,iBAAiB,QAAQ,KAAK,kBAAkB;GAC9D,GAAG;GACH,QAAQ;EACT,EAAC;OACG;GACL,MAAM,iBAAiB,iBAAiB,QAAQ,SAAS,QAAQ;GACjE,MAAM,SAAS,IAAI,eAAe;IAChC,UAAU;IACV,gBAAgB,CAAC,WAAW,OAAQ;GACrC;GACD,gBAAgB,IAAI,kBAAkB;IACpC;IACA;IACA,WAAW;GACZ;EACF;AAED,SAAO,IAAI,sBAAsB;GAC/B,GAAG;GACH;GACA;GACA,cAAc;EACf;CACF;CAED,aAAqB;AACnB,SAAO;CACR;AACF"}

package/dist/chains/router/multi_route.cjs

@@ -0,0 +1,69 @@
+const require_base = require('../base.cjs');
+
+//#region src/chains/router/multi_route.ts
+/**
+* A class that represents a router chain. It
+* extends the BaseChain class and provides functionality for routing
+* inputs to different chains.
+*/
+var RouterChain = class extends require_base.BaseChain {
+	get outputKeys() {
+		return ["destination", "next_inputs"];
+	}
+	async route(inputs, callbacks) {
+		const result = await this.call(inputs, callbacks);
+		return {
+			destination: result.destination,
+			nextInputs: result.next_inputs
+		};
+	}
+};
+/**
+* A class that represents a multi-route chain.
+* It extends the BaseChain class and provides functionality for routing
+* inputs to different chains based on a router chain.
+*/
+var MultiRouteChain = class extends require_base.BaseChain {
+	static lc_name() {
+		return "MultiRouteChain";
+	}
+	routerChain;
+	destinationChains;
+	defaultChain;
+	silentErrors = false;
+	constructor(fields) {
+		super(fields);
+		this.routerChain = fields.routerChain;
+		this.destinationChains = fields.destinationChains;
+		this.defaultChain = fields.defaultChain;
+		this.silentErrors = fields.silentErrors ?? this.silentErrors;
+	}
+	get inputKeys() {
+		return this.routerChain.inputKeys;
+	}
+	get outputKeys() {
+		return [];
+	}
+	async _call(values, runManager) {
+		const { destination, nextInputs } = await this.routerChain.route(values, runManager?.getChild());
+		await runManager?.handleText(`${destination}: ${JSON.stringify(nextInputs)}`);
+		if (!destination) return this.defaultChain.call(nextInputs, runManager?.getChild()).catch((err) => {
+			throw new Error(`Error in default chain: ${err}`);
+		});
+		if (destination in this.destinationChains) return this.destinationChains[destination].call(nextInputs, runManager?.getChild()).catch((err) => {
+			throw new Error(`Error in ${destination} chain: ${err}`);
+		});
+		if (this.silentErrors) return this.defaultChain.call(nextInputs, runManager?.getChild()).catch((err) => {
+			throw new Error(`Error in default chain: ${err}`);
+		});
+		throw new Error(`Destination ${destination} not found in destination chains with keys ${Object.keys(this.destinationChains)}`);
+	}
+	_chainType() {
+		return "multi_route_chain";
+	}
+};
+
+//#endregion
+exports.MultiRouteChain = MultiRouteChain;
+exports.RouterChain = RouterChain;
+//# sourceMappingURL=multi_route.cjs.map

package/dist/chains/router/multi_route.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"multi_route.cjs","names":["BaseChain","inputs: ChainValues","callbacks?: Callbacks","fields: MultiRouteChainInput","values: ChainValues","runManager?: CallbackManagerForChainRun"],"sources":["../../../src/chains/router/multi_route.ts"],"sourcesContent":["import { ChainValues } from \"@langchain/core/utils/types\";\nimport {\n  CallbackManagerForChainRun,\n  Callbacks,\n} from \"@langchain/core/callbacks/manager\";\nimport { BaseChain, ChainInputs } from \"../../chains/base.js\";\n\n/**\n * A type that represents the inputs for the MultiRouteChain. It is a\n * recursive type that can contain nested objects, arrays, strings, and\n * numbers.\n */\ntype Inputs = {\n  [key: string]: Inputs | Inputs[] | string | string[] | number | number[];\n};\n\n/**\n * An interface that represents the route returned by the RouterChain. It\n * includes optional fields for the destination and nextInputs.\n */\nexport interface Route {\n  destination?: string;\n  nextInputs: { [key: string]: Inputs };\n}\n\n/**\n * An interface that extends the ChainInputs interface and adds additional\n * properties for the routerChain, destinationChains, defaultChain, and\n * silentErrors. It represents the input expected by the MultiRouteChain\n * class.\n */\nexport interface MultiRouteChainInput extends ChainInputs {\n  routerChain: RouterChain;\n  destinationChains: { [name: string]: BaseChain };\n  defaultChain: BaseChain;\n  silentErrors?: boolean;\n}\n\n/**\n * A class that represents a router chain. It\n * extends the BaseChain class and provides functionality for routing\n * inputs to different chains.\n */\nexport abstract class RouterChain extends BaseChain {\n  get outputKeys(): string[] {\n    return [\"destination\", \"next_inputs\"];\n  }\n\n  async route(inputs: ChainValues, callbacks?: Callbacks): Promise<Route> {\n    const result = await this.call(inputs, callbacks);\n    return {\n      destination: result.destination,\n      nextInputs: result.next_inputs,\n    };\n  }\n}\n\n/**\n * A class that represents a multi-route chain.\n * It extends the BaseChain class and provides functionality for routing\n * inputs to different chains based on a router chain.\n */\nexport class MultiRouteChain extends BaseChain {\n  static lc_name() {\n    return \"MultiRouteChain\";\n  }\n\n  routerChain: RouterChain;\n\n  destinationChains: { [name: string]: BaseChain };\n\n  defaultChain: BaseChain;\n\n  silentErrors = false;\n\n  constructor(fields: MultiRouteChainInput) {\n    super(fields);\n    this.routerChain = fields.routerChain;\n    this.destinationChains = fields.destinationChains;\n    this.defaultChain = fields.defaultChain;\n    this.silentErrors = fields.silentErrors ?? this.silentErrors;\n  }\n\n  get inputKeys(): string[] {\n    return this.routerChain.inputKeys;\n  }\n\n  get outputKeys(): string[] {\n    return [];\n  }\n\n  async _call(\n    values: ChainValues,\n    runManager?: CallbackManagerForChainRun\n  ): Promise<ChainValues> {\n    const { destination, nextInputs } = await this.routerChain.route(\n      values,\n      runManager?.getChild()\n    );\n    await runManager?.handleText(\n      `${destination}: ${JSON.stringify(nextInputs)}`\n    );\n    if (!destination) {\n      return this.defaultChain\n        .call(nextInputs, runManager?.getChild())\n        .catch((err) => {\n          throw new Error(`Error in default chain: ${err}`);\n        });\n    }\n    if (destination in this.destinationChains) {\n      return this.destinationChains[destination]\n        .call(nextInputs, runManager?.getChild())\n        .catch((err) => {\n          throw new Error(`Error in ${destination} chain: ${err}`);\n        });\n    }\n    if (this.silentErrors) {\n      return this.defaultChain\n        .call(nextInputs, runManager?.getChild())\n        .catch((err) => {\n          throw new Error(`Error in default chain: ${err}`);\n        });\n    }\n    throw new Error(\n      `Destination ${destination} not found in destination chains with keys ${Object.keys(\n        this.destinationChains\n      )}`\n    );\n  }\n\n  _chainType(): string {\n    return \"multi_route_chain\";\n  }\n}\n"],"mappings":";;;;;;;;AA2CA,IAAsB,cAAtB,cAA0CA,uBAAU;CAClD,IAAI,aAAuB;AACzB,SAAO,CAAC,eAAe,aAAc;CACtC;CAED,MAAM,MAAMC,QAAqBC,WAAuC;EACtE,MAAM,SAAS,MAAM,KAAK,KAAK,QAAQ,UAAU;AACjD,SAAO;GACL,aAAa,OAAO;GACpB,YAAY,OAAO;EACpB;CACF;AACF;;;;;;AAOD,IAAa,kBAAb,cAAqCF,uBAAU;CAC7C,OAAO,UAAU;AACf,SAAO;CACR;CAED;CAEA;CAEA;CAEA,eAAe;CAEf,YAAYG,QAA8B;EACxC,MAAM,OAAO;EACb,KAAK,cAAc,OAAO;EAC1B,KAAK,oBAAoB,OAAO;EAChC,KAAK,eAAe,OAAO;EAC3B,KAAK,eAAe,OAAO,gBAAgB,KAAK;CACjD;CAED,IAAI,YAAsB;AACxB,SAAO,KAAK,YAAY;CACzB;CAED,IAAI,aAAuB;AACzB,SAAO,CAAE;CACV;CAED,MAAM,MACJC,QACAC,YACsB;EACtB,MAAM,EAAE,aAAa,YAAY,GAAG,MAAM,KAAK,YAAY,MACzD,QACA,YAAY,UAAU,CACvB;EACD,MAAM,YAAY,WAChB,GAAG,YAAY,EAAE,EAAE,KAAK,UAAU,WAAW,EAAE,CAChD;AACD,MAAI,CAAC,YACH,QAAO,KAAK,aACT,KAAK,YAAY,YAAY,UAAU,CAAC,CACxC,MAAM,CAAC,QAAQ;AACd,SAAM,IAAI,MAAM,CAAC,wBAAwB,EAAE,KAAK;EACjD,EAAC;AAEN,MAAI,eAAe,KAAK,kBACtB,QAAO,KAAK,kBAAkB,aAC3B,KAAK,YAAY,YAAY,UAAU,CAAC,CACxC,MAAM,CAAC,QAAQ;AACd,SAAM,IAAI,MAAM,CAAC,SAAS,EAAE,YAAY,QAAQ,EAAE,KAAK;EACxD,EAAC;AAEN,MAAI,KAAK,aACP,QAAO,KAAK,aACT,KAAK,YAAY,YAAY,UAAU,CAAC,CACxC,MAAM,CAAC,QAAQ;AACd,SAAM,IAAI,MAAM,CAAC,wBAAwB,EAAE,KAAK;EACjD,EAAC;AAEN,QAAM,IAAI,MACR,CAAC,YAAY,EAAE,YAAY,2CAA2C,EAAE,OAAO,KAC7E,KAAK,kBACN,EAAE;CAEN;CAED,aAAqB;AACnB,SAAO;CACR;AACF"}