@langchain/classic 1.0.0-alpha.1

package/dist/chains/graph_qa/cypher.d.ts

@@ -0,0 +1,76 @@
+import { BaseChain, ChainInputs } from "../base.js";
+import { LLMChain } from "../llm_chain.js";
+import { BasePromptTemplate } from "@langchain/core/prompts";
+import { BaseLanguageModelInterface } from "@langchain/core/language_models/base";
+import { CallbackManagerForChainRun } from "@langchain/core/callbacks/manager";
+import { ChainValues } from "@langchain/core/utils/types";
+
+//#region src/chains/graph_qa/cypher.d.ts
+declare const INTERMEDIATE_STEPS_KEY = "intermediateSteps";
+interface GraphCypherQAChainInput extends ChainInputs {
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  graph: any;
+  cypherGenerationChain: LLMChain;
+  qaChain: LLMChain;
+  inputKey?: string;
+  outputKey?: string;
+  topK?: number;
+  returnIntermediateSteps?: boolean;
+  returnDirect?: boolean;
+}
+interface FromLLMInput {
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  graph: any;
+  llm?: BaseLanguageModelInterface;
+  cypherLLM?: BaseLanguageModelInterface;
+  qaLLM?: BaseLanguageModelInterface;
+  qaPrompt?: BasePromptTemplate;
+  cypherPrompt?: BasePromptTemplate;
+  returnIntermediateSteps?: boolean;
+  returnDirect?: boolean;
+}
+/**
+ * Chain for question-answering against a graph by generating Cypher statements.
+ *
+ * @example
+ * ```typescript
+ * const chain = new GraphCypherQAChain({
+ *   llm: new ChatOpenAI({ model: "gpt-4o-mini", temperature: 0 }),
+ *   graph: new Neo4jGraph(),
+ * });
+ * const res = await chain.invoke("Who played in Pulp Fiction?");
+ * ```
+ *
+ * @security
+ * This chain will execute Cypher statements against the provided database.
+ * Make sure that the database connection uses credentials
+ * that are narrowly-scoped to only include necessary permissions.
+ * Failure to do so may result in data corruption or loss, since the calling code
+ * may attempt commands that would result in deletion, mutation of data
+ * if appropriately prompted or reading sensitive data if such data is present in the database.
+ * The best way to guard against such negative outcomes is to (as appropriate) limit the
+ * permissions granted to the credentials used with this tool.
+ *
+ * See https://js.langchain.com/docs/security for more information.
+ */
+declare class GraphCypherQAChain extends BaseChain {
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  private graph;
+  private cypherGenerationChain;
+  private qaChain;
+  private inputKey;
+  private outputKey;
+  private topK;
+  private returnDirect;
+  private returnIntermediateSteps;
+  constructor(props: GraphCypherQAChainInput);
+  _chainType(): "graph_cypher_chain";
+  get inputKeys(): string[];
+  get outputKeys(): string[];
+  static fromLLM(props: FromLLMInput): GraphCypherQAChain;
+  private extractCypher;
+  _call(values: ChainValues, runManager?: CallbackManagerForChainRun): Promise<ChainValues>;
+}
+//#endregion
+export { FromLLMInput, GraphCypherQAChain, GraphCypherQAChainInput, INTERMEDIATE_STEPS_KEY };
+//# sourceMappingURL=cypher.d.ts.map

package/dist/chains/graph_qa/cypher.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cypher.d.ts","names":["BaseLanguageModelInterface","ChainValues","BasePromptTemplate","CallbackManagerForChainRun","LLMChain","BaseChain","ChainInputs","INTERMEDIATE_STEPS_KEY","GraphCypherQAChainInput","FromLLMInput","GraphCypherQAChain","Promise"],"sources":["../../../src/chains/graph_qa/cypher.d.ts"],"sourcesContent":["import type { BaseLanguageModelInterface } from \"@langchain/core/language_models/base\";\nimport { ChainValues } from \"@langchain/core/utils/types\";\nimport { BasePromptTemplate } from \"@langchain/core/prompts\";\nimport { CallbackManagerForChainRun } from \"@langchain/core/callbacks/manager\";\nimport { LLMChain } from \"../llm_chain.js\";\nimport { BaseChain, ChainInputs } from \"../base.js\";\nexport declare const INTERMEDIATE_STEPS_KEY = \"intermediateSteps\";\nexport interface GraphCypherQAChainInput extends ChainInputs {\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    graph: any;\n    cypherGenerationChain: LLMChain;\n    qaChain: LLMChain;\n    inputKey?: string;\n    outputKey?: string;\n    topK?: number;\n    returnIntermediateSteps?: boolean;\n    returnDirect?: boolean;\n}\nexport interface FromLLMInput {\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    graph: any;\n    llm?: BaseLanguageModelInterface;\n    cypherLLM?: BaseLanguageModelInterface;\n    qaLLM?: BaseLanguageModelInterface;\n    qaPrompt?: BasePromptTemplate;\n    cypherPrompt?: BasePromptTemplate;\n    returnIntermediateSteps?: boolean;\n    returnDirect?: boolean;\n}\n/**\n * Chain for question-answering against a graph by generating Cypher statements.\n *\n * @example\n * ```typescript\n * const chain = new GraphCypherQAChain({\n *   llm: new ChatOpenAI({ model: \"gpt-4o-mini\", temperature: 0 }),\n *   graph: new Neo4jGraph(),\n * });\n * const res = await chain.invoke(\"Who played in Pulp Fiction?\");\n * ```\n *\n * @security\n * This chain will execute Cypher statements against the provided database.\n * Make sure that the database connection uses credentials\n * that are narrowly-scoped to only include necessary permissions.\n * Failure to do so may result in data corruption or loss, since the calling code\n * may attempt commands that would result in deletion, mutation of data\n * if appropriately prompted or reading sensitive data if such data is present in the database.\n * The best way to guard against such negative outcomes is to (as appropriate) limit the\n * permissions granted to the credentials used with this tool.\n *\n * See https://js.langchain.com/docs/security for more information.\n */\nexport declare class GraphCypherQAChain extends BaseChain {\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    private graph;\n    private cypherGenerationChain;\n    private qaChain;\n    private inputKey;\n    private outputKey;\n    private topK;\n    private returnDirect;\n    private returnIntermediateSteps;\n    constructor(props: GraphCypherQAChainInput);\n    _chainType(): \"graph_cypher_chain\";\n    get inputKeys(): string[];\n    get outputKeys(): string[];\n    static fromLLM(props: FromLLMInput): GraphCypherQAChain;\n    private extractCypher;\n    _call(values: ChainValues, runManager?: CallbackManagerForChainRun): Promise<ChainValues>;\n}\n"],"mappings":";;;;;;;;cAMqBO,sBAAAA;UACJC,uBAAAA,SAAgCF;EAD5BC;EACJC,KAAAA,EAAAA,GAAAA;EAAuB,qBAAA,EAGbJ,QAHa;EAAA,OAGbA,EACdA,QADcA;EAAQ,QACtBA,CAAAA,EAAAA,MAAAA;EAAQ,SAJ4BE,CAAAA,EAAAA,MAAAA;EAAW,IAAA,CAAA,EAAA,MAAA;EAW3CG,uBAAY,CAAA,EAAA,OAAA;EAAA,YAAA,CAAA,EAAA,OAAA;;AAIbT,UAJCS,YAAAA,CAIDT;EAA0B;EACJ,KACvBE,EAAAA,GAAAA;EAAkB,GACdA,CAAAA,EAJTF,0BAISE;EAAkB,SAAA,CAAA,EAHrBF,0BAGqB;EA4BhBU,KAAAA,CAAAA,EA9BTV,0BA8B2B;EAAA,QAAA,CAAA,EA7BxBE,kBA6BwB;EAAA,YAUhBM,CAAAA,EAtCJN,kBAsCIM;EAAuB,uBAIpBC,CAAAA,EAAAA,OAAAA;EAAY,YAAGC,CAAAA,EAAAA,OAAAA;;;;;;AAdgB;;;;;;;;;;;;;;;;;;;;cAApCA,kBAAAA,SAA2BL,SAAAA;;;;;;;;;;qBAUzBG;;;;wBAIGC,eAAeC;;gBAEvBT,0BAA0BE,6BAA6BQ,QAAQV"}

