@tiledesk/tiledesk-tybot-connector 2.0.10-rc1 → 2.0.10-rc11

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tiledesk/tiledesk-tybot-connector",
-  "version": "2.0.10-rc1",
+  "version": "2.0.10-rc11",
   "description": "Tiledesk Tybot connector",
   "main": "index.js",
   "scripts": {
@@ -15,7 +15,7 @@
     "@tiledesk/tiledesk-chatbot-client": "^0.5.30",
     "@tiledesk/tiledesk-chatbot-util": "^0.8.39",
     "@tiledesk/tiledesk-client": "^0.10.13",
-    "@tiledesk/tiledesk-multi-worker": "^0.3.1-rc10",
+    "@tiledesk/tiledesk-multi-worker": "^0.3.1-rc12",
     "accept-language-parser": "^1.5.0",
     "app-root-path": "^3.1.0",
     "axios": "^1.7.7",

package/tiledeskChatbotPlugs/DirectivesChatbotPlug.js

@@ -57,6 +57,7 @@ const { DirReplaceBotV3 } = require('./directives/DirReplaceBotV3');
 const { DirAiTask, DirAiPrompt } = require('./directives/DirAiPrompt');
 const { DirWebResponse } = require('./directives/DirWebResponse');
 const { DirConnectBlock } = require('./directives/DirConnectBlock');
+const { DirAddKbContent } = require('./directives/DirAddKbContent');
 
 const winston = require('../utils/winston');
 const { DirFlowLog } = require('./directives/DirFlowLog');
@@ -721,6 +722,12 @@ class DirectivesChatbotPlug {
         this.process(next_dir);
       })
     }
