@cognigy/rest-api-client 2025.21.0 → 2025.23.0

package/build/shared/interfaces/restAPI/resources/project/v2.0/settings/IAgentSettings_2_0.js

@@ -1,3 +1,107 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.EPiiBehaviorType = void 0;
+/**
+ * @openapi
+ *
+ * components:
+ *   schemas:
+ *     EPiiBehaviorType:
+ *       type: string
+ *       description: PII redaction behavior types
+ *       enum:
+ *         - predefined-alias
+ *         - custom-alias
+ *
+ *     IRedactionBehavior:
+ *       oneOf:
+ *         - type: object
+ *           properties:
+ *             type:
+ *               type: string
+ *               enum: [predefined-alias]
+ *             customAlias:
+ *               type: string
+ *               nullable: true
+ *           required: [type, customAlias]
+ *         - type: object
+ *           properties:
+ *             type:
+ *               type: string
+ *               enum: [custom-alias]
+ *             customAlias:
+ *               type: string
+ *               description: Custom alias to replace PII data with
+ *           required: [type, customAlias]
+ *
+ *     IRedactionScope:
+ *       type: object
+ *       properties:
+ *         logs:
+ *           type: boolean
+ *           description: Whether to redact PII in logs
+ *         analytics:
+ *           type: boolean
+ *           description: Whether to redact PII in analytics
+ *       required: [logs, analytics]
+ *
+ *     IPiiFieldSettings:
+ *       type: object
+ *       properties:
+ *         enabled:
+ *           type: boolean
+ *           description: Whether PII redaction is enabled for this field type
+ *         behavior:
+ *           $ref: '#/components/schemas/IRedactionBehavior'
+ *         scope:
+ *           $ref: '#/components/schemas/IRedactionScope'
+ *         name:
+ *           type: string
+ *           description: Display name for the PII field type
+ *       required: [enabled, behavior, scope, name]
+ *
+ *     ICustomPatternSettings:
+ *       type: object
+ *       properties:
+ *         behavior:
+ *           $ref: '#/components/schemas/IRedactionBehavior'
+ *         scope:
+ *           $ref: '#/components/schemas/IRedactionScope'
+ *         name:
+ *           type: string
+ *           description: Display name for the custom PII field type
+ *         regex:
+ *           type: string
+ *           description: Regular expression pattern to match custom PII data (RE2 syntax)
+ *           minLength: 1
+ *           maxLength: 2000
+ *       required: [behavior, scope, name, regex]
+ *
+ *     IPiiDataRedactionSettings_2_0:
+ *       type: object
+ *       properties:
+ *         emailAddress:
+ *           $ref: '#/components/schemas/IPiiFieldSettings'
+ *         phoneNumber:
+ *           $ref: '#/components/schemas/IPiiFieldSettings'
+ *         creditCard:
+ *           $ref: '#/components/schemas/IPiiFieldSettings'
+ *         ssn:
+ *           $ref: '#/components/schemas/IPiiFieldSettings'
+ *         ipAddressV4:
+ *           $ref: '#/components/schemas/IPiiFieldSettings'
+ *         ipAddressV6:
+ *           $ref: '#/components/schemas/IPiiFieldSettings'
+ *         customTypes:
+ *           type: object
+ *           additionalProperties:
+ *             $ref: '#/components/schemas/ICustomPatternSettings'
+ *           description: User-defined custom PII patterns with regex matching
+ *       required: [emailAddress, phoneNumber, creditCard, ssn, ipAddressV4, ipAddressV6]
+ */
+var EPiiBehaviorType;
+(function (EPiiBehaviorType) {
+    EPiiBehaviorType["PREDEFINED_ALIAS"] = "predefined-alias";
+    EPiiBehaviorType["CUSTOM_ALIAS"] = "custom-alias";
+})(EPiiBehaviorType = exports.EPiiBehaviorType || (exports.EPiiBehaviorType = {}));
 //# sourceMappingURL=IAgentSettings_2_0.js.map

package/build/shared/interfaces/restAPI/simulation/persona/IGeneratePersonaFromTranscriptRest_2_0.js

