Package com.azure.ai.openai.responses.models

Class ResponsesTextFormatJsonSchema

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

  • Constructor Details

    • ResponsesTextFormatJsonSchema

      public ResponsesTextFormatJsonSchema(String name, com.azure.core.util.BinaryData schema)
      Creates an instance of ResponsesTextFormatJsonSchema class.
      Parameters:
      name - the name value to set.
      schema - the schema value to set.

  • Method Details

    • getType

      public ResponsesTextFormatType getType()
      Get the type property: The type property.
      Overrides:
      getType in class ResponsesTextFormat
      Returns:
      the type value.

    • getName

      public String getName()
      Get the name property: The name property.
      Returns:
      the name value.

    • getSchema

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

    • getDescription

      public String getDescription()
      Get the description property: The description property.
      Returns:
      the description value.

    • setDescription

      public ResponsesTextFormatJsonSchema setDescription(String description)
      Set the description property: The description property.
      Parameters:
      description - the description value to set.
      Returns:
      the ResponsesTextFormatJsonSchema object itself.

    • isStrict

      public Boolean isStrict()
      Get the strict property: The strict property.
      Returns:
      the strict value.

    • setStrict

      public ResponsesTextFormatJsonSchema setStrict(Boolean strict)
      Set the strict property: The strict property.
      Parameters:
      strict - the strict value to set.
      Returns:
      the ResponsesTextFormatJsonSchema 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<ResponsesTextFormat>
      Overrides:
      toJson in class ResponsesTextFormat
      Throws:
      IOException

    • fromJson

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