package/dist/chains/graph_qa/cypher.js

@@ -0,0 +1,126 @@
+import { __export } from "../../_virtual/rolldown_runtime.js";
+import { BaseChain } from "../base.js";
+import { LLMChain } from "../llm_chain.js";
+import { CYPHER_GENERATION_PROMPT, CYPHER_QA_PROMPT } from "./prompts.js";
+import "../../util/entrypoint_deprecation.js";
+
+//#region src/chains/graph_qa/cypher.ts
+var cypher_exports = {};
+__export(cypher_exports, {
+	GraphCypherQAChain: () => GraphCypherQAChain,
+	INTERMEDIATE_STEPS_KEY: () => INTERMEDIATE_STEPS_KEY
+});
+const INTERMEDIATE_STEPS_KEY = "intermediateSteps";
+/**
+* Chain for question-answering against a graph by generating Cypher statements.
+*
+* @example
+* ```typescript
+* const chain = new GraphCypherQAChain({
+*   llm: new ChatOpenAI({ model: "gpt-4o-mini", temperature: 0 }),
+*   graph: new Neo4jGraph(),
+* });
+* const res = await chain.invoke("Who played in Pulp Fiction?");
+* ```
+*
+* @security
+* This chain will execute Cypher statements against the provided database.
+* Make sure that the database connection uses credentials
+* that are narrowly-scoped to only include necessary permissions.
+* Failure to do so may result in data corruption or loss, since the calling code
+* may attempt commands that would result in deletion, mutation of data
+* if appropriately prompted or reading sensitive data if such data is present in the database.
+* The best way to guard against such negative outcomes is to (as appropriate) limit the
+* permissions granted to the credentials used with this tool.
+*
+* See https://js.langchain.com/docs/security for more information.
+*/
+var GraphCypherQAChain = class GraphCypherQAChain extends BaseChain {
+	graph;
+	cypherGenerationChain;
+	qaChain;
+	inputKey = "query";
+	outputKey = "result";
+	topK = 10;
+	returnDirect = false;
+	returnIntermediateSteps = false;
+	constructor(props) {
+		super(props);
+		const { graph, cypherGenerationChain, qaChain, inputKey, outputKey, topK, returnIntermediateSteps, returnDirect } = props;
+		this.graph = graph;
+		this.cypherGenerationChain = cypherGenerationChain;
+		this.qaChain = qaChain;
+		if (inputKey) this.inputKey = inputKey;
+		if (outputKey) this.outputKey = outputKey;
+		if (topK) this.topK = topK;
+		if (returnIntermediateSteps) this.returnIntermediateSteps = returnIntermediateSteps;
+		if (returnDirect) this.returnDirect = returnDirect;
+	}
+	_chainType() {
+		return "graph_cypher_chain";
+	}
+	get inputKeys() {
+		return [this.inputKey];
+	}
+	get outputKeys() {
+		return [this.outputKey];
+	}
+	static fromLLM(props) {
+		const { graph, qaPrompt = CYPHER_QA_PROMPT, cypherPrompt = CYPHER_GENERATION_PROMPT, llm, cypherLLM, qaLLM, returnIntermediateSteps = false, returnDirect = false } = props;
+		if (!cypherLLM && !llm) throw new Error("Either 'llm' or 'cypherLLM' parameters must be provided");
+		if (!qaLLM && !llm) throw new Error("Either 'llm' or 'qaLLM' parameters must be provided");
+		if (cypherLLM && qaLLM && llm) throw new Error("You can specify up to two of 'cypherLLM', 'qaLLM', and 'llm', but not all three simultaneously.");
+		const qaChain = new LLMChain({
+			llm: qaLLM || llm,
+			prompt: qaPrompt
+		});
+		const cypherGenerationChain = new LLMChain({
+			llm: cypherLLM || llm,
+			prompt: cypherPrompt
+		});
+		return new GraphCypherQAChain({
+			cypherGenerationChain,
+			qaChain,
+			graph,
+			returnIntermediateSteps,
+			returnDirect
+		});
+	}
+	extractCypher(text) {
+		const pattern = /```(.*?)```/s;
+		const matches = text.match(pattern);
+		return matches ? matches[1] : text;
+	}
+	async _call(values, runManager) {
+		const callbacks = runManager?.getChild();
+		const question = values[this.inputKey];
+		const intermediateSteps = [];
+		const generatedCypher = await this.cypherGenerationChain.call({
+			question,
+			schema: this.graph.getSchema()
+		}, callbacks);
+		const extractedCypher = this.extractCypher(generatedCypher.text);
+		await runManager?.handleText(`Generated Cypher:\n`);
+		await runManager?.handleText(`${extractedCypher} green\n`);
+		intermediateSteps.push({ query: extractedCypher });
+		let chainResult;
+		const context = await this.graph.query(extractedCypher, { topK: this.topK });
+		if (this.returnDirect) chainResult = { [this.outputKey]: context };
+		else {
+			await runManager?.handleText("Full Context:\n");
+			await runManager?.handleText(`${context} green\n`);
+			intermediateSteps.push({ context });
+			const result = await this.qaChain.call({
+				question,
+				context: JSON.stringify(context)
+			}, callbacks);
+			chainResult = { [this.outputKey]: result[this.qaChain.outputKey] };
+		}
+		if (this.returnIntermediateSteps) chainResult[INTERMEDIATE_STEPS_KEY] = intermediateSteps;
+		return chainResult;
+	}
+};
+
+//#endregion
+export { GraphCypherQAChain, INTERMEDIATE_STEPS_KEY, cypher_exports };
+//# sourceMappingURL=cypher.js.map

