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, ZhiPuAiAssistantMessage

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.

Since:

1.0.0

Author:

Mark Pollack, Christian Tzolov, Thomas Vitale

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	AssistantMessage.Builder
static final record	AssistantMessage.ToolCall

Field Summary

Fields

Modifier and Type	Field	Description
protected final List<Media>	media

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

MESSAGE_TYPE, messageType, metadata, textContent

Constructor Summary

Constructors

Constructor	Description
AssistantMessage(String content)
AssistantMessage(String content, Map<String,Object> properties)	Deprecated. in favor of builder().
AssistantMessage(String content, Map<String,Object> properties, List<AssistantMessage.ToolCall> toolCalls)	Deprecated. in favor of builder().
AssistantMessage(String content, Map<String,Object> properties, List<AssistantMessage.ToolCall> toolCalls, List<Media> media)	Deprecated. in favor of builder().

Method Summary

Modifier and Type	Method	Description
static AssistantMessage.Builder	builder()
boolean	equals(Object o)
List<Media>	getMedia()	Get the media associated with the content.
List<AssistantMessage.ToolCall>	getToolCalls()
int	hashCode()
boolean	hasToolCalls()
String	toString()

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

getMessageType, getMetadata, getText

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

protected final List<Media> media

Constructor Details

AssistantMessage

public AssistantMessage(String content)

AssistantMessage

@Deprecated
public AssistantMessage(String content,
 Map<String,Object> properties)

Deprecated.

in favor of builder().

AssistantMessage

@Deprecated
public AssistantMessage(String content,
 Map<String,Object> properties,
 List<AssistantMessage.ToolCall> toolCalls)

Deprecated.

in favor of builder().

AssistantMessage

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

Deprecated.

in favor of builder().

Method Details

getToolCalls

public List<AssistantMessage.ToolCall> getToolCalls()

hasToolCalls

public boolean hasToolCalls()

getMedia

public List<Media> getMedia()

Description copied from interface: MediaContent

Get the media associated with the content.

Specified by:

getMedia in interface MediaContent

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractMessage

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractMessage

toString

public String toString()

Overrides:

toString in class Object

builder

public static AssistantMessage.Builder builder()