Package com.azure.ai.inference.models

Class ChatCompletionsResponseFormatText

java.lang.Object
com.azure.ai.inference.models.ChatCompletionsResponseFormat
com.azure.ai.inference.models.ChatCompletionsResponseFormatText
All Implemented Interfaces:
com.azure.json.JsonSerializable<ChatCompletionsResponseFormat>
public final class ChatCompletionsResponseFormatText extends ChatCompletionsResponseFormat
A response format for Chat Completions that emits text responses. This is the default response format.

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    static ChatCompletionsResponseFormatText
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of ChatCompletionsResponseFormatText 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

    • ChatCompletionsResponseFormatText

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