@tiledesk/tiledesk-tybot-connector 2.0.33 → 2.0.34

package/package.json

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

package/tiledeskChatbotPlugs/directives/DirAskGPTV2.js

@@ -30,11 +30,6 @@ class DirAskGPTV2 {
     
     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 });
-
-    this.rerankingOff = false;
-    if (process.env.RERANKING_OFF && (process.env.RERANKING_OFF === "true" || process.env.RERANKING_OFF === true)) {
-      this.rerankingOff = true;
-    }
   }
 
   execute(directive, callback) {
@@ -63,7 +58,6 @@ class DirAskGPTV2 {
       return;
     }
 
-    let publicKey = false;
     let trueIntent = action.trueIntent;
     let falseIntent = action.falseIntent;
     let trueIntentAttributes = action.trueIntentAttributes;
@@ -74,11 +68,11 @@ class DirAskGPTV2 {
     winston.debug("DirAskGPTV2 trueIntentAttributes", trueIntentAttributes)
     winston.debug("DirAskGPTV2 falseIntentAttributes", falseIntentAttributes)
   
-
     // default values
     let answer = "No answers";
     let namespace = this.context.projectId;
-    let model = "gpt-3.5-turbo";
+    let llm;
+    let model;
     let temperature;
     let max_tokens;
     let top_k;
@@ -87,7 +81,8 @@ class DirAskGPTV2 {
     let citations = false;
     let chunks_only = 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 reranking;
+    let skip_unanswered;
 
     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}####",
@@ -105,16 +100,18 @@ class DirAskGPTV2 {
 
     let source = null;
 
-    if (!action.question || action.question === '') {
-      this.logger.error("[Ask Knowledge Base] question attribute is mandatory");
-      winston.error("DirAskGPTV2 Error: question attribute is mandatory. Executing condition false...");
+    await this.checkMandatoryParameters(action).catch( async (missing_param) => {
+      this.logger.error(`[Ask Knowledge Base] missing attribute '${missing_param}'`);
+      await this.chatbot.addParameter("flowError", `AskKnowledgeBase Error: '${missing_param}' attribute is undefined`);
       await this.#assignAttributes(action, answer, source);
       if (falseIntent) {
         await this.#executeCondition(false, trueIntent, trueIntentAttributes, falseIntent, falseIntentAttributes);
+        callback(true);
+        return Promise.reject();
       }
-      callback(true);
-      return;
-    }
+      callback();
+      return Promise.reject();
+    })
 
     if (action.namespace) {
       namespace = action.namespace;
@@ -122,30 +119,27 @@ class DirAskGPTV2 {
     if (action.model) {
       model = action.model;
     }
-
     if (action.top_k) {
       top_k = action.top_k;
     }
-
     if (action.temperature) {
       temperature = action.temperature;
     }
-
     if (action.max_tokens) {
       max_tokens = action.max_tokens;
     }
-
     if (action.alpha) {
       alpha = action.alpha;
     }
-
     if (action.citations) {
       citations = action.citations;
     }
-
     if (action.chunks_only) {
       chunks_only = action.chunks_only;
     }
+    if (action.reranking) {
+      reranking = action.reranking;
+    }
 
     let requestVariables = null;
     requestVariables =
@@ -175,41 +169,67 @@ class DirAskGPTV2 {
       }
     }
 
-    let key = await integrationService.getKeyFromIntegrations(this.projectId, 'openai', this.token);
-    if (!key) {
-      this.logger.native("[Ask Knowledge Base] OpenAI key not found in Integration. Using shared OpenAI key");
-      winston.verbose("DirAskGPTV2 - Key not found in Integrations. Searching in kb settings...");
-      key = await kbService.getKeyFromKbSettings(this.projectId, this.token);
-    }
-
-    if (!key) {
-      winston.verbose("DirAskGPTV2 - Retrieve public gptkey")
-      key = process.env.GPTKEY;
-      publicKey = true;
+    let key;
+    let publicKey = false;
+    let ollama_integration;
+
+    if (action.llm === 'ollama') {
+      ollama_integration = await integrationService.getIntegration(this.projectId, action.llm, this.token).catch( async (err) => {
+        this.logger.error("[Ask Knowledge Base] Error getting ollama integration.");
+        await this.chatbot.addParameter("flowError", "Ollama integration not found");
+        if (falseIntent) {
+          await this.#executeCondition(false, trueIntent, trueIntentAttributes, falseIntent, falseIntentAttributes);
+          callback(true);
+          return;
+        }
+        callback();
+        return;
+      })
     } else {
-      this.logger.native("[Ask Knowledge Base] use your own OpenAI key")
-    }
+      key = await integrationService.getKeyFromIntegrations(this.projectId, action.llm, this.token);
 
-    if (!key) {
-      winston.info("DirAskGPTV2 Error: gptkey is mandatory");
-      await this.#assignAttributes(action, answer);
-      if (falseIntent) {
-        await this.#executeCondition(false, trueIntent, trueIntentAttributes, falseIntent, falseIntentAttributes);
-        callback(true);
+      if (!key && action.llm === 'openai') {
+        this.logger.native("[Ask Knowledge Base] OpenAI key not found in Integration. Retrieve shared OpenAI key.");
+        key = process.env.GPTKEY;
+        publicKey = true;
+      }
+
+      if (!key) {
+        this.logger.error(`[Ask Knowledge Base] llm key for ${action.llm} not found in integrations`);
+        await this.chatbot.addParameter("flowError", `AskKnowledgeBase Error: missing key for llm ${action.llm}`);
+        if (falseIntent) {
+          await this.#executeCondition(false, trueIntent, trueIntentAttributes, falseIntent, falseIntentAttributes);
+          callback(true);
+          return;
+        }
+        callback();
         return;
       }
-      callback();
-      return;
     }
 
     if (publicKey === true && !chunks_only) {
-      let keep_going = await quotasService.checkQuoteAvailability(this.projectId, this.token);
-      if (keep_going === false) {
-        this.logger.warn("[Ask Knowledge Base] Tokens quota exceeded. Skip the action")
-        winston.verbose("DirAskGPTV2 - Quota exceeded for tokens. Skip the action")
-        await this.chatbot.addParameter("flowError", "AskGPT Error: tokens quota exceeded");
-        await this.#executeCondition(false, trueIntent, trueIntentAttributes, falseIntent, falseIntentAttributes);
-        callback(true);  
+      try {
+        let keep_going = await quotasService.checkQuoteAvailability(this.projectId, this.token)
+        if (keep_going === false) {
+          this.logger.warn("[AI Prompt] OpenAI tokens quota exceeded");
+          await this.chatbot.addParameter("flowError", "GPT Error: tokens quota exceeded");
+          if (falseIntent) {
+            await this.#executeCondition(false, trueIntent, trueIntentAttributes, falseIntent, falseIntentAttributes);
+            callback();
+            return;
+          }
+          callback();
+          return;
+        }
+      } catch (err) {
+        this.logger.error("An error occured on checking token quota availability");
+        await this.chatbot.addParameter("flowError", "An error occured on checking token quota availability");
+        if (falseIntent) {
+          await this.#executeCondition(false, trueIntent, trueIntentAttributes, falseIntent, falseIntentAttributes);
+          callback();
+          return;
+        }
+        callback();
         return;
       }
     }
@@ -262,6 +282,7 @@ class DirAskGPTV2 {
       question: filled_question,
       gptkey: key,
       namespace: namespace,
+      llm: llm,
       model: model,
       citations: citations,
       engine: engine,
@@ -280,6 +301,16 @@ class DirAskGPTV2 {
       json.chunks_only = chunks_only;
     }
 
+    if (llm === 'ollama') {
+      json.gptkey = "";
+      json.model = {
+        name: action.model,
+        url: ollama_integration.value.url,
+        token: ollama_integration.value.token
+      }
+      json.stream = false;
+    }
+
 
     if (ns.hybrid === true) {
       json.search_type = 'hybrid';
@@ -301,13 +332,12 @@ class DirAskGPTV2 {
       json.chat_history_dict = await this.transcriptToLLM(transcript);
     }
 
-    if (!this.rerankingOff) {
+    if (reranking === true) {
       json.reranking = true;
       json.reranking_multiplier = 3;
       json.reranker_model = "cross-encoder/ms-marco-MiniLM-L-6-v2";
     }
 
-
     winston.debug("DirAskGPTV2 json:", json);
 
     let kb_endpoint = process.env.KB_ENDPOINT_QA;
@@ -331,7 +361,8 @@ class DirAskGPTV2 {
       HTTPREQUEST, async (err, resbody) => {
         
         if (err) {
-          winston.error("DirAskGPTV2 error: ", err?.respose);
+          winston.error("DirAskGPTV2 error: ", err?.response);
+          this.logger.error(`[Ask Knowledge Base] Error getting answer`);
           await this.#assignAttributes(action, answer, source);
           if (callback) {
             if (falseIntent) {
@@ -357,7 +388,7 @@ class DirAskGPTV2 {
 
           } else {
             await this.#assignAttributes(action, resbody.answer, resbody.source, resbody.content_chunks);
-            if (publicKey === true) {
+            if (publicKey === true && !chunks_only) {
               let tokens_usage = {
                 tokens: resbody.prompt_token_size,
                 model: json.model
@@ -377,10 +408,12 @@ class DirAskGPTV2 {
           }
         } else {
           await this.#assignAttributes(action, answer, source);
-          kbService.addUnansweredQuestion(this.projectId, json.namespace, json.question, this.token).catch((err) => {
-            winston.error("DirAskGPTV2 - Error adding unanswered question: ", err);
-            this.logger.warn("[Ask Knowledge Base] Unable to add unanswered question", json.question, "to namespacae", json.namespace);
-          })
+          if (!skip_unanswered) {
+            kbService.addUnansweredQuestion(this.projectId, json.namespace, json.question, this.token).catch((err) => {
+              winston.error("DirAskGPTV2 - Error adding unanswered question: ", err);
+              this.logger.warn("[Ask Knowledge Base] Unable to add unanswered question", json.question, "to namespacae", json.namespace);
+            })
+          }
           if (falseIntent) {
             await this.#executeCondition(false, trueIntent, trueIntentAttributes, falseIntent, falseIntentAttributes);
             callback(true);
@@ -451,6 +484,18 @@ class DirAskGPTV2 {
     }
   }
 
+  async checkMandatoryParameters(action) {
+    return new Promise((resolve, reject) => {
+      let params = ['question', 'llm', 'model']; // mandatory params
+      params.forEach((p) => {
+        if (!action[p]) {
+          reject(p)
+        }
+      })
+      resolve(true);
+    })
+  }
+
   /**
    * 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.