Advanced Options

The secure method in the Spro SDK offers several advanced options to customize the masking process according to your specific requirements. These options allow you to fine-tune the masking behavior and achieve the desired level of data protection.

Mask Options

The secure method offers several customizable options to fit your requirements.

Parameters

1. prompt (str) (required)

   • The text to be masked.
   • Example: "My name is John Doe, and my email is john.doe@example.com"

2. mask_type (str) (optional)

   • Specifies the type of masking to apply.
   • Options:
     • char: Masks with characters (e.g., *).
     • label: Replaces entities with labels (e.g., [PERSON]).
     • enhanced: Masks entities in markdown format (e.g., PERSON).
   • Default: char

3. mask_char (str) (optional)

   • The character used for masking.
   • Default: *
   • Example: Setting mask_char to # will replace text with ####.

4. entities (list) (optional)

   • A list of specific entities to mask.
   • Default: All Entities
   • Example: ["PERSON", "EMAIL"] to mask only names and email addresses.

Example

from spro import Spro

# Initialize Spro
spro = Spro()

# Define the input
text = "My name is John Doe, and my email is john.doe@example.com."

# Apply masking with advanced options
result = spro.secure(
    prompt=text,
    mask_type="enhanced",
    entities=["PERSON", "EMAIL"]
)

print(result["redacted_text"])

Output

{
    "status": "success",
    "redacted_text": "My name is **[PERSON]**, and my email is **[EMAIL]**",
    "redacted_entities": [
        {
            "original": "John Doe",
            "redacted": "**[PERSON]**",
            "label": "PERSON",
            "start": 11,
            "end": 19
        },
        {
            "original": "john.doe@example.com",
            "redacted": "**[EMAIL]**",
            "label": "EMAIL",
            "start": 37,
            "end": 57
        }
    ],
    "metadata": {
        "mask_char": "*",
        "mask_type": "enhanced",
        "detected_entities": 2,
        "redacted_entities": 2,
        "confidence": 100.0,
        "processing_time": 0.007374
    },
    "credits": {
        "remaining_credits": 13.846095,
        "redacted_cost": 5e-05
    },
    "request_id": "ec27d1df-4ced-4270-995c-0e69c3d2c032"
}

List of Entities Supported

Spro supports the following entities for masking:

With these advanced options, you can tailor the masking process to suit your specific use case and ensure that sensitive information is protected effectively.