アノテーションキュー項目クエリ

annotation queue内の項目をページネーションと並べ替えでクエリします。

POST /annotation_queues/{queue_id}/items/query

アノテーションキュー項目クエリ

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": {
    "id": "<string>",
    "call_id": "<string>",
    "call_op_name": "<string>",
    "call_trace_id": "<string>",
    "added_by": "<string>",
    "annotation_states": [
      "unstarted",
      "in_progress"
    ]
  },
  "sort_by": [
    {
      "field": "<string>",
      "direction": "asc"
    }
  ],
  "limit": 50,
  "offset": 0,
  "include_position": false
}
'

200

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

承認

Authorization · string · header · 必須

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

パスパラメータ

queue_id · string · 必須

ボディ

application/json

アノテーションキュー内の項目をクエリするためのリクエストボディ（queue_id はパスから取得）。

project_id · string · 必須

例:

"entity/project"

filter · AnnotationQueueItemsFilter · object

コールのメタデータとアノテーション状態でキュー項目をフィルター

Show child attributes

sort_by · SortBy · object[] | null

複数のフィールドで並べ替え（例: created_at、updated_at）

Show child attributes

limit · integer | null

例:

50

offset · integer | null

例:

0

include_position · boolean · デフォルト: false

position_in_queue フィールドを含める（キュー全体内での 1 始まりのインデックス）

レスポンス

200

application/json

成功レスポンス

アノテーションキュー項目をクエリした際のレスポンス。

items · AnnotationQueueItemSchema · object[] · 必須

Show child attributes