@cognigy/rest-api-client 0.13.1 → 0.14.0

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

@@ -0,0 +1,316 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.COMPLETE_TEXT = void 0;
+/* Custom modules */
+const createNodeDescriptor_1 = require("../../createNodeDescriptor");
+exports.COMPLETE_TEXT = (0, createNodeDescriptor_1.createNodeDescriptor)({
+    type: "completeText",
+    defaultLabel: {
+        default: "Complete Text",
+    },
+    summary: {
+        default: "Generates a new text based on a given prompt",
+        deDE: "Erzeugt einen neuen Text auf Grundlage eines vorhandenen Kontext"
+    },
+    fields: [
+        {
+            key: "prompt",
+            label: {
+                default: "Prompt",
+                deDE: "Kontext"
+            },
+            type: "cognigyText",
+            description: {
+                default: "The prompt to generate completions for, encoded as a string, array of strings, array of tokens, or array of token arrays.",
+                deDE: "Die Eingabeaufforderung, für die Vervollständigungen generiert werden sollen, codiert als Zeichenfolge, Array von Zeichenfolgen, Array von Token oder Array von Token-Arrays."
+            },
+            params: {
+                required: true,
+                multiline: true
+            },
+            defaultValue: ""
+        },
+        {
+            key: "samplingMethod",
+            label: "Sampling Method",
+            type: "select",
+            defaultValue: "temperature",
+            params: {
+                options: [
+                    {
+                        label: "Temperature",
+                        value: "temperature"
+                    },
+                    {
+                        label: "Top Percentage",
+                        value: "topP"
+                    }
+                ]
+            }
+        },
+        {
+            key: "temperature",
+            label: {
+                default: "Temperature",
+                deDE: "Temperatur"
+            },
+            type: "slider",
+            description: {
+                default: "What sampling temperature to use. Higher values means the model will take more risks",
+                deDE: "Welche Probenahmetemperatur soll verwendet werden. Höhere Werte bedeuten, dass das Modell mehr Risiken eingeht"
+            },
+            defaultValue: 0.7,
+            params: {
+                min: 0,
+                max: 1,
+                step: 0.1
+            },
+            condition: {
+                key: "samplingMethod",
+                value: "temperature",
+            }
+        },
+        {
+            key: "topP",
+            label: {
+                default: "Top Percentage",
+                deDE: "Maximaler Prozentsatz"
+            },
+            type: "slider",
+            description: {
+                default: "An alternative to sampling with temperature, called nucleus sampling",
+                deDE: "Eine Alternative zum Sampling mit Temperatur, genannt Nucleus Sampling"
+            },
+            defaultValue: 1,
+            params: {
+                min: 0,
+                max: 1,
+                step: 0.1
+            },
+            condition: {
+                key: "samplingMethod",
+                value: "topP",
+            }
+        },
+        {
+            key: "maxTokens",
+            label: {
+                default: "Maximal Tokens",
+                deDE: "Maximale Zeichen"
+            },
+            type: "slider",
+            description: {
+                default: "The maximum number of tokens to generate in the completion",
+                deDE: "Die maximale Anzahl von Token, die beim Abschluss generiert werden sollen"
+            },
+            defaultValue: 100,
+            params: {
+                min: 1,
+                max: 4000,
+                step: 1
+            }
+        },
+        {
+            key: "frequencyPenalty",
+            label: {
+                default: "Frequency Penalty",
+                deDE: "Frequenzregelung"
+            },
+            type: "slider",
+            description: {
+                default: "Number between -2.0 and 2.0",
+                deDE: "Zahl zwischen -2,0 und 2,0"
+            },
+            defaultValue: 0,
+            params: {
+                min: -2,
+                max: 2,
+                step: 0.1
+            }
+        },
+        {
+            key: "presencePenalty",
+            label: {
+                default: "Presence Penalty",
+                deDE: "Gegenwartsregelung"
+            },
+            type: "slider",
+            description: {
+                default: "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics",
+                deDE: "Zahl zwischen -2,0 und 2,0. Positive Werte bestrafen neue Token basierend darauf, ob sie bisher im Text erschienen sind, und erhöhen die Wahrscheinlichkeit, dass das Modell über neue Themen spricht"
+            },
+            defaultValue: 0,
+            params: {
+                min: -2,
+                max: 2,
+                step: 0.1
+            }
+        },
+        {
+            key: "useStop",
+            label: {
+                default: "Use Stops",
+                deDE: "Stopps verwenden"
+            },
+            type: "toggle",
+            description: {
+                default: "Whether to use a list of stop words to let the Generative AI know where the sentence stops",
+                deDE: "Ob eine Liste von Stoppwörtern verwendet werden soll, um der Generativen AI mitzuteilen, wo der Satz endet"
+            },
+            defaultValue: false
+        },
+        {
+            key: "stop",
+            label: {
+                default: "Stops",
+                deDE: "Stopps"
+            },
+            type: "textArray",
+            description: {
+                default: "Up to 4 sequences where the API will stop generating further tokens. The returned text will not contain the stop sequence",
+                deDE: "Bis zu 4 Sequenzen, bei denen die API aufhört, weitere Token zu generieren. Der zurückgegebene Text enthält nicht die Stoppsequenz"
+            },
+            condition: {
+                key: "useStop",
+                value: true
+            }
+        },
+        {
+            key: "timeout",
+            label: {
+                default: "Timeout",
+            },
+            defaultValue: 5000,
+            type: "number",
+            description: {
+                default: "The maximum amount of milliseconds to wait for a response from the Generative AI Provider",
+            },
+        },
+        {
+            key: "storeLocation",
+            type: "select",
+            label: {
+                default: "Where to store the result",
+                deDE: "Wo das Ergebnis gespeichert werden soll"
+            },
+            defaultValue: "input",
+            params: {
+                options: [
+                    {
+                        label: "Input",
+                        value: "input"
+                    },
+                    {
+                        label: "Context",
+                        value: "context"
+                    }
+                ],
+                required: true
+            },
+        },
+        {
+            key: "inputKey",
+            type: "cognigyText",
+            label: {
+                default: "Input Key to store Result",
+                deDE: "Input Key zum Speichern des Ergebnisses"
+            },
+            defaultValue: "generativeAi",
+            condition: {
+                key: "storeLocation",
+                value: "input",
+            }
+        },
+        {
+            key: "contextKey",
+            type: "cognigyText",
+            label: {
+                default: "Context Key to store Result",
+                deDE: "Context Key zum Speichern des Ergebnisses"
+            },
+            defaultValue: "generativeAi",
+            condition: {
+                key: "storeLocation",
+                value: "context",
+            }
+        },
+    ],
+    sections: [
+        {
+            key: "advanced",
+            label: {
+                default: "Advanced",
+                deDE: "Erweitert"
+            },
+            defaultCollapsed: true,
+            fields: [
+                "model",
+                "samplingMethod",
+                "temperature",
+                "topP",
+                "maxTokens",
+                "presencePenalty",
+                "frequencyPenalty",
+                "useStop",
+                "stop",
+                "timeout",
+            ]
+        },
+        {
+            key: "storage",
+            label: {
+                default: "Storage Option",
+                deDE: "Speicheroption"
+            },
+            defaultCollapsed: true,
+            fields: [
+                "storeLocation",
+                "inputKey",
+                "contextKey",
+            ]
+        }
+    ],
+    form: [
+        { type: "field", key: "prompt" },
+        { type: "section", key: "advanced" },
+        { type: "section", key: "storage" },
+    ],
+    appearance: {},
+    tags: ["service"],
+    function: async ({ cognigy, config }) => {
+        const { api } = cognigy;
+        const { prompt, temperature, maxTokens, topP, presencePenalty, frequencyPenalty, useStop, stop, storeLocation, contextKey, inputKey, timeout, } = config;
+        try {
+            const data = {
+                prompt,
+                temperature,
+                maxTokens,
+                topP,
+                presencePenalty,
+                frequencyPenalty,
+                timeoutInMs: timeout,
+            };
+            if (useStop) {
+                data["stop"] = stop;
+            }
+            const response = await api.runGenerativeAIPrompt(data);
+            if (storeLocation === "context") {
+                api.addToContext(contextKey, response, "simple");
+            }
+            else {
+                // @ts-ignore
+                api.addToInput(inputKey, response);
+            }
+        }
+        catch (error) {
+            if (storeLocation === "context") {
+                api.addToContext(contextKey, { error: error }, "simple");
+            }
+            else {
+                // @ts-ignore
+                api.addToInput(inputKey, { error: error });
+            }
+        }
+    }
+});
+//# sourceMappingURL=completeText.js.map

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

