input_data list_merged_task¶
Description¶
入力データ一覧にタスク一覧結合した情報を出力します。 動画プロジェクトで、各タスクの動画時間を出力するときなどに利用できます。
Examples¶
基本的な使い方¶
以下のコマンドは、入力データ全件ファイル、タスク全件ファイルをダウンロードしてから、一覧を出力します。
$ annofabcli input_data list_merged_task --project_id prj1
手元にある入力データ全件ファイル、タスク全件ファイルを指定する場合は、--task_json , --input_data_json を指定してください。
$ annofabcli input_data list_merged_task --input_data_json input_data.json --task_json task.json
絞り込み¶
--input_data_query を指定すると、入力データの名前や入力データのパスで絞り込めます。
以下のコマンドは、入力データ名に"sample"を含む一覧を出力します。
$ annofabcli input_data list_merged_task --project_id prj1 \
--input_data_query '{"input_data_name": "sample"}'
--input_data_id を指定すると、input_data_idに合致する入力データの一覧を出力します。
$ annofabcli input_data list_merged_task --project_id prj1 \
--input_data_id file://input_data_id.txt
--not_used_by_task を指定すれば、タスクに使われていない入力データがあります。
--used_by_multiple_task を指定すれば、複数のタスクから使われている入力データが出力されます。
出力結果¶
CSV出力¶
$ annofabcli input_data list_merged_task --project_id prj1 --format csv --output out.csv
JSON出力¶
$ annofabcli input_data list_merged_task --project_id prj1 --format pretty_json --output out.json
[
{
"input_data_id": "input1",
"project_id": "prj1",
"organization_id": "org1",
"input_data_set_id": ",12345678-abcd-1234-abcd-1234abcd5678",
"input_data_name": "data1",
"input_data_path": "s3://af-production-input/organizations/...",
"url": "https://annofab.com/organizations/...",
"etag": "...",
"updated_datetime": "2021-01-04T21:21:28.169+09:00",
"original_input_data_path": "s3://af-production-input/organizations/...",
"sign_required": false,
"metadata": {},
"system_metadata": {
"resized_resolution": null,
"original_resolution": null,
"_type": "Image"
},
"resized_resolution": null,
"original_resolution": {
"width": 128,
"height": 128
},
"_type": "Image",
"task_id": "task1",
"task_status": "break",
"task_phase": "annotation",
"worktime_hour": 4.308171944444444
},
...
]
Usage Details¶
タスク一覧と結合した入力データ一覧の情報を出力します。
usage: annofabcli input_data list_merged_task [-h] [--yes]
[--endpoint_url ENDPOINT_URL]
[--logdir LOGDIR]
[--disable_log] [--debug]
[-p PROJECT_ID]
[-i INPUT_DATA_ID [INPUT_DATA_ID ...]]
[--input_data_name INPUT_DATA_NAME [INPUT_DATA_NAME ...]]
[-iq INPUT_DATA_QUERY]
[--not_used_by_task | --used_by_multiple_task]
[--input_data_json INPUT_DATA_JSON]
[--task_json TASK_JSON]
[--latest]
[--wait_options WAIT_OPTIONS]
[-f {csv,json,pretty_json}]
[-o OUTPUT]
[--csv_format CSV_FORMAT]
Named Arguments¶
- -p, --project_id
対象のプロジェクトのproject_idを指定してください。指定すると、入力データ一覧ファイル、タスク一覧ファイルをダウンロードします。
- -i, --input_data_id
指定したinput_data_idに完全一致する入力データを絞り込みます。
- --input_data_name
指定したinput_data_nameに部分一致(大文字小文字区別しない）する入力データを絞り込みます。
- -iq, --input_data_query
入力データの検索クエリをJSON形式で指定します。
file://を先頭に付けると、JSON形式のファイルを指定できます。指定できるキーは、input_data_id,input_data_name,input_data_pathです。- --not_used_by_task
タスクから使われていない入力データのみ出力します。
- --used_by_multiple_task
複数のタスクから使われている入力データのみ出力します。
- --input_data_json
入力データ情報が記載されたJSONファイルのパスを指定してください。JSONに記載された情報を元に出力します。JSONファイルは
$ annofabcli input_data downloadコマンドで取得できます。- --task_json
タスク情報が記載されたJSONファイルのパスを指定してください。JSONに記載された情報を元に出力します。JSONファイルは
$ annofabcli task downloadコマンドで取得できます。- --latest
入力データ一覧ファイル、タスク一覧ファイルの更新が完了するまで待って、最新のファイルをダウンロードします。
--project_idを指定したときのみ有効です。- --wait_options
入力データ一覧ファイル、タスク一覧ファイルの更新が完了するまで待つ際のオプションを、JSON形式で指定してください。
file://を先頭に付けるとjsonファイルを指定できます。デフォルトは{"interval":60, "max_tries":360}です。interval:完了したかを問い合わせる間隔[秒],max_tires:完了したかの問い合わせを最大何回行うか。- -f, --format
Possible choices: csv, json, pretty_json
出力フォーマットを指定します。
Default: "csv"
- -o, --output
出力先のファイルパスを指定します。未指定の場合は、標準出力に出力されます。
- --csv_format
CSVのフォーマットをJSON形式で指定します。
--formatがcsvでないときは、このオプションは無視されます。file://を先頭に付けると、JSON形式のファイルを指定できます。 指定した値はpandas.DataFrame.to_csvの引数として渡されます。
global optional arguments¶
- --yes
処理中に現れる問い合わせに対して、常に
yesと回答します。- --endpoint_url
Annofab WebAPIのエンドポイントを指定します。
Default: "https://annofab.com"
- --logdir
ログファイルを保存するディレクトリを指定します。
Default: .log
- --disable_log
ログを無効にします。
- --debug
HTTPリクエストの内容やレスポンスのステータスコードなど、デバッグ用のログが出力されます。