Section ID:
DOC-API-MODEL-schema-1j9496mkdg#overview
AnnotationQueue
Named work queue assigning score configurations to human annotation items.
Meaning and usage
Section ID: DOC-API-MODEL-schema-1j9496mkdg#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-1j9496mkdg#fields
| Usage | Fields and validation |
|---|---|
| In responses | View fields |
In responses
Section ID: DOC-API-MODEL-schema-1j9496mkdg#response
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-1j9496mkdg#field-queueidSection ID: DOC-API-MODEL-schema-1j9496mkdg#response-field-queueidqueueId | string | Optional | Identifier of the annotation queue. |
Section ID: DOC-API-MODEL-schema-1j9496mkdg#field-nameSection ID: DOC-API-MODEL-schema-1j9496mkdg#response-field-namename | string | Optional | Display name of the annotation work queue. |
Section ID: DOC-API-MODEL-schema-1j9496mkdg#field-descriptionSection ID: DOC-API-MODEL-schema-1j9496mkdg#response-field-descriptiondescription | string | Optional | Human-readable description of the resource. |
Section ID: DOC-API-MODEL-schema-1j9496mkdg#field-scoreconfigidsSection ID: DOC-API-MODEL-schema-1j9496mkdg#response-field-scoreconfigidsscoreConfigIds | Array of string | Optional | Score configurations available when annotating items in this queue. At least one configuration is required. |
Section ID: DOC-API-MODEL-schema-1j9496mkdg#field-createdatSection ID: DOC-API-MODEL-schema-1j9496mkdg#response-field-createdatcreatedAt | string (date-time) | Optional | Time when this record was created. |
Section ID: DOC-API-MODEL-schema-1j9496mkdg#field-updatedatSection ID: DOC-API-MODEL-schema-1j9496mkdg#response-field-updatedatupdatedAt | string (date-time) | Optional | Time when this record was last updated. |
Section ID: DOC-API-MODEL-schema-1j9496mkdg#field-pendingcountSection ID: DOC-API-MODEL-schema-1j9496mkdg#response-field-pendingcountpendingCount | string (int64) | Optional | Number of queue items awaiting annotation. Pattern: ^-?\d+$. |
Section ID: DOC-API-MODEL-schema-1j9496mkdg#field-completedcountSection ID: DOC-API-MODEL-schema-1j9496mkdg#response-field-completedcountcompletedCount | string (int64) | Optional | Number of queue items reported completed. Pattern: ^-?\d+$. |
Where used
Section ID: DOC-API-MODEL-schema-1j9496mkdg#where-used
| Reference | Relationship |
|---|---|
| List annotation queues | POST /api/v1/evals/list-annotation-queues |
Download the public reference contract.
Document ID: DOC-API-MODEL-schema-1j9496mkdg