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

モジュールの定義情報を取得します。 実行方式は JSON-RPC v2.0 を利用します。

エンドポイント

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

リクエスト例

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

パラメータ

パラメータ名	データ型	内容	既定値
module	string	モジュール名	必須

出力サンプル

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

  (以下省略)

}

戻り値

指定されたモジュールの定義情報を含む JSON オブジェクトを返します。

キー	データ型	内容
name	string	モジュールの名前
description	string	モジュールの説明
supports	string	モジュールがサポートする機能 (現在未使用)
definitions	JSON Object	モジュールのパラメータ型の定義
scripts	JSON Object	モジュールが提供するメソッドの入出力定義

説明

(モジュール実行時のパラメータ検査のために、内部的に利用されるものです。利用者は通常、この API を実行する必要はありません)

モジュールの定義情報を取得します。

リクエストパラメータの module に指定されたモジュールについて、モジュールの概要説明、モジュールが提供する各メソッドの入出力仕様などを含む定義情報を返します。 モジュールを実行する際には、定義情報に従う形式の入力データを与える必要があります。 また、モジュールの実行結果は、定義情報に従う形式で格納されます。

モジュールの説明や各メソッドの入出力仕様などは、各モジュールが提供するドキュメントを参照してください。 一般的な利用者は、この API を実行する必要はありません。