@langchain/classic 1.0.44 → 1.0.46

package/dist/chains/sequential_chain.cjs

@@ -91,11 +91,12 @@ var SequentialChain = class SequentialChain extends require_base.BaseChain {
 			if (overlappingOutputKeys.size > 0) throw new Error(`The following output variables for chain "${chain._chainType()}" are overlapping: ${formatSet(overlappingOutputKeys)}. This can lead to unexpected behaviour.`);
 			for (const outputKey of outputKeysSet) availableKeys.add(outputKey);
 		}
-		if (this.outputVariables.length === 0) if (this.returnAll) {
-			const outputKeys = require_set.difference(availableKeys, inputKeysSet);
-			this.outputVariables = Array.from(outputKeys);
-		} else this.outputVariables = this.chains[this.chains.length - 1].outputKeys;
-		else {
+		if (this.outputVariables.length === 0) {
+			if (this.returnAll) {
+				const outputKeys = require_set.difference(availableKeys, inputKeysSet);
+				this.outputVariables = Array.from(outputKeys);
+			} else this.outputVariables = this.chains[this.chains.length - 1].outputKeys;
+		} else {
 			const missingKeys = require_set.difference(new Set(this.outputVariables), new Set(availableKeys));
 			if (missingKeys.size > 0) throw new Error(`The following output variables were expected to be in the final chain output but were not found: ${formatSet(missingKeys)}.`);
 		}

package/dist/chains/sequential_chain.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"sequential_chain.cjs","names":["BaseChain","intersection","union","difference"],"sources":["../../src/chains/sequential_chain.ts"],"sourcesContent":["import { ChainValues } from \"@langchain/core/utils/types\";\nimport { CallbackManagerForChainRun } from \"@langchain/core/callbacks/manager\";\nimport { BaseChain, ChainInputs } from \"./base.js\";\nimport {\n  SerializedBaseChain,\n  SerializedSequentialChain,\n  SerializedSimpleSequentialChain,\n} from \"./serde.js\";\nimport { intersection, union, difference } from \"../util/set.js\";\n\nfunction formatSet(input: Set<string>) {\n  return Array.from(input)\n    .map((i) => `\"${i}\"`)\n    .join(\", \");\n}\n\n/**\n * Interface for the input parameters of the SequentialChain class.\n */\nexport interface SequentialChainInput extends ChainInputs {\n  /** Array of chains to run as a sequence. The chains are run in order they appear in the array. */\n  chains: BaseChain[];\n  /** Defines which variables should be passed as initial input to the first chain. */\n  inputVariables: string[];\n  /** Which variables should be returned as a result of executing the chain. If not specified, output of the last of the chains is used. */\n  outputVariables?: string[];\n  /** Whether or not to return all intermediate outputs and variables (excluding initial input variables). */\n  returnAll?: boolean;\n}\n\n/**\n * Chain where the outputs of one chain feed directly into next.\n * @example\n * ```typescript\n * const promptTemplate = new PromptTemplate({\n *   template: `You are a playwright. Given the title of play and the era it is set in, it is your job to write a synopsis for that title.\n * Title: {title}\n * Era: {era}\n * Playwright: This is a synopsis for the above play:`,\n *   inputVariables: [\"title\", \"era\"],\n * });\n\n * const reviewPromptTemplate = new PromptTemplate({\n *   template: `You are a play critic from the New York Times. Given the synopsis of play, it is your job to write a review for that play.\n *   \n *     Play Synopsis:\n *     {synopsis}\n *     Review from a New York Times play critic of the above play:`,\n *   inputVariables: [\"synopsis\"],\n * });\n\n * const overallChain = new SequentialChain({\n *   chains: [\n *     new LLMChain({\n *       llm: new ChatOpenAI({ model: \"gpt-4o-mini\", temperature: 0 }),\n *       prompt: promptTemplate,\n *       outputKey: \"synopsis\",\n *     }),\n *     new LLMChain({\n *       llm: new OpenAI({ model: \"gpt-4o-mini\", temperature: 0 }),\n *       prompt: reviewPromptTemplate,\n *       outputKey: \"review\",\n *     }),\n *   ],\n *   inputVariables: [\"era\", \"title\"],\n *   outputVariables: [\"synopsis\", \"review\"],\n *   verbose: true,\n * });\n\n * const chainExecutionResult = await overallChain.call({\n *   title: \"Tragedy at sunset on the beach\",\n *   era: \"Victorian England\",\n * });\n * console.log(chainExecutionResult);\n * ```\n */\nexport class SequentialChain extends BaseChain implements SequentialChainInput {\n  static lc_name() {\n    return \"SequentialChain\";\n  }\n\n  chains: BaseChain[];\n\n  inputVariables: string[];\n\n  outputVariables: string[];\n\n  returnAll?: boolean | undefined;\n\n  get inputKeys() {\n    return this.inputVariables;\n  }\n\n  get outputKeys(): string[] {\n    return this.outputVariables;\n  }\n\n  constructor(fields: SequentialChainInput) {\n    super(fields);\n    this.chains = fields.chains;\n    this.inputVariables = fields.inputVariables;\n    this.outputVariables = fields.outputVariables ?? [];\n    if (this.outputVariables.length > 0 && fields.returnAll) {\n      throw new Error(\n        \"Either specify variables to return using `outputVariables` or use `returnAll` param. Cannot apply both conditions at the same time.\"\n      );\n    }\n    this.returnAll = fields.returnAll ?? false;\n    this._validateChains();\n  }\n\n  /** @ignore */\n  _validateChains() {\n    if (this.chains.length === 0) {\n      throw new Error(\"Sequential chain must have at least one chain.\");\n    }\n\n    const memoryKeys = this.memory?.memoryKeys ?? [];\n    const inputKeysSet = new Set(this.inputKeys);\n    const memoryKeysSet = new Set(memoryKeys);\n    const keysIntersection = intersection(inputKeysSet, memoryKeysSet);\n    if (keysIntersection.size > 0) {\n      throw new Error(\n        `The following keys: ${formatSet(\n          keysIntersection\n        )} are overlapping between memory and input keys of the chain variables. This can lead to unexpected behaviour. Please use input and memory keys that don't overlap.`\n      );\n    }\n\n    const availableKeys = union(inputKeysSet, memoryKeysSet);\n    for (const chain of this.chains) {\n      let missingKeys = difference(new Set(chain.inputKeys), availableKeys);\n\n      if (chain.memory) {\n        missingKeys = difference(missingKeys, new Set(chain.memory.memoryKeys));\n      }\n\n      if (missingKeys.size > 0) {\n        throw new Error(\n          `Missing variables for chain \"${chain._chainType()}\": ${formatSet(\n            missingKeys\n          )}. Only got the following variables: ${formatSet(availableKeys)}.`\n        );\n      }\n      const outputKeysSet = new Set(chain.outputKeys);\n      const overlappingOutputKeys = intersection(availableKeys, outputKeysSet);\n      if (overlappingOutputKeys.size > 0) {\n        throw new Error(\n          `The following output variables for chain \"${chain._chainType()}\" are overlapping: ${formatSet(\n            overlappingOutputKeys\n          )}. This can lead to unexpected behaviour.`\n        );\n      }\n\n      for (const outputKey of outputKeysSet) {\n        availableKeys.add(outputKey);\n      }\n    }\n\n    if (this.outputVariables.length === 0) {\n      if (this.returnAll) {\n        const outputKeys = difference(availableKeys, inputKeysSet);\n        this.outputVariables = Array.from(outputKeys);\n      } else {\n        this.outputVariables = this.chains[this.chains.length - 1].outputKeys;\n      }\n    } else {\n      const missingKeys = difference(\n        new Set(this.outputVariables),\n        new Set(availableKeys)\n      );\n      if (missingKeys.size > 0) {\n        throw new Error(\n          `The following output variables were expected to be in the final chain output but were not found: ${formatSet(\n            missingKeys\n          )}.`\n        );\n      }\n    }\n  }\n\n  /** @ignore */\n  async _call(\n    values: ChainValues,\n    runManager?: CallbackManagerForChainRun\n  ): Promise<ChainValues> {\n    let input: ChainValues = {};\n    const allChainValues: ChainValues = values;\n    let i = 0;\n    for (const chain of this.chains) {\n      i += 1;\n      input = await chain.call(\n        allChainValues,\n        runManager?.getChild(`step_${i}`)\n      );\n      for (const key of Object.keys(input)) {\n        allChainValues[key] = input[key];\n      }\n    }\n    const output: ChainValues = {};\n    for (const key of this.outputVariables) {\n      output[key] = allChainValues[key];\n    }\n\n    return output;\n  }\n\n  _chainType() {\n    return \"sequential_chain\" as const;\n  }\n\n  static async deserialize(data: SerializedSequentialChain) {\n    const chains: BaseChain[] = [];\n    const inputVariables: string[] = data.input_variables;\n    const outputVariables: string[] = data.output_variables;\n    const serializedChains = data.chains;\n    for (const serializedChain of serializedChains) {\n      const deserializedChain = await BaseChain.deserialize(serializedChain);\n      chains.push(deserializedChain);\n    }\n    return new SequentialChain({ chains, inputVariables, outputVariables });\n  }\n\n  serialize(): SerializedSequentialChain {\n    const chains: SerializedBaseChain[] = [];\n    for (const chain of this.chains) {\n      chains.push(chain.serialize());\n    }\n    return {\n      _type: this._chainType(),\n      input_variables: this.inputVariables,\n      output_variables: this.outputVariables,\n      chains,\n    };\n  }\n}\n\n/**\n * Interface for the input parameters of the SimpleSequentialChain class.\n */\nexport interface SimpleSequentialChainInput extends ChainInputs {\n  /** Array of chains to run as a sequence. The chains are run in order they appear in the array. */\n  chains: Array<BaseChain>;\n  /** Whether or not to trim the intermediate outputs. */\n  trimOutputs?: boolean;\n}\n\n/**\n * Simple chain where a single string output of one chain is fed directly into the next.\n * @augments BaseChain\n * @augments SimpleSequentialChainInput\n *\n * @example\n * ```ts\n * import { SimpleSequentialChain, LLMChain } from \"@langchain/classic/chains\";\n * import { OpenAI } from \"langchain/llms/openai\";\n * import { PromptTemplate } from \"langchain/prompts\";\n *\n * // This is an LLMChain to write a synopsis given a title of a play.\n * const llm = new OpenAI({ temperature: 0 });\n * const template = `You are a playwright. Given the title of play, it is your job to write a synopsis for that title.\n *\n * Title: {title}\n * Playwright: This is a synopsis for the above play:`\n * const promptTemplate = new PromptTemplate({ template, inputVariables: [\"title\"] });\n * const synopsisChain = new LLMChain({ llm, prompt: promptTemplate });\n *\n *\n * // This is an LLMChain to write a review of a play given a synopsis.\n * const reviewLLM = new OpenAI({ temperature: 0 })\n * const reviewTemplate = `You are a play critic from the New York Times. Given the synopsis of play, it is your job to write a review for that play.\n *\n * Play Synopsis:\n * {synopsis}\n * Review from a New York Times play critic of the above play:`\n * const reviewPromptTemplate = new PromptTemplate({ template: reviewTemplate, inputVariables: [\"synopsis\"] });\n * const reviewChain = new LLMChain({ llm: reviewLLM, prompt: reviewPromptTemplate });\n *\n * const overallChain = new SimpleSequentialChain({chains: [synopsisChain, reviewChain], verbose:true})\n * const review = await overallChain.run(\"Tragedy at sunset on the beach\")\n * // the variable review contains resulting play review.\n * ```\n */\nexport class SimpleSequentialChain\n  extends BaseChain\n  implements SimpleSequentialChainInput\n{\n  static lc_name() {\n    return \"SimpleSequentialChain\";\n  }\n\n  chains: Array<BaseChain>;\n\n  inputKey = \"input\";\n\n  outputKey = \"output\";\n\n  trimOutputs: boolean;\n\n  get inputKeys() {\n    return [this.inputKey];\n  }\n\n  get outputKeys(): string[] {\n    return [this.outputKey];\n  }\n\n  constructor(fields: SimpleSequentialChainInput) {\n    super(fields);\n    this.chains = fields.chains;\n    this.trimOutputs = fields.trimOutputs ?? false;\n    this._validateChains();\n  }\n\n  /** @ignore */\n  _validateChains() {\n    for (const chain of this.chains) {\n      if (\n        chain.inputKeys.filter((k) => !chain.memory?.memoryKeys.includes(k))\n          .length !== 1\n      ) {\n        throw new Error(\n          `Chains used in SimpleSequentialChain should all have one input, got ${\n            chain.inputKeys.length\n          } for ${chain._chainType()}.`\n        );\n      }\n      if (chain.outputKeys.length !== 1) {\n        throw new Error(\n          `Chains used in SimpleSequentialChain should all have one output, got ${\n            chain.outputKeys.length\n          } for ${chain._chainType()}.`\n        );\n      }\n    }\n  }\n\n  /** @ignore */\n  async _call(\n    values: ChainValues,\n    runManager?: CallbackManagerForChainRun\n  ): Promise<ChainValues> {\n    let input: string = values[this.inputKey];\n    let i = 0;\n    for (const chain of this.chains) {\n      i += 1;\n      input = (\n        await chain.call(\n          { [chain.inputKeys[0]]: input, signal: values.signal },\n          runManager?.getChild(`step_${i}`)\n        )\n      )[chain.outputKeys[0]];\n      if (this.trimOutputs) {\n        input = input.trim();\n      }\n      await runManager?.handleText(input);\n    }\n    return { [this.outputKey]: input };\n  }\n\n  _chainType() {\n    return \"simple_sequential_chain\" as const;\n  }\n\n  static async deserialize(data: SerializedSimpleSequentialChain) {\n    const chains: Array<BaseChain> = [];\n    const serializedChains = data.chains;\n    for (const serializedChain of serializedChains) {\n      const deserializedChain = await BaseChain.deserialize(serializedChain);\n      chains.push(deserializedChain);\n    }\n    return new SimpleSequentialChain({ chains });\n  }\n\n  serialize(): SerializedSimpleSequentialChain {\n    const chains: Array<SerializedBaseChain> = [];\n    for (const chain of this.chains) {\n      chains.push(chain.serialize());\n    }\n    return {\n      _type: this._chainType(),\n      chains,\n    };\n  }\n}\n"],"mappings":";;;AAUA,SAAS,UAAU,OAAoB;CACrC,OAAO,MAAM,KAAK,KAAK,CAAC,CACrB,KAAK,MAAM,IAAI,EAAE,EAAE,CAAC,CACpB,KAAK,IAAI;AACd;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8DA,IAAa,kBAAb,MAAa,wBAAwBA,aAAAA,UAA0C;CAC7E,OAAO,UAAU;EACf,OAAO;CACT;CAEA;CAEA;CAEA;CAEA;CAEA,IAAI,YAAY;EACd,OAAO,KAAK;CACd;CAEA,IAAI,aAAuB;EACzB,OAAO,KAAK;CACd;CAEA,YAAY,QAA8B;EACxC,MAAM,MAAM;EACZ,KAAK,SAAS,OAAO;EACrB,KAAK,iBAAiB,OAAO;EAC7B,KAAK,kBAAkB,OAAO,mBAAmB,CAAC;EAClD,IAAI,KAAK,gBAAgB,SAAS,KAAK,OAAO,WAC5C,MAAM,IAAI,MACR,qIACF;EAEF,KAAK,YAAY,OAAO,aAAa;EACrC,KAAK,gBAAgB;CACvB;;CAGA,kBAAkB;EAChB,IAAI,KAAK,OAAO,WAAW,GACzB,MAAM,IAAI,MAAM,gDAAgD;EAGlE,MAAM,aAAa,KAAK,QAAQ,cAAc,CAAC;EAC/C,MAAM,eAAe,IAAI,IAAI,KAAK,SAAS;EAC3C,MAAM,gBAAgB,IAAI,IAAI,UAAU;EACxC,MAAM,mBAAmBC,YAAAA,aAAa,cAAc,aAAa;EACjE,IAAI,iBAAiB,OAAO,GAC1B,MAAM,IAAI,MACR,uBAAuB,UACrB,gBACF,EAAE,mKACJ;EAGF,MAAM,gBAAgBC,YAAAA,MAAM,cAAc,aAAa;EACvD,KAAK,MAAM,SAAS,KAAK,QAAQ;GAC/B,IAAI,cAAcC,YAAAA,WAAW,IAAI,IAAI,MAAM,SAAS,GAAG,aAAa;GAEpE,IAAI,MAAM,QACR,cAAcA,YAAAA,WAAW,aAAa,IAAI,IAAI,MAAM,OAAO,UAAU,CAAC;GAGxE,IAAI,YAAY,OAAO,GACrB,MAAM,IAAI,MACR,gCAAgC,MAAM,WAAW,EAAE,KAAK,UACtD,WACF,EAAE,sCAAsC,UAAU,aAAa,EAAE,EACnE;GAEF,MAAM,gBAAgB,IAAI,IAAI,MAAM,UAAU;GAC9C,MAAM,wBAAwBF,YAAAA,aAAa,eAAe,aAAa;GACvE,IAAI,sBAAsB,OAAO,GAC/B,MAAM,IAAI,MACR,6CAA6C,MAAM,WAAW,EAAE,qBAAqB,UACnF,qBACF,EAAE,yCACJ;GAGF,KAAK,MAAM,aAAa,eACtB,cAAc,IAAI,SAAS;EAE/B;EAEA,IAAI,KAAK,gBAAgB,WAAW,GAClC,IAAI,KAAK,WAAW;GAClB,MAAM,aAAaE,YAAAA,WAAW,eAAe,YAAY;GACzD,KAAK,kBAAkB,MAAM,KAAK,UAAU;EAC9C,OACE,KAAK,kBAAkB,KAAK,OAAO,KAAK,OAAO,SAAS,EAAE,CAAC;OAExD;GACL,MAAM,cAAcA,YAAAA,WAClB,IAAI,IAAI,KAAK,eAAe,GAC5B,IAAI,IAAI,aAAa,CACvB;GACA,IAAI,YAAY,OAAO,GACrB,MAAM,IAAI,MACR,oGAAoG,UAClG,WACF,EAAE,EACJ;EAEJ;CACF;;CAGA,MAAM,MACJ,QACA,YACsB;EACtB,IAAI,QAAqB,CAAC;EAC1B,MAAM,iBAA8B;EACpC,IAAI,IAAI;EACR,KAAK,MAAM,SAAS,KAAK,QAAQ;GAC/B,KAAK;GACL,QAAQ,MAAM,MAAM,KAClB,gBACA,YAAY,SAAS,QAAQ,GAAG,CAClC;GACA,KAAK,MAAM,OAAO,OAAO,KAAK,KAAK,GACjC,eAAe,OAAO,MAAM;EAEhC;EACA,MAAM,SAAsB,CAAC;EAC7B,KAAK,MAAM,OAAO,KAAK,iBACrB,OAAO,OAAO,eAAe;EAG/B,OAAO;CACT;CAEA,aAAa;EACX,OAAO;CACT;CAEA,aAAa,YAAY,MAAiC;EACxD,MAAM,SAAsB,CAAC;EAC7B,MAAM,iBAA2B,KAAK;EACtC,MAAM,kBAA4B,KAAK;EACvC,MAAM,mBAAmB,KAAK;EAC9B,KAAK,MAAM,mBAAmB,kBAAkB;GAC9C,MAAM,oBAAoB,MAAMH,aAAAA,UAAU,YAAY,eAAe;GACrE,OAAO,KAAK,iBAAiB;EAC/B;EACA,OAAO,IAAI,gBAAgB;GAAE;GAAQ;GAAgB;EAAgB,CAAC;CACxE;CAEA,YAAuC;EACrC,MAAM,SAAgC,CAAC;EACvC,KAAK,MAAM,SAAS,KAAK,QACvB,OAAO,KAAK,MAAM,UAAU,CAAC;EAE/B,OAAO;GACL,OAAO,KAAK,WAAW;GACvB,iBAAiB,KAAK;GACtB,kBAAkB,KAAK;GACvB;EACF;CACF;AACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAgDA,IAAa,wBAAb,MAAa,8BACHA,aAAAA,UAEV;CACE,OAAO,UAAU;EACf,OAAO;CACT;CAEA;CAEA,WAAW;CAEX,YAAY;CAEZ;CAEA,IAAI,YAAY;EACd,OAAO,CAAC,KAAK,QAAQ;CACvB;CAEA,IAAI,aAAuB;EACzB,OAAO,CAAC,KAAK,SAAS;CACxB;CAEA,YAAY,QAAoC;EAC9C,MAAM,MAAM;EACZ,KAAK,SAAS,OAAO;EACrB,KAAK,cAAc,OAAO,eAAe;EACzC,KAAK,gBAAgB;CACvB;;CAGA,kBAAkB;EAChB,KAAK,MAAM,SAAS,KAAK,QAAQ;GAC/B,IACE,MAAM,UAAU,QAAQ,MAAM,CAAC,MAAM,QAAQ,WAAW,SAAS,CAAC,CAAC,CAAC,CACjE,WAAW,GAEd,MAAM,IAAI,MACR,uEACE,MAAM,UAAU,OACjB,OAAO,MAAM,WAAW,EAAE,EAC7B;GAEF,IAAI,MAAM,WAAW,WAAW,GAC9B,MAAM,IAAI,MACR,wEACE,MAAM,WAAW,OAClB,OAAO,MAAM,WAAW,EAAE,EAC7B;EAEJ;CACF;;CAGA,MAAM,MACJ,QACA,YACsB;EACtB,IAAI,QAAgB,OAAO,KAAK;EAChC,IAAI,IAAI;EACR,KAAK,MAAM,SAAS,KAAK,QAAQ;GAC/B,KAAK;GACL,SACE,MAAM,MAAM,KACV;KAAG,MAAM,UAAU,KAAK;IAAO,QAAQ,OAAO;GAAO,GACrD,YAAY,SAAS,QAAQ,GAAG,CAClC,EAAA,CACA,MAAM,WAAW;GACnB,IAAI,KAAK,aACP,QAAQ,MAAM,KAAK;GAErB,MAAM,YAAY,WAAW,KAAK;EACpC;EACA,OAAO,GAAG,KAAK,YAAY,MAAM;CACnC;CAEA,aAAa;EACX,OAAO;CACT;CAEA,aAAa,YAAY,MAAuC;EAC9D,MAAM,SAA2B,CAAC;EAClC,MAAM,mBAAmB,KAAK;EAC9B,KAAK,MAAM,mBAAmB,kBAAkB;GAC9C,MAAM,oBAAoB,MAAMA,aAAAA,UAAU,YAAY,eAAe;GACrE,OAAO,KAAK,iBAAiB;EAC/B;EACA,OAAO,IAAI,sBAAsB,EAAE,OAAO,CAAC;CAC7C;CAEA,YAA6C;EAC3C,MAAM,SAAqC,CAAC;EAC5C,KAAK,MAAM,SAAS,KAAK,QACvB,OAAO,KAAK,MAAM,UAAU,CAAC;EAE/B,OAAO;GACL,OAAO,KAAK,WAAW;GACvB;EACF;CACF;AACF"}
+{"version":3,"file":"sequential_chain.cjs","names":["BaseChain","intersection","union","difference"],"sources":["../../src/chains/sequential_chain.ts"],"sourcesContent":["import { ChainValues } from \"@langchain/core/utils/types\";\nimport { CallbackManagerForChainRun } from \"@langchain/core/callbacks/manager\";\nimport { BaseChain, ChainInputs } from \"./base.js\";\nimport {\n  SerializedBaseChain,\n  SerializedSequentialChain,\n  SerializedSimpleSequentialChain,\n} from \"./serde.js\";\nimport { intersection, union, difference } from \"../util/set.js\";\n\nfunction formatSet(input: Set<string>) {\n  return Array.from(input)\n    .map((i) => `\"${i}\"`)\n    .join(\", \");\n}\n\n/**\n * Interface for the input parameters of the SequentialChain class.\n */\nexport interface SequentialChainInput extends ChainInputs {\n  /** Array of chains to run as a sequence. The chains are run in order they appear in the array. */\n  chains: BaseChain[];\n  /** Defines which variables should be passed as initial input to the first chain. */\n  inputVariables: string[];\n  /** Which variables should be returned as a result of executing the chain. If not specified, output of the last of the chains is used. */\n  outputVariables?: string[];\n  /** Whether or not to return all intermediate outputs and variables (excluding initial input variables). */\n  returnAll?: boolean;\n}\n\n/**\n * Chain where the outputs of one chain feed directly into next.\n * @example\n * ```typescript\n * const promptTemplate = new PromptTemplate({\n *   template: `You are a playwright. Given the title of play and the era it is set in, it is your job to write a synopsis for that title.\n * Title: {title}\n * Era: {era}\n * Playwright: This is a synopsis for the above play:`,\n *   inputVariables: [\"title\", \"era\"],\n * });\n\n * const reviewPromptTemplate = new PromptTemplate({\n *   template: `You are a play critic from the New York Times. Given the synopsis of play, it is your job to write a review for that play.\n *   \n *     Play Synopsis:\n *     {synopsis}\n *     Review from a New York Times play critic of the above play:`,\n *   inputVariables: [\"synopsis\"],\n * });\n\n * const overallChain = new SequentialChain({\n *   chains: [\n *     new LLMChain({\n *       llm: new ChatOpenAI({ model: \"gpt-4o-mini\", temperature: 0 }),\n *       prompt: promptTemplate,\n *       outputKey: \"synopsis\",\n *     }),\n *     new LLMChain({\n *       llm: new OpenAI({ model: \"gpt-4o-mini\", temperature: 0 }),\n *       prompt: reviewPromptTemplate,\n *       outputKey: \"review\",\n *     }),\n *   ],\n *   inputVariables: [\"era\", \"title\"],\n *   outputVariables: [\"synopsis\", \"review\"],\n *   verbose: true,\n * });\n\n * const chainExecutionResult = await overallChain.call({\n *   title: \"Tragedy at sunset on the beach\",\n *   era: \"Victorian England\",\n * });\n * console.log(chainExecutionResult);\n * ```\n */\nexport class SequentialChain extends BaseChain implements SequentialChainInput {\n  static lc_name() {\n    return \"SequentialChain\";\n  }\n\n  chains: BaseChain[];\n\n  inputVariables: string[];\n\n  outputVariables: string[];\n\n  returnAll?: boolean | undefined;\n\n  get inputKeys() {\n    return this.inputVariables;\n  }\n\n  get outputKeys(): string[] {\n    return this.outputVariables;\n  }\n\n  constructor(fields: SequentialChainInput) {\n    super(fields);\n    this.chains = fields.chains;\n    this.inputVariables = fields.inputVariables;\n    this.outputVariables = fields.outputVariables ?? [];\n    if (this.outputVariables.length > 0 && fields.returnAll) {\n      throw new Error(\n        \"Either specify variables to return using `outputVariables` or use `returnAll` param. Cannot apply both conditions at the same time.\"\n      );\n    }\n    this.returnAll = fields.returnAll ?? false;\n    this._validateChains();\n  }\n\n  /** @ignore */\n  _validateChains() {\n    if (this.chains.length === 0) {\n      throw new Error(\"Sequential chain must have at least one chain.\");\n    }\n\n    const memoryKeys = this.memory?.memoryKeys ?? [];\n    const inputKeysSet = new Set(this.inputKeys);\n    const memoryKeysSet = new Set(memoryKeys);\n    const keysIntersection = intersection(inputKeysSet, memoryKeysSet);\n    if (keysIntersection.size > 0) {\n      throw new Error(\n        `The following keys: ${formatSet(\n          keysIntersection\n        )} are overlapping between memory and input keys of the chain variables. This can lead to unexpected behaviour. Please use input and memory keys that don't overlap.`\n      );\n    }\n\n    const availableKeys = union(inputKeysSet, memoryKeysSet);\n    for (const chain of this.chains) {\n      let missingKeys = difference(new Set(chain.inputKeys), availableKeys);\n\n      if (chain.memory) {\n        missingKeys = difference(missingKeys, new Set(chain.memory.memoryKeys));\n      }\n\n      if (missingKeys.size > 0) {\n        throw new Error(\n          `Missing variables for chain \"${chain._chainType()}\": ${formatSet(\n            missingKeys\n          )}. Only got the following variables: ${formatSet(availableKeys)}.`\n        );\n      }\n      const outputKeysSet = new Set(chain.outputKeys);\n      const overlappingOutputKeys = intersection(availableKeys, outputKeysSet);\n      if (overlappingOutputKeys.size > 0) {\n        throw new Error(\n          `The following output variables for chain \"${chain._chainType()}\" are overlapping: ${formatSet(\n            overlappingOutputKeys\n          )}. This can lead to unexpected behaviour.`\n        );\n      }\n\n      for (const outputKey of outputKeysSet) {\n        availableKeys.add(outputKey);\n      }\n    }\n\n    if (this.outputVariables.length === 0) {\n      if (this.returnAll) {\n        const outputKeys = difference(availableKeys, inputKeysSet);\n        this.outputVariables = Array.from(outputKeys);\n      } else {\n        this.outputVariables = this.chains[this.chains.length - 1].outputKeys;\n      }\n    } else {\n      const missingKeys = difference(\n        new Set(this.outputVariables),\n        new Set(availableKeys)\n      );\n      if (missingKeys.size > 0) {\n        throw new Error(\n          `The following output variables were expected to be in the final chain output but were not found: ${formatSet(\n            missingKeys\n          )}.`\n        );\n      }\n    }\n  }\n\n  /** @ignore */\n  async _call(\n    values: ChainValues,\n    runManager?: CallbackManagerForChainRun\n  ): Promise<ChainValues> {\n    let input: ChainValues = {};\n    const allChainValues: ChainValues = values;\n    let i = 0;\n    for (const chain of this.chains) {\n      i += 1;\n      input = await chain.call(\n        allChainValues,\n        runManager?.getChild(`step_${i}`)\n      );\n      for (const key of Object.keys(input)) {\n        allChainValues[key] = input[key];\n      }\n    }\n    const output: ChainValues = {};\n    for (const key of this.outputVariables) {\n      output[key] = allChainValues[key];\n    }\n\n    return output;\n  }\n\n  _chainType() {\n    return \"sequential_chain\" as const;\n  }\n\n  static async deserialize(data: SerializedSequentialChain) {\n    const chains: BaseChain[] = [];\n    const inputVariables: string[] = data.input_variables;\n    const outputVariables: string[] = data.output_variables;\n    const serializedChains = data.chains;\n    for (const serializedChain of serializedChains) {\n      const deserializedChain = await BaseChain.deserialize(serializedChain);\n      chains.push(deserializedChain);\n    }\n    return new SequentialChain({ chains, inputVariables, outputVariables });\n  }\n\n  serialize(): SerializedSequentialChain {\n    const chains: SerializedBaseChain[] = [];\n    for (const chain of this.chains) {\n      chains.push(chain.serialize());\n    }\n    return {\n      _type: this._chainType(),\n      input_variables: this.inputVariables,\n      output_variables: this.outputVariables,\n      chains,\n    };\n  }\n}\n\n/**\n * Interface for the input parameters of the SimpleSequentialChain class.\n */\nexport interface SimpleSequentialChainInput extends ChainInputs {\n  /** Array of chains to run as a sequence. The chains are run in order they appear in the array. */\n  chains: Array<BaseChain>;\n  /** Whether or not to trim the intermediate outputs. */\n  trimOutputs?: boolean;\n}\n\n/**\n * Simple chain where a single string output of one chain is fed directly into the next.\n * @augments BaseChain\n * @augments SimpleSequentialChainInput\n *\n * @example\n * ```ts\n * import { SimpleSequentialChain, LLMChain } from \"@langchain/classic/chains\";\n * import { OpenAI } from \"langchain/llms/openai\";\n * import { PromptTemplate } from \"langchain/prompts\";\n *\n * // This is an LLMChain to write a synopsis given a title of a play.\n * const llm = new OpenAI({ temperature: 0 });\n * const template = `You are a playwright. Given the title of play, it is your job to write a synopsis for that title.\n *\n * Title: {title}\n * Playwright: This is a synopsis for the above play:`\n * const promptTemplate = new PromptTemplate({ template, inputVariables: [\"title\"] });\n * const synopsisChain = new LLMChain({ llm, prompt: promptTemplate });\n *\n *\n * // This is an LLMChain to write a review of a play given a synopsis.\n * const reviewLLM = new OpenAI({ temperature: 0 })\n * const reviewTemplate = `You are a play critic from the New York Times. Given the synopsis of play, it is your job to write a review for that play.\n *\n * Play Synopsis:\n * {synopsis}\n * Review from a New York Times play critic of the above play:`\n * const reviewPromptTemplate = new PromptTemplate({ template: reviewTemplate, inputVariables: [\"synopsis\"] });\n * const reviewChain = new LLMChain({ llm: reviewLLM, prompt: reviewPromptTemplate });\n *\n * const overallChain = new SimpleSequentialChain({chains: [synopsisChain, reviewChain], verbose:true})\n * const review = await overallChain.run(\"Tragedy at sunset on the beach\")\n * // the variable review contains resulting play review.\n * ```\n */\nexport class SimpleSequentialChain\n  extends BaseChain\n  implements SimpleSequentialChainInput\n{\n  static lc_name() {\n    return \"SimpleSequentialChain\";\n  }\n\n  chains: Array<BaseChain>;\n\n  inputKey = \"input\";\n\n  outputKey = \"output\";\n\n  trimOutputs: boolean;\n\n  get inputKeys() {\n    return [this.inputKey];\n  }\n\n  get outputKeys(): string[] {\n    return [this.outputKey];\n  }\n\n  constructor(fields: SimpleSequentialChainInput) {\n    super(fields);\n    this.chains = fields.chains;\n    this.trimOutputs = fields.trimOutputs ?? false;\n    this._validateChains();\n  }\n\n  /** @ignore */\n  _validateChains() {\n    for (const chain of this.chains) {\n      if (\n        chain.inputKeys.filter((k) => !chain.memory?.memoryKeys.includes(k))\n          .length !== 1\n      ) {\n        throw new Error(\n          `Chains used in SimpleSequentialChain should all have one input, got ${\n            chain.inputKeys.length\n          } for ${chain._chainType()}.`\n        );\n      }\n      if (chain.outputKeys.length !== 1) {\n        throw new Error(\n          `Chains used in SimpleSequentialChain should all have one output, got ${\n            chain.outputKeys.length\n          } for ${chain._chainType()}.`\n        );\n      }\n    }\n  }\n\n  /** @ignore */\n  async _call(\n    values: ChainValues,\n    runManager?: CallbackManagerForChainRun\n  ): Promise<ChainValues> {\n    let input: string = values[this.inputKey];\n    let i = 0;\n    for (const chain of this.chains) {\n      i += 1;\n      input = (\n        await chain.call(\n          { [chain.inputKeys[0]]: input, signal: values.signal },\n          runManager?.getChild(`step_${i}`)\n        )\n      )[chain.outputKeys[0]];\n      if (this.trimOutputs) {\n        input = input.trim();\n      }\n      await runManager?.handleText(input);\n    }\n    return { [this.outputKey]: input };\n  }\n\n  _chainType() {\n    return \"simple_sequential_chain\" as const;\n  }\n\n  static async deserialize(data: SerializedSimpleSequentialChain) {\n    const chains: Array<BaseChain> = [];\n    const serializedChains = data.chains;\n    for (const serializedChain of serializedChains) {\n      const deserializedChain = await BaseChain.deserialize(serializedChain);\n      chains.push(deserializedChain);\n    }\n    return new SimpleSequentialChain({ chains });\n  }\n\n  serialize(): SerializedSimpleSequentialChain {\n    const chains: Array<SerializedBaseChain> = [];\n    for (const chain of this.chains) {\n      chains.push(chain.serialize());\n    }\n    return {\n      _type: this._chainType(),\n      chains,\n    };\n  }\n}\n"],"mappings":";;;AAUA,SAAS,UAAU,OAAoB;CACrC,OAAO,MAAM,KAAK,KAAK,CAAC,CACrB,KAAK,MAAM,IAAI,EAAE,EAAE,CAAC,CACpB,KAAK,IAAI;AACd;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8DA,IAAa,kBAAb,MAAa,wBAAwBA,aAAAA,UAA0C;CAC7E,OAAO,UAAU;EACf,OAAO;CACT;CAEA;CAEA;CAEA;CAEA;CAEA,IAAI,YAAY;EACd,OAAO,KAAK;CACd;CAEA,IAAI,aAAuB;EACzB,OAAO,KAAK;CACd;CAEA,YAAY,QAA8B;EACxC,MAAM,MAAM;EACZ,KAAK,SAAS,OAAO;EACrB,KAAK,iBAAiB,OAAO;EAC7B,KAAK,kBAAkB,OAAO,mBAAmB,CAAC;EAClD,IAAI,KAAK,gBAAgB,SAAS,KAAK,OAAO,WAC5C,MAAM,IAAI,MACR,qIACF;EAEF,KAAK,YAAY,OAAO,aAAa;EACrC,KAAK,gBAAgB;CACvB;;CAGA,kBAAkB;EAChB,IAAI,KAAK,OAAO,WAAW,GACzB,MAAM,IAAI,MAAM,gDAAgD;EAGlE,MAAM,aAAa,KAAK,QAAQ,cAAc,CAAC;EAC/C,MAAM,eAAe,IAAI,IAAI,KAAK,SAAS;EAC3C,MAAM,gBAAgB,IAAI,IAAI,UAAU;EACxC,MAAM,mBAAmBC,YAAAA,aAAa,cAAc,aAAa;EACjE,IAAI,iBAAiB,OAAO,GAC1B,MAAM,IAAI,MACR,uBAAuB,UACrB,gBACF,EAAE,mKACJ;EAGF,MAAM,gBAAgBC,YAAAA,MAAM,cAAc,aAAa;EACvD,KAAK,MAAM,SAAS,KAAK,QAAQ;GAC/B,IAAI,cAAcC,YAAAA,WAAW,IAAI,IAAI,MAAM,SAAS,GAAG,aAAa;GAEpE,IAAI,MAAM,QACR,cAAcA,YAAAA,WAAW,aAAa,IAAI,IAAI,MAAM,OAAO,UAAU,CAAC;GAGxE,IAAI,YAAY,OAAO,GACrB,MAAM,IAAI,MACR,gCAAgC,MAAM,WAAW,EAAE,KAAK,UACtD,WACF,EAAE,sCAAsC,UAAU,aAAa,EAAE,EACnE;GAEF,MAAM,gBAAgB,IAAI,IAAI,MAAM,UAAU;GAC9C,MAAM,wBAAwBF,YAAAA,aAAa,eAAe,aAAa;GACvE,IAAI,sBAAsB,OAAO,GAC/B,MAAM,IAAI,MACR,6CAA6C,MAAM,WAAW,EAAE,qBAAqB,UACnF,qBACF,EAAE,yCACJ;GAGF,KAAK,MAAM,aAAa,eACtB,cAAc,IAAI,SAAS;EAE/B;EAEA,IAAI,KAAK,gBAAgB,WAAW,GAAG;GACrC,IAAI,KAAK,WAAW;IAClB,MAAM,aAAaE,YAAAA,WAAW,eAAe,YAAY;IACzD,KAAK,kBAAkB,MAAM,KAAK,UAAU;GAC9C,OACE,KAAK,kBAAkB,KAAK,OAAO,KAAK,OAAO,SAAS,EAAE,CAAC;EAE/D,OAAO;GACL,MAAM,cAAcA,YAAAA,WAClB,IAAI,IAAI,KAAK,eAAe,GAC5B,IAAI,IAAI,aAAa,CACvB;GACA,IAAI,YAAY,OAAO,GACrB,MAAM,IAAI,MACR,oGAAoG,UAClG,WACF,EAAE,EACJ;EAEJ;CACF;;CAGA,MAAM,MACJ,QACA,YACsB;EACtB,IAAI,QAAqB,CAAC;EAC1B,MAAM,iBAA8B;EACpC,IAAI,IAAI;EACR,KAAK,MAAM,SAAS,KAAK,QAAQ;GAC/B,KAAK;GACL,QAAQ,MAAM,MAAM,KAClB,gBACA,YAAY,SAAS,QAAQ,GAAG,CAClC;GACA,KAAK,MAAM,OAAO,OAAO,KAAK,KAAK,GACjC,eAAe,OAAO,MAAM;EAEhC;EACA,MAAM,SAAsB,CAAC;EAC7B,KAAK,MAAM,OAAO,KAAK,iBACrB,OAAO,OAAO,eAAe;EAG/B,OAAO;CACT;CAEA,aAAa;EACX,OAAO;CACT;CAEA,aAAa,YAAY,MAAiC;EACxD,MAAM,SAAsB,CAAC;EAC7B,MAAM,iBAA2B,KAAK;EACtC,MAAM,kBAA4B,KAAK;EACvC,MAAM,mBAAmB,KAAK;EAC9B,KAAK,MAAM,mBAAmB,kBAAkB;GAC9C,MAAM,oBAAoB,MAAMH,aAAAA,UAAU,YAAY,eAAe;GACrE,OAAO,KAAK,iBAAiB;EAC/B;EACA,OAAO,IAAI,gBAAgB;GAAE;GAAQ;GAAgB;EAAgB,CAAC;CACxE;CAEA,YAAuC;EACrC,MAAM,SAAgC,CAAC;EACvC,KAAK,MAAM,SAAS,KAAK,QACvB,OAAO,KAAK,MAAM,UAAU,CAAC;EAE/B,OAAO;GACL,OAAO,KAAK,WAAW;GACvB,iBAAiB,KAAK;GACtB,kBAAkB,KAAK;GACvB;EACF;CACF;AACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAgDA,IAAa,wBAAb,MAAa,8BACHA,aAAAA,UAEV;CACE,OAAO,UAAU;EACf,OAAO;CACT;CAEA;CAEA,WAAW;CAEX,YAAY;CAEZ;CAEA,IAAI,YAAY;EACd,OAAO,CAAC,KAAK,QAAQ;CACvB;CAEA,IAAI,aAAuB;EACzB,OAAO,CAAC,KAAK,SAAS;CACxB;CAEA,YAAY,QAAoC;EAC9C,MAAM,MAAM;EACZ,KAAK,SAAS,OAAO;EACrB,KAAK,cAAc,OAAO,eAAe;EACzC,KAAK,gBAAgB;CACvB;;CAGA,kBAAkB;EAChB,KAAK,MAAM,SAAS,KAAK,QAAQ;GAC/B,IACE,MAAM,UAAU,QAAQ,MAAM,CAAC,MAAM,QAAQ,WAAW,SAAS,CAAC,CAAC,CAAC,CACjE,WAAW,GAEd,MAAM,IAAI,MACR,uEACE,MAAM,UAAU,OACjB,OAAO,MAAM,WAAW,EAAE,EAC7B;GAEF,IAAI,MAAM,WAAW,WAAW,GAC9B,MAAM,IAAI,MACR,wEACE,MAAM,WAAW,OAClB,OAAO,MAAM,WAAW,EAAE,EAC7B;EAEJ;CACF;;CAGA,MAAM,MACJ,QACA,YACsB;EACtB,IAAI,QAAgB,OAAO,KAAK;EAChC,IAAI,IAAI;EACR,KAAK,MAAM,SAAS,KAAK,QAAQ;GAC/B,KAAK;GACL,SACE,MAAM,MAAM,KACV;KAAG,MAAM,UAAU,KAAK;IAAO,QAAQ,OAAO;GAAO,GACrD,YAAY,SAAS,QAAQ,GAAG,CAClC,EAAA,CACA,MAAM,WAAW;GACnB,IAAI,KAAK,aACP,QAAQ,MAAM,KAAK;GAErB,MAAM,YAAY,WAAW,KAAK;EACpC;EACA,OAAO,GAAG,KAAK,YAAY,MAAM;CACnC;CAEA,aAAa;EACX,OAAO;CACT;CAEA,aAAa,YAAY,MAAuC;EAC9D,MAAM,SAA2B,CAAC;EAClC,MAAM,mBAAmB,KAAK;EAC9B,KAAK,MAAM,mBAAmB,kBAAkB;GAC9C,MAAM,oBAAoB,MAAMA,aAAAA,UAAU,YAAY,eAAe;GACrE,OAAO,KAAK,iBAAiB;EAC/B;EACA,OAAO,IAAI,sBAAsB,EAAE,OAAO,CAAC;CAC7C;CAEA,YAA6C;EAC3C,MAAM,SAAqC,CAAC;EAC5C,KAAK,MAAM,SAAS,KAAK,QACvB,OAAO,KAAK,MAAM,UAAU,CAAC;EAE/B,OAAO;GACL,OAAO,KAAK,WAAW;GACvB;EACF;CACF;AACF"}

