comment put_inspection_simply#

Description#

comment put_inspection コマンドよりも、簡単に検査コメントを付与できます。

Examples#

基本的な使い方#

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

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

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

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

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

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

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

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

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

画像プロジェクト：(x=0,y=0),(x=100,y=100)のポリライン#

{
    "coordinates": [{"x":0, "y":0}, {"x":100, "y":100}],
    "_type": "Polyline"
}

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

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

カスタムプロジェクト（3dpc editor）：原点付近に辺が1の立方体#

{
    "data": "{\"kind\": \"CUBOID\", \"shape\": {\"dimensions\": {\"width\": 1.0, \"height\": 1.0, \"depth\": 1.0}, \"location\": {\"x\": 0.0, \"y\": 0.0, \"z\": 0.0}, \"rotation\": {\"x\": 0.0, \"y\": 0.0, \"z\": 0.0}, \"direction\": {\"front\": {\"x\": 1.0, \"y\": 0.0, \"z\": 0.0}, \"up\": {\"x\": 0.0, \"y\": 0.0, \"z\": 1.0}}}, \"version\": \"2\"}",
    "_type": "Custom"
}

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

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

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

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

並列処理#

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

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

Usage Details#

comment put_inspection コマンドよりも、簡単に検査コメントを付与します。

usage: annofabcli comment put_inspection_simply [-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 ...] --comment
                                                COMMENT
                                                [--phrase_id PHRASE_ID [PHRASE_ID ...]]
                                                [--comment_data COMMENT_DATA]
                                                [--custom_project_type {3dpc}]
                                                [--parallelism PARALLELISM]

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

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

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

チェッカーロールまたはオーナロールを持つユーザで実行してください。