comment put_onhold#

Description#

保留コメントを付与します。

Examples#

基本的な使い方#

--json に保留コメントの内容をJSON形式で指定すると、保留コメントを付与できます。

comment.json#

{
    "task1":{
        "input_data1": [
            {
                "comment": "type属性が間違っています。",
            },
            {
                "comment": "枠がズレています。",
                "annotation_id": "foo",
            }
        ],
        "input_data2":[]
    },
    "task2": {
        "input_data3":[]
    }
}

1階層目のキーはtask_id, 2階層目のキーはinput_data_idです。
保留コメントのプロパティとして指定できるキーは以下の通りです。
- comment：コメントの内容。必須。
- annotation_id：コメントに紐づくアノテーションのannotation_id
- comment_id：コメントID。省略した場合は自動的にUUIDv4が生成されます。

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

CSV形式で指定する場合#

--csv にCSVファイルを指定すると、保留コメントを付与できます。

comment.csv#

task_id,input_data_id,comment,annotation_id,comment_id
task001,input001,画像が間違っている,,
task001,input002,確認が必要,anno789,

CSVには以下の列が必要です。
- task_id （必須）：タスクID
- input_data_id （必須）：入力データID
- comment （必須）：コメント本文
- annotation_id （任意）：紐付けるアノテーションID
- comment_id （任意）：コメントID（省略時はUUIDv4自動生成）

$ annofabcli comment put_onhold --project_id prj1 --csv comment.csv

並列処理#

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

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

Usage Details#

保留コメントを付与します

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

Named Arguments#

-p, --project_id

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

--json

付与する保留コメントの情報をJSON形式で指定してください。file:// を先頭に付けると、JSON形式のファイルを指定できます。

各コメントには comment_id を指定することができます。省略した場合は自動的にUUIDv4が生成されます。

(ex) {"task1": {"input_data1": [{"comment": "type属性が間違っています。"}]}}

--csv

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

task_id （必須）: タスクID

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

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

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

comment_id （任意）: コメントID（省略時はUUIDv4自動生成）

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