langchain 0.0.212 → 0.0.213

package/dist/agents/xml/index.cjs

@@ -1,11 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.XMLAgent = void 0;
+exports.createXmlAgent = exports.XMLAgent = void 0;
+const runnables_1 = require("@langchain/core/runnables");
 const llm_chain_js_1 = require("../../chains/llm_chain.cjs");
 const chat_js_1 = require("../../prompts/chat.cjs");
 const agent_js_1 = require("../agent.cjs");
 const prompt_js_1 = require("./prompt.cjs");
 const output_parser_js_1 = require("./output_parser.cjs");
+const render_js_1 = require("../../tools/render.cjs");
+const xml_js_1 = require("../format_scratchpad/xml.cjs");
 /**
  * Class that represents an agent that uses XML tags.
  */
@@ -101,3 +104,74 @@ class XMLAgent extends agent_js_1.BaseSingleActionAgent {
     }
 }
 exports.XMLAgent = XMLAgent;
+/**
+ * Create an agent that uses XML to format its logic.
+ * @param params Params required to create the agent. Includes an LLM, tools, and prompt.
+ * @returns A runnable sequence representing an agent. It takes as input all the same input
+ *     variables as the prompt passed in does. It returns as output either an
+ *     AgentAction or AgentFinish.
+ *
+ * @example
+ * ```typescript
+ * import { AgentExecutor, createXmlAgent } from "langchain/agents";
+ * import { pull } from "langchain/hub";
+ * import type { PromptTemplate } from "@langchain/core/prompts";
+ *
+ * import { ChatAnthropic } from "@langchain/anthropic";
+ *
+ * // Define the tools the agent will have access to.
+ * const tools = [...];
+ *
+ * // Get the prompt to use - you can modify this!
+ * const prompt = await pull<PromptTemplate>("hwchase17/xml-agent-convo");
+ *
+ * const llm = new ChatAnthropic({
+ *   temperature: 0,
+ * });
+ *
+ * const agent = await createXmlAgent({
+ *   llm,
+ *   tools,
+ *   prompt,
+ * });
+ *
+ * const agentExecutor = new AgentExecutor({
+ *   agent,
+ *   tools,
+ * });
+ *
+ * const result = await agentExecutor.invoke({
+ *   input: "what is LangChain?",
+ * });
+ *
+ * // With chat history
+ * const result2 = await agentExecutor.invoke({
+ *   input: "what's my name?",
+ *   // Notice that chat_history is a string, since this prompt is aimed at LLMs, not chat models
+ *   chat_history: "Human: Hi! My name is Cob\nAI: Hello Cob! Nice to meet you",
+ * });
+ * ```
+ */
+async function createXmlAgent({ llm, tools, prompt, }) {
+    const missingVariables = ["tools", "agent_scratchpad"].filter((v) => !prompt.inputVariables.includes(v));
+    if (missingVariables.length > 0) {
+        throw new Error(`Provided prompt is missing required input variables: ${JSON.stringify(missingVariables)}`);
+    }
+    const partialedPrompt = await prompt.partial({
+        tools: (0, render_js_1.renderTextDescription)(tools),
+    });
+    // TODO: Add .bind to core runnable interface.
+    const llmWithStop = llm.bind({
+        stop: ["</tool_input>", "</final_answer>"],
+    });
+    const agent = runnables_1.RunnableSequence.from([
+        runnables_1.RunnablePassthrough.assign({
+            agent_scratchpad: (input) => (0, xml_js_1.formatXml)(input.steps),
+        }),
+        partialedPrompt,
+        llmWithStop,
+        new output_parser_js_1.XMLAgentOutputParser(),
+    ]);
+    return agent;
+}
+exports.createXmlAgent = createXmlAgent;

package/dist/agents/xml/index.d.ts

@@ -1,5 +1,7 @@
 import type { BaseLanguageModelInterface } from "@langchain/core/language_models/base";
 import type { ToolInterface } from "@langchain/core/tools";
