Package com.azure.ai.openai.models

Class ChatCompletionsTextResponseFormat

java.lang.Object
com.azure.ai.openai.models.ChatCompletionsResponseFormat
com.azure.ai.openai.models.ChatCompletionsTextResponseFormat
All Implemented Interfaces:
com.azure.json.JsonSerializable<ChatCompletionsResponseFormat>
public final class ChatCompletionsTextResponseFormat extends ChatCompletionsResponseFormat
The standard Chat Completions response format that can freely generate text and is not guaranteed to produce response content that adheres to a specific schema.

  • Constructor Details

    • ChatCompletionsTextResponseFormat

      public ChatCompletionsTextResponseFormat()
      Creates an instance of ChatCompletionsTextResponseFormat class.

  • Method Details

    • getType

      public String getType()
      Get the type property: The discriminated type for the response format.
      Overrides:
      getType in class ChatCompletionsResponseFormat
      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<ChatCompletionsResponseFormat>
      Overrides:
      toJson in class ChatCompletionsResponseFormat
      Throws:
      IOException

    • fromJson

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