Prompt Shield API
Mit der Prompt Shield-API können Sie Eingabeaufforderungen und Antworten aus jeder Anwendung scannen. Sie müssen die integrierte Chatbot-Infrastruktur von SecureAI nicht verwenden. Integrieren Sie die Scan-Engine mit drei REST-Endpunkten in Ihre eigene LLM-Pipeline. Prompt Shield kann auf zwei Arten verwendet werden:- Eigenständige Scan-API – die unten dokumentierten Endpunkte
/scan,/scan-outputund/scan-conversationfür Ihre eigene LLM-Pipeline. - Inline bei Vervollständigungen – wenn Sie Chat Completion oder den OpenAI-kompatiblen Endpunkt aufrufen, wird Prompt Shield automatisch ausgeführt und kann pro Aufruf optimiert werden. Siehe Kontrolle pro Anruf bei Abschlüssen.
Kontrolle pro Anruf bei Abschlüssen
Abschlussanforderungen scannen Eingabe (und Ausgabe) automatisch über Prompt Shield, wenn der API-Schlüssel dies aktiviert hat. Sie können das Verhalten für einen einzelnen Aufruf mit einemprompt_shield-Objekt im Anforderungstext überschreiben:
Sie können
policy nicht mit enabled: false kombinieren. Die angewendete Richtlinie wird in der Antwort zurückgegeben (metadata.prompt_shield_policy auf dem klassischen Endpunkt, secureai.prompt_shield_policy auf dem /v1-Endpunkt). Um eine Vorschau des Urteils eines Anrufs anzuzeigen, ohne das Modell auszuführen, verwenden Sie Policy Check.
Authentifizierung
Alle Prompt Shield API-Anfragen erfordern einen SecureAI API-Schlüssel imAuthorization-Header:
Basis-URL
POST /scan
Scannen Sie eine einzelne Benutzeraufforderung auf Injektionsangriffe, bevor Sie sie an Ihr LLM senden.Anfrage
Antwort
Empfohlenes Integrationsmuster
POST /Scan-Ausgabe
Scannen Sie eine LLM-Antwort auf Anzeichen einer Kompromittierung, einschließlich System-Prompt-Lecks, Canary-Token-Lecks oder Rollendrift.Anfrage
Antwort
POST /scan-conversation
Scannen Sie eine gesamte Konversation mit mehreren Runden auf einmal. Dies ist nützlich für die Batch-Analyse oder für die Auswertung historischer Konversationen zur rückwirkenden Erkennung.Anfrage
Antwort
Fehlerantworten
Ratenbeschränkungen und Leistung
– Die Scan-Latenz beträgt normalerweise 1–5 ms für die Regex- und Heuristikebenen. – Durch das Hinzufügen der ML-Ebene erhöht sich die Latenz je nach Einbettungsanbieter auf 20–50 ms.- Die externe API teilt die Ratenbeschränkungen mit dem Rest Ihrer API-Schlüsselzuteilung.
– Der Leistungsschalter gibt
503-Antworten zurück, wenn der Motor innerhalb von 30 Sekunden 5 aufeinanderfolgende Ausfälle erfährt.
Prompt Shield für einen API-Schlüssel aktivieren
- Gehen Sie zu Admin -> API-Schlüssel.
- Bearbeiten Sie den API-Schlüssel, den Sie für externe Aufrufe verwenden.
- Schalten Sie Prompt-Schutz aktivieren ein.
- Legen Sie optional Prompt Shield Sensitivity auf
strict,balancedoderpermissivefest. - Legen Sie optional Prompt Shield Policy fest, um eine bestimmte Richtlinie an diesen Schlüssel zu binden.
- Speichern.
/api/external/prompt-shield/*-Anfragen durchlaufen die Engine mit der konfigurierten Richtlinie.