package/dist/chains/graph_qa/cypher.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cypher.js","names":["props: GraphCypherQAChainInput","props: FromLLMInput","text: string","values: ChainValues","runManager?: CallbackManagerForChainRun","chainResult: ChainValues"],"sources":["../../../src/chains/graph_qa/cypher.ts"],"sourcesContent":["import type { BaseLanguageModelInterface } from \"@langchain/core/language_models/base\";\nimport { ChainValues } from \"@langchain/core/utils/types\";\nimport { BasePromptTemplate } from \"@langchain/core/prompts\";\nimport { CallbackManagerForChainRun } from \"@langchain/core/callbacks/manager\";\nimport { LLMChain } from \"../llm_chain.js\";\nimport { BaseChain, ChainInputs } from \"../base.js\";\nimport { CYPHER_GENERATION_PROMPT, CYPHER_QA_PROMPT } from \"./prompts.js\";\nimport { logVersion020MigrationWarning } from \"../../util/entrypoint_deprecation.js\";\n\n/* #__PURE__ */ logVersion020MigrationWarning({\n  oldEntrypointName: \"chains/graph_qa/cypher\",\n  newPackageName: \"@langchain/community\",\n});\n\nexport const INTERMEDIATE_STEPS_KEY = \"intermediateSteps\";\n\nexport interface GraphCypherQAChainInput extends ChainInputs {\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  graph: any;\n  cypherGenerationChain: LLMChain;\n  qaChain: LLMChain;\n  inputKey?: string;\n  outputKey?: string;\n  topK?: number;\n  returnIntermediateSteps?: boolean;\n  returnDirect?: boolean;\n}\n\nexport interface FromLLMInput {\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  graph: any;\n  llm?: BaseLanguageModelInterface;\n  cypherLLM?: BaseLanguageModelInterface;\n  qaLLM?: BaseLanguageModelInterface;\n  qaPrompt?: BasePromptTemplate;\n  cypherPrompt?: BasePromptTemplate;\n  returnIntermediateSteps?: boolean;\n  returnDirect?: boolean;\n}\n\n/**\n * Chain for question-answering against a graph by generating Cypher statements.\n *\n * @example\n * ```typescript\n * const chain = new GraphCypherQAChain({\n *   llm: new ChatOpenAI({ model: \"gpt-4o-mini\", temperature: 0 }),\n *   graph: new Neo4jGraph(),\n * });\n * const res = await chain.invoke(\"Who played in Pulp Fiction?\");\n * ```\n *\n * @security\n * This chain will execute Cypher statements against the provided database.\n * Make sure that the database connection uses credentials\n * that are narrowly-scoped to only include necessary permissions.\n * Failure to do so may result in data corruption or loss, since the calling code\n * may attempt commands that would result in deletion, mutation of data\n * if appropriately prompted or reading sensitive data if such data is present in the database.\n * The best way to guard against such negative outcomes is to (as appropriate) limit the\n * permissions granted to the credentials used with this tool.\n *\n * See https://js.langchain.com/docs/security for more information.\n */\nexport class GraphCypherQAChain extends BaseChain {\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  private graph: any;\n\n  private cypherGenerationChain: LLMChain;\n\n  private qaChain: LLMChain;\n\n  private inputKey = \"query\";\n\n  private outputKey = \"result\";\n\n  private topK = 10;\n\n  private returnDirect = false;\n\n  private returnIntermediateSteps = false;\n\n  constructor(props: GraphCypherQAChainInput) {\n    super(props);\n    const {\n      graph,\n      cypherGenerationChain,\n      qaChain,\n      inputKey,\n      outputKey,\n      topK,\n      returnIntermediateSteps,\n      returnDirect,\n    } = props;\n\n    this.graph = graph;\n    this.cypherGenerationChain = cypherGenerationChain;\n    this.qaChain = qaChain;\n\n    if (inputKey) {\n      this.inputKey = inputKey;\n    }\n    if (outputKey) {\n      this.outputKey = outputKey;\n    }\n    if (topK) {\n      this.topK = topK;\n    }\n    if (returnIntermediateSteps) {\n      this.returnIntermediateSteps = returnIntermediateSteps;\n    }\n    if (returnDirect) {\n      this.returnDirect = returnDirect;\n    }\n  }\n\n  _chainType() {\n    return \"graph_cypher_chain\" as const;\n  }\n\n  get inputKeys(): string[] {\n    return [this.inputKey];\n  }\n\n  get outputKeys(): string[] {\n    return [this.outputKey];\n  }\n\n  static fromLLM(props: FromLLMInput): GraphCypherQAChain {\n    const {\n      graph,\n      qaPrompt = CYPHER_QA_PROMPT,\n      cypherPrompt = CYPHER_GENERATION_PROMPT,\n      llm,\n      cypherLLM,\n      qaLLM,\n      returnIntermediateSteps = false,\n      returnDirect = false,\n    } = props;\n\n    if (!cypherLLM && !llm) {\n      throw new Error(\n        \"Either 'llm' or 'cypherLLM' parameters must be provided\"\n      );\n    }\n\n    if (!qaLLM && !llm) {\n      throw new Error(\"Either 'llm' or 'qaLLM' parameters must be provided\");\n    }\n\n    if (cypherLLM && qaLLM && llm) {\n      throw new Error(\n        \"You can specify up to two of 'cypherLLM', 'qaLLM', and 'llm', but not all three simultaneously.\"\n      );\n    }\n\n    const qaChain = new LLMChain({\n      llm: (qaLLM || llm) as BaseLanguageModelInterface,\n      prompt: qaPrompt,\n    });\n\n    const cypherGenerationChain = new LLMChain({\n      llm: (cypherLLM || llm) as BaseLanguageModelInterface,\n      prompt: cypherPrompt,\n    });\n\n    return new GraphCypherQAChain({\n      cypherGenerationChain,\n      qaChain,\n      graph,\n      returnIntermediateSteps,\n      returnDirect,\n    });\n  }\n\n  private extractCypher(text: string): string {\n    const pattern = /```(.*?)```/s;\n    const matches = text.match(pattern);\n    return matches ? matches[1] : text;\n  }\n\n  async _call(\n    values: ChainValues,\n    runManager?: CallbackManagerForChainRun\n  ): Promise<ChainValues> {\n    const callbacks = runManager?.getChild();\n    const question = values[this.inputKey];\n\n    const intermediateSteps = [];\n\n    const generatedCypher = await this.cypherGenerationChain.call(\n      { question, schema: this.graph.getSchema() },\n      callbacks\n    );\n\n    const extractedCypher = this.extractCypher(generatedCypher.text);\n\n    await runManager?.handleText(`Generated Cypher:\\n`);\n    await runManager?.handleText(`${extractedCypher} green\\n`);\n\n    intermediateSteps.push({ query: extractedCypher });\n\n    let chainResult: ChainValues;\n    const context = await this.graph.query(extractedCypher, {\n      topK: this.topK,\n    });\n\n    if (this.returnDirect) {\n      chainResult = { [this.outputKey]: context };\n    } else {\n      await runManager?.handleText(\"Full Context:\\n\");\n      await runManager?.handleText(`${context} green\\n`);\n\n      intermediateSteps.push({ context });\n\n      const result = await this.qaChain.call(\n        { question, context: JSON.stringify(context) },\n        callbacks\n      );\n\n      chainResult = {\n        [this.outputKey]: result[this.qaChain.outputKey],\n      };\n    }\n\n    if (this.returnIntermediateSteps) {\n      chainResult[INTERMEDIATE_STEPS_KEY] = intermediateSteps;\n    }\n\n    return chainResult;\n  }\n}\n"],"mappings":";;;;;;;;;;;;AAcA,MAAa,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;AAkDtC,IAAa,qBAAb,MAAa,2BAA2B,UAAU;CAEhD,AAAQ;CAER,AAAQ;CAER,AAAQ;CAER,AAAQ,WAAW;CAEnB,AAAQ,YAAY;CAEpB,AAAQ,OAAO;CAEf,AAAQ,eAAe;CAEvB,AAAQ,0BAA0B;CAElC,YAAYA,OAAgC;EAC1C,MAAM,MAAM;EACZ,MAAM,EACJ,OACA,uBACA,SACA,UACA,WACA,MACA,yBACA,cACD,GAAG;EAEJ,KAAK,QAAQ;EACb,KAAK,wBAAwB;EAC7B,KAAK,UAAU;AAEf,MAAI,UACF,KAAK,WAAW;AAElB,MAAI,WACF,KAAK,YAAY;AAEnB,MAAI,MACF,KAAK,OAAO;AAEd,MAAI,yBACF,KAAK,0BAA0B;AAEjC,MAAI,cACF,KAAK,eAAe;CAEvB;CAED,aAAa;AACX,SAAO;CACR;CAED,IAAI,YAAsB;AACxB,SAAO,CAAC,KAAK,QAAS;CACvB;CAED,IAAI,aAAuB;AACzB,SAAO,CAAC,KAAK,SAAU;CACxB;CAED,OAAO,QAAQC,OAAyC;EACtD,MAAM,EACJ,OACA,WAAW,kBACX,eAAe,0BACf,KACA,WACA,OACA,0BAA0B,OAC1B,eAAe,OAChB,GAAG;AAEJ,MAAI,CAAC,aAAa,CAAC,IACjB,OAAM,IAAI,MACR;AAIJ,MAAI,CAAC,SAAS,CAAC,IACb,OAAM,IAAI,MAAM;AAGlB,MAAI,aAAa,SAAS,IACxB,OAAM,IAAI,MACR;EAIJ,MAAM,UAAU,IAAI,SAAS;GAC3B,KAAM,SAAS;GACf,QAAQ;EACT;EAED,MAAM,wBAAwB,IAAI,SAAS;GACzC,KAAM,aAAa;GACnB,QAAQ;EACT;AAED,SAAO,IAAI,mBAAmB;GAC5B;GACA;GACA;GACA;GACA;EACD;CACF;CAED,AAAQ,cAAcC,MAAsB;EAC1C,MAAM,UAAU;EAChB,MAAM,UAAU,KAAK,MAAM,QAAQ;AACnC,SAAO,UAAU,QAAQ,KAAK;CAC/B;CAED,MAAM,MACJC,QACAC,YACsB;EACtB,MAAM,YAAY,YAAY,UAAU;EACxC,MAAM,WAAW,OAAO,KAAK;EAE7B,MAAM,oBAAoB,CAAE;EAE5B,MAAM,kBAAkB,MAAM,KAAK,sBAAsB,KACvD;GAAE;GAAU,QAAQ,KAAK,MAAM,WAAW;EAAE,GAC5C,UACD;EAED,MAAM,kBAAkB,KAAK,cAAc,gBAAgB,KAAK;EAEhE,MAAM,YAAY,WAAW,CAAC,mBAAmB,CAAC,CAAC;EACnD,MAAM,YAAY,WAAW,GAAG,gBAAgB,QAAQ,CAAC,CAAC;EAE1D,kBAAkB,KAAK,EAAE,OAAO,gBAAiB,EAAC;EAElD,IAAIC;EACJ,MAAM,UAAU,MAAM,KAAK,MAAM,MAAM,iBAAiB,EACtD,MAAM,KAAK,KACZ,EAAC;AAEF,MAAI,KAAK,cACP,cAAc,GAAG,KAAK,YAAY,QAAS;OACtC;GACL,MAAM,YAAY,WAAW,kBAAkB;GAC/C,MAAM,YAAY,WAAW,GAAG,QAAQ,QAAQ,CAAC,CAAC;GAElD,kBAAkB,KAAK,EAAE,QAAS,EAAC;GAEnC,MAAM,SAAS,MAAM,KAAK,QAAQ,KAChC;IAAE;IAAU,SAAS,KAAK,UAAU,QAAQ;GAAE,GAC9C,UACD;GAED,cAAc,GACX,KAAK,YAAY,OAAO,KAAK,QAAQ,WACvC;EACF;AAED,MAAI,KAAK,yBACP,YAAY,0BAA0B;AAGxC,SAAO;CACR;AACF"}

