guardrail_id を設定すると、
そのキーで行われるすべての /v1/* 呼び出しが次のリクエストでスクリーニングされます
— 再デプロイなし、SDK 変更なしで。
このページはバインディングのみを扱います — どうアタッチするか、解決が有効な
ポリシーをどう選ぶか、そしてオフスイッチが何をするか。ルールの種類、アクション、
ステージについてはガードレールリファレンスを参照
してください。
1. guardrail_id で API キーごとにガードレールをバインドする
ガードレールはワークスペーススコープですが、強制はキーごとに決定されます。
各 API キーは
guardrail_id フィールドを持ちます。それをガードレールに向けると、そのキー —
そしてそのキーだけ — がそのポリシーでスクリーニングされます。
これにより、ひとつのワークスペースが異なるキーで異なるポリシーを実行できます:
- 厳格な
pii-blockerにバインドされた本番キー、 - より軽い
flag-onlyポリシーにバインドされたステージングキー、 - 何もアタッチされていない内部キー。
https://api.orcarouter.ai/v1/chat/completions を呼び出し
続けます。
リレーキー(
sk-orca-…)はあなたのアプリが送信するものです。それにガードレールを
アタッチするのは、あなたのセッションで認証されるコンソール / トークン API
アクションです — リレーキー自体でガードレールを設定することは決してありません。2. コンソールでアタッチする
コンソールからバインディングを設定します(ロールゲート:キーとガードレールの編集には Developer+ が必要)。
その後、バインドされたキーでの通常のリレー呼び出しは自動的にスクリーニングされます:
[EMAIL] を見て、アドレスを決して見ません — 同じ呼び出し、クライアント
変更なし。
3. 解決が有効なガードレールをどう選ぶか
すべてのリクエストで、ゲートウェイはこの順序で正確にひとつの有効な ガードレール(または none)を解決します:1 — 明示的なキーアタッチメント
1 — 明示的なキーアタッチメント
キーの
guardrail_id がガードレールを指し、かつそのガードレールが
存在し、かつ有効である場合、それが適用されます。明示的アタッチメントは
権威的です — ワークスペースデフォルトに決してサイレントにフォールバックしません。2 — ワークスペースデフォルト
2 — ワークスペースデフォルト
キーにアタッチメントがない場合(
guardrail_id が 0 / 未設定)、設定
されていればワークスペースの有効なデフォルトガードレールが適用されます。3 — どちらも解決しない
3 — どちらも解決しない
強制なし。リクエストはこの機能を一度も有効化していないワークスペースと
バイト単位で同一です — 何もブロック、マスク、ログ記録されません。
4. オフスイッチ:アタッチメントを無効化、フォールバックなし
これは人々が見落とす部分です。明示的なキーアタッチメントはそれ自体が権威です — そのためアタッチされたガードレールを無効化すると、そのキーの強制が OFF に なり、ワークスペースデフォルトにフォールバックしません。| キーの状態 | 何がリクエストをスクリーニングするか |
|---|---|
guardrail_id → 有効なガードレール | そのガードレール |
guardrail_id → 無効なガードレール | 何もなし(フォールバックなし) |
guardrail_id → 削除済み / 欠落 | 何もなし(フォールバックなし) |
guardrail_id = 0 / 未設定 | ワークスペースデフォルト(あれば) |
5. バインディングをデタッチまたはクリアする
特定のガードレールでキーをスクリーニングするのを止めるには、異なる結果を持つ 2 つの異なる手があります:- アタッチメントをクリアする — キーの
guardrail_idを0に設定します。 キーは(存在すれば)ワークスペースデフォルトに、なければ none に解決されます。 - ガードレールを無効化する — ガードレールの
enabledをオフに切り替えます。 それに明示的にアタッチされたすべてのキーは(§4 のとおり)none に解決され、 一方それをワークスペースデフォルトとして頼っていたキーは強制なしに流れ落ちます。
6. スクリーニングされたリクエストにかかる(かからない)コスト
ガードレールが解決すると、そのルールがリクエストを決定します。バインドされた キーについて知っておく価値のある 2 つの結果:- block は、発火したガードレールとルールを示しつつ、エラーコード
guardrail_blockedとともに HTTP 400 を返します。クォータは消費されません — 入力ステージのブロックはメータリングの前に発火し、出力ステージのブロックは 事前消費されたクォータを返金します — そして skip-retry とマークされます。 - mask はマッチを型付きタグ(例:
[EMAIL])に書き換え、サニタイズされた リクエストを通します。アップストリームモデルが元のものを目にすることはありません。
guardrail_blocked エラー
ページを、ストリーミングされたレスポンスで出力ルールがどう振る舞うかについては
ストリーミングカバレッジを参照
してください。
7. 次にどこへ
最初のガードレールを作成する
キーにバインドするポリシーを構築します。
アカウントデフォルトガードレール
ワークスペースのすべてのキーを一度にスクリーニングします。
ガードレールリファレンス
ルールの種類、アクション、ステージ、PII、judge、グラウンディング。
キー、ポリシー、ワークスペース
バインディングがゲートウェイ全体でどうスコープされるか。
