開発者向け

既存のシステムに匿名化を組み込む

promptShieldは、ローカルのパイプラインで使うCLIツールと、自社のインフラで運用するセルフホスト型のDocker APIとして提供しています。データが当社のサーバーに届くことはありません。

CLIとPython SDK

ターミナルやPythonスクリプトから文書を匿名化でき、CI/CDパイプライン、バッチ処理、独自のアプリケーションにも組み込めます。パッケージはまだPyPIで公開していません。当面は、Dockerイメージを使うか、ソースコードをチェックアウトしたうえで下記のコマンドでインストールしてください。

bash
pip install -e .

セルフホスト型Docker API

docker compose upコマンド1つで、promptShieldのAPI一式を自社のインフラに展開できます。取り込み、検出、匿名化、デコードのRESTエンドポイントを備えています。

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

クイックスタート

bash
# 文書内の個人情報を検出
promptshield detect report.pdf -o report-pii.json

# 匿名化して出力
promptshield anonymize report.pdf -o report-safe.pdf

# デコードして元の値に戻す
promptshield detokenize ai-output.pdf -o restored.pdf

# ローカルAPIサーバーを起動
promptshield serve --host 0.0.0.0 --port 8000

検出オプション

デスクトップアプリで設定できるパラメーターは、すべてCLIでも指定できます。フラグを組み合わせて使うことも、ロケールごとのプリセットとしてdemo/setup.jsonに保存することもできます。

bash
# 検出言語と正規表現の国別パックを指定
promptshield detect contract.pdf --language en --countries CA -o pii.json

# 固有名詞の検出エンジンを変更(Hugging FaceのモデルID)
promptshield detect contract.pdf --ner-backend Davlan/bert-base-multilingual-cased-ner-hrl

# 一部の検出方法をオフにし、領域のまとめ方を厳しく設定(固有名詞の検出はPERSONとORGのみ)
promptshield detect contract.pdf --no-llm --fuzziness 0.5 --ner-types PERSON,ORG

# 個人情報として必ず検出する語句を追加(複数指定可)
promptshield detect contract.pdf -e SA-2026-0847 -e "84-329-1057"

# demo/setup.jsonからロケール別の設定をすべて読み込み、確認用のファイルにまとめる
promptshield detect contract.pdf --preset en --export-review -o contract.psreview
--language LANG

ISO 639-1コード:en、fr、de、es、it、nl、pt、pl。固有名詞の検出モデルと正規表現の言語パックが、この値で決まります。

--countries CODES

ISOの国コードをカンマ区切りで指定します。CAを指定すると、すべての州のSIN、RAMQ、郵便番号が検出対象になります。

--ner-backend MODEL

spacy(軽量)またはHugging FaceのモデルIDを指定します。BERTやGLiNERのエンジンは、promptshield models installでインストールします。

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

必要な検出方法がわかっている場合は、それ以外を個別にスキップできます。

--fuzziness 0.0-1.0

領域のまとめ方の強さです。0は厳格、1は緩やかです。

--regex-types / --ner-types

検出方法ごとに、対象とする個人情報の種類を限定します(PERSON、ORG、EMAILなど)。

-e / --expression PATTERN

CUSTOM型の個人情報として検出する文字列を指定します。正規表現を使う場合は、先頭にre:を付けます。複数指定できます。

--preset LOCALE

demo/setup.json[locale]から検出パラメーターをすべて読み込みます。CLIのフラグを指定した場合は、フラグが優先されます。

--export-review -o FILE.psreview

元の文書と検出した領域を、.psreview形式のZIPファイルにまとめます。テスト用のフィクスチャや、確認作業の引き継ぎに使えます。

コマンドラインインターフェイス

ターミナルからコマンド1つで文書を処理できます。検出、匿名化、デコードのすべてをオフラインで実行します。

セルフホスト型Docker API

docker composeで自社のインフラに展開できます。REST APIのすべての機能を利用でき、OpenAPIスキーマは/openapi.jsonで取得できます。

Python SDK

コアエンジンをPythonスクリプトから直接インポートできます。非同期処理、型ヒント、Pydanticモデルに対応しています。

ゼロトラスト設計

すべての処理は、コンテナー内またはお使いのデバイス上で完結します。文書のデータが、当社を含む外部に送信されることはありません。

各種の文書形式に対応

PDF、DOCX、XLSX、PPTX、画像(PNG、JPEG、TIFF、BMP、WebP)に対応しています。スキャンした文書のOCRも含まれます。

バッチ処理

数百件の文書をプログラムから一括で処理できます。リンクした文書のセットでは、同じ値に同じコードが割り当てられます。

CLIとセルフホストAPIは、Proプラン以上でご利用いただけます。

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

黒塗りを画面で操作するのではなく自動化する場合、比較すべき点が変わります。ガイドでは、開発者向けの選択肢(ライブラリ、ホスト型のAPI、ローカルのCLI)を比較し、それぞれで文書がどこに置かれるかを説明しています。

ガイドを読む