@cognigy/rest-api-client 0.17.0 → 0.19.0

package/build/shared/charts/descriptors/nlu/extractAnswer.js

@@ -1,115 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.EXTRACT_ANSWER = void 0;
-/* Custom modules */
-const createNodeDescriptor_1 = require("../../createNodeDescriptor");
-/**
- * Node name: 'extractAnswer'
- *
- * Purpose:
- * Answers a question based on a given context with the built-in question answering module
- */
-exports.EXTRACT_ANSWER = (0, createNodeDescriptor_1.createNodeDescriptor)({
-    type: "extractAnswer",
-    defaultLabel: "Extract Answer",
-    summary: "UI__NODE_EDITOR__NLU__EXTRACT_ANSWER__SUMMARY",
-    appearance: {
-        showIcon: false
-    },
-    fields: [
-        {
-            key: "text",
-            type: "cognigyText",
-            label: "UI__NODE_EDITOR__NLU__EXTRACT_ANSWER__FIELDS__TEXT__LABEL",
-            defaultValue: ""
-        },
-        {
-            key: "question",
-            type: "cognigyText",
-            label: "UI__NODE_EDITOR__NLU__EXTRACT_ANSWER__FIELDS__QUESTION__LABEL",
-            params: {
-                required: true
-            }
-        },
-        {
-            key: "storeLocation",
-            type: "select",
-            label: "UI__NODE_EDITOR__NLU__EXTRACT_ANSWER__FIELDS__STORE_LOCATION__LABEL",
-            params: {
-                options: [
-                    {
-                        label: "UI__NODE_EDITOR__NLU__EXTRACT_ANSWER__FIELDS__STORE_LOCATION__OPTIONS__INPUT__LABEL",
-                        value: "input"
-                    },
-                    {
-                        label: "UI__NODE_EDITOR__NLU__EXTRACT_ANSWER__FIELDS__STORE_LOCATION__OPTIONS__CONTEXT__LABEL",
-                        value: "context"
-                    }
-                ],
-                required: true
-            },
-            defaultValue: "input"
-        },
-        {
-            key: "inputKey",
-            type: "cognigyText",
-            label: "UI__NODE_EDITOR__NLU__EXTRACT_ANSWER__FIELDS__INPUT_KEY__LABEL",
-            description: "UI__NODE_EDITOR__NLU__EXTRACT_ANSWER__FIELDS__INPUT_KEY__DESCRIPTION",
-            defaultValue: "extractAnswer",
-            condition: {
-                key: "storeLocation",
-                value: "input"
-            }
-        },
-        {
-            key: "contextKey",
-            type: "cognigyText",
-            label: "UI__NODE_EDITOR__NLU__EXTRACT_ANSWER__FIELDS__CONETEXT_KEY__LABEL",
-            description: "UI__NODE_EDITOR__NLU__EXTRACT_ANSWER__FIELDS__CONETEXT_KEY__DESCRIPTION",
-            defaultValue: "extractAnswer",
-            condition: {
-                key: "storeLocation",
-                value: "context"
-            }
-        },
-    ],
-    sections: [
-        {
-            key: "storage",
-            label: "UI__NODE_EDITOR__NLU__EXTRACT_ANSWER__SECTIONS__STORAGE__LABEL",
-            defaultCollapsed: true,
-            fields: [
-                "storeLocation",
-                "inputKey",
-                "contextKey",
-            ]
-        },
-    ],
-    form: [
-        { type: "field", key: "text" },
-        { type: "field", key: "question" },
-        { type: "field", key: "maxTextLength" },
-        { type: "section", key: "storage" },
-    ],
-    preview: {
-        key: "text",
-        type: "text",
-    },
-    tags: ["nlu"],
-    function: async (extractAnswerParams) => {
-        const { cognigy, config } = extractAnswerParams;
-        const { api } = cognigy;
-        const { question, storeLocation, contextKey, inputKey } = config;
-        if (!question) {
-            throw new Error("Unable to answer question. Question is missing.");
-        }
-        if (storeLocation === "context" && !contextKey) {
-            throw new Error("Unable to answer question. Context Key is missing.");
-        }
-        if (storeLocation === "input" && !inputKey) {
-            throw new Error("Unable to answer question. Input Key is missing.");
-        }
-        return await api.extractAnswer(extractAnswerParams);
-    }
-});
-//# sourceMappingURL=extractAnswer.js.map

