最初のAPIリクエストを送信
キーを作成し、API契約を選択してリクエストを送り、レスポンスを理解します。
最初のAPI呼び出し
ダッシュボードにログイン して購入を完了してください。マネージドAPIの初回購入時、有効なキーがなければAPIキーを発行し、確認済みのアカウントメールに送信します。「APIキー」からコピーし、ソースコード外のシークレットマネージャーで保管してください。
ブラウザで作成したキーは24時間以内なら再表示できます。追加のキーを作る際はメール送信を無効にできます。再表示期限を過ぎた場合は明示的にキーを置き換えてください。古いキーは無効になります。オフライン専用の購入ではインストールの有効化を行い、マネージドAPIキーは発行されません。
APIキーはアプリケーションを認証します。AI接続はMCPを使用し、選択した権限でアシスタントがツールにアクセスできるようにします。アシスタントの接続だけでは、関係のないチャットメッセージは自動保護されません。
本番環境のベースURL: https://api.getshinrai.com
curl https://api.getshinrai.com/v2/detect \
-H "Authorization: Bearer $SHINRAI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"text":"Emma Weber, emma@example.com"}'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":"Emma Weber, emma@example.com"}]},"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="Emma Weber, emma@example.com", 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":"Emma Weber, emma@example.com"},"inspectConfig":{"includeQuote":true}}'互換APIでは、ShinrAIが返せる内容が制限されます。最高の品質にはネイティブPII API v2を使用してください。
出力例(シミュレーション)
上のコマンドに対応する、シミュレーションによるJSON応答の抜粋です。実際の検出結果、置換値、残高は異なる場合があります。
{
"offset_unit": "codepoint",
"engine": {
"model": "shinrai-v1.5",
"layers_run": ["model", "pattern"],
"degraded": false
},
"results": [
{
"input_id": "1",
"status": "ok",
"entities": [
{
"id": "e1",
"type": "PERSON",
"span": {"start": 0, "end": 10},
"confidence": 0.98,
"source": "model"
},
{
"id": "e2",
"type": "EMAIL",
"span": {"start": 12, "end": 28},
"confidence": 1.0,
"source": "pattern"
}
]
}
],
"usage": {
"records": 1,
"weighted_records": 1.0,
"tier": "standard",
"charged": true,
"balance_after": 9999.0
}
}レスポンスには、各入力のエンティティ(種類、範囲、信頼度)、実行されたエンジン、残高を含む利用量が含まれます。この短い標準リクエストは1レコードを使用します。検出結果はモデルと入力によって異なります。
この例ではネイティブPII API v2を使用します。オフライン版は、イメージがv2に対応するまでネイティブAPI v1を提供します。
好みのクライアントを使用
curl https://api.getshinrai.com/v2/detect \
-H "Authorization: Bearer $SHINRAI_API_KEY" \
-H 'Content-Type: application/json' \
-d '{"text":"Emma Weber, emma@example.com"}'import os, requests
response = requests.post(
"https://api.getshinrai.com/v2/detect",
headers={"Authorization": f"Bearer {os.environ['SHINRAI_API_KEY']}"},
json={"text": "Emma Weber, emma@example.com"},
)
response.raise_for_status()
for entity in response.json()["results"][0]["entities"]:
print(entity["type"], entity["span"], entity["confidence"])const response = await fetch("https://api.getshinrai.com/v2/detect", {
method: "POST",
headers: { Authorization: `Bearer ${process.env.SHINRAI_API_KEY}`, "Content-Type": "application/json" },
body: JSON.stringify({ text: "Emma Weber, emma@example.com" }),
});
if (!response.ok) throw new Error(`ShinrAI HTTP ${response.status}`);
const { results } = await response.json();
for (const entity of results[0].entities) console.log(entity.type, entity.span, entity.confidence);