@langchain/core 0.3.72 → 1.0.0-alpha.2

package/dist/prompts/prompt.d.cts

@@ -0,0 +1,134 @@
+import { InputValues, PartialValues } from "../utils/types/index.cjs";
+import { ContentBlock } from "../messages/content/index.cjs";
+import { MessageContent } from "../messages/base.cjs";
+import { TemplateFormat } from "./template.cjs";
+import { SerializedPromptTemplate } from "./serde.cjs";
+import { BasePromptTemplateInput, TypedPromptInputValues } from "./base.cjs";
+import { BaseStringPromptTemplate } from "./string.cjs";
+
+//#region src/prompts/prompt.d.ts
+
+/**
+ * Inputs to create a {@link PromptTemplate}
+ * @augments BasePromptTemplateInput
+ */
+interface PromptTemplateInput<
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+RunInput extends InputValues = any,
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+PartialVariableName extends string = any, Format extends TemplateFormat = TemplateFormat> extends BasePromptTemplateInput<RunInput, PartialVariableName> {
+  /**
+   * The prompt template
+   */
+  template: MessageContent;
+  /**
+   * The format of the prompt template. Options are "f-string" and "mustache"
+   */
+  templateFormat?: Format;
+  /**
+   * Whether or not to try validating the template on initialization
+   *
+   * @defaultValue `true`
+   */
+  validateTemplate?: boolean;
+  /**
+   * 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
+  additionalContentFields?: ContentBlock;
+}
+type NonAlphanumeric = " " | "\t" | "\n" | "\r" | '"' | "'" | "{" | "[" | "(" | "`" | ":" | ";";
+/**
+ * Recursive type to extract template parameters from a string.
+ * @template T - The input string.
+ * @template Result - The resulting array of extracted template parameters.
+ */
+type ExtractTemplateParamsRecursive<T extends string, Result extends string[] = []> = T extends `${string}{${infer Param}}${infer Rest}` ? Param extends `${NonAlphanumeric}${string}` ? 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
+: ExtractTemplateParamsRecursive<Rest, [...Result, Param]> : Result;
+type ParamsFromFString<T extends string> = { [Key in ExtractTemplateParamsRecursive<T>[number]
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+| (string & Record<never, never>)]: any };
+type ExtractedFStringParams<T extends string,
+// eslint-disable-next-line @typescript-eslint/ban-types
+RunInput extends InputValues = Symbol
+// eslint-disable-next-line @typescript-eslint/ban-types
+> = RunInput extends Symbol ? ParamsFromFString<T> : RunInput;
+/**
+ * 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}",
+ * });
+ * ```
+ */
+declare class PromptTemplate<
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+RunInput extends InputValues = any,
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+PartialVariableName extends string = any> extends BaseStringPromptTemplate<RunInput, PartialVariableName> implements PromptTemplateInput<RunInput, PartialVariableName> {
+  static lc_name(): string;
+  template: MessageContent;
+  templateFormat: TemplateFormat;
+  validateTemplate: boolean;
+  /**
+   * 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
+  additionalContentFields?: ContentBlock;
+  constructor(input: PromptTemplateInput<RunInput, PartialVariableName>);
+  _getPromptType(): "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.
+   */
+  format(values: TypedPromptInputValues<RunInput>): Promise<string>;
+  /**
+   * 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: string[], suffix: string, inputVariables: string[], exampleSeparator?: string, prefix?: string): PromptTemplate<any, any>;
+  /**
+   * Load prompt template from a template f-string
+   */
+  static fromTemplate<
+  // eslint-disable-next-line @typescript-eslint/ban-types
+  RunInput extends InputValues = Symbol, T extends string = string>(template: T, options?: Omit<PromptTemplateInput<RunInput, string, "f-string">, "template" | "inputVariables">): PromptTemplate<ExtractedFStringParams<T, RunInput>>;
+  static fromTemplate<
+  // eslint-disable-next-line @typescript-eslint/ban-types
+  RunInput extends InputValues = Symbol, T extends string = string>(template: T, options?: Omit<PromptTemplateInput<RunInput, string>, "template" | "inputVariables">): PromptTemplate<ExtractedFStringParams<T, RunInput>>;
+  static fromTemplate<
+  // eslint-disable-next-line @typescript-eslint/ban-types
+  RunInput extends InputValues = Symbol, T extends string = string>(template: T, options?: Omit<PromptTemplateInput<RunInput, string, "mustache">, "template" | "inputVariables">): PromptTemplate<InputValues>;
+  /**
+   * 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.
+   */
+  partial<NewPartialVariableName extends string>(values: PartialValues<NewPartialVariableName>): Promise<PromptTemplate<InputValues<Exclude<Extract<keyof RunInput, string>, NewPartialVariableName>>, any>>;
+  serialize(): SerializedPromptTemplate;
+  static deserialize(data: SerializedPromptTemplate): Promise<PromptTemplate>;
+}
+//#endregion
+export { ExtractedFStringParams, ParamsFromFString, PromptTemplate, PromptTemplateInput };
+//# sourceMappingURL=prompt.d.cts.map

package/dist/prompts/prompt.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"prompt.d.cts","names":["BaseStringPromptTemplate","BasePromptTemplateInput","TypedPromptInputValues","TemplateFormat","SerializedPromptTemplate","InputValues","PartialValues","MessageContent","ContentBlock","PromptTemplateInput","RunInput","PartialVariableName","Format","NonAlphanumeric","ExtractTemplateParamsRecursive","T","Param","Rest","Result","ParamsFromFString","Record","ExtractedFStringParams","Symbol","PromptTemplate","Promise","Omit","NewPartialVariableName","Extract","Exclude"],"sources":["../../src/prompts/prompt.d.ts"],"sourcesContent":["// Default generic \"any\" values are for backwards compatibility.\n// Replace with \"string\" when we are comfortable with a breaking change.\nimport { BaseStringPromptTemplate } from \"./string.js\";\nimport type { BasePromptTemplateInput, TypedPromptInputValues } from \"./base.js\";\nimport { type TemplateFormat } 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 * Inputs to create a {@link PromptTemplate}\n * @augments BasePromptTemplateInput\n */\nexport interface PromptTemplateInput<\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nRunInput extends InputValues = any, \n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nPartialVariableName extends string = any, Format extends TemplateFormat = TemplateFormat> extends BasePromptTemplateInput<RunInput, PartialVariableName> {\n    /**\n     * The prompt template\n     */\n    template: MessageContent;\n    /**\n     * The format of the prompt template. Options are \"f-string\" and \"mustache\"\n     */\n    templateFormat?: Format;\n    /**\n     * Whether or not to try validating the template on initialization\n     *\n     * @defaultValue `true`\n     */\n    validateTemplate?: boolean;\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}\ntype NonAlphanumeric = \" \" | \"\\t\" | \"\\n\" | \"\\r\" | '\"' | \"'\" | \"{\" | \"[\" | \"(\" | \"`\" | \":\" | \";\";\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<T extends string, Result extends string[] = []> = T extends `${string}{${infer Param}}${infer Rest}` ? Param extends `${NonAlphanumeric}${string}` ? 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]> : Result;\nexport type ParamsFromFString<T extends string> = {\n    [Key in ExtractTemplateParamsRecursive<T>[number]\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n     | (string & Record<never, never>)]: any;\n};\nexport type ExtractedFStringParams<T extends string, \n// eslint-disable-next-line @typescript-eslint/ban-types\nRunInput extends InputValues = Symbol\n// eslint-disable-next-line @typescript-eslint/ban-types\n> = RunInput extends Symbol ? ParamsFromFString<T> : RunInput;\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 declare class PromptTemplate<\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nRunInput extends InputValues = any, \n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nPartialVariableName extends string = any> extends BaseStringPromptTemplate<RunInput, PartialVariableName> implements PromptTemplateInput<RunInput, PartialVariableName> {\n    static lc_name(): string;\n    template: MessageContent;\n    templateFormat: TemplateFormat;\n    validateTemplate: boolean;\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    constructor(input: PromptTemplateInput<RunInput, PartialVariableName>);\n    _getPromptType(): \"prompt\";\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    format(values: TypedPromptInputValues<RunInput>): Promise<string>;\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(examples: string[], suffix: string, inputVariables: string[], exampleSeparator?: string, prefix?: string): PromptTemplate<any, any>;\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, T extends string = string>(template: T, options?: Omit<PromptTemplateInput<RunInput, string, \"f-string\">, \"template\" | \"inputVariables\">): PromptTemplate<ExtractedFStringParams<T, RunInput>>;\n    static fromTemplate<\n    // eslint-disable-next-line @typescript-eslint/ban-types\n    RunInput extends InputValues = Symbol, T extends string = string>(template: T, options?: Omit<PromptTemplateInput<RunInput, string>, \"template\" | \"inputVariables\">): PromptTemplate<ExtractedFStringParams<T, RunInput>>;\n    static fromTemplate<\n    // eslint-disable-next-line @typescript-eslint/ban-types\n    RunInput extends InputValues = Symbol, T extends string = string>(template: T, options?: Omit<PromptTemplateInput<RunInput, string, \"mustache\">, \"template\" | \"inputVariables\">): PromptTemplate<InputValues>;\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    partial<NewPartialVariableName extends string>(values: PartialValues<NewPartialVariableName>): Promise<PromptTemplate<InputValues<Exclude<Extract<keyof RunInput, string>, NewPartialVariableName>>, any>>;\n    serialize(): SerializedPromptTemplate;\n    static deserialize(data: SerializedPromptTemplate): Promise<PromptTemplate>;\n}\nexport {};\n"],"mappings":";;;;;;;;;;;AAYA;;;AAIyDG,UAJxCM,mBAIwCN;;iBAFxCE,WAEyGK,GAAAA,GAAAA;;4BAI5GH,MAAAA,GAAAA,GAAAA,EAAAA,eAJ2CJ,cAI3CI,GAJ4DJ,cAI5DI,CAAAA,SAJoFN,uBAIpFM,CAJ4GG,QAI5GH,EAJsHI,mBAItHJ,CAAAA,CAAAA;EAAc;;;EAJ6F,QAAA,EAI3GA,cAJ2G;EAuBpHM;AAAe;;EAMe,cAAmDE,CAAAA,EArBjEH,MAqBiEG;EAAC;;;;;EAAgI,gBACrLE,CAAAA,EAAAA,OAAAA;EAAI;;;;AAA8B;EACxDE;EAAiB,uBAAA,CAAA,EAVCX,YAUD;;KARxBK,eAAAA,GASOC,GAAAA,GAAAA,IAAAA,GAAAA,IAAAA,GAAAA,IAAAA,GAAAA,GAAAA,GAAAA,GAAAA,GAAAA,GAAAA,GAAAA,GAAAA,GAAAA,GAAAA,GAAAA,GAAAA,GAAAA,GAAAA,GAAAA,GAAAA;;AAEW;AAEvB;;;KAPKA,8BAS0BQ,CAAAA,UAAAA,MAAAA,EAAAA,eAAAA,MAAAA,EAAAA,GAAAA,EAAAA,CAAAA,GATuDP,CASvDO,SAAAA,GAAAA,MAAAA,IAAAA,KAAAA,MAAAA,IAAAA,KAAAA,KAAAA,EAAAA,GAT4GN,KAS5GM,SAAAA,GAT6HT,eAS7HS,GAAAA,MAAAA,EAAAA,GAT0JR,8BAS1JQ,CATyLL,IASzLK,EAT+LJ,MAS/LI,CAAAA,CAAAA;AAAAA,EAR5BR,8BAUCJ,CAV8BO,IAU9BP,EAAAA,CAAAA,GAVwCQ,MAUxCR,EAVgDM,KAUhDN,CAAAA,CAAAA,GAV0DQ,MAU1DR;AAAiBY,KATTH,iBASSG,CAAAA,UAAAA,MAAAA,CAAAA,GAAAA,UARTR,8BAQoCC,CARLA,CAQKA,CAAAA,CAAAA,MAAAA;AAAC;AAAA,EAAIL,CAAAA,MAAAA,GANpCU,MAMoCV,CAAAA,KAAAA,EAAAA,KAAAA,CAAAA,CAAAA,GAAAA,GAAAA,EAAQ;AAgBxCa,KApBTF,sBAoBuB,CAAA,UAAA,MAAA;;iBAlBlBhB,WAoBAA,GApBciB;;CAsBoD,GApB/EZ,QAoBiFC,SApBhEW,MAoBgEX,GApBvDQ,iBAoBuDR,CApBrCI,CAoBqCJ,CAAAA,GApBhCD,QAoBgCC;;;;;;;;;;;;;;;;AAuCiCD,cA3CjGa,cA2CiGb;;iBAzCrGL,WAyC4EoB,GAAAA,GAAAA;;4BAAkIf,MAAAA,GAAAA,GAAAA,CAAAA,SAvC7KV,wBAuC6KU,CAvCpJA,QAuCoJA,EAvC1IC,mBAuC0ID,CAAAA,YAvC1GD,mBAuC0GC,CAvCtFA,QAuCsFA,EAvC5EC,mBAuC4ED,CAAAA,CAAAA;EAAQ,OAAlCW,OAAAA,CAAAA,CAAAA,EAAAA,MAAAA;EAAsB,QAArCE,EArCxKhB,cAqCwKgB;EAAc,cAG/KlB,EAvCDF,cAuCCE;EAAW,gBAAGiB,EAAAA,OAAAA;EAAM;;;;;EAAwK;EAAU,uBAAlCD,CAAAA,EA/B3Jb,YA+B2Ja;EAAsB,WAArCE,CAAAA,KAAAA,EA9BnJd,mBA8BmJc,CA9B/Hb,QA8B+Ha,EA9BrHZ,mBA8BqHY,CAAAA;EAAc,cAGnKlB,CAAAA,CAAAA,EAAAA,QAAAA;EAAW;;;;;EAAiE,MAAoGA,CAAAA,MAAAA,EA1BlLH,sBA0BkLG,CA1B3JK,QA0B2JL,CAAAA,CAAAA,EA1B/ImB,OA0B+InB,CAAAA,MAAAA,CAAAA;EAAW;;;;;;;;;;;;;EAQlI,OAAtBmB,YAAAA,CAAAA,QAAAA,EAAAA,MAAAA,EAAAA,EAAAA,MAAAA,EAAAA,MAAAA,EAAAA,cAAAA,EAAAA,MAAAA,EAAAA,EAAAA,gBAAAA,CAAAA,EAAAA,MAAAA,EAAAA,MAAAA,CAAAA,EAAAA,MAAAA,CAAAA,EApB2ED,cAoB3EC,CAAAA,GAAAA,EAAAA,GAAAA,CAAAA;EAAO;;AArDyE;;;mBAuCnHnB,cAAciB,6CAA6CP,aAAaU,KAAKhB,oBAAoBC,gEAAgEa,eAAeF,uBAAuBN,GAAGL;;;mBAG1ML,cAAciB,6CAA6CP,aAAaU,KAAKhB,oBAAoBC,oDAAoDa,eAAeF,uBAAuBN,GAAGL;;;mBAG9LL,cAAciB,6CAA6CP,aAAaU,KAAKhB,oBAAoBC,gEAAgEa,eAAelB;;;;;;yDAM1IC,cAAcoB,0BAA0BF,QAAQD,eAAelB,YAAYuB,QAAQD,cAAcjB,mBAAmBgB;eAC9JtB;2BACYA,2BAA2BoB,QAAQD"}

