annotation_specs update_labels#

Description#

アノテーション仕様の既存ラベルに設定された日本語名、色、キーバインド、 field_values を更新します。

label_id 、ラベル名(英語)、アノテーション種類は既存アノテーションへの影響を避けるため更新できません。

Examples#

JSON形式で指定する場合#

labels.json#

[
    {
        "label_name_en": "car",
        "label_name_ja": "車",
        "color": "#123456",
        "keybind": {
            "alt": false,
            "code": "Digit1",
            "ctrl": true,
            "shift": false
        },
        "field_values": {
            "margin_of_error_tolerance": {
                "max_pixel": 5,
                "_type": "MarginOfErrorTolerance"
            }
        }
    },
    {
        "label_id": "bike",
        "field_values_operation": "replace"
    }
]

$ annofabcli annotation_specs update_labels \
 --project_id prj1 \
 --label_json file://labels.json

field_values のフォーマットは、annotation_specs update_label_field_values を参照してください。

--label_json には、ラベル更新情報のJSON配列を指定してください。配列の各要素が1件のラベルに対応します。

キー	必須	説明
`label_id`	条件付き必須	更新対象ラベルの `label_id` 。 `label_name_en` とどちらか一方を指定してください。
`label_name_en`	条件付き必須	更新対象ラベルの英語名。 `label_id` とどちらか一方を指定してください。この値自体は更新されません。
`label_name_ja`	任意	更新後のラベル日本語名。
`color`	任意	更新後のラベルの色。 `#RRGGBB` 形式の16進数カラーコードを指定してください。
`keybind`	任意	更新後のキーボードショートカットのJSONオブジェクト。 `code` に指定できる値は、 KeyboardEvent.code を参照してください。
`field_values`	任意	更新するサイズ制約や許容誤差範囲などのJSONオブジェクト。 `field_values_operation` を省略した場合は既存の `field_values` にマージします。
`field_values_operation`	任意	`field_values` の更新方法。 `merge` または `replace` を指定できます。 `replace` を指定して `field_values` を省略した場合は、 `field_values` を空辞書に更新します。

CSV形式で指定する場合#

labels.csv#

label_id,label_name_en,label_name_ja,color,keybind,field_values,field_values_operation
,car,車,#123456,"{""alt"": false, ""code"": ""Digit1"", ""ctrl"": true, ""shift"": false}","{""margin_of_error_tolerance"": {""max_pixel"": 5, ""_type"": ""MarginOfErrorTolerance""}}",
bike,,,,,,replace

CSV形式では、 keybind 列と field_values 列だけはJSONオブジェクト文字列として指定してください。そのため、CSVセル全体を " で囲み、JSON内の " は "" のようにエスケープする必要があります。

$ annofabcli annotation_specs update_labels \
 --project_id prj1 \
 --label_csv labels.csv

Usage Details#

アノテーション仕様の既存ラベルに設定された日本語名、色、キーバインド、field_values を更新します。

usage: annofabcli annotation_specs update_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_json LABEL_JSON | --label_csv LABEL_CSV)
                                                 [--comment COMMENT]

Named Arguments#

-p, --project_id: 対象のプロジェクトのproject_idを指定します。
--label_json: 更新するラベル情報のJSON配列を指定します。 file:// を先頭に付けるとJSON形式のファイルを指定できます。各要素には label_id または label_name_en のどちらか一方が必要です。任意で label_name_ja , color , keybind , field_values , field_values_operation を指定できます。 (例) [{"label_name_en": "car", "label_name_ja": "車", "color": "#123456", "keybind": {"alt": false, "code": "Digit1", "ctrl": true, "shift": false}, "field_values": {"margin_of_error_tolerance": {"max_pixel": 5, "_type": "MarginOfErrorTolerance"}}}, {"label_id": "bike", "field_values_operation": "replace"}]
--label_csv: 更新するラベル情報のCSVファイルを指定します。 CSVには label_id または label_name_en 列のどちらか一方が必要です。任意で label_name_ja , color , keybind , field_values , field_values_operation 列を指定できます。 keybind 列と field_values 列にはJSONオブジェクト文字列を指定してください。
--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リクエストの内容やレスポンスのステータスコードなど、デバッグ用のログが出力されます。