bassamtantawi-misunderstood

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
+
+![image](https://user-images.githubusercontent.com/89806971/200899653-2010d62a-573d-4531-943a-49a62acd262c.png)
+
+## 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:
+
+![image](https://user-images.githubusercontent.com/89806971/200905807-5ea04e46-0550-41f5-9cb8-6fb610b9ac5d.png)
+
+### 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:
+
+![image](https://user-images.githubusercontent.com/89806971/202796242-4398de57-db26-4ca9-ba5e-99d7cc44951b.png)
+
+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:
+
+![image](https://user-images.githubusercontent.com/89806971/202796362-44de41c8-655c-435a-8b09-184d1d76c9cd.png)
+
+
+### Amend
+You can amend your intent(s) or QnA(s) utternaces with what was not understood
+
+![image](https://user-images.githubusercontent.com/89806971/200906095-72cff795-9a35-4f33-a29e-c3e828caee37.png)
+
+### Ignore
+You can choose to ignore a statement, so it is not logged again as a misunderstood
+
+![image](https://user-images.githubusercontent.com/89806971/200906493-3da3968f-ba27-4532-957c-3ecb6f2d8186.png)
+
+And you can also **Revert** that
+
+![image](https://user-images.githubusercontent.com/89806971/200906745-50a03933-9066-494c-83c6-edf4e12cf90b.png)
+
+
+## Misunderstood Statments Statuses
+In general the misunderstood statements are categorized in three categories:
+
+![image](https://user-images.githubusercontent.com/89806971/200909412-08005f33-d532-48e9-99bd-a16d4677b1df.png)
+
+### 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.

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/",

sidebar/misunderstood.js

@@ -0,0 +1,8 @@
+module.exports = [
+  {
+    type: "category",
+    collapsible: false,
+    label: "Misunderstood",
+    items: ["misunderstood/misunderstood"]
+  },
+]

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

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"
       });
     </script>
     <h1 style="text-align: center;">