package/build/shared/interfaces/journeys/IJourney.js

@@ -1,83 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.journeyQuerySchema = exports.journeySchema = exports.journeyDataSchema = exports.journeyStepGoals = void 0;
-/* Custom Modules */
-const createQuerySchema_1 = require("../../helper/createQuerySchema");
-/* Interfaces & Types */
-const IEntityMeta_1 = require("../resources/IEntityMeta");
-exports.journeyStepGoals = [
-    "createAgent",
-    "createFlow",
-    "createEndpoint",
-    "createLexicon",
-    "createSnapshot",
-    "createKnowledgeStore",
-    "createKnowledgeSource",
-    "openWebchat",
-    "createCodeNode",
-    "createHttpRequestNode",
-    "createIfNode",
-    "createQuestionNode",
-    "createSayNode",
-    "createLookupNode",
-    "createKnowledgeSearchNode",
-    "createSearchExtractOutputNode",
-    "createGptConversationNode",
-    "createLlmPromptNode",
-    "updateCaseNode",
-    "updateHttpRequestNode",
-    "updateIfNode",
-    "updateQuestionNode",
-    "updateSayNode",
-    "createIntent",
-    "trainIntents",
-    "activateLexicon",
-    "useToken",
-    "addKeyphrase",
-    "expertModeOn",
-    "openContextTab",
-    "openInfoTab",
-    "openIP",
-    "sendMessage",
-    "prepareSnapshotDownload",
-    "restoreSnapshot",
-];
-exports.journeyDataSchema = {
-    title: "journeyDataSchema",
-    type: "object",
-    additionalProperties: false,
-    properties: {
-        name: { type: "string", minLength: 1, maxLength: 200 },
-        link: { type: "string", maxLength: 1000 },
-        summary: { type: "string", maxLength: 200 },
-        steps: {
-            type: "array",
-            additionalItems: false,
-            items: {
-                type: "object",
-                additionalProperties: false,
-                properties: {
-                    referenceId: { type: "string", format: "uuid" },
-                    name: { type: "string", minLength: 1, maxLength: 200 },
-                    link: { type: "string", maxLength: 1000 },
-                    summary: { type: "string", maxLength: 200 },
-                    description: { type: "string", maxLength: 10000 },
-                    goals: {
-                        type: "array",
-                        additionalItems: false,
-                        maxItems: 25,
-                        items: { type: "string", format: "journey-step-goal" }
-                    }
-                }
-            }
-        }
-    }
-};
-exports.journeySchema = {
-    title: "journeySchema",
-    type: "object",
-    additionalProperties: false,
-    properties: Object.assign(Object.assign({ referenceId: { type: "string", format: "uuid" } }, exports.journeyDataSchema.properties), IEntityMeta_1.entityMetaSchema.properties)
-};
-exports.journeyQuerySchema = (0, createQuerySchema_1.createQuerySchema)("journeyQuerySchema", exports.journeySchema);
-//# sourceMappingURL=IJourney.js.map

package/build/shared/interfaces/journeys/IJourneyProgress.js

