@cognigy/rest-api-client 0.9.1 → 0.12.0

package/build/shared/charts/descriptors/nlu/utils/patternMatcher.js

@@ -0,0 +1,197 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.patternMatcher = void 0;
+/**
+ * Finds compound slots using pattern inside the user input
+ * @param input Cognigy Input Object
+ * @param patterns The patterns to check for
+ * @param patternGroupName Name for the compound group
+ * @param detailedCompoundSlots Store detailed results for compound slots
+ * @param tagExistingSlots Tag existing slots
+ * @param createNewSlots Create new slots from tags
+ * @param nluResult result from cognigy NLU since there was an alternative input
+ */
+const patternMatcher = (params) => {
+    const { input, patternGroupName, detailedCompoundSlots, tagExistingSlots, createNewSlots, nluResult } = params;
+    let { patterns } = params;
+    // prune patterns if more than 20
+    if (patterns.length > 20) {
+        patterns = patterns.slice(0, 20);
+    }
+    // firstly sort array to start with the longest patterns, as those will win
+    patterns.sort((a, b) => {
+        return b.length - a.length;
+    });
+    // we use let because we strip out found phrases later
+    let inputText = nluResult.text || input.text; // ci.processText
+    let inputSlots = nluResult.slots || input.slots;
+    const regexPatterns = [];
+    // go through patterns and create regex versions of each that is not empty string
+    patterns.forEach((pattern) => {
+        if (pattern) {
+            // set parsedPattern to pattern in case there are no slots
+            let parsedPattern = pattern;
+            // match all mentioned slots in the pattern
+            const foundSlots = pattern.match(/\@[\w>]+/g);
+            const tags = [];
+            const slots = [];
+            // if there are slots, process them
+            if (Array.isArray(foundSlots) && foundSlots.length > 0) {
+                foundSlots.forEach((slot) => {
+                    // splits tags from slots
+                    const split = slot.split(">");
+                    const slotName = split[0].replace("@", "");
+                    slots.push(slotName);
+                    // if there is a tag (SLOT>TAG), remember it
+                    if (split.length === 2)
+                        tags.push(split[1]);
+                    else
+                        tags.push("");
+                    const slotValues = [];
+                    if (inputSlots[slotName]) {
+                        switch (slotName) {
+                            case "DATE":
+                                inputSlots.DATE.forEach((s) => {
+                                    // just add the number
+                                    if (s.start)
+                                        slotValues.push(s["text"]);
+                                });
+                                break;
+                            case "TEMPERATURE":
+                                inputSlots.TEMPERATURE.forEach((s) => {
+                                    // just add the number
+                                    slotValues.push(s.value);
+                                });
+                                break;
+                            case "AGE":
+                                inputSlots.AGE.forEach((s) => {
+                                    // just add the number
+                                    slotValues.push(s.value);
+                                });
+                                break;
+                            case "PERCENTAGE":
+                                inputSlots.PERCENTAGE.forEach((s) => {
+                                    // just add the number
+                                    slotValues.push(s + "%");
+                                    slotValues.push(s + " percent");
+                                });
+                                break;
+                            case "NUMBER":
+                                inputSlots.NUMBER.forEach((s) => {
+                                    // just add the number
+                                    slotValues.push(s);
+                                });
+                                break;
+                            default:
+                                inputSlots[slotName].forEach((s) => {
+                                    // it's important to use the synonym, as this is the text that was actually found
+                                    slotValues.push(s.synonym);
+                                });
+                        }
+                        const slotRegex = slotValues.join("|");
+                        // replace the slots name with the list of actually found entites for this slot
+                        parsedPattern = parsedPattern.replace(new RegExp(`${slot}`, "g"), `(${slotRegex})`);
+                    }
+                });
+            }
+            regexPatterns.push({
+                "pattern": pattern,
+                "parsedPattern": parsedPattern,
+                "tags": tags,
+                "slots": slots
+            });
+        }
+    });
+    const compoundGroups = [];
+    // go through all created patterns and test them
+    regexPatterns.forEach((pattern) => {
+        let result;
+        const regExp = new RegExp(pattern.parsedPattern, "gi");
+        const regexMatches = [];
+        while (result = regExp.exec(inputText)) {
+            regexMatches.push(result);
+        }
+        regexMatches.forEach((m) => {
+            inputText = inputText.replace(m[0], "");
+        });
+        if (regexMatches.length > 0) {
+            // we found a match for this pattern!
+            regexMatches.forEach((matches, mi) => {
+                // set up a compoundGroup scaffold, just in case we need it
+                const matchedPatternGroup = {
+                    "matchedPhrase": matches[0],
+                    "components": []
+                };
+                if (!detailedCompoundSlots)
+                    delete matchedPatternGroup.components;
+                // iterate through matches, starting at the first group result ([0] is the full match)
+                for (let i = 1; i < matches.length; i++) {
+                    let originalSlot = null;
+                    switch (pattern.slots[i - 1]) {
+                        case "PERCENTAGE":
+                            originalSlot = Number(matches[i].replace(new RegExp("[^0-9]", "gi"), ""));
+                            break;
+                        case "TEMPERATURE":
+                        case "AGE":
+                        case "NUMBER":
+                            originalSlot = Number(matches[i]);
+                            break;
+                        case "DATE":
+                            // @ts-ignore
+                            const dateSlot = inputSlots.DATE.find(e => (e["text"] === matches[i]));
+                            originalSlot = (dateSlot === null || dateSlot === void 0 ? void 0 : dateSlot.start) || (dateSlot === null || dateSlot === void 0 ? void 0 : dateSlot.end);
+                            break;
+                        default:
+                            originalSlot = inputSlots[pattern.slots[i - 1]].find(e => (e.synonym) ? e.synonym.toLowerCase() === matches[i].toLowerCase() : false);
+                    }
+                    // create compound groups
+                    if (detailedCompoundSlots) {
+                        const components = {
+                            "slot": pattern.slots[i - 1],
+                            "value": originalSlot.keyphrase || originalSlot
+                        };
+                        if (pattern.tags[i - 1])
+                            components["tag"] = pattern.tags[i - 1];
+                        else
+                            components["tag"] = null;
+                        matchedPatternGroup.components.push(components);
+                    }
+                    else {
+                        if (pattern.tags[i - 1])
+                            matchedPatternGroup[pattern.tags[i - 1]] = (originalSlot === null || originalSlot === void 0 ? void 0 : originalSlot.keyphrase) || originalSlot;
+                        else
+                            matchedPatternGroup[pattern.slots[i - 1]] = originalSlot || originalSlot.keyphrase;
+                    }
+                    if (pattern.tags[i - 1]) {
+                        if (createNewSlots) {
+                            if (inputSlots[pattern.tags[i - 1]]) {
+                                inputSlots[pattern.tags[i - 1]].push(originalSlot);
+                            }
+                            else
+                                inputSlots[pattern.tags[i - 1]] = [originalSlot];
+                        }
+                        if (tagExistingSlots) {
+                            inputSlots[pattern.slots[i - 1]].forEach((s) => {
+                                var _a, _b;
+                                if (((_a = s === null || s === void 0 ? void 0 : s.synonym) === null || _a === void 0 ? void 0 : _a.toLowerCase()) === ((_b = matches[i]) === null || _b === void 0 ? void 0 : _b.toLowerCase())) {
+                                    s["tags"] = (Array.isArray(s["tags"])) ? s["tags"].push(pattern.tags[i - 1]) : [pattern.tags[i - 1]];
+                                }
+                            });
+                        }
+                    }
+                }
+                compoundGroups.push(matchedPatternGroup);
+            });
+        }
+    });
+    if (!input["matchedPatterns"])
+        input["matchedPatterns"] = {};
+    if (compoundGroups && Array.isArray(compoundGroups) && compoundGroups.length > 0) {
+        input["matchedPatterns"][patternGroupName] = compoundGroups;
+    }
+    if (compoundGroups && compoundGroups.length === 0 && (typeof input["matchedPatterns"] !== 'object' || Object.keys(input["matchedPatterns"]).length === 0))
+        delete input["matchedPatterns"];
+    return input;
+};
+exports.patternMatcher = patternMatcher;
+//# sourceMappingURL=patternMatcher.js.map