package/dist/chains/graph_qa/prompts.cjs

@@ -0,0 +1,46 @@
+const require_rolldown_runtime = require('../../_virtual/rolldown_runtime.cjs');
+const __langchain_core_prompts = require_rolldown_runtime.__toESM(require("@langchain/core/prompts"));
+
+//#region src/chains/graph_qa/prompts.ts
+const CYPHER_GENERATION_TEMPLATE = `Task:Generate Cypher statement to query a graph database.
+Instructions:
+Use only the provided relationship types and properties in the schema.
+Do not use any other relationship types or properties that are not provided.
+Schema:
+{schema}
+Note: Do not include any explanations or apologies in your responses.
+Do not respond to any questions that might ask anything else than for you to construct a Cypher statement.
+Do not include any text except the generated Cypher statement.
+
+The question is:
+{question}`;
+const CYPHER_GENERATION_PROMPT = /* @__PURE__ */ new __langchain_core_prompts.PromptTemplate({
+	template: CYPHER_GENERATION_TEMPLATE,
+	inputVariables: ["schema", "question"]
+});
+const CYPHER_QA_TEMPLATE = `You are an assistant that helps to form nice and human understandable answers.
+The information part contains the provided information that you must use to construct an answer.
+The provided information is authoritative, you must never doubt it or try to use your internal knowledge to correct it.
+Make the answer sound as a response to the question. Do not mention that you based the result on the given information.
+Here is an example:
+
+Question: Which managers own Neo4j stocks?
+Context:[manager:CTL LLC, manager:JANE STREET GROUP LLC]
+Helpful Answer: CTL LLC, JANE STREET GROUP LLC owns Neo4j stocks.
+
+Follow this example when generating answers.
+If the provided information is empty, say that you don't know the answer.
+Information:
+{context}
+
+Question: {question}
+Helpful Answer:`;
+const CYPHER_QA_PROMPT = /* @__PURE__ */ new __langchain_core_prompts.PromptTemplate({
+	template: CYPHER_QA_TEMPLATE,
+	inputVariables: ["context", "question"]
+});
+
+//#endregion
+exports.CYPHER_GENERATION_PROMPT = CYPHER_GENERATION_PROMPT;
+exports.CYPHER_QA_PROMPT = CYPHER_QA_PROMPT;
+//# sourceMappingURL=prompts.cjs.map

package/dist/chains/graph_qa/prompts.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"prompts.cjs","names":["PromptTemplate"],"sources":["../../../src/chains/graph_qa/prompts.ts"],"sourcesContent":["import { PromptTemplate } from \"@langchain/core/prompts\";\n\nconst CYPHER_GENERATION_TEMPLATE = `Task:Generate Cypher statement to query a graph database.\nInstructions:\nUse only the provided relationship types and properties in the schema.\nDo not use any other relationship types or properties that are not provided.\nSchema:\n{schema}\nNote: Do not include any explanations or apologies in your responses.\nDo not respond to any questions that might ask anything else than for you to construct a Cypher statement.\nDo not include any text except the generated Cypher statement.\n\nThe question is:\n{question}`;\nexport const CYPHER_GENERATION_PROMPT = /* #__PURE__ */ new PromptTemplate({\n  template: CYPHER_GENERATION_TEMPLATE,\n  inputVariables: [\"schema\", \"question\"],\n});\n\nconst CYPHER_QA_TEMPLATE = `You are an assistant that helps to form nice and human understandable answers.\nThe information part contains the provided information that you must use to construct an answer.\nThe provided information is authoritative, you must never doubt it or try to use your internal knowledge to correct it.\nMake the answer sound as a response to the question. Do not mention that you based the result on the given information.\nHere is an example:\n\nQuestion: Which managers own Neo4j stocks?\nContext:[manager:CTL LLC, manager:JANE STREET GROUP LLC]\nHelpful Answer: CTL LLC, JANE STREET GROUP LLC owns Neo4j stocks.\n\nFollow this example when generating answers.\nIf the provided information is empty, say that you don't know the answer.\nInformation:\n{context}\n\nQuestion: {question}\nHelpful Answer:`;\nexport const CYPHER_QA_PROMPT = /* #__PURE__ */ new PromptTemplate({\n  template: CYPHER_QA_TEMPLATE,\n  inputVariables: [\"context\", \"question\"],\n});\n"],"mappings":";;;;AAEA,MAAM,6BAA6B,CAAC;;;;;;;;;;;UAW1B,CAAC;AACX,MAAa,2CAA2C,IAAIA,wCAAe;CACzE,UAAU;CACV,gBAAgB,CAAC,UAAU,UAAW;AACvC;AAED,MAAM,qBAAqB,CAAC;;;;;;;;;;;;;;;;eAgBb,CAAC;AAChB,MAAa,mCAAmC,IAAIA,wCAAe;CACjE,UAAU;CACV,gBAAgB,CAAC,WAAW,UAAW;AACxC"}

package/dist/chains/graph_qa/prompts.js

