Interface FewShotChatMessagePromptTemplateInput

Input common to all prompt templates.

interface FewShotChatMessagePromptTemplateInput {
    examplePrompt: BaseMessagePromptTemplate<any, BaseMessage[]> | BaseChatPromptTemplate<any, any>;
    inputVariables: string[];
    exampleSelector?: BaseExampleSelector;
    exampleSeparator?: string;
    examples?: Example[];
    outputParser?: BaseOutputParser<unknown>;
    partialVariables?: PartialValues<any>;
    prefix?: string;
    suffix?: string;
    templateFormat?: "f-string" | "mustache";
    validateTemplate?: boolean;
}

Hierarchy (view full)

Implemented by

Properties

examplePrompt inputVariables exampleSelector? exampleSeparator? examples? outputParser? partialVariables? prefix? suffix? templateFormat? validateTemplate?

Properties

examplePrompt

examplePrompt: BaseMessagePromptTemplate<any, BaseMessage[]> | BaseChatPromptTemplate<any, any>

An BaseMessagePromptTemplate | BaseChatPromptTemplate used to format a single example.

inputVariables

inputVariables: string[]

A list of variable names the prompt template expects

Optional exampleSelector

exampleSelector?: BaseExampleSelector

An BaseExampleSelector Examples to format into the prompt. Exactly one of this or examples must be provided.

Optional exampleSeparator

exampleSeparator?: string

String separator used to join the prefix, the examples, and suffix.

Default Value

"\n\n"

Optional examples

examples?: Example[]

Examples to format into the prompt. Exactly one of this or exampleSelector must be provided.

Optional outputParser

outputParser?: BaseOutputParser<unknown>

How to parse the output of calling an LLM on this formatted prompt

Optional partialVariables

partialVariables?: PartialValues<any>

Partial variables

Optional prefix

prefix?: string

A prompt template string to put before the examples.

Default Value

""

Optional suffix

suffix?: string

A prompt template string to put after the examples.

Default Value

""

Optional templateFormat

templateFormat?: "f-string" | "mustache"

The format of the prompt template. Options are: 'f-string'

Default Value

f-string

Optional validateTemplate

validateTemplate?: boolean

Whether or not to try validating the template on initialization.

Default Value

true

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc