comment create_inspection_simply#

Description#

comment create_inspection コマンドよりも、簡単に検査コメントを作成できます。

注釈

タスクが教師付けフェーズのときは、検査コメントを作成できません。検査コメントを作成するには、タスクのフェーズを「検査」または「受入」にする必要があります。

Examples#

基本的な使い方#

指定したタスクに、検査コメントを作成できます。 --comment に検査コメントの内容を指定してください。タスク内の先頭の入力データに、検査コメントが作成されます。

$ annofabcli comment create_inspection_simply --project_id prj1 --task_id task1 task2 \
 --comment "枠がズレています。"

--phrase_id に定型指摘IDも指定できます。

$ annofabcli comment create_inspection_simply --project_id prj1 --task_id task1 task2 \
 --comment "枠がズレています。 #ID1" --phrase_id ID1

自身が担当者ではないタスクに検査コメントを作成する#

自身が担当者ではないタスクに検査コメントを作成する場合は、 --change_operator_to_me を指定してください。このオプションを指定すると、タスクの担当者を一時的に自分自身へ変更して作業中状態にした後、検査コメントを作成します。処理後は元の担当者へ戻します。そのため、タスクの最終状態は未着手になります。

$ annofabcli comment create_inspection_simply --project_id prj1 --task_id task1 \
 --comment "枠がズレています。" --change_operator_to_me

休憩中または保留中のタスクに検査コメントを作成する#

comment create_inspection の「休憩中または保留中のタスクに検査コメントを作成する」を参照してください。

完了状態のタスクに検査コメントを作成する#

comment create_inspection の「完了状態のタスクに検査コメントを作成する」を参照してください。

$ annofabcli comment create_inspection_simply --project_id prj1 --task_id task1 \
--comment "枠がズレています。" --include_complete_task

検査コメントの位置や区間を指定する#

--comment_data に、検査コメントの位置や区間をJSON形式で指定することができます。

以下は、 --comment_data に渡すJSON文字列のサンプルです。

画像プロジェクト：(x=0,y=0)の位置に点#

{
    "x":0,
    "y":0,
    "_type": "Point"
}

動画プロジェクト：0〜100ミリ秒の区間#

{
    "start":0,
    "end":100,
    "_type": "Time"
}

--comment_data を指定しない場合は、以下の検査コメントが作成されます。

画像プロジェクト：点。先頭画像の左上に位置する。
動画プロジェクト：区間。動画の先頭に位置する。
カスタムプロジェクト（3dpc）：辺が1の立方体。先頭フレームの原点に位置する。

ただし、ビルトインのエディタプラグインを使用していないカスタムプロジェクトの場合は --custom_project_type が必須です。

$ annofabcli comment create_inspection_simply --project_id prj1 --task_id task1 \
--comment "weather属性を見直してください。" \
--custom_project_type 3dpc

並列処理#

以下のコマンドは、並列数4で実行します。

$ annofabcli comment create_inspection_simply --project_id prj1 --task_id t1 t2 t3 t4 \
--parallelism 4 --yes

Usage Details#

comment create_inspection コマンドよりも、簡単に検査コメントを作成します。

usage: annofabcli comment create_inspection_simply [-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
                                                   COMMENT
                                                   [--phrase_id PHRASE_ID [PHRASE_ID ...]]
                                                   [--comment_data COMMENT_DATA]
                                                   [--custom_project_type {3dpc}]
                                                   [--parallelism {2,3,4}]
                                                   [--include_break_task]
                                                   [--include_on_hold_task]
                                                   [--change_operator_to_me]
                                                   [--include_complete_task]

Named Arguments#

-p, --project_id

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

-t, --task_id

検査コメントを作成するタスクのtask_idを指定してください。 file:// を先頭に付けると、task_idの一覧が記載されたファイルを指定できます。

--comment

作成する検査コメントのメッセージを指定します。

--phrase_id

定型指摘コメントのIDを指定してください。

--comment_data

検査コメントを作成する位置や区間をJSON形式で指定します。 file:// を先頭に付けると、JSON形式のファイルを指定できます。デフォルトの検査コメントの種類と位置は以下の通りです。

画像プロジェクト：点。先頭画像の左上

動画プロジェクト：区間。動画の先頭

カスタムプロジェクト(3dpc)：辺が1の立方体。原点

--custom_project_type

Possible choices: 3dpc

[BETA] ビルトインのエディタプラグインを使用していないカスタムプロジェクトの種類を指定します。カスタムプロジェクトに対して、検査コメントの位置を指定しない場合は必須です。

--parallelism

Possible choices: 2, 3, 4

使用するプロセス数（並列度）を指定してください。指定する場合は必ず --yes を指定してください。指定しない場合は、逐次的に処理します。

--include_break_task

休憩中状態のタスクに対しても検査コメントを作成します。未指定の場合は、休憩中状態のタスクはスキップされます。

--include_on_hold_task

保留中状態のタスクに対しても検査コメントを作成します。ただし、検査コメントの作成後は保留中状態でなくなります。未指定の場合は、保留中状態のタスクはスキップされます。

--change_operator_to_me

自身が担当者ではないタスクに検査コメントを作成する場合に指定してください。タスクの担当者を一時的に自分自身に変更し、検査コメントの作成完了後に元へ戻します。

--include_complete_task

オーナーロールで完了状態のタスクに対しても検査コメントを作成します。受入フェーズが完了状態のタスクは、受入を取り消してから検査コメントを作成します。

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

チェッカーロールまたはオーナロールを持つユーザで実行してください。--include_complete_task を指定した場合は、オーナロールを持つユーザで実行してください。