ShinrAIで開発
有用な文脈を保ちながら個人データを保護します。
実際のリクエストから始めるか、本番向けレシピに沿うか、対応するすべての顧客向けエンドポイントを確認できます。
APIを選択
すべての契約を同じサービスと同じモデルが処理します。コードに合う契約を選んでください。
ホスト型APIと自社クラスターへのインストールに共通の1つの契約です。オフライン版は、イメージがv2に対応するまでネイティブAPI v1を提供します。
- 安定版の契約2.0.0:2.x内の変更は追加のみです
- テキスト、表、JSON、文字起こし
- 画像:OCR、エンティティごとのピクセル枠、マスキング済み画像の返却
- 音声:音声認識、時間区間、すべての個人情報をピー音処理した録音
- ジョブによるPDF・DOCX文書の処理とマスキング済みPDFの返却
- ジョブによる長い録音の処理
- リアルタイム、標準、バッチの処理区分
- セッションで複数リクエストにわたり1つの置換マップを保持
- テキストや画像をそのまま本文として送信でき、curlで直接使えます
SDKとリクエスト形式はそのままです。各ベンダーAPIには専用のエンドポイントがあり、エンドポイントだけを変更してShinrAIキーを使用します。
| API | エンドポイント(ここだけ変更) | APIホスト上の代替パス |
|---|---|---|
| Azure AI Language PII | https://azure.api.getshinrai.com | https://api.getshinrai.com/v1/azure |
| Google Cloud DLP | https://google.api.getshinrai.com | https://api.getshinrai.com/v1/google |
| AWS Comprehend | https://aws.api.getshinrai.com | https://api.getshinrai.com/v1/aws |
- Azureクライアントは、ShinrAIキーをサブスクリプションキーとして送信します。
- Googleクライアントは、APIキーまたはBearerトークンとして送信します。
- AWSクライアントは、ShinrAIキーで作成したSigV4認証情報で署名します。
各ベンダーのエンドポイントは、/openapi.json で独自のOpenAPIドキュメントを提供します。サンドボックスは同じ名前で api-sbx を使います。
ベンダーの契約により、ShinrAIが返せる内容(種類、信頼度、メディア、セッション、ジョブ)は制限されます。そのため、結果はShinrAI本来の性能より劣る場合があります。最高の品質にはネイティブPII API v2を使用してください。
既存のv1連携はそのまま動作します。新しい開発にはネイティブAPI v2を使用します。
すべての契約はOpenAPI 3.1として公開されています。SDKは不要で、任意のHTTPクライアントで使えます。
60秒でわかるネイティブAPI v2
キーを一度設定します。各例ではBearerトークンとして送信します。
export SHINRAI_API_KEY=shr_live_...
テキスト内の個人データを検出
curl -s https://api.getshinrai.com/v2/detect -H "Authorization: Bearer $SHINRAI_API_KEY" \
-H "Content-Type: application/json" -d '{"text": "Anna Weber, anna.weber@example.org, IBAN DE89 3704 0044 0532 0130 00"}'curl 'https://azure.api.getshinrai.com/language/:analyze-text?api-version=2023-04-01' \
-H "Ocp-Apim-Subscription-Key: $SHINRAI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"kind":"PiiEntityRecognition","analysisInput":{"documents":[{"id":"1","language":"en","text":"Anna Weber, anna.weber@example.org, IBAN DE89 3704 0044 0532 0130 00"}]},"parameters":{"modelVersion":"latest","stringIndexType":"Utf16CodeUnit"}}'互換APIでは、ShinrAIが返せる内容が制限されます。最高の品質にはネイティブPII API v2を使用してください。
# Once: create SigV4 credentials with your ShinrAI key
# curl -X POST https://aws.api.getshinrai.com/providers/aws/credentials -H "Authorization: Bearer $SHINRAI_API_KEY"
import boto3, os
client = boto3.client(
"comprehend",
region_name="eu-central-1",
endpoint_url="https://aws.api.getshinrai.com",
aws_access_key_id=os.environ["SHINRAI_AWS_ACCESS_KEY_ID"],
aws_secret_access_key=os.environ["SHINRAI_AWS_SECRET_ACCESS_KEY"],
)
print(client.detect_pii_entities(Text="Anna Weber, anna.weber@example.org, IBAN DE89 3704 0044 0532 0130 00", LanguageCode="en"))互換APIでは、ShinrAIが返せる内容が制限されます。最高の品質にはネイティブPII API v2を使用してください。
curl 'https://google.api.getshinrai.com/v2/projects/my-project/locations/global/content:inspect' \
-H "x-goog-api-key: $SHINRAI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"item":{"value":"Anna Weber, anna.weber@example.org, IBAN DE89 3704 0044 0532 0130 00"},"inspectConfig":{"includeQuote":true}}'互換APIでは、ShinrAIが返せる内容が制限されます。最高の品質にはネイティブPII API v2を使用してください。
テキストファイルをそのまま送信し、保護済みテキストを受け取る
curl -s "https://api.getshinrai.com/v2/protect?preset=label" -H "Authorization: Bearer $SHINRAI_API_KEY" \
-H "Content-Type: text/plain" -H "Accept: text/plain" --data-binary @letter.txt# Azure returns the masked text as redactedText.
curl 'https://azure.api.getshinrai.com/language/:analyze-text?api-version=2023-04-01' \
-H "Ocp-Apim-Subscription-Key: $SHINRAI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"kind":"PiiEntityRecognition","analysisInput":{"documents":[{"id":"1","language":"en","text":"Anna Weber, anna.weber@example.org"}]},"parameters":{"modelVersion":"latest","stringIndexType":"Utf16CodeUnit"}}'互換APIでは、ShinrAIが返せる内容が制限されます。最高の品質にはネイティブPII API v2を使用してください。
curl 'https://google.api.getshinrai.com/v2/projects/my-project/locations/global/content:deidentify' \
-H "x-goog-api-key: $SHINRAI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"item":{"value":"Anna Weber, anna.weber@example.org"},"deidentifyConfig":{"infoTypeTransformations":{"transformations":[{"primitiveTransformation":{"replaceWithInfoTypeConfig":{}}}]}}}'互換APIでは、ShinrAIが返せる内容が制限されます。最高の品質にはネイティブPII API v2を使用してください。
マスキング済みのスクリーンショットを受け取る
curl -s https://api.getshinrai.com/v2/protect -H "Authorization: Bearer $SHINRAI_API_KEY" \
-H "Content-Type: image/png" -H "Accept: image/png" --data-binary @screenshot.png -o redacted.png
大きなバッチのジョブを開始
まず1行に1入力のJSONLファイルをアップロードします。アップロードの応答にジョブ用のIDが含まれます。
curl -s https://api.getshinrai.com/v2/jobs \
-H "Authorization: Bearer $SHINRAI_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: rows-2026-09-28" \
-d '{"kind": "text_batch",
"inputs": [{"kind": "file", "source": {"upload": "up_..."}}],
"output": {"artifacts": ["protected", "entities"]}}'
ネイティブAPI v2ガイド · v2の完全なリファレンス(Markdown) · APIエクスプローラー(Swagger) · v2のOpenAPI 3.1 · 全APIのOpenAPI 3.1
開始方法を選択
Hello ShinrAI をローカルで実行
ブラウザのワークスペースで保護フロー全体を試し、デバッグできます。テキスト、ファイル、スキャン、互換 API には ShinrAI キーを用意し、保護されたチャットを使う場合のみ LLM キーを追加します。
uv を一度インストールしてから、確認済みリリースを起動します。
uvx --from https://github.com/Innovius-ai/hello-shinrai/releases/download/v0.1.4/hello_shinrai-0.1.4-py3-none-any.whl hello-shinrai
テキスト、ファイル、チャット、Azure 比較、API エクスプローラーの各ワークスペースを利用できます。キーは、OS の資格情報ストアへの保存を明示的に選ばない限り、ローカルプロセス内に留まります。
検証済みリリース: v0.1.4。アップグレードするには、wheel URL の両方のバージョン値を変更します。
APIリファレンス
実際のAPIにリクエストを送信
エクスプローラーはShinrAIゲートウェイから配信され、登録済みの顧客向けルートから構築されます。スクリプトとスタイルもバックエンドでホストされます。