@cognigy/rest-api-client 2025.24.0 → 2025.25.0

package/build/shared/charts/descriptors/service/cxone/knowledgehub/CXoneKnowledgehub.js

@@ -0,0 +1,198 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NICE_CXONE_KNOWLEDGEHUB = void 0;
+/* Node modules */
+const crypto = require("crypto");
+/* Custom modules */
+const createNodeDescriptor_1 = require("../../../../createNodeDescriptor");
+const logic_1 = require("../../../logic");
+const CXoneKnowledgehubForm_1 = require("./CXoneKnowledgehubForm");
+const errors_1 = require("../../../../../errors");
+const DEFAULT_NICE_CXONE_ENDPOINT_URL = "https://cxone.niceincontact.com/";
+exports.NICE_CXONE_KNOWLEDGEHUB = (0, createNodeDescriptor_1.createNodeDescriptor)({
+    type: "niceCXoneKnowledgehub",
+    defaultLabel: "UI__NODE_EDITOR__NICE_CXONE_KNOWLEDGEHUB__LABEL",
+    summary: "UI__NODE_EDITOR__NICE_CXONE_KNOWLEDGEHUB__DESCRIPTION",
+    behavior: {
+        entrypoint: true
+    },
+    fields: CXoneKnowledgehubForm_1.fields,
+    sections: CXoneKnowledgehubForm_1.sections,
+    form: CXoneKnowledgehubForm_1.form,
+    appearance: {
+        color: "#252525",
+    },
+    preview: {
+        key: "query",
+        type: "text"
+    },
+    tags: ["ai"],
+    function: async ({ cognigy, config, nodeId }) => {
+        var _a, _b, _c, _d, _e, _f, _g, _h;
+        const { api, input } = cognigy;
+        const { query, queryPersona, queryLanguage, knowledgehubConnection, filters, promptEditorProfileId, answersMaxWords, linksMax, knowledgeHubId, awsBedrockKbId, maxKernels, prompt, modelArn, storeLocation, inputKey, contextKey, logErrorToSystem, errorHandling = "continue", errorHandlingGotoTarget, errorMessage, debugLogRequestBody, debugLogRequestLatency } = config;
+        const { traceId, sessionId } = input;
+        try {
+            // Set default value of knowledgehubConnection.endpointUrl if not provided.
+            if (!knowledgehubConnection.endpointUrl || knowledgehubConnection.endpointUrl.trim().length === 0) {
+                knowledgehubConnection.endpointUrl = DEFAULT_NICE_CXONE_ENDPOINT_URL;
+            }
+            // Validate that both prompt and model ARN are provided if either is used.
+            const isPromptTemplateUsed = ((prompt && prompt.trim().length > 0) ||
+                (modelArn && modelArn.trim().length > 0));
+            if (isPromptTemplateUsed && (!prompt || !modelArn)) {
+                throw new errors_1.InvalidArgumentError("Both Prompt and Model ARN are required when using a custom prompt template.");
+            }
+            // Construct request body.
+            const requestBody = {
+                timestamp: new Date().toISOString(),
+                meta: {
+                    tenantId: undefined,
+                    contactNumber: uuidToSafeInt64String(sessionId),
+                    agentUid: undefined,
+                    provider: "Cognigy",
+                },
+                query: {
+                    uid: crypto.randomUUID(),
+                    text: query,
+                    persona: queryPersona || undefined,
+                    language: queryLanguage || undefined,
+                },
+                kbFiltering: {
+                    filters
+                },
+                config: {
+                    kbAnswers: {
+                        promptEditorProfileId: promptEditorProfileId || undefined,
+                        answers: {
+                            enabled: true,
+                            maxWords: answersMaxWords !== null && answersMaxWords !== void 0 ? answersMaxWords : 100
+                        },
+                        // It was agreed to keep images disabled for now.
+                        images: {
+                            enabled: false,
+                            maxImages: 5
+                        },
+                        links: {
+                            enabled: true,
+                            maxLinks: linksMax !== null && linksMax !== void 0 ? linksMax : 5
+                        }
+                    },
+                    // It was agreed to keep process steps disabled for now.
+                    kbProcessSteps: {
+                        enabled: false,
+                        maxSteps: 5,
+                        maxTitleWords: 8,
+                        maxStepWords: 10
+                    },
+                    awsBedrock: {
+                        knowledgeHubId,
+                        awsBedrockKbId,
+                        maxKernels: maxKernels !== null && maxKernels !== void 0 ? maxKernels : 5,
+                        shareable: false,
+                        promptTemplate: isPromptTemplateUsed ? {
+                            textPromptTemplate: prompt,
+                            modelArn: modelArn
+                        } : undefined
+                    }
+                }
+            };
+            // Start measuring node latency.
+            const startTime = debugLogRequestLatency ? Date.now() : 0;
+            // Execute the request against the CXone Knowledgehub API.
+            // A result means successful communication with the API, not necessarily that something was found.
+            // An error is always thrown and handled by the catch block.
+            const result = await api.executeNiceCxoneKnowledgehubApiRequest(knowledgehubConnection, requestBody);
+            // We log the request body after the actual request to include any modifications made by the API function.
+            if (debugLogRequestBody) {
+                // Create a filtered copy of requestBody for logging, excluding sensitive fields
+                const filteredRequestBody = Object.assign(Object.assign({}, requestBody), { kbFiltering: Object.assign(Object.assign({}, requestBody.kbFiltering), { conversationContextRefId: undefined }), config: Object.assign(Object.assign({}, requestBody.config), { awsBedrock: Object.assign(Object.assign({}, requestBody.config.awsBedrock), { awsBedrockKbId: undefined }) }) });
+                const debugMessage = `UI__DEBUG_MODE__NICE_CXONE_KNOWLEDGEHUB__REQUEST_BODY__LABEL: ${JSON.stringify(filteredRequestBody, null, 2)}`;
+                (_a = api.logDebugMessage) === null || _a === void 0 ? void 0 : _a.call(api, debugMessage, "UI__DEBUG_MODE__NICE_CXONE_KNOWLEDGEHUB__REQUEST_BODY__HEADER");
+            }
+            if (debugLogRequestLatency) {
+                const llmLatencyMs = Date.now() - startTime;
+                const debugMessage = `UI__DEBUG_MODE__NICE_CXONE_KNOWLEDGEHUB__REQEUEST_LATENCY__LABEL: ${llmLatencyMs}ms`;
+                (_b = api.logDebugMessage) === null || _b === void 0 ? void 0 : _b.call(api, debugMessage, "UI__DEBUG_MODE__NICE_CXONE_KNOWLEDGEHUB__REQEUEST_LATENCY__HEADER");
+            }
+            // Save result to input or context based on configuration.
+            switch (storeLocation) {
+                case "context":
+                    (_c = api.addToContext) === null || _c === void 0 ? void 0 : _c.call(api, contextKey, result, "simple");
+                    break;
+                default:
+                    api.addToInput(inputKey, result);
+            }
+        }
+        catch (error) {
+            const errorDetails = {
+                name: error === null || error === void 0 ? void 0 : error.name,
+                code: (error === null || error === void 0 ? void 0 : error.code) || (error === null || error === void 0 ? void 0 : error.httpStatusCode),
+                message: error === null || error === void 0 ? void 0 : error.message,
+            };
+            // Debug log to console.
+            (_d = api.logDebugError) === null || _d === void 0 ? void 0 : _d.call(api, errorDetails, "UI__DEBUG_MODE__NICE_CXONE_KNOWLEDGEHUB__ERROR");
+            // Log to system if configured.
+            if (logErrorToSystem) {
+                (_e = api.log) === null || _e === void 0 ? void 0 : _e.call(api, "error", JSON.stringify(errorDetails));
+            }
+            // Store error details either in input or context.
+            switch (storeLocation) {
+                case "context":
+                    (_f = api.addToContext) === null || _f === void 0 ? void 0 : _f.call(api, contextKey, errorDetails, "simple");
+                    break;
+                default:
+                    api.addToInput(inputKey, errorDetails);
+            }
+            // Handle the error based on the configured error handling approach.
+            if (errorHandling === "continue") {
+                if (errorMessage) {
+                    await ((_g = api.output) === null || _g === void 0 ? void 0 : _g.call(api, errorMessage, null));
+                }
+            }
+            else if (errorHandling === "goto") {
+                if (!errorHandlingGotoTarget) {
+                    throw new errors_1.InvalidArgumentError("GoTo Target is required");
+                }
+                const gotoParams = {
+                    cognigy,
+                    childConfigs: [],
+                    nodeId,
+                    config: {
+                        flowNode: {
+                            flow: errorHandlingGotoTarget.flow,
+                            node: errorHandlingGotoTarget.node,
+                        },
+                        injectedText: input.text,
+                        injectedData: input.data,
+                        executionMode: "continue",
+                        absorbContext: false
+                    }
+                };
+                await ((_h = logic_1.GO_TO.function) === null || _h === void 0 ? void 0 : _h.call(logic_1.GO_TO, gotoParams));
+            }
+            else {
+                throw new errors_1.InternalServerError(error === null || error === void 0 ? void 0 : error.message, { traceId });
+            }
+        }
+    }
+});
+/**
+ * Converts a UUID string to a safe int64 string using the lower 53 bits of SHA-256 hash.
+ * Always returns a string representing a safe integer in the range [0, 2^53-1].
+ * @param uuid - The UUID string to convert.
+ * @returns A string representation of a safe int64 value.
+ */
+function uuidToSafeInt64String(uuid) {
+    const hash = crypto.createHash("sha256").update(uuid).digest();
+    // Use the lower 53 bits from the first 7 bytes
+    // 53 bits = 6 full bytes + 5 bits from the 7th byte
+    let value = 0;
+    for (let i = 0; i < 6; i++) {
+        value = (value << 8) | hash[i];
+    }
+    // Add lower 5 bits of the 7th byte
+    value = (value << 5) | (hash[6] >> 3);
+    return value.toString();
+}
+//# sourceMappingURL=CXoneKnowledgehub.js.map

