Skip to content
Briefcase AI

briefcase.sanitize

Terminal window
pip install briefcase-ai[sanitize]

Sanitizer

from briefcase.sanitize import Sanitizer


sanitizer = Sanitizer()


result = sanitizer.sanitize("Contact support@example.com or call 555-123-4567")
print(result.sanitized, result.redaction_count)
for redaction in result.redactions:
    print(redaction.pii_type, redaction.start_position, redaction.end_position)


print(sanitizer.contains_pii("support@example.com"))
print(sanitizer.analyze_pii("support@example.com"))


json_result = sanitizer.sanitize_json({"contact": "support@example.com"})
print(json_result.redaction_count)


sanitizer.add_pattern("ticket_id", r"\bTCK-\d{6}\b")
Sanitizer()
  .sanitize(text) -> SanitizationResult
  .sanitize_json(data) -> SanitizationJsonResult
  .contains_pii(text)
  .analyze_pii(text)
  .add_pattern(name, pattern)
  .remove_pattern(pattern_name)
  .set_enabled(enabled)

SanitizationResult

Attributes: sanitized, redactions, redaction_count, has_redactions, plus to_dict().

Redaction

Attributes: pii_type, start_position, end_position, original_length, plus to_dict().