@cognigy/rest-api-client 0.19.0 → 0.20.0

package/build/shared/charts/descriptors/transcripts/addTranscriptStep.js

@@ -0,0 +1,413 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ADD_TRANSCRIPT_STEP = void 0;
+/* Custom modules */
+const createNodeDescriptor_1 = require("../../createNodeDescriptor");
+const transcripts_1 = require("../../../interfaces/transcripts/transcripts");
+/**
+ * Node name: 'addTranscriptStep'
+ *
+ * Purpose:
+ * Add a transcript step to the current session
+ */
+exports.ADD_TRANSCRIPT_STEP = (0, createNodeDescriptor_1.createNodeDescriptor)({
+    type: "addTranscriptStep",
+    defaultLabel: "Add Transcript Step",
+    summary: "UI__NODE_EDITOR__ADD_TRANSCRIPT_STEP__SUMMARY",
+    appearance: {
+        showIcon: false
+    },
+    fields: [
+        {
+            key: "role",
+            type: "select",
+            label: "UI__NODE_EDITOR__ADD_TRANSCRIPT_STEP__FIELDS__ROLE__LABEL",
+            defaultValue: transcripts_1.TranscriptRole.USER,
+            params: {
+                options: [
+                    {
+                        label: "UI__NODE_EDITOR__ADD_TRANSCRIPT_STEP__FIELDS__ROLE__OPTIONS__USER",
+                        value: transcripts_1.TranscriptRole.USER,
+                    },
+                    {
+                        label: "UI__NODE_EDITOR__ADD_TRANSCRIPT_STEP__FIELDS__ROLE__OPTIONS__ASSISTANT",
+                        value: transcripts_1.TranscriptRole.ASSISTANT,
+                    },
+                    {
+                        label: "UI__NODE_EDITOR__ADD_TRANSCRIPT_STEP__FIELDS__ROLE__OPTIONS__AGENT",
+                        value: transcripts_1.TranscriptRole.AGENT,
+                    },
+                    {
+                        label: "UI__NODE_EDITOR__ADD_TRANSCRIPT_STEP__FIELDS__ROLE__OPTIONS__SYSTEM",
+                        value: transcripts_1.TranscriptRole.SYSTEM,
+                    },
+                    {
+                        label: "UI__NODE_EDITOR__ADD_TRANSCRIPT_STEP__FIELDS__ROLE__OPTIONS__TOOL",
+                        value: transcripts_1.TranscriptRole.TOOL,
+                    },
+                ],
+            },
+        },
+        {
+            key: "assistantType",
+            type: "select",
+            label: "UI__NODE_EDITOR__ADD_TRANSCRIPT_STEP__FIELDS__TYPE__LABEL",
+            defaultValue: transcripts_1.TranscriptEntryType.OUTPUT,
+            params: {
+                options: [
+                    {
+                        label: "UI__NODE_EDITOR__ADD_TRANSCRIPT_STEP__FIELDS__TYPE__OPTIONS__OUTPUT",
+                        value: transcripts_1.TranscriptEntryType.OUTPUT,
+                    },
+                    {
+                        label: "UI__NODE_EDITOR__ADD_TRANSCRIPT_STEP__FIELDS__TYPE__OPTIONS__TOOL_CALL",
+                        value: transcripts_1.TranscriptEntryType.TOOL_CALL,
+                    },
+                ],
+            },
+            condition: {
+                key: "role",
+                value: transcripts_1.TranscriptRole.ASSISTANT,
+            },
+        },
+        {
+            key: "agentType",
+            type: "select",
+            label: "UI__NODE_EDITOR__ADD_TRANSCRIPT_STEP__FIELDS__TYPE__LABEL",
+            defaultValue: transcripts_1.TranscriptEntryType.OUTPUT,
+            params: {
+                options: [
+                    {
+                        label: "UI__NODE_EDITOR__ADD_TRANSCRIPT_STEP__FIELDS__TYPE__OPTIONS__OUTPUT",
+                        value: transcripts_1.TranscriptEntryType.OUTPUT,
+                    }
+                ],
+                disabled: true
+            },
+            condition: {
+                key: "role",
+                value: transcripts_1.TranscriptRole.AGENT,
+            },
+        },
+        {
+            key: "userType",
+            type: "select",
+            label: "UI__NODE_EDITOR__ADD_TRANSCRIPT_STEP__FIELDS__TYPE__LABEL",
+            defaultValue: transcripts_1.TranscriptEntryType.INPUT,
+            params: {
+                options: [
+                    {
+                        label: "UI__NODE_EDITOR__ADD_TRANSCRIPT_STEP__FIELDS__TYPE__OPTIONS__INPUT",
+                        value: transcripts_1.TranscriptEntryType.INPUT,
+                    },
+                ],
+                disabled: true
+            },
+            condition: {
+                key: "role",
+                value: transcripts_1.TranscriptRole.USER,
+            },
+        },
+        {
+            key: "systemType",
+            type: "select",
+            label: "UI__NODE_EDITOR__ADD_TRANSCRIPT_STEP__FIELDS__TYPE__LABEL",
+            defaultValue: transcripts_1.TranscriptEntryType.DEBUG_LOG,
+            params: {
+                options: [
+                    {
+                        label: "UI__NODE_EDITOR__ADD_TRANSCRIPT_STEP__FIELDS__TYPE__OPTIONS__DEBUG_LOG",
+                        value: transcripts_1.TranscriptEntryType.DEBUG_LOG,
+                    },
+                ],
+                disabled: true
+            },
+            condition: {
+                key: "role",
+                value: transcripts_1.TranscriptRole.SYSTEM,
+            },
+        },
+        {
+            key: "toolType",
+            type: "select",
+            label: "UI__NODE_EDITOR__ADD_TRANSCRIPT_STEP__FIELDS__TYPE__LABEL",
+            defaultValue: transcripts_1.TranscriptEntryType.TOOL_ANSWER,
+            params: {
+                options: [
+                    {
+                        label: "UI__NODE_EDITOR__ADD_TRANSCRIPT_STEP__FIELDS__TYPE__OPTIONS__TOOL_ANSWER",
+                        value: transcripts_1.TranscriptEntryType.TOOL_ANSWER,
+                    },
+                ],
+                disabled: true
+            },
+            condition: {
+                key: "role",
+                value: transcripts_1.TranscriptRole.TOOL,
+            },
+        },
+        {
+            key: "text",
+            type: "cognigyText",
+            label: "UI__NODE_EDITOR__ADD_TRANSCRIPT_STEP__FIELDS__TEXT__LABEL",
+            defaultValue: "",
+            condition: {
+                or: [
+                    {
+                        key: "role",
+                        value: transcripts_1.TranscriptRole.USER,
+                    },
+                    {
+                        key: "role",
+                        value: transcripts_1.TranscriptRole.AGENT,
+                    },
+                    {
+                        and: [{
+                                key: "role",
+                                value: transcripts_1.TranscriptRole.ASSISTANT
+                            }, {
+                                key: "assistantType",
+                                value: transcripts_1.TranscriptEntryType.OUTPUT
+                            }]
+                    },
+                ],
+            },
+        },
+        {
+            key: "data",
+            type: "json",
+            label: "UI__NODE_EDITOR__ADD_TRANSCRIPT_STEP__FIELDS__DATA__LABEL",
+            defaultValue: "",
+            condition: {
+                or: [
+                    {
+                        key: "role",
+                        value: transcripts_1.TranscriptRole.USER,
+                    },
+                    {
+                        key: "role",
+                        value: transcripts_1.TranscriptRole.AGENT,
+                    },
+                    {
+                        and: [{
+                                key: "role",
+                                value: transcripts_1.TranscriptRole.ASSISTANT
+                            }, {
+                                key: "assistantType",
+                                value: transcripts_1.TranscriptEntryType.OUTPUT
+                            }]
+                    },
+                ],
+            },
+        },
+        {
+            key: "name",
+            type: "cognigyText",
+            label: "UI__NODE_EDITOR__ADD_TRANSCRIPT_STEP__FIELDS__NAME__LABEL",
+            defaultValue: "",
+            condition: {
+                or: [
+                    {
+                        and: [{
+                                key: "role",
+                                value: transcripts_1.TranscriptRole.ASSISTANT
+                            }, {
+                                key: "assistantType",
+                                value: transcripts_1.TranscriptEntryType.TOOL_CALL
+                            }]
+                    },
+                    {
+                        key: "role",
+                        value: transcripts_1.TranscriptRole.TOOL,
+                    }
+                ],
+            },
+        },
+        {
+            key: "id",
+            type: "cognigyText",
+            label: "UI__NODE_EDITOR__ADD_TRANSCRIPT_STEP__FIELDS__ID__LABEL",
+            defaultValue: "",
+            condition: {
+                and: [{
+                        key: "role",
+                        value: transcripts_1.TranscriptRole.ASSISTANT
+                    }, {
+                        key: "assistantType",
+                        value: transcripts_1.TranscriptEntryType.TOOL_CALL
+                    }]
+            },
+        },
+        {
+            key: "input",
+            type: "json",
+            label: "UI__NODE_EDITOR__ADD_TRANSCRIPT_STEP__FIELDS__INPUT__LABEL",
+            defaultValue: "",
+            condition: {
+                and: [{
+                        key: "role",
+                        value: transcripts_1.TranscriptRole.ASSISTANT
+                    }, {
+                        key: "assistantType",
+                        value: transcripts_1.TranscriptEntryType.TOOL_CALL
+                    }]
+            },
+        },
+        {
+            key: "toolCallId",
+            type: "cognigyText",
+            label: "UI__NODE_EDITOR__ADD_TRANSCRIPT_STEP__FIELDS__TOOL_CALL_ID__LABEL",
+            defaultValue: "",
+            condition: {
+                key: "role",
+                value: transcripts_1.TranscriptRole.TOOL,
+            },
+        },
+        {
+            key: "content",
+            type: "cognigyText",
+            label: "UI__NODE_EDITOR__ADD_TRANSCRIPT_STEP__FIELDS__CONTENT__LABEL",
+            defaultValue: "",
+            condition: {
+                key: "role",
+                value: transcripts_1.TranscriptRole.TOOL,
+            },
+        },
+        {
+            key: "header",
+            type: "cognigyText",
+            label: "UI__NODE_EDITOR__ADD_TRANSCRIPT_STEP__FIELDS__HEADER__LABEL",
+            defaultValue: "",
+            condition: {
+                key: "role",
+                value: transcripts_1.TranscriptRole.SYSTEM,
+            },
+        },
+        {
+            key: "message",
+            type: "cognigyText",
+            label: "UI__NODE_EDITOR__ADD_TRANSCRIPT_STEP__FIELDS__MESSAGE__LABEL",
+            defaultValue: "",
+            condition: {
+                key: "role",
+                value: transcripts_1.TranscriptRole.SYSTEM,
+            },
+        },
+        {
+            key: "metadata",
+            type: "json",
+            label: "UI__NODE_EDITOR__ADD_TRANSCRIPT_STEP__FIELDS__METADATA__LABEL",
+            defaultValue: "",
+            condition: {
+                key: "role",
+                value: transcripts_1.TranscriptRole.SYSTEM,
+            },
+        },
+    ],
+    form: [
+        { type: "field", key: "role" },
+        { type: "field", key: "userType" },
+        { type: "field", key: "assistantType" },
+        { type: "field", key: "agentType" },
+        { type: "field", key: "systemType" },
+        { type: "field", key: "toolType" },
+        { type: "field", key: "text" },
+        { type: "field", key: "data" },
+        { type: "field", key: "name" },
+        { type: "field", key: "id" },
+        { type: "field", key: "input" },
+        { type: "field", key: "toolCallId" },
+        { type: "field", key: "content" },
+        { type: "field", key: "header" },
+        { type: "field", key: "message" },
+        { type: "field", key: "metadata" },
+    ],
+    preview: {
+        key: "role",
+        type: "text"
+    },
+    tags: ["service", "transcripts"],
+    function: async ({ cognigy, config }) => {
+        const { role, agentType, text, data, name, id, input, toolCallId, content, header, message, metadata } = config;
+        const { api } = cognigy;
+        let log = null;
+        switch (role) {
+            case transcripts_1.TranscriptRole.USER:
+                log = {
+                    role: transcripts_1.TranscriptRole.USER,
+                    type: transcripts_1.TranscriptEntryType.INPUT,
+                    source: transcripts_1.TranscriptEntrySource.SYSTEM,
+                    payload: {
+                        text,
+                        data
+                    }
+                };
+                break;
+            case transcripts_1.TranscriptRole.ASSISTANT:
+                if (agentType === transcripts_1.TranscriptEntryType.OUTPUT) {
+                    log = {
+                        role: transcripts_1.TranscriptRole.ASSISTANT,
+                        type: transcripts_1.TranscriptEntryType.OUTPUT,
+                        source: transcripts_1.TranscriptEntrySource.SYSTEM,
+                        payload: {
+                            text,
+                            data
+                        }
+                    };
+                }
+                else if (agentType === transcripts_1.TranscriptEntryType.TOOL_CALL) {
+                    log = {
+                        role: transcripts_1.TranscriptRole.ASSISTANT,
+                        type: transcripts_1.TranscriptEntryType.TOOL_CALL,
+                        source: transcripts_1.TranscriptEntrySource.SYSTEM,
+                        payload: {
+                            name,
+                            id,
+                            input
+                        }
+                    };
+                }
+                break;
+            case transcripts_1.TranscriptRole.AGENT:
+                log = {
+                    role: transcripts_1.TranscriptRole.AGENT,
+                    type: transcripts_1.TranscriptEntryType.OUTPUT,
+                    source: transcripts_1.TranscriptEntrySource.SYSTEM,
+                    payload: {
+                        text,
+                        data
+                    }
+                };
+                break;
+            case transcripts_1.TranscriptRole.SYSTEM:
+                log = {
+                    role: transcripts_1.TranscriptRole.SYSTEM,
+                    type: transcripts_1.TranscriptEntryType.DEBUG_LOG,
+                    source: transcripts_1.TranscriptEntrySource.SYSTEM,
+                    payload: {
+                        header,
+                        message,
+                        metadata
+                    }
+                };
+                break;
+            case transcripts_1.TranscriptRole.TOOL:
+                log = {
+                    role: transcripts_1.TranscriptRole.TOOL,
+                    type: transcripts_1.TranscriptEntryType.TOOL_ANSWER,
+                    source: transcripts_1.TranscriptEntrySource.SYSTEM,
+                    payload: {
+                        toolCallId,
+                        name,
+                        content,
+                    }
+                };
+                break;
+            default:
+                break;
+        }
+        if (log)
+            await api.addTranscriptStep(log);
+    }
+});
+//# sourceMappingURL=addTranscriptStep.js.map

