Interface PromptTemplateInput<RunInput, PartialVariableName, Format>

Inputs to create a PromptTemplate

interface PromptTemplateInput<RunInput, PartialVariableName, Format> {
    inputVariables: Extract<keyof RunInput, string>[];
    template: MessageContent;
    outputParser?: BaseOutputParser<unknown>;
    partialVariables?: PartialValues<PartialVariableName>;
    templateFormat?: Format;
    validateTemplate?: boolean;
}

Type Parameters

RunInput extends InputValues = any
PartialVariableName extends string = any
Format extends TemplateFormat = TemplateFormat

Hierarchy (view full)

BasePromptTemplateInput<RunInput, PartialVariableName>
- PromptTemplateInput

Implemented by

PromptTemplate

Index

Properties

inputVariables template outputParser? partialVariables? templateFormat? validateTemplate?

Properties

inputVariables

inputVariables: Extract<keyof RunInput, string>[]

A list of variable names the prompt template expects

template

template: MessageContent

The prompt template

`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` templateFormat

templateFormat?: Format

The format of the prompt template. Options are "f-string" and "mustache"

`Optional` validateTemplate

validateTemplate?: boolean

Whether or not to try validating the template on initialization

Default Value

true

Generated using TypeDoc