PromptTemplate

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

Extends

• BasePromptTemplate<TemplatesVar, Vars>

Type Parameters

TemplatesVar

TemplatesVar extends readonly string[] = string[]

Vars

Vars extends readonly string[] = string[]

Template

Template extends StringTemplate<TemplatesVar> = StringTemplate<TemplatesVar>

Constructors

Constructor

new PromptTemplate<TemplatesVar, Vars, Template>(options): PromptTemplate<TemplatesVar, Vars, Template>

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

Parameters

options

PromptTemplateOptions<TemplatesVar, Vars, Template>

Returns

PromptTemplate<TemplatesVar, Vars, Template>

Overrides

BasePromptTemplate.constructor

Properties

metadata

metadata: Metadata = {}

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

Inherited from

BasePromptTemplate.metadata

---

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.

Inherited from

BasePromptTemplate.templateVars

---

options

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

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

Inherited from

BasePromptTemplate.options

---

outputParser

outputParser: undefined | BaseOutputParser<any>

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

Inherited from

BasePromptTemplate.outputParser

---

templateVarMappings

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

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

Inherited from

BasePromptTemplate.templateVarMappings

---

functionMappings

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

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

Inherited from

BasePromptTemplate.functionMappings

---

promptType

promptType: "custom" | "summary" | "insert" | "tree_select" | "tree_select_multiple" | "text_qa" | "refine" | "keyword_extract" | "query_keyword_extract" | "schema_extract" | "text_to_sql" | "text_to_graph_query" | "table_context" | "knowledge_triplet_extract" | "simple_input" | "pandas" | "json_path" | "single_select" | "multi_select" | "vector_store_query" | "sub_question" | "sql_response_synthesis" | "sql_response_synthesis_v2" | "conversation" | "decompose" | "choice_select" | "rankgpt_rerank"

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

Accessors

template

Get Signature

get template(): Template

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

Returns

Template

Overrides

BasePromptTemplate.template

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

Inherited from

BasePromptTemplate.mapTemplateVars

---

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>

Inherited from

BasePromptTemplate.mapFunctionVars

---

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>

Inherited from

BasePromptTemplate.mapAllVars

---

partialFormat()

partialFormat(options): PromptTemplate<TemplatesVar, Vars, Template>

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

Parameters

options

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

Returns

PromptTemplate<TemplatesVar, Vars, Template>

Overrides

BasePromptTemplate.partialFormat

---

format()

format(options?): string

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

Parameters

options?

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

Returns

string

Overrides

BasePromptTemplate.format

---

formatMessages()

formatMessages(options?): ChatMessage[]

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

Parameters

options?

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

Returns

ChatMessage[]

Overrides

BasePromptTemplate.formatMessages

---

vars()

vars(): string[]

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

Returns all the template variables used in the prompt template.

Returns

string[]