Embabel Agent Documentation/com.embabel.chat/UserMessage

UserMessage

class UserMessage constructor(val parts: List<ContentPart>, val name: String? = null, val assets: List<Asset> = emptyList(), val timestamp: Instant = Instant.now()) : BaseMessage, UserContent, AssetView

Message sent by the user - supports multimodal content and attached assets.

Assets attached to a message that may be checkpointed (e.g. via blackboard persistence) or persisted across sessions must be serializable. Use DurableAsset (typically by materializing into an com.embabel.chat.spi.AssetStore first), or serializable assets such as MaterializableAsset.fromBytes or MaterializableAsset.fromPath. Transient stream-based assets created via MaterializableAsset.of must be materialized before attaching to a message subject to checkpointing.

Constructors

UserMessage

constructor(content: String, name: String? = null, assets: List<Asset> = emptyList(), timestamp: Instant = Instant.now())

Convenience constructor for text-only messages with optional assets.

constructor(parts: List<ContentPart>, name: String? = null, assets: List<Asset> = emptyList(), timestamp: Instant = Instant.now())

Properties

assets

open override val assets: List<Asset>

All tracked assets, in order in which they were added

content

open override val content: String

Maintains backward compatibility with HasContent interface. Returns concatenated text from all TextParts.

documentParts

val documentParts: List<DocumentPart>

Returns all document parts in this message.

imageParts

val imageParts: List<ImagePart>

Returns all image parts in this message.

isMultimodal

val isMultimodal: Boolean

Returns true if this message contains any non-text content.

mediaParts

val mediaParts: List<MediaPart>

Returns all binary media parts in this message.

name

val name: String? = null

parts

val parts: List<ContentPart>

role

open override val role: Role

sender

val ~~sender~~: String

textContent

val textContent: String

Returns the text content of the message by concatenating all TextParts.

timestamp

open val timestamp: Instant

Functions

mostRecent

open fun mostRecent(n: Int): AssetView

The most recently timestamped assets

mostRecentlyAdded

open fun mostRecentlyAdded(n: Int): AssetView

The most recently added assets

references

open fun references(): List<LlmReference>

Convenience method to return references. References will be converted to matryoshka tools

since

open fun since(instant: Instant): AssetView

Assets timestamped since the given instant

toSpringAiMessage

fun Message.toSpringAiMessage(toolResponseContentAdapter: ToolResponseContentAdapter = ToolResponseContentAdapter.PASSTHROUGH): <Error class: unknown class>

Convert one of our messages to a Spring AI message with multimodal support.

toString

open override fun toString(): String