@@ -0,0 +1,44 @@
+import { PromptTemplate } from "@langchain/core/prompts";
+
+//#region src/chains/graph_qa/prompts.ts
+const CYPHER_GENERATION_TEMPLATE = `Task:Generate Cypher statement to query a graph database.
+Instructions:
+Use only the provided relationship types and properties in the schema.
+Do not use any other relationship types or properties that are not provided.
+Schema:
+{schema}
+Note: Do not include any explanations or apologies in your responses.
+Do not respond to any questions that might ask anything else than for you to construct a Cypher statement.
+Do not include any text except the generated Cypher statement.
+
+The question is:
+{question}`;
+const CYPHER_GENERATION_PROMPT = /* @__PURE__ */ new PromptTemplate({
+	template: CYPHER_GENERATION_TEMPLATE,
+	inputVariables: ["schema", "question"]
+});
+const CYPHER_QA_TEMPLATE = `You are an assistant that helps to form nice and human understandable answers.
+The information part contains the provided information that you must use to construct an answer.
+The provided information is authoritative, you must never doubt it or try to use your internal knowledge to correct it.
+Make the answer sound as a response to the question. Do not mention that you based the result on the given information.
+Here is an example:
+
+Question: Which managers own Neo4j stocks?
+Context:[manager:CTL LLC, manager:JANE STREET GROUP LLC]
+Helpful Answer: CTL LLC, JANE STREET GROUP LLC owns Neo4j stocks.
+
+Follow this example when generating answers.
+If the provided information is empty, say that you don't know the answer.
+Information:
+{context}
+
+Question: {question}
+Helpful Answer:`;
+const CYPHER_QA_PROMPT = /* @__PURE__ */ new PromptTemplate({
+	template: CYPHER_QA_TEMPLATE,
+	inputVariables: ["context", "question"]
+});
+
+//#endregion
+export { CYPHER_GENERATION_PROMPT, CYPHER_QA_PROMPT };
+//# sourceMappingURL=prompts.js.map

package/dist/chains/graph_qa/prompts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"prompts.js","names":[],"sources":["../../../src/chains/graph_qa/prompts.ts"],"sourcesContent":["import { PromptTemplate } from \"@langchain/core/prompts\";\n\nconst CYPHER_GENERATION_TEMPLATE = `Task:Generate Cypher statement to query a graph database.\nInstructions:\nUse only the provided relationship types and properties in the schema.\nDo not use any other relationship types or properties that are not provided.\nSchema:\n{schema}\nNote: Do not include any explanations or apologies in your responses.\nDo not respond to any questions that might ask anything else than for you to construct a Cypher statement.\nDo not include any text except the generated Cypher statement.\n\nThe question is:\n{question}`;\nexport const CYPHER_GENERATION_PROMPT = /* #__PURE__ */ new PromptTemplate({\n  template: CYPHER_GENERATION_TEMPLATE,\n  inputVariables: [\"schema\", \"question\"],\n});\n\nconst CYPHER_QA_TEMPLATE = `You are an assistant that helps to form nice and human understandable answers.\nThe information part contains the provided information that you must use to construct an answer.\nThe provided information is authoritative, you must never doubt it or try to use your internal knowledge to correct it.\nMake the answer sound as a response to the question. Do not mention that you based the result on the given information.\nHere is an example:\n\nQuestion: Which managers own Neo4j stocks?\nContext:[manager:CTL LLC, manager:JANE STREET GROUP LLC]\nHelpful Answer: CTL LLC, JANE STREET GROUP LLC owns Neo4j stocks.\n\nFollow this example when generating answers.\nIf the provided information is empty, say that you don't know the answer.\nInformation:\n{context}\n\nQuestion: {question}\nHelpful Answer:`;\nexport const CYPHER_QA_PROMPT = /* #__PURE__ */ new PromptTemplate({\n  template: CYPHER_QA_TEMPLATE,\n  inputVariables: [\"context\", \"question\"],\n});\n"],"mappings":";;;AAEA,MAAM,6BAA6B,CAAC;;;;;;;;;;;UAW1B,CAAC;AACX,MAAa,2CAA2C,IAAI,eAAe;CACzE,UAAU;CACV,gBAAgB,CAAC,UAAU,UAAW;AACvC;AAED,MAAM,qBAAqB,CAAC;;;;;;;;;;;;;;;;eAgBb,CAAC;AAChB,MAAa,mCAAmC,IAAI,eAAe;CACjE,UAAU;CACV,gBAAgB,CAAC,WAAW,UAAW;AACxC"}

package/dist/chains/history_aware_retriever.cjs

@@ -0,0 +1,55 @@
+const require_rolldown_runtime = require('../_virtual/rolldown_runtime.cjs');
+const __langchain_core_runnables = require_rolldown_runtime.__toESM(require("@langchain/core/runnables"));
+const __langchain_core_output_parsers = require_rolldown_runtime.__toESM(require("@langchain/core/output_parsers"));
+
+//#region src/chains/history_aware_retriever.ts
+var history_aware_retriever_exports = {};
+require_rolldown_runtime.__export(history_aware_retriever_exports, { createHistoryAwareRetriever: () => createHistoryAwareRetriever });
+/**
+* Create a chain that takes conversation history and returns documents.
+* If there is no `chat_history`, then the `input` is just passed directly to the
+* retriever. If there is `chat_history`, then the prompt and LLM will be used
+* to generate a search query. That search query is then passed to the retriever.
+* @param {CreateHistoryAwareRetriever} params
+* @returns An LCEL Runnable. The runnable input must take in `input`, and if there
+* is chat history should take it in the form of `chat_history`.
+* The Runnable output is a list of Documents
+* @example
+* ```typescript
+* // pnpm add langchain @langchain/openai
+*
+* import { ChatOpenAI } from "@langchain/openai";
+* import { pull } from "langchain/hub";
+* import { createHistoryAwareRetriever } from "@langchain/classic/chains/history_aware_retriever";
+*
+* const rephrasePrompt = await pull("langchain-ai/chat-langchain-rephrase");
+* const llm = new ChatOpenAI({ model: "gpt-4o-mini" });
+* const retriever = ...
+* const chain = await createHistoryAwareRetriever({
+*   llm,
+*   retriever,
+*   rephrasePrompt,
+* });
+* const result = await chain.invoke({"input": "...", "chat_history": [] })
+* ```
+*/
+async function createHistoryAwareRetriever({ llm, retriever, rephrasePrompt }) {
+	if (!rephrasePrompt.inputVariables.includes("input")) throw new Error(`Expected "input" to be a prompt variable, but got ${JSON.stringify(rephrasePrompt.inputVariables)}`);
+	const retrieveDocuments = __langchain_core_runnables.RunnableBranch.from([[(input) => !input.chat_history || input.chat_history.length === 0, __langchain_core_runnables.RunnableSequence.from([(input) => input.input, retriever])], __langchain_core_runnables.RunnableSequence.from([
+		rephrasePrompt,
+		llm,
+		new __langchain_core_output_parsers.StringOutputParser(),
+		retriever
+	])]).withConfig({ runName: "history_aware_retriever" });
+	return retrieveDocuments;
+}
+
+//#endregion
+exports.createHistoryAwareRetriever = createHistoryAwareRetriever;
+Object.defineProperty(exports, 'history_aware_retriever_exports', {
+  enumerable: true,
+  get: function () {
+    return history_aware_retriever_exports;
+  }
+});
+//# sourceMappingURL=history_aware_retriever.cjs.map

