annotation download#

Description#

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

Examples#

基本的な使い方#

以下のコマンドを実行すると、アノテーションZIPがダウンロードされます。アノテーションZIPのフォーマットについては https://annofab.com/docs/api/#section/Simple-Annotation-ZIP を参照してください。

$ annofabcli annotation download --project_id prj1 --output annotation.zip

作成したアノテーションは、03:00(JST)頃にアノテーションZIPに反映されます。現在のアノテーションの状態をアノテーションZIPに反映させたい場合は、--latest を指定してください。アノテーションZIPへの反映が完了したら、ダウンロードされます。ただし、データ数に応じて数分から数十分待ちます。

$ annofabcli annotation download --project_id prj1 --output annotation.zip --latest

FullアノテーションZIPダウンロード（非推奨）#

--download_full_annotation を指定すると、FullアノテーションZIPダウンロードされます。 FullアノテーションZIPのフォーマットについては https://annofab.com/docs/api/#section/Full-Annotation-ZIP を参照してください。

ただし、--download_full_annotation は非推奨です。将来、廃止される可能性があります。

$ annofabcli annotation download --project_id prj1 --output full-annotation.zip --download_full_annotation

Usage Details#

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

usage: annofabcli annotation download [-h] [--yes]
                                      [--endpoint_url ENDPOINT_URL]
                                      [--annofab_user_id ANNOFAB_USER_ID]
                                      [--annofab_password ANNOFAB_PASSWORD]
                                      [--mfa_code MFA_CODE] [--logdir LOGDIR]
                                      [--disable_log] [--debug] -p PROJECT_ID
                                      -o OUTPUT [--latest]
                                      [--download_full_annotation]

Named Arguments#

-p, --project_id: 対象のプロジェクトのproject_idを指定します。
-o, --output: ダウンロード先を指定します。
--latest: 現在のアノテーションの状態をアノテーションZIPに反映させてから、ダウンロードします。アノテーションZIPへの反映には、データ数に応じて数分から数十分かかります。
--download_full_annotation: [DEPRECATED] FullアノテーションZIPをダウンロードします。このオプションは、廃止予定のため非推奨です。

global optional arguments#

--yes

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

--endpoint_url

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

Default: "https://annofab.com"

--annofab_user_id

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

--annofab_password

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

--mfa_code

Annofabにログインする際のMFAコード

--logdir

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

Default: .log

--disable_log

ログを無効にします。

--debug

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

オーナロールまたはアノテーションユーザロールを持つユーザで実行してください。