Class AbstractMessage

java.lang.Object

org.springframework.ai.chat.messages.AbstractMessage

All Implemented Interfaces:

Message, Content

Direct Known Subclasses:

AssistantMessage, SystemMessage, ToolResponseMessage, UserMessage

public abstract class AbstractMessage
extends Object
implements Message

The AbstractMessage class is an abstract implementation of the Message interface. It provides a base implementation for message content, media attachments, metadata, and message type.

See Also:

• Message

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MESSAGE_TYPE	The key for the message type in the metadata.
protected final MessageType	messageType	The message type of the message.
protected final Map<String,Object>	metadata	Additional options for the message to influence the response, not a generative map.
protected final String	textContent	The content of the message.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractMessage(MessageType messageType, String textContent, Map<String,Object> metadata)	Create a new AbstractMessage with the given message type, text content, and metadata.
protected	AbstractMessage(MessageType messageType, org.springframework.core.io.Resource resource, Map<String,Object> metadata)	Create a new AbstractMessage with the given message type, resource, and metadata.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
MessageType	getMessageType()	Get the message type of the message.
Map<String,Object>	getMetadata()	Get the metadata of the message.
String	getText()	Get the content of the message.
int	hashCode()

Methods inherited from class Object

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

Field Details

MESSAGE_TYPE

public static final String MESSAGE_TYPE

The key for the message type in the metadata.

See Also:

• Constant Field Values

messageType

protected final MessageType messageType

The message type of the message.

textContent

@Nullable
protected final String textContent

The content of the message.

metadata

protected final Map<String,Object> metadata

Additional options for the message to influence the response, not a generative map.

Constructor Details

AbstractMessage

protected AbstractMessage(MessageType messageType,
 @Nullable
 String textContent,
 Map<String,Object> metadata)

Create a new AbstractMessage with the given message type, text content, and metadata.

Parameters:

messageType - the message type

textContent - the text content

metadata - the metadata

AbstractMessage

protected AbstractMessage(MessageType messageType,
 org.springframework.core.io.Resource resource,
 Map<String,Object> metadata)

Create a new AbstractMessage with the given message type, resource, and metadata.

Parameters:

messageType - the message type

resource - the resource

metadata - the metadata

Method Details

getText

@Nullable
public String getText()

Get the content of the message.

Specified by:

getText in interface Content

Returns:

the content of the message

getMetadata

public Map<String,Object> getMetadata()

Get the metadata of the message.

Specified by:

getMetadata in interface Content

Returns:

the metadata of the message

getMessageType

public MessageType getMessageType()

Get the message type of the message.

Specified by:

getMessageType in interface Message

Returns:

the message type of the message

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object