Interface ImagePromptTemplateInput<RunInput, PartialVariableName>

Inputs to create a ImagePromptTemplate

interface ImagePromptTemplateInput<RunInput, PartialVariableName> {
    additionalContentFields?: MessageContentComplex;
    inputVariables: Extract<keyof RunInput, string>[];
    outputParser?: BaseOutputParser<unknown>;
    partialVariables?: PartialValues<PartialVariableName>;
    template: Record<string, unknown>;
    templateFormat?: TemplateFormat;
    validateTemplate?: boolean;
}

Type Parameters

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

Hierarchy (view full)

Properties

additionalContentFields? inputVariables outputParser? partialVariables? template templateFormat? validateTemplate?

Properties

OptionaladditionalContentFields

additionalContentFields?: MessageContentComplex

Additional fields which should be included inside the message content array if using a complex message content.

inputVariables

inputVariables: Extract<keyof RunInput, string>[]

A list of variable names the prompt template expects

OptionaloutputParser

outputParser?: BaseOutputParser<unknown>

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

OptionalpartialVariables

partialVariables?: PartialValues<PartialVariableName>

Partial variables

template

template: Record<string, unknown>

The prompt template

OptionaltemplateFormat

templateFormat?: TemplateFormat

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

Default Value

'f-string'

OptionalvalidateTemplate

validateTemplate?: boolean

Whether or not to try validating the template on initialization

Default Value

true

Settings

Member Visibility

On This Page

Properties