📓
API を用いた推論の手順(Mac/Linux)（プレビュー）
推論事前準備APIキーの保存CSVファイルパスの保存推論APIの実行推論種別が予測でProphet以外のAIモデルを利用したAPIの場合推論種別が予測でProphetを利用したAPIの場合推論種別が異常検知のAPIの場合
モデルAPIサービスは現在プレビュー機能です。
推論
ユーザーのPC等からNode-AI モデルAPIサービスにデータを送信し、推論結果を取得します。
まず、インターネットに接続されたご自身のPCでTerminalを開いてください。
次に、Node-AIのAPI一覧が表示されている画面にて、利用したいAPIモデルの名前をクリックしてください。
クリックすることで以下APIの詳細画面が開きます。
API利用例を参考に、ターミナルから推論を実行できます。
事前準備
APIの詳細画面から以下の値を事前に取得しておいてください
- APIキー
- 見出し「APIキー」から取得してください。（画像で黒塗りになっている部分の値を取得してください。）
- 利用するAPIのURL
- 見出し「API URL」から取得してください。（画像で黒塗りになっている部分の値を取得してください。）
APIキーの保存
はじめに、事前準備で取得したAPIキーを環境変数に保存します。
の箇所を取得したAPIキーに書き換えて以下のコマンドを実行してください。
複数のAPIを1台のPCから使用する場合、環境変数名NODEAI_MODEL_API_KEY を別の名前に書き換えてください。この時、環境変数名は自由に名づけることができますが、以降のコマンドで環境変数名を書き換えて実行する必要があります。
また、APIキーの再生成をした場合、NODEAI_MODEL_API_KEYを再度設定する必要があります。
CSVファイルパスの保存
Prophetのモデルを利用して推論を行う場合はこちらの手順は不要です。
次に、推論で利用するCSVファイルのパスを環境変数に保存します。
の箇所を推論で利用するCSVファイルのパスに書き換えて以下のコマンドを実行してください。
ファイルパスは、絶対パスと相対パスが存在します。ここでは、どちらの方式であっても問題ありませんが、相対パスの場合、実行可能なディレクトが限定されます。原則として、絶対パスをお勧めします。
複数のAPIを1台のPCから使用する場合、環境変数名NODEAI_INFERENCE_CSV_FILE_PATH を別の名前に書き換えてください。この時、環境変数名は自由に名づけることができますが、以降のコマンドで環境変数名を書き換えて実行する必要があります。
次のコマンドで、ファイルの存在を確認します。もしも、ファイルパスが間違っているといった要因により、ファイルにたどり着けない場合にエラーになります。
推論APIの実行
コマンドを実行する前にcurlコマンドをインストールしてください。OSや環境によってインストールされていないことがあります。
コマンドを実行し、推論結果を取得します。
コマンド実行後、推論結果の応答まで数十秒の時間がかかる場合があります。
実行するコマンド、実行後に返ってくるレスポンスは行いたい推論種別（回帰 or 異常検知）やAIモデル（線形モデルやProphetといったもの）によって異なりますので、以下参考にコマンドを実行するようにしてください。
推論種別が予測でProphet以外のAIモデルを利用したAPIの場合
推論種別が予測でProphet以外のAIモデルを利用したAPIを実行する場合、以下のコマンドを実行してください。
Prophet以外のAIモデルとは、以下のモデルが該当します。
- 線形モデル
- 決定木回帰
- LightGBM
- MLP
- FastSGL
は事前準備で取得したAPIのURLに書き換えてください。
このコマンドを実行すると一定時間後に以下のような返答を受け取ります。
columnsには予測対象の列、resultsには予測した時刻（timestamp）とその時刻での予測値（predicted）が含まれています。
推論種別が予測でProphetを利用したAPIの場合
推論種別が予測でProphetを利用したAPIを実行する場合、推論したい期間を指定する必要があります。
推論したい期間を指定する方法は、コマンドを実行する際に と を設定することで指定可能です。
と の詳細については以下参照してください。
| 名称 | 説明 | 設定が必須か | 形式 |
| Prophetを利用して推論したい期間の開始時刻を指定する | 必須でない →設定しない場合は「モデル作成時に利用した学習データの最後の日付」が利用されます。 | 例: 2025-01-01 12:00:00 | |
| Prophetを利用して推論したい期間の終了時刻を指定する | 必須 | 例: 2025-01-31 12:00:00 |
Prophetモデルを利用するためのコマンド例を以下に記載しますので、こちら参考にコマンドを実行してください。
◆ を設定する場合
◆ を設定しない場合
上記コマンド内で、、、という文字列がありますが、こちらは適宜以下に変更して実行してください。
- ：事前準備で取得したAPIのURL
- ：Prophetを利用して推論したい期間の開始時刻を で指定
- ：Prophetを利用して推論したい期間の終了時刻を で指定
このコマンドを実行すると一定時間後に以下のような構造で返答を受け取ります。
各値の意味については以下参考にしてください。
| 名称 | 説明 |
| 予測対象の列 （モデル作成時に目的変数として設定した列） | |
| 予測結果 | |
| 予測した時刻 | |
| 予測した時刻での予測値 | |
| 信頼区間（※）の下限値 | |
| 信頼区間（※）の上限値 |
推論種別が異常検知のAPIの場合
推論種別が異常検知のAPIを実行する場合、コマンド実行する際に指定する内容は 推論種別が予測でProphet以外のAIモデルを利用したAPIの場合 と同じ内容になります。
現在モデルAPIサービスで利用可能な異常検知のAIモデルはMLPのみとなります。
は事前準備で取得したAPIのURLに書き換えてください。
このコマンドを実行すると一定時間後に以下のような返答を受け取ります。
columnsにはAIモデル作成時に指定したデータ列、resultsには時刻（timestamp）とその時刻での再構成誤差（reconstructionError）、thresholdには再構成誤差の標準偏差値(+2σ, +3σ)が含まれます。
σは標準偏差のことを示します。2σは標準偏差の2倍、3σは標準偏差の3倍という意味になります。
これらの実行結果を基に、別のシステムと連携したり、ダッシュボードを作成してください。