supplementary create

Description

補助情報を作成します。

Examples

CSVから補助情報を作成する

補助情報が記載されたCSVファイルを元に、補助情報を作成します。

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

• ヘッダ行あり

• カンマ区切り

列名	必須	備考
input_data_id	Yes
supplementary_data_name	Yes
supplementary_data_path	Yes	先頭が file:// の場合、ローカルのファイルを補助情報に使用します。
supplementary_data_id	No	省略した場合はsupplementary_data_nameに近い値（IDに使えない文字を加工した値）になります。
supplementary_data_type	No	補助情報の種類。 image 、 text または custom のいずれかを指定ください。省略した場合は、ファイル名から推測します。
supplementary_data_number	No	補助情報の表示順。省略した場合は、既存の補助情報の最大値+1になります。

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

supplementary_data.csv

input_data_id,supplementary_data_name,supplementary_data_path,supplementary_data_id,supplementary_data_type,supplementary_data_number
input1,data1-1,s3://example.com/data1,id1,,
input1,data1-2,s3://example.com/data2,id2,image,1
input1,data1-3,s3://example.com/data3,id3,text,2
input2,data2-1,https://example.com/data4,,,
input2,data2-2,file://sample.jpg,,,
input2,data2-3,file:///tmp/sample.jpg,,,

警告

プライベートストレージが利用可能な組織配下のプロジェクトでしか、 supplementary_data_path に https または s3 スキームを利用できません。 プライベートストレージを利用するには、Annofabサポート窓口への問い合わせが必要です。 詳細は https://annofab.readme.io/docs/external-storage を参照してください。

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

$ annofabcli supplementary create --project_id prj1 --csv supplementary_data.csv

supplementary_data_idが一致する補助情報が既に存在する場合は、デフォルトではスキップします。補助情報を上書きする場合は、 --overwrite を指定してください。

$ annofabcli supplementary create --project_id prj1 --csv supplementary_data.csv --overwrite

JSONから補助情報を作成する

補助情報が記載されたJSONファイルを元に、補助情報を作成します。

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

supplementary_data.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 create --project_id prj1 --json file://supplementary_data.json

並列処理

以下のコマンドは、並列数4で実行します。

$ annofabcli supplementary create --project_id prj1 --csv supplementary_data.csv
--parallelism 4 --yes

Usage Details

補助情報を作成します。

usage: annofabcli supplementary create [-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
                                       (--csv CSV | --json JSON) [--overwrite]
                                       [--parallelism {2,3,4}]

Named Arguments

-p, --project_id

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

--csv

補助情報が記載されたCSVファイルのパスを指定してください。CSVのフォーマットは、以下の通りです。

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

• 必須列: input_data_id, supplementary_data_name, supplementary_data_path

• 任意列: supplementary_data_id, supplementary_data_type, supplementary_data_number

各項目の詳細は https://annofab-cli.readthedocs.io/ja/latest/command_reference/supplementary/create.html を参照してください。

--json

作成対象の補助情報データをJSON形式で指定してください。

(ex) [{"input_data_id": "input1", "supplementary_data_name": "foo", "supplementary_data_path": "file://foo.jpg"}]

JSONの各キーは --csv に渡すCSVの各列に対応しています。 file:// を先頭に付けるとjsonファイルを指定できます。

--overwrite

指定した場合、supplementary_data_idがすでに存在していたら上書きします。指定しなければ、スキップします。

--parallelism

Possible choices: 2, 3, 4

並列度。指定しない場合は、逐次的に処理します。必ず --yes を指定してください。

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

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