annotation list_count#

Description#

task_idまたはinput_data_idで集約したアノテーションの個数を、CSV形式で出力します。

Examples#

基本的な使い方#

--annotation_query に、集計対象のアノテーションを検索するする条件をJSON形式で指定してください。 --annotation_query のサンプルは、 Command line options を参照してください。

以下のコマンドは、ラベル名（英語）が"car"であるアノテーションの個数をタスクごとに出力します。

$ annofabcli annotation list_count --project_id prj1 \
--annotation_query '{"label": "car"}' --output out_by_task.csv
out_by_task.csv#

task_id

annotation_count

task1

1

task2

2

デフォルトではタスクごとに集計します。入力データごとに出力する場合は、--group_by input_data_id を指定しでください。

$ annofabcli annotation list_count --project_id prj1 \
--annotation_query '{"label": "car"}' --group_by input_data_id --output out_by_input_data.csv
out_by_input_data.csv#

task_id

input_data_id

annotation_count

task1

input1

1

task1

input2

2

task2

input3

3

task2

input4

4

--task_id で集計対象タスクを絞り込むこともできます。

$ annofabcli annotation list_count --project_id prj1 \
--annotation_query '{"label": "car"}'  --task_id file://task.txt

注釈

--annotation_query にマッチするアノテーションの一覧から、アノテーションの個数を算出しいています。 したがって、 annotation_count 列の値は必ず0より大きいです。

警告

WebAPIの都合上、集計対象のアノテーションは10,000個までしか検索できません。 10,000件以上のアノテーションを集計する場合は、 annofabcli statistics list_annotation_count コマンドの使用を検討してください。

Usage Details#

task_idまたはinput_data_idで集約したアノテーションの個数を出力します。

usage: annofabcli annotation list_count [-h] [--yes]
                                        [--endpoint_url ENDPOINT_URL]
                                        [--annofab_user_id ANNOFAB_USER_ID]
                                        [--annofab_password ANNOFAB_PASSWORD]
                                        [--annofab_pat ANNOFAB_PAT]
                                        [--logdir LOGDIR] [--disable_log]
                                        [--debug] -p PROJECT_ID
                                        [-aq ANNOTATION_QUERY]
                                        [-t TASK_ID [TASK_ID ...] | -i
                                        INPUT_DATA_ID [INPUT_DATA_ID ...]]
                                        [--group_by {task_id,input_data_id}]
                                        [-o OUTPUT]
                                        [-f {csv,json,pretty_json}]

Named Arguments#

-p, --project_id

対象のプロジェクトのproject_idを指定します。

-aq, --annotation_query

アノテーションの検索クエリをJSON形式で指定します。 file:// を先頭に付けると、JSON形式のファイルを指定できます。

-t, --task_id

対象のタスクのtask_idを指定します。 file:// を先頭に付けると、task_idの一覧が記載されたファイルを指定できます。

-i, --input_data_id

対象の入力データのinput_data_idを指定します。 file:// を先頭に付けると、input_data_idの一覧が記載されたファイルを指定できます。

--group_by

Possible choices: task_id, input_data_id

アノテーションの個数をどの単位で集約するかを指定してます。

Default: 'task_id'

-o, --output

出力先のファイルパスを指定します。未指定の場合は、標準出力に出力されます。

-f, --format

Possible choices: csv, json, pretty_json

出力フォーマットを指定します。

Default: 'csv'

global optional arguments#

--yes

処理中に現れる問い合わせに対して、常に yes と回答します。

--endpoint_url

Annofab WebAPIのエンドポイントを指定します。

Default: 'https://annofab.com'

--annofab_user_id

Annofabにログインする際のユーザーID

--annofab_password

Annofabにログインする際のパスワード

--annofab_pat

Annofabにログインする際のパーソナルアクセストークン

--logdir

ログファイルを保存するディレクトリを指定します。

Default: .log

--disable_log

ログを無効にします。

--debug

HTTPリクエストの内容やレスポンスのステータスコードなど、デバッグ用のログが出力されます。

See also#