Workflows

from pii_redactor_sdk import PiiRedactor
 
client = PiiRedactor(api_key="pk_live_...")
 
result = client.redact.text(
    text="Contact Jane Doe at jane.doe@acme.com or 555-0123",
)
 
print(result.redacted_text)
# "Contact [PERSON] at [EMAIL_ADDRESS] or [PHONE_NUMBER]"
 
for finding in result.findings:
    print(f"{finding.entity_type}: {finding.text} (score: {finding.score})")

import { PiiRedactor } from '@pii-redactor/sdk';
 
const client = new PiiRedactor({ apiKey: 'pk_live_...' });
 
const result = await client.redact.text({
  text: 'Contact Jane Doe at jane.doe@acme.com or 555-0123',
});
 
console.log(result.redactedText);
// "Contact [PERSON] at [EMAIL_ADDRESS] or [PHONE_NUMBER]"
 
for (const finding of result.findings) {
  console.log(`${finding.entityType}: ${finding.text} (score: ${finding.score})`);
}

import time
from pii_redactor_sdk import PiiRedactor
 
client = PiiRedactor(api_key="pk_live_...")
 
# Submit a file
job = client.redact.file(file_path="/path/to/document.pdf")
print(f"Job submitted: {job.job_id}")
 
# Poll for completion
while True:
    status = client.jobs.get(job.job_id)
    print(f"Status: {status.status}")
 
    if status.status == "completed":
        print(f"Redacted file: {status.output_uri}")
        break
    elif status.status in ("failed", "error"):
        print(f"Job failed: {status.error}")
        break
 
    time.sleep(2)

import { PiiRedactor } from '@pii-redactor/sdk';
 
const client = new PiiRedactor({ apiKey: 'pk_live_...' });
 
// Submit a file
const job = await client.redact.file({ filePath: '/path/to/document.pdf' });
console.log(`Job submitted: ${job.jobId}`);
 
// Poll for completion
while (true) {
  const status = await client.jobs.get(job.jobId);
  console.log(`Status: ${status.status}`);
 
  if (status.status === 'completed') {
    console.log(`Redacted file: ${status.outputUri}`);
    break;
  } else if (status.status === 'failed' || status.status === 'error') {
    console.log(`Job failed: ${status.error}`);
    break;
  }
 
  await new Promise((r) => setTimeout(r, 2000));
}

from pii_redactor_sdk import PiiRedactor
 
client = PiiRedactor(api_key="pk_live_...")
 
batch = client.batch.create(
    uris=[
        "s3://my-bucket/reports/q1-report.pdf",
        "s3://my-bucket/reports/q2-report.pdf",
        "s3://my-bucket/recordings/meeting-2024-03.mp4",
    ],
    output_prefix="s3://my-bucket/redacted/",
)
 
print(f"Batch ID: {batch.batch_id}")
print(f"Jobs created: {batch.total_jobs}")
 
# Check batch progress
status = client.batch.get(batch.batch_id)
print(f"Completed: {status.completed_jobs}/{status.total_jobs}")

import { PiiRedactor } from '@pii-redactor/sdk';
 
const client = new PiiRedactor({ apiKey: 'pk_live_...' });
 
const batch = await client.batch.create({
  uris: [
    's3://my-bucket/reports/q1-report.pdf',
    's3://my-bucket/reports/q2-report.pdf',
    's3://my-bucket/recordings/meeting-2024-03.mp4',
  ],
  outputPrefix: 's3://my-bucket/redacted/',
});
 
console.log(`Batch ID: ${batch.batchId}`);
console.log(`Jobs created: ${batch.totalJobs}`);
 
// Check batch progress
const status = await client.batch.get(batch.batchId);
console.log(`Completed: ${status.completedJobs}/${status.totalJobs}`);

from pii_redactor_sdk import PiiRedactor
 
client = PiiRedactor(api_key="pk_live_...")
 
policy = client.policies.create(
    name="customer-support",
    description="Redact PII in customer support transcripts",
    entity_actions={
        "PERSON": "pseudonymize",
        "EMAIL_ADDRESS": "redact",
        "PHONE_NUMBER": "mask",
        "CREDIT_CARD": "redact",
        "LOCATION": "allow",
    },
)
 
print(f"Policy ID: {policy.policy_id}")

import { PiiRedactor } from '@pii-redactor/sdk';
 
const client = new PiiRedactor({ apiKey: 'pk_live_...' });
 
const policy = await client.policies.create({
  name: 'customer-support',
  description: 'Redact PII in customer support transcripts',
  entityActions: {
    PERSON: 'pseudonymize',
    EMAIL_ADDRESS: 'redact',
    PHONE_NUMBER: 'mask',
    CREDIT_CARD: 'redact',
    LOCATION: 'allow',
  },
});
 
console.log(`Policy ID: ${policy.policyId}`);

result = client.redact.text(
    text="Jane Doe called from 555-0123 about order #789",
    policy_id=policy.policy_id,
)
 
print(result.redacted_text)
# "Alice Johnson called from ***-**** about order #789"

const result = await client.redact.text({
  text: 'Jane Doe called from 555-0123 about order #789',
  policyId: policy.policyId,
});
 
console.log(result.redactedText);
// "Alice Johnson called from ***-**** about order #789"

from pii_redactor_sdk import PiiRedactor
 
client = PiiRedactor(api_key="pk_live_...")
 
# Spanish text
result = client.redact.text(
    text="El paciente Juan Garcia, DNI 12345678A, vive en Madrid",
    language="es",
)
 
print(result.redacted_text)
# "El paciente [PERSON], DNI [US_SSN], vive en [LOCATION]"

import { PiiRedactor } from '@pii-redactor/sdk';
 
const client = new PiiRedactor({ apiKey: 'pk_live_...' });
 
// Spanish text
const result = await client.redact.text({
  text: 'El paciente Juan Garcia, DNI 12345678A, vive en Madrid',
  language: 'es',
});
 
console.log(result.redactedText);
// "El paciente [PERSON], DNI [US_SSN], vive en [LOCATION]"