package/dist/chains/history_aware_retriever.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"history_aware_retriever.cjs","names":["RunnableBranch","RunnableSequence","StringOutputParser"],"sources":["../../src/chains/history_aware_retriever.ts"],"sourcesContent":["import type { LanguageModelLike } from \"@langchain/core/language_models/base\";\nimport {\n  type Runnable,\n  type RunnableInterface,\n  RunnableSequence,\n  RunnableBranch,\n} from \"@langchain/core/runnables\";\nimport { type BasePromptTemplate } from \"@langchain/core/prompts\";\nimport { StringOutputParser } from \"@langchain/core/output_parsers\";\nimport type { DocumentInterface } from \"@langchain/core/documents\";\nimport type { BaseMessage } from \"@langchain/core/messages\";\n\n/**\n * Params for the createHistoryAwareRetriever method.\n */\nexport type CreateHistoryAwareRetrieverParams = {\n  /**\n   * Language model to use for generating a search term given chat history.\n   */\n  llm: LanguageModelLike;\n  /**\n   * RetrieverLike object that takes a string as input and outputs a list of Documents.\n   */\n  retriever: RunnableInterface<string, DocumentInterface[]>;\n  /**\n   * The prompt used to generate the search query for the retriever.\n   */\n  rephrasePrompt: BasePromptTemplate;\n};\n\n/**\n * Create a chain that takes conversation history and returns documents.\n * If there is no `chat_history`, then the `input` is just passed directly to the\n * retriever. If there is `chat_history`, then the prompt and LLM will be used\n * to generate a search query. That search query is then passed to the retriever.\n * @param {CreateHistoryAwareRetriever} params\n * @returns An LCEL Runnable. The runnable input must take in `input`, and if there\n * is chat history should take it in the form of `chat_history`.\n * The Runnable output is a list of Documents\n * @example\n * ```typescript\n * // pnpm add langchain @langchain/openai\n *\n * import { ChatOpenAI } from \"@langchain/openai\";\n * import { pull } from \"langchain/hub\";\n * import { createHistoryAwareRetriever } from \"@langchain/classic/chains/history_aware_retriever\";\n *\n * const rephrasePrompt = await pull(\"langchain-ai/chat-langchain-rephrase\");\n * const llm = new ChatOpenAI({ model: \"gpt-4o-mini\" });\n * const retriever = ...\n * const chain = await createHistoryAwareRetriever({\n *   llm,\n *   retriever,\n *   rephrasePrompt,\n * });\n * const result = await chain.invoke({\"input\": \"...\", \"chat_history\": [] })\n * ```\n */\nexport async function createHistoryAwareRetriever({\n  llm,\n  retriever,\n  rephrasePrompt,\n}: CreateHistoryAwareRetrieverParams): Promise<\n  Runnable<\n    { input: string; chat_history: string | BaseMessage[] },\n    DocumentInterface[]\n  >\n> {\n  if (!rephrasePrompt.inputVariables.includes(\"input\")) {\n    throw new Error(\n      `Expected \"input\" to be a prompt variable, but got ${JSON.stringify(\n        rephrasePrompt.inputVariables\n      )}`\n    );\n  }\n  const retrieveDocuments = RunnableBranch.from([\n    [\n      (input) => !input.chat_history || input.chat_history.length === 0,\n      RunnableSequence.from([(input) => input.input, retriever]),\n    ],\n    RunnableSequence.from([\n      rephrasePrompt,\n      llm,\n      new StringOutputParser(),\n      retriever,\n    ]),\n  ]).withConfig({\n    runName: \"history_aware_retriever\",\n  });\n  return retrieveDocuments;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0DA,eAAsB,4BAA4B,EAChD,KACA,WACA,gBACkC,EAKlC;AACA,KAAI,CAAC,eAAe,eAAe,SAAS,QAAQ,CAClD,OAAM,IAAI,MACR,CAAC,kDAAkD,EAAE,KAAK,UACxD,eAAe,eAChB,EAAE;CAGP,MAAM,oBAAoBA,0CAAe,KAAK,CAC5C,CACE,CAAC,UAAU,CAAC,MAAM,gBAAgB,MAAM,aAAa,WAAW,GAChEC,4CAAiB,KAAK,CAAC,CAAC,UAAU,MAAM,OAAO,SAAU,EAAC,AAC3D,GACDA,4CAAiB,KAAK;EACpB;EACA;EACA,IAAIC;EACJ;CACD,EAAC,AACH,EAAC,CAAC,WAAW,EACZ,SAAS,0BACV,EAAC;AACF,QAAO;AACR"}

package/dist/chains/history_aware_retriever.d.cts

@@ -0,0 +1,64 @@
+import { BaseMessage } from "@langchain/core/messages";
+import { Runnable, RunnableInterface } from "@langchain/core/runnables";
+import { BasePromptTemplate } from "@langchain/core/prompts";
+import { LanguageModelLike } from "@langchain/core/language_models/base";
+import { DocumentInterface } from "@langchain/core/documents";
+
+//#region src/chains/history_aware_retriever.d.ts
+
+/**
+ * Params for the createHistoryAwareRetriever method.
+ */
+type CreateHistoryAwareRetrieverParams = {
+  /**
+   * Language model to use for generating a search term given chat history.
+   */
+  llm: LanguageModelLike;
+  /**
+   * RetrieverLike object that takes a string as input and outputs a list of Documents.
+   */
+  retriever: RunnableInterface<string, DocumentInterface[]>;
+  /**
+   * The prompt used to generate the search query for the retriever.
+   */
+  rephrasePrompt: BasePromptTemplate;
+};
+/**
+ * Create a chain that takes conversation history and returns documents.
+ * If there is no `chat_history`, then the `input` is just passed directly to the
+ * retriever. If there is `chat_history`, then the prompt and LLM will be used
+ * to generate a search query. That search query is then passed to the retriever.
+ * @param {CreateHistoryAwareRetriever} params
+ * @returns An LCEL Runnable. The runnable input must take in `input`, and if there
+ * is chat history should take it in the form of `chat_history`.
+ * The Runnable output is a list of Documents
+ * @example
+ * ```typescript
+ * // pnpm add langchain @langchain/openai
+ *
+ * import { ChatOpenAI } from "@langchain/openai";
+ * import { pull } from "langchain/hub";
+ * import { createHistoryAwareRetriever } from "@langchain/classic/chains/history_aware_retriever";
+ *
+ * const rephrasePrompt = await pull("langchain-ai/chat-langchain-rephrase");
+ * const llm = new ChatOpenAI({ model: "gpt-4o-mini" });
+ * const retriever = ...
+ * const chain = await createHistoryAwareRetriever({
+ *   llm,
+ *   retriever,
+ *   rephrasePrompt,
+ * });
+ * const result = await chain.invoke({"input": "...", "chat_history": [] })
+ * ```
+ */
+declare function createHistoryAwareRetriever({
+  llm,
+  retriever,
+  rephrasePrompt
+}: CreateHistoryAwareRetrieverParams): Promise<Runnable<{
+  input: string;
+  chat_history: string | BaseMessage[];
+}, DocumentInterface[]>>;
+//#endregion
+export { CreateHistoryAwareRetrieverParams, createHistoryAwareRetriever };
+//# sourceMappingURL=history_aware_retriever.d.cts.map

