// PYTHON LIBRARY

pii_report()

`df.omna.pii_report()` audits every string column in your DataFrame for personal information and reports what it found — types, hit rates, and confidence — without modifying a single value. Run it before you redact, before you share, and before any data ships.

1 min readAudit before you redact

Signature

python

df.omna.pii_report()

Scans every string column. Returns the detected PII types, the hit rate per column, and confidence scores. Nothing is modified — this is a read-only audit.

Example

python

import polars as pl
import omna

df = pl.read_csv("documents.csv")
df.omna.pii_report()

code

 column    detected types                                    hit rate   flagged
 entities  CREDIT_CARD, EMAIL_ADDRESS, PERSON, PHONE_NUMBER   85.4%    ✓ YES
 text      CREDIT_CARD, EMAIL_ADDRESS, PERSON, PHONE_NUMBER   78.1%    ✓ YES

Detection runs on Omna's own six-layer Rust engine — fully local, no heavy Python ML dependencies, no network call.

Tip: pii_report() tells you where the risk is; [mask_pii()](/docs/mask-pii) removes it. Audit first, then redact.

What's next

DocsRedact PII — mask_pii() →DocsPII types Omna detects →