Update an annotation config
Update an annotation config by its ID.
Payload Requirements
annotation_config_typeis required and must match the stored config’s type. The type is immutable and cannot be changed.- The updatable fields depend on the type:
categorical:name,values,optimization_direction.continuous:name,minimum_score,maximum_score,optimization_direction.freeform:name.
- All fields other than
annotation_config_typeare optional; omitted fields are left unchanged. name, if provided, must be unique within the space (409 Conflict if duplicate).valuesreplaces the full label set (2-100 labels).- System-managed fields (
id,space_id,created_at) cannot be modified.
Valid example (categorical config)
{
"annotation_config_type": "categorical",
"name": "quality-v2",
"values": [
{ "label": "good", "score": 1 },
{ "label": "bad", "score": 0 }
],
"optimization_direction": "maximize"
}
Invalid example (missing annotation_config_type)
{
"name": "quality-v2"
}
Authorizations
Most Arize AI endpoints require authentication. For those endpoints that require authentication, include your API key in the request header using the format
Path Parameters
The unique annotation config identifier (base64) A universally unique identifier (base64-encoded opaque string).
"RW50aXR5OjEyMzQ1"
Body
Body containing annotation config update parameters. The annotation_config_type is required and must match the stored config's type.
- Option 1
- Option 2
- Option 3
The base annotation config update parameters
The type of annotation config:
- continuous: a numeric score within a defined range
- categorical: a set of labeled values each with an optional score
- freeform: free-text annotation with no structured scoring
continuous New name for the annotation config. Must be unique within the space.
New minimum score value.
New maximum score value.
New optimization direction.
maximize, minimize, none Response
An annotation config object
- Option 1
- Option 2
- Option 3
The unique identifier for the annotation config
The name of the annotation config
The timestamp for when the annotation config was created
The space id the annotation config belongs to
Discriminator value identifying a continuous annotation config.
continuous The minimum score value
The maximum score value
Direction for optimization. When absent, the server treats the value as none.
maximize, minimize, none