Package com.azure.ai.inference.models

Class ChatCompletionsResponseFormat

java.lang.Object
com.azure.ai.inference.models.ChatCompletionsResponseFormat
All Implemented Interfaces:
com.azure.json.JsonSerializable<ChatCompletionsResponseFormat>
Direct Known Subclasses:
ChatCompletionsResponseFormatJsonObject, ChatCompletionsResponseFormatJsonSchema, ChatCompletionsResponseFormatText
public class ChatCompletionsResponseFormat extends Object implements com.azure.json.JsonSerializable<ChatCompletionsResponseFormat>
Represents the format that the model must output. Use this to enable JSON mode instead of the default text mode. 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 Summary

    Constructors
    Constructor
    Description
    ChatCompletionsResponseFormat()
    Creates an instance of ChatCompletionsResponseFormat class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static ChatCompletionsResponseFormat
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of ChatCompletionsResponseFormat from the JsonReader.
    String
    getType()
    Get the type property: The response format type to use for chat completions.
    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

    • ChatCompletionsResponseFormat

      public ChatCompletionsResponseFormat()
      Creates an instance of ChatCompletionsResponseFormat class.

  • Method Details

    • getType

      public String getType()
      Get the type property: The response format type to use for chat completions.
      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>
      Throws:
      IOException

    • fromJson

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