@cognigy/rest-api-client 0.14.0 → 0.16.0

package/build/shared/charts/descriptors/service/conversationSummary.js

@@ -0,0 +1,148 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GPT_CONVERSATION_SUMMARY = void 0;
+/* Custom modules */
+const createNodeDescriptor_1 = require("../../createNodeDescriptor");
+const prompt_1 = require("../nlu/generativeSlotFiller/prompt");
+exports.GPT_CONVERSATION_SUMMARY = (0, createNodeDescriptor_1.createNodeDescriptor)({
+    type: "conversationSummary",
+    defaultLabel: "Generative Conversation Summary",
+    summary: "UI__NODE_EDITOR__SERVICE__CONVERSATION_SUMMARY__SUMMARY__DEFAULT",
+    fields: [
+        {
+            key: "temperature",
+            label: "UI__NODE_EDITOR__SERVICE__CONVERSATION_SUMMARY__FIELDS__TEMPERATURE__DEFAULT",
+            type: "slider",
+            description: "UI__NODE_EDITOR__SERVICE__CONVERSATION_SUMMARY__FIELDS__TEMPERATURE__DESCRIPTION__DEFAULT",
+            defaultValue: 0.7,
+            params: {
+                min: 0,
+                max: 1,
+                step: 0.1
+            },
+            condition: {
+                key: "samplingMethod",
+                value: "temperature",
+            }
+        },
+        {
+            key: "timeout",
+            label: "UI__NODE_EDITOR__SERVICE__CONVERSATION_SUMMARY__FIELDS__TIMEOUT__DEFAULT",
+            defaultValue: 5000,
+            type: "number",
+            description: "UI__NODE_EDITOR__SERVICE__CONVERSATION_SUMMARY__FIELDS__TIMEOUT__DESCRIPTION",
+        },
+        {
+            key: "storeLocation",
+            type: "select",
+            label: "UI__NODE_EDITOR__SERVICE__CONVERSATION_SUMMARY__FIELDS__STORE_LOCATION__DEFAULT",
+            defaultValue: "input",
+            params: {
+                options: [
+                    {
+                        label: "UI__NODE_EDITOR__SERVICE__CONVERSATION_SUMMARY__FIELDS__STORE_LOCATION__PARAMS__INPUT__LABEL",
+                        value: "input"
+                    },
+                    {
+                        label: "UI__NODE_EDITOR__SERVICE__CONVERSATION_SUMMARY__FIELDS__STORE_LOCATION__PARAMS__CONTEXT__LABEL",
+                        value: "context"
+                    }
+                ],
+                required: true
+            },
+        },
+        {
+            key: "inputKey",
+            type: "cognigyText",
+            label: "UI__NODE_EDITOR__SERVICE__CONVERSATION_SUMMARY__FIELDS__INPUT_KEY__DEFAULT",
+            defaultValue: "conversationSummary",
+            condition: {
+                key: "storeLocation",
+                value: "input",
+            }
+        },
+        {
+            key: "contextKey",
+            type: "cognigyText",
+            label: "UI__NODE_EDITOR__SERVICE__CONVERSATION_SUMMARY__FIELDS__CONTEXT_KEY__DEFAULT",
+            defaultValue: "conversationSummary",
+            condition: {
+                key: "storeLocation",
+                value: "context",
+            }
+        },
+    ],
+    sections: [
+        {
+            key: "advanced",
+            label: "UI__NODE_EDITOR__SERVICE__CONVERSATION_SUMMARY__SECTIONS__ADVANCED__DEFAULT",
+            defaultCollapsed: true,
+            fields: [
+                "temperature",
+                "timeout",
+            ]
+        },
+        {
+            key: "storage",
+            label: "UI__NODE_EDITOR__SERVICE__CONVERSATION_SUMMARY__SECTIONS__STORAGE__DEFAULT",
+            defaultCollapsed: true,
+            fields: [
+                "storeLocation",
+                "inputKey",
+                "contextKey",
+            ]
+        }
+    ],
+    form: [
+        { type: "section", key: "advanced" },
+        { type: "section", key: "storage" },
+    ],
+    appearance: {},
+    tags: ["service"],
+    function: async ({ cognigy, config }) => {
+        var _a;
+        const { api } = cognigy;
+        const { temperature, storeLocation, contextKey, inputKey, timeout, } = config;
+        const prompt = createConversationSummaryPrompt(cognigy.lastConversationEntries);
+        try {
+            const data = {
+                prompt,
+                temperature,
+                timeoutInMs: timeout,
+                useCase: "conversationSummary"
+            };
+            // TODO: Create a new useCase for this feature and use it here instead
+            const response = await api.runGenerativeAIPrompt(data, "gptConversation");
+            if (storeLocation === "context") {
+                api.addToContext(contextKey, response, "simple");
+            }
+            else {
+                // @ts-ignore
+                api.addToInput(inputKey, response);
+            }
+        }
+        catch (error) {
+            const errorDetails = {
+                name: error.name,
+                code: error.code,
+                message: error.message || ((_a = error.originalErrorDetails) === null || _a === void 0 ? void 0 : _a.message),
+            };
+            if (storeLocation === "context") {
+                api.addToContext(contextKey, { error: errorDetails }, "simple");
+            }
+            else {
+                // @ts-ignore
+                api.addToInput(inputKey, { error: errorDetails });
+            }
+            throw error;
+        }
+    }
+});
+const createConversationSummaryPrompt = (lastConversationEntries) => {
+    const conversation = (0, prompt_1.createLastConverationString)(lastConversationEntries);
+    const prompt = `A bot had a conversation with a user. This is the conversation so far:
+${conversation}
+Write a concise summary of the conversation in short sentences: `;
+    return prompt;
+};
+//# sourceMappingURL=conversationSummary.js.map

