📓
Node-AI モデルAPIサービス利用の流れ
全体ステップの流れ共通のステップStep1. AI モデルを作成Step2. 推論API/学習APIを作成Step3. APIキーを作成推論APIのみを利用するパターンStep4. 推論API:予測用パラメータを送信し、推論ジョブを実行Step5. 推論API:推論の進捗状況を確認Step6. 推論API:結果(予測値)を取得学習APIも利用するパターンStep4. 学習API:学習用ファイルをアップロードし、学習を実行Step5. 学習API:学習の進捗状況を確認Step6. 学習API:結果(推論用モデルID)を取得Step7. 推論API:推論APIを実行し、推論値を取得する
全体ステップの流れ
Node-AI モデルAPIサービス(以下、モデル API)を利用する場合、ユースケースとして主に下記の2パターンが存在します。
ここでは各ステップの簡単な概要と Node-AI 特有の概念について説明します。詳細手順については以下のページを参照してください。
- 推論 API のみを利用するパターン
- 学習 API を利用し、推論APIを作成した上で結果(予測値)を取得するパターン
共通のステップ
Step1~3 はどちらのパターンでも共通のステップとなります。
Step1. AI モデルを作成
Node-AI のブラウザ操作で AI モデルを作成します。AI モデルの作成には、予測タスクであれば評価カードの実行、異常検知タスクであれば異常度可視化カードの実行 がそれぞれ必要です。
| 単語/概念 | 意味 |
|---|---|
| AI モデル | Node-AI にアップロードしたデータによって構築された AI モデル |
Step2. 推論API/学習APIを作成
Node-AI のブラウザ操作で推論 API または学習 API を作成します。推論 API または学習 API で対象となる AI モデルは API 作成時に選択可能です。
| 単語/概念 | 意味 |
|---|---|
| 推論 API | API 作成時に選択した AI モデルで推論(予測)を行うための API |
| 学習 API | API 作成時に選択した AI モデルで学習を行い、新たな推論 API を作成するための API |
| API 作成時に選択可能な AI モデル | API を作成したいチーム内のキャンバスで評価カードもしくは異常度可視化カードが実行された際の AI モデル |
Step3. APIキーを作成
Node-AI のブラウザ操作で API キーを作成します。API キーはモデルAPIサービス 無制限オプションの加入状況によって有効期限が異なります。
| 単語/概念 | 意味 |
|---|---|
| API キー | API 利用に必要な認証鍵 |
| モデルAPIサービス 無制限オプション | モデルAPIの利用には通常以下制限がかかるが、このオプションに加入することで制限を解除することが可能 • APIキーの有効期限が1時間 • 学習APIが利用不可 このオプションに加入するためには、Business プランに加入した上でモデル API サービス 無制限オプションに加入する必要がある 加入する場合は こちら からの問い合わせが必要 |
推論APIのみを利用するパターン
推論APIでは、非同期処理 + ポーリング 形式 で 結果(予測値)を取得します
非同期処理 + ポーリング 形式 とは、「サーバ側に処理(ジョブ)を投げ、その処理が完了しているかクライアント側から定期的に完了確認(ポーリング)を行う」ような処理を指します。
Step4. 推論API:予測用パラメータを送信し、推論ジョブを実行
作成した推論 API に対して HTTP リクエスト の POST で AIモデルが必要とするパラメータを送信することで、推論を実行する推論ジョブを作成します。
推論ジョブの作成が完了すると、推論ジョブを一意に識別する推論ジョブIDが発行されます。
| 単語/概念 | 意味 |
|---|---|
| 推論ジョブ | AIモデルが推論するための一連の処理 |
| パラメータ | Base64 化された CSV ファイルデータや予測期間など AI モデルが推論ジョブを実行するにあたって必要とする値 |
Step5. 推論API:推論の進捗状況を確認
Step4 で作成した推論ジョブのステータスを確認します。ステータスの確認は Step4 で発行された推論ジョブIDを利用します。推論ジョブは最終的に必ず failed・completed のいずれかのステータスになります。
Step6. 推論API:結果(予測値)を取得
Step5 で推論ジョブのステータスが completed になったものに対して、推論ジョブの結果(予測値)を取得します。推論ジョブの結果取得には Step4 で発行された推論ジョブIDを利用します。
| 単語/概念 | 意味 |
|---|---|
| 予測値 | 推論 API 作成時に選択した AI モデルがパラメーターに基づいて出力した値 |
学習APIも利用するパターン
このパターンでは、学習APIを実行することで推論APIを作成し、その推論APIを利用して結果(予測値)を取得します。
学習APIでも推論APIと同様に 非同期処理 + ポーリング 形式 で 結果(推論用モデルID)を取得します。
取得した推論用モデルIDを利用して推論APIを実行します。
Step4. 学習API:学習用ファイルをアップロードし、学習を実行
作成した学習 API に対して HTTP リクエスト の POST で 学習用データセット(CSVファイル)を送信することで、新たな推論 API を作成する学習ジョブを作成します。
学習ジョブの作成が完了すると、学習ジョブを一意に識別する学習ジョブIDが発行されます。
| 単語/概念 | 意味 |
|---|---|
| 学習ジョブ | AIモデルが学習するための一連の処理 |
| 学習用データセット | AIモデルを学習する際に利用するデータ データ形式として以下である必要がある • CSVファイル • Node-AI 上でモデル学習を実施した時に指定した説明変数を含むデータ |
Step5. 学習API:学習の進捗状況を確認
Step4 で作成した学習ジョブのステータスを確認します。ステータスの確認は Step4 で発行された学習ジョブIDを利用します。学習ジョブは最終的に必ず failed・completed のいずれかのステータスになります。
Step6. 学習API:結果(推論用モデルID)を取得
Step5 で学習ジョブのステータスが completed になったものに対して、学習ジョブの結果(推論用モデルID)を取得します。学習ジョブの結果取得には Step4 で発行された学習ジョブIDを利用します。
| 単語/概念 | 意味 |
|---|---|
| 推論用モデルID | 学習によって新たに作成された推論用モデルを一意に識別するためのID 後続の推論APIを実行する際(リクエスト時)に、どのモデルを使用するかを指定するために利用します。 |
Step7. 推論API:推論APIを実行し、推論値を取得する
Step6. で取得した推論用モデルIDを、推論APIの実行時(リクエスト時)に指定して予測を行います。詳細な実行手順については、本ページ上部の 推論APIのみを利用するパターン を参照してください。