Record Class MessageContent.PdfBytesMessageContent

Object
Record
akka.javasdk.agent.MessageContent.PdfBytesMessageContent
All Implemented Interfaces:
MessageContent, MessageContent.DataMessageContent, MessageContent.PdfDataMessageContent
Enclosing interface:
MessageContent

public static record MessageContent.PdfBytesMessageContent(byte[] data) extends Record implements MessageContent.PdfDataMessageContent
PDF content carried as inline bytes, for returning binary media from a @FunctionTool.

Inline bytes are only valid as a tool return value; they cannot be sent to the model as input. In a UserMessage reference PDFs by URI using MessageContent.PdfUrlMessageContent.

The data array must be effectively immutable — do not modify it after passing it in.

Build via MessageContent.PdfMessageContent.fromBytes(byte[]).

  • Constructor Details

    • PdfBytesMessageContent

      public PdfBytesMessageContent(byte[] data)
      Creates an instance of a PdfBytesMessageContent record class.
      Parameters:
      data - the value for the data record component
  • Method Details

    • mimeType

      public Optional<String> mimeType()
      Description copied from interface: MessageContent.DataMessageContent
      The media type of MessageContent.DataMessageContent.data(), if known, e.g. image/png.
      Specified by:
      mimeType in interface MessageContent.DataMessageContent
    • 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.
    • data

      public byte[] data()
      Returns the value of the data record component.
      Specified by:
      data in interface MessageContent.DataMessageContent
      Returns:
      the value of the data record component