@cognigy/rest-api-client 0.9.1 → 0.12.0

package/build/shared/charts/descriptors/voicegateway2/nodes/setSessionConfig.js

@@ -0,0 +1,584 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setSessionConfigNode = exports.voiceConfigFields = void 0;
+/** Custom Modules */
+const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
+/** Helper Modules */
+const design_1 = require("../utils/design");
+const strip_nulls_1 = require("../utils/strip-nulls");
+exports.voiceConfigFields = [
+    {
+        key: "bargeInMinWordCount",
+        type: "slider",
+        label: "Barge In Minimum Words",
+        description: "Defines the minimum number of words that the user must say for the Voice Gateway to consider it a barge in",
+        defaultValue: 1,
+        params: {
+            min: 0,
+            max: 5,
+            step: 1
+        }
+    },
+    {
+        key: "bargeInOnSpeech",
+        type: "toggle",
+        label: "Barge In On Speech",
+        description: "Allows the user to interrupt bot output with speech",
+        defaultValue: false
+    },
+    {
+        key: "bargeInOnDtmf",
+        type: "toggle",
+        label: "Barge In On DTMF",
+        description: "Allows the user to interrupt bot output with DTMF",
+        defaultValue: false
+    },
+    {
+        key: "sttVendor",
+        type: "sttSelect",
+        label: "_unused_",
+        description: "_unused_",
+        defaultValue: "",
+        params: {
+            languageKey: "config.sttLanguage"
+        }
+    },
+    {
+        key: "sttHints",
+        type: "textArray",
+        label: "STT Hints",
+        description: "Array of words or phrases to assist speech detection",
+        defaultValue: [""]
+    },
+    {
+        key: "ttsDisableCache",
+        type: "toggle",
+        label: "Disable TTS audio caching",
+        description: "Disable TTS audio caching for a reduced number of queries to TSS vendor. Warning, " +
+            "disabling caching increases your TTS costs",
+        defaultValue: false
+    },
+    {
+        key: "ttsVendor",
+        defaultValue: "",
+        type: "ttsSelect",
+        label: "_unused_",
+        description: "_unused_",
+        params: {
+            languageKey: "config.ttsLanguage",
+            voiceKey: "config.ttsVoice"
+        }
+    },
+    {
+        key: "sttVadEnabled",
+        type: "toggle",
+        label: "Enable Voice Activity Detection",
+        description: "Delay connection to cloud recognizer until speech is detected",
+        defaultValue: true
+    },
+    {
+        key: "sttVadMode",
+        type: "slider",
+        label: "VAD sensitivity",
+        description: "Detection sensitivity, the lowest value has the highest sensitivity",
+        defaultValue: 1,
+        params: {
+            min: 0,
+            max: 3,
+            step: 1
+        },
+        condition: {
+            key: "sttVadEnabled",
+            value: true
+        }
+    },
+    {
+        key: "sttVadVoiceMs",
+        type: "slider",
+        label: "Minimal voice duration",
+        description: "Milliseconds of speech activity required before connecting to the cloud recognizer",
+        defaultValue: 100,
+        params: {
+            min: 100,
+            max: 1000,
+            step: 100
+        },
+        condition: {
+            key: "sttVadEnabled",
+            value: true
+        }
+    },
+    /*
+    {
+        key: "azureTtsDeploymentId",
+        type: "text",
+        label: "Azure TTS deployment ID",
+        description: "Define a custom azure deployment for TTS",
+        defaultValue: ""
+    },
+    {
+        key: "azureSttDeploymentId",
+        type: "text",
+        label: "Azure STT deployment ID",
+        description: "Define a custome azure STT deployment",
+        defaultValue: ""
+    },
+    {
+        key: "azureSpeechRecognitionMode",
+        type: "text",
+        label: "Azure Speech recognition mode",
+        description: "Define azure STT mode",
+        defaultValue: ""
+    },
+    {
+        key: "azureEnableAudioLogging",
+        type: "toggle",
+        label: "Azure Audio logging",
+        description: "Select the desired TTS Vendor",
+        defaultValue: false
+    },
+    {
+        key: "azureHintsBoost",
+        type: "number",
+        label: "Azure Hints Boost",
+        description: "Define if Azure Hints needs to be boosted",
+        defaultValue: 0
+    },
+    {
+        key: "googleDisablePunctuation",
+        type: "toggle",
+        label: "Google Disable Punctuation",
+        description: "Disable Punctuation detection in Google's STT",
+        defaultValue: false
+    },
+    {
+        key: "googleInteractionType",
+        type: "text",
+        label: "Google STT Interaction type",
+        description: "Define Google STT interaction type",
+        defaultValue: ""
+    },
+    {
+        key: "googleHintsBoost",
+        type: "number",
+        label: "Google STT Hints Boost",
+        description: "Define if Google Hints needs to be boosted",
+        defaultValue: 0
+    },*/
+    {
+        key: "userNoInputMode",
+        type: "select",
+        label: "User No Input Mode",
+        description: "Define what should happen if a user does not provide input to the bot in time",
+        defaultValue: "event",
+        params: {
+            options: [
+                {
+                    label: "Speak", value: "speech"
+                },
+                {
+                    label: "Play File", value: "play"
+                },
+                {
+                    label: "Send Event", value: "event"
+                }
+            ]
+        }
+    },
+    {
+        key: "userNoInputTimeout",
+        type: "number",
+        label: "User No Input Timeout",
+        description: "Define the timeout for user input in ms",
+        defaultValue: 10000
+    },
+    {
+        key: "userNoInputRetries",
+        type: "number",
+        label: "User No Input Retries",
+        description: "Define how often the bot should retry to get an input from a user before completing the call",
+        defaultValue: 1
+    },
+    {
+        key: "userNoInputSpeech",
+        type: "text",
+        label: "User No Input Speech",
+        description: "Define a prompt to speak in case a user does not answer the bot in time",
+        defaultValue: "",
+        condition: {
+            key: "userNoInputMode",
+            value: "speech"
+        },
+        params: {
+            required: true
+        }
+    },
+    {
+        key: "userNoInputUrl",
+        type: "text",
+        label: "User No Input URL",
+        description: "Define which URL will be played in case a user does not answer the bot in time. MP3 and WAV files are supported",
+        defaultValue: "",
+        condition: {
+            key: "userNoInputMode",
+            value: "play"
+        },
+        params: {
+            required: true
+        }
+    },
+    /*
+    {
+        key: "botFailOnError",
+        type: "toggle",
+        label: "Bot Fail on Error",
+        description: "Define if the Bot should fail and escalate the call if an error occured",
+        defaultValue: true
+    },
+    {
+        key: "botNoOutputGiveupTimeout",
+        type: "number",
+        label: "Bot No Output Giveup Tinmeout",
+        description:
+            "Define the time in ms, after which the bot should escalate if no output has been provided by cognigy",
+        defaultValue: 0
+    },
+    {
+        key: "botNoOutputTimeout",
+        type: "number",
+        label: "Bot No Output Timeout",
+        description: "Define the timeout for bot outputin ms",
+        defaultValue: 0
+    },
+    {
+        key: "botNoOutputRetries",
+        type: "number",
+        label: "Bot No Input Retries",
+        description: "Define how many times should we try to get bot output",
+        defaultValue: 0
+    },
+    {
+        key: "botNoOutputSpeech",
+        type: "text",
+        label: "Bot No Input Speech",
+        description: "Define the default speech the bot will speak if no bot output detected",
+        defaultValue: ""
+    },
+    {
+        key: "botNoOutputUrl",
+        type: "text",
+        label: "Bot No Input URL",
+        description: "Define the file which should be played if no bot output was detected",
+        defaultValue: ""
+    },*/
+    {
+        key: "dtmfEnable",
+        type: "toggle",
+        label: "Capture DTMF signals",
+        description: "Enable capturing of DTMF signals by the bot",
+        defaultValue: false
+    },
+    {
+        key: "dtmfInterDigitTimeout",
+        type: "number",
+        label: "DTMF Inter Digit Timeout",
+        description: "Define the max timeout between entering the digits on the phone",
+        defaultValue: 1000,
+        condition: {
+            key: "dtmfEnable",
+            value: true
+        }
+    },
+    {
+        key: "dtmfMaxDigits",
+        type: "number",
+        label: "DTMF Max Digits",
+        description: "Define the max number of digits which can be entered by the user. After reaching the max number of entered digits these will be automatically submited to the bot",
+        defaultValue: 1,
+        condition: {
+            key: "dtmfEnable",
+            value: true
+        }
+    },
+    {
+        key: "dtmfMinDigits",
+        type: "number",
+        label: "DTMF Min Digits",
+        description: "Define the min number of digits a user needs to submit before they are forwarded to the bot. Can be overriden by a submit digit",
+        defaultValue: 1,
+        condition: {
+            key: "dtmfEnable",
+            value: true
+        }
+    },
+    {
+        key: "dtmfSubmitDigit",
+        type: "text",
+        label: "DTMF Submit Digit",
+        description: "Define the DTMF submit digit which will be used for submitting the previously entered digits. Overrides min digits validation",
+        defaultValue: "#",
+        condition: {
+            key: "dtmfEnable",
+            value: true
+        }
+    },
+    /*
+    {
+        key: "asrDigits",
+        type: "text",
+        label: "ASR Digits",
+        description: "???????",
+        defaultValue: ""
+    },
+    {
+        key: "asrTimeout",
+        type: "number",
+        label: "ASR Timeout in ms",
+        description: "???",
+        defaultValue: 0
+    },
+    */
+    /*
+    {
+        key: "setBotOutputParams",
+        label: "Set Bot Output Parameters",
+        type: "toggle",
+        defaultValue: false
+    },
+    {
+        key: "setContiniousASR",
+        label: "Set continous ASR params",
+        type: "toggle",
+        defaultValue: false
+    },
+    {
+        key: "setAzureParams",
+        label: "Set Azure STT/TTS params",
+        type: "toggle",
+        defaultValue: false
+    },
+    {
+        key: "setGoogleParams",
+        label: "Set Google STT/TTS params",
+        type: "toggle",
+        defaultValue: false
+    }*/
+];
+exports.setSessionConfigNode = createNodeDescriptor_1.createNodeDescriptor({
+    type: "setSessionConfig",
+    defaultLabel: "Set Session Config",
+    appearance: {
+        color: design_1.nodeColor
+    },
+    fields: exports.voiceConfigFields,
+    sections: [
+        {
+            key: "params_stt",
+            label: "Recognizer (STT)",
+            defaultCollapsed: true,
+            fields: ["sttVendor", "sttHints", "sttVadEnabled", "sttVadMode", "sttVadVoiceMs"]
+        },
+        {
+            key: "params_tts",
+            label: "Synthesizer (TTS)",
+            defaultCollapsed: true,
+            fields: ["ttsVendor"]
+        },
+        {
+            key: "params_bargein",
+            label: "Barge In",
+            defaultCollapsed: true,
+            fields: ["bargeInOnSpeech", "bargeInOnDtmf", "bargeInMinWordCount"]
+        },
+        /*
+        {
+            key: "params_azure",
+            label: "Azure STT/TTS Configuration",
+            defaultCollapsed: true,
+            fields: [
+                "azureTtsDeploymentId",
+                "azureSttDeploymentId",
+                "azureSpeechRecognitionMode",
+                "azureEnableAudioLogging",
+                "azureHintsBoost"
+            ],
+            condition: {
+                key: "setAzureParams",
+                value: true
+            }
+        },
+        {
+            key: "params_google",
+            label: "Google STT/TTS Configuration",
+            defaultCollapsed: true,
+            fields: ["googleDisablePunctuation", "googleInteractionType", "googleHintsBoost"],
+            condition: {
+                key: "setGoogleParams",
+                value: true
+            }
+        },*/
+        {
+            key: "params_user_timeouts",
+            label: "User Input Timeout",
+            defaultCollapsed: true,
+            fields: [
+                "userNoInputMode",
+                "userNoInputSpeech",
+                "userNoInputUrl",
+                "userNoInputTimeout",
+                "userNoInputRetries"
+            ]
+        },
+        /*
+        {
+            key: "params_bot_timeouts",
+            label: "Configure what should happen on bot output timeout",
+            defaultCollapsed: true,
+            fields: [
+                "botFailOnError",
+                "botNoOutputGiveupTimeout",
+                "botNoOutputTimeout",
+                "botNoOutputRetries",
+                "botNoOutputSpeech",
+                "botNoOutputUrl"
+            ],
+            condition: {
+                key: "setBotOutputParams",
+                value: true
+            }
+        },*/
+        {
+            key: "params_dtmf",
+            label: "DTMF",
+            defaultCollapsed: true,
+            fields: ["dtmfEnable", "dtmfInterDigitTimeout", "dtmfMaxDigits", "dtmfMinDigits", "dtmfSubmitDigit"]
+        }
+        /*
+        {
+            key: "params_continuousasr",
+            label: "Configgure the cotinious Audio Speech Recognition",
+            defaultCollapsed: true,
+            fields: ["arsDigits", "asrTimeout"],
+            condition: {
+                key: "setContiniousASR",
+                value: true
+            }
+        }*/
+    ],
+    form: [
+        { type: "section", key: "params_tts" },
+        { type: "section", key: "params_stt" },
+        { type: "section", key: "params_bargein" },
+        { type: "section", key: "params_user_timeouts" },
+        //{ type: "field", key: "setBotOutputParams" },
+        //{ type: "section", key: "params_bot_timeouts" },
+        { type: "section", key: "params_dtmf" },
+        //{ type: "field", key: "setContiniousASR" },
+        //{ type: "section", key: "params_continuousasr" },
+        //{ type: "field", key: "setAzureParams" },
+        //{ type: "section", key: "params_azure" },
+        //{ type: "field", key: "setGoogleParams" },
+        //{ type: "section", key: "params_google" }
+    ],
+    summary: "Change configuration settings for the call session",
+    function: async ({ cognigy, config }) => {
+        const { api } = cognigy;
+        const voiceGateway2VerbConfig = {};
+        const voiceGateway2CongnigyConfig = {};
+        const synthesizer = {
+            language: config.ttsLanguage,
+            voice: config.ttsVoice,
+            vendor: config.ttsVendor
+        };
+        voiceGateway2VerbConfig.synthesizer = synthesizer;
+        const recognizer = {
+            language: config.sttLanguage,
+            vendor: config.sttVendor || "default",
+            hints: config.sttHints,
+            vad: {
+                enable: config.sttVadEnabled,
+                mode: config.sttVadMode,
+                voiceMs: config.sttVadVoiceMs
+            }
+        };
+        voiceGateway2VerbConfig.recognizer = recognizer;
+        const bargein = {
+            enable: false,
+            minBargeinWordCount: config.bargeInMinWordCount,
+            input: [],
+            actionHook: "voice"
+        };
+        if (config.bargeInOnDtmf) {
+            bargein.dtmfBargein = true;
+            bargein.input.push("digits");
+        }
+        if (config.bargeInOnSpeech) {
+            bargein.input.push("speech");
+        }
+        if (bargein.input.length > 0) {
+            bargein.enable = true;
+            bargein.sticky = true;
+        }
+        voiceGateway2VerbConfig.bargeIn = bargein;
+        const user = {
+            noInputMode: config.userNoInputMode,
+            noInputTimeout: (config.userNoInputTimeout || 10000) / 1000,
+            noInputRetries: config.userNoInputRetries,
+            noInputSpeech: config.userNoInputSpeech,
+            noInputUrl: config.userNoInputUrl
+        };
+        voiceGateway2CongnigyConfig.cognigyConfig = { user };
+        /*
+        todo this needs to be implemented on voiceGateway2 side first
+        if (setBotOutputParams) {
+            const bot: BotOutputConfig = {
+                failOnError: config.botFailOnError,
+                noInputGiveUpTimeoutMs: config.botNoOutputGiveupTimeout,
+                noInputTimeout: config.botNoOutputTimeout,
+                noInputRetries: config.botNoOutputRetries,
+                noInputSpeech: config.botNoOutputSpeech,
+                noInputUrl: config.botNoOutputUrl
+            };
+
+            sessionConfig.bot = bot;
+        }
+        */
+        if (config.dtmfEnable) {
+            if (!voiceGateway2VerbConfig.bargeIn) {
+                voiceGateway2VerbConfig.bargeIn = {
+                    enable: false
+                };
+            }
+            voiceGateway2VerbConfig.bargeIn.interDigitTimeout =
+                (config.dtmfInterDigitTimeout || 500) / 1000;
+            voiceGateway2VerbConfig.bargeIn.maxDigits = config.dtmfMaxDigits;
+            voiceGateway2VerbConfig.bargeIn.minDigits = config.dtmfMinDigits;
+            voiceGateway2VerbConfig.bargeIn.finishOnKey = config.dtmfSubmitDigit;
+            if (!voiceGateway2CongnigyConfig.cognigyConfig) {
+                voiceGateway2CongnigyConfig.cognigyConfig = {};
+            }
+            voiceGateway2CongnigyConfig.cognigyConfig.dtmf = true;
+        }
+        //if (setContiniousASR) {
+        //	// todo
+        //}
+        //if (setAzureParams) {
+        //	// todo
+        //}
+        //if (setGoogleParams) {
+        // todo
+        //}
+        if (Object.keys(voiceGateway2VerbConfig).length > 0) {
+            voiceGateway2CongnigyConfig.voiceGateway2Config = voiceGateway2VerbConfig;
+        }
+        strip_nulls_1.stripNulls(voiceGateway2CongnigyConfig);
+        api.say(null, {
+            _cognigy: {
+                _voiceGateway2: {
+                    json: voiceGateway2CongnigyConfig
+                }
+            }
+        });
+    }
+});
+//# sourceMappingURL=setSessionConfig.js.map