package/build/shared/charts/descriptors/service/cxone/knowledgehub/CXoneKnowledgehubConnection.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NICE_CXONE_KNOWLEDGEHUB_CONNECTION = void 0;
+/* JWT Secret Connection */
+exports.NICE_CXONE_KNOWLEDGEHUB_CONNECTION = {
+    type: "niceCXoneKnowledgehub",
+    label: "UI__CONNECTION_EDITOR__NICE_CXONE_KNOWLEDGEHUB__TITLE",
+    fields: [
+        { fieldName: "accessKey", label: "UI__CONNECTION_EDITOR__FIELD_ACCESS_KEY", required: true },
+        { fieldName: "secretKey", label: "UI__CONNECTION_EDITOR__FIELD_SECRET_KEY", required: true },
+        { fieldName: "clientId", label: "UI__CONNECTION_EDITOR__FIELD_CLIENT_ID", required: false, description: "UI__CONNECTION_EDITOR__NICE_CXONE_KNOWLEDGEHUB__FIELDS__CLIENT_ID__DESCRIPTION" },
+        { fieldName: "clientSecret", label: "UI__CONNECTION_EDITOR__FIELD_CLIENT_SECRET", required: false, description: "UI__CONNECTION_EDITOR__NICE_CXONE_KNOWLEDGEHUB__FIELDS__CLIENT_SECRET__DESCRIPTION" },
+        { fieldName: "endpointUrl", label: "UI__CONNECTION_EDITOR__NICE_CXONE_KNOWLEDGEHUB__FIELDS__URL__LABEL", required: false, description: "UI__CONNECTION_EDITOR__NICE_CXONE_KNOWLEDGEHUB__FIELDS__URL__DESCRIPTION" },
+    ],
+};
+//# sourceMappingURL=CXoneKnowledgehubConnection.js.map

