annotation delete_per_annotation

Description

task_id、input_data_id、annotation_id の一覧で指定したアノテーションを削除します。

作業中状態のタスクは削除できません。完了状態のタスクも削除するには、--include_complete_task を指定してください。

削除前のバックアップを保存するには、--backup を指定してください。 復元方法は annotation restore を参照してください。

Examples

CSVに annotation_id を指定して削除する

CSVのフォーマットは以下の通りです。

• カンマ区切り

• ヘッダ行あり

列名	必須	備考
task_id	Yes
input_data_id	Yes
annotation_id	Yes

以下はCSVファイルのサンプルです。

annotation.csv

task_id,input_data_id,annotation_id
t1,i1,a1
t1,i1,a2
t2,i2,a3

$ annofabcli annotation delete_per_annotation --project_id p1 --csv annotation.csv --backup backup_dir/

annotation_id をJSON形式で指定して削除する

以下は、JSONファイルのサンプルです。

annotation.json

[
    {
        "task_id": "t1",
        "input_data_id":"i1",
        "annotation_id": "a1"
    }
]

JSONのキーは、 --csv に指定するCSVファイルの列に対応します。 --json にJSON形式の文字列、またはJSONファイルのパスを指定できます。

$ annofabcli annotation delete_per_annotation --project_id p1 --json file://annotation.json --backup backup_dir/

Usage Details

ID一覧で指定されたアノテーションを削除します。作業中状態のタスクは削除できません。復元用に --backup の指定を推奨します。

usage: annofabcli annotation delete_per_annotation [-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
                                                   (--json JSON | --csv CSV)
                                                   [--include_complete_task]
                                                   [--backup BACKUP]
                                                   [--parallelism {2,3,4}]

Named Arguments

-p, --project_id

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

--json

削除対象をtask_id、input_data_id、annotation_idを持つJSONオブジェクトの配列で指定します。先頭に file:// を付けるとJSONファイルを指定できます。

--csv

削除対象をCSVファイルで指定します。task_id、input_data_id、annotation_id列が必要です。

--include_complete_task

完了状態のタスクに含まれるアノテーションも削除します。オーナーロールが必要です。

--backup

削除前のアノテーションを保存するディレクトリ。復元には annotation restore を使用してください。

--parallelism

Possible choices: 2, 3, 4

並列に処理するタスク数。指定する場合は --yes も指定してください。

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

オーナーまたはチェッカーロールを持つユーザーで実行してください。--include_complete_task を指定する場合は、オーナーロールが必要です。

See also

• annotation delete

• annotation restore