Package com.azure.ai.openai.models

Class ChatCompletionsJsonSchemaResponseFormatJsonSchema

java.lang.Object
com.azure.ai.openai.models.ChatCompletionsJsonSchemaResponseFormatJsonSchema
All Implemented Interfaces:
com.azure.json.JsonSerializable<ChatCompletionsJsonSchemaResponseFormatJsonSchema>
public final class ChatCompletionsJsonSchemaResponseFormatJsonSchema extends Object implements com.azure.json.JsonSerializable<ChatCompletionsJsonSchemaResponseFormatJsonSchema>
The ChatCompletionsJsonSchemaResponseFormatJsonSchema model.

  • Constructor Details

    • ChatCompletionsJsonSchemaResponseFormatJsonSchema

      public ChatCompletionsJsonSchemaResponseFormatJsonSchema(String name)
      Creates an instance of ChatCompletionsJsonSchemaResponseFormatJsonSchema class.
      Parameters:
      name - the name value to set.

  • Method Details

    • getDescription

      public String getDescription()
      Get the description property: A description of what the response format is for, used by the model to determine how to respond in the format.
      Returns:
      the description value.

    • setDescription

      public ChatCompletionsJsonSchemaResponseFormatJsonSchema setDescription(String description)
      Set the description property: A description of what the response format is for, used by the model to determine how to respond in the format.
      Parameters:
      description - the description value to set.
      Returns:
      the ChatCompletionsJsonSchemaResponseFormatJsonSchema object itself.

    • getName

      public String getName()
      Get the name property: The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.
      Returns:
      the name value.

    • getSchema

      public com.azure.core.util.BinaryData getSchema()
      Get the schema property: The schema property.
      Returns:
      the schema value.

    • setSchema

      public ChatCompletionsJsonSchemaResponseFormatJsonSchema setSchema(com.azure.core.util.BinaryData schema)
      Set the schema property: The schema property.
      Parameters:
      schema - the schema value to set.
      Returns:
      the ChatCompletionsJsonSchemaResponseFormatJsonSchema object itself.

    • isStrict

      public Boolean isStrict()
      Get the strict property: Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the `schema` field. Only a subset of JSON Schema is supported when `strict` is `true`. To learn more, read the [Structured Outputs guide](/docs/guides/structured-outputs).
      Returns:
      the strict value.

    • setStrict

      public ChatCompletionsJsonSchemaResponseFormatJsonSchema setStrict(Boolean strict)
      Set the strict property: Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the `schema` field. Only a subset of JSON Schema is supported when `strict` is `true`. To learn more, read the [Structured Outputs guide](/docs/guides/structured-outputs).
      Parameters:
      strict - the strict value to set.
      Returns:
      the ChatCompletionsJsonSchemaResponseFormatJsonSchema 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<ChatCompletionsJsonSchemaResponseFormatJsonSchema>
      Throws:
      IOException

    • fromJson

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