package/build/shared/charts/descriptors/service/cxone/knowledgehub/CXoneKnowledgehubForm.js

@@ -0,0 +1,300 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.form = exports.sections = exports.fields = void 0;
+const CXoneKnowledgehubConnection_1 = require("./CXoneKnowledgehubConnection");
+exports.fields = [
+    {
+        key: "query",
+        type: "cognigyText",
+        label: "UI__NODE_EDITOR__NICE_CXONE_KNOWLEDGEHUB__FIELDS__QUERY__LABEL",
+        description: "UI__NODE_EDITOR__NICE_CXONE_KNOWLEDGEHUB__FIELDS__QUERY__DESCRIPTION",
+        params: {
+            required: true,
+        }
+    },
+    {
+        key: "queryPersona",
+        type: "cognigyText",
+        label: "UI__NODE_EDITOR__NICE_CXONE_KNOWLEDGEHUB__FIELDS__QUERYPERSONA__LABEL",
+        description: "UI__NODE_EDITOR__NICE_CXONE_KNOWLEDGEHUB__FIELDS__QUERYPERSONA__DESCRIPTION",
+        params: {
+            required: false,
+        }
+    },
+    {
+        key: "queryLanguage",
+        type: "cognigyText",
+        label: "UI__NODE_EDITOR__NICE_CXONE_KNOWLEDGEHUB__FIELDS__QUERYLANGUAGE__LABEL",
+        description: "UI__NODE_EDITOR__NICE_CXONE_KNOWLEDGEHUB__FIELDS__QUERYLANGUAGE__DESCRIPTION",
+        params: {
+            required: false,
+        },
+        defaultValue: "en-US"
+    },
+    {
+        key: "knowledgehubConnection",
+        type: "connection",
+        label: "UI__NODE_EDITOR__NICE_CXONE_KNOWLEDGEHUB__FIELDS__CONNECTION__LABEL",
+        description: "UI__NODE_EDITOR__NICE_CXONE_KNOWLEDGEHUB__FIELDS__CONNECTION__DESCRIPTION",
+        params: {
+            required: true,
+            connectionType: CXoneKnowledgehubConnection_1.NICE_CXONE_KNOWLEDGEHUB_CONNECTION.type
+        }
+    },
+    {
+        key: "filters",
+        type: "json",
+        label: "UI__NODE_EDITOR__NICE_CXONE_KNOWLEDGEHUB__FIELDS__FILTERS__LABEL",
+        description: "UI__NODE_EDITOR__NICE_CXONE_KNOWLEDGEHUB__FIELDS__FILTERS__DESCRIPTION",
+        params: {
+            required: false,
+        },
+        defaultValue: "{}",
+    },
+    {
+        key: "promptEditorProfileId",
+        type: "cognigyText",
+        label: "UI__NODE_EDITOR__NICE_CXONE_KNOWLEDGEHUB__FIELDS__PROMPTEDITORPROFILEID__LABEL",
+        description: "UI__NODE_EDITOR__NICE_CXONE_KNOWLEDGEHUB__FIELDS__PROMPTEDITORPROFILEID__DESCRIPTION",
+        params: {
+            required: false,
+        }
+    },
+    {
+        key: "answersMaxWords",
+        type: "number",
+        label: "UI__NODE_EDITOR__NICE_CXONE_KNOWLEDGEHUB__FIELDS__ANSWERSMAXWORDS__LABEL",
+        description: "UI__NODE_EDITOR__NICE_CXONE_KNOWLEDGEHUB__FIELDS__ANSWERSMAXWORDS__DESCRIPTION",
+        params: {
+            required: true,
+        },
+        defaultValue: 100,
+    },
+    {
+        key: "linksMax",
+        type: "number",
+        label: "UI__NODE_EDITOR__NICE_CXONE_KNOWLEDGEHUB__FIELDS__MAXLINKS__LABEL",
+        description: "UI__NODE_EDITOR__NICE_CXONE_KNOWLEDGEHUB__FIELDS__MAXLINKS__DESCRIPTION",
+        params: {
+            required: true,
+        },
+        defaultValue: 5,
+    },
+    {
+        key: "knowledgeHubId",
+        type: "cognigyText",
+        label: "UI__NODE_EDITOR__NICE_CXONE_KNOWLEDGEHUB__FIELDS__KNOWLEDGEHUBID__LABEL",
+        description: "UI__NODE_EDITOR__NICE_CXONE_KNOWLEDGEHUB__FIELDS__KNOWLEDGEHUBID__DESCRIPTION",
+        params: {
+            required: true,
+        }
+    },
+    {
+        key: "maxKernels",
+        type: "number",
+        label: "UI__NODE_EDITOR__NICE_CXONE_KNOWLEDGEHUB__FIELDS__MAXKERNELS__LABEL",
+        description: "UI__NODE_EDITOR__NICE_CXONE_KNOWLEDGEHUB__FIELDS__MAXKERNELS__DESCRIPTION",
+        params: {
+            required: true,
+        },
+        defaultValue: 5,
+    },
+    {
+        key: "prompt",
+        type: "cognigyLLMText",
+        label: "UI__NODE_EDITOR__NICE_CXONE_KNOWLEDGEHUB__FIELDS__PROMPT__LABEL",
+        description: "UI__NODE_EDITOR__NICE_CXONE_KNOWLEDGEHUB__FIELDS__PROMPT__DESCRIPTION",
+        params: {
+            required: false,
+            multiline: true,
+            rows: 5,
+        },
+        defaultValue: "",
+    },
+    {
+        key: "modelArn",
+        type: "cognigyText",
+        label: "UI__NODE_EDITOR__NICE_CXONE_KNOWLEDGEHUB__FIELDS__MODELARN__LABEL",
+        description: "UI__NODE_EDITOR__NICE_CXONE_KNOWLEDGEHUB__FIELDS__MODELARN__DESCRIPTION",
+        params: {
+            required: false,
+        }
+    },
+    {
+        key: "storeLocation",
+        type: "select",
+        label: "UI__NODE_EDITOR__NICE_CXONE_KNOWLEDGEHUB__FIELDS__STORAGE__LABEL",
+        description: "UI__NODE_EDITOR__NICE_CXONE_KNOWLEDGEHUB__FIELDS__STORAGE__DESCRIPTION",
+        defaultValue: "input",
+        params: {
+            options: [
+                {
+                    label: "Input",
+                    value: "input"
+                },
+                {
+                    label: "Context",
+                    value: "context"
+                }
+            ],
+            required: true
+        },
+    },
+    {
+        key: "inputKey",
+        type: "cognigyText",
+        label: "UI__NODE_EDITOR__NICE_CXONE_KNOWLEDGEHUB__FIELDS__STORAGEVARIABLE__LABEL",
+        description: "UI__NODE_EDITOR__NICE_CXONE_KNOWLEDGEHUB__FIELDS__STORAGEVARIABLE__DESCRIPTION",
+        defaultValue: "knowledgehub",
+        condition: {
+            key: "storeLocation",
+            value: "input",
+        }
+    },
+    {
+        key: "contextKey",
+        type: "cognigyText",
+        label: "UI__NODE_EDITOR__NICE_CXONE_KNOWLEDGEHUB__FIELDS__STORAGEVARIABLE__LABEL",
+        description: "UI__NODE_EDITOR__NICE_CXONE_KNOWLEDGEHUB__FIELDS__STORAGEVARIABLE__DESCRIPTION",
+        defaultValue: "knowledgehub",
+        condition: {
+            key: "storeLocation",
+            value: "context",
+        }
+    },
+    {
+        key: "logErrorToSystem",
+        label: "UI__NODE_EDITOR__NICE_CXONE_KNOWLEDGEHUB__FIELDS__LOGERRORTOSYSTEM__LABEL",
+        description: "UI__NODE_EDITOR__NICE_CXONE_KNOWLEDGEHUB__FIELDS__LOGERRORTOSYSTEM__DESCRIPTION",
+        type: "toggle",
+        defaultValue: false,
+    },
+    {
+        key: "errorHandling",
+        type: "select",
+        label: "UI__NODE_EDITOR__NICE_CXONE_KNOWLEDGEHUB__FIELDS__ERRORHANDLING__LABEL",
+        description: "UI__NODE_EDITOR__NICE_CXONE_KNOWLEDGEHUB__FIELDS__ERRORHANDLING__DESCRIPTION",
+        defaultValue: "continue",
+        params: {
+            options: [
+                {
+                    label: "UI__NODE_EDITOR__FIELDS__HANDLE_SERVICE_ERROR__OPTIONS__STOP__LABEL",
+                    value: "stop"
+                },
+                {
+                    label: "UI__NODE_EDITOR__FIELDS__HANDLE_SERVICE_ERROR__OPTIONS__CONTINUE__LABEL",
+                    value: "continue"
+                },
+                {
+                    label: "UI__NODE_EDITOR__FIELDS__HANDLE_SERVICE_ERROR__OPTIONS__GOTO__LABEL",
+                    value: "goto"
+                },
+            ]
+        }
+    },
+    {
+        key: "errorHandlingGotoTarget",
+        type: "flowNode",
+        label: "UI__NODE_EDITOR__NICE_CXONE_KNOWLEDGEHUB__FIELDS__ERRORGOTO__LABEL",
+        condition: {
+            key: "errorHandling",
+            value: "goto"
+        }
+    },
+    {
+        key: "errorMessage",
+        type: "cognigyText",
+        label: "UI__NODE_EDITOR__NICE_CXONE_KNOWLEDGEHUB__FIELDS__ERRORMESSAGE__LABEL",
+        description: "UI__NODE_EDITOR__NICE_CXONE_KNOWLEDGEHUB__FIELDS__ERRORMESSAGE__DESCRIPTION",
+        defaultValue: "",
+        condition: {
+            key: "errorHandling",
+            value: "continue"
+        }
+    },
+    {
+        key: "debugDescription",
+        type: "description",
+        label: " ",
+        params: {
+            text: "UI__NODE_EDITOR__NICE_CXONE_KNOWLEDGEHUB__FIELDS__DEBUG__DESCRIPTION"
+        }
+    },
+    {
+        key: "debugLogRequestBody",
+        type: "toggle",
+        label: "UI__NODE_EDITOR__NICE_CXONE_KNOWLEDGEHUB__FIELDS__DEBUGLOGREQUESTBODY__LABEL",
+        description: "UI__NODE_EDITOR__NICE_CXONE_KNOWLEDGEHUB__FIELDS__DEBUGLOGREQUESTBODY__DESCRIPTION",
+        defaultValue: false
+    },
+    {
+        key: "debugLogRequestLatency",
+        type: "toggle",
+        label: "UI__NODE_EDITOR__NICE_CXONE_KNOWLEDGEHUB__FIELDS__DEBUGLOGREQUESTLATENCY__LABEL",
+        description: "UI__NODE_EDITOR__NICE_CXONE_KNOWLEDGEHUB__FIELDS__DEBUGLOGREQUESTLATENCY__DESCRIPTION",
+        defaultValue: false
+    }
+];
+exports.sections = [
+    {
+        key: "query",
+        label: "UI__NODE_EDITOR__NICE_CXONE_KNOWLEDGEHUB__FIELDS__QUERY__SECTION_TITLE",
+        defaultCollapsed: true,
+        fields: ["queryPersona", "queryLanguage"],
+    },
+    {
+        key: "kbAnswers",
+        label: "UI__NODE_EDITOR__NICE_CXONE_KNOWLEDGEHUB__FIELDS__GENERATIVEAI__SECTION_TITLE",
+        defaultCollapsed: true,
+        fields: ["promptEditorProfileId", "answersMaxWords", "linksMax"],
+    },
+    {
+        key: "KnowledgeHub",
+        label: "UI__NODE_EDITOR__NICE_CXONE_KNOWLEDGEHUB__FIELDS__AWSBEDROCK__SECTION_TITLE",
+        defaultCollapsed: true,
+        fields: ["filters", "maxKernels", "prompt", "modelArn"],
+    },
+    {
+        key: "storage",
+        label: "UI__NODE_EDITOR__NICE_CXONE_KNOWLEDGEHUB__FIELDS__STORAGE__SECTION_TITLE",
+        defaultCollapsed: true,
+        fields: [
+            "storeLocation",
+            "inputKey",
+            "contextKey",
+        ]
+    },
+    {
+        key: "errorHandling",
+        label: "UI__NODE_EDITOR__NICE_CXONE_KNOWLEDGEHUB__FIELDS__ERRORHANDLING__SECTION_TITLE",
+        defaultCollapsed: true,
+        fields: [
+            "logErrorToSystem",
+            "errorHandling",
+            "errorMessage",
+            "errorHandlingGotoTarget",
+        ]
+    },
+    {
+        key: "debugging",
+        label: "UI__NODE_EDITOR__SECTIONS__DEBUG_SETTINGS__LABEL",
+        defaultCollapsed: true,
+        fields: [
+            "debugDescription",
+            "debugLogRequestBody",
+            "debugLogRequestLatency",
+        ]
+    },
+];
+exports.form = [
+    { type: "field", key: "knowledgehubConnection" },
+    { type: "field", key: "knowledgeHubId" },
+    { type: "field", key: "query" },
+    { type: "section", key: "query" },
+    { type: "section", key: "KnowledgeHub" },
+    { type: "section", key: "kbAnswers" },
+    { type: "section", key: "storage" },
+    { type: "section", key: "errorHandling" },
+    { type: "section", key: "debugging" },
+];
+//# sourceMappingURL=CXoneKnowledgehubForm.js.map

