Package akka.javasdk.agent

Record Class UserMessage

Object
Record
akka.javasdk.agent.UserMessage
Record Components:
contents - The list of message content elements (text, images, etc.)
public record UserMessage(List<MessageContent> contents) extends Record
Represents a user message that can contain multimodal content for interaction with AI models.

A UserMessage encapsulates one or more MessageContent elements, allowing agents to send text, images, or both.

Multimodal message with text and image: 


 UserMessage message = UserMessage.from(
     MessageContent.TextMessageContent.from("What's in this image?"),
     ImageMessageContent.from("https://example.com/photo.jpg")
 );
See Also:

  • Constructor Details

    • UserMessage

      public UserMessage(List<MessageContent> contents)
      Creates an instance of a UserMessage record class.
      Parameters:
      contents - the value for the contents record component

  • Method Details

    • isTextOnly

      public boolean isTextOnly()
      Whether this message consists of a single MessageContent.TextMessageContent and nothing else.

    • text

      public String text()
      The text of this message.
      Throws:
      ClassCastException - if the first content element is not a MessageContent.TextMessageContent

    • from

      public static UserMessage from(String text)
      Create a text-only message.

    • from

      public static UserMessage from(MessageContent... messageContent)
      Create a multimodal message from one or more content elements.

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • contents

      public List<MessageContent> contents()
      Returns the value of the contents record component.
      Returns:
      the value of the contents record component