package/build/shared/charts/descriptors/voicegateway2/utils/design.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.nodeColor = void 0;
+exports.nodeColor = "#F5A623";
+//# sourceMappingURL=design.js.map

package/build/shared/charts/descriptors/voicegateway2/utils/strip-nulls.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.stripNulls = void 0;
+function stripNulls(data) {
+    Object.entries(data).forEach(([key, value]) => {
+        if (typeof value === "undefined" || typeof value === null || (typeof value === "string" && value.length == 0)) {
+            delete data[key];
+        }
+        if (typeof value === "object" && (typeof value !== "number" || typeof value !== "string")) {
+            stripNulls(value);
+        }
+        if (typeof value === "object" && (typeof value !== "number" || typeof value !== "string" || typeof value !== "boolean") && Object.keys(value).length === 0) {
+            delete data[key];
+        }
+    });
+    return data;
+}
+exports.stripNulls = stripNulls;
+//# sourceMappingURL=strip-nulls.js.map

package/build/shared/constants.js

@@ -1,9 +1,21 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CREATED_BY_SSO = "SSO";
+exports.ADMIN_CONSOLE_URL_TOKEN = exports.X_COGNIGY_ORIGIN = exports.EMBEDDED_EXTENSION = exports.VOICE_GATEWAY_2_EXTENSION = exports.MICROSOFT_EXTENSION = exports.VOICE_GATEWAY_EXTENSION = exports.SMTP_EXTENSION = exports.SQL_EXTENSION = exports.MONGO_DB_EXTENSION = exports.BASIC_EXTENSION = exports.MAX_INT32 = exports.PASSWORD_RESET_TOKEN_TTL_IN_SECONDS = exports.SCOPED_USER = exports.SYSTEM = exports.CREATED_BY_SSO = void 0;
+exports.CREATED_BY_SSO = "000000000000000000000550";
+exports.SYSTEM = "000000000000000000000000";
+exports.SCOPED_USER = "000000000000000000000660";
+exports.PASSWORD_RESET_TOKEN_TTL_IN_SECONDS = 900;
 exports.MAX_INT32 = 2147483647;
 exports.BASIC_EXTENSION = "@cognigy/basic-nodes";
 exports.MONGO_DB_EXTENSION = "@cognigy/mongodb";
 exports.SQL_EXTENSION = "@cognigy/mssql";
 exports.SMTP_EXTENSION = "@cognigy/smtp";
