annotation delete_invalid_attribute_value#

Description#

ラベルに含まれていない属性値を削除します。 アノテーション自体は削除しません。

アノテーションを付与した後に、アノテーション仕様画面で「属性XをラベルAから削除する」といった変更を行うと、Annofabのアノテーションエディタ画面にエラーアイコンが表示されます。 このエラーを解消するには、アノテーションエディタ画面で対象フレームを保存する必要があります。 ただし、対象フレームが多い場合、画面上で1件ずつ保存するのは手間がかかります。 そのような場合は、このコマンドを利用することで、ラベルに含まれていない属性値を一括で削除できます。

Examples#

基本的な使い方#

--task_id に属性値削除対象のタスクのtask_idを指定してください。 全タスクを対象にする場合は --all_tasks を指定してください。指定方法は --all_tasks を参照してください。 ただし、プロジェクト内のタスク数が10,000件を超える場合は、全タスクを安全に取得できないため処理を中断します。その場合は --task_id で対象タスクを絞り込んでください。

$ annofabcli annotation delete_invalid_attribute_value --project_id prj1 --task_id file://task.txt \
--backup backup_dir/

プロジェクト内の全タスクを対象にする#

$ annofabcli annotation delete_invalid_attribute_value --project_id prj1 --all_tasks --backup backup_dir/

注釈

--all_tasks を指定したときに、プロジェクト内のタスク数が10,000件を超える場合は処理を中断します。必要に応じて --task_id で対象タスクを絞り込んでください。

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

注釈

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

注釈

作業中状態のタスクに含まれるアノテーションは変更できません。 完了状態のタスクのアノテーションは、デフォルトでは変更できません。 --include_complete_task を指定すれば、完了状態のタスクに含まれるアノテーションも変更できます。ただし、--include_complete_task はオーナーロールを持つユーザーでしか実行できません。

Usage Details#

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

usage: annofabcli annotation delete_invalid_attribute_value
       [-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 ...] | --all_tasks) [--include_complete_task]
       [--backup BACKUP]

Named Arguments#

-p, --project_id

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

-t, --task_id

対象のタスクのtask_idを指定します。 file:// を先頭に付けると、task_idの一覧が記載されたファイルを指定できます。 --all_tasks とは同時に指定できません。 ファイルを読み込む場合は、ファイル指定を1個だけ渡してください。直接指定する値や別のファイル指定とは併用できません。

--all_tasks

プロジェクト内の全タスクを対象にします。タスクの状態などによるスキップ条件は適用されます。 --task_id とは同時に指定できません。

--include_complete_task

完了状態のタスクの、ラベルに含まれていない属性値も削除します。ただし、オーナーロールを持つユーザーでしか実行できません。

--backup

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

common options (after the subcommand)#

--yes

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

--endpoint_url

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

--annofab_user_id

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

--annofab_password

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

--annofab_pat

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

--logdir

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

Default: .log

--disable_log

ログを無効にします。

--debug

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

オーナロールまたはチェッカーロールを持つユーザで実行してください。

See also#