inspection_comment list

Description

検査コメントの一覧を出力します。

警告

非推奨なコマンドです。2022/12/01以降に廃止する予定です。 替わりに annofabcli comment list コマンドを使用してください。

Examples

基本的な使い方

--task_id に出力対象のタスクのtask_idを指定してください。

$ annofabcli inspection_comment list --project_id prj1 --task_id task1 task2

絞り込み

デフォルトでは指摘に対する返信コメントも出力します。返信コメントを除外する場合は、--exclude_reply を指定してください。自分自身が所属していて、進行中のプロジェクトが対象になります。

$ annofabcli inspection_comment list --project_id prj1 --task_id task1 task2 --exclude_reply

返信コメントのみ出力する場合は、--only_reply を指定してください。

$ annofabcli inspection_comment list --project_id prj1 --task_id task1 task2 --only_reply

出力結果

CSV出力

$ annofabcli inspection_comment list --project_id prj1 --task_id task1 \
 --format csv --output out.csv

out.csv

JSON出力

$ annofabcli inspection_comment list --format pretty_json --output out.json
out.json
[
    {
        "project_id": "prj1",
        "task_id": "task1",
        "input_data_id": "input1",
        "inspection_id": "inspection1",
        "phase": "annotation",
        "phase_stage": 1,
        "commenter_account_id": "account1",
        "annotation_id": null,
        "label_id": null,
        "data": {
        "x": 0,
        "y": 0,
        "_type": "Point"
        },
        "parent_inspection_id": null,
        "phrases": [],
        "comment": "test-comment",
        "status": "no_correction_required",
        "created_datetime": "2020-09-09T15:23:12.802+09:00",
        "updated_datetime": "2020-09-09T15:23:13.18+09:00",
        "commenter_user_id": "user1",
        "commenter_username": "test-user1",
        "phrase_names_en": [],
        "phrase_names_ja": [],
        "label_name_en": null,
        "label_name_ja": null,
        "input_data_index": 0
    },
    ...
]

Usage Details

[DEPRECATED] 検査コメント一覧を出力します。 2022/12/01以降に廃止する予定です。替わりに annofabcli comment list コマンドを利用してください。

usage: annofabcli inspection_comment list [-h] [--yes]
                                          [--endpoint_url ENDPOINT_URL]
                                          [--annofab_user_id ANNOFAB_USER_ID]
                                          [--annofab_password ANNOFAB_PASSWORD]
                                          [--logdir LOGDIR] [--disable_log]
                                          [--debug] -p PROJECT_ID -t TASK_ID
                                          [TASK_ID ...]
                                          [--only_reply | --exclude_reply]
                                          [-f {csv,json,pretty_json,inspection_id_list}]
                                          [-o OUTPUT]
                                          [--csv_format CSV_FORMAT] [-q QUERY]

Named Arguments

-p, --project_id

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

-t, --task_id

対象のタスクのtask_idを指定します。  file:// を先頭に付けると、task_idの一覧が記載されたファイルを指定できます。

--only_reply

返信コメントのみを出力する。

--exclude_reply

返信コメントを除外して出力する。

-f, --format

Possible choices: csv, json, pretty_json, inspection_id_list

出力フォーマットを指定します。

Default: "csv"

-o, --output

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

--csv_format

CSVのフォーマットをJSON形式で指定します。 --formatcsv でないときは、このオプションは無視されます。 file:// を先頭に付けると、JSON形式のファイルを指定できます。 指定した値は pandas.DataFrame.to_csv の引数として渡されます。

-q, --query

JMESPath形式で指定します。出力結果の抽出や、出力内容の変更に利用できます。

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