@cognigy/rest-api-client 0.17.0 → 0.19.0

package/build/shared/charts/descriptors/agentAssist/helpers/knowledgeSearch/followUpDetection.helper.js

@@ -0,0 +1,72 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.detectFollowUp = void 0;
+const getInitialPrompt = ({ recentConversation, value, }) => {
+    const prompt = `Below is the transcript of a conversation:
+${recentConversation}
+USER: ${value}
+Does the last USER input refer to the conversation before?
+Answer with "true" or "false". Answer:`;
+    return prompt;
+};
+const getFollowUpPrompt = ({ lastRoundTrip, value, }) => {
+    const prompt = `You are tasked to rewrite a question based on a context, so that the question is clearer.
+
+Example:
+Context: 
+USER: Where is Germany?
+BOT: Germany is in Europe.
+Question: Is that a continent?
+New: Is Europe a continent?
+
+Task: 
+Context:
+${lastRoundTrip}
+Question: ${value}
+New: `;
+    return prompt;
+};
+async function detectFollowUp({ value, cognigy, followUpDetectionSteps, }) {
+    var _a, _b, _c, _d, _e;
+    const { api, input } = cognigy;
+    let prompt;
+    let lastRoundTrip;
+    // this is a fallback in case the node was created before this function was added and followUpDetectionSteps is undefined
+    followUpDetectionSteps = followUpDetectionSteps || 2;
+    let promptResponse;
+    // check whether we're in an flow execution that's not the first
+    // as it doesn't make sense to check for follow ups in the first execution
+    if (input.execution > 1) {
+        // always remember the last thing the user said (needed later)
+        lastRoundTrip = (_a = cognigy.lastConversationEntries) === null || _a === void 0 ? void 0 : _a.slice(1, 3).reverse().map((entry) => "- " + (entry.source === "user" ? "USER: " : "BOT: ") + entry.text).join("\n");
+        // if follow up detection is set to 2 or more, we use the conversation transcript
+        // as reference. Start at the second entry, because the first one is the current
+        const recentConversation = (_b = cognigy.lastConversationEntries) === null || _b === void 0 ? void 0 : _b.slice(1, followUpDetectionSteps + 1).reverse().map((entry) => "- " + (entry.source === "user" ? "USER: " : "BOT: ") + entry.text).join("\n");
+        prompt = getInitialPrompt({
+            recentConversation,
+            value,
+        });
+        try {
+            promptResponse = await ((_c = api.runGenerativeAIPrompt) === null || _c === void 0 ? void 0 : _c.call(api, { prompt }, "answerExtraction"));
+            // check if LLM thinks the input was a follow up question and rewrite it
+            if (promptResponse === null || promptResponse === void 0 ? void 0 : promptResponse.toLowerCase().includes("true")) {
+                prompt = getFollowUpPrompt({
+                    lastRoundTrip,
+                    value,
+                });
+                promptResponse = await ((_d = api.runGenerativeAIPrompt) === null || _d === void 0 ? void 0 : _d.call(api, { prompt }, "answerExtraction"));
+            }
+            else {
+                // if there is no question to rewrite, no response is provided to not override original input
+                promptResponse = undefined;
+            }
+        }
+        catch (err) {
+            (_e = api.log) === null || _e === void 0 ? void 0 : _e.call(api, "error", "Search Extract Output. Error when trying to rewrite follow up input: " +
+                err.message);
+        }
+    }
+    return promptResponse;
+}
+exports.detectFollowUp = detectFollowUp;
+//# sourceMappingURL=followUpDetection.helper.js.map