package/dist/prompts/prompt.d.ts

@@ -1,34 +1,43 @@
+import { InputValues, PartialValues } from "../utils/types/index.js";
+import { ContentBlock } from "../messages/content/index.js";
+import { MessageContent } from "../messages/base.js";
+import { TemplateFormat } from "./template.js";
+import { SerializedPromptTemplate } from "./serde.js";
+import { BasePromptTemplateInput, TypedPromptInputValues } from "./base.js";
 import { BaseStringPromptTemplate } from "./string.js";
-import type { BasePromptTemplateInput, TypedPromptInputValues } from "./base.js";
-import { type TemplateFormat } from "./template.js";
-import type { SerializedPromptTemplate } from "./serde.js";
-import type { InputValues, PartialValues } from "../utils/types/index.js";
-import { MessageContent, MessageContentComplex } from "../messages/index.js";
+
+//#region src/prompts/prompt.d.ts
+
 /**
  * Inputs to create a {@link PromptTemplate}
  * @augments BasePromptTemplateInput
  */
-export interface PromptTemplateInput<RunInput extends InputValues = any, PartialVariableName extends string = any, Format extends TemplateFormat = TemplateFormat> extends BasePromptTemplateInput<RunInput, PartialVariableName> {
-    /**
-     * The prompt template
-     */
-    template: MessageContent;
-    /**
-     * The format of the prompt template. Options are "f-string" and "mustache"
-     */
-    templateFormat?: Format;
-    /**
-     * Whether or not to try validating the template on initialization
-     *
-     * @defaultValue `true`
-     */
-    validateTemplate?: boolean;
-    /**
-     * Additional fields which should be included inside
-     * the message content array if using a complex message
-     * content.
-     */
-    additionalContentFields?: MessageContentComplex;
+interface PromptTemplateInput<
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+RunInput extends InputValues = any,
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+PartialVariableName extends string = any, Format extends TemplateFormat = TemplateFormat> extends BasePromptTemplateInput<RunInput, PartialVariableName> {
+  /**
+   * The prompt template
+   */
+  template: MessageContent;
+  /**
+   * The format of the prompt template. Options are "f-string" and "mustache"
+   */
+  templateFormat?: Format;
+  /**
+   * Whether or not to try validating the template on initialization
+   *
+   * @defaultValue `true`
+   */
+  validateTemplate?: boolean;
+  /**
+   * 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
+  additionalContentFields?: ContentBlock;
 }
 type NonAlphanumeric = " " | "\t" | "\n" | "\r" | '"' | "'" | "{" | "[" | "(" | "`" | ":" | ";";
 /**
@@ -36,11 +45,16 @@ type NonAlphanumeric = " " | "\t" | "\n" | "\r" | '"' | "'" | "{" | "[" | "(" |
  * @template T - The input string.
  * @template Result - The resulting array of extracted template parameters.
  */
-type ExtractTemplateParamsRecursive<T extends string, Result extends string[] = []> = T extends `${string}{${infer Param}}${infer Rest}` ? Param extends `${NonAlphanumeric}${string}` ? ExtractTemplateParamsRecursive<Rest, Result> : ExtractTemplateParamsRecursive<Rest, [...Result, Param]> : Result;
-export type ParamsFromFString<T extends string> = {
-    [Key in ExtractTemplateParamsRecursive<T>[number] | (string & Record<never, never>)]: any;
-};
-export type ExtractedFStringParams<T extends string, RunInput extends InputValues = Symbol> = RunInput extends Symbol ? ParamsFromFString<T> : RunInput;
+type ExtractTemplateParamsRecursive<T extends string, Result extends string[] = []> = T extends `${string}{${infer Param}}${infer Rest}` ? Param extends `${NonAlphanumeric}${string}` ? 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
+: ExtractTemplateParamsRecursive<Rest, [...Result, Param]> : Result;
+type ParamsFromFString<T extends string> = { [Key in ExtractTemplateParamsRecursive<T>[number]
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+| (string & Record<never, never>)]: any };
+type ExtractedFStringParams<T extends string,
+// eslint-disable-next-line @typescript-eslint/ban-types
+RunInput extends InputValues = Symbol
+// eslint-disable-next-line @typescript-eslint/ban-types
+> = RunInput extends Symbol ? ParamsFromFString<T> : RunInput;
 /**
  * Schema to represent a basic prompt for an LLM.
  * @augments BasePromptTemplate
@@ -56,52 +70,65 @@ export type ExtractedFStringParams<T extends string, RunInput extends InputValue
  * });
  * ```
  */
-export declare class PromptTemplate<RunInput extends InputValues = any, PartialVariableName extends string = any> extends BaseStringPromptTemplate<RunInput, PartialVariableName> implements PromptTemplateInput<RunInput, PartialVariableName> {
-    static lc_name(): string;
-    template: MessageContent;
-    templateFormat: TemplateFormat;
-    validateTemplate: boolean;
-    /**
-     * Additional fields which should be included inside
-     * the message content array if using a complex message
-     * content.
-     */
-    additionalContentFields?: MessageContentComplex;
-    constructor(input: PromptTemplateInput<RunInput, PartialVariableName>);
-    _getPromptType(): "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.
-     */
-    format(values: TypedPromptInputValues<RunInput>): Promise<string>;
-    /**
-     * 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: string[], suffix: string, inputVariables: string[], exampleSeparator?: string, prefix?: string): PromptTemplate<any, any>;
-    /**
-     * Load prompt template from a template f-string
-     */
-    static fromTemplate<RunInput extends InputValues = Symbol, T extends string = string>(template: T, options?: Omit<PromptTemplateInput<RunInput, string, "f-string">, "template" | "inputVariables">): PromptTemplate<ExtractedFStringParams<T, RunInput>>;
-    static fromTemplate<RunInput extends InputValues = Symbol, T extends string = string>(template: T, options?: Omit<PromptTemplateInput<RunInput, string>, "template" | "inputVariables">): PromptTemplate<ExtractedFStringParams<T, RunInput>>;
-    static fromTemplate<RunInput extends InputValues = Symbol, T extends string = string>(template: T, options?: Omit<PromptTemplateInput<RunInput, string, "mustache">, "template" | "inputVariables">): PromptTemplate<InputValues>;
-    /**
-     * 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.
-     */
-    partial<NewPartialVariableName extends string>(values: PartialValues<NewPartialVariableName>): Promise<PromptTemplate<InputValues<Exclude<Extract<keyof RunInput, string>, NewPartialVariableName>>, any>>;
-    serialize(): SerializedPromptTemplate;
-    static deserialize(data: SerializedPromptTemplate): Promise<PromptTemplate>;
+declare class PromptTemplate<
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+RunInput extends InputValues = any,
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+PartialVariableName extends string = any> extends BaseStringPromptTemplate<RunInput, PartialVariableName> implements PromptTemplateInput<RunInput, PartialVariableName> {
+  static lc_name(): string;
+  template: MessageContent;
+  templateFormat: TemplateFormat;
+  validateTemplate: boolean;
+  /**
+   * 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
+  additionalContentFields?: ContentBlock;
+  constructor(input: PromptTemplateInput<RunInput, PartialVariableName>);
+  _getPromptType(): "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.
+   */
+  format(values: TypedPromptInputValues<RunInput>): Promise<string>;
+  /**
+   * 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: string[], suffix: string, inputVariables: string[], exampleSeparator?: string, prefix?: string): PromptTemplate<any, any>;
+  /**
+   * Load prompt template from a template f-string
+   */
+  static fromTemplate<
+  // eslint-disable-next-line @typescript-eslint/ban-types
+  RunInput extends InputValues = Symbol, T extends string = string>(template: T, options?: Omit<PromptTemplateInput<RunInput, string, "f-string">, "template" | "inputVariables">): PromptTemplate<ExtractedFStringParams<T, RunInput>>;
+  static fromTemplate<
+  // eslint-disable-next-line @typescript-eslint/ban-types
+  RunInput extends InputValues = Symbol, T extends string = string>(template: T, options?: Omit<PromptTemplateInput<RunInput, string>, "template" | "inputVariables">): PromptTemplate<ExtractedFStringParams<T, RunInput>>;
+  static fromTemplate<
+  // eslint-disable-next-line @typescript-eslint/ban-types
+  RunInput extends InputValues = Symbol, T extends string = string>(template: T, options?: Omit<PromptTemplateInput<RunInput, string, "mustache">, "template" | "inputVariables">): PromptTemplate<InputValues>;
+  /**
+   * 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.
+   */
+  partial<NewPartialVariableName extends string>(values: PartialValues<NewPartialVariableName>): Promise<PromptTemplate<InputValues<Exclude<Extract<keyof RunInput, string>, NewPartialVariableName>>, any>>;
+  serialize(): SerializedPromptTemplate;
+  static deserialize(data: SerializedPromptTemplate): Promise<PromptTemplate>;
 }
-export {};
+//#endregion
+export { ExtractedFStringParams, ParamsFromFString, PromptTemplate, PromptTemplateInput };
+//# sourceMappingURL=prompt.d.ts.map

package/dist/prompts/prompt.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"prompt.d.ts","names":["BaseStringPromptTemplate","BasePromptTemplateInput","TypedPromptInputValues","TemplateFormat","SerializedPromptTemplate","InputValues","PartialValues","MessageContent","ContentBlock","PromptTemplateInput","RunInput","PartialVariableName","Format","NonAlphanumeric","ExtractTemplateParamsRecursive","T","Param","Rest","Result","ParamsFromFString","Record","ExtractedFStringParams","Symbol","PromptTemplate","Promise","Omit","NewPartialVariableName","Extract","Exclude"],"sources":["../../src/prompts/prompt.d.ts"],"sourcesContent":["// Default generic \"any\" values are for backwards compatibility.\n// Replace with \"string\" when we are comfortable with a breaking change.\nimport { BaseStringPromptTemplate } from \"./string.js\";\nimport type { BasePromptTemplateInput, TypedPromptInputValues } from \"./base.js\";\nimport { type TemplateFormat } 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 * Inputs to create a {@link PromptTemplate}\n * @augments BasePromptTemplateInput\n */\nexport interface PromptTemplateInput<\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nRunInput extends InputValues = any, \n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nPartialVariableName extends string = any, Format extends TemplateFormat = TemplateFormat> extends BasePromptTemplateInput<RunInput, PartialVariableName> {\n    /**\n     * The prompt template\n     */\n    template: MessageContent;\n    /**\n     * The format of the prompt template. Options are \"f-string\" and \"mustache\"\n     */\n    templateFormat?: Format;\n    /**\n     * Whether or not to try validating the template on initialization\n     *\n     * @defaultValue `true`\n     */\n    validateTemplate?: boolean;\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}\ntype NonAlphanumeric = \" \" | \"\\t\" | \"\\n\" | \"\\r\" | '\"' | \"'\" | \"{\" | \"[\" | \"(\" | \"`\" | \":\" | \";\";\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<T extends string, Result extends string[] = []> = T extends `${string}{${infer Param}}${infer Rest}` ? Param extends `${NonAlphanumeric}${string}` ? 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]> : Result;\nexport type ParamsFromFString<T extends string> = {\n    [Key in ExtractTemplateParamsRecursive<T>[number]\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n     | (string & Record<never, never>)]: any;\n};\nexport type ExtractedFStringParams<T extends string, \n// eslint-disable-next-line @typescript-eslint/ban-types\nRunInput extends InputValues = Symbol\n// eslint-disable-next-line @typescript-eslint/ban-types\n> = RunInput extends Symbol ? ParamsFromFString<T> : RunInput;\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 declare class PromptTemplate<\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nRunInput extends InputValues = any, \n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nPartialVariableName extends string = any> extends BaseStringPromptTemplate<RunInput, PartialVariableName> implements PromptTemplateInput<RunInput, PartialVariableName> {\n    static lc_name(): string;\n    template: MessageContent;\n    templateFormat: TemplateFormat;\n    validateTemplate: boolean;\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    constructor(input: PromptTemplateInput<RunInput, PartialVariableName>);\n    _getPromptType(): \"prompt\";\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    format(values: TypedPromptInputValues<RunInput>): Promise<string>;\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(examples: string[], suffix: string, inputVariables: string[], exampleSeparator?: string, prefix?: string): PromptTemplate<any, any>;\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, T extends string = string>(template: T, options?: Omit<PromptTemplateInput<RunInput, string, \"f-string\">, \"template\" | \"inputVariables\">): PromptTemplate<ExtractedFStringParams<T, RunInput>>;\n    static fromTemplate<\n    // eslint-disable-next-line @typescript-eslint/ban-types\n    RunInput extends InputValues = Symbol, T extends string = string>(template: T, options?: Omit<PromptTemplateInput<RunInput, string>, \"template\" | \"inputVariables\">): PromptTemplate<ExtractedFStringParams<T, RunInput>>;\n    static fromTemplate<\n    // eslint-disable-next-line @typescript-eslint/ban-types\n    RunInput extends InputValues = Symbol, T extends string = string>(template: T, options?: Omit<PromptTemplateInput<RunInput, string, \"mustache\">, \"template\" | \"inputVariables\">): PromptTemplate<InputValues>;\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    partial<NewPartialVariableName extends string>(values: PartialValues<NewPartialVariableName>): Promise<PromptTemplate<InputValues<Exclude<Extract<keyof RunInput, string>, NewPartialVariableName>>, any>>;\n    serialize(): SerializedPromptTemplate;\n    static deserialize(data: SerializedPromptTemplate): Promise<PromptTemplate>;\n}\nexport {};\n"],"mappings":";;;;;;;;;;;AAYA;;;AAIyDG,UAJxCM,mBAIwCN;;iBAFxCE,WAEyGK,GAAAA,GAAAA;;4BAI5GH,MAAAA,GAAAA,GAAAA,EAAAA,eAJ2CJ,cAI3CI,GAJ4DJ,cAI5DI,CAAAA,SAJoFN,uBAIpFM,CAJ4GG,QAI5GH,EAJsHI,mBAItHJ,CAAAA,CAAAA;EAAc;;;EAJ6F,QAAA,EAI3GA,cAJ2G;EAuBpHM;AAAe;;EAMe,cAAmDE,CAAAA,EArBjEH,MAqBiEG;EAAC;;;;;EAAgI,gBACrLE,CAAAA,EAAAA,OAAAA;EAAI;;;;AAA8B;EACxDE;EAAiB,uBAAA,CAAA,EAVCX,YAUD;;KARxBK,eAAAA,GASOC,GAAAA,GAAAA,IAAAA,GAAAA,IAAAA,GAAAA,IAAAA,GAAAA,GAAAA,GAAAA,GAAAA,GAAAA,GAAAA,GAAAA,GAAAA,GAAAA,GAAAA,GAAAA,GAAAA,GAAAA,GAAAA,GAAAA,GAAAA;;AAEW;AAEvB;;;KAPKA,8BAS0BQ,CAAAA,UAAAA,MAAAA,EAAAA,eAAAA,MAAAA,EAAAA,GAAAA,EAAAA,CAAAA,GATuDP,CASvDO,SAAAA,GAAAA,MAAAA,IAAAA,KAAAA,MAAAA,IAAAA,KAAAA,KAAAA,EAAAA,GAT4GN,KAS5GM,SAAAA,GAT6HT,eAS7HS,GAAAA,MAAAA,EAAAA,GAT0JR,8BAS1JQ,CATyLL,IASzLK,EAT+LJ,MAS/LI,CAAAA,CAAAA;AAAAA,EAR5BR,8BAUCJ,CAV8BO,IAU9BP,EAAAA,CAAAA,GAVwCQ,MAUxCR,EAVgDM,KAUhDN,CAAAA,CAAAA,GAV0DQ,MAU1DR;AAAiBY,KATTH,iBASSG,CAAAA,UAAAA,MAAAA,CAAAA,GAAAA,UARTR,8BAQoCC,CARLA,CAQKA,CAAAA,CAAAA,MAAAA;AAAC;AAAA,EAAIL,CAAAA,MAAAA,GANpCU,MAMoCV,CAAAA,KAAAA,EAAAA,KAAAA,CAAAA,CAAAA,GAAAA,GAAAA,EAAQ;AAgBxCa,KApBTF,sBAoBuB,CAAA,UAAA,MAAA;;iBAlBlBhB,WAoBAA,GApBciB;;CAsBoD,GApB/EZ,QAoBiFC,SApBhEW,MAoBgEX,GApBvDQ,iBAoBuDR,CApBrCI,CAoBqCJ,CAAAA,GApBhCD,QAoBgCC;;;;;;;;;;;;;;;;AAuCiCD,cA3CjGa,cA2CiGb;;iBAzCrGL,WAyC4EoB,GAAAA,GAAAA;;4BAAkIf,MAAAA,GAAAA,GAAAA,CAAAA,SAvC7KV,wBAuC6KU,CAvCpJA,QAuCoJA,EAvC1IC,mBAuC0ID,CAAAA,YAvC1GD,mBAuC0GC,CAvCtFA,QAuCsFA,EAvC5EC,mBAuC4ED,CAAAA,CAAAA;EAAQ,OAAlCW,OAAAA,CAAAA,CAAAA,EAAAA,MAAAA;EAAsB,QAArCE,EArCxKhB,cAqCwKgB;EAAc,cAG/KlB,EAvCDF,cAuCCE;EAAW,gBAAGiB,EAAAA,OAAAA;EAAM;;;;;EAAwK;EAAU,uBAAlCD,CAAAA,EA/B3Jb,YA+B2Ja;EAAsB,WAArCE,CAAAA,KAAAA,EA9BnJd,mBA8BmJc,CA9B/Hb,QA8B+Ha,EA9BrHZ,mBA8BqHY,CAAAA;EAAc,cAGnKlB,CAAAA,CAAAA,EAAAA,QAAAA;EAAW;;;;;EAAiE,MAAoGA,CAAAA,MAAAA,EA1BlLH,sBA0BkLG,CA1B3JK,QA0B2JL,CAAAA,CAAAA,EA1B/ImB,OA0B+InB,CAAAA,MAAAA,CAAAA;EAAW;;;;;;;;;;;;;EAQlI,OAAtBmB,YAAAA,CAAAA,QAAAA,EAAAA,MAAAA,EAAAA,EAAAA,MAAAA,EAAAA,MAAAA,EAAAA,cAAAA,EAAAA,MAAAA,EAAAA,EAAAA,gBAAAA,CAAAA,EAAAA,MAAAA,EAAAA,MAAAA,CAAAA,EAAAA,MAAAA,CAAAA,EApB2ED,cAoB3EC,CAAAA,GAAAA,EAAAA,GAAAA,CAAAA;EAAO;;AArDyE;;;mBAuCnHnB,cAAciB,6CAA6CP,aAAaU,KAAKhB,oBAAoBC,gEAAgEa,eAAeF,uBAAuBN,GAAGL;;;mBAG1ML,cAAciB,6CAA6CP,aAAaU,KAAKhB,oBAAoBC,oDAAoDa,eAAeF,uBAAuBN,GAAGL;;;mBAG9LL,cAAciB,6CAA6CP,aAAaU,KAAKhB,oBAAoBC,gEAAgEa,eAAelB;;;;;;yDAM1IC,cAAcoB,0BAA0BF,QAAQD,eAAelB,YAAYuB,QAAQD,cAAcjB,mBAAmBgB;eAC9JtB;2BACYA,2BAA2BoB,QAAQD"}