Skip to main content
The ax annotation-configs commands are currently in BETA. The API may change without notice. A one-time warning is emitted on first use.
The ax annotation-configs commands let you create, retrieve, and manage annotation configs on the Arize platform. Annotation configs define structured label schemas for human feedback and data curation.

ax annotation-configs list

List all annotation configs in a space.
ax annotation-configs list [--space <id>] [--name <filter>] [--limit <n>] [--cursor <cursor>]
OptionDescription
--spaceFilter by space name or ID
--nameCase-insensitive substring filter on annotation config name
--limitMaximum number of results to return (default: 15)
--cursorPagination cursor for the next page
Examples:
ax annotation-configs list --space sp_abc123
ax annotation-configs list --space sp_abc123 --output configs.json

ax annotation-configs create

Create a new annotation config. Three types are supported: categorical, continuous, and freeform.
ax annotation-configs create --name <name> --space <id> --type <type> [type-specific options]
OptionDescription
--nameName for the annotation config
--spaceSpace name or ID to create the config in
--typeConfig type: categorical, continuous, or freeform
--min-scoreMinimum score (required for continuous type)
--max-scoreMaximum score (required for continuous type)
--valueLabel for categorical type — repeat for multiple values (e.g. --value good --value bad)
--optimization-directionmaximize, minimize, or none
Examples: Categorical (discrete labels with optional scores):
ax annotation-configs create \
  --name "accuracy" \
  --space sp_abc123 \
  --type categorical \
  --value accurate \
  --value inaccurate \
  --optimization-direction maximize
Continuous (numeric score range):
ax annotation-configs create \
  --name "relevance" \
  --space sp_abc123 \
  --type continuous \
  --min-score 0.0 \
  --max-score 1.0 \
  --optimization-direction maximize
Freeform (free-text feedback, no scoring):
ax annotation-configs create \
  --name "reviewer-notes" \
  --space sp_abc123 \
  --type freeform

ax annotation-configs get

Retrieve a single annotation config by name or ID.
ax annotation-configs get <name-or-id> [--space <name_or_id>]
OptionDescription
--spaceSpace name or ID (required when using annotation config name instead of ID)
Examples:
ax annotation-configs get ac_xyz789
ax annotation-configs get "accuracy" --space my-space

ax annotation-configs delete

Delete an annotation config by name or ID. This operation is irreversible.
ax annotation-configs delete <name-or-id> [--space <name_or_id>] [--force]
OptionDescription
--spaceSpace name or ID (required when using annotation config name instead of ID)
--forceSkip the confirmation prompt
Examples:
ax annotation-configs delete ac_xyz789 --force
ax annotation-configs delete "accuracy" --space my-space --force