botium-core 1.15.5 → 1.15.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "botium-core",
-  "version": "1.15.5",
+  "version": "1.15.6",
   "description": "The Selenium for Chatbots",
   "main": "index.js",
   "module": "dist/botium-es.js",

package/src/Capabilities.js

@@ -104,6 +104,13 @@ module.exports = {
   SIMPLEREST_INBOUND_ORDER_UNSETTLED_EVENTS_JSONPATH: 'SIMPLEREST_INBOUND_ORDER_UNSETTLED_EVENTS_JSONPATH',
   SIMPLEREST_INBOUND_DEBOUNCE_TIMEOUT: 'SIMPLEREST_INBOUND_DEBOUNCE_TIMEOUT',
   SIMPLEREST_COOKIE_REPLICATION: 'SIMPLEREST_COOKIE_REPLICATION',
+  SIMPLEREST_NLP_INTENT_JSONPATH: 'SIMPLEREST_NLP_INTENT_JSONPATH',
+  SIMPLEREST_NLP_CONFIDENCE_JSONPATH: 'SIMPLEREST_NLP_CONFIDENCE_JSONPATH',
+  SIMPLEREST_NLP_CONFIDENCE_DIVIDEBY100: 'SIMPLEREST_NLP_CONFIDENCE_DIVIDEBY100',
+  SIMPLEREST_NLP_FALLBACK_INTENTS: 'SIMPLEREST_NLP_FALLBACK_INTENTS',
+  SIMPLEREST_NLP_LIST_JSONPATH: 'SIMPLEREST_NLP_LIST_JSONPATH',
+  SIMPLEREST_NLP_LIST_INTENT_JSONPATH: 'SIMPLEREST_NLP_LIST_INTENT_JSONPATH',
+  SIMPLEREST_NLP_LIST_CONFIDENCE_JSONPATH: 'SIMPLEREST_NLP_LIST_CONFIDENCE_JSONPATH',
   // Script Compiler
   SCRIPTING_TXT_EOL: 'SCRIPTING_TXT_EOL',
   // ROW_PER_MESSAGE or QUESTION_ANSWER

package/src/containers/plugins/SimpleRestContainer.js

@@ -496,6 +496,76 @@ module.exports = class SimpleRestContainer {
         })
         debug(`found response cards: ${util.inspect(cards)}`)
 
