input_data list

Description

入力データ一覧を出力します。

Examples

基本的な使い方

以下のコマンドは、すべての入力データの一覧を出力します。 ただし10,000件までしか出力できません。

$ annofabcli input_data list --project_id prj1

警告

WebAPIの都合上、10,000件までしか出力できません。 10,000件以上の入力データを出力する場合は、annofabcli input_data list_all コマンドを使用してください。

絞り込み

--input_data_query を指定すると、入力データの名前やinput_data_idで絞り込めます。 --input_data_query に渡す値は、https://annofab.com/docs/api/#operation/getInputDataList のクエリパラメータとほとんど同じです。

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

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

以下のコマンドは、task_idに"task1"を含むタスクが使用している入力データの一覧を出力します。

$ annofabcli input_data list --project_id prj1 \
 --input_data_query '{"task_id": "task1"}'

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

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

詳細な情報を出力する

--add_details を指定すると、入力データの詳細な情報を出力します。具体的には以下の情報を出力します。

  • parent_task_id_list : 入力データを使用しているタスクのtask_idのリスト

出力結果

CSV出力

$ annofabcli input_data list --format csv --output out.csv

out.csv

JSON出力

$ annofabcli input_data list --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/...",
        "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": {
                "width": 128,
                "height": 128
            }
        },
        "_type": "Image"
    },
    ...
]

input_data_idの一覧を出力

$ annofabcli input_data list --format input_data_id_list --output out.txt
out.txt
input1
input2
...

Usage Details

入力データ一覧を出力します。Annofabの制約上、10,000件までしか出力されません。

usage: annofabcli input_data list [-h] [--yes] [--endpoint_url ENDPOINT_URL]
                                  [--annofab_user_id ANNOFAB_USER_ID]
                                  [--annofab_password ANNOFAB_PASSWORD]
                                  [--logdir LOGDIR] [--disable_log] [--debug]
                                  -p PROJECT_ID
                                  [-iq INPUT_DATA_QUERY | -i INPUT_DATA_ID [INPUT_DATA_ID ...]]
                                  [--add_details]
                                  [--average_input_data_id_length AVERAGE_INPUT_DATA_ID_LENGTH]
                                  [-f {csv,json,pretty_json,input_data_id_list}]
                                  [-o OUTPUT] [--csv_format CSV_FORMAT]
                                  [-q QUERY]

Named Arguments

-p, --project_id

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

-iq, --input_data_query

入力データの検索クエリをJSON形式で指定します。 file:// を先頭に付けると、JSON形式のファイルを指定できます。クエリのフォーマットは、getInputDataList APIのクエリパラメータと同じです。ただし page , limit キーは指定できません。

-i, --input_data_id

対象のinput_data_idを指定します。 --input_data_query 引数とは同時に指定できません。 file:// を先頭に付けると、input_data_idの一覧が記載されたファイルを指定できます。

--add_details

入力データの詳細情報を表示します。以下の列を追加します。

  • parent_task_id_list

--average_input_data_id_length

入力データIDの平均長さを指定します。 add_details がTrueのときのみ有効です。デフォルトはUUIDv4の長さです。この値を元にして、タスク一括取得APIの実行回数を決めます。

Default: 36

-f, --format

Possible choices: csv, json, pretty_json, input_data_id_list

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

Default: "csv"

-o, --output

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

--csv_format

CSVのフォーマットをJSON形式で指定します。 --formatcsv でないときは、このオプションは無視されます。 file:// を先頭に付けると、JSON形式のファイルを指定できます。 指定した値は pandas.DataFrame.to_csv の引数として渡されます。

-q, --query

JMESPath形式で指定します。出力結果の抽出や、出力内容の変更に利用できます。

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