package/build/shared/charts/descriptors/placeholder.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PLACEHOLDER = void 0;
+/* Custom modules */
+const createNodeDescriptor_1 = require("../createNodeDescriptor");
+exports.PLACEHOLDER = createNodeDescriptor_1.createNodeDescriptor({
+    type: "placeholder",
+    defaultLabel: "Placeholder",
+    summary: "This node is used as a Placeholder.",
+    behavior: {
+        stopping: false,
+    },
+    appearance: {
+        showIcon: false,
+        color: "#CCC",
+    },
+    fields: [
+        {
+            key: "text",
+            label: "text placeholder",
+            type: "text",
+        },
+        {
+            key: "data",
+            label: "data placeholder",
+            type: "json",
+        },
+    ],
+    constraints: {
+        placement: {},
+    },
+    tags: [],
+    preview: {
+        key: "text",
+        type: "text",
+    }
+});
+//# sourceMappingURL=placeholder.js.map

package/build/shared/charts/descriptors/profile/activateProfile.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ACTIVATE_PROFILE = void 0;
 /* Custom modules */
 const createNodeDescriptor_1 = require("../../createNodeDescriptor");
 /**

package/build/shared/charts/descriptors/profile/blindMode.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.BLIND_MODE = void 0;
 /* Custom modules */
 const createNodeDescriptor_1 = require("../../createNodeDescriptor");
 /**
@@ -20,16 +21,19 @@ exports.BLIND_MODE = createNodeDescriptor_1.createNodeDescriptor({
             key: "maskLogging",
             type: "toggle",
             label: "Mask Logging",
+            defaultValue: false,
         },
         {
             key: "maskAnalytics",
             type: "toggle",
-            label: "Mask Analytics"
+            label: "Mask Analytics",
+            defaultValue: false,
         },
         {
             key: "disableConversations",
             type: "toggle",
-            label: "Disable Conversations"
+            label: "Disable Conversations",
+            defaultValue: false,
         }
     ],
     tags: ["profile"],

package/build/shared/charts/descriptors/profile/completeGoal.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.COMPLETE_GOAL = void 0;
 /* Custom modules */
 const createNodeDescriptor_1 = require("../../createNodeDescriptor");
 /**
@@ -26,6 +27,10 @@ exports.COMPLETE_GOAL = createNodeDescriptor_1.createNodeDescriptor({
             }
         }
     ],
+    preview: {
+        key: "goal",
+        type: "text"
+    },
     tags: ["profile"],
     function: async ({ cognigy, config }) => {
         const { goal } = config;

package/build/shared/charts/descriptors/profile/deactivateProfile.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEACTIVATE_PROFILE = void 0;
 /* Custom modules */
 const createNodeDescriptor_1 = require("../../createNodeDescriptor");
 /**

package/build/shared/charts/descriptors/profile/deleteProfile.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.DELETE_PROFILE = void 0;
 /* Custom modules */
 const createNodeDescriptor_1 = require("../../createNodeDescriptor");
 /**

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

@@ -1,17 +1,24 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.REQUEST_RATING = exports.SET_RATING = exports.OVERWRITE_ANALYTICS = exports.BLIND_MODE = exports.UPDATE_PROFILE = exports.MERGE_PROFILE = exports.DELETE_PROFILE = exports.DEACTIVATE_PROFILE = exports.COMPLETE_GOAL = exports.ACTIVATE_PROFILE = void 0;
 var activateProfile_1 = require("./activateProfile");
-exports.ACTIVATE_PROFILE = activateProfile_1.ACTIVATE_PROFILE;
+Object.defineProperty(exports, "ACTIVATE_PROFILE", { enumerable: true, get: function () { return activateProfile_1.ACTIVATE_PROFILE; } });
 var completeGoal_1 = require("./completeGoal");
-exports.COMPLETE_GOAL = completeGoal_1.COMPLETE_GOAL;
+Object.defineProperty(exports, "COMPLETE_GOAL", { enumerable: true, get: function () { return completeGoal_1.COMPLETE_GOAL; } });
 var deactivateProfile_1 = require("./deactivateProfile");
-exports.DEACTIVATE_PROFILE = deactivateProfile_1.DEACTIVATE_PROFILE;
+Object.defineProperty(exports, "DEACTIVATE_PROFILE", { enumerable: true, get: function () { return deactivateProfile_1.DEACTIVATE_PROFILE; } });
 var deleteProfile_1 = require("./deleteProfile");
-exports.DELETE_PROFILE = deleteProfile_1.DELETE_PROFILE;
+Object.defineProperty(exports, "DELETE_PROFILE", { enumerable: true, get: function () { return deleteProfile_1.DELETE_PROFILE; } });
 var mergeProfile_1 = require("./mergeProfile");
-exports.MERGE_PROFILE = mergeProfile_1.MERGE_PROFILE;
+Object.defineProperty(exports, "MERGE_PROFILE", { enumerable: true, get: function () { return mergeProfile_1.MERGE_PROFILE; } });
 var updateProfile_1 = require("./updateProfile");
-exports.UPDATE_PROFILE = updateProfile_1.UPDATE_PROFILE;
+Object.defineProperty(exports, "UPDATE_PROFILE", { enumerable: true, get: function () { return updateProfile_1.UPDATE_PROFILE; } });
 var blindMode_1 = require("./blindMode");
-exports.BLIND_MODE = blindMode_1.BLIND_MODE;
+Object.defineProperty(exports, "BLIND_MODE", { enumerable: true, get: function () { return blindMode_1.BLIND_MODE; } });
+var overwriteAnalytics_1 = require("./overwriteAnalytics");
+Object.defineProperty(exports, "OVERWRITE_ANALYTICS", { enumerable: true, get: function () { return overwriteAnalytics_1.OVERWRITE_ANALYTICS; } });
+var setRating_1 = require("./setRating");
+Object.defineProperty(exports, "SET_RATING", { enumerable: true, get: function () { return setRating_1.SET_RATING; } });
+var requestRating_1 = require("./requestRating");
+Object.defineProperty(exports, "REQUEST_RATING", { enumerable: true, get: function () { return requestRating_1.REQUEST_RATING; } });
 //# sourceMappingURL=index.js.map

package/build/shared/charts/descriptors/profile/mergeProfile.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.MERGE_PROFILE = void 0;
 /* Custom modules */
 const createNodeDescriptor_1 = require("../../createNodeDescriptor");
 /**

package/build/shared/charts/descriptors/profile/overwriteAnalytics.js

@@ -0,0 +1,223 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OVERWRITE_ANALYTICS = void 0;
+/* Custom modules */
+const createNodeDescriptor_1 = require("../../createNodeDescriptor");
+/**
+ * Node name: 'Overwrite Analytics'
+ *
+ * Purpose:
+ * Overwrites the analytics record
+ */
+exports.OVERWRITE_ANALYTICS = createNodeDescriptor_1.createNodeDescriptor({
+    type: "overwriteAnalytics",
+    defaultLabel: "Overwrite Analytics",
+    summary: "Overwrites the analytics record",
+    appearance: {
+        showIcon: false
+    },
+    fields: [
+        {
+            key: "customDesc",
+            type: "description",
+            label: " ",
+            params: {
+                text: "The fields below are custom fields into which you can store any data. The fields are exposed in your analytics records."
+            }
+        },
+        {
+            key: "defaultDesc",
+            type: "description",
+            label: " ",
+            params: {
+                text: "If you don't wish to overwrite a value, leave the field blank."
+            }
+        },
+        {
+            key: "custom1",
+            type: "cognigyText",
+            label: "Custom Value 1",
+        },
+        {
+            key: "custom2",
+            type: "cognigyText",
+            label: "Custom Value 2",
+        },
+        {
+            key: "custom3",
+            type: "cognigyText",
+            label: "Custom Value 3",
+        },
+        {
+            key: "custom4",
+            type: "cognigyText",
+            label: "Custom Value 4",
+        },
+        {
+            key: "custom5",
+            type: "cognigyText",
+            label: "Custom Value 5",
+        },
+        {
+            key: "custom6",
+            type: "cognigyText",
+            label: "Custom Value 6",
+        },
+        {
+            key: "custom7",
+            type: "cognigyText",
+            label: "Custom Value 7",
+        },
+        {
+            key: "custom8",
+            type: "cognigyText",
+            label: "Custom Value 8",
+        },
+        {
+            key: "custom9",
+            type: "cognigyText",
+            label: "Custom Value 9",
+        },
+        {
+            key: "custom10",
+            type: "cognigyText",
+            label: "Custom Value 10",
+        },
+        {
+            key: "intent",
+            type: "cognigyText",
+            label: "Intent",
+        },
+        {
+            key: "intentScore",
+            type: "number",
+            label: "IntentScore",
+        },
+        {
+            key: "inputText",
+            type: "cognigyText",
+            label: "inputText",
+        },
+        {
+            key: "inputData",
+            type: "json",
+            label: "Input Data",
+            defaultValue: "{}"
+        },
+        {
+            key: "state",
+            type: "cognigyText",
+            label: "State",
+        },
+        {
+            key: "handoverEscalations",
+            type: "cognigyText",
+            label: "Handover Escalations",
+        },
+        {
+            key: "slots",
+            type: "json",
+            label: "Slots",
+            defaultValue: "{}"
+        },
+        {
+            key: "completedGoals",
+            type: "textArray",
+            label: "Completed Goals",
+        },
+        {
+            key: "understood",
+            type: "select",
+            label: "Understood",
+            defaultValue: "cUndefined",
+            params: {
+                options: [
+                    {
+                        label: "Don't overwrite",
+                        value: "cUndefined",
+                    },
+                    {
+                        label: "True",
+                        value: "true",
+                    },
+                    {
+                        label: "False",
+                        value: "false",
+                    }
+                ]
+            }
+        }
+    ],
+    sections: [
+        {
+            key: "customFields",
+            label: "Custom Fields",
+            defaultCollapsed: false,
+            fields: [
+                "customDesc",
+                "custom1",
+                "custom2",
+                "custom3",
+                "custom4",
+                "custom5",
+                "custom6",
+                "custom7",
+                "custom8",
+                "custom9",
+                "custom10",
+            ]
+        },
+        {
+            key: "defaultFields",
+            label: "Default Fields",
+            defaultCollapsed: false,
+            fields: [
+                "defaultDesc",
+                "intent",
+                "intentScore",
+                "inputText",
+                "inputData",
+                "state",
+                "slots",
+                "completedGoals",
+                "understood",
+                "handoverEscalations",
+            ]
+        },
+    ],
+    form: [
+        { type: "section", key: "customFields" },
+        { type: "section", key: "defaultFields" }
+    ],
+    tags: ["profile", "analytics", "customize"],
+    function: async ({ cognigy, config }) => {
+        const { api } = cognigy;
+        for (let key of Object.keys(config)) {
+            if (key === "handoverEscalations") {
+                api.setAnalyticsData(key, parseInt(config[key]));
+                continue;
+            }
+            switch (typeof config[key]) {
+                case "string":
+                    if (config[key] && config[key].length > 0 && config[key] !== "cUndefined") {
+                        api.setAnalyticsData(key, config[key]);
+                    }
+                    break;
+                case "object":
+                    if (config[key] && Array.isArray(config[key]) && config[key].length > 0) {
+                        api.setAnalyticsData(key, config[key]);
+                    }
+                    else if (config[key] && Object.keys(config[key]).length > 0) {
+                        api.setAnalyticsData(key, config[key]);
+                    }
+                    break;
+                case "number":
+                    if (config[key] && Number(config[key])) {
+                        api.setAnalyticsData(key, config[key]);
+                    }
+                    break;
+            }
+        }
+    }
+});
+//# sourceMappingURL=overwriteAnalytics.js.map

