NVIDIA の NemoGuard モデルでエージェントのリクエストをチェックする NeMo Guardrails
エージェントのモデルリクエストは NVIDIA NeMo Guardrails を通過し、NeMo Guardrails は各リクエストを NVIDIA の 2 つの NemoGuard モデルでチェックします。これらは NVIDIA のライセンス製品で、実行には NVIDIA のライセンス、NGC API キー、GPU ノードが必要です。
必要なもの
2 つの NemoGuard モデルは、NVIDIA の条件のもとで実行する NVIDIA 製品です。このワークスペースがビルドするものをデプロイするには、次のものが必要です:
- NVIDIA のライセンス。 各 NemoGuard マイクロサービスに関する NVIDIA のドキュメントは、前提条件を「NVIDIA AI Enterprise 製品の有効なサブスクリプションを持っているか、NVIDIA Developer Program のメンバーであること」としており、コンテナとモデルへのアクセスは制限されていると述べています。
- Release がシークレットとして参照する NGC API キー。 NemoGuard コンテナは NVIDIA のレジストリ
nvcr.ioからプルされ、各コンテナは起動時にそのキーを使って NVIDIA からモデルを取得します。Release はキーを保持する 2 つの Kubernetes Secret を指定します(1 つは Pod がキーを読み取るためのもの、もう 1 つはクラスターがイメージをプルするためのもの)。このワークスペースのどのファイルも、ビルドが書き出すどのものも、キー自体は保持しません。 - GPU ノード。 各 NemoGuard コンテナは NVIDIA GPU を要求します。NVIDIA によると、コンテンツセーフティモデルには、1 基または 2 基の GPU で 48 GB の GPU メモリが必要です。
ビルドにはこれらのいずれも必要ありません。キーがない状態で Kubernetes マニフェストにコンパイルし、NVIDIA にもクラスターにも接続しません。
構築されるもの
エージェントは AI ゲートウェイを通じてモデルを要求します。ゲートウェイはすべてのモデルリクエストをまずガードに送り、ガードは最新のユーザーメッセージを 3 つの方法でチェックしてから、許可したものをモデルに転送します。プロンプトインジェクション分類器、NVIDIA のコンテンツセーフティモデル、NVIDIA のジェイルブレイク分類器によるチェックです。このワークスペースは、この構成を Kubernetes マニフェストにコンパイルします。
ライセンスが必要な商用製品も、オープンソース製品と同じ方法でプロビジョニングされることを示します。カタログの Component、Recipe、uses エッジ、認証情報のアタッチメントを使い、ライセンスについては読者がコンポーネントを選ぶ場所に記載します。このワークスペースは独自のカタログエンティティを記述しません。Aggregate、Manifest、Release が、誰かが書くもののすべてです。
| インスタンス | カタログの Component | ここでの役割 |
|---|---|---|
agent | core/ai-agent/langgraph | エージェント。Release 独自のアプリケーションイメージで、ゲートウェイを通じてモデルにアクセスします |
checkpointer | core/datastore/valkey | エージェントが実行状態を保存する場所 |
router | core/gateway/litellm | AI ゲートウェイ。1 つのエイリアス assistant を、ガードを経由してモデルに送ります |
guard | core/security/nemo-guardrails | モデルの経路上にある NVIDIA NeMo Guardrails のサーバー |
detector | core/security/trustyai-huggingface-detector | ガード自身のレールが問い合わせるプロンプトインジェクション分類器 |
safety | core/ai-model/nemoguard-content-safety | NVIDIA の Llama 3.1 NemoGuard 8B ContentSafety。その NIM が提供します |
jailbreak | core/security/nemoguard-jailbreak-detect | NVIDIA の NemoGuard JailbreakDetect。その NIM が提供します |
uses エッジは次のとおりです。エージェントの model ソケットからゲートウェイへ、checkpointer_db ソケットからストアへ。ゲートウェイの guard ソケットからガードへ。ガードの detector、content_safety、jailbreak_detection ソケットから 3 つのチェックへ。アタッチメントは次のとおりです。shield(ガードをゲートウェイの経路に置く core/prompt-injection-shield Feature)、upstream_key(ガードがモデル API に提示する認証情報)、そして各 NemoGuard コンポーネント上の ngc_api_key です。
サンプルを生成する
このサンプルは以下のコマンドでビルドできます。または、AI アシスタントにビルドを任せることもできます。
例の名前を付けた新しいフォルダーに例を書き出します。
aggrega scaffold --example nemo-guardrails-nemoguard-nimsその後、次に実行するコマンドを表示します。最初のコマンドは新しいフォルダーに移動します。
cd nemo-guardrails-nemoguard-nimsビルド
aggrega build --release release.yaml --auto-pullrelease はビルドの前に lockfile を必要とします。lockfile は同梱されるのではなく生成されるため、クローンした直後には存在しません。先に解決するか、ビルドに作成させてください:
aggrega pull --release release.yaml # resolve once, then build with no flagaggrega build --release release.yaml --auto-pull # or resolve during the buildこのワークスペースは、.aggrega-config.yaml が指定するデフォルトレジストリからカタログのエンティティを解決します。shield の実現では、コンパイラにもカタログにも同梱されていないプラグインを 1 つ実行します。これはゲートウェイ設定ステップ pipeline-step/litellm-gateway-config で、解決時に default_registry が指定するレジストリ hub.aggrega.ai から取得されます。
ビルドは次のように出力します。<workspace> はこの例のフォルダを表します。
[… omitted: a line reporting on the gateway configuration step's plugin, the resolution's summary, a notice that core/referenced-secret declares origin in both of its pillars, and a total build time, which differs per run]Build completed: 18 files written to <workspace>/distRelease は、カタログが指定しないすべてのイメージを指定します。 エージェントのイメージは独自のアプリケーションです。ガードと検出器のイメージは、実行するビルドのコピーで、管理下のレジストリにミラーしたものです。2 つの NemoGuard イメージは NVIDIA のもので、ライセンスに基づいてプルする権利があります。カタログはそのいずれも指定せず、release.yaml はそれぞれをタグ change-me で記述しています。ビルドはそこにある文字列をそのまま渡します。デプロイ前に置き換えてください。
AI アシスタントを使う
Aggrega のツールでセットアップした AI アシスタントでも同じことができます。次のプロンプトを貼り付けてください。
Aggrega のツールのみを使用し、フォルダーは自分で作成しないでください。Workspace フォルダーにまだ `nemo-guardrails-nemoguard-nims` フォルダーがない場合は、`example` を `nemo-guardrails-nemoguard-nims` に設定し、`dir` を指定せずに `scaffold` ツールを 1 回呼び出してください。これにより、新しい `nemo-guardrails-nemoguard-nims` フォルダーに例が書き込まれます。次に、`workspace_root` を `nemo-guardrails-nemoguard-nims`、`release` を `release.yaml`、`auto_pull` を true、`write` を true に設定して `build` ツールを呼び出してください。ビルドが書き込んだファイルを教えてください。それらは `nemo-guardrails-nemoguard-nims/dist/` の下にあります。レンダリングされたツリー
dist/helm/├── agent-deployment.yaml├── checkpointer-default-service.yaml├── checkpointer-deployment.yaml├── detector-default-service.yaml├── detector-deployment.yaml├── guard-default-service.yaml├── guard-deployment.yaml├── guard/│ └── nemo-guardrails-config.configmap.yaml├── jailbreak-default-service.yaml├── jailbreak-headless-service.yaml├── jailbreak-statefulset.yaml├── router-default-service.yaml├── router-deployment.yaml├── router/│ ├── litellm-gateway-config/│ │ └── configmap.yaml│ └── request-guard/│ └── request-guard.yaml├── safety-default-service.yaml├── safety-headless-service.yaml└── safety-statefulset.yamlその中に Secret はありません。すべての認証情報は core/referenced-secret としてアタッチされ、Manifest はそれを helm/k8s-existing-secret にバインドします。これはワークロードを名前空間にすでに存在する Secret に向け、それ自体は何もレンダリングしません。
参照としてのキー
Aggregate が書くのは、Secret の中でキーが置かれている場所、つまりデータキー NGC_API_KEY だけです。Release は Secret の名前 ngc-api-key と、イメージのプルに使う Secret の名前 ngc-registry を指定します。dist/helm/safety-statefulset.yaml では次のとおりで、ジェイルブレイク分類器のファイルでも同様です:
env: - name: NGC_API_KEY valueFrom: secretKeyRef: name: ngc-api-key key: NGC_API_KEY imagePullSecrets: - name: ngc-registryデプロイする前に、ターゲットの名前空間に両方の Secret を作成してください。NGC_API_KEY の下にキーを保持する ngc-api-key と、そのキーでログインする nvcr.io 用のイメージプル Secret である ngc-registry です。ガードの上流の認証情報も同じ方法で名前が付けられており、upstream-key の下にモデル API のキーを保持する Secret upstream-provider-key です。
Release はその場所にキーそのものを書き込むことはできません。Release 内のアタッチメントに置かれた values: ブロックは、ドキュメントの読み込み時に拒否されます。Release がそこに書くものはオペレーターのものであり、values は開発者のものだからです。safety コンポーネントの ngc_api_key の infra: ブロックを、origin を保持する values: に置き換えると、ビルドは他の何よりも先に次を出力します:
[OPS_ERROR E0215] release.yaml document envelope validation failed (Release, at release.yaml); 66:11: spec.components.safety.features.ngc_api_key.values: against /$defs/boundary_component: unexpected property: "values". correct the document to match its kind's schemaRelease が実際に書く唯一の文字列である Secret の名前は、書かれたとおりに公開されます。ビルドは名前とキーを区別できないため、名前を書くべき場所に入力されたキーは、その名前としてマニフェストに現れます。aggrega build --ir-graph が出力するグラフは、どちらの場合もそれを伏せます。origin が機密として宣言されているためです。
ガードが行うこと
ガードの設定、つまり dist/helm/guard/nemo-guardrails-config.configmap.yaml の config.yaml キーのうち、プロンプトの手前までです:
models: - type: main engine: openai model: named-by-each-request api_key_env_var: UPSTREAM_API_KEY - type: content_safety engine: openai model: "llama-3.1-nemoguard-8b-content-safety" parameters: base_url: "http://safety-default:8000/v1" api_key: EMPTYpassthrough: truerails: config: hf_classifier: prompt_injection: engine: fms model: "protectai/deberta-v3-base-prompt-injection-v2" base_url: "http://detector-default:8000" threshold: 0.5 blocked_labels: ["INJECTION"] jailbreak_detection: nim_base_url: "http://jailbreak-default:8000/v1/" nim_server_endpoint: classify input: flows: - hf classifier check input $classifier=prompt_injection - jailbreak detection model - content safety check input $model=content_safetyチャットリクエストごとに、ガードは最新のユーザーメッセージに対して 3 つの入力レールをこの順序で実行し、いずれかが拒否した場合にリクエストを拒否します:
- プロンプトインジェクション分類器は、検出器が
INJECTIONを0.5以上と報告した場合に拒否します。 - ジェイルブレイク分類器は、NVIDIA の分類器がメッセージをジェイルブレイクの試みであると回答した場合に拒否します。ガードはメッセージを
classifyルートに送信します。クラスター内のサービスはキーを求めないため、キーは設定されていません。 - コンテンツセーフティモデルは、メッセージを安全でないと評価した場合に拒否します。ガードはこれを、NIM が提供する OpenAI 互換 API を通じて、
safetyエッジが公開するエンドポイントとモデル名で到達するモデルとして宣言します。そのプロンプト(config.yamlの残りの部分)は、NVIDIA の NeMo Guardrails ドキュメントがこのモデル向けに示しているもので、有害カテゴリを列挙しており、NeMo Guardrails がその判定用に提供するパーサーで読み取られます。
拒否されたリクエストにはガード自身が I’m sorry, I can’t respond to that. と応答し、その内容は何もモデルに届きません。ガードの設定には、リクエスト本文が何を求めていても入力レールを実行するフロー rails.co も含まれています。
safety の values.model は、コンテンツセーフティ NIM が応答する名前で、NIM はこれを自身のモデルマニフェストから取得します。そのモデル一覧 /v1/models は、稼働中のサーバー上でこの名前を表示します。ガードはすべてのチェックでこれを送信するため、両者は一致している必要があります。
行わないこと
- 最新のユーザーメッセージのみを判定します。 システムメッセージ、以前のターン、またはツールの結果に置かれた試みはチェックされずにモデルに届き、モデルの応答、ツール呼び出しの引数、画像はいずれも判定されません。
- すべての判定はモデルによるものです。 3 つのチェックは、有害または操作的なリクエストの一部を見逃し、通常のリクエストの一部を拒否します。
- ジェイルブレイクレールは障害時にリクエストを通過させます。 NVIDIA のドキュメントによると、ジェイルブレイク分類器に到達できない、タイムアウトする、またはエラーで応答する場合、レールはリクエストを通過させ、呼び出し元には何も報告しません。他の 2 つのチェックは引き続き実行されます。プロンプトインジェクションレールは、検出器に到達できない場合にリクエストを拒否します。
- ゲートウェイを通過するトラフィックのみを対象とします。 モデルのアドレスを直接呼び出すワークロードは、これを迂回します。ガードと 3 つのチェックはどの呼び出し元も認証しないため、それらの Services はそれらを呼び出すコンポーネント向けのアドレスであり、公開するためのものではありません。
- ここでの動作は実証されていません。 設定は NVIDIA のドキュメントが説明しているものを事前にコンパイルしたものであり、このワークスペースでは NemoGuard コンテナを実行したことはありません。
ビルドを停止させるもの
ガードの Recipe は、NemoGuard ソケットに何が入っているかをチェックします。safety を通常の core/ai-model/nvidia-nim にする(Aggregate での型と Manifest での行の両方)と、ビルドは何も書き込まずに停止します:
[… omitted: a line reporting on the gateway configuration step's plugin, what resolving the lockfile prints, the same halt among it, and a notice that core/referenced-secret declares origin in both of its pillars][CATALOG_ERROR E0364] instance guard rendering node "guard" caused by: [CATALOG_ERROR] nemo-guardrails-config.configmap.yaml artifact "nemo-guardrails-config.configmap.yaml" template eval caused by: [CATALOG_ERROR] artifacts[nemo-guardrails/nemo-guardrails-config.configmap.yaml] template "artifacts[nemo-guardrails/nemo-guardrails-config.configmap.yaml]" execute caused by (2): a value template failed while it ran --- [… omitted: the template position and the template's own source]: error calling fail: the guard's content_safety socket is wired to "safety", a core/ai-model/nvidia-nim, but the content-safety rail's prompt and verdict parser are NVIDIA's for core/ai-model/nemoguard-content-safety, which another model answers in a shape the parser does not read; wire a core/ai-model/nemoguard-content-safety to content_safetyjailbreak_detection ソケットも同様に core/security/nemoguard-jailbreak-detect だけを受け付け、それ以外は受け付けません。また、各ソケットが受け付けるターゲットは 1 つです。シールド自体の停止条件は ai-gateway-prompt-injection-shield のものと同じで、こちらは NemoGuard のチェックなしで同じゲートウェイとガードを構築します。
コンパイラが解釈しない箇所
コンパイラは、NIM の Service 名とポートをガードの設定に、Secret の名前を Pod に、文字列として渡します。イメージをプルすることも、モデルを取得したりキーを読み取ったりすることもなく、NVIDIA、ガード、モデルのいずれにも接続しません。上記の各停止は、カタログ自身のエンティティによって宣言されています。
応用する
- コンテンツセーフティモデルを使わない場合。
safetyコンポーネントとガードのcontent_safetyエッジを削除します。するとガードの設定には、そのようなモデル、レール、プロンプトは含まれなくなります。ジェイルブレイク分類器も同じ方法で削除します。 - 自分で運用するモデルを使う。 ガードの
upstream_endpointをモデルサーバーのエンドポイントに向け(core/ai-model/vllmがこれを公開します)、 エイリアスのターゲットをopenai/<the name that server serves>と記述します。 - より大きな GPU、または 2 基の GPU。 各 NemoGuard コンポーネントは
infra.gpu.countを受け取り、クラスターがクラスによって GPU ランタイムを選択する場合はinfra.gpu.runtime_classも受け取ります。