Package io.openliberty.mcp.content

Record Class ImageContent

java.lang.Object
java.lang.Record
io.openliberty.mcp.content.ImageContent
Record Components:
data - a base64-encoded string representing the image data (must not be null)
mimeType - the mime type of the image (must not be null)
_meta - the optional metadata (may be null)
annotations - the optional annotations (may be null)
All Implemented Interfaces:
Content
public record ImageContent(String data, String mimeType, Map<MetaKey,Object> _meta, Content.Annotations annotations) extends Record implements Content
An image content provided to or from an LLM.

  • Constructor Details

    • ImageContent

      public ImageContent(String data, String mimeType)

    • ImageContent

      public ImageContent(String data, String mimeType, Map<MetaKey,Object> _meta, Content.Annotations annotations)
      Creates an instance of a ImageContent record class.
      Parameters:
      data - the value for the data record component
      mimeType - the value for the mimeType record component
      _meta - the value for the _meta record component
      annotations - the value for the annotations record component

  • Method Details

    • type

      public Content.Type type()
      Specified by:
      type in interface Content
      Returns:
      the type of the content

    • asImage

      public ImageContent asImage()
      Description copied from interface: Content
      Casts and returns this object as an image content, or throws an IllegalArgumentException if the content object does not represent a ImageContent.
      Specified by:
      asImage in interface Content
      Returns:
      the image content

    • 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 String data()
      Returns the value of the data record component.
      Returns:
      the value of the data record component

    • mimeType

      public String mimeType()
      Returns the value of the mimeType record component.
      Returns:
      the value of the mimeType record component

    • _meta

      public Map<MetaKey,Object> _meta()
      Returns the value of the _meta record component.
      Returns:
      the value of the _meta record component

    • annotations

      public Content.Annotations annotations()
      Returns the value of the annotations record component.
      Specified by:
      annotations in interface Content
      Returns:
      the value of the annotations record component