+import { RunnableSequence } from "@langchain/core/runnables";
+import type { BasePromptTemplate } from "@langchain/core/prompts";
 import { LLMChain } from "../../chains/llm_chain.js";
 import { AgentStep, AgentAction, AgentFinish, ChainValues } from "../../schema/index.js";
 import { ChatPromptTemplate } from "../../prompts/chat.js";
@@ -44,3 +46,66 @@ export declare class XMLAgent extends BaseSingleActionAgent implements XMLAgentI
      */
     static fromLLMAndTools(llm: BaseLanguageModelInterface, tools: ToolInterface[], args?: XMLAgentInput & Pick<AgentArgs, "callbacks">): XMLAgent;
 }
+/**
+ * Params used by the createXmlAgent function.
+ */
+export type CreateXmlAgentParams = {
+    /** LLM to use for the agent. */
+    llm: BaseLanguageModelInterface;
+    /** Tools this agent has access to. */
+    tools: ToolInterface[];
+    /**
+     * The prompt to use. Must have input keys for
+     * `tools` and `agent_scratchpad`.
+     */
+    prompt: BasePromptTemplate;
+};
+/**
+ * Create an agent that uses XML to format its logic.
+ * @param params Params required to create the agent. Includes an LLM, tools, and prompt.
+ * @returns A runnable sequence representing an agent. It takes as input all the same input
+ *     variables as the prompt passed in does. It returns as output either an
+ *     AgentAction or AgentFinish.
+ *
+ * @example
+ * ```typescript
+ * import { AgentExecutor, createXmlAgent } from "langchain/agents";
+ * import { pull } from "langchain/hub";
+ * import type { PromptTemplate } from "@langchain/core/prompts";
+ *
+ * import { ChatAnthropic } from "@langchain/anthropic";
+ *
+ * // Define the tools the agent will have access to.
+ * const tools = [...];
+ *
+ * // Get the prompt to use - you can modify this!
+ * const prompt = await pull<PromptTemplate>("hwchase17/xml-agent-convo");
+ *
+ * const llm = new ChatAnthropic({
+ *   temperature: 0,
+ * });
+ *
+ * const agent = await createXmlAgent({
+ *   llm,
+ *   tools,
+ *   prompt,
+ * });
+ *
+ * const agentExecutor = new AgentExecutor({
+ *   agent,
+ *   tools,
+ * });
+ *
+ * const result = await agentExecutor.invoke({
+ *   input: "what is LangChain?",
+ * });
+ *
+ * // With chat history
+ * const result2 = await agentExecutor.invoke({
+ *   input: "what's my name?",
+ *   // Notice that chat_history is a string, since this prompt is aimed at LLMs, not chat models
+ *   chat_history: "Human: Hi! My name is Cob\nAI: Hello Cob! Nice to meet you",
+ * });
+ * ```
+ */
+export declare function createXmlAgent({ llm, tools, prompt, }: CreateXmlAgentParams): Promise<RunnableSequence<Record<string, unknown>, AgentAction | AgentFinish>>;

package/dist/agents/xml/index.js

@@ -1,8 +1,11 @@
+import { RunnablePassthrough, RunnableSequence, } from "@langchain/core/runnables";
 import { LLMChain } from "../../chains/llm_chain.js";
 import { AIMessagePromptTemplate, ChatPromptTemplate, HumanMessagePromptTemplate, } from "../../prompts/chat.js";
 import { BaseSingleActionAgent } from "../agent.js";
 import { AGENT_INSTRUCTIONS } from "./prompt.js";
 import { XMLAgentOutputParser } from "./output_parser.js";
+import { renderTextDescription } from "../../tools/render.js";
+import { formatXml } from "../format_scratchpad/xml.js";
 /**
  * Class that represents an agent that uses XML tags.
  */
@@ -97,3 +100,73 @@ export class XMLAgent extends BaseSingleActionAgent {
         });
     }
 }
