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

Class ResponsesStreamEventOutputItemDone

java.lang.Object
com.azure.ai.openai.responses.models.ResponsesStreamEvent
com.azure.ai.openai.responses.models.ResponsesStreamEventOutputItemDone
All Implemented Interfaces:
com.azure.json.JsonSerializable<ResponsesStreamEvent>
public final class ResponsesStreamEventOutputItemDone extends ResponsesStreamEvent
Returned when an output item is done streaming.

  • Method Details

    • getType

      public ResponsesStreamEventType getType()
      Get the type property: The type property.
      Overrides:
      getType in class ResponsesStreamEvent
      Returns:
      the type 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.

    • getItem

      public ResponsesItem getItem()
      Get the item property: The completed output item.
      Returns:
      the item 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 ResponsesStreamEventOutputItemDone fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of ResponsesStreamEventOutputItemDone from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of ResponsesStreamEventOutputItemDone 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 ResponsesStreamEventOutputItemDone.