> ## 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

<Note>
  The `ax annotation-configs` commands are currently in **BETA**. The API may change without notice. A one-time warning is emitted on first use.
</Note>

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={null}
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={null}
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`.

```bash theme={null}
ax annotation-configs create --name <name> --space <id> --type <type> [type-specific options] [--output <fmt>] [--verbose]
```

| Option                     | Description                                                                                       |
| -------------------------- | ------------------------------------------------------------------------------------------------- |
| `--name`, `-n`             | Annotation config name (required; prompts if omitted)                                             |
| `--space`, `-s`            | Space name or ID (required; prompts if omitted)                                                   |
| `--type`, `-t`             | Annotation config type: `categorical`, `continuous`, or `freeform` (required; prompts if omitted) |
| `--min-score`              | Minimum score (required for `continuous` type)                                                    |
| `--max-score`              | Maximum score (required for `continuous` type)                                                    |
| `--value`                  | Label for `categorical` type — repeat for multiple values (e.g. `--value good --value bad`)       |
| `--optimization-direction` | `maximize`, `minimize`, or `none`                                                                 |
| `--output`, `-o`           | Output format (`table`, `json`, `csv`, `parquet`) or file path                                    |
| `--verbose`, `-v`          | Enable verbose logs                                                                               |

**Examples:**

Categorical (discrete labels with optional scores):

```bash theme={null}
ax annotation-configs create \
  --name "accuracy" \
  --space sp_abc123 \
  --type categorical \
  --value accurate \
  --value inaccurate \
  --optimization-direction maximize
```

Continuous (numeric score range):

```bash theme={null}
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):

```bash theme={null}
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.

```bash theme={null}
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={null}
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.

```bash theme={null}
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={null}
ax annotation-configs delete ac_xyz789 --force
ax annotation-configs delete "accuracy" --space my-space --force
```