@cognigy/rest-api-client 2025.22.0 → 2025.23.0

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

@@ -11,7 +11,7 @@ import { generateSearchPrompt } from "./helpers/generateSearchPrompt";
 import { getUserMemory } from "./helpers/getUserMemory";
 import { createToolDefinitions } from "./helpers/createToolDefinitions";
 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",
@@ -1195,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" &&
@@ -1284,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;
                     }

package/dist/esm/shared/charts/descriptors/service/aiAgent/helpers/createToolDefinitions.js

@@ -33,35 +33,6 @@ export const createToolDefinitions = (childConfigs, api, useStrict) => __awaiter
             continue;
         }
         const toolId = child.config.toolId;
-        if ((child.type === "aiAgentJobTool" || child.type === "llmPromptTool") &&
-            (!child.config.condition || !!(yield api.parseCognigyScriptCondition(child.config.condition)))) {
-            if (!toolId) {
-                throw new Error(`Tool ID is missing in Tool Node configuration.`);
-            }
-            const parsedToolId = yield api.parseCognigyScriptText(toolId);
-            if (!validateToolId(parsedToolId)) {
-                throw new Error(`Tool ID ${parsedToolId} is not valid. Please use only alphanumeric characters, dashes and underscores.`);
-            }
-            if (toolIds.includes(parsedToolId)) {
-                throw new Error(`Tool ID ${parsedToolId} is not unique. Please ensure each tool has a unique id.`);
-            }
-            toolIds.push(parsedToolId);
-            toolNames.push(parsedToolId);
-            const tool = {
-                type: "function",
-                function: {
-                    name: parsedToolId,
-                    description: yield api.parseCognigyScriptText(child.config.description),
-                },
-            };
-            if (useStrict) {
-                tool.function.strict = true;
-            }
-            if (child.config.useParameters) {
-                tool.function.parameters = child.config.parameters;
-            }
-            tools.push(tool);
-        }
         if ((child.type === "aiAgentJobMCPTool" || child.type === "llmPromptMCPTool") &&
             (!child.config.condition || !!(yield api.parseCognigyScriptCondition(child.config.condition)))) {
             if (!child.config.mcpServerUrl) {
@@ -166,6 +137,34 @@ export const createToolDefinitions = (childConfigs, api, useStrict) => __awaiter
                 tools.push(...structuredMcpTools);
             }
         }