+/**
+ * Create an agent that uses XML to format its logic.
+ * @param params Params required to create the agent. Includes an LLM, tools, and prompt.
+ * @returns A runnable sequence representing an agent. It takes as input all the same input
+ *     variables as the prompt passed in does. It returns as output either an
+ *     AgentAction or AgentFinish.
+ *
+ * @example
+ * ```typescript
+ * import { AgentExecutor, createXmlAgent } from "langchain/agents";
+ * import { pull } from "langchain/hub";
+ * import type { PromptTemplate } from "@langchain/core/prompts";
+ *
+ * import { ChatAnthropic } from "@langchain/anthropic";
+ *
+ * // Define the tools the agent will have access to.
+ * const tools = [...];
+ *
+ * // Get the prompt to use - you can modify this!
+ * const prompt = await pull<PromptTemplate>("hwchase17/xml-agent-convo");
+ *
+ * const llm = new ChatAnthropic({
+ *   temperature: 0,
+ * });
+ *
+ * const agent = await createXmlAgent({
+ *   llm,
+ *   tools,
+ *   prompt,
+ * });
+ *
+ * const agentExecutor = new AgentExecutor({
+ *   agent,
+ *   tools,
+ * });
+ *
+ * const result = await agentExecutor.invoke({
+ *   input: "what is LangChain?",
+ * });
+ *
+ * // With chat history
+ * const result2 = await agentExecutor.invoke({
+ *   input: "what's my name?",
+ *   // Notice that chat_history is a string, since this prompt is aimed at LLMs, not chat models
+ *   chat_history: "Human: Hi! My name is Cob\nAI: Hello Cob! Nice to meet you",
+ * });
+ * ```
+ */
+export async function createXmlAgent({ llm, tools, prompt, }) {
+    const missingVariables = ["tools", "agent_scratchpad"].filter((v) => !prompt.inputVariables.includes(v));
+    if (missingVariables.length > 0) {
+        throw new Error(`Provided prompt is missing required input variables: ${JSON.stringify(missingVariables)}`);
+    }
+    const partialedPrompt = await prompt.partial({
+        tools: renderTextDescription(tools),
+    });
+    // TODO: Add .bind to core runnable interface.
+    const llmWithStop = llm.bind({
+        stop: ["</tool_input>", "</final_answer>"],
+    });
+    const agent = RunnableSequence.from([
+        RunnablePassthrough.assign({
+            agent_scratchpad: (input) => formatXml(input.steps),
+        }),
+        partialedPrompt,
+        llmWithStop,
+        new XMLAgentOutputParser(),
+    ]);
+    return agent;
+}

package/dist/chains/combine_documents/base.cjs

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatDocuments = exports.DEFAULT_DOCUMENT_PROMPT = exports.INTERMEDIATE_STEPS_KEY = exports.DOCUMENTS_KEY = exports.DEFAULT_DOCUMENT_SEPARATOR = void 0;
+const prompts_1 = require("@langchain/core/prompts");
+exports.DEFAULT_DOCUMENT_SEPARATOR = "\n\n";
+exports.DOCUMENTS_KEY = "context";
+exports.INTERMEDIATE_STEPS_KEY = "intermediate_steps";
+exports.DEFAULT_DOCUMENT_PROMPT = 
+/* #__PURE__ */ prompts_1.PromptTemplate.fromTemplate("{page_content}");
+async function formatDocuments({ documentPrompt, documentSeparator, documents, config, }) {
+    const formattedDocs = await Promise.all(documents.map((document) => documentPrompt
+        .withConfig({ runName: "document_formatter" })
+        .invoke({ page_content: document.pageContent }, config)));
+    return formattedDocs.join(documentSeparator);
+}
+exports.formatDocuments = formatDocuments;

package/dist/chains/combine_documents/base.d.ts

