Package com.azure.ai.openai.assistants.models

Class MessageDeltaTextAnnotation

java.lang.Object
com.azure.ai.openai.assistants.models.MessageDeltaTextAnnotation
All Implemented Interfaces:
com.azure.json.JsonSerializable<MessageDeltaTextAnnotation>
Direct Known Subclasses:
MessageDeltaTextFileCitationAnnotationObject, MessageDeltaTextFilePathAnnotationObject
public class MessageDeltaTextAnnotation extends Object implements com.azure.json.JsonSerializable<MessageDeltaTextAnnotation>
The abstract base representation of a streamed text content part's text annotation.

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    MessageDeltaTextAnnotation(int index)
    Creates an instance of MessageDeltaTextAnnotation class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static MessageDeltaTextAnnotation
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of MessageDeltaTextAnnotation from the JsonReader.
    int
    getIndex()
    Get the index property: The index of the annotation within a text content part.
    String
    getType()
    Get the type property: The type of the text content annotation.
    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

    • MessageDeltaTextAnnotation

      protected MessageDeltaTextAnnotation(int index)
      Creates an instance of MessageDeltaTextAnnotation class.
      Parameters:
      index - the index value to set.

  • Method Details

    • getType

      public String getType()
      Get the type property: The type of the text content annotation.
      Returns:
      the type value.

    • getIndex

      public int getIndex()
      Get the index property: The index of the annotation within a text content part.
      Returns:
      the index value.

    • toJson

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

    • fromJson

      public static MessageDeltaTextAnnotation fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of MessageDeltaTextAnnotation from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of MessageDeltaTextAnnotation 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 MessageDeltaTextAnnotation.