@cognigy/rest-api-client 0.13.2 → 0.15.0

package/build/shared/charts/descriptors/message/question/optionalQuestion.js

@@ -6,10 +6,11 @@ const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
 const evaluateQuestionAnswer_1 = require("./utils/evaluateQuestionAnswer");
 const say_1 = require("../say");
 const BaseContext_1 = require("../../../../helper/BaseContext");
+const getRephraseWithAIFields_1 = require("../../../helpers/generativeAI/getRephraseWithAIFields");
 exports.OPTIONAL_QUESTION = (0, createNodeDescriptor_1.createNodeDescriptor)({
     type: "optionalQuestion",
     defaultLabel: "Optional Question",
-    summary: "Ask a question and continues the Flow",
+    summary: "UI__NODE_EDITOR__MESSAGE__QUESTION__OPTIONAL_QUESTION__SUMMARY",
     behavior: {
         stopping: false,
         entrypoint: true
@@ -21,68 +22,68 @@ exports.OPTIONAL_QUESTION = (0, createNodeDescriptor_1.createNodeDescriptor)({
         {
             key: "type",
             type: "select",
-            label: "Question Type",
+            label: "UI__NODE_EDITOR__MESSAGE__QUESTION__OPTIONAL_QUESTION__FIELDS__TYPE__LABEL",
             params: {
                 required: true,
                 options: [
                     {
-                        label: "Yes / No",
+                        label: "UI__NODE_EDITOR__MESSAGE__QUESTION__OPTIONAL_QUESTION__FIELDS__TYPE__OPTIONS__YES_NO__LABEL",
                         value: "yesNo"
                     },
                     {
-                        label: "Intent",
+                        label: "UI__NODE_EDITOR__MESSAGE__QUESTION__OPTIONAL_QUESTION__FIELDS__TYPE__OPTIONS__INTENT__LABEL",
                         value: "intent"
                     },
                     {
-                        label: "Slot",
+                        label: "UI__NODE_EDITOR__MESSAGE__QUESTION__OPTIONAL_QUESTION__FIELDS__TYPE__OPTIONS__SLOT__LABEL",
                         value: "keyphrase",
                     },
                     {
-                        label: "Date",
+                        label: "UI__NODE_EDITOR__MESSAGE__QUESTION__OPTIONAL_QUESTION__FIELDS__TYPE__OPTIONS__DATE__LABEL",
                         value: "date",
                     },
                     {
-                        label: "Number",
+                        label: "UI__NODE_EDITOR__MESSAGE__QUESTION__OPTIONAL_QUESTION__FIELDS__TYPE__OPTIONS__NUMBER__LABEL",
                         value: "number",
                     },
                     {
-                        label: "Temperature",
+                        label: "UI__NODE_EDITOR__MESSAGE__QUESTION__OPTIONAL_QUESTION__FIELDS__TYPE__OPTIONS__TEMPERATURE__LABEL",
                         value: "temperature",
                     },
                     {
-                        label: "Age",
+                        label: "UI__NODE_EDITOR__MESSAGE__QUESTION__OPTIONAL_QUESTION__FIELDS__TYPE__OPTIONS__AGE__LABEL",
                         value: "age",
                     },
                     {
-                        label: "Url",
+                        label: "UI__NODE_EDITOR__MESSAGE__QUESTION__OPTIONAL_QUESTION__FIELDS__TYPE__OPTIONS__URL__LABEL",
                         value: "url"
                     },
                     {
-                        label: "Duration",
+                        label: "UI__NODE_EDITOR__MESSAGE__QUESTION__OPTIONAL_QUESTION__FIELDS__TYPE__OPTIONS__DURATION__LABEL",
                         value: "duration",
                     },
                     {
-                        label: "Email",
+                        label: "UI__NODE_EDITOR__MESSAGE__QUESTION__OPTIONAL_QUESTION__FIELDS__TYPE__OPTIONS__EMAIL__LABEL",
                         value: "email",
                     },
                     {
-                        label: "Money",
+                        label: "UI__NODE_EDITOR__MESSAGE__QUESTION__OPTIONAL_QUESTION__FIELDS__TYPE__OPTIONS__MONEY__LABEL",
                         value: "money"
                     },
                     {
-                        label: "Percentage",
+                        label: "UI__NODE_EDITOR__MESSAGE__QUESTION__OPTIONAL_QUESTION__FIELDS__TYPE__OPTIONS__PERCENTAGE__LABEL",
                         value: "percentage"
                     },
                     {
-                        label: "Regex",
+                        label: "UI__NODE_EDITOR__MESSAGE__QUESTION__OPTIONAL_QUESTION__FIELDS__TYPE__OPTIONS__REGEX__LABEL",
                         value: "regex",
                     },
-                    process.env.FEATURE_USE_COGNIGY_APPS && {
-                        label: "xApp",
+                    {
+                        label: "UI__NODE_EDITOR__MESSAGE__QUESTION__OPTIONAL_QUESTION__FIELDS__TYPE__OPTIONS__XAPP__LABEL",
                         value: "app",
                     },
                     {
-                        label: "Data",
+                        label: "UI__NODE_EDITOR__MESSAGE__QUESTION__OPTIONAL_QUESTION__FIELDS__TYPE__OPTIONS__DATA__LABEL",
                         value: "data",
                     },
                 ].filter(option => !!option),
@@ -92,7 +93,7 @@ exports.OPTIONAL_QUESTION = (0, createNodeDescriptor_1.createNodeDescriptor)({
         {
             key: "keyphraseTag",
             type: "cognigyText",
-            label: "Slot Name",
+            label: "UI__NODE_EDITOR__MESSAGE__QUESTION__OPTIONAL_QUESTION__FIELDS__KEY_PHRASE_TAG__LABEL",
             condition: {
                 key: "type",
                 value: "keyphrase"
@@ -101,7 +102,7 @@ exports.OPTIONAL_QUESTION = (0, createNodeDescriptor_1.createNodeDescriptor)({
         {
             key: "usePositiveOnly",
             type: "toggle",
-            label: "Use Positive Keyphrases Only",
+            label: "UI__NODE_EDITOR__MESSAGE__QUESTION__OPTIONAL_QUESTION__FIELDS__USE_POSITIVE_ONLY__LABEL",
             condition: {
                 key: "type",
                 value: "keyphrase"
@@ -110,7 +111,7 @@ exports.OPTIONAL_QUESTION = (0, createNodeDescriptor_1.createNodeDescriptor)({
         {
             key: "regex",
             type: "cognigyText",
-            label: "Regular Expression",
+            label: "UI__NODE_EDITOR__MESSAGE__QUESTION__OPTIONAL_QUESTION__FIELDS__REGEX__LABEL",
             condition: {
                 key: "type",
                 value: "regex"
@@ -119,7 +120,7 @@ exports.OPTIONAL_QUESTION = (0, createNodeDescriptor_1.createNodeDescriptor)({
         {
             key: "say",
             type: "say",
-            label: "Question",
+            label: "UI__NODE_EDITOR__MESSAGE__QUESTION__OPTIONAL_QUESTION__FIELDS__SAY__LABEL",
             defaultValue: {
                 data: "{}",
                 linear: false,
@@ -132,23 +133,23 @@ exports.OPTIONAL_QUESTION = (0, createNodeDescriptor_1.createNodeDescriptor)({
         {
             key: "retentionTime",
             type: "number",
-            label: "Forget Question Threshold",
+            label: "UI__NODE_EDITOR__MESSAGE__QUESTION__OPTIONAL_QUESTION__FIELDS__RETENTION_TIME__LABEL",
             defaultValue: 3
         },
         {
             key: "storeDetailedResults",
             type: "toggle",
-            label: "Store detailed Results"
+            label: "UI__NODE_EDITOR__MESSAGE__QUESTION__OPTIONAL_QUESTION__FIELDS__STORE_DETAILS_RESULT__LABEL"
         },
         {
             key: "storeResultInContext",
             type: "toggle",
-            label: "Store Result in Context"
+            label: "UI__NODE_EDITOR__MESSAGE__QUESTION__OPTIONAL_QUESTION__FIELDS__STORE_RESULT_IN_CONTEXT__LABEL"
         },
         {
             key: "contextKey",
             type: "text",
-            label: "Store Result in Context",
+            label: "UI__NODE_EDITOR__MESSAGE__QUESTION__OPTIONAL_QUESTION__FIELDS__CONTEXT_KEY__LABEL",
             condition: {
                 key: "storeResultInContext",
                 value: true
@@ -156,34 +157,58 @@ exports.OPTIONAL_QUESTION = (0, createNodeDescriptor_1.createNodeDescriptor)({
         },
         {
             key: "executeChildrenOnly",
-            label: "Stop Flow execution after Answer",
+            label: "UI__NODE_EDITOR__MESSAGE__QUESTION__OPTIONAL_QUESTION__FIELDS__EXECUTE_CHILDREN_ONLY__LABEL",
             type: "toggle",
             defaultValue: true
         },
         {
             key: "cognigyScript",
             type: "select",
-            label: "On which user input should we parse CognigyScript after Answer?",
+            label: "UI__NODE_EDITOR__MESSAGE__QUESTION__OPTIONAL_QUESTION__FIELDS__COGNIGY_SCRIPT__LABEL",
             params: {
                 required: true,
                 options: [
                     {
-                        label: "On the Answer input",
+                        label: "UI__NODE_EDITOR__MESSAGE__QUESTION__OPTIONAL_QUESTION__FIELDS__COGNIGY_SCRIPT__OPTIONS__ANSWER_LABEL",
                         value: "answer"
                     },
                     {
-                        label: "On the Question input",
+                        label: "UI__NODE_EDITOR__MESSAGE__QUESTION__OPTIONAL_QUESTION__FIELDS__COGNIGY_SCRIPT__OPTIONS__QUESTION_LABEL",
                         value: "question"
                     },
                 ]
             },
             defaultValue: "answer"
-        }
-    ],
+        },
+        {
+            key: "handoverOutput",
+            type: "select",
+            label: "UI__NODE_EDITOR__MESSAGE__QUESTION__OPTIONAL_QUESTION__FIELDS__HANDOVER_OUTPUT__LABEL",
+            description: "UI__NODE_EDITOR__MESSAGE__QUESTION__OPTIONAL_QUESTION__FIELDS__HANDOVER_OUTPUT__DESCRIPTION",
+            defaultValue: "userAndAgent",
+            params: {
+                options: [
+                    {
+                        label: "UI__NODE_EDITOR__MESSAGE__QUESTION__OPTIONAL_QUESTION__FIELDS__HANDOVER_OUTPUT__OPTIONS__USER_AND_AGENT__LABEL",
+                        value: "userAndAgent"
+                    },
+                    {
+                        label: "UI__NODE_EDITOR__MESSAGE__QUESTION__OPTIONAL_QUESTION__FIELDS__HANDOVER_OUTPUT__OPTIONS__USER_ONLY__LABEL",
+                        value: "userOnly"
+                    },
+                    {
+                        label: "UI__NODE_EDITOR__MESSAGE__QUESTION__OPTIONAL_QUESTION__FIELDS__HANDOVER_OUTPUT__OPTIONS__AGENT_ONLY__LABEL",
+                        value: "agentOnly"
+                    },
+                ],
+            },
+        },
+        ...(0, getRephraseWithAIFields_1.getRephraseWithAIFields)(),
+    ].filter(field => !!field),
     sections: [
         {
             key: "context",
-            label: "Result Storage",
+            label: "UI__NODE_EDITOR__MESSAGE__QUESTION__OPTIONAL_QUESTION__SECTIONS__CONTEXT__LABEL",
             defaultCollapsed: true,
             fields: [
                 "storeResultInContext",
@@ -193,7 +218,7 @@ exports.OPTIONAL_QUESTION = (0, createNodeDescriptor_1.createNodeDescriptor)({
         },
         {
             key: "advanced",
-            label: "Advanced",
+            label: "UI__NODE_EDITOR__MESSAGE__QUESTION__OPTIONAL_QUESTION__SECTIONS__ADVANCE__LABEL",
             defaultCollapsed: true,
             fields: [
                 "storeDetailedResults",
@@ -201,8 +226,17 @@ exports.OPTIONAL_QUESTION = (0, createNodeDescriptor_1.createNodeDescriptor)({
                 "retentionTime",
                 "cognigyScript"
             ]
-        }
-    ],
+        },
+        {
+            key: "handoverSettings",
+            label: "UI__NODE_EDITOR__MESSAGE__QUESTION__OPTIONAL_QUESTION__SECTIONS__HANDOVER_SETTINGS__LABEL",
+            defaultCollapsed: true,
+            fields: [
+                "handoverOutput",
+            ]
+        },
+        (0, getRephraseWithAIFields_1.getRephraseWithAISection)(),
+    ].filter(section => !!section),
     form: [
         { type: "field", key: "type" },
         { type: "field", key: "keyphraseTag" },
@@ -211,6 +245,8 @@ exports.OPTIONAL_QUESTION = (0, createNodeDescriptor_1.createNodeDescriptor)({
         { type: "field", key: "say" },
         { type: "section", key: "advanced" },
         { type: "section", key: "context" },
+        { type: "section", key: "aiEnhancedOutput" },
+        { type: "section", key: "handoverSettings" },
     ],
     preview: {
         key: "say",
@@ -224,8 +260,8 @@ exports.OPTIONAL_QUESTION = (0, createNodeDescriptor_1.createNodeDescriptor)({
         placement: {}
     },
     tags: ["basic", "message", "nlu"],
-    function: async ({ cognigy, config, childConfigs, nodeId }) => {
-        const { say, retentionTime = 3, type, executeChildrenOnly, cognigyScript, storeResultInContext, contextKey } = config;
+    function: async ({ cognigy, config, childConfigs, nodeId, organisationId, }) => {
+        const { say, retentionTime = 3, type, executeChildrenOnly, cognigyScript, storeResultInContext, contextKey, handoverOutput, } = config;
         const { regex: regexField } = config;
         const { keyphraseTag, usePositiveOnly } = config;
         const { api, input, context } = cognigy;
@@ -292,7 +328,19 @@ exports.OPTIONAL_QUESTION = (0, createNodeDescriptor_1.createNodeDescriptor)({
                 addConditionalEntrypointParams.cognigyScriptInput = input;
             }
             api.addConditionalEntrypoint(addConditionalEntrypointParams);
-            say_1.SAY.function({ cognigy, config: { say }, childConfigs: [], nodeId });
+            const rephraseWithAIParams = {
+                generativeAI_rephraseOutputMode: config.generativeAI_rephraseOutputMode,
+                generativeAI_temperature: config.generativeAI_temperature,
+                generativeAI_amountOfLastUserInputs: config.generativeAI_amountOfLastUserInputs,
+                generativeAI_customInputs: config.generativeAI_customInputs,
+                promtType: "question",
+                questionType: config.type,
+                question: undefined,
+                answer: undefined,
+            };
+            rephraseWithAIParams.promtType = "question";
+            rephraseWithAIParams.questionType = config.type;
+            await say_1.SAY.function({ cognigy, config: Object.assign({ handoverOutput, say }, rephraseWithAIParams), childConfigs: [], nodeId, organisationId });
             if (onQuestionChild) {
                 api.setNextNode(onQuestionChild.id);
             }