node-nlp

<!doctype html> <html lang="en"> <head> <title>Code coverage report for lib/recognizer/recognizer.js</title> <meta charset="utf-8" /> <link rel="stylesheet" href="..\..\prettify.css" /> <link rel="stylesheet" href="..\..\base.css" /> <meta name="viewport" content="width=device-width, initial-scale=1"> <style type='text/css'> .coverage-summary .sorter { background-image: url(..\..\sort-arrow-sprite.png); } </style> </head> <body> <div class='wrapper'> <div class='pad1'> <h1> <a href="..\..\index.html">All files</a> / <a href="index.html">lib/recognizer</a> recognizer.js </h1> <div class='clearfix'> <div class='fl pad1y space-right2'> 75.89% Statements 85/112 </div> <div class='fl pad1y space-right2'> 77.33% Branches 58/75 </div> <div class='fl pad1y space-right2'> 73.33% Functions 22/30 </div> <div class='fl pad1y space-right2'> 75.89% Lines 85/112 </div> </div> </div> <div class='status-line medium'></div> <pre><table class="coverage"> <tr><td class="line-count quiet">1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323</td><td class="line-coverage quiet">                                              31x 31x                     26x 26x     26x 26x               2x               9x               2x               2x 2x 2x                     19x 19x     19x 2x 2x   17x 21x 21x   17x 6x   11x   17x                   2x           2x                 14x 12x   2x 2x 5x 5x 1x     1x       14x 14x 13x 13x 13x     11x 11x 11x 11x 11x   11x   11x     2x 2x   13x     1x                                             1x                 14x 14x                                     3x     2x 2x 1x 1x 1x   1x     1x   1x   1x                       4x         4x 1x   3x                 2x 1x   1x                       3x 3x 1x   2x   2x 2x     2x 1x 1x                         1x           1x     1x     1x   1x         31x  </td><td class="text"><pre class="prettyprint lang-js">/* * Copyright (c) AXA Shared Services Spain S.A. * * Permission is hereby granted, free of charge, to any person obtaining * a copy of this software and associated documentation files (the * "Software"), to deal in the Software without restriction, including * without limitation the rights to use, copy, modify, merge, publish, * distribute, sublicense, and/or sell copies of the Software, and to * permit persons to whom the Software is furnished to do so, subject to * the following conditions: * * The above copyright notice and this permission notice shall be * included in all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */   const { NlpManager } = require('../nlp'); const MemoryConversationContext = require('./memory-conversation-context');   /** * Microsoft Bot Framework compatible recognizer for nlp.js. */ class Recognizer { /** * Constructor of the class. * @param {Object} settings Settings for the instance. */ constructor(settings) { this.settings = settings || {}; this.nlpManager = this.settings.nlpManager || new NlpManager({ ner: { threshold: this.settings.nerThreshold || 0.7 } }); this.threshold = this.settings.threshold || 0.7; this.conversationContext = this.settings.conversationContext || new MemoryConversationContext(); }   /** * Train the NLP manager. */ async train() { await this.nlpManager.train(); }   /** * Loads the model from a file. * @param {String} filename Name of the file. */ load(filename) { this.nlpManager.load(filename); }   /** * Saves the model into a file. * @param {String} filename Name of the file. */ save(filename) { this.nlpManager.save(filename); }   /** * Loads the NLP manager from an excel. * @param {String} filename Name of the file. */ async loadExcel(filename) { this.nlpManager.loadExcel(filename); await this.train(); this.save(); }   /** * Process an utterance using the NLP manager. This is done using a given context * as the context object. * @param {Object} srcContext Source context * @param {String} locale Locale of the utterance. * @param {Promise.String} Promise utterance Utterance to be recognized. */ async process(srcContext, locale, utterance) { const context = srcContext || {}; const response = await (locale ? this.nlpManager.process(locale, utterance, context) : this.nlpManager.process(utterance, undefined, context)); if (response.score < this.threshold || response.intent === 'None') { response.answer = undefined; return response; } for (let i = 0; i < response.entities.length; i += 1) { const entity = response.entities[i]; context[entity.entity] = entity.option; } if (response.slotFill) { context.slotFill = response.slotFill; } else { delete context.slotFill; } return response; }   /** * Given an utterance and the locale, returns the recognition of the utterance. * @param {String} utterance Utterance to be recognized. * @param {String} model Model of the utterance. * @param {Function} cb Callback Function. */ async recognizeUtterance(utterance, model, cb) { const response = await this.process( model, model ? model.locale : undefined, utterance, {} ); return cb(null, response); }   /** * Gets the last developer (not framework) dialogId on the stack. * @param {Object} session Microsoft bot framework session. * @returns {string} Last dialog id. */ getDialogId(session) { if (!session.dialogStack) { return ''; } const stack = session.dialogStack(); for (let i = 0; i < stack.length; i += 1) { const dialogId = stack[i]; if (dialogId.startsWith('*:')) { return dialogId.substring(2); } } return ''; }   innerRecognize(session, cb) { const result = { score: 0.0, intent: undefined }; if (session && session.message && session.message.text) { const utterance = session.message.text; const { locale } = session; this.conversationContext .getConversationContext(session) .then(async srcContext => { const context = srcContext; context.dialogId = this.getDialogId(session); const processResult = await this.process(context, locale, utterance); context.lastRecognized = processResult; this.conversationContext .setConversationContext(session, context) .then(() => cb(null, processResult)) .catch(() => cb(null, processResult)); return undefined; }) .catch(async () => { const processResult = await this.process({}, locale, utterance); return cb(null, processResult); }); return undefined; } // eslint-disable-next-line no-underscore-dangle Iif (session && session._activity && session._activity.type === 'message') { // eslint-disable-next-line no-underscore-dangle const message = session._activity; const utterance = message.text; const { locale } = message; this.conversationContext .getConversationContext(session) .then(async srcContext => { const context = srcContext; const processResult = await this.process(context, locale, utterance); context.lastRecognized = processResult; this.conversationContext .setConversationContext(session, context) .then(() => cb(null, processResult)) .catch(() => cb(null, processResult)); return undefined; }) .catch(async () => { const processResult = await this.process({}, locale, utterance); return cb(null, processResult); }); return undefined; } return cb(null, result); }   /** * Given a session of a chatbot containing a message, recognize the utterance in the message. * @param {Object} session Chatbot session of the message. * @param {Function} cb Callback function. */ recognize(session, cb) { Eif (cb) { return this.innerRecognize(session, cb); } return new Promise((resolve, reject) => { this.innerRecognize(session, (err, result) => { if (err) { return reject(err); } return resolve(result); }); }); }   /** * Given a session of a chatbot containing a message, recognize for second time * the utterance in the message. * @param {Object} session Chatbot session of the message. * @param {Function} cb Callback function. */ recognizeTwice(session, cb) { this.conversationContext .getConversationContext(session) .then(async srcContext => { const context = srcContext; if (context.lastRecognized) { const processResult = context.lastRecognized; delete context.lastRecognized; this.conversationContext .setConversationContext(session, context) .then(() => cb(null, processResult)) .catch(() => cb(null, processResult)); } else { return this.recognize(session, cb); } return undefined; }) .catch(async () => this.recognize(session, cb)); }   /** * Route to a default route of the bot. First the route is calculated as the * best route based on the results and the dialog stack. If no best route exists * then is routed to the active dialog. * @param {Object} bot Microsoft Bot Framework Universal Bot instance. * @param {Object} session Microsoft bot framework session. * @param {Object} results Results for the routing. */ defaultRouting(bot, session, results) { const route = bot.libraries.BotBuilder.constructor.bestRouteResult( results, session.dialogStack(), bot.name ); if (route) { return bot.library(route.libraryName).selectRoute(session, route); } return session.routeToActiveDialog(); }   /** * When an answer is received over the threshold, decide what to do with this answer. * @param {Object} session Microsoft bot framework session. * @param {string} answer Answer given by the NLP. */ processAnswer(session, answer) { if (answer[0] === '/') { return session.beginDialog(answer); } return session.send(answer); }   /** * Sets the recognizer to a Microsoft bot framework universal bot instance. * Also, the default bot routing can be overrided and replaced by the * recognizer routing. * @param {Object} bot Microsoft Bot Framework Universal Bot instance. * @param {boolean} activateRouting True if default routing should be overrided. * @param {number} routingThreshold Threshold for the score of the intent. */ setBot(bot, activateRouting = false, routingThreshold = 0.7) { bot.recognizer(this); if (!activateRouting) { return; } const self = this; // eslint-disable-next-line no-underscore-dangle, no-param-reassign bot._onDisambiguateRoute = function disambiguate(session, results) { Iif (self.onBeginRouting && !self.onBeginRouting(session)) { return undefined; } if (session.message && session.message.text) { self.recognizeTwice(session, (err, result) => { Iif ( result.score > routingThreshold && result.answer && result.answer !== '' ) { if ( self.onRecognizedRouting && !self.onRecognizedRouting(session, result) ) { return undefined; } return self.processAnswer(session, result.answer); } Iif ( self.onUnrecognizedRouting && !self.onUnrecognizedRouting(session, result) ) { return undefined; } return self.defaultRouting(bot, session, results); }); } else { Iif (self.onNoTextRouting && !self.onNoTextRouting(session)) { return undefined; } return self.defaultRouting(bot, session, results); } return undefined; }; } }   module.exports = Recognizer;  </pre></td></tr> </table></pre> <div class='push'></div> </div> <div class='footer quiet pad2 space-top1 center small'> Code coverage generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Fri Jan 25 2019 22:43:23 GMT+0100 (GMT+01:00) </div> </div> <script src="..\..\prettify.js"></script> <script> window.onload = function () { if (typeof prettyPrint === 'function') { prettyPrint(); } }; </script> <script src="..\..\sorter.js"></script> </body> </html>