Package org.springframework.ai.chat.prompt

Class Prompt

java.lang.Object

org.springframework.ai.chat.prompt.Prompt

All Implemented Interfaces:

ModelRequest<List<Message>>

public class Prompt
extends Object
implements ModelRequest<List<Message>>

The Prompt class represents a prompt used in AI model requests. A prompt consists of one or more messages and additional chat options.

Author:

Mark Pollack, luocongqiu, Thomas Vitale

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Prompt.Builder

Constructor Summary

Constructors

Constructor	Description
Prompt(String contents)
Prompt(String contents, ChatOptions chatOptions)
Prompt(List<Message> messages)
Prompt(List<Message> messages, ChatOptions chatOptions)
Prompt(Message message)
Prompt(Message... messages)
Prompt(Message message, ChatOptions chatOptions)

Method Summary

Modifier and Type	Method	Description
Prompt	augmentUserMessage(String newUserText)	Creates a copy of the prompt, replacing the text content of the last UserMessage with the provided text.
Prompt	augmentUserMessage(Function<UserMessage,UserMessage> userMessageAugmenter)
static Prompt.Builder	builder()
Prompt	copy()
boolean	equals(Object o)
String	getContents()
List<Message>	getInstructions()	Retrieves the instructions or input required by the AI model.
ChatOptions	getOptions()	Retrieves the customizable options for AI model interactions.
UserMessage	getUserMessage()	Get the last user message in the prompt.
int	hashCode()
Prompt.Builder	mutate()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Prompt

public Prompt(String contents)

Prompt

public Prompt(Message message)

Prompt

public Prompt(List<Message> messages)

Prompt

public Prompt(Message... messages)

Prompt

public Prompt(String contents,
 @Nullable
 ChatOptions chatOptions)

Prompt

public Prompt(Message message,
 @Nullable
 ChatOptions chatOptions)

Prompt

public Prompt(List<Message> messages,
 @Nullable
 ChatOptions chatOptions)

Method Details

getContents

public String getContents()

getOptions

@Nullable
public ChatOptions getOptions()

Description copied from interface: ModelRequest

Retrieves the customizable options for AI model interactions.

Specified by:

getOptions in interface ModelRequest<List<Message>>

Returns:

the customizable options for AI model interactions

getInstructions

public List<Message> getInstructions()

Description copied from interface: ModelRequest

Retrieves the instructions or input required by the AI model.

Specified by:

getInstructions in interface ModelRequest<List<Message>>

Returns:

the instructions or input required by the AI model

getUserMessage

public UserMessage getUserMessage()

Get the last user message in the prompt. If no user message is found, an empty UserMessage is returned.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

copy

public Prompt copy()

augmentUserMessage

public Prompt augmentUserMessage(Function<UserMessage,UserMessage> userMessageAugmenter)

Parameters:

userMessageAugmenter - the function to augment the last user message.

Returns:

a new prompt instance with the augmented user message.

augmentUserMessage

public Prompt augmentUserMessage(String newUserText)

Creates a copy of the prompt, replacing the text content of the last UserMessage with the provided text. If no UserMessage exists, a new one with the given text is added.

Parameters:

newUserText - The new text content for the last user message.

Returns:

A new Prompt instance with the augmented user message text.

mutate

public Prompt.Builder mutate()

builder

public static Prompt.Builder builder()