API-Referenz

Antwortformat

Jede Prüfung liefert dasselbe Objekt, einzeln bei /v1/check und als Liste bei /v1/checks.

Antwort
{
  "toxic": true,
  "score": 0.71,
  "severity": 2,
  "action": "flag",
  "rule": null,
  "categories": {},
  "model": "axo-small",
  "lang": "de",
  "self_harm": false
}

Felder

FeldTypBedeutung
toxicbooleantrue, sobald der Score die Markier-Schwelle der gewählten Stufe erreicht.
scorenumberKalibrierter Score von 0 bis 1, auf sechs Stellen gerundet. Höher heißt toxischer.
severity0 – 3Schweregrad als grobes Band des Scores. Hängt nicht von der Stufe ab. Beta.
actionstringallow, flag oder block. Die Empfehlung für deine Stufe und deine Regeln.
rulestring | nullallow oder block, wenn eine deiner Regeln gegriffen hat, sonst null.
categoriesobjectHeute immer leer. Kategorien wie Hass oder Drohung kommen mit späteren Modellen.
modelstringDas Modell, das geantwortet hat.
langstringSprache des Modells, heute de.
self_harmbooleanZusatzfeld. Heute immer false.

action

WertBedeutung
allowScore unter der Markier-Schwelle. Durchlassen.
flagScore zwischen Markier- und Block-Schwelle. Zur Prüfung vorlegen oder verbergen, bis jemand entscheidet.
blockScore ab der Block-Schwelle oder eine Sperr-Regel hat gegriffen. Nachricht entfernen.

severity

Der Schweregrad ist ein Band des Scores und für alle Stufen gleich.

WertNameScore
0Unbedenklich0,00 bis 0,30
1Leicht0,30 bis 0,60
2Mittel0,60 bis 0,85
3Schwer0,85 bis 1,00

Beta. Die Bänder sind grob gestuft und keine menschliche Einordnung. Für Entscheidungen nutze action oder den score.

Mit Regeln

Greift eine Sperr-Regel, lautet die Antwort immer action: "block", severity: 3, toxic: true und rule: "block". Bei Erlaubt-Regeln wird der Rest der Zeile normal bewertet und rule ist "allow". Details unter Eigene Regeln.