Package com.azure.ai.inference.models

Class ChatCompletionsResponseFormatJsonObject

java.lang.Object
com.azure.ai.inference.models.ChatCompletionsResponseFormat
com.azure.ai.inference.models.ChatCompletionsResponseFormatJsonObject
All Implemented Interfaces:
com.azure.json.JsonSerializable<ChatCompletionsResponseFormat>
public final class ChatCompletionsResponseFormatJsonObject extends ChatCompletionsResponseFormat
A response format for Chat Completions that restricts responses to emitting valid JSON objects. Note that to enable JSON mode, some AI models may also require you to instruct the model to produce JSON via a system or user message.

  • Constructor Details

    • ChatCompletionsResponseFormatJsonObject

      public ChatCompletionsResponseFormatJsonObject()
      Creates an instance of ChatCompletionsResponseFormatJsonObject class.

  • Method Details

    • getType

      public String getType()
      Get the type property: The response format type to use for chat completions.
      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 ChatCompletionsResponseFormatJsonObject fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of ChatCompletionsResponseFormatJsonObject from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of ChatCompletionsResponseFormatJsonObject 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 ChatCompletionsResponseFormatJsonObject.