Package org.springframework.ai.chat.prompt

Class PromptTemplate

java.lang.Object

org.springframework.ai.chat.prompt.PromptTemplate

All Implemented Interfaces:

PromptTemplateActions, PromptTemplateMessageActions, PromptTemplateStringActions

Direct Known Subclasses:

AssistantPromptTemplate, FunctionPromptTemplate, SystemPromptTemplate

public class PromptTemplate
extends Object
implements PromptTemplateActions, PromptTemplateMessageActions

A template for creating prompts. It allows you to define a template string with placeholders for variables, and then render the template with specific values for those variables.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PromptTemplate.Builder

Field Summary

Fields

Modifier and Type	Field	Description
protected String	template	Deprecated. will become private in the next release.
protected TemplateFormat	templateFormat	Deprecated. in favor of TemplateRenderer

Constructor Summary

Constructors

Constructor	Description
PromptTemplate(String template)
PromptTemplate(String template, Map<String,Object> variables)	Deprecated. in favor of builder().
PromptTemplate(org.springframework.core.io.Resource resource)
PromptTemplate(org.springframework.core.io.Resource resource, Map<String,Object> variables)	Deprecated. in fahvor of builder().

Method Summary

Modifier and Type	Method	Description
void	add(String name, Object value)
static PromptTemplate.Builder	builder()
Prompt	create()
Prompt	create(Map<String,Object> additionalVariables)
Prompt	create(Map<String,Object> additionalVariables, ChatOptions modelOptions)
Prompt	create(ChatOptions modelOptions)
Message	createMessage()
Message	createMessage(List<Media> mediaList)
Message	createMessage(Map<String,Object> additionalVariables)
Set<String>	getInputVariables()	Deprecated. in favor of TemplateRenderer.
String	getTemplate()
TemplateFormat	getTemplateFormat()	Deprecated. in favor of TemplateRenderer
PromptTemplate.Builder	mutate()
String	render()
String	render(Map<String,Object> additionalVariables)
protected void	validate(Map<String,Object> model)	Deprecated. in favor of TemplateRenderer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

template

@Deprecated
protected String template

Deprecated.

will become private in the next release. If you're subclassing this class, re-consider using the built-in implementation together with the new PromptTemplateRenderer interface, designed to give you more flexibility and control over the rendering process.

templateFormat

@Deprecated
protected TemplateFormat templateFormat

Deprecated.

in favor of TemplateRenderer

Constructor Details

PromptTemplate

public PromptTemplate(org.springframework.core.io.Resource resource)

PromptTemplate

public PromptTemplate(String template)

PromptTemplate

@Deprecated
public PromptTemplate(String template,
 Map<String,Object> variables)

Deprecated.

in favor of builder().

PromptTemplate

@Deprecated
public PromptTemplate(org.springframework.core.io.Resource resource,
 Map<String,Object> variables)

Deprecated.

in fahvor of builder().

Method Details

add

public void add(String name,
 Object value)

getTemplate

public String getTemplate()

getTemplateFormat

@Deprecated
public TemplateFormat getTemplateFormat()

Deprecated.

in favor of TemplateRenderer

render

public String render()

Specified by:

render in interface PromptTemplateStringActions

render

public String render(Map<String,Object> additionalVariables)

Specified by:

render in interface PromptTemplateStringActions

createMessage

public Message createMessage()

Specified by:

createMessage in interface PromptTemplateMessageActions

createMessage

public Message createMessage(List<Media> mediaList)

Specified by:

createMessage in interface PromptTemplateMessageActions

createMessage

public Message createMessage(Map<String,Object> additionalVariables)

Specified by:

createMessage in interface PromptTemplateMessageActions

create

public Prompt create()

Specified by:

create in interface PromptTemplateActions

create

public Prompt create(ChatOptions modelOptions)

Specified by:

create in interface PromptTemplateActions

create

public Prompt create(Map<String,Object> additionalVariables)

Specified by:

create in interface PromptTemplateActions

create

public Prompt create(Map<String,Object> additionalVariables,
 ChatOptions modelOptions)

Specified by:

create in interface PromptTemplateActions

getInputVariables

@Deprecated
public Set<String> getInputVariables()

Deprecated.

in favor of TemplateRenderer.

validate

@Deprecated
protected void validate(Map<String,Object> model)

Deprecated.

in favor of TemplateRenderer.

mutate

public PromptTemplate.Builder mutate()

builder

public static PromptTemplate.Builder builder()