annotation change_attributes#

Description#

アノテーションの属性を一括で変更します。 ただし、作業中状態のタスクのアノテーションは、属性を変更できません。

Examples#

基本的な使い方#

--task_id にアノテーション変更対象のタスクのtask_idを指定してください。

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

--attributes に、変更後の属性を指定してください。フォーマットは --annotation_query の attributes キーの値と同じフォーマットです。

以下のコマンドは、ラベル名（英語）の値が"car"であるアノテーションに対して、属性名(英語)が"occluded"である値をfalse（"occluded"チェックボックスをOFF）に変更します。

$ annofabcli annotation change_attributes --project_id prj1 --task_id file://task.txt \
--annotation_query '{"label": "car"}' \
--attributes '{"occluded": false}' \
--backup backup_dir/

--backup にディレクトリを指定すると、変更対象のタスクのアノテーション情報を、バックアップとしてディレクトリに保存します。 アノテーション情報の復元は、 annofabcli annotation restore コマンドで実現できます。

注釈

間違えてアノテーションを変更したときに復元できるようにするため、--backup を指定することを推奨します。

デフォルトでは完了状態のタスクのアノテーションは変更できません。完了状態のタスクのアノテーションも変更する場合は、--force を指定してください。

Usage Details#

アノテーションの属性を一括で変更します。ただし、作業中状態のタスクのアノテーションの属性は変更できません。間違えてアノテーション属性を変更したときに復元できるようにするため、 --backup でバックアップ用のディレクトリを指定することを推奨します。

usage: annofabcli annotation change_attributes [-h] [--yes]
                                               [--endpoint_url ENDPOINT_URL]
                                               [--annofab_user_id ANNOFAB_USER_ID]
                                               [--annofab_password ANNOFAB_PASSWORD]
                                               [--logdir LOGDIR]
                                               [--disable_log] [--debug] -p
                                               PROJECT_ID -t TASK_ID
                                               [TASK_ID ...] -aq
                                               ANNOTATION_QUERY --attributes
                                               ATTRIBUTES [--force]
                                               [--backup BACKUP]
                                               [--parallelism PARALLELISM]

Named Arguments#

-p, --project_id

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

-t, --task_id

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

-aq, --annotation_query

変更対象のアノテーションを検索する条件をJSON形式で指定します。file:// を先頭に付けると、JSON形式のファイルを指定できます。(ex): {"label": "car", "attributes":{"occluded" true} }

--attributes

変更後の属性をJSON形式で指定します。file:// を先頭に付けると、JSON形式のファイルを指定できます。(ex): {"occluded": false}

--force

完了状態のタスクのアノテーション属性も変更します。

--backup

アノテーションのバックアップを保存するディレクトリを指定してください。アノテーションの復元は annotation restore コマンドで実現できます。

--parallelism

並列度。指定しない場合は、逐次的に処理します。指定した場合は、--yes も指定してください。

global optional arguments#

--yes

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

--endpoint_url

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

Default: "https://annofab.com"

--annofab_user_id

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

--annofab_password

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

--logdir

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

Default: .log

--disable_log

ログを無効にします。

--debug

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

オーナロールを持つユーザで実行してください。

See also#