+        let nlp = { intent: {} }
+        const _normalizeIntent = (intent) => {
+          if ('name' in intent) {
+            if (!intent.name) {
+              intent.name = 'None'
+            }
+            const fallbackIntents = this.caps[Capabilities.SIMPLEREST_NLP_FALLBACK_INTENTS]
+            if (fallbackIntents) {
+              intent.incomprehension = this.caps[Capabilities.SIMPLEREST_NLP_FALLBACK_INTENTS].includes(intent.name) ? true : undefined
+            } else {
+              intent.incomprehension = intent.name.toLowerCase() === 'none' ? true : undefined
+            }
+          }
+
+          if (!_.isNil(intent.confidence)) {
+            if (typeof intent.confidence === 'string') {
+              intent.confidence = Number(intent.confidence)
+            }
+            if (_.isNil(this.caps[Capabilities.SIMPLEREST_NLP_CONFIDENCE_DIVIDEBY100]) ? intent.confidence > 1 : this.caps[Capabilities.SIMPLEREST_NLP_CONFIDENCE_DIVIDEBY100]) {
+              intent.confidence /= 100
+            }
+          }
+
+          return intent
+        }
+        const jsonPathIntent = this.caps[Capabilities.SIMPLEREST_NLP_INTENT_JSONPATH]
+        if (jsonPathIntent) {
+          const name = jp.query(jsonPathRoot, jsonPathIntent)
+          nlp.intent.name = name?.length ? name[0] : null
+        }
+        const jsonPathConfidence = this.caps[Capabilities.SIMPLEREST_NLP_CONFIDENCE_JSONPATH]
+        if (jsonPathConfidence) {
+          const confidence = jp.query(jsonPathRoot, jsonPathConfidence)
+          nlp.intent.confidence = confidence?.length ? confidence[0] : null
+        }
+        _normalizeIntent(nlp.intent)
+        const jsonPathList = this.caps[Capabilities.SIMPLEREST_NLP_LIST_JSONPATH]
+        const jsonPathListIntent = this.caps[Capabilities.SIMPLEREST_NLP_LIST_INTENT_JSONPATH]
+        const jsonPathListConfidence = this.caps[Capabilities.SIMPLEREST_NLP_LIST_CONFIDENCE_JSONPATH]
+        if (jsonPathList) {
+          const list = jp.query(jsonPathRoot, jsonPathList)
+          if (list?.length) {
+            const intentList = list[0].map(e => {
+              const name = jp.query(e, jsonPathListIntent)
+              const res = { name: name?.length ? name[0] : null }
+              if (jsonPathListConfidence) {
+                const confidence = jp.query(e, jsonPathListConfidence)
+                res.confidence = confidence?.length ? confidence[0] : null
+              }
+              _normalizeIntent(res)
+              return res
+            })
+            if (intentList.length > 0 && !nlp.intent.name) {
+              nlp.intent.name = intentList[0].name
+              nlp.intent.confidence = intentList[0].confidence
+            }
+
+            if (nlp.intent.name === intentList[0].name) {
+              intentList.shift()
+            }
+
+            nlp.intent.intents = intentList
+          }
+        }
+        if (Object.keys(nlp.intent).length > 0) {
+          debug(`found response nlp: ${util.inspect(nlp)}`)
+        } else {
+          nlp = null
+        }
+
         let hasMessageText = false
         const jsonPathsTexts = getAllCapValues(Capabilities.SIMPLEREST_RESPONSE_JSONPATH, this.caps)
         for (const jsonPath of jsonPathsTexts) {
@@ -509,18 +579,18 @@ module.exports = class SimpleRestContainer {
             if (!messageText) continue
 
             hasMessageText = true
-            const botMsg = { sourceData: body, messageText, media, buttons, cards }
+            const botMsg = { sourceData: body, messageText, media, buttons, nlp }
             await executeHook(this.caps, this.responseHook, Object.assign({ botMsg, botMsgRoot: jsonPathRoot, messageTextIndex }, this.view))
             result.push(botMsg)
           }
         }
 
         if (!hasMessageText) {
-          const botMsg = { messageText: '', sourceData: body, media, buttons, cards }
+          const botMsg = { messageText: '', sourceData: body, media, buttons, cards, nlp }
           const beforeHookKeys = Object.keys(botMsg)
           await executeHook(this.caps, this.responseHook, Object.assign({ botMsg, botMsgRoot: jsonPathRoot }, this.view))
           const afterHookKeys = Object.keys(botMsg)
-          if (beforeHookKeys.length !== afterHookKeys.length || !!(botMsg.messageText && botMsg.messageText.length > 0) || botMsg.media.length > 0 || botMsg.buttons.length > 0 || botMsg.cards.length > 0 || !this.caps[Capabilities.SIMPLEREST_IGNORE_EMPTY]) {
+          if (beforeHookKeys.length !== afterHookKeys.length || !!(botMsg.messageText && botMsg.messageText.length > 0) || botMsg.media.length > 0 || botMsg.buttons.length > 0 || botMsg.cards.length > 0 || botMsg.nlp || !this.caps[Capabilities.SIMPLEREST_IGNORE_EMPTY]) {
             result.push(botMsg)
           }
         }

package/test/connectors/simplerest.spec.js

@@ -1190,6 +1190,68 @@ describe('connectors.simplerest', function () {
 
       await container.Clean()
     })
+
+    it('should extract intent and confidence', async function () {
+      const myCaps = Object.assign({}, myCapsGet, {
+        [Capabilities.SIMPLEREST_NLP_INTENT_JSONPATH]: '$.intent.intentname',
+        [Capabilities.SIMPLEREST_NLP_CONFIDENCE_JSONPATH]: '$.intent.intentconfidence'
+      })
+      const driver = new BotDriver(myCaps)
+      const container = await driver.Build()
+      assert.equal(container.pluginInstance.constructor.name, 'SimpleRestContainer')
+
+      await container.Start()
+      const msgs = await container.pluginInstance._processBodyAsyncImpl({
+        intent: {
+          intentname: 'iname',
+          intentconfidence: '50'
+        }
+      }, {}, true)
+
+      assert.equal(msgs?.length, 1)
+      assert.exists(msgs[0].nlp)
+      assert.exists(msgs[0].nlp.intent)
+      assert.equal(msgs[0].nlp.intent.name, 'iname')
+      assert.equal(msgs[0].nlp.intent.confidence, 0.5)
+
+      await container.Clean()
+    })
+
+    it('should extract intent list', async function () {
+      const myCaps = Object.assign({}, myCapsGet, {
+        [Capabilities.SIMPLEREST_NLP_LIST_JSONPATH]: '$.intents',
+        [Capabilities.SIMPLEREST_NLP_LIST_INTENT_JSONPATH]: '$.intentname',
+        [Capabilities.SIMPLEREST_NLP_LIST_CONFIDENCE_JSONPATH]: '$.intentconfidence'
+      })
+      const driver = new BotDriver(myCaps)
+      const container = await driver.Build()
+      assert.equal(container.pluginInstance.constructor.name, 'SimpleRestContainer')
+
+      await container.Start()
+      const msgs = await container.pluginInstance._processBodyAsyncImpl({
+        intents: [
+          {
+            intentname: 'iname1',
+            intentconfidence: '50'
+          },
+          {
+            intentname: 'iname2',
+            intentconfidence: 25
+          }
+        ]
+      }, {}, true)
+
+      assert.equal(msgs?.length, 1)
+      assert.exists(msgs[0].nlp)
+      assert.exists(msgs[0].nlp.intent)
+      assert.equal(msgs[0].nlp.intent.name, 'iname1')
+      assert.equal(msgs[0].nlp.intent.confidence, 0.5)
+      assert.equal(msgs[0].nlp.intent.intents.length, 1)
+      assert.equal(msgs[0].nlp.intent.intents[0].name, 'iname2')
+      assert.equal(msgs[0].nlp.intent.intents[0].confidence, 0.25)
+
+      await container.Clean()
+    })
   })
 
   describe('parseCapabilities', function () {