このセクションの他の記事
- サービスとは
- サービス管理画面
- 新規サービスを追加（学習）
- 新規サービスを追加（推論）
- 新規サービスを追加（プロジェクト管理）
- 新規サービスを追加（最適化）
- サービスの詳細と実行コードの作成（推論）
- サービスの詳細と実行コードの作成（学習）
- サービスの詳細と実行コードの作成（プロジェクト管理）
- サービスの詳細と実行コードの作成（最適化）
- サービスの編集
- サービス使用状況を表示
- APIの共通仕様
- APIの返り値（数値データ／文書データ（csv）の分類）
- APIの返り値（回帰）
- APIの返り値（画像の分類、ベクトル化、次元圧縮）
- APIの返り値（文書データ（zip/txt/pdf）の分類、ベク…
- APIの返り値（時系列解析）
- APIの返り値（学習）
- APIの返り値（最適化）
推論APIの返り値（時系列解析）
時系列データを APIで推論した際のレスポンス（返り値）です。
出力される項目の解説は、推論結果の見方 をご覧ください。
■対象のレシピと投入データ／ファイル形式
＜レシピ＞
・ブロックタイプ「時系列解析」のTrendFlow、またはMfTransformerを使っている
＜投入データ／ファイル形式＞
・数値データ／csvファイル
日時の列を必ず含み、学習に使用する列、予測する列どちらも数値のデータ
■レスポンスのデータ形式
| 項目 | 値と説明 |
|---|---|
| MIMEタイプ | application/json |
| 文字コード | Unicode（UTF-8） |
■レスポンスの値
フィールドの出力順は実行環境によって異なります。
また、TrendFlowとMfTransformerで異なります。
＜TrendFlow＞
| フィールド_0 | フィールド_1 | フィールド_2 | 説明 |
|---|---|---|---|
| inferenceType | 固定値 “time” 時系列解析であることを意味する |
||
| id | MatrixFlow内部で自動で付与する実行時の識別ID | ||
| list | coloumnName | AIを作成する際に指定した「予測する列名」（＝目的変数） | |
| forecast | 投入したデータセットの先頭から行ごとに以下の情報を繰り返し出力し、投入データの最終行の出力に続けて指定した予測期間の情報を出力する | ||
| ds | 予測した日時 エポック秒（UNIX秒）で出力 |
||
| yhat | 予測値 | ||
| yhat_lower | 予測の95%信頼区間の下限値 | ||
| yhat_upper | 予測の95%信頼区間の上限値 | ||
| trend | トレンドの値 トレンドは、時間の経過とともに増減する動きのこと |
||
| trend_lower | トレンドの95%信頼区間の下限値 | ||
| trend_upper | トレンドの95%信頼区間の上限値 | ||
| additive_terms | 周期性を加法的に計算した観測値 加法的，乗法的どちらか（乗法的モデルの場合3つとも0.0） |
||
| additive_terms_lower | 加法的観測値の95%信頼区間の下限値 | ||
| additive_terms_upper | 加法的観測値の95%信頼区間の上限値 | ||
| multiplicative_terms | 周期性を乗法的に計算した観測値 加法的，乗法的どちらか（加法的モデルの場合3つとも0.0） |
||
| multiplicative_terms_lower | 乗法的観測値の95%信頼区間の下限値 | ||
| multiplicative_terms_upper | 乗法的観測値の95%信頼区間の上限値 |
以下は、レシピのパラメータ「自動周期設定」を「ON」にした場合、投入データから自動で判断した周期が出力されます。
自動で選択される周期は、年/週/日のいずれかです。
| フィールド_0 | フィールド_1 | フィールド_2 | 説明 |
|---|---|---|---|
| list | forecast | yearly | 年周期の観測値 |
| yearly_lower | 年周期観測値の95%信頼区間の下限値 | ||
| yearly_upper | 年周期観測値の95%信頼区間の上限値 | ||
| weekly | 週周期の観測値 | ||
| weekly_lower | 週周期観測値の95%信頼区間の下限値 | ||
| weekly_upper | 週周期観測値の95%信頼区間の上限値 | ||
| daily | 日周期の観測値 | ||
| daily_lower | 日周期観測値の95%信頼区間の下限値 | ||
| daily_upper | 日周期観測値の95%信頼区間の上限値 |
以下は、レシピのパラメータに手動で周期設定を追加した場合に出力されます。
| フィールド_0 | フィールド_1 | フィールド_2 | 説明 |
|---|---|---|---|
| list | forecast | 周期の名前 | 設定した周期の観測値 |
| 周期の名前_lower | 観測値の95%信頼区間の下限値 | ||
| 周期の名前_upper | 観測値の95%信頼区間の上限値 |
＜MFTransformerV2＞ ※MfTransformerの後継ブロックです。
| フィールド_0 | フィールド_1 | 説明 |
|---|---|---|
| inferenceType | 固定値 “time_transformerV2” 時系列解析”MfTransformerV2″であることを意味する |
|
| id | MatrixFlow内部で自動で付与する実行時の識別ID | |
| forecast | 投入データの空白行の分の予測情報を出力する（例：予測したい行数が７行の場合、７行分の予測情報が出力される） | |
| ds | 予測した日時 エポック秒（UNIX秒）で出力 |
|
| yhat | 予測値、または null* | |
| y | 実測値（投入データの値）または null** | |
| yhat_lower | 予測の95%信頼区間の下限値 | |
| yhat_upper | 予測の95%信頼区間の上限値 | |
| ColumnName | カラム名 | 列名 |
*yhat（予測値）の null
実測値(y)の存在するレコードに予測値は出力されません。nullになります。
**y（実測値）の null
予測値(yhat)を得たい行には実測値がありませんので、null になります。
＜MFTransformer＞
※MfTransformerは機能が古いため、推奨しておりません。
後継のMfTransformerV2をご利用ください。
| フィールド_0 | フィールド_1 | 説明 |
|---|---|---|
| inferenceType | 固定値 “time” 時系列解析であることを意味する |
|
| id | MatrixFlow内部で自動で付与する実行時の識別ID | |
| forecast | 投入したデータセットの先頭から行ごとに以下の情報を繰り返し出力し、投入データの最終行の出力に続けて次の1行分の予測情報を出力する | |
| ds | 予測した日時 エポック秒（UNIX秒）で出力 |
|
| yhat | 予測値、または null*** | |
| y | 実測値（投入データの値）または null**** |
***yhat（予測値）の null
レシピブロック「MfTransformer」の「入力列の長さ」に指定した行数を読み込んで次の1行分を推論します。
入力列の長さに「28」を指定した場合、1‐28行目で29行目を推論、次に2‐29行目で30行目の推論･･･と投入データの最後まで繰り返します。
そのため、入力列の長さに満たない行は推論できず null になります。
****y（実測値）の null
予測値を得たい行には実測値がありませんので、null になります。