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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UserMessage.Builder

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
UserMessage(String textContent)
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.
String	getText()	Get the content of the message.
UserMessage.Builder	mutate()
String	toString()

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

equals, getMessageType, getMetadata, hashCode

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

Field Details

media

protected final List<Media> media

Constructor Details

UserMessage

public UserMessage(String textContent)

UserMessage

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

Method Details

toString

public String toString()

Overrides:

toString in class Object

getText

@NonNull
public String getText()

Description copied from class: AbstractMessage

Get the content of the message.

Specified by:

getText in interface Content

Overrides:

getText in class AbstractMessage

Returns:

the content of the message

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

builder

public static UserMessage.Builder builder()