> ## Documentation Index
> Fetch the complete documentation index at: https://arize-ax.mintlify.site/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Annotation Configs

> Manage annotation configs with the AX CLI

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.

```bash theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
ax annotation-configs list [--space <id>] [--name <filter>] [--limit <n>] [--cursor <cursor>] [--output <fmt>] [--verbose]
```

| Option | Description |
| - | - |
| `--name`, `-n` | Case-insensitive substring filter on annotation config name |
| `--space`, `-s` | Space name or ID |
| `--limit`, `-l` | Maximum number of annotation configs to return (default: 15) |
| `--cursor`, `-c` | Pagination cursor for the next page |
| `--output`, `-o` | Output format (`table`, `json`, `csv`, `parquet`) or file path |
| `--verbose`, `-v` | Enable verbose logs |

**Examples:**

```bash theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
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. Choose the subcommand matching the type you want: `continuous`, `categorical`, or `freeform`.

### `ax annotation-configs create continuous`

```bash theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
ax annotation-configs create continuous --name <name> --space <id> --min-score <n> --max-score <n> [--optimization-direction <dir>] [--output <fmt>] [--verbose]
```

| Option | Description |
| - | - |
| `--name`, `-n` | Annotation config name (required; prompts if omitted) |
| `--space`, `-s` | Space name or ID (required; prompts if omitted) |
| `--min-score` | Minimum score (required) |
| `--max-score` | Maximum score (required) |
| `--optimization-direction` | Optimization direction (`MAXIMIZE`, `MINIMIZE`, or `NONE`) |
| `--output`, `-o` | Output format (`table`, `json`, `csv`, `parquet`) or file path |
| `--verbose`, `-v` | Enable verbose logs |

### `ax annotation-configs create categorical`

```bash theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
ax annotation-configs create categorical --name <name> --space <id> --value <label> [--value <label> ...] [--optimization-direction <dir>] [--output <fmt>] [--verbose]
```

| Option | Description |
| - | - |
| `--name`, `-n` | Annotation config name (required; prompts if omitted) |
| `--space`, `-s` | Space name or ID (required; prompts if omitted) |
| `--value` | Label value — repeat for multiple (e.g. `--value good --value bad`) (required) |
| `--optimization-direction` | Optimization direction (`MAXIMIZE`, `MINIMIZE`, or `NONE`) |
| `--output`, `-o` | Output format (`table`, `json`, `csv`, `parquet`) or file path |
| `--verbose`, `-v` | Enable verbose logs |

### `ax annotation-configs create freeform`

```bash theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
ax annotation-configs create freeform --name <name> --space <id> [--output <fmt>] [--verbose]
```

| Option | Description |
| - | - |
| `--name`, `-n` | Annotation config name (required; prompts if omitted) |
| `--space`, `-s` | Space name or ID (required; prompts if omitted) |
| `--output`, `-o` | Output format (`table`, `json`, `csv`, `parquet`) or file path |
| `--verbose`, `-v` | Enable verbose logs |

**Examples:**

Categorical (discrete labels):

```bash theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
ax annotation-configs create categorical \
  --name "accuracy" \
  --space sp_abc123 \
  --value accurate \
  --value inaccurate \
  --optimization-direction MAXIMIZE
```

Continuous (numeric score range):

```bash theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
ax annotation-configs create continuous \
  --name "relevance" \
  --space sp_abc123 \
  --min-score 0.0 \
  --max-score 1.0 \
  --optimization-direction MAXIMIZE
```

Freeform (free-text feedback, no scoring):

```bash theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
ax annotation-configs create freeform \
  --name "reviewer-notes" \
  --space sp_abc123
```

## `ax annotation-configs get`

Retrieve a single annotation config by name or ID.

```bash theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
ax annotation-configs get <name-or-id> [--space <name_or_id>] [--output <fmt>] [--verbose]
```

| Option | Description |
| - | - |
| `--space`, `-s` | Space name or ID (required when using annotation config name instead of ID) |
| `--output`, `-o` | Output format (`table`, `json`, `csv`, `parquet`) or file path |
| `--verbose`, `-v` | Enable verbose logs |

**Examples:**

```bash theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
ax annotation-configs get ac_xyz789
ax annotation-configs get "accuracy" --space my-space
```

## `ax annotation-configs update`

Update an annotation config. Choose the subcommand matching the config's type: `continuous`, `categorical`, or `freeform`. Only the fields you pass are changed; omitted fields are left unchanged.

### `ax annotation-configs update continuous`

```bash theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
ax annotation-configs update continuous <name-or-id> [--space <id>] [--new-name <name>] [--min-score <n>] [--max-score <n>] [--optimization-direction <dir>] [--output <fmt>] [--verbose]
```

| Option | Description |
| - | - |
| `--space`, `-s` | Space name or ID (required when using a name instead of an ID) |
| `--new-name` | New name for the annotation config |
| `--min-score` | New minimum score |
| `--max-score` | New maximum score |
| `--optimization-direction` | New optimization direction (`MAXIMIZE`, `MINIMIZE`, or `NONE`) |
| `--output`, `-o` | Output format (`table`, `json`, `csv`, `parquet`) or file path |
| `--verbose`, `-v` | Enable verbose logs |

### `ax annotation-configs update categorical`

```bash theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
ax annotation-configs update categorical <name-or-id> [--space <id>] [--new-name <name>] [--value <label> ...] [--optimization-direction <dir>] [--output <fmt>] [--verbose]
```

| Option | Description |
| - | - |
| `--space`, `-s` | Space name or ID (required when using a name instead of an ID) |
| `--new-name` | New name for the annotation config |
| `--value` | Replacement label value — repeat for multiple |
| `--optimization-direction` | New optimization direction (`MAXIMIZE`, `MINIMIZE`, or `NONE`) |
| `--output`, `-o` | Output format (`table`, `json`, `csv`, `parquet`) or file path |
| `--verbose`, `-v` | Enable verbose logs |

### `ax annotation-configs update freeform`

```bash theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
ax annotation-configs update freeform <name-or-id> [--space <id>] [--new-name <name>] [--output <fmt>] [--verbose]
```

| Option | Description |
| - | - |
| `--space`, `-s` | Space name or ID (required when using a name instead of an ID) |
| `--new-name` | New name for the annotation config |
| `--output`, `-o` | Output format (`table`, `json`, `csv`, `parquet`) or file path |
| `--verbose`, `-v` | Enable verbose logs |

**Examples:**

```bash theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
ax annotation-configs update continuous relevance --max-score 5.0
ax annotation-configs update categorical accuracy --value accurate --value inaccurate
ax annotation-configs update freeform reviewer-notes --new-name "review-notes"
```

## `ax annotation-configs delete`

Delete an annotation config by name or ID. This operation is irreversible.

```bash theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
ax annotation-configs delete <name-or-id> [--space <name_or_id>] [--force] [--verbose]
```

| Option | Description |
| - | - |
| `--space`, `-s` | Space name or ID (required when using annotation config name instead of ID) |
| `--force`, `-f` | Skip the confirmation prompt |
| `--verbose`, `-v` | Enable verbose logs |

**Examples:**

```bash theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
ax annotation-configs delete ac_xyz789 --force
ax annotation-configs delete "accuracy" --space my-space --force
```