Module Execution API - dataproc.exec

Note

This document has been machine translated.

Execute the methods provided by the module.

The execution method uses JSON-RPC v2.0.

Endpoint

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

Example request

{
  "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"
}

Parameters

Parameter Name	Data Type	Contents	Default Value
module	string	Module name	required
method	string	Name of method to execute	required
input	JSON Object	ddc of the data or model store that will be the input for the method.	{} (Normally required)
output	JSON Object	ddc, which is the output destination for the results of the execution of the method	{} (Normally required)
params	JSON Object	Parameters given to the method	{}

Output samples

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

Return values

The value of the result key is true if the module terminated successfully.

Description

Executes a method provided by a module.

Executes the process specified by the request parameters module and method. The input and output of the method is specified by ddc. Parameters can be JSON data. The format of the input/output ddc schema and parameters differs for each method to be executed. For specific information, check the documentation of each module, etc.