annotation_specs get_with_label_id_replaced_english_name#
Description#
ラベルIDをUUIDから英語名に置換したアノテーション仕様のJSONを出力します。
アノテーション仕様は変更しません。画面のインポート機能を使って、アノテーション仕様を変更することを想定しています。
相関制約をJSONで直接設定する際などに利用すると便利です。IDをがUUID形式から分かりやすい名前になるため、JSON記述しやすくなります。
警告
既にアノテーションが存在する状態でラベルIDを変更すると、既存のアノテーション情報が消える恐れがあります。十分注意して、IDを変更してください。
Examples#
基本的な使い方#
# 元のアノテーション仕様の最初のラベル情報を出力
$ annofabcli annotation_specs list_label --project_id prj1 \
--format pretty_json | jq ".[0]"
{
"label_id": "8ec9417b-abef-47ad-af7d-e0a03c680eac",
"label_name": {
"messages": [
{
"lang": "ja-JP",
"message": "天気"
},
{
"lang": "en-US",
"message": "weather"
}
],
"default_lang": "ja-JP"
},
...
}
# ラベルIDを英語名に変更したアノテーション仕様を出力
$ annofabcli annotation_specs get_with_label_id_replaced_english_name --project_id prj1 --out out.json
$ jq ".labels[0]" out.json
{
"label_id": "weather",
"label_name": {
"messages": [
{
"lang": "ja-JP",
"message": "天気"
},
{
"lang": "en-US",
"message": "weather"
}
],
"default_lang": "ja-JP"
},
...
}
特定のラベルのラベルIDのみ変更する場合は、 --label_name
を指定してください。
$ annofabcli annotation_specs get_with_label_id_replaced_english_name --project_id prj1 \
--label_name weather car --out out.json
Usage Details#
ラベルIDをUUIDから英語名に置換したアノテーション仕様のJSONを出力します。 アノテーション仕様は変更しません。画面のインポート機能を使って、アノテーション仕様を変更することを想定しています。 相関制約をJSONで直接設定する際などに利用すると便利です。IDをがUUID形式から分かりやすい名前になるため、JSON記述しやすくなります。 【注意】既にアノテーションが存在する状態でラベルIDを変更すると、既存のアノテーション情報が消える恐れがあります。十分注意して、IDを変更してください。
usage: annofabcli annotation_specs get_with_label_id_replaced_english_name
[-h] [--yes] [--endpoint_url ENDPOINT_URL]
[--annofab_user_id ANNOFAB_USER_ID]
[--annofab_password ANNOFAB_PASSWORD] [--logdir LOGDIR] [--disable_log]
[--debug] -p PROJECT_ID [--label_name LABEL_NAME [LABEL_NAME ...]]
[-o OUTPUT] [-f {json,pretty_json}]
Named Arguments#
- -p, --project_id
対象のプロジェクトのproject_idを指定します。
- --label_name
置換対象のラベルの英語名
- -o, --output
出力先のファイルパスを指定します。未指定の場合は、標準出力に出力されます。
- -f, --format
Possible choices: json, pretty_json
出力フォーマットを指定します。
Default: "pretty_json"
global optional arguments#
- --yes
処理中に現れる問い合わせに対して、常に
yes
と回答します。- --endpoint_url
Annofab WebAPIのエンドポイントを指定します。
Default: "https://annofab.com"
- --annofab_user_id
Annofabにログインする際のユーザーID
- --annofab_password
Annofabにログインする際のパスワード
- --logdir
ログファイルを保存するディレクトリを指定します。
Default: .log
- --disable_log
ログを無効にします。
- --debug
HTTPリクエストの内容やレスポンスのステータスコードなど、デバッグ用のログが出力されます。