package/dist/chains/history_aware_retriever.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"history_aware_retriever.d.cts","names":["LanguageModelLike","Runnable","RunnableInterface","BasePromptTemplate","DocumentInterface","BaseMessage","CreateHistoryAwareRetrieverParams","createHistoryAwareRetriever","llm","retriever","rephrasePrompt","Promise"],"sources":["../../src/chains/history_aware_retriever.d.ts"],"sourcesContent":["import type { LanguageModelLike } from \"@langchain/core/language_models/base\";\nimport { type Runnable, type RunnableInterface } from \"@langchain/core/runnables\";\nimport { type BasePromptTemplate } from \"@langchain/core/prompts\";\nimport type { DocumentInterface } from \"@langchain/core/documents\";\nimport type { BaseMessage } from \"@langchain/core/messages\";\n/**\n * Params for the createHistoryAwareRetriever method.\n */\nexport type CreateHistoryAwareRetrieverParams = {\n    /**\n     * Language model to use for generating a search term given chat history.\n     */\n    llm: LanguageModelLike;\n    /**\n     * RetrieverLike object that takes a string as input and outputs a list of Documents.\n     */\n    retriever: RunnableInterface<string, DocumentInterface[]>;\n    /**\n     * The prompt used to generate the search query for the retriever.\n     */\n    rephrasePrompt: BasePromptTemplate;\n};\n/**\n * Create a chain that takes conversation history and returns documents.\n * If there is no `chat_history`, then the `input` is just passed directly to the\n * retriever. If there is `chat_history`, then the prompt and LLM will be used\n * to generate a search query. That search query is then passed to the retriever.\n * @param {CreateHistoryAwareRetriever} params\n * @returns An LCEL Runnable. The runnable input must take in `input`, and if there\n * is chat history should take it in the form of `chat_history`.\n * The Runnable output is a list of Documents\n * @example\n * ```typescript\n * // pnpm add langchain @langchain/openai\n *\n * import { ChatOpenAI } from \"@langchain/openai\";\n * import { pull } from \"langchain/hub\";\n * import { createHistoryAwareRetriever } from \"@langchain/classic/chains/history_aware_retriever\";\n *\n * const rephrasePrompt = await pull(\"langchain-ai/chat-langchain-rephrase\");\n * const llm = new ChatOpenAI({ model: \"gpt-4o-mini\" });\n * const retriever = ...\n * const chain = await createHistoryAwareRetriever({\n *   llm,\n *   retriever,\n *   rephrasePrompt,\n * });\n * const result = await chain.invoke({\"input\": \"...\", \"chat_history\": [] })\n * ```\n */\nexport declare function createHistoryAwareRetriever({ llm, retriever, rephrasePrompt }: CreateHistoryAwareRetrieverParams): Promise<Runnable<{\n    input: string;\n    chat_history: string | BaseMessage[];\n}, DocumentInterface[]>>;\n"],"mappings":";;;;;;;;;;AAQA;AAA6C,KAAjCM,iCAAAA,GAAiC;EAAA;;;EAQb,GAIZH,EARXH,iBAQWG;EAAkB;AA8BtC;;EAAmD,SAAGK,EAlCvCN,iBAkCuCM,CAAAA,MAAAA,EAlCbJ,iBAkCaI,EAAAA,CAAAA;EAAG;;;EAAgE,cAE9FH,EAhCPF,kBAgCOE;CAAW;;;AAF6F;;;;;;;;;;;;;;;;;;;;;;;;;;iBAA3GE,2BAAAA;;;;GAAgED,oCAAoCK,QAAQV;;yBAEzGI;GACxBD"}

package/dist/chains/history_aware_retriever.d.ts

@@ -0,0 +1,64 @@
+import { DocumentInterface } from "@langchain/core/documents";
+import { BasePromptTemplate } from "@langchain/core/prompts";
+import { Runnable, RunnableInterface } from "@langchain/core/runnables";
+import { LanguageModelLike } from "@langchain/core/language_models/base";
+import { BaseMessage } from "@langchain/core/messages";
+
+//#region src/chains/history_aware_retriever.d.ts
+
+/**
+ * Params for the createHistoryAwareRetriever method.
+ */
+type CreateHistoryAwareRetrieverParams = {
+  /**
+   * Language model to use for generating a search term given chat history.
+   */
+  llm: LanguageModelLike;
+  /**
+   * RetrieverLike object that takes a string as input and outputs a list of Documents.
+   */
+  retriever: RunnableInterface<string, DocumentInterface[]>;
+  /**
+   * The prompt used to generate the search query for the retriever.
+   */
+  rephrasePrompt: BasePromptTemplate;
+};
+/**
+ * Create a chain that takes conversation history and returns documents.
+ * If there is no `chat_history`, then the `input` is just passed directly to the
+ * retriever. If there is `chat_history`, then the prompt and LLM will be used
+ * to generate a search query. That search query is then passed to the retriever.
+ * @param {CreateHistoryAwareRetriever} params
+ * @returns An LCEL Runnable. The runnable input must take in `input`, and if there
+ * is chat history should take it in the form of `chat_history`.
+ * The Runnable output is a list of Documents
+ * @example
+ * ```typescript
+ * // pnpm add langchain @langchain/openai
+ *
+ * import { ChatOpenAI } from "@langchain/openai";
+ * import { pull } from "langchain/hub";
+ * import { createHistoryAwareRetriever } from "@langchain/classic/chains/history_aware_retriever";
+ *
+ * const rephrasePrompt = await pull("langchain-ai/chat-langchain-rephrase");
+ * const llm = new ChatOpenAI({ model: "gpt-4o-mini" });
+ * const retriever = ...
+ * const chain = await createHistoryAwareRetriever({
+ *   llm,
+ *   retriever,
+ *   rephrasePrompt,
+ * });
+ * const result = await chain.invoke({"input": "...", "chat_history": [] })
+ * ```
+ */
+declare function createHistoryAwareRetriever({
+  llm,
+  retriever,
+  rephrasePrompt
+}: CreateHistoryAwareRetrieverParams): Promise<Runnable<{
+  input: string;
+  chat_history: string | BaseMessage[];
+}, DocumentInterface[]>>;
+//#endregion
+export { CreateHistoryAwareRetrieverParams, createHistoryAwareRetriever };
+//# sourceMappingURL=history_aware_retriever.d.ts.map

package/dist/chains/history_aware_retriever.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"history_aware_retriever.d.ts","names":["LanguageModelLike","Runnable","RunnableInterface","BasePromptTemplate","DocumentInterface","BaseMessage","CreateHistoryAwareRetrieverParams","createHistoryAwareRetriever","llm","retriever","rephrasePrompt","Promise"],"sources":["../../src/chains/history_aware_retriever.d.ts"],"sourcesContent":["import type { LanguageModelLike } from \"@langchain/core/language_models/base\";\nimport { type Runnable, type RunnableInterface } from \"@langchain/core/runnables\";\nimport { type BasePromptTemplate } from \"@langchain/core/prompts\";\nimport type { DocumentInterface } from \"@langchain/core/documents\";\nimport type { BaseMessage } from \"@langchain/core/messages\";\n/**\n * Params for the createHistoryAwareRetriever method.\n */\nexport type CreateHistoryAwareRetrieverParams = {\n    /**\n     * Language model to use for generating a search term given chat history.\n     */\n    llm: LanguageModelLike;\n    /**\n     * RetrieverLike object that takes a string as input and outputs a list of Documents.\n     */\n    retriever: RunnableInterface<string, DocumentInterface[]>;\n    /**\n     * The prompt used to generate the search query for the retriever.\n     */\n    rephrasePrompt: BasePromptTemplate;\n};\n/**\n * Create a chain that takes conversation history and returns documents.\n * If there is no `chat_history`, then the `input` is just passed directly to the\n * retriever. If there is `chat_history`, then the prompt and LLM will be used\n * to generate a search query. That search query is then passed to the retriever.\n * @param {CreateHistoryAwareRetriever} params\n * @returns An LCEL Runnable. The runnable input must take in `input`, and if there\n * is chat history should take it in the form of `chat_history`.\n * The Runnable output is a list of Documents\n * @example\n * ```typescript\n * // pnpm add langchain @langchain/openai\n *\n * import { ChatOpenAI } from \"@langchain/openai\";\n * import { pull } from \"langchain/hub\";\n * import { createHistoryAwareRetriever } from \"@langchain/classic/chains/history_aware_retriever\";\n *\n * const rephrasePrompt = await pull(\"langchain-ai/chat-langchain-rephrase\");\n * const llm = new ChatOpenAI({ model: \"gpt-4o-mini\" });\n * const retriever = ...\n * const chain = await createHistoryAwareRetriever({\n *   llm,\n *   retriever,\n *   rephrasePrompt,\n * });\n * const result = await chain.invoke({\"input\": \"...\", \"chat_history\": [] })\n * ```\n */\nexport declare function createHistoryAwareRetriever({ llm, retriever, rephrasePrompt }: CreateHistoryAwareRetrieverParams): Promise<Runnable<{\n    input: string;\n    chat_history: string | BaseMessage[];\n}, DocumentInterface[]>>;\n"],"mappings":";;;;;;;;;;AAQA;AAA6C,KAAjCM,iCAAAA,GAAiC;EAAA;;;EAQb,GAIZH,EARXH,iBAQWG;EAAkB;AA8BtC;;EAAmD,SAAGK,EAlCvCN,iBAkCuCM,CAAAA,MAAAA,EAlCbJ,iBAkCaI,EAAAA,CAAAA;EAAG;;;EAAgE,cAE9FH,EAhCPF,kBAgCOE;CAAW;;;AAF6F;;;;;;;;;;;;;;;;;;;;;;;;;;iBAA3GE,2BAAAA;;;;GAAgED,oCAAoCK,QAAQV;;yBAEzGI;GACxBD"}

