wingbot 3.66.2 → 3.66.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wingbot",
-  "version": "3.66.2",
+  "version": "3.66.4",
   "description": "Enterprise Messaging Bot Conversation Engine",
   "main": "index.js",
   "scripts": {

package/src/Ai.js

@@ -10,8 +10,6 @@ const { deepEqual } = require('./utils/deepMapTools');
 const systemEntities = require('./systemEntities');
 const CustomEntityDetectionModel = require('./wingbot/CustomEntityDetectionModel');
 
-const DEFAULT_PREFIX = 'default';
-
 let uq = 1;
 
 /** @typedef {import('./AiMatching').Compare} Compare */
@@ -49,9 +47,15 @@ let uq = 1;
 /** @typedef {import('./wingbot/CustomEntityDetectionModel').Phrases} Phrases */
 /** @typedef {import('./wingbot/CustomEntityDetectionModel').EntityDetector} EntityDetector */
 /** @typedef {import('./wingbot/CustomEntityDetectionModel').DetectorOptions} DetectorOptions */
+/** @typedef {import('./wingbot/CustomEntityDetectionModel').Entity} Entity */
 // eslint-disable-next-line max-len
 /** @typedef {import('./wingbot/CustomEntityDetectionModel').WordEntityDetector} WordEntityDetector */
 
+/**
+ * @callback WordEntityDetectorFactory
+ * @returns {Promise<WordEntityDetector>}
+ */
+
 /** @typedef {[string,EntityDetector|RegExp,DetectorOptions]} DetectorArgs */
 
 /**
@@ -76,7 +80,13 @@ class Ai {
 
         /**
          * @private
-         * @type {WordEntityDetector}
+         * @type {WordEntityDetectorFactory}
+         */
+        this._wordEntityDetectorFactory = null;
+
+        /**
+         * @private
+         * @type {WordEntityDetector|Promise<WordEntityDetector>}
          */
         this._wordEntityDetector = null;
 
@@ -140,6 +150,37 @@ class Ai {
          * @type {AiMatching}
          */
         this.matcher = new AiMatching(this);
+
+        /**
+         * @type {string}
+         */
+        this.DEFAULT_PREFIX = 'default';
+    }
+
+    /**
+     *
+     * @param {string} text
+     * @param {string|Request} prefix
+     * @returns {Promise<Entity[]>}
+     */
+    async detectEntities (text, prefix = this.DEFAULT_PREFIX) {
+        let model;
+
+        if (typeof prefix === 'string') {
+            model = this._keyworders.get(prefix);
+        } else {
+            const usePrefix = this.getPrefix(this.DEFAULT_PREFIX, prefix);
+            model = this._keyworders.get(usePrefix);
+        }
+
+        if (!model) {
+            return [];
+        }
+
+        const entities = await model.resolveEntities(text);
+
+        // @ts-ignore
+        return entities;
     }
 
     /**
@@ -192,23 +233,28 @@ class Ai {
      * @returns {T}
      * @memberOf Ai
      */
-    register (model, prefix = 'default') {
+    register (model, prefix = this.DEFAULT_PREFIX) {
         /** @type {T} */
         let modelObj;
 
         if (typeof model === 'string') {
             // @ts-ignore
             modelObj = new WingbotModel({
-                model
+                model,
+                prefix
             }, this.logger);
         } else {
             // @ts-ignore
             modelObj = model;
+            modelObj.prefix = prefix;
         }
 
         this._keyworders.set(prefix, modelObj);
 
-        modelObj.wordEntityDetector = this._wordEntityDetector;
+        if (typeof this._wordEntityDetector === 'function') {
+            modelObj.wordEntityDetector = this._wordEntityDetector;
+        }
+
         for (const entityArgs of this._detectors.values()) {
             modelObj.setEntityDetector(...entityArgs);
         }
@@ -243,9 +289,15 @@ class Ai {
 
     /**
      *
-     * @param {WordEntityDetector} wordEntityDetector
+     * @param {WordEntityDetector|WordEntityDetectorFactory} wordEntityDetector
      */
     setWordEntityDetector (wordEntityDetector) {
+        if (wordEntityDetector.length === 0) {
+            // @ts-ignore
+            this._wordEntityDetectorFactory = wordEntityDetector;
+            return this;
+        }
+
         this._wordEntityDetector = wordEntityDetector;
 
         for (const model of this._keyworders.values()) {
@@ -284,7 +336,7 @@ class Ai {
      *
      * @param {string} [prefix]
      */
-    deregister (prefix = 'default') {
+    deregister (prefix = this.DEFAULT_PREFIX) {
         this._keyworders.delete(prefix);
     }
 
@@ -296,7 +348,7 @@ class Ai {
      * @returns {CustomEntityDetectionModel}
      * @memberOf Ai
      */
-    getModel (prefix = 'default') {
+    getModel (prefix = this.DEFAULT_PREFIX) {
         const model = this._keyworders.get(prefix);
         if (!model) {
             throw new Error(`Model ${prefix} not registered yet. Register the model first.`);
@@ -590,7 +642,8 @@ class Ai {
         };
     }
 
-    _getModelForRequest (req, isConfident = req.isConfidentInput(), defaultModel = DEFAULT_PREFIX) {
+    // eslint-disable-next-line max-len
+    _getModelForRequest (req, isConfident = req.isConfidentInput(), defaultModel = this.DEFAULT_PREFIX) {
         if (isConfident) {
             return null;
         }
@@ -625,6 +678,35 @@ class Ai {
         };
     }
 
+    /**
+     *
+     * @returns {Promise}
+     */
+    preloadDetectors () {
+        if (this._wordEntityDetectorFactory === null || this._wordEntityDetector) {
+            return Promise.resolve();
+        }
+
+        const promise = this._wordEntityDetectorFactory()
+            .then((detector) => {
+                this._wordEntityDetector = detector;
+                for (const model of this._keyworders.values()) {
+                    model.wordEntityDetector = detector;
+                }
+                return detector;
+            })
+            .catch((e) => {
+                // eslint-disable-next-line no-console
+                console.error('AI.preloadDetectors FAILED', e);
+                this._wordEntityDetector = null;
+            });
+
+        // @ts-ignore
+        this._wordEntityDetector = promise;
+
+        return promise;
+    }
+
     /**
      *
      * @param {Request} req
@@ -708,6 +790,7 @@ class Ai {
                 req.intents = [];
                 return;
             }
+
             await this._loadIntents(req, res, model);
         } else {
             req.intents = [];
@@ -732,6 +815,8 @@ class Ai {
             }
         }
 
+        await this.preloadDetectors();
+
         const texts = req.textAlternatives()
             .filter((alt) => alt.score >= this.sttScoreThreshold)
             .slice(0, this.sttMaxAlternatives);

package/src/Processor.js

@@ -333,6 +333,7 @@ class Processor extends EventEmitter {
 
     async _preload () {
         return Promise.all([
+            Ai.ai.preloadDetectors(),
             // @ts-ignore
             this.reducer && typeof this.reducer.preload === 'function'
                 // @ts-ignore

package/src/wingbot/CachedModel.js

@@ -33,6 +33,7 @@ class CachedModel extends CustomEntityDetectionModel {
 
     /**
      * @param {object} options
+     * @param {string} [options.prefix]
      * @param {number} [options.cacheSize]
      * @param {number} [options.cachePhrasesTime]
      * @param {{ warn: Function, error: Function, log: Function }} [log]

package/src/wingbot/CustomEntityDetectionModel.js

@@ -67,6 +67,7 @@ const { iterateThroughWords } = require('../utils/ai');
  * @param {string} text
  * @param {DetectedEntity[]} entities
  * @param {number} startIndex
+ * @param {string} prefix
  */
 
 /**
@@ -90,12 +91,15 @@ class CustomEntityDetectionModel {
 
     /**
      * @param {object} options
+     * @param {string} [options.prefix]
      * @param {{ warn: Function, error: Function, log: Function }} [log]
      */
     constructor (options, log = console) {
         this._options = options;
         this._log = log;
 
+        this.prefix = options.prefix;
+
         this._entityDetectors = new Map();
 
         /**
@@ -399,7 +403,7 @@ class CustomEntityDetectionModel {
         let entities = prevEnts.slice();
         if (this.wordEntityDetector) {
             for (const [s, startIndex] of iterateThroughWords(text, this.maxWordCount)) {
-                this.wordEntityDetector(s, entities, startIndex);
+                this.wordEntityDetector(s, entities, startIndex, this.prefix);
             }
         }
 

package/src/wingbot/WingbotModel.js

@@ -37,6 +37,7 @@ class WingbotModel extends CachedModel {
 
     /**
      * @param {object} options
+     * @param {string} [options.prefix]
      * @param {string} [options.serviceUrl]
      * @param {string} [options.trainingUrl]
      * @param {string} options.model