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

Field Summary

Fields

Modifier and Type	Field	Description
protected String	template
protected TemplateFormat	templateFormat

Constructor Summary

Constructors

Constructor	Description
PromptTemplate(String template)
PromptTemplate(String template, Map<String,Object> model)
PromptTemplate(org.springframework.core.io.Resource resource)
PromptTemplate(org.springframework.core.io.Resource resource, Map<String,Object> model)

Method Summary

Modifier and Type	Method	Description
void	add(String name, Object value)
Prompt	create()
Prompt	create(Map<String,Object> model)
Prompt	create(Map<String,Object> model, ChatOptions modelOptions)
Prompt	create(ChatOptions modelOptions)
Message	createMessage()
Message	createMessage(List<Media> mediaList)
Message	createMessage(Map<String,Object> model)
Set<String>	getInputVariables()
String	getTemplate()
TemplateFormat	getTemplateFormat()
String	render()
String	render(Map<String,Object> model)
protected void	validate(Map<String,Object> model)

Methods inherited from class java.lang.Object

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

Field Details

template

protected String template

templateFormat

protected TemplateFormat templateFormat

Constructor Details

PromptTemplate

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

PromptTemplate

public PromptTemplate(String template)

PromptTemplate

public PromptTemplate(String template,
 Map<String,Object> model)

PromptTemplate

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

Method Details

add

public void add(String name,
 Object value)

getTemplate

public String getTemplate()

getTemplateFormat

public TemplateFormat getTemplateFormat()

render

public String render()

Specified by:

render in interface PromptTemplateStringActions

render

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

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> model)

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> model)

Specified by:

create in interface PromptTemplateActions

create

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

Specified by:

create in interface PromptTemplateActions

getInputVariables

public Set<String> getInputVariables()

validate

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