pii-scanner 0.1.3

A library for scanning Personally Identifiable Information (PII).

PII Scanner

A library for scanning Personally Identifiable Information (PII) from text.

Installation

pip install pii_scanner

Usage

from pii_scanner.main import PIIScanner

# Create an instance of the scanner
pii_scanner = PIIScanner()

# Sample data containing PII
data = [
    "Ankit Gupta",
    "Lucknow",
    "[phone]",
    "Indian",
    "Sofia Rossi",
    "Rome",
    "[phone]",
    "Italian"
]

# Scan the structured data
results = pii_scanner.scan_structured_data(data, chunk_size=10, sample_size=1.0)

# Print the results
print(results)

Output

[
    {
        "text": "Ankit Gupta",
        "entity_detected": [
            {"type": "PERSON", "start": 0, "end": 11, "score": 0.85}
        ]
    },
    {
        "text": "Rome",
        "entity_detected": [
            {"type": "LOCATION", "start": 0, "end": 4, "score": 0.85}
        ]
    },
    {
        "text": "[phone]",
        "entity_detected": [
            {"type": "PHONE_NUMBER", "start": 0, "end": 13, "score": 0.85}
        ]
    },
    {
        "text": "Sofia Rossi",
        "entity_detected": [
            {"type": "PERSON", "start": 0, "end": 11, "score": 0.85}
        ]
    },
    {
        "text": "Indian",
        "entity_detected": [
            {"type": "NATIONALITY", "start": 0, "end": 6, "score": 0.9}
        ]
    }
]