package/dist/chains/sequential_chain.js

@@ -91,11 +91,12 @@ var SequentialChain = class SequentialChain extends BaseChain {
 			if (overlappingOutputKeys.size > 0) throw new Error(`The following output variables for chain "${chain._chainType()}" are overlapping: ${formatSet(overlappingOutputKeys)}. This can lead to unexpected behaviour.`);
 			for (const outputKey of outputKeysSet) availableKeys.add(outputKey);
 		}
-		if (this.outputVariables.length === 0) if (this.returnAll) {
-			const outputKeys = difference(availableKeys, inputKeysSet);
-			this.outputVariables = Array.from(outputKeys);
-		} else this.outputVariables = this.chains[this.chains.length - 1].outputKeys;
-		else {
+		if (this.outputVariables.length === 0) {
+			if (this.returnAll) {
+				const outputKeys = difference(availableKeys, inputKeysSet);
+				this.outputVariables = Array.from(outputKeys);
+			} else this.outputVariables = this.chains[this.chains.length - 1].outputKeys;
+		} else {
 			const missingKeys = difference(new Set(this.outputVariables), new Set(availableKeys));
 			if (missingKeys.size > 0) throw new Error(`The following output variables were expected to be in the final chain output but were not found: ${formatSet(missingKeys)}.`);
 		}

package/dist/chains/sequential_chain.js.map

@@ -1 +1 @@
-{"version":3,"file":"sequential_chain.js","names":[],"sources":["../../src/chains/sequential_chain.ts"],"sourcesContent":["import { ChainValues } from \"@langchain/core/utils/types\";\nimport { CallbackManagerForChainRun } from \"@langchain/core/callbacks/manager\";\nimport { BaseChain, ChainInputs } from \"./base.js\";\nimport {\n  SerializedBaseChain,\n  SerializedSequentialChain,\n  SerializedSimpleSequentialChain,\n} from \"./serde.js\";\nimport { intersection, union, difference } from \"../util/set.js\";\n\nfunction formatSet(input: Set<string>) {\n  return Array.from(input)\n    .map((i) => `\"${i}\"`)\n    .join(\", \");\n}\n\n/**\n * Interface for the input parameters of the SequentialChain class.\n */\nexport interface SequentialChainInput extends ChainInputs {\n  /** Array of chains to run as a sequence. The chains are run in order they appear in the array. */\n  chains: BaseChain[];\n  /** Defines which variables should be passed as initial input to the first chain. */\n  inputVariables: string[];\n  /** Which variables should be returned as a result of executing the chain. If not specified, output of the last of the chains is used. */\n  outputVariables?: string[];\n  /** Whether or not to return all intermediate outputs and variables (excluding initial input variables). */\n  returnAll?: boolean;\n}\n\n/**\n * Chain where the outputs of one chain feed directly into next.\n * @example\n * ```typescript\n * const promptTemplate = new PromptTemplate({\n *   template: `You are a playwright. Given the title of play and the era it is set in, it is your job to write a synopsis for that title.\n * Title: {title}\n * Era: {era}\n * Playwright: This is a synopsis for the above play:`,\n *   inputVariables: [\"title\", \"era\"],\n * });\n\n * const reviewPromptTemplate = new PromptTemplate({\n *   template: `You are a play critic from the New York Times. Given the synopsis of play, it is your job to write a review for that play.\n *   \n *     Play Synopsis:\n *     {synopsis}\n *     Review from a New York Times play critic of the above play:`,\n *   inputVariables: [\"synopsis\"],\n * });\n\n * const overallChain = new SequentialChain({\n *   chains: [\n *     new LLMChain({\n *       llm: new ChatOpenAI({ model: \"gpt-4o-mini\", temperature: 0 }),\n *       prompt: promptTemplate,\n *       outputKey: \"synopsis\",\n *     }),\n *     new LLMChain({\n *       llm: new OpenAI({ model: \"gpt-4o-mini\", temperature: 0 }),\n *       prompt: reviewPromptTemplate,\n *       outputKey: \"review\",\n *     }),\n *   ],\n *   inputVariables: [\"era\", \"title\"],\n *   outputVariables: [\"synopsis\", \"review\"],\n *   verbose: true,\n * });\n\n * const chainExecutionResult = await overallChain.call({\n *   title: \"Tragedy at sunset on the beach\",\n *   era: \"Victorian England\",\n * });\n * console.log(chainExecutionResult);\n * ```\n */\nexport class SequentialChain extends BaseChain implements SequentialChainInput {\n  static lc_name() {\n    return \"SequentialChain\";\n  }\n\n  chains: BaseChain[];\n\n  inputVariables: string[];\n\n  outputVariables: string[];\n\n  returnAll?: boolean | undefined;\n\n  get inputKeys() {\n    return this.inputVariables;\n  }\n\n  get outputKeys(): string[] {\n    return this.outputVariables;\n  }\n\n  constructor(fields: SequentialChainInput) {\n    super(fields);\n    this.chains = fields.chains;\n    this.inputVariables = fields.inputVariables;\n    this.outputVariables = fields.outputVariables ?? [];\n    if (this.outputVariables.length > 0 && fields.returnAll) {\n      throw new Error(\n        \"Either specify variables to return using `outputVariables` or use `returnAll` param. Cannot apply both conditions at the same time.\"\n      );\n    }\n    this.returnAll = fields.returnAll ?? false;\n    this._validateChains();\n  }\n\n  /** @ignore */\n  _validateChains() {\n    if (this.chains.length === 0) {\n      throw new Error(\"Sequential chain must have at least one chain.\");\n    }\n\n    const memoryKeys = this.memory?.memoryKeys ?? [];\n    const inputKeysSet = new Set(this.inputKeys);\n    const memoryKeysSet = new Set(memoryKeys);\n    const keysIntersection = intersection(inputKeysSet, memoryKeysSet);\n    if (keysIntersection.size > 0) {\n      throw new Error(\n        `The following keys: ${formatSet(\n          keysIntersection\n        )} are overlapping between memory and input keys of the chain variables. This can lead to unexpected behaviour. Please use input and memory keys that don't overlap.`\n      );\n    }\n\n    const availableKeys = union(inputKeysSet, memoryKeysSet);\n    for (const chain of this.chains) {\n      let missingKeys = difference(new Set(chain.inputKeys), availableKeys);\n\n      if (chain.memory) {\n        missingKeys = difference(missingKeys, new Set(chain.memory.memoryKeys));\n      }\n\n      if (missingKeys.size > 0) {\n        throw new Error(\n          `Missing variables for chain \"${chain._chainType()}\": ${formatSet(\n            missingKeys\n          )}. Only got the following variables: ${formatSet(availableKeys)}.`\n        );\n      }\n      const outputKeysSet = new Set(chain.outputKeys);\n      const overlappingOutputKeys = intersection(availableKeys, outputKeysSet);\n      if (overlappingOutputKeys.size > 0) {\n        throw new Error(\n          `The following output variables for chain \"${chain._chainType()}\" are overlapping: ${formatSet(\n            overlappingOutputKeys\n          )}. This can lead to unexpected behaviour.`\n        );\n      }\n\n      for (const outputKey of outputKeysSet) {\n        availableKeys.add(outputKey);\n      }\n    }\n\n    if (this.outputVariables.length === 0) {\n      if (this.returnAll) {\n        const outputKeys = difference(availableKeys, inputKeysSet);\n        this.outputVariables = Array.from(outputKeys);\n      } else {\n        this.outputVariables = this.chains[this.chains.length - 1].outputKeys;\n      }\n    } else {\n      const missingKeys = difference(\n        new Set(this.outputVariables),\n        new Set(availableKeys)\n      );\n      if (missingKeys.size > 0) {\n        throw new Error(\n          `The following output variables were expected to be in the final chain output but were not found: ${formatSet(\n            missingKeys\n          )}.`\n        );\n      }\n    }\n  }\n\n  /** @ignore */\n  async _call(\n    values: ChainValues,\n    runManager?: CallbackManagerForChainRun\n  ): Promise<ChainValues> {\n    let input: ChainValues = {};\n    const allChainValues: ChainValues = values;\n    let i = 0;\n    for (const chain of this.chains) {\n      i += 1;\n      input = await chain.call(\n        allChainValues,\n        runManager?.getChild(`step_${i}`)\n      );\n      for (const key of Object.keys(input)) {\n        allChainValues[key] = input[key];\n      }\n    }\n    const output: ChainValues = {};\n    for (const key of this.outputVariables) {\n      output[key] = allChainValues[key];\n    }\n\n    return output;\n  }\n\n  _chainType() {\n    return \"sequential_chain\" as const;\n  }\n\n  static async deserialize(data: SerializedSequentialChain) {\n    const chains: BaseChain[] = [];\n    const inputVariables: string[] = data.input_variables;\n    const outputVariables: string[] = data.output_variables;\n    const serializedChains = data.chains;\n    for (const serializedChain of serializedChains) {\n      const deserializedChain = await BaseChain.deserialize(serializedChain);\n      chains.push(deserializedChain);\n    }\n    return new SequentialChain({ chains, inputVariables, outputVariables });\n  }\n\n  serialize(): SerializedSequentialChain {\n    const chains: SerializedBaseChain[] = [];\n    for (const chain of this.chains) {\n      chains.push(chain.serialize());\n    }\n    return {\n      _type: this._chainType(),\n      input_variables: this.inputVariables,\n      output_variables: this.outputVariables,\n      chains,\n    };\n  }\n}\n\n/**\n * Interface for the input parameters of the SimpleSequentialChain class.\n */\nexport interface SimpleSequentialChainInput extends ChainInputs {\n  /** Array of chains to run as a sequence. The chains are run in order they appear in the array. */\n  chains: Array<BaseChain>;\n  /** Whether or not to trim the intermediate outputs. */\n  trimOutputs?: boolean;\n}\n\n/**\n * Simple chain where a single string output of one chain is fed directly into the next.\n * @augments BaseChain\n * @augments SimpleSequentialChainInput\n *\n * @example\n * ```ts\n * import { SimpleSequentialChain, LLMChain } from \"@langchain/classic/chains\";\n * import { OpenAI } from \"langchain/llms/openai\";\n * import { PromptTemplate } from \"langchain/prompts\";\n *\n * // This is an LLMChain to write a synopsis given a title of a play.\n * const llm = new OpenAI({ temperature: 0 });\n * const template = `You are a playwright. Given the title of play, it is your job to write a synopsis for that title.\n *\n * Title: {title}\n * Playwright: This is a synopsis for the above play:`\n * const promptTemplate = new PromptTemplate({ template, inputVariables: [\"title\"] });\n * const synopsisChain = new LLMChain({ llm, prompt: promptTemplate });\n *\n *\n * // This is an LLMChain to write a review of a play given a synopsis.\n * const reviewLLM = new OpenAI({ temperature: 0 })\n * const reviewTemplate = `You are a play critic from the New York Times. Given the synopsis of play, it is your job to write a review for that play.\n *\n * Play Synopsis:\n * {synopsis}\n * Review from a New York Times play critic of the above play:`\n * const reviewPromptTemplate = new PromptTemplate({ template: reviewTemplate, inputVariables: [\"synopsis\"] });\n * const reviewChain = new LLMChain({ llm: reviewLLM, prompt: reviewPromptTemplate });\n *\n * const overallChain = new SimpleSequentialChain({chains: [synopsisChain, reviewChain], verbose:true})\n * const review = await overallChain.run(\"Tragedy at sunset on the beach\")\n * // the variable review contains resulting play review.\n * ```\n */\nexport class SimpleSequentialChain\n  extends BaseChain\n  implements SimpleSequentialChainInput\n{\n  static lc_name() {\n    return \"SimpleSequentialChain\";\n  }\n\n  chains: Array<BaseChain>;\n\n  inputKey = \"input\";\n\n  outputKey = \"output\";\n\n  trimOutputs: boolean;\n\n  get inputKeys() {\n    return [this.inputKey];\n  }\n\n  get outputKeys(): string[] {\n    return [this.outputKey];\n  }\n\n  constructor(fields: SimpleSequentialChainInput) {\n    super(fields);\n    this.chains = fields.chains;\n    this.trimOutputs = fields.trimOutputs ?? false;\n    this._validateChains();\n  }\n\n  /** @ignore */\n  _validateChains() {\n    for (const chain of this.chains) {\n      if (\n        chain.inputKeys.filter((k) => !chain.memory?.memoryKeys.includes(k))\n          .length !== 1\n      ) {\n        throw new Error(\n          `Chains used in SimpleSequentialChain should all have one input, got ${\n            chain.inputKeys.length\n          } for ${chain._chainType()}.`\n        );\n      }\n      if (chain.outputKeys.length !== 1) {\n        throw new Error(\n          `Chains used in SimpleSequentialChain should all have one output, got ${\n            chain.outputKeys.length\n          } for ${chain._chainType()}.`\n        );\n      }\n    }\n  }\n\n  /** @ignore */\n  async _call(\n    values: ChainValues,\n    runManager?: CallbackManagerForChainRun\n  ): Promise<ChainValues> {\n    let input: string = values[this.inputKey];\n    let i = 0;\n    for (const chain of this.chains) {\n      i += 1;\n      input = (\n        await chain.call(\n          { [chain.inputKeys[0]]: input, signal: values.signal },\n          runManager?.getChild(`step_${i}`)\n        )\n      )[chain.outputKeys[0]];\n      if (this.trimOutputs) {\n        input = input.trim();\n      }\n      await runManager?.handleText(input);\n    }\n    return { [this.outputKey]: input };\n  }\n\n  _chainType() {\n    return \"simple_sequential_chain\" as const;\n  }\n\n  static async deserialize(data: SerializedSimpleSequentialChain) {\n    const chains: Array<BaseChain> = [];\n    const serializedChains = data.chains;\n    for (const serializedChain of serializedChains) {\n      const deserializedChain = await BaseChain.deserialize(serializedChain);\n      chains.push(deserializedChain);\n    }\n    return new SimpleSequentialChain({ chains });\n  }\n\n  serialize(): SerializedSimpleSequentialChain {\n    const chains: Array<SerializedBaseChain> = [];\n    for (const chain of this.chains) {\n      chains.push(chain.serialize());\n    }\n    return {\n      _type: this._chainType(),\n      chains,\n    };\n  }\n}\n"],"mappings":";;;AAUA,SAAS,UAAU,OAAoB;CACrC,OAAO,MAAM,KAAK,KAAK,CAAC,CACrB,KAAK,MAAM,IAAI,EAAE,EAAE,CAAC,CACpB,KAAK,IAAI;AACd;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8DA,IAAa,kBAAb,MAAa,wBAAwB,UAA0C;CAC7E,OAAO,UAAU;EACf,OAAO;CACT;CAEA;CAEA;CAEA;CAEA;CAEA,IAAI,YAAY;EACd,OAAO,KAAK;CACd;CAEA,IAAI,aAAuB;EACzB,OAAO,KAAK;CACd;CAEA,YAAY,QAA8B;EACxC,MAAM,MAAM;EACZ,KAAK,SAAS,OAAO;EACrB,KAAK,iBAAiB,OAAO;EAC7B,KAAK,kBAAkB,OAAO,mBAAmB,CAAC;EAClD,IAAI,KAAK,gBAAgB,SAAS,KAAK,OAAO,WAC5C,MAAM,IAAI,MACR,qIACF;EAEF,KAAK,YAAY,OAAO,aAAa;EACrC,KAAK,gBAAgB;CACvB;;CAGA,kBAAkB;EAChB,IAAI,KAAK,OAAO,WAAW,GACzB,MAAM,IAAI,MAAM,gDAAgD;EAGlE,MAAM,aAAa,KAAK,QAAQ,cAAc,CAAC;EAC/C,MAAM,eAAe,IAAI,IAAI,KAAK,SAAS;EAC3C,MAAM,gBAAgB,IAAI,IAAI,UAAU;EACxC,MAAM,mBAAmB,aAAa,cAAc,aAAa;EACjE,IAAI,iBAAiB,OAAO,GAC1B,MAAM,IAAI,MACR,uBAAuB,UACrB,gBACF,EAAE,mKACJ;EAGF,MAAM,gBAAgB,MAAM,cAAc,aAAa;EACvD,KAAK,MAAM,SAAS,KAAK,QAAQ;GAC/B,IAAI,cAAc,WAAW,IAAI,IAAI,MAAM,SAAS,GAAG,aAAa;GAEpE,IAAI,MAAM,QACR,cAAc,WAAW,aAAa,IAAI,IAAI,MAAM,OAAO,UAAU,CAAC;GAGxE,IAAI,YAAY,OAAO,GACrB,MAAM,IAAI,MACR,gCAAgC,MAAM,WAAW,EAAE,KAAK,UACtD,WACF,EAAE,sCAAsC,UAAU,aAAa,EAAE,EACnE;GAEF,MAAM,gBAAgB,IAAI,IAAI,MAAM,UAAU;GAC9C,MAAM,wBAAwB,aAAa,eAAe,aAAa;GACvE,IAAI,sBAAsB,OAAO,GAC/B,MAAM,IAAI,MACR,6CAA6C,MAAM,WAAW,EAAE,qBAAqB,UACnF,qBACF,EAAE,yCACJ;GAGF,KAAK,MAAM,aAAa,eACtB,cAAc,IAAI,SAAS;EAE/B;EAEA,IAAI,KAAK,gBAAgB,WAAW,GAClC,IAAI,KAAK,WAAW;GAClB,MAAM,aAAa,WAAW,eAAe,YAAY;GACzD,KAAK,kBAAkB,MAAM,KAAK,UAAU;EAC9C,OACE,KAAK,kBAAkB,KAAK,OAAO,KAAK,OAAO,SAAS,EAAE,CAAC;OAExD;GACL,MAAM,cAAc,WAClB,IAAI,IAAI,KAAK,eAAe,GAC5B,IAAI,IAAI,aAAa,CACvB;GACA,IAAI,YAAY,OAAO,GACrB,MAAM,IAAI,MACR,oGAAoG,UAClG,WACF,EAAE,EACJ;EAEJ;CACF;;CAGA,MAAM,MACJ,QACA,YACsB;EACtB,IAAI,QAAqB,CAAC;EAC1B,MAAM,iBAA8B;EACpC,IAAI,IAAI;EACR,KAAK,MAAM,SAAS,KAAK,QAAQ;GAC/B,KAAK;GACL,QAAQ,MAAM,MAAM,KAClB,gBACA,YAAY,SAAS,QAAQ,GAAG,CAClC;GACA,KAAK,MAAM,OAAO,OAAO,KAAK,KAAK,GACjC,eAAe,OAAO,MAAM;EAEhC;EACA,MAAM,SAAsB,CAAC;EAC7B,KAAK,MAAM,OAAO,KAAK,iBACrB,OAAO,OAAO,eAAe;EAG/B,OAAO;CACT;CAEA,aAAa;EACX,OAAO;CACT;CAEA,aAAa,YAAY,MAAiC;EACxD,MAAM,SAAsB,CAAC;EAC7B,MAAM,iBAA2B,KAAK;EACtC,MAAM,kBAA4B,KAAK;EACvC,MAAM,mBAAmB,KAAK;EAC9B,KAAK,MAAM,mBAAmB,kBAAkB;GAC9C,MAAM,oBAAoB,MAAM,UAAU,YAAY,eAAe;GACrE,OAAO,KAAK,iBAAiB;EAC/B;EACA,OAAO,IAAI,gBAAgB;GAAE;GAAQ;GAAgB;EAAgB,CAAC;CACxE;CAEA,YAAuC;EACrC,MAAM,SAAgC,CAAC;EACvC,KAAK,MAAM,SAAS,KAAK,QACvB,OAAO,KAAK,MAAM,UAAU,CAAC;EAE/B,OAAO;GACL,OAAO,KAAK,WAAW;GACvB,iBAAiB,KAAK;GACtB,kBAAkB,KAAK;GACvB;EACF;CACF;AACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAgDA,IAAa,wBAAb,MAAa,8BACH,UAEV;CACE,OAAO,UAAU;EACf,OAAO;CACT;CAEA;CAEA,WAAW;CAEX,YAAY;CAEZ;CAEA,IAAI,YAAY;EACd,OAAO,CAAC,KAAK,QAAQ;CACvB;CAEA,IAAI,aAAuB;EACzB,OAAO,CAAC,KAAK,SAAS;CACxB;CAEA,YAAY,QAAoC;EAC9C,MAAM,MAAM;EACZ,KAAK,SAAS,OAAO;EACrB,KAAK,cAAc,OAAO,eAAe;EACzC,KAAK,gBAAgB;CACvB;;CAGA,kBAAkB;EAChB,KAAK,MAAM,SAAS,KAAK,QAAQ;GAC/B,IACE,MAAM,UAAU,QAAQ,MAAM,CAAC,MAAM,QAAQ,WAAW,SAAS,CAAC,CAAC,CAAC,CACjE,WAAW,GAEd,MAAM,IAAI,MACR,uEACE,MAAM,UAAU,OACjB,OAAO,MAAM,WAAW,EAAE,EAC7B;GAEF,IAAI,MAAM,WAAW,WAAW,GAC9B,MAAM,IAAI,MACR,wEACE,MAAM,WAAW,OAClB,OAAO,MAAM,WAAW,EAAE,EAC7B;EAEJ;CACF;;CAGA,MAAM,MACJ,QACA,YACsB;EACtB,IAAI,QAAgB,OAAO,KAAK;EAChC,IAAI,IAAI;EACR,KAAK,MAAM,SAAS,KAAK,QAAQ;GAC/B,KAAK;GACL,SACE,MAAM,MAAM,KACV;KAAG,MAAM,UAAU,KAAK;IAAO,QAAQ,OAAO;GAAO,GACrD,YAAY,SAAS,QAAQ,GAAG,CAClC,EAAA,CACA,MAAM,WAAW;GACnB,IAAI,KAAK,aACP,QAAQ,MAAM,KAAK;GAErB,MAAM,YAAY,WAAW,KAAK;EACpC;EACA,OAAO,GAAG,KAAK,YAAY,MAAM;CACnC;CAEA,aAAa;EACX,OAAO;CACT;CAEA,aAAa,YAAY,MAAuC;EAC9D,MAAM,SAA2B,CAAC;EAClC,MAAM,mBAAmB,KAAK;EAC9B,KAAK,MAAM,mBAAmB,kBAAkB;GAC9C,MAAM,oBAAoB,MAAM,UAAU,YAAY,eAAe;GACrE,OAAO,KAAK,iBAAiB;EAC/B;EACA,OAAO,IAAI,sBAAsB,EAAE,OAAO,CAAC;CAC7C;CAEA,YAA6C;EAC3C,MAAM,SAAqC,CAAC;EAC5C,KAAK,MAAM,SAAS,KAAK,QACvB,OAAO,KAAK,MAAM,UAAU,CAAC;EAE/B,OAAO;GACL,OAAO,KAAK,WAAW;GACvB;EACF;CACF;AACF"}
+{"version":3,"file":"sequential_chain.js","names":[],"sources":["../../src/chains/sequential_chain.ts"],"sourcesContent":["import { ChainValues } from \"@langchain/core/utils/types\";\nimport { CallbackManagerForChainRun } from \"@langchain/core/callbacks/manager\";\nimport { BaseChain, ChainInputs } from \"./base.js\";\nimport {\n  SerializedBaseChain,\n  SerializedSequentialChain,\n  SerializedSimpleSequentialChain,\n} from \"./serde.js\";\nimport { intersection, union, difference } from \"../util/set.js\";\n\nfunction formatSet(input: Set<string>) {\n  return Array.from(input)\n    .map((i) => `\"${i}\"`)\n    .join(\", \");\n}\n\n/**\n * Interface for the input parameters of the SequentialChain class.\n */\nexport interface SequentialChainInput extends ChainInputs {\n  /** Array of chains to run as a sequence. The chains are run in order they appear in the array. */\n  chains: BaseChain[];\n  /** Defines which variables should be passed as initial input to the first chain. */\n  inputVariables: string[];\n  /** Which variables should be returned as a result of executing the chain. If not specified, output of the last of the chains is used. */\n  outputVariables?: string[];\n  /** Whether or not to return all intermediate outputs and variables (excluding initial input variables). */\n  returnAll?: boolean;\n}\n\n/**\n * Chain where the outputs of one chain feed directly into next.\n * @example\n * ```typescript\n * const promptTemplate = new PromptTemplate({\n *   template: `You are a playwright. Given the title of play and the era it is set in, it is your job to write a synopsis for that title.\n * Title: {title}\n * Era: {era}\n * Playwright: This is a synopsis for the above play:`,\n *   inputVariables: [\"title\", \"era\"],\n * });\n\n * const reviewPromptTemplate = new PromptTemplate({\n *   template: `You are a play critic from the New York Times. Given the synopsis of play, it is your job to write a review for that play.\n *   \n *     Play Synopsis:\n *     {synopsis}\n *     Review from a New York Times play critic of the above play:`,\n *   inputVariables: [\"synopsis\"],\n * });\n\n * const overallChain = new SequentialChain({\n *   chains: [\n *     new LLMChain({\n *       llm: new ChatOpenAI({ model: \"gpt-4o-mini\", temperature: 0 }),\n *       prompt: promptTemplate,\n *       outputKey: \"synopsis\",\n *     }),\n *     new LLMChain({\n *       llm: new OpenAI({ model: \"gpt-4o-mini\", temperature: 0 }),\n *       prompt: reviewPromptTemplate,\n *       outputKey: \"review\",\n *     }),\n *   ],\n *   inputVariables: [\"era\", \"title\"],\n *   outputVariables: [\"synopsis\", \"review\"],\n *   verbose: true,\n * });\n\n * const chainExecutionResult = await overallChain.call({\n *   title: \"Tragedy at sunset on the beach\",\n *   era: \"Victorian England\",\n * });\n * console.log(chainExecutionResult);\n * ```\n */\nexport class SequentialChain extends BaseChain implements SequentialChainInput {\n  static lc_name() {\n    return \"SequentialChain\";\n  }\n\n  chains: BaseChain[];\n\n  inputVariables: string[];\n\n  outputVariables: string[];\n\n  returnAll?: boolean | undefined;\n\n  get inputKeys() {\n    return this.inputVariables;\n  }\n\n  get outputKeys(): string[] {\n    return this.outputVariables;\n  }\n\n  constructor(fields: SequentialChainInput) {\n    super(fields);\n    this.chains = fields.chains;\n    this.inputVariables = fields.inputVariables;\n    this.outputVariables = fields.outputVariables ?? [];\n    if (this.outputVariables.length > 0 && fields.returnAll) {\n      throw new Error(\n        \"Either specify variables to return using `outputVariables` or use `returnAll` param. Cannot apply both conditions at the same time.\"\n      );\n    }\n    this.returnAll = fields.returnAll ?? false;\n    this._validateChains();\n  }\n\n  /** @ignore */\n  _validateChains() {\n    if (this.chains.length === 0) {\n      throw new Error(\"Sequential chain must have at least one chain.\");\n    }\n\n    const memoryKeys = this.memory?.memoryKeys ?? [];\n    const inputKeysSet = new Set(this.inputKeys);\n    const memoryKeysSet = new Set(memoryKeys);\n    const keysIntersection = intersection(inputKeysSet, memoryKeysSet);\n    if (keysIntersection.size > 0) {\n      throw new Error(\n        `The following keys: ${formatSet(\n          keysIntersection\n        )} are overlapping between memory and input keys of the chain variables. This can lead to unexpected behaviour. Please use input and memory keys that don't overlap.`\n      );\n    }\n\n    const availableKeys = union(inputKeysSet, memoryKeysSet);\n    for (const chain of this.chains) {\n      let missingKeys = difference(new Set(chain.inputKeys), availableKeys);\n\n      if (chain.memory) {\n        missingKeys = difference(missingKeys, new Set(chain.memory.memoryKeys));\n      }\n\n      if (missingKeys.size > 0) {\n        throw new Error(\n          `Missing variables for chain \"${chain._chainType()}\": ${formatSet(\n            missingKeys\n          )}. Only got the following variables: ${formatSet(availableKeys)}.`\n        );\n      }\n      const outputKeysSet = new Set(chain.outputKeys);\n      const overlappingOutputKeys = intersection(availableKeys, outputKeysSet);\n      if (overlappingOutputKeys.size > 0) {\n        throw new Error(\n          `The following output variables for chain \"${chain._chainType()}\" are overlapping: ${formatSet(\n            overlappingOutputKeys\n          )}. This can lead to unexpected behaviour.`\n        );\n      }\n\n      for (const outputKey of outputKeysSet) {\n        availableKeys.add(outputKey);\n      }\n    }\n\n    if (this.outputVariables.length === 0) {\n      if (this.returnAll) {\n        const outputKeys = difference(availableKeys, inputKeysSet);\n        this.outputVariables = Array.from(outputKeys);\n      } else {\n        this.outputVariables = this.chains[this.chains.length - 1].outputKeys;\n      }\n    } else {\n      const missingKeys = difference(\n        new Set(this.outputVariables),\n        new Set(availableKeys)\n      );\n      if (missingKeys.size > 0) {\n        throw new Error(\n          `The following output variables were expected to be in the final chain output but were not found: ${formatSet(\n            missingKeys\n          )}.`\n        );\n      }\n    }\n  }\n\n  /** @ignore */\n  async _call(\n    values: ChainValues,\n    runManager?: CallbackManagerForChainRun\n  ): Promise<ChainValues> {\n    let input: ChainValues = {};\n    const allChainValues: ChainValues = values;\n    let i = 0;\n    for (const chain of this.chains) {\n      i += 1;\n      input = await chain.call(\n        allChainValues,\n        runManager?.getChild(`step_${i}`)\n      );\n      for (const key of Object.keys(input)) {\n        allChainValues[key] = input[key];\n      }\n    }\n    const output: ChainValues = {};\n    for (const key of this.outputVariables) {\n      output[key] = allChainValues[key];\n    }\n\n    return output;\n  }\n\n  _chainType() {\n    return \"sequential_chain\" as const;\n  }\n\n  static async deserialize(data: SerializedSequentialChain) {\n    const chains: BaseChain[] = [];\n    const inputVariables: string[] = data.input_variables;\n    const outputVariables: string[] = data.output_variables;\n    const serializedChains = data.chains;\n    for (const serializedChain of serializedChains) {\n      const deserializedChain = await BaseChain.deserialize(serializedChain);\n      chains.push(deserializedChain);\n    }\n    return new SequentialChain({ chains, inputVariables, outputVariables });\n  }\n\n  serialize(): SerializedSequentialChain {\n    const chains: SerializedBaseChain[] = [];\n    for (const chain of this.chains) {\n      chains.push(chain.serialize());\n    }\n    return {\n      _type: this._chainType(),\n      input_variables: this.inputVariables,\n      output_variables: this.outputVariables,\n      chains,\n    };\n  }\n}\n\n/**\n * Interface for the input parameters of the SimpleSequentialChain class.\n */\nexport interface SimpleSequentialChainInput extends ChainInputs {\n  /** Array of chains to run as a sequence. The chains are run in order they appear in the array. */\n  chains: Array<BaseChain>;\n  /** Whether or not to trim the intermediate outputs. */\n  trimOutputs?: boolean;\n}\n\n/**\n * Simple chain where a single string output of one chain is fed directly into the next.\n * @augments BaseChain\n * @augments SimpleSequentialChainInput\n *\n * @example\n * ```ts\n * import { SimpleSequentialChain, LLMChain } from \"@langchain/classic/chains\";\n * import { OpenAI } from \"langchain/llms/openai\";\n * import { PromptTemplate } from \"langchain/prompts\";\n *\n * // This is an LLMChain to write a synopsis given a title of a play.\n * const llm = new OpenAI({ temperature: 0 });\n * const template = `You are a playwright. Given the title of play, it is your job to write a synopsis for that title.\n *\n * Title: {title}\n * Playwright: This is a synopsis for the above play:`\n * const promptTemplate = new PromptTemplate({ template, inputVariables: [\"title\"] });\n * const synopsisChain = new LLMChain({ llm, prompt: promptTemplate });\n *\n *\n * // This is an LLMChain to write a review of a play given a synopsis.\n * const reviewLLM = new OpenAI({ temperature: 0 })\n * const reviewTemplate = `You are a play critic from the New York Times. Given the synopsis of play, it is your job to write a review for that play.\n *\n * Play Synopsis:\n * {synopsis}\n * Review from a New York Times play critic of the above play:`\n * const reviewPromptTemplate = new PromptTemplate({ template: reviewTemplate, inputVariables: [\"synopsis\"] });\n * const reviewChain = new LLMChain({ llm: reviewLLM, prompt: reviewPromptTemplate });\n *\n * const overallChain = new SimpleSequentialChain({chains: [synopsisChain, reviewChain], verbose:true})\n * const review = await overallChain.run(\"Tragedy at sunset on the beach\")\n * // the variable review contains resulting play review.\n * ```\n */\nexport class SimpleSequentialChain\n  extends BaseChain\n  implements SimpleSequentialChainInput\n{\n  static lc_name() {\n    return \"SimpleSequentialChain\";\n  }\n\n  chains: Array<BaseChain>;\n\n  inputKey = \"input\";\n\n  outputKey = \"output\";\n\n  trimOutputs: boolean;\n\n  get inputKeys() {\n    return [this.inputKey];\n  }\n\n  get outputKeys(): string[] {\n    return [this.outputKey];\n  }\n\n  constructor(fields: SimpleSequentialChainInput) {\n    super(fields);\n    this.chains = fields.chains;\n    this.trimOutputs = fields.trimOutputs ?? false;\n    this._validateChains();\n  }\n\n  /** @ignore */\n  _validateChains() {\n    for (const chain of this.chains) {\n      if (\n        chain.inputKeys.filter((k) => !chain.memory?.memoryKeys.includes(k))\n          .length !== 1\n      ) {\n        throw new Error(\n          `Chains used in SimpleSequentialChain should all have one input, got ${\n            chain.inputKeys.length\n          } for ${chain._chainType()}.`\n        );\n      }\n      if (chain.outputKeys.length !== 1) {\n        throw new Error(\n          `Chains used in SimpleSequentialChain should all have one output, got ${\n            chain.outputKeys.length\n          } for ${chain._chainType()}.`\n        );\n      }\n    }\n  }\n\n  /** @ignore */\n  async _call(\n    values: ChainValues,\n    runManager?: CallbackManagerForChainRun\n  ): Promise<ChainValues> {\n    let input: string = values[this.inputKey];\n    let i = 0;\n    for (const chain of this.chains) {\n      i += 1;\n      input = (\n        await chain.call(\n          { [chain.inputKeys[0]]: input, signal: values.signal },\n          runManager?.getChild(`step_${i}`)\n        )\n      )[chain.outputKeys[0]];\n      if (this.trimOutputs) {\n        input = input.trim();\n      }\n      await runManager?.handleText(input);\n    }\n    return { [this.outputKey]: input };\n  }\n\n  _chainType() {\n    return \"simple_sequential_chain\" as const;\n  }\n\n  static async deserialize(data: SerializedSimpleSequentialChain) {\n    const chains: Array<BaseChain> = [];\n    const serializedChains = data.chains;\n    for (const serializedChain of serializedChains) {\n      const deserializedChain = await BaseChain.deserialize(serializedChain);\n      chains.push(deserializedChain);\n    }\n    return new SimpleSequentialChain({ chains });\n  }\n\n  serialize(): SerializedSimpleSequentialChain {\n    const chains: Array<SerializedBaseChain> = [];\n    for (const chain of this.chains) {\n      chains.push(chain.serialize());\n    }\n    return {\n      _type: this._chainType(),\n      chains,\n    };\n  }\n}\n"],"mappings":";;;AAUA,SAAS,UAAU,OAAoB;CACrC,OAAO,MAAM,KAAK,KAAK,CAAC,CACrB,KAAK,MAAM,IAAI,EAAE,EAAE,CAAC,CACpB,KAAK,IAAI;AACd;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8DA,IAAa,kBAAb,MAAa,wBAAwB,UAA0C;CAC7E,OAAO,UAAU;EACf,OAAO;CACT;CAEA;CAEA;CAEA;CAEA;CAEA,IAAI,YAAY;EACd,OAAO,KAAK;CACd;CAEA,IAAI,aAAuB;EACzB,OAAO,KAAK;CACd;CAEA,YAAY,QAA8B;EACxC,MAAM,MAAM;EACZ,KAAK,SAAS,OAAO;EACrB,KAAK,iBAAiB,OAAO;EAC7B,KAAK,kBAAkB,OAAO,mBAAmB,CAAC;EAClD,IAAI,KAAK,gBAAgB,SAAS,KAAK,OAAO,WAC5C,MAAM,IAAI,MACR,qIACF;EAEF,KAAK,YAAY,OAAO,aAAa;EACrC,KAAK,gBAAgB;CACvB;;CAGA,kBAAkB;EAChB,IAAI,KAAK,OAAO,WAAW,GACzB,MAAM,IAAI,MAAM,gDAAgD;EAGlE,MAAM,aAAa,KAAK,QAAQ,cAAc,CAAC;EAC/C,MAAM,eAAe,IAAI,IAAI,KAAK,SAAS;EAC3C,MAAM,gBAAgB,IAAI,IAAI,UAAU;EACxC,MAAM,mBAAmB,aAAa,cAAc,aAAa;EACjE,IAAI,iBAAiB,OAAO,GAC1B,MAAM,IAAI,MACR,uBAAuB,UACrB,gBACF,EAAE,mKACJ;EAGF,MAAM,gBAAgB,MAAM,cAAc,aAAa;EACvD,KAAK,MAAM,SAAS,KAAK,QAAQ;GAC/B,IAAI,cAAc,WAAW,IAAI,IAAI,MAAM,SAAS,GAAG,aAAa;GAEpE,IAAI,MAAM,QACR,cAAc,WAAW,aAAa,IAAI,IAAI,MAAM,OAAO,UAAU,CAAC;GAGxE,IAAI,YAAY,OAAO,GACrB,MAAM,IAAI,MACR,gCAAgC,MAAM,WAAW,EAAE,KAAK,UACtD,WACF,EAAE,sCAAsC,UAAU,aAAa,EAAE,EACnE;GAEF,MAAM,gBAAgB,IAAI,IAAI,MAAM,UAAU;GAC9C,MAAM,wBAAwB,aAAa,eAAe,aAAa;GACvE,IAAI,sBAAsB,OAAO,GAC/B,MAAM,IAAI,MACR,6CAA6C,MAAM,WAAW,EAAE,qBAAqB,UACnF,qBACF,EAAE,yCACJ;GAGF,KAAK,MAAM,aAAa,eACtB,cAAc,IAAI,SAAS;EAE/B;EAEA,IAAI,KAAK,gBAAgB,WAAW,GAAG;GACrC,IAAI,KAAK,WAAW;IAClB,MAAM,aAAa,WAAW,eAAe,YAAY;IACzD,KAAK,kBAAkB,MAAM,KAAK,UAAU;GAC9C,OACE,KAAK,kBAAkB,KAAK,OAAO,KAAK,OAAO,SAAS,EAAE,CAAC;EAE/D,OAAO;GACL,MAAM,cAAc,WAClB,IAAI,IAAI,KAAK,eAAe,GAC5B,IAAI,IAAI,aAAa,CACvB;GACA,IAAI,YAAY,OAAO,GACrB,MAAM,IAAI,MACR,oGAAoG,UAClG,WACF,EAAE,EACJ;EAEJ;CACF;;CAGA,MAAM,MACJ,QACA,YACsB;EACtB,IAAI,QAAqB,CAAC;EAC1B,MAAM,iBAA8B;EACpC,IAAI,IAAI;EACR,KAAK,MAAM,SAAS,KAAK,QAAQ;GAC/B,KAAK;GACL,QAAQ,MAAM,MAAM,KAClB,gBACA,YAAY,SAAS,QAAQ,GAAG,CAClC;GACA,KAAK,MAAM,OAAO,OAAO,KAAK,KAAK,GACjC,eAAe,OAAO,MAAM;EAEhC;EACA,MAAM,SAAsB,CAAC;EAC7B,KAAK,MAAM,OAAO,KAAK,iBACrB,OAAO,OAAO,eAAe;EAG/B,OAAO;CACT;CAEA,aAAa;EACX,OAAO;CACT;CAEA,aAAa,YAAY,MAAiC;EACxD,MAAM,SAAsB,CAAC;EAC7B,MAAM,iBAA2B,KAAK;EACtC,MAAM,kBAA4B,KAAK;EACvC,MAAM,mBAAmB,KAAK;EAC9B,KAAK,MAAM,mBAAmB,kBAAkB;GAC9C,MAAM,oBAAoB,MAAM,UAAU,YAAY,eAAe;GACrE,OAAO,KAAK,iBAAiB;EAC/B;EACA,OAAO,IAAI,gBAAgB;GAAE;GAAQ;GAAgB;EAAgB,CAAC;CACxE;CAEA,YAAuC;EACrC,MAAM,SAAgC,CAAC;EACvC,KAAK,MAAM,SAAS,KAAK,QACvB,OAAO,KAAK,MAAM,UAAU,CAAC;EAE/B,OAAO;GACL,OAAO,KAAK,WAAW;GACvB,iBAAiB,KAAK;GACtB,kBAAkB,KAAK;GACvB;EACF;CACF;AACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAgDA,IAAa,wBAAb,MAAa,8BACH,UAEV;CACE,OAAO,UAAU;EACf,OAAO;CACT;CAEA;CAEA,WAAW;CAEX,YAAY;CAEZ;CAEA,IAAI,YAAY;EACd,OAAO,CAAC,KAAK,QAAQ;CACvB;CAEA,IAAI,aAAuB;EACzB,OAAO,CAAC,KAAK,SAAS;CACxB;CAEA,YAAY,QAAoC;EAC9C,MAAM,MAAM;EACZ,KAAK,SAAS,OAAO;EACrB,KAAK,cAAc,OAAO,eAAe;EACzC,KAAK,gBAAgB;CACvB;;CAGA,kBAAkB;EAChB,KAAK,MAAM,SAAS,KAAK,QAAQ;GAC/B,IACE,MAAM,UAAU,QAAQ,MAAM,CAAC,MAAM,QAAQ,WAAW,SAAS,CAAC,CAAC,CAAC,CACjE,WAAW,GAEd,MAAM,IAAI,MACR,uEACE,MAAM,UAAU,OACjB,OAAO,MAAM,WAAW,EAAE,EAC7B;GAEF,IAAI,MAAM,WAAW,WAAW,GAC9B,MAAM,IAAI,MACR,wEACE,MAAM,WAAW,OAClB,OAAO,MAAM,WAAW,EAAE,EAC7B;EAEJ;CACF;;CAGA,MAAM,MACJ,QACA,YACsB;EACtB,IAAI,QAAgB,OAAO,KAAK;EAChC,IAAI,IAAI;EACR,KAAK,MAAM,SAAS,KAAK,QAAQ;GAC/B,KAAK;GACL,SACE,MAAM,MAAM,KACV;KAAG,MAAM,UAAU,KAAK;IAAO,QAAQ,OAAO;GAAO,GACrD,YAAY,SAAS,QAAQ,GAAG,CAClC,EAAA,CACA,MAAM,WAAW;GACnB,IAAI,KAAK,aACP,QAAQ,MAAM,KAAK;GAErB,MAAM,YAAY,WAAW,KAAK;EACpC;EACA,OAAO,GAAG,KAAK,YAAY,MAAM;CACnC;CAEA,aAAa;EACX,OAAO;CACT;CAEA,aAAa,YAAY,MAAuC;EAC9D,MAAM,SAA2B,CAAC;EAClC,MAAM,mBAAmB,KAAK;EAC9B,KAAK,MAAM,mBAAmB,kBAAkB;GAC9C,MAAM,oBAAoB,MAAM,UAAU,YAAY,eAAe;GACrE,OAAO,KAAK,iBAAiB;EAC/B;EACA,OAAO,IAAI,sBAAsB,EAAE,OAAO,CAAC;CAC7C;CAEA,YAA6C;EAC3C,MAAM,SAAqC,CAAC;EAC5C,KAAK,MAAM,SAAS,KAAK,QACvB,OAAO,KAAK,MAAM,UAAU,CAAC;EAE/B,OAAO;GACL,OAAO,KAAK,WAAW;GACvB;EACF;CACF;AACF"}

package/dist/chains/sql_db/sql_db_chain.cjs

@@ -111,8 +111,9 @@ var SqlDatabaseChain = class extends require_base.BaseChain {
 	async verifyNumberOfTokens(inputText, tableinfo) {
 		if (this.llm._llmType() !== "openai") return;
 		const llm = this.llm;
+		const stringWeSend = `${inputText}${this.prompt.template}${tableinfo}`;
 		if (await (0, _langchain_core_language_models_base.calculateMaxTokens)({
-			prompt: `${inputText}${this.prompt.template}${tableinfo}`,
+			prompt: stringWeSend,
 			modelName: llm.model
 		}) < (llm.maxTokens ?? -1)) throw new Error(`The combination of the database structure and your question is too big for the model ${llm.model} which can compute only a max tokens of ${(0, _langchain_core_language_models_base.getModelContextSize)(llm.model)}.
       We suggest you to use the includeTables parameters when creating the SqlDatabase object to select only a subset of the tables. You can also use a model which can handle more tokens.`);

package/dist/chains/sql_db/sql_db_chain.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"sql_db_chain.cjs","names":["BaseChain","DEFAULT_SQL_DATABASE_PROMPT","getPromptTemplateFromDataSource","LLMChain","SQL_PROMPTS_MAP","RunnableSequence","RunnablePassthrough","StringOutputParser"],"sources":["../../../src/chains/sql_db/sql_db_chain.ts"],"sourcesContent":["import type {\n  BaseLanguageModel,\n  BaseLanguageModelInterface,\n} from \"@langchain/core/language_models/base\";\nimport type { OpenAI, TiktokenModel } from \"@langchain/openai\";\nimport { ChainValues } from \"@langchain/core/utils/types\";\nimport { BasePromptTemplate, PromptTemplate } from \"@langchain/core/prompts\";\nimport {\n  calculateMaxTokens,\n  getModelContextSize,\n} from \"@langchain/core/language_models/base\";\nimport { CallbackManagerForChainRun } from \"@langchain/core/callbacks/manager\";\nimport {\n  RunnablePassthrough,\n  RunnableSequence,\n} from \"@langchain/core/runnables\";\nimport { StringOutputParser } from \"@langchain/core/output_parsers\";\nimport {\n  DEFAULT_SQL_DATABASE_PROMPT,\n  SQL_PROMPTS_MAP,\n  SqlDialect,\n} from \"./sql_db_prompt.js\";\nimport { BaseChain, ChainInputs } from \"../base.js\";\nimport { LLMChain } from \"../llm_chain.js\";\nimport type { SqlDatabase } from \"../../sql_db.js\";\nimport { getPromptTemplateFromDataSource } from \"../../util/sql_utils.js\";\n\n/**\n * Interface that extends the ChainInputs interface and defines additional\n * fields specific to a SQL database chain. It represents the input fields\n * for a SQL database chain.\n */\nexport interface SqlDatabaseChainInput extends ChainInputs {\n  llm: BaseLanguageModelInterface;\n  database: SqlDatabase;\n  topK?: number;\n  inputKey?: string;\n  outputKey?: string;\n  sqlOutputKey?: string;\n  prompt?: PromptTemplate;\n}\n\n/**\n * Class that represents a SQL database chain in the LangChain framework.\n * It extends the BaseChain class and implements the functionality\n * specific to a SQL database chain.\n *\n * @security **Security Notice**\n * This chain generates SQL queries for the given database.\n * The SQLDatabase class provides a getTableInfo method that can be used\n * to get column information as well as sample data from the table.\n * To mitigate risk of leaking sensitive data, limit permissions\n * to read and scope to the tables that are needed.\n * Optionally, use the includesTables or ignoreTables class parameters\n * to limit which tables can/cannot be accessed.\n *\n * @link See https://js.langchain.com/docs/security for more information.\n * @example\n * ```typescript\n * const chain = new SqlDatabaseChain({\n *   llm: new OpenAI({ temperature: 0 }),\n *   database: new SqlDatabase({ ...config }),\n * });\n *\n * const result = await chain.run(\"How many tracks are there?\");\n * ```\n */\nexport class SqlDatabaseChain extends BaseChain {\n  static lc_name() {\n    return \"SqlDatabaseChain\";\n  }\n\n  // LLM wrapper to use\n  llm: BaseLanguageModelInterface;\n\n  // SQL Database to connect to.\n  database: SqlDatabase;\n\n  // Prompt to use to translate natural language to SQL.\n  prompt = DEFAULT_SQL_DATABASE_PROMPT;\n\n  // Number of results to return from the query\n  topK = 5;\n\n  inputKey = \"query\";\n\n  outputKey = \"result\";\n\n  sqlOutputKey: string | undefined = undefined;\n\n  // Whether to return the result of querying the SQL table directly.\n  returnDirect = false;\n\n  constructor(fields: SqlDatabaseChainInput) {\n    super(fields);\n    this.llm = fields.llm;\n    this.database = fields.database;\n    this.topK = fields.topK ?? this.topK;\n    this.inputKey = fields.inputKey ?? this.inputKey;\n    this.outputKey = fields.outputKey ?? this.outputKey;\n    this.sqlOutputKey = fields.sqlOutputKey ?? this.sqlOutputKey;\n    this.prompt =\n      fields.prompt ??\n      getPromptTemplateFromDataSource(this.database.appDataSource);\n  }\n\n  /** @ignore */\n  async _call(\n    values: ChainValues,\n    runManager?: CallbackManagerForChainRun\n  ): Promise<ChainValues> {\n    const llmChain = new LLMChain({\n      prompt: this.prompt,\n      llm: this.llm,\n      outputKey: this.outputKey,\n      memory: this.memory,\n    });\n    if (!(this.inputKey in values)) {\n      throw new Error(`Question key ${this.inputKey} not found.`);\n    }\n    const question: string = values[this.inputKey];\n    let inputText = `${question}\\nSQLQuery:`;\n    const tablesToUse = values.table_names_to_use;\n    const tableInfo = await this.database.getTableInfo(tablesToUse);\n\n    const llmInputs = {\n      input: inputText,\n      top_k: this.topK,\n      dialect: this.database.appDataSourceOptions.type,\n      table_info: tableInfo,\n      stop: [\"\\nSQLResult:\"],\n    };\n    await this.verifyNumberOfTokens(inputText, tableInfo);\n\n    const sqlCommand = await llmChain.predict(\n      llmInputs,\n      runManager?.getChild(\"sql_generation\")\n    );\n    let queryResult = \"\";\n    try {\n      queryResult = await this.database.appDataSource.query(sqlCommand);\n    } catch (error) {\n      console.error(error);\n    }\n\n    let finalResult;\n    if (this.returnDirect) {\n      finalResult = { [this.outputKey]: queryResult };\n    } else {\n      inputText += `${sqlCommand}\\nSQLResult: ${JSON.stringify(\n        queryResult\n      )}\\nAnswer:`;\n      llmInputs.input = inputText;\n      finalResult = {\n        [this.outputKey]: await llmChain.predict(\n          llmInputs,\n          runManager?.getChild(\"result_generation\")\n        ),\n      };\n    }\n\n    if (this.sqlOutputKey != null) {\n      finalResult[this.sqlOutputKey] = sqlCommand;\n    }\n\n    return finalResult;\n  }\n\n  _chainType() {\n    return \"sql_database_chain\" as const;\n  }\n\n  get inputKeys(): string[] {\n    return [this.inputKey];\n  }\n\n  get outputKeys(): string[] {\n    if (this.sqlOutputKey != null) {\n      return [this.outputKey, this.sqlOutputKey];\n    }\n    return [this.outputKey];\n  }\n\n  /**\n   * Private method that verifies the number of tokens in the input text and\n   * table information. It throws an error if the number of tokens exceeds\n   * the maximum allowed by the language model.\n   * @param inputText The input text.\n   * @param tableinfo The table information.\n   * @returns A promise that resolves when the verification is complete.\n   */\n  private async verifyNumberOfTokens(\n    inputText: string,\n    tableinfo: string\n  ): Promise<void> {\n    // We verify it only for OpenAI for the moment\n    if (this.llm._llmType() !== \"openai\") {\n      return;\n    }\n    const llm = this.llm as OpenAI;\n    const promptTemplate = this.prompt.template;\n    const stringWeSend = `${inputText}${promptTemplate}${tableinfo}`;\n\n    const maxToken = await calculateMaxTokens({\n      prompt: stringWeSend,\n      // Cast here to allow for other models that may not fit the union\n      modelName: llm.model as TiktokenModel,\n    });\n\n    if (maxToken < (llm.maxTokens ?? -1)) {\n      throw new Error(`The combination of the database structure and your question is too big for the model ${\n        llm.model\n      } which can compute only a max tokens of ${getModelContextSize(\n        llm.model\n      )}.\n      We suggest you to use the includeTables parameters when creating the SqlDatabase object to select only a subset of the tables. You can also use a model which can handle more tokens.`);\n    }\n  }\n}\n\nexport interface CreateSqlQueryChainFields {\n  llm: BaseLanguageModel;\n  db: SqlDatabase;\n  prompt?: BasePromptTemplate;\n  /**\n   * @default 5\n   */\n  k?: number;\n  dialect: SqlDialect;\n}\n\ntype SqlInput = {\n  question: string;\n};\n\ntype SqlInoutWithTables = SqlInput & {\n  tableNamesToUse: string[];\n};\n\nconst strip = (text: string) => {\n  // Replace escaped quotes with actual quotes\n  let newText = text.replace(/\\\\\"/g, '\"').trim();\n  // Remove wrapping quotes if the entire string is wrapped in quotes\n  if (newText.startsWith('\"') && newText.endsWith('\"')) {\n    newText = newText.substring(1, newText.length - 1);\n  }\n  return newText;\n};\n\nconst difference = (setA: Set<string>, setB: Set<string>) =>\n  new Set([...setA].filter((x) => !setB.has(x)));\n\n/**\n * Create a SQL query chain that can create SQL queries for the given database.\n * Returns a Runnable.\n *\n * @param {BaseLanguageModel} llm The language model to use in the chain.\n * @param {SqlDatabase} db The database to use in the chain.\n * @param {BasePromptTemplate | undefined} prompt The prompt to use in the chain.\n * @param {BaseLanguageModel | undefined} k The amount of docs/results to return. Passed through the prompt input value `top_k`.\n * @param {SqlDialect} dialect The SQL dialect to use in the chain.\n * @returns {Promise<RunnableSequence<Record<string, unknown>, string>>} A runnable sequence representing the chain.\n * @example ```typescript\n * const datasource = new DataSource({\n *   type: \"sqlite\",\n *   database: \"../../../../Chinook.db\",\n * });\n * const db = await SqlDatabase.fromDataSourceParams({\n *   appDataSource: datasource,\n * });\n * const llm = new ChatOpenAI({ model: \"gpt-4o-mini\", temperature: 0 });\n * const chain = await createSqlQueryChain({\n *   llm,\n *   db,\n *   dialect: \"sqlite\",\n * });\n * ```\n */\nexport async function createSqlQueryChain({\n  llm,\n  db,\n  prompt,\n  k = 5,\n  dialect,\n}: CreateSqlQueryChainFields) {\n  let promptToUse: BasePromptTemplate;\n  if (prompt) {\n    promptToUse = prompt;\n  } else if (SQL_PROMPTS_MAP[dialect]) {\n    promptToUse = SQL_PROMPTS_MAP[dialect];\n  } else {\n    promptToUse = DEFAULT_SQL_DATABASE_PROMPT;\n  }\n\n  if (\n    difference(\n      new Set([\"input\", \"top_k\", \"table_info\"]),\n      new Set(promptToUse.inputVariables)\n    ).size > 0\n  ) {\n    throw new Error(\n      `Prompt must have input variables: 'input', 'top_k', 'table_info'. Received prompt with input variables: ` +\n        `${promptToUse.inputVariables}. Full prompt:\\n\\n${promptToUse}`\n    );\n  }\n  if (promptToUse.inputVariables.includes(\"dialect\")) {\n    promptToUse = await promptToUse.partial({ dialect });\n  }\n\n  promptToUse = await promptToUse.partial({ top_k: k.toString() });\n\n  const inputs = {\n    input: (x: Record<string, unknown>) => {\n      if (\"question\" in x) {\n        return `${(x as SqlInput).question}\\nSQLQuery: `;\n      }\n      throw new Error(\"Input must include a question property.\");\n    },\n    table_info: async (x: Record<string, unknown>) =>\n      db.getTableInfo((x as SqlInoutWithTables).tableNamesToUse),\n  };\n\n  return RunnableSequence.from([\n    RunnablePassthrough.assign(inputs),\n    (x) => {\n      const newInputs = { ...x };\n      delete newInputs.question;\n      delete newInputs.tableNamesToUse;\n      return newInputs;\n    },\n    promptToUse,\n    llm.withConfig({ stop: [\"\\nSQLResult:\"] }),\n    new StringOutputParser(),\n    strip,\n  ]);\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAmEA,IAAa,mBAAb,cAAsCA,aAAAA,UAAU;CAC9C,OAAO,UAAU;EACf,OAAO;CACT;CAGA;CAGA;CAGA,SAASC,sBAAAA;CAGT,OAAO;CAEP,WAAW;CAEX,YAAY;CAEZ,eAAmC,KAAA;CAGnC,eAAe;CAEf,YAAY,QAA+B;EACzC,MAAM,MAAM;EACZ,KAAK,MAAM,OAAO;EAClB,KAAK,WAAW,OAAO;EACvB,KAAK,OAAO,OAAO,QAAQ,KAAK;EAChC,KAAK,WAAW,OAAO,YAAY,KAAK;EACxC,KAAK,YAAY,OAAO,aAAa,KAAK;EAC1C,KAAK,eAAe,OAAO,gBAAgB,KAAK;EAChD,KAAK,SACH,OAAO,UACPC,kBAAAA,gCAAgC,KAAK,SAAS,aAAa;CAC/D;;CAGA,MAAM,MACJ,QACA,YACsB;EACtB,MAAM,WAAW,IAAIC,kBAAAA,SAAS;GAC5B,QAAQ,KAAK;GACb,KAAK,KAAK;GACV,WAAW,KAAK;GAChB,QAAQ,KAAK;EACf,CAAC;EACD,IAAI,EAAE,KAAK,YAAY,SACrB,MAAM,IAAI,MAAM,gBAAgB,KAAK,SAAS,YAAY;EAG5D,IAAI,YAAY,GADS,OAAO,KAAK,UACT;EAC5B,MAAM,cAAc,OAAO;EAC3B,MAAM,YAAY,MAAM,KAAK,SAAS,aAAa,WAAW;EAE9D,MAAM,YAAY;GAChB,OAAO;GACP,OAAO,KAAK;GACZ,SAAS,KAAK,SAAS,qBAAqB;GAC5C,YAAY;GACZ,MAAM,CAAC,cAAc;EACvB;EACA,MAAM,KAAK,qBAAqB,WAAW,SAAS;EAEpD,MAAM,aAAa,MAAM,SAAS,QAChC,WACA,YAAY,SAAS,gBAAgB,CACvC;EACA,IAAI,cAAc;EAClB,IAAI;GACF,cAAc,MAAM,KAAK,SAAS,cAAc,MAAM,UAAU;EAClE,SAAS,OAAO;GACd,QAAQ,MAAM,KAAK;EACrB;EAEA,IAAI;EACJ,IAAI,KAAK,cACP,cAAc,GAAG,KAAK,YAAY,YAAY;OACzC;GACL,aAAa,GAAG,WAAW,eAAe,KAAK,UAC7C,WACF,EAAE;GACF,UAAU,QAAQ;GAClB,cAAc,GACX,KAAK,YAAY,MAAM,SAAS,QAC/B,WACA,YAAY,SAAS,mBAAmB,CAC1C,EACF;EACF;EAEA,IAAI,KAAK,gBAAgB,MACvB,YAAY,KAAK,gBAAgB;EAGnC,OAAO;CACT;CAEA,aAAa;EACX,OAAO;CACT;CAEA,IAAI,YAAsB;EACxB,OAAO,CAAC,KAAK,QAAQ;CACvB;CAEA,IAAI,aAAuB;EACzB,IAAI,KAAK,gBAAgB,MACvB,OAAO,CAAC,KAAK,WAAW,KAAK,YAAY;EAE3C,OAAO,CAAC,KAAK,SAAS;CACxB;;;;;;;;;CAUA,MAAc,qBACZ,WACA,WACe;EAEf,IAAI,KAAK,IAAI,SAAS,MAAM,UAC1B;EAEF,MAAM,MAAM,KAAK;EAUjB,IAAI,OAAA,GAAA,qCAAA,mBAAA,CANsC;GACxC,QAAQ,GAHc,YADD,KAAK,OAAO,WACkB;GAKnD,WAAW,IAAI;EACjB,CAAC,KAEe,IAAI,aAAa,KAC/B,MAAM,IAAI,MAAM,wFACd,IAAI,MACL,2CAAA,GAAA,qCAAA,oBAAA,CACC,IAAI,KACN,EAAE;4LACoL;CAE1L;AACF;AAqBA,MAAM,SAAS,SAAiB;CAE9B,IAAI,UAAU,KAAK,QAAQ,QAAQ,IAAG,CAAC,CAAC,KAAK;CAE7C,IAAI,QAAQ,WAAW,IAAG,KAAK,QAAQ,SAAS,IAAG,GACjD,UAAU,QAAQ,UAAU,GAAG,QAAQ,SAAS,CAAC;CAEnD,OAAO;AACT;AAEA,MAAM,cAAc,MAAmB,SACrC,IAAI,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC,QAAQ,MAAM,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4B/C,eAAsB,oBAAoB,EACxC,KACA,IACA,QACA,IAAI,GACJ,WAC4B;CAC5B,IAAI;CACJ,IAAI,QACF,cAAc;MACT,IAAIC,sBAAAA,gBAAgB,UACzB,cAAcA,sBAAAA,gBAAgB;MAE9B,cAAcH,sBAAAA;CAGhB,IACE,2BACE,IAAI,IAAI;EAAC;EAAS;EAAS;CAAY,CAAC,GACxC,IAAI,IAAI,YAAY,cAAc,CACpC,CAAC,CAAC,OAAO,GAET,MAAM,IAAI,MACR,2GACK,YAAY,eAAe,oBAAoB,aACtD;CAEF,IAAI,YAAY,eAAe,SAAS,SAAS,GAC/C,cAAc,MAAM,YAAY,QAAQ,EAAE,QAAQ,CAAC;CAGrD,cAAc,MAAM,YAAY,QAAQ,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;CAa/D,OAAOI,0BAAAA,iBAAiB,KAAK;EAC3BC,0BAAAA,oBAAoB,OAAO;GAX3B,QAAQ,MAA+B;IACrC,IAAI,cAAc,GAChB,OAAO,GAAI,EAAe,SAAS;IAErC,MAAM,IAAI,MAAM,yCAAyC;GAC3D;GACA,YAAY,OAAO,MACjB,GAAG,aAAc,EAAyB,eAAe;EAI3B,CAAC;GAChC,MAAM;GACL,MAAM,YAAY,EAAE,GAAG,EAAE;GACzB,OAAO,UAAU;GACjB,OAAO,UAAU;GACjB,OAAO;EACT;EACA;EACA,IAAI,WAAW,EAAE,MAAM,CAAC,cAAc,EAAE,CAAC;EACzC,IAAIC,+BAAAA,mBAAmB;EACvB;CACF,CAAC;AACH"}
+{"version":3,"file":"sql_db_chain.cjs","names":["BaseChain","DEFAULT_SQL_DATABASE_PROMPT","getPromptTemplateFromDataSource","LLMChain","calculateMaxTokens","getModelContextSize","SQL_PROMPTS_MAP","RunnableSequence","RunnablePassthrough","StringOutputParser"],"sources":["../../../src/chains/sql_db/sql_db_chain.ts"],"sourcesContent":["import type {\n  BaseLanguageModel,\n  BaseLanguageModelInterface,\n} from \"@langchain/core/language_models/base\";\nimport type { OpenAI, TiktokenModel } from \"@langchain/openai\";\nimport { ChainValues } from \"@langchain/core/utils/types\";\nimport { BasePromptTemplate, PromptTemplate } from \"@langchain/core/prompts\";\nimport {\n  calculateMaxTokens,\n  getModelContextSize,\n} from \"@langchain/core/language_models/base\";\nimport { CallbackManagerForChainRun } from \"@langchain/core/callbacks/manager\";\nimport {\n  RunnablePassthrough,\n  RunnableSequence,\n} from \"@langchain/core/runnables\";\nimport { StringOutputParser } from \"@langchain/core/output_parsers\";\nimport {\n  DEFAULT_SQL_DATABASE_PROMPT,\n  SQL_PROMPTS_MAP,\n  SqlDialect,\n} from \"./sql_db_prompt.js\";\nimport { BaseChain, ChainInputs } from \"../base.js\";\nimport { LLMChain } from \"../llm_chain.js\";\nimport type { SqlDatabase } from \"../../sql_db.js\";\nimport { getPromptTemplateFromDataSource } from \"../../util/sql_utils.js\";\n\n/**\n * Interface that extends the ChainInputs interface and defines additional\n * fields specific to a SQL database chain. It represents the input fields\n * for a SQL database chain.\n */\nexport interface SqlDatabaseChainInput extends ChainInputs {\n  llm: BaseLanguageModelInterface;\n  database: SqlDatabase;\n  topK?: number;\n  inputKey?: string;\n  outputKey?: string;\n  sqlOutputKey?: string;\n  prompt?: PromptTemplate;\n}\n\n/**\n * Class that represents a SQL database chain in the LangChain framework.\n * It extends the BaseChain class and implements the functionality\n * specific to a SQL database chain.\n *\n * @security **Security Notice**\n * This chain generates SQL queries for the given database.\n * The SQLDatabase class provides a getTableInfo method that can be used\n * to get column information as well as sample data from the table.\n * To mitigate risk of leaking sensitive data, limit permissions\n * to read and scope to the tables that are needed.\n * Optionally, use the includesTables or ignoreTables class parameters\n * to limit which tables can/cannot be accessed.\n *\n * @link See https://js.langchain.com/docs/security for more information.\n * @example\n * ```typescript\n * const chain = new SqlDatabaseChain({\n *   llm: new OpenAI({ temperature: 0 }),\n *   database: new SqlDatabase({ ...config }),\n * });\n *\n * const result = await chain.run(\"How many tracks are there?\");\n * ```\n */\nexport class SqlDatabaseChain extends BaseChain {\n  static lc_name() {\n    return \"SqlDatabaseChain\";\n  }\n\n  // LLM wrapper to use\n  llm: BaseLanguageModelInterface;\n\n  // SQL Database to connect to.\n  database: SqlDatabase;\n\n  // Prompt to use to translate natural language to SQL.\n  prompt = DEFAULT_SQL_DATABASE_PROMPT;\n\n  // Number of results to return from the query\n  topK = 5;\n\n  inputKey = \"query\";\n\n  outputKey = \"result\";\n\n  sqlOutputKey: string | undefined = undefined;\n\n  // Whether to return the result of querying the SQL table directly.\n  returnDirect = false;\n\n  constructor(fields: SqlDatabaseChainInput) {\n    super(fields);\n    this.llm = fields.llm;\n    this.database = fields.database;\n    this.topK = fields.topK ?? this.topK;\n    this.inputKey = fields.inputKey ?? this.inputKey;\n    this.outputKey = fields.outputKey ?? this.outputKey;\n    this.sqlOutputKey = fields.sqlOutputKey ?? this.sqlOutputKey;\n    this.prompt =\n      fields.prompt ??\n      getPromptTemplateFromDataSource(this.database.appDataSource);\n  }\n\n  /** @ignore */\n  async _call(\n    values: ChainValues,\n    runManager?: CallbackManagerForChainRun\n  ): Promise<ChainValues> {\n    const llmChain = new LLMChain({\n      prompt: this.prompt,\n      llm: this.llm,\n      outputKey: this.outputKey,\n      memory: this.memory,\n    });\n    if (!(this.inputKey in values)) {\n      throw new Error(`Question key ${this.inputKey} not found.`);\n    }\n    const question: string = values[this.inputKey];\n    let inputText = `${question}\\nSQLQuery:`;\n    const tablesToUse = values.table_names_to_use;\n    const tableInfo = await this.database.getTableInfo(tablesToUse);\n\n    const llmInputs = {\n      input: inputText,\n      top_k: this.topK,\n      dialect: this.database.appDataSourceOptions.type,\n      table_info: tableInfo,\n      stop: [\"\\nSQLResult:\"],\n    };\n    await this.verifyNumberOfTokens(inputText, tableInfo);\n\n    const sqlCommand = await llmChain.predict(\n      llmInputs,\n      runManager?.getChild(\"sql_generation\")\n    );\n    let queryResult = \"\";\n    try {\n      queryResult = await this.database.appDataSource.query(sqlCommand);\n    } catch (error) {\n      console.error(error);\n    }\n\n    let finalResult;\n    if (this.returnDirect) {\n      finalResult = { [this.outputKey]: queryResult };\n    } else {\n      inputText += `${sqlCommand}\\nSQLResult: ${JSON.stringify(\n        queryResult\n      )}\\nAnswer:`;\n      llmInputs.input = inputText;\n      finalResult = {\n        [this.outputKey]: await llmChain.predict(\n          llmInputs,\n          runManager?.getChild(\"result_generation\")\n        ),\n      };\n    }\n\n    if (this.sqlOutputKey != null) {\n      finalResult[this.sqlOutputKey] = sqlCommand;\n    }\n\n    return finalResult;\n  }\n\n  _chainType() {\n    return \"sql_database_chain\" as const;\n  }\n\n  get inputKeys(): string[] {\n    return [this.inputKey];\n  }\n\n  get outputKeys(): string[] {\n    if (this.sqlOutputKey != null) {\n      return [this.outputKey, this.sqlOutputKey];\n    }\n    return [this.outputKey];\n  }\n\n  /**\n   * Private method that verifies the number of tokens in the input text and\n   * table information. It throws an error if the number of tokens exceeds\n   * the maximum allowed by the language model.\n   * @param inputText The input text.\n   * @param tableinfo The table information.\n   * @returns A promise that resolves when the verification is complete.\n   */\n  private async verifyNumberOfTokens(\n    inputText: string,\n    tableinfo: string\n  ): Promise<void> {\n    // We verify it only for OpenAI for the moment\n    if (this.llm._llmType() !== \"openai\") {\n      return;\n    }\n    const llm = this.llm as OpenAI;\n    const promptTemplate = this.prompt.template;\n    const stringWeSend = `${inputText}${promptTemplate}${tableinfo}`;\n\n    const maxToken = await calculateMaxTokens({\n      prompt: stringWeSend,\n      // Cast here to allow for other models that may not fit the union\n      modelName: llm.model as TiktokenModel,\n    });\n\n    if (maxToken < (llm.maxTokens ?? -1)) {\n      throw new Error(`The combination of the database structure and your question is too big for the model ${\n        llm.model\n      } which can compute only a max tokens of ${getModelContextSize(\n        llm.model\n      )}.\n      We suggest you to use the includeTables parameters when creating the SqlDatabase object to select only a subset of the tables. You can also use a model which can handle more tokens.`);\n    }\n  }\n}\n\nexport interface CreateSqlQueryChainFields {\n  llm: BaseLanguageModel;\n  db: SqlDatabase;\n  prompt?: BasePromptTemplate;\n  /**\n   * @default 5\n   */\n  k?: number;\n  dialect: SqlDialect;\n}\n\ntype SqlInput = {\n  question: string;\n};\n\ntype SqlInoutWithTables = SqlInput & {\n  tableNamesToUse: string[];\n};\n\nconst strip = (text: string) => {\n  // Replace escaped quotes with actual quotes\n  let newText = text.replace(/\\\\\"/g, '\"').trim();\n  // Remove wrapping quotes if the entire string is wrapped in quotes\n  if (newText.startsWith('\"') && newText.endsWith('\"')) {\n    newText = newText.substring(1, newText.length - 1);\n  }\n  return newText;\n};\n\nconst difference = (setA: Set<string>, setB: Set<string>) =>\n  new Set([...setA].filter((x) => !setB.has(x)));\n\n/**\n * Create a SQL query chain that can create SQL queries for the given database.\n * Returns a Runnable.\n *\n * @param {BaseLanguageModel} llm The language model to use in the chain.\n * @param {SqlDatabase} db The database to use in the chain.\n * @param {BasePromptTemplate | undefined} prompt The prompt to use in the chain.\n * @param {BaseLanguageModel | undefined} k The amount of docs/results to return. Passed through the prompt input value `top_k`.\n * @param {SqlDialect} dialect The SQL dialect to use in the chain.\n * @returns {Promise<RunnableSequence<Record<string, unknown>, string>>} A runnable sequence representing the chain.\n * @example ```typescript\n * const datasource = new DataSource({\n *   type: \"sqlite\",\n *   database: \"../../../../Chinook.db\",\n * });\n * const db = await SqlDatabase.fromDataSourceParams({\n *   appDataSource: datasource,\n * });\n * const llm = new ChatOpenAI({ model: \"gpt-4o-mini\", temperature: 0 });\n * const chain = await createSqlQueryChain({\n *   llm,\n *   db,\n *   dialect: \"sqlite\",\n * });\n * ```\n */\nexport async function createSqlQueryChain({\n  llm,\n  db,\n  prompt,\n  k = 5,\n  dialect,\n}: CreateSqlQueryChainFields) {\n  let promptToUse: BasePromptTemplate;\n  if (prompt) {\n    promptToUse = prompt;\n  } else if (SQL_PROMPTS_MAP[dialect]) {\n    promptToUse = SQL_PROMPTS_MAP[dialect];\n  } else {\n    promptToUse = DEFAULT_SQL_DATABASE_PROMPT;\n  }\n\n  if (\n    difference(\n      new Set([\"input\", \"top_k\", \"table_info\"]),\n      new Set(promptToUse.inputVariables)\n    ).size > 0\n  ) {\n    throw new Error(\n      `Prompt must have input variables: 'input', 'top_k', 'table_info'. Received prompt with input variables: ` +\n        `${promptToUse.inputVariables}. Full prompt:\\n\\n${promptToUse}`\n    );\n  }\n  if (promptToUse.inputVariables.includes(\"dialect\")) {\n    promptToUse = await promptToUse.partial({ dialect });\n  }\n\n  promptToUse = await promptToUse.partial({ top_k: k.toString() });\n\n  const inputs = {\n    input: (x: Record<string, unknown>) => {\n      if (\"question\" in x) {\n        return `${(x as SqlInput).question}\\nSQLQuery: `;\n      }\n      throw new Error(\"Input must include a question property.\");\n    },\n    table_info: async (x: Record<string, unknown>) =>\n      db.getTableInfo((x as SqlInoutWithTables).tableNamesToUse),\n  };\n\n  return RunnableSequence.from([\n    RunnablePassthrough.assign(inputs),\n    (x) => {\n      const newInputs = { ...x };\n      delete newInputs.question;\n      delete newInputs.tableNamesToUse;\n      return newInputs;\n    },\n    promptToUse,\n    llm.withConfig({ stop: [\"\\nSQLResult:\"] }),\n    new StringOutputParser(),\n    strip,\n  ]);\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAmEA,IAAa,mBAAb,cAAsCA,aAAAA,UAAU;CAC9C,OAAO,UAAU;EACf,OAAO;CACT;CAGA;CAGA;CAGA,SAASC,sBAAAA;CAGT,OAAO;CAEP,WAAW;CAEX,YAAY;CAEZ,eAAmC,KAAA;CAGnC,eAAe;CAEf,YAAY,QAA+B;EACzC,MAAM,MAAM;EACZ,KAAK,MAAM,OAAO;EAClB,KAAK,WAAW,OAAO;EACvB,KAAK,OAAO,OAAO,QAAQ,KAAK;EAChC,KAAK,WAAW,OAAO,YAAY,KAAK;EACxC,KAAK,YAAY,OAAO,aAAa,KAAK;EAC1C,KAAK,eAAe,OAAO,gBAAgB,KAAK;EAChD,KAAK,SACH,OAAO,UACPC,kBAAAA,gCAAgC,KAAK,SAAS,aAAa;CAC/D;;CAGA,MAAM,MACJ,QACA,YACsB;EACtB,MAAM,WAAW,IAAIC,kBAAAA,SAAS;GAC5B,QAAQ,KAAK;GACb,KAAK,KAAK;GACV,WAAW,KAAK;GAChB,QAAQ,KAAK;EACf,CAAC;EACD,IAAI,EAAE,KAAK,YAAY,SACrB,MAAM,IAAI,MAAM,gBAAgB,KAAK,SAAS,YAAY;EAG5D,IAAI,YAAY,GADS,OAAO,KAAK,UACT;EAC5B,MAAM,cAAc,OAAO;EAC3B,MAAM,YAAY,MAAM,KAAK,SAAS,aAAa,WAAW;EAE9D,MAAM,YAAY;GAChB,OAAO;GACP,OAAO,KAAK;GACZ,SAAS,KAAK,SAAS,qBAAqB;GAC5C,YAAY;GACZ,MAAM,CAAC,cAAc;EACvB;EACA,MAAM,KAAK,qBAAqB,WAAW,SAAS;EAEpD,MAAM,aAAa,MAAM,SAAS,QAChC,WACA,YAAY,SAAS,gBAAgB,CACvC;EACA,IAAI,cAAc;EAClB,IAAI;GACF,cAAc,MAAM,KAAK,SAAS,cAAc,MAAM,UAAU;EAClE,SAAS,OAAO;GACd,QAAQ,MAAM,KAAK;EACrB;EAEA,IAAI;EACJ,IAAI,KAAK,cACP,cAAc,GAAG,KAAK,YAAY,YAAY;OACzC;GACL,aAAa,GAAG,WAAW,eAAe,KAAK,UAC7C,WACF,EAAE;GACF,UAAU,QAAQ;GAClB,cAAc,GACX,KAAK,YAAY,MAAM,SAAS,QAC/B,WACA,YAAY,SAAS,mBAAmB,CAC1C,EACF;EACF;EAEA,IAAI,KAAK,gBAAgB,MACvB,YAAY,KAAK,gBAAgB;EAGnC,OAAO;CACT;CAEA,aAAa;EACX,OAAO;CACT;CAEA,IAAI,YAAsB;EACxB,OAAO,CAAC,KAAK,QAAQ;CACvB;CAEA,IAAI,aAAuB;EACzB,IAAI,KAAK,gBAAgB,MACvB,OAAO,CAAC,KAAK,WAAW,KAAK,YAAY;EAE3C,OAAO,CAAC,KAAK,SAAS;CACxB;;;;;;;;;CAUA,MAAc,qBACZ,WACA,WACe;EAEf,IAAI,KAAK,IAAI,SAAS,MAAM,UAC1B;EAEF,MAAM,MAAM,KAAK;EAEjB,MAAM,eAAe,GAAG,YADD,KAAK,OAAO,WACkB;EAQrD,IAAI,OAAA,GANmBC,qCAAAA,mBAAAA,CAAmB;GACxC,QAAQ;GAER,WAAW,IAAI;EACjB,CAAC,KAEe,IAAI,aAAa,KAC/B,MAAM,IAAI,MAAM,wFACd,IAAI,MACL,2CAAA,GAA0CC,qCAAAA,oBAAAA,CACzC,IAAI,KACN,EAAE;4LACoL;CAE1L;AACF;AAqBA,MAAM,SAAS,SAAiB;CAE9B,IAAI,UAAU,KAAK,QAAQ,QAAQ,IAAG,CAAC,CAAC,KAAK;CAE7C,IAAI,QAAQ,WAAW,IAAG,KAAK,QAAQ,SAAS,IAAG,GACjD,UAAU,QAAQ,UAAU,GAAG,QAAQ,SAAS,CAAC;CAEnD,OAAO;AACT;AAEA,MAAM,cAAc,MAAmB,SACrC,IAAI,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC,QAAQ,MAAM,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4B/C,eAAsB,oBAAoB,EACxC,KACA,IACA,QACA,IAAI,GACJ,WAC4B;CAC5B,IAAI;CACJ,IAAI,QACF,cAAc;MACT,IAAIC,sBAAAA,gBAAgB,UACzB,cAAcA,sBAAAA,gBAAgB;MAE9B,cAAcL,sBAAAA;CAGhB,IACE,2BACE,IAAI,IAAI;EAAC;EAAS;EAAS;CAAY,CAAC,GACxC,IAAI,IAAI,YAAY,cAAc,CACpC,CAAC,CAAC,OAAO,GAET,MAAM,IAAI,MACR,2GACK,YAAY,eAAe,oBAAoB,aACtD;CAEF,IAAI,YAAY,eAAe,SAAS,SAAS,GAC/C,cAAc,MAAM,YAAY,QAAQ,EAAE,QAAQ,CAAC;CAGrD,cAAc,MAAM,YAAY,QAAQ,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;CAa/D,OAAOM,0BAAAA,iBAAiB,KAAK;EAC3BC,0BAAAA,oBAAoB,OAAO;GAX3B,QAAQ,MAA+B;IACrC,IAAI,cAAc,GAChB,OAAO,GAAI,EAAe,SAAS;IAErC,MAAM,IAAI,MAAM,yCAAyC;GAC3D;GACA,YAAY,OAAO,MACjB,GAAG,aAAc,EAAyB,eAAe;EAI3B,CAAC;GAChC,MAAM;GACL,MAAM,YAAY,EAAE,GAAG,EAAE;GACzB,OAAO,UAAU;GACjB,OAAO,UAAU;GACjB,OAAO;EACT;EACA;EACA,IAAI,WAAW,EAAE,MAAM,CAAC,cAAc,EAAE,CAAC;EACzC,IAAIC,+BAAAA,mBAAmB;EACvB;CACF,CAAC;AACH"}

package/dist/chains/sql_db/sql_db_chain.js

@@ -111,8 +111,9 @@ var SqlDatabaseChain = class extends BaseChain {
 	async verifyNumberOfTokens(inputText, tableinfo) {
 		if (this.llm._llmType() !== "openai") return;
 		const llm = this.llm;
+		const stringWeSend = `${inputText}${this.prompt.template}${tableinfo}`;
 		if (await calculateMaxTokens({
-			prompt: `${inputText}${this.prompt.template}${tableinfo}`,
+			prompt: stringWeSend,
 			modelName: llm.model
 		}) < (llm.maxTokens ?? -1)) throw new Error(`The combination of the database structure and your question is too big for the model ${llm.model} which can compute only a max tokens of ${getModelContextSize(llm.model)}.
       We suggest you to use the includeTables parameters when creating the SqlDatabase object to select only a subset of the tables. You can also use a model which can handle more tokens.`);

package/dist/chains/sql_db/sql_db_chain.js.map

@@ -1 +1 @@
-{"version":3,"file":"sql_db_chain.js","names":[],"sources":["../../../src/chains/sql_db/sql_db_chain.ts"],"sourcesContent":["import type {\n  BaseLanguageModel,\n  BaseLanguageModelInterface,\n} from \"@langchain/core/language_models/base\";\nimport type { OpenAI, TiktokenModel } from \"@langchain/openai\";\nimport { ChainValues } from \"@langchain/core/utils/types\";\nimport { BasePromptTemplate, PromptTemplate } from \"@langchain/core/prompts\";\nimport {\n  calculateMaxTokens,\n  getModelContextSize,\n} from \"@langchain/core/language_models/base\";\nimport { CallbackManagerForChainRun } from \"@langchain/core/callbacks/manager\";\nimport {\n  RunnablePassthrough,\n  RunnableSequence,\n} from \"@langchain/core/runnables\";\nimport { StringOutputParser } from \"@langchain/core/output_parsers\";\nimport {\n  DEFAULT_SQL_DATABASE_PROMPT,\n  SQL_PROMPTS_MAP,\n  SqlDialect,\n} from \"./sql_db_prompt.js\";\nimport { BaseChain, ChainInputs } from \"../base.js\";\nimport { LLMChain } from \"../llm_chain.js\";\nimport type { SqlDatabase } from \"../../sql_db.js\";\nimport { getPromptTemplateFromDataSource } from \"../../util/sql_utils.js\";\n\n/**\n * Interface that extends the ChainInputs interface and defines additional\n * fields specific to a SQL database chain. It represents the input fields\n * for a SQL database chain.\n */\nexport interface SqlDatabaseChainInput extends ChainInputs {\n  llm: BaseLanguageModelInterface;\n  database: SqlDatabase;\n  topK?: number;\n  inputKey?: string;\n  outputKey?: string;\n  sqlOutputKey?: string;\n  prompt?: PromptTemplate;\n}\n\n/**\n * Class that represents a SQL database chain in the LangChain framework.\n * It extends the BaseChain class and implements the functionality\n * specific to a SQL database chain.\n *\n * @security **Security Notice**\n * This chain generates SQL queries for the given database.\n * The SQLDatabase class provides a getTableInfo method that can be used\n * to get column information as well as sample data from the table.\n * To mitigate risk of leaking sensitive data, limit permissions\n * to read and scope to the tables that are needed.\n * Optionally, use the includesTables or ignoreTables class parameters\n * to limit which tables can/cannot be accessed.\n *\n * @link See https://js.langchain.com/docs/security for more information.\n * @example\n * ```typescript\n * const chain = new SqlDatabaseChain({\n *   llm: new OpenAI({ temperature: 0 }),\n *   database: new SqlDatabase({ ...config }),\n * });\n *\n * const result = await chain.run(\"How many tracks are there?\");\n * ```\n */\nexport class SqlDatabaseChain extends BaseChain {\n  static lc_name() {\n    return \"SqlDatabaseChain\";\n  }\n\n  // LLM wrapper to use\n  llm: BaseLanguageModelInterface;\n\n  // SQL Database to connect to.\n  database: SqlDatabase;\n\n  // Prompt to use to translate natural language to SQL.\n  prompt = DEFAULT_SQL_DATABASE_PROMPT;\n\n  // Number of results to return from the query\n  topK = 5;\n\n  inputKey = \"query\";\n\n  outputKey = \"result\";\n\n  sqlOutputKey: string | undefined = undefined;\n\n  // Whether to return the result of querying the SQL table directly.\n  returnDirect = false;\n\n  constructor(fields: SqlDatabaseChainInput) {\n    super(fields);\n    this.llm = fields.llm;\n    this.database = fields.database;\n    this.topK = fields.topK ?? this.topK;\n    this.inputKey = fields.inputKey ?? this.inputKey;\n    this.outputKey = fields.outputKey ?? this.outputKey;\n    this.sqlOutputKey = fields.sqlOutputKey ?? this.sqlOutputKey;\n    this.prompt =\n      fields.prompt ??\n      getPromptTemplateFromDataSource(this.database.appDataSource);\n  }\n\n  /** @ignore */\n  async _call(\n    values: ChainValues,\n    runManager?: CallbackManagerForChainRun\n  ): Promise<ChainValues> {\n    const llmChain = new LLMChain({\n      prompt: this.prompt,\n      llm: this.llm,\n      outputKey: this.outputKey,\n      memory: this.memory,\n    });\n    if (!(this.inputKey in values)) {\n      throw new Error(`Question key ${this.inputKey} not found.`);\n    }\n    const question: string = values[this.inputKey];\n    let inputText = `${question}\\nSQLQuery:`;\n    const tablesToUse = values.table_names_to_use;\n    const tableInfo = await this.database.getTableInfo(tablesToUse);\n\n    const llmInputs = {\n      input: inputText,\n      top_k: this.topK,\n      dialect: this.database.appDataSourceOptions.type,\n      table_info: tableInfo,\n      stop: [\"\\nSQLResult:\"],\n    };\n    await this.verifyNumberOfTokens(inputText, tableInfo);\n\n    const sqlCommand = await llmChain.predict(\n      llmInputs,\n      runManager?.getChild(\"sql_generation\")\n    );\n    let queryResult = \"\";\n    try {\n      queryResult = await this.database.appDataSource.query(sqlCommand);\n    } catch (error) {\n      console.error(error);\n    }\n\n    let finalResult;\n    if (this.returnDirect) {\n      finalResult = { [this.outputKey]: queryResult };\n    } else {\n      inputText += `${sqlCommand}\\nSQLResult: ${JSON.stringify(\n        queryResult\n      )}\\nAnswer:`;\n      llmInputs.input = inputText;\n      finalResult = {\n        [this.outputKey]: await llmChain.predict(\n          llmInputs,\n          runManager?.getChild(\"result_generation\")\n        ),\n      };\n    }\n\n    if (this.sqlOutputKey != null) {\n      finalResult[this.sqlOutputKey] = sqlCommand;\n    }\n\n    return finalResult;\n  }\n\n  _chainType() {\n    return \"sql_database_chain\" as const;\n  }\n\n  get inputKeys(): string[] {\n    return [this.inputKey];\n  }\n\n  get outputKeys(): string[] {\n    if (this.sqlOutputKey != null) {\n      return [this.outputKey, this.sqlOutputKey];\n    }\n    return [this.outputKey];\n  }\n\n  /**\n   * Private method that verifies the number of tokens in the input text and\n   * table information. It throws an error if the number of tokens exceeds\n   * the maximum allowed by the language model.\n   * @param inputText The input text.\n   * @param tableinfo The table information.\n   * @returns A promise that resolves when the verification is complete.\n   */\n  private async verifyNumberOfTokens(\n    inputText: string,\n    tableinfo: string\n  ): Promise<void> {\n    // We verify it only for OpenAI for the moment\n    if (this.llm._llmType() !== \"openai\") {\n      return;\n    }\n    const llm = this.llm as OpenAI;\n    const promptTemplate = this.prompt.template;\n    const stringWeSend = `${inputText}${promptTemplate}${tableinfo}`;\n\n    const maxToken = await calculateMaxTokens({\n      prompt: stringWeSend,\n      // Cast here to allow for other models that may not fit the union\n      modelName: llm.model as TiktokenModel,\n    });\n\n    if (maxToken < (llm.maxTokens ?? -1)) {\n      throw new Error(`The combination of the database structure and your question is too big for the model ${\n        llm.model\n      } which can compute only a max tokens of ${getModelContextSize(\n        llm.model\n      )}.\n      We suggest you to use the includeTables parameters when creating the SqlDatabase object to select only a subset of the tables. You can also use a model which can handle more tokens.`);\n    }\n  }\n}\n\nexport interface CreateSqlQueryChainFields {\n  llm: BaseLanguageModel;\n  db: SqlDatabase;\n  prompt?: BasePromptTemplate;\n  /**\n   * @default 5\n   */\n  k?: number;\n  dialect: SqlDialect;\n}\n\ntype SqlInput = {\n  question: string;\n};\n\ntype SqlInoutWithTables = SqlInput & {\n  tableNamesToUse: string[];\n};\n\nconst strip = (text: string) => {\n  // Replace escaped quotes with actual quotes\n  let newText = text.replace(/\\\\\"/g, '\"').trim();\n  // Remove wrapping quotes if the entire string is wrapped in quotes\n  if (newText.startsWith('\"') && newText.endsWith('\"')) {\n    newText = newText.substring(1, newText.length - 1);\n  }\n  return newText;\n};\n\nconst difference = (setA: Set<string>, setB: Set<string>) =>\n  new Set([...setA].filter((x) => !setB.has(x)));\n\n/**\n * Create a SQL query chain that can create SQL queries for the given database.\n * Returns a Runnable.\n *\n * @param {BaseLanguageModel} llm The language model to use in the chain.\n * @param {SqlDatabase} db The database to use in the chain.\n * @param {BasePromptTemplate | undefined} prompt The prompt to use in the chain.\n * @param {BaseLanguageModel | undefined} k The amount of docs/results to return. Passed through the prompt input value `top_k`.\n * @param {SqlDialect} dialect The SQL dialect to use in the chain.\n * @returns {Promise<RunnableSequence<Record<string, unknown>, string>>} A runnable sequence representing the chain.\n * @example ```typescript\n * const datasource = new DataSource({\n *   type: \"sqlite\",\n *   database: \"../../../../Chinook.db\",\n * });\n * const db = await SqlDatabase.fromDataSourceParams({\n *   appDataSource: datasource,\n * });\n * const llm = new ChatOpenAI({ model: \"gpt-4o-mini\", temperature: 0 });\n * const chain = await createSqlQueryChain({\n *   llm,\n *   db,\n *   dialect: \"sqlite\",\n * });\n * ```\n */\nexport async function createSqlQueryChain({\n  llm,\n  db,\n  prompt,\n  k = 5,\n  dialect,\n}: CreateSqlQueryChainFields) {\n  let promptToUse: BasePromptTemplate;\n  if (prompt) {\n    promptToUse = prompt;\n  } else if (SQL_PROMPTS_MAP[dialect]) {\n    promptToUse = SQL_PROMPTS_MAP[dialect];\n  } else {\n    promptToUse = DEFAULT_SQL_DATABASE_PROMPT;\n  }\n\n  if (\n    difference(\n      new Set([\"input\", \"top_k\", \"table_info\"]),\n      new Set(promptToUse.inputVariables)\n    ).size > 0\n  ) {\n    throw new Error(\n      `Prompt must have input variables: 'input', 'top_k', 'table_info'. Received prompt with input variables: ` +\n        `${promptToUse.inputVariables}. Full prompt:\\n\\n${promptToUse}`\n    );\n  }\n  if (promptToUse.inputVariables.includes(\"dialect\")) {\n    promptToUse = await promptToUse.partial({ dialect });\n  }\n\n  promptToUse = await promptToUse.partial({ top_k: k.toString() });\n\n  const inputs = {\n    input: (x: Record<string, unknown>) => {\n      if (\"question\" in x) {\n        return `${(x as SqlInput).question}\\nSQLQuery: `;\n      }\n      throw new Error(\"Input must include a question property.\");\n    },\n    table_info: async (x: Record<string, unknown>) =>\n      db.getTableInfo((x as SqlInoutWithTables).tableNamesToUse),\n  };\n\n  return RunnableSequence.from([\n    RunnablePassthrough.assign(inputs),\n    (x) => {\n      const newInputs = { ...x };\n      delete newInputs.question;\n      delete newInputs.tableNamesToUse;\n      return newInputs;\n    },\n    promptToUse,\n    llm.withConfig({ stop: [\"\\nSQLResult:\"] }),\n    new StringOutputParser(),\n    strip,\n  ]);\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAmEA,IAAa,mBAAb,cAAsC,UAAU;CAC9C,OAAO,UAAU;EACf,OAAO;CACT;CAGA;CAGA;CAGA,SAAS;CAGT,OAAO;CAEP,WAAW;CAEX,YAAY;CAEZ,eAAmC,KAAA;CAGnC,eAAe;CAEf,YAAY,QAA+B;EACzC,MAAM,MAAM;EACZ,KAAK,MAAM,OAAO;EAClB,KAAK,WAAW,OAAO;EACvB,KAAK,OAAO,OAAO,QAAQ,KAAK;EAChC,KAAK,WAAW,OAAO,YAAY,KAAK;EACxC,KAAK,YAAY,OAAO,aAAa,KAAK;EAC1C,KAAK,eAAe,OAAO,gBAAgB,KAAK;EAChD,KAAK,SACH,OAAO,UACP,gCAAgC,KAAK,SAAS,aAAa;CAC/D;;CAGA,MAAM,MACJ,QACA,YACsB;EACtB,MAAM,WAAW,IAAI,SAAS;GAC5B,QAAQ,KAAK;GACb,KAAK,KAAK;GACV,WAAW,KAAK;GAChB,QAAQ,KAAK;EACf,CAAC;EACD,IAAI,EAAE,KAAK,YAAY,SACrB,MAAM,IAAI,MAAM,gBAAgB,KAAK,SAAS,YAAY;EAG5D,IAAI,YAAY,GADS,OAAO,KAAK,UACT;EAC5B,MAAM,cAAc,OAAO;EAC3B,MAAM,YAAY,MAAM,KAAK,SAAS,aAAa,WAAW;EAE9D,MAAM,YAAY;GAChB,OAAO;GACP,OAAO,KAAK;GACZ,SAAS,KAAK,SAAS,qBAAqB;GAC5C,YAAY;GACZ,MAAM,CAAC,cAAc;EACvB;EACA,MAAM,KAAK,qBAAqB,WAAW,SAAS;EAEpD,MAAM,aAAa,MAAM,SAAS,QAChC,WACA,YAAY,SAAS,gBAAgB,CACvC;EACA,IAAI,cAAc;EAClB,IAAI;GACF,cAAc,MAAM,KAAK,SAAS,cAAc,MAAM,UAAU;EAClE,SAAS,OAAO;GACd,QAAQ,MAAM,KAAK;EACrB;EAEA,IAAI;EACJ,IAAI,KAAK,cACP,cAAc,GAAG,KAAK,YAAY,YAAY;OACzC;GACL,aAAa,GAAG,WAAW,eAAe,KAAK,UAC7C,WACF,EAAE;GACF,UAAU,QAAQ;GAClB,cAAc,GACX,KAAK,YAAY,MAAM,SAAS,QAC/B,WACA,YAAY,SAAS,mBAAmB,CAC1C,EACF;EACF;EAEA,IAAI,KAAK,gBAAgB,MACvB,YAAY,KAAK,gBAAgB;EAGnC,OAAO;CACT;CAEA,aAAa;EACX,OAAO;CACT;CAEA,IAAI,YAAsB;EACxB,OAAO,CAAC,KAAK,QAAQ;CACvB;CAEA,IAAI,aAAuB;EACzB,IAAI,KAAK,gBAAgB,MACvB,OAAO,CAAC,KAAK,WAAW,KAAK,YAAY;EAE3C,OAAO,CAAC,KAAK,SAAS;CACxB;;;;;;;;;CAUA,MAAc,qBACZ,WACA,WACe;EAEf,IAAI,KAAK,IAAI,SAAS,MAAM,UAC1B;EAEF,MAAM,MAAM,KAAK;EAUjB,IAAI,MANmB,mBAAmB;GACxC,QAAQ,GAHc,YADD,KAAK,OAAO,WACkB;GAKnD,WAAW,IAAI;EACjB,CAAC,KAEe,IAAI,aAAa,KAC/B,MAAM,IAAI,MAAM,wFACd,IAAI,MACL,0CAA0C,oBACzC,IAAI,KACN,EAAE;4LACoL;CAE1L;AACF;AAqBA,MAAM,SAAS,SAAiB;CAE9B,IAAI,UAAU,KAAK,QAAQ,QAAQ,IAAG,CAAC,CAAC,KAAK;CAE7C,IAAI,QAAQ,WAAW,IAAG,KAAK,QAAQ,SAAS,IAAG,GACjD,UAAU,QAAQ,UAAU,GAAG,QAAQ,SAAS,CAAC;CAEnD,OAAO;AACT;AAEA,MAAM,cAAc,MAAmB,SACrC,IAAI,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC,QAAQ,MAAM,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4B/C,eAAsB,oBAAoB,EACxC,KACA,IACA,QACA,IAAI,GACJ,WAC4B;CAC5B,IAAI;CACJ,IAAI,QACF,cAAc;MACT,IAAI,gBAAgB,UACzB,cAAc,gBAAgB;MAE9B,cAAc;CAGhB,IACE,2BACE,IAAI,IAAI;EAAC;EAAS;EAAS;CAAY,CAAC,GACxC,IAAI,IAAI,YAAY,cAAc,CACpC,CAAC,CAAC,OAAO,GAET,MAAM,IAAI,MACR,2GACK,YAAY,eAAe,oBAAoB,aACtD;CAEF,IAAI,YAAY,eAAe,SAAS,SAAS,GAC/C,cAAc,MAAM,YAAY,QAAQ,EAAE,QAAQ,CAAC;CAGrD,cAAc,MAAM,YAAY,QAAQ,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;CAa/D,OAAO,iBAAiB,KAAK;EAC3B,oBAAoB,OAAO;GAX3B,QAAQ,MAA+B;IACrC,IAAI,cAAc,GAChB,OAAO,GAAI,EAAe,SAAS;IAErC,MAAM,IAAI,MAAM,yCAAyC;GAC3D;GACA,YAAY,OAAO,MACjB,GAAG,aAAc,EAAyB,eAAe;EAI3B,CAAC;GAChC,MAAM;GACL,MAAM,YAAY,EAAE,GAAG,EAAE;GACzB,OAAO,UAAU;GACjB,OAAO,UAAU;GACjB,OAAO;EACT;EACA;EACA,IAAI,WAAW,EAAE,MAAM,CAAC,cAAc,EAAE,CAAC;EACzC,IAAI,mBAAmB;EACvB;CACF,CAAC;AACH"}
+{"version":3,"file":"sql_db_chain.js","names":[],"sources":["../../../src/chains/sql_db/sql_db_chain.ts"],"sourcesContent":["import type {\n  BaseLanguageModel,\n  BaseLanguageModelInterface,\n} from \"@langchain/core/language_models/base\";\nimport type { OpenAI, TiktokenModel } from \"@langchain/openai\";\nimport { ChainValues } from \"@langchain/core/utils/types\";\nimport { BasePromptTemplate, PromptTemplate } from \"@langchain/core/prompts\";\nimport {\n  calculateMaxTokens,\n  getModelContextSize,\n} from \"@langchain/core/language_models/base\";\nimport { CallbackManagerForChainRun } from \"@langchain/core/callbacks/manager\";\nimport {\n  RunnablePassthrough,\n  RunnableSequence,\n} from \"@langchain/core/runnables\";\nimport { StringOutputParser } from \"@langchain/core/output_parsers\";\nimport {\n  DEFAULT_SQL_DATABASE_PROMPT,\n  SQL_PROMPTS_MAP,\n  SqlDialect,\n} from \"./sql_db_prompt.js\";\nimport { BaseChain, ChainInputs } from \"../base.js\";\nimport { LLMChain } from \"../llm_chain.js\";\nimport type { SqlDatabase } from \"../../sql_db.js\";\nimport { getPromptTemplateFromDataSource } from \"../../util/sql_utils.js\";\n\n/**\n * Interface that extends the ChainInputs interface and defines additional\n * fields specific to a SQL database chain. It represents the input fields\n * for a SQL database chain.\n */\nexport interface SqlDatabaseChainInput extends ChainInputs {\n  llm: BaseLanguageModelInterface;\n  database: SqlDatabase;\n  topK?: number;\n  inputKey?: string;\n  outputKey?: string;\n  sqlOutputKey?: string;\n  prompt?: PromptTemplate;\n}\n\n/**\n * Class that represents a SQL database chain in the LangChain framework.\n * It extends the BaseChain class and implements the functionality\n * specific to a SQL database chain.\n *\n * @security **Security Notice**\n * This chain generates SQL queries for the given database.\n * The SQLDatabase class provides a getTableInfo method that can be used\n * to get column information as well as sample data from the table.\n * To mitigate risk of leaking sensitive data, limit permissions\n * to read and scope to the tables that are needed.\n * Optionally, use the includesTables or ignoreTables class parameters\n * to limit which tables can/cannot be accessed.\n *\n * @link See https://js.langchain.com/docs/security for more information.\n * @example\n * ```typescript\n * const chain = new SqlDatabaseChain({\n *   llm: new OpenAI({ temperature: 0 }),\n *   database: new SqlDatabase({ ...config }),\n * });\n *\n * const result = await chain.run(\"How many tracks are there?\");\n * ```\n */\nexport class SqlDatabaseChain extends BaseChain {\n  static lc_name() {\n    return \"SqlDatabaseChain\";\n  }\n\n  // LLM wrapper to use\n  llm: BaseLanguageModelInterface;\n\n  // SQL Database to connect to.\n  database: SqlDatabase;\n\n  // Prompt to use to translate natural language to SQL.\n  prompt = DEFAULT_SQL_DATABASE_PROMPT;\n\n  // Number of results to return from the query\n  topK = 5;\n\n  inputKey = \"query\";\n\n  outputKey = \"result\";\n\n  sqlOutputKey: string | undefined = undefined;\n\n  // Whether to return the result of querying the SQL table directly.\n  returnDirect = false;\n\n  constructor(fields: SqlDatabaseChainInput) {\n    super(fields);\n    this.llm = fields.llm;\n    this.database = fields.database;\n    this.topK = fields.topK ?? this.topK;\n    this.inputKey = fields.inputKey ?? this.inputKey;\n    this.outputKey = fields.outputKey ?? this.outputKey;\n    this.sqlOutputKey = fields.sqlOutputKey ?? this.sqlOutputKey;\n    this.prompt =\n      fields.prompt ??\n      getPromptTemplateFromDataSource(this.database.appDataSource);\n  }\n\n  /** @ignore */\n  async _call(\n    values: ChainValues,\n    runManager?: CallbackManagerForChainRun\n  ): Promise<ChainValues> {\n    const llmChain = new LLMChain({\n      prompt: this.prompt,\n      llm: this.llm,\n      outputKey: this.outputKey,\n      memory: this.memory,\n    });\n    if (!(this.inputKey in values)) {\n      throw new Error(`Question key ${this.inputKey} not found.`);\n    }\n    const question: string = values[this.inputKey];\n    let inputText = `${question}\\nSQLQuery:`;\n    const tablesToUse = values.table_names_to_use;\n    const tableInfo = await this.database.getTableInfo(tablesToUse);\n\n    const llmInputs = {\n      input: inputText,\n      top_k: this.topK,\n      dialect: this.database.appDataSourceOptions.type,\n      table_info: tableInfo,\n      stop: [\"\\nSQLResult:\"],\n    };\n    await this.verifyNumberOfTokens(inputText, tableInfo);\n\n    const sqlCommand = await llmChain.predict(\n      llmInputs,\n      runManager?.getChild(\"sql_generation\")\n    );\n    let queryResult = \"\";\n    try {\n      queryResult = await this.database.appDataSource.query(sqlCommand);\n    } catch (error) {\n      console.error(error);\n    }\n\n    let finalResult;\n    if (this.returnDirect) {\n      finalResult = { [this.outputKey]: queryResult };\n    } else {\n      inputText += `${sqlCommand}\\nSQLResult: ${JSON.stringify(\n        queryResult\n      )}\\nAnswer:`;\n      llmInputs.input = inputText;\n      finalResult = {\n        [this.outputKey]: await llmChain.predict(\n          llmInputs,\n          runManager?.getChild(\"result_generation\")\n        ),\n      };\n    }\n\n    if (this.sqlOutputKey != null) {\n      finalResult[this.sqlOutputKey] = sqlCommand;\n    }\n\n    return finalResult;\n  }\n\n  _chainType() {\n    return \"sql_database_chain\" as const;\n  }\n\n  get inputKeys(): string[] {\n    return [this.inputKey];\n  }\n\n  get outputKeys(): string[] {\n    if (this.sqlOutputKey != null) {\n      return [this.outputKey, this.sqlOutputKey];\n    }\n    return [this.outputKey];\n  }\n\n  /**\n   * Private method that verifies the number of tokens in the input text and\n   * table information. It throws an error if the number of tokens exceeds\n   * the maximum allowed by the language model.\n   * @param inputText The input text.\n   * @param tableinfo The table information.\n   * @returns A promise that resolves when the verification is complete.\n   */\n  private async verifyNumberOfTokens(\n    inputText: string,\n    tableinfo: string\n  ): Promise<void> {\n    // We verify it only for OpenAI for the moment\n    if (this.llm._llmType() !== \"openai\") {\n      return;\n    }\n    const llm = this.llm as OpenAI;\n    const promptTemplate = this.prompt.template;\n    const stringWeSend = `${inputText}${promptTemplate}${tableinfo}`;\n\n    const maxToken = await calculateMaxTokens({\n      prompt: stringWeSend,\n      // Cast here to allow for other models that may not fit the union\n      modelName: llm.model as TiktokenModel,\n    });\n\n    if (maxToken < (llm.maxTokens ?? -1)) {\n      throw new Error(`The combination of the database structure and your question is too big for the model ${\n        llm.model\n      } which can compute only a max tokens of ${getModelContextSize(\n        llm.model\n      )}.\n      We suggest you to use the includeTables parameters when creating the SqlDatabase object to select only a subset of the tables. You can also use a model which can handle more tokens.`);\n    }\n  }\n}\n\nexport interface CreateSqlQueryChainFields {\n  llm: BaseLanguageModel;\n  db: SqlDatabase;\n  prompt?: BasePromptTemplate;\n  /**\n   * @default 5\n   */\n  k?: number;\n  dialect: SqlDialect;\n}\n\ntype SqlInput = {\n  question: string;\n};\n\ntype SqlInoutWithTables = SqlInput & {\n  tableNamesToUse: string[];\n};\n\nconst strip = (text: string) => {\n  // Replace escaped quotes with actual quotes\n  let newText = text.replace(/\\\\\"/g, '\"').trim();\n  // Remove wrapping quotes if the entire string is wrapped in quotes\n  if (newText.startsWith('\"') && newText.endsWith('\"')) {\n    newText = newText.substring(1, newText.length - 1);\n  }\n  return newText;\n};\n\nconst difference = (setA: Set<string>, setB: Set<string>) =>\n  new Set([...setA].filter((x) => !setB.has(x)));\n\n/**\n * Create a SQL query chain that can create SQL queries for the given database.\n * Returns a Runnable.\n *\n * @param {BaseLanguageModel} llm The language model to use in the chain.\n * @param {SqlDatabase} db The database to use in the chain.\n * @param {BasePromptTemplate | undefined} prompt The prompt to use in the chain.\n * @param {BaseLanguageModel | undefined} k The amount of docs/results to return. Passed through the prompt input value `top_k`.\n * @param {SqlDialect} dialect The SQL dialect to use in the chain.\n * @returns {Promise<RunnableSequence<Record<string, unknown>, string>>} A runnable sequence representing the chain.\n * @example ```typescript\n * const datasource = new DataSource({\n *   type: \"sqlite\",\n *   database: \"../../../../Chinook.db\",\n * });\n * const db = await SqlDatabase.fromDataSourceParams({\n *   appDataSource: datasource,\n * });\n * const llm = new ChatOpenAI({ model: \"gpt-4o-mini\", temperature: 0 });\n * const chain = await createSqlQueryChain({\n *   llm,\n *   db,\n *   dialect: \"sqlite\",\n * });\n * ```\n */\nexport async function createSqlQueryChain({\n  llm,\n  db,\n  prompt,\n  k = 5,\n  dialect,\n}: CreateSqlQueryChainFields) {\n  let promptToUse: BasePromptTemplate;\n  if (prompt) {\n    promptToUse = prompt;\n  } else if (SQL_PROMPTS_MAP[dialect]) {\n    promptToUse = SQL_PROMPTS_MAP[dialect];\n  } else {\n    promptToUse = DEFAULT_SQL_DATABASE_PROMPT;\n  }\n\n  if (\n    difference(\n      new Set([\"input\", \"top_k\", \"table_info\"]),\n      new Set(promptToUse.inputVariables)\n    ).size > 0\n  ) {\n    throw new Error(\n      `Prompt must have input variables: 'input', 'top_k', 'table_info'. Received prompt with input variables: ` +\n        `${promptToUse.inputVariables}. Full prompt:\\n\\n${promptToUse}`\n    );\n  }\n  if (promptToUse.inputVariables.includes(\"dialect\")) {\n    promptToUse = await promptToUse.partial({ dialect });\n  }\n\n  promptToUse = await promptToUse.partial({ top_k: k.toString() });\n\n  const inputs = {\n    input: (x: Record<string, unknown>) => {\n      if (\"question\" in x) {\n        return `${(x as SqlInput).question}\\nSQLQuery: `;\n      }\n      throw new Error(\"Input must include a question property.\");\n    },\n    table_info: async (x: Record<string, unknown>) =>\n      db.getTableInfo((x as SqlInoutWithTables).tableNamesToUse),\n  };\n\n  return RunnableSequence.from([\n    RunnablePassthrough.assign(inputs),\n    (x) => {\n      const newInputs = { ...x };\n      delete newInputs.question;\n      delete newInputs.tableNamesToUse;\n      return newInputs;\n    },\n    promptToUse,\n    llm.withConfig({ stop: [\"\\nSQLResult:\"] }),\n    new StringOutputParser(),\n    strip,\n  ]);\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAmEA,IAAa,mBAAb,cAAsC,UAAU;CAC9C,OAAO,UAAU;EACf,OAAO;CACT;CAGA;CAGA;CAGA,SAAS;CAGT,OAAO;CAEP,WAAW;CAEX,YAAY;CAEZ,eAAmC,KAAA;CAGnC,eAAe;CAEf,YAAY,QAA+B;EACzC,MAAM,MAAM;EACZ,KAAK,MAAM,OAAO;EAClB,KAAK,WAAW,OAAO;EACvB,KAAK,OAAO,OAAO,QAAQ,KAAK;EAChC,KAAK,WAAW,OAAO,YAAY,KAAK;EACxC,KAAK,YAAY,OAAO,aAAa,KAAK;EAC1C,KAAK,eAAe,OAAO,gBAAgB,KAAK;EAChD,KAAK,SACH,OAAO,UACP,gCAAgC,KAAK,SAAS,aAAa;CAC/D;;CAGA,MAAM,MACJ,QACA,YACsB;EACtB,MAAM,WAAW,IAAI,SAAS;GAC5B,QAAQ,KAAK;GACb,KAAK,KAAK;GACV,WAAW,KAAK;GAChB,QAAQ,KAAK;EACf,CAAC;EACD,IAAI,EAAE,KAAK,YAAY,SACrB,MAAM,IAAI,MAAM,gBAAgB,KAAK,SAAS,YAAY;EAG5D,IAAI,YAAY,GADS,OAAO,KAAK,UACT;EAC5B,MAAM,cAAc,OAAO;EAC3B,MAAM,YAAY,MAAM,KAAK,SAAS,aAAa,WAAW;EAE9D,MAAM,YAAY;GAChB,OAAO;GACP,OAAO,KAAK;GACZ,SAAS,KAAK,SAAS,qBAAqB;GAC5C,YAAY;GACZ,MAAM,CAAC,cAAc;EACvB;EACA,MAAM,KAAK,qBAAqB,WAAW,SAAS;EAEpD,MAAM,aAAa,MAAM,SAAS,QAChC,WACA,YAAY,SAAS,gBAAgB,CACvC;EACA,IAAI,cAAc;EAClB,IAAI;GACF,cAAc,MAAM,KAAK,SAAS,cAAc,MAAM,UAAU;EAClE,SAAS,OAAO;GACd,QAAQ,MAAM,KAAK;EACrB;EAEA,IAAI;EACJ,IAAI,KAAK,cACP,cAAc,GAAG,KAAK,YAAY,YAAY;OACzC;GACL,aAAa,GAAG,WAAW,eAAe,KAAK,UAC7C,WACF,EAAE;GACF,UAAU,QAAQ;GAClB,cAAc,GACX,KAAK,YAAY,MAAM,SAAS,QAC/B,WACA,YAAY,SAAS,mBAAmB,CAC1C,EACF;EACF;EAEA,IAAI,KAAK,gBAAgB,MACvB,YAAY,KAAK,gBAAgB;EAGnC,OAAO;CACT;CAEA,aAAa;EACX,OAAO;CACT;CAEA,IAAI,YAAsB;EACxB,OAAO,CAAC,KAAK,QAAQ;CACvB;CAEA,IAAI,aAAuB;EACzB,IAAI,KAAK,gBAAgB,MACvB,OAAO,CAAC,KAAK,WAAW,KAAK,YAAY;EAE3C,OAAO,CAAC,KAAK,SAAS;CACxB;;;;;;;;;CAUA,MAAc,qBACZ,WACA,WACe;EAEf,IAAI,KAAK,IAAI,SAAS,MAAM,UAC1B;EAEF,MAAM,MAAM,KAAK;EAEjB,MAAM,eAAe,GAAG,YADD,KAAK,OAAO,WACkB;EAQrD,IAAI,MANmB,mBAAmB;GACxC,QAAQ;GAER,WAAW,IAAI;EACjB,CAAC,KAEe,IAAI,aAAa,KAC/B,MAAM,IAAI,MAAM,wFACd,IAAI,MACL,0CAA0C,oBACzC,IAAI,KACN,EAAE;4LACoL;CAE1L;AACF;AAqBA,MAAM,SAAS,SAAiB;CAE9B,IAAI,UAAU,KAAK,QAAQ,QAAQ,IAAG,CAAC,CAAC,KAAK;CAE7C,IAAI,QAAQ,WAAW,IAAG,KAAK,QAAQ,SAAS,IAAG,GACjD,UAAU,QAAQ,UAAU,GAAG,QAAQ,SAAS,CAAC;CAEnD,OAAO;AACT;AAEA,MAAM,cAAc,MAAmB,SACrC,IAAI,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC,QAAQ,MAAM,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4B/C,eAAsB,oBAAoB,EACxC,KACA,IACA,QACA,IAAI,GACJ,WAC4B;CAC5B,IAAI;CACJ,IAAI,QACF,cAAc;MACT,IAAI,gBAAgB,UACzB,cAAc,gBAAgB;MAE9B,cAAc;CAGhB,IACE,2BACE,IAAI,IAAI;EAAC;EAAS;EAAS;CAAY,CAAC,GACxC,IAAI,IAAI,YAAY,cAAc,CACpC,CAAC,CAAC,OAAO,GAET,MAAM,IAAI,MACR,2GACK,YAAY,eAAe,oBAAoB,aACtD;CAEF,IAAI,YAAY,eAAe,SAAS,SAAS,GAC/C,cAAc,MAAM,YAAY,QAAQ,EAAE,QAAQ,CAAC;CAGrD,cAAc,MAAM,YAAY,QAAQ,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;CAa/D,OAAO,iBAAiB,KAAK;EAC3B,oBAAoB,OAAO;GAX3B,QAAQ,MAA+B;IACrC,IAAI,cAAc,GAChB,OAAO,GAAI,EAAe,SAAS;IAErC,MAAM,IAAI,MAAM,yCAAyC;GAC3D;GACA,YAAY,OAAO,MACjB,GAAG,aAAc,EAAyB,eAAe;EAI3B,CAAC;GAChC,MAAM;GACL,MAAM,YAAY,EAAE,GAAG,EAAE;GACzB,OAAO,UAAU;GACjB,OAAO,UAAU;GACjB,OAAO;EACT;EACA;EACA,IAAI,WAAW,EAAE,MAAM,CAAC,cAAc,EAAE,CAAC;EACzC,IAAI,mBAAmB;EACvB;CACF,CAAC;AACH"}

package/dist/chains/summarization/load.cjs

@@ -7,33 +7,37 @@ const loadSummarizationChain = (llm, params = { type: "map_reduce" }) => {
 	const { verbose } = params;
 	if (params.type === "stuff") {
 		const { prompt = require_stuff_prompts.DEFAULT_PROMPT } = params;
+		const llmChain = new require_llm_chain.LLMChain({
+			prompt,
+			llm,
+			verbose
+		});
 		return new require_combine_docs_chain.StuffDocumentsChain({
-			llmChain: new require_llm_chain.LLMChain({
-				prompt,
-				llm,
-				verbose
-			}),
+			llmChain,
 			documentVariableName: "text",
 			verbose
 		});
 	}
 	if (params.type === "map_reduce") {
 		const { combineMapPrompt = require_stuff_prompts.DEFAULT_PROMPT, combinePrompt = require_stuff_prompts.DEFAULT_PROMPT, combineLLM, returnIntermediateSteps } = params;
+		const llmChain = new require_llm_chain.LLMChain({
+			prompt: combineMapPrompt,
+			llm,
+			verbose
+		});
+		const combineLLMChain = new require_llm_chain.LLMChain({
+			prompt: combinePrompt,
+			llm: combineLLM ?? llm,
+			verbose
+		});
+		const combineDocumentChain = new require_combine_docs_chain.StuffDocumentsChain({
+			llmChain: combineLLMChain,
+			documentVariableName: "text",
+			verbose
+		});
 		return new require_combine_docs_chain.MapReduceDocumentsChain({
-			llmChain: new require_llm_chain.LLMChain({
-				prompt: combineMapPrompt,
-				llm,
-				verbose
-			}),
-			combineDocumentChain: new require_combine_docs_chain.StuffDocumentsChain({
-				llmChain: new require_llm_chain.LLMChain({
-					prompt: combinePrompt,
-					llm: combineLLM ?? llm,
-					verbose
-				}),
-				documentVariableName: "text",
-				verbose
-			}),
+			llmChain,
+			combineDocumentChain,
 			documentVariableName: "text",
 			returnIntermediateSteps,
 			verbose
@@ -41,17 +45,19 @@ const loadSummarizationChain = (llm, params = { type: "map_reduce" }) => {
 	}
 	if (params.type === "refine") {
 		const { refinePrompt = require_refine_prompts.REFINE_PROMPT, refineLLM, questionPrompt = require_stuff_prompts.DEFAULT_PROMPT } = params;
+		const llmChain = new require_llm_chain.LLMChain({
+			prompt: questionPrompt,
+			llm,
+			verbose
+		});
+		const refineLLMChain = new require_llm_chain.LLMChain({
+			prompt: refinePrompt,
+			llm: refineLLM ?? llm,
+			verbose
+		});
 		return new require_combine_docs_chain.RefineDocumentsChain({
-			llmChain: new require_llm_chain.LLMChain({
-				prompt: questionPrompt,
-				llm,
-				verbose
-			}),
-			refineLLMChain: new require_llm_chain.LLMChain({
-				prompt: refinePrompt,
-				llm: refineLLM ?? llm,
-				verbose
-			}),
+			llmChain,
+			refineLLMChain,
 			documentVariableName: "text",
 			verbose
 		});

package/dist/chains/summarization/load.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"load.cjs","names":["DEFAULT_PROMPT","StuffDocumentsChain","LLMChain","MapReduceDocumentsChain","REFINE_PROMPT","RefineDocumentsChain"],"sources":["../../../src/chains/summarization/load.ts"],"sourcesContent":["import type { BaseLanguageModelInterface } from \"@langchain/core/language_models/base\";\nimport { BasePromptTemplate } from \"@langchain/core/prompts\";\nimport { LLMChain } from \"../llm_chain.js\";\nimport {\n  StuffDocumentsChain,\n  MapReduceDocumentsChain,\n  RefineDocumentsChain,\n  MapReduceDocumentsChainInput,\n} from \"../combine_docs_chain.js\";\nimport { DEFAULT_PROMPT } from \"./stuff_prompts.js\";\nimport { REFINE_PROMPT } from \"./refine_prompts.js\";\n\n/**\n * Type for the base parameters that can be used to configure a\n * summarization chain.\n */\ntype BaseParams = {\n  verbose?: boolean;\n};\n\n/** @interface */\nexport type SummarizationChainParams = BaseParams &\n  (\n    | {\n        type?: \"stuff\";\n        prompt?: BasePromptTemplate;\n      }\n    | ({\n        type?: \"map_reduce\";\n        combineMapPrompt?: BasePromptTemplate;\n        combinePrompt?: BasePromptTemplate;\n        combineLLM?: BaseLanguageModelInterface;\n      } & Pick<MapReduceDocumentsChainInput, \"returnIntermediateSteps\">)\n    | {\n        type?: \"refine\";\n        refinePrompt?: BasePromptTemplate;\n        refineLLM?: BaseLanguageModelInterface;\n        questionPrompt?: BasePromptTemplate;\n      }\n  );\n\nexport const loadSummarizationChain = (\n  llm: BaseLanguageModelInterface,\n  params: SummarizationChainParams = { type: \"map_reduce\" }\n) => {\n  const { verbose } = params;\n  if (params.type === \"stuff\") {\n    const { prompt = DEFAULT_PROMPT } = params;\n    const llmChain = new LLMChain({ prompt, llm, verbose });\n    const chain = new StuffDocumentsChain({\n      llmChain,\n      documentVariableName: \"text\",\n      verbose,\n    });\n    return chain;\n  }\n  if (params.type === \"map_reduce\") {\n    const {\n      combineMapPrompt = DEFAULT_PROMPT,\n      combinePrompt = DEFAULT_PROMPT,\n      combineLLM,\n      returnIntermediateSteps,\n    } = params;\n    const llmChain = new LLMChain({ prompt: combineMapPrompt, llm, verbose });\n    const combineLLMChain = new LLMChain({\n      prompt: combinePrompt,\n      llm: combineLLM ?? llm,\n      verbose,\n    });\n    const combineDocumentChain = new StuffDocumentsChain({\n      llmChain: combineLLMChain,\n      documentVariableName: \"text\",\n      verbose,\n    });\n    const chain = new MapReduceDocumentsChain({\n      llmChain,\n      combineDocumentChain,\n      documentVariableName: \"text\",\n      returnIntermediateSteps,\n      verbose,\n    });\n    return chain;\n  }\n  if (params.type === \"refine\") {\n    const {\n      refinePrompt = REFINE_PROMPT,\n      refineLLM,\n      questionPrompt = DEFAULT_PROMPT,\n    } = params;\n    const llmChain = new LLMChain({ prompt: questionPrompt, llm, verbose });\n    const refineLLMChain = new LLMChain({\n      prompt: refinePrompt,\n      llm: refineLLM ?? llm,\n      verbose,\n    });\n    const chain = new RefineDocumentsChain({\n      llmChain,\n      refineLLMChain,\n      documentVariableName: \"text\",\n      verbose,\n    });\n    return chain;\n  }\n  throw new Error(`Invalid _type: ${params.type}`);\n};\n"],"mappings":";;;;;AAyCA,MAAa,0BACX,KACA,SAAmC,EAAE,MAAM,aAAa,MACrD;CACH,MAAM,EAAE,YAAY;CACpB,IAAI,OAAO,SAAS,SAAS;EAC3B,MAAM,EAAE,SAASA,sBAAAA,mBAAmB;EAOpC,OAAO,IALWC,2BAAAA,oBAAoB;GACpC,UAAA,IAFmBC,kBAAAA,SAAS;IAAE;IAAQ;IAAK;GAAQ,CAE5C;GACP,sBAAsB;GACtB;EACF,CACW;CACb;CACA,IAAI,OAAO,SAAS,cAAc;EAChC,MAAM,EACJ,mBAAmBF,sBAAAA,gBACnB,gBAAgBA,sBAAAA,gBAChB,YACA,4BACE;EAmBJ,OAAO,IAPWG,2BAAAA,wBAAwB;GACxC,UAAA,IAZmBD,kBAAAA,SAAS;IAAE,QAAQ;IAAkB;IAAK;GAAQ,CAY9D;GACP,sBAAA,IAP+BD,2BAAAA,oBAAoB;IACnD,UAAU,IANgBC,kBAAAA,SAAS;KACnC,QAAQ;KACR,KAAK,cAAc;KACnB;IACF,CAE0B;IACxB,sBAAsB;IACtB;GACF,CAGqB;GACnB,sBAAsB;GACtB;GACA;EACF,CACW;CACb;CACA,IAAI,OAAO,SAAS,UAAU;EAC5B,MAAM,EACJ,eAAeE,uBAAAA,eACf,WACA,iBAAiBJ,sBAAAA,mBACf;EAaJ,OAAO,IANWK,2BAAAA,qBAAqB;GACrC,UAAA,IAPmBH,kBAAAA,SAAS;IAAE,QAAQ;IAAgB;IAAK;GAAQ,CAO5D;GACP,gBAAA,IAPyBA,kBAAAA,SAAS;IAClC,QAAQ;IACR,KAAK,aAAa;IAClB;GACF,CAGe;GACb,sBAAsB;GACtB;EACF,CACW;CACb;CACA,MAAM,IAAI,MAAM,kBAAkB,OAAO,MAAM;AACjD"}
+{"version":3,"file":"load.cjs","names":["DEFAULT_PROMPT","LLMChain","StuffDocumentsChain","MapReduceDocumentsChain","REFINE_PROMPT","RefineDocumentsChain"],"sources":["../../../src/chains/summarization/load.ts"],"sourcesContent":["import type { BaseLanguageModelInterface } from \"@langchain/core/language_models/base\";\nimport { BasePromptTemplate } from \"@langchain/core/prompts\";\nimport { LLMChain } from \"../llm_chain.js\";\nimport {\n  StuffDocumentsChain,\n  MapReduceDocumentsChain,\n  RefineDocumentsChain,\n  MapReduceDocumentsChainInput,\n} from \"../combine_docs_chain.js\";\nimport { DEFAULT_PROMPT } from \"./stuff_prompts.js\";\nimport { REFINE_PROMPT } from \"./refine_prompts.js\";\n\n/**\n * Type for the base parameters that can be used to configure a\n * summarization chain.\n */\ntype BaseParams = {\n  verbose?: boolean;\n};\n\n/** @interface */\nexport type SummarizationChainParams = BaseParams &\n  (\n    | {\n        type?: \"stuff\";\n        prompt?: BasePromptTemplate;\n      }\n    | ({\n        type?: \"map_reduce\";\n        combineMapPrompt?: BasePromptTemplate;\n        combinePrompt?: BasePromptTemplate;\n        combineLLM?: BaseLanguageModelInterface;\n      } & Pick<MapReduceDocumentsChainInput, \"returnIntermediateSteps\">)\n    | {\n        type?: \"refine\";\n        refinePrompt?: BasePromptTemplate;\n        refineLLM?: BaseLanguageModelInterface;\n        questionPrompt?: BasePromptTemplate;\n      }\n  );\n\nexport const loadSummarizationChain = (\n  llm: BaseLanguageModelInterface,\n  params: SummarizationChainParams = { type: \"map_reduce\" }\n) => {\n  const { verbose } = params;\n  if (params.type === \"stuff\") {\n    const { prompt = DEFAULT_PROMPT } = params;\n    const llmChain = new LLMChain({ prompt, llm, verbose });\n    const chain = new StuffDocumentsChain({\n      llmChain,\n      documentVariableName: \"text\",\n      verbose,\n    });\n    return chain;\n  }\n  if (params.type === \"map_reduce\") {\n    const {\n      combineMapPrompt = DEFAULT_PROMPT,\n      combinePrompt = DEFAULT_PROMPT,\n      combineLLM,\n      returnIntermediateSteps,\n    } = params;\n    const llmChain = new LLMChain({ prompt: combineMapPrompt, llm, verbose });\n    const combineLLMChain = new LLMChain({\n      prompt: combinePrompt,\n      llm: combineLLM ?? llm,\n      verbose,\n    });\n    const combineDocumentChain = new StuffDocumentsChain({\n      llmChain: combineLLMChain,\n      documentVariableName: \"text\",\n      verbose,\n    });\n    const chain = new MapReduceDocumentsChain({\n      llmChain,\n      combineDocumentChain,\n      documentVariableName: \"text\",\n      returnIntermediateSteps,\n      verbose,\n    });\n    return chain;\n  }\n  if (params.type === \"refine\") {\n    const {\n      refinePrompt = REFINE_PROMPT,\n      refineLLM,\n      questionPrompt = DEFAULT_PROMPT,\n    } = params;\n    const llmChain = new LLMChain({ prompt: questionPrompt, llm, verbose });\n    const refineLLMChain = new LLMChain({\n      prompt: refinePrompt,\n      llm: refineLLM ?? llm,\n      verbose,\n    });\n    const chain = new RefineDocumentsChain({\n      llmChain,\n      refineLLMChain,\n      documentVariableName: \"text\",\n      verbose,\n    });\n    return chain;\n  }\n  throw new Error(`Invalid _type: ${params.type}`);\n};\n"],"mappings":";;;;;AAyCA,MAAa,0BACX,KACA,SAAmC,EAAE,MAAM,aAAa,MACrD;CACH,MAAM,EAAE,YAAY;CACpB,IAAI,OAAO,SAAS,SAAS;EAC3B,MAAM,EAAE,SAASA,sBAAAA,mBAAmB;EACpC,MAAM,WAAW,IAAIC,kBAAAA,SAAS;GAAE;GAAQ;GAAK;EAAQ,CAAC;EAMtD,OAAO,IALWC,2BAAAA,oBAAoB;GACpC;GACA,sBAAsB;GACtB;EACF,CACW;CACb;CACA,IAAI,OAAO,SAAS,cAAc;EAChC,MAAM,EACJ,mBAAmBF,sBAAAA,gBACnB,gBAAgBA,sBAAAA,gBAChB,YACA,4BACE;EACJ,MAAM,WAAW,IAAIC,kBAAAA,SAAS;GAAE,QAAQ;GAAkB;GAAK;EAAQ,CAAC;EACxE,MAAM,kBAAkB,IAAIA,kBAAAA,SAAS;GACnC,QAAQ;GACR,KAAK,cAAc;GACnB;EACF,CAAC;EACD,MAAM,uBAAuB,IAAIC,2BAAAA,oBAAoB;GACnD,UAAU;GACV,sBAAsB;GACtB;EACF,CAAC;EAQD,OAAO,IAPWC,2BAAAA,wBAAwB;GACxC;GACA;GACA,sBAAsB;GACtB;GACA;EACF,CACW;CACb;CACA,IAAI,OAAO,SAAS,UAAU;EAC5B,MAAM,EACJ,eAAeC,uBAAAA,eACf,WACA,iBAAiBJ,sBAAAA,mBACf;EACJ,MAAM,WAAW,IAAIC,kBAAAA,SAAS;GAAE,QAAQ;GAAgB;GAAK;EAAQ,CAAC;EACtE,MAAM,iBAAiB,IAAIA,kBAAAA,SAAS;GAClC,QAAQ;GACR,KAAK,aAAa;GAClB;EACF,CAAC;EAOD,OAAO,IANWI,2BAAAA,qBAAqB;GACrC;GACA;GACA,sBAAsB;GACtB;EACF,CACW;CACb;CACA,MAAM,IAAI,MAAM,kBAAkB,OAAO,MAAM;AACjD"}

package/dist/chains/summarization/load.js

@@ -7,33 +7,37 @@ const loadSummarizationChain = (llm, params = { type: "map_reduce" }) => {
 	const { verbose } = params;
 	if (params.type === "stuff") {
 		const { prompt = DEFAULT_PROMPT } = params;
+		const llmChain = new LLMChain({
+			prompt,
+			llm,
+			verbose
+		});
 		return new StuffDocumentsChain({
-			llmChain: new LLMChain({
-				prompt,
-				llm,
-				verbose
-			}),
+			llmChain,
 			documentVariableName: "text",
 			verbose
 		});
 	}
 	if (params.type === "map_reduce") {
 		const { combineMapPrompt = DEFAULT_PROMPT, combinePrompt = DEFAULT_PROMPT, combineLLM, returnIntermediateSteps } = params;
+		const llmChain = new LLMChain({
+			prompt: combineMapPrompt,
+			llm,
+			verbose
+		});
+		const combineLLMChain = new LLMChain({
+			prompt: combinePrompt,
+			llm: combineLLM ?? llm,
+			verbose
+		});
+		const combineDocumentChain = new StuffDocumentsChain({
+			llmChain: combineLLMChain,
+			documentVariableName: "text",
+			verbose
+		});
 		return new MapReduceDocumentsChain({
-			llmChain: new LLMChain({
-				prompt: combineMapPrompt,
-				llm,
-				verbose
-			}),
-			combineDocumentChain: new StuffDocumentsChain({
-				llmChain: new LLMChain({
-					prompt: combinePrompt,
-					llm: combineLLM ?? llm,
-					verbose
-				}),
-				documentVariableName: "text",
-				verbose
-			}),
+			llmChain,
+			combineDocumentChain,
 			documentVariableName: "text",
 			returnIntermediateSteps,
 			verbose
@@ -41,17 +45,19 @@ const loadSummarizationChain = (llm, params = { type: "map_reduce" }) => {
 	}
 	if (params.type === "refine") {
 		const { refinePrompt = REFINE_PROMPT, refineLLM, questionPrompt = DEFAULT_PROMPT } = params;
+		const llmChain = new LLMChain({
+			prompt: questionPrompt,
+			llm,
+			verbose
+		});
+		const refineLLMChain = new LLMChain({
+			prompt: refinePrompt,
+			llm: refineLLM ?? llm,
+			verbose
+		});
 		return new RefineDocumentsChain({
-			llmChain: new LLMChain({
-				prompt: questionPrompt,
-				llm,
-				verbose
-			}),
-			refineLLMChain: new LLMChain({
-				prompt: refinePrompt,
-				llm: refineLLM ?? llm,
-				verbose
-			}),
+			llmChain,
+			refineLLMChain,
 			documentVariableName: "text",
 			verbose
 		});

package/dist/chains/summarization/load.js.map

@@ -1 +1 @@
-{"version":3,"file":"load.js","names":[],"sources":["../../../src/chains/summarization/load.ts"],"sourcesContent":["import type { BaseLanguageModelInterface } from \"@langchain/core/language_models/base\";\nimport { BasePromptTemplate } from \"@langchain/core/prompts\";\nimport { LLMChain } from \"../llm_chain.js\";\nimport {\n  StuffDocumentsChain,\n  MapReduceDocumentsChain,\n  RefineDocumentsChain,\n  MapReduceDocumentsChainInput,\n} from \"../combine_docs_chain.js\";\nimport { DEFAULT_PROMPT } from \"./stuff_prompts.js\";\nimport { REFINE_PROMPT } from \"./refine_prompts.js\";\n\n/**\n * Type for the base parameters that can be used to configure a\n * summarization chain.\n */\ntype BaseParams = {\n  verbose?: boolean;\n};\n\n/** @interface */\nexport type SummarizationChainParams = BaseParams &\n  (\n    | {\n        type?: \"stuff\";\n        prompt?: BasePromptTemplate;\n      }\n    | ({\n        type?: \"map_reduce\";\n        combineMapPrompt?: BasePromptTemplate;\n        combinePrompt?: BasePromptTemplate;\n        combineLLM?: BaseLanguageModelInterface;\n      } & Pick<MapReduceDocumentsChainInput, \"returnIntermediateSteps\">)\n    | {\n        type?: \"refine\";\n        refinePrompt?: BasePromptTemplate;\n        refineLLM?: BaseLanguageModelInterface;\n        questionPrompt?: BasePromptTemplate;\n      }\n  );\n\nexport const loadSummarizationChain = (\n  llm: BaseLanguageModelInterface,\n  params: SummarizationChainParams = { type: \"map_reduce\" }\n) => {\n  const { verbose } = params;\n  if (params.type === \"stuff\") {\n    const { prompt = DEFAULT_PROMPT } = params;\n    const llmChain = new LLMChain({ prompt, llm, verbose });\n    const chain = new StuffDocumentsChain({\n      llmChain,\n      documentVariableName: \"text\",\n      verbose,\n    });\n    return chain;\n  }\n  if (params.type === \"map_reduce\") {\n    const {\n      combineMapPrompt = DEFAULT_PROMPT,\n      combinePrompt = DEFAULT_PROMPT,\n      combineLLM,\n      returnIntermediateSteps,\n    } = params;\n    const llmChain = new LLMChain({ prompt: combineMapPrompt, llm, verbose });\n    const combineLLMChain = new LLMChain({\n      prompt: combinePrompt,\n      llm: combineLLM ?? llm,\n      verbose,\n    });\n    const combineDocumentChain = new StuffDocumentsChain({\n      llmChain: combineLLMChain,\n      documentVariableName: \"text\",\n      verbose,\n    });\n    const chain = new MapReduceDocumentsChain({\n      llmChain,\n      combineDocumentChain,\n      documentVariableName: \"text\",\n      returnIntermediateSteps,\n      verbose,\n    });\n    return chain;\n  }\n  if (params.type === \"refine\") {\n    const {\n      refinePrompt = REFINE_PROMPT,\n      refineLLM,\n      questionPrompt = DEFAULT_PROMPT,\n    } = params;\n    const llmChain = new LLMChain({ prompt: questionPrompt, llm, verbose });\n    const refineLLMChain = new LLMChain({\n      prompt: refinePrompt,\n      llm: refineLLM ?? llm,\n      verbose,\n    });\n    const chain = new RefineDocumentsChain({\n      llmChain,\n      refineLLMChain,\n      documentVariableName: \"text\",\n      verbose,\n    });\n    return chain;\n  }\n  throw new Error(`Invalid _type: ${params.type}`);\n};\n"],"mappings":";;;;;AAyCA,MAAa,0BACX,KACA,SAAmC,EAAE,MAAM,aAAa,MACrD;CACH,MAAM,EAAE,YAAY;CACpB,IAAI,OAAO,SAAS,SAAS;EAC3B,MAAM,EAAE,SAAS,mBAAmB;EAOpC,OAAO,IALW,oBAAoB;GACpC,UAAA,IAFmB,SAAS;IAAE;IAAQ;IAAK;GAAQ,CAE5C;GACP,sBAAsB;GACtB;EACF,CACW;CACb;CACA,IAAI,OAAO,SAAS,cAAc;EAChC,MAAM,EACJ,mBAAmB,gBACnB,gBAAgB,gBAChB,YACA,4BACE;EAmBJ,OAAO,IAPW,wBAAwB;GACxC,UAAA,IAZmB,SAAS;IAAE,QAAQ;IAAkB;IAAK;GAAQ,CAY9D;GACP,sBAAA,IAP+B,oBAAoB;IACnD,UAAU,IANgB,SAAS;KACnC,QAAQ;KACR,KAAK,cAAc;KACnB;IACF,CAE0B;IACxB,sBAAsB;IACtB;GACF,CAGqB;GACnB,sBAAsB;GACtB;GACA;EACF,CACW;CACb;CACA,IAAI,OAAO,SAAS,UAAU;EAC5B,MAAM,EACJ,eAAe,eACf,WACA,iBAAiB,mBACf;EAaJ,OAAO,IANW,qBAAqB;GACrC,UAAA,IAPmB,SAAS;IAAE,QAAQ;IAAgB;IAAK;GAAQ,CAO5D;GACP,gBAAA,IAPyB,SAAS;IAClC,QAAQ;IACR,KAAK,aAAa;IAClB;GACF,CAGe;GACb,sBAAsB;GACtB;EACF,CACW;CACb;CACA,MAAM,IAAI,MAAM,kBAAkB,OAAO,MAAM;AACjD"}
+{"version":3,"file":"load.js","names":[],"sources":["../../../src/chains/summarization/load.ts"],"sourcesContent":["import type { BaseLanguageModelInterface } from \"@langchain/core/language_models/base\";\nimport { BasePromptTemplate } from \"@langchain/core/prompts\";\nimport { LLMChain } from \"../llm_chain.js\";\nimport {\n  StuffDocumentsChain,\n  MapReduceDocumentsChain,\n  RefineDocumentsChain,\n  MapReduceDocumentsChainInput,\n} from \"../combine_docs_chain.js\";\nimport { DEFAULT_PROMPT } from \"./stuff_prompts.js\";\nimport { REFINE_PROMPT } from \"./refine_prompts.js\";\n\n/**\n * Type for the base parameters that can be used to configure a\n * summarization chain.\n */\ntype BaseParams = {\n  verbose?: boolean;\n};\n\n/** @interface */\nexport type SummarizationChainParams = BaseParams &\n  (\n    | {\n        type?: \"stuff\";\n        prompt?: BasePromptTemplate;\n      }\n    | ({\n        type?: \"map_reduce\";\n        combineMapPrompt?: BasePromptTemplate;\n        combinePrompt?: BasePromptTemplate;\n        combineLLM?: BaseLanguageModelInterface;\n      } & Pick<MapReduceDocumentsChainInput, \"returnIntermediateSteps\">)\n    | {\n        type?: \"refine\";\n        refinePrompt?: BasePromptTemplate;\n        refineLLM?: BaseLanguageModelInterface;\n        questionPrompt?: BasePromptTemplate;\n      }\n  );\n\nexport const loadSummarizationChain = (\n  llm: BaseLanguageModelInterface,\n  params: SummarizationChainParams = { type: \"map_reduce\" }\n) => {\n  const { verbose } = params;\n  if (params.type === \"stuff\") {\n    const { prompt = DEFAULT_PROMPT } = params;\n    const llmChain = new LLMChain({ prompt, llm, verbose });\n    const chain = new StuffDocumentsChain({\n      llmChain,\n      documentVariableName: \"text\",\n      verbose,\n    });\n    return chain;\n  }\n  if (params.type === \"map_reduce\") {\n    const {\n      combineMapPrompt = DEFAULT_PROMPT,\n      combinePrompt = DEFAULT_PROMPT,\n      combineLLM,\n      returnIntermediateSteps,\n    } = params;\n    const llmChain = new LLMChain({ prompt: combineMapPrompt, llm, verbose });\n    const combineLLMChain = new LLMChain({\n      prompt: combinePrompt,\n      llm: combineLLM ?? llm,\n      verbose,\n    });\n    const combineDocumentChain = new StuffDocumentsChain({\n      llmChain: combineLLMChain,\n      documentVariableName: \"text\",\n      verbose,\n    });\n    const chain = new MapReduceDocumentsChain({\n      llmChain,\n      combineDocumentChain,\n      documentVariableName: \"text\",\n      returnIntermediateSteps,\n      verbose,\n    });\n    return chain;\n  }\n  if (params.type === \"refine\") {\n    const {\n      refinePrompt = REFINE_PROMPT,\n      refineLLM,\n      questionPrompt = DEFAULT_PROMPT,\n    } = params;\n    const llmChain = new LLMChain({ prompt: questionPrompt, llm, verbose });\n    const refineLLMChain = new LLMChain({\n      prompt: refinePrompt,\n      llm: refineLLM ?? llm,\n      verbose,\n    });\n    const chain = new RefineDocumentsChain({\n      llmChain,\n      refineLLMChain,\n      documentVariableName: \"text\",\n      verbose,\n    });\n    return chain;\n  }\n  throw new Error(`Invalid _type: ${params.type}`);\n};\n"],"mappings":";;;;;AAyCA,MAAa,0BACX,KACA,SAAmC,EAAE,MAAM,aAAa,MACrD;CACH,MAAM,EAAE,YAAY;CACpB,IAAI,OAAO,SAAS,SAAS;EAC3B,MAAM,EAAE,SAAS,mBAAmB;EACpC,MAAM,WAAW,IAAI,SAAS;GAAE;GAAQ;GAAK;EAAQ,CAAC;EAMtD,OAAO,IALW,oBAAoB;GACpC;GACA,sBAAsB;GACtB;EACF,CACW;CACb;CACA,IAAI,OAAO,SAAS,cAAc;EAChC,MAAM,EACJ,mBAAmB,gBACnB,gBAAgB,gBAChB,YACA,4BACE;EACJ,MAAM,WAAW,IAAI,SAAS;GAAE,QAAQ;GAAkB;GAAK;EAAQ,CAAC;EACxE,MAAM,kBAAkB,IAAI,SAAS;GACnC,QAAQ;GACR,KAAK,cAAc;GACnB;EACF,CAAC;EACD,MAAM,uBAAuB,IAAI,oBAAoB;GACnD,UAAU;GACV,sBAAsB;GACtB;EACF,CAAC;EAQD,OAAO,IAPW,wBAAwB;GACxC;GACA;GACA,sBAAsB;GACtB;GACA;EACF,CACW;CACb;CACA,IAAI,OAAO,SAAS,UAAU;EAC5B,MAAM,EACJ,eAAe,eACf,WACA,iBAAiB,mBACf;EACJ,MAAM,WAAW,IAAI,SAAS;GAAE,QAAQ;GAAgB;GAAK;EAAQ,CAAC;EACtE,MAAM,iBAAiB,IAAI,SAAS;GAClC,QAAQ;GACR,KAAK,aAAa;GAClB;EACF,CAAC;EAOD,OAAO,IANW,qBAAqB;GACrC;GACA;GACA,sBAAsB;GACtB;EACF,CACW;CACb;CACA,MAAM,IAAI,MAAM,kBAAkB,OAAO,MAAM;AACjD"}