@@ -0,0 +1,20 @@
+"use strict";
+/**
+ * POST /testing/beta/personas/from-transcript
+ *
+ * Create a scenario draft by analyzing a conversation transcript. The system uses LLM to extract user intent,
+ * conversation goals, and user characteristics from the transcript, then generates an appropriate persona package.
+ *
+ * The endpoint supports:
+ * - Fetching transcript via sessionId from analytics service (RPC call)
+ * - Direct transcript content via transcriptContent
+ * - Optional flow context for enhanced persona generation
+ * - Content safety validation (warnings only, non-blocking)
+ *
+ * Priority: If both sessionId and transcriptContent are provided, sessionId takes precedence.
+ *
+ * operationId: createScenarioFromTranscript
+ * tags: Personas
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IGeneratePersonaFromTranscriptRest_2_0.js.map

package/build/shared/interfaces/restAPI/simulation/simulation/ICloneSimulationRest_2_0.js

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

package/dist/esm/apigroups/SimulationAPIGroup_2_0.js

@@ -22,6 +22,10 @@ export function SimulationAPIGroup_2_0(instance) {
             var { simulationReference } = _a, args = __rest(_a, ["simulationReference"]);
             return GenericAPIFn(`/testing/beta/simulations/${simulationReference}/schedule`, "POST", self)(args, options);
         },
+        cloneSimulation: (_a, options) => {
+            var { simulationReference } = _a, args = __rest(_a, ["simulationReference"]);
+            return GenericAPIFn(`/testing/beta/simulations/${simulationReference}/clone`, "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"]);
@@ -46,7 +50,8 @@ export function SimulationAPIGroup_2_0(instance) {
         getPersonaOptions: (args, options) => GenericAPIFn("/testing/beta/personas/options", "POST", self)(args, options),
         generatePersona: (args, options) => GenericAPIFn("/testing/beta/personas/generate", "POST", self)(args, options),
         regeneratePersonaField: (args, options) => GenericAPIFn("/testing/beta/personas/regenerate-field", "POST", self)(args, options),
-        generateBulkPersona: (args, options) => GenericAPIFn("/testing/beta/personas/generate-bulk", "POST", self)(args, options)
+        generateBulkPersona: (args, options) => GenericAPIFn("/testing/beta/personas/generate-bulk", "POST", self)(args, options),
+        generatePersonaFromTranscript: (args, options) => GenericAPIFn("/testing/beta/personas/from-transcript", "POST", self)(args, options)
     };
 }
 //# sourceMappingURL=SimulationAPIGroup_2_0.js.map

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

@@ -2,7 +2,7 @@ import { __awaiter } from "tslib";
 /* Custom modules */
 import { createNodeDescriptor } from "../../createNodeDescriptor";
 /* Npm modules */