package/build/shared/charts/descriptors/agentAssist/helpers/knowledgeSearch/knowledgeSearch.helper.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.performKnowledgeSearch = void 0;
+const errors_1 = require("../../../../../errors");
+async function performKnowledgeSearch({ api, config, query, input, errorHandler, }) {
+    var _a;
+    let knowledgeSearchResponseData;
+    const { language, traceId } = input;
+    const { topK = 5, searchStoreLocation = "default", searchStoreLocationContextKey = "knowledgeSearch", searchStoreLocationInputKey = "knowledgeSearch", } = config;
+    const knowledgeStoreId = (_a = config === null || config === void 0 ? void 0 : config.knowledgeStoreId) === null || _a === void 0 ? void 0 : _a.trim();
+    const data = {
+        language: language,
+        query,
+        topK: topK,
+        traceId: traceId,
+        disableSensitiveLogging: false,
+    };
+    // Add knowledgeStoreIds to data
+    if (knowledgeStoreId) {
+        data.knowledgeStoreIds = [knowledgeStoreId];
+    }
+    // Perform knowledge search
+    try {
+        const knowledgeSearchResponse = await api.knowledgeSearch(data);
+        // Handle possible response errors
+        if ((knowledgeSearchResponse === null || knowledgeSearchResponse === void 0 ? void 0 : knowledgeSearchResponse.status) !== "success") {
+            const errorMessage = (knowledgeSearchResponse === null || knowledgeSearchResponse === void 0 ? void 0 : knowledgeSearchResponse.error) || "empty";
+            throw new Error(`Error while performing knowledge search. Remote returned error: ${errorMessage}`);
+        }
+        if (!(knowledgeSearchResponse === null || knowledgeSearchResponse === void 0 ? void 0 : knowledgeSearchResponse.data)) {
+            throw new Error("Error while performing knowledge search. Remote returned empty response.");
+        }
+        knowledgeSearchResponseData = knowledgeSearchResponse.data;
+    }
+    catch (error) {
+        await errorHandler(error, knowledgeSearchResponseData);
+        throw error;
+    }
+    // Save result
+    switch (searchStoreLocation) {
+        case "context":
+            // @ts-ignore
+            api.addToContext(searchStoreLocationContextKey, knowledgeSearchResponseData, "simple");
+            break;
+        case "default":
+        case "input":
+            api.addToInput(searchStoreLocationInputKey, knowledgeSearchResponseData);
+            break;
+        default:
+            throw new errors_1.InternalServerError(`Error while performing knowledge search. Store location was invalid. Value was: ${searchStoreLocation}`, {
+                traceId,
+                disableSensitiveLogging: data === null || data === void 0 ? void 0 : data.disableSensitiveLogging,
+            });
+    }
+    return knowledgeSearchResponseData;
+}
+exports.performKnowledgeSearch = performKnowledgeSearch;
+//# sourceMappingURL=knowledgeSearch.helper.js.map

package/build/shared/charts/descriptors/agentAssist/helpers/sentiment.helper.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.sentimentAnalysis = void 0;
+const sentimentList = ["Positive", "Neutral", "Negative"];
 /**
  * This method is used to analyze the sentiment based on the given prompt string.
  * It returns either the detected sentiment or 'Neutral' if the sentiment could not be detected or was not clear.
@@ -9,18 +10,16 @@ exports.sentimentAnalysis = void 0;
  * @param prompt The prompt to be analyzed
  */
 const sentimentAnalysis = async (api, prompt) => {
-    let sentiment = "";
+    var _a;
     const payload = {
         prompt,
         useCase: "sentimentAnalysis",
     };
-    const llmResponse = await api.runGenerativeAIPrompt(payload, "sentimentAnalysis");
-    //TODO: remove if the lookup works
-    api.log("info", `Sentiment: ${llmResponse}`);
+    const llmResponse = await ((_a = api.runGenerativeAIPrompt) === null || _a === void 0 ? void 0 : _a.call(api, payload, "sentimentAnalysis"));
     if (llmResponse) {
-        sentiment = getSentiment(llmResponse);
+        return getSentiment(llmResponse);
     }
-    return sentiment;
+    return "";
 };
 exports.sentimentAnalysis = sentimentAnalysis;
 /**
@@ -30,12 +29,7 @@ exports.sentimentAnalysis = sentimentAnalysis;
  * @param text The text to be analyzed
  */
 function getSentiment(text) {
-    const sentimentList = ["Positive", "Neutral", "Negative"];
-    for (let sentiment of sentimentList) {
-        if (text.includes(sentiment) || text.includes(sentiment.toLowerCase())) {
-            return sentiment;
-        }
-    }
-    return sentimentList[1];
+    var _a;
+    return (_a = sentimentList.find((sentiment) => text.toLowerCase().includes(sentiment.toLowerCase()))) !== null && _a !== void 0 ? _a : "Neutral";
 }
 //# sourceMappingURL=sentiment.helper.js.map