package/dist/chains/history_aware_retriever.js

@@ -0,0 +1,49 @@
+import { __export } from "../_virtual/rolldown_runtime.js";
+import { RunnableBranch, RunnableSequence } from "@langchain/core/runnables";
+import { StringOutputParser } from "@langchain/core/output_parsers";
+
+//#region src/chains/history_aware_retriever.ts
+var history_aware_retriever_exports = {};
+__export(history_aware_retriever_exports, { createHistoryAwareRetriever: () => createHistoryAwareRetriever });
+/**
+* Create a chain that takes conversation history and returns documents.
+* If there is no `chat_history`, then the `input` is just passed directly to the
+* retriever. If there is `chat_history`, then the prompt and LLM will be used
+* to generate a search query. That search query is then passed to the retriever.
+* @param {CreateHistoryAwareRetriever} params
+* @returns An LCEL Runnable. The runnable input must take in `input`, and if there
+* is chat history should take it in the form of `chat_history`.
+* The Runnable output is a list of Documents
+* @example
+* ```typescript
+* // pnpm add langchain @langchain/openai
+*
+* import { ChatOpenAI } from "@langchain/openai";
+* import { pull } from "langchain/hub";
+* import { createHistoryAwareRetriever } from "@langchain/classic/chains/history_aware_retriever";
+*
+* const rephrasePrompt = await pull("langchain-ai/chat-langchain-rephrase");
+* const llm = new ChatOpenAI({ model: "gpt-4o-mini" });
+* const retriever = ...
+* const chain = await createHistoryAwareRetriever({
+*   llm,
+*   retriever,
+*   rephrasePrompt,
+* });
+* const result = await chain.invoke({"input": "...", "chat_history": [] })
+* ```
+*/
+async function createHistoryAwareRetriever({ llm, retriever, rephrasePrompt }) {
+	if (!rephrasePrompt.inputVariables.includes("input")) throw new Error(`Expected "input" to be a prompt variable, but got ${JSON.stringify(rephrasePrompt.inputVariables)}`);
+	const retrieveDocuments = RunnableBranch.from([[(input) => !input.chat_history || input.chat_history.length === 0, RunnableSequence.from([(input) => input.input, retriever])], RunnableSequence.from([
+		rephrasePrompt,
+		llm,
+		new StringOutputParser(),
+		retriever
+	])]).withConfig({ runName: "history_aware_retriever" });
+	return retrieveDocuments;
+}
+
+//#endregion
+export { createHistoryAwareRetriever, history_aware_retriever_exports };
+//# sourceMappingURL=history_aware_retriever.js.map

package/dist/chains/history_aware_retriever.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"history_aware_retriever.js","names":[],"sources":["../../src/chains/history_aware_retriever.ts"],"sourcesContent":["import type { LanguageModelLike } from \"@langchain/core/language_models/base\";\nimport {\n  type Runnable,\n  type RunnableInterface,\n  RunnableSequence,\n  RunnableBranch,\n} from \"@langchain/core/runnables\";\nimport { type BasePromptTemplate } from \"@langchain/core/prompts\";\nimport { StringOutputParser } from \"@langchain/core/output_parsers\";\nimport type { DocumentInterface } from \"@langchain/core/documents\";\nimport type { BaseMessage } from \"@langchain/core/messages\";\n\n/**\n * Params for the createHistoryAwareRetriever method.\n */\nexport type CreateHistoryAwareRetrieverParams = {\n  /**\n   * Language model to use for generating a search term given chat history.\n   */\n  llm: LanguageModelLike;\n  /**\n   * RetrieverLike object that takes a string as input and outputs a list of Documents.\n   */\n  retriever: RunnableInterface<string, DocumentInterface[]>;\n  /**\n   * The prompt used to generate the search query for the retriever.\n   */\n  rephrasePrompt: BasePromptTemplate;\n};\n\n/**\n * Create a chain that takes conversation history and returns documents.\n * If there is no `chat_history`, then the `input` is just passed directly to the\n * retriever. If there is `chat_history`, then the prompt and LLM will be used\n * to generate a search query. That search query is then passed to the retriever.\n * @param {CreateHistoryAwareRetriever} params\n * @returns An LCEL Runnable. The runnable input must take in `input`, and if there\n * is chat history should take it in the form of `chat_history`.\n * The Runnable output is a list of Documents\n * @example\n * ```typescript\n * // pnpm add langchain @langchain/openai\n *\n * import { ChatOpenAI } from \"@langchain/openai\";\n * import { pull } from \"langchain/hub\";\n * import { createHistoryAwareRetriever } from \"@langchain/classic/chains/history_aware_retriever\";\n *\n * const rephrasePrompt = await pull(\"langchain-ai/chat-langchain-rephrase\");\n * const llm = new ChatOpenAI({ model: \"gpt-4o-mini\" });\n * const retriever = ...\n * const chain = await createHistoryAwareRetriever({\n *   llm,\n *   retriever,\n *   rephrasePrompt,\n * });\n * const result = await chain.invoke({\"input\": \"...\", \"chat_history\": [] })\n * ```\n */\nexport async function createHistoryAwareRetriever({\n  llm,\n  retriever,\n  rephrasePrompt,\n}: CreateHistoryAwareRetrieverParams): Promise<\n  Runnable<\n    { input: string; chat_history: string | BaseMessage[] },\n    DocumentInterface[]\n  >\n> {\n  if (!rephrasePrompt.inputVariables.includes(\"input\")) {\n    throw new Error(\n      `Expected \"input\" to be a prompt variable, but got ${JSON.stringify(\n        rephrasePrompt.inputVariables\n      )}`\n    );\n  }\n  const retrieveDocuments = RunnableBranch.from([\n    [\n      (input) => !input.chat_history || input.chat_history.length === 0,\n      RunnableSequence.from([(input) => input.input, retriever]),\n    ],\n    RunnableSequence.from([\n      rephrasePrompt,\n      llm,\n      new StringOutputParser(),\n      retriever,\n    ]),\n  ]).withConfig({\n    runName: \"history_aware_retriever\",\n  });\n  return retrieveDocuments;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0DA,eAAsB,4BAA4B,EAChD,KACA,WACA,gBACkC,EAKlC;AACA,KAAI,CAAC,eAAe,eAAe,SAAS,QAAQ,CAClD,OAAM,IAAI,MACR,CAAC,kDAAkD,EAAE,KAAK,UACxD,eAAe,eAChB,EAAE;CAGP,MAAM,oBAAoB,eAAe,KAAK,CAC5C,CACE,CAAC,UAAU,CAAC,MAAM,gBAAgB,MAAM,aAAa,WAAW,GAChE,iBAAiB,KAAK,CAAC,CAAC,UAAU,MAAM,OAAO,SAAU,EAAC,AAC3D,GACD,iBAAiB,KAAK;EACpB;EACA;EACA,IAAI;EACJ;CACD,EAAC,AACH,EAAC,CAAC,WAAW,EACZ,SAAS,0BACV,EAAC;AACF,QAAO;AACR"}