annotation_specs list_annotation_import_info#

Description#

アノテーションをimportする際に参照すべき情報（ラベル、属性、選択肢）のみを出力します。

annotation import のJSONに指定するラベル名、属性名、選択肢名を確認するためのコマンドです。日本語名は、プロンプトや変換処理を書く際の参考情報として出力します。色情報、ID、キーバインドなど、 annotation import で直接参照せず、インポートデータを作成する際の判断にも不要な情報は出力しません。

Examples#

基本的な使い方#

$ annofabcli annotation_specs list_annotation_import_info --project_id prj1 --format pretty_json

過去のアノテーション仕様を出力する方法は、過去のアノテーション仕様を指定するを参照してください。

以下のコマンドは、最新より1つ前のアノテーション仕様を出力します。

$ annofabcli annotation_specs list_annotation_import_info --project_id prj1 --before 1

以下のコマンドは、history_idが"xxx"のアノテーション仕様を出力します。

$ annofabcli annotation_specs list_annotation_import_info --project_id prj1 --history_id xxx

出力結果#

JSON出力#

$ annofabcli annotation_specs list_annotation_import_info --project_id prj1 --format pretty_json --output out.json

out.json#

[
    {
        "label_name_en": "car",
        "label_name_ja": "車",
        "annotation_type": "bounding_box",
        "attributes": [
            {
                "attribute_name_en": "occluded",
                "attribute_name_ja": "遮蔽",
                "attribute_type": "flag",
                "read_only": false,
                "choices": []
            },
            {
                "attribute_name_en": "direction",
                "attribute_name_ja": "向き",
                "attribute_type": "select",
                "read_only": false,
                "choices": [
                    {
                        "choice_name_en": "front",
                        "choice_name_ja": "前"
                    },
                    {
                        "choice_name_en": "side",
                        "choice_name_ja": "横"
                    }
                ]
            }
        ]
    }
]

label_name_en : ラベル名（英語）。 annotation import の label に指定する値です。
label_name_ja : ラベル名（日本語）。プロンプトや変換処理を書く際の参考情報です。
annotation_type : アノテーションの種類。Web APIの AnnotationType に対応しています。
attributes : ラベルに指定できる属性情報の配列です。
- attribute_name_en : 属性名（英語）。 annotation import の attributes のキーに指定する値です。
- attribute_name_ja : 属性名（日本語）。プロンプトや変換処理を書く際の参考情報です。
- attribute_type : 属性の種類。WebAPIの AdditionalDataDefinitionType に対応しています。
- read_only : 読み込み専用の属性か否か。
- choices : 選択肢情報の配列です。属性の種類がラジオボタンまたはドロップダウン以外の場合は空配列です。
  - choice_name_en : 選択肢名（英語）。属性の種類がラジオボタンまたはドロップダウンの場合に、 annotation import の attributes の値として指定する値です。
  - choice_name_ja : 選択肢名（日本語）。プロンプトや変換処理を書く際の参考情報です。

Usage Details#

アノテーションをimportする際に参照すべき情報（ラベル、属性、選択肢）のみを出力します。

usage: annofabcli annotation_specs list_annotation_import_info
       [-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 | --annotation_specs_json_file ANNOTATION_SPECS_JSON_FILE)
       [--history_id HISTORY_ID | --before BEFORE | --updated_datetime UPDATED_DATETIME]
       [-f {json,pretty_json}] [-o OUTPUT]

Named Arguments#

-p, --project_id

対象のプロジェクトのproject_idを指定します。APIで取得したアノテーション仕様情報を元に出力します。

--annotation_specs_json_file

指定したアノテーション仕様のJSONファイルを指定します。JSONファイルに記載された情報を元に出力します。ただしアノテーション仕様の format_version は 3 である必要があります。

--history_id

参照するアノテーション仕様のhistory_id。指定しない場合は最新のアノテーション仕様を参照します。

--before

参照するアノテーション仕様が最新よりいくつ前かを指定します。たとえば 1 は最新より1個前を表します。

--updated_datetime

参照するアノテーション仕様の更新日時をISO 8601形式で指定します。日、分、秒、小数秒の精度で検索し、1件に特定できる必要があります。タイムゾーンを省略した場合はJSTとして扱います。

-f, --format

Possible choices: json, pretty_json

出力フォーマット

Default: 'json'

-o, --output

出力先のファイルパスを指定します。未指定の場合は、標準出力に出力されます。

common options (after the subcommand)#

--yes

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

--endpoint_url

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

--annofab_user_id

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

--annofab_password

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

--annofab_pat

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

--logdir

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

Default: .log

--disable_log

ログを無効にします。

--debug

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