@cognigy/rest-api-client 2025.12.0 → 2025.14.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (75) hide show
  1. package/CHANGELOG.md +10 -0
  2. package/build/apigroups/ResourcesAPIGroup_2_0.js +8 -1
  3. package/build/apigroups/SimulationAPIGroup_2_0.js +4 -1
  4. package/build/shared/charts/descriptors/analytics/trackGoal.js +3 -1
  5. package/build/shared/charts/descriptors/connectionNodes/internalStorageProviders/amazonStorageProviderConnection.js +7 -1
  6. package/build/shared/charts/descriptors/index.js +5 -0
  7. package/build/shared/charts/descriptors/knowledgeSearch/searchExtractOutput.js +10 -6
  8. package/build/shared/charts/descriptors/message/question/question.js +12 -1
  9. package/build/shared/charts/descriptors/nlu/generativeSlotFiller/prompt.js +11 -3
  10. package/build/shared/charts/descriptors/service/GPTPrompt.js +21 -1
  11. package/build/shared/charts/descriptors/service/aiAgent/aiAgentJob.js +71 -175
  12. package/build/shared/charts/descriptors/service/aiAgent/aiAgentJobTool.js +2 -2
  13. package/build/shared/charts/descriptors/service/aiAgent/helpers/createToolDefinitions.js +175 -0
  14. package/build/shared/charts/descriptors/service/aiAgent/loadAiAgent.js +194 -0
  15. package/build/shared/charts/descriptors/service/handoverV2.js +1 -1
  16. package/build/shared/charts/descriptors/service/index.js +11 -1
  17. package/build/shared/charts/descriptors/service/llmPrompt/LLMPromptV2.js +959 -0
  18. package/build/shared/charts/descriptors/service/llmPrompt/llmPromptDefault.js +31 -0
  19. package/build/shared/charts/descriptors/service/llmPrompt/llmPromptMCPTool.js +196 -0
  20. package/build/shared/charts/descriptors/service/llmPrompt/llmPromptTool.js +139 -0
  21. package/build/shared/constants.js +1 -5
  22. package/build/shared/interfaces/debugEvents/IGoalCompletedEventPayload.js +3 -0
  23. package/build/shared/interfaces/debugEvents/TDebugEventType.js +1 -0
  24. package/build/shared/interfaces/generativeAI/IGenerativeAIModels.js +12 -1
  25. package/build/shared/interfaces/messageAPI/handover.js +6 -0
  26. package/build/shared/interfaces/resources/ISimulation.js +9 -0
  27. package/build/shared/interfaces/resources/TResourceType.js +3 -0
  28. package/build/shared/interfaces/resources/knowledgeStore/IKnowledgeChunk.js +2 -1
  29. package/build/shared/interfaces/resources/settings/IGenerativeAISettings.js +5 -18
  30. package/build/shared/interfaces/restAPI/operations/generateOutput/v2.0/index.js +3 -0
  31. package/build/shared/interfaces/restAPI/resources/chart/v2.0/IReadFlowChartAiAgentsRest_2_0.js +3 -0
  32. package/build/shared/interfaces/restAPI/simulation/persona/IGeneratePersonaRest_2_0.js +3 -0
  33. package/build/shared/interfaces/restAPI/simulation/persona/IGetPersonaOptionsRest_2_0.js +3 -0
  34. package/build/shared/interfaces/restAPI/simulation/persona/IRegeneratePersonaFieldRest_2_0.js +3 -0
  35. package/build/shared/interfaces/security/IPermission.js +4 -0
  36. package/build/shared/interfaces/security/IRole.js +5 -1
  37. package/build/shared/interfaces/security/index.js +1 -1
  38. package/dist/esm/apigroups/ResourcesAPIGroup_2_0.js +8 -1
  39. package/dist/esm/apigroups/SimulationAPIGroup_2_0.js +4 -1
  40. package/dist/esm/shared/charts/descriptors/analytics/trackGoal.js +3 -1
  41. package/dist/esm/shared/charts/descriptors/connectionNodes/internalStorageProviders/amazonStorageProviderConnection.js +7 -1
  42. package/dist/esm/shared/charts/descriptors/index.js +6 -1
  43. package/dist/esm/shared/charts/descriptors/knowledgeSearch/searchExtractOutput.js +10 -6
  44. package/dist/esm/shared/charts/descriptors/message/question/question.js +12 -1
  45. package/dist/esm/shared/charts/descriptors/nlu/generativeSlotFiller/prompt.js +11 -3
  46. package/dist/esm/shared/charts/descriptors/service/GPTPrompt.js +21 -1
  47. package/dist/esm/shared/charts/descriptors/service/aiAgent/aiAgentJob.js +72 -176
  48. package/dist/esm/shared/charts/descriptors/service/aiAgent/aiAgentJobTool.js +2 -2
  49. package/dist/esm/shared/charts/descriptors/service/aiAgent/helpers/createToolDefinitions.js +172 -0
  50. package/dist/esm/shared/charts/descriptors/service/aiAgent/loadAiAgent.js +192 -0
  51. package/dist/esm/shared/charts/descriptors/service/handoverV2.js +1 -1
  52. package/dist/esm/shared/charts/descriptors/service/index.js +5 -0
  53. package/dist/esm/shared/charts/descriptors/service/llmPrompt/LLMPromptV2.js +946 -0
  54. package/dist/esm/shared/charts/descriptors/service/llmPrompt/llmPromptDefault.js +28 -0
  55. package/dist/esm/shared/charts/descriptors/service/llmPrompt/llmPromptMCPTool.js +193 -0
  56. package/dist/esm/shared/charts/descriptors/service/llmPrompt/llmPromptTool.js +136 -0
  57. package/dist/esm/shared/constants.js +1 -5
  58. package/dist/esm/shared/interfaces/debugEvents/IGoalCompletedEventPayload.js +2 -0
  59. package/dist/esm/shared/interfaces/debugEvents/TDebugEventType.js +1 -0
  60. package/dist/esm/shared/interfaces/generativeAI/IGenerativeAIModels.js +12 -1
  61. package/dist/esm/shared/interfaces/messageAPI/handover.js +6 -0
  62. package/dist/esm/shared/interfaces/resources/ISimulation.js +6 -0
  63. package/dist/esm/shared/interfaces/resources/TResourceType.js +3 -0
  64. package/dist/esm/shared/interfaces/resources/knowledgeStore/IKnowledgeChunk.js +2 -1
  65. package/dist/esm/shared/interfaces/resources/settings/IGenerativeAISettings.js +4 -17
  66. package/dist/esm/shared/interfaces/restAPI/operations/generateOutput/v2.0/index.js +2 -0
  67. package/dist/esm/shared/interfaces/restAPI/resources/chart/v2.0/IReadFlowChartAiAgentsRest_2_0.js +2 -0
  68. package/dist/esm/shared/interfaces/restAPI/simulation/persona/IGeneratePersonaRest_2_0.js +2 -0
  69. package/dist/esm/shared/interfaces/restAPI/simulation/persona/IGetPersonaOptionsRest_2_0.js +2 -0
  70. package/dist/esm/shared/interfaces/restAPI/simulation/persona/IRegeneratePersonaFieldRest_2_0.js +2 -0
  71. package/dist/esm/shared/interfaces/security/IPermission.js +4 -0
  72. package/dist/esm/shared/interfaces/security/IRole.js +5 -1
  73. package/dist/esm/shared/interfaces/security/index.js +1 -1
  74. package/package.json +1 -1
  75. package/types/index.d.ts +2093 -1927
