Package org.springframework.ai.chat.messages.part

Record Class MediaPart

java.lang.Object
java.lang.Record
org.springframework.ai.chat.messages.part.MediaPart
Record Components:
media - the media
payload - provider data to replay with this part, or null
attributes - free-form attributes, copied and unmodifiable
All Implemented Interfaces:
MessagePart
public record MediaPart(Media media, @Nullable OpaquePayload payload, Map<String,String> attributes) extends Record implements MessagePart
A media element (image, audio, video, document) produced by the model or supplied by the caller.

Media.getData() is an untyped Object (byte[], String or URL), so the media is serialized through a small DTO that records which kind of data it held and restores the same kind on read.

Since:
2.1.0
Author:
Christian Tzolov

  • Constructor Details

    • MediaPart

      public MediaPart(Media media, @Nullable OpaquePayload payload, Map<String,String> attributes)
      Creates an instance of a MediaPart record class.
      Parameters:
      media - the value for the media record component
      payload - the value for the payload record component
      attributes - the value for the attributes record component

  • Method Details

    • withAttributes

      public MediaPart withAttributes(Map<String,String> attributes)
      Description copied from interface: MessagePart
      Returns a copy of this part with the given attributes replacing the current ones. All other components are unchanged.
      Specified by:
      withAttributes in interface MessagePart
      Parameters:
      attributes - the new attributes, copied
      Returns:
      the copy

    • of

      public static MediaPart of(Media media)
      Creates a media part without payload or attributes.
      Parameters:
      media - the media
      Returns:
      the part

    • 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.

    • media

      public Media media()
      Returns the value of the media record component.
      Returns:
      the value of the media record component

    • payload

      public @Nullable OpaquePayload payload()
      Returns the value of the payload record component.
      Specified by:
      payload in interface MessagePart
      Returns:
      the value of the payload record component

    • attributes

      public Map<String,String> attributes()
      Returns the value of the attributes record component.
      Specified by:
      attributes in interface MessagePart
      Returns:
      the value of the attributes record component