comment update_inspection#

Description#

検査コメントを更新します。

comment_id が一致するコメントが存在する場合だけ更新します。存在しない場合はスキップします。

注釈

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

Examples#

基本的な使い方#

--json に検査コメントの内容をJSON形式で指定すると、検査コメントを更新できます。

comment.json#

[
    {
        "task_id": "task1",
        "input_data_id": "input_data1",
        "comment_id": "comment1",
        "comment": "type属性が間違っています。",
        "data": {
            "x": 10,
            "y": 20,
            "_type": "Point"
        }
    }
]

JSONの各要素は1件の検査コメントを表します。
検査コメントのプロパティとして指定できるキーは以下の通りです。
- task_id：タスクID。必須。
- input_data_id：入力データID。必須。
- comment_id：コメントID。必須。
- comment：検査コメントの内容。必須。
- data：検査コメントの位置や区間。 annotation_id が指定されている場合はオプショナル。省略した場合は、アノテーション情報から自動補完されます。
- annotation_id：検査コメントに紐づくアノテーションのannotation_id。
- phrases：参照する定型指摘のIDの配列。

$ annofabcli comment update_inspection --project_id prj1 --json file://comment.json

CSV形式で指定する場合#

--csv にCSVファイルを指定すると、検査コメントを更新できます。

comment.csv#

task_id,input_data_id,comment_id,comment,data,annotation_id,phrases
task001,input001,comment001,type属性が間違っています。,"{""x"":10,""y"":20,""_type"":""Point""}",,
task001,input002,comment002,枠がズレています。,"{""x"":20,""y"":20,""_type"":""Point""}",anno123,"[""A1""]"

CSVの列は、JSONの各キーに対応しています。

並列処理#

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

$ annofabcli comment update_inspection --project_id prj1 --json file://comment.json \
--parallelism 4 --yes

Usage Details#

検査コメントを更新します。comment_idが存在しない場合はスキップします。

usage: annofabcli comment update_inspection [-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)
                                            [--parallelism {2,3,4}]

Named Arguments#

-p, --project_id

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

--json

更新する検査コメントの内容をJSON形式で指定してください。file:// を先頭に付けると、JSON形式のファイルを指定できます。

各コメントには comment_id を指定してください。

(ex) [{"task_id": "task1", "input_data_id": "input_data1", "comment_id": "comment1", "comment": "type属性が間違っています。", "data": {"x": 10, "y": 20, "_type": "Point"}}]

--csv

更新する検査コメントの内容をCSV形式で指定してください。 CSVには以下の列が必要です：

task_id （必須）: タスクID

input_data_id （必須）: 入力データID

comment_id （必須）: コメントID

comment （必須）: コメント本文

data （任意）: コメント位置情報（JSON形式の文字列。例: ``'{"x":10,"y":20,"_type":"Point"}' `` ）

annotation_id （任意）: 紐付けるアノテーションID

phrases （任意）: 定型指摘IDのリスト（JSON配列形式の文字列。例: ``'["ID1","ID2"]' `` ）

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

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