@@ -0,0 +1,13 @@
+import { Document } from "@langchain/core/documents";
+import { BasePromptTemplate, PromptTemplate } from "@langchain/core/prompts";
+import { RunnableConfig } from "@langchain/core/runnables";
+export declare const DEFAULT_DOCUMENT_SEPARATOR = "\n\n";
+export declare const DOCUMENTS_KEY = "context";
+export declare const INTERMEDIATE_STEPS_KEY = "intermediate_steps";
+export declare const DEFAULT_DOCUMENT_PROMPT: PromptTemplate<import("@langchain/core/prompts").ParamsFromFString<"{page_content}">, any>;
+export declare function formatDocuments({ documentPrompt, documentSeparator, documents, config, }: {
+    documentPrompt: BasePromptTemplate;
+    documentSeparator: string;
+    documents: Document[];
+    config?: RunnableConfig;
+}): Promise<string>;

package/dist/chains/combine_documents/base.js

@@ -0,0 +1,12 @@
+import { PromptTemplate } from "@langchain/core/prompts";
+export const DEFAULT_DOCUMENT_SEPARATOR = "\n\n";
+export const DOCUMENTS_KEY = "context";
+export const INTERMEDIATE_STEPS_KEY = "intermediate_steps";
+export const DEFAULT_DOCUMENT_PROMPT = 
+/* #__PURE__ */ PromptTemplate.fromTemplate("{page_content}");
+export async function formatDocuments({ documentPrompt, documentSeparator, documents, config, }) {
+    const formattedDocs = await Promise.all(documents.map((document) => documentPrompt
+        .withConfig({ runName: "document_formatter" })
+        .invoke({ page_content: document.pageContent }, config)));
+    return formattedDocs.join(documentSeparator);
+}

package/dist/chains/combine_documents/index.cjs

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createStuffDocumentsChain = void 0;
+var stuff_js_1 = require("./stuff.cjs");
+Object.defineProperty(exports, "createStuffDocumentsChain", { enumerable: true, get: function () { return stuff_js_1.createStuffDocumentsChain; } });

package/dist/chains/combine_documents/index.d.ts

@@ -0,0 +1 @@
+export { createStuffDocumentsChain } from "./stuff.js";

package/dist/chains/combine_documents/index.js

@@ -0,0 +1 @@
+export { createStuffDocumentsChain } from "./stuff.js";

package/dist/chains/combine_documents/reduce.cjs

@@ -48,6 +48,10 @@ exports.splitListOfDocs = splitListOfDocs;
  */
 async function collapseDocs(docs, combineDocumentFunc) {
     const result = await combineDocumentFunc(docs);
+    return { pageContent: result, metadata: collapseDocsMetadata(docs) };
+}
+exports.collapseDocs = collapseDocs;
+function collapseDocsMetadata(docs) {
     const combinedMetadata = {};
     for (const key in docs[0].metadata) {
         if (key in docs[0].metadata) {
@@ -64,6 +68,5 @@ async function collapseDocs(docs, combineDocumentFunc) {
             }
         }
     }
-    return { pageContent: result, metadata: combinedMetadata };
+    return combinedMetadata;
 }
-exports.collapseDocs = collapseDocs;

package/dist/chains/combine_documents/reduce.js

