Package org.springframework.ai.chat.messages

Class AssistantMessage

java.lang.Object

org.springframework.ai.chat.messages.AbstractMessage

org.springframework.ai.chat.messages.AssistantMessage

All Implemented Interfaces:

Message, Content, MediaContent

Direct Known Subclasses:

DeepSeekAssistantMessage

public class AssistantMessage
extends AbstractMessage
implements MediaContent

Lets the generative know the content was generated as a response to the user. This role indicates messages that the generative has previously generated in the conversation. By including assistant messages in the series, you provide context to the generative about prior exchanges in the conversation.

The message content is an ordered list of MessageParts, inherited from AbstractMessage so that UserMessage can carry the same kind of content. The text, tool calls, media and reasoning accessors are views over that list: AbstractMessage.getText() joins the TextParts, getToolCalls() selects the ToolCallParts except streamed tool-call argument deltas, getMedia() selects the MediaParts and getReasoning() selects the ReasoningParts, in part order. Because reasoning is a part like any other, a message preserves the exact interleaving some providers stream between reasoning, tool calls, text and media (for example a reasoning block immediately followed by the tool call it justified). Messages built through the legacy constructor or builder setters get their parts in the legacy order: text, tool calls, media.

Since:

1.0.0

Author:

Mark Pollack, Christian Tzolov, Thomas Vitale, guan xu

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AssistantMessage.Builder<B extends AssistantMessage.Builder<B>>	Builder for AssistantMessage.
static final record	AssistantMessage.ToolCall

Field Summary

Fields

Modifier and Type	Field	Description
protected final List<Media>	media	Deprecated, for removal: This API element is subject to removal in a future version. since 2.1.0 in favor of getMedia(); kept so existing subclasses that read the field keep compiling.

Fields inherited from class org.springframework.ai.chat.messages.AbstractMessage

MESSAGE_TYPE, messageType, metadata, textContent

Constructor Summary

Constructors

Modifier	Constructor	Description
	AssistantMessage(@Nullable String content)
protected	AssistantMessage(@Nullable String content, Map<String,Object> properties, List<AssistantMessage.ToolCall> toolCalls, List<Media> media)
protected	AssistantMessage(List<MessagePart> parts, Map<String,Object> properties)	Creates a message from an ordered list of content parts, which may include ReasoningParts interleaved with the rest of the content.

Method Summary

Modifier and Type	Method	Description
static AssistantMessage.Builder<?>	builder()
AssistantMessage	copy()
List<Media>	getMedia()	Get the media associated with the content.
List<ReasoningPart>	getReasoning()	The reasoning parts of this message, in part order.
List<AssistantMessage.ToolCall>	getToolCalls()	The tool calls of this message, in part order.
boolean	hasToolCalls()	Whether this message holds a tool call.
AssistantMessage.Builder<?>	mutate()	A builder pre-populated with this message's parts and metadata.
String	toString()

Methods inherited from class org.springframework.ai.chat.messages.AbstractMessage

equals, firstIndexOf, getMessageType, getMetadata, getParts, getText, hashCode, legacyParts, replace, select

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.ai.content.Content

getMetadata, getText

Field Details

media

@Deprecated(since="2.1.0",
            forRemoval=true)
protected final List<Media> media

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

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

The media of this message, derived from its MediaParts.

Constructor Details

AssistantMessage

public AssistantMessage(@Nullable String content)

AssistantMessage

protected AssistantMessage(@Nullable String content,
 Map<String,Object> properties,
 List<AssistantMessage.ToolCall> toolCalls,
 List<Media> media)

AssistantMessage

protected AssistantMessage(List<MessagePart> parts,
 Map<String,Object> properties)

Creates a message from an ordered list of content parts, which may include ReasoningParts interleaved with the rest of the content.

Parameters:

parts - the parts, in order

properties - the message metadata

Since:

2.1.0

Method Details

getReasoning

public List<ReasoningPart> getReasoning()

The reasoning parts of this message, in part order.

Returns:

an unmodifiable list of reasoning parts

Since:

2.1.0

getToolCalls

public List<AssistantMessage.ToolCall> getToolCalls()

The tool calls of this message, in part order. A streamed tool-call argument delta, a ToolCallPart marked partial, is not a tool call and is skipped.

Returns:

an unmodifiable list of tool calls

hasToolCalls

public boolean hasToolCalls()

Whether this message holds a tool call. A streamed tool-call argument delta does not count, see getToolCalls().

Returns:

true if the message holds at least one tool call

getMedia

public List<Media> getMedia()

Description copied from interface: MediaContent

Get the media associated with the content.

Specified by:

getMedia in interface MediaContent

copy

public AssistantMessage copy()

mutate

public AssistantMessage.Builder<?> mutate()

A builder pre-populated with this message's parts and metadata. Calling AssistantMessage.Builder.content(String), AssistantMessage.Builder.toolCalls(List) or AssistantMessage.Builder.media(List) on it replaces the corresponding parts in place, so rewriting the text keeps the reasoning and tool calls where they were and vice versa.

Returns:

the builder

toString

public String toString()

Overrides:

toString in class Object

builder

public static AssistantMessage.Builder<?> builder()