ART Framework API Docs
    Preparing search index...

    Interface HITLFeedbackSchema

    Schema for what kind of feedback a blocking tool expects.

    Tools declare this schema to inform the UI layer what input to collect. The framework uses this to validate feedback and construct the tool result.

    // Simple confirmation
    {
      inputType: 'confirm',
      prompt: 'Are you sure you want to delete this file?',
      confirmLabel: 'Delete',
      cancelLabel: 'Keep'
    }

    // Selection from options
    {
      inputType: 'select',
      prompt: 'Which deployment environment should we use?',
      options: [
        { value: 'staging', label: 'Staging', description: 'Test environment' },
        { value: 'production', label: 'Production', description: 'Live environment' }
      ],
      required: true
    }

    // Text input with validation
    {
      inputType: 'text',
      prompt: 'Please provide the API key for the service:',
      placeholder: 'sk-...',
      validation: {
        required: true,
        pattern: '^sk-[a-zA-Z0-9]{32,}$',
        patternMessage: 'Must be a valid API key starting with sk-'
      }
    }
    interface HITLFeedbackSchema {
        allowModifyArgs?: boolean;
        cancelLabel?: string;
        confirmLabel?: string;
        customSchema?: Record<string, unknown>;
        defaultValue?: unknown;
        hint?: string;
        inputType: HITLInputType;
        options?: HITLSelectOption[];
        placeholder?: string;
        prompt: string;
        sensitive?: boolean;
        title?: string;
        validation?: HITLInputValidation;
    }
    Index

    Properties

    allowModifyArgs? cancelLabel? confirmLabel? customSchema? defaultValue? hint? inputType options? placeholder? prompt sensitive? title? validation?

    Properties

    allowModifyArgs?: boolean

    If true, user can modify the original tool arguments before submitting. The modified args are returned in the feedback.

    false
    cancelLabel?: string

    For confirm type: custom label for the reject button.

    'Reject'
    confirmLabel?: string

    For confirm type: custom label for the approve button.

    'Approve'
    customSchema?: Record<string, unknown>

    For custom inputType: application-defined JSON schema for the input.

    defaultValue?: unknown

    Optional default value to pre-fill.

    hint?: string

    Optional hint text shown below the input.

    inputType: HITLInputType

    The type of input expected from the user.

    options?: HITLSelectOption[]

    For select/multiselect: available options to choose from.

    placeholder?: string

    Placeholder text for text/number inputs.

    prompt: string

    Human-readable prompt shown to the user. This should clearly explain what input is needed and why.

    sensitive?: boolean

    Whether this is a sensitive input (e.g., password, API key). UI should mask the input if true.

    false
    title?: string

    Optional title for the feedback dialog/section.

    validation?: HITLInputValidation

    Validation constraints for the input.

    Settings

    Member Visibility

    On This Page

    Properties