package/build/shared/charts/descriptors/service/cxone/knowledgehub/CXoneKnowledgehubProviderModule.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.niceCXoneKnowledgehubProviderModule = void 0;
+/* Custom modules */
+const createNodeDescriptor_1 = require("../../../../createNodeDescriptor");
+const CXoneKnowledgehub_1 = require("./CXoneKnowledgehub");
+const CXoneKnowledgehubConnection_1 = require("./CXoneKnowledgehubConnection");
+exports.niceCXoneKnowledgehubProviderModule = (0, createNodeDescriptor_1.createExtension)({
+    nodes: [
+        CXoneKnowledgehub_1.NICE_CXONE_KNOWLEDGEHUB
+    ],
+    connections: [
+        CXoneKnowledgehubConnection_1.NICE_CXONE_KNOWLEDGEHUB_CONNECTION
+    ]
+});
+//# sourceMappingURL=CXoneKnowledgehubProviderModule.js.map

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AIOPS_CENTER_WEBHOOKS_CONNECTION = exports.NICECXONEAAH_AUTHENTICATION_CONNECTION = exports.STORM_CONNECTION = exports.GENESYS_CLOUD_CONNECTION_OM = exports.GENESYS_CLOUD_CONNECTION = exports.EIGHT_BY_EIGHT_CONNECTION = exports.CHATWOOT_CONNECTION = exports.RINGCENTRAL_ENGAGE_CONNECTION = exports.LIVE_AGENT_CONNECTION = exports.LOAD_AI_AGENT = exports.KNOWLEDGE_TOOL = exports.AI_AGENT_JOB_CALL_MCP_TOOL = exports.AI_AGENT_HANDOVER = exports.AI_AGENT_TOOL_ANSWER = exports.AI_AGENT_JOB_MCP_TOOL = exports.AI_AGENT_JOB_TOOL = exports.AI_AGENT_JOB_DEFAULT = exports.AI_AGENT_JOB = exports.LLM_MODERATE = exports.LLM_ENTITY_EXTRACT = exports.GPT_CONVERSATION_SUMMARY = exports.GPT_CONVERSATION = exports.HANDOVER_INACTIVITY_TIMER = exports.CLOSE_HANDOVER = exports.LLM_PROMPT_TOOL = exports.LLM_PROMPT_MCP_TOOL = exports.LLM_PROMPT_DEFAULT = exports.LLM_PROMPT_V2 = exports.GPT_PROMPT = exports.ON_SCHEDULING_ERROR = exports.ON_SCHEDULED = exports.TRIGGER_FUNCTION = exports.JWT_SECRET_CONNECTION = exports.HTTP_CONNECTION_OAUTH2 = exports.HTTP_CONNECTION_APIKEYXKEY = exports.HTTP_CONNECTION_APIKEYAUTHKEY = exports.HTTP_CONNECTION_BASIC = exports.HTTP_REQUEST = exports.CHECK_AGENT_AVAILABILITY = exports.HANDOVER_V2 = exports.HANDOVER = void 0;
+exports.AIOPS_CENTER_WEBHOOKS_CONNECTION = exports.NICECXONEAAH_AUTHENTICATION_CONNECTION = exports.STORM_CONNECTION = exports.GENESYS_CLOUD_CONNECTION_OM = exports.GENESYS_CLOUD_CONNECTION = exports.EIGHT_BY_EIGHT_CONNECTION = exports.CHATWOOT_CONNECTION = exports.RINGCENTRAL_ENGAGE_CONNECTION = exports.LIVE_AGENT_CONNECTION = exports.LOAD_AI_AGENT = exports.SEND_EMAIL_TOOL = exports.HANDOVER_TO_AI_AGENT_TOOL = exports.KNOWLEDGE_TOOL = exports.AI_AGENT_JOB_CALL_MCP_TOOL = exports.AI_AGENT_HANDOVER = exports.AI_AGENT_TOOL_ANSWER = exports.AI_AGENT_JOB_MCP_TOOL = exports.AI_AGENT_JOB_TOOL = exports.AI_AGENT_JOB_DEFAULT = exports.AI_AGENT_JOB = exports.LLM_MODERATE = exports.LLM_ENTITY_EXTRACT = exports.GPT_CONVERSATION_SUMMARY = exports.GPT_CONVERSATION = exports.HANDOVER_INACTIVITY_TIMER = exports.CLOSE_HANDOVER = exports.LLM_PROMPT_TOOL = exports.LLM_PROMPT_MCP_TOOL = exports.LLM_PROMPT_DEFAULT = exports.LLM_PROMPT_V2 = exports.GPT_PROMPT = exports.ON_SCHEDULING_ERROR = exports.ON_SCHEDULED = exports.TRIGGER_FUNCTION = exports.JWT_SECRET_CONNECTION = exports.HTTP_CONNECTION_OAUTH2 = exports.HTTP_CONNECTION_APIKEYXKEY = exports.HTTP_CONNECTION_APIKEYAUTHKEY = exports.HTTP_CONNECTION_BASIC = exports.HTTP_REQUEST = exports.CHECK_AGENT_AVAILABILITY = exports.HANDOVER_V2 = exports.HANDOVER = void 0;
 var handover_1 = require("./handover");
 Object.defineProperty(exports, "HANDOVER", { enumerable: true, get: function () { return handover_1.HANDOVER; } });
 var handoverV2_1 = require("./handoverV2");
