wingbot 3.67.22 → 3.67.25

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wingbot",
-  "version": "3.67.22",
+  "version": "3.67.25",
   "description": "Enterprise Messaging Bot Conversation Engine",
   "main": "index.js",
   "type": "commonjs",

package/src/Ai.js

@@ -553,9 +553,15 @@ class Ai {
         };
     }
 
-    ruleIsMatching (intent, req, stateless = false) {
+    ruleIsMatching (intent, req, stateless = false, noEntityThreshold = false) {
         const rules = this.matcher.preprocessRule(intent);
-        const winningIntent = this.matcher.match(req, rules, stateless);
+        const winningIntent = this.matcher.match(
+            req,
+            rules,
+            stateless,
+            undefined,
+            noEntityThreshold
+        );
 
         if (!winningIntent || winningIntent.score < this.threshold) {
             return null;

package/src/AiMatching.js

@@ -467,9 +467,10 @@ class AiMatching {
      * @param {PreprocessorOutput} rule
      * @param {boolean} [stateless]
      * @param {Entity[]} [reqEntities]
+     * @param {boolean} [noEntityThreshold]
      * @returns {Intent|null}
      */
-    match (req, rule, stateless = false, reqEntities = req.entities) {
+    match (req, rule, stateless = false, reqEntities = req.entities, noEntityThreshold = false) {
         const { regexps, intents, entities } = rule;
 
         const noIntentHandicap = req.intents.length === 0 ? 0 : this.redundantIntentHandicap;
@@ -510,7 +511,10 @@ class AiMatching {
                     textLength,
                     entities,
                     reqEntities,
-                    useState
+                    useState,
+                    undefined,
+                    undefined,
+                    noEntityThreshold
                 );
 
             const allOptional = entities.every((e) => e.optional
@@ -576,7 +580,8 @@ class AiMatching {
                             requestIntent,
                             entities,
                             req,
-                            useState
+                            useState,
+                            noEntityThreshold
                         );
 
                     if (score > max) {
@@ -610,6 +615,7 @@ class AiMatching {
      * @param {EntityExpression[]} wantedEntities
      * @param {AIRequest} req
      * @param {object} useState
+     * @param {boolean} [noEntityThreshold]
      * @returns {{score:number,entities:Entity[]}}
      */
     _intentMatchingScore (
@@ -618,7 +624,8 @@ class AiMatching {
         requestIntent,
         wantedEntities,
         req,
-        useState
+        useState,
+        noEntityThreshold = false
     ) {
         if (wantedIntent !== requestIntent.intent) {
             return { score: 0, entities: [] };
@@ -644,7 +651,8 @@ class AiMatching {
                 requestIntent.entities
                     ? (x) => Math.atan((x - 0.76) * 40) / Math.atan((1 - 0.76) * 40)
                     : (x) => x,
-                req.entities
+                req.entities,
+                noEntityThreshold
             );
 
         // eslint-disable-next-line max-len,object-curly-newline
@@ -680,7 +688,8 @@ class AiMatching {
      * @param {Entity[]} requestEntities
      * @param {object} [requestState]
      * @param {Function} [scoreFn]
-     * @param {Entity[]} allEntities
+     * @param {Entity[]} [allEntities]
+     * @param {boolean} [noEntityThreshold]
      *
      * @returns {EntityMatchingResult}
      */
@@ -690,7 +699,8 @@ class AiMatching {
         requestEntities = [],
         requestState = {},
         scoreFn = (x) => x,
-        allEntities = requestEntities
+        allEntities = requestEntities,
+        noEntityThreshold = false
     ) {
         const occurences = new Map();
 
@@ -713,7 +723,7 @@ class AiMatching {
                 .findIndex((e, i) => {
                     if (e.entity !== wanted.entity
                         || usedIndexes.includes(i)
-                        || e.score < ENTITY_OK) {
+                        || (!noEntityThreshold && e.score < ENTITY_OK)) {
                         return false;
                     }
                     entityExists = true;

package/src/BotApp.js

@@ -166,24 +166,33 @@ class BotApp {
              * @param {Responder} res
              */
             afterProcessMessage (req, res) {
-                const wasSet = req.getSetContext(true);
-                const updatedVariables = Object.keys(res.newState)
-                    .filter((key) => key.match(/^§/) && wasSet[key] !== res.newState[key]);
-
-                if (updatedVariables.length !== 0) {
-                    const setContext = updatedVariables
-                        .reduce((o, key) => Object.assign(o, {
-                            [key.replace(/^§/, '')]: res.newState[key]
-                        }), {});
-
-                    res.send({
-                        set_context: setContext
-                    });
-                }
+                BotApp.sendContext(req, res);
             }
         };
     }
 
+    /**
+     *
+     * @param {Request} req
+     * @param {Responder} res
+     */
+    static sendContext (req, res) {
+        const wasSet = req.getSetContext(true);
+        const updatedVariables = Object.keys(res.newState)
+            .filter((key) => key.match(/^§/) && wasSet[key] !== res.newState[key]);
+
+        if (updatedVariables.length !== 0) {
+            const setContext = updatedVariables
+                .reduce((o, key) => Object.assign(o, {
+                    [key.replace(/^§/, '')]: res.newState[key]
+                }), {});
+
+            res.send({
+                set_context: setContext
+            });
+        }
+    }
+
     /**
      * Get the processor instance
      *

package/src/OrchestratorClient.js

@@ -6,6 +6,9 @@
 const { withParams } = require('webalize');
 const { default: fetch, Headers } = require('node-fetch');
 const BotAppSender = require('./BotAppSender');
+const extractText = require('./transcript/extractText');
+
+/** @typedef {import('./transcript/transcriptFromHistory').Transcript} Transcript */
 
 /**
  * @typedef OrchestratorClientOptions
@@ -60,7 +63,131 @@ class OrchestratorClient {
             expirationInSeconds,
             conversationToken
         };
+    }
+
+    /**
+     * @returns {Promise<Transcript[]>}
+     */
+    async getTranscript () {
+        const events = await this.getChatHistory();
+
+        return events
+            .map((e) => {
+                const text = extractText(e);
+
+                return {
+                    fromBot: e.sender
+                        ? e.sender.id !== this._senderId
+                        : e.recipient.id === this._senderId,
+                    text
+                };
+            })
+            .filter((ret) => !!ret.text);
+    }
+
+    /**
+     *
+     * @returns {Promise<object[]>}
+     */
+    async getChatHistory () {
+        const res = await this._send({
+            query: `query FetchHistory (
+                $pageId: String!
+                $senderId: String!
+            ) {
+                chat {
+                    history (
+                        pageId: $pageId,
+                        senderId: $senderId
+                    ) {
+                        events {
+                            sender {
+                                id
+                            }
+                            recipient {
+                                id
+                            }
+                            mid
+                            timestamp
+                            sender_action
+                            set_context
+                            postback {
+                                payload
+                                title
+                            }
+                            expected {
+                                input {
+                                    type
+                                }
+                            }
+                            persona {
+                                name
+                                profile_pic_url
+                            }
+                            message {
+                                text
+                                is_confident
+                                attachments {
+                                    type
+                                    payload {
+                                        url
+                                        template_type
+                                        image_aspect_ratio
+                                        text
+                                        buttons {
+                                            type
+                                            title
+                                            payload
+                                            url
+                                        }
+                                        elements {
+                                            default_action {
+                                                type
+                                                title
+                                                payload
+                                                url
+                                            }
+                                            title
+                                            subtitle
+                                            image_url
+                                            buttons {
+                                                type
+                                                title
+                                                payload
+                                                url
+                                            }
+                                        }
+                                    }
+                                }
+                                quick_replies {
+                                    content_type
+                                    title
+                                    payload
+                                }
+                            }
+                        }
+                        nextStartAt
+                        nextEndAt
+                    }
+                }
+            }`,
+            variables: {
+                senderId: this._senderId,
+                pageId: this._pageId
+            }
+        });
+
+        if (res.errors && res.errors[0]) {
+            throw new Error(res.errors[0].message);
+        }
+
+        const events = (res.data
+            && res.data
+            && res.data.chat
+            && res.data.chat.history
+            && res.data.chat.history.events) || [];
 
+        return events;
     }
 
     /**

package/src/Request.js

@@ -1649,7 +1649,7 @@ It looks like the bot isn't connected to class BotApp or the Processor is used w
         entity,
         value,
         score = 1,
-        entityScore = Math.max(score, 0.8),
+        entityScore = Math.max(score, 0.835),
         timestamp = makeTimestamp()
     ) {
         const res = Request.text(senderId, text, timestamp);

package/src/Tester.js

@@ -461,13 +461,21 @@ class Tester {
      * @param {string} [value]
      * @param {string} [text]
      * @param {number} [score]
+     * @param {number} [entityScore]
      * @returns {Promise}
      *
      * @memberOf Tester
      */
-    intentWithEntity (intent, entity, value = entity, text = intent, score = 1) {
+    intentWithEntity (
+        intent,
+        entity,
+        value = entity,
+        text = intent,
+        score = 1,
+        entityScore = score
+    ) {
         return this.processMessage(Request
-            .intentWithEntity(this.senderId, text, intent, entity, value, score));
+            .intentWithEntity(this.senderId, text, intent, entity, value, score, entityScore));
     }
 
     /**

package/src/fuzzy/factoryFuzzySearch.js

@@ -41,7 +41,7 @@ function getIndexesToIterate (ngrams, tfEntry) {
 function searchFnFactory (indexMap, ngramCounts, entities, maxIdf, {
     stemmer = null,
     keepMultipleValues = false,
-    threshold = 0.79,
+    threshold = 0.835,
     limit = undefined
 }, hasFuzzyMultiplier = false) {
     /** @type {WordEntityDetector} */

package/plugins/ai.wingbot.clearMessageSequences/README.md

@@ -1 +0,0 @@
-> This plugin erases state of conversational sequences

package/plugins/ai.wingbot.conditionIfGoBackPossible/README.md

@@ -1,7 +0,0 @@
-> This plugin helps you to hide "back" quick reply, when there is no interaction to go.
-
-Put it as a condition to quick reply and it will be only visible, when there is an interaction to go back to.
-
-Use it in combination with the **Go back to previous interaction** plugin.
-
-![go back condition](https://github.com/wingbotai/wingbot/raw/master/plugins/ai.wingbot.conditionIfGoBackPossible/back.png)

package/plugins/ai.wingbot.disambiguation/README.md

@@ -1,12 +0,0 @@
-> Disambiguation is useful, when the bot has lot of very similar intents. When more than one intent is detected, users can decide, what was their intention.
-
-How to set up the disambiguation.
-
-1. Put this plugin into a fallback
-2. Set up the disambiguation message (disambiguation options will be added to the message as quick replies)
-3. Put a regular "fallback" message behind this plugin. If the disambiguation will not occur, your bot will answer with this fallback message
-4. Add a disambiguation title to all interactions, which you want to disambiguate
-
-To fine tune the disambiguation, you can also set up a custom `ai.threshold` on bot (there is `0.3` by default). Detected intent has to reach this minimum score, to be disambiguated.
-
-![disambiguation](https://github.com/wingbotai/wingbot/raw/master/plugins/ai.wingbot.disambiguation/disambiguation.png)

package/plugins/ai.wingbot.goBack/README.md

@@ -1,9 +0,0 @@
-> This plugin helps you to drive user back to previous interaction.
-
-If the previous interaction exists and it's not a fallback or the same interaction, where the plugin is, the bot will go back and stops executing this interaction.
-
-If not, the bot will continue in execution of this interaction, so you can handle situation.
-
-It's useful to  it use **Show when there is a way back** condition, so you don't have to worry about handling the situation, when there's no way to go back.
-
-![go back condition](https://github.com/wingbotai/wingbot/raw/master/plugins/ai.wingbot.conditionIfGoBackPossible/back.png)

package/plugins/ai.wingbot.goToLastBreadcrumb/README.md

@@ -1,8 +0,0 @@
-> Breadcrumbs allows you to track some particular flow and make user able to return to previous steps in the flow.
-
-This is a example of using breadcrubms:
-
-1. Put breadcrumbs at checkpoints - interaction, where each step begins
-2. Allow user to get back to the previous step using a **Go to last breadcrumb** plugin.
-
-![breadcrumbs](https://github.com/wingbotai/wingbot/raw/master/plugins/ai.wingbot.putABreadcrumb/breadcrumbs.png)

package/plugins/ai.wingbot.ifImageDetected/README.md

@@ -1,10 +0,0 @@
-> This plugin helps you to react, when user randomly sends an image attachment to your bot.
-
-How to set up this plugin:
-
-1. create a new interaction in **Root dialogue** and place it before a first fallback
-2. Put the plugin on top position in this interaction
-3. Make the interaction to intercept all messages - the star icon should appear at it's top right corner
-4. Insert your reactions under the plugin
-
-![image detector](https://github.com/wingbotai/wingbot/raw/master/plugins/ai.wingbot.ifImageDetected/image.png)

package/plugins/ai.wingbot.ifStickerDetected/README.md

@@ -1,10 +0,0 @@
-> This plugin helps you to react, when user randomly sends a sticker to your bot from Facebook Messenger.
-
-How to set up this plugin:
-
-1. create a new interaction in **Root dialogue** and place it before a first fallback
-2. Put the plugin on top position in this interaction
-3. Make the interaction to intercept all messages - the star icon should appear at it's top right corner
-4. Insert your reactions under the plugin
-
-![sticker detector](https://github.com/wingbotai/wingbot/raw/master/plugins/ai.wingbot.ifStickerDetected/sticker.png)

package/plugins/ai.wingbot.jumpBack/README.md

@@ -1,9 +0,0 @@
-> This plugin helps you to drive user back to previous interaction.
-
-If the previous interaction exists and it's not a fallback or the same interaction, where the plugin is, the bot will go back and stops executing this interaction.
-
-If not, the bot will continue in execution of this interaction, so you can handle situation.
-
-It's useful to  it use **Show when there is a way back** condition, so you don't have to worry about handling the situation, when there's no way to go back.
-
-![go back condition](https://github.com/wingbotai/wingbot/raw/master/plugins/ai.wingbot.conditionIfGoBackPossible/back.png)

package/plugins/ai.wingbot.jumpTo/README.md

@@ -1,9 +0,0 @@
-> This plugin helps you to drive user back to previous interaction.
-
-If the previous interaction exists and it's not a fallback or the same interaction, where the plugin is, the bot will go back and stops executing this interaction.
-
-If not, the bot will continue in execution of this interaction, so you can handle situation.
-
-It's useful to  it use **Show when there is a way back** condition, so you don't have to worry about handling the situation, when there's no way to go back.
-
-![go back condition](https://github.com/wingbotai/wingbot/raw/master/plugins/ai.wingbot.conditionIfGoBackPossible/back.png)

package/plugins/ai.wingbot.keepInInteraction/README.md

@@ -1,12 +0,0 @@
-> Use this snippet for keeping fallback of this interaction (where the snippet is used). So the context stays in this interaction.
-
-**Most used example: Get answer from users**
-- At the interaction fallback to keep users at the interaction. Bot can give help to users and keep them in interaction.
-
-**About the snippet:**
-- The snippet is applied whenever the user gets to this point of conversation.
-- Should be used in the fallback of the interaction to keep the interaction's context.
-
-Check out the [tutorial here](http://docs.wingbot.ai/context/AnswerTheQuestion/AnswerTheQuestion.html).
-
-![keep user in interaction](https://github.com/wingbotai/wingbot/raw/master/plugins/ai.wingbot.keepInInteraction/keepInInteraction.png)

package/plugins/ai.wingbot.keepInInteractionJustOnce/README.md

@@ -1,13 +0,0 @@
-> Use this snippet for keeping fallback of this interaction (where the snippet is used). So the context stays in this interaction.
-
-**Most used example: Get answer from users**
-- At the interaction fallback to keep users at the interaction. Bot can give help to users and keep them in interaction.
-
-**About the snippet:**
-- The snippet is applied whenever the user gets to this point of conversation.
-- Should be used in the fallback of the interaction to keep the interaction's context.
-- This is done just once.
-
-Check out the [tutorial here](http://docs.wingbot.ai/context/AnswerTheQuestion/AnswerTheQuestion.html).
-
-![keep user in interaction](https://github.com/wingbotai/wingbot/raw/master/plugins/ai.wingbot.keepInInteraction/keepInInteractionJustOnce.png)

package/plugins/ai.wingbot.keepPreviousHandlers/README.md

@@ -1,17 +0,0 @@
-> Lock users in interaction, until they reply as you wish.
-
-**Most used example: Get answer from users with the same options of answers**
-- At the interaction fallback to keep users at the interaction. Bot can give help to users and keep them in interaction.
-- This snippet keeps previous NLP handlers.
-> This snippet is very similar to previous snippet Keep user in this interaction (use it as a fallback)]. The difference is you don't need to set NLP handlers.
-
-**About the snippet:**
-- Keeps previous NLP handlers and fallback.
-- Where to use:
-    - At the dialogue or global fallbacks - keep NLP handlers and fallback from previous interactions.
-    - At the interaction fallback - keep NLP handlers and fallback from this interaction (they are used again)
-- The snippet is applied whenever the user gets to this point of conversation.
-
-**Take a look how to use this snippet:** [here](http://docs.wingbot.ai/context/AnswerTheQuestion/AnswerTheQuestion.html)
-
-![keep previous handlers](https://github.com/wingbotai/wingbot/raw/master/plugins/ai.wingbot.keepPreviousHandlers/image1.gif)

package/plugins/ai.wingbot.keepPreviousHandlersJustOnce/README.md

@@ -1,15 +0,0 @@
-> Give users a chance to correct their answers (at least just once)
-
-**Most used example: Give user chance to correct answer in fallback**
-- At the dialogue or global fallback to keep the context of previous interaction just once. So the users can correct their reaction to chatbot's utterance.
-
-**About the snippet:**
-- The snippet keeps previous NLP handlers and fallback.
-- Where to use:
-    - At the dialogue or global fallbacks - keep NLP handlers and fallback from a previous interaction.
-    - At the interaction fallback - keep NLP handlers and fallback from this interaction (they are used again).
-- This is done just once.
-
-**Take a look how to use this snippet:** [here](http://docs.wingbot.ai/context/ChanceToCorrectAnswer/ChanceToCorrectAnswer.html)
-
-![keep previous handlers](https://github.com/wingbotai/wingbot/raw/master/plugins/ai.wingbot.keepPreviousHandlersJustOnce/image1.png)

package/plugins/ai.wingbot.oneTimeNotificationRequest/README.md

@@ -1,5 +0,0 @@
-> To be able to use Facebook's one-time notification, user has to make opt-in using a one-time notification request.
-
-More here, [at Facebook Messenger Docs](https://developers.facebook.com/docs/messenger-platform/send-messages/one-time-notification/)
-
-![one time notification](https://github.com/wingbotai/wingbot/raw/master/plugins/ai.wingbot.oneTimeNotificationRequest/notification.png)

package/plugins/ai.wingbot.openai/README.md

@@ -1 +0,0 @@
-> This plugin allows you to use chatGPT

package/plugins/ai.wingbot.passThreadToBot/README.md

@@ -1,19 +0,0 @@
-> One of base pillars of masterbot architecture
-
-## Passing thread to another bot
-
-The action is determined by metadata JSON string.
-
-1. **Pass thread with text (leave action and intent fields empty)**
-
-	Let the target bot's NLP to decide.
-
-2. **Pass thread to specific action**
-
-	Target bot will response with a predefined interaction
-
-3. **Trigger a specific intent at a target bot**
-
-	Intent will be enforced at target bot
-
-![pass thread to bot](https://github.com/wingbotai/wingbot/raw/master/plugins/ai.wingbot.passThreadToBot/passThreadToBot.png)

package/plugins/ai.wingbot.putABreadcrumb/README.md

@@ -1,8 +0,0 @@
-> Breadcrumbs allows you to track some particular flow and make user able to return to previous steps in the flow.
-
-This is a example of using breadcrubms:
-
-1. Put breadcrumbs at checkpoints - interaction, where each step begins
-2. Allow user to get back to the previous step using a **Go to last breadcrumb** plugin.
-
-![breadcrumbs](https://github.com/wingbotai/wingbot/raw/master/plugins/ai.wingbot.putABreadcrumb/breadcrumbs.png)

package/plugins/ai.wingbot.regexp/README.md

@@ -1 +0,0 @@
-> This plugin detects reqular expressions

package/plugins/ai.wingbot.setState/README.md

@@ -1 +0,0 @@
-> This plugin has been replaced with native UI.

package/plugins/ai.wingbot.setStateFromInput/README.md

@@ -1 +0,0 @@
-> This plugin has been replaced with native UI.

package/plugins/ai.wingbot.stopResponding/README.md

@@ -1,7 +0,0 @@
-> This plugin allows bot to just **send no response**
-
-This is useful, when you want to override the default behavior of wingbot - because **when there is no response message in an interaction, users request will fall into a fallback.
-
-Following example shows, how to use this plugin to keep following users response without reaction. Second users attempt will be processed as usual.
-
-![stop responding](https://github.com/wingbotai/wingbot/raw/master/plugins/ai.wingbot.stopResponding/noop.png)

package/plugins/ai.wingbot.trackingEvent/README.md

@@ -1,3 +0,0 @@
-# Track analytic event
-
-This plugin lets you easily track any analytics informations

package/plugins/ai.wingbot.waitASecond/README.md

@@ -1,5 +0,0 @@
-> Just to make change a rythm of conversation.
-
-This snippet will make a small delay between two messages.
-
-![wait](https://github.com/wingbotai/wingbot/raw/master/plugins/ai.wingbot.waitASecond/wait.png)