@cognigy/rest-api-client 0.17.0 → 0.19.0

package/build/shared/charts/descriptors/nlu/cleanText.js

@@ -84,6 +84,7 @@ exports.CLEAN_TEXT = (0, createNodeDescriptor_1.createNodeDescriptor)({
                 localeToUse = cleanTextLocale;
             }
             const result = new textCleaner_1.TextCleaner(localeToUse, additionalAllowedCharacters, additionalMappedSymbols, additionalSpecialPhrases, additionalPhoneticAlphabet).cleanAll(textToClean, options, (_b = input === null || input === void 0 ? void 0 : input.nlu) === null || _b === void 0 ? void 0 : _b.detailedSlots);
+            result !== textToClean && api.logDebugMessage(`UI__DEBUG_MODE__CLEAN_TEXT__MESSAGE ${textToClean}<br>UI__DEBUG_MODE__CLEAN_TEXT__MESSAGE_2 ${result}`);
             if (storeLocation === "context") {
                 api.addToContext(contextKeyToStoreResult, result, "simple");
             }

package/build/shared/charts/descriptors/nlu/fuzzySearch.js

@@ -211,7 +211,8 @@ exports.FUZZY_SEARCH = (0, createNodeDescriptor_1.createNodeDescriptor)({
         { type: "section", key: "storageOption" }
     ],
     function: async ({ cognigy, config }) => {
-        const { api } = cognigy;
+        var _a, _b, _c, _d, _e, _f, _g;
+        const { api, input } = cognigy;
         const { searchPattern, items, distance, findAllMatches, ignoreLocation, includeMatches, includeScore, isCaseSensitive, location, minMatchCharLength, shouldSort, threshold, storeLocation, inputKey, contextKey } = config;
         if (!searchPattern)
             throw new Error("No search pattern provided.");
@@ -244,11 +245,31 @@ exports.FUZZY_SEARCH = (0, createNodeDescriptor_1.createNodeDescriptor)({
                         }
                     });
                 }
+                if (result && result.length > 0 && ((_a = result === null || result === void 0 ? void 0 : result[0]) === null || _a === void 0 ? void 0 : _a.item) && (input.endpointType === "adminconsole" || api.getMetadata().isFollowSessionActive)) {
+                    let debugMessage = `Found ${result.length} match${result.length > 1 ? 'es' : ''}.<br><br>`;
+                    if (result.length > 3) {
+                        debugMessage += `Top 3:<br>`;
+                    }
+                    if (result.length >= 1 && ((_b = result === null || result === void 0 ? void 0 : result[0]) === null || _b === void 0 ? void 0 : _b.item) && ((_c = result === null || result === void 0 ? void 0 : result[0]) === null || _c === void 0 ? void 0 : _c.score)) {
+                        debugMessage += `1. ${result[0].item} (score: ${result[0].score})<br>`;
+                    }
+                    if (result.length >= 2 && ((_d = result === null || result === void 0 ? void 0 : result[1]) === null || _d === void 0 ? void 0 : _d.item) && ((_e = result === null || result === void 0 ? void 0 : result[1]) === null || _e === void 0 ? void 0 : _e.score)) {
+                        debugMessage += `2. ${result[1].item} (score: ${result[1].score})<br>`;
+                    }
+                    if (result.length >= 3 && ((_f = result === null || result === void 0 ? void 0 : result[2]) === null || _f === void 0 ? void 0 : _f.item) && ((_g = result === null || result === void 0 ? void 0 : result[2]) === null || _g === void 0 ? void 0 : _g.score)) {
+                        debugMessage += `3. ${result[2].item} (score: ${result[2].score})`;
+                    }
+                    api.logDebugMessage(debugMessage, "Result Found");
+                }
+                else {
+                    api.logDebugMessage("UI__DEBUG_MODE__FUZZY_SEARCH__NO_RESULTS", "No Results");
+                }
             }
             else {
                 result = {
                     "error": `Source data file size limit (${getFuzzySearchMaxObjectSizeInBytes()} bytes) exceeded`
                 };
+                api.logDebugError(`Source data file size limit (${getFuzzySearchMaxObjectSizeInBytes()} bytes) exceeded`, "Size Limit Exceeded");
             }
             if (storeLocation === "context") {
                 api.addToContext(contextKey, result, "simple");
@@ -264,6 +285,7 @@ exports.FUZZY_SEARCH = (0, createNodeDescriptor_1.createNodeDescriptor)({
             else {
                 api.addToInput(inputKey, error);
             }
+            api.logDebugError(error.message, "Error");
         }
     }
 });

