annotation_specs list_inspection_phrase#

Description#

アノテーション仕様の定型指摘情報を出力します。

Examples#

基本的な使い方#

$ annofabcli annotation_specs list_inspection_phrase --project_id prj1

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

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

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

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

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

出力結果#

CSV出力#

$ annofabcli annotation_specs list_inspection_phrase --project_id prj1 --format csv --output out.csv

out.csv#
inspection_phrase_id	inspection_phrase_text_en	inspection_phrase_text_ja	inspection_phrase_text_vi
phrase_blur	blurred	ぼやけています	mo

JSON出力#

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

out.json#

[
    {
        "inspection_phrase_id": "phrase_blur",
        "inspection_phrase_text_en": "blurred",
        "inspection_phrase_text_ja": "ぼやけています",
        "inspection_phrase_text_vi": "mo"
    }
]

inspection_phrase_id : 定型指摘ID
inspection_phrase_text_en : 定型指摘の本文（英語）
inspection_phrase_text_ja : 定型指摘の本文（日本語）
inspection_phrase_text_vi : 定型指摘の本文（ベトナム語）

Usage Details#

アノテーション仕様の定型指摘情報を出力します。

usage: annofabcli annotation_specs list_inspection_phrase [-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 {csv,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: csv, json, pretty_json

出力フォーマット

Default: 'csv'

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

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