annotation_specs describe_label_attributes#

Description#

ラベルと、そのラベルで利用できる属性および選択肢の関係を、共有用のMarkdown形式で出力します。ラベル色、ショートカットキー、ID、指定していない言語の名前、属性制約および定型指摘は出力しません。読み込み専用の属性には、読み込み専用であることを記載します。

Examples#

基本的な使い方#

$ annofabcli annotation_specs describe_label_attributes --project_id prj1
# 「車」ラベル（矩形）

- 「向き」属性（ドロップダウン）
  - 前
  - 横
- 「遮蔽」属性（チェックボックス、読み込み専用）

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

名前は既定で日本語で出力します。英語名を出力する場合は --lang en を指定してください。

$ annofabcli annotation_specs describe_label_attributes --project_id prj1 --lang en
# Label "Car" (Bounding box)

- Attribute "Direction" (Dropdown)
  - Front
  - Side

--output を指定すると、Markdownファイルに出力できます。

$ annofabcli annotation_specs describe_label_attributes --project_id prj1 --output label_attributes.md

Usage Details#

ラベルと属性の関係を共有用のMarkdown形式で出力します。

usage: annofabcli annotation_specs describe_label_attributes
       [-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] [--lang {ja,en}] [-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として扱います。

--lang

Possible choices: ja, en

ラベル名、属性名、選択肢名の出力言語を指定します。

Default: 'ja'

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

すべてのプロジェクトメンバーロールで実行できます。