@@ -1,40 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.journeyProgressSchema = exports.journeyProgressDataSchema = void 0;
-exports.journeyProgressDataSchema = {
-    title: "journeyProgressDataSchema",
-    type: "object",
-    additionalProperties: false,
-    properties: {
-        userReference: { type: "string", format: "mongo-id" },
-        organisationReference: { type: "string", format: "mongo-id" },
-        isCurrent: { type: "boolean" },
-        isComplete: { type: "boolean" },
-        journeyReferenceId: { type: "string", format: "uuid" },
-        journeySteps: {
-            type: "array",
-            additionalItems: false,
-            items: {
-                type: "object",
-                additionalProperties: false,
-                properties: {
-                    journeyStepReferenceId: { type: "string", format: "uuid" },
-                    isComplete: { type: "boolean" },
-                    completedGoals: {
-                        type: "array",
-                        additionalItems: false,
-                        maxItems: 25,
-                        items: { type: "string", format: "journey-step-goal" }
-                    }
-                }
-            }
-        }
-    }
-};
-exports.journeyProgressSchema = {
-    title: "journeyProgressSchema",
-    type: "object",
-    additionalProperties: false,
-    properties: Object.assign({}, exports.journeyProgressDataSchema.properties)
-};
-//# sourceMappingURL=IJourneyProgress.js.map

package/build/shared/interfaces/journeys/IJourneyTrackEvent.js

@@ -1,35 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.trackableJourneyEvent = void 0;
-exports.trackableJourneyEvent = [
-    /* resources */
-    "createAgent",
-    "createFlow",
-    "createEndpoint",
-    "createLexicon",
-    "createSnapshot",
-    "createKnowledgeStore",
-    "createKnowledgeSource",
-    /* endpoint editor */
-    "openWebchat",
-    /* flow chart */
-    "createNode",
-    "updateNode",
-    /* flow editor other */
-    "createIntent",
-    "trainIntents",
-    "activateLexicon",
-    "useToken",
-    /* lexicon editor */
-    "addKeyphrase",
-    /* interaction panel (ui) */
-    "expertModeOn",
-    "openContextTab",
-    "openInfoTab",
-    "openIP",
-    "sendMessage",
-    /* snapshots */
-    "prepareSnapshotDownload",
-    "restoreSnapshot"
-];
-//# sourceMappingURL=IJourneyTrackEvent.js.map

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

@@ -1,14 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.journeyProgressSchema = exports.journeyProgressDataSchema = exports.journeyStepGoals = exports.journeySchema = exports.journeyQuerySchema = exports.journeyDataSchema = exports.trackableJourneyEvent = void 0;
-var IJourneyTrackEvent_1 = require("./IJourneyTrackEvent");
-Object.defineProperty(exports, "trackableJourneyEvent", { enumerable: true, get: function () { return IJourneyTrackEvent_1.trackableJourneyEvent; } });
-var IJourney_1 = require("./IJourney");
-Object.defineProperty(exports, "journeyDataSchema", { enumerable: true, get: function () { return IJourney_1.journeyDataSchema; } });
-Object.defineProperty(exports, "journeyQuerySchema", { enumerable: true, get: function () { return IJourney_1.journeyQuerySchema; } });
-Object.defineProperty(exports, "journeySchema", { enumerable: true, get: function () { return IJourney_1.journeySchema; } });
-Object.defineProperty(exports, "journeyStepGoals", { enumerable: true, get: function () { return IJourney_1.journeyStepGoals; } });
-var IJourneyProgress_1 = require("./IJourneyProgress");
-Object.defineProperty(exports, "journeyProgressDataSchema", { enumerable: true, get: function () { return IJourneyProgress_1.journeyProgressDataSchema; } });
-Object.defineProperty(exports, "journeyProgressSchema", { enumerable: true, get: function () { return IJourneyProgress_1.journeyProgressSchema; } });
-//# sourceMappingURL=index.js.map

package/build/shared/interfaces/restAPI/resources/journey/v2.0/IJourneyTrackEvents_2_0.js

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

package/build/shared/interfaces/restAPI/resources/journey/v2.0/IReadJourneyProgressRest_2_0.js

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

package/build/shared/interfaces/restAPI/resources/journey/v2.0/IReadJourneyRest_2_0.js

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

package/build/shared/interfaces/restAPI/resources/journey/v2.0/ITrackJourneyEventRest_2_0.js

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

package/build/shared/interfaces/restAPI/resources/journey/v2.0/IUpdateSelectedJourneyRest_2_0.js

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