Package akka.javasdk.agent

Record Class SessionMessage.MultimodalUserMessage

Object
Record
akka.javasdk.agent.SessionMessage.MultimodalUserMessage
Record Components:
sanitized - true when the message holds the text that the runtime sent to the model, with the configured sanitizers applied. The runtime sends such a message to the model as it is. For a message with false, the runtime masks the text with the current sanitizers before it sends it. Leave it false in a message that you build.
All Implemented Interfaces:
SessionMessage
Enclosing interface:
SessionMessage
public static record SessionMessage.MultimodalUserMessage(Instant timestamp, List<SessionMessage.MessageContent> contents, String componentId, boolean sanitized) extends Record implements SessionMessage
A multimodal user message, e.g. text combined with an image or PDF.

  • Constructor Details

    • MultimodalUserMessage

      public MultimodalUserMessage(Instant timestamp, List<SessionMessage.MessageContent> contents, String componentId)

    • MultimodalUserMessage

      public MultimodalUserMessage(Instant timestamp, List<SessionMessage.MessageContent> contents, String componentId, boolean sanitized)
      Creates an instance of a MultimodalUserMessage record class.
      Parameters:
      timestamp - the value for the timestamp record component
      contents - the value for the contents record component
      componentId - the value for the componentId record component
      sanitized - the value for the sanitized record component

  • Method Details

    • text

      public Optional<String> text()
      returns text from the first MessageContent.TextMessageContent

    • size

      public int size()
      Description copied from interface: SessionMessage
      The approximate size of this message in bytes, used to enforce memory size limits.
      Specified by:
      size in interface SessionMessage

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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.

    • timestamp

      public Instant timestamp()
      Returns the value of the timestamp record component.
      Returns:
      the value of the timestamp record component

    • contents

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

    • componentId

      public String componentId()
      Returns the value of the componentId record component.
      Specified by:
      componentId in interface SessionMessage
      Returns:
      the value of the componentId record component

    • sanitized

      public boolean sanitized()
      Returns the value of the sanitized record component.
      Returns:
      the value of the sanitized record component