Package org.springframework.ai.chat.messages

Class UserMessage

java.lang.Object

org.springframework.ai.chat.messages.AbstractMessage

org.springframework.ai.chat.messages.UserMessage

All Implemented Interfaces:

Message, Content, MediaContent

public class UserMessage
extends AbstractMessage
implements MediaContent

A message of the type 'user' passed as input Messages with the user role are from the end-user or developer. They represent questions, prompts, or any input that you want the generative to respond to.

The message content is an ordered list of MessageParts, inherited from AbstractMessage so that it is shared with AssistantMessage. getMedia() is a view over that list, selecting the MediaParts in part order.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	UserMessage.Builder	Builder for UserMessage.

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
	UserMessage(@Nullable String textContent)
protected	UserMessage(List<MessagePart> parts, Map<String,Object> metadata)	Creates a message from an ordered list of parts.
	UserMessage(org.springframework.core.io.Resource resource)

Method Summary

Modifier and Type	Method	Description
static UserMessage.Builder	builder()
UserMessage	copy()
List<Media>	getMedia()	Get the media associated with the content.
UserMessage.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, getMessageType, getMetadata, getParts, getText, hashCode, legacyParts, 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

UserMessage

public UserMessage(@Nullable String textContent)

UserMessage

public UserMessage(org.springframework.core.io.Resource resource)

UserMessage

protected UserMessage(List<MessagePart> parts,
 Map<String,Object> metadata)

Creates a message from an ordered list of parts. A message without a TextPart (for example media only) has an empty text.

Parameters:

parts - the parts, in order

metadata - the message metadata

Since:

2.1.0

Method Details

toString

public String toString()

Overrides:

toString in class Object

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

mutate

public UserMessage.Builder mutate()

A builder pre-populated with this message's parts and metadata. Calling UserMessage.Builder.text(String) or UserMessage.Builder.media(List) on it replaces the corresponding parts, so rewriting the question keeps the media and vice versa.

builder

public static UserMessage.Builder builder()