@cognigy/rest-api-client 2025.11.0 → 2025.13.0

package/build/shared/interfaces/restAPI/simulation/simulationRunBatch/IReadSimulationRunBatchRest_2_0.js

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

package/build/shared/interfaces/restAPI/simulation/simulationRunBatch/ISimulationRunBatchRest_2_0.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SimulationRunBatchStatus = void 0;
+exports.SimulationRunBatchStatus = [
+    "IN_PROGRESS",
+    "COMPLETED",
+    "FAILED"
+];
+//# sourceMappingURL=ISimulationRunBatchRest_2_0.js.map

package/build/shared/interfaces/security/IPermission.js

@@ -74,6 +74,7 @@ exports.organisationWidePermissions = [
  *         - functions
  *         - yesNoIntents
  *         - dataPrivacySettings
+ *         - simulator
  */
 exports.projectWidePermissions = [
     "agentAssistConfigs",
@@ -113,6 +114,7 @@ exports.projectWidePermissions = [
     "tokens",
     "yesNoIntents",
     "dataPrivacySettings",
+    "simulator"
 ];
 exports.availablePermissions = [
     ...exports.organisationWidePermissions,

package/build/shared/interfaces/security/IRole.js

@@ -88,6 +88,7 @@ exports.organisationWideRoles = [
  *         - tokenEditor
  *         - function_admin
  *         - function_editor
+ *         - simulator_admin
  */
 exports.projectWideRoles = [
     "agentAssistConfigAdmin",
@@ -129,7 +130,8 @@ exports.projectWideRoles = [
     "tokenEditor",
     "data_privacy_admin",
     "data_privacy_editor",
-    "data_privacy_viewer"
+    "data_privacy_viewer",
+    "simulator_admin"
 ];
 exports.availableRoles = [
     ...exports.organisationWideRoles,

package/build/shared/interfaces/security/index.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.identityProviderSchema = exports.oidcIdentityProviderDataSchema = exports.samlIdentityProviderDataSchema = exports.operations = exports.availableRoles = exports.projectWideRoles = exports.organisationWideRoles = exports.availablePermissions = exports.COMPUTED_ACL_HASH_VERSION = void 0;
-exports.COMPUTED_ACL_HASH_VERSION = "v19";
+exports.COMPUTED_ACL_HASH_VERSION = "v20";
 var IPermission_1 = require("./IPermission");
 Object.defineProperty(exports, "availablePermissions", { enumerable: true, get: function () { return IPermission_1.availablePermissions; } });
 var IRole_1 = require("./IRole");

package/dist/esm/RestAPIClient.js

@@ -15,6 +15,7 @@ import { ResourcesAPIGroup_2_0 } from "./apigroups/ResourcesAPIGroup_2_0";
 import { SessionsAPIGroup_2_0 } from "./apigroups/SessionsAPIGroup_2_0";
 import { setLogger } from "./shared/helper/logger";
 import { AIOpsCenterAPIGroup_2_0 } from "./apigroups/AIOpsCenterAPIGroup_2_0";
+import { SimulationAPIGroup_2_0 } from "./apigroups/SimulationAPIGroup_2_0";
 export const RestAPIClient = function (config) {
     var _a;
     if (!(this instanceof RestAPIClient)) {
@@ -89,6 +90,12 @@ export const RestAPIClient = function (config) {
                 plugins.push(AIOpsCenterAPIGroup_2_0);
                 break;
         }
+        switch (config.versions.simulation) {
+            default:
+            case "2.0":
+                plugins.push(SimulationAPIGroup_2_0);
+                break;
+        }
         const Client = Base.plugin(plugins);
         Client.config = config;
         Client.prototype.getHttpAdapter = () => {

package/dist/esm/apigroups/ResourcesAPIGroup_2_0.js

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

package/dist/esm/apigroups/SimulationAPIGroup_2_0.js

@@ -0,0 +1,44 @@
+import { __rest } from "tslib";
+import { GenericAPIFn } from "../GenericAPIFn";
+import { stringifyQuery } from "../shared/helper/rest/query";
+export function SimulationAPIGroup_2_0(instance) {
+    const self = instance;
+    return {
+        indexSimulations: (args, options) => GenericAPIFn(`/testing/beta/simulations?${stringifyQuery(args)}`, "GET", self)(undefined, options),
+        createSimulation: (args, options) => GenericAPIFn("/testing/beta/simulations", "POST", self)(args, options),
+        updateSimulation: (_a, options) => {
+            var { simulationReference, projectId } = _a, args = __rest(_a, ["simulationReference", "projectId"]);
+            return GenericAPIFn(`/testing/beta/simulations/${simulationReference}?${stringifyQuery({
+                projectId
+            })}`, "PATCH", self)(args, options);
+        },
+        deleteSimulation: ({ simulationReference, projectId }, options) => GenericAPIFn(`/testing/beta/simulations/${simulationReference}?${stringifyQuery({
+            projectId
+        })}`, "DELETE", self)(undefined, options),
+        readSimulation: ({ simulationReference, projectId }, options) => GenericAPIFn(`/testing/beta/simulations/${simulationReference}?${stringifyQuery({
+            projectId
+        })}`, "GET", self)(undefined, options),
+        scheduleSimulation: (_a, options) => {
+            var { simulationReference } = _a, args = __rest(_a, ["simulationReference"]);
+            return GenericAPIFn(`/testing/beta/simulations/${simulationReference}/schedule`, "POST", self)(args, options);
+        },
+        indexSimulationRunBatches: (args, options) => GenericAPIFn(`/testing/beta/simulations/batches?${stringifyQuery(args)}`, "GET", self)(undefined, options),
+        getAllSimulationRunBatches: (_a, options) => {
+            var { simulationReference } = _a, args = __rest(_a, ["simulationReference"]);
+            return GenericAPIFn(`/testing/beta/simulations/${simulationReference}/batches?${stringifyQuery(args)}`, "GET", self)(undefined, options);
+        },
+        readSimulationRunBatch: (_a, options) => {
+            var { simulationReference, simulationRunBatchReference } = _a, args = __rest(_a, ["simulationReference", "simulationRunBatchReference"]);
+            return GenericAPIFn(`/testing/beta/simulations/${simulationReference}/batches/${simulationRunBatchReference}?${stringifyQuery(args)}`, "GET", self)(undefined, options);
+        },
+        indexSimulationRuns: (_a, options) => {
+            var { simulationReference, simulationRunBatchReference } = _a, args = __rest(_a, ["simulationReference", "simulationRunBatchReference"]);
+            return GenericAPIFn(`/testing/beta/simulations/${simulationReference}/batches/${simulationRunBatchReference}/runs?${stringifyQuery(args)}`, "GET", self)(undefined, options);
+        },
+        readSimulationRun: (_a, options) => {
+            var { simulationReference, simulationRunBatchReference, simulationRunReference } = _a, args = __rest(_a, ["simulationReference", "simulationRunBatchReference", "simulationRunReference"]);
+            return GenericAPIFn(`/testing/beta/simulations/${simulationReference}/batches/${simulationRunBatchReference}/runs/${simulationRunReference}?${stringifyQuery(args)}`, "GET", self)(undefined, options);
+        }
+    };
+}
+//# sourceMappingURL=SimulationAPIGroup_2_0.js.map

package/dist/esm/apigroups/index.js

@@ -11,4 +11,5 @@ export { ResourcesAPIGroup_2_0 } from "./ResourcesAPIGroup_2_0";
 export { SessionsAPIGroup_2_0 } from "./SessionsAPIGroup_2_0";
 export { AnalyticsAPIGroup_2_0 } from "./AnalyticsAPIGroup_2_0";
 export { AIOpsCenterAPIGroup_2_0 } from "./AIOpsCenterAPIGroup_2_0";
+export { SimulationAPIGroup_2_0 } from "./SimulationAPIGroup_2_0";
 //# sourceMappingURL=index.js.map

package/dist/esm/shared/charts/descriptors/analytics/trackGoal.js

@@ -45,7 +45,7 @@ export const TRACK_GOAL = 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");
@@ -73,10 +73,12 @@ export const TRACK_GOAL = createNodeDescriptor({
                     organisationId,
                     sessionId,
                     version,
+                    referenceId,
                     timestamp: new Date(),
                     goalCycleId: cycleId,
                     goalId,
                     stepId: step.stepId,
+                    stepType: step.type,
                     endpointUrlToken,
                     endpointName,
                     endpointType,

package/dist/esm/shared/charts/descriptors/index.js

@@ -11,7 +11,7 @@ import { REGEX_SLOT_FILLER, EXECUTE_COGNIGY_NLU, ADD_LEXICON_KEYPHRASE, FUZZY_SE
 import { KNOWLEDGE_SEARCH, KNOWLEDGE_SEARCH_V2, SEARCH_EXTRACT_OUTPUT } from "./knowledgeSearch";
 import { CONTINUOUS_ASR, DTMF, HANG_UP, PLAY, TRANSFER_VOICE, SESSION_SPEECH_PARAMETERS, USER_INPUT_TIMEOUT, SEND_METADATA, BARGE_IN, MUTE_SPEECH_INPUT, } from "./voice";
 import { ACTIVATE_PROFILE, COMPLETE_GOAL, DEACTIVATE_PROFILE, DELETE_PROFILE, MERGE_PROFILE, UPDATE_PROFILE, ADD_MEMORY, BLIND_MODE, OVERWRITE_ANALYTICS, SET_RATING, REQUEST_RATING, TRACK_GOAL, } from "./analytics";
-import { HANDOVER, HANDOVER_V2, CHECK_AGENT_AVAILABILITY, HTTP_REQUEST, HTTP_CONNECTION_BASIC, HTTP_CONNECTION_APIKEYAUTHKEY, HTTP_CONNECTION_APIKEYXKEY, HTTP_CONNECTION_OAUTH2, JWT_SECRET_CONNECTION, TRIGGER_FUNCTION, ON_SCHEDULING_ERROR, ON_SCHEDULED, GPT_PROMPT, CLOSE_HANDOVER, HANDOVER_INACTIVITY_TIMER, GPT_CONVERSATION, GPT_CONVERSATION_SUMMARY, LLM_ENTITY_EXTRACT, AI_AGENT_JOB, AI_AGENT_JOB_DEFAULT, AI_AGENT_JOB_TOOL, AI_AGENT_JOB_MCP_TOOL, AI_AGENT_JOB_CALL_MCP_TOOL, AI_AGENT_TOOL_ANSWER, AI_AGENT_HANDOVER, LIVE_AGENT_CONNECTION, RINGCENTRAL_ENGAGE_CONNECTION, CHATWOOT_CONNECTION, EIGHT_BY_EIGHT_CONNECTION, GENESYS_CLOUD_CONNECTION, GENESYS_CLOUD_CONNECTION_OM, LLM_MODERATE, NICECXONEAAH_AUTHENTICATION_CONNECTION } from "./service";
+import { HANDOVER, HANDOVER_V2, CHECK_AGENT_AVAILABILITY, HTTP_REQUEST, HTTP_CONNECTION_BASIC, HTTP_CONNECTION_APIKEYAUTHKEY, HTTP_CONNECTION_APIKEYXKEY, HTTP_CONNECTION_OAUTH2, JWT_SECRET_CONNECTION, TRIGGER_FUNCTION, ON_SCHEDULING_ERROR, ON_SCHEDULED, GPT_PROMPT, LLM_PROMPT_V2, LLM_PROMPT_DEFAULT, LLM_PROMPT_MCP_TOOL, LLM_PROMPT_TOOL, CLOSE_HANDOVER, HANDOVER_INACTIVITY_TIMER, GPT_CONVERSATION, GPT_CONVERSATION_SUMMARY, LLM_ENTITY_EXTRACT, AI_AGENT_JOB, AI_AGENT_JOB_DEFAULT, AI_AGENT_JOB_TOOL, AI_AGENT_JOB_MCP_TOOL, AI_AGENT_JOB_CALL_MCP_TOOL, AI_AGENT_TOOL_ANSWER, AI_AGENT_HANDOVER, LIVE_AGENT_CONNECTION, RINGCENTRAL_ENGAGE_CONNECTION, CHATWOOT_CONNECTION, EIGHT_BY_EIGHT_CONNECTION, GENESYS_CLOUD_CONNECTION, GENESYS_CLOUD_CONNECTION_OM, LLM_MODERATE, NICECXONEAAH_AUTHENTICATION_CONNECTION, LOAD_AI_AGENT, AIOPS_CENTER_WEBHOOKS_CONNECTION } from "./service";
 import { INIT_APP_SESSION, GET_APP_SESSION_PIN, SET_HTML_APP_STATE, SET_ADAPTIVE_CARD_APP_STATE, } from "./apps";
 import { SET_IFRAME_TILE, SET_HTML_TILE, SEND_TILE_DATA, SET_SECURE_FORMS_TILE, SET_ADAPTIVE_CARD_TILE, SET_AGENT_ASSIST_GRID, NEXT_ACTION_ASSIST, SENTIMENT_ASSIST, TRANSCRIPT_ASSIST, IDENTITY_ASSIST, KNOWLEDGE_ASSIST, } from "./agentAssist";
 import { ASSIST_INFO } from "./liveAgent";
@@ -88,6 +88,10 @@ const nodes = [
     CHECK_AGENT_AVAILABILITY,
     HTTP_REQUEST,
     GPT_PROMPT,
+    LLM_PROMPT_V2,
+    LLM_PROMPT_DEFAULT,
+    LLM_PROMPT_MCP_TOOL,
+    LLM_PROMPT_TOOL,
     GPT_CONVERSATION,
     GPT_CONVERSATION_SUMMARY,
     LLM_ENTITY_EXTRACT,
@@ -143,6 +147,7 @@ if (process.env.DISABLE_FEATURE_TRANSCRIPT_MANAGER !== "true") {
     nodes.push(AI_AGENT_JOB_CALL_MCP_TOOL);
     nodes.push(AI_AGENT_TOOL_ANSWER);
     nodes.push(AI_AGENT_HANDOVER);
+    nodes.push(LOAD_AI_AGENT);
 }
 if (process.env.FEATURE_USE_COGNIGY_LIVE_AGENT === "true") {
     nodes.push(ASSIST_INFO);
@@ -164,7 +169,8 @@ export const cognigyBasicModule = createExtension({
         EIGHT_BY_EIGHT_CONNECTION,
         GENESYS_CLOUD_CONNECTION,
         GENESYS_CLOUD_CONNECTION_OM,
-        NICECXONEAAH_AUTHENTICATION_CONNECTION
+        NICECXONEAAH_AUTHENTICATION_CONNECTION,
+        AIOPS_CENTER_WEBHOOKS_CONNECTION,
     ],
 });
 export { cognigyMongoDBModule } from "./connectionNodes/mongoDB";

package/dist/esm/shared/charts/descriptors/knowledgeSearch/searchExtractOutput.js

@@ -582,10 +582,12 @@ export const SEARCH_EXTRACT_OUTPUT = 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/dist/esm/shared/charts/descriptors/message/question/question.js

@@ -307,7 +307,7 @@ export const QUESTION = 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.
@@ -740,6 +740,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",
@@ -2407,6 +2418,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) {
@@ -2417,9 +2429,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":
-                            yield 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";
+                            }
+                            yield 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
@@ -2468,11 +2484,14 @@ DO NOT talk about other topics. Do not offer general assistance.`,
                             }
                             const repromptMessage = yield api.runGenerativeAIPrompt(data, "gptPromptNode");
                             if (!repromptLLMStream) {
-                                yield SAY.function({ nodeType: "question.reprompt", cognigy, childConfigs: [], nodeId, organisationId, config: Object.assign({ preventTranscript, handoverOutput, say: { type: "text", text: [repromptMessage] } }, rephraseWithAIParams) });
+                                yield SAY.function({ nodeType, cognigy, childConfigs: [], nodeId, organisationId, config: Object.assign({ preventTranscript, handoverOutput, say: { type: "text", text: [repromptMessage] } }, rephraseWithAIParams) });
                             }
                             break;
                         default: // this is also "text"
-                            yield 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";
+                            }
+                            yield 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 */
@@ -2497,7 +2516,7 @@ DO NOT talk about other topics. Do not offer general assistance.`,
                 rephraseWithAIParams.promptType = "question";
                 rephraseWithAIParams.questionType = config.type;
                 yield SAY.function({
-                    nodeType: "question.initial",
+                    nodeType,
                     cognigy,
                     childConfigs: [],
                     nodeId,

package/dist/esm/shared/charts/descriptors/service/GPTPrompt.js

@@ -5,9 +5,10 @@ import { GO_TO } from "../logic";
 import { randomUUID } from 'crypto';
 import { createLastConverationString, createLastConversationChatObject, createLastUserInputString, writeLLMDebugLogs } from "../nlu/generativeSlotFiller/prompt";
 import { InternalServerError } from "../../../errors";
+import { TranscriptEntryType, TranscriptRole } from "../../../interfaces/transcripts/transcripts";
 export const GPT_PROMPT = createNodeDescriptor({
     type: "completeText",
-    defaultLabel: "LLM Prompt",
+    defaultLabel: "LLM Prompt (legacy)",
     summary: "UI__NODE_EDITOR__SERVICE__GPT_PROMPT__DESCRIPTION",
     fields: [
         {
@@ -643,6 +644,7 @@ export const GPT_PROMPT = createNodeDescriptor({
                         api.output(text, {
                             _cognigy: {
                                 _messageId,
+                                _preventTranscript: true
                             }
                         });
                     }
@@ -700,6 +702,18 @@ export const GPT_PROMPT = 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;
                     yield api.output(resultToOutput, null);
                 }
+                else if (storeLocation === "stream") {
+                    const transcriptContent = {
+                        role: TranscriptRole.ASSISTANT,
+                        type: TranscriptEntryType.OUTPUT,
+                        source: "assistant",
+                        payload: {
+                            text: ((response === null || response === void 0 ? void 0 : response.result) || response),
+                            data: {},
+                        }
+                    };
+                    yield 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, "", {