Get an annotation queue
Changed onGet an annotation queue object by its ID.
This includes the annotation queue's annotation configs, which define the structure of annotations that can be created in this queue.
This endpoint does not include queue records or annotation progress. To manage records in a queue, use the Annotation Queue Items endpoints.
Request
- Base URLhttps://api.arize.com
- URLhttps://api.arize.com/v2/annotation-queues/{annotation_queue_id}
- AuthHTTP bearer
Path parameters
A universally unique identifier (base64-encoded opaque string).
The unique annotation queue identifier (base64)
Response
An annotation queue object
Example response
{
"id": "aq_abc123",
"name": "Quality Review Queue",
"space_id": "spc_xyz789",
"instructions": "Review each response for accuracy and helpfulness",
"annotators": [
{
"email": "user@example.com"
}
],
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-20T14:45:00Z",
"column_allowlist": [
"context.trace_id",
"attributes.llm.input_messages",
"column with spaces"
]
}Changes
- info
added the optional property
to the response with the status
- info
- breaking
the
/////response's property type changed from no type toobjectfor status - breaking
the
/////response's property type changed from no type toobjectfor status - breaking
the
/////response's property type changed from no type toobjectfor status - info
api operation id
annotation_queues_getremoved and replaced withget_annotation_queue - info
removed the non-success response with the status
- info
added the optional property
//////to the response with the status - info
added the optional property
//////to the response with the status - info
removed
subschema #2from the/////response propertyallOflist for the response status - info
removed
subschema #2from the/////response propertyallOflist for the response status - info
removed
subschema #2from the/////response propertyallOflist for the response status - info
added
CONTINUOUSCATEGORICALFREEFORMdiscriminator mapping keys to the/response property for the response status - info
removed
continuouscategoricalfreeformdiscriminator mapping keys from the/response property for the response status - info
added the required property
//////to the response with the status - info
added the required property
//////to the response with the status - info
added the required property
//////to the response with the status - info
added the required property
//////to the response with the status - info
added the required property
//////to the response with the status - info
added the required property
//////to the response with the status - info
added the required property
//////to the response with the status - info
added the required property
//////to the response with the status - info
added the required property
//////to the response with the status - info
added the required property
//////to the response with the status - info
added the required property
//////to the response with the status - info
added the required property
//////to the response with the status - info
added the required property
//////to the response with the status - info
added the required property
//////to the response with the status - info
added the required property
//////to the response with the status - info
added the required property
//////to the response with the status - info
added the required property
//////to the response with the status - info
added the required property
//////to the response with the status
- breaking