-import { v4 as uuidv4 } from "uuid";
+import * as crypto from "crypto";
 /**
  * Node name: 'trackGoal'
  *
@@ -56,7 +56,7 @@ export const TRACK_GOAL = createNodeDescriptor({
         }
         // Create a new cycle id if there is a start step
         if (hasStartStep) {
-            cycleId = uuidv4();
+            cycleId = crypto.randomUUID();
             activeCycleIds[goalId] = cycleId;
             const sessionStateAnalyticsUpdate = Object.assign(Object.assign({}, sessionState.analytics), { goalCycleIds: activeCycleIds });
             api.setSessionState("analytics", sessionStateAnalyticsUpdate);

package/dist/esm/shared/charts/descriptors/connectionNodes/generativeAIProviders/azureOpenAIProviderOauth2Connection.js

@@ -5,7 +5,9 @@ export const AZURE_OPEN_AI_OAUTH2_PROVIDER_CONNECTION = {
         { fieldName: "clientId", label: "UI__CONNECTION_EDITOR__FIELD_CLIENT_ID" },
         { fieldName: "clientSecret", label: "UI__CONNECTION_EDITOR__FIELD_CLIENT_SECRET" },
         { fieldName: "oauthUrl", label: "UI__CONNECTION_EDITOR__FIELD_OAUTH2_URL" },
-        { fieldName: "scope", label: "UI__CONNECTION_EDITOR__FIELD_SCOPE" }
+        { fieldName: "scope", label: "UI__CONNECTION_EDITOR__FIELD_SCOPE" },
+        { fieldName: "additionalHeaderName", label: "UI__CONNECTION_EDITOR__FIELD_OAUTH2_ADDITIONAL_HEADER_NAME", required: false },
+        { fieldName: "additionalHeaderValue", label: "UI__CONNECTION_EDITOR__FIELD_OAUTH2_ADDITIONAL_HEADER_VALUE", required: false }
     ]
 };
 //# sourceMappingURL=azureOpenAIProviderOauth2Connection.js.map

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, 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 { 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, KNOWLEDGE_TOOL, 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";
@@ -146,6 +146,7 @@ if (process.env.DISABLE_FEATURE_TRANSCRIPT_MANAGER !== "true") {
     nodes.push(AI_AGENT_JOB_MCP_TOOL);
     nodes.push(AI_AGENT_JOB_CALL_MCP_TOOL);
     nodes.push(AI_AGENT_TOOL_ANSWER);
+    nodes.push(KNOWLEDGE_TOOL);
     nodes.push(AI_AGENT_HANDOVER);
     nodes.push(LOAD_AI_AGENT);
 }

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

@@ -21,8 +21,8 @@ const getLanguageName = (languageCode) => {
     // remove the "region" part from language codes (e.g. en-US becomes en, the -US gets stripped)
     const languageOnly = languageCode.split('-')[0];
     // our runtimes support this, but it's not reflected in every project's typings!
-    // this flag is used to reset a breaking-change behavior (returning "flamish" instead of "dutch (belgium)") to its former behavior 
-    // @ts-ignore 
+    // this flag is used to reset a breaking-change behavior (returning "flamish" instead of "dutch (belgium)") to its former behavior
+    // @ts-ignore
     const languageName = (new Intl.DisplayNames(["en-US"], { type: "language", languageDisplay: "standard", fallback: 'none' }).of(languageOnly));
     return languageName;
 };
@@ -654,7 +654,7 @@ export const SEARCH_EXTRACT_OUTPUT = createNodeDescriptor({
             // add error to context or input
             switch (searchStoreLocation) {
                 case "context":
-                    // @ts-ignore	
+                    // @ts-ignore
                     api.addToContext(searchStoreLocationContextKey, searchStoreDataWithError, "simple");
                     break;
                 default:
@@ -736,7 +736,7 @@ export const SEARCH_EXTRACT_OUTPUT = createNodeDescriptor({
         // Save result
         switch (searchStoreLocation) {
             case "context":
-                // @ts-ignore	
+                // @ts-ignore
                 api.addToContext(searchStoreLocationContextKey, knowledgeSearchResponseData, "simple");
                 break;
             case "default":
@@ -765,7 +765,7 @@ export const SEARCH_EXTRACT_OUTPUT = createNodeDescriptor({
         if (documents && (mode !== "s")) {
             // check if we received streamed output at all
             let streamedOutput = false;
-            const isStreamingChannel = input.channel === "webchat3" || input.channel === "adminconsole";
+            const isStreamingChannel = input.endpointType === "webchat3" || input.channel === "adminconsole";
             const _messageId = randomUUID();
             const promptData = {
                 prompt,

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

@@ -2,7 +2,7 @@ import { __awaiter } from "tslib";
 /* Custom modules */
 import { createNodeDescriptor } from "../../createNodeDescriptor";
 import { GO_TO } from "../logic";
-import { v4 as randomUUID } from "uuid";
+import * as crypto from "crypto";
 import { createLastConverationString, createLastConversationChatObject, createLastUserInputString, writeLLMDebugLogs } from "../nlu/generativeSlotFiller/prompt";
 import { InternalServerError } from "../../../errors";
 import { TranscriptEntryType, TranscriptRole } from "../../../interfaces/transcripts/transcripts";
