Skip to content

PII

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

CategoryEnum valueDescription
Email AddressPIICategory.EMAIL_ADDRESSEmail addresses
Phone NumberPIICategory.PHONE_NUMBERPhone numbers
Credit CardPIICategory.CREDIT_CARDCredit/debit card numbers
US SSNPIICategory.US_SSNUS 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 john.doe@example.com",
                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):

# Lower threshold — more sensitive
await guardrails.guard_prompt(
    prompt=user_input,
    guardrails=[PII(threshold=0.5)],
)

# Higher threshold — less sensitive
await guardrails.guard_prompt(
    prompt=user_input,
    guardrails=[PII(threshold=0.9)],
)

Threshold: Defines the value from which a guardrail action is triggered. When the threshold is met or exceeded, the guardrail action is executed, returned through the API, and the system marks the event as an issue.