Package com.azure.ai.openai.models

Class ChatFinishDetails

java.lang.Object
com.azure.ai.openai.models.ChatFinishDetails
All Implemented Interfaces:
com.azure.json.JsonSerializable<ChatFinishDetails>
Direct Known Subclasses:
MaxTokensFinishDetails, StopFinishDetails
public class ChatFinishDetails extends Object implements com.azure.json.JsonSerializable<ChatFinishDetails>
An abstract representation of structured information about why a chat completions response terminated.

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    ChatFinishDetails()
    Creates an instance of ChatFinishDetails class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static ChatFinishDetails
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of ChatFinishDetails from the JsonReader.
    String
    getType()
    Get the type property: The object type.
    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

  • Constructor Details

    • ChatFinishDetails

      protected ChatFinishDetails()
      Creates an instance of ChatFinishDetails class.

  • Method Details

    • getType

      public String getType()
      Get the type property: The object type.
      Returns:
      the type value.

    • toJson

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

    • fromJson

      public static ChatFinishDetails fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of ChatFinishDetails from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of ChatFinishDetails if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IOException - If an error occurs while reading the ChatFinishDetails.