異常検知（MLP）
このページでは異常検知用推論 API（MLP）の実行手順を記載しています。
異常検知用推論 API（MLP）を実行することで、Node-AI上で異常度可視化カードを実行したときに得られる異常度をAPI経由で取得することが可能です。
異常度についての詳細は以下ページを参考にしてください。
Node-AIリソース本ページの想定読者
本ページはAPI連携を行う開発者向けに記載しています。
そのため、プログラミングの基礎知識をお持ちの方を想定した内容となっています。
利用要件
どなたでもご利用いただけます。
モデル API をご利用いただくにあたり、API キーの作成が必要となります。API キーの有効期限は Businessプランにおけるモデル API サービス 無制限オプションに加入中かどうかで異なります。
モデル API サービス 無制限オプションの詳細については以下を参照してください。
- モデル API サービス 無制限オプションに加入している場合
- 有効期限：無期限
- モデル API サービス 無制限オプションに加入していない場合
- 有効期限：1 時間
事前準備
異常検知用推論 API(MLP)を利用するには、以下の条件を満たしている必要があります。
- 実験管理 に推論 API で利用したい異常検知用ツリーの実行時のパラメータが表示されていること
- 上記異常検知用ツリーのモデルとして MLP が利用されていること
上記条件を満たすためには、事前に以下の Node-AI 上での操作が必要です。
- キャンバス上で異常検知用のツリーを用意してあること
- 異常度可視化カードまでツリーが実行済みであること
手順
Node-AI 上での準備
推論 API を利用するためには以下の2つを Node-AI で準備する必要があります。
- API キー (JWT)
- 推論用モデルID (UUID)
Node-AI の API タブ に進んでいただき、「API用モデルを作成」ボタンを押してください。
次のようなモーダルが表示されるので、利用したいモデルを選び、「次へ」をクリックしてください。
そして、種別で「推論」を選択してください。
「API用モデル名」と「概要」は自由に設定してください。
設定後、「作成」をクリックしてください。
すると作成済みの API 一覧が表示されます。該当する API の行を選択すると、右側にパネルが開きます。このパネルで API キー と 推論用モデルID を取得してください（この2つの値が API の利用に必要です）。
※ 下の画面のように、API キーが表示されていない場合は「APIキーを作成」をクリックすることでAPIキーが作成されます。
推論 API の実行
以下は実行手順の全体像を示した図となります。
手順の全体像
以下にPython、Bash(cURL)、PowerShell 7系でのサンプルコードを記載します。
セキュリティに関する注意
本ドキュメントのサンプルコードでは、説明の簡略化のため API キーをスクリプト内に直接記載しています。
本番環境で運用する際は、以下のような方法で API キーを安全に管理してください。
- 環境変数を利用する
- シークレット管理ツール(AWS Secrets Manager、HashiCorp Vault など)を利用する
API キーをソースコードや Git リポジトリにハードコードしないようご注意ください。
Python
などのファイル名で保存し、サンプルコード上部にコメントで記載されている必要な設定を行うことで、Pythonで実行することができます。
Pythonはサポート期間中のものを利用することを推奨します。
どのバージョンの Python がサポート期間中であるかについての詳細は、以下のページを参照してください。
また、ライブラリ を追加でインストールする必要があります。未インストールの場合は、以下のインストールコマンドを実行してください。
Bash(cURL)
などのファイル名で保存し、 などで実行権限を付与します。その後、サンプルコード上部にコメントで記載されている必要な設定を行うことで実行することが可能です。
以下のスクリプトは Linux、Mac、Windows の Bash 環境で動作します。 および コマンドが使用できる環境が必要です。
PowerShell 7系
などのファイル名で保存し、サンプルコード上部にコメントで記載されている必要な設定を行うことで、PowerShell で実行することができます。
以下のスクリプトは PowerShell 7.x のインストールが必要です。
PowerShell 7.x のインストール方法は、公式ドキュメントを参照してください。