総合情報サイト / マニュアル / サービス管理 / APIの返り値について(時系列)

推論APIの返り値について(時系列)

時系列データの予測AIを推論サービスで実行した際に得られる値について解説します。

APIの返り値について(時系列)_1.jpg

外部アプリケーションやプログラムからMatrixFlowの推論サービスを実行する方法はいろいろありますが、Windows標準機能のコマンドプロンプトを利用して時系列データを用いた推論を行うと、上のような出力がされます。
サービス機能を使った推論を行う手順については「サービスを使って推論を行う」をご覧ください。

この出力値は[推論サービスの詳細画面]の[Responses]タブに指定されている内容に沿っており、学習や予測に使うアルゴリズムによって出力される項目が異なります。
なお、項目の出力は順不同です。
※Responsesの内容は変更できません。

返り値のフォーマットは次の通りです。

形式 :JSON
MIMEタイプ :application/json
文字コード :unicode(UTF-8)
APIの返り値について(時系列)_2.jpg

実際にはすべての値は改行されずに出力されますが、ここでは分かりやすくするため
改行して図示します。

APIの返り値について(時系列)_3.jpg

1. “forecast”: データセットの行ごとに次の情報が出力されます。
  ”ds”:予測した日付,
     システム内部の日付データで出力されます。

以降には、予測値、トレンド、既定の周期性、学習時に設定した周期のそれぞれの値と信頼区間の下限/上限値が出力されます。

  ■予測値
   ”yhat”:予測された値,
   ”yhat_lower”:予測された値の下限,
   ”yhat_upper”:予測された値の上限,

  ■トレンド(時間の経過とともに増加や減少する傾向のこと)
   ”trend”:トレンドの値,
   ”trend_lower”:トレンドの値の下限,
   ”trend_upper”:トレンドの値の上限,

  ■周期性:加法的(乗法的AIの場合すべて0.0)
   ”additive_terms”:加法的に計算した値,
   ”additive_terms_lower”:加法的に計算した値の下限,
   ”additive_terms_upper”:加法的に計算した値の上限,

  ■周期性:乗法的(加法的AIの場合すべて0.0)
   ”multiplicative_terms”:乗法的に計算した値,
   ”multiplicative_terms_lower”:乗法的に計算した値の下限,
   ”multiplicative_terms_upper”:乗法的に計算した値の上限,

 次の値は、学習時に指定した周期によって出力される項目が異なります。

  ■年周期
   ”yearly”:指定した周期の予測された値,
   ”yearly_lower”:指定した周期の予測された値の下限,
   ”yearly_upper”:指定した周期の予測された値の上限,

  ■週周期
   ”weekly”:指定した周期の予測された値,
   ”weekly_lower”:指定した周期の予測された値の下限,
   ”weekly_upper”:指定した周期の予測された値の上限,

  ■日周期
   ”daily”:指定した周期の予測された値,
   ”daily_lower”:指定した周期の予測された値の下限,
   ”daily_upper”:指定した周期の予測された値の上限,

  ■学習時に手入力で追加した周期
   ”周期の名前”:指定した周期の予測された値,
   ”周期の名前_lower”:指定した周期の予測された値の下限,
   ”周期の名前_upper”:指定した周期の予測された値の上限,
   ※”周期の名前”が全角文字の場合、Unicodeコードで出力されます。

APIの返り値について(時系列)_4.jpg

2. “inferenceType”: “推論の形式”
  時系列AIの場合、”time”です。

3. “id”: “推論のID”
  MatrixFlow内部で自動で付与する実行時の識別IDです。

※全角文字の文字コードはUnicodeです。