Redact
Redact or anonymize sensitive information from a document while preserving the original layout.
Coming soon
This Operation is on our roadmap and not available yet. Contact us for more information.
The Redact Operation detects and anonymizes personally identifiable information (PII) in a document, returning a clean copy with the original layout preserved. The engine classifies sensitive spans into a fixed set of PII categories and replaces each one with a consistent, labeled placeholder — so the same person, email, or account appearing multiple times always maps to the same token. This keeps the document readable and internally consistent while removing the underlying private data.
- Category-Based Detection: PII is detected and grouped into well-defined categories (names, addresses, emails, account numbers, secrets, and more) rather than relying on brittle pattern matching.
- Consistent Placeholders: Each detected entity is replaced with a labeled placeholder such as
[private_person_1]. Recurrences of the same entity reuse the same token, preserving relationships within the document. - High-Fidelity Output: The system returns a downloadable, redacted version of the original file. Supported formats include PDF and DOCX. The resulting file masks sensitive spans while preserving the original layout.
🏗️ Configuration
It will be the redaction Operation of a Job, running on the language model of the Job's Perimeter. By default the engine redacts a standard set of PII categories — no configuration is required. You can narrow or override that set with the categories field, and add natural language guidance with instructions.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
categories | string[] | No | PII categories to redact. Defaults to all categories below when omitted. |
instructions | string | No | Natural language guidance to refine detection (e.g., keep a specific company name unredacted). |
Default PII Categories
When categories is omitted, the engine detects and redacts all of the following:
| Category | Description |
|---|---|
private_person | Names of individuals. |
private_address | Physical or mailing addresses. |
private_email | Email addresses. |
private_phone | Phone and fax numbers. |
private_url | Personal or identifying URLs and links. |
private_date | Dates tied to an individual (e.g. birth dates, appointment dates). |
account_number | Bank, card, or other account identifiers. |
secret | Credentials such as API keys, passwords, and access tokens. |
Pass an explicit categories array to redact only a subset — for example
["private_person", "account_number", "secret"] to leave contact details intact.