@@ -57,6 +57,13 @@ exports.HANDOVER_V2 = (0, createNodeDescriptor_1.createNodeDescriptor)({
                 ],
             },
         },
+        {
+            key: "additionalCategoryIds",
+            type: "cognigyTextArray",
+            label: "Additional Category Ids",
+            description: "Additional Category Ids to be passed to Ring Central Engage handover provider",
+            defaultValue: []
+        },
         {
             key: "sendResolveEvent",
             type: "toggle",
@@ -72,7 +79,7 @@ exports.HANDOVER_V2 = (0, createNodeDescriptor_1.createNodeDescriptor)({
         {
             key: "agentAssistInitMessage",
             type: "cognigyText",
-            label: "Initial Whisper Assist Trigger",
+            label: "Initial Agent Assist Trigger",
             description: "If an Assist Flow is configured, this trigger message is sent to it as an input upon Live Agent handover"
         },
         {
@@ -109,6 +116,25 @@ exports.HANDOVER_V2 = (0, createNodeDescriptor_1.createNodeDescriptor)({
             description: "The details that should be displayed to the Live Chat Agent.",
             defaultValue: "[]",
         },
+        {
+            key: "eightByEightChannelId",
+            type: "cognigyText",
+            label: "8x8 Channel Id",
+            description: "The 8x8 Channel Id that should be used.",
+        },
+        {
+            key: "eightByEightQueueId",
+            type: "cognigyText",
+            label: "8x8 Queue Id",
+            description: "The 8x8 Queue Id that should be used.",
+        },
+        {
+            key: "eightByEightJSONProps",
+            type: "json",
+            label: "8x8 JSON properties",
+            description: "Extend 8x8 properties with custom JSON.",
+            defaultValue: [],
+        },
     ],
     sections: [
         {
@@ -156,6 +182,24 @@ exports.HANDOVER_V2 = (0, createNodeDescriptor_1.createNodeDescriptor)({
                 "salesforcePrechatEntities",
                 "salesforcePrechatDetails"
             ]
+        },
+        {
+            key: "eightByEightSettings",
+            label: "8x8 Settings",
+            defaultCollapsed: true,
+            fields: [
+                "eightByEightChannelId",
+                "eightByEightQueueId",
+                "eightByEightJSONProps"
+            ]
+        },
+        {
+            key: "ringCentralEngageSettings",
+            label: "Ring Central Engage Settings",
+            defaultCollapsed: true,
+            fields: [
+                "additionalCategoryIds",
+            ]
         }
     ],
     form: [
@@ -169,7 +213,9 @@ exports.HANDOVER_V2 = (0, createNodeDescriptor_1.createNodeDescriptor)({
             key: "liveAgentSettings"
         },
         { type: "section", key: "chatwootSettings" },
-        { type: "section", key: "salesforceSettings" }
+        { type: "section", key: "salesforceSettings" },
+        { type: "section", key: "eightByEightSettings" },
+        { type: "section", key: "ringCentralEngageSettings" },
     ]
         .filter(element => !!element),
     tags: ["service", "livechat", "chat", "hand over"],

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ON_SCHEDULING_ERROR = exports.ON_SCHEDULED = exports.TRIGGER_FUNCTION = exports.HTTP_CONNECTION_OAUTH2 = exports.HTTP_CONNECTION_APIKEYXKEY = exports.HTTP_CONNECTION_APIKEYAUTHKEY = exports.HTTP_CONNECTION_BASIC = exports.HTTP_REQUEST = exports.CHECK_AGENT_AVAILABILITY = exports.HANDOVER_V2 = exports.HANDOVER = void 0;
+exports.COMPLETE_TEXT = exports.ON_SCHEDULING_ERROR = exports.ON_SCHEDULED = exports.TRIGGER_FUNCTION = exports.HTTP_CONNECTION_OAUTH2 = exports.HTTP_CONNECTION_APIKEYXKEY = exports.HTTP_CONNECTION_APIKEYAUTHKEY = exports.HTTP_CONNECTION_BASIC = exports.HTTP_REQUEST = exports.CHECK_AGENT_AVAILABILITY = exports.HANDOVER_V2 = exports.HANDOVER = void 0;
 var handover_1 = require("./handover");
 Object.defineProperty(exports, "HANDOVER", { enumerable: true, get: function () { return handover_1.HANDOVER; } });
 var handoverV2_1 = require("./handoverV2");
@@ -21,4 +21,6 @@ var onScheduled_1 = require("./triggerFunction/onScheduled");
 Object.defineProperty(exports, "ON_SCHEDULED", { enumerable: true, get: function () { return onScheduled_1.ON_SCHEDULED; } });
 var onSchedulingError_1 = require("./triggerFunction/onSchedulingError");
 Object.defineProperty(exports, "ON_SCHEDULING_ERROR", { enumerable: true, get: function () { return onSchedulingError_1.ON_SCHEDULING_ERROR; } });
+var completeText_1 = require("./completeText");
+Object.defineProperty(exports, "COMPLETE_TEXT", { enumerable: true, get: function () { return completeText_1.COMPLETE_TEXT; } });
 //# sourceMappingURL=index.js.map

package/build/shared/charts/descriptors/voice/mappers/setSessionConfig.mapper.js

@@ -5,12 +5,13 @@ const strip_nulls_1 = require("../../voicegateway2/utils/strip-nulls");
 const helper_1 = require("../utils/helper");
 const constants_1 = require("../utils/constants");
 function voiceConfigParamsToVoiceSettings(config, api) {
+    var _a, _b, _c;
     let voiceSettings = {};
     if (config.bargeInOnSpeech || config.bargeInOnDtmf) {
         voiceSettings.bargeIn = {
             bargeInEnable: false,
-            bargeInOnDtmf: config.bargeInOnDtmf ? true : false,
-            bargeInOnSpeech: config.bargeInOnSpeech ? true : false,
+            bargeInOnDtmf: (_a = config.bargeInOnDtmf) !== null && _a !== void 0 ? _a : false,
+            bargeInOnSpeech: (_b = config.bargeInOnSpeech) !== null && _b !== void 0 ? _b : false,
             bargeInMinimunWords: config.bargeInMinWordCount,
         };
     }
@@ -35,7 +36,10 @@ function voiceConfigParamsToVoiceSettings(config, api) {
         ttsVendor: config.ttsVendor,
         ttsLanguage: config.ttsLanguage,
         ttsVoice: config.ttsVoice,
+        azureServiceEndpoint: config.azureTtsDeploymentId
     };
+    if (config.ttsVendor === 'microsoft' && config.azureTtsDeploymentId)
+        voiceSettings.tts.azureServiceEndpoint = config.azureTtsDeploymentId;
     // userNoInput
     voiceSettings.userNoInput = {
         userNoInputMode: config.userNoInputMode,
@@ -44,17 +48,14 @@ function voiceConfigParamsToVoiceSettings(config, api) {
         userNoInputSpeech: config.userNoInputSpeech,
         userNoInputUrl: config.userNoInputUrl,
     };
-    // dtmf
     voiceSettings.dtmf = {
         dtmfEnable: config.dtmfEnable,
         dtmfInterDigitTimeout: config.dtmfInterDigitTimeout,
         dtmfMaxDigits: config.dtmfMaxDigits,
         dtmfMinDigits: config.dtmfMinDigits,
-        dtmfSubmitDigit: config.dtmfSubmitDigit,
+        dtmfSubmitDigit: (_c = config.dtmfSubmitDigit) === null || _c === void 0 ? void 0 : _c.trim(),
     };
     if (config === null || config === void 0 ? void 0 : config.dtmfEnable) {
-        if (config.dtmfSubmitDigit)
-            voiceSettings.dtmf.dtmfSubmitDigit = config.dtmfSubmitDigit.trim();
         if (voiceSettings.dtmf.dtmfSubmitDigit &&
             !(0, helper_1.isValidDTMF)(voiceSettings.dtmf.dtmfSubmitDigit)) {
             if (api)
@@ -87,6 +88,19 @@ function voiceConfigParamsToVoiceSettings(config, api) {
             delete voiceSettings.continuousAsr.asrDigit;
         }
     }
+    // Azure configurations
+    if ((config.sttVendor === "microsoft" && config.azureSttContextId) ||
+        (config.sttVendor === "microsoft" && config.azureTtsDeploymentId)) {
+        voiceSettings.azureConfig = {
+            azureSttContextId: config.azureSttContextId
+                ? config.azureSttContextId.trim()
+                : undefined,
+            azureEnableAudioLogging: config.azureEnableAudioLogging || undefined,
+            azureTtsDeploymentId: config.azureTtsDeploymentId
+                ? config.azureTtsDeploymentId.trim()
+                : undefined,
+        };
+    }
     return (0, strip_nulls_1.stripNulls)(voiceSettings);
 }
 exports.voiceConfigParamsToVoiceSettings = voiceConfigParamsToVoiceSettings;
@@ -115,7 +129,8 @@ exports.setSessionConfig = {
         }
     },
     handleVGInput(voiceSettings) {
-        const { bargeIn, continuousAsr, stt, tts, userNoInput, dtmf, vad } = voiceSettings;
+        var _a;
+        const { bargeIn, continuousAsr, stt, tts, userNoInput, dtmf, vad, azureConfig, } = voiceSettings;
         const user = {};
         const synthesizer = {};
         const recognizer = {};
@@ -129,18 +144,21 @@ exports.setSessionConfig = {
         }
         recognizer.vendor = (stt === null || stt === void 0 ? void 0 : stt.sttVendor) ? stt.sttVendor : "default";
         recognizer.punctuation = stt === null || stt === void 0 ? void 0 : stt.sttDisablePunctuation;
-        if (vad && vad.enable) {
-            recognizer.vad = {
-                enable: true,
-                mode: vad.mode,
-                voiceMs: vad.voiceMs,
-            };
+        recognizer.azureSttEndpointId = azureConfig === null || azureConfig === void 0 ? void 0 : azureConfig.azureSttContextId;
+        recognizer.audioLogging = azureConfig === null || azureConfig === void 0 ? void 0 : azureConfig.azureEnableAudioLogging;
+        if (vad) {
+            recognizer.vad = { enable: vad.enable };
+            if (vad.enable) {
+                recognizer.vad.mode = vad.mode;
+                recognizer.vad.voiceMs = vad.voiceMs;
+            }
         }
         //verify if there are TTS Configs to set
         if (tts) {
             synthesizer.vendor = tts.ttsVendor;
             synthesizer.language = tts.ttsLanguage;
             synthesizer.voice = tts.ttsVoice;
+            synthesizer.azureServiceEndpoint = tts.azureServiceEndpoint ? tts.azureServiceEndpoint : "";
         }
         //verify if there are No User Input Configs to set
         if (userNoInput) {
@@ -155,17 +173,20 @@ exports.setSessionConfig = {
                 ? userNoInput.userNoInputTimeout / 1000
                 : 10;
         }
-        //verify if there are Continuous ASR Configs to set
+        // verify if there are Continuous ASR Configs to set
         if (continuousAsr === null || continuousAsr === void 0 ? void 0 : continuousAsr.asrEnabled) {
             recognizer.asrDtmfTerminationDigit = continuousAsr.asrDigit;
             recognizer.asrTimeout = continuousAsr.asrTimeout
                 ? continuousAsr.asrTimeout / 1000
                 : undefined;
         }
-        //verify if there are Barge In Configs to set
+        // verify if there are Barge In Configs to set
         if (bargeIn) {
             barge.enable = bargeIn.bargeInEnable;
-            barge.minBargeinWordCount = bargeIn.bargeInMinimunWords;
+            /* Barge in minimum words. min: 1, max: 5, default: 1 */
+            bargeIn.bargeInMinimunWords >= 1 && bargeIn.bargeInMinimunWords <= 5
+                ? (barge.minBargeinWordCount = bargeIn.bargeInMinimunWords)
+                : (barge.minBargeinWordCount = 1);
             barge.input = [];
             barge.actionHook = "voice";
             barge.dtmfBargein = bargeIn.bargeInOnDtmf;
@@ -178,32 +199,36 @@ exports.setSessionConfig = {
                 barge.input.push("speech");
             }
         }
-        //verify if there are DTMF Configs to set
+        // verify if there are DTMF Configs to set
         if (dtmf) {
             dtmfParam = dtmf.dtmfEnable;
             if (dtmf.dtmfEnable) {
+                barge.enable = (_a = barge.enable) !== null && _a !== void 0 ? _a : false;
                 barge.interDigitTimeout =
                     dtmf.dtmfInterDigitTimeout && dtmf.dtmfInterDigitTimeout >= 0
                         ? dtmf.dtmfInterDigitTimeout === 0
                             ? 0
                             : dtmf.dtmfInterDigitTimeout / 1000
                         : undefined;
+                /* Max digits. min: 1, max: - default: 1 */
                 barge.maxDigits =
-                    dtmf.dtmfMaxDigits && dtmf.dtmfMaxDigits >= 1
-                        ? dtmf.dtmfMaxDigits
-                        : undefined;
+                    dtmf.dtmfMaxDigits >= 1 ? (barge.maxDigits = dtmf.dtmfMaxDigits) : 1;
                 barge.minDigits = dtmf.dtmfMinDigits || 1;
                 barge.finishOnKey = dtmf.dtmfSubmitDigit;
             }
         }
-        //Check if there are configs for synthesizer, recognizer and bargeIn
+        // Check if there are configs for synthesizer, recognizer and bargeIn
         const voiceConfig = {
-            synthesizer: synthesizer ? synthesizer : undefined,
-            recognizer: recognizer ? recognizer : undefined,
-            bargeIn: barge ? barge : undefined,
+            synthesizer: synthesizer || undefined,
+            recognizer: recognizer || undefined,
+            bargeIn: barge || undefined,
         };
         (0, strip_nulls_1.stripNulls)(voiceConfig);
-        //Check if there are configs for No User Input and DTMF
+        if (voiceConfig.synthesizer && !voiceConfig.synthesizer.azureServiceEndpoint)
+            voiceConfig.synthesizer.azureServiceEndpoint = "";
+        if (voiceConfig.recognizer && !voiceConfig.recognizer.azureSttEndpointId)
+            voiceConfig.recognizer.azureSttEndpointId = "";
+        // Check if there are configs for No User Input and DTMF
         const cognigyConfig = {
             user: user ? user : undefined,
             dtmf: dtmfParam,
@@ -225,7 +250,7 @@ exports.setSessionConfig = {
         return payload;
     },
     handleAudioCodesInput(voiceSettings) {
-        const { bargeIn, continuousAsr, stt, tts, userNoInput, dtmf } = voiceSettings;
+        const { bargeIn, continuousAsr, stt, tts, userNoInput, dtmf, azureConfig } = voiceSettings;
         const sessionParams = {};
         if (stt) {
             sessionParams.sttLanguage = stt.sttLanguage;
@@ -241,6 +266,10 @@ exports.setSessionConfig = {
         if (tts) {
             sessionParams.ttsLanguage = tts.ttsLanguage;
             sessionParams.voiceName = tts.ttsVoice;
+            if (tts.azureServiceEndpoint) {
+                sessionParams.ttsDeploymentId = tts.azureServiceEndpoint;
+            }
+            ;
         }
         if (dtmf) {
             sessionParams.sendDTMF = dtmf.dtmfEnable;
@@ -278,6 +307,13 @@ exports.setSessionConfig = {
                 sessionParams.userNoInputRetries > 0)
                 sessionParams.userNoInputUrl = userNoInput.userNoInputUrl;
         }
+        if (azureConfig === null || azureConfig === void 0 ? void 0 : azureConfig.azureSttContextId) {
+            sessionParams.sttContextId = azureConfig.azureSttContextId;
+            if (azureConfig.azureEnableAudioLogging) {
+                sessionParams.azureEnableAudioLogging =
+                    azureConfig.azureEnableAudioLogging;
+            }
+        }
         const activities = {
             type: "event",
             name: "config",