doc-redaction-app

Execute initial PII redaction on PDFs and images via Gradio endpoints.

55|11|Updated Apr 25, 2024
One-click install
npx skills add https://github.com/seanpedrick-case/doc_redaction --skill doc-redaction-app
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-redaction-app
Source: https://github.com/seanpedrick-case/doc_redaction/tree/main/skills/doc-redaction-app
Command: npx skills add https://github.com/seanpedrick-case/doc_redaction --skill doc-redaction-app

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

The skill reduces manual effort needed to perform an initial PII redaction on PDFs/images and reliably download the resulting redacted artifacts for downstream review.

Core Features & Use Cases

It orchestrates calling the correct Gradio endpoints to run a first-pass redaction and fetch the server-generated output files. It supports both common document inputs and deployments that require careful parameter naming for OCR and PII entity selection. It is especially useful when you need to get initial redacted PDFs plus review artifacts onto the client quickly, then hand off to later review/apply passes or parallel page-level review.

Quick Start

Call the doc-redaction app endpoint from your client using gradio_client for /doc_redact, then download the returned server paths as downloadable files from the gradio_api/file URL.

Frequently Asked Questions about doc-redaction-app

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I perform initial PII redaction on PDFs and images using a Gradio API?

To perform initial PII redaction on PDFs and images using a Gradio API, you can orchestrate calls to the /doc_redact or /redact_document endpoints, applying first-pass workflows with selectable OCR methods and PII entity lists.

How do I download redacted PDF artifacts from a Gradio server to my client?

You download redacted PDF artifacts from a Gradio server using deterministic download handling that fetches generated outputs via URL-encoded server paths from the gradio_api/file URL, optionally including HF authorization headers.

What is the difference between the /doc_redact and /redact_document endpoints for document redaction?

The difference between /doc_redact and /redact_document endpoints lies in their endpoint-specific parameter requirements for OCR and PII entity selection, allowing flexible API orchestration for different document redaction deployments.

Can I choose specific OCR methods and PII entity lists for my document redaction workflow?

Yes, you can choose specific OCR methods and PII entity lists for your document redaction workflow, enabling customized first-pass PII redaction tailored to your deployment requirements and data types.

What should I do after downloading the initial redacted documents and review artifacts?

After downloading the initial redacted documents and review artifacts, you should hand off the deliverables to later review and apply passes or parallel page-level review workflows for downstream processing.

Why do my downloaded redaction artifacts fail to validate as non-empty deliverables?

Downloaded redaction artifacts fail to validate as non-empty deliverables when the Gradio API orchestration encounters endpoint parameter mismatches or incorrect server path URL-encoding during the redaction workflow execution.