annotation dump#

Description#

annofabcli annotation restore コマンドに読み込ませることができるアノテーション情報を出力します。アノテーションのバックアップ目的で利用することを想定しています。

Examples#

基本的な使い方#

--task_id に出力対象のタスクのtask_idを指定して、 --output_dir に出力先ディレクトリのパスを指定してください。

$ annofabcli annotation dump --project_id prj1 --task_id file://task.txt --output_dir backup-dir/

出力先ディレクトリの構成は以下の通りです。 {input_data_id}.json のフォーマットは、https://annofab.com/docs/api/#operation/getEditorAnnotation APIのレスポンス AnnotationV2Output と同じです。

ルートディレクトリ/
├── {task_id}/
│   ├── {input_data_id}.json
│   ├── {input_data_id}/
│          ├── {annotation_id}............ 塗りつぶしPNG画像

アノテーション情報のリストアは、 annofabcli annotation restore コマンドで実現できます。

$ annofabcli annotation restore --project_id prj1 --annotation backup-dir/

警告

annotation dump コマンドの出力結果は、annotation restore コマンドに読み込ませることを目的として作られています。

annotation dump コマンドの出力結果であるJSONの構造は、現在 AnnotationV2Output 形式ですが、WebAPIの変更により今後変更する可能性はあります。 annotation dump コマンドの出力結果であるJSONの構造に直接依存したプログラムを作成する場合は、ご注意ください。

過去のアノテーション情報をダンプする#

--task_history_index または --task_history_id を指定すると、該当するタスク履歴で付与されたアノテーション情報をダンプできます。

--task_history_index : タスク履歴のインデックス（0始まり）を指定します。
--task_history_id : タスク履歴IDを直接指定します。

これらのオプションは排他的で、同時に指定することはできません。

たとえばタスク履歴が以下のような場合に --task_history_index 1 （0始まり）を指定すると、2番目（1始まり）のタスク履歴の完了日時である 2025/07/09 12:28:52 時点のアノテーション情報をダンプします。

警告

過去のアノテーション情報は30日間しか保存されません。 30日より前に保存されたアノテーション情報をダンプしようとした場合、アノテーションの結果（ details 配下）は0件の状態でダンプされます。

Usage Details#

annotation restore コマンドに読み込ませることができるアノテーション情報を出力します。アノテーションのバックアップ目的で利用することを想定しています。

usage: annofabcli annotation dump [-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 -t TASK_ID [TASK_ID ...] -o
                                  OUTPUT_DIR
                                  [--task_history_index TASK_HISTORY_INDEX | --task_history_id TASK_HISTORY_ID]
                                  [--parallelism {2,3,4}]

Named Arguments#

-p, --project_id

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

-t, --task_id

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

-o, --output_dir

出力先ディレクトリのパス

--task_history_index

指定したタスク履歴のインデックス（ゼロ始まり）で付与されたアノテーション情報をダンプします。過去のアノテーション結果をダンプする場合に指定します。ただし、過去のアノテーションデータは30日間しか保持されません。30日より前に更新されたアノテーションをダンプした場合は、アノテーションが0件の状態でダンプされます。

--task_history_id

指定したタスク履歴IDで付与されたアノテーション情報をダンプします。過去のアノテーション結果をダンプする場合に指定します。ただし、過去のアノテーションデータは30日間しか保持されません。30日より前に更新されたアノテーションをダンプした場合は、アノテーションが0件の状態でダンプされます。

--parallelism

Possible choices: 2, 3, 4

並列度。指定しない場合は、逐次的に処理します。

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