Anonymize Scanner

The Anonymize Scanner acts as your digital guardian, ensuring your user prompts remain confidential and free from sensitive data exposure.

What is PII?

PII, an acronym for Personally Identifiable Information, is the cornerstone of an individual's digital identity. Leaks or mishandling of PII can unleash a storm of problems, from privacy breaches to identity theft. Global regulations, including GDPR and HIPAA, underscore the significance of PII by laying out strict measures for its protection. Furthermore, any unintentional dispatch of PII to LLMs can proliferate this data across various storage points, thus raising the stakes.

Attack scenario

Some model providers may train their models on your requests, which can be a privacy concern. Use the scanner to ensure PII is not leaked to the model provider.

PII entities

• Credit Cards: Formats mentioned in Wikipedia.
  • 4111111111111111
  • 378282246310005 (American Express)
  • 30569309025904 (Diners Club)
• Person: A full person name, which can include first names, middle names or initials, and last names.
  • John Doe
• PHONE_NUMBER:
  • 5555551234
• URL: A URL (Uniform Resource Locator), unique identifier used to locate a resource on the Internet.
  • https://protectai.com/
• E-mail Addresses: Standard email formats.
  • john.doe@protectai.com
  • john.doe[AT]protectai[DOT]com
  • john.doe[AT]protectai.com
  • john.doe@protectai[DOT]com
• IPs: An Internet Protocol (IP) address (either IPv4 or IPv6).
  • 192.168.1.1 (IPv4)
  • 2001:db8:3333:4444:5555:6666:7777:8888 (IPv6)
• UUID:
  • 550e8400-e29b-41d4-a716-446655440000
• US Social Security Number (SSN):
  • 111-22-3333
• Crypto wallet number: Currently only Bitcoin address is supported.
  • 1Lbcfr7sAHTD9CgdQo3HTMTkV8LK4ZnX71
• IBAN Code: The International Bank Account Number (IBAN) is an internationally agreed system of identifying bank accounts across national borders to facilitate the communication and processing of cross border transactions with a reduced risk of transcription errors.
  • DE89370400440532013000

Features

• Integration with Presidio Analyzer: Leverages the Presidio Analyzer library, crafted with spaCy, flair and transformers libraries, for precise detection of private data.
• Enhanced Detection: Beyond Presidio Analyzer's capabilities, the scanner recognizes specific patterns like Email, US SSN, UUID, and more.
• Entities support:
  • Peek at our default entities.
  • View the Presidio's supported entities.
  • And, we've got custom regex patterns too!
• Tailored recognizers:
  • Balance speed vs. accuracy of the recognizers.
  • Top Pick: dslim/bert-base-NER
  • Alternative with more parameters: dslim/bert-large-NER.
  • Chinese recognizer: gyr66/bert-base-chinese-finetuned-ner.
  • Good models from AI4Privacy: Isotonic/distilbert_finetuned_ai4privacy_v2 and Isotonic/deberta-v3-base_finetuned_ai4privacy_v2.
• Support of multiple languages: The scanner can detect PII in English and Chinese.

Get started

Initialize the Vault: The Vault archives data that's been redacted.

from llm_guard.vault import Vault

vault = Vault()

Configure the Anonymize Scanner:

from llm_guard.input_scanners import Anonymize
from llm_guard.input_scanners.anonymize_helpers import BERT_LARGE_NER_CONF

scanner = Anonymize(vault, preamble="Insert before prompt", allowed_names=["John Doe"], hidden_names=["Test LLC"],
                    recognizer_conf=BERT_LARGE_NER_CONF, language="en")
sanitized_prompt, is_valid, risk_score = scanner.scan(prompt)

• preamble: Directs the LLM to bypass specific content.
• hidden_names: Transforms specified names to formats like [REDACTED_CUSTOM_1].
• entity_types: Opt for particular information types to redact.
• regex_pattern_groups_path: Input a path for personalized patterns.
• use_faker: Substitutes eligible entities with fabricated data.
• recognizer_conf: Configures recognizer for the PII data detection. There are many PII detection models available for various use-cases.
• threshold: Sets the acceptance threshold (Default: 0).
• language: Language of the anonymize detect. Default is "en".

To revert to the initial data, utilize the Deanonymize scanner.

Optimization Strategies

Read more

Benchmarks

Test setup:

• Platform: Amazon Linux 2
• Python Version: 3.11.6
• Input Length: 317
• Test Times: 5

Run the following script:

python benchmarks/run.py input Anonymize

Results: