> ## Documentation Index
> Fetch the complete documentation index at: https://praison.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# redact • AI Agent SDK

> Redaction utilities for action trace.

# redact

AI Agent

Redaction utilities for action trace.

Provides deterministic redaction of sensitive data in tool arguments
and results. Uses only stdlib for zero dependencies.

## Import

```python theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
from praisonaiagents.trace import redact
```

## Functions

> [card] [redact\_dict()](https://praison.ai/docs/sdk/reference/praisonaiagents/functions/redact_dict.md)
>
> Redact sensitive values from a dictionary.

> [card] [scrub\_pii\_text()](https://praison.ai/docs/sdk/reference/praisonaiagents/functions/scrub_pii_text.md)
>
> Redact API keys, passwords, SSNs, credit cards, and emails from free text.

> [card] [enable\_pii\_redaction()](https://praison.ai/docs/sdk/reference/praisonaiagents/functions/enable_pii_redaction.md)
>
> Register a BEFORE\_LLM hook that scrubs secrets from every message.

> [card] [disable\_pii\_redaction()](https://praison.ai/docs/sdk/reference/praisonaiagents/functions/disable_pii_redaction.md)
>
> Unregister the PII-redaction hook. No-op if never enabled.

> [card] [redact\_string()](https://praison.ai/docs/sdk/reference/praisonaiagents/functions/redact_string.md)
>
> Redact potential secrets from a string.

### Constants

| Name | Value |
| - | - |
| `_REDACT_PATTERN` | `re.compile('(' + '\|'.join((re.escape(k) for k in REDACT_KEYS)) + ')')` |
| `_REDACT_KV_PATTERN` | `re.compile('(["\\\']?)(' + '\|'.join((re.escape(k) for k in REDACT_KEYS)) + ')(["\\\']?\\s*[:=]\\s*["\\\']?)([^"\\\'\\s,}\\]]+)', re.IGNORECASE)` |
| `_URL_USERINFO_PATTERN` | `re.compile('\\b([a-zA-Z][a-zA-Z0-9+.\\-]*://)[^/?#\\s]+@')` |
| `_URL_BOT_TOKEN_PATTERN` | `re.compile('/bot\\d+:[A-Za-z0-9_\\-]+')` |
| `REDACTED_VALUE` | `'[REDACTED]'` |
| `_VALUE_PATTERNS` | `((re.compile('\\bsk-[A-Za-z0-9]{12,}\\b'), '[REDACTED]'), (re.compile('\\b\\d{3}-\\d{2}-\\d{4}\\b'), '[REDACTED-SSN]'), (re.compile('\\b(?:\\d{4}[ -]){3}\\d{4}\\b'), '[REDACTED-CC]'), (re.compile('\\b...` |
| `_PII_HOOK_LOCK` | `threading.Lock()` |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.