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

Class MessageDeltaTextFileCitationAnnotationObject

java.lang.Object
com.azure.ai.openai.assistants.models.MessageDeltaTextAnnotation
com.azure.ai.openai.assistants.models.MessageDeltaTextFileCitationAnnotationObject
All Implemented Interfaces:
com.azure.json.JsonSerializable<MessageDeltaTextAnnotation>
public final class MessageDeltaTextFileCitationAnnotationObject extends MessageDeltaTextAnnotation
Represents a streamed file citation applied to a streaming text content part.

  • Method Details

    • getType

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

    • getFileCitation

      public MessageDeltaTextFileCitationAnnotation getFileCitation()
      Get the fileCitation property: The file citation information.
      Returns:
      the fileCitation value.

    • getStartIndex

      public Integer getStartIndex()
      Get the startIndex property: The start index of this annotation in the content text.
      Returns:
      the startIndex value.

    • getEndIndex

      public Integer getEndIndex()
      Get the endIndex property: The end index of this annotation in the content text.
      Returns:
      the endIndex 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>
      Overrides:
      toJson in class MessageDeltaTextAnnotation
      Throws:
      IOException

    • fromJson

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

    • getText

      public String getText()
      Get the text property: The text in the message content that needs to be replaced.
      Returns:
      the text value.