@langchain/core 0.3.72 → 1.0.0-alpha.2

package/dist/prompts/pipeline.js

@@ -1,140 +1,130 @@
 import { BasePromptTemplate } from "./base.js";
 import { ChatPromptTemplate } from "./chat.js";
+
+//#region src/prompts/pipeline.ts
 /**
- * Class that handles a sequence of prompts, each of which may require
- * different input variables. Includes methods for formatting these
- * prompts, extracting required input values, and handling partial
- * prompts.
- * @example
- * ```typescript
- * const composedPrompt = new PipelinePromptTemplate({
- *   pipelinePrompts: [
- *     {
- *       name: "introduction",
- *       prompt: PromptTemplate.fromTemplate(`You are impersonating {person}.`),
- *     },
- *     {
- *       name: "example",
- *       prompt: PromptTemplate.fromTemplate(
- *         `Here's an example of an interaction:
- * Q: {example_q}
- * A: {example_a}`,
- *       ),
- *     },
- *     {
- *       name: "start",
- *       prompt: PromptTemplate.fromTemplate(
- *         `Now, do this for real!
- * Q: {input}
- * A:`,
- *       ),
- *     },
- *   ],
- *   finalPrompt: PromptTemplate.fromTemplate(
- *     `{introduction}
- * {example}
- * {start}`,
- *   ),
- * });
- *
- * const formattedPrompt = await composedPrompt.format({
- *   person: "Elon Musk",
- *   example_q: `What's your favorite car?`,
- *   example_a: "Tesla",
- *   input: `What's your favorite social media site?`,
- * });
- * ```
- */
-export class PipelinePromptTemplate extends BasePromptTemplate {
-    static lc_name() {
-        return "PipelinePromptTemplate";
-    }
-    constructor(input) {
-        super({ ...input, inputVariables: [] });
-        Object.defineProperty(this, "pipelinePrompts", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "finalPrompt", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        this.pipelinePrompts = input.pipelinePrompts;
-        this.finalPrompt = input.finalPrompt;
-        this.inputVariables = this.computeInputValues();
-    }
-    /**
-     * Computes the input values required by the pipeline prompts.
-     * @returns Array of input values required by the pipeline prompts.
-     */
-    computeInputValues() {
-        const intermediateValues = this.pipelinePrompts.map((pipelinePrompt) => pipelinePrompt.name);
-        const inputValues = this.pipelinePrompts
-            .map((pipelinePrompt) => pipelinePrompt.prompt.inputVariables.filter((inputValue) => !intermediateValues.includes(inputValue)))
-            .flat();
-        return [...new Set(inputValues)];
-    }
-    static extractRequiredInputValues(allValues, requiredValueNames) {
-        return requiredValueNames.reduce((requiredValues, valueName) => {
-            // eslint-disable-next-line no-param-reassign
-            requiredValues[valueName] = allValues[valueName];
-            return requiredValues;
-        }, {});
-    }
-    /**
-     * Formats the pipeline prompts based on the provided input values.
-     * @param values Input values to format the pipeline prompts.
-     * @returns Promise that resolves with the formatted input values.
-     */
-    async formatPipelinePrompts(values) {
-        const allValues = await this.mergePartialAndUserVariables(values);
-        for (const { name: pipelinePromptName, prompt: pipelinePrompt } of this
-            .pipelinePrompts) {
-            const pipelinePromptInputValues = PipelinePromptTemplate.extractRequiredInputValues(allValues, pipelinePrompt.inputVariables);
-            // eslint-disable-next-line no-instanceof/no-instanceof
-            if (pipelinePrompt instanceof ChatPromptTemplate) {
-                allValues[pipelinePromptName] = await pipelinePrompt.formatMessages(pipelinePromptInputValues);
-            }
-            else {
-                allValues[pipelinePromptName] = await pipelinePrompt.format(pipelinePromptInputValues);
-            }
-        }
-        return PipelinePromptTemplate.extractRequiredInputValues(allValues, this.finalPrompt.inputVariables);
-    }
-    /**
-     * Formats the final prompt value based on the provided input values.
-     * @param values Input values to format the final prompt value.
-     * @returns Promise that resolves with the formatted final prompt value.
-     */
-    async formatPromptValue(values) {
-        return this.finalPrompt.formatPromptValue(await this.formatPipelinePrompts(values));
-    }
-    async format(values) {
-        return this.finalPrompt.format(await this.formatPipelinePrompts(values));
-    }
-    /**
-     * Handles partial prompts, which are prompts that have been partially
-     * filled with input values.
-     * @param values Partial input values.
-     * @returns Promise that resolves with a new PipelinePromptTemplate instance with updated input variables.
-     */
-    async partial(values) {
-        const promptDict = { ...this };
-        promptDict.inputVariables = this.inputVariables.filter((iv) => !(iv in values));
-        promptDict.partialVariables = {
-            ...(this.partialVariables ?? {}),
-            ...values,
-        };
-        return new PipelinePromptTemplate(promptDict);
-    }
-    serialize() {
-        throw new Error("Not implemented.");
-    }
-    _getPromptType() {
-        return "pipeline";
-    }
-}
+* Class that handles a sequence of prompts, each of which may require
+* different input variables. Includes methods for formatting these
+* prompts, extracting required input values, and handling partial
+* prompts.
+* @example
+* ```typescript
+* const composedPrompt = new PipelinePromptTemplate({
+*   pipelinePrompts: [
+*     {
+*       name: "introduction",
+*       prompt: PromptTemplate.fromTemplate(`You are impersonating {person}.`),
+*     },
+*     {
+*       name: "example",
+*       prompt: PromptTemplate.fromTemplate(
+*         `Here's an example of an interaction:
+* Q: {example_q}
+* A: {example_a}`,
+*       ),
+*     },
+*     {
+*       name: "start",
+*       prompt: PromptTemplate.fromTemplate(
+*         `Now, do this for real!
+* Q: {input}
+* A:`,
+*       ),
+*     },
+*   ],
+*   finalPrompt: PromptTemplate.fromTemplate(
+*     `{introduction}
+* {example}
+* {start}`,
+*   ),
+* });
+*
+* const formattedPrompt = await composedPrompt.format({
+*   person: "Elon Musk",
+*   example_q: `What's your favorite car?`,
+*   example_a: "Tesla",
+*   input: `What's your favorite social media site?`,
+* });
+* ```
+*/
+var PipelinePromptTemplate = class PipelinePromptTemplate extends BasePromptTemplate {
+	static lc_name() {
+		return "PipelinePromptTemplate";
+	}
+	pipelinePrompts;
+	finalPrompt;
+	constructor(input) {
+		super({
+			...input,
+			inputVariables: []
+		});
+		this.pipelinePrompts = input.pipelinePrompts;
+		this.finalPrompt = input.finalPrompt;
+		this.inputVariables = this.computeInputValues();
+	}
+	/**
+	* Computes the input values required by the pipeline prompts.
+	* @returns Array of input values required by the pipeline prompts.
+	*/
+	computeInputValues() {
+		const intermediateValues = this.pipelinePrompts.map((pipelinePrompt) => pipelinePrompt.name);
+		const inputValues = this.pipelinePrompts.map((pipelinePrompt) => pipelinePrompt.prompt.inputVariables.filter((inputValue) => !intermediateValues.includes(inputValue))).flat();
+		return [...new Set(inputValues)];
+	}
+	static extractRequiredInputValues(allValues, requiredValueNames) {
+		return requiredValueNames.reduce((requiredValues, valueName) => {
+			requiredValues[valueName] = allValues[valueName];
+			return requiredValues;
+		}, {});
+	}
+	/**
+	* Formats the pipeline prompts based on the provided input values.
+	* @param values Input values to format the pipeline prompts.
+	* @returns Promise that resolves with the formatted input values.
+	*/
+	async formatPipelinePrompts(values) {
+		const allValues = await this.mergePartialAndUserVariables(values);
+		for (const { name: pipelinePromptName, prompt: pipelinePrompt } of this.pipelinePrompts) {
+			const pipelinePromptInputValues = PipelinePromptTemplate.extractRequiredInputValues(allValues, pipelinePrompt.inputVariables);
+			if (pipelinePrompt instanceof ChatPromptTemplate) allValues[pipelinePromptName] = await pipelinePrompt.formatMessages(pipelinePromptInputValues);
+			else allValues[pipelinePromptName] = await pipelinePrompt.format(pipelinePromptInputValues);
+		}
+		return PipelinePromptTemplate.extractRequiredInputValues(allValues, this.finalPrompt.inputVariables);
+	}
+	/**
+	* Formats the final prompt value based on the provided input values.
+	* @param values Input values to format the final prompt value.
+	* @returns Promise that resolves with the formatted final prompt value.
+	*/
+	async formatPromptValue(values) {
+		return this.finalPrompt.formatPromptValue(await this.formatPipelinePrompts(values));
+	}
+	async format(values) {
+		return this.finalPrompt.format(await this.formatPipelinePrompts(values));
+	}
+	/**
+	* Handles partial prompts, which are prompts that have been partially
+	* filled with input values.
+	* @param values Partial input values.
+	* @returns Promise that resolves with a new PipelinePromptTemplate instance with updated input variables.
+	*/
+	async partial(values) {
+		const promptDict = { ...this };
+		promptDict.inputVariables = this.inputVariables.filter((iv) => !(iv in values));
+		promptDict.partialVariables = {
+			...this.partialVariables ?? {},
+			...values
+		};
+		return new PipelinePromptTemplate(promptDict);
+	}
+	serialize() {
+		throw new Error("Not implemented.");
+	}
+	_getPromptType() {
+		return "pipeline";
+	}
+};
+
+//#endregion
+export { PipelinePromptTemplate };
+//# sourceMappingURL=pipeline.js.map

package/dist/prompts/pipeline.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pipeline.js","names":["input: PipelinePromptTemplateInput<PromptTemplateType>","allValues: InputValues","requiredValueNames: string[]","values: InputValues","values: PartialValues"],"sources":["../../src/prompts/pipeline.ts"],"sourcesContent":["import type { InputValues, PartialValues } from \"../utils/types/index.js\";\nimport type { SerializedBasePromptTemplate } from \"./serde.js\";\nimport { BasePromptTemplate, type BasePromptTemplateInput } from \"./base.js\";\nimport { ChatPromptTemplate } from \"./chat.js\";\n\n/**\n * Type that includes the name of the prompt and the prompt itself.\n */\nexport type PipelinePromptParams<\n  PromptTemplateType extends BasePromptTemplate\n> = {\n  name: string;\n  prompt: PromptTemplateType;\n};\n\n/**\n * Type that extends the BasePromptTemplateInput type, excluding the\n * inputVariables property. It includes an array of pipelinePrompts and a\n * finalPrompt.\n */\nexport type PipelinePromptTemplateInput<\n  PromptTemplateType extends BasePromptTemplate\n> = Omit<BasePromptTemplateInput, \"inputVariables\"> & {\n  pipelinePrompts: PipelinePromptParams<PromptTemplateType>[];\n  finalPrompt: PromptTemplateType;\n};\n\n/**\n * Class that handles a sequence of prompts, each of which may require\n * different input variables. Includes methods for formatting these\n * prompts, extracting required input values, and handling partial\n * prompts.\n * @example\n * ```typescript\n * const composedPrompt = new PipelinePromptTemplate({\n *   pipelinePrompts: [\n *     {\n *       name: \"introduction\",\n *       prompt: PromptTemplate.fromTemplate(`You are impersonating {person}.`),\n *     },\n *     {\n *       name: \"example\",\n *       prompt: PromptTemplate.fromTemplate(\n *         `Here's an example of an interaction:\n * Q: {example_q}\n * A: {example_a}`,\n *       ),\n *     },\n *     {\n *       name: \"start\",\n *       prompt: PromptTemplate.fromTemplate(\n *         `Now, do this for real!\n * Q: {input}\n * A:`,\n *       ),\n *     },\n *   ],\n *   finalPrompt: PromptTemplate.fromTemplate(\n *     `{introduction}\n * {example}\n * {start}`,\n *   ),\n * });\n *\n * const formattedPrompt = await composedPrompt.format({\n *   person: \"Elon Musk\",\n *   example_q: `What's your favorite car?`,\n *   example_a: \"Tesla\",\n *   input: `What's your favorite social media site?`,\n * });\n * ```\n */\nexport class PipelinePromptTemplate<\n  PromptTemplateType extends BasePromptTemplate\n> extends BasePromptTemplate {\n  static lc_name() {\n    return \"PipelinePromptTemplate\";\n  }\n\n  pipelinePrompts: PipelinePromptParams<PromptTemplateType>[];\n\n  finalPrompt: PromptTemplateType;\n\n  constructor(input: PipelinePromptTemplateInput<PromptTemplateType>) {\n    super({ ...input, inputVariables: [] });\n    this.pipelinePrompts = input.pipelinePrompts;\n    this.finalPrompt = input.finalPrompt;\n    this.inputVariables = this.computeInputValues();\n  }\n\n  /**\n   * Computes the input values required by the pipeline prompts.\n   * @returns Array of input values required by the pipeline prompts.\n   */\n  protected computeInputValues() {\n    const intermediateValues = this.pipelinePrompts.map(\n      (pipelinePrompt) => pipelinePrompt.name\n    );\n    const inputValues = this.pipelinePrompts\n      .map((pipelinePrompt) =>\n        pipelinePrompt.prompt.inputVariables.filter(\n          (inputValue) => !intermediateValues.includes(inputValue)\n        )\n      )\n      .flat();\n    return [...new Set(inputValues)];\n  }\n\n  protected static extractRequiredInputValues(\n    allValues: InputValues,\n    requiredValueNames: string[]\n  ) {\n    return requiredValueNames.reduce((requiredValues, valueName) => {\n      // eslint-disable-next-line no-param-reassign\n      requiredValues[valueName] = allValues[valueName];\n      return requiredValues;\n    }, {} as InputValues);\n  }\n\n  /**\n   * Formats the pipeline prompts based on the provided input values.\n   * @param values Input values to format the pipeline prompts.\n   * @returns Promise that resolves with the formatted input values.\n   */\n  protected async formatPipelinePrompts(\n    values: InputValues\n  ): Promise<InputValues> {\n    const allValues = await this.mergePartialAndUserVariables(values);\n    for (const { name: pipelinePromptName, prompt: pipelinePrompt } of this\n      .pipelinePrompts) {\n      const pipelinePromptInputValues =\n        PipelinePromptTemplate.extractRequiredInputValues(\n          allValues,\n          pipelinePrompt.inputVariables\n        );\n      // eslint-disable-next-line no-instanceof/no-instanceof\n      if (pipelinePrompt instanceof ChatPromptTemplate) {\n        allValues[pipelinePromptName] = await pipelinePrompt.formatMessages(\n          pipelinePromptInputValues\n        );\n      } else {\n        allValues[pipelinePromptName] = await pipelinePrompt.format(\n          pipelinePromptInputValues\n        );\n      }\n    }\n    return PipelinePromptTemplate.extractRequiredInputValues(\n      allValues,\n      this.finalPrompt.inputVariables\n    );\n  }\n\n  /**\n   * Formats the final prompt value based on the provided input values.\n   * @param values Input values to format the final prompt value.\n   * @returns Promise that resolves with the formatted final prompt value.\n   */\n  async formatPromptValue(\n    values: InputValues\n  ): Promise<PromptTemplateType[\"PromptValueReturnType\"]> {\n    return this.finalPrompt.formatPromptValue(\n      await this.formatPipelinePrompts(values)\n    );\n  }\n\n  async format(values: InputValues): Promise<string> {\n    return this.finalPrompt.format(await this.formatPipelinePrompts(values));\n  }\n\n  /**\n   * Handles partial prompts, which are prompts that have been partially\n   * filled with input values.\n   * @param values Partial input values.\n   * @returns Promise that resolves with a new PipelinePromptTemplate instance with updated input variables.\n   */\n  async partial(\n    values: PartialValues\n  ): Promise<PipelinePromptTemplate<PromptTemplateType>> {\n    const promptDict = { ...this };\n    promptDict.inputVariables = this.inputVariables.filter(\n      (iv) => !(iv in values)\n    );\n    promptDict.partialVariables = {\n      ...(this.partialVariables ?? {}),\n      ...values,\n    };\n    return new PipelinePromptTemplate<PromptTemplateType>(promptDict);\n  }\n\n  serialize(): SerializedBasePromptTemplate {\n    throw new Error(\"Not implemented.\");\n  }\n\n  _getPromptType(): string {\n    return \"pipeline\";\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwEA,IAAa,yBAAb,MAAa,+BAEH,mBAAmB;CAC3B,OAAO,UAAU;AACf,SAAO;CACR;CAED;CAEA;CAEA,YAAYA,OAAwD;EAClE,MAAM;GAAE,GAAG;GAAO,gBAAgB,CAAE;EAAE,EAAC;EACvC,KAAK,kBAAkB,MAAM;EAC7B,KAAK,cAAc,MAAM;EACzB,KAAK,iBAAiB,KAAK,oBAAoB;CAChD;;;;;CAMD,AAAU,qBAAqB;EAC7B,MAAM,qBAAqB,KAAK,gBAAgB,IAC9C,CAAC,mBAAmB,eAAe,KACpC;EACD,MAAM,cAAc,KAAK,gBACtB,IAAI,CAAC,mBACJ,eAAe,OAAO,eAAe,OACnC,CAAC,eAAe,CAAC,mBAAmB,SAAS,WAAW,CACzD,CACF,CACA,MAAM;AACT,SAAO,CAAC,GAAG,IAAI,IAAI,YAAa;CACjC;CAED,OAAiB,2BACfC,WACAC,oBACA;AACA,SAAO,mBAAmB,OAAO,CAAC,gBAAgB,cAAc;GAE9D,eAAe,aAAa,UAAU;AACtC,UAAO;EACR,GAAE,CAAE,EAAgB;CACtB;;;;;;CAOD,MAAgB,sBACdC,QACsB;EACtB,MAAM,YAAY,MAAM,KAAK,6BAA6B,OAAO;AACjE,OAAK,MAAM,EAAE,MAAM,oBAAoB,QAAQ,gBAAgB,IAAI,KAChE,iBAAiB;GAClB,MAAM,4BACJ,uBAAuB,2BACrB,WACA,eAAe,eAChB;AAEH,OAAI,0BAA0B,oBAC5B,UAAU,sBAAsB,MAAM,eAAe,eACnD,0BACD;QAED,UAAU,sBAAsB,MAAM,eAAe,OACnD,0BACD;EAEJ;AACD,SAAO,uBAAuB,2BAC5B,WACA,KAAK,YAAY,eAClB;CACF;;;;;;CAOD,MAAM,kBACJA,QACsD;AACtD,SAAO,KAAK,YAAY,kBACtB,MAAM,KAAK,sBAAsB,OAAO,CACzC;CACF;CAED,MAAM,OAAOA,QAAsC;AACjD,SAAO,KAAK,YAAY,OAAO,MAAM,KAAK,sBAAsB,OAAO,CAAC;CACzE;;;;;;;CAQD,MAAM,QACJC,QACqD;EACrD,MAAM,aAAa,EAAE,GAAG,KAAM;EAC9B,WAAW,iBAAiB,KAAK,eAAe,OAC9C,CAAC,OAAO,EAAE,MAAM,QACjB;EACD,WAAW,mBAAmB;GAC5B,GAAI,KAAK,oBAAoB,CAAE;GAC/B,GAAG;EACJ;AACD,SAAO,IAAI,uBAA2C;CACvD;CAED,YAA0C;AACxC,QAAM,IAAI,MAAM;CACjB;CAED,iBAAyB;AACvB,SAAO;CACR;AACF"}

package/dist/prompts/prompt.cjs

@@ -1,166 +1,133 @@
-"use strict";
-// Default generic "any" values are for backwards compatibility.
-// Replace with "string" when we are comfortable with a breaking change.
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PromptTemplate = void 0;
-const string_js_1 = require("./string.cjs");
-const template_js_1 = require("./template.cjs");
+const require_string = require('./string.cjs');
+const require_template = require('./template.cjs');
+
+//#region src/prompts/prompt.ts
 /**
- * Schema to represent a basic prompt for an LLM.
- * @augments BasePromptTemplate
- * @augments PromptTemplateInput
- *
- * @example
- * ```ts
- * import { PromptTemplate } from "langchain/prompts";
- *
- * const prompt = new PromptTemplate({
- *   inputVariables: ["foo"],
- *   template: "Say {foo}",
- * });
- * ```
- */
-class PromptTemplate extends string_js_1.BaseStringPromptTemplate {
-    static lc_name() {
-        return "PromptTemplate";
-    }
-    constructor(input) {
-        super(input);
-        Object.defineProperty(this, "template", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "templateFormat", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: "f-string"
-        });
-        Object.defineProperty(this, "validateTemplate", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: true
-        });
-        /**
-         * Additional fields which should be included inside
-         * the message content array if using a complex message
-         * content.
-         */
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        Object.defineProperty(this, "additionalContentFields", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        // If input is mustache and validateTemplate is not defined, set it to false
-        if (input.templateFormat === "mustache" &&
-            input.validateTemplate === undefined) {
-            this.validateTemplate = false;
-        }
-        Object.assign(this, input);
-        if (this.validateTemplate) {
-            if (this.templateFormat === "mustache") {
-                throw new Error("Mustache templates cannot be validated.");
-            }
-            let totalInputVariables = this.inputVariables;
-            if (this.partialVariables) {
-                totalInputVariables = totalInputVariables.concat(Object.keys(this.partialVariables));
-            }
-            (0, template_js_1.checkValidTemplate)(this.template, this.templateFormat, totalInputVariables);
-        }
-    }
-    _getPromptType() {
-        return "prompt";
-    }
-    /**
-     * Formats the prompt template with the provided values.
-     * @param values The values to be used to format the prompt template.
-     * @returns A promise that resolves to a string which is the formatted prompt.
-     */
-    async format(values) {
-        const allValues = await this.mergePartialAndUserVariables(values);
-        return (0, template_js_1.renderTemplate)(this.template, this.templateFormat, allValues);
-    }
-    /**
-     * Take examples in list format with prefix and suffix to create a prompt.
-     *
-     * Intended to be used a a way to dynamically create a prompt from examples.
-     *
-     * @param examples - List of examples to use in the prompt.
-     * @param suffix - String to go after the list of examples. Should generally set up the user's input.
-     * @param inputVariables - A list of variable names the final prompt template will expect
-     * @param exampleSeparator - The separator to use in between examples
-     * @param prefix - String that should go before any examples. Generally includes examples.
-     *
-     * @returns The final prompt template generated.
-     */
-    static fromExamples(examples, suffix, inputVariables, exampleSeparator = "\n\n", prefix = "") {
-        const template = [prefix, ...examples, suffix].join(exampleSeparator);
-        return new PromptTemplate({
-            inputVariables,
-            template,
-        });
-    }
-    static fromTemplate(template, options) {
-        const { templateFormat = "f-string", ...rest } = options ?? {};
-        const names = new Set();
-        (0, template_js_1.parseTemplate)(template, templateFormat).forEach((node) => {
-            if (node.type === "variable") {
-                names.add(node.name);
-            }
-        });
-        return new PromptTemplate({
-            // Rely on extracted types
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any
-            inputVariables: [...names],
-            templateFormat,
-            template,
-            ...rest,
-        });
-    }
-    /**
-     * Partially applies values to the prompt template.
-     * @param values The values to be partially applied to the prompt template.
-     * @returns A new instance of PromptTemplate with the partially applied values.
-     */
-    async partial(values) {
-        const newInputVariables = this.inputVariables.filter((iv) => !(iv in values));
-        const newPartialVariables = {
-            ...(this.partialVariables ?? {}),
-            ...values,
-        };
-        const promptDict = {
-            ...this,
-            inputVariables: newInputVariables,
-            partialVariables: newPartialVariables,
-        };
-        return new PromptTemplate(promptDict);
-    }
-    serialize() {
-        if (this.outputParser !== undefined) {
-            throw new Error("Cannot serialize a prompt template with an output parser");
-        }
-        return {
-            _type: this._getPromptType(),
-            input_variables: this.inputVariables,
-            template: this.template,
-            template_format: this.templateFormat,
-        };
-    }
-    static async deserialize(data) {
-        if (!data.template) {
-            throw new Error("Prompt template must have a template");
-        }
-        const res = new PromptTemplate({
-            inputVariables: data.input_variables,
-            template: data.template,
-            templateFormat: data.template_format,
-        });
-        return res;
-    }
-}
+* Schema to represent a basic prompt for an LLM.
+* @augments BasePromptTemplate
+* @augments PromptTemplateInput
+*
+* @example
+* ```ts
+* import { PromptTemplate } from "langchain/prompts";
+*
+* const prompt = new PromptTemplate({
+*   inputVariables: ["foo"],
+*   template: "Say {foo}",
+* });
+* ```
+*/
+var PromptTemplate = class PromptTemplate extends require_string.BaseStringPromptTemplate {
+	static lc_name() {
+		return "PromptTemplate";
+	}
+	template;
+	templateFormat = "f-string";
+	validateTemplate = true;
+	/**
+	* Additional fields which should be included inside
+	* the message content array if using a complex message
+	* content.
+	*/
+	additionalContentFields;
+	constructor(input) {
+		super(input);
+		if (input.templateFormat === "mustache" && input.validateTemplate === void 0) this.validateTemplate = false;
+		Object.assign(this, input);
+		if (this.validateTemplate) {
+			if (this.templateFormat === "mustache") throw new Error("Mustache templates cannot be validated.");
+			let totalInputVariables = this.inputVariables;
+			if (this.partialVariables) totalInputVariables = totalInputVariables.concat(Object.keys(this.partialVariables));
+			require_template.checkValidTemplate(this.template, this.templateFormat, totalInputVariables);
+		}
+	}
+	_getPromptType() {
+		return "prompt";
+	}
+	/**
+	* Formats the prompt template with the provided values.
+	* @param values The values to be used to format the prompt template.
+	* @returns A promise that resolves to a string which is the formatted prompt.
+	*/
+	async format(values) {
+		const allValues = await this.mergePartialAndUserVariables(values);
+		return require_template.renderTemplate(this.template, this.templateFormat, allValues);
+	}
+	/**
+	* Take examples in list format with prefix and suffix to create a prompt.
+	*
+	* Intended to be used a a way to dynamically create a prompt from examples.
+	*
+	* @param examples - List of examples to use in the prompt.
+	* @param suffix - String to go after the list of examples. Should generally set up the user's input.
+	* @param inputVariables - A list of variable names the final prompt template will expect
+	* @param exampleSeparator - The separator to use in between examples
+	* @param prefix - String that should go before any examples. Generally includes examples.
+	*
+	* @returns The final prompt template generated.
+	*/
+	static fromExamples(examples, suffix, inputVariables, exampleSeparator = "\n\n", prefix = "") {
+		const template = [
+			prefix,
+			...examples,
+			suffix
+		].join(exampleSeparator);
+		return new PromptTemplate({
+			inputVariables,
+			template
+		});
+	}
+	static fromTemplate(template, options) {
+		const { templateFormat = "f-string",...rest } = options ?? {};
+		const names = /* @__PURE__ */ new Set();
+		require_template.parseTemplate(template, templateFormat).forEach((node) => {
+			if (node.type === "variable") names.add(node.name);
+		});
+		return new PromptTemplate({
+			inputVariables: [...names],
+			templateFormat,
+			template,
+			...rest
+		});
+	}
+	/**
+	* Partially applies values to the prompt template.
+	* @param values The values to be partially applied to the prompt template.
+	* @returns A new instance of PromptTemplate with the partially applied values.
+	*/
+	async partial(values) {
+		const newInputVariables = this.inputVariables.filter((iv) => !(iv in values));
+		const newPartialVariables = {
+			...this.partialVariables ?? {},
+			...values
+		};
+		const promptDict = {
+			...this,
+			inputVariables: newInputVariables,
+			partialVariables: newPartialVariables
+		};
+		return new PromptTemplate(promptDict);
+	}
+	serialize() {
+		if (this.outputParser !== void 0) throw new Error("Cannot serialize a prompt template with an output parser");
+		return {
+			_type: this._getPromptType(),
+			input_variables: this.inputVariables,
+			template: this.template,
+			template_format: this.templateFormat
+		};
+	}
+	static async deserialize(data) {
+		if (!data.template) throw new Error("Prompt template must have a template");
+		const res = new PromptTemplate({
+			inputVariables: data.input_variables,
+			template: data.template,
+			templateFormat: data.template_format
+		});
+		return res;
+	}
+};
+
+//#endregion
 exports.PromptTemplate = PromptTemplate;
+//# sourceMappingURL=prompt.cjs.map

package/dist/prompts/prompt.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"prompt.cjs","names":["BaseStringPromptTemplate","input: PromptTemplateInput<RunInput, PartialVariableName>","totalInputVariables: string[]","checkValidTemplate","values: TypedPromptInputValues<RunInput>","renderTemplate","examples: string[]","suffix: string","inputVariables: string[]","template: T","options?: Omit<\n      PromptTemplateInput<RunInput, string, TemplateFormat>,\n      \"template\" | \"inputVariables\"\n    >","parseTemplate","values: PartialValues<NewPartialVariableName>","data: SerializedPromptTemplate"],"sources":["../../src/prompts/prompt.ts"],"sourcesContent":["// Default generic \"any\" values are for backwards compatibility.\n// Replace with \"string\" when we are comfortable with a breaking change.\n\nimport { BaseStringPromptTemplate } from \"./string.js\";\nimport type {\n  BasePromptTemplateInput,\n  TypedPromptInputValues,\n} from \"./base.js\";\nimport {\n  checkValidTemplate,\n  parseTemplate,\n  renderTemplate,\n  type TemplateFormat,\n} from \"./template.js\";\nimport type { SerializedPromptTemplate } from \"./serde.js\";\nimport type { InputValues, PartialValues } from \"../utils/types/index.js\";\nimport { MessageContent, ContentBlock } from \"../messages/index.js\";\n\n/**\n * Inputs to create a {@link PromptTemplate}\n * @augments BasePromptTemplateInput\n */\nexport interface PromptTemplateInput<\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  RunInput extends InputValues = any,\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  PartialVariableName extends string = any,\n  Format extends TemplateFormat = TemplateFormat\n> extends BasePromptTemplateInput<RunInput, PartialVariableName> {\n  /**\n   * The prompt template\n   */\n  template: MessageContent;\n\n  /**\n   * The format of the prompt template. Options are \"f-string\" and \"mustache\"\n   */\n  templateFormat?: Format;\n\n  /**\n   * Whether or not to try validating the template on initialization\n   *\n   * @defaultValue `true`\n   */\n  validateTemplate?: boolean;\n\n  /**\n   * Additional fields which should be included inside\n   * the message content array if using a complex message\n   * content.\n   */\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  additionalContentFields?: ContentBlock;\n}\n\ntype NonAlphanumeric =\n  | \" \"\n  | \"\\t\"\n  | \"\\n\"\n  | \"\\r\"\n  | '\"'\n  | \"'\"\n  | \"{\"\n  | \"[\"\n  | \"(\"\n  | \"`\"\n  | \":\"\n  | \";\";\n\n/**\n * Recursive type to extract template parameters from a string.\n * @template T - The input string.\n * @template Result - The resulting array of extracted template parameters.\n */\ntype ExtractTemplateParamsRecursive<\n  T extends string,\n  Result extends string[] = []\n> = T extends `${string}{${infer Param}}${infer Rest}`\n  ? Param extends `${NonAlphanumeric}${string}`\n    ? ExtractTemplateParamsRecursive<Rest, Result> // for non-template variables that look like template variables e.g. see https://github.com/langchain-ai/langchainjs/blob/main/langchain/src/chains/query_constructor/prompt.ts\n    : ExtractTemplateParamsRecursive<Rest, [...Result, Param]>\n  : Result;\n\nexport type ParamsFromFString<T extends string> = {\n  [Key in\n    | ExtractTemplateParamsRecursive<T>[number]\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    | (string & Record<never, never>)]: any;\n};\n\nexport type ExtractedFStringParams<\n  T extends string,\n  // eslint-disable-next-line @typescript-eslint/ban-types\n  RunInput extends InputValues = Symbol\n  // eslint-disable-next-line @typescript-eslint/ban-types\n> = RunInput extends Symbol ? ParamsFromFString<T> : RunInput;\n\n/**\n * Schema to represent a basic prompt for an LLM.\n * @augments BasePromptTemplate\n * @augments PromptTemplateInput\n *\n * @example\n * ```ts\n * import { PromptTemplate } from \"langchain/prompts\";\n *\n * const prompt = new PromptTemplate({\n *   inputVariables: [\"foo\"],\n *   template: \"Say {foo}\",\n * });\n * ```\n */\nexport class PromptTemplate<\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    RunInput extends InputValues = any,\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    PartialVariableName extends string = any\n  >\n  extends BaseStringPromptTemplate<RunInput, PartialVariableName>\n  implements PromptTemplateInput<RunInput, PartialVariableName>\n{\n  static lc_name() {\n    return \"PromptTemplate\";\n  }\n\n  template: MessageContent;\n\n  templateFormat: TemplateFormat = \"f-string\";\n\n  validateTemplate = true;\n\n  /**\n   * Additional fields which should be included inside\n   * the message content array if using a complex message\n   * content.\n   */\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  additionalContentFields?: ContentBlock;\n\n  constructor(input: PromptTemplateInput<RunInput, PartialVariableName>) {\n    super(input);\n    // If input is mustache and validateTemplate is not defined, set it to false\n    if (\n      input.templateFormat === \"mustache\" &&\n      input.validateTemplate === undefined\n    ) {\n      this.validateTemplate = false;\n    }\n    Object.assign(this, input);\n\n    if (this.validateTemplate) {\n      if (this.templateFormat === \"mustache\") {\n        throw new Error(\"Mustache templates cannot be validated.\");\n      }\n      let totalInputVariables: string[] = this.inputVariables;\n      if (this.partialVariables) {\n        totalInputVariables = totalInputVariables.concat(\n          Object.keys(this.partialVariables)\n        );\n      }\n      checkValidTemplate(\n        this.template,\n        this.templateFormat,\n        totalInputVariables\n      );\n    }\n  }\n\n  _getPromptType(): \"prompt\" {\n    return \"prompt\";\n  }\n\n  /**\n   * Formats the prompt template with the provided values.\n   * @param values The values to be used to format the prompt template.\n   * @returns A promise that resolves to a string which is the formatted prompt.\n   */\n  async format(values: TypedPromptInputValues<RunInput>): Promise<string> {\n    const allValues = await this.mergePartialAndUserVariables(values);\n    return renderTemplate(\n      this.template as string,\n      this.templateFormat,\n      allValues\n    );\n  }\n\n  /**\n   * Take examples in list format with prefix and suffix to create a prompt.\n   *\n   * Intended to be used a a way to dynamically create a prompt from examples.\n   *\n   * @param examples - List of examples to use in the prompt.\n   * @param suffix - String to go after the list of examples. Should generally set up the user's input.\n   * @param inputVariables - A list of variable names the final prompt template will expect\n   * @param exampleSeparator - The separator to use in between examples\n   * @param prefix - String that should go before any examples. Generally includes examples.\n   *\n   * @returns The final prompt template generated.\n   */\n  static fromExamples(\n    examples: string[],\n    suffix: string,\n    inputVariables: string[],\n    exampleSeparator = \"\\n\\n\",\n    prefix = \"\"\n  ) {\n    const template = [prefix, ...examples, suffix].join(exampleSeparator);\n    return new PromptTemplate({\n      inputVariables,\n      template,\n    });\n  }\n\n  /**\n   * Load prompt template from a template f-string\n   */\n  static fromTemplate<\n    // eslint-disable-next-line @typescript-eslint/ban-types\n    RunInput extends InputValues = Symbol,\n    T extends string = string\n  >(\n    template: T,\n    options?: Omit<\n      PromptTemplateInput<RunInput, string, \"f-string\">,\n      \"template\" | \"inputVariables\"\n    >\n  ): PromptTemplate<ExtractedFStringParams<T, RunInput>>;\n\n  static fromTemplate<\n    // eslint-disable-next-line @typescript-eslint/ban-types\n    RunInput extends InputValues = Symbol,\n    T extends string = string\n  >(\n    template: T,\n    options?: Omit<\n      PromptTemplateInput<RunInput, string>,\n      \"template\" | \"inputVariables\"\n    >\n  ): PromptTemplate<ExtractedFStringParams<T, RunInput>>;\n\n  static fromTemplate<\n    // eslint-disable-next-line @typescript-eslint/ban-types\n    RunInput extends InputValues = Symbol,\n    T extends string = string\n  >(\n    template: T,\n    options?: Omit<\n      PromptTemplateInput<RunInput, string, \"mustache\">,\n      \"template\" | \"inputVariables\"\n    >\n  ): PromptTemplate<InputValues>;\n\n  static fromTemplate<\n    // eslint-disable-next-line @typescript-eslint/ban-types\n    RunInput extends InputValues = Symbol,\n    T extends string = string\n  >(\n    template: T,\n    options?: Omit<\n      PromptTemplateInput<RunInput, string, TemplateFormat>,\n      \"template\" | \"inputVariables\"\n    >\n  ): PromptTemplate<ExtractedFStringParams<T, RunInput> | InputValues> {\n    const { templateFormat = \"f-string\", ...rest } = options ?? {};\n    const names = new Set<string>();\n    parseTemplate(template, templateFormat).forEach((node) => {\n      if (node.type === \"variable\") {\n        names.add(node.name);\n      }\n    });\n\n    return new PromptTemplate({\n      // Rely on extracted types\n      // eslint-disable-next-line @typescript-eslint/no-explicit-any\n      inputVariables: [...names] as any[],\n      templateFormat,\n      template,\n      ...rest,\n    });\n  }\n\n  /**\n   * Partially applies values to the prompt template.\n   * @param values The values to be partially applied to the prompt template.\n   * @returns A new instance of PromptTemplate with the partially applied values.\n   */\n  async partial<NewPartialVariableName extends string>(\n    values: PartialValues<NewPartialVariableName>\n  ) {\n    const newInputVariables = this.inputVariables.filter(\n      (iv) => !(iv in values)\n    ) as Exclude<Extract<keyof RunInput, string>, NewPartialVariableName>[];\n    const newPartialVariables = {\n      ...(this.partialVariables ?? {}),\n      ...values,\n    } as PartialValues<PartialVariableName | NewPartialVariableName>;\n    const promptDict = {\n      ...this,\n      inputVariables: newInputVariables,\n      partialVariables: newPartialVariables,\n    };\n    return new PromptTemplate<\n      InputValues<\n        Exclude<Extract<keyof RunInput, string>, NewPartialVariableName>\n      >\n    >(promptDict);\n  }\n\n  serialize(): SerializedPromptTemplate {\n    if (this.outputParser !== undefined) {\n      throw new Error(\n        \"Cannot serialize a prompt template with an output parser\"\n      );\n    }\n    return {\n      _type: this._getPromptType(),\n      input_variables: this.inputVariables,\n      template: this.template,\n      template_format: this.templateFormat,\n    };\n  }\n\n  static async deserialize(\n    data: SerializedPromptTemplate\n  ): Promise<PromptTemplate> {\n    if (!data.template) {\n      throw new Error(\"Prompt template must have a template\");\n    }\n    const res = new PromptTemplate({\n      inputVariables: data.input_variables,\n      template: data.template,\n      templateFormat: data.template_format,\n    });\n    return res;\n  }\n\n  // TODO(from file)\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;AAgHA,IAAa,iBAAb,MAAa,uBAMHA,wCAEV;CACE,OAAO,UAAU;AACf,SAAO;CACR;CAED;CAEA,iBAAiC;CAEjC,mBAAmB;;;;;;CAQnB;CAEA,YAAYC,OAA2D;EACrE,MAAM,MAAM;AAEZ,MACE,MAAM,mBAAmB,cACzB,MAAM,qBAAqB,QAE3B,KAAK,mBAAmB;EAE1B,OAAO,OAAO,MAAM,MAAM;AAE1B,MAAI,KAAK,kBAAkB;AACzB,OAAI,KAAK,mBAAmB,WAC1B,OAAM,IAAI,MAAM;GAElB,IAAIC,sBAAgC,KAAK;AACzC,OAAI,KAAK,kBACP,sBAAsB,oBAAoB,OACxC,OAAO,KAAK,KAAK,iBAAiB,CACnC;GAEHC,oCACE,KAAK,UACL,KAAK,gBACL,oBACD;EACF;CACF;CAED,iBAA2B;AACzB,SAAO;CACR;;;;;;CAOD,MAAM,OAAOC,QAA2D;EACtE,MAAM,YAAY,MAAM,KAAK,6BAA6B,OAAO;AACjE,SAAOC,gCACL,KAAK,UACL,KAAK,gBACL,UACD;CACF;;;;;;;;;;;;;;CAeD,OAAO,aACLC,UACAC,QACAC,gBACA,mBAAmB,QACnB,SAAS,IACT;EACA,MAAM,WAAW;GAAC;GAAQ,GAAG;GAAU;EAAO,EAAC,KAAK,iBAAiB;AACrE,SAAO,IAAI,eAAe;GACxB;GACA;EACD;CACF;CAyCD,OAAO,aAKLC,UACAC,SAImE;EACnE,MAAM,EAAE,iBAAiB,WAAY,GAAG,MAAM,GAAG,WAAW,CAAE;EAC9D,MAAM,wBAAQ,IAAI;EAClBC,+BAAc,UAAU,eAAe,CAAC,QAAQ,CAAC,SAAS;AACxD,OAAI,KAAK,SAAS,YAChB,MAAM,IAAI,KAAK,KAAK;EAEvB,EAAC;AAEF,SAAO,IAAI,eAAe;GAGxB,gBAAgB,CAAC,GAAG,KAAM;GAC1B;GACA;GACA,GAAG;EACJ;CACF;;;;;;CAOD,MAAM,QACJC,QACA;EACA,MAAM,oBAAoB,KAAK,eAAe,OAC5C,CAAC,OAAO,EAAE,MAAM,QACjB;EACD,MAAM,sBAAsB;GAC1B,GAAI,KAAK,oBAAoB,CAAE;GAC/B,GAAG;EACJ;EACD,MAAM,aAAa;GACjB,GAAG;GACH,gBAAgB;GAChB,kBAAkB;EACnB;AACD,SAAO,IAAI,eAIT;CACH;CAED,YAAsC;AACpC,MAAI,KAAK,iBAAiB,OACxB,OAAM,IAAI,MACR;AAGJ,SAAO;GACL,OAAO,KAAK,gBAAgB;GAC5B,iBAAiB,KAAK;GACtB,UAAU,KAAK;GACf,iBAAiB,KAAK;EACvB;CACF;CAED,aAAa,YACXC,MACyB;AACzB,MAAI,CAAC,KAAK,SACR,OAAM,IAAI,MAAM;EAElB,MAAM,MAAM,IAAI,eAAe;GAC7B,gBAAgB,KAAK;GACrB,UAAU,KAAK;GACf,gBAAgB,KAAK;EACtB;AACD,SAAO;CACR;AAGF"}