BasePromptTemplate

Defined in: packages/core/src/prompts/base.ts:30

Extended by

• PromptTemplate

Type Parameters

TemplatesVar

TemplatesVar extends readonly string[] = string[]

Vars

Vars extends readonly string[] = string[]

Constructors

Constructor

protected new BasePromptTemplate<TemplatesVar, Vars>(options): BasePromptTemplate<TemplatesVar, Vars>

Defined in: packages/core/src/prompts/base.ts:49

Parameters

options

BasePromptTemplateOptions<TemplatesVar, Vars>

Returns

BasePromptTemplate<TemplatesVar, Vars>

Properties

metadata

metadata: Metadata = {}

Defined in: packages/core/src/prompts/base.ts:34

---

templateVars

templateVars: Set<string>

Defined in: packages/core/src/prompts/base.ts:39

Set of template variables used in the prompt template. Used for type hints only. To get the list of template variables used in the prompt at run-time, use the vars method.

---

options

options: Partial<Record<string & object | TemplatesVar[number], string>> = {}

Defined in: packages/core/src/prompts/base.ts:40

---

outputParser

outputParser: undefined | BaseOutputParser<any>

Defined in: packages/core/src/prompts/base.ts:41

---

templateVarMappings

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

Defined in: packages/core/src/prompts/base.ts:42

---

functionMappings

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

Defined in: packages/core/src/prompts/base.ts:45

Accessors

template

Get Signature

get abstract template(): string

Defined in: packages/core/src/prompts/base.ts:123

Returns

string

Methods

mapTemplateVars()

protected mapTemplateVars(options): object

Defined in: packages/core/src/prompts/base.ts:77

Parameters

options

Record<string & object | TemplatesVar[number], string>

Returns

object

---

mapFunctionVars()

protected mapFunctionVars(options): Record<TemplatesVar[number], string>

Defined in: packages/core/src/prompts/base.ts:86

Parameters

options

Record<string & object | TemplatesVar[number], string>

Returns

Record<TemplatesVar[number], string>

---

mapAllVars()

protected mapAllVars(options): Record<string, string>

Defined in: packages/core/src/prompts/base.ts:104

Parameters

options

Record<string & object | TemplatesVar[number], string>

Returns

Record<string, string>

---

partialFormat()

abstract partialFormat(options): BasePromptTemplate<TemplatesVar, Vars>

Defined in: packages/core/src/prompts/base.ts:111

Parameters

options

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

Returns

BasePromptTemplate<TemplatesVar, Vars>

---

format()

abstract format(options?): string

Defined in: packages/core/src/prompts/base.ts:115

Parameters

options?

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

Returns

string

---

formatMessages()

abstract formatMessages(options?): ChatMessage[]

Defined in: packages/core/src/prompts/base.ts:119

Parameters

options?

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

Returns

ChatMessage[]