Skip to content

Commit

Permalink
Adds PII redaction documentation page
Browse files Browse the repository at this point in the history
Incorporates a new page detailing PII redaction features within
the AI Safety group, enhancing documentation coverage on
privacy-related tools.
  • Loading branch information
gharbat committed Nov 18, 2024
1 parent f10da32 commit 47fec77
Show file tree
Hide file tree
Showing 2 changed files with 164 additions and 1 deletion.
8 changes: 7 additions & 1 deletion docs/mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,13 @@
{
"group": "AI Safety",
"icon": "shield-check",
"pages": ["safety/introduction", "safety/inspect-mode", "safety/debug-mode", "resources/assist-mode"]
"pages": [
"safety/introduction",
"safety/inspect-mode",
"safety/debug-mode",
"safety/pii-redaction",
"resources/assist-mode"
]
},
{
"group": "Resources",
Expand Down
157 changes: 157 additions & 0 deletions docs/safety/pii-redaction.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,157 @@
---
title: "PII Redaction"
description: "Automatically protect sensitive information in conversations"
icon: "user-shield"
---

## What's This?

Our PII (Personally Identifiable Information) redaction system automatically removes sensitive data from conversations to protect privacy and ensure compliance.

<Note>
Data is retained for 30 days after session closure before automatic redaction begins. This period is customizable for your organization.
</Note>

## What Gets Protected

<CardGroup cols={2}>
<Card title="Financial Data" icon="credit-card">
- Credit card numbers
- Bank accounts
- IBAN numbers
- Transaction details
</Card>

<Card title="Personal Info" icon="user">
- Full names
- Birth dates
- ID numbers
- Social security
</Card>

<Card title="Contact Details" icon="address-book">
- Email addresses
- Phone numbers
- Physical addresses
- Postal codes
</Card>

<Card title="Business Data" icon="building">
- VAT numbers
- Company IDs
- License numbers
- Tax references
</Card>
</CardGroup>

## Important Notes

<AccordionGroup>
<Accordion title="Permanent Process">
- Redaction cannot be reversed
- Configure settings before closing sessions
- Changes affect future redactions only
</Accordion>

<Accordion title="Common Examples">
- Credit Cards: XXXX-XXXX-XXXX-1234
- Email: [email protected]
- Phone: +1 (555) 123-4567
- Date: 23/04/1990
</Accordion>
</AccordionGroup>

## Supported Countries

### πŸ‡³πŸ‡± Netherlands

<CardGroup cols={3}>
<Card title="Personal" icon="id-card">
- BSN (Social Security)
- Phone Numbers
- Postal Codes
</Card>
<Card title="Financial" icon="euro-sign">
- IBAN
- BTW (VAT)
- KvK Numbers
</Card>
<Card title="Vehicle" icon="car">
- License Plates
- Registration Numbers
</Card>
</CardGroup>

### πŸ‡§πŸ‡ͺ Belgium

<CardGroup cols={3}>
<Card title="Identity" icon="passport">
- National Registry
- SIS Cards
- Phone Numbers
</Card>
<Card title="Business" icon="building">
- VAT Numbers
- Company Numbers
- KBO/BCE IDs
</Card>
<Card title="Banking" icon="bank">
- IBAN
- Account Numbers
</Card>
</CardGroup>

### πŸ‡©πŸ‡ͺ Germany

<CardGroup cols={3}>
<Card title="Government" icon="landmark">
- Tax ID
- ID Card Numbers
- Social Security
</Card>
<Card title="Financial" icon="euro-sign">
- IBAN
- Tax Numbers
</Card>
<Card title="Vehicle" icon="car">
- License Plates
- Vehicle IDs
</Card>
</CardGroup>

### πŸ‡«πŸ‡· France

<CardGroup cols={3}>
<Card title="Identity" icon="id-card">
- Social Security (NIR)
- Carte Vitale
</Card>
<Card title="Business" icon="building">
- SIRET Numbers
- VAT Numbers
</Card>
<Card title="Vehicle" icon="car">
- License Plates
- Registration IDs
</Card>
</CardGroup>

## Configuration

<Steps>
<Step title="Set Retention Period">
Choose how long to keep original data (default: 30 days)
</Step>

<Step title="Choose Data Types">
Select which types of information to redact
</Step>

<Step title="Configure Patterns">
Add custom patterns for your organization
</Step>
</Steps>

<Card title="Need Help?" icon="question" color="#0091FF">
Contact our security team at [[email protected]](mailto:[email protected]) for custom redaction rules or compliance questions.
</Card>

0 comments on commit 47fec77

Please sign in to comment.