SpamDetectionResult

The spam verdict: spam (delete it), suspected spam (send it back with the suggestion), or neither (publish it).

Python

from respectify.schemas import SpamDetectionResult

PHP

use Respectify\Schemas\SpamDetectionResult;

JSON

Types are returned as JSON objects in API responses.

Fields

reasoning

Explanation of the spam analysis

Python

result.reasoning: str

PHP

$result->reasoning: string

JSON

"reasoning": "string"

is_spam

Whether the comment is detected as spam

Python

result.is_spam: bool

PHP

$result->isSpam: bool

JSON

"is_spam": true

confidence

Confidence in the verdict (0.0=uncertain, 1.0=certain the verdict is correct)

Constraints: ge=0.0, le=1.0

Python

result.confidence: float # 0.0-1.0

PHP

$result->confidence: float

JSON

"confidence": 0.5

suspected_spam

Looks like spam but is not certain: send the comment back to its writer with the suggestion instead of deleting it. Always false when is_spam is true

Python

result.suspected_spam: bool

PHP

$result->suspectedSpam: bool

JSON

"suspected_spam": true

suggestion

What to tell the writer of a suspected-spam comment, e.g. to remove a link. Empty unless suspected_spam is true

Python

result.suggestion: str

PHP

$result->suggestion: string

JSON

"suggestion": "string"