From 71e1b69afe788ae2efc4d79a71e52bc2ce80f0a8 Mon Sep 17 00:00:00 2001 From: immber Date: Tue, 16 Oct 2018 11:35:10 -0700 Subject: [PATCH] perspective documentation update (#1999) --- plugins/talk-plugin-toxic-comments/README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/plugins/talk-plugin-toxic-comments/README.md b/plugins/talk-plugin-toxic-comments/README.md index 60c05ad9f..6fb1849df 100644 --- a/plugins/talk-plugin-toxic-comments/README.md +++ b/plugins/talk-plugin-toxic-comments/README.md @@ -10,9 +10,11 @@ plugin: --- Using the [Perspective API](http://perspectiveapi.com/), this -plugin will warn users and reject comments that exceed the predefined toxicity -threshold. For more information on what Toxic Comments are, check out the -[Toxic Comments](/talk/toxic-comments/) documentation. +plugin will warn users when comments exceed the predefined toxicity +threshold. Toxic comments will be flagged and are held back from being posted until reviewed by a moderator. + +For more information on what Toxic Comments are, check out the +[Toxic Comments](/talk/toxic-comments/) documentation, and you can see how the plugin works on [this blog post](https://coralproject.net/blog/toxic-avenging/). Configuration: @@ -25,4 +27,4 @@ Configuration: - `TALK_PERSPECTIVE_TIMEOUT` - The timeout for sending a comment to be processed before it will skip the toxicity analysis, parsed by [ms](https://www.npmjs.com/package/ms). (Default `300ms`) -- `TALK_PERSPECTIVE_DO_NOT_STORE` - Whether the API is permitted to store comment and context from this request. Stored comments will be used for future research and community model building purposes to improve the API over time. (Default `true`) [Perspective API - Analize Comment Request](https://github.com/conversationai/perspectiveapi/blob/master/api_reference.md#analyzecomment-request) \ No newline at end of file +- `TALK_PERSPECTIVE_DO_NOT_STORE` - Whether the API stores or deletes the comment text and context from this request after it has been evaluated. Stored comments will be used for future research and community model building purposes to improve the API over time. (Default `true`) [Perspective API - Analize Comment Request](https://github.com/conversationai/perspectiveapi/blob/master/api_reference.md#analyzecomment-request)