📓
API を用いた推論の手順(Windows)（プレビュー）
モデルAPIは現在プレビュー機能です。
推論
ユーザーのPC等からNode-AI モデルAPIにデータを送信し、推論結果を取得します。
Node-AIの画面にはMac/Linux向けの操作を表示しています。Windows向けの操作は本マニュアルを参照してください。
まず、インターネットに接続されたご自身のPCでコマンドプロンプト(Windows)を開いてください。
コマンドプロンプト
コマンドプロンプトとはWindowsにおいて、最初からインストールされているシェルです。コマンドプロンプトでは、コマンドを用いてWindowsに対し、シャットダウンやアプリケーションの停止といった様々な処理を要求できます。
ウィンドウズ+Rキーで実行ダイアログを表示し、”cmd”と入力してOKを押すことで起動します。
*windowsにはコマンドプロンプトとは別にpowershellという類似のシェルも提供されています。ただし、コマンドプロンプトとpowershellでは同じ処理を実行するために指定するコマンドが異なります。そのため、このマニュアルを参考に実施する場合はコマンドプロンプトを開いて実行するようにしてください。
次に、Node-AIのAPI一覧が表示されている画面にて、利用したいAPIモデルの名前をクリックしてください。
クリックすることで以下APIの詳細画面が開きます。
API利用例を同様の手順をWindows向けに書き換えることで、コマンドプロンプトから推論を実行できます。
事前準備
APIの詳細画面から以下の値を事前に取得しておいてください
- APIキー
- 見出し「APIキー」から取得してください。（画像で黒塗りになっている部分の値を取得してください。）
- 利用するAPIのURL
- 見出し「API URL」から取得してください。（画像で黒塗りになっている部分の値を取得してください。）
APIキーの保存
はじめに、事前準備で取得したAPIキーを環境変数に保存します。
の箇所を取得したAPIキーに書き換えて以下のコマンドを実行してください。
複数のNode-AI モデルAPIを1台のPCから使用する場合、環境変数名NODEAI_MODEL_API_KEY を別の名前に書き換えてください。この時、環境変数名は自由に名づけることができますが、以降のコマンドで環境変数名を書き換えて実行する必要があります。
また、APIキーの再生成をした場合、NODEAI_MODEL_API_KEYを再度設定する必要があります。
次のコマンドで、先ほど自分が指定したAPIキーが環境変数に登録されていることを確認してください。
CSVファイルパスの保存
Prophetのモデルを利用して推論を行う場合はこちらの手順は不要です。
次に、推論で利用するCSVファイルのパスを環境変数に保存します。
の箇所を推論で利用するCSVファイルのパスに書き換えて以下のコマンドを実行してください。
ファイルパスは、絶対パスと相対パスが存在します。ここでは、どちらの方式であっても問題ありませんが、相対パスの場合、実行可能なディレクトが限定されます。原則として、絶対パスをお勧めします。
複数のNode-AI モデルAPIを1台のPCから使用する場合、環境変数名NODEAI_INFERENCE_CSV_FILE_PATH を別の名前に書き換えてください。この時、環境変数名は自由に名づけることができますが、以降のコマンドで環境変数名を書き換えて実行する必要があります。
次のコマンドで、先ほど自分が指定したAPIキーが環境変数に登録されていることを確認してください。
また、次のコマンドで、環境変数に設定したファイルが存在しているかを確認できます。空欄が表示された場合、正しくファイルを参照できていません。
推論APIの実行
コマンドを実行する前にcurlコマンドをインストールしてください。OSや環境によってインストールされていないことがあります。
コマンドを実行し、推論結果を取得します。
コマンド実行後、推論結果の応答まで数十秒の時間がかかる場合があります。
Prophet以外のモデルを利用する場合
Prophet以外のモデルを利用する場合は以下のコマンドを実行してください。
は事前準備で取得したAPIのURLに書き換えてください。
このコマンドを実行すると一定時間後に以下のような返答を受け取ります。
columnsには予測対象、resultsには、予測した時刻とともに、予測値が含まれています。
Prophetのモデルを利用する場合
Prophetのモデルを利用する場合は推論したい期間を指定する必要があります。
期間指定の方法は、コマンドを実行する際に と を設定することで指定することが可能です。
と の詳細については以下参照してください。
| 名称 | 説明 | 設定が必須か | 形式 |
| Prophetを利用して推論したい期間の開始時刻を指定する | 必須でない →設定しない場合は「モデル作成時に利用した学習データの最後の日付」が利用されます。 | 例: 2025-01-01 12:00:00 | |
| Prophetを利用して推論したい期間の終了時刻を指定する | 必須 | 例: 2025-01-31 12:00:00 |
Prophetモデルを利用するためのコマンド例を以下に記載しますので、こちら参考にコマンドを実行してください。
上記コマンド内で、、、という文字列がありますが、こちらは適宜以下に変更して実行してください。
- ：事前準備で取得したAPIのURL
- ：Prophetを利用して推論したい期間の開始時刻を で指定
- ：Prophetを利用して推論したい期間の終了時刻を で指定
このコマンドを実行すると一定時間後に以下のような構造で返答を受け取ります。
各値の意味については以下参考にしてください。
| 名称 | 説明 |
| 予測対象の列 （モデル作成時に目的変数として設定した列） | |
| 予測結果 | |
| 予測した値の対象日時 | |
| 予測値 | |
| 信頼区間（※）の下限値 | |
| 信頼区間（※）の上限値 |
これらの実行結果を基に、別のシステムと連携したり、ダッシュボードを作成してください。