Requête des éléments de la file d'attente d'annotation

Interroger les éléments d’une file d’attente d’annotation avec pagination et tri.

POST /annotation_queues/{queue_id}/items/query

Requête des éléments de la file d'attente d'annotation

cURL

curl --request POST \
  --url https://api.example.com/annotation_queues/{queue_id}/items/query \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "project_id": "<string>",
  "filter": {
    "added_by": "<string>",
    "annotation_states": [
      "unstarted",
      "in_progress"
    ],
    "call_id": "<string>",
    "call_op_name": "<string>",
    "call_trace_id": "<string>",
    "id": "<string>"
  },
  "include_position": false,
  "limit": 50,
  "offset": 0,
  "sort_by": [
    {
      "field": "<string>"
    }
  ]
}
'

200

{
  "items": [
    {
      "call_id": "<string>",
      "call_op_name": "<string>",
      "call_started_at": "2023-11-07T05:31:56Z",
      "call_trace_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "created_by": "<string>",
      "display_fields": [
        "<string>"
      ],
      "id": "<string>",
      "project_id": "<string>",
      "queue_id": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "added_by": "<string>",
      "annotator_user_id": "<string>",
      "call_ended_at": "2023-11-07T05:31:56Z",
      "deleted_at": "2023-11-07T05:31:56Z",
      "position_in_queue": 123
    }
  ]
}

Autorisations

Authorization · string · header · requis

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Paramètres de chemin

queue_id · string · requis

Corps

application/json

Corps de la requête pour interroger les éléments d’une file d'attente d'annotation (queue_id provient du chemin).

project_id · string · requis

Exemple:

"entity/project"

filter · AnnotationQueueItemsFilter · object

Filtrer les éléments de la file d'attente par métadonnées d’appel et état d’annotation

Show child attributes

include_position · boolean · défaut: false

Inclure le champ position_in_queue (index commençant à 1 dans la file d'attente complète)

limit · integer | null

Exemple:

50

offset · integer | null

Exemple:

0

sort_by · SortBy · object[] | null

Trier par plusieurs champs (par ex. created_at, updated_at)

Show child attributes

Réponse

200

application/json

Réponse réussie

Réponse à l’interrogation des éléments de la file d'attente d'annotation.

items · AnnotationQueueItemSchema · object[] · requis

Show child attributes