comment list#

Description#

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

Examples#

基本的な使い方#

以下のコマンドを実行すると、コメント（検査コメントまたは保留コメント）の一覧が出力されます。

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

--comment_type を指定すると、コメントの種類で絞り込めます。

# 検査コメントを出力
$ annofabcli comment list --project_id prj1 --task_id task1 task2 \
 --comment_type inspection

# 保留コメントを出力
$ annofabcli comment list --project_id prj1 --task_id task1 task2 \
 --comment_type onhold

デフォルトでは返信コメントも出力されます。返信コメントを除去する場合は、 --exclude_reply を指定してください。

$ annofabcli comment list --project_id prj1 --task_id task1 task2 \
 --exclude_reply

出力結果#

以下は、コメント投稿者のユーザー情報を取得できない場合の出力例です。

CSV出力#

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

out.csv#
project_id	task_id	input_data_id	comment_id	phase	phase_stage	account_id	comment_type	phrases	phrase_names_en	phrase_names_ja	comment	datetime_for_sorting	created_datetime	updated_datetime	reply_count	user_id	username	comment_node.data	comment_node.annotation_id	comment_node.label_id	comment_node.label_name_en	comment_node.label_name_ja	comment_node.status	comment_node._type	comment_node.data.x	comment_node.data.y	comment_node.data._type
prj1	task1	input_data1	comment1	acceptance	1	account1	onhold	[]	[]	[]	画像が間違っている	2022-07-05T11:45:21.968+09:00	2022-07-05T11:45:32.88+09:00	2022-07-05T11:45:32.88+09:00	1				8ec9417b-abef-47ad-af7d-e0a03c680eac	8ec9417b-abef-47ad-af7d-e0a03c680eac	car	自動車	open	Root
prj1	task1	input_data1	comment2	acceptance	1	account2	inspection	[]	[]	[]	枠がずれています	2022-07-05T11:45:08.506+09:00	2022-07-05T11:45:32.88+09:00	2022-07-05T11:45:32.88+09:00	0				8ec9417b-abef-47ad-af7d-e0a03c680eac	8ec9417b-abef-47ad-af7d-e0a03c680eac	car	自動車	open	Root	62.0	137.0	Point

JSON出力#

$ annofabcli comment list --project_id prj1 --task_id task1 --format pretty_json --output out.json

out.json#

[
{
    "project_id": "prj1",
    "task_id": "task1",
    "input_data_id": "input_data1",
    "comment_id": "comment1",
    "phase": "acceptance",
    "phase_stage": 1,
    "account_id": "account1",
    "comment_type": "onhold",
    "phrases": [],
    "phrase_names_en": [],
    "phrase_names_ja": [],
    "comment": "画像が間違っている",
    "comment_node": {
        "data": null,
        "annotation_id": "8ec9417b-abef-47ad-af7d-e0a03c680eac",
        "label_id": "8ec9417b-abef-47ad-af7d-e0a03c680eac",
        "label_name_en": "car",
        "label_name_ja": "自動車",
        "status": "open",
        "_type": "Root"
    },
    "datetime_for_sorting": "2022-07-05T11:45:21.968+09:00",
    "created_datetime": "2022-07-05T11:45:32.88+09:00",
    "updated_datetime": "2022-07-05T11:45:32.88+09:00",
    "reply_count": 1,
    "user_id": null,
    "username": null
},
{
    "project_id": "prj1",
    "task_id": "task1",
    "input_data_id": "input_data1",
    "comment_id": "comment2",
    "phase": "acceptance",
    "phase_stage": 1,
    "account_id": "account2",
    "comment_type": "inspection",
    "phrases": [],
    "phrase_names_en": [],
    "phrase_names_ja": [],
    "comment": "枠がずれています",
    "comment_node": {
        "data": {
            "x": 62,
            "y": 137,
            "_type": "Point"
        },
        "annotation_id": "8ec9417b-abef-47ad-af7d-e0a03c680eac",
        "label_id": "8ec9417b-abef-47ad-af7d-e0a03c680eac",
        "label_name_en": "car",
        "label_name_ja": "自動車",
        "status": "open",
        "_type": "Root"
    },
    "datetime_for_sorting": "2022-07-05T11:45:08.506+09:00",
    "created_datetime": "2022-07-05T11:45:32.88+09:00",
    "updated_datetime": "2022-07-05T11:45:32.88+09:00",
    "reply_count": 0,
    "user_id": null,
    "username": null
}
]

Usage Details#

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

usage: annofabcli comment list [-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 -t
                               TASK_ID [TASK_ID ...]
                               [--comment_type {inspection,onhold}]
                               [--exclude_reply]
                               [-f {csv,json,pretty_json,comment_id_list}]
                               [-o OUTPUT]

Named Arguments#

-p, --project_id

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

-t, --task_id

対象のタスクのtask_idを指定します。 file:// を先頭に付けると、task_idの一覧が記載されたファイルを指定できます。ファイルを読み込む場合は、ファイル指定を1個だけ渡してください。直接指定するIDや別のファイル指定とは併用できません。

--comment_type

Possible choices: inspection, onhold

コメントの種類で絞り込みます。

inspection: 検査コメント

onhold: 保留コメント

--exclude_reply

返信コメントを除外します。

-f, --format

Possible choices: csv, json, pretty_json, comment_id_list

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

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