Private AI Developer Documentation

This is an end-user documentation for Private AI’s container-based de-identification system. The Private AI solution is provided as a Docker image and communicates via POST requests.

To be able to run the container, the following are required,

1. Docker Image

2. Container Orchestration Platform

3. API key

For commercial use or demonstration purposes, the API key has to be obtained from Private AI (info@private-ai.com).

Contents:

• Introduction
  • What is PII?
  • Why Redaction?
  • Redaction in Machine Learning
  • Why Synthetic PII?
  • Evaluation Toolkit
• Text Web Demo
• Quickstart Guide
  • Prerequisites
  • Starting up DEID container
  • Sample commands
• Installation
  • System Requirements
  • Prerequisites
  • Docker Image Setup Instructions
  • Run Instructions
  • Environment Variables
  • Authentication and External Communications
• Deployment Considerations
  • Running a single container
  • Running in AWS ECS
  • Running on Kubernetes
• API Reference
  • Processing Text
  • Sample Commands
  • Performance Tips
• Supported Entity Types
  • PII
  • PHI
  • PCI
• Supported Languages