Package com.github.copilot.sdk.json

Class ElicitationSchema

java.lang.Object
com.github.copilot.sdk.json.ElicitationSchema
public class ElicitationSchema extends Object
JSON Schema describing the form fields to present for an elicitation dialog.
Since:
1.0.0

  • Constructor Details

    • ElicitationSchema

      public ElicitationSchema()

  • Method Details

    • getType

      public String getType()
      Gets the schema type indicator (always "object").
      Returns:
      the type

    • setType

      public ElicitationSchema setType(String type)
      Sets the schema type indicator.
      Parameters:
      type - the type (typically "object")
      Returns:
      this instance for method chaining

    • getProperties

      public Map<String,Object> getProperties()
      Gets the form field definitions, keyed by field name.
      Returns:
      the properties map

    • setProperties

      public ElicitationSchema setProperties(Map<String,Object> properties)
      Sets the form field definitions, keyed by field name.
      Parameters:
      properties - the properties map
      Returns:
      this instance for method chaining

    • getRequired

      public List<String> getRequired()
      Gets the list of required field names.
      Returns:
      the required field names, or null

    • setRequired

      public ElicitationSchema setRequired(List<String> required)
      Sets the list of required field names.
      Parameters:
      required - the required field names
      Returns:
      this instance for method chaining