package/build/shared/charts/descriptors/agentAssist/htmlTemplates/identityAssistTemplate.js

@@ -1,27 +1,24 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const identityAssistTemplate = ({ widgetLayout = "horizontal", imageShape = "round", imageUrl, customer, customerData, }) => {
+const identityAssistTemplate = ({ widgetLayout = "horizontal", imageShape = "round", imageUrl, customer, customerData, fontSize, profileFontSize, keyValueFontSize, showProfileImage, profileImageSize }) => {
     const imageClass = imageShape === "round" ? "rounded-full" : "rounded-none";
     let layoutClass = "";
     let marginClass = "";
     let textClass = "";
     let imageHTML = "";
     let customerDataHTML = "";
-    layoutClass +=
-        widgetLayout === "horizontal"
-            ? ""
-            : "flex-col";
+    layoutClass += widgetLayout === "horizontal" ? "" : "flex-col";
     marginClass = widgetLayout === "horizontal" ? "ml-2" : "";
     imageHTML = `
-			<div class="mt-6 flex justify-center" style="min-width: 130px;">
-			<img class="h-32 w-32 object-cover ${marginClass} ${imageClass}" src="${imageUrl || 'https://cdn-icons-png.flaticon.com/512/149/149071.png'}" alt="User Avatar" />
+			<div class="mt-6 flex justify-center">
+			<img class="${profileImageSize} object-cover ${marginClass} ${imageClass}" src="${imageUrl || "https://cdn-icons-png.flaticon.com/512/149/149071.png"}" alt="User Avatar" />
 			</div>
 		`;
     if (widgetLayout === "horizontal") {
         textClass = "flex-grow";
     }
     for (const [key, value] of Object.entries(customerData)) {
-        customerDataHTML += `<p class="mt-1 text-gray-500">${key}: ${value}</p>`;
+        customerDataHTML += `<p class="mt-1 ${keyValueFontSize} text-gray-500">${key}: ${value}</p>`;
     }
     return `
 	<!DOCTYPE html>
@@ -34,18 +31,20 @@ const identityAssistTemplate = ({ widgetLayout = "horizontal", imageShape = "rou
 	</head>
 	<body>
 		<div class="flex h-screen items-center justify-center bg-gray-100">
-		<div class="h-full w-full rounded-lg bg-white shadow-md overflow-hidden">
-		<div class="flex h-full ${layoutClass}">
-		${imageHTML}
-		<div class="mt-2 pl-4 pt-4 pb-4 flex flex-col h-full break-all overflow-hidden ${textClass}">
-		<div class="text-sm pl-4 font-semibold uppercase tracking-wide text-indigo-500">User Profile</div>
-		<div class="mt-2 pl-4 text-xl font-semibold">${customer}</div>
-			<div class="flex-grow overflow-auto p-4 h-full break-words">
-				${customerDataHTML}
+			<div class="h-full w-full rounded-lg bg-white shadow-md overflow-hidden">
+				<div class="flex h-full ${layoutClass}">
+					${showProfileImage ? imageHTML : ''}
+					<div class="mt-2 pl-4 pt-4 pb-4 flex flex-col h-full break-all overflow-hidden ${textClass}">
+							<div class="${fontSize} pl-4 font-semibold uppercase tracking-wide text-indigo-500">User Profile</div>
+							<div class="mt-2 pl-4 ${profileFontSize} font-semibold">
+							${customer}
+							</div>
+							<div class="flex-grow overflow-auto p-4 h-full break-words">
+									${customerDataHTML}
+							</div>
+					</div>
 				</div>
 			</div>
-			</div>
-		</div>
 		</div>
 	</body>
 	</html>`;