@tiledesk/tiledesk-tybot-connector 0.2.107 → 0.2.108

package/CHANGELOG.md

@@ -17,6 +17,12 @@ available on:
 - Added flowError on JSONCondition when result = null
 - Added fix on Filler -->
 
+# v0.2.108 -> test
+- Added DirUnassign
+- Added chatbot_id
+- Added support for citations in AskGPTV2
+- Added support Json type in GPT Task
+
 # v0.2.107 -> production
 - clean logs (more)
 

package/index.js

@@ -467,6 +467,7 @@ router.get('/ext/parameters/requests/:requestid', async (req, res) => {
   else {
     const RESERVED = [
       TiledeskChatbotConst.REQ_CHATBOT_NAME_KEY,
+      TiledeskChatbotConst.REQ_CHATBOT_ID_KEY,
       TiledeskChatbotConst.REQ_CHAT_URL,
       TiledeskChatbotConst.REQ_CITY_KEY,
       TiledeskChatbotConst.REQ_COUNTRY_KEY,

package/models/TiledeskChatbotConst.js

@@ -4,6 +4,7 @@ class TiledeskChatbotConst {
     static REQ_PROJECT_ID_KEY = "project_id";
     static REQ_REQUEST_ID_KEY = "conversation_id";
     static REQ_CHATBOT_NAME_KEY = "chatbot_name";
+    static REQ_CHATBOT_ID_KEY = "chatbot_id";
     static REQ_LAST_USER_TEXT_KEY = "last_user_text";
     static REQ_LAST_USER_TEXT_v2_KEY = "lastUserText";
     static REQ_LAST_MESSAGE_ID_KEY = "last_message_id";
@@ -31,24 +32,7 @@ class TiledeskChatbotConst {
     static REQ_USER_COMPANY_KEY = "userCompany";
     static REQ_TICKET_ID_KEY = "ticketId";
     static REQ_CHATBOT_TOKEN = "chatbotToken";
-    
-
-    // static REQ_DEPARTMENT_ID_KEY = "tdDepartmentId";
-    // static REQ_PROJECT_ID_KEY = "projectId";
-    // static REQ_REQUEST_ID_KEY = "tdRequestId";
-    // static REQ_CHATBOT_NAME_KEY = "tdChatbotName";
-    // static REQ_LAST_USER_TEXT_KEY = "tdLastUserText";
-    // static REQ_LAST_MESSAGE_ID_KEY = "tdLastMessageId";
-    // static REQ_COUNTRY_KEY = "tdCountry";
-    // static REQ_CITY_KEY = "tdCity";
-    // static REQ_USER_SOURCE_PAGE_KEY = "tdUserSourcePage";
-    // static REQ_USER_LANGUAGE_KEY = "tdUserLanguage";
-    // static REQ_USER_AGENT_KEY = "tdUserAgent";
-    // static REQ_DEPARTMENT_NAME_KEY = "tdDepartmentName";
-    // static REQ_END_USER_ID_KEY = "tdEndUserId";
-    // static REQ_END_USER_IP_ADDRESS_KEY = "tdEndUserIpAddress";
-    // static REQ_CHAT_URL = "chat_url";
-    
+    static REQ_CHATBOT_TOKEN_v2 = "chatbot_jwt_token";
 }
 
 module.exports = { TiledeskChatbotConst };

package/models/TiledeskChatbotUtil.js

@@ -511,14 +511,16 @@ class TiledeskChatbotUtil {
             await chatbot.addParameter(TiledeskChatbotConst.REQ_REQUEST_ID_KEY, requestId);
             if (chatbot.bot) {
                 await chatbot.addParameter(TiledeskChatbotConst.REQ_CHATBOT_NAME_KEY, chatbot.bot.name);
+                await chatbot.addParameter(TiledeskChatbotConst.REQ_CHATBOT_ID_KEY, chatbot.bot._id);
             }
             if (chatbotToken) {
-                await chatbot.addParameter(TiledeskChatbotConst.REQ_CHATBOT_TOKEN, chatbotToken);
+                await chatbot.addParameter(TiledeskChatbotConst.REQ_CHATBOT_TOKEN, chatbotToken); // DEPRECATED
+                await chatbot.addParameter(TiledeskChatbotConst.REQ_CHATBOT_TOKEN_v2, "JWT " + chatbotToken);
             }
             
             if (message.text && message.sender !== "_tdinternal") {
                 // await chatbot.addParameter(TiledeskChatbotConst.USER_INPUT, true); // set userInput
-                await chatbot.deleteParameter(TiledeskChatbotConst.USER_INPUT); // set userInput
+                await chatbot.deleteParameter(TiledeskChatbotConst.USER_INPUT); // user wrote, delete userInput, replyv2 will not trigger timeout action
                 await chatbot.addParameter(TiledeskChatbotConst.REQ_LAST_USER_TEXT_KEY, message.text); // DEPRECATED
                 await chatbot.addParameter(TiledeskChatbotConst.REQ_LAST_USER_TEXT_v2_KEY, message.text);
                 if (message.channel) {
@@ -888,7 +890,8 @@ class TiledeskChatbotUtil {
             "lastUserText",
             TiledeskChatbotConst.REQ_REQUESTER_IS_AUTHENTICATED_KEY,
             TiledeskChatbotConst.USER_INPUT,
-            TiledeskChatbotConst.REQ_CHATBOT_TOKEN
+            TiledeskChatbotConst.REQ_CHATBOT_TOKEN,
+            TiledeskChatbotConst.REQ_CHATBOT_TOKEN_v2,
           ]
           let userParams = {};
           if (flowAttributes) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tiledesk/tiledesk-tybot-connector",
-  "version": "0.2.107",
+  "version": "0.2.108",
   "description": "Tiledesk Tybot connector",
   "main": "index.js",
   "scripts": {

package/tiledeskChatbotPlugs/DirectivesChatbotPlug.js

@@ -51,6 +51,7 @@ const { DirReplyV2 } = require('./directives/DirReplyV2');
 const { DirIfOnlineAgentsV2 } = require('./directives/DirIfOnlineAgentsV2');
 const { DirContactUpdate } = require('./directives/DirContactUpdate');
 const { DirClearTranscript } = require('./directives/DirClearTranscript');
+const { DirMoveToUnassigned } = require('./directives/DirMoveToUnassigned');
 
 class DirectivesChatbotPlug {
 
@@ -698,6 +699,13 @@ class DirectivesChatbotPlug {
         this.process(next_dir);
       });
     }
+    else if (directive_name === Directives.MOVE_TO_UNASSIGNED) {
+      console.log("...MOVE_TO_UNASSIGNED");
+      new DirMoveToUnassigned(context).execute(directive, async () => {
+        let next_dir = await this.nextDirective(this.directives);
+        this.process(next_dir);
+      });
+    }
     else {
       //console.log("Unhandled Post-message Directive:", directive_name);
       let next_dir = await this.nextDirective(this.directives);

package/tiledeskChatbotPlugs/directives/DirAskGPTV2.js

@@ -66,6 +66,7 @@ class DirAskGPTV2 {
     let max_tokens;
     let top_k;
     let transcript;
+    let citations = false;
     //let default_context = "You are an helpful assistant for question-answering tasks.\nUse ONLY the following pieces of retrieved context to answer the question.\nIf you don't know the answer, just say that you don't know.\nIf none of the retrieved context answer the question, add this word to the end <NOANS>\n\n{context}";
 
     let contexts = {
@@ -107,6 +108,10 @@ class DirAskGPTV2 {
       max_tokens = action.max_tokens;
     }
 
+    if (action.citations) {
+      citations = action.citations;
+    }
+
     let requestVariables = null;
     requestVariables =
       await TiledeskChatbot.allParametersStatic(
@@ -194,7 +199,8 @@ class DirAskGPTV2 {
       question: filled_question,
       gptkey: key,
       namespace: namespace,
-      model: model
+      model: model,
+      citations: citations
     };
     if (top_k) {
       json.top_k = top_k;

package/tiledeskChatbotPlugs/directives/DirClose.js

@@ -8,15 +8,16 @@ class DirClose {
         this.context = context;
         this.tdclient = context.tdclient;
         this.requestId = context.requestId;
+        this.chatbot = context.chatbot;
     }
     
     execute(directive, callback) {
-        this.tdclient.closeRequest(this.requestId, (err) => {
+        this.tdclient.closeRequest(this.requestId, async (err) => {
             if (err) {
                 console.error("Error in 'close directive':", err);
             }
             else {
-                // console.log("Successfully closed on close()");
+                await this.chatbot.deleteParameter(TiledeskChatbotConst.USER_INPUT);
             }
             callback();
         });

package/tiledeskChatbotPlugs/directives/DirGptTask.js

@@ -145,6 +145,8 @@ class DirGptTask {
       let keep_going = await this.checkQuoteAvailability(server_base_url);
       if (keep_going === false) {
         if (this.log) { console.log("DirGptTask - Quota exceeded for tokens. Skip the action")}
+        await this.chatbot.addParameter("flowError", "GPT Error: tokens quota exceeded");
+        await this.#executeCondition(false, trueIntent, trueIntentAttributes, falseIntent, falseIntentAttributes);
         callback();
         return;
       }
@@ -153,12 +155,6 @@ class DirGptTask {
     let json = {
       model: action.model,
       messages: [],
-      // messages: [
-      //   {
-      //     role: "user",
-      //     content: filled_question
-      //   }
-      // ],
       max_tokens: action.max_tokens,
       temperature: action.temperature,
     }
@@ -180,6 +176,12 @@ class DirGptTask {
       json.messages.push(message);
     } 
 
+    if (action.formatType && action.formatType !== 'none') {
+      json.response_format = {
+        type: action.formatType
+      }
+    }
+    
     if (this.log) { console.log("DirGptTask json: ", json) }
 
     const HTTPREQUEST = {
@@ -211,9 +213,12 @@ class DirGptTask {
         } else {
           if (this.log) { console.log("DirGptTask resbody: ", JSON.stringify(resbody)); }
           answer = resbody.choices[0].message.content;
-          // check if answer is a json
-          let answer_json = await this.convertToJson(answer);
-          await this.#assignAttributes(action, answer_json);
+
+          if (action.formatType === 'json_object' || action.formatType === undefined || action.formatType === null) {
+            answer = await this.convertToJson(answer);
+          }
+        
+          await this.#assignAttributes(action, answer);
 
           if (publicKey === true) {
             let tokens_usage = {
@@ -471,7 +476,7 @@ class DirGptTask {
             console.error("(httprequest) DirGptTask Increment tokens quote err: ", err);
             rejects(false)
           } else {
-            console.log("(httprequest) DirGptTask Increment token quote resbody: ", resbody);
+            if (this.log) { console.log("(httprequest) DirGptTask Increment token quote resbody: ", resbody); }
             resolve(true);
           }
         }

package/tiledeskChatbotPlugs/directives/DirMoveToAgent.js

@@ -10,106 +10,29 @@ class DirMoveToAgent {
       throw new Error('context object is mandatory.');
     }
     this.context = context;
-    // let context =  {
-    //   projectId: projectId,
-    //   token: token,
-    //   supportRequest: supportRequest,
-    //   requestId: supportRequest.request_id,
-    //   TILEDESK_APIURL: API_URL,
-    //   TILEBOT_ENDPOINT:TILEBOT_ENDPOINT,
-    //   departmentId: depId,
-    //   tdcache: tdcache,
-    //   log: false
-    // }
-    // new TiledeskClient({
-    //   projectId: context.projectId,
-    //   token: context.token,
-    //   APIURL: context.TILEDESK_APIURL,
-    //   APIKEY: "___",
-    //   log: context.log
-    // });
     this.tdclient = context.tdclient;
     this.tdcache = context.tdcache;
     this.requestId = context.requestId;
-    // this.depId = context.departmentId;
     this.log = context.log;
   }
 
   execute(directive, callback) {
     directive.action = {};
-    // if (directive.name === Directives.WHEN_ONLINE_MOVE_TO_AGENT) { // TEMP
-    //   directive.action = {
-    //     whenOnlineOnly: true
-    //   }
-    // }
     this.go(directive.action, () => {
       callback();
     });
   }
 
   async go(action, callback) {
-    // let depId = null;
-    // if (this.log) {console.log("DirMoveToAgent this.context.departmentId:", this.context.departmentId);}
-    // if (this.context.departmentId) {
-    //   depId = this.context.departmentId
-    //   if (this.log) {console.log("DirMoveToAgent depId:", depId);}
-    // }
-    // else if (this.tdcache) {
-    //   depId = 
-    //   await TiledeskChatbot.getParameterStatic(
-    //     this.tdcache, this.requestId, TiledeskChatbotConst.REQ_DEPARTMENT_ID_KEY
-    //   );
-    //   if (this.log) {console.log("DirMoveToAgent depId (cache):", depId);}
-    // }
-    // if (this.log) {console.log("DirMoveToAgent anyway depId is:", depId);}
-    // if (action.whenOnlineOnly === true) {
-    //   this.tdclient.openNow( async (err, result) => {
-    //     if (err) {
-    //       console.error("Agent in DirOfflineHours Error:", err);
-    //       callback();
-    //     }
-    //     else {
-    //       if (result && result.isopen) {
-    //         // if (depId) {
-    //           // this.tdclient.agent(this.requestId, depId, (err) => {
-    //           this.tdclient.moveToAgent(this.requestId, (err) => {
-    //             if (err) {
-    //               console.error("Error moving to agent during online hours:", err);
-    //             }
-    //             else {
-    //               console.log("Successfully moved to agent during online hours");
-    //             }
-    //             callback();
-    //           });
-    //         // }
-    //         // else {
-    //         //   callback();
-    //         // }
-    //       }
-    //       else {
-    //         callback();
-    //       }
-    //     }
-    //   });
-    // }
-    // else {
-        // if (depId) {
-          // this.tdclient.agent(this.requestId, depId, (err) => {
-          this.tdclient.moveToAgent(this.requestId, (err) => {
-            if (err) {
-              console.error("Error moving to agent:", err);
-            }
-            else {
-              // console.log("Successfully moved to agent");
-            }
-            callback();
-          });
-        // }
-        // else {
-        //   callback();
-        // }
-      
-    // }
+    this.tdclient.moveToAgent(this.requestId, (err) => {
+      if (err) {
+        console.error("Error moving to agent:", err);
+      }
+      else {
+        // console.log("Successfully moved to agent");
+      }
+      callback();
+    });
   }
 
 }

package/tiledeskChatbotPlugs/directives/DirMoveToUnassigned.js

@@ -0,0 +1,50 @@
+// const { TiledeskClient } = require('@tiledesk/tiledesk-client');
+const { Directives } = require('./Directives');
+const { TiledeskChatbot } = require('../../models/TiledeskChatbot');
+const { TiledeskChatbotConst } = require('../../models/TiledeskChatbotConst');
+
+class DirMoveToUnassigned {
+
+  constructor(context) {
+    if (!context) {
+      throw new Error('context object is mandatory.');
+    }
+    this.context = context;
+    this.tdclient = context.tdclient;
+    this.requestId = context.requestId;
+    this.log = context.log;
+  }
+
+  execute(directive, callback) {
+    directive.action = {};
+    this.go(directive.action, () => {
+      callback();
+    });
+  }
+
+  async go(action, callback) {
+    this.moveToUnassigned(this.requestId, (err) => {
+      if (err) {
+        console.error("Error moving to unassigned:", err);
+      }
+      else {
+        // console.log("Successfully moved to unassigned");
+      }
+      callback();
+    });
+  }
+
+  async moveToUnassigned(requestId, callback) {
+    const empty_participants = [] // STATUS WILL MOVE AUTOMATICALLY TO UNASSIGNED (100)
+    this.tdclient.updateRequestParticipants(requestId, empty_participants, (err) => {
+      if (callback) {
+        callback(err);
+      }
+    });
+  }
+
+  
+
+}
+
+module.exports = { DirMoveToUnassigned };

package/tiledeskChatbotPlugs/directives/Directives.js

@@ -51,6 +51,7 @@ class Directives {
   static IF_ONLINE_AGENTS_V2 = "ifonlineagentsv2";
   static CONTACT_UPDATE = "leadupdate";
   static CLEAR_TRANSCRIPT = "clear_transcript";
+  static MOVE_TO_UNASSIGNED = "move_to_unassigned";
 
   // 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