supplementary put#
Description#
補助情報を作成します。
Examples#
CSVから補助情報を登録する#
補助情報が記載されたCSVファイルを元に、補助情報を登録します。
CSVのフォーマットは以下の通りです。
カンマ区切り
ヘッダ行なし
列番号 |
名前 |
必須 |
備考 |
---|---|---|---|
1列目 |
input_data_id |
Yes |
|
2列目 |
supplementary_data_number |
Yes |
表示順を表す数値を指定してください。 |
3列目 |
supplementary_data_name |
Yes |
|
4列目 |
supplementary_data_path |
Yes |
先頭が |
5列目 |
supplementary_data_id |
No |
省略した場合はUUID(v4)になります。 |
6列目 |
supplementary_data_type |
No |
|
以下はCSVファイルのサンプルです。
input1,1,data1-1,s3://example.com/data1,id1,
input1,2,data1-2,s3://example.com/data2,id2,image
input1,3,data1-3,s3://example.com/data3,id3,text
input2,1,data2-1,https://example.com/data4,,
input2,2,data2-2,file://sample.jpg,,
input2,3,data2-3,file:///tmp/sample.jpg,,
--csv
に、CSVファイルのパスを指定してください。
$ annofabcli supplementary put --project_id prj1 --csv supplementary_data.csv
supplementary_data_id(省略時は supplementary_data_number)が一致する補助情報が既に存在する場合は、デフォルトではスキップします。補助情報を上書きする場合は、 --overwrite
を指定してください。
$ annofabcli supplementary put --project_id prj1 --csv supplementary_data.csv --overwrite
JSONから補助情報を登録する#
補助情報が記載されたJSONファイルを元に、補助情報を登録します。
以下は、JSONのサンプルです。
[
{
"input_data_id": "input1",
"supplementary_data_number": 1,
"supplementary_data_name": "foo",
"supplementary_data_path": "file://foo.jpg",
}
,
{
"input_data_id": "input1",
"supplementary_data_number": 2,
"supplementary_data_name": "bar",
"supplementary_data_path": "s3://example.com/bar.jpg",
"supplementary_data_id": "id2",
"supplementary_data_type": "image"
}
]
JSONのキーは、--csv
に指定するCSVファイルの列に対応します。
--json
にJSON形式の文字列、またはJSONファイルのパスを指定できます。
$ annofabcli supplementary put --project_id prj1 --json file://supplementary_data.json
並列処理#
以下のコマンドは、並列数4で実行します。
$ annofabcli supplementary put --project_id prj1 --csv supplementary_data.csv
--parallelism 4 --yes
Usage Details#
補助情報を登録します。
usage: annofabcli supplementary put [-h] [--yes] [--endpoint_url ENDPOINT_URL]
[--annofab_user_id ANNOFAB_USER_ID]
[--annofab_password ANNOFAB_PASSWORD]
[--logdir LOGDIR] [--disable_log]
[--debug] -p PROJECT_ID
(--csv CSV | --json JSON) [--overwrite]
[--parallelism PARALLELISM]
Named Arguments#
- -p, --project_id
対象のプロジェクトのproject_idを指定します。
- --csv
補助情報が記載されたCVファイルのパスを指定してください。CSVのフォーマットは、以下の通りです。
ヘッダ行なし, カンマ区切り
1列目: input_data_id (required)
2列目: supplementary_data_number (required)
3列目: supplementary_data_name (required)
4列目: supplementary_data_path (required)
5列目: supplementary_data_id
6列目: supplementary_data_type
各項目の詳細は https://annofab-cli.readthedocs.io/ja/latest/command_reference/supplementary/put.html を参照してください。
- --json
登録対象の補助情報データをJSON形式で指定してください。
(ex)
[{"input_data_id": "input1", "supplementary_data_number": 1, "supplementary_data_name": "foo", "supplementary_data_path": "file://foo.jpg"}]
JSONの各キーは
--csv
に渡すCSVの各列に対応しています。file://
を先頭に付けるとjsonファイルを指定できます。- --overwrite
指定した場合、supplementary_data_id(省略時はsupplementary_data_number)がすでに存在していたら上書きします。指定しなければ、スキップします。
- --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リクエストの内容やレスポンスのステータスコードなど、デバッグ用のログが出力されます。
オーナロールを持つユーザで実行してください。