@tiledesk/tiledesk-tybot-connector 0.2.601-rc1 → 0.3.1

package/tiledeskChatbotPlugs/directives/DirAskGPTV2.js

@@ -3,6 +3,9 @@ const { TiledeskChatbot } = require('../../models/TiledeskChatbot');
 const { Filler } = require('../Filler');
 let https = require("https");
 const { DirIntent } = require("./DirIntent");
+const { TiledeskChatbotConst } = require("../../models/TiledeskChatbotConst");
+const { TiledeskChatbotUtil } = require("../../models/TiledeskChatbotUtil");
+const assert = require("assert");
 require('dotenv').config();
 
 class DirAskGPTV2 {
@@ -12,9 +15,11 @@ class DirAskGPTV2 {
       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.intentDir = new DirIntent(context);
+    this.API_ENDPOINT = this.context.API_ENDPOINT;
     this.log = context.log;
   }
 
@@ -57,11 +62,25 @@ class DirAskGPTV2 {
 
     // default values
     let answer = "No answers";
-    let source = null;
+    let namespace = this.context.projectId;
     let model = "gpt-3.5-turbo";
     let temperature;
     let max_tokens;
     let top_k;
+    let transcript;
+    let citations = false;
+    let engine;
+    //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 = {
+      "gpt-3.5-turbo":        "You are an helpful assistant for question-answering tasks.\nUse ONLY the pieces of retrieved context delimited by #### to answer the question.\nIf you don't know the answer, just say: \"I don't know<NOANS>\"\n\n####{context}####",
+      "gpt-4":                "You are an helpful assistant for question-answering tasks.\nUse ONLY the pieces of retrieved context delimited by #### to answer the question.\nIf you don't know the answer, just say that you don't know.\nIf and only if none of the retrieved context is useful for your task, add this word to the end <NOANS>\n\n####{context}####",
+      "gpt-4-turbo-preview":  "You are an helpful assistant for question-answering tasks.\nUse ONLY the pieces of retrieved context delimited by #### to answer the question.\nIf you don't know the answer, just say that you don't know.\nIf and only if none of the retrieved context is useful for your task, add this word to the end <NOANS>\n\n####{context}####",
+      "gpt-4o":               "You are an helpful assistant for question-answering tasks. Follow these steps carefully:\n1. Answer in the same language of the user question, regardless of the retrieved context language\n2. Use ONLY the pieces of the retrieved context to answer the question.\n3. If the retrieved context does not contain sufficient information to generate an accurate and informative answer, return <NOANS>\n\n==Retrieved context start==\n{context}\n==Retrieved context end==",
+      "gpt-4o-mini":          "You are an helpful assistant for question-answering tasks. Follow these steps carefully:\n1. Answer in the same language of the user question, regardless of the retrieved context language\n2. Use ONLY the pieces of the retrieved context to answer the question.\n3. If the retrieved context does not contain sufficient information to generate an accurate and informative answer, return <NOANS>\n\n==Retrieved context start==\n{context}\n==Retrieved context end=="
+    }
+
+    let source = null;
 
     if (!action.question || action.question === '') {
       console.error("Error: DirAskGPT question attribute is mandatory. Executing condition false...");
@@ -73,6 +92,9 @@ class DirAskGPTV2 {
       return;
     }
 
+    if (action.namespace) {
+      namespace = action.namespace;
+    }
     if (action.model) {
       model = action.model;
     }
@@ -89,6 +111,10 @@ class DirAskGPTV2 {
       max_tokens = action.max_tokens;
     }
 
+    if (action.citations) {
+      citations = action.citations;
+    }
+
     let requestVariables = null;
     requestVariables =
       await TiledeskChatbot.allParametersStatic(
@@ -99,18 +125,25 @@ class DirAskGPTV2 {
     const filled_question = filler.fill(action.question, requestVariables);
     const filled_context = filler.fill(action.context, requestVariables)
 
-    const server_base_url = process.env.API_ENDPOINT || process.env.API_URL;
-    const kb_endpoint = process.env.KB_ENDPOINT_QA
-    
-    if (this.log) {
-      console.log("DirAskGPT ApiEndpoint URL: ", server_base_url);
-      console.log("DirAskGPT KbEndpoint URL: ", kb_endpoint);
+    if (action.history) {
+      let transcript_string = await TiledeskChatbot.getParameterStatic(
+        this.context.tdcache,
+        this.context.requestId,
+        TiledeskChatbotConst.REQ_TRANSCRIPT_KEY
+      )
+      if (this.log) { console.log("DirAskGPT transcript string: ", transcript_string) }
+
+      transcript = await TiledeskChatbotUtil.transcriptJSON(transcript_string);
+      if (this.log) { console.log("DirAskGPT transcript ", transcript) }
     }
 
-    let key = await this.getKeyFromIntegrations(server_base_url);
+    const kb_endpoint = process.env.KB_ENDPOINT_QA
+    if (this.log) { console.log("DirAskGPT KbEndpoint URL: ", kb_endpoint); }
+
+    let key = await this.getKeyFromIntegrations();
     if (!key) {
       if (this.log) { console.log("DirAskGPT - Key not found in Integrations. Searching in kb settings..."); }
-      key = await this.getKeyFromKbSettings(server_base_url);
+      key = await this.getKeyFromKbSettings();
     }
 
     if (!key) {
@@ -132,10 +165,52 @@ class DirAskGPTV2 {
     }
 
     if (publicKey === true) {
-      let keep_going = await this.checkQuoteAvailability(server_base_url);
+      let keep_going = await this.checkQuoteAvailability();
       if (keep_going === false) {
         if (this.log) { console.log("DirAskGPT - Quota exceeded for tokens. Skip the action")}
-        callback();
+        await this.chatbot.addParameter("flowError", "AskGPT Error: tokens quota exceeded");
+        await this.#executeCondition(false, trueIntent, trueIntentAttributes, falseIntent, falseIntentAttributes);
+        callback(true);  
+        return;
+      }
+    }
+
+    let ns;
+
+    if (action.namespaceAsName) {
+      // Namespace could be an attribute
+      const filled_namespace = filler.fill(action.namespace, requestVariables)
+      ns = await this.getNamespace(filled_namespace, null);
+      namespace = ns?.id;
+      if (this.log) { console.log("DirAskGPT - Retrieved namespace id from name ", namespace); }
+    } else {
+      ns = await this.getNamespace(null, namespace);
+    }
+
+    if (!ns) {
+      await this.#assignAttributes(action, answer);
+      await this.chatbot.addParameter("flowError", "AskGPT Error: namespace not found");
+      if (falseIntent) {
+        await this.#executeCondition(false, trueIntent, trueIntentAttributes, falseIntent, falseIntentAttributes);
+        callback(true);
+        return;
+      }
+      callback();
+      return;
+    }
+
+    if (ns.engine) {
+      engine = ns.engine;
+    } else {
+      engine = await this.setDefaultEngine()
+    }
+    
+    if (!namespace) {
+      console.log("DirAskGPT - Error: namespace is undefined")
+      if (falseIntent) {
+        await this.chatbot.addParameter("flowError", "AskGPT Error: namespace is undefined");
+        await this.#executeCondition(false, trueIntent, trueIntentAttributes, falseIntent, falseIntentAttributes);
+        callback(true);
         return;
       }
     }
@@ -143,8 +218,10 @@ class DirAskGPTV2 {
     let json = {
       question: filled_question,
       gptkey: key,
-      namespace: this.context.projectId,
-      model: model
+      namespace: namespace,
+      model: model,
+      citations: citations,
+      engine: engine
     };
     if (top_k) {
       json.top_k = top_k;
@@ -155,13 +232,24 @@ class DirAskGPTV2 {
     if (max_tokens) {
       json.max_tokens = max_tokens;
     }
-    if (filled_context) {
-      json.context = filled_context;
+    
+    if (!action.advancedPrompt) {
+      if (filled_context) {
+        json.system_context = filled_context + "\n" + contexts[model];
+      } else {
+        json.system_context = contexts[model];
+      }
+    } else {
+      json.system_context = filled_context;
+    }
+
+    if (transcript) {
+      json.chat_history_dict = await this.transcriptToLLM(transcript);
     }
+
     if (this.log) { console.log("DirAskGPT json:", json); }
 
     const HTTPREQUEST = {
-      // url: server_base_url + "/" + this.context.projectId + "/kb/qa",
       url: kb_endpoint + "/qa",
       headers: {
         'Content-Type': 'application/json',
@@ -178,11 +266,13 @@ class DirAskGPTV2 {
           console.log("DirAskGPT error: ", err);
         }
         if (this.log) { console.log("DirAskGPT resbody:", resbody); }
-        let answer = resbody.answer;
-        let source = resbody.source;
-        await this.#assignAttributes(action, answer, source);
+        
+        // let answer = resbody.answer;
+        // let source = resbody.source;
+        // await this.#assignAttributes(action, answer, source);
 
         if (err) {
+          await this.#assignAttributes(action, answer, source);
           if (callback) {
             if (falseIntent) {
               await this.#executeCondition(false, trueIntent, trueIntentAttributes, falseIntent, falseIntentAttributes);
@@ -195,9 +285,13 @@ class DirAskGPTV2 {
         }
         else if (resbody.success === true) {
 
+          await this.#assignAttributes(action, resbody.answer, resbody.source);
           if (publicKey === true) {
-            let token_usage = resbody.prompt_token_size;
-            this.updateQuote(server_base_url, token_usage);
+            let tokens_usage = {
+              tokens: resbody.prompt_token_size,
+              model: json.model
+            }
+            this.updateQuote(tokens_usage);
           }
 
           if (trueIntent) {
@@ -208,6 +302,7 @@ class DirAskGPTV2 {
           callback();
           return;
         } else {
+          await this.#assignAttributes(action, answer, source);
           if (falseIntent) {
             await this.#executeCondition(false, trueIntent, trueIntentAttributes, falseIntent, falseIntentAttributes);
             callback(true);
@@ -325,18 +420,18 @@ class DirAskGPTV2 {
         }
       })
       .catch((error) => {
-        // console.error("An error occurred:", JSON.stringify(error.data));
+        console.error("(DirAskGPT) Axios error: ", JSON.stringify(error));
         if (callback) {
           callback(error, null);
         }
       });
   }
 
-  async getKeyFromIntegrations(server_base_url) {
+  async getKeyFromIntegrations() {
     return new Promise((resolve) => {
 
       const INTEGRATIONS_HTTPREQUEST = {
-        url: server_base_url + "/" + this.context.projectId + "/integration/name/openai",
+        url: this.API_ENDPOINT + "/" + this.context.projectId + "/integration/name/openai",
         headers: {
           'Content-Type': 'application/json',
           'Authorization': 'JWT ' + this.context.token
@@ -364,11 +459,11 @@ class DirAskGPTV2 {
     })
   }
 
-  async getKeyFromKbSettings(server_base_url) {
+  async getKeyFromKbSettings() {
     return new Promise((resolve) => {
 
       const KB_HTTPREQUEST = {
-        url: server_base_url + "/" + this.context.projectId + "/kbsettings",
+        url: this.API_ENDPOINT + "/" + this.context.projectId + "/kbsettings",
         headers: {
           'Content-Type': 'application/json',
           'Authorization': 'JWT ' + this.context.token
@@ -394,11 +489,11 @@ class DirAskGPTV2 {
     })
   }
 
-  async checkQuoteAvailability(server_base_url) {
+  async checkQuoteAvailability() {
     return new Promise((resolve) => {
 
       const HTTPREQUEST = {
-        url: server_base_url + "/" + this.context.projectId + "/quotes/tokens",
+        url: this.API_ENDPOINT + "/" + this.context.projectId + "/quotes/tokens",
         headers: {
           'Content-Type': 'application/json',
           'Authorization': 'JWT ' + this.context.token
@@ -424,16 +519,16 @@ class DirAskGPTV2 {
     })
   }
 
-  async updateQuote(server_base_url, tokens) {
-    return new Promise((resolve) => {
+  async updateQuote(tokens_usage) {
+    return new Promise((resolve, reject) => {
 
       const HTTPREQUEST = {
-        url: server_base_url + "/" + this.context.projectId + "/quotes/incr/tokens",
+        url: this.API_ENDPOINT + "/" + this.context.projectId + "/quotes/incr/tokens",
         headers: {
           'Content-Type': 'application/json',
           'Authorization': 'JWT ' + this.context.token
         },
-        json: { tokens: tokens },
+        json: tokens_usage,
         method: "POST"
       }
       if (this.log) { console.log("DirAskGPT check quote availability HTTPREQUEST", HTTPREQUEST); }
@@ -442,9 +537,9 @@ class DirAskGPTV2 {
         HTTPREQUEST, async (err, resbody) => {
           if (err) {
             console.error("(httprequest) DirAskGPT Increment tokens quote err: ", err);
-            rejects(false)
+            reject(false)
           } else {
-            console.log("(httprequest) DirAskGPT Increment token quote resbody: ", resbody);
+            // console.log("(httprequest) DirAskGPT Increment token quote resbody: ", resbody);
             resolve(true);
           }
         }
@@ -452,6 +547,98 @@ class DirAskGPTV2 {
     })
   }
 
+  /**
+   * Transforms the transcirpt array in a dictionary like '0': { "question": "xxx", "answer":"xxx"}
+   * merging consecutive messages with the same role in a single question or answer.
+   * If the first message was sent from assistant, this will be deleted.
+   */
+  async transcriptToLLM(transcript) {
+    
+    let objectTranscript = {};
+
+    if (transcript.length === 0) {
+      return objectTranscript;
+    }
+
+    let mergedTranscript = [];
+    let current = transcript[0];
+
+    for (let i = 1; i < transcript.length; i++) {
+      if (transcript[i].role === current.role) {
+        current.content += '\n' + transcript[i].content;
+      } else {
+        mergedTranscript.push(current);
+        current = transcript[i]
+      }
+    }
+    mergedTranscript.push(current);
+
+    if (mergedTranscript[0].role === 'assistant') {
+      mergedTranscript.splice(0, 1)
+    }
+
+    let counter = 0;
+    for (let i = 0; i < mergedTranscript.length - 1; i += 2) {
+      // Check if [i] is role user and [i+1] is role assistant??
+      assert(mergedTranscript[i].role === 'user');
+      assert(mergedTranscript[i+1].role === 'assistant');
+
+      if (!mergedTranscript[i].content.startsWith('/')) {
+        objectTranscript[counter] = {
+          question: mergedTranscript[i].content,
+          answer: mergedTranscript[i+1].content
+        }
+        counter++;
+      }
+    }
+
+    return objectTranscript;
+  }
+
+  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"
+      }
+      if (this.log) { console.log("DirAskGPT get all namespaces HTTPREQUEST", HTTPREQUEST); }
+      this.#myrequest(
+        HTTPREQUEST, async (err, namespaces) => {
+          if (err) {
+            console.error("(httprequest) DirAskGPT get all namespaces err: ", err);
+            resolve(null)
+          } else {
+            if (this.log) { console.log("(httprequest) DirAskGPT 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);
+    })
+  }
 
 }
 

package/tiledeskChatbotPlugs/directives/DirAssign.js

@@ -10,17 +10,6 @@ class DirAssign {
       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
-    // }
     this.log = context.log;
   }
 

package/tiledeskChatbotPlugs/directives/DirAssignFromFunction.js

@@ -9,27 +9,17 @@ class DirAssignFromFunction {
       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
-    // }
-    this.tdclient = context.tdclient;
-    // new TiledeskClient({
-    //   projectId: context.projectId,
-    //   token: context.token,
-    //   APIURL: context.TILEDESK_APIURL,
-    //   APIKEY: "___",
-    //   log: context.log
-    // });
     this.log = context.log;
     this.tdcache = context.tdcache;
+    this.API_ENDPOINT = context.API_ENDPOINT;
+
+    this.tdClient = new TiledeskClient({
+      projectId: this.context.projectId,
+      token: this.context.token,
+      APIURL: this.API_ENDPOINT,
+      APIKEY: "___",
+      log: this.log
+    });
   }
 
   async execute(directive, callback) {
@@ -77,7 +67,7 @@ class DirAssignFromFunction {
   async invoke(functionName, callback) {
     switch (functionName) {
       case "openNow":
-        this.tdclient.openNow((err, result) => {
+        this.tdClient.openNow((err, result) => {
           if (this.log) {console.log("openNow():", result);}
           if (err) {
             callback(err);
@@ -91,7 +81,7 @@ class DirAssignFromFunction {
         });
         break;
       case "availableAgents":
-        this.tdclient.getProjectAvailableAgents((err, agents) => {
+        this.tdClient.getProjectAvailableAgents((err, agents) => {
           if (this.log) {console.log("Agents on 'open'", agents);}
           if (err || !agents) {
             console.error("Error getting available agents in DirWhenAvailableAgents", err);