annotation delete

Description

タスク配下のアノテーションを削除します。 ただし、完了状態のタスクのアノテーションは削除できません。

Examples

基本的な使い方

--task_id に削除対象のタスクのtask_idを指定してください。

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

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

注釈

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

削除するアノテーションを絞り込む場合は、--annotation_query を指定してください。 --annotation_query のサンプルは、Command line options を参照してください。

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

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

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

Usage Details

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

usage: annofabcli annotation delete [-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]
                                    [--force] [--backup BACKUP]

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} }

--force

完了状態のタスクのアノテーションを削除します。

--backup

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

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

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