comment create_onhold# Description# 保留コメントを作成します。 comment_id が一致するコメントが既に存在する場合はスキップします。既存コメントを変更する場合は、 comment update_onhold コマンドを使用してください。 Examples# 基本的な使い方# --json に保留コメントの内容をJSON形式で指定すると、保留コメントを作成できます。 comment.json# [ { "task_id": "task1", "input_data_id": "input_data1", "comment": "画像が間違っています。" }, { "task_id": "task1", "input_data_id": "input_data2", "comment": "確認が必要です。", "annotation_id": "foo", "comment_id": "comment1" } ] JSONの各要素は1件の保留コメントを表します。 保留コメントのプロパティとして指定できるキーは以下の通りです。 task_id：タスクID。必須。 input_data_id：入力データID。必須。 comment：コメントの内容。必須。 annotation_id：コメントに紐づくアノテーションのannotation_id。 comment_id：コメントID。省略した場合は自動的にUUIDv4が生成されます。 $ annofabcli comment create_onhold --project_id prj1 --json file://comment.json 自身が担当者ではないタスクに保留コメントを作成する# オーナーまたはチェッカーロールで、自身が担当者ではないタスクに保留コメントを作成する場合は、 --change_operator_to_me を指定してください。タスクの担当者を一時的に自分自身へ変更して保留コメントを作成し、処理後に元の担当者へ戻します。ワーカーロールは、自身が担当するタスクだけに保留コメントを作成できます。 $ annofabcli comment create_onhold --project_id prj1 --json file://comment.json \ --change_operator_to_me 休憩中状態・保留中状態のタスクに保留コメントを作成する# デフォルトでは、休憩中状態と保留中状態のタスクはスキップします。休憩中状態のタスクも処理する場合は --include_break_task 、保留中状態のタスクも処理する場合は --include_on_hold_task を指定してください。 保留中状態のタスクを処理した場合、保留コメントの作成後は休憩中状態になります。 $ annofabcli comment create_onhold --project_id prj1 --json file://comment.json \ --include_break_task --include_on_hold_task CSV形式で指定する場合# --csv にCSVファイルを指定すると、保留コメントを作成できます。 comment.csv# task_id,input_data_id,comment,annotation_id,comment_id task001,input001,画像が間違っている,, task001,input002,確認が必要,anno789, CSVの列は、JSONの各キーに対応しています。 並列処理# 以下のコマンドは、並列数4で実行します。 $ annofabcli comment create_onhold --project_id prj1 --json file://comment.json \ --parallelism 4 --yes Usage Details# 保留コメントを作成します。comment_idがすでに存在する場合、デフォルトではスキップします。自身が担当者ではないタスクには、--change_operator_to_me を指定した場合だけ作成できます。 usage: annofabcli comment create_onhold [-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 (--json JSON | --csv CSV) [--change_operator_to_me] [--include_break_task] [--include_on_hold_task] [--parallelism {2,3,4}] Named Arguments# -p, --project_id 対象のプロジェクトのproject_idを指定します。 --json 作成する保留コメントの情報をJSON形式で指定してください。file:// を先頭に付けると、JSON形式のファイルを指定できます。 各コメントには comment_id を指定することができます。省略した場合は自動的にUUIDv4が生成されます。 (ex) [{"task_id": "task1", "input_data_id": "input_data1", "comment": "画像が間違っています。"}] --csv 作成する保留コメントの内容をCSV形式で指定してください。 CSVには以下の列が必要です： task_id （必須）: タスクID input_data_id （必須）: 入力データID comment （必須）: コメント本文 annotation_id （任意）: 紐付けるアノテーションID comment_id （任意）: コメントID（省略時はUUIDv4自動生成） --change_operator_to_me オーナーまたはチェッカーロールで、自身が担当者ではないタスクに保留コメントを作成する場合に指定してください。タスクの担当者を一時的に自分自身に変更し、保留コメントの作成完了後に元へ戻します。 --include_break_task 休憩中状態のタスクに対しても保留コメントを作成します。未指定の場合は、休憩中状態のタスクはスキップされます。 --include_on_hold_task 保留中状態のタスクに対しても保留コメントを作成します。ただし、保留コメントの作成後は休憩中状態になります。未指定の場合は、保留中状態のタスクはスキップされます。 --parallelism Possible choices: 2, 3, 4 使用するプロセス数（並列度）を指定してください。指定する場合は必ず --yes を指定してください。指定しない場合は、逐次的に処理します。 global optional arguments# --yes 処理中に現れる問い合わせに対して、常に yes と回答します。 --endpoint_url Annofab WebAPIのエンドポイントを指定します。 Default: 'https://annofab.com' --annofab_user_id Annofabにログインする際のユーザーID --annofab_password Annofabにログインする際のパスワード --annofab_pat Annofabにログインする際のパーソナルアクセストークン --logdir ログファイルを保存するディレクトリを指定します。 Default: .log --disable_log ログを無効にします。 --debug HTTPリクエストの内容やレスポンスのステータスコードなど、デバッグ用のログが出力されます。 ワーカーロールで実行する場合は、自身が担当するタスクだけに保留コメントを作成できます。--change_operator_to_me を指定する場合は、オーナーロールまたはチェッカーロールを持つユーザで実行してください。
comment create_onhold#
Description#
保留コメントを作成します。
comment_idが一致するコメントが既に存在する場合はスキップします。既存コメントを変更する場合は、 comment update_onhold コマンドを使用してください。Examples#
基本的な使い方#
--jsonに保留コメントの内容をJSON形式で指定すると、保留コメントを作成できます。JSONの各要素は1件の保留コメントを表します。
保留コメントのプロパティとして指定できるキーは以下の通りです。
task_id：タスクID。必須。input_data_id：入力データID。必須。comment：コメントの内容。必須。annotation_id：コメントに紐づくアノテーションのannotation_id。comment_id：コメントID。省略した場合は自動的にUUIDv4が生成されます。自身が担当者ではないタスクに保留コメントを作成する#
オーナーまたはチェッカーロールで、自身が担当者ではないタスクに保留コメントを作成する場合は、
--change_operator_to_meを指定してください。タスクの担当者を一時的に自分自身へ変更して保留コメントを作成し、処理後に元の担当者へ戻します。ワーカーロールは、自身が担当するタスクだけに保留コメントを作成できます。休憩中状態・保留中状態のタスクに保留コメントを作成する#
デフォルトでは、休憩中状態と保留中状態のタスクはスキップします。休憩中状態のタスクも処理する場合は
--include_break_task、保留中状態のタスクも処理する場合は--include_on_hold_taskを指定してください。保留中状態のタスクを処理した場合、保留コメントの作成後は休憩中状態になります。
CSV形式で指定する場合#
--csvにCSVファイルを指定すると、保留コメントを作成できます。CSVの列は、JSONの各キーに対応しています。
並列処理#
以下のコマンドは、並列数4で実行します。
Usage Details#
保留コメントを作成します。comment_idがすでに存在する場合、デフォルトではスキップします。自身が担当者ではないタスクには、
--change_operator_to_meを指定した場合だけ作成できます。usage: annofabcli comment create_onhold [-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 (--json JSON | --csv CSV) [--change_operator_to_me] [--include_break_task] [--include_on_hold_task] [--parallelism {2,3,4}]Named Arguments#
対象のプロジェクトのproject_idを指定します。
作成する保留コメントの情報をJSON形式で指定してください。
file://を先頭に付けると、JSON形式のファイルを指定できます。各コメントには
comment_idを指定することができます。省略した場合は自動的にUUIDv4が生成されます。(ex)
[{"task_id": "task1", "input_data_id": "input_data1", "comment": "画像が間違っています。"}]作成する保留コメントの内容をCSV形式で指定してください。 CSVには以下の列が必要です：
オーナーまたはチェッカーロールで、自身が担当者ではないタスクに保留コメントを作成する場合に指定してください。タスクの担当者を一時的に自分自身に変更し、保留コメントの作成完了後に元へ戻します。
休憩中状態のタスクに対しても保留コメントを作成します。未指定の場合は、休憩中状態のタスクはスキップされます。
保留中状態のタスクに対しても保留コメントを作成します。ただし、保留コメントの作成後は休憩中状態になります。未指定の場合は、保留中状態のタスクはスキップされます。
Possible choices: 2, 3, 4
使用するプロセス数（並列度）を指定してください。指定する場合は必ず
--yesを指定してください。指定しない場合は、逐次的に処理します。global optional arguments#
処理中に現れる問い合わせに対して、常に
yesと回答します。Annofab WebAPIのエンドポイントを指定します。
Default:
'https://annofab.com'Annofabにログインする際のユーザーID
Annofabにログインする際のパスワード
Annofabにログインする際のパーソナルアクセストークン
ログファイルを保存するディレクトリを指定します。
Default:
.logログを無効にします。
HTTPリクエストの内容やレスポンスのステータスコードなど、デバッグ用のログが出力されます。
ワーカーロールで実行する場合は、自身が担当するタスクだけに保留コメントを作成できます。
--change_operator_to_meを指定する場合は、オーナーロールまたはチェッカーロールを持つユーザで実行してください。