Para programadores

Integre a anonimização na sua stack

O promptShield está disponível como ferramenta de CLI para pipelines locais e como API Docker auto-alojada para a sua infraestrutura. Os seus dados nunca tocam nos nossos servidores.

CLI e SDK de Python

Instale a partir do PyPI e anonimize documentos a partir do seu terminal ou dos seus scripts de Python. Integre em pipelines de CI/CD, fluxos de trabalho de processamento em lote ou aplicações personalizadas.

bash

pip install promptshield-app

API Docker auto-alojada

Implemente toda a API do promptShield na sua própria infraestrutura com um único docker compose up. Endpoints RESTful para ingestão, deteção, anonimização e descodificação.

bash

docker pull promptshield/promptshield-api:latest
docker compose up -d

Início rápido

bash

# Detetar dados pessoais num documento
promptshield detect report.pdf -o report-pii.json

# Anonimizar e exportar
promptshield anonymize report.pdf -o report-safe.pdf

# Restaurar os dados originais
promptshield detokenize ai-output.pdf -o restored.pdf

# Iniciar o servidor de API local
promptshield serve --host 0.0.0.0 --port 8000

Opções de deteção

Todos os parâmetros que a aplicação de ambiente de trabalho expõe estão também disponíveis na CLI. Combine flags ou guarde-as como uma predefinição por idioma em demo/setup.json.

bash

# Definir o idioma de deteção + o pacote de padrões por país
promptshield detect contract.pdf --language en --countries CA -o pii.json

# Substituir o backend de entidades (ID de modelo HuggingFace)
promptshield detect contract.pdf --ner-backend Davlan/bert-base-multilingual-cased-ner-hrl

# Desativar camadas + apertar o agrupamento + filtrar as entidades apenas para PERSON/ORG
promptshield detect contract.pdf --no-llm --fuzziness 0.5 --ner-types PERSON,ORG

# Adicionar expressões literais que devem ser assinaladas como dados pessoais (repetível)
promptshield detect contract.pdf -e SA-2026-0847 -e "84-329-1057"

# Carregar todas as definições a partir de demo/setup.json por idioma e depois empacotar para revisão
promptshield detect contract.pdf --preset en --export-review -o contract.psreview

--language LANG

Código ISO 639-1: en, fr, de, es, it, nl, pt. Determina o modelo de entidades + os pacotes de idioma dos padrões.

--countries CODES

Códigos de país ISO separados por vírgulas. CA ativa SIN/RAMQ/códigos postais para todas as províncias.

--ner-backend MODEL

spacy (leve) ou qualquer ID de modelo HuggingFace. Instale os backends BERT/GLiNER via promptshield models install.

--no-regex / --no-ner / --no-llm

Ignore camadas individuais quando já sabe de quais precisa.

--fuzziness 0.0-1.0

Agressividade do agrupamento de regiões. 0 = estrito, 1 = permissivo.

--regex-types / --ner-types

Restringir cada camada a tipos específicos de dados pessoais (PERSON, ORG, EMAIL, …).

-e / --expression PATTERN

Texto literal a assinalar como dados pessoais CUSTOM. Use o prefixo re: para uma expressão regular. Repetível.

--preset LOCALE

Carregar todos os parâmetros de deteção a partir de demo/setup.json[locale]. As flags da CLI continuam a ter prioridade.

--export-review -o FILE.psreview

Empacotar o documento de origem + as regiões detetadas num ZIP .psreview — perfeito para fixtures ou para passagem de revisão.

Interface de linha de comandos

Processe documentos a partir do seu terminal com um único comando. Detete, anonimize e descodifique, tudo offline.

API Docker auto-alojada

Implemente na sua infraestrutura com o docker compose. API REST completa, com documentação Swagger interativa em /docs.

SDK de Python

Importe o motor principal diretamente nos seus scripts de Python. Suporte assíncrono completo, anotações de tipo e modelos Pydantic.

Arquitetura de confiança zero

Todo o processamento acontece dentro do contentor ou no seu dispositivo. Nenhum dado é enviado para o exterior — nem sequer para nós.

Todos os formatos de documento

PDF, DOCX, XLSX, PPTX, imagens (PNG, JPEG, TIFF, BMP, WebP). OCR para documentos digitalizados incluído.

Processamento em lote

Processe centenas de documentos de forma programática. Correspondências de códigos consistentes em conjuntos de documentos ligados.

Ver a documentação da API Gerir chaves de API

A CLI e a API auto-alojada estão disponíveis no plano Pro e superiores.

Google Cloud

Infrastructure

Sentry

Error Monitoring

Stripe

Billing

Cloudflare

Edge Security

Tauri 2

Desktop Shell

React 19

Frontend

Next.js 14

Website

Python

Runtime

Rust

Core Engine

Início rápido

bash

# Detetar dados pessoais num documento
promptshield detect report.pdf -o report-pii.json

# Anonimizar e exportar
promptshield anonymize report.pdf -o report-safe.pdf

# Restaurar os dados originais
promptshield detokenize ai-output.pdf -o restored.pdf

# Iniciar o servidor de API local
promptshield serve --host 0.0.0.0 --port 8000

Opções de deteção

Todos os parâmetros que a aplicação de ambiente de trabalho expõe estão também disponíveis na CLI. Combine flags ou guarde-as como uma predefinição por idioma em demo/setup.json.

bash

# Definir o idioma de deteção + o pacote de padrões por país
promptshield detect contract.pdf --language en --countries CA -o pii.json

# Substituir o backend de entidades (ID de modelo HuggingFace)
promptshield detect contract.pdf --ner-backend Davlan/bert-base-multilingual-cased-ner-hrl

# Desativar camadas + apertar o agrupamento + filtrar as entidades apenas para PERSON/ORG
promptshield detect contract.pdf --no-llm --fuzziness 0.5 --ner-types PERSON,ORG

# Adicionar expressões literais que devem ser assinaladas como dados pessoais (repetível)
promptshield detect contract.pdf -e SA-2026-0847 -e "84-329-1057"

# Carregar todas as definições a partir de demo/setup.json por idioma e depois empacotar para revisão
promptshield detect contract.pdf --preset en --export-review -o contract.psreview

--language LANG

Código ISO 639-1: en, fr, de, es, it, nl, pt. Determina o modelo de entidades + os pacotes de idioma dos padrões.

--countries CODES

Códigos de país ISO separados por vírgulas. CA ativa SIN/RAMQ/códigos postais para todas as províncias.

--ner-backend MODEL

spacy (leve) ou qualquer ID de modelo HuggingFace. Instale os backends BERT/GLiNER via promptshield models install.

--no-regex / --no-ner / --no-llm

Ignore camadas individuais quando já sabe de quais precisa.

--fuzziness 0.0-1.0

Agressividade do agrupamento de regiões. 0 = estrito, 1 = permissivo.

--regex-types / --ner-types

Restringir cada camada a tipos específicos de dados pessoais (PERSON, ORG, EMAIL, …).

-e / --expression PATTERN

Texto literal a assinalar como dados pessoais CUSTOM. Use o prefixo re: para uma expressão regular. Repetível.

--preset LOCALE

Carregar todos os parâmetros de deteção a partir de demo/setup.json[locale]. As flags da CLI continuam a ter prioridade.

--export-review -o FILE.psreview

Empacotar o documento de origem + as regiões detetadas num ZIP .psreview — perfeito para fixtures ou para passagem de revisão.