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

Class ResponsesStreamEventOutputTextDone

java.lang.Object
com.azure.ai.openai.responses.models.ResponsesStreamEvent
com.azure.ai.openai.responses.models.ResponsesStreamEventOutputTextDone
All Implemented Interfaces:
com.azure.json.JsonSerializable<ResponsesStreamEvent>
public final class ResponsesStreamEventOutputTextDone extends ResponsesStreamEvent
Emitted when the text value of a "text" content part is done streaming. Also emitted when a Response is interrupted, incomplete, or cancelled.

  • Method Summary

    Modifier and Type
    Method
    Description
    static ResponsesStreamEventOutputTextDone
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of ResponsesStreamEventOutputTextDone from the JsonReader.
    int
    getContentIndex()
    Get the contentIndex property: The index of the content part that was added to an item's content collection.
    String
    getItemId()
    Get the itemId property: The ID of the item that this stream event applies to.
    int
    getOutputIndex()
    Get the outputIndex property: The index of the output item within the response that this stream event applies to.
    String
    getText()
    Get the text property: The final text content.
    ResponsesStreamEventType
    getType()
    Get the type property: The type property.
    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

  • 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.

    • getText

      public String getText()
      Get the text property: The final text content.
      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<ResponsesStreamEvent>
      Overrides:
      toJson in class ResponsesStreamEvent
      Throws:
      IOException

    • fromJson

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