@@ -0,0 +1,194 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.LOAD_AI_AGENT = void 0;
4
+ /* Custom modules */
5
+ const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
6
+ /**
7
+ * Node name: 'loadAiAigent'
8
+ *
9
+ * Purpose:
10
+ * Loads the AI Agent configuration and stores it to context/input.
11
+ */
12
+ exports.LOAD_AI_AGENT = (0, createNodeDescriptor_1.createNodeDescriptor)({
13
+ type: "loadAiAigent",
14
+ defaultLabel: "Load AI Agent",
15
+ summary: "UI__NODE_EDITOR__LOAD_AI_AGENT__SUMMARY",
16
+ appearance: {
17
+ showIcon: false
18
+ },
19
+ fields: [
20
+ {
21
+ key: "aiAgent",
22
+ type: "aiAgentSelect",
23
+ label: "UI__NODE_EDITOR__LOAD_AI_AGENT__AI_AGENT_SELECTOR__LABEL",
24
+ description: "UI__NODE_EDITOR__AI_AGENT__AI_AGENT_SELECTOR__DESCRIPTION",
25
+ params: {
26
+ required: true
27
+ },
28
+ },
29
+ {
30
+ key: "storeLocation",
31
+ type: "select",
32
+ label: "UI__NODE_EDITOR__LOAD_AI_AGENT__FIELDS__STORE_LOCATION__LABEL",
33
+ description: "UI__NODE_EDITOR__LOAD_AI_AGENT__FIELDS__STORE_LOCATION__DESCRIPTION",
34
+ defaultValue: "context",
35
+ params: {
36
+ options: [
37
+ {
38
+ label: "UI__NODE_EDITOR__LOAD_AI_AGENT__FIELDS__STORE_LOCATION__OPTIONS__INPUT__LABEL",
39
+ value: "input"
40
+ },
41
+ {
42
+ label: "UI__NODE_EDITOR__LOAD_AI_AGENT__FIELDS__STORE_LOCATION__OPTIONS__CONTEXT__LABEL",
43
+ value: "context"
44
+ }
45
+ ],
46
+ required: true
47
+ },
48
+ },
49
+ {
50
+ key: "inputKey",
51
+ type: "cognigyText",
52
+ label: "UI__NODE_EDITOR__LOAD_AI_AGENT__FIELDS__INPUT_KEY__LABEL",
53
+ description: "UI__NODE_EDITOR__LOAD_AI_AGENT__FIELDS__INPUT_KEY__DESCRIPTION",
54
+ defaultValue: "aiAgentConfiguration",
55
+ condition: {
56
+ or: [
57
+ {
58
+ key: "storeLocation",
59
+ value: "input",
60
+ }
61
+ ]
62
+ }
63
+ },
64
+ {
65
+ key: "contextKey",
66
+ type: "cognigyText",
67
+ label: "UI__NODE_EDITOR__LOAD_AI_AGENT__FIELDS__CONTEXT_KEY__LABEL",
68
+ description: "UI__NODE_EDITOR__LOAD_AI_AGENT__FIELDS__CONTEXT_KEY__DESCRIPTION",
69
+ defaultValue: "aiAgentConfiguration",
70
+ condition: {
71
+ key: "storeLocation",
72
+ value: "context",
73
+ }
74
+ },
75
+ {
76
+ key: "keyWarning",
77
+ type: "description",
78
+ label: " ",
79
+ params: {
80
+ text: "UI__NODE_EDITOR__LOAD_AI_AGENT__FIELDS__KEY_WARNING__TEXT"
81
+ },
82
+ condition: {
83
+ or: [
84
+ {
85
+ and: [
86
+ {
87
+ key: "storeLocation",
88
+ value: "input",
89
+ },
90
+ {
91
+ key: "inputKey",
92
+ value: "aiAgentConfiguration",
93
+ negate: true
94
+ }
95
+ ]
96
+ },
97
+ {
98
+ and: [
99
+ {
100
+ key: "storeLocation",
101
+ value: "context",
102
+ },
103
+ {
104
+ key: "contextKey",
105
+ value: "aiAgentConfiguration",
106
+ negate: true
107
+ }
108
+ ]
109
+ }
110
+ ]
111
+ }
112
+ }
113
+ ],
114
+ preview: {
115
+ key: "storeLocation",
116
+ type: "text",
117
+ },
118
+ form: [
119
+ { type: "field", key: "aiAgent" },
120
+ { type: "field", key: "storeLocation" },
121
+ { type: "field", key: "inputKey" },
122
+ { type: "field", key: "contextKey" },
123
+ { type: "field", key: "keyWarning" }
124
+ ],
125
+ tags: ["ai", "aiagent", "llm"],
126
+ tokens: [
127
+ {
128
+ label: "AI Agent Reference ID",
129
+ type: "input",
130
+ script: "(input.aiAgentConfiguration || context.aiAgentConfiguration)?.referenceId",
131
+ },
132
+ {
133
+ label: "AI Agent Name",
134
+ type: "input",
135
+ script: "(input.aiAgentConfiguration || context.aiAgentConfiguration)?.name",
136
+ },
137
+ {
138
+ label: "AI Agent Description",
139
+ type: "input",
140
+ script: "(input.aiAgentConfiguration || context.aiAgentConfiguration)?.description",
141
+ },
142
+ {
143
+ label: "AI Agent Instructions",
144
+ type: "input",
145
+ script: "(input.aiAgentConfiguration || context.aiAgentConfiguration)?.instructions",
146
+ },
147
+ {
148
+ label: "AI Agent Image URL",
149
+ type: "input",
150
+ script: "(input.aiAgentConfiguration || context.aiAgentConfiguration)?.image",
151
+ },
152
+ {
153
+ label: "AI Agent Knowledge Store ID",
154
+ type: "input",
155
+ script: "(input.aiAgentConfiguration || context.aiAgentConfiguration)?.knowledgeReferenceId",
156
+ },
157
+ ],
158
+ function: async ({ cognigy, config }) => {
159
+ const { api } = cognigy;
160
+ const { aiAgent, storeLocation, contextKey, inputKey } = config;
161
+ if (storeLocation === "input" && !inputKey) {
162
+ throw new Error("Unable to add value to input. No input key was defined.");
163
+ }
164
+ if (storeLocation === "context" && !contextKey) {
165
+ throw new Error("Unable to add value to context. No context key was defined.");
166
+ }
167
+ if (!aiAgent) {
168
+ throw new Error("Unable to load AI Agent values. No AI agent was defined.");
169
+ }
170
+ const aiAgentData = {
171
+ referenceId: aiAgent.referenceId,
172
+ name: aiAgent.name,
173
+ description: aiAgent.description,
174
+ instructions: aiAgent.instructions,
175
+ image: aiAgent.image,
176
+ speakingStyle: aiAgent.speakingStyle,
177
+ safetySettings: aiAgent.safetySettings,
178
+ contactProfilesOption: aiAgent.contactProfilesOption,
179
+ contactProfilesSelected: aiAgent.contactProfilesSelected,
180
+ knowledgeReferenceId: aiAgent.knowledgeReferenceId,
181
+ enableVoiceConfigs: aiAgent.enableVoiceConfigs,
182
+ voiceConfigs: aiAgent.voiceConfigs,
183
+ };
184
+ switch (storeLocation) {
185
+ case "context":
186
+ // @ts-ignore
187
+ api.addToContext(contextKey, aiAgentData, "simple");
188
+ break;
189
+ default:
190
+ api.addToInput(inputKey, aiAgentData);
191
+ }
192
+ }
193
+ });
194
+ //# sourceMappingURL=loadAiAgent.js.map
@@ -86,7 +86,7 @@ exports.HANDOVER_V2 = (0, createNodeDescriptor_1.createNodeDescriptor)({
86
86
  label: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__FIELDS__HANDOVER_PROVIDER__LABEL",
87
87
  type: "json",
88
88
  description: "UI__NODE_EDITOR__SERVICE__HANDOVER_TO_AGENT__FIELDS__HANDOVER_PROVIDER__DESCRIPTION",
89
- defaultValue: {},
89
+ defaultValue: { liveAgentPriority: "none" },
90
90
  params: {
91
91
  required: true,
92
92
  },
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.AIOPS_CENTER_WEBHOOKS_CONNECTION = exports.NICECXONEAAH_AUTHENTICATION_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.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.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;
3
+ exports.AIOPS_CENTER_WEBHOOKS_CONNECTION = exports.NICECXONEAAH_AUTHENTICATION_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.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;
4
4
  var handover_1 = require("./handover");
5
5
  Object.defineProperty(exports, "HANDOVER", { enumerable: true, get: function () { return handover_1.HANDOVER; } });
6
6
  var handoverV2_1 = require("./handoverV2");
@@ -25,6 +25,14 @@ var onSchedulingError_1 = require("./triggerFunction/onSchedulingError");
25
25
  Object.defineProperty(exports, "ON_SCHEDULING_ERROR", { enumerable: true, get: function () { return onSchedulingError_1.ON_SCHEDULING_ERROR; } });
26
26
  var GPTPrompt_1 = require("./GPTPrompt");
27
27
  Object.defineProperty(exports, "GPT_PROMPT", { enumerable: true, get: function () { return GPTPrompt_1.GPT_PROMPT; } });
28
+ var LLMPromptV2_1 = require("./llmPrompt/LLMPromptV2");
29
+ Object.defineProperty(exports, "LLM_PROMPT_V2", { enumerable: true, get: function () { return LLMPromptV2_1.LLM_PROMPT_V2; } });
30
+ var llmPromptDefault_1 = require("./llmPrompt/llmPromptDefault");
31
+ Object.defineProperty(exports, "LLM_PROMPT_DEFAULT", { enumerable: true, get: function () { return llmPromptDefault_1.LLM_PROMPT_DEFAULT; } });
32
+ var llmPromptMCPTool_1 = require("./llmPrompt/llmPromptMCPTool");
33
+ Object.defineProperty(exports, "LLM_PROMPT_MCP_TOOL", { enumerable: true, get: function () { return llmPromptMCPTool_1.LLM_PROMPT_MCP_TOOL; } });
34
+ var llmPromptTool_1 = require("./llmPrompt/llmPromptTool");
35
+ Object.defineProperty(exports, "LLM_PROMPT_TOOL", { enumerable: true, get: function () { return llmPromptTool_1.LLM_PROMPT_TOOL; } });
28
36
  var closeHandover_1 = require("./closeHandover");
29
37
  Object.defineProperty(exports, "CLOSE_HANDOVER", { enumerable: true, get: function () { return closeHandover_1.CLOSE_HANDOVER; } });
30
38
  var handoverInactivityTimer_1 = require("./handoverInactivityTimer");
@@ -51,6 +59,8 @@ var aiAgentHandover_1 = require("./aiAgent/aiAgentHandover");
51
59
  Object.defineProperty(exports, "AI_AGENT_HANDOVER", { enumerable: true, get: function () { return aiAgentHandover_1.AI_AGENT_HANDOVER; } });
52
60
  var aiAgentJobCallMCPTool_1 = require("./aiAgent/aiAgentJobCallMCPTool");
53
61
  Object.defineProperty(exports, "AI_AGENT_JOB_CALL_MCP_TOOL", { enumerable: true, get: function () { return aiAgentJobCallMCPTool_1.AI_AGENT_JOB_CALL_MCP_TOOL; } });
62
+ var loadAiAgent_1 = require("./aiAgent/loadAiAgent");
63
+ Object.defineProperty(exports, "LOAD_AI_AGENT", { enumerable: true, get: function () { return loadAiAgent_1.LOAD_AI_AGENT; } });
54
64
  var handoverConnections_1 = require("./handoverConnections");
55
65
  Object.defineProperty(exports, "LIVE_AGENT_CONNECTION", { enumerable: true, get: function () { return handoverConnections_1.LIVE_AGENT_CONNECTION; } });
56
66
  Object.defineProperty(exports, "RINGCENTRAL_ENGAGE_CONNECTION", { enumerable: true, get: function () { return handoverConnections_1.RINGCENTRAL_ENGAGE_CONNECTION; } });