langchain 0.0.131 → 0.0.132

package/dist/chains/question_answering/load.cjs

@@ -20,6 +20,13 @@ const loadQAChain = (llm, params = { type: "stuff" }) => {
     throw new Error(`Invalid _type: ${type}`);
 };
 exports.loadQAChain = loadQAChain;
+/**
+ * Loads a StuffQAChain based on the provided parameters. It takes an LLM
+ * instance and StuffQAChainParams as parameters.
+ * @param llm An instance of BaseLanguageModel.
+ * @param params Parameters for creating a StuffQAChain.
+ * @returns A StuffQAChain instance.
+ */
 function loadQAStuffChain(llm, params = {}) {
     const { prompt = stuff_prompts_js_1.QA_PROMPT_SELECTOR.getPrompt(llm), verbose } = params;
     const llmChain = new llm_chain_js_1.LLMChain({ prompt, llm, verbose });
@@ -27,6 +34,13 @@ function loadQAStuffChain(llm, params = {}) {
     return chain;
 }
 exports.loadQAStuffChain = loadQAStuffChain;
+/**
+ * Loads a MapReduceQAChain based on the provided parameters. It takes an
+ * LLM instance and MapReduceQAChainParams as parameters.
+ * @param llm An instance of BaseLanguageModel.
+ * @param params Parameters for creating a MapReduceQAChain.
+ * @returns A MapReduceQAChain instance.
+ */
 function loadQAMapReduceChain(llm, params = {}) {
     const { combineMapPrompt = map_reduce_prompts_js_1.COMBINE_QA_PROMPT_SELECTOR.getPrompt(llm), combinePrompt = map_reduce_prompts_js_1.COMBINE_PROMPT_SELECTOR.getPrompt(llm), verbose, returnIntermediateSteps, } = params;
     const llmChain = new llm_chain_js_1.LLMChain({ prompt: combineMapPrompt, llm, verbose });
@@ -45,6 +59,13 @@ function loadQAMapReduceChain(llm, params = {}) {
     return chain;
 }
 exports.loadQAMapReduceChain = loadQAMapReduceChain;
+/**
+ * Loads a RefineQAChain based on the provided parameters. It takes an LLM
+ * instance and RefineQAChainParams as parameters.
+ * @param llm An instance of BaseLanguageModel.
+ * @param params Parameters for creating a RefineQAChain.
+ * @returns A RefineQAChain instance.
+ */
 function loadQARefineChain(llm, params = {}) {
     const { questionPrompt = refine_prompts_js_1.QUESTION_PROMPT_SELECTOR.getPrompt(llm), refinePrompt = refine_prompts_js_1.REFINE_PROMPT_SELECTOR.getPrompt(llm), verbose, } = params;
     const llmChain = new llm_chain_js_1.LLMChain({ prompt: questionPrompt, llm, verbose });

package/dist/chains/question_answering/load.d.ts

@@ -1,6 +1,10 @@
 import { BasePromptTemplate } from "../../prompts/base.js";
 import { StuffDocumentsChain, MapReduceDocumentsChain, RefineDocumentsChain, MapReduceDocumentsChainInput } from "../combine_docs_chain.js";
 import { BaseLanguageModel } from "../../base_language/index.js";
+/**
+ * Represents the parameters for creating a QAChain. It can be of three
+ * types: "stuff", "map_reduce", or "refine".
+ */
 export type QAChainParams = ({
     type?: "stuff";
 } & StuffQAChainParams) | ({
@@ -9,21 +13,51 @@ export type QAChainParams = ({
     type?: "refine";
 } & RefineQAChainParams);
 export declare const loadQAChain: (llm: BaseLanguageModel, params?: QAChainParams) => StuffDocumentsChain | MapReduceDocumentsChain | RefineDocumentsChain;
+/**
+ * Represents the parameters for creating a StuffQAChain.
+ */
 export interface StuffQAChainParams {
     prompt?: BasePromptTemplate;
     verbose?: boolean;
 }
+/**
+ * Loads a StuffQAChain based on the provided parameters. It takes an LLM
+ * instance and StuffQAChainParams as parameters.
+ * @param llm An instance of BaseLanguageModel.
+ * @param params Parameters for creating a StuffQAChain.
+ * @returns A StuffQAChain instance.
+ */
 export declare function loadQAStuffChain(llm: BaseLanguageModel, params?: StuffQAChainParams): StuffDocumentsChain;
+/**
+ * Represents the parameters for creating a MapReduceQAChain.
+ */
 export interface MapReduceQAChainParams {
     returnIntermediateSteps?: MapReduceDocumentsChainInput["returnIntermediateSteps"];
     combineMapPrompt?: BasePromptTemplate;
     combinePrompt?: BasePromptTemplate;
     verbose?: boolean;
 }
+/**
+ * Loads a MapReduceQAChain based on the provided parameters. It takes an
+ * LLM instance and MapReduceQAChainParams as parameters.
+ * @param llm An instance of BaseLanguageModel.
+ * @param params Parameters for creating a MapReduceQAChain.
+ * @returns A MapReduceQAChain instance.
+ */
 export declare function loadQAMapReduceChain(llm: BaseLanguageModel, params?: MapReduceQAChainParams): MapReduceDocumentsChain;
+/**
+ * Represents the parameters for creating a RefineQAChain.
+ */
 export interface RefineQAChainParams {
     questionPrompt?: BasePromptTemplate;
     refinePrompt?: BasePromptTemplate;
     verbose?: boolean;
 }
+/**
+ * Loads a RefineQAChain based on the provided parameters. It takes an LLM
+ * instance and RefineQAChainParams as parameters.
+ * @param llm An instance of BaseLanguageModel.
+ * @param params Parameters for creating a RefineQAChain.
+ * @returns A RefineQAChain instance.
+ */
 export declare function loadQARefineChain(llm: BaseLanguageModel, params?: RefineQAChainParams): RefineDocumentsChain;

package/dist/chains/question_answering/load.js

@@ -16,12 +16,26 @@ export const loadQAChain = (llm, params = { type: "stuff" }) => {
     }
     throw new Error(`Invalid _type: ${type}`);
 };
+/**
+ * Loads a StuffQAChain based on the provided parameters. It takes an LLM
+ * instance and StuffQAChainParams as parameters.
+ * @param llm An instance of BaseLanguageModel.
+ * @param params Parameters for creating a StuffQAChain.
+ * @returns A StuffQAChain instance.
+ */
 export function loadQAStuffChain(llm, params = {}) {
     const { prompt = QA_PROMPT_SELECTOR.getPrompt(llm), verbose } = params;
     const llmChain = new LLMChain({ prompt, llm, verbose });
     const chain = new StuffDocumentsChain({ llmChain, verbose });
     return chain;
 }
+/**
+ * Loads a MapReduceQAChain based on the provided parameters. It takes an
+ * LLM instance and MapReduceQAChainParams as parameters.
+ * @param llm An instance of BaseLanguageModel.
+ * @param params Parameters for creating a MapReduceQAChain.
+ * @returns A MapReduceQAChain instance.
+ */
 export function loadQAMapReduceChain(llm, params = {}) {
     const { combineMapPrompt = COMBINE_QA_PROMPT_SELECTOR.getPrompt(llm), combinePrompt = COMBINE_PROMPT_SELECTOR.getPrompt(llm), verbose, returnIntermediateSteps, } = params;
     const llmChain = new LLMChain({ prompt: combineMapPrompt, llm, verbose });
@@ -39,6 +53,13 @@ export function loadQAMapReduceChain(llm, params = {}) {
     });
     return chain;
 }
+/**
+ * Loads a RefineQAChain based on the provided parameters. It takes an LLM
+ * instance and RefineQAChainParams as parameters.
+ * @param llm An instance of BaseLanguageModel.
+ * @param params Parameters for creating a RefineQAChain.
+ * @returns A RefineQAChain instance.
+ */
 export function loadQARefineChain(llm, params = {}) {
     const { questionPrompt = QUESTION_PROMPT_SELECTOR.getPrompt(llm), refinePrompt = REFINE_PROMPT_SELECTOR.getPrompt(llm), verbose, } = params;
     const llmChain = new LLMChain({ prompt: questionPrompt, llm, verbose });

package/dist/chains/retrieval_qa.cjs

@@ -3,6 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.RetrievalQAChain = void 0;
 const base_js_1 = require("./base.cjs");
 const load_js_1 = require("./question_answering/load.cjs");
+/**
+ * Class representing a chain for performing question-answering tasks with
+ * a retrieval component.
+ */
 class RetrievalQAChain extends base_js_1.BaseChain {
     static lc_name() {
         return "RetrievalQAChain";
@@ -71,6 +75,14 @@ class RetrievalQAChain extends base_js_1.BaseChain {
     serialize() {
         throw new Error("Not implemented");
     }
+    /**
+     * Creates a new instance of RetrievalQAChain using a BaseLanguageModel
+     * and a BaseRetriever.
+     * @param llm The BaseLanguageModel used to generate a new question.
+     * @param retriever The BaseRetriever used to retrieve relevant documents.
+     * @param options Optional parameters for the RetrievalQAChain.
+     * @returns A new instance of RetrievalQAChain.
+     */
     static fromLLM(llm, retriever, options) {
         const qaChain = (0, load_js_1.loadQAStuffChain)(llm, {
             prompt: options?.prompt,

package/dist/chains/retrieval_qa.d.ts

@@ -6,12 +6,19 @@ import { BaseRetriever } from "../schema/retriever.js";
 import { StuffQAChainParams } from "./question_answering/load.js";
 import { CallbackManagerForChainRun } from "../callbacks/manager.js";
 export type LoadValues = Record<string, any>;
+/**
+ * Interface for the input parameters of the RetrievalQAChain class.
+ */
 export interface RetrievalQAChainInput extends Omit<ChainInputs, "memory"> {
     retriever: BaseRetriever;
     combineDocumentsChain: BaseChain;
     inputKey?: string;
     returnSourceDocuments?: boolean;
 }
+/**
+ * Class representing a chain for performing question-answering tasks with
+ * a retrieval component.
+ */
 export declare class RetrievalQAChain extends BaseChain implements RetrievalQAChainInput {
     static lc_name(): string;
     inputKey: string;
@@ -26,5 +33,13 @@ export declare class RetrievalQAChain extends BaseChain implements RetrievalQACh
     _chainType(): "retrieval_qa";
     static deserialize(_data: SerializedVectorDBQAChain, _values: LoadValues): Promise<RetrievalQAChain>;
     serialize(): SerializedVectorDBQAChain;
+    /**
+     * Creates a new instance of RetrievalQAChain using a BaseLanguageModel
+     * and a BaseRetriever.
+     * @param llm The BaseLanguageModel used to generate a new question.
+     * @param retriever The BaseRetriever used to retrieve relevant documents.
+     * @param options Optional parameters for the RetrievalQAChain.
+     * @returns A new instance of RetrievalQAChain.
+     */
     static fromLLM(llm: BaseLanguageModel, retriever: BaseRetriever, options?: Partial<Omit<RetrievalQAChainInput, "retriever" | "combineDocumentsChain" | "index">> & StuffQAChainParams): RetrievalQAChain;
 }

package/dist/chains/retrieval_qa.js

@@ -1,5 +1,9 @@
 import { BaseChain } from "./base.js";
 import { loadQAStuffChain, } from "./question_answering/load.js";
+/**
+ * Class representing a chain for performing question-answering tasks with
+ * a retrieval component.
+ */
 export class RetrievalQAChain extends BaseChain {
     static lc_name() {
         return "RetrievalQAChain";
@@ -68,6 +72,14 @@ export class RetrievalQAChain extends BaseChain {
     serialize() {
         throw new Error("Not implemented");
     }
+    /**
+     * Creates a new instance of RetrievalQAChain using a BaseLanguageModel
+     * and a BaseRetriever.
+     * @param llm The BaseLanguageModel used to generate a new question.
+     * @param retriever The BaseRetriever used to retrieve relevant documents.
+     * @param options Optional parameters for the RetrievalQAChain.
+     * @returns A new instance of RetrievalQAChain.
+     */
     static fromLLM(llm, retriever, options) {
         const qaChain = loadQAStuffChain(llm, {
             prompt: options?.prompt,

package/dist/chains/router/llm_router.cjs

@@ -3,6 +3,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.LLMRouterChain = void 0;
 const llm_chain_js_1 = require("../../chains/llm_chain.cjs");
 const multi_route_js_1 = require("./multi_route.cjs");
+/**
+ * A class that represents an LLM router chain in the LangChain framework.
+ * It extends the RouterChain class and implements the LLMRouterChainInput
+ * interface. It provides additional functionality specific to LLMs and
+ * routing based on LLM predictions.
+ */
 class LLMRouterChain extends multi_route_js_1.RouterChain {
     constructor(fields) {
         super(fields);
@@ -23,6 +29,16 @@ class LLMRouterChain extends multi_route_js_1.RouterChain {
     _chainType() {
         return "llm_router_chain";
     }
+    /**
+     * A static method that creates an instance of LLMRouterChain from a
+     * BaseLanguageModel and a BasePromptTemplate. It takes in an optional
+     * options object and returns an instance of LLMRouterChain with the
+     * specified LLMChain.
+     * @param llm A BaseLanguageModel instance.
+     * @param prompt A BasePromptTemplate instance.
+     * @param options Optional LLMRouterChainInput object, excluding "llmChain".
+     * @returns An instance of LLMRouterChain.
+     */
     static fromLLM(llm, prompt, options) {
         const llmChain = new llm_chain_js_1.LLMChain({ llm, prompt });
         return new LLMRouterChain({ ...options, llmChain });

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

@@ -5,20 +5,44 @@ import { CallbackManagerForChainRun } from "../../callbacks/manager.js";
 import { ChainValues } from "../../schema/index.js";
 import { BaseLanguageModel } from "../../base_language/index.js";
 import { ChainInputs } from "../../chains/base.js";
+/**
+ * A type that represents the output schema of a router chain. It defines
+ * the structure of the output data returned by the router chain.
+ */
 export type RouterOutputSchema = {
     destination: string;
     next_inputs: {
         [key: string]: string;
     };
 };
+/**
+ * An interface that extends the default ChainInputs interface and adds an
+ * additional "llmChain" property.
+ */
 export interface LLMRouterChainInput extends ChainInputs {
     llmChain: LLMChain<RouterOutputSchema>;
 }
+/**
+ * A class that represents an LLM router chain in the LangChain framework.
+ * It extends the RouterChain class and implements the LLMRouterChainInput
+ * interface. It provides additional functionality specific to LLMs and
+ * routing based on LLM predictions.
+ */
 export declare class LLMRouterChain extends RouterChain implements LLMRouterChainInput {
     llmChain: LLMChain<RouterOutputSchema>;
     constructor(fields: LLMRouterChainInput);
     get inputKeys(): string[];
     _call(values: ChainValues, runManager?: CallbackManagerForChainRun | undefined): Promise<RouterOutputSchema>;
     _chainType(): string;
+    /**
+     * A static method that creates an instance of LLMRouterChain from a
+     * BaseLanguageModel and a BasePromptTemplate. It takes in an optional
+     * options object and returns an instance of LLMRouterChain with the
+     * specified LLMChain.
+     * @param llm A BaseLanguageModel instance.
+     * @param prompt A BasePromptTemplate instance.
+     * @param options Optional LLMRouterChainInput object, excluding "llmChain".
+     * @returns An instance of LLMRouterChain.
+     */
     static fromLLM(llm: BaseLanguageModel, prompt: BasePromptTemplate, options?: Omit<LLMRouterChainInput, "llmChain">): LLMRouterChain;
 }

package/dist/chains/router/llm_router.js

@@ -1,5 +1,11 @@
 import { LLMChain } from "../../chains/llm_chain.js";
 import { RouterChain } from "./multi_route.js";
+/**
+ * A class that represents an LLM router chain in the LangChain framework.
+ * It extends the RouterChain class and implements the LLMRouterChainInput
+ * interface. It provides additional functionality specific to LLMs and
+ * routing based on LLM predictions.
+ */
 export class LLMRouterChain extends RouterChain {
     constructor(fields) {
         super(fields);
@@ -20,6 +26,16 @@ export class LLMRouterChain extends RouterChain {
     _chainType() {
         return "llm_router_chain";
     }
+    /**
+     * A static method that creates an instance of LLMRouterChain from a
+     * BaseLanguageModel and a BasePromptTemplate. It takes in an optional
+     * options object and returns an instance of LLMRouterChain with the
+     * specified LLMChain.
+     * @param llm A BaseLanguageModel instance.
+     * @param prompt A BasePromptTemplate instance.
+     * @param options Optional LLMRouterChainInput object, excluding "llmChain".
+     * @returns An instance of LLMRouterChain.
+     */
     static fromLLM(llm, prompt, options) {
         const llmChain = new LLMChain({ llm, prompt });
         return new LLMRouterChain({ ...options, llmChain });

package/dist/chains/router/multi_prompt.cjs

@@ -11,6 +11,11 @@ const llm_router_js_1 = require("./llm_router.cjs");
 const conversation_js_1 = require("../../chains/conversation.cjs");
 const utils_js_1 = require("./utils.cjs");
 const router_js_1 = require("../../output_parsers/router.cjs");
+/**
+ * A class that represents a multi-prompt chain in the LangChain
+ * framework. It extends the MultiRouteChain class and provides additional
+ * functionality specific to multi-prompt chains.
+ */
 class MultiPromptChain extends multi_route_js_1.MultiRouteChain {
     /**
      * @deprecated Use `fromLLMAndPrompts` instead
@@ -24,6 +29,20 @@ class MultiPromptChain extends multi_route_js_1.MultiRouteChain {
             multiRouteChainOpts: options,
         });
     }
+    /**
+     * A static method that creates an instance of MultiPromptChain from a
+     * BaseLanguageModel and a set of prompts. It takes in optional parameters
+     * for the default chain and additional options.
+     * @param llm A BaseLanguageModel instance.
+     * @param promptNames An array of prompt names.
+     * @param promptDescriptions An array of prompt descriptions.
+     * @param promptTemplates An array of prompt templates.
+     * @param defaultChain An optional BaseChain instance to be used as the default chain.
+     * @param llmChainOpts Optional parameters for the LLMChainInput, excluding 'llm' and 'prompt'.
+     * @param conversationChainOpts Optional parameters for the LLMChainInput, excluding 'llm' and 'outputKey'.
+     * @param multiRouteChainOpts Optional parameters for the MultiRouteChainInput, excluding 'defaultChain'.
+     * @returns An instance of MultiPromptChain.
+     */
     static fromLLMAndPrompts(llm, { promptNames, promptDescriptions, promptTemplates, defaultChain, llmChainOpts, conversationChainOpts, multiRouteChainOpts, }) {
         const destinations = (0, utils_js_1.zipEntries)(promptNames, promptDescriptions).map(([name, desc]) => `${name}: ${desc}`);
         const structuredOutputParserSchema = zod_1.z.object({

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

@@ -3,11 +3,30 @@ import { MultiRouteChain, MultiRouteChainInput } from "./multi_route.js";
 import { BaseChain } from "../../chains/base.js";
 import { LLMChainInput } from "../../chains/llm_chain.js";
 import { PromptTemplate } from "../../prompts/prompt.js";
+/**
+ * A class that represents a multi-prompt chain in the LangChain
+ * framework. It extends the MultiRouteChain class and provides additional
+ * functionality specific to multi-prompt chains.
+ */
 export declare class MultiPromptChain extends MultiRouteChain {
     /**
      * @deprecated Use `fromLLMAndPrompts` instead
      */
     static fromPrompts(llm: BaseLanguageModel, promptNames: string[], promptDescriptions: string[], promptTemplates: string[] | PromptTemplate[], defaultChain?: BaseChain, options?: Omit<MultiRouteChainInput, "defaultChain">): MultiPromptChain;
+    /**
+     * A static method that creates an instance of MultiPromptChain from a
+     * BaseLanguageModel and a set of prompts. It takes in optional parameters
+     * for the default chain and additional options.
+     * @param llm A BaseLanguageModel instance.
+     * @param promptNames An array of prompt names.
+     * @param promptDescriptions An array of prompt descriptions.
+     * @param promptTemplates An array of prompt templates.
+     * @param defaultChain An optional BaseChain instance to be used as the default chain.
+     * @param llmChainOpts Optional parameters for the LLMChainInput, excluding 'llm' and 'prompt'.
+     * @param conversationChainOpts Optional parameters for the LLMChainInput, excluding 'llm' and 'outputKey'.
+     * @param multiRouteChainOpts Optional parameters for the MultiRouteChainInput, excluding 'defaultChain'.
+     * @returns An instance of MultiPromptChain.
+     */
     static fromLLMAndPrompts(llm: BaseLanguageModel, { promptNames, promptDescriptions, promptTemplates, defaultChain, llmChainOpts, conversationChainOpts, multiRouteChainOpts, }: {
         promptNames: string[];
         promptDescriptions: string[];

package/dist/chains/router/multi_prompt.js

@@ -8,6 +8,11 @@ import { LLMRouterChain } from "./llm_router.js";
 import { ConversationChain } from "../../chains/conversation.js";
 import { zipEntries } from "./utils.js";
 import { RouterOutputParser } from "../../output_parsers/router.js";
+/**
+ * A class that represents a multi-prompt chain in the LangChain
+ * framework. It extends the MultiRouteChain class and provides additional
+ * functionality specific to multi-prompt chains.
+ */
 export class MultiPromptChain extends MultiRouteChain {
     /**
      * @deprecated Use `fromLLMAndPrompts` instead
@@ -21,6 +26,20 @@ export class MultiPromptChain extends MultiRouteChain {
             multiRouteChainOpts: options,
         });
     }
+    /**
+     * A static method that creates an instance of MultiPromptChain from a
+     * BaseLanguageModel and a set of prompts. It takes in optional parameters
+     * for the default chain and additional options.
+     * @param llm A BaseLanguageModel instance.
+     * @param promptNames An array of prompt names.
+     * @param promptDescriptions An array of prompt descriptions.
+     * @param promptTemplates An array of prompt templates.
+     * @param defaultChain An optional BaseChain instance to be used as the default chain.
+     * @param llmChainOpts Optional parameters for the LLMChainInput, excluding 'llm' and 'prompt'.
+     * @param conversationChainOpts Optional parameters for the LLMChainInput, excluding 'llm' and 'outputKey'.
+     * @param multiRouteChainOpts Optional parameters for the MultiRouteChainInput, excluding 'defaultChain'.
+     * @returns An instance of MultiPromptChain.
+     */
     static fromLLMAndPrompts(llm, { promptNames, promptDescriptions, promptTemplates, defaultChain, llmChainOpts, conversationChainOpts, multiRouteChainOpts, }) {
         const destinations = zipEntries(promptNames, promptDescriptions).map(([name, desc]) => `${name}: ${desc}`);
         const structuredOutputParserSchema = z.object({

package/dist/chains/router/multi_retrieval_qa.cjs

@@ -11,6 +11,12 @@ const multi_retrieval_prompt_js_1 = require("./multi_retrieval_prompt.cjs");
 const utils_js_1 = require("./utils.cjs");
 const retrieval_qa_js_1 = require("../../chains/retrieval_qa.cjs");
 const router_js_1 = require("../../output_parsers/router.cjs");
+/**
+ * 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.
+ */
 class MultiRetrievalQAChain extends multi_route_js_1.MultiRouteChain {
     get outputKeys() {
         return ["result"];
@@ -28,6 +34,22 @@ class MultiRetrievalQAChain extends multi_route_js_1.MultiRouteChain {
             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 BaseRetriever 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) {

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

@@ -4,17 +4,44 @@ import { BaseChain } from "../../chains/base.js";
 import { PromptTemplate } from "../../prompts/prompt.js";
 import { BaseRetriever } from "../../schema/retriever.js";
 import { RetrievalQAChainInput } from "../../chains/retrieval_qa.js";
+/**
+ * A type that represents the default values for the MultiRetrievalQAChain
+ * class. It includes optional properties for the default retriever,
+ * default prompt, and default chain.
+ */
 export type MultiRetrievalDefaults = {
     defaultRetriever?: BaseRetriever;
     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.
+ */
 export declare class MultiRetrievalQAChain extends MultiRouteChain {
     get outputKeys(): string[];
     /**
      * @deprecated Use `fromRetrieversAndPrompts` instead
      */
     static fromRetrievers(llm: BaseLanguageModel, retrieverNames: string[], retrieverDescriptions: string[], retrievers: BaseRetriever[], 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 BaseRetriever 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: BaseLanguageModel, { retrieverNames, retrieverDescriptions, retrievers, retrieverPrompts, defaults, multiRetrievalChainOpts, retrievalQAChainOpts, }: {
         retrieverNames: string[];
         retrieverDescriptions: string[];

package/dist/chains/router/multi_retrieval_qa.js

@@ -8,6 +8,12 @@ import { STRUCTURED_MULTI_RETRIEVAL_ROUTER_TEMPLATE } from "./multi_retrieval_pr
 import { zipEntries } from "./utils.js";
 import { RetrievalQAChain, } from "../../chains/retrieval_qa.js";
 import { RouterOutputParser } from "../../output_parsers/router.js";
+/**
+ * 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.
+ */
 export class MultiRetrievalQAChain extends MultiRouteChain {
     get outputKeys() {
         return ["result"];
@@ -25,6 +31,22 @@ export class MultiRetrievalQAChain extends MultiRouteChain {
             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 BaseRetriever 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) {

package/dist/chains/router/multi_route.cjs

@@ -2,6 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MultiRouteChain = exports.RouterChain = void 0;
 const base_js_1 = require("../../chains/base.cjs");
+/**
+ * A class that represents a router chain. It
+ * extends the BaseChain class and provides functionality for routing
+ * inputs to different chains.
+ */
 class RouterChain extends base_js_1.BaseChain {
     get outputKeys() {
         return ["destination", "next_inputs"];
@@ -15,6 +20,11 @@ class RouterChain extends base_js_1.BaseChain {
     }
 }
 exports.RouterChain = RouterChain;
+/**
+ * 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.
+ */
 class MultiRouteChain extends base_js_1.BaseChain {
     static lc_name() {
         return "MultiRouteChain";

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

@@ -1,15 +1,30 @@
 import { CallbackManagerForChainRun, Callbacks } from "../../callbacks/manager.js";
 import { BaseChain, ChainInputs } from "../../chains/base.js";
 import { ChainValues } from "../../schema/index.js";
+/**
+ * A type that represents the inputs for the MultiRouteChain. It is a
+ * recursive type that can contain nested objects, arrays, strings, and
+ * numbers.
+ */
 type Inputs = {
     [key: string]: Inputs | Inputs[] | string | string[] | number | number[];
 };
+/**
+ * An interface that represents the route returned by the RouterChain. It
+ * includes optional fields for the destination and nextInputs.
+ */
 export interface Route {
     destination?: string;
     nextInputs: {
         [key: string]: Inputs;
     };
 }
+/**
+ * An interface that extends the ChainInputs interface and adds additional
+ * properties for the routerChain, destinationChains, defaultChain, and
+ * silentErrors. It represents the input expected by the MultiRouteChain
+ * class.
+ */
 export interface MultiRouteChainInput extends ChainInputs {
     routerChain: RouterChain;
     destinationChains: {
@@ -18,10 +33,20 @@ export interface MultiRouteChainInput extends ChainInputs {
     defaultChain: BaseChain;
     silentErrors?: boolean;
 }
+/**
+ * A class that represents a router chain. It
+ * extends the BaseChain class and provides functionality for routing
+ * inputs to different chains.
+ */
 export declare abstract class RouterChain extends BaseChain {
     get outputKeys(): string[];
     route(inputs: ChainValues, callbacks?: Callbacks): Promise<Route>;
 }
+/**
+ * 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.
+ */
 export declare class MultiRouteChain extends BaseChain {
     static lc_name(): string;
     routerChain: RouterChain;

package/dist/chains/router/multi_route.js

@@ -1,4 +1,9 @@
 import { BaseChain } from "../../chains/base.js";
+/**
+ * A class that represents a router chain. It
+ * extends the BaseChain class and provides functionality for routing
+ * inputs to different chains.
+ */
 export class RouterChain extends BaseChain {
     get outputKeys() {
         return ["destination", "next_inputs"];
@@ -11,6 +16,11 @@ export class RouterChain extends BaseChain {
         };
     }
 }
+/**
+ * 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.
+ */
 export class MultiRouteChain extends BaseChain {
     static lc_name() {
         return "MultiRouteChain";