Documentation

Inputs

Define the values callers can pass with JSON Schema.

Declare accepted values

The inputs field is a JSON Schema object. Use types, required fields, ranges, defaults, and additionalProperties to make the application contract explicit.

inputs:
  $schema: "https://json-schema.org/draft/2020-12/schema"
  type: object
  required:
    - target_f1
    - max_trials
  properties:
    target_f1:
      type: number
      minimum: 0.5
      maximum: 1.0
    max_trials:
      type: integer
      minimum: 2
      maximum: 12
  additionalProperties: false

Use inputs in the application

Prompt templates can reference declared values with input.<name>. Python tools can read the validated values through recurse.inputs.