package/build/shared/charts/descriptors/service/handover.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.HANDOVER = void 0;
 /* Custom modules */
 const createNodeDescriptor_1 = require("../../createNodeDescriptor");
+const constants_1 = require("../../../constants");
 /**
  * Node name: 'handover'
  *
@@ -12,7 +13,7 @@ const createNodeDescriptor_1 = require("../../createNodeDescriptor");
 exports.HANDOVER = (0, createNodeDescriptor_1.createNodeDescriptor)({
     type: "handover",
     defaultLabel: "Handover",
-    summary: "Sends a handover request to an agent",
+    summary: "UI__NODE_EDITOR__SERVICE__HANDOVER__SUMMARY_LABEL",
     appearance: {
         showIcon: false
     },
@@ -24,41 +25,41 @@ exports.HANDOVER = (0, createNodeDescriptor_1.createNodeDescriptor)({
         {
             key: "text",
             type: "cognigyText",
-            label: "Text Message",
-            description: "The message to display to the user once the handover request was accepted by the live chat provider"
+            label: "UI__NODE_EDITOR__SERVICE__HANDOVER__FIELDS__TEXT__LABEL",
+            description: "UI__NODE_EDITOR__SERVICE__HANDOVER__FIELDS__TEXT__DESCRIPTION"
         },
         {
             key: "cancelIntent",
             type: "cognigyText",
-            label: "Cancel Intent Name",
-            description: "Name of the intent which will cancel the handover"
+            label: "UI__NODE_EDITOR__SERVICE__HANDOVER__FIELDS__CANCEL_INTENT__LABEL",
+            description: "UI__NODE_EDITOR__SERVICE__HANDOVER__FIELDS__CANCEL_INTENT__DESCRIPTION"
         },
         {
             key: "unavailable",
             type: "cognigyText",
-            label: "Unavailable Message",
-            description: "Message to display if no agents are available"
+            label: "UI__NODE_EDITOR__SERVICE__HANDOVER__FIELDS__UNAVAILABLE__LABEL",
+            description: "UI__NODE_EDITOR__SERVICE__HANDOVER__FIELDS__UNAVAILABLE__DESCRIPTION"
         },
         {
             key: "unsupportedChannel",
             type: "cognigyText",
-            label: "Unsupported Channel Message",
-            description: "Message to display if handover was triggered in an unsupported channel"
+            label: "UI__NODE_EDITOR__SERVICE__HANDOVER__FIELDS__UNSUPPORTED_CHANNEL__LABEL",
+            description: "UI__NODE_EDITOR__SERVICE__HANDOVER__FIELDS__UNSUPPORTED_CHANNEL__DESCRIPTION"
         },
         {
             key: "quickReply",
             type: "cognigyText",
-            label: "Quick Reply Text",
-            description: "Text of the Quick Reply Button which sends the user back to the Virtual Agent"
+            label: "UI__NODE_EDITOR__SERVICE__HANDOVER__FIELDS__QUICK_REPLAY__LABEL",
+            description: "UI__NODE_EDITOR__SERVICE__HANDOVER__FIELDS__QUICK_REPLAY__DESCRIPTION"
         },
         {
             key: "chatwootInboxId",
             type: "cognigyText",
-            label: "Chatwoot Inbox Id",
-            description: "Inbox Id in Chatwoot"
+            label: "UI__NODE_EDITOR__SERVICE__HANDOVER__FIELDS__CHATWOOT_INBOXID__LABEL",
+            description: "UI__NODE_EDITOR__SERVICE__HANDOVER__FIELDS__CHATWOOT_INBOXID__DESCRIPTION"
         },
         {
-            key: "liveAgentInboxId",
+            key: constants_1.COGNIGY_LIVE_AGENT_DESCRIPTOR_FIELDS.LIVE_AGENT_INBOX_ID,
             type: "cognigyText",
             label: "Live Agent Inbox Id",
             description: "Inbox Id in Live Agent"
@@ -67,7 +68,7 @@ exports.HANDOVER = (0, createNodeDescriptor_1.createNodeDescriptor)({
     sections: [
         {
             key: "chatwootSettings",
-            label: "Chatwoot Settings",
+            label: "UI__NODE_EDITOR__SERVICE__HANDOVER__SECTIONS__CHATWOOT_SETTINGS__LABEL",
             defaultCollapsed: true,
             fields: [
                 "chatwootInboxId",
@@ -75,10 +76,10 @@ exports.HANDOVER = (0, createNodeDescriptor_1.createNodeDescriptor)({
         },
         {
             key: "liveAgentSettings",
-            label: "Live Agent Settings",
+            label: "UI__NODE_EDITOR__SERVICE__HANDOVER__SECTIONS__LIVEAGENT_SETTINGS__LABEL",
             defaultCollapsed: true,
             fields: [
-                "liveAgentInboxId",
+                constants_1.COGNIGY_LIVE_AGENT_DESCRIPTOR_FIELDS.LIVE_AGENT_INBOX_ID
             ]
         }
     ],

package/build/shared/charts/descriptors/service/handoverInactivityTimer.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HANDOVER_INACTIVITY_TIMER = void 0;
+/* Custom modules */
+const createNodeDescriptor_1 = require("../../createNodeDescriptor");
+exports.HANDOVER_INACTIVITY_TIMER = (0, createNodeDescriptor_1.createNodeDescriptor)({
+    type: "handoverInactivityTimer",
+    defaultLabel: "Set Handover Inactivity",
+    summary: "UI__NODE_EDITOR__SERVICE__HANDOVER_INACTIVITY_TIMER__SUMMARY",
+    appearance: {
+        showIcon: false
+    },
+    dependencies: {
+        children: [],
+    },
+    fields: [
+        {
+            key: "timer",
+            type: "cognigyText",
+            label: "UI__NODE_EDITOR__SERVICE__HANDOVER_INACTIVITY_TIMER__FIELDS__TIMER__LABEL",
+            description: "UI__NODE_EDITOR__SERVICE__HANDOVER_INACTIVITY_TIMER__FIELDS__TIMER__DESCRIPTION"
+        },
+    ],
+    sections: [],
+    form: [
+        { type: "field", key: "timer" },
+    ],
+    tags: ["service", "livechat", "chat", "hand over", "inactivity"],
+    function: async ({ cognigy, config }) => {
+        const { api } = cognigy;
+        await api.addHandoverInactivityTimer({
+            // Convert timer from minutes to ms
+            timerInMs: Number(config.timer) * 60 * 1000
+        });
+    }
+});
+//# sourceMappingURL=handoverInactivityTimer.js.map