package/build/shared/charts/descriptors/nlu/generativeSlotFiller/prompt.js

@@ -80,7 +80,7 @@ exports.createLastConverationString = createLastConverationString;
     }
   ]
 */
-const createLastConversationChatObject = (lastConversationEntries, systemMessage, turnLimit = 100) => {
+const createLastConversationChatObject = (lastConversationEntries, systemMessage, turnLimit = 100, limitToOnlyUserMessages) => {
     const conversation = [];
     if (systemMessage) {
         conversation.push({
@@ -88,16 +88,31 @@ const createLastConversationChatObject = (lastConversationEntries, systemMessage
             content: systemMessage
         });
     }
-    lastConversationEntries === null || lastConversationEntries === void 0 ? void 0 : lastConversationEntries.slice(0, turnLimit).reverse().map(entry => {
-        // if text exists, add to conversation
-        // necessary to prevent data only messages from being added
-        if (entry === null || entry === void 0 ? void 0 : entry.text) {
-            conversation.push({
-                role: entry.source === "user" ? "user" : "assistant",
-                content: entry.text
-            });
-        }
-    });
+    if (limitToOnlyUserMessages) {
+        // limit the conversation entries to the last X messages with source user
+        lastConversationEntries === null || lastConversationEntries === void 0 ? void 0 : lastConversationEntries.filter(entry => entry.source === "user").slice(0, turnLimit).reverse().map(entry => {
+            var _a, _b;
+            if ((_b = (_a = entry === null || entry === void 0 ? void 0 : entry.text) === null || _a === void 0 ? void 0 : _a.trim()) === null || _b === void 0 ? void 0 : _b.length) {
+                conversation.push({
+                    role: "user",
+                    content: entry.text.trim()
+                });
+            }
+        });
+    }
+    else {
+        lastConversationEntries === null || lastConversationEntries === void 0 ? void 0 : lastConversationEntries.slice(0, turnLimit).reverse().map(entry => {
+            var _a, _b;
+            // if text exists, add to conversation
+            // necessary to prevent data only messages from being added
+            if ((_b = (_a = entry === null || entry === void 0 ? void 0 : entry.text) === null || _a === void 0 ? void 0 : _a.trim()) === null || _b === void 0 ? void 0 : _b.length) {
+                conversation.push({
+                    role: entry.source === "user" ? "user" : "assistant",
+                    content: entry.text.trim()
+                });
+            }
+        });
+    }
     return conversation;
 };
 exports.createLastConversationChatObject = createLastConversationChatObject;
@@ -120,7 +135,15 @@ exports.createLastUserInputString = createLastUserInputString;
  * @param cognigy the cognigy object (input, api, etc)
  */
 const writeLLMDebugLogs = async (label, prompt, response, debugLogTokenCount, debugLogRequestAndCompletion, cognigy) => {
-    const { api } = cognigy;
+    var _a, _b, _c, _d;
+    const { api, input } = cognigy;
+    if (input.endpointType !== "adminconsole" && !api.getMetadata().isFollowSessionActive) {
+        // only return logs if in interaction panel or following session
+        return;
+    }
+    // stringify the response if it is an object
+    const responseOutput = typeof response === "object" ? JSON.stringify(response.result || response) : response;
+    const responseOutputFormatted = typeof response === "object" ? JSON.stringify(response.result || response, null, 4) : response;
     // debug logs are only processed for the interaction panel
     if (debugLogRequestAndCompletion) {
         try {
@@ -128,15 +151,15 @@ const writeLLMDebugLogs = async (label, prompt, response, debugLogTokenCount, de
             let completionTokenMessage = "";
             if (debugLogTokenCount) {
                 if (prompt) {
-                    const requestTokens = await api.countGPTTokens(prompt);
+                    const requestTokens = ((_a = response === null || response === void 0 ? void 0 : response.usage) === null || _a === void 0 ? void 0 : _a.prompt_tokens) || await api.countGPTTokens(prompt);
                     requestTokenMessage = ` (${requestTokens} Tokens)`;
                 }
                 if (response) {
-                    const completionTokens = await api.countGPTTokens(response);
+                    const completionTokens = ((_b = response === null || response === void 0 ? void 0 : response.usage) === null || _b === void 0 ? void 0 : _b.completion_tokens) || await api.countGPTTokens(responseOutput);
                     completionTokenMessage = ` (${completionTokens} Tokens)`;
                 }
             }
-            api.log('debug', `${label} - Request${requestTokenMessage}: '${prompt}' - Completion${completionTokenMessage}: '${response}'`);
+            api.logDebugMessage(`UI__DEBUG_MODE__LLM_PROMPT__FULL_REQUEST__REQUEST${requestTokenMessage}:<br>${prompt}<br><br>UI__DEBUG_MODE__LLM_PROMPT__FULL_REQUEST__COMPLETION${completionTokenMessage}:<br>${responseOutputFormatted}`, "UI__DEBUG_MODE__LLM_PROMPT__FULL_REQUEST__HEADER");
         }
         catch (err) { }
     }
@@ -144,10 +167,13 @@ const writeLLMDebugLogs = async (label, prompt, response, debugLogTokenCount, de
         try {
             let requestTokens = 0;
             let completionTokens = 0;
-            requestTokens = prompt && await api.countGPTTokens(prompt);
-            completionTokens = response && await api.countGPTTokens(response);
-            const completionMessage = response ? ` - Completion Tokens: ${completionTokens} - Total Tokens: ${requestTokens + completionTokens}` : "";
-            api.log('debug', `${label} - Request Tokens: ${requestTokens} ${completionMessage}`);
+            requestTokens = ((_c = response.usage) === null || _c === void 0 ? void 0 : _c.prompt_tokens) || await api.countGPTTokens(prompt);
+            completionTokens = ((_d = response.usage) === null || _d === void 0 ? void 0 : _d.completion_tokens) || await api.countGPTTokens(responseOutput);
+            const requestTokenMessage = requestTokens || "unknown";
+            const completionTokenMessage = completionTokens || "unknown";
+            const totalTokens = (requestTokens + completionTokens) || "unknown";
+            const completionMessage = response ? `<br>UI__DEBUG_MODE__LLM_PROMPT__TOKEN_COUNT__COMPLETION_TOKENS: ${completionTokenMessage}<br>UI__DEBUG_MODE__LLM_PROMPT__TOKEN_COUNT__TOTAL_TOKENS: ${totalTokens}` : "";
+            api.logDebugMessage(`UI__DEBUG_MODE__LLM_PROMPT__TOKEN_COUNT__REQUEST_TOKENS: ${requestTokenMessage}${completionMessage}`, "UI__DEBUG_MODE__LLM_PROMPT__TOKEN_COUNT__HEADER");
         }
         catch (err) { }
     }

package/build/shared/charts/descriptors/nlu/index.js

@@ -1,12 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CLEAN_TEXT = exports.GENERATIVE_SLOT_FILLER_FALLBACK = exports.GENERATIVE_SLOT_FILLER_SUCCESS = exports.GENERATIVE_SLOT_FILLER = exports.FUZZY_SEARCH = exports.MATCH_PATTERN = exports.REGEX_SLOT_FILLER = exports.EXTRACT_ANSWER = exports.EXECUTE_COGNIGY_NLU = exports.ADD_LEXICON_KEYPHRASE = void 0;
+exports.CLEAN_TEXT = exports.GENERATIVE_SLOT_FILLER_FALLBACK = exports.GENERATIVE_SLOT_FILLER_SUCCESS = exports.GENERATIVE_SLOT_FILLER = exports.FUZZY_SEARCH = exports.MATCH_PATTERN = exports.REGEX_SLOT_FILLER = exports.EXECUTE_COGNIGY_NLU = exports.ADD_LEXICON_KEYPHRASE = void 0;
 var addLexiconKeyphrase_1 = require("./addLexiconKeyphrase");
 Object.defineProperty(exports, "ADD_LEXICON_KEYPHRASE", { enumerable: true, get: function () { return addLexiconKeyphrase_1.ADD_LEXICON_KEYPHRASE; } });
 var executeCognigyNLU_1 = require("./executeCognigyNLU");
 Object.defineProperty(exports, "EXECUTE_COGNIGY_NLU", { enumerable: true, get: function () { return executeCognigyNLU_1.EXECUTE_COGNIGY_NLU; } });
-var extractAnswer_1 = require("./extractAnswer");
-Object.defineProperty(exports, "EXTRACT_ANSWER", { enumerable: true, get: function () { return extractAnswer_1.EXTRACT_ANSWER; } });
 var regexSlotFiller_1 = require("./regexSlotFiller");
 Object.defineProperty(exports, "REGEX_SLOT_FILLER", { enumerable: true, get: function () { return regexSlotFiller_1.REGEX_SLOT_FILLER; } });
 var matchPattern_1 = require("./matchPattern");