Ansichten:

Überschriften

Name
Erforderlich
Beschreibung
Authorization
Ja
Das Inhabertoken für die Authentifizierung.

Abfrageparameter

Name
Erforderlich
Beschreibung
detailedResponse
No
Das Detailniveau der API-Antwort.
Mögliche Werte sind:
  • false: Eine kurze Bewertung Ihrer Eingaben basierend auf den KI Guard-Einstellungen (Standard).
  • true: Eine detaillierte Bewertung Ihrer Eingaben basierend auf den KI Guard-Einstellungen.

Anforderung

OpenAI Chat-Abschlussanforderungsformat:
{
  "model": "us.meta.llama3-1-70b-instruct-v1:0",
  "messages": [
    {
      "role": "user",
      "content": "Your prompt text here"
    }
  ]
}
OpenAI Chat-Antwortformat für die Fertigstellung:
{
  "id": "chatcmpl-8f88f71a-7d42-c548-d587-8fc8a17091b6",
  "object": "chat.completion",
  "created": 1748535080,
  "model": "us.meta.llama3-1-70b-instruct-v1:0",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "Response content here",
        "refusal": null
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 139,
    "completion_tokens": 97,
    "total_tokens": 236
  }
}
Einfache Zeichenfolgenformatierung:
{
  "guard": "Your prompt text here"
}

Antwort

Beispielantwort (wenn detailedResponse: false):
{
    "id": "1234567890abcdef",
    "action": "Block",
    "reason": "[Violation] Policy Name: harmful_content"
  }
Beispielantwort (wenn detailedResponse: true):
{
    "id": "1234567890abcdef",
    "action": "Allow",
    "reason": "No policy violations detected",
    "harmful_content": [
      {
        "name": "harmful_content",
        "content_violation": false,
        "confidence_score": 0.05
      }
    ],
    "sensitive_information": {
      "content_violation": false,
      "rule": ""
    },
    "prompt_attack": [
      {
        "name": "prompt_injection",
        "content_violation": false,
        "confidence_score": 0.02
      }
    ]
  }
Parameter
Beschreibung
id
Der eindeutige Bezeichner der KI Guard-Bewertung.
action
Die empfohlene Aktion.
Mögliche Werte sind:
  • Allow
  • Block
reason
Die Erklärung der Aktion, einschließlich der Details zum Einstellungsverstoß.
harmful_content
Jeglicher schädlicher Inhalt, der in den Eingaben oder Ausgaben erkannt wurde, mit Vertrauensbewertungen.
sensitive_information
Alle erkannten Verstöße im Zusammenhang mit persönlich identifizierbaren Informationen (PII) oder sensiblen Informationen.
prompt_attack
Ein Array aller erkannten Prompt-Angriffe mit Vertrauensbewertungen.

Häufige Fehler

Die API gibt standardmäßige HTTP-Statuscodes zurück:
  • 400 Ungültige Anfrage: Überprüfen Sie die Fehlermeldung für weitere Details
  • 403 Verboten: Unzureichende Benutzerberechtigungen oder ein Authentifizierungsproblem
  • 429 Zu viele Anfragen: Ratenbegrenzung überschritten
  • 500 Interner Serverfehler: Ein vorübergehendes Problem ist auf der Serverseite aufgetreten
Zugehörige Informationen