Package com.azure.ai.inference.models

Class ChatCompletionsResponseFormatJsonSchema

java.lang.Object
com.azure.ai.inference.models.ChatCompletionsResponseFormat
com.azure.ai.inference.models.ChatCompletionsResponseFormatJsonSchema
All Implemented Interfaces:
com.azure.json.JsonSerializable<ChatCompletionsResponseFormat>
public final class ChatCompletionsResponseFormatJsonSchema extends ChatCompletionsResponseFormat
A response format for Chat Completions that restricts responses to emitting valid JSON objects, with a JSON schema specified by the caller.

  • Constructor Details

    • ChatCompletionsResponseFormatJsonSchema

      public ChatCompletionsResponseFormatJsonSchema(ChatCompletionsResponseFormatJsonSchemaDefinition jsonSchema)
      Creates an instance of ChatCompletionsResponseFormatJsonSchema class.
      Parameters:
      jsonSchema - the jsonSchema value to set.

  • 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.

    • getJsonSchema

      public ChatCompletionsResponseFormatJsonSchemaDefinition getJsonSchema()
      Get the jsonSchema property: The definition of the required JSON schema in the response, and associated metadata.
      Returns:
      the jsonSchema 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 ChatCompletionsResponseFormatJsonSchema fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of ChatCompletionsResponseFormatJsonSchema from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of ChatCompletionsResponseFormatJsonSchema 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 ChatCompletionsResponseFormatJsonSchema.