Package com.azure.ai.openai.models

Class StopFinishDetails

java.lang.Object
com.azure.ai.openai.models.ChatFinishDetails
com.azure.ai.openai.models.StopFinishDetails
All Implemented Interfaces:
com.azure.json.JsonSerializable<ChatFinishDetails>
public final class StopFinishDetails extends ChatFinishDetails
A structured representation of a stop reason that signifies natural termination by the model.

  • Method Details

    • getStop

      public String getStop()
      Get the stop property: The token sequence that the model terminated with.
      Returns:
      the stop value.

    • getType

      public String getType()
      Get the type property: The object type.
      Overrides:
      getType in class ChatFinishDetails
      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>
      Overrides:
      toJson in class ChatFinishDetails
      Throws:
      IOException

    • fromJson

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