Interface ChatPromptTemplateInput<RunInput, PartialVariableName>

Interface for the input of a ChatPromptTemplate.

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

Type Parameters

RunInput extends InputValues = any
PartialVariableName extends string = any

Hierarchy (view full)

BasePromptTemplateInput<RunInput, PartialVariableName>
- ChatPromptTemplateInput
  - StructuredPromptInput

Implemented by

ChatPromptTemplate

Index

Properties

inputVariables promptMessages outputParser? partialVariables? 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

`Optional` outputParser

outputParser?: BaseOutputParser<unknown>

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

`Optional` partialVariables

partialVariables?: PartialValues<PartialVariableName>

Partial variables

`Optional` validateTemplate

validateTemplate?: boolean

Whether to try validating the template on initialization

Default Value

true

Generated using TypeDoc