@@ -61,6 +61,10 @@ var aiAgentJobCallMCPTool_1 = require("./aiAgent/aiAgentJobCallMCPTool");
 Object.defineProperty(exports, "AI_AGENT_JOB_CALL_MCP_TOOL", { enumerable: true, get: function () { return aiAgentJobCallMCPTool_1.AI_AGENT_JOB_CALL_MCP_TOOL; } });
 var knowledgeTool_1 = require("./agentTools/knowledgeTool");
 Object.defineProperty(exports, "KNOWLEDGE_TOOL", { enumerable: true, get: function () { return knowledgeTool_1.KNOWLEDGE_TOOL; } });
+var handoverToAiAgentTool_1 = require("./agentTools/handoverToAiAgentTool");
+Object.defineProperty(exports, "HANDOVER_TO_AI_AGENT_TOOL", { enumerable: true, get: function () { return handoverToAiAgentTool_1.HANDOVER_TO_AI_AGENT_TOOL; } });
+var sendEmailTool_1 = require("./agentTools/sendEmailTool");
+Object.defineProperty(exports, "SEND_EMAIL_TOOL", { enumerable: true, get: function () { return sendEmailTool_1.SEND_EMAIL_TOOL; } });
 var loadAiAgent_1 = require("./aiAgent/loadAiAgent");
 Object.defineProperty(exports, "LOAD_AI_AGENT", { enumerable: true, get: function () { return loadAiAgent_1.LOAD_AI_AGENT; } });
 var handoverConnections_1 = require("./handoverConnections");

