@langchain/core 0.3.72 → 1.0.0-alpha.2

package/dist/prompts/few_shot.d.cts

@@ -0,0 +1,204 @@
+import { InputValues, PartialValues } from "../utils/types/index.cjs";
+import { BaseMessage } from "../messages/base.cjs";
+import { TemplateFormat } from "./template.cjs";
+import { SerializedFewShotTemplate } from "./serde.cjs";
+import { BasePromptTemplateInput, Example, TypedPromptInputValues } from "./base.cjs";
+import { BaseExampleSelector } from "../example_selectors/base.cjs";
+import { BaseStringPromptTemplate } from "./string.cjs";
+import { PromptTemplate } from "./prompt.cjs";
+import { BaseChatPromptTemplate, BaseMessagePromptTemplate } from "./chat.cjs";
+
+//#region src/prompts/few_shot.d.ts
+interface FewShotPromptTemplateInput extends BasePromptTemplateInput<InputValues> {
+  /**
+   * Examples to format into the prompt. Exactly one of this or
+   * {@link exampleSelector} must be
+   * provided.
+   */
+  examples?: Example[];
+  /**
+   * An {@link BaseExampleSelector} Examples to format into the prompt. Exactly one of this or
+   * {@link examples} must be
+   * provided.
+   */
+  exampleSelector?: BaseExampleSelector;
+  /**
+   * An {@link PromptTemplate} used to format a single example.
+   */
+  examplePrompt: PromptTemplate;
+  /**
+   * String separator used to join the prefix, the examples, and suffix.
+   */
+  exampleSeparator?: string;
+  /**
+   * A prompt template string to put before the examples.
+   *
+   * @defaultValue `""`
+   */
+  prefix?: string;
+  /**
+   * A prompt template string to put after the examples.
+   */
+  suffix?: string;
+  /**
+   * The format of the prompt template. Options are: 'f-string'
+   */
+  templateFormat?: TemplateFormat;
+  /**
+   * Whether or not to try validating the template on initialization.
+   */
+  validateTemplate?: boolean;
+}
+/**
+ * Prompt template that contains few-shot examples.
+ * @augments BasePromptTemplate
+ * @augments FewShotPromptTemplateInput
+ * @example
+ * ```typescript
+ * const examplePrompt = PromptTemplate.fromTemplate(
+ *   "Input: {input}\nOutput: {output}",
+ * );
+ *
+ * const exampleSelector = await SemanticSimilarityExampleSelector.fromExamples(
+ *   [
+ *     { input: "happy", output: "sad" },
+ *     { input: "tall", output: "short" },
+ *     { input: "energetic", output: "lethargic" },
+ *     { input: "sunny", output: "gloomy" },
+ *     { input: "windy", output: "calm" },
+ *   ],
+ *   new OpenAIEmbeddings(),
+ *   HNSWLib,
+ *   { k: 1 },
+ * );
+ *
+ * const dynamicPrompt = new FewShotPromptTemplate({
+ *   exampleSelector,
+ *   examplePrompt,
+ *   prefix: "Give the antonym of every input",
+ *   suffix: "Input: {adjective}\nOutput:",
+ *   inputVariables: ["adjective"],
+ * });
+ *
+ * // Format the dynamic prompt with the input 'rainy'
+ * console.log(await dynamicPrompt.format({ adjective: "rainy" }));
+ *
+ * ```
+ */
+declare class FewShotPromptTemplate extends BaseStringPromptTemplate implements FewShotPromptTemplateInput {
+  lc_serializable: boolean;
+  examples?: InputValues[];
+  exampleSelector?: BaseExampleSelector | undefined;
+  examplePrompt: PromptTemplate;
+  suffix: string;
+  exampleSeparator: string;
+  prefix: string;
+  templateFormat: TemplateFormat;
+  validateTemplate: boolean;
+  constructor(input: FewShotPromptTemplateInput);
+  _getPromptType(): "few_shot";
+  static lc_name(): string;
+  private getExamples;
+  partial<NewPartialVariableName extends string>(values: PartialValues<NewPartialVariableName>): Promise<FewShotPromptTemplate>;
+  /**
+   * Formats the prompt with the given values.
+   * @param values The values to format the prompt with.
+   * @returns A promise that resolves to a string representing the formatted prompt.
+   */
+  format(values: InputValues): Promise<string>;
+  serialize(): SerializedFewShotTemplate;
+  static deserialize(data: SerializedFewShotTemplate): Promise<FewShotPromptTemplate>;
+}
+interface FewShotChatMessagePromptTemplateInput extends BasePromptTemplateInput<InputValues> {
+  /**
+   * Examples to format into the prompt. Exactly one of this or
+   * {@link exampleSelector} must be
+   * provided.
+   */
+  examples?: Example[];
+  /**
+   * An {@link BaseMessagePromptTemplate} | {@link BaseChatPromptTemplate} used to format a single example.
+   */
+  examplePrompt: BaseMessagePromptTemplate | BaseChatPromptTemplate;
+  /**
+   * String separator used to join the prefix, the examples, and suffix.
+   *
+   * @defaultValue `"\n\n"`
+   */
+  exampleSeparator?: string;
+  /**
+   * An {@link BaseExampleSelector} Examples to format into the prompt. Exactly one of this or
+   * {@link examples} must be
+   * provided.
+   */
+  exampleSelector?: BaseExampleSelector | undefined;
+  /**
+   * A prompt template string to put before the examples.
+   *
+   * @defaultValue `""`
+   */
+  prefix?: string;
+  /**
+   * A prompt template string to put after the examples.
+   *
+   * @defaultValue `""`
+   */
+  suffix?: string;
+  /**
+   * The format of the prompt template. Options are: 'f-string'
+   *
+   * @defaultValue `f-string`
+   */
+  templateFormat?: TemplateFormat;
+  /**
+   * Whether or not to try validating the template on initialization.
+   *
+   * @defaultValue `true`
+   */
+  validateTemplate?: boolean;
+}
+/**
+ * Chat prompt template that contains few-shot examples.
+ * @augments BasePromptTemplateInput
+ * @augments FewShotChatMessagePromptTemplateInput
+ */
+declare class FewShotChatMessagePromptTemplate<
+// 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 BaseChatPromptTemplate implements FewShotChatMessagePromptTemplateInput {
+  lc_serializable: boolean;
+  examples?: InputValues[];
+  exampleSelector?: BaseExampleSelector | undefined;
+  examplePrompt: BaseMessagePromptTemplate | BaseChatPromptTemplate;
+  suffix: string;
+  exampleSeparator: string;
+  prefix: string;
+  templateFormat: TemplateFormat;
+  validateTemplate: boolean;
+  _getPromptType(): "few_shot_chat";
+  static lc_name(): string;
+  constructor(fields: FewShotChatMessagePromptTemplateInput);
+  private getExamples;
+  /**
+   * Formats the list of values and returns a list of formatted messages.
+   * @param values The values to format the prompt with.
+   * @returns A promise that resolves to a string representing the formatted prompt.
+   */
+  formatMessages(values: TypedPromptInputValues<RunInput>): Promise<BaseMessage[]>;
+  /**
+   * Formats the prompt with the given values.
+   * @param values The values to format the prompt with.
+   * @returns A promise that resolves to a string representing the formatted prompt.
+   */
+  format(values: TypedPromptInputValues<RunInput>): Promise<string>;
+  /**
+   * Partially formats the prompt with the given values.
+   * @param values The values to partially format the prompt with.
+   * @returns A promise that resolves to an instance of `FewShotChatMessagePromptTemplate` with the given values partially formatted.
+   */
+  partial(values: PartialValues<PartialVariableName>): Promise<FewShotChatMessagePromptTemplate<RunInput, PartialVariableName>>;
+}
+//#endregion
+export { FewShotChatMessagePromptTemplate, FewShotChatMessagePromptTemplateInput, FewShotPromptTemplate, FewShotPromptTemplateInput };
+//# sourceMappingURL=few_shot.d.cts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"few_shot.d.cts","names":["BaseStringPromptTemplate","BasePromptTemplateInput","TypedPromptInputValues","Example","BaseExampleSelector","TemplateFormat","PromptTemplate","SerializedFewShotTemplate","InputValues","PartialValues","BaseMessage","BaseChatPromptTemplate","BaseMessagePromptTemplate","FewShotPromptTemplateInput","FewShotPromptTemplate","NewPartialVariableName","Promise","FewShotChatMessagePromptTemplateInput","FewShotChatMessagePromptTemplate","RunInput","PartialVariableName"],"sources":["../../src/prompts/few_shot.d.ts"],"sourcesContent":["import { BaseStringPromptTemplate } from \"./string.js\";\nimport type { BasePromptTemplateInput, TypedPromptInputValues, Example } from \"./base.js\";\nimport type { BaseExampleSelector } from \"../example_selectors/base.js\";\nimport { type TemplateFormat } from \"./template.js\";\nimport { PromptTemplate } from \"./prompt.js\";\nimport type { SerializedFewShotTemplate } from \"./serde.js\";\nimport type { InputValues, PartialValues } from \"../utils/types/index.js\";\nimport type { BaseMessage } from \"../messages/index.js\";\nimport { BaseChatPromptTemplate, type BaseMessagePromptTemplate } from \"./chat.js\";\nexport interface FewShotPromptTemplateInput extends BasePromptTemplateInput<InputValues> {\n    /**\n     * Examples to format into the prompt. Exactly one of this or\n     * {@link exampleSelector} must be\n     * provided.\n     */\n    examples?: Example[];\n    /**\n     * An {@link BaseExampleSelector} Examples to format into the prompt. Exactly one of this or\n     * {@link examples} must be\n     * provided.\n     */\n    exampleSelector?: BaseExampleSelector;\n    /**\n     * An {@link PromptTemplate} used to format a single example.\n     */\n    examplePrompt: PromptTemplate;\n    /**\n     * String separator used to join the prefix, the examples, and suffix.\n     */\n    exampleSeparator?: string;\n    /**\n     * A prompt template string to put before the examples.\n     *\n     * @defaultValue `\"\"`\n     */\n    prefix?: string;\n    /**\n     * A prompt template string to put after the examples.\n     */\n    suffix?: string;\n    /**\n     * The format of the prompt template. Options are: 'f-string'\n     */\n    templateFormat?: TemplateFormat;\n    /**\n     * Whether or not to try validating the template on initialization.\n     */\n    validateTemplate?: boolean;\n}\n/**\n * Prompt template that contains few-shot examples.\n * @augments BasePromptTemplate\n * @augments FewShotPromptTemplateInput\n * @example\n * ```typescript\n * const examplePrompt = PromptTemplate.fromTemplate(\n *   \"Input: {input}\\nOutput: {output}\",\n * );\n *\n * const exampleSelector = await SemanticSimilarityExampleSelector.fromExamples(\n *   [\n *     { input: \"happy\", output: \"sad\" },\n *     { input: \"tall\", output: \"short\" },\n *     { input: \"energetic\", output: \"lethargic\" },\n *     { input: \"sunny\", output: \"gloomy\" },\n *     { input: \"windy\", output: \"calm\" },\n *   ],\n *   new OpenAIEmbeddings(),\n *   HNSWLib,\n *   { k: 1 },\n * );\n *\n * const dynamicPrompt = new FewShotPromptTemplate({\n *   exampleSelector,\n *   examplePrompt,\n *   prefix: \"Give the antonym of every input\",\n *   suffix: \"Input: {adjective}\\nOutput:\",\n *   inputVariables: [\"adjective\"],\n * });\n *\n * // Format the dynamic prompt with the input 'rainy'\n * console.log(await dynamicPrompt.format({ adjective: \"rainy\" }));\n *\n * ```\n */\nexport declare class FewShotPromptTemplate extends BaseStringPromptTemplate implements FewShotPromptTemplateInput {\n    lc_serializable: boolean;\n    examples?: InputValues[];\n    exampleSelector?: BaseExampleSelector | undefined;\n    examplePrompt: PromptTemplate;\n    suffix: string;\n    exampleSeparator: string;\n    prefix: string;\n    templateFormat: TemplateFormat;\n    validateTemplate: boolean;\n    constructor(input: FewShotPromptTemplateInput);\n    _getPromptType(): \"few_shot\";\n    static lc_name(): string;\n    private getExamples;\n    partial<NewPartialVariableName extends string>(values: PartialValues<NewPartialVariableName>): Promise<FewShotPromptTemplate>;\n    /**\n     * Formats the prompt with the given values.\n     * @param values The values to format the prompt with.\n     * @returns A promise that resolves to a string representing the formatted prompt.\n     */\n    format(values: InputValues): Promise<string>;\n    serialize(): SerializedFewShotTemplate;\n    static deserialize(data: SerializedFewShotTemplate): Promise<FewShotPromptTemplate>;\n}\nexport interface FewShotChatMessagePromptTemplateInput extends BasePromptTemplateInput<InputValues> {\n    /**\n     * Examples to format into the prompt. Exactly one of this or\n     * {@link exampleSelector} must be\n     * provided.\n     */\n    examples?: Example[];\n    /**\n     * An {@link BaseMessagePromptTemplate} | {@link BaseChatPromptTemplate} used to format a single example.\n     */\n    examplePrompt: BaseMessagePromptTemplate | BaseChatPromptTemplate;\n    /**\n     * String separator used to join the prefix, the examples, and suffix.\n     *\n     * @defaultValue `\"\\n\\n\"`\n     */\n    exampleSeparator?: string;\n    /**\n     * An {@link BaseExampleSelector} Examples to format into the prompt. Exactly one of this or\n     * {@link examples} must be\n     * provided.\n     */\n    exampleSelector?: BaseExampleSelector | undefined;\n    /**\n     * A prompt template string to put before the examples.\n     *\n     * @defaultValue `\"\"`\n     */\n    prefix?: string;\n    /**\n     * A prompt template string to put after the examples.\n     *\n     * @defaultValue `\"\"`\n     */\n    suffix?: string;\n    /**\n     * The format of the prompt template. Options are: 'f-string'\n     *\n     * @defaultValue `f-string`\n     */\n    templateFormat?: TemplateFormat;\n    /**\n     * Whether or not to try validating the template on initialization.\n     *\n     * @defaultValue `true`\n     */\n    validateTemplate?: boolean;\n}\n/**\n * Chat prompt template that contains few-shot examples.\n * @augments BasePromptTemplateInput\n * @augments FewShotChatMessagePromptTemplateInput\n */\nexport declare class FewShotChatMessagePromptTemplate<\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 BaseChatPromptTemplate implements FewShotChatMessagePromptTemplateInput {\n    lc_serializable: boolean;\n    examples?: InputValues[];\n    exampleSelector?: BaseExampleSelector | undefined;\n    examplePrompt: BaseMessagePromptTemplate | BaseChatPromptTemplate;\n    suffix: string;\n    exampleSeparator: string;\n    prefix: string;\n    templateFormat: TemplateFormat;\n    validateTemplate: boolean;\n    _getPromptType(): \"few_shot_chat\";\n    static lc_name(): string;\n    constructor(fields: FewShotChatMessagePromptTemplateInput);\n    private getExamples;\n    /**\n     * Formats the list of values and returns a list of formatted messages.\n     * @param values The values to format the prompt with.\n     * @returns A promise that resolves to a string representing the formatted prompt.\n     */\n    formatMessages(values: TypedPromptInputValues<RunInput>): Promise<BaseMessage[]>;\n    /**\n     * Formats the prompt with the given values.\n     * @param values The values to format the prompt with.\n     * @returns A promise that resolves to a string representing the formatted prompt.\n     */\n    format(values: TypedPromptInputValues<RunInput>): Promise<string>;\n    /**\n     * Partially formats the prompt with the given values.\n     * @param values The values to partially format the prompt with.\n     * @returns A promise that resolves to an instance of `FewShotChatMessagePromptTemplate` with the given values partially formatted.\n     */\n    partial(values: PartialValues<PartialVariableName>): Promise<FewShotChatMessagePromptTemplate<RunInput, PartialVariableName>>;\n}\n"],"mappings":";;;;;;;;;;;UASiBa,0BAAAA,SAAmCZ,wBAAwBO;;AAA5E;;;;EAMsB,QAMAJ,CAAAA,EANPD,OAMOC,EAAAA;EAAmB;;;AAZkC;AA4E3E;EAA0C,eAAA,CAAA,EAhEpBA,mBAgEoB;EAAA;;;EAIT,aAIbC,EApEDC,cAoECD;EAAc;;;EAMsC,gBAAmCS,CAAAA,EAAAA,MAAAA;EAAqB;;;;;EAQ1E,MAAWA,CAAAA,EAAAA,MAAAA;EAAqB;;;EAtB2B,MAAA,CAAA,EAAA,MAAA;EAwBhGG;;;EAAiF,cAMnFd,CAAAA,EAxEME,cAwENF;EAAO;;;EAgBmB,gBAkBpBE,CAAAA,EAAAA,OAAAA;;AAxCiE;AAqDtF;;;;;;;;;;;;;;;;;;;;;;;;AAIyH;;;;;;;;;;;cAjFpGS,qBAAAA,SAA8Bd,wBAAAA,YAAoCa;;aAExEL;oBACOJ;iBACHE;;;;kBAICD;;qBAEGQ;;;;yDAIoCJ,cAAcM,0BAA0BC,QAAQF;;;;;;iBAMxFN,cAAcQ;eAChBT;2BACYA,4BAA4BS,QAAQF;;UAEhDG,qCAAAA,SAA8ChB,wBAAwBO;;;;;;aAMxEL;;;;iBAIIS,4BAA4BD;;;;;;;;;;;;oBAYzBP;;;;;;;;;;;;;;;;;;mBAkBDC;;;;;;;;;;;;;cAaAa;;iBAEJV;;kDAEiCG,sBAAAA,YAAkCM;;aAErET;oBACOJ;iBACHQ,4BAA4BD;;;;kBAI3BN;;;;sBAIIY;;;;;;;yBAOGf,uBAAuBiB,YAAYH,QAAQN;;;;;;iBAMnDR,uBAAuBiB,YAAYH;;;;;;kBAMlCP,cAAcW,uBAAuBJ,QAAQE,iCAAiCC,UAAUC"}

