Module Execution API - dataproc.get_definitions

Note

This document has been machine translated.

Get module definition information. The execution method uses JSON-RPC v2.0.

Endpoint

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

Request Example

{
  "jsonrpc": "2.0",
  "method": "dataproc.get_definitions",
  "params": {
    "module": "mnist-module"
  },
  "id": "dataproc_get_definitions"
}

Parameter

parameter name	data type	content	default value
module	string	Module name	required

Output Sample

{
  "result": {
    "name": "module.mnist-module",
    "description": "MNIST module",
    "supports": "",
    "definitions": {
      "mnist_dataset": {
        "description": "MNIST dataset",
        "definition": {

  (Omitted below.)

}

Return values

Returns a JSON object containing the definition information of the specified module.

key	data type	content
name	string	Module Name
description	string	Module Description
supports	string	Functions supported by the module (currently unused)
definitions	JSON Object	Define module parameter types
scripts	JSON Object	Input/output definitions for methods provided by the module

Description.

(This is used internally to inspect parameters at module runtime. Users normally do not need to execute this API)

Get module definition information.

Returns definition information about the module specified in the module request parameter, including a brief description of the module and input/output specifications for each method provided by the module. When executing the module, input data in the format according to the definition information must be given. The results of module execution are also stored in a format that conforms to the definition information.

For module descriptions and input/output specifications of each method, refer to the documentation provided by each module. General users do not need to execute this API.