Package com.azure.ai.agents.persistent.models

Class ResponseFormatJsonSchema

java.lang.Object
com.azure.ai.agents.persistent.models.ResponseFormatJsonSchema
All Implemented Interfaces:
com.azure.json.JsonSerializable<ResponseFormatJsonSchema>
public final class ResponseFormatJsonSchema extends Object implements com.azure.json.JsonSerializable<ResponseFormatJsonSchema>
A description of what the response format is for, used by the model to determine how to respond in the format.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ResponseFormatJsonSchema(String name, com.azure.core.util.BinaryData schema)
    Creates an instance of ResponseFormatJsonSchema class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static ResponseFormatJsonSchema
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of ResponseFormatJsonSchema from the JsonReader.
    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.
    String
    getName()
    Get the name property: The name of a schema.
    com.azure.core.util.BinaryData
    getSchema()
    Get the schema property: The JSON schema object, describing the response format.
    ResponseFormatJsonSchema
    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.
    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

    • ResponseFormatJsonSchema

      public ResponseFormatJsonSchema(String name, com.azure.core.util.BinaryData schema)
      Creates an instance of ResponseFormatJsonSchema class.
      Parameters:
      name - the name value to set.
      schema - the schema 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 ResponseFormatJsonSchema 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 ResponseFormatJsonSchema object itself.

    • getName

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

    • getSchema

      public com.azure.core.util.BinaryData getSchema()
      Get the schema property: The JSON schema object, describing the response format.
      Returns:
      the schema value.

    • toJson

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

    • fromJson

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