annotation_zip list_classification_annotation#

Description#

アノテーションZIPから全体アノテーション（Classification）の情報を出力します。

Examples#

基本的な使い方#

$ annofabcli annotation_zip list_classification_annotation --project_id prj1 --output out.json --format pretty_json

out.json#

[
  {
    "project_id": "proj1",
    "task_id": "task_00",
    "task_status": "complete",
    "task_phase": "annotation",
    "task_phase_stage": 1,
    "input_data_id": "i1",
    "input_data_name": "i1.jpg",
    "updated_datetime": "2023-10-01T12:00:00.000+09:00",
    "label": "climatic",
    "annotation_id": "ann1",
    "annotation_editor_url": "https://annofab.com/projects/proj1/tasks/task_00/editor?#i1/ann1",
    "attributes": {
      "weather": "sunny"
    }
  }
]

動画プロジェクトのアノテーションZIPを指定する#

--annotation で動画プロジェクトのアノテーションZIPまたはディレクトリを指定する場合は、--annotation_editor_type video を指定してください。

$ annofabcli annotation_zip list_classification_annotation \
    --annotation annotation.zip \
    --annotation_editor_type video \
    --output out.csv

特定のラベルのみ出力#

$ annofabcli annotation_zip list_classification_annotation --project_id prj1 --label_name climatic quality --output out.csv

出力項目について#

基本情報#

project_id : プロジェクトID
task_id : タスクID
task_status : タスクのステータス（not_started, working, complete, など）
task_phase : タスクのフェーズ（annotation, inspection, acceptance）
task_phase_stage : タスクのフェーズステージ（1から始まる整数）
input_data_id : 入力データID
input_data_name : 入力データ名
updated_datetime : アノテーションJSONの更新日時（ISO 8601形式）
label : ラベル名
annotation_id : アノテーションID
annotation_editor_url : アノテーションエディタのURL。対象のアノテーションを直接開くことができます。

属性情報#

attributes : 属性情報。JSON形式ではオブジェクト、CSV形式では attributes.属性名 の形式で列が追加されます。

Usage Details#

アノテーションZIPから全体アノテーション（Classification）の情報を出力します。

usage: annofabcli annotation_zip list_classification_annotation
       [-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]
       (--annotation ANNOTATION | -p PROJECT_ID)
       [--annotation_editor_type {image,video,3dpc}]
       [-f {csv,json,pretty_json}] [-o OUTPUT] [-tq TASK_QUERY]
       [-t TASK_ID [TASK_ID ...]] [--label_name LABEL_NAME [LABEL_NAME ...]]
       [--latest] [--temp_dir TEMP_DIR]

Named Arguments#

--annotation

アノテーションzip、またはzipを展開したディレクトリを指定します。

-p, --project_id

project_id。アノテーションZIPをダウンロードします。

--annotation_editor_type

Possible choices: image, video, 3dpc

--annotation で指定したアノテーションZIPに対応するアノテーションエディタの種類を指定します。未指定の場合は image としてURLを生成します。

-f, --format

Possible choices: csv, json, pretty_json

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

Default: 'csv'

-o, --output

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

-tq, --task_query

集計対象タスクを絞り込むためのクエリ条件をJSON形式で指定します。使用できるキーは task_id, status, phase, phase_stage です。 file:// を先頭に付けると、JSON形式のファイルを指定できます。

-t, --task_id

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

--label_name

指定したラベル名の全体アノテーションのみを対象にします。複数指定できます。

--latest

--annotation を指定しないとき、最新のアノテーションzipを参照します。このオプションを指定すると、アノテーションzipを更新するのに数分待ちます。

--temp_dir

指定したディレクトリに、アノテーションZIPなどの一時ファイルをダウンロードします。

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リクエストの内容やレスポンスのステータスコードなど、デバッグ用のログが出力されます。

アノテーションZIPをダウンロードする場合は、オーナロールまたはアノテーションユーザロールを持つユーザで実行してください。