@tiledesk/tiledesk-tybot-connector 2.0.10-rc2 → 2.0.10-rc20

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tiledesk/tiledesk-tybot-connector",
-  "version": "2.0.10-rc2",
+  "version": "2.0.10-rc20",
   "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-rc11",
+    "@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,333 @@
+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.API_ENDPOINT = this.context.API_ENDPOINT;
+    this.log = context.log;
+    
+    this.intentDir = new DirIntent(context);
+    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.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

@@ -24,20 +24,14 @@ class DirAddTags {
     this.tdcache = this.context.tdcache;
     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.tdClient = new TiledeskClient({
-      projectId: this.context.projectId,
-      token: this.context.token,
-      APIURL: this.API_ENDPOINT,
-      APIKEY: "___"
-    });
+    
+    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, token: this.context.token, APIURL: this.API_ENDPOINT, APIKEY: "___" });
   }
 
   execute(directive, callback) {
+    this.logger.info("[Add Tag] Executing action")
     winston.verbose("Execute AddTags action");
-    this.logger.error("Execute AddTags directive")
     let action;
     if (directive.action) {
       action = directive.action;
@@ -49,7 +43,7 @@ class DirAddTags {
       return;
     }
     this.go(action, (stop) => {
-      this.logger.info("Acion AddTag completed");
+      this.logger.info("[Add Tag] Action completed");
       callback(stop);
     })
   }
@@ -70,7 +64,7 @@ class DirAddTags {
     pushToList = action.pushToList
 
     if (!action.tags || action.tags === '') {
-      this.logger.error("Add tags Error: tags attribute is mandatory");
+      this.logger.error("[Add Tag] tags attribute is mandatory");
       winston.error("(DirAddTags) Error: tags attribute is mandatory")
       await this.chatbot.addParameter("flowError", "Add tags Error: tags attribute is mandatory");
       callback();
@@ -91,7 +85,7 @@ class DirAddTags {
     if(target === 'request'){
       
       let newTags = filled_tags.split(',').filter(tag => tag !== '').map(el => el.trim())
-      this.logger.debug("Adding following tags to conversation: ", newTags)
+      this.logger.debug("[Add Tag] Adding following tags to conversation: ", newTags)
 
       if(action.pushToList){
         newTags.forEach(async (tag) => {
@@ -105,7 +99,7 @@ class DirAddTags {
 
       winston.debug('(DirAddTags) UPDATE request with newTags', newTags)
       let updatedRequest = await this.updateRequestWithTags(newTags)
-      this.logger.info("Tags added to conversation")
+      this.logger.info("[Add Tag] Tags added to conversation")
       if(!updatedRequest){
         callback();
         return;
@@ -116,7 +110,7 @@ class DirAddTags {
     /** use case: LEAD */
     if(target === 'lead'){
       let newTags = filled_tags.split(',').filter(tag => tag !== '').map(el => el.trim())
-      this.logger.debug("Adding following tags to lead: ", newTags)
+      this.logger.debug("[Add Tag] Adding following tags to lead: ", newTags)
 
       let request = await this.tdClient.getRequestById(this.requestId);
       winston.debug('(DirAddTags) request detail: ', request)
@@ -138,7 +132,7 @@ class DirAddTags {
 
       winston.debug('(DirAddTags) UPDATE lead with newTags ', newTags)
       let updatedLead = await this.updateLeadWithTags(request.lead._id, newTags)
-      this.logger.info("Tags added to lead")
+      this.logger.info("[Add Tag] Tags added to lead")
       if(!updatedLead){
         callback();
         return;
@@ -183,7 +177,7 @@ class DirAddTags {
       httpUtils.request(
         HTTPREQUEST, async (err, resbody) => {
           if (err) {
-            this.logger.error("Add tags to list error ", err?.response?.data)
+            this.logger.error("[Add Tag] Add tags to list error ", err?.response?.data)
             winston.error("(httprequest) DirAddTags add tags to list err: ", err);
             resolve(true)
           } else {
@@ -218,7 +212,7 @@ class DirAddTags {
       httpUtils.request(
         HTTPREQUEST, async (err, resbody) => {
           if (err) {
-            this.logger.error("Add tag to conversation error ", err?.response?.data);
+            this.logger.error("[Add Tag] Add tag to conversation error ", err?.response?.data);
             winston.error("(httprequest) DirAddTags patch request with new tags err: ", err);
             resolve(true)
           } else {
@@ -248,7 +242,7 @@ class DirAddTags {
       httpUtils.request(
         HTTPREQUEST, async (err, resbody) => {
           if (err) {
-            this.logger.error("Add tag to lead error ", err?.response?.data);
+            this.logger.error("[Add Tag] Add tag to lead error ", err?.response?.data);
             winston.error("(httprequest) DirAddTags put lead with new tags err: ", err);
             resolve(true)
           } else {

package/tiledeskChatbotPlugs/directives/DirAiPrompt.js

@@ -26,27 +26,27 @@ class DirAiPrompt {
     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 });
+    
+    this.intentDir = new DirIntent(context);
+    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.info("[AI Prompt] Executing action");
     winston.verbose("Execute AiPrompt directive");
-    this.logger.error("AiPrompt: executing action");
     let action;
     if (directive.action) {
       action = directive.action;
     }
     else {
-      this.logger.error("AiPrompt incorrect action ", directive)
+      this.logger.error("Incorrect action for ", directive.name, directive)
       winston.debug("DirAiPrompt Incorrect directive: ", directive);
       callback();
       return;
     }
     this.go(action, (stop) => {
-      this.logger.info("AiPrompt: action completed");
+      this.logger.info("[AI Prompt] Action completed");
       callback(stop);
     })
   }
@@ -70,7 +70,7 @@ class DirAiPrompt {
     winston.debug("DirAskGPTV2 falseIntent", falseIntent)
 
     await this.checkMandatoryParameters(action).catch( async (missing_param) => {
-      this.logger.error(`AiPrompt: missing attribute '${missing_param}'`);
+      this.logger.error(`[AI Prompt] missing attribute '${missing_param}'`);
       await this.chatbot.addParameter("flowError", "AiPrompt Error: '" + missing_param + "' attribute is undefined");
       if (falseIntent) {
         await this.#executeCondition(false, trueIntent, trueIntentAttributes, falseIntent, falseIntentAttributes);
@@ -92,7 +92,7 @@ class DirAiPrompt {
     const filled_context = filler.fill(action.context, requestVariables);
 
     if (action.history) {
-      this.logger.info("AiPrompt: using chat transcript");
+      this.logger.info("[AI Prompt] using chat transcript");
       let transcript_string = await TiledeskChatbot.getParameterStatic(
         this.context.tdcache,
         this.context.requestId,
@@ -103,7 +103,7 @@ class DirAiPrompt {
         transcript = await TiledeskChatbotUtil.transcriptJSON(transcript_string);
         winston.debug("DirAiPrompt transcript: ", transcript)
       } else {
-        this.logger.warn("AiPrompt: no chat transcript found, skipping history translation");
+        this.logger.warn("[AI Prompt] no chat transcript found, skipping history translation");
         winston.verbose("DirAiPrompt transcript_string is undefined. Skip JSON translation for chat history")
       }
     }
@@ -120,7 +120,7 @@ class DirAiPrompt {
 
     if (action.llm === 'ollama') {
       ollama_integration = await integrationService.getIntegration(this.projectId, action.llm, this.token).catch( async (err) => {
-        this.logger.error("AiPrompt: Error getting ollama integration.")
+        this.logger.error("[AI Prompt] Error getting ollama integration.")
         winston.error("DirAiPrompt Error getting ollama integration: ", err);
         await this.chatbot.addParameter("flowError", "Ollama integration not found");
         if (falseIntent) {
@@ -136,7 +136,7 @@ class DirAiPrompt {
       key = await integrationService.getKeyFromIntegrations(this.projectId, action.llm, this.token);
   
       if (!key) {
-        this.logger.error("AiPrompt: llm key not found in integrations");
+        this.logger.error("[AI Prompt] llm key not found in integrations");
         winston.error("Error: DirAiPrompt llm key not found in integrations");
         await this.chatbot.addParameter("flowError", "AiPrompt Error: missing key for llm " + action.llm);
         if (falseIntent) {
@@ -199,7 +199,7 @@ class DirAiPrompt {
           } else {
             error = JSON.stringify(err.response.data);
           }
-          this.logger.error("AiPrompt: error executing action: ", error);
+          this.logger.error("[AI Prompt] error executing action: ", error);
           if (falseIntent) {
             await this.chatbot.addParameter("flowError", "AiPrompt Error: " + error);
             await this.#executeCondition(false, trueIntent, trueIntentAttributes, falseIntent, falseIntentAttributes);
@@ -212,7 +212,7 @@ class DirAiPrompt {
 
           winston.debug("DirAiPrompt resbody: ", resbody);
           answer = resbody.answer;
-          this.logger.info("AiPrompt: answer: ", answer);
+          this.logger.info("[AI Prompt] answer: ", answer);
         
           await this.#assignAttributes(action, answer);
 
@@ -300,7 +300,7 @@ class DirAiPrompt {
     }
     if (result === true) {
       if (trueIntentDirective) {
-        this.logger.info("AiPrompt: executing true condition");
+        this.logger.info("[AI Prompt] executing true condition");
         this.intentDir.execute(trueIntentDirective, () => {
           if (callback) {
             callback();
@@ -308,7 +308,7 @@ class DirAiPrompt {
         })
       }
       else {
-        this.logger.info("AiPrompt: no block connected to true condition");
+        this.logger.info("[AI Prompt] no block connected to true condition");
         winston.debug("DirAiPrompt No trueIntentDirective specified");
         if (callback) {
           callback();
@@ -317,7 +317,7 @@ class DirAiPrompt {
     }
     else {
       if (falseIntentDirective) {
-        this.logger.info("AiPrompt: executing false condition");
+        this.logger.info("[AI Prompt] executing false condition");
         this.intentDir.execute(falseIntentDirective, () => {
           if (callback) {
             callback();
@@ -325,7 +325,7 @@ class DirAiPrompt {
         });
       }
       else {
-        this.logger.info("AiPrompt: no block connected to false condition");
+        this.logger.info("[AI Prompt] no block connected to false condition");
         winston.debug("DirAiPrompt No falseIntentDirective specified");
         if (callback) {
           callback();

package/tiledeskChatbotPlugs/directives/DirAskGPT.js

@@ -19,8 +19,9 @@ class DirAskGPT {
     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.intentDir = new DirIntent(context);
   }
 
   execute(directive, callback) {