Merge branch 'recognizer' into main

Author: Léo Guillaume

package-lock.json

@@ -59,6 +59,7 @@
     "@nlpjs/request": "^4.25.0",
     "@nlpjs/sentiment": "^4.26.1",
     "@nlpjs/similarity": "^4.26.1",
-    "@nlpjs/xtables": "^4.25.0"
+    "@nlpjs/xtables": "^4.25.0",
+    "node-nlp": "^4.26.1"
   }
 }

package.json

@@ -0,0 +1,28 @@
+/*
+ * Copyright (c) AXA Group Operations 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.
+ */
+
+import { NeuralNetwork } from '@nlpjs/neural'
+
+export {
+  NeuralNetwork,
+};

src/classifiers/index.ts

@@ -26,6 +26,14 @@ import { NlpUtil, NlpManager, NlpExcelReader } from './nlp'
 import { XTableUtils, XTable, XDoc } from './xtables'
 import { removeEmojis, Evaluator, SpellCheck, Handlebars } from './util'
 import { ActionManager, NlgManager } from './nlg'
+import { NeuralNetwork } from './classifiers'
+import { SentimentAnalyzer, SentimentManager } from './sentiment'
+import {
+    Recognizer,
+    ConversationContext,
+    MemoryConversationContext,
+} from './recognizer'
+
 export {
     Language,
     NlpUtil,
@@ -40,11 +48,11 @@ export {
     Handlebars,
     ActionManager,
     NlgManager,
-    // NeuralNetwork,
-    // SentimentAnalyzer,
-    // SentimentManager,
-    // Recognizer,
-    // ConversationContext,
-    // MemoryConversationContext,
+    NeuralNetwork,
+    SentimentAnalyzer,
+    SentimentManager,
+    Recognizer,
+    ConversationContext,
+    MemoryConversationContext,
     // BrainNLU,
 };

src/index.ts

@@ -21,6 +21,7 @@ export interface NlpManagerSettings {
     useDuckling?: boolean
     ducklingUrl?: string
     locale?: string
+    threshold?: number
   }
   action?: {
     [key: string]: (params: any, context: any, result: any) => Promise<void> | void
@@ -198,7 +199,7 @@ class NlpManager {
     return this.nlp.classify(locale, utterance, settings);
   }
 
-  async process(locale: string, utterance: string, context?: Record<string, unknown>, settings?: Record<string, unknown>): Promise<any> {
+  async process(locale?: string, utterance?: string, context?: Record<string, unknown>, settings?: Record<string, unknown>): Promise<any> {
     const result = await this.nlp.process(locale, utterance, context, settings);
     if (this.settings.processTransformer) {
       return this.settings.processTransformer(result);

src/nlp/nlp-manager.ts

@@ -0,0 +1,64 @@
+/*
+ * Copyright (c) AXA Group Operations 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.
+ */
+
+
+
+import { Session } from "../types/session";
+
+/**
+ * Abstract class for a conversation context of a chatbot.
+ * The conversation context is the responsible for storing and retrieving
+ * the context scope variables based on the current conversation.
+ * The getConversationContext receive the session of the chatbot, and must return
+ * a promise with the context in the resolve.
+ */
+
+class ConversationContext {
+  private settings: object;
+
+  /**
+   * Constructor of the class.
+   * @param {Object} settings Settings for the instance.
+   */
+  constructor(settings: object) {
+    this.settings = settings || {};
+  }
+
+  /**
+   * Given a session instance of a chatbot, return the conversation identifier.
+   * @param {Object} session Session instance of a message of chatbot.
+   * @returns {String} Identifier of the conversation.
+   */
+  public getConversationId(session: Session): string | undefined {
+    if (session?.message?.address?.conversation) {
+      return session.message.address.conversation.id;
+    }
+    if (session?._activity?.conversation) {
+      return session._activity.conversation.id;
+    }
+    return undefined;
+  }
+}
+
+export default ConversationContext;
+

src/recognizer/conversation-context.ts

@@ -0,0 +1,32 @@
+/*
+ * Copyright (c) AXA Group Operations 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.
+ */
+
+import Recognizer from './recognizer';
+import ConversationContext from './conversation-context'
+import MemoryConversationContext from './memory-conversation-context'
+
+export {
+  Recognizer,
+  ConversationContext,
+  MemoryConversationContext,
+};

src/recognizer/index.ts

@@ -0,0 +1,73 @@
+/*
+ * Copyright (c) AXA Group Operations 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.
+ */
+
+import ConversationContext from './conversation-context';
+import { Session } from "../types/session";
+
+/**
+ * In memory conversation context manager.
+ */
+class MemoryConversationContext extends ConversationContext {
+  private readonly conversationContexts: { [conversationId: string]: any };
+
+  /**
+   * Constructor of the class.
+   * @param {Object} settings Settings for the instance.
+   */
+  constructor(settings: object) {
+    super(settings);
+    this.conversationContexts = {};
+  }
+
+  /**
+   * Gets the conversation context from the session.
+   * @param {Object} session Chatbot session of the conversation.
+   * @returns {Promise<Object>} Promise to resolve the conversation context.
+   */
+  public getConversationContext(session: Session): Promise<Object> {
+    return new Promise((resolve, reject) => {
+      const conversationId = this.getConversationId(session);
+      if (!conversationId) {
+        return reject(new Error('No conversation id found'));
+      }
+      if (!this.conversationContexts[conversationId]) {
+        this.conversationContexts[conversationId] = {};
+      }
+      return resolve(this.conversationContexts[conversationId]);
+    });
+  }
+
+  public setConversationContext(session: Session, context: any): Promise<void> {
+    return new Promise((resolve, reject) => {
+      const conversationId = this.getConversationId(session);
+      if (!conversationId) {
+        return reject(new Error('No conversation id found'));
+      }
+      this.conversationContexts[conversationId] = context;
+      return resolve();
+    });
+  }
+}
+
+export default MemoryConversationContext;
+