Class: BasePromptTemplate
prompts.BasePromptTemplate
Base class for prompt templates. Exposes a format method that returns a string prompt given a set of input values.
Hierarchy
BasePromptTemplate
Implements
Constructors
constructor
• new BasePromptTemplate(input
)
Parameters
Name | Type |
---|---|
input | BasePromptTemplateInput |
Defined in
langchain/src/prompts/base.ts:57
Properties
inputVariables
• inputVariables: string
[]
A list of variable names the prompt template expects
Implementation of
BasePromptTemplateInput.inputVariables
Defined in
langchain/src/prompts/base.ts:51
outputParser
• Optional
outputParser: BaseOutputParser
How to parse the output of calling an LLM on this formatted prompt
Implementation of
BasePromptTemplateInput.outputParser
Defined in
langchain/src/prompts/base.ts:53
partialVariables
• Optional
partialVariables: InputValues
Partial variables
Implementation of
BasePromptTemplateInput.partialVariables
Defined in
langchain/src/prompts/base.ts:55
Methods
_getPromptType
▸ Abstract
_getPromptType(): string
Return the string type key uniquely identifying this class of prompt template.
Returns
string
Defined in
langchain/src/prompts/base.ts:110
format
▸ Abstract
format(values
): Promise
<string
>
Format the prompt given the input values.
Example
prompt.format({ foo: "bar" });
Parameters
Name | Type | Description |
---|---|---|
values | InputValues | A dictionary of arguments to be passed to the prompt template. |
Returns
Promise
<string
>
A formatted prompt string.
Defined in
langchain/src/prompts/base.ts:98
formatPromptValue
▸ Abstract
formatPromptValue(values
): Promise
<BasePromptValue
>
Format the prompt given the input values and return a formatted prompt value.
Parameters
Name | Type |
---|---|
values | InputValues |
Returns
Promise
<BasePromptValue
>
A formatted PromptValue.
Defined in
langchain/src/prompts/base.ts:105
mergePartialAndUserVariables
▸ mergePartialAndUserVariables(userVariables
): Promise
<InputValues
>
Parameters
Name | Type |
---|---|
userVariables | InputValues |
Returns
Promise
<InputValues
>
Defined in
langchain/src/prompts/base.ts:69
partial
▸ Abstract
partial(values
): Promise
<BasePromptTemplate
>
Parameters
Name | Type |
---|---|
values | PartialValues |
Returns
Promise
<BasePromptTemplate
>
Defined in
langchain/src/prompts/base.ts:67
serialize
▸ Abstract
serialize(): SerializedBasePromptTemplate
Return a json-like object representing this prompt template.
Returns
Defined in
langchain/src/prompts/base.ts:115
deserialize
▸ Static
deserialize(data
): Promise
<BasePromptTemplate
>
Load a prompt template from a json-like object describing it.
Remarks
Deserializing needs to be async because templates (e.g. FewShotPromptTemplate) can reference remote resources that we read asynchronously with a web request.
Parameters
Name | Type |
---|---|
data | SerializedBasePromptTemplate |
Returns
Promise
<BasePromptTemplate
>
Defined in
langchain/src/prompts/base.ts:125