@@ -44,6 +44,9 @@ lengthFunc, tokenMax) {
  */
 export async function collapseDocs(docs, combineDocumentFunc) {
     const result = await combineDocumentFunc(docs);
+    return { pageContent: result, metadata: collapseDocsMetadata(docs) };
+}
+function collapseDocsMetadata(docs) {
     const combinedMetadata = {};
     for (const key in docs[0].metadata) {
         if (key in docs[0].metadata) {
@@ -60,5 +63,5 @@ export async function collapseDocs(docs, combineDocumentFunc) {
             }
         }
     }
-    return { pageContent: result, metadata: combinedMetadata };
+    return combinedMetadata;
 }

package/dist/chains/combine_documents/stuff.cjs

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createStuffDocumentsChain = void 0;
+const output_parsers_1 = require("@langchain/core/output_parsers");
+const runnables_1 = require("@langchain/core/runnables");
+const base_js_1 = require("./base.cjs");
+/**
+ * Create a chain that passes a list of documents to a model.
+ *
+ * @param llm Language model to use for responding.
+ * @param prompt Prompt template. Must contain input variable "context", which will be
+    used for passing in the formatted documents.
+ * @param outputParser Output parser. Defaults to `StringOutputParser`.
+ * @param documentPrompt Prompt used for formatting each document into a string. Input
+    variables can be "page_content" or any metadata keys that are in all documents.
+    "page_content" will automatically retrieve the `Document.page_content`, and all
+    other inputs variables will be automatically retrieved from the `Document.metadata` dictionary. Default to a prompt that only contains `Document.page_content`.
+ * @param documentSeparator String separator to use between formatted document strings.
+ * @returns An LCEL `Runnable` chain.
+    Expects a dictionary as input with a list of `Document`s being passed under
+    the "context" key.
+    Return type depends on the `output_parser` used.
+ */
+async function createStuffDocumentsChain({ llm, prompt, outputParser = new output_parsers_1.StringOutputParser(), documentPrompt = base_js_1.DEFAULT_DOCUMENT_PROMPT, documentSeparator = base_js_1.DEFAULT_DOCUMENT_SEPARATOR, }) {
+    if (!prompt.inputVariables.includes(base_js_1.DOCUMENTS_KEY)) {
+        throw new Error(`Prompt must include a "${base_js_1.DOCUMENTS_KEY}" variable`);
+    }
+    return runnables_1.RunnableSequence.from([
+        runnables_1.RunnablePassthrough.assign({
+            [base_js_1.DOCUMENTS_KEY]: new runnables_1.RunnablePick(base_js_1.DOCUMENTS_KEY).pipe((documents, metadata) => (0, base_js_1.formatDocuments)({
+                documents,
+                documentPrompt,
+                documentSeparator,
+                config: metadata?.config,
+            })),
+        }),
+        prompt,
+        llm,
+        outputParser,
+    ], "stuff_documents_chain");
+}
+exports.createStuffDocumentsChain = createStuffDocumentsChain;

package/dist/chains/combine_documents/stuff.d.ts

@@ -0,0 +1,28 @@
+import { LanguageModelLike } from "@langchain/core/language_models/base";
+import { BaseOutputParser } from "@langchain/core/output_parsers";
+import { BasePromptTemplate } from "@langchain/core/prompts";
+import { RunnableSequence } from "@langchain/core/runnables";
+/**
+ * Create a chain that passes a list of documents to a model.
+ *
+ * @param llm Language model to use for responding.
+ * @param prompt Prompt template. Must contain input variable "context", which will be
+    used for passing in the formatted documents.
+ * @param outputParser Output parser. Defaults to `StringOutputParser`.
+ * @param documentPrompt Prompt used for formatting each document into a string. Input
+    variables can be "page_content" or any metadata keys that are in all documents.
+    "page_content" will automatically retrieve the `Document.page_content`, and all
+    other inputs variables will be automatically retrieved from the `Document.metadata` dictionary. Default to a prompt that only contains `Document.page_content`.
+ * @param documentSeparator String separator to use between formatted document strings.
+ * @returns An LCEL `Runnable` chain.
+    Expects a dictionary as input with a list of `Document`s being passed under
+    the "context" key.
+    Return type depends on the `output_parser` used.
+ */
+export declare function createStuffDocumentsChain<RunOutput = string>({ llm, prompt, outputParser, documentPrompt, documentSeparator, }: {
+    llm: LanguageModelLike;
+    prompt: BasePromptTemplate;
+    outputParser?: BaseOutputParser<RunOutput>;
+    documentPrompt?: BasePromptTemplate;
+    documentSeparator?: string;
+}): Promise<RunnableSequence<Record<string, unknown>, Exclude<RunOutput, Error>>>;

package/dist/chains/combine_documents/stuff.js

@@ -0,0 +1,38 @@
+import { StringOutputParser, } from "@langchain/core/output_parsers";
+import { RunnablePassthrough, RunnablePick, RunnableSequence, } from "@langchain/core/runnables";
+import { DEFAULT_DOCUMENT_PROMPT, DEFAULT_DOCUMENT_SEPARATOR, DOCUMENTS_KEY, formatDocuments, } from "./base.js";
+/**
+ * Create a chain that passes a list of documents to a model.
+ *
+ * @param llm Language model to use for responding.
+ * @param prompt Prompt template. Must contain input variable "context", which will be
+    used for passing in the formatted documents.
+ * @param outputParser Output parser. Defaults to `StringOutputParser`.
+ * @param documentPrompt Prompt used for formatting each document into a string. Input
+    variables can be "page_content" or any metadata keys that are in all documents.
+    "page_content" will automatically retrieve the `Document.page_content`, and all
+    other inputs variables will be automatically retrieved from the `Document.metadata` dictionary. Default to a prompt that only contains `Document.page_content`.
+ * @param documentSeparator String separator to use between formatted document strings.
+ * @returns An LCEL `Runnable` chain.
+    Expects a dictionary as input with a list of `Document`s being passed under
+    the "context" key.
+    Return type depends on the `output_parser` used.
+ */
+export async function createStuffDocumentsChain({ llm, prompt, outputParser = new StringOutputParser(), documentPrompt = DEFAULT_DOCUMENT_PROMPT, documentSeparator = DEFAULT_DOCUMENT_SEPARATOR, }) {
+    if (!prompt.inputVariables.includes(DOCUMENTS_KEY)) {
+        throw new Error(`Prompt must include a "${DOCUMENTS_KEY}" variable`);
+    }
+    return RunnableSequence.from([
+        RunnablePassthrough.assign({
+            [DOCUMENTS_KEY]: new RunnablePick(DOCUMENTS_KEY).pipe((documents, metadata) => formatDocuments({
+                documents,
+                documentPrompt,
+                documentSeparator,
+                config: metadata?.config,
+            })),
+        }),
+        prompt,
+        llm,
+        outputParser,
+    ], "stuff_documents_chain");
+}

package/dist/chains/conversational_retrieval_chain.cjs

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ConversationalRetrievalQAChain = void 0;
-const prompt_js_1 = require("../prompts/prompt.cjs");
+const prompts_1 = require("@langchain/core/prompts");
 const index_js_1 = require("../schema/index.cjs");
 const base_js_1 = require("./base.cjs");
 const llm_chain_js_1 = require("./llm_chain.cjs");
@@ -218,11 +218,11 @@ class ConversationalRetrievalQAChain extends base_js_1.BaseChain {
         const { questionGeneratorTemplate, qaTemplate, qaChainOptions = {
             type: "stuff",
             prompt: qaTemplate
-                ? prompt_js_1.PromptTemplate.fromTemplate(qaTemplate)
+                ? prompts_1.PromptTemplate.fromTemplate(qaTemplate)
                 : undefined,
         }, questionGeneratorChainOptions, verbose, ...rest } = options;
         const qaChain = (0, load_js_1.loadQAChain)(llm, qaChainOptions);
-        const questionGeneratorChainPrompt = prompt_js_1.PromptTemplate.fromTemplate(questionGeneratorChainOptions?.template ??
+        const questionGeneratorChainPrompt = prompts_1.PromptTemplate.fromTemplate(questionGeneratorChainOptions?.template ??
             questionGeneratorTemplate ??
             question_generator_template);
         const questionGeneratorChain = new llm_chain_js_1.LLMChain({

package/dist/chains/conversational_retrieval_chain.js

@@ -1,4 +1,4 @@
-import { PromptTemplate } from "../prompts/prompt.js";
+import { PromptTemplate } from "@langchain/core/prompts";
 import { HumanMessage, AIMessage, } from "../schema/index.js";
 import { BaseChain } from "./base.js";
 import { LLMChain } from "./llm_chain.js";

package/dist/chains/history_aware_retriever.cjs

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createHistoryAwareRetriever = void 0;
+const runnables_1 = require("@langchain/core/runnables");
+const output_parsers_1 = require("@langchain/core/output_parsers");
+/**
+ * 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
+ * // yarn add langchain @langchain/openai
+ *
+ * import { ChatOpenAI } from "@langchain/openai";
+ * import { pull } from "langchain/hub";
+ * import { createRetrievalChain } from "langchain/chains/retrieval";
+ * import { createStuffDocumentsChain } from "langchain/chains/combine_documents";
+ *
+ * const rephrasePrompt = await pull("langchain-ai/chat-langchain-rephrase");
+ * const llm = new ChatOpenAI({});
+ * const retriever = ...
+ * const historyAwareRetrieverChain = 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 = runnables_1.RunnableBranch.from([
+        [
+            (input) => !input.chat_history || input.chat_history.length === 0,
+            runnables_1.RunnableSequence.from([(input) => input.input, retriever]),
+        ],
+        runnables_1.RunnableSequence.from([
+            rephrasePrompt,
+            llm,
+            new output_parsers_1.StringOutputParser(),
+            retriever,
+        ]),
+    ]).withConfig({
+        runName: "history_aware_retriever",
+    });
+    return retrieveDocuments;
+}
+exports.createHistoryAwareRetriever = createHistoryAwareRetriever;

package/dist/chains/history_aware_retriever.d.ts

@@ -0,0 +1,55 @@
+import type { LanguageModelLike } from "@langchain/core/language_models/base";
+import { type RunnableInterface } from "@langchain/core/runnables";
+import { type BasePromptTemplate } from "@langchain/core/prompts";
+import type { DocumentInterface } from "@langchain/core/documents";
+import type { BaseMessage } from "../schema/index.js";
+/**
+ * Params for the createHistoryAwareRetriever method.
+ */
+export type CreateHistoryAwareRetriever = {
+    /**
+     * 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
+ * // yarn add langchain @langchain/openai
+ *
+ * import { ChatOpenAI } from "@langchain/openai";
+ * import { pull } from "langchain/hub";
+ * import { createRetrievalChain } from "langchain/chains/retrieval";
+ * import { createStuffDocumentsChain } from "langchain/chains/combine_documents";
+ *
+ * const rephrasePrompt = await pull("langchain-ai/chat-langchain-rephrase");
+ * const llm = new ChatOpenAI({});
+ * const retriever = ...
+ * const historyAwareRetrieverChain = await createHistoryAwareRetriever({
+ *   llm,
+ *   retriever,
+ *   rephrasePrompt,
+ * });
+ * const result = await chain.invoke({"input": "...", "chat_history": [] })
+ * ```
+ */
+export declare function createHistoryAwareRetriever({ llm, retriever, rephrasePrompt, }: CreateHistoryAwareRetriever): Promise<RunnableInterface<{
+    input: string;
+    chat_history: string | BaseMessage[];
+}, DocumentInterface[]>>;

package/dist/chains/history_aware_retriever.js

@@ -0,0 +1,51 @@
+import { RunnableSequence, RunnableBranch, } from "@langchain/core/runnables";
+import { StringOutputParser } from "@langchain/core/output_parsers";
+/**
+ * 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
+ * // yarn add langchain @langchain/openai
+ *
+ * import { ChatOpenAI } from "@langchain/openai";
+ * import { pull } from "langchain/hub";
+ * import { createRetrievalChain } from "langchain/chains/retrieval";
+ * import { createStuffDocumentsChain } from "langchain/chains/combine_documents";
+ *
+ * const rephrasePrompt = await pull("langchain-ai/chat-langchain-rephrase");
+ * const llm = new ChatOpenAI({});
+ * const retriever = ...
+ * const historyAwareRetrieverChain = await createHistoryAwareRetriever({
+ *   llm,
+ *   retriever,
+ *   rephrasePrompt,
+ * });
+ * const result = await chain.invoke({"input": "...", "chat_history": [] })
+ * ```
+ */
+export 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;
+}