+        if (!["llmPromptMCPTool", "aiAgentJobMCPTool"].includes(child.type) && (!child.config.condition || !!(yield api.parseCognigyScriptCondition(child.config.condition)))) {
+            if (!toolId) {
+                throw new Error(`Tool ID is missing in Tool Node configuration.`);
+            }
+            const parsedToolId = yield api.parseCognigyScriptText(toolId);
+            if (!validateToolId(parsedToolId)) {
+                throw new Error(`Tool ID ${parsedToolId} is not valid. Please use only alphanumeric characters, dashes and underscores.`);
+            }
+            if (toolIds.includes(parsedToolId)) {
+                throw new Error(`Tool ID ${parsedToolId} is not unique. Please ensure each tool has a unique id.`);
+            }
+            toolIds.push(parsedToolId);
+            toolNames.push(parsedToolId);
+            const tool = {
+                type: "function",
+                function: {
+                    name: parsedToolId,
+                    description: yield api.parseCognigyScriptText(child.config.description),
+                },
+            };
+            if (useStrict) {
+                tool.function.strict = true;
+            }
+            if (child.config.useParameters) {
+                tool.function.parameters = child.config.parameters;
+            }
+            tools.push(tool);
+        }
     }
     ;
     return {

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

@@ -28,6 +28,7 @@ export { AI_AGENT_JOB_MCP_TOOL } from "./aiAgent/aiAgentJobMCPTool";
 export { AI_AGENT_TOOL_ANSWER } from "./aiAgent/aiAgentToolAnswer";
 export { AI_AGENT_HANDOVER } from "./aiAgent/aiAgentHandover";
 export { AI_AGENT_JOB_CALL_MCP_TOOL } from "./aiAgent/aiAgentJobCallMCPTool";
+export { KNOWLEDGE_TOOL } from "./agentTools/knowledgeTool";
 export { LOAD_AI_AGENT } from "./aiAgent/loadAiAgent";
 export { LIVE_AGENT_CONNECTION, RINGCENTRAL_ENGAGE_CONNECTION, CHATWOOT_CONNECTION, EIGHT_BY_EIGHT_CONNECTION, GENESYS_CLOUD_CONNECTION, GENESYS_CLOUD_CONNECTION_OM } from "./handoverConnections";
 export { NICECXONEAAH_AUTHENTICATION_CONNECTION } from "./niceCXOneAAHAuthenticationConnection";

package/dist/esm/shared/charts/descriptors/service/llmPrompt/LLMPromptV2.js

@@ -16,7 +16,7 @@ export const LLM_PROMPT_V2 = createNodeDescriptor({
         collapsable: true,
         placement: {
             children: {
-                whitelist: ["llmPromptDefault", "llmPromptTool", "llmPromptMCPTool"],
+                whitelist: ["llmPromptDefault", "llmPromptTool", "llmPromptMCPTool", "knowledgeTool"],
             },
         },
     },
@@ -843,6 +843,7 @@ export const LLM_PROMPT_V2 = createNodeDescriptor({
                     rolesWhiteList: [TranscriptRole.USER, TranscriptRole.ASSISTANT, TranscriptRole.TOOL],
                     excludeDataOnlyMessagesFilter: [TranscriptRole.ASSISTANT],
                     useTextAlternativeForLLM,
+                    excludeUserEventMessages: true,
                 });
                 llmPromptOptions["transcript"] = transcript;
                 llmPromptOptions["chat"] = [{
@@ -888,7 +889,7 @@ export const LLM_PROMPT_V2 = createNodeDescriptor({
                 // Find the child node with the toolId of the tool call
                 let toolChild = undefined;
                 for (const child of childConfigs) {
-                    if (child.type === "llmPromptTool" && ((_e = child.config) === null || _e === void 0 ? void 0 : _e.toolId) && (yield api.parseCognigyScriptText((_f = child.config) === null || _f === void 0 ? void 0 : _f.toolId)) === mainToolCall.function.name) {
+                    if (!["llmPromptDefault", "llmPromptMCPTool"].includes(child.type) && ((_e = child.config) === null || _e === void 0 ? void 0 : _e.toolId) && (yield api.parseCognigyScriptText((_f = child.config) === null || _f === void 0 ? void 0 : _f.toolId)) === mainToolCall.function.name) {
                         toolChild = child;
                         break;
                     }

package/dist/esm/shared/interfaces/IProfile.js

@@ -3,12 +3,16 @@ import { createQuerySchema } from "../helper/createQuerySchema";
 import { entityMetaSchema } from "./resources/IEntityMeta";
 ;
 ;
+export const profileTypes = [
+    "simulator",
+];
 export const profileDataSchema = {
     title: "profileDataSchema",
     type: "object",
     additionalProperties: false,
     properties: {
         active: { type: "boolean" },
+        type: { type: "string", enum: [...profileTypes] },
         contactIds: { type: "array", items: { type: "string" }, additionalItems: false, minItems: 1 },
         contactIdsHash: { type: "string" },
         expiresAt: { type: "object" },

package/dist/esm/shared/interfaces/resources/INodeDescriptorSet.js

@@ -369,7 +369,17 @@ export const nodeDescriptorSchema = {
     properties: {
         _id: { type: "string", format: "mongo-id" },
         type: { type: "string", minLength: 1, maxLength: 200 },
-        parentType: { type: ["string", "null"], minLength: 1, maxLength: 200 },
+        parentType: {
+            oneOf: [
+                { type: "null" },
+                { type: "string", minLength: 1, maxLength: 200 },
+                {
+                    type: "array",
+                    items: { type: "string", minLength: 1, maxLength: 200 },
+                    minItems: 1
+                }
+            ]
+        },
         defaultLabel: {
             oneOf: [
                 { type: "string", minLength: 1, maxLength: 200 },

package/dist/esm/shared/interfaces/resources/settings/IAgentSettings.js

@@ -1,9 +1,10 @@
 import { entityMetaSchema } from "../IEntityMeta";
 import { sharedSettingsSchema } from "./ISharedSettings";
-import { generativeAISettingsDataSchema } from "./IGenerativeAISettings";
-import { audioPreviewSettingsDataSchema } from "./IAudioPreviewSettings";
-import { translationSettingsDataSchema } from "./ITranslationSettings";
-import { knowledgeAISettingsDataSchema } from "./IKnowledgeAISettings";
+import { generativeAISettingsDataSchema, } from "./IGenerativeAISettings";
+import { audioPreviewSettingsDataSchema, } from "./IAudioPreviewSettings";
+import { translationSettingsDataSchema, } from "./ITranslationSettings";
+import { knowledgeAISettingsDataSchema, } from "./IKnowledgeAISettings";
+import { piiDataRedactionSettingsSchema, } from "./IPiiDataRedactionSettings";
 export const agentSettingsDataSchema = {
     title: "agentSettingsDataSchema",
     type: "object",
@@ -11,31 +12,35 @@ export const agentSettingsDataSchema = {
     properties: Object.assign(Object.assign({}, sharedSettingsSchema.properties), { trackDataOnlyInputs: { type: "boolean" }, collectAnalytics: { type: "boolean" }, timezone: { type: "string", format: "timezone" }, useCaseSensitiveIntentMapping: { type: "boolean" }, translationSettings: {
             type: ["object", "null"],
             additionalProperties: false,
-            properties: Object.assign({}, translationSettingsDataSchema.properties)
+            properties: Object.assign({}, translationSettingsDataSchema.properties),
         }, audioPreviewSettings: {
             type: ["object", "null"],
             additionalProperties: false,
-            properties: Object.assign({}, audioPreviewSettingsDataSchema.properties)
+            properties: Object.assign({}, audioPreviewSettingsDataSchema.properties),
         }, generativeAISettings: {
             type: ["object", "null"],
             additionalProperties: false,
-            properties: Object.assign({}, generativeAISettingsDataSchema.properties)
+            properties: Object.assign({}, generativeAISettingsDataSchema.properties),
         }, currencySettings: {
             type: ["object", "null"],
             additionalProperties: false,
             properties: {
                 currency: { type: "string", format: "currency-code" },
-            }
+            },
         }, knowledgeAISettings: {
             type: ["object", "null"],
             additionalProperties: false,
-            properties: Object.assign({}, knowledgeAISettingsDataSchema.properties)
-        } })
+            properties: Object.assign({}, knowledgeAISettingsDataSchema.properties),
+        }, piiDataRedactionSettings: {
+            type: ["object", "null"],
+            additionalProperties: false,
+            properties: Object.assign({}, piiDataRedactionSettingsSchema.properties),
+        } }),
 };
 export const agentSettingsSchema = {
     title: "agentSettingsSchema",
     type: "object",
     additionalProperties: false,
-    properties: Object.assign(Object.assign(Object.assign({}, entityMetaSchema.properties), agentSettingsDataSchema.properties), { projectReference: { type: "string", format: "mongo-id" }, organisationReference: { type: "string", format: "mongo-id" } })
+    properties: Object.assign(Object.assign(Object.assign({}, entityMetaSchema.properties), agentSettingsDataSchema.properties), { projectReference: { type: "string", format: "mongo-id" }, organisationReference: { type: "string", format: "mongo-id" } }),
 };
 //# sourceMappingURL=IAgentSettings.js.map

package/dist/esm/shared/interfaces/resources/settings/IPiiDataRedactionSettings.js

@@ -0,0 +1,139 @@
+export var EPiiBehaviorType;
+(function (EPiiBehaviorType) {
+    EPiiBehaviorType["PREDEFINED_ALIAS"] = "predefined-alias";
+    EPiiBehaviorType["CUSTOM_ALIAS"] = "custom-alias";
+})(EPiiBehaviorType || (EPiiBehaviorType = {}));
+export const piiFieldSettingsSchema = {
+    title: "piiFieldSettingsSchema",
+    type: "object",
+    additionalProperties: false,
+    required: ["enabled", "name"],
+    properties: {
+        enabled: { type: "boolean" },
+        behavior: {
+            oneOf: [
+                {
+                    type: "object",
+                    additionalProperties: false,
+                    required: ["type"],
+                    properties: {
+                        type: {
+                            type: "string",
+                            enum: [EPiiBehaviorType.PREDEFINED_ALIAS],
+                        },
+                        customAlias: { type: "null" },
+                    },
+                },
+                {
+                    type: "object",
+                    additionalProperties: false,
+                    // @ts-ignore
+                    required: ["type", "customAlias"],
+                    properties: {
+                        type: {
+                            type: "string",
+                            enum: [EPiiBehaviorType.CUSTOM_ALIAS],
+                        },
+                        customAlias: {
+                            type: "string",
+                            minLength: 3,
+                            maxLength: 100
+                        },
+                    },
+                },
+            ],
+        },
+        scope: {
+            type: ["object", "null"],
+            additionalProperties: false,
+            required: ["logs", "analytics"],
+            properties: {
+                logs: { type: "boolean" },
+                analytics: { type: "boolean" },
+            },
+        },
+        name: { type: "string", minLength: 3, maxLength: 100, pattern: "^[a-zA-Z0-9_\\s]+$" },
+    },
+    if: {
+        properties: {
+            enabled: { const: true }
+        }
+    },
+    then: {
+        required: ["enabled", "name", "behavior", "scope"]
+    },
+    else: {
+        required: ["enabled", "name"]
+    }
+};
+export const customPatternSettingsSchema = {
+    title: "customPatternSettingsSchema",
+    type: "object",
+    additionalProperties: false,
+    required: ["name", "regex", "behavior", "scope"],
+    properties: {
+        regex: {
+            type: "string",
+            minLength: 1,
+            maxLength: 1000
+        },
+        behavior: {
+            type: "object",
+            additionalProperties: false,
+            // @ts-ignore
+            required: ["type", "customAlias"],
+            properties: {
+                type: {
+                    type: "string",
+                    enum: [EPiiBehaviorType.CUSTOM_ALIAS],
+                },
+                customAlias: {
+                    type: "string",
+                    minLength: 3,
+                    maxLength: 100
+                },
+            },
+        },
+        scope: {
+            type: ["object", "null"],
+            additionalProperties: false,
+            required: ["logs", "analytics"],
+            properties: {
+                logs: { type: "boolean" },
+                analytics: { type: "boolean" },
+            },
+        },
+        name: {
+            type: "string",
+            minLength: 3,
+            maxLength: 100,
+            pattern: "^[a-zA-Z0-9_\\s]+$"
+        },
+    },
+};
+export const piiDataRedactionSettingsSchema = {
+    title: "piiDataRedactionSettingsSchema",
+    type: "object",
+    additionalProperties: false,
+    required: [
+        "emailAddress",
+        "phoneNumber",
+        "creditCard",
+        "ssn",
+        "ipAddressV4",
+        "ipAddressV6",
+    ],
+    properties: {
+        emailAddress: piiFieldSettingsSchema,
+        phoneNumber: piiFieldSettingsSchema,
+        creditCard: piiFieldSettingsSchema,
+        ssn: piiFieldSettingsSchema,
+        ipAddressV4: piiFieldSettingsSchema,
+        ipAddressV6: piiFieldSettingsSchema,
+        customTypes: {
+            type: ["object", "null"],
+            additionalProperties: customPatternSettingsSchema
+        },
+    },
+};
+//# sourceMappingURL=IPiiDataRedactionSettings.js.map

package/dist/esm/shared/interfaces/resources/settings/index.js

@@ -1,8 +1,9 @@
 export { agentSettingsDataSchema, agentSettingsSchema, } from "./IAgentSettings";
-export { flowIntentMappingOrderType, flowSettingsDataSchema, flowSettingsSchema } from "./IFlowSettings";
+export { flowIntentMappingOrderType, flowSettingsDataSchema, flowSettingsSchema, } from "./IFlowSettings";
 export { sharedSettingsSchema } from "./ISharedSettings";
-export { generativeAISettingsDataSchema } from "./IGenerativeAISettings";
-export { audioPreviewSettingsDataSchema, audioPreviewProviders } from "./IAudioPreviewSettings";
-export { translationSettingsDataSchema, translationProviders } from "./ITranslationSettings";
+export { generativeAISettingsDataSchema, } from "./IGenerativeAISettings";
+export { audioPreviewSettingsDataSchema, audioPreviewProviders, } from "./IAudioPreviewSettings";
+export { translationSettingsDataSchema, translationProviders, } from "./ITranslationSettings";
 export { knowledgeAISettingsDataSchema, fileExtractorOptions, } from "./IKnowledgeAISettings";
+export { EPiiBehaviorType, piiDataRedactionSettingsSchema, } from "./IPiiDataRedactionSettings";
 //# sourceMappingURL=index.js.map

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

@@ -1,2 +1,104 @@
-export {};
+/**
+ * @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]
+ */
+export var EPiiBehaviorType;
+(function (EPiiBehaviorType) {
+    EPiiBehaviorType["PREDEFINED_ALIAS"] = "predefined-alias";
+    EPiiBehaviorType["CUSTOM_ALIAS"] = "custom-alias";
+})(EPiiBehaviorType || (EPiiBehaviorType = {}));
 //# sourceMappingURL=IAgentSettings_2_0.js.map

package/dist/esm/shared/interfaces/restAPI/simulation/persona/IGeneratePersonaFromTranscriptRest_2_0.js

@@ -0,0 +1,19 @@
+/**
+ * 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
+ */
+export {};
+//# sourceMappingURL=IGeneratePersonaFromTranscriptRest_2_0.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@cognigy/rest-api-client",
-	"version": "2025.22.0",
+	"version": "2025.23.0",
 	"description": "Cognigy REST-Client",
 	"main": "build/index.js",
 	"module": "dist/esm/index.js",