Record Class TextPart

java.lang.Object
java.lang.Record
org.a2aproject.sdk.spec.TextPart
Record Components:
text - the text content (required, must not be null)
metadata - additional metadata for the part
All Implemented Interfaces:
Part<String>

public record TextPart(String text, @Nullable Map<String,Object> metadata) extends Record implements Part<String>
Represents a plain text content part within a Message or Artifact.

TextPart is the most common part type, containing textual content such as user messages, agent responses, descriptions, or any other human-readable text.

The text content is required and must be non-null. Optional metadata can provide additional context about the text (such as language, encoding, or formatting hints).

Example usage:


 TextPart greeting = new TextPart("Hello, how can I help you?");
 TextPart withMetadata = new TextPart("Bonjour!", Map.of("language", "fr"));
 
See Also:
  • Field Details

    • TEXT

      public static final String TEXT
      The JSON member name discriminator for text parts: "text".

      In protocol v1.0+, this constant defines the JSON member name used for serialization: { "text": "Hello, world!" }

      See Also:
  • Constructor Details

    • TextPart

      public TextPart(String text, @Nullable Map<String,Object> metadata)
      Compact constructor with validation.
      Parameters:
      text - the text content (required, must not be null)
      Throws:
      IllegalArgumentException - if text is null
    • TextPart

      public TextPart(String text)
      Constructor.
      Parameters:
      text - the text content (required, must not be null)
      Throws:
      IllegalArgumentException - if data is null
  • Method Details

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

      public String text()
      Returns the value of the text record component.
      Returns:
      the value of the text record component
    • metadata

      public @Nullable Map<String,Object> metadata()
      Returns the value of the metadata record component.
      Returns:
      the value of the metadata record component