annotation_specs add_choice_attribute#

Description#

アノテーション仕様に選択肢系属性(ラジオボタン/ドロップダウン)を追加し、指定したラベルへ紐付けます。

Examples#

JSON形式で指定する場合#

choices.json#
[
    {
        "choice_name_en": "front"
    },
    {
        "choice_id": "c2",
        "choice_name_en": "rear",
        "choice_name_ja": "後ろ",
        "is_default": true
    }
]
$ annofabcli annotation_specs add_choice_attribute \
 --project_id prj1 \
 --attribute_type choice \
 --attribute_name_en direction \
 --choice_json file://choices.json \
 --label_name_en car bus \

CSV形式で指定する場合#

choices.csv#
choice_id,choice_name_en,choice_name_ja,is_default
,front,,
c2,rear,後ろ,true
$ annofabcli annotation_specs add_choice_attribute \
 --project_id prj1 \
 --attribute_type select \
 --attribute_name_en direction \
 --choice_csv choices.csv \
 --label_id l1 l2

Usage Details#

アノテーション仕様に選択肢系属性(ラジオボタン/ドロップダウン)を追加し、指定したラベルへ紐付けます。

usage: annofabcli annotation_specs add_choice_attribute [-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
                                                        --attribute_type
                                                        {choice,select}
                                                        --attribute_name_en
                                                        ATTRIBUTE_NAME_EN
                                                        [--attribute_id ATTRIBUTE_ID]
                                                        [--attribute_name_ja ATTRIBUTE_NAME_JA]
                                                        (--choice_json CHOICE_JSON | --choice_csv CHOICE_CSV)
                                                        (--label_name_en LABEL_NAME_EN [LABEL_NAME_EN ...] | --label_id LABEL_ID [LABEL_ID ...])
                                                        [--comment COMMENT]

Named Arguments#

-p, --project_id

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

--attribute_type

Possible choices: choice, select

追加する属性の種類。 choice はラジオボタン、 select はドロップダウンです。

--attribute_name_en

追加する属性の英語名。

--attribute_id

追加する属性の属性ID。未指定の場合はUUIDv4を自動生成します。

--attribute_name_ja

追加する属性の日本語名。

--choice_json

追加する選択肢情報のJSON配列を指定します。 file:// を先頭に付けるとJSON形式のファイルを指定できます。 (例) [{"choice_id": "front", "choice_name_en": "front", "choice_name_ja": "前", "is_default": true}, {"choice_name_en": "rear"}]

--choice_csv

追加する選択肢情報のCSVファイルを指定します。 CSVには choice_name_en 列が必要です。 任意で choice_id , choice_name_ja , is_default 列を指定できます。

--label_name_en

属性を追加する対象ラベルの英語名。複数指定できます。 file:// を先頭に付けると一覧ファイルを指定できます。

--label_id

属性を追加する対象ラベルのlabel_id。複数指定できます。 file:// を先頭に付けると一覧ファイルを指定できます。

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