@cognigy/rest-api-client 2025.11.0 → 2025.13.0

package/CHANGELOG.md

@@ -1,3 +1,13 @@
+# 2025.13.0
+Released: June 24th, 2025 
+
+Released state of package up to date with Cognigy.AI v2025.13.0 
+
+# 2025.12.0
+Released: June 10th, 2025 
+
+Released state of package up to date with Cognigy.AI v2025.12.0 
+
 # 2025.11.0
 Released: May 27th, 2025 
 

package/build/RestAPIClient.js

@@ -18,6 +18,7 @@ const ResourcesAPIGroup_2_0_1 = require("./apigroups/ResourcesAPIGroup_2_0");
 const SessionsAPIGroup_2_0_1 = require("./apigroups/SessionsAPIGroup_2_0");
 const logger_1 = require("./shared/helper/logger");
 const AIOpsCenterAPIGroup_2_0_1 = require("./apigroups/AIOpsCenterAPIGroup_2_0");
+const SimulationAPIGroup_2_0_1 = require("./apigroups/SimulationAPIGroup_2_0");
 exports.RestAPIClient = function (config) {
     var _a;
     if (!(this instanceof exports.RestAPIClient)) {
@@ -92,6 +93,12 @@ exports.RestAPIClient = function (config) {
                 plugins.push(AIOpsCenterAPIGroup_2_0_1.AIOpsCenterAPIGroup_2_0);
                 break;
         }
+        switch (config.versions.simulation) {
+            default:
+            case "2.0":
+                plugins.push(SimulationAPIGroup_2_0_1.SimulationAPIGroup_2_0);
+                break;
+        }
         const Client = PluginBase_1.Base.plugin(plugins);
         Client.config = config;
         Client.prototype.getHttpAdapter = () => {

package/build/apigroups/ResourcesAPIGroup_2_0.js

@@ -628,6 +628,10 @@ const ResourcesAPIGroup_2_0 = (instance) => {
         generateNluScores: (_a) => {
             var { projectId } = _a, args = __rest(_a, ["projectId"]);
             return (0, GenericAPIFn_1.GenericAPIFn)(`/new/v2.0/projects/${projectId}/nlu/scores`, "POST", self)(args);
+        },
+        generateDesignTimeLLMOutput: (_a) => {
+            var { projectId } = _a, args = __rest(_a, ["projectId"]);
+            return (0, GenericAPIFn_1.GenericAPIFn)(`/new/v2.0/projects/${projectId}/generate-output/design-time-llm`, "POST", self)(args);
         }
     };
 };

package/build/apigroups/SimulationAPIGroup_2_0.js

@@ -0,0 +1,58 @@
+"use strict";
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SimulationAPIGroup_2_0 = void 0;
+const GenericAPIFn_1 = require("../GenericAPIFn");
+const query_1 = require("../shared/helper/rest/query");
+function SimulationAPIGroup_2_0(instance) {
+    const self = instance;
+    return {
+        indexSimulations: (args, options) => (0, GenericAPIFn_1.GenericAPIFn)(`/testing/beta/simulations?${(0, query_1.stringifyQuery)(args)}`, "GET", self)(undefined, options),
+        createSimulation: (args, options) => (0, GenericAPIFn_1.GenericAPIFn)("/testing/beta/simulations", "POST", self)(args, options),
+        updateSimulation: (_a, options) => {
+            var { simulationReference, projectId } = _a, args = __rest(_a, ["simulationReference", "projectId"]);
+            return (0, GenericAPIFn_1.GenericAPIFn)(`/testing/beta/simulations/${simulationReference}?${(0, query_1.stringifyQuery)({
+                projectId
+            })}`, "PATCH", self)(args, options);
+        },
+        deleteSimulation: ({ simulationReference, projectId }, options) => (0, GenericAPIFn_1.GenericAPIFn)(`/testing/beta/simulations/${simulationReference}?${(0, query_1.stringifyQuery)({
+            projectId
+        })}`, "DELETE", self)(undefined, options),
+        readSimulation: ({ simulationReference, projectId }, options) => (0, GenericAPIFn_1.GenericAPIFn)(`/testing/beta/simulations/${simulationReference}?${(0, query_1.stringifyQuery)({
+            projectId
+        })}`, "GET", self)(undefined, options),
+        scheduleSimulation: (_a, options) => {
+            var { simulationReference } = _a, args = __rest(_a, ["simulationReference"]);
+            return (0, GenericAPIFn_1.GenericAPIFn)(`/testing/beta/simulations/${simulationReference}/schedule`, "POST", self)(args, options);
+        },
+        indexSimulationRunBatches: (args, options) => (0, GenericAPIFn_1.GenericAPIFn)(`/testing/beta/simulations/batches?${(0, query_1.stringifyQuery)(args)}`, "GET", self)(undefined, options),
+        getAllSimulationRunBatches: (_a, options) => {
+            var { simulationReference } = _a, args = __rest(_a, ["simulationReference"]);
+            return (0, GenericAPIFn_1.GenericAPIFn)(`/testing/beta/simulations/${simulationReference}/batches?${(0, query_1.stringifyQuery)(args)}`, "GET", self)(undefined, options);
+        },
+        readSimulationRunBatch: (_a, options) => {
+            var { simulationReference, simulationRunBatchReference } = _a, args = __rest(_a, ["simulationReference", "simulationRunBatchReference"]);
+            return (0, GenericAPIFn_1.GenericAPIFn)(`/testing/beta/simulations/${simulationReference}/batches/${simulationRunBatchReference}?${(0, query_1.stringifyQuery)(args)}`, "GET", self)(undefined, options);
+        },
+        indexSimulationRuns: (_a, options) => {
+            var { simulationReference, simulationRunBatchReference } = _a, args = __rest(_a, ["simulationReference", "simulationRunBatchReference"]);
+            return (0, GenericAPIFn_1.GenericAPIFn)(`/testing/beta/simulations/${simulationReference}/batches/${simulationRunBatchReference}/runs?${(0, query_1.stringifyQuery)(args)}`, "GET", self)(undefined, options);
+        },
+        readSimulationRun: (_a, options) => {
+            var { simulationReference, simulationRunBatchReference, simulationRunReference } = _a, args = __rest(_a, ["simulationReference", "simulationRunBatchReference", "simulationRunReference"]);
+            return (0, GenericAPIFn_1.GenericAPIFn)(`/testing/beta/simulations/${simulationReference}/batches/${simulationRunBatchReference}/runs/${simulationRunReference}?${(0, query_1.stringifyQuery)(args)}`, "GET", self)(undefined, options);
+        }
+    };
+}
+exports.SimulationAPIGroup_2_0 = SimulationAPIGroup_2_0;
+//# sourceMappingURL=SimulationAPIGroup_2_0.js.map

package/build/apigroups/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AIOpsCenterAPIGroup_2_0 = exports.AnalyticsAPIGroup_2_0 = exports.SessionsAPIGroup_2_0 = exports.ResourcesAPIGroup_2_0 = exports.ManagementAPIGroup_2_0 = exports.MetricsAPIGroup_2_0 = exports.JWTAuthAPIGroup_2_0 = exports.InsightsAPIGroup_2_0 = exports.ExternalAPIGroup_2_0 = exports.AdministrationAPIGroup_2_1 = exports.AdministrationAPIGroup_2_0 = void 0;
+exports.SimulationAPIGroup_2_0 = exports.AIOpsCenterAPIGroup_2_0 = exports.AnalyticsAPIGroup_2_0 = exports.SessionsAPIGroup_2_0 = exports.ResourcesAPIGroup_2_0 = exports.ManagementAPIGroup_2_0 = exports.MetricsAPIGroup_2_0 = exports.JWTAuthAPIGroup_2_0 = exports.InsightsAPIGroup_2_0 = exports.ExternalAPIGroup_2_0 = exports.AdministrationAPIGroup_2_1 = exports.AdministrationAPIGroup_2_0 = void 0;
 // AdministrationAPIGroup;
 var AdministrationAPIGroup_2_0_1 = require("./AdministrationAPIGroup_2_0");
 Object.defineProperty(exports, "AdministrationAPIGroup_2_0", { enumerable: true, get: function () { return AdministrationAPIGroup_2_0_1.AdministrationAPIGroup_2_0; } });
@@ -25,4 +25,6 @@ var AnalyticsAPIGroup_2_0_1 = require("./AnalyticsAPIGroup_2_0");
 Object.defineProperty(exports, "AnalyticsAPIGroup_2_0", { enumerable: true, get: function () { return AnalyticsAPIGroup_2_0_1.AnalyticsAPIGroup_2_0; } });
 var AIOpsCenterAPIGroup_2_0_1 = require("./AIOpsCenterAPIGroup_2_0");
 Object.defineProperty(exports, "AIOpsCenterAPIGroup_2_0", { enumerable: true, get: function () { return AIOpsCenterAPIGroup_2_0_1.AIOpsCenterAPIGroup_2_0; } });
+var SimulationAPIGroup_2_0_1 = require("./SimulationAPIGroup_2_0");
+Object.defineProperty(exports, "SimulationAPIGroup_2_0", { enumerable: true, get: function () { return SimulationAPIGroup_2_0_1.SimulationAPIGroup_2_0; } });
 //# sourceMappingURL=index.js.map

package/build/shared/charts/descriptors/analytics/trackGoal.js

@@ -47,7 +47,7 @@ exports.TRACK_GOAL = (0, createNodeDescriptor_1.createNodeDescriptor)({
             return;
         }
         const sessionState = api.getSessionStateCopy();
-        const { selectedSteps, version, name, goalId, } = config.goal;
+        const { selectedSteps, referenceId, version, name, goalId, } = config.goal;
         const activeCycleIds = ((_a = sessionState.analytics) === null || _a === void 0 ? void 0 : _a.goalCycleIds) || {};
         let cycleId = activeCycleIds[goalId];
         const hasStartStep = selectedSteps.some(step => step.type === "start");
@@ -75,10 +75,12 @@ exports.TRACK_GOAL = (0, createNodeDescriptor_1.createNodeDescriptor)({
                     organisationId,
                     sessionId,
                     version,
+                    referenceId,
                     timestamp: new Date(),
                     goalCycleId: cycleId,
                     goalId,
                     stepId: step.stepId,
+                    stepType: step.type,
                     endpointUrlToken,
                     endpointName,
                     endpointType,

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

@@ -91,6 +91,10 @@ const nodes = [
     service_1.CHECK_AGENT_AVAILABILITY,
     service_1.HTTP_REQUEST,
     service_1.GPT_PROMPT,
+    service_1.LLM_PROMPT_V2,
+    service_1.LLM_PROMPT_DEFAULT,
+    service_1.LLM_PROMPT_MCP_TOOL,
+    service_1.LLM_PROMPT_TOOL,
     service_1.GPT_CONVERSATION,
     service_1.GPT_CONVERSATION_SUMMARY,
     service_1.LLM_ENTITY_EXTRACT,
@@ -146,6 +150,7 @@ if (process.env.DISABLE_FEATURE_TRANSCRIPT_MANAGER !== "true") {
     nodes.push(service_1.AI_AGENT_JOB_CALL_MCP_TOOL);
     nodes.push(service_1.AI_AGENT_TOOL_ANSWER);
     nodes.push(service_1.AI_AGENT_HANDOVER);
+    nodes.push(service_1.LOAD_AI_AGENT);
 }
 if (process.env.FEATURE_USE_COGNIGY_LIVE_AGENT === "true") {
     nodes.push(liveAgent_1.ASSIST_INFO);
@@ -167,7 +172,8 @@ exports.cognigyBasicModule = (0, createNodeDescriptor_1.createExtension)({
         service_1.EIGHT_BY_EIGHT_CONNECTION,
         service_1.GENESYS_CLOUD_CONNECTION,
         service_1.GENESYS_CLOUD_CONNECTION_OM,
-        service_1.NICECXONEAAH_AUTHENTICATION_CONNECTION
+        service_1.NICECXONEAAH_AUTHENTICATION_CONNECTION,
+        service_1.AIOPS_CENTER_WEBHOOKS_CONNECTION,
     ],
 });
 var mongoDB_1 = require("./connectionNodes/mongoDB");

package/build/shared/charts/descriptors/knowledgeSearch/searchExtractOutput.js

@@ -584,10 +584,12 @@ exports.SEARCH_EXTRACT_OUTPUT = (0, createNodeDescriptor_1.createNodeDescriptor)
             // 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 = (_b = cognigy.lastConversationEntries) === null || _b === void 0 ? void 0 : _b.slice(1, 3).reverse().map(entry => "- " + (entry.source === "user" ? "USER: " : "BOT: ") + entry.text).join("\n");
+                lastRoundTrip = (_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");
                 // 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 = (_c = cognigy.lastConversationEntries) === null || _c === void 0 ? void 0 : _c.slice(1, followUpDetectionSteps + 1).reverse().map(entry => "- " + (entry.source === "user" ? "USER: " : "BOT: ") + entry.text).join("\n");
+                const recentConversation = (_c = cognigy
+                    .lastConversationEntries) === null || _c === void 0 ? void 0 : _c.slice(1, followUpDetectionSteps + 1).reverse().map(entry => "- " + (entry.source === "user" ? "USER: " : "BOT: ") + entry.text).join("\n");
                 prompt = `Below is the transcript of a conversation:
 ${recentConversation}
 USER: ${searchString}

package/build/shared/charts/descriptors/message/question/question.js

@@ -309,7 +309,7 @@ exports.QUESTION = (0, createNodeDescriptor_1.createNodeDescriptor)({
         },
         {
             key: "repromptLLMPrompt",
-            type: "cognigyText",
+            type: "cognigyLLMText",
             label: "UI__NODE_EDITOR__MESSAGE__QUESTION__QUESTION__FIELDS__REPROMPT_LLM_PROMPT__LABEL",
             description: "UI__NODE_EDITOR__MESSAGE__QUESTION__QUESTION__FIELDS__REPROMPT_LLM_PROMPT__DESCRIPTION",
             defaultValue: `You are a chatbot that helps a user.
@@ -742,6 +742,17 @@ DO NOT talk about other topics. Do not offer general assistance.`,
             },
             defaultValue: true,
         },
+        {
+            key: "escalateAnswersRepeatHandoverMessage",
+            type: "toggle",
+            label: "UI__NODE_EDITOR__MESSAGE__QUESTION__QUESTION__FIELDS__ESCALATE_ANSWERS_REPEAT_HANDOVER_MESSAGE__LABEL",
+            description: "UI__NODE_EDITOR__MESSAGE__QUESTION__QUESTION__FIELDS__ESCALATE_ANSWERS_REPEAT_HANDOVER_MESSAGE__DESCRIPTION",
+            defaultValue: false,
+            condition: {
+                key: "escalateAnswersAction",
+                value: "handover"
+            }
+        },
         {
             key: "escalateAnswersHandoverCancelIntent",
             type: "cognigyText",
@@ -2409,6 +2420,7 @@ DO NOT talk about other topics. Do not offer general assistance.`,
                 api.logDebugMessage(`UI__DEBUG_MODE__QUESTION__MESSAGE_5`, "Skipping Reprompt Message");
                 sayReprompt = false;
             }
+            let nodeType = "question";
             // We will only output a reprompt if the user is not in the first execution
             // and no skip condition is true
             if ((validationMessage || repromptType) && !isFirstExecution && sayReprompt) {
@@ -2419,9 +2431,13 @@ DO NOT talk about other topics. Do not offer general assistance.`,
                 rephraseWithAIParams.question = say.text[0];
                 rephraseWithAIParams.answer = input.text;
                 if (sayReprompt) {
+                    nodeType = "question.reprompt";
                     switch (repromptType) {
                         case "say":
-                            await say_1.SAY.function(Object.assign({ nodeType: "question.reprompt", cognigy, childConfigs: [], nodeId, organisationId, config: { preventTranscript, say: repromptSay } }, rephraseWithAIParams));
+                            if ((input === null || input === void 0 ? void 0 : input.channel) === "voiceGateway2" && !validationRepeat) {
+                                nodeType = "question";
+                            }
+                            await say_1.SAY.function(Object.assign({ nodeType, cognigy, childConfigs: [], nodeId, organisationId, config: { preventTranscript, say: repromptSay } }, rephraseWithAIParams));
                             break;
                         case "execute":
                             // if a question reprompt is set to execute flow and we have just executed
@@ -2470,11 +2486,14 @@ DO NOT talk about other topics. Do not offer general assistance.`,
                             }
                             const repromptMessage = await api.runGenerativeAIPrompt(data, "gptPromptNode");
                             if (!repromptLLMStream) {
-                                await say_1.SAY.function({ nodeType: "question.reprompt", cognigy, childConfigs: [], nodeId, organisationId, config: Object.assign({ preventTranscript, handoverOutput, say: { type: "text", text: [repromptMessage] } }, rephraseWithAIParams) });
+                                await say_1.SAY.function({ nodeType, cognigy, childConfigs: [], nodeId, organisationId, config: Object.assign({ preventTranscript, handoverOutput, say: { type: "text", text: [repromptMessage] } }, rephraseWithAIParams) });
                             }
                             break;
                         default: // this is also "text"
-                            await say_1.SAY.function({ nodeType: "question.reprompt", cognigy, childConfigs: [], nodeId, organisationId, config: Object.assign({ preventTranscript, handoverOutput, say: { type: "text", text: [validationMessage] } }, rephraseWithAIParams) });
+                            if ((input === null || input === void 0 ? void 0 : input.channel) === "voiceGateway2" && !validationRepeat) {
+                                nodeType = "question";
+                            }
+                            await say_1.SAY.function({ nodeType, cognigy, childConfigs: [], nodeId, organisationId, config: Object.assign({ preventTranscript, handoverOutput, say: { type: "text", text: [validationMessage] } }, rephraseWithAIParams) });
                     }
                 }
                 /* If repeat toggle is on, also output question (and maybe datepicker) again */
@@ -2499,7 +2518,7 @@ DO NOT talk about other topics. Do not offer general assistance.`,
                 rephraseWithAIParams.promptType = "question";
                 rephraseWithAIParams.questionType = config.type;
                 await say_1.SAY.function({
-                    nodeType: "question.initial",
+                    nodeType,
                     cognigy,
                     childConfigs: [],
                     nodeId,

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

@@ -7,9 +7,10 @@ const logic_1 = require("../logic");
 const crypto_1 = require("crypto");
 const prompt_1 = require("../nlu/generativeSlotFiller/prompt");
 const errors_1 = require("../../../errors");
+const transcripts_1 = require("../../../interfaces/transcripts/transcripts");
 exports.GPT_PROMPT = (0, createNodeDescriptor_1.createNodeDescriptor)({
     type: "completeText",
-    defaultLabel: "LLM Prompt",
+    defaultLabel: "LLM Prompt (legacy)",
     summary: "UI__NODE_EDITOR__SERVICE__GPT_PROMPT__DESCRIPTION",
     fields: [
         {
@@ -645,6 +646,7 @@ exports.GPT_PROMPT = (0, createNodeDescriptor_1.createNodeDescriptor)({
                         api.output(text, {
                             _cognigy: {
                                 _messageId,
+                                _preventTranscript: true
                             }
                         });
                     }
@@ -702,6 +704,18 @@ exports.GPT_PROMPT = (0, createNodeDescriptor_1.createNodeDescriptor)({
                     const resultToOutput = typeof ((response === null || response === void 0 ? void 0 : response.result) || response) === "object" ? JSON.stringify((response === null || response === void 0 ? void 0 : response.result) || response, undefined, 2) : (response === null || response === void 0 ? void 0 : response.result) || response;
                     await api.output(resultToOutput, null);
                 }
+                else if (storeLocation === "stream") {
+                    const transcriptContent = {
+                        role: transcripts_1.TranscriptRole.ASSISTANT,
+                        type: transcripts_1.TranscriptEntryType.OUTPUT,
+                        source: "assistant",
+                        payload: {
+                            text: ((response === null || response === void 0 ? void 0 : response.result) || response),
+                            data: {},
+                        }
+                    };
+                    await api.addTranscriptStep(transcriptContent);
+                }
                 if (storeLocation === "stream" && responseToStore.finishReason) {
                     // send the finishReason as last output for a stream
                     (_a = api.output) === null || _a === void 0 ? void 0 : _a.call(api, "", {