import { BasePromptValue, Example, HumanMessage, InputValues, PartialValues } from "../schema/index.js"; import { BaseOutputParser } from "../schema/output_parser.js"; import { Serializable } from "../load/serializable.js"; import { SerializedBasePromptTemplate } from "./serde.js"; import { SerializedFields } from "../load/map_keys.js"; import { Runnable } from "../schema/runnable/index.js"; import { BaseCallbackConfig } from "../callbacks/manager.js"; export type TypedPromptInputValues = InputValues | (string & Record)>; /** * Represents a prompt value as a string. It extends the BasePromptValue * class and overrides the toString and toChatMessages methods. */ export declare class StringPromptValue extends BasePromptValue { lc_namespace: string[]; value: string; constructor(value: string); toString(): string; toChatMessages(): HumanMessage[]; } /** * Input common to all prompt templates. */ export interface BasePromptTemplateInput { /** * A list of variable names the prompt template expects */ inputVariables: Array>; /** * How to parse the output of calling an LLM on this formatted prompt */ outputParser?: BaseOutputParser; /** Partial variables */ partialVariables?: PartialValues; } /** * Base class for prompt templates. Exposes a format method that returns a * string prompt given a set of input values. */ export declare abstract class BasePromptTemplate extends Runnable implements BasePromptTemplateInput { PromptValueReturnType: RunOutput; lc_serializable: boolean; lc_namespace: string[]; get lc_attributes(): SerializedFields | undefined; inputVariables: Array>; outputParser?: BaseOutputParser; partialVariables: PartialValues; constructor(input: BasePromptTemplateInput); abstract partial(values: PartialValues): Promise>; /** * Merges partial variables and user variables. * @param userVariables The user variables to merge with the partial variables. * @returns A Promise that resolves to an object containing the merged variables. */ mergePartialAndUserVariables(userVariables: TypedPromptInputValues): Promise | PartialVariableName>>; /** * Invokes the prompt template with the given input and options. * @param input The input to invoke the prompt template with. * @param options Optional configuration for the callback. * @returns A Promise that resolves to the output of the prompt template. */ invoke(input: RunInput, options?: BaseCallbackConfig): Promise; /** * Format the prompt given the input values. * * @param values - A dictionary of arguments to be passed to the prompt template. * @returns A formatted prompt string. * * @example * ```ts * prompt.format({ foo: "bar" }); * ``` */ abstract format(values: TypedPromptInputValues): Promise; /** * Format the prompt given the input values and return a formatted prompt value. * @param values * @returns A formatted PromptValue. */ abstract formatPromptValue(values: TypedPromptInputValues): Promise; /** * Return the string type key uniquely identifying this class of prompt template. */ abstract _getPromptType(): string; /** * Return a json-like object representing this prompt template. * @deprecated */ serialize(): SerializedBasePromptTemplate; /** * @deprecated * Load a prompt template from a json-like object describing it. * * @remarks * Deserializing needs to be async because templates (e.g. {@link FewShotPromptTemplate}) can * reference remote resources that we read asynchronously with a web * request. */ static deserialize(data: SerializedBasePromptTemplate): Promise>; } /** * Base class for string prompt templates. It extends the * BasePromptTemplate class and overrides the formatPromptValue method to * return a StringPromptValue. */ export declare abstract class BaseStringPromptTemplate extends BasePromptTemplate { /** * Formats the prompt given the input values and returns a formatted * prompt value. * @param values The input values to format the prompt. * @returns A Promise that resolves to a formatted prompt value. */ formatPromptValue(values: TypedPromptInputValues): Promise; } /** * Base class for example selectors. */ export declare abstract class BaseExampleSelector extends Serializable { lc_namespace: string[]; /** * Adds an example to the example selector. * @param example The example to add to the example selector. * @returns A Promise that resolves to void or a string. */ abstract addExample(example: Example): Promise; /** * Selects examples from the example selector given the input variables. * @param input_variables The input variables to select examples with. * @returns A Promise that resolves to an array of selected examples. */ abstract selectExamples(input_variables: Example): Promise; }