PII detection

The PII (Personally Identifiable Information) detection guardrail protects your LLM applications from processing or exposing sensitive personal data such as email addresses, phone numbers, credit card numbers, and Social Security Numbers.

What you need

Python 3.10 or higher.
cx-guardrails installed. See Getting Started with Guardrails.
Environment variables configured: CX_GUARDRAILS_TOKEN, CX_GUARDRAILS_ENDPOINT.

Install the SDK

pip install cx-guardrails

Set up environment variables

export CX_GUARDRAILS_TOKEN="your-coralogix-guardrails-api-key"
export CX_GUARDRAILS_ENDPOINT="https://api.<domain>.coralogix.com/api/v1/guardrails/guard"
export CX_TOKEN="your-coralogix-send-your-data-key"
export CX_ENDPOINT="https://your-domain.coralogix.com"

# Optional: Application metadata for observability
export CX_APPLICATION_NAME="my-app"
export CX_SUBSYSTEM_NAME="my-subsystem"

Set up observability

from llm_tracekit import setup_export_to_coralogix
from llm_tracekit.openai import OpenAIInstrumentor

setup_export_to_coralogix(
    service_name="my-service",
    application_name="my-app",
    subsystem_name="my-subsystem",
    capture_content=True,
)
OpenAIInstrumentor().instrument()

Available PII categories

Category	Enum value	Description
Email Address	`PIICategory.EMAIL_ADDRESS`	Email addresses
Phone Number	`PIICategory.PHONE_NUMBER`	Phone numbers
Credit Card	`PIICategory.CREDIT_CARD`	Credit/debit card numbers
US SSN	`PIICategory.US_SSN`	US Social Security Numbers

Usage

import asyncio
from llm_tracekit import setup_export_to_coralogix
from cx_guardrails import Guardrails, PII, GuardrailsTriggered

setup_export_to_coralogix(
    service_name="my-service",
    application_name="my-app",
    subsystem_name="my-subsystem",
    capture_content=True,
)

async def main():
    guardrails = Guardrails()
    async with guardrails.guarded_session():
        try:
            await guardrails.guard_prompt(
                prompt="My email is [email protected]",
                guardrails=[PII()],
            )
            print("✓ No PII detected")
        except GuardrailsTriggered as e:
            print(f"✗ PII detected: {e}")

asyncio.run(main())

Configuration options

Specific categories

Detect only specific PII types:

await guardrails.guard_prompt(
    prompt=user_input,
    guardrails=[PII(categories=[PIICategory.EMAIL_ADDRESS, PIICategory.CREDIT_CARD])],
)

Custom threshold

Adjust detection sensitivity (0.0 to 1.0, default 0.7):

await guardrails.guard_prompt(
    prompt=user_input,
    guardrails=[PII(threshold=0.8)],
)

Threshold guidelines

Threshold	Use case
0.4–0.6	Low-risk applications
0.7 (default)	General applications
0.8–0.9	High-security applications

Learn more

Need help? Contact Support.

What's new? Find out here.

LLM? Read llms.txt.

Previous Prompt Injection Detection

Next Toxicity Detection