+    else if (directive_name === Directives.ADD_KB_CONTENT) {
+      new DirAddKbContent(context).execute(directive, async () => {
+        let next_dir = await this.nextDirective(this.directives);
+        this.process(next_dir);
+      });
+    }
     else {
       let next_dir = await this.nextDirective(this.directives);
       this.process(next_dir);

package/tiledeskChatbotPlugs/directives/DirAddKbContent.js

@@ -0,0 +1,332 @@
+const axios = require("axios").default;
+const { TiledeskChatbot } = require('../../engine/TiledeskChatbot');
+const { Filler } = require('../Filler');
+let https = require("https");
+const { DirIntent } = require("./DirIntent");
+const { TiledeskChatbotConst } = require("../../engine/TiledeskChatbotConst");
+const { TiledeskChatbotUtil } = require("../../utils/TiledeskChatbotUtil");
+const assert = require("assert");
+require('dotenv').config();
+const winston = require('../../utils/winston');
+const httpUtils = require("../../utils/HttpUtils");
+const integrationService = require("../../services/IntegrationService");
+const { Logger } = require("../../Logger");
+
+class DirAddKbContent {
+
+  constructor(context) {
+    if (!context) {
+      throw new Error('context object is mandatory');
+    }
+    this.context = context;
+    this.chatbot = context.chatbot;
+    this.tdcache = this.context.tdcache;
+    this.requestId = this.context.requestId;
+    this.projectId = this.context.projectId;
+    this.token = this.context.token;
+    this.intentDir = new DirIntent(context);
+    this.API_ENDPOINT = this.context.API_ENDPOINT;
+    this.log = context.log;
+    this.logger = new Logger({ request_id: this.requestId, dev: this.context.supportRequest.draft });
+  }
+
+  execute(directive, callback) {
+    this.logger.info("Execute AskKnowledgeBase action")
+    winston.debug("DirAskGPTV2 directive: ", directive);
+    let action;
+    if (directive.action) {
+      action = directive.action;
+    }
+    else {
+      this.logger.error("Incorrect action for ", directive.name, directive)
+      winston.debug("DirAskGPTV2 Incorrect directive: ", directive);
+      callback();
+      return;
+    }
+    this.go(action, (stop) => {
+      this.logger.info("Acion AskKnowledgeBase completed");
+      callback(stop);
+    })
+  }
+
+  async go(action, callback) {
+    winston.debug("[DirAddKbContent] action:", action);
+    if (!this.tdcache) {
+      winston.error("[DirAddKbContent] Error: tdcache is mandatory");
+      callback();
+      return;
+    }
+
+    let publicKey = false;
+    let type = action.type;
+    let name = action.name;
+    let content = action.content;
+    let engine;
+
+    // default values
+    let namespace = this.context.projectId;
+
+    if (action.namespace) {
+      namespace = action.namespace;
+    }
+
+    let requestVariables = null;
+    requestVariables =
+      await TiledeskChatbot.allParametersStatic(
+        this.tdcache, this.requestId
+      );
+
+    const filler = new Filler();
+    const filled_content = filler.fill(content, requestVariables);
+    const filled_name = filler.fill(name, requestVariables);
+
+    const kb_endpoint = process.env.API_ENDPOINT;
+    winston.verbose("[DirAddKbContent] KbEndpoint URL: " + kb_endpoint);
+
+    let key = await integrationService.getKeyFromIntegrations(this.projectId, 'openai', this.token);
+    if (!key) {
+      this.logger.debug("[DirAddKbContent] OpenAI key not found in Integration. Using shared OpenAI key");
+      winston.verbose("[DirAddKbContent] - Key not found in Integrations. Searching in kb settings...");
+      key = await this.getKeyFromKbSettings();
+    }
+
+    if (!key) {
+      winston.verbose("[DirAddKbContent] - Retrieve public gptkey")
+      key = process.env.GPTKEY;
+      publicKey = true;
+    } else {
+      this.logger.debug("[DirAddKbContent] use your own OpenAI key")
+    }
+
+    if (!key) {
+      winston.info("[DirAddKbContent] Error: gptkey is mandatory");
+      await this.chatbot.addParameter("flowError", "[DirAddKbContent] Error: gptkey is mandatory");
+      callback();
+      return;
+    }
+
+    if (publicKey === true) {
+      let keep_going = await this.checkQuoteAvailability();
+      if (keep_going === false) {
+        this.logger.warn("[DirAddKbContent] Tokens quota exceeded. Skip the action")
+        winston.verbose("[DirAddKbContent] - Quota exceeded for tokens. Skip the action")
+        await this.chatbot.addParameter("flowError", "[DirAddKbContent] Error: tokens quota exceeded");
+        callback(true);  
+        return;
+      }
+    }
+
+    let ns;
+
+    if (action.namespaceAsName) {
+      // Namespace could be an attribute
+      const filled_namespace = filler.fill(action.namespace, requestVariables)
+      this.logger.debug("[DirAddKbContent] Searching namespace by name ", filled_namespace);
+      ns = await this.getNamespace(filled_namespace, null);
+      namespace = ns?.id;
+      winston.verbose("[DirAddKbContent] - Retrieved namespace id from name " + namespace);
+    } else {
+      this.logger.debug("[DirAddKbContent] Searching namespace by id ", namespace);
+      ns = await this.getNamespace(null, namespace);
+    }
+
+    if (!ns) {
+      this.logger.error("[DirAddKbContent] Namespace not found");
+      await this.chatbot.addParameter("flowError", "[DirAddKbContent] Error: namespace not found");
+      callback();
+      return;
+    }
+
+    if (ns.engine) {
+      engine = ns.engine;
+    } else {
+      engine = await this.setDefaultEngine()
+    }
+    
+    if (!namespace) {
+      this.logger.error("[DirAddKbContent] Namespace is undefined")
+      winston.verbose("[DirAddKbContent] - Error: namespace is undefined")
+      await this.chatbot.addParameter("flowError", "[DirAddKbContent] Error: namespace is undefined");
+      callback(true);
+      return;
+    }
+
+    let json = {
+      content: filled_content,
+      namespace: namespace,
+      type: type,
+      name: filled_name,
+      source: filled_name
+    };
+    
+    winston.debug("[DirAddKbContent] json:", json);
+
+    const HTTPREQUEST = {
+      url: kb_endpoint + "/" + this.projectId + "/kb",
+      headers: {
+        'Content-Type': 'application/json',
+        'Authorization': 'JWT ' + this.context.token
+      },
+      json: json,
+      method: "POST"
+    }
+    winston.debug("[DirAddKbContent] HttpRequest: ", HTTPREQUEST);
+
+    httpUtils.request(
+      HTTPREQUEST, async (err, resbody) => {
+        
+        if (err) {
+          this.logger.error("[DirAddKbContent] error: " + JSON.stringify(err?.response));
+          winston.error("[DirAddKbContent] error: ", err?.response);
+          if (callback) {
+            callback();
+            return;
+          }
+        }
+        else if (resbody.success === true) {
+          winston.debug("[DirAddKbContent] resbody: ", resbody);
+          callback();
+          return;
+        } else {
+          callback();
+          return;
+        }
+      }
+    )
+  }
+
+  async getKeyFromKbSettings() {
+    return new Promise((resolve) => {
+
+      const KB_HTTPREQUEST = {
+        url: this.API_ENDPOINT + "/" + this.context.projectId + "/kbsettings",
+        headers: {
+          'Content-Type': 'application/json',
+          'Authorization': 'JWT ' + this.context.token
+        },
+        method: "GET"
+      }
+      winston.debug("DirAskGPTV2 KB HttpRequest", KB_HTTPREQUEST);
+
+      httpUtils.request(
+        KB_HTTPREQUEST, async (err, resbody) => {
+          if (err) {
+            winston.error("DirAskGPTV2 Get kb settings error ", err?.response?.data);
+            resolve(null);
+          } else {
+            if (!resbody.gptkey) {
+              resolve(null);
+            } else {
+              resolve(resbody.gptkey);
+            }
+          }
+        }
+      )
+    })
+  }
+
+  async checkQuoteAvailability() {
+    return new Promise((resolve) => {
+
+      const HTTPREQUEST = {
+        url: this.API_ENDPOINT + "/" + this.context.projectId + "/quotes/tokens",
+        headers: {
+          'Content-Type': 'application/json',
+          'Authorization': 'JWT ' + this.context.token
+        },
+        method: "GET"
+      }
+      winston.debug("DirAskGPTV2 check quote availability HttpRequest", HTTPREQUEST);
+
+      httpUtils.request(
+        HTTPREQUEST, async (err, resbody) => {
+          if (err) {
+            winston.error("DirAskGPTV2 Check quote availability err: ", err);
+            resolve(true)
+          } else {
+            if (resbody.isAvailable === true) {
+              resolve(true)
+            } else {
+              resolve(false)
+            }
+          }
+        }
+      )
+    })
+  }
+
+  async updateQuote(tokens_usage) {
+    return new Promise((resolve, reject) => {
+
+      const HTTPREQUEST = {
+        url: this.API_ENDPOINT + "/" + this.context.projectId + "/quotes/incr/tokens",
+        headers: {
+          'Content-Type': 'application/json',
+          'Authorization': 'JWT ' + this.context.token
+        },
+        json: tokens_usage,
+        method: "POST"
+      }
+      winston.debug("DirAskGPTV2 update quote HttpRequest ", HTTPREQUEST);
+
+      httpUtils.request(
+        HTTPREQUEST, async (err, resbody) => {
+          if (err) {
+            winston.error("DirAskGPTV2 Increment tokens quote err: ", err);
+            reject(false)
+          } else {
+            resolve(true);
+          }
+        }
+      )
+    })
+  }
+
+  async getNamespace(name, id) {
+    return new Promise((resolve) => {
+      const HTTPREQUEST = {
+        url: this.API_ENDPOINT + "/" + this.context.projectId + "/kb/namespace/all",
+        headers: {
+          'Content-Type': 'application/json',
+          'Authorization': 'JWT ' + this.context.token
+        },
+        method: "GET"
+      }
+      winston.debug("DirAskGPTV2 get all namespaces HttpRequest", HTTPREQUEST);
+      httpUtils.request(
+        HTTPREQUEST, async (err, namespaces) => {
+          if (err) {
+            winston.error("DirAskGPTV2 get all namespaces err: ", err);
+            resolve(null)
+          } else {
+            winston.debug("DirAskGPTV2 get all namespaces resbody: ", namespaces);
+            if (name) {
+              let namespace = namespaces.find(n => n.name === name);
+              resolve(namespace);
+            } else {
+              let namespace = namespaces.find(n => n.id === id);
+              resolve(namespace);
+            }
+
+          }
+        }
+      )
+    })
+  }
+
+  async setDefaultEngine() {
+    return new Promise((resolve) => {
+      let engine = {
+        name: "pinecone",
+        type: process.env.PINECONE_TYPE,
+        apikey: "",
+        vector_size: 1536,
+        index_name: process.env.PINECONE_INDEX
+      }
+      resolve(engine);
+    })
+  }
+
+}
+
+module.exports = { DirAddKbContent }

package/tiledeskChatbotPlugs/directives/DirAddTags.js

@@ -25,7 +25,7 @@ class DirAddTags {
     this.requestId = this.context.requestId;
     this.API_ENDPOINT = this.context.API_ENDPOINT;
     this.log = context.log;
-    this.logger = new Logger({ request_id: this.requestId, dev: this.context.supportRequest.draft });
+    this.logger = new Logger({ request_id: this.requestId, dev: this.context.supportRequest.draft, intent_id: this.context.reply.attributes.intent_info.intent_id });
 
     this.tdClient = new TiledeskClient({
       projectId: this.context.projectId,

package/tiledeskChatbotPlugs/directives/DirAiPrompt.js

@@ -29,7 +29,7 @@ class DirAiPrompt {
     this.intentDir = new DirIntent(context);
     this.API_ENDPOINT = this.context.API_ENDPOINT;
     this.log = context.log;
-    this.logger = new Logger({ request_id: this.requestId, dev: this.context.supportRequest.draft });
+    this.logger = new Logger({ request_id: this.requestId, dev: this.context.supportRequest.draft, intent_id: this.context.reply.attributes.intent_info.intent_id });
   }
 
   execute(directive, callback) {

package/tiledeskChatbotPlugs/directives/DirAskGPTV2.js

@@ -27,11 +27,11 @@ class DirAskGPTV2 {
     this.intentDir = new DirIntent(context);
     this.API_ENDPOINT = this.context.API_ENDPOINT;
     this.log = context.log;
-    this.logger = new Logger({ request_id: this.requestId, dev: this.context.supportRequest.draft });
+    this.logger = new Logger({ request_id: this.requestId, dev: this.context.supportRequest.draft, intent_id: this.context.reply.attributes.intent_info.intent_id });
   }
 
   execute(directive, callback) {
-    this.logger.error("Execute AskKnowledgeBase action")
+    this.logger.info("Execute AskKnowledgeBase action")
     winston.debug("DirAskGPTV2 directive: ", directive);
     let action;
     if (directive.action) {

package/tiledeskChatbotPlugs/directives/DirFlowLog.js

@@ -1,7 +1,10 @@
 
 
 const { Logger } = require('../../Logger');
+const { TiledeskChatbot } = require('../../engine/TiledeskChatbot');
+const { Filler } = require('../Filler');
 const winston = require('../../utils/winston');
+
 let levels = ['error', 'warn', 'info', 'debug'];
 
 class DirFlowLog {
@@ -38,7 +41,6 @@ class DirFlowLog {
 
   async go(action, callback) {
     winston.debug("(DirFlowLog) Action: ", action);
-    console.log("(DirFlowLog) Action: ", action);
 
     let level = action.level || 'info';
     if (!levels.includes(level)) {
@@ -52,21 +54,31 @@ class DirFlowLog {
       callback();
     }
 
+    let requestVariables = null;
+    requestVariables =
+      await TiledeskChatbot.allParametersStatic(
+        this.tdcache, this.requestId
+      );
+
+    const filler = new Filler();
+    const filled_log = filler.fill(action.log, requestVariables);
+    winston.debug("(DirFlowLog) fille log: ", filled_log);
+
     if (level === 'error') {
-      winston.info("Adding log " + action.log + " with level " + level);
-      this.logger.error(action.log);
+      winston.info("Adding log '" + filled_log + "' with level " + level);
+      this.logger.error(filled_log);
     }
     else if (level === 'warn') {
-      winston.info("Adding log " + action.log + " with level " + level);
-      this.logger.warn(action.log);
+      winston.info("Adding log '" + filled_log + "' with level " + level);
+      this.logger.warn(filled_log);
     }
     else if (level === 'info') {
-      winston.info("Adding log " + action.log + " with level " + level);
-      this.logger.info(action.log);
+      winston.info("Adding log '" + filled_log + "' with level " + level);
+      this.logger.info(filled_log);
     }
     else if (level === 'debug') {
-      winston.info("Adding log " + action.log + " with level " + level);
-      this.logger.debug(action.log);
+      winston.info("Adding log '" + filled_log + "' with level " + level);
+      this.logger.debug(filled_log);
     }
 
     callback();

package/tiledeskChatbotPlugs/directives/DirReply.js

@@ -18,7 +18,7 @@ class DirReply {
     this.token = context.token;
     this.tdcache = context.tdcache;
     this.supportRequest = this.context.supportRequest;
-    this.logger = new Logger({ request_id: this.requestId, dev: this.context.supportRequest.draft });
+    this.logger = new Logger({ request_id: this.requestId, dev: this.context.supportRequest.draft, intent_id: this.context.reply.attributes.intent_info.intent_id });
 
     this.API_ENDPOINT = context.API_ENDPOINT;
     this.tdClient = new TiledeskClient({

package/tiledeskChatbotPlugs/directives/DirWebRequestV2.js

@@ -18,7 +18,7 @@ class DirWebRequestV2 {
     this.chatbot = context.chatbot;
     this.intentDir = new DirIntent(context);
     this.log = context.log;
-    this.logger = new Logger({ request_id: this.requestId, dev: this.context.supportRequest.draft });
+    this.logger = new Logger({ request_id: this.requestId, dev: this.context.supportRequest.draft, intent_id: this.context.reply.attributes.intent_info.intent_id });
   }
 
   execute(directive, callback) {
@@ -54,10 +54,10 @@ class DirWebRequestV2 {
     let trueIntentAttributes = action.trueIntentAttributes;
     let falseIntentAttributes = action.falseIntentAttributes;
 
-    winston.debug("DirWebRequestV2  trueIntent " + trueIntent)
-    winston.debug("DirWebRequestV2  falseIntent " + falseIntent)
-    winston.debug("DirWebRequestV2  trueIntentAttributes " + trueIntentAttributes)
-    winston.debug("DirWebRequestV2  falseIntentAttributes " + falseIntentAttributes)
+    winston.debug("DirWebRequestV2 trueIntent " + trueIntent)
+    winston.debug("DirWebRequestV2 falseIntent " + falseIntent)
+    winston.debug("DirWebRequestV2 trueIntentAttributes " + trueIntentAttributes)
+    winston.debug("DirWebRequestV2 falseIntentAttributes " + falseIntentAttributes)
 
     let requestAttributes = null;
     requestAttributes =
@@ -139,6 +139,7 @@ class DirWebRequestV2 {
         }
         else {
           this.logger.warn("WebRequest status ", status);
+          this.logger.error("WebRequest error ", error);
           if (falseIntent) {
             await this.#executeCondition(false, trueIntent, trueIntentAttributes, falseIntent, falseIntentAttributes);
             callback(true);

package/tiledeskChatbotPlugs/directives/DirWebResponse.js

@@ -16,7 +16,7 @@ class DirWebResponse {
     this.requestId = context.requestId;
     this.token = context.token;
     this.tdcache = context.tdcache;
-    this.logger = new Logger({ request_id: this.requestId, dev: this.context.supportRequest.draft });
+    this.logger = new Logger({ request_id: this.requestId, dev: this.context.supportRequest.draft, intent_id: this.context.reply.attributes.intent_info.intent_id });
   }
 
   execute(directive, callback) {

package/tiledeskChatbotPlugs/directives/Directives.js

@@ -61,6 +61,7 @@ class Directives {
   static WEBHOOK = 'webhook';
   static WEB_RESPONSE = "web_response";
   static FLOW_LOG = "flow_log";
+  static ADD_KB_CONTENT = "add_kb_content";
 
   // static WHEN_ONLINE_MOVE_TO_AGENT = "whenonlinemovetoagent"; // DEPRECATED?
   // static WHEN_OFFLINE_HOURS = "whenofflinehours"; // DEPRECATED // adds a message on top of the original message when offline hours opts: --replace