annotation_specs update_label_field_values#

Description#

アノテーション仕様の既存ラベルに設定された field_values を、マージ・置換・クリアのいずれかで更新します。 field_values にはサイズ制約や許容誤差範囲などの情報を設定できます。

Examples#

既存の `field_values` にマージする場合#

field_values.json#

    {
    // 矩形のサイズ制約（幅また高さが20px以上）
            "minimum_size_2d_with_default_insert_position": {
                    "min_warn_rule": {
                            "_type": "Or"
                    },
                    "min_width": 20,
                    "min_height": 20,
                    "position_for_minimum_bounding_box_insertion": null,
                    "_type": "MinimumSize2dWithDefaultInsertPosition"
            }
    }

注釈

field_values のフォーマットは、 getAnnotationSpecs API のレスポンス（ AnnotationSpecsV3 ）配下の field_values を参照してください。

なお、 annotation_specs list_label コマンドの出力結果で、各ラベルの field_values を確認できます。

$ annofabcli annotation_specs update_label_field_values \
 --project_id prj1 \
 --label_name_en car bus \
 --field_values_json file://field_values.json

`field_values` 全体を置換する場合#

$ annofabcli annotation_specs update_label_field_values \
 --project_id prj1 \
 --label_name_en car \
 --field_values_json file://field_values.json \
 --replace

`field_values` をクリアする場合#

$ annofabcli annotation_specs update_label_field_values \
 --project_id prj1 \
 --label_id label1 label2 \
 --clear

Usage Details#

アノテーション仕様の既存ラベルに設定された field_values を、マージ・置換・クリアのいずれかで更新します。field_values にはサイズ制約や許容誤差範囲などの情報を設定できます。

usage: annofabcli annotation_specs update_label_field_values
       [-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 ...])
       (--field_values_json FIELD_VALUES_JSON | --clear) [--replace]
       [--comment COMMENT]

Named Arguments#

-p, --project_id: 対象のプロジェクトのproject_idを指定します。
--label_name_en: 更新する対象ラベルの英語名。複数指定できます。 file:// を先頭に付けると一覧ファイルを指定できます。
--label_id: 更新する対象ラベルのlabel_id。複数指定できます。 file:// を先頭に付けると一覧ファイルを指定できます。
--field_values_json: 更新するfield_valuesのJSONオブジェクト。 file:// を先頭に付けるとJSONファイルを指定できます。field_valuesのフォーマットはWebAPIの AnnotationTypeFieldValue を参照してください。
--clear: 対象ラベルの field_values を空辞書に更新します。
--replace: 既存の field_values にマージせず、指定したJSONオブジェクトで field_values 全体を置換します。
--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リクエストの内容やレスポンスのステータスコードなど、デバッグ用のログが出力されます。