From f1fe229bb10738485f67225cd0604a3cd2495170 Mon Sep 17 00:00:00 2001
From: Krrish Dholakia <krrishdholakia@gmail.com>
Date: Sat, 13 Jul 2024 12:34:49 -0700
Subject: [PATCH] docs(guardrails.md): update guardrail api spec

---
 docs/my-website/docs/proxy/guardrails.md | 31 +++++++++++++++---------
 1 file changed, 20 insertions(+), 11 deletions(-)

diff --git a/docs/my-website/docs/proxy/guardrails.md b/docs/my-website/docs/proxy/guardrails.md
index 4c4d0c0e91b..5f561066bd2 100644
--- a/docs/my-website/docs/proxy/guardrails.md
+++ b/docs/my-website/docs/proxy/guardrails.md
@@ -277,6 +277,22 @@ The `pii_masking` guardrail ran on this request because api key=sk-jNm1Zar7XfNdZ
 
 ## Spec for `guardrails` on litellm config
 
+```yaml
+litellm_settings:
+  guardrails:
+    - string: GuardrailItemSpec
+```
+
+- `string` - Your custom guardrail name
+
+- `GuardrailItemSpec`:
+    - `callbacks`: List[str], list of supported guardrail callbacks.
+        - Full List: presidio, lakera_prompt_injection, hide_secrets, llmguard_moderations, llamaguard_moderations, google_text_moderation
+    - `default_on`: bool,  will run on all llm requests when true
+    - `logging_only`: Optional[bool], if true, run guardrail only on logged output, not on the actual LLM API call. Currently only supported for presidio pii masking. Requires `default_on` to be True as well.
+
+Example: 
+
 ```yaml
 litellm_settings:
   guardrails:
@@ -286,19 +302,12 @@ litellm_settings:
     - hide_secrets:
         callbacks: [hide_secrets]
         default_on: true
+    - pii_masking:
+        callback: ["presidio"]
+        default_on: true
+        logging_only: true
     - your-custom-guardrail
         callbacks: [hide_secrets]
         default_on: false
 ```
 
-
-### `guardrails`: List of guardrail configurations to be applied to LLM requests.
-
-#### Guardrail: `prompt_injection`: Configuration for detecting and preventing prompt injection attacks.
-
-- `callbacks`: List of LiteLLM callbacks used for this guardrail. [Can be one of `[lakera_prompt_injection, hide_secrets, presidio, llmguard_moderations, llamaguard_moderations, google_text_moderation]`](enterprise#content-moderation)
-- `default_on`: Boolean flag determining if this guardrail runs on all LLM requests by default.
-#### Guardrail: `your-custom-guardrail`: Configuration for a user-defined custom guardrail.
-
-- `callbacks`: List of callbacks for this custom guardrail. Can be one of `[lakera_prompt_injection, hide_secrets, presidio, llmguard_moderations, llamaguard_moderations, google_text_moderation]`
-- `default_on`: Boolean flag determining if this custom guardrail runs by default, set to false.