input_data list_all_merged_task#

Description#

すべての入力データ一覧にタスク一覧を結合した情報を出力します。

入力データがどのタスクで使われているかを参照するときに有用です。

注釈

出力される入力データとタスクは、コマンドを実行した日の02:00(JST)頃の状態です。最新の情報を出力したい場合は、 --latest 引数を指定してください。

Examples#

基本的な使い方#

以下のコマンドは、入力データ全件ファイル、タスク全件ファイルをダウンロードしてから、一覧を出力します。

$ annofabcli input_data list_all_merged_task --project_id prj1

手元にある入力データ全件ファイル、タスク全件ファイルを指定する場合は、 --task_json , --input_data_json を指定してください。

$ annofabcli input_data list_all_merged_task --input_data_json input_data.json --task_json task.json

絞り込み#

--input_data_query を指定すると、入力データの名前や入力データのパスで絞り込めます。

以下のコマンドは、入力データ名に"sample"を含む一覧を出力します。

$ annofabcli input_data list_all_merged_task --project_id prj1  \
 --input_data_query '{"input_data_name": "sample"}'

--input_data_id を指定すると、input_data_idに合致する入力データの一覧を出力します。

$ annofabcli input_data list_all_merged_task --project_id prj1 \
 --input_data_id file://input_data_id.txt

--not_used_by_task を指定すれば、タスクに使われていない入力データがあります。「入力データは登録したがタスクは登録していなかった」などのデータ登録のミスを探すときに、このオプションは便利です。

--used_by_multiple_task を指定すれば、複数のタスクから使われている入力データが出力されます。基本的な運用では、1個の入力データは複数のタスクから参照されることはありません。複数のタスクから参照されている場合は、データ登録のミスの可能性があります。このようなミスを探すときに、このオプションは便利です。

出力結果#

CSV出力#

$ annofabcli input_data list_all_merged_task --project_id prj1 --format csv --output out.csv

out.csv#
input_data_id	project_id	organization_id	input_data_set_id	input_data_name	input_data_path	updated_datetime	sign_required	metadata	system_metadata.resized_resolution	system_metadata.original_resolution.width	system_metadata.original_resolution.height	system_metadata._type	system_metadata.resized_resolution.width	system_metadata.resized_resolution.height	system_metadata.original_resolution	task_id	task_status	task_phase	frame_no
input1	prj1	org1	12345678-abcd-1234-abcd-1234abcd5678	test-input1	s3://af-production-input/organizations/…	2021-01-04T21:21:28.169+09:00	False			1280	720	Image				task1	not_started	annotation	1
input2	prj1	org1	12345678-abcd-1234-abcd-1234abcd5678	test-input2	s3://af-production-input/organizations/…	2021-01-04T21:21:28.169+09:00	False			975	435	Image	640	285		task2	not_started	annotation	2

JSON出力#

$ annofabcli input_data list_all_merged_task --project_id prj1 --format pretty_json --output out.json

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/...",
        "updated_datetime": "2021-01-04T21:21:28.169+09:00",
        "sign_required": false,
        "metadata": {},
        "system_metadata": {
            "resized_resolution": null,
            "original_resolution": {
                "width": 80,
                "height": 80
            },
            "_type": "Image"
        },
        "parent_task_list": [
            {
                "task_id": "test_16",
                "task_phase": "acceptance",
                "task_phase_stage": 1,
                "task_status": "break",
                "frame_no": 1
            }
        ]
    },
    ...
]

Usage Details#

タスク一覧と結合したすべての入力データ一覧の情報を出力します。

usage: annofabcli input_data list_all_merged_task [-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]
                                                  [-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]
                                                  [--temp_dir TEMP_DIR]
                                                  [-f {csv,json,pretty_json}]
                                                  [-o OUTPUT]

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

複数のタスクから使われている入力データのみ出力します。基本的な運用では、1個の入力データは複数のタスクから参照されることはありません。複数のタスクから参照されている場合は、データ登録のミスの可能性があります。このようなミスを探すときに利用できます。

--input_data_json

入力データ情報が記載されたJSONファイルのパスを指定してください。JSONに記載された情報を元に出力します。JSONファイルは $ annofabcli input_data download コマンドで取得できます。

--task_json

タスク情報が記載されたJSONファイルのパスを指定してください。JSONに記載された情報を元に出力します。JSONファイルは $ annofabcli task download コマンドで取得できます。

--latest

入力データ一覧ファイル、タスク一覧ファイルの更新が完了するまで待って、最新のファイルをダウンロードします。 --project_id を指定したときのみ有効です。

--temp_dir

指定したディレクトリに、入力データJSONやタスクJSONなどの一時ファイルをダウンロードします。 --project_id を指定したときのみ有効です。

-f, --format

Possible choices: csv, json, pretty_json

出力フォーマットを指定します。

Default: 'csv'

-o, --output

出力先のファイルパスを指定します。未指定の場合は、標準出力に出力されます。

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