PII Detection

import { detectPII, redactPII } from '@directive-run/ai';

// Step 1: Scan text for PII matches
const result = await detectPII('My SSN is 123-45-6789', {
  types: ['ssn', 'email'],
  minConfidence: 0.7,
});

console.log(result.detected);  // true
console.log(result.items);     // [{ type: 'ssn', value: '123-45-6789', confidence: 0.95, ... }]

// Step 2: Replace detected items with type-safe placeholders
const redacted = redactPII(
  'My SSN is 123-45-6789',
  result.items,
  'typed'
);
console.log(redacted); // 'My SSN is [SSN]'

import { createEnhancedPIIGuardrail } from '@directive-run/ai';

const guardrail = createEnhancedPIIGuardrail({
  // What to look for
  types: ['ssn', 'credit_card', 'email', 'phone'],
  detector: 'regex',         // 'regex' or a custom PIIDetector

  // How to handle matches
  redact: true,              // redact instead of blocking
  redactionStyle: 'typed',   // 'placeholder' | 'typed' | 'masked' | 'hashed'

  // Tuning and thresholds
  minConfidence: 0.7,        // confidence threshold (0-1)
  allowlist: ['test@example.com'],  // values to skip
  minItemsToBlock: 1,        // minimum PII items to trigger
  detectorTimeout: 5000,     // timeout for custom detectors (ms)

  // Called whenever PII is found, useful for metrics
  onDetected: (items) => {
    console.log(`Found ${items.length} PII items`);
  },
});

// Wrap an external PII detection service as a Directive detector
const customDetector = {
  name: 'presidio',
  detect: async (text, types) => {
    // Send text to your Presidio (or similar) endpoint
    const response = await fetch('https://presidio.internal/analyze', {
      method: 'POST',
      body: JSON.stringify({ text, entities: types }),
    });

    // Map the external format to Directive's expected shape
    const results = await response.json();

    return results.map(r => ({
      type: r.entity_type,
      value: r.text,
      position: { start: r.start, end: r.end },
      confidence: r.score,
    }));
  },
};

// Plug the custom detector into the guardrail
const guardrail = createEnhancedPIIGuardrail({
  detector: customDetector,
  detectorTimeout: 5000, // timeout prevents DoS from slow services
});

import { createPIIGuardrail } from '@directive-run/ai';

// Lightweight alternative using raw regex patterns (no detection pipeline)
const guardrail = createPIIGuardrail({
  patterns: [/\b\d{3}-\d{2}-\d{4}\b/, /\b\d{16}\b/], // SSN and 16-digit card formats
  redact: true,
  redactReplacement: '[REDACTED]',
});

import { createAgentOrchestrator, createOpenAIRunner } from '@directive-run/ai';

const runner = createOpenAIRunner({ apiKey: process.env.OPENAI_API_KEY! });

const orchestrator = createAgentOrchestrator({
  runner,
  guardrails: {
    // Redact PII from user messages before the agent sees them
    input: [{ name: 'pii', fn: createEnhancedPIIGuardrail({
      types: ['ssn', 'credit_card', 'email'],
      redact: true,
      redactionStyle: 'typed',
    }) }],

    // Catch any PII the agent leaks in its response
    output: [{ name: 'output-pii', fn: createOutputPIIGuardrail({
      types: ['ssn', 'credit_card'],
      redact: true,
    }) }],
  },
});