WebAPI v1 リファレンス

イベントデータ取得API

• eventdata: イベントデータの取得

マップ取得API

• riskmap: リスクマップの取得
• predictmap: 予測マップの取得
• contour: 降水量データの等高線ポリゴンの取得

ルート探索API

• dijkstra: 指定したリスクマップの指定した日時におけるリスクを基に、 安全で近い経路を探索
• calcrisk: 指定された経路を始点から終点まで通行したときのリスク曝露量を計算

データローダAPI

• 概要
• registerloader:addrecordでイベントデータを投入するテーブルの初期化
• deleteloader:データ投入テーブルの削除
• getloderlist:データ投入テーブル一覧を表示
• initrecord:addrecordで利用するイベントデータ投入用の雛形を取得
• addrecord: イベントデータを投入

ファイル取得API

• getfile: データローダWebAPI addrecordで保存したイベントデータ内のファイルの情報を取得

アラート通知API

• 概要
• アラート設定: 監視したいリスクテーマを登録・購読
• アラート変更: 監視しているリスクテーマのアラート発報に関する条件を変更
• アラート通知: アラート通知メッセージを受信
• アラート通知APIクライアント: アラート通知APIクライアントのJavaScript 実装

プロベナンスAPI

• DDCに対する操作
  • prov.count_ddc_records: レコード数のカウント
  • prov.ddc_exists: DDC 存在チェック
  • prov.get_ddc_columns: カラム情報取得
  • prov.resolve_ddc: DDC のメタデータを取得
  • prov.process: Open API処理実行
  • prov.get_ddc_activities: DDC の処理履歴を取得
  • prov.get_ddc_last_activity: DDC の最後の処理を取得
  • prov.ddc_processing_status: DDC の実行状態を取得
• 処理の実行制御
• テーブル・ビュー操作
  • prov.new_ddc: テーブルの作成
  • prov.get_ddc_columns: カラム情報の取得
  • prov.count_ddc_records: レコード数のカウント
  • prov.set_ddc: レコード・カラムの部分選択
  • prov.put_ddc_records: レコード追加
  • prov.join_ddc: テーブル結合
  • prov.delete_ddc: テーブル削除
  • prov.begin_session, prov.resume_session, prov.begin_or_resume_session, prov.rollback, prov.commit: トランザクション
  • prov.set_ddc, prov.resolve_ddc: テーブル名と ddc の変換
• 構成情報

セッション API

• セッションAPI一覧
  • session.open_session: セッションの開始
  • session.verify_session_token: トークンの有効チェック
  • session.close_session: セッションの終了

モジュール実行 API

• dataproc.exec: モジュールのメソッドを実行
• dataproc.get_definitions: モジュールの定義情報を取得
• dataproc.get_server_version: モジュール実行 API のサーバーバージョンを取得

イベントデータ分析API

• 局所的相関ルールの抽出
  • 概要
  • train_fpgrowth: FP-Growth による相関パターン抽出
  • import_category: FP-Growth 用補助 API、カテゴリ定義の登録
  • extract_items: FP-Growth 用補助 API、カテゴリ定義に基づくトランザクションテーブルの記号変換
  • shuim: SHUIMによる頻出アイテム集合抽出
  • extract_distance: SHUIM 用補助 API、トランザクションテーブル中の各地点間の距離を計算
• 時空間相関パターンの深層学習手法
  • 概要
  • train_crnn: CRNN モデル学習
  • predict_crnn: 学習済みのCRNN モデルを適用して予測
  • train_lgbm: LGBM モデル学習
  • predict_lgbm: 学習済みのLGBM モデルを適用して予測
• 複合イベント分析
  • 概要
  • train_3dcnn: 3D-CNN のモデル学習
  • predict_3dcnn: 学習済みの3D-CNN モデルを適用して予測

連合学習API

• Federated Learning API

  • fl.get_server_version: Federated Learning API のサーバーバージョンを取得
  • fl.initialize_model_store: モデルストアを作成
  • fl.exists_store: モデルストアの存在を確認
  • fl.delete_store: モデルストアを削除
  • fl.put_model: 指定したモデルストアにモデルを格納
  • fl.put_aggregated_model: 指定したモデルストアにモデルを格納
  • fl.feedback: 指定したモデルをアップストリームのモデルストアへ feedback
  • fl.proxy_feedback: 指定したモデルをアップストリームのモデルストアへ feedback
  • fl.load_model: 指定したモデルストアの指定したモデルをダウンロード
  • fl.request_transfer: アップストリームのモデルストアから最新の集約されたモデルを取得し、指定したモデルストアに格納
  • fl.proxy_request_transfer_model: アップストリームのモデルストアから最新の集約されたモデルを取得
  • fl.proxy_request_transfer_info: アップストリームのモデルストアから最新の集約されたモデルの情報を取得
  • fl.get_model_info: 指定したモデルストアの指定したモデルの情報を取得
  • fl.exists_model: 指定したモデルストアの指定したモデルの存在を確認
  • fl.delete_model: 指定したモデルストアの指定したモデルを削除
  • fl.delete_all_model: 指定したモデルストアの全てのモデルを削除
  • fl.get_models: 指定したモデルストアの全てのモデル情報を取得
  • fl.get_model_info_latest: 指定したモデルストアの最新のモデル情報を取得
  • fl.get_latest_feedbacked_models: 指定したモデルストアから最新の feedbacked モデル情報の一覧を取得
  • fl.get_latest_aggregated_model: 指定したモデルストアから最新の aggregated モデル情報を取得
  • fl.get_latest_transferred_model: 指定したモデルストアから最新の transferred モデル情報を取得
  • fl.get_parties: アップストリームからパーティを取得
  • fl.create_party: アップストリームにパーティを登録
  • fl.delete_party: アップストリームからパーティを削除

• xData Aggregation FW

  • class Manager: Aggregator と Party の構成を管理するクラス
  • class Aggregator: Aggregator として、連合学習の一連の処理を実行するクラス
  • class Trainer: Party として、連合学習の一連の処理を実行するクラス
  • class Serializer: モデル送受信時の永続化方法・復元方法を記述するクラス
  • class RemoteStore: Federated Learning Web API をバックエンドとするモデルストア

アルゴリズムモジュール

• モジュール定義ファイル