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.

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(String textContent, Collection<Media> mediaList, Map<String,Object> metadata)
UserMessage(String textContent, List<Media> media)
UserMessage(String textContent, Media... media)
UserMessage(MessageType messageType, String textContent, Collection<Media> media, Map<String,Object> metadata)
UserMessage(org.springframework.core.io.Resource resource)

Method Summary

Modifier and Type	Method	Description
String	getContent()	Get the content of the message.
Collection<Media>	getMedia()	Get the media associated with the content.
List<Media>	getMedia(String... dummy)
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.model.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)

UserMessage

public UserMessage(String textContent,
 List<Media> media)

UserMessage

public UserMessage(String textContent,
 Media... media)

UserMessage

public UserMessage(String textContent,
 Collection<Media> mediaList,
 Map<String,Object> metadata)

UserMessage

public UserMessage(MessageType messageType,
 String textContent,
 Collection<Media> media,
 Map<String,Object> metadata)

Method Details

getMedia

public List<Media> getMedia(String... dummy)

toString

public String toString()

Overrides:

toString in class Object

getMedia

public Collection<Media> getMedia()

Description copied from interface: MediaContent

Get the media associated with the content.

Specified by:

getMedia in interface MediaContent

getContent

public String getContent()

Description copied from class: AbstractMessage

Get the content of the message.

Specified by:

getContent in interface Content

Overrides:

getContent in class AbstractMessage

Returns:

the content of the message