Skip to content
LlamaIndex TypeScript API Reference

BasePromptTemplateOptions

BasePromptTemplateOptions<TemplatesVar, Vars> = object

Defined in: .build/typescript/packages/core/src/prompts/base.ts:11

Type Parameters

Section titled “Type Parameters”

TemplatesVar

Section titled “TemplatesVar”

TemplatesVar extends readonly string[]

Vars

Section titled “Vars”

Vars extends readonly string[]

Properties

Section titled “Properties”

metadata?

Section titled “metadata?”

optional metadata: Metadata

Defined in: .build/typescript/packages/core/src/prompts/base.ts:15

templateVars?

Section titled “templateVars?”

optional templateVars: TemplatesVar | readonly string[]

Defined in: .build/typescript/packages/core/src/prompts/base.ts:16

options?

Section titled “options?”

optional options: Partial<Record<TemplatesVar[number] | string & object, string>>

Defined in: .build/typescript/packages/core/src/prompts/base.ts:20

outputParser?

Section titled “outputParser?”

optional outputParser: BaseOutputParser

Defined in: .build/typescript/packages/core/src/prompts/base.ts:21

templateVarMappings?

Section titled “templateVarMappings?”

optional templateVarMappings: Partial<Record<Vars[number] | string & object, TemplatesVar[number] | string & object>>

Defined in: .build/typescript/packages/core/src/prompts/base.ts:22

functionMappings?

Section titled “functionMappings?”

optional functionMappings: Partial<Record<TemplatesVar[number] | string & object, MappingFn>>

Defined in: .build/typescript/packages/core/src/prompts/base.ts:25