package/dist/prompts/few_shot.d.ts

@@ -1,51 +1,53 @@
+import { InputValues, PartialValues } from "../utils/types/index.js";
+import { BaseMessage } from "../messages/base.js";
+import { TemplateFormat } from "./template.js";
+import { SerializedFewShotTemplate } from "./serde.js";
+import { BasePromptTemplateInput, Example, TypedPromptInputValues } from "./base.js";
+import { BaseExampleSelector } from "../example_selectors/base.js";
 import { BaseStringPromptTemplate } from "./string.js";
-import type { BasePromptTemplateInput, TypedPromptInputValues, Example } from "./base.js";
-import type { BaseExampleSelector } from "../example_selectors/base.js";
-import { type TemplateFormat } from "./template.js";
 import { PromptTemplate } from "./prompt.js";
-import type { SerializedFewShotTemplate } from "./serde.js";
-import type { InputValues, PartialValues } from "../utils/types/index.js";
-import type { BaseMessage } from "../messages/index.js";
-import { BaseChatPromptTemplate, type BaseMessagePromptTemplate } from "./chat.js";
-export interface FewShotPromptTemplateInput extends BasePromptTemplateInput<InputValues> {
-    /**
-     * Examples to format into the prompt. Exactly one of this or
-     * {@link exampleSelector} must be
-     * provided.
-     */
-    examples?: Example[];
-    /**
-     * An {@link BaseExampleSelector} Examples to format into the prompt. Exactly one of this or
-     * {@link examples} must be
-     * provided.
-     */
-    exampleSelector?: BaseExampleSelector;
-    /**
-     * An {@link PromptTemplate} used to format a single example.
-     */
-    examplePrompt: PromptTemplate;
-    /**
-     * String separator used to join the prefix, the examples, and suffix.
-     */
-    exampleSeparator?: string;
-    /**
-     * A prompt template string to put before the examples.
-     *
-     * @defaultValue `""`
-     */
-    prefix?: string;
-    /**
-     * A prompt template string to put after the examples.
-     */
-    suffix?: string;
-    /**
-     * The format of the prompt template. Options are: 'f-string'
-     */
-    templateFormat?: TemplateFormat;
-    /**
-     * Whether or not to try validating the template on initialization.
-     */
-    validateTemplate?: boolean;
+import { BaseChatPromptTemplate, BaseMessagePromptTemplate } from "./chat.js";
+
+//#region src/prompts/few_shot.d.ts
+interface FewShotPromptTemplateInput extends BasePromptTemplateInput<InputValues> {
+  /**
+   * Examples to format into the prompt. Exactly one of this or
+   * {@link exampleSelector} must be
+   * provided.
+   */
+  examples?: Example[];
+  /**
+   * An {@link BaseExampleSelector} Examples to format into the prompt. Exactly one of this or
+   * {@link examples} must be
+   * provided.
+   */
+  exampleSelector?: BaseExampleSelector;
+  /**
+   * An {@link PromptTemplate} used to format a single example.
+   */
+  examplePrompt: PromptTemplate;
+  /**
+   * String separator used to join the prefix, the examples, and suffix.
+   */
+  exampleSeparator?: string;
+  /**
+   * A prompt template string to put before the examples.
+   *
+   * @defaultValue `""`
+   */
+  prefix?: string;
+  /**
+   * A prompt template string to put after the examples.
+   */
+  suffix?: string;
+  /**
+   * The format of the prompt template. Options are: 'f-string'
+   */
+  templateFormat?: TemplateFormat;
+  /**
+   * Whether or not to try validating the template on initialization.
+   */
+  validateTemplate?: boolean;
 }
 /**
  * Prompt template that contains few-shot examples.
@@ -83,113 +85,120 @@ export interface FewShotPromptTemplateInput extends BasePromptTemplateInput<Inpu
  *
  * ```
  */
-export declare class FewShotPromptTemplate extends BaseStringPromptTemplate implements FewShotPromptTemplateInput {
-    lc_serializable: boolean;
-    examples?: InputValues[];
-    exampleSelector?: BaseExampleSelector | undefined;
-    examplePrompt: PromptTemplate;
-    suffix: string;
-    exampleSeparator: string;
-    prefix: string;
-    templateFormat: TemplateFormat;
-    validateTemplate: boolean;
-    constructor(input: FewShotPromptTemplateInput);
-    _getPromptType(): "few_shot";
-    static lc_name(): string;
-    private getExamples;
-    partial<NewPartialVariableName extends string>(values: PartialValues<NewPartialVariableName>): Promise<FewShotPromptTemplate>;
-    /**
-     * Formats the prompt with the given values.
-     * @param values The values to format the prompt with.
-     * @returns A promise that resolves to a string representing the formatted prompt.
-     */
-    format(values: InputValues): Promise<string>;
-    serialize(): SerializedFewShotTemplate;
-    static deserialize(data: SerializedFewShotTemplate): Promise<FewShotPromptTemplate>;
+declare class FewShotPromptTemplate extends BaseStringPromptTemplate implements FewShotPromptTemplateInput {
+  lc_serializable: boolean;
+  examples?: InputValues[];
+  exampleSelector?: BaseExampleSelector | undefined;
+  examplePrompt: PromptTemplate;
+  suffix: string;
+  exampleSeparator: string;
+  prefix: string;
+  templateFormat: TemplateFormat;
+  validateTemplate: boolean;
+  constructor(input: FewShotPromptTemplateInput);
+  _getPromptType(): "few_shot";
+  static lc_name(): string;
+  private getExamples;
+  partial<NewPartialVariableName extends string>(values: PartialValues<NewPartialVariableName>): Promise<FewShotPromptTemplate>;
+  /**
+   * Formats the prompt with the given values.
+   * @param values The values to format the prompt with.
+   * @returns A promise that resolves to a string representing the formatted prompt.
+   */
+  format(values: InputValues): Promise<string>;
+  serialize(): SerializedFewShotTemplate;
+  static deserialize(data: SerializedFewShotTemplate): Promise<FewShotPromptTemplate>;
 }
-export interface FewShotChatMessagePromptTemplateInput extends BasePromptTemplateInput<InputValues> {
-    /**
-     * Examples to format into the prompt. Exactly one of this or
-     * {@link exampleSelector} must be
-     * provided.
-     */
-    examples?: Example[];
-    /**
-     * An {@link BaseMessagePromptTemplate} | {@link BaseChatPromptTemplate} used to format a single example.
-     */
-    examplePrompt: BaseMessagePromptTemplate | BaseChatPromptTemplate;
-    /**
-     * String separator used to join the prefix, the examples, and suffix.
-     *
-     * @defaultValue `"\n\n"`
-     */
-    exampleSeparator?: string;
-    /**
-     * An {@link BaseExampleSelector} Examples to format into the prompt. Exactly one of this or
-     * {@link examples} must be
-     * provided.
-     */
-    exampleSelector?: BaseExampleSelector | undefined;
-    /**
-     * A prompt template string to put before the examples.
-     *
-     * @defaultValue `""`
-     */
-    prefix?: string;
-    /**
-     * A prompt template string to put after the examples.
-     *
-     * @defaultValue `""`
-     */
-    suffix?: string;
-    /**
-     * The format of the prompt template. Options are: 'f-string'
-     *
-     * @defaultValue `f-string`
-     */
-    templateFormat?: TemplateFormat;
-    /**
-     * Whether or not to try validating the template on initialization.
-     *
-     * @defaultValue `true`
-     */
-    validateTemplate?: boolean;
+interface FewShotChatMessagePromptTemplateInput extends BasePromptTemplateInput<InputValues> {
+  /**
+   * Examples to format into the prompt. Exactly one of this or
+   * {@link exampleSelector} must be
+   * provided.
+   */
+  examples?: Example[];
+  /**
+   * An {@link BaseMessagePromptTemplate} | {@link BaseChatPromptTemplate} used to format a single example.
+   */
+  examplePrompt: BaseMessagePromptTemplate | BaseChatPromptTemplate;
+  /**
+   * String separator used to join the prefix, the examples, and suffix.
+   *
+   * @defaultValue `"\n\n"`
+   */
+  exampleSeparator?: string;
+  /**
+   * An {@link BaseExampleSelector} Examples to format into the prompt. Exactly one of this or
+   * {@link examples} must be
+   * provided.
+   */
+  exampleSelector?: BaseExampleSelector | undefined;
+  /**
+   * A prompt template string to put before the examples.
+   *
+   * @defaultValue `""`
+   */
+  prefix?: string;
+  /**
+   * A prompt template string to put after the examples.
+   *
+   * @defaultValue `""`
+   */
+  suffix?: string;
+  /**
+   * The format of the prompt template. Options are: 'f-string'
+   *
+   * @defaultValue `f-string`
+   */
+  templateFormat?: TemplateFormat;
+  /**
+   * Whether or not to try validating the template on initialization.
+   *
+   * @defaultValue `true`
+   */
+  validateTemplate?: boolean;
 }
 /**
  * Chat prompt template that contains few-shot examples.
  * @augments BasePromptTemplateInput
  * @augments FewShotChatMessagePromptTemplateInput
  */
-export declare class FewShotChatMessagePromptTemplate<RunInput extends InputValues = any, PartialVariableName extends string = any> extends BaseChatPromptTemplate implements FewShotChatMessagePromptTemplateInput {
-    lc_serializable: boolean;
-    examples?: InputValues[];
-    exampleSelector?: BaseExampleSelector | undefined;
-    examplePrompt: BaseMessagePromptTemplate | BaseChatPromptTemplate;
-    suffix: string;
-    exampleSeparator: string;
-    prefix: string;
-    templateFormat: TemplateFormat;
-    validateTemplate: boolean;
-    _getPromptType(): "few_shot_chat";
-    static lc_name(): string;
-    constructor(fields: FewShotChatMessagePromptTemplateInput);
-    private getExamples;
-    /**
-     * Formats the list of values and returns a list of formatted messages.
-     * @param values The values to format the prompt with.
-     * @returns A promise that resolves to a string representing the formatted prompt.
-     */
-    formatMessages(values: TypedPromptInputValues<RunInput>): Promise<BaseMessage[]>;
-    /**
-     * Formats the prompt with the given values.
-     * @param values The values to format the prompt with.
-     * @returns A promise that resolves to a string representing the formatted prompt.
-     */
-    format(values: TypedPromptInputValues<RunInput>): Promise<string>;
-    /**
-     * Partially formats the prompt with the given values.
-     * @param values The values to partially format the prompt with.
-     * @returns A promise that resolves to an instance of `FewShotChatMessagePromptTemplate` with the given values partially formatted.
-     */
-    partial(values: PartialValues<PartialVariableName>): Promise<FewShotChatMessagePromptTemplate<RunInput, PartialVariableName>>;
+declare class FewShotChatMessagePromptTemplate<
+// 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 BaseChatPromptTemplate implements FewShotChatMessagePromptTemplateInput {
+  lc_serializable: boolean;
+  examples?: InputValues[];
+  exampleSelector?: BaseExampleSelector | undefined;
+  examplePrompt: BaseMessagePromptTemplate | BaseChatPromptTemplate;
+  suffix: string;
+  exampleSeparator: string;
+  prefix: string;
+  templateFormat: TemplateFormat;
+  validateTemplate: boolean;
+  _getPromptType(): "few_shot_chat";
+  static lc_name(): string;
+  constructor(fields: FewShotChatMessagePromptTemplateInput);
+  private getExamples;
+  /**
+   * Formats the list of values and returns a list of formatted messages.
+   * @param values The values to format the prompt with.
+   * @returns A promise that resolves to a string representing the formatted prompt.
+   */
+  formatMessages(values: TypedPromptInputValues<RunInput>): Promise<BaseMessage[]>;
+  /**
+   * Formats the prompt with the given values.
+   * @param values The values to format the prompt with.
+   * @returns A promise that resolves to a string representing the formatted prompt.
+   */
+  format(values: TypedPromptInputValues<RunInput>): Promise<string>;
+  /**
+   * Partially formats the prompt with the given values.
+   * @param values The values to partially format the prompt with.
+   * @returns A promise that resolves to an instance of `FewShotChatMessagePromptTemplate` with the given values partially formatted.
+   */
+  partial(values: PartialValues<PartialVariableName>): Promise<FewShotChatMessagePromptTemplate<RunInput, PartialVariableName>>;
 }
+//#endregion
+export { FewShotChatMessagePromptTemplate, FewShotChatMessagePromptTemplateInput, FewShotPromptTemplate, FewShotPromptTemplateInput };
+//# sourceMappingURL=few_shot.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"few_shot.d.ts","names":["BaseStringPromptTemplate","BasePromptTemplateInput","TypedPromptInputValues","Example","BaseExampleSelector","TemplateFormat","PromptTemplate","SerializedFewShotTemplate","InputValues","PartialValues","BaseMessage","BaseChatPromptTemplate","BaseMessagePromptTemplate","FewShotPromptTemplateInput","FewShotPromptTemplate","NewPartialVariableName","Promise","FewShotChatMessagePromptTemplateInput","FewShotChatMessagePromptTemplate","RunInput","PartialVariableName"],"sources":["../../src/prompts/few_shot.d.ts"],"sourcesContent":["import { BaseStringPromptTemplate } from \"./string.js\";\nimport type { BasePromptTemplateInput, TypedPromptInputValues, Example } from \"./base.js\";\nimport type { BaseExampleSelector } from \"../example_selectors/base.js\";\nimport { type TemplateFormat } from \"./template.js\";\nimport { PromptTemplate } from \"./prompt.js\";\nimport type { SerializedFewShotTemplate } from \"./serde.js\";\nimport type { InputValues, PartialValues } from \"../utils/types/index.js\";\nimport type { BaseMessage } from \"../messages/index.js\";\nimport { BaseChatPromptTemplate, type BaseMessagePromptTemplate } from \"./chat.js\";\nexport interface FewShotPromptTemplateInput extends BasePromptTemplateInput<InputValues> {\n    /**\n     * Examples to format into the prompt. Exactly one of this or\n     * {@link exampleSelector} must be\n     * provided.\n     */\n    examples?: Example[];\n    /**\n     * An {@link BaseExampleSelector} Examples to format into the prompt. Exactly one of this or\n     * {@link examples} must be\n     * provided.\n     */\n    exampleSelector?: BaseExampleSelector;\n    /**\n     * An {@link PromptTemplate} used to format a single example.\n     */\n    examplePrompt: PromptTemplate;\n    /**\n     * String separator used to join the prefix, the examples, and suffix.\n     */\n    exampleSeparator?: string;\n    /**\n     * A prompt template string to put before the examples.\n     *\n     * @defaultValue `\"\"`\n     */\n    prefix?: string;\n    /**\n     * A prompt template string to put after the examples.\n     */\n    suffix?: string;\n    /**\n     * The format of the prompt template. Options are: 'f-string'\n     */\n    templateFormat?: TemplateFormat;\n    /**\n     * Whether or not to try validating the template on initialization.\n     */\n    validateTemplate?: boolean;\n}\n/**\n * Prompt template that contains few-shot examples.\n * @augments BasePromptTemplate\n * @augments FewShotPromptTemplateInput\n * @example\n * ```typescript\n * const examplePrompt = PromptTemplate.fromTemplate(\n *   \"Input: {input}\\nOutput: {output}\",\n * );\n *\n * const exampleSelector = await SemanticSimilarityExampleSelector.fromExamples(\n *   [\n *     { input: \"happy\", output: \"sad\" },\n *     { input: \"tall\", output: \"short\" },\n *     { input: \"energetic\", output: \"lethargic\" },\n *     { input: \"sunny\", output: \"gloomy\" },\n *     { input: \"windy\", output: \"calm\" },\n *   ],\n *   new OpenAIEmbeddings(),\n *   HNSWLib,\n *   { k: 1 },\n * );\n *\n * const dynamicPrompt = new FewShotPromptTemplate({\n *   exampleSelector,\n *   examplePrompt,\n *   prefix: \"Give the antonym of every input\",\n *   suffix: \"Input: {adjective}\\nOutput:\",\n *   inputVariables: [\"adjective\"],\n * });\n *\n * // Format the dynamic prompt with the input 'rainy'\n * console.log(await dynamicPrompt.format({ adjective: \"rainy\" }));\n *\n * ```\n */\nexport declare class FewShotPromptTemplate extends BaseStringPromptTemplate implements FewShotPromptTemplateInput {\n    lc_serializable: boolean;\n    examples?: InputValues[];\n    exampleSelector?: BaseExampleSelector | undefined;\n    examplePrompt: PromptTemplate;\n    suffix: string;\n    exampleSeparator: string;\n    prefix: string;\n    templateFormat: TemplateFormat;\n    validateTemplate: boolean;\n    constructor(input: FewShotPromptTemplateInput);\n    _getPromptType(): \"few_shot\";\n    static lc_name(): string;\n    private getExamples;\n    partial<NewPartialVariableName extends string>(values: PartialValues<NewPartialVariableName>): Promise<FewShotPromptTemplate>;\n    /**\n     * Formats the prompt with the given values.\n     * @param values The values to format the prompt with.\n     * @returns A promise that resolves to a string representing the formatted prompt.\n     */\n    format(values: InputValues): Promise<string>;\n    serialize(): SerializedFewShotTemplate;\n    static deserialize(data: SerializedFewShotTemplate): Promise<FewShotPromptTemplate>;\n}\nexport interface FewShotChatMessagePromptTemplateInput extends BasePromptTemplateInput<InputValues> {\n    /**\n     * Examples to format into the prompt. Exactly one of this or\n     * {@link exampleSelector} must be\n     * provided.\n     */\n    examples?: Example[];\n    /**\n     * An {@link BaseMessagePromptTemplate} | {@link BaseChatPromptTemplate} used to format a single example.\n     */\n    examplePrompt: BaseMessagePromptTemplate | BaseChatPromptTemplate;\n    /**\n     * String separator used to join the prefix, the examples, and suffix.\n     *\n     * @defaultValue `\"\\n\\n\"`\n     */\n    exampleSeparator?: string;\n    /**\n     * An {@link BaseExampleSelector} Examples to format into the prompt. Exactly one of this or\n     * {@link examples} must be\n     * provided.\n     */\n    exampleSelector?: BaseExampleSelector | undefined;\n    /**\n     * A prompt template string to put before the examples.\n     *\n     * @defaultValue `\"\"`\n     */\n    prefix?: string;\n    /**\n     * A prompt template string to put after the examples.\n     *\n     * @defaultValue `\"\"`\n     */\n    suffix?: string;\n    /**\n     * The format of the prompt template. Options are: 'f-string'\n     *\n     * @defaultValue `f-string`\n     */\n    templateFormat?: TemplateFormat;\n    /**\n     * Whether or not to try validating the template on initialization.\n     *\n     * @defaultValue `true`\n     */\n    validateTemplate?: boolean;\n}\n/**\n * Chat prompt template that contains few-shot examples.\n * @augments BasePromptTemplateInput\n * @augments FewShotChatMessagePromptTemplateInput\n */\nexport declare class FewShotChatMessagePromptTemplate<\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 BaseChatPromptTemplate implements FewShotChatMessagePromptTemplateInput {\n    lc_serializable: boolean;\n    examples?: InputValues[];\n    exampleSelector?: BaseExampleSelector | undefined;\n    examplePrompt: BaseMessagePromptTemplate | BaseChatPromptTemplate;\n    suffix: string;\n    exampleSeparator: string;\n    prefix: string;\n    templateFormat: TemplateFormat;\n    validateTemplate: boolean;\n    _getPromptType(): \"few_shot_chat\";\n    static lc_name(): string;\n    constructor(fields: FewShotChatMessagePromptTemplateInput);\n    private getExamples;\n    /**\n     * Formats the list of values and returns a list of formatted messages.\n     * @param values The values to format the prompt with.\n     * @returns A promise that resolves to a string representing the formatted prompt.\n     */\n    formatMessages(values: TypedPromptInputValues<RunInput>): Promise<BaseMessage[]>;\n    /**\n     * Formats the prompt with the given values.\n     * @param values The values to format the prompt with.\n     * @returns A promise that resolves to a string representing the formatted prompt.\n     */\n    format(values: TypedPromptInputValues<RunInput>): Promise<string>;\n    /**\n     * Partially formats the prompt with the given values.\n     * @param values The values to partially format the prompt with.\n     * @returns A promise that resolves to an instance of `FewShotChatMessagePromptTemplate` with the given values partially formatted.\n     */\n    partial(values: PartialValues<PartialVariableName>): Promise<FewShotChatMessagePromptTemplate<RunInput, PartialVariableName>>;\n}\n"],"mappings":";;;;;;;;;;;UASiBa,0BAAAA,SAAmCZ,wBAAwBO;;AAA5E;;;;EAMsB,QAMAJ,CAAAA,EANPD,OAMOC,EAAAA;EAAmB;;;AAZkC;AA4E3E;EAA0C,eAAA,CAAA,EAhEpBA,mBAgEoB;EAAA;;;EAIT,aAIbC,EApEDC,cAoECD;EAAc;;;EAMsC,gBAAmCS,CAAAA,EAAAA,MAAAA;EAAqB;;;;;EAQ1E,MAAWA,CAAAA,EAAAA,MAAAA;EAAqB;;;EAtB2B,MAAA,CAAA,EAAA,MAAA;EAwBhGG;;;EAAiF,cAMnFd,CAAAA,EAxEME,cAwENF;EAAO;;;EAgBmB,gBAkBpBE,CAAAA,EAAAA,OAAAA;;AAxCiE;AAqDtF;;;;;;;;;;;;;;;;;;;;;;;;AAIyH;;;;;;;;;;;cAjFpGS,qBAAAA,SAA8Bd,wBAAAA,YAAoCa;;aAExEL;oBACOJ;iBACHE;;;;kBAICD;;qBAEGQ;;;;yDAIoCJ,cAAcM,0BAA0BC,QAAQF;;;;;;iBAMxFN,cAAcQ;eAChBT;2BACYA,4BAA4BS,QAAQF;;UAEhDG,qCAAAA,SAA8ChB,wBAAwBO;;;;;;aAMxEL;;;;iBAIIS,4BAA4BD;;;;;;;;;;;;oBAYzBP;;;;;;;;;;;;;;;;;;mBAkBDC;;;;;;;;;;;;;cAaAa;;iBAEJV;;kDAEiCG,sBAAAA,YAAkCM;;aAErET;oBACOJ;iBACHQ,4BAA4BD;;;;kBAI3BN;;;;sBAIIY;;;;;;;yBAOGf,uBAAuBiB,YAAYH,QAAQN;;;;;;iBAMnDR,uBAAuBiB,YAAYH;;;;;;kBAMlCP,cAAcW,uBAAuBJ,QAAQE,iCAAiCC,UAAUC"}