Package org.springframework.ai.chat.messages

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 @Nullable String	textContent	Deprecated, for removal: This API element is subject to removal in a future version. since 2.1.0 in favor of getText(); kept so existing subclasses that read the field keep compiling.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractMessage(MessageType messageType, @Nullable String textContent, Map<String,Object> metadata)	Create a new AbstractMessage with the given message type, text content, and metadata.
protected	AbstractMessage(MessageType messageType, List<MessagePart> parts, Map<String,Object> metadata)	Create a new AbstractMessage from an ordered list of parts.

Method Summary

Modifier and Type	Method	Description
boolean	equals(@Nullable Object o)
protected static int	firstIndexOf(List<MessagePart> parts, Class<? extends MessagePart>... types)	The index of the first part that is an instance of any of the given types, for use as the fallbackIndex of replace(java.util.List<org.springframework.ai.chat.messages.part.MessagePart>, java.lang.Class<? extends org.springframework.ai.chat.messages.part.MessagePart>, java.util.List<? extends org.springframework.ai.chat.messages.part.MessagePart>, int).
MessageType	getMessageType()	Get the message type of the message.
Map<String,Object>	getMetadata()	Get the metadata of the message.
List<MessagePart>	getParts()	The ordered content parts of this message.
@Nullable String	getText()	Get the content of the message.
int	hashCode()
protected static List<MessagePart>	legacyParts(@Nullable String textContent)
protected static void	replace(List<MessagePart> parts, Class<? extends MessagePart> type, List<? extends MessagePart> replacements, int fallbackIndex)	Removes every part of the given type and inserts the replacements where the first one was, or at fallbackIndex when there was none.
protected <P extends MessagePart> Stream<P>	select(Class<P> type)

Methods inherited from class java.lang.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

@Deprecated(since="2.1.0",
            forRemoval=true)
protected final @Nullable String textContent

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.1.0 in favor of getText(); kept so existing subclasses that read the field keep compiling. Will be removed in a future release.

The text content of this message, derived from its TextParts.

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,
 List<MessagePart> parts,
 Map<String,Object> metadata)

Create a new AbstractMessage from an ordered list of parts. The text content is derived by joining the TextParts in the list, without a separator.

Parameters:

messageType - the message type

parts - the parts, in order

metadata - the metadata

Since:

2.1.0

Method Details

legacyParts

protected static List<MessagePart> legacyParts(@Nullable String textContent)

replace

protected static void replace(List<MessagePart> parts,
 Class<? extends MessagePart> type,
 List<? extends MessagePart> replacements,
 int fallbackIndex)

Removes every part of the given type and inserts the replacements where the first one was, or at fallbackIndex when there was none. Builders use it so that a setter such as text(...) on a mutate() builder replaces the corresponding parts in place instead of adding to them.

Parameters:

parts - the mutable parts to update

type - the type of the parts to replace

replacements - the parts to insert, possibly empty to only remove

fallbackIndex - where to insert when parts has no part of the type

Since:

2.1.0

firstIndexOf

@SafeVarargs
protected static int firstIndexOf(List<MessagePart> parts,
 Class<? extends MessagePart>... types)

The index of the first part that is an instance of any of the given types, for use as the fallbackIndex of replace(java.util.List<org.springframework.ai.chat.messages.part.MessagePart>, java.lang.Class<? extends org.springframework.ai.chat.messages.part.MessagePart>, java.util.List<? extends org.springframework.ai.chat.messages.part.MessagePart>, int).

Parameters:

parts - the parts to search

types - the types to look for

Returns:

the index of the first matching part, or the size of parts when there is none

Since:

2.1.0

select

protected <P extends MessagePart> Stream<P> select(Class<P> type)

getParts

public List<MessagePart> getParts()

The ordered content parts of this message.

Returns:

an unmodifiable list of parts

Since:

2.1.0

getText

public @Nullable 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(@Nullable Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object