Package com.azure.ai.openai.responses.models

Class ResponsesStreamEventOutputTextAnnotationAdded

java.lang.Object
com.azure.ai.openai.responses.models.ResponsesStreamEvent
com.azure.ai.openai.responses.models.ResponsesStreamEventOutputTextAnnotationAdded
All Implemented Interfaces:
com.azure.json.JsonSerializable<ResponsesStreamEvent>
public final class ResponsesStreamEventOutputTextAnnotationAdded extends ResponsesStreamEvent
Emitted when a new output text annotation is added.

  • Method Details

    • getType

      public ResponsesStreamEventType getType()
      Get the type property: The type property.
      Overrides:
      getType in class ResponsesStreamEvent
      Returns:
      the type value.

    • getItemId

      public String getItemId()
      Get the itemId property: The ID of the item that this stream event applies to.
      Returns:
      the itemId value.

    • getOutputIndex

      public int getOutputIndex()
      Get the outputIndex property: The index of the output item within the response that this stream event applies to.
      Returns:
      the outputIndex value.

    • getContentIndex

      public int getContentIndex()
      Get the contentIndex property: The index of the content part that was added to an item's content collection.
      Returns:
      the contentIndex value.

    • getAnnotation

      public ResponsesOutputTextAnnotation getAnnotation()
      Get the annotation property: The annotation index, within the output item content part, for the new annotation.The new annotation added.
      Returns:
      the annotation value.

    • toJson

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

    • fromJson

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