Praxisnahe API-Beispiele

Probieren Sie sofort synthetische Beispiele aus oder führen Sie dieselben Abläufe mit der echten ShinrAI-API aus.

Standardmäßig synthetisch

Ablauf vor Verwendung eines Schlüssels ansehen

Jedes Szenario beginnt mit einem aufgezeichneten synthetischen Ergebnis und stellt keine API-Anfrage. Wechseln Sie in den Live-Modus, wenn Sie Ihren eigenen Schlüssel und Ihr Kontingent verwenden möchten.

Supportnachricht schützen

Ersetzen Sie die Identität eines Kunden, bevor Sie den Fall an einen externen Assistenten senden, und stellen Sie die Antwort lokal wieder her.

Original→Protected→Restored reply

{"protected":"Nora Winter needs help with order 4815.","restored_reply":"Emma Weber can reset order 4815."}

Selbst ausführen

Voraussetzungen

Setzen Sie SHINRAI_API_KEY und optional SHINRAI_API_URL. Verwenden Sie beim Testen nur synthetische Supporttexte.

Befehl

curl "${SHINRAI_API_URL:-https://api.getshinrai.com}/v2/protect"   -H "Authorization: Bearer $SHINRAI_API_KEY" -H "Content-Type: application/json"   -d '{"text":"Emma Weber needs help with order 4815.","policy":{"preset":"pseudonymize"},"output":{"include":["entities","mapping"]}}'

Erwartetes Ergebnis

Die Antwort enthält geschützten Text, eine lokale Zuordnung, erkannte Entitäten und Nutzungsdaten. Verwenden Sie die Zuordnung in Ihrer Anwendung, um die Antwort des Assistenten wiederherzustellen.

Fehlerbehebung

Eine fehlgeschlagene Schutzantwort muss die Weitergabe stoppen. Prüfen Sie den Fehlerumschlag auf ungültige Zugangsdaten, Kontingent, Nutzlastgröße oder nicht verfügbare Verarbeitung.

Leitfaden zur nativen API v2 · API-Vorgang · Secure AI Suite

CRM-Datensätze konsistent schützen

Verwenden Sie eine Zuordnung pro Anfrage, damit dieselbe Person in allen Datensätzen denselben Ersatz erhält.

{"results":[{"output":"Nora Winter owns account A-17."},{"output":"Email Nora Winter at nora@example.net"}],"mapping":{"delta":[{"original":"Emma Weber","replacement":"Nora Winter"}]}}

Selbst ausführen

Voraussetzungen

Setzen Sie SHINRAI_API_KEY; exportieren Sie während der Evaluierung nur synthetische CRM-Zeilen.

Befehl

curl "${SHINRAI_API_URL:-https://api.getshinrai.com}/v2/protect"   -H "Authorization: Bearer $SHINRAI_API_KEY" -H "Content-Type: application/json"   -d '{"texts":["Emma Weber owns A-17.","Email Emma Weber at emma@example.com."],"policy":{"preset":"pseudonymize"},"output":{"include":["entities","mapping"]}}'

Erwartetes Ergebnis

Beide Ergebnisse verwenden denselben Ersatz für Emma Weber. Die Antwort liefert eine anfragebezogene Zuordnung und die Gesamtnutzung.

Fehlerbehebung

Senden Sie zusammengehörige Datensätze in einem Stapel. Getrennte Anfragen bleiben nur konsistent, wenn Ihre Anwendung die frühere Zuordnung mitsendet.

Leitfaden zur nativen API v2 · API-Vorgang · n8n-Integration

Kontext vor einer KI-Anfrage schützen

Senden Sie geschützten Retrieval-Kontext an das Modell und behalten Sie die Ersetzungszuordnung in Ihrer Anwendung.

Retrieved context→ShinrAI→AI→Local restore

{"model_input":"Summarize Nora Winter's account.","restored_reply":"Emma Weber's account is ready for review."}

Selbst ausführen

Voraussetzungen

Setzen Sie den ShinrAI-Schlüssel sowie MODEL_ENDPOINT, MODEL_NAME und MODEL_API_KEY für einen OpenAI-kompatiblen Endpunkt.

Befehl

curl -O https://getshinrai.com/downloads/examples/shinrai-ai-workflow-python.py
SHINRAI_API_KEY=... MODEL_ENDPOINT=https://model.example/v1   MODEL_NAME=your-model MODEL_API_KEY=... python shinrai-ai-workflow-python.py

Erwartetes Ergebnis

Das Skript gibt die geschützte Modelleingabe und eine lokal wiederhergestellte Antwort aus. Die Ersetzungszuordnung gelangt nie in die Modellanfrage.

Fehlerbehebung

Wenn der Schutz fehlschlägt, beendet sich das Skript vor dem Modellaufruf. Prüfen Sie beide Endpunkte und Zugangsdaten einzeln und versuchen Sie es erneut mit synthetischem Kontext.

Leitfaden zur nativen API v2 · API-Vorgang · Python-Beispiel · JavaScript-Beispiel · Open WebUI

Dokument schützen

Laden Sie eine synthetische PDF- oder DOCX-Datei hoch, verfolgen Sie den Job und laden Sie das geschwärzte PDF und den geschützten Text herunter.

{"id":"job_5e2a","kind":"document","status":"succeeded","artifacts":{"protected":"/v2/jobs/job_5e2a/artifacts/protected","text":"/v2/jobs/job_5e2a/artifacts/text","entities":"/v2/jobs/job_5e2a/artifacts/entities"}}

Selbst ausführen

Voraussetzungen

Erstellen Sie eine synthetische PDF- oder DOCX-Datei und setzen Sie SHINRAI_API_KEY.

Befehl

UPLOAD=$(curl -s "${SHINRAI_API_URL:-https://api.getshinrai.com}/v2/uploads" \
  -H "Authorization: Bearer $SHINRAI_API_KEY" -H "Content-Type: application/pdf" \
  --data-binary @sample.pdf | python3 -c 'import sys, json; print(json.load(sys.stdin)["id"])')
curl -i "${SHINRAI_API_URL:-https://api.getshinrai.com}/v2/jobs" \
  -H "Authorization: Bearer $SHINRAI_API_KEY" -H "Content-Type: application/json" \
  -d '{"kind":"document","inputs":[{"kind":"file","source":{"upload":"'$UPLOAD'"}}]}'

Erwartetes Ergebnis

Eine 202-Antwort liefert die Auftrags-ID und Location. Fragen Sie diese URL bis zum Status succeeded ab und laden Sie dann die aufgeführten Artefakte herunter.

Fehlerbehebung

Beachten Sie Retry-After beim Abfragen. Eine Bereitstellung kann nicht unterstützte Datei- oder Artefaktformate ablehnen; prüfen Sie vor einem neuen Versuch den Auftragsfehler.

Dokument-Leitfaden · API-Vorgang · Nextcloud-Integration

Vollständigen KI-Ablauf lokal ausführen

Die herunterladbaren Beispiele rufen die native PII-API v2 auf, geben nur geschützten Text an einen OpenAI-kompatiblen Modell-Endpunkt weiter und stellen die Antwort lokal wieder her. Zugangsdaten für Modell und ShinrAI kommen aus Umgebungsvariablen.

Python herunterladen JavaScript herunterladen