input_data put

Description

入力データを作成します。

Examples

入力データを個別に作成する(CSV)

入力データ情報が記載されたCSVファイルを元に、入力データを作成します。

CSVのフォーマットは以下の通りです。

  • カンマ区切り

  • ヘッダ行なし

列番号

名前

必須

備考

1列目

input_data_name

Yes

2列目

input_data_path

Yes

先頭が file:// の場合、ローカルのファイルを入力データに使用します。

3列目

input_data_id

No

省略した場合はUUID(v4)になります。

4列目

sign_required

No

true または false を指定してください。省略した場合は null です。

各項目の詳細は AnnofabのWebAPIドキュメント を参照してください。

以下はCSVファイルのサンプルです。

input_data.csv
data1,s3://example.com/data1,id1,
data2,s3://example.com/data2,id2,true
data3,s3://example.com/data3,id3,false
data4,https://example.com/data4,,
data5,file://sample.jpg,,
data6,file:///tmp/sample.jpg,,

--csv に、CSVファイルのパスを指定してください。

$ annofabcli input_data put --project_id prj1 --csv input_data.csv

input_data_idが一致する入力データが既に存在する場合、デフォルトではスキップします。入力データを上書きする場合は、 --overwrite を指定してください。

$ annofabcli input_data put --project_id prj1 --csv input_data.csv --overwrite

入力データを個別に作成する(JSON)

入力データ情報が記載されたJSONファイルを元に、入力データを作成します。

以下は、JSONのサンプルです。

input_data.json
[
    {
        "input_data_name":"data1",
        "input_data_path":"file://sample.jpg",
    },
    {
        "input_data_name":"data2",
        "input_data_path":"s3://example.com/data2",
        "input_data_id":"id2",
        "sign_required": false
    }
]

JSONのキーは、--csv に指定するCSVファイルの列に対応します。

--json にJSON形式の文字列、またはJSONファイルのパスを指定できます。

$ annofabcli input_data put --project_id prj1 --json file://input_data.json

zipファイルから入力データを作成する

画像や動画ファイルが格納されたzipファイルから、入力データを作成します。 --zip にzipファイルのパスを指定してください。

$ annofabcli input_data put --project_id prj1 --zip input_data.zip

デフォルトでは、入力データ名の先頭にはzipファイルのパスになります。別の名前を付ける場合は、--input_data_name_for_zip を指定してください。

$ annofabcli input_data put --project_id prj1 --zip input_data.zip \
--input_data_name_for_zip foo.zip

--wait を指定すると、入力データの作成が完了するまで待ちます。

$ annofabcli input_data put --project_id prj1 --zip input_data.zip --wait

並列処理

--csv を指定したときは、並列実行が可能です。

$ annofabcli input_data put --project_id prj1 --csv input_data.csv
--parallelism 4 --yes

Usage Details

CSVに記載された入力データ情報やzipファイルを、入力データとして登録します。

usage: annofabcli input_data 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 | --zip ZIP)
                                 [--overwrite]
                                 [--input_data_name_for_zip INPUT_DATA_NAME_FOR_ZIP]
                                 [--allow_duplicated_input_data] [--wait]
                                 [--wait_options WAIT_OPTIONS]
                                 [--parallelism PARALLELISM]

Named Arguments

-p, --project_id

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

--csv

入力データが記載されたCSVファイルのパスを指定してください。 CSVのフォーマットは以下の通りです。詳細は https://annofab-cli.readthedocs.io/ja/latest/command_reference/input_data/put.html を参照してください。

  • ヘッダ行なし, カンマ区切り

  • 1列目: input_data_name (required)

  • 2列目: input_data_path (required)

  • 3列目: input_data_id

  • 4列目: sign_required (bool)

--json

登録対象の入力データをJSON形式で指定してください。 JSONの各キーは --csv に渡すCSVの各列に対応しています。 file:// を先頭に付けるとjsonファイルを指定できます。 (ex) [{"input_data_name":"", "input_data_path":"file://lenna.png", "input_data_id":"foo","sign_required":false}]

--zip

入力データとして登録するzipファイルのパスを指定してください。

--overwrite

指定した場合、input_data_idがすでに存在していたら上書きします。指定しなければ、スキップします。 --csv , --json` を指定したときのみ有効なオプションです。

--input_data_name_for_zip

入力データとして登録するzipファイルのinput_data_nameを指定してください。省略した場合、 --zip のパスになります。 --zip を指定したときのみ有効なオプションです。

--allow_duplicated_input_data

--csv , --json に渡した入力データの重複(input_data_name, input_data_path)を許可します。 --csv , ``--json` `を指定したときのみ有効なオプションです。

--wait

入力データの登録が完了するまで待ちます。 --zip を指定したときのみ有効なオプションです。

--wait_options

入力データの登録が完了するまで待つ際のオプションをJSON形式で指定してください。 --wait を指定したときのみ有効なオプションです。 file:// を先頭に付けるとjsonファイルを指定できます。デフォルとは {"interval":60, "max_tries":360} です。interval :完了したかを問い合わせる間隔[秒], max_tires :完了したかの問い合わせを最大何回行うか。

--parallelism

並列度。指定しない場合は、逐次的に処理します。--csv , --json を指定したときのみ有効なオプションです。また、必ず --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リクエストの内容やレスポンスのステータスコードなど、デバッグ用のログが出力されます。

オーナロールを持つユーザで実行してください。