A prompt template for creating prompts with variables.
The PromptTemplate class allows users to define a template string with
variables represented in curly braces {variable}. The variable
names cannot contain spaces and must start with a letter or underscore,
followed by letters, digits, or underscore. These variables can be
replaced with specific values using the assemble method, providing
flexibility in generating dynamic prompts.
Usage:
```
template_str = "Hello, {name}! Today is {day}. How are you?"
prompt_template = PromptTemplate(template_str)
completed_prompt = prompt_template.assemble(name="John", day="Monday")
print(completed_prompt)
```
Methods
PromptTemplate
PromptTemplate(template:str)
Initializes the PromptTemplate with a given template.
__repr__
__repr__()-> str
Returns a string representation of the PromptTemplate.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[],[],null,["# Class PromptTemplate (1.95.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.95.1 (latest)](/python/docs/reference/vertexai/latest/vertexai.evaluation.PromptTemplate)\n- [1.94.0](/python/docs/reference/vertexai/1.94.0/vertexai.evaluation.PromptTemplate)\n- [1.93.1](/python/docs/reference/vertexai/1.93.1/vertexai.evaluation.PromptTemplate)\n- [1.92.0](/python/docs/reference/vertexai/1.92.0/vertexai.evaluation.PromptTemplate)\n- [1.91.0](/python/docs/reference/vertexai/1.91.0/vertexai.evaluation.PromptTemplate)\n- [1.90.0](/python/docs/reference/vertexai/1.90.0/vertexai.evaluation.PromptTemplate)\n- [1.89.0](/python/docs/reference/vertexai/1.89.0/vertexai.evaluation.PromptTemplate)\n- [1.88.0](/python/docs/reference/vertexai/1.88.0/vertexai.evaluation.PromptTemplate)\n- [1.87.0](/python/docs/reference/vertexai/1.87.0/vertexai.evaluation.PromptTemplate)\n- [1.86.0](/python/docs/reference/vertexai/1.86.0/vertexai.evaluation.PromptTemplate)\n- [1.85.0](/python/docs/reference/vertexai/1.85.0/vertexai.evaluation.PromptTemplate)\n- [1.84.0](/python/docs/reference/vertexai/1.84.0/vertexai.evaluation.PromptTemplate)\n- [1.83.0](/python/docs/reference/vertexai/1.83.0/vertexai.evaluation.PromptTemplate)\n- [1.82.0](/python/docs/reference/vertexai/1.82.0/vertexai.evaluation.PromptTemplate)\n- [1.81.0](/python/docs/reference/vertexai/1.81.0/vertexai.evaluation.PromptTemplate)\n- [1.80.0](/python/docs/reference/vertexai/1.80.0/vertexai.evaluation.PromptTemplate)\n- [1.79.0](/python/docs/reference/vertexai/1.79.0/vertexai.evaluation.PromptTemplate)\n- [1.78.0](/python/docs/reference/vertexai/1.78.0/vertexai.evaluation.PromptTemplate)\n- [1.77.0](/python/docs/reference/vertexai/1.77.0/vertexai.evaluation.PromptTemplate)\n- [1.76.0](/python/docs/reference/vertexai/1.76.0/vertexai.evaluation.PromptTemplate)\n- [1.75.0](/python/docs/reference/vertexai/1.75.0/vertexai.evaluation.PromptTemplate)\n- [1.74.0](/python/docs/reference/vertexai/1.74.0/vertexai.evaluation.PromptTemplate)\n- [1.73.0](/python/docs/reference/vertexai/1.73.0/vertexai.evaluation.PromptTemplate)\n- [1.72.0](/python/docs/reference/vertexai/1.72.0/vertexai.evaluation.PromptTemplate)\n- [1.71.1](/python/docs/reference/vertexai/1.71.1/vertexai.evaluation.PromptTemplate)\n- [1.70.0](/python/docs/reference/vertexai/1.70.0/vertexai.evaluation.PromptTemplate)\n- [1.69.0](/python/docs/reference/vertexai/1.69.0/vertexai.evaluation.PromptTemplate)\n- [1.68.0](/python/docs/reference/vertexai/1.68.0/vertexai.evaluation.PromptTemplate)\n- [1.67.1](/python/docs/reference/vertexai/1.67.1/vertexai.evaluation.PromptTemplate)\n- [1.66.0](/python/docs/reference/vertexai/1.66.0/vertexai.evaluation.PromptTemplate)\n- [1.65.0](/python/docs/reference/vertexai/1.65.0/vertexai.evaluation.PromptTemplate)\n- [1.63.0](/python/docs/reference/vertexai/1.63.0/vertexai.evaluation.PromptTemplate)\n- [1.62.0](/python/docs/reference/vertexai/1.62.0/vertexai.evaluation.PromptTemplate)\n- [1.60.0](/python/docs/reference/vertexai/1.60.0/vertexai.evaluation.PromptTemplate)\n- [1.59.0](/python/docs/reference/vertexai/1.59.0/vertexai.evaluation.PromptTemplate) \n\n PromptTemplate(template: str)\n\nA prompt template for creating prompts with variables.\n\nThe `PromptTemplate` class allows users to define a template string with\nvariables represented in curly braces `{variable}`. The variable\nnames cannot contain spaces and must start with a letter or underscore,\nfollowed by letters, digits, or underscore. These variables can be\nreplaced with specific values using the `assemble` method, providing\nflexibility in generating dynamic prompts.\n\nUsage: \n\n ```\n template_str = \"Hello, {name}! Today is {day}. How are you?\"\n prompt_template = PromptTemplate(template_str)\n completed_prompt = prompt_template.assemble(name=\"John\", day=\"Monday\")\n print(completed_prompt)\n ```\n\nMethods\n-------\n\n### PromptTemplate\n\n PromptTemplate(template: str)\n\nInitializes the PromptTemplate with a given template.\n\n### __repr__\n\n __repr__() -\u003e str\n\nReturns a string representation of the PromptTemplate.\n\n### __str__\n\n __str__() -\u003e str\n\nReturns the template string.\n\n### assemble\n\n assemble(**kwargs) -\u003e vertexai.evaluation.prompt_template.PromptTemplate\n\nReplaces only the provided variables in the template with specific values."]]