Skip to main content
網關護欄在綁定到某個 API 密鑰的每次補全請求周圍,疊加一層確定性的輸入/輸出策略。SDK 提供以下能力:
  • theo.guardrails.policies — 創建和管理策略。
  • theo.guardrails.presets — 只讀的預設模板。
  • theo.guardrails.executions — 追溯審計日誌。
  • theo.keys.getGuardrailPolicy / setGuardrailPolicy — 將策略綁定到某個密鑰。
關於嚴格的可選啓用約定、內置防護措施以及裁定語義,參見護欄指南。底層的 HTTP 結構見API 參考。

嚴格的可選啓用約定

策略僅在通過 theo.keys.setGuardrailPolicy() 顯式綁定到某個 API 密鑰時才會生效。未綁定的密鑰永遠不會觸發護欄——不存在自動的組織級或用戶級默認回退。創建策略(或從預設生成策略)不會自動綁定它。

策略

列出

獲取

創建

scope: "team" 需要一個有效的組織以及團隊配置權限。通過 Idempotency-Key 請求頭實現冪等。

更新

發送 rules 會替換整個規則集。

刪除

會級聯移除所有指向該策略的密鑰綁定——此前綁定的密鑰將回歸嚴格可選啓用的默認狀態(即不執行任何護欄檢查)。

測試(重放提示詞)

針對該策略重放一個固定的提示詞(以及可選的模型輸出),並返回裁定鏈路——供儀表盤的測試台使用,無需消耗一次真正的補全調用。

綁定關係

列出當前綁定到某個策略的活躍(未撤銷)密鑰。在生產環境依賴某個策略之前,可用它來確認該策略正在預期的密鑰上生效。

預設

儀表盤在空狀態下提供的只讀藍圖。目前上線的四個預設分別是 pii-safe、strict-json、cost-conscious 和 enterprise-default。 從預設創建策略,本質上就是一次普通的 policies.create() 調用,只是用預設的 rules 作為初始值:

執行記錄(審計日誌)

記錄每一次護欄評估的只追加日誌。個人調用方只能看到自己的記錄;團隊調用方可以看到當前活躍組織所擁有的策略下所有成員的記錄。記錄保留 90 天。

密鑰綁定

錯誤處理

當輸入階段觸發 deny 裁定時,SDK 會拋出一個與 REST 響應體結構一致的結構化錯誤:
對於流式補全,同樣的響應體會在 done 之前以 error 類型的 SSE 事件發出。完整的錯誤分類見錯誤處理。

類型

SDK 為每一種數據結構都導出了對應的類型:
  • GuardrailPolicySummary — 完整的策略記錄行。
  • GuardrailRuleInput — 單條規則(guardrail_id、phase、verdict,可選的 config、enabled、rule_order)。
  • GuardrailId — "pii_redactor" | "prompt_injection" | "json_repair" | "max_length" | "profanity"。
  • GuardrailPhase — "input" | "output"。
  • GuardrailVerdict — "flag" | "redact" | "truncate" | "repair" | "deny"。
  • GuardrailPolicyPreset — presets.list() 返回的預設模板。
  • GuardrailPolicyBinding — 綁定關係端點返回的單條記錄。
  • GuardrailPolicyTestResult — policies.test() 返回的裁定鏈路。
  • GuardrailExecutionRecord — 執行記錄審計日誌中的單條記錄。