page icon

/api/v1/models/{model_directory}/inference

💡
Prophetモデルで予測を実行する推論APIの仕様書です

用途

Prophetモデルに予測開始日時と予測終了日時を指定し、指定した期間の予測結果を取得します。

前提条件

  • 対象のProphetモデルがアップロード済みであること
  • 予測開始日時と予測終了日時をISO 8601形式で指定すること

仕様

リクエスト

エンドポイント

項目内容
メソッド
パス
には、モデルファイル (zip) を配置したディレクトリ名を指定します。

ヘッダー

ヘッダー

ボディ

パラメータ必須説明
必須string (ISO8691形式)予測開始日時
必須string (ISO8691形式)予測終了日時

実行例

レスポンス

ヘッダー

ヘッダー

ボディ

項目説明
array予測対象のカラム名
array予測結果の一覧
string対象日時 (ISO8691形式)
number予測値
number信頼区間の上限
number信頼区間の下限

成功例

ステータスコード

HTTPステータス主な発生条件対処方法
成功
パラメータが不正(日時形式など)の形式を確認します。
指定したモデルが存在しないを確認します。
必須パラメータが不足が指定されているか確認します。
推論処理中にエラーが発生[ログの確認方法や問い合わせ先を記載]

注意事項

  • にはより前の日時を指定してください。
  • タイムゾーンを含むISO 8601形式で指定してください。

トラブルシューティング

予測期間を指定できない

  • がISO 8601形式であることを確認します。
  • 開始日時が終了日時より前であることを確認します。