package/build/shared/charts/descriptors/service/llmPrompt/LLMPromptV2.js

@@ -29,7 +29,7 @@ exports.LLM_PROMPT_V2 = (0, createNodeDescriptor_1.createNodeDescriptor)({
         collapsable: true,
         placement: {
             children: {
-                whitelist: ["llmPromptDefault", "llmPromptTool", "llmPromptMCPTool", "knowledgeTool"],
+                whitelist: ["llmPromptDefault", "llmPromptTool", "llmPromptMCPTool", "knowledgeTool", "handoverToAiAgentTool", "sendEmailTool"],
             },
         },
     },

package/build/shared/charts/descriptors/voice/mappers/setSessionConfig.mapper.js

@@ -165,22 +165,17 @@ class SessionConfigMapper extends base_mapper_1.BaseMapper {
         const { vendor: spVendor, language: spLanguage, voice: spVoice, label: spLabel, model: spModel, azureServiceEndpoint: spAzureServiceEndpoint } = sessionParamsTts || {};
         const { azureServiceEndpoint, ttsLabel, ttsLanguage, ttsModel, ttsVendor, ttsVoice } = tts || {};
         const synthesizer = {};
-        if (this.has(tts) || this.has(sessionParamsTts)) {
-            synthesizer.vendor = spVendor || ttsVendor;
-            synthesizer.language = spLanguage || ttsLanguage;
-            synthesizer.voice = spVoice || ttsVoice;
-            synthesizer.label = spLabel || ttsLabel;
-            synthesizer.azureServiceEndpoint = "";
-            if (spAzureServiceEndpoint || azureServiceEndpoint) {
-                synthesizer.azureServiceEndpoint = spAzureServiceEndpoint || azureServiceEndpoint;
-            }
-            if (spModel || ttsModel) {
-                synthesizer.options = {
-                    model_id: spModel || ttsModel
-                };
-            }
-            return synthesizer;
+        synthesizer.vendor = spVendor || ttsVendor || undefined;
+        synthesizer.language = spLanguage || ttsLanguage || undefined;
+        synthesizer.voice = spVoice || ttsVoice || undefined;
+        synthesizer.label = spLabel || ttsLabel || undefined;
+        synthesizer.azureServiceEndpoint = spAzureServiceEndpoint || azureServiceEndpoint || "";
+        if (spModel || ttsModel) {
+            synthesizer.options = {
+                model_id: spModel || ttsModel
+            };
         }
+        return synthesizer;
     }
     buildRecognizer(sessionParams, stt, vad, azureConfig) {
         var _a, _b, _c;
@@ -518,11 +513,12 @@ exports.setSessionConfig = {
         var _a;
         const { bargeIn, continuousAsr, stt, tts, userNoInput, dtmf, vad, azureConfig, atmosphereNoise, silenceOverlay, flowNoInput } = voiceSettings;
         try {
+            const synthesizer = mapper.buildSynthesizer(sessionParams, tts) || undefined;
             const recognizer = mapper.buildRecognizer(sessionParams, stt, vad, azureConfig) || undefined;
             mapper.recognizerApplyContinuousAsr(sessionParams, recognizer, continuousAsr);
             // Check if there are configs for synthesizer, recognizer and bargeIn
             const voiceConfig = {
-                synthesizer: mapper.buildSynthesizer(sessionParams, tts) || undefined,
+                synthesizer,
                 recognizer,
                 bargeIn: mapper.buildBarge(sessionParams, dtmf, bargeIn) || undefined,
                 fillerNoise: mapper.buildFillerNoise(sessionParams, silenceOverlay) || undefined,

package/build/shared/constants.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PLATFORM_PROVIDED_LLM_CONNECTION_ID = exports.PLATFORM_PROVIDED_LLM_ID = exports.DEPRECATED_GENAI_USE_CASES = exports.PLATFORM_PROVIDED_LLM_USE_CASES = exports.SECONDS_PER_MINUTE = exports.IP_NOT_AVAILABLE = exports.COGNIGY_LIVE_AGENT_DESCRIPTOR_FIELDS = exports.DOCUMENT_PARSER_PROVIDER_EXTENSION = exports.TRANSLATION_PROVIDER_EXTENSION = exports.AUDIO_PREVIEW_PROVIDER_EXTENSION = exports.GENERATIVE_AI_PROVIDER_EXTENSION = exports.ADMIN_CONSOLE_URL_TOKEN = exports.X_COGNIGY_ORIGIN = exports.EMBEDDED_EXTENSION = exports.INTERNAL_STORAGE_PROVIDER_EXTENSION = exports.VOICE_GATEWAY_2_EXTENSION = exports.MICROSOFT_EXTENSION = exports.VOICE_GATEWAY_EXTENSION = exports.SMTP_EXTENSION = exports.SQL_EXTENSION = exports.MONGO_DB_EXTENSION = exports.BASIC_EXTENSION = exports.MAX_INT32 = exports.PASSWORD_RESET_TOKEN_TTL_IN_SECONDS = exports.SCOPED_USER = exports.SYSTEM_EMAIL = exports.SYSTEM = exports.CREATED_BY_SSO = void 0;
+exports.PLATFORM_PROVIDED_LLM_CONNECTION_ID = exports.PLATFORM_PROVIDED_LLM_ID = exports.DEPRECATED_GENAI_USE_CASES = exports.PLATFORM_PROVIDED_LLM_USE_CASES = exports.SECONDS_PER_MINUTE = exports.IP_NOT_AVAILABLE = exports.COGNIGY_LIVE_AGENT_DESCRIPTOR_FIELDS = exports.NICE_CXONE_KNOWLEDGEHUB_EXTENSION = exports.DOCUMENT_PARSER_PROVIDER_EXTENSION = exports.TRANSLATION_PROVIDER_EXTENSION = exports.AUDIO_PREVIEW_PROVIDER_EXTENSION = exports.GENERATIVE_AI_PROVIDER_EXTENSION = exports.ADMIN_CONSOLE_URL_TOKEN = exports.X_COGNIGY_ORIGIN = exports.EMBEDDED_EXTENSION = exports.INTERNAL_STORAGE_PROVIDER_EXTENSION = exports.VOICE_GATEWAY_2_EXTENSION = exports.MICROSOFT_EXTENSION = exports.VOICE_GATEWAY_EXTENSION = exports.SMTP_EXTENSION = exports.SQL_EXTENSION = exports.MONGO_DB_EXTENSION = exports.BASIC_EXTENSION = exports.MAX_INT32 = exports.PASSWORD_RESET_TOKEN_TTL_IN_SECONDS = exports.SCOPED_USER = exports.SYSTEM_EMAIL = exports.SYSTEM = exports.CREATED_BY_SSO = void 0;
 exports.CREATED_BY_SSO = "000000000000000000000550";
 exports.SYSTEM = "000000000000000000000000";
 exports.SYSTEM_EMAIL = "system@mail.com";
@@ -24,6 +24,7 @@ exports.GENERATIVE_AI_PROVIDER_EXTENSION = "@cognigy/generative-ai-provider";
 exports.AUDIO_PREVIEW_PROVIDER_EXTENSION = "@cognigy/audio-preview-provider";
 exports.TRANSLATION_PROVIDER_EXTENSION = "@cognigy/translation-provider";
 exports.DOCUMENT_PARSER_PROVIDER_EXTENSION = "@cognigy/document-parser-provider";
+exports.NICE_CXONE_KNOWLEDGEHUB_EXTENSION = "@cognigy/nice-cxone-knowledgehub";
 exports.COGNIGY_LIVE_AGENT_DESCRIPTOR_FIELDS = {
     ESCALATE_INTENTS_HANDOVER_LIVE_AGENT_INBOX_ID: "escalateIntentsHandoverLiveAgentInboxId",
     ESCALATE_INTENTS_AGENT_ASSIST_INIT_MESSAGE: "escalateIntentsAgentAssistInitMessage",

package/build/shared/interfaces/IOrganisation.js

@@ -60,6 +60,7 @@ exports.organisationDataSchema = {
         disabled: { type: "boolean" },
         name: { type: "string", minLength: 1, format: "resource-name" },
         businessUnitId: { type: "string" },
+        tenantId: { type: "string" },
         passwordPolicy: exports.organisationPasswordPolicySchema,
         quotaMaxChannelsPerProject: { type: "integer", minimum: 0 },
         quotaMaxMessagesPerDay: { type: "integer", minimum: 0 },

package/build/shared/interfaces/cxone/knowledgehub/CXoneKnowledgehubAPI.js

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

package/build/shared/interfaces/resources/IAuditEvent.js

@@ -117,6 +117,7 @@ exports.actionTypes = [
     "loginFailed",
     "loginError",
     "unauthorized",
+    "disableCreditCardRedaction",
 ];
 exports.auditEventSchema = {
     title: "auditEventSchema",