From a61b0bf9e5a864a41bf882f3f50bfc9c34e63d20 Mon Sep 17 00:00:00 2001
From: Krrish Dholakia <krrishdholakia@gmail.com>
Date: Wed, 14 Feb 2024 12:09:05 -0800
Subject: [PATCH] docs(pii_masking.md): add output parsing to docs

---
 docs/my-website/docs/proxy/pii_masking.md | 33 ++++++++++++++++++++---
 1 file changed, 29 insertions(+), 4 deletions(-)

diff --git a/docs/my-website/docs/proxy/pii_masking.md b/docs/my-website/docs/proxy/pii_masking.md
index 9fd55c7e1..54fb32bce 100644
--- a/docs/my-website/docs/proxy/pii_masking.md
+++ b/docs/my-website/docs/proxy/pii_masking.md
@@ -4,21 +4,22 @@ import Image from '@theme/IdealImage';
 
 LiteLLM supports [Microsoft Presidio](https://github.com/microsoft/presidio/) for PII masking. 
 
-## Step 1. Add env
+## Quick Start
+### Step 1. Add env
 
 ```bash
 export PRESIDIO_ANALYZER_API_BASE="http://localhost:5002"
 export PRESIDIO_ANONYMIZER_API_BASE="http://localhost:5001"
 ```
 
-## Step 2. Set it as a callback in config.yaml
+### Step 2. Set it as a callback in config.yaml
 
 ```yaml
 litellm_settings: 
     callbacks = ["presidio", ...] # e.g. ["presidio", custom_callbacks.proxy_handler_instance]
 ```
 
-## Start proxy 
+### Step 3. Start proxy 
 
 ```
 litellm --config /path/to/config.yaml
@@ -27,4 +28,28 @@ litellm --config /path/to/config.yaml
 
 This will mask the input going to the llm provider
 
-<Image img={require('../../img/presidio_screenshot.png')} />
\ No newline at end of file
+<Image img={require('../../img/presidio_screenshot.png')} />
+
+## Output parsing 
+
+LLM responses can sometimes contain the masked tokens. 
+
+For presidio 'replace' operations, LiteLLM can check the LLM response and replace the masked token with the user-submitted values. 
+
+Just set `litellm.output_parse_pii = True`, to enable this. 
+
+
+```yaml
+litellm_settings:
+    output_parse_pii: true
+```
+
+**Expected Flow: **
+
+1. User Input: "hello world, my name is Jane Doe. My number is: 034453334"
+
+2. LLM Input: "hello world, my name is [PERSON]. My number is: [PHONE_NUMBER]"
+
+3. LLM Response: "Hey [PERSON], nice to meet you!"
+
+4. User Response: "Hey Jane Doe, nice to meet you!"
\ No newline at end of file