@@ -619,7 +619,7 @@ export const GPT_PROMPT = createNodeDescriptor({
             // add error to context or input
             switch (storeLocation) {
                 case "context":
-                    // @ts-ignore	
+                    // @ts-ignore
                     api.addToContext(contextKey, errorResponse, "simple");
                     break;
                 default:
@@ -657,8 +657,8 @@ export const GPT_PROMPT = createNodeDescriptor({
             }
         });
         try {
-            const isStreamingChannel = input.channel === "webchat3" || input.channel === "adminconsole";
-            const _messageId = randomUUID();
+            const isStreamingChannel = input.endpointType === "webchat3" || input.channel === "adminconsole";
+            const _messageId = crypto.randomUUID();
             const data = {
                 prompt,
                 temperature,

package/dist/esm/shared/charts/descriptors/service/agentTools/knowledgeTool.js

@@ -0,0 +1,338 @@
+import { __awaiter } from "tslib";
+/* Custom modules */
+import { createNodeDescriptor } from "../../../createNodeDescriptor";
+import { TranscriptEntryType, TranscriptRole } from "../../../../interfaces/transcripts/transcripts";
+export const KNOWLEDGE_TOOL = createNodeDescriptor({
+    type: "knowledgeTool",
+    defaultLabel: "Knowledge Tool",
+    parentType: ["aiAgentJob", "llmPromptV2"],
+    constraints: {
+        editable: true,
+        deletable: true,
+        collapsable: true,
+        creatable: true,
+        movable: true,
+        placement: {
+            predecessor: {
+                whitelist: []
+            }
+        },
+        childFlowCreatable: false
+    },
+    behavior: {
+        stopping: true
+    },
+    preview: {
+        type: "text",
+        key: "toolId"
+    },
+    fields: [
+        {
+            key: "knowledgeStoreId",
+            label: "UI__NODE_EDITOR__SERVICE__AI_AGENT_KNOWLEDGE_TOOL__FIELDS__KNOWLEDGE_STORE__LABEL",
+            type: "knowledgeStoreSelect",
+        },
+        {
+            key: "toolId",
+            label: "UI__NODE_EDITOR__SERVICE__AI_AGENT_TOOL__FIELDS__TOOL_ID__LABEL",
+            description: "UI__NODE_EDITOR__SERVICE__AI_AGENT_TOOL__FIELDS__TOOL_ID__DESCRIPTION",
+            type: "cognigyLLMText",
+            defaultValue: "retrieve_knowledge_and_data",
+            params: {
+                required: true,
+                rows: 1,
+                multiline: false,
+                maxLength: 64,
+            }
+        },
+        {
+            key: "description",
+            label: "UI__NODE_EDITOR__SERVICE__AI_AGENT_TOOL__FIELDS__DESCRIPTION__LABEL",
+            description: "UI__NODE_EDITOR__SERVICE__AI_AGENT_TOOL__FIELDS__DESCRIPTION__DESCRIPTION",
+            type: "cognigyLLMText",
+            defaultValue: "Find the answer to general prompts or questions searching the attached data sources. It focuses exclusively on a knowledge search and does not execute tasks like small talk, calculations, or script running.",
+            params: {
+                required: true,
+                rows: 5,
+                multiline: true
+            }
+        },
+        {
+            key: "parameters",
+            label: "UI__NODE_EDITOR__SERVICE__AI_AGENT_TOOL__FIELDS__PARAMETERS__LABEL",
+            description: "UI__NODE_EDITOR__SERVICE__AI_AGENT_TOOL__FIELDS__PARAMETERS__DESCRIPTION",
+            type: "toolParameters",
+            defaultValue: `{
+	"type": "object",
+	"properties": {
+		"generated_prompt": {
+			"type": "string",
+			"description": "Generated question including the context of the conversation (I want to know...)."
+		},
+		"generated_buffer_phrase": {
+			"type": "string",
+			"description": "A generated delay or stalling phrase. Consider the context. Adapt to your speech style and language."
+		},
+	},
+	"required": ["generated_prompt", "generated_buffer_phrase"],
+	"additionalProperties": false
+}`,
+            params: {
+                required: false,
+            },
+        },
+        {
+            key: "debugMessage",
+            type: "toggle",
+            label: "UI__NODE_EDITOR__SERVICE__AI_AGENT_TOOL__FIELDS__DEBUG_MESSAGE__LABEL",
+            description: "UI__NODE_EDITOR__SERVICE__AI_AGENT_TOOL__FIELDS__DEBUG_MESSAGE__DESCRIPTION",
+            defaultValue: true,
+        },
+        {
+            key: "condition",
+            label: "UI__NODE_EDITOR__SERVICE__AI_AGENT_TOOL__FIELDS__CONDITION__LABEL",
+            description: "UI__NODE_EDITOR__SERVICE__AI_AGENT_TOOL__FIELDS__CONDITION__DESCRIPTION",
+            type: "cognigyText",
+            defaultValue: "",
+        },
+        {
+            key: "topK",
+            type: "slider",
+            label: "UI__NODE_EDITOR__KNOWLEDGE_SEARCH__TOP_K__LABEL",
+            description: "UI__NODE_EDITOR__KNOWLEDGE_SEARCH__TOP_K__DESCRIPTION",
+            defaultValue: 5,
+            params: {
+                min: 1,
+                max: 10
+            }
+        },
+        {
+            key: "storeLocation",
+            type: "select",
+            label: "UI__NODE_EDITOR__SERVICE__AI_AGENT_KNOWLEDGE_TOOL__FIELDS__STORE_LOCATION__LABEL",
+            params: {
+                options: [
+                    {
+                        label: "UI__NODE_EDITOR__SERVICE__AI_AGENT_KNOWLEDGE_TOOL__FIELDS__STORE_LOCATION__OPTIONS__NONE__LABEL",
+                        value: "none"
+                    },
+                    {
+                        label: "UI__NODE_EDITOR__SERVICE__AI_AGENT_KNOWLEDGE_TOOL__FIELDS__STORE_LOCATION__OPTIONS__INPUT__LABEL",
+                        value: "input"
+                    },
+                    {
+                        label: "UI__NODE_EDITOR__SERVICE__AI_AGENT_KNOWLEDGE_TOOL__FIELDS__STORE_LOCATION__OPTIONS__CONTEXT__LABEL",
+                        value: "context"
+                    }
+                ],
+            },
+            defaultValue: "none"
+        },
+        {
+            key: "storeLocationInputKey",
+            type: "cognigyText",
+            label: "UI__NODE_EDITOR__KNOWLEDGE_SEARCH__INPUT_KEY__LABEL",
+            description: "UI__NODE_EDITOR__KNOWLEDGE_SEARCH__INPUT_KEY__DESCRIPTION",
+            defaultValue: "knowledgeSearch",
+            condition: {
+                key: "storeLocation",
+                value: "input"
+            }
+        },
+        {
+            key: "storeLocationContextKey",
+            type: "cognigyText",
+            label: "UI__NODE_EDITOR__KNOWLEDGE_SEARCH__CONTEXT_KEY__LABEL",
+            description: "UI__NODE_EDITOR__KNOWLEDGE_SEARCH__CONTEXT_KEY__DESCRIPTION",
+            defaultValue: "knowledgeSearch",
+            condition: {
+                key: "storeLocation",
+                value: "context"
+            }
+        },
+        {
+            key: "sourceTags",
+            type: "knowledgeSourceTags",
+            label: "UI__NODE_EDITOR__KNOWLEDGE_SEARCH__SOURCE_TAGS__LABEL",
+            description: "UI__NODE_EDITOR__KNOWLEDGE_SEARCH__SOURCE_TAGS__DESCRIPTION",
+            params: {
+                tagLimit: 5
+            }
+        },
+        {
+            key: "sourceTagsFilterOp",
+            type: "select",
+            label: "UI__NODE_EDITOR__KNOWLEDGE_SEARCH__SOURCE_TAGS_FILTER_OP__LABEL",
+            description: "UI__NODE_EDITOR__SEARCH_EXTRACT_OUTPUT__FIELDS__SOURCE_TAGS_FILTER_OP__DESCRIPTION",
+            defaultValue: "and",
+            params: {
+                options: [
+                    {
+                        label: "UI__NODE_EDITOR__SEARCH_EXTRACT_OUTPUT__FIELDS__SOURCE_TAGS_FILTER_OP__OPTIONS__AND__LABEL",
+                        value: "and"
+                    },
+                    {
+                        label: "UI__NODE_EDITOR__SEARCH_EXTRACT_OUTPUT__FIELDS__SOURCE_TAGS_FILTER_OP__OPTIONS__OR__LABEL",
+                        value: "or"
+                    },
+                ]
+            }
+        },
+    ],
+    sections: [
+        {
+            key: "debugging",
+            label: "UI__NODE_EDITOR__SERVICE__AI_AGENT_JOB__SECTIONS__DEBUG_SETTINGS__LABEL",
+            defaultCollapsed: true,
+            fields: [
+                "debugMessage",
+            ],
+        },
+        {
+            key: "advanced",
+            label: "UI__NODE_EDITOR__SERVICE__AI_AGENT_JOB__SECTIONS__ADVANCED__LABEL",
+            defaultCollapsed: true,
+            fields: [
+                "topK",
+                "storeLocation",
+                "storeLocationInputKey",
+                "storeLocationContextKey",
+                "sourceTags",
+                "sourceTagsFilterOp",
+                "condition",
+            ],
+        },
+    ],
+    form: [
+        { type: "field", key: "knowledgeStoreId" },
+        { type: "field", key: "toolId" },
+        { type: "field", key: "description" },
+        { type: "section", key: "debugging" },
+        { type: "section", key: "advanced" },
+    ],
+    appearance: {
+        color: "white",
+        textColor: "#252525",
+        variant: "mini",
+    },
+    function: ({ cognigy, config, nodeId: thisNodeId }) => __awaiter(void 0, void 0, void 0, function* () {
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o;
+        const { api, context, input } = cognigy;
+        const { knowledgeStoreId, debugMessage, topK, storeLocation, storeLocationInputKey, storeLocationContextKey, sourceTags, sourceTagsFilterOp, } = config;
+        const sessionState = yield api.loadSessionState();
+        const toolCall = (_a = sessionState.lastToolCall) === null || _a === void 0 ? void 0 : _a.toolCall;
+        const aiAgentJobNode = (_b = sessionState.lastToolCall) === null || _b === void 0 ? void 0 : _b.aiAgentJobNode;
+        if (!(toolCall === null || toolCall === void 0 ? void 0 : toolCall.id)) {
+            (_c = api.logDebugError) === null || _c === void 0 ? void 0 : _c.call(api, "UI__DEBUG_MODE__AI_AGENT_ANSWER__ERROR__MESSAGE");
+        }
+        if (toolCall && aiAgentJobNode && knowledgeStoreId && (input.text || ((_e = (_d = toolCall === null || toolCall === void 0 ? void 0 : toolCall.function) === null || _d === void 0 ? void 0 : _d.arguments) === null || _e === void 0 ? void 0 : _e.generated_prompt))) {
+            if (!((_f = api.checkThink) === null || _f === void 0 ? void 0 : _f.call(api, thisNodeId))) {
+                let query = ((_h = (_g = toolCall === null || toolCall === void 0 ? void 0 : toolCall.function) === null || _g === void 0 ? void 0 : _g.arguments) === null || _h === void 0 ? void 0 : _h.generated_prompt) || input.text;
+                const data = {
+                    language: input.language,
+                    query,
+                    topK,
+                    traceId: input.traceId,
+                    disableSensitiveLogging: false,
+                    knowledgeStoreIds: [knowledgeStoreId],
+                };
+                const generated_buffer_phrase = (_k = (_j = toolCall === null || toolCall === void 0 ? void 0 : toolCall.function) === null || _j === void 0 ? void 0 : _j.arguments) === null || _k === void 0 ? void 0 : _k.generated_buffer_phrase;
+                if (generated_buffer_phrase) {
+                    // output the generated buffer phrase. Don't add it to the transcript, else the LLM will repeat it next time.
+                    yield ((_l = api.output) === null || _l === void 0 ? void 0 : _l.call(api, generated_buffer_phrase, {
+                        _cognigy: {
+                            _preventTranscript: true
+                        }
+                    }));
+                }
+                if (sourceTags && sourceTags.length > 0) {
+                    // convert each knowledgeSourceTag to a string
+                    sourceTags.forEach((tag, index) => {
+                        sourceTags[index] = tag.toString();
+                    });
+                    data.tagsData = {
+                        tags: sourceTags,
+                        op: sourceTagsFilterOp
+                    };
+                }
+                const knowledgeSearchResponse = yield api.knowledgeSearch(data);
+                // Handle possible response errors
+                if ((knowledgeSearchResponse === null || knowledgeSearchResponse === void 0 ? void 0 : knowledgeSearchResponse.status) !== "success") {
+                    const errorMessage = (knowledgeSearchResponse === null || knowledgeSearchResponse === void 0 ? void 0 : knowledgeSearchResponse.error) || "empty";
+                    throw new Error(`Error while performing knowledge search. Remote returned error: ${errorMessage}`);
+                }
+                // Store full response data in input or context
+                if (storeLocation === "input" && storeLocationInputKey) {
+                    input[storeLocationInputKey] = knowledgeSearchResponse;
+                }
+                else if (storeLocation === "context" && storeLocationContextKey) {
+                    context[storeLocationContextKey] = knowledgeSearchResponse;
+                }
+                const knowledgeSearchResponseData = knowledgeSearchResponse.data;
+                // Optional Debug Message of Knowledge Search Results
+                if (debugMessage) {
+                    const messageLines = [];
+                    if (query) {
+                        messageLines.push(`\n<b>UI__DEBUG_MODE__AI_AGENT_JOB__KNOWLEDGE_SEARCH__SEARCH_PROMPT</b> ${query}`);
+                    }
+                    if ((_m = knowledgeSearchResponseData === null || knowledgeSearchResponseData === void 0 ? void 0 : knowledgeSearchResponseData.topK) === null || _m === void 0 ? void 0 : _m.length) {
+                        knowledgeSearchResponseData === null || knowledgeSearchResponseData === void 0 ? void 0 : knowledgeSearchResponseData.topK.forEach((result, index) => {
+                            var _a;
+                            messageLines.push(`\nTop ${index + 1}:`);
+                            messageLines.push(`Distance: ${result.distance}`);
+                            messageLines.push(`Source Name: ${(_a = result.sourceMetaData) === null || _a === void 0 ? void 0 : _a.sourceName}`);
+                            messageLines.push(`Text: ${result.text}`);
+                        });
+                    }
+                    else {
+                        messageLines.push("UI__DEBUG_MODE__AI_AGENT_JOB__KNOWLEDGE_SEARCH__NO_RESULTS");
+                    }
+                    (_o = api.logDebugMessage) === null || _o === void 0 ? void 0 : _o.call(api, messageLines.join("\n"), "UI__DEBUG_MODE__AI_AGENT_JOB__KNOWLEDGE_SEARCH__HEADER");
+                }
+                const { flow, node } = aiAgentJobNode;
+                if (flow && node) {
+                    // Add Tool Call Message to Transcript
+                    const toolCallTranscriptStep = {
+                        role: TranscriptRole.ASSISTANT,
+                        type: TranscriptEntryType.TOOL_CALL,
+                        source: "system",
+                        payload: {
+                            name: toolCall.function.name,
+                            id: toolCall.id,
+                            input: toolCall.function.arguments,
+                        }
+                    };
+                    yield api.addTranscriptStep(toolCallTranscriptStep);
+                    // Add Tool Answer Message to Transcript
+                    const toolAnswer = {
+                        role: TranscriptRole.TOOL,
+                        type: TranscriptEntryType.TOOL_ANSWER,
+                        source: "system",
+                        payload: {
+                            toolCallId: toolCall.id,
+                            name: toolCall.function.name,
+                            content: `We have this context as answer from the knowledge source:\n${JSON.stringify(knowledgeSearchResponseData)}`,
+                        }
+                    };
+                    yield api.addTranscriptStep(toolAnswer);
+                    api.resetNextNodes();
+                    // remove the call from the session state, because the call has been answered
+                    api.updateSessionStateValues({
+                        lastToolCall: undefined
+                    });
+                    yield api.executeFlow({
+                        flowNode: {
+                            flow,
+                            node,
+                        },
+                        absorbContext: true,
+                    });
+                }
+            }
+            else {
+                throw new Error("Infinite Loop Detected");
+            }
+        }
+    })
+});
+//# sourceMappingURL=knowledgeTool.js.map

package/dist/esm/shared/charts/descriptors/service/aiAgent/aiAgentJob.js

@@ -1,4 +1,6 @@
 import { __awaiter, __rest } from "tslib";
+/* Npm modules */
+import * as crypto from "crypto";
 /* Custom modules */
 import { createNodeDescriptor } from "../../../createNodeDescriptor";
 import { setSessionConfig } from "../../voice/mappers/setSessionConfig.mapper";
@@ -8,9 +10,8 @@ import { createSystemMessage, getCognigyBrandMessage } from "./helpers/createSys
 import { generateSearchPrompt } from "./helpers/generateSearchPrompt";
 import { getUserMemory } from "./helpers/getUserMemory";
 import { createToolDefinitions } from "./helpers/createToolDefinitions";
-import { v4 as randomUUID } from "uuid";
 import { TranscriptEntryType, TranscriptRole } from "../../../../interfaces/transcripts/transcripts";
-export const AI_AGENT_TOOLS_WHITELIST = ["aiAgentJobDefault", "aiAgentJobTool", "aiAgentJobMCPTool"];
+export const AI_AGENT_TOOLS_WHITELIST = ["aiAgentJobDefault", "aiAgentJobTool", "aiAgentJobMCPTool", "knowledgeTool"];
 export const AI_AGENT_JOB = createNodeDescriptor({
     type: "aiAgentJob",
     defaultLabel: "AI Agent",
@@ -1194,6 +1195,7 @@ export const AI_AGENT_JOB = createNodeDescriptor({
                 rolesWhiteList: [TranscriptRole.USER, TranscriptRole.ASSISTANT, TranscriptRole.TOOL],
                 excludeDataOnlyMessagesFilter: [TranscriptRole.ASSISTANT],
                 useTextAlternativeForLLM,
+                excludeUserEventMessages: true,
             });
             // For knowledgeSearch "always", we enhance the user input with the knowledge search response data
             if (knowledgeSearchBehavior === "always" &&
@@ -1205,8 +1207,8 @@ export const AI_AGENT_JOB = createNodeDescriptor({
                 const enhancedInput = `## Knowledge Source Context\nAdditional Context from the knowledge source: \n${JSON.stringify(knowledgeSearchResponseData)}\n\n\n${((_z = userInput === null || userInput === void 0 ? void 0 : userInput.payload) === null || _z === void 0 ? void 0 : _z.text) || input.text}`;
                 transcript[transcript.length - 1].payload.text = enhancedInput;
             }
-            const isStreamingChannel = input.channel === "webchat3" || input.channel === "adminconsole";
-            const _messageId = randomUUID();
+            const isStreamingChannel = input.endpointType === "webchat3" || input.channel === "adminconsole";
+            const _messageId = crypto.randomUUID();
             const enableAdvancedLogging = advancedLogging && loggingWebhookUrl && (conditionForLogging === "" || !!conditionForLogging);
             const llmPromptOptions = Object.assign(Object.assign(Object.assign({ prompt: "", chat: systemMessage, 
                 // Temp fix to override the transcript if needed
@@ -1283,7 +1285,7 @@ export const AI_AGENT_JOB = createNodeDescriptor({
                 // Find the child node with the toolId of the tool call
                 let toolChild = undefined;
                 for (const child of childConfigs) {
-                    if (child.type === "aiAgentJobTool" && ((_5 = child.config) === null || _5 === void 0 ? void 0 : _5.toolId) && (yield api.parseCognigyScriptText((_6 = child.config) === null || _6 === void 0 ? void 0 : _6.toolId)) === mainToolCall.function.name) {
+                    if (!["aiAgentJobDefault", "aiAgentJobMCPTool"].includes(child.type) && ((_5 = child.config) === null || _5 === void 0 ? void 0 : _5.toolId) && (yield api.parseCognigyScriptText((_6 = child.config) === null || _6 === void 0 ? void 0 : _6.toolId)) === mainToolCall.function.name) {
                         toolChild = child;
                         break;
                     }