annotation_specs delete_labels#

Description#

アノテーション仕様からラベルを削除します。

削除対象ラベルだけが参照している属性も削除します。また、削除対象ラベルまたは削除される属性に関連する属性制約も削除します。

Examples#

ラベル名を指定して削除する#

以下のコマンドは、"car", "bus" ラベルを削除します。

$ annofabcli annotation_specs delete_labels \
 --project_id prj1 \
 --label_name_en car bus

ラベルIDを指定して削除する#

$ annofabcli annotation_specs delete_labels \
 --project_id prj1 \
 --label_id label1 label2

既存アノテーションに影響する変更を許可する#

削除対象ラベルが既存アノテーションで使われている場合は、デフォルトでは削除できません。既存アノテーションに影響することを理解した上でラベルを削除する場合は、 --allow_affecting_annotations を指定してください。

$ annofabcli annotation_specs delete_labels \
 --project_id prj1 \
 --label_name_en car bus \
 --allow_affecting_annotations

Usage Details#

アノテーション仕様からラベルを複数件削除します。

usage: annofabcli annotation_specs delete_labels [-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
                                                 (--label_name_en LABEL_NAME_EN [LABEL_NAME_EN ...] | --label_id LABEL_ID [LABEL_ID ...])
                                                 [--allow_affecting_annotations]
                                                 [--comment COMMENT]

Named Arguments#

-p, --project_id: 対象のプロジェクトのproject_idを指定します。
--label_name_en: 削除するラベルの英語名。複数指定できます。 file:// を先頭に付けると一覧ファイルを指定できます。
--label_id: 削除するラベルのlabel_id。複数指定できます。 file:// を先頭に付けると一覧ファイルを指定できます。
--allow_affecting_annotations: 指定すると、既存アノテーションに影響する変更でもラベルを削除します。
--comment: アノテーション仕様の変更内容を説明するコメント。未指定の場合、自動でコメントが生成されます。

global optional arguments#

--yes

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

--endpoint_url

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

Default: 'https://annofab.com'

--annofab_user_id

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

--annofab_password

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

--annofab_pat

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

--logdir

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

Default: .log

--disable_log

ログを無効にします。

--debug

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