diff --git a/docs/misunderstood/misunderstood.md b/docs/misunderstood/misunderstood.md index fb05112..cabc04f 100644 --- a/docs/misunderstood/misunderstood.md +++ b/docs/misunderstood/misunderstood.md @@ -1,10 +1,65 @@ -Misunderstood -What it is? -How does it work? +--- +title: About Misunderstood +--- -Pending -Resolved -Ignored +# ِAbout Misunderstood +The misunderstood module holds infromation about the user messages that were misunderstood by the chatbot and it is available only for an activated bot. -Amend -Ignore +## How does it work? +The chatbot determines that it didn't understand the user in three ways: +1. Big ambiguty between two or more intents with nearly the same confidence when matching what the user said + + +2. When what the user said didn't match with any intent, a "none" intent is selected by the chatbot + + +4. When a QnA is fired, and the user clickd on the "thumbs down" emoji + + + +## Continous Learning +By checking the misunderstood module, you gurantee that your bot is continously learning and growing. +When a user input is identified as a misunderstood then we can do one of two things: + + + +### Automatic Utterance Clustering +In order to make it easier for our builder (conversation designers, developers, etc.) we have added a new functionality in the misunderstood module, which is the automatic utterance clustering. When a builder click an utterance to take a decision about, the user statements are reordered to push all the matching/similar statements to the one the builder have chose. + +So for example, below are the misunerstood statements: + + + +We can see, food related statements are in the middle, when we select one of them, it is pushed up to the top along with other matching/similar statements: + + + + +### Amend +You can amend your intent(s) or QnA(s) utternaces with what was not understood + + + +### Ignore +You can choose to ignore a statement, so it is not logged again as a misunderstood + + + +And you can also **Revert** that + + + + +## Misunderstood Statments Statuses +In general the misunderstood statements are categorized in three categories: + + + +### Pending +Contains all the statements that are not processed yet, not ignored or amended to an intent or a QnA + +### Resolved +Contains all the statements that are amended either to an intent or a QnA + +### Ignored +Contains all the statements that are marked to by Ignored. diff --git a/docusaurus.config.js b/docusaurus.config.js index 9a066bd..c51809c 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -98,6 +98,12 @@ const config = { docId: "analytics/analytics", position: "left", label: "Analytics", + }, + { + type: "doc", + docId: "misunderstood/misunderstood", + position: "left", + label: "Misunderstood", }, { type: "docsVersionDropdown", @@ -134,6 +140,10 @@ const config = { label: "Analytics", to: "analytics/", }, + { + label: "Misunderstood", + to: "misunderstood/misunderstood", + }, { label: "v12 Docs", href: "https://v12.botpress.com/", diff --git a/sidebar/misunderstood.js b/sidebar/misunderstood.js new file mode 100644 index 0000000..6bda6f6 --- /dev/null +++ b/sidebar/misunderstood.js @@ -0,0 +1,8 @@ +module.exports = [ + { + type: "category", + collapsible: false, + label: "Misunderstood", + items: ["misunderstood/misunderstood"] + }, +] diff --git a/sidebar/sidebar.js b/sidebar/sidebar.js index c1088ee..c4b9475 100644 --- a/sidebar/sidebar.js +++ b/sidebar/sidebar.js @@ -6,6 +6,7 @@ const quickstart = require("./quickstart") // const goingToProduction = require("./goingToProduction") const messaging = require("./messaging") const analytics = require("./analytics") +const misunderstood = require("./misunderstood") // const chatbotManagement = require("./chatbotManagement") // const enterprise = require("./enterprise") const fm = require("front-matter") @@ -75,6 +76,7 @@ function filterDraftPages(sidebar) { } module.exports = { + misunderstoodSidebar: misunderstood, analyticsSidebar: analytics, messagingSidebar: filterDraftPages(messaging), quickstartSidebar: quickstart diff --git a/static/img/botpress_chatbot.html b/static/img/botpress_chatbot.html index 106eced..336ea55 100644 --- a/static/img/botpress_chatbot.html +++ b/static/img/botpress_chatbot.html @@ -16,7 +16,8 @@ "clientId": "822ad2f6-f206-48bb-b7ba-f0052aa56ef1", "botName": "Learn Botpress", "botConversationDescription": "A bot with a simple workflow made for learning Botpress.", - "locale": "en" + "locale": "en", + "extraStylesheet":"https://bpweb.sebastienburon.com/cssTheme/dark.css" });