package/build/shared/charts/descriptors/profile/requestRating.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.REQUEST_RATING = void 0;
+/* Custom modules */
+const createNodeDescriptor_1 = require("../../createNodeDescriptor");
+/**
+ * Node name: 'requestRating'
+ *
+ * Purpose:
+ * Send a rating request message to a webchat endpoint
+ */
+exports.REQUEST_RATING = createNodeDescriptor_1.createNodeDescriptor({
+    type: "requestRating",
+    defaultLabel: "Request Rating",
+    summary: "Request a rating from a Webchat User",
+    appearance: {
+        showIcon: false,
+    },
+    preview: {
+        key: "ratingTitleText",
+        type: "text",
+    },
+    fields: [
+        {
+            key: "ratingTitleText",
+            type: "cognigyText",
+            label: "Rating Title",
+            description: "Define a custom title for the rating request dialog",
+        },
+        {
+            key: "ratingCommentText",
+            type: "cognigyText",
+            label: "Rating Comment Text",
+            description: "Define a custom comment text for the rating request dialog",
+        },
+    ],
+    form: [
+        { type: "field", key: "ratingTitleText" },
+        { type: "field", key: "ratingCommentText" },
+    ],
+    tags: ["message", "profile", "analytics", "rating",],
+    function: async ({ cognigy, config }) => {
+        const { api } = cognigy;
+        const ratingTitleText = config.ratingTitleText;
+        const ratingCommentText = config.ratingCommentText;
+        api.say("", {
+            _plugin: {
+                type: "request-rating",
+                data: {
+                    ratingTitleText,
+                    ratingCommentText,
+                },
+            },
+        });
+    }
+});
+//# sourceMappingURL=requestRating.js.map

package/build/shared/charts/descriptors/profile/setRating.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SET_RATING = void 0;
+/* Custom modules */
+const createNodeDescriptor_1 = require("../../createNodeDescriptor");
+exports.SET_RATING = createNodeDescriptor_1.createNodeDescriptor({
+    type: "setRating",
+    defaultLabel: "Set Rating",
+    summary: "Sets the rating and rating comment for a conversation",
+    appearance: {
+        showIcon: false
+    },
+    fields: [
+        {
+            key: "rating",
+            type: "cognigyText",
+            label: "Rating Score",
+            description: "The rating for the conversation. -1 for a negative rating or 1 for a positive rating"
+        },
+        {
+            key: "ratingComment",
+            type: "cognigyText",
+            label: "Rating Comment",
+        },
+    ],
+    form: [
+        { type: "field", key: "rating" },
+        { type: "field", key: "ratingComment" }
+    ],
+    tags: ["profile", "analytics", "rating", "success"],
+    function: async ({ cognigy, config }) => {
+        const { api } = cognigy;
+        api.setRating({
+            rating: config.rating,
+            comment: config.ratingComment
+        });
+    }
+});
+//# sourceMappingURL=setRating.js.map