package/build/shared/charts/descriptors/transcripts/getTranscript.js

@@ -0,0 +1,104 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GET_TRANSCRIPT = void 0;
+/* Custom modules */
+const createNodeDescriptor_1 = require("../../createNodeDescriptor");
+const transcripts_1 = require("../../../interfaces/transcripts/transcripts");
+/**
+ * Node name: 'getTranscript'
+ *
+ * Purpose:
+ * Get the transcript of the current session
+ * @param mode the mode in which the transcript should be read
+ * @param limit the number of entries to read
+ */
+exports.GET_TRANSCRIPT = (0, createNodeDescriptor_1.createNodeDescriptor)({
+    type: "getTranscript",
+    defaultLabel: "Get Transcript",
+    summary: "UI__NODE_EDITOR__GET_TRANSCRIPT__SUMMARY",
+    appearance: {
+        showIcon: false
+    },
+    fields: [
+        {
+            key: "limit",
+            type: "slider",
+            label: "UI__NODE_EDITOR__GET_TRANSCRIPT__FIELDS__LIMIT__LABEL",
+            description: "UI__NODE_EDITOR__GET_TRANSCRIPT__FIELDS__LIMIT__DESCRIPTION",
+            defaultValue: 25,
+            params: {
+                min: 0,
+                max: 50,
+                step: 1,
+            },
+        },
+        {
+            key: "storeLocation",
+            type: "select",
+            label: "UI__NODE_EDITOR__GET_TRANSCRIPT__FIELDS__STORE_LOCATION__LABEL",
+            params: {
+                options: [
+                    {
+                        label: "UI__NODE_EDITOR__GET_TRANSCRIPT__FIELDS__STORE_LOCATION__OPTIONS__INPUT",
+                        value: "input"
+                    },
+                    {
+                        label: "UI__NODE_EDITOR__GET_TRANSCRIPT__FIELDS__STORE_LOCATION__OPTIONS__CONTEXT",
+                        value: "context"
+                    }
+                ],
+            },
+            defaultValue: "input"
+        },
+        {
+            key: "inputKey",
+            type: "cognigyText",
+            label: "UI__NODE_EDITOR__GET_TRANSCRIPT__FIELDS__INPUT_KEY__LABEL",
+            defaultValue: "transcript",
+            condition: {
+                key: "storeLocation",
+                value: "input",
+            }
+        },
+        {
+            key: "contextKey",
+            type: "cognigyText",
+            label: "UI__NODE_EDITOR__GET_TRANSCRIPT__FIELDS__CONTEXT_KEY__LABEL",
+            defaultValue: "transcript",
+            condition: {
+                key: "storeLocation",
+                value: "context",
+            }
+        },
+    ],
+    sections: [
+        {
+            key: "storage",
+            label: "UI__NODE_EDITOR__GET_TRANSCRIPT__FIELDS__STORAGE__LABEL",
+            defaultCollapsed: true,
+            fields: [
+                "storeLocation",
+                "inputKey",
+                "contextKey",
+            ]
+        }
+    ],
+    form: [
+        { type: "field", key: "limit" },
+        { type: "section", key: "storage" },
+    ],
+    tags: ["service", "transcripts"],
+    function: async ({ cognigy, config }) => {
+        var _a;
+        const { limit, storeLocation, inputKey, contextKey } = config;
+        const { api } = cognigy;
+        const transcript = await api.getTranscript({ limit, excludeDataOnlyMessagesFilter: [transcripts_1.TranscriptRole.AGENT, transcripts_1.TranscriptRole.ASSISTANT] });
+        if (storeLocation === "context") {
+            (_a = api.addToContext) === null || _a === void 0 ? void 0 : _a.call(api, contextKey, transcript, "simple");
+        }
+        else {
+            api.addToInput(inputKey, transcript);
+        }
+    }
+});
+//# sourceMappingURL=getTranscript.js.map

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

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ADD_TRANSCRIPT_STEP = exports.GET_TRANSCRIPT = void 0;
+var getTranscript_1 = require("./getTranscript");
+Object.defineProperty(exports, "GET_TRANSCRIPT", { enumerable: true, get: function () { return getTranscript_1.GET_TRANSCRIPT; } });
+var addTranscriptStep_1 = require("./addTranscriptStep");
+Object.defineProperty(exports, "ADD_TRANSCRIPT_STEP", { enumerable: true, get: function () { return addTranscriptStep_1.ADD_TRANSCRIPT_STEP; } });
+//# sourceMappingURL=index.js.map

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

@@ -92,6 +92,26 @@ class BaseMapper {
             return false;
         }
     }
+    has(data) {
+        if (typeof data === "string") {
+            return data && data.length > 0;
+        }
+        else if (Array.isArray(data)) {
+            return data && data.length > 0;
+        }
+        else if (typeof data === "object") {
+            return data && Object.keys(data).length > 0;
+        }
+        else if (typeof data === "number") {
+            return data !== null;
+        }
+        else if (typeof data === "boolean") {
+            return data !== null;
+        }
+        else {
+            return false;
+        }
+    }
 }
 exports.BaseMapper = BaseMapper;
 //# sourceMappingURL=base.mapper.js.map