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

Class MessageDeltaChunk

java.lang.Object
com.azure.ai.openai.assistants.models.MessageDeltaChunk
All Implemented Interfaces:
com.azure.json.JsonSerializable<MessageDeltaChunk>
public final class MessageDeltaChunk extends Object implements com.azure.json.JsonSerializable<MessageDeltaChunk>
Represents a message delta i.e. any changed fields on a message during streaming.

  • Method Summary

    Modifier and Type
    Method
    Description
    static MessageDeltaChunk
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of MessageDeltaChunk from the JsonReader.
    MessageDelta
    getDelta()
    Get the delta property: The delta containing the fields that have changed on the Message.
    String
    getId()
    Get the id property: The identifier of the message, which can be referenced in API endpoints.
    String
    getObject()
    Get the object property: The object type, which is always `thread.message.delta`.
    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

    • getId

      public String getId()
      Get the id property: The identifier of the message, which can be referenced in API endpoints.
      Returns:
      the id value.

    • getObject

      public String getObject()
      Get the object property: The object type, which is always `thread.message.delta`.
      Returns:
      the object value.

    • getDelta

      public MessageDelta getDelta()
      Get the delta property: The delta containing the fields that have changed on the Message.
      Returns:
      the delta value.

    • toJson

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

    • fromJson

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