+exports.VOICE_GATEWAY_EXTENSION = "@cognigy/voicegateway";
+exports.MICROSOFT_EXTENSION = "@cognigy/microsoft";
+// to minimize confusion and also to not break existing voicegateway nodes implementation,
+// we will call the new set of voice nodes voiceGateway2
+exports.VOICE_GATEWAY_2_EXTENSION = "@cognigy/voicegateway2";
+exports.EMBEDDED_EXTENSION = "@embedded/";
+exports.X_COGNIGY_ORIGIN = "x-cognigy-origin";
+exports.ADMIN_CONSOLE_URL_TOKEN = "ffffffffffffffffffff55555555555555555eeeeeeeeeeeeeeeaaaaaaaaaaaa";
 //# sourceMappingURL=constants.js.map

package/build/shared/errors/BadGatewayError.js

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

package/build/shared/errors/BadRequestError.js

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

package/build/shared/errors/ErrorCode.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ErrorCode = void 0;
 var ErrorCode;
 (function (ErrorCode) {
     ErrorCode[ErrorCode["BAD_REQUEST"] = 400] = "BAD_REQUEST";
@@ -10,6 +11,7 @@ var ErrorCode;
     ErrorCode[ErrorCode["BAD_GATEWAY"] = 502] = "BAD_GATEWAY";
     ErrorCode[ErrorCode["SERVICE_UNAVAILABLE_ERROR"] = 503] = "SERVICE_UNAVAILABLE_ERROR";
     ErrorCode[ErrorCode["GATEWAY_TIMEOUT_ERROR"] = 504] = "GATEWAY_TIMEOUT_ERROR";
+    ErrorCode[ErrorCode["NETWORK_ERROR"] = 666] = "NETWORK_ERROR";
     ErrorCode[ErrorCode["MISSING_ARGUMENT_ERROR"] = 1000] = "MISSING_ARGUMENT_ERROR";
     ErrorCode[ErrorCode["DATABASE_WRITE_ERROR"] = 1001] = "DATABASE_WRITE_ERROR";
     ErrorCode[ErrorCode["RESOURCE_NOT_FOUND_ERROR"] = 1002] = "RESOURCE_NOT_FOUND_ERROR";