Interface StructuredPromptInput<RunInput, PartialVariableName>

Interface for the input of a ChatPromptTemplate.

interface StructuredPromptInput<RunInput, PartialVariableName> {
    inputVariables: Extract<keyof RunInput, string>[];
    promptMessages: (BaseMessage | BaseMessagePromptTemplate<any, BaseMessage[]>)[];
    schema: Record<string, any>;
    outputParser?: BaseOutputParser<unknown>;
    partialVariables?: PartialValues<PartialVariableName>;
    templateFormat?: TemplateFormat;
    validateTemplate?: boolean;
}

Type Parameters

  • RunInput extends InputValues = any
  • PartialVariableName extends string = any

Hierarchy (view full)

Implemented by

Properties

inputVariables promptMessages schema outputParser? partialVariables? templateFormat? validateTemplate?

Properties

inputVariables

inputVariables: Extract<keyof RunInput, string>[]

A list of variable names the prompt template expects

promptMessages

promptMessages: (BaseMessage | BaseMessagePromptTemplate<any, BaseMessage[]>)[]

The prompt messages

schema

schema: Record<string, any>

OptionaloutputParser

outputParser?: BaseOutputParser<unknown>

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

OptionalpartialVariables

partialVariables?: PartialValues<PartialVariableName>

Partial variables

OptionaltemplateFormat

templateFormat?: TemplateFormat

The formatting method to use on the prompt.

Default

"f-string"

OptionalvalidateTemplate

validateTemplate?: boolean

Whether to try validating the template on initialization

Default Value

true

Settings

Member Visibility

On This Page

Properties