Package com.azure.ai.agents.persistent.models

Class MessageTextAnnotation

java.lang.Object
com.azure.ai.agents.persistent.models.MessageTextAnnotation
All Implemented Interfaces:
com.azure.json.JsonSerializable<MessageTextAnnotation>
Direct Known Subclasses:
MessageTextFileCitationAnnotation, MessageTextFilePathAnnotation, MessageTextUrlCitationAnnotation
public class MessageTextAnnotation extends Object implements com.azure.json.JsonSerializable<MessageTextAnnotation>
An abstract representation of an annotation to text thread message content.

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    MessageTextAnnotation(String text)
    Creates an instance of MessageTextAnnotation class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static MessageTextAnnotation
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of MessageTextAnnotation from the JsonReader.
    String
    getText()
    Get the text property: The textual content associated with this text annotation item.
    String
    getType()
    Get the type property: The object type.
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.azure.json.JsonSerializable

    toJson, toJson, toJsonBytes, toJsonString

  • Constructor Details

    • MessageTextAnnotation

      protected MessageTextAnnotation(String text)
      Creates an instance of MessageTextAnnotation class.
      Parameters:
      text - the text value to set.

  • Method Details

    • getType

      public String getType()
      Get the type property: The object type.
      Returns:
      the type value.

    • getText

      public String getText()
      Get the text property: The textual content associated with this text annotation item.
      Returns:
      the text value.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<MessageTextAnnotation>
      Throws:
      IOException

    • fromJson

      public static MessageTextAnnotation fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of MessageTextAnnotation from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of MessageTextAnnotation if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the MessageTextAnnotation.