---
title: "Reference"
description: "Per-product documentation, configuration, and API details."
url: "https://philterd.ai/dev/reference/"
---

Each project’s reference documentation is published from its own repository.

## Core redaction

| Project | Documentation | Source |
| --- | --- | --- |
| Philter | [docs](https://philterd.github.io/philter/) | [philter](https://github.com/philterd/philter) |
| Phileas (Java) | [docs](https://philterd.github.io/phileas/) | [phileas](https://github.com/philterd/phileas) |
| Phileas (Python) | [docs](https://philterd.github.io/phileas-python/) | [phileas-python](https://github.com/philterd/phileas-python) |
| Phileas (.NET) | [docs](https://philterd.github.io/phileas-dotnet/) | [phileas-dotnet](https://github.com/philterd/phileas-dotnet) |

## AI and LLM guardrails

| Project | Documentation | Source |
| --- | --- | --- |
| Philter AI Proxy | [docs](https://philterd.github.io/philter-ai-proxy/) | [philter-ai-proxy](https://github.com/philterd/philter-ai-proxy) |
| Philter MCP | [docs](https://philterd.github.io/philter-mcp/) | [philter-mcp](https://github.com/philterd/philter-mcp) |
| PhEye | [docs](https://philterd.github.io/ph-eye/) | [ph-eye](https://github.com/philterd/ph-eye) |
| PII Lenses | [catalog](https://philterd.ai/ph-eye/#lenses) | [pheye-pii-lenses](https://github.com/philterd/pheye-pii-lenses) |

## Discovery, review, and operations

| Project | Documentation | Source |
| --- | --- | --- |
| Phinder | [docs](https://philterd.github.io/phinder/) | [phinder](https://github.com/philterd/phinder) |
| Phield | [docs](https://philterd.github.io/phield/) | [phield](https://github.com/philterd/phield) |
| Philter Workspace | [docs](https://philterd.github.io/philter-workspace/) | [philter-workspace](https://github.com/philterd/philter-workspace) |
| Philter Scope | [docs](https://philterd.github.io/philter-scope/) | [philterscope](https://github.com/philterd/philterscope) |
| Philter Diffuse | [docs](https://philterd.github.io/philter-diffuse/) | [philter-diffuse](https://github.com/philterd/philter-diffuse) |

## Policies

| Project | Documentation | Source |
| --- | --- | --- |
| Redaction Policy Editor | [policies.philterd.ai](https://policies.philterd.ai/) | [redaction-policy-editor](https://github.com/philterd/philterd-redaction-policy-editor) |
| PhiSQL | [docs](https://philterd.github.io/phisql/) | [phisql](https://github.com/philterd/phisql) |

## Integrations and tooling

| Project | Purpose | Source |
| --- | --- | --- |
| Java SDK | Typed client for the Philter API | [philter-sdk-java](https://github.com/philterd/philter-sdk-java) |
| CLI | Redact from the command line and in scripts | [philter-cli](https://github.com/philterd/philter-cli) |
| Trino connector | Redact columns at query time | [phileas-trino-connector](https://github.com/philterd/phileas-trino-connector) |
| Redaction policies | A browsable [policy library](https://philterd.ai/policies/) to copy and adapt | [pii-redaction-policies](https://github.com/philterd/pii-redaction-policies) |

## Guides

### AI privacy

- [PII in Vector Embeddings: A Defense Guide](https://philterd.ai/guides/pii-in-vector-embeddings-a-defense-guide/)
- [Prompt Engineering for Privacy: Practical Patterns for Not Leaking PII](https://philterd.ai/guides/prompt-engineering-for-privacy/)

### Compliance

- [Deploying Philter in a HIPAA Environment](https://philterd.ai/guides/deploying-philter-in-a-hipaa-environment/)
- [PIPEDA and Law 25: PII Redaction for Canadian Privacy Compliance](https://philterd.ai/guides/pipeda-and-law-25-pii-redaction-canadian-privacy-compliance/)
- [SOC 2 and HIPAA Control Mapping for Philter AI Proxy](https://philterd.ai/guides/soc-2-and-hipaa-control-mapping-for-philter-ai-proxy/)
- [Why Philterd Doesn't Need to Sign a BAA](https://philterd.ai/guides/why-philterd-doesnt-sign-a-baa/)

### Detection

- [Find the PII in a Folder of Files Before You Share or Migrate It](https://philterd.ai/guides/find-pii-in-a-folder-with-phinder/)
- [Measure Philter's Redaction Accuracy on Your Own Documents](https://philterd.ai/guides/measure-redaction-accuracy-with-philter-scope/)
- [Span Disambiguation: What It Does and When to Enable It](https://philterd.ai/guides/span-disambiguation/)
- [Using an LLM or Pattern-based Rules for PII/PHI Redaction](https://philterd.ai/guides/using-an-llm-or-pattern-based-rules-for-pii-phi-redaction/)

### Encryption

- [What is format-preserving encryption?](https://philterd.ai/guides/what-is-format-preserving-encryption/)

### File formats

- [The Hidden Difficulties of Redacting PDF Documents](https://philterd.ai/guides/the-hidden-difficulties-of-redacting-pdf-documents/)

### Fundamentals

- [PII vs PHI vs NPPI: An Engineer's Guide](https://philterd.ai/guides/pii-vs-phi-vs-nppi-an-engineers-guide/)
- [What is Data Redaction? A Practical Guide](https://philterd.ai/guides/what-is-data-redaction-a-practical-guide/)
- [What is NPPI? Nonpublic Personal Information, Defined](https://philterd.ai/guides/what-is-nppi-nonpublic-personal-information/)
- [What is PII? A Practical Guide for Engineers and Compliance Teams](https://philterd.ai/guides/what-is-pii-a-practical-guide-for-engineers-and-compliance-teams/)

### Integrations

- [Apache NiFi and Philter](https://philterd.ai/guides/apache-nifi-and-philter/)
- [Redacting PII in Apache Kafka](https://philterd.ai/guides/redacting-pii-in-apache-kafka/)
- [Redacting PII in Logs with log4j2 and logback](https://philterd.ai/guides/redacting-pii-in-logs-with-log4j2-and-logback/)
- [Redacting PII in Spark and Databricks](https://philterd.ai/guides/redacting-pii-in-spark-and-databricks/)
- [Redacting PII in Trino with the Phileas Connector](https://philterd.ai/guides/redacting-pii-in-trino-with-the-phileas-connector/)
- [Redacting Text in Amazon Kinesis Data Firehose](https://philterd.ai/guides/redacting-text-in-amazon-kinesis-data-firehose/)
- [Using Philter with Microsoft Power Automate](https://philterd.ai/guides/using-philter-with-microsoft-power-automate/)

### On-device

- [Philter Desktop Blocked by Smart App Control or App Control for Business](https://philterd.ai/guides/philter-desktop-blocked-by-smart-app-control/)
- [Philter Desktop Quick Start, from Install to First Redacted Document](https://philterd.ai/guides/philter-desktop-quick-start/)
- [Redact a Folder of Documents Automatically on Windows](https://philterd.ai/guides/redact-a-folder-of-documents-automatically/)
- [Running Philter Desktop on an Apple Silicon Mac with Parallels](https://philterd.ai/guides/running-philter-desktop-on-a-mac-with-parallels/)

### Operations

- [Alerting on PII Spikes with Phield and Slack](https://philterd.ai/guides/alert-on-pii-spikes-with-phield/)
- [Deploying Philter in AWS via a CloudFormation Template](https://philterd.ai/guides/deploying-philter-with-aws-cloudformation/)
- [How to Use a Signed SSL Certificate with Philter](https://philterd.ai/guides/using-a-signed-ssl-certificate-with-philter/)
- [How to Use an Apache Reverse Proxy with Philter](https://philterd.ai/guides/using-an-apache-reverse-proxy-with-philter/)
- [Monitoring Philter in AWS](https://philterd.ai/guides/monitoring-philter-in-aws/)
- [Referential Integrity with Valkey](https://philterd.ai/guides/referential-integrity-with-valkey/)
- [Review Redactions Before Release: Thresholds, Sampling, and Sign-off in Philter Workspace](https://philterd.ai/guides/philter-workspace-review-thresholds-and-sign-off/)

### Policy authoring

- [Authoring Redaction Policies with PhiSQL](https://philterd.ai/guides/authoring-redaction-policies-with-phisql/)
- [Build and test a redaction policy without writing JSON](https://philterd.ai/guides/build-and-test-a-redaction-policy-without-json/)
- [Redacting National and Financial ID Numbers](https://philterd.ai/guides/redacting-national-and-financial-id-numbers/)
- [The Phileas redaction policy schema](https://philterd.ai/guides/redaction-policy-schema/)
- [Writing your first redaction policy](https://philterd.ai/guides/writing-your-first-redaction-policy/)

### Privacy engineering

- [Modern Privacy Techniques, and When to Use Each](https://philterd.ai/guides/modern-privacy-techniques-and-when-to-use-each/)
- [Publish PII counts with differential privacy instead of exact numbers](https://philterd.ai/guides/publishing-pii-counts-with-differential-privacy/)

### Self-hosting

- [Self-Hosted Philter Reference Architectures](https://philterd.ai/guides/self-hosted-philter-reference-architectures/)
- [Self-Hosted PII Detection on Your Own Hardware](https://philterd.ai/guides/self-hosted-pii-detection-on-your-own-hardware/)

## How the products fit together

The [architecture overview](https://philterd.ai/architecture/) shows how Philter, Phileas, PhEye, the AI Proxy, and the rest connect, along with deployment topologies. The [integrations list](https://philterd.ai/integrations/) covers the platforms, services, and frameworks the toolkit works with.

## API clients

`philter-sdk-java` is the maintained SDK. For every other language, generate a client from the [OpenAPI specification](https://raw.githubusercontent.com/philterd/philter/refs/heads/main/docs/docs/api_and_sdks/openapi.json).
