Package com.azure.search.documents.indexes.models

Class ChatCompletionResponseFormatJsonSchemaProperties

java.lang.Object
com.azure.search.documents.indexes.models.ChatCompletionResponseFormatJsonSchemaProperties
All Implemented Interfaces:
com.azure.json.JsonSerializable<ChatCompletionResponseFormatJsonSchemaProperties>
public final class ChatCompletionResponseFormatJsonSchemaProperties extends Object implements com.azure.json.JsonSerializable<ChatCompletionResponseFormatJsonSchemaProperties>
An open dictionary for extended properties. Required if 'type' == 'json_schema'.

  • Constructor Details

    • ChatCompletionResponseFormatJsonSchemaProperties

      public ChatCompletionResponseFormatJsonSchemaProperties()
      Creates an instance of ChatCompletionResponseFormatJsonSchemaProperties class.

  • Method Details

    • getName

      public String getName()
      Get the name property: Name of the json schema the model will adhere to.
      Returns:
      the name value.

    • setName

      public ChatCompletionResponseFormatJsonSchemaProperties setName(String name)
      Set the name property: Name of the json schema the model will adhere to.
      Parameters:
      name - the name value to set.
      Returns:
      the ChatCompletionResponseFormatJsonSchemaProperties object itself.

    • getDescription

      public String getDescription()
      Get the description property: Description of the json schema the model will adhere to.
      Returns:
      the description value.

    • setDescription

      public ChatCompletionResponseFormatJsonSchemaProperties setDescription(String description)
      Set the description property: Description of the json schema the model will adhere to.
      Parameters:
      description - the description value to set.
      Returns:
      the ChatCompletionResponseFormatJsonSchemaProperties object itself.

    • isStrict

      public Boolean isStrict()
      Get the strict property: Whether or not the model's response should use structured outputs. Default is true.
      Returns:
      the strict value.

    • setStrict

      public ChatCompletionResponseFormatJsonSchemaProperties setStrict(Boolean strict)
      Set the strict property: Whether or not the model's response should use structured outputs. Default is true.
      Parameters:
      strict - the strict value to set.
      Returns:
      the ChatCompletionResponseFormatJsonSchemaProperties object itself.

    • getSchema

      public ChatCompletionSchema getSchema()
      Get the schema property: Object defining the custom schema the model will use to structure its output.
      Returns:
      the schema value.

    • setSchema

      public ChatCompletionResponseFormatJsonSchemaProperties setSchema(ChatCompletionSchema schema)
      Set the schema property: Object defining the custom schema the model will use to structure its output.
      Parameters:
      schema - the schema value to set.
      Returns:
      the ChatCompletionResponseFormatJsonSchemaProperties object itself.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<ChatCompletionResponseFormatJsonSchemaProperties>
      Throws:
      IOException

    • fromJson

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