200
Successful response - returns JSON with results for each requested evaluation. | Schema — OPTIONAL |
|---|
comment_score object — OPTIONALSchema for comment scoring results under the site's tolerances: findings (with those the site's levels accept already removed), comment health per item and overall, and the exceeds_tolerance verdict. logical_fallacies object[]A list of any logical fallacies identified within the comment. fallacy_name stringName of the logical fallacy, eg, 'straw man' | quoted_logical_fallacy_example stringQuoted part of the comment that demonstrates the fallacy | explanation string — OPTIONALExplanation of why we think that quote shows a logical fallacy, and suggestions on how to tackle it | suggested_rewrite string — OPTIONALRarely, a suggested rewrite. Provided only if the commenter's intent was very clear. | severity integerPossible values: 1 ≤ value ≤ 4 How serious this finding is: 1 minor, 2 clear, 3 severe (a slur or dehumanising language, a threat, sexual harassment, urging self-harm, sustained abuse), 4 extreme (the same at full force: a slur combined with a threat or a call for violence, a credible threat against a named person, graphic sexual abuse). Findings the site's level for this kind of problem accepts are not sent (at standard, minor findings; at relaxed, minor and clear; at permissive, minor, clear and severe), except for floored categories, which accept none. No level accepts an extreme finding. |
| objectionable_phrases object[]A list of any objectionable or rude phrases identified within the comment. quoted_objectionable_phrase stringQuoted part of the comment that may be seen as objectionable | explanation string — OPTIONALExplanation of why we assessed this as potentially objectionable | suggested_rewrite string — OPTIONALRarely, a suggested rewrite. Provided only if the commenter's intent was very clear. | category stringPossible values: [threat, identity_attack, sexual_content, harassment, insult, profanity, dismissive_tone] What kind of problem the phrase is. | severity integerPossible values: 1 ≤ value ≤ 4 How serious this finding is: 1 minor, 2 clear, 3 severe (a slur or dehumanising language, a threat, sexual harassment, urging self-harm, sustained abuse), 4 extreme (the same at full force: a slur combined with a threat or a call for violence, a credible threat against a named person, graphic sexual abuse). Findings the site's level for this kind of problem accepts are not sent (at standard, minor findings; at relaxed, minor and clear; at permissive, minor, clear and severe), except for floored categories, which accept none. No level accepts an extreme finding. |
| negative_tone_phrases object[]A list of any negative tone phrases identified within the comment. quoted_negative_tone_phrase stringQuoted part of the comment that may contribute negatively to the conversation | explanation string — OPTIONALExplanation of why we assessed this as potentially negative for the conversation | suggested_rewrite string — OPTIONALRarely, a suggested rewrite. Provided only if the commenter's intent was very clear. | category stringPossible values: [threat, identity_attack, sexual_content, harassment, insult, profanity, dismissive_tone] What kind of problem the phrase is. | severity integerPossible values: 1 ≤ value ≤ 4 How serious this finding is: 1 minor, 2 clear, 3 severe (a slur or dehumanising language, a threat, sexual harassment, urging self-harm, sustained abuse), 4 extreme (the same at full force: a slur combined with a threat or a call for violence, a credible threat against a named person, graphic sexual abuse). Findings the site's level for this kind of problem accepts are not sent (at standard, minor findings; at relaxed, minor and clear; at permissive, minor, clear and severe), except for floored categories, which accept none. No level accepts an extreme finding. |
| appears_low_effort booleanTrue if the comment appears to be low effort, eg, 'me too' or 'I agree'. Reported as false when the site's low_effort level accepts it (permissive, relaxed or off). | overall_score integerPossible values: 1 ≤ value ≤ 5 Comment health, 1 (poor) to 5 (excellent): health_score rounded half up. The quality score alone is health_items.quality.score. When every item is off (so health_score is omitted), this is the quality rubric's score. Older servers, which do not send health_items, give the quality score here. | toxicity_score number — OPTIONALPossible values: value ≤ 1 Score indicating level of toxicity in the comment, ranging from 0.0 (not toxic) to 1.0 (highly toxic). Never adjusted for the site's tolerances. | toxicity_explanation string — OPTIONALEducational explanation of toxicity issues found in the comment, if any. Empty when the comment was cleared by first-pass screening. | exceeds_tolerance booleanThe verdict to act on: true when any health_items entry has is_acceptable false, or the comment is toxic (toxicity_score 0.7 or higher, or 0.5 or higher when none of its findings was accepted by the site's levels). Decide whether to coach or hold a comment on this, rather than on toxicity_score or overall_score alone. | health_score number — OPTIONALPossible values: 1 ≤ value ≤ 5 Comment health, 1.0-5.0 to two decimal places: the geometric mean of the quality score and the worst problem item's score, leaving out whichever is off. Optional: omitted (not null) when every item is off, and absent from older servers' responses. | health_items object — OPTIONALEach comment health item that is not off, by name (the nine problem categories and quality). Optional: absent from older servers' responses. | tolerances objectThe level each of the ten items was judged under: the levels given in the request, with standard for every item it did not name. threat string — OPTIONALPossible values: [off, permissive, relaxed, standard, strict, zero_tolerance] Threats of violence or harm, or urging self-harm. Floored: standard, strict or zero_tolerance only; off, permissive and relaxed are rejected. | identity_attack string — OPTIONALPossible values: [off, permissive, relaxed, standard, strict, zero_tolerance] Hostility toward people for an identity they hold, including slurs. Floored: standard, strict or zero_tolerance only; off, permissive and relaxed are rejected. | sexual_content string — OPTIONALPossible values: [off, permissive, relaxed, standard, strict, zero_tolerance] Explicit or crude sexual content. Floored: standard, strict or zero_tolerance only; off, permissive and relaxed are rejected. | harassment string — OPTIONALPossible values: [off, permissive, relaxed, standard, strict, zero_tolerance] Targeted or sustained demeaning of a person, or othering them. Floored: standard, strict or zero_tolerance only; off, permissive and relaxed are rejected. | insult string — OPTIONALPossible values: [off, permissive, relaxed, standard, strict, zero_tolerance] One-off insults and put-downs. | profanity string — OPTIONALPossible values: [off, permissive, relaxed, standard, strict, zero_tolerance] Swearing and crude language not aimed at an identity. | dismissive_tone string — OPTIONALPossible values: [off, permissive, relaxed, standard, strict, zero_tolerance] Sarcasm or dismissal toward someone in the discussion. | logical_fallacy string — OPTIONALPossible values: [off, permissive, relaxed, standard, strict, zero_tolerance] | low_effort string — OPTIONALPossible values: [off, permissive, relaxed, standard, strict, zero_tolerance] Empty posts such as 'me too' or '+1'. | quality string — OPTIONALPossible values: [off, permissive, relaxed, standard, strict, zero_tolerance] The comment's overall quality, on the 1-5 quality rubric: the level sets the lowest quality score accepted (permissive and relaxed 2, standard 3, strict 4, zero_tolerance 5). off leaves quality out of comment health. |
|
| spam_check object — OPTIONALSchema for spam check result. Spam is decided by first-pass screening alone, with three outcomes: spam (is_spam true: delete it), suspected spam (suspected_spam true: send it back to the commenter with the suggestion), or not spam (both false: publish it). reasoning stringHow the verdict was reached. "Classified as spam by first-pass screening." for spam; "Not checked for spam: screening was unavailable." when screening gave no answer; empty otherwise. | confidence numberPossible values: value ≤ 1 Confidence (0-1) in the verdict given: in spam when is_spam is true, in not spam when it is false. 0 when the comment was not screened. | is_spam booleanTrue if the comment is spam (screen probability 0.85 or above) and should be deleted; false otherwise, including for suspected spam. | suspected_spam boolean — OPTIONALTrue if the comment looks like spam but not surely (screen probability 0.50 up to 0.85). It is not spam and should not be deleted: send it back to the commenter with the suggestion, as for a comment that needs revision. Always false when is_spam is true. | suggestion string — OPTIONALA short message for the commenter of a suspected-spam comment, saying what to change: "This looks like spam. How about removing the link?" when the comment contains a link, otherwise "This reads like promotion. How about saying what you think about the discussion?". Empty unless suspected_spam is true. |
| relevance_check object — OPTIONALSchema for comment relevance evaluation, including on-topic assessment and banned topics check. on_topic objectHolds data about the on-topic (relevance) assessment. reasoning stringShort explanation of why this comment was or was not regarded as on-topic. | on_topic booleanIndicates if the comment is considered on-topic. True if it is; false if it is not on-topic / relevant. | confidence numberConfidence score (0-1) for the on-topic evaluation. |
| banned_topics objectHolds data about the off-topic (banned topics) assessment. reasoning stringShort explanation of why the comment was assessed as, or not, being about topics that are off-topic. | banned_topics string[]List of off-topic topics detected. | quantity_on_banned_topics numberA score representing the extent of the off-topic content in the comment: 0-1, where 0.5 is that about half the comment was about a topic that was flagged. | confidence numberConfidence score (0-1) for the off-topic evaluation. |
|
| dogwhistle_check object — OPTIONALSchema for dogwhistle detection results, including analysis reasoning and detailed findings. detection objectMain detection results and analysis. reasoning stringExplanation of the analysis and reasoning behind the detection. | dogwhistles_detected booleanWhether dogwhistles were found in the comment. | confidence numberPossible values: value ≤ 1 Confidence level of the detection (0.0 to 1.0). |
| details object — OPTIONALOptional detailed information about detected dogwhistles. dogwhistle_terms string[] — OPTIONALSpecific terms or phrases detected as potential dogwhistles. | categories string[] — OPTIONALCategories or types of dogwhistles detected. | subtlety_level number — OPTIONALPossible values: value ≤ 1 How subtle the dogwhistles are (0.0 = obvious, 1.0 = very subtle). | harm_potential number — OPTIONALPossible values: value ≤ 1 Potential harm level of the detected content (0.0 = low, 1.0 = high). |
|
| perspective — OPTIONAL |
|