Skip to main content

AnnotationQueueItem

Evaluation object assigned to an annotation queue with completion state and attribution.

Usage profiles​

UsageFields and validation
In responsesView fields

In responses​

API JSON uses JSON field names (camelCase).

FieldTypePresenceMeaning
itemIdstringOptionalIdentifier of the dataset or annotation queue item.
queueIdstringOptionalIdentifier of the annotation queue.
objectIdstringOptionalIdentifier of the evaluation object addressed by the comment or queue item.
objectTypestring (EVAL_TARGET_TYPE_TRACE, EVAL_TARGET_TYPE_OBSERVATION, EVAL_TARGET_TYPE_DATASET_RUN, EVAL_TARGET_TYPE_SESSION) or integer (int32)OptionalKind of evaluation object addressed by the comment or annotation queue item.
statusstring (ANNOTATION_QUEUE_ITEM_STATUS_PENDING, ANNOTATION_QUEUE_ITEM_STATUS_COMPLETED) or integer (int32)OptionalCompletion state of the annotation queue item.
completedAtstring (date-time)OptionalTime when the operation was marked complete.
completedBystringOptionalIdentifier of the user who completed the annotation queue item.
createdAtstring (date-time)OptionalTime when this record was created.

Values of objectType​

Kind of evaluation object a score or evaluation configuration addresses.

ValueNo.FormMeaning
EVAL_TARGET_TYPE_TRACE1CanonicalA complete trace identified by its trace identifier.
EVAL_TARGET_TYPE_OBSERVATION2CanonicalA specific observation within a trace.
EVAL_TARGET_TYPE_DATASET_RUN3CanonicalAn evaluation run over a dataset.
EVAL_TARGET_TYPE_SESSION4CanonicalA session grouping multiple traces; session scores are attached directly by the harness.

Values of status​

Progress of a work item in a human annotation queue.

ValueNo.FormMeaning
ANNOTATION_QUEUE_ITEM_STATUS_PENDING1CanonicalThe item is waiting for its annotation to be completed.
ANNOTATION_QUEUE_ITEM_STATUS_COMPLETED2CanonicalAnnotation of the queue item has been completed.

Where used​

ReferenceRelationship
Complete an annotation queue itemPOST /api/v1/evals/complete-annotation-queue-item
List annotation queue itemsPOST /api/v1/evals/list-annotation-queue-items

Download the public reference contract.

Document: DOC-API-MODEL-annotation-queue-item.