モジュール実行 API - dataproc.exec

モジュールが提供するメソッドを実行します。

実行方式は JSON-RPC v2.0 を利用します。

エンドポイント

https://<api-server-endpoint>/api/v1/dataproc/jsonrpc

リクエスト例

{
  "jsonrpc": "2.0",
  "method": "dataproc.exec",
  "params": {
    "module": "mnist-module",
    "method": "train",
    "input": {
      "train_dataset": {
        "data_ddc": "ddc:mnist_train"
      }
    },
    "output": {
      "trained_model": {
        "model_store_ddc": "ddc:mnist_models"
      }
    },
    "params": {
    }
  },
  "id": "dataproc_exec"
}

パラメータ

パラメータ名	データ型	内容	既定値
module	string	モジュール名	必須
method	string	実行するメソッド名	必須
input	JSON Object	メソッドの入力となるデータやモデルストアの ddc	{} (通常は必須)
output	JSON Object	メソッドの実行結果の出力先となる ddc	{} (通常は必須)
params	JSON Object	メソッドに与えるパラメータ	{}

出力サンプル

{
  "result": true,
  "id": "dataproc_exec",
  "jsonrpc": "2.0"
}

戻り値

モジュールが正常に終了した場合には result キーの値が true となります。

説明

モジュールが提供するメソッドを実行します。

リクエストパラメータの module と method で指定された処理を実行します。 メソッドの入出力は ddc で指定します。パラメータは JSON データを指定できます。 入出力 ddc のスキーマやパラメータの書式は実行するメソッドごとに異なります。 具体的な情報は、各モジュールのドキュメント等を確認してください。