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

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 message, ChatOptions chatOptions)

Method Summary

Modifier and Type	Method	Description
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.
int	hashCode()
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(String contents,
 ChatOptions chatOptions)

Prompt

public Prompt(Message message,
 ChatOptions chatOptions)

Prompt

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

Method Details

getContents

public String getContents()

getOptions

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

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