@cognigy/rest-api-client 0.18.0 → 0.19.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 (136) hide show
  1. package/CHANGELOG.md +6 -0
  2. package/build/apigroups/AdministrationAPIGroup_2_0.js +3 -1
  3. package/build/apigroups/MetricsAPIGroup_2_0.js +5 -0
  4. package/build/apigroups/ResourcesAPIGroup_2_0.js +9 -6
  5. package/build/shared/charts/descriptors/agentAssist/helpers/determineMetadata.js +15 -0
  6. package/build/shared/charts/descriptors/agentAssist/helpers/knowledgeSearch/answerExtraction.helper.js +1 -1
  7. package/build/shared/charts/descriptors/agentAssist/helpers/knowledgeSearch/followUpDetection.helper.js +2 -2
  8. package/build/shared/charts/descriptors/agentAssist/identityAssist.js +1 -1
  9. package/build/shared/charts/descriptors/agentAssist/knowledgeAssist.js +1 -1
  10. package/build/shared/charts/descriptors/agentAssist/nextActionAssist.js +4 -5
  11. package/build/shared/charts/descriptors/agentAssist/sentimentAssist.js +1 -1
  12. package/build/shared/charts/descriptors/agentAssist/setAdaptiveCardTile.js +2 -0
  13. package/build/shared/charts/descriptors/agentAssist/setAgentAssistGrid.js +2 -1
  14. package/build/shared/charts/descriptors/agentAssist/setHtmlTile.js +5 -3
  15. package/build/shared/charts/descriptors/agentAssist/setIframeTile.js +5 -3
  16. package/build/shared/charts/descriptors/agentAssist/setSecureFormsTile.js +2 -2
  17. package/build/shared/charts/descriptors/agentAssist/transcriptAssist.js +2 -1
  18. package/build/shared/charts/descriptors/analytics/activateProfile.js +1 -0
  19. package/build/shared/charts/descriptors/analytics/blindMode.js +2 -0
  20. package/build/shared/charts/descriptors/analytics/completeGoal.js +1 -0
  21. package/build/shared/charts/descriptors/analytics/deactivateProfile.js +1 -0
  22. package/build/shared/charts/descriptors/analytics/deleteProfile.js +1 -0
  23. package/build/shared/charts/descriptors/analytics/index.js +3 -1
  24. package/build/shared/charts/descriptors/analytics/mergeProfile.js +1 -0
  25. package/build/shared/charts/descriptors/analytics/overwriteAnalytics.js +9 -0
  26. package/build/shared/charts/descriptors/analytics/setRating.js +4 -2
  27. package/build/shared/charts/descriptors/analytics/trackMilestone.js +95 -0
  28. package/build/shared/charts/descriptors/analytics/updateProfile.js +1 -0
  29. package/build/shared/charts/descriptors/apps/initAppSession.js +1 -0
  30. package/build/shared/charts/descriptors/apps/setAdaptiveCardAppState.js +35 -10
  31. package/build/shared/charts/descriptors/apps/setHtmlAppState.js +25 -2
  32. package/build/shared/charts/descriptors/apps/utils/getXAppsOverlaySettings.js +54 -0
  33. package/build/shared/charts/descriptors/connectionNodes/documentParserProviders/azureAIDocumentIntelligenceConnection.js +12 -0
  34. package/build/shared/charts/descriptors/connectionNodes/documentParserProviders/index.js +13 -0
  35. package/build/shared/charts/descriptors/connectionNodes/generativeAIProviders/awsBedrockProviderConnection.js +12 -0
  36. package/build/shared/charts/descriptors/connectionNodes/generativeAIProviders/azureOpenAIProviderConnection.js +4 -3
  37. package/build/shared/charts/descriptors/connectionNodes/generativeAIProviders/azureOpenAIProviderConnectionV2.js +3 -3
  38. package/build/shared/charts/descriptors/connectionNodes/generativeAIProviders/azureOpenAIProviderOauth2Connection.js +14 -0
  39. package/build/shared/charts/descriptors/connectionNodes/generativeAIProviders/index.js +16 -8
  40. package/build/shared/charts/descriptors/connectionNodes/generativeAIProviders/openAIProviderConnection.js +3 -3
  41. package/build/shared/charts/descriptors/data/addToContext.js +7 -0
  42. package/build/shared/charts/descriptors/data/copyDataToContext.js +3 -0
  43. package/build/shared/charts/descriptors/data/copySlotsToContext.js +3 -0
  44. package/build/shared/charts/descriptors/data/debugMessage.js +73 -0
  45. package/build/shared/charts/descriptors/data/index.js +3 -1
  46. package/build/shared/charts/descriptors/data/removeFromContext.js +9 -1
  47. package/build/shared/charts/descriptors/data/resetContext.js +1 -0
  48. package/build/shared/charts/descriptors/index.js +7 -1
  49. package/build/shared/charts/descriptors/knowledgeSearch/searchExtractOutput.js +35 -10
  50. package/build/shared/charts/descriptors/logic/resetState.js +1 -0
  51. package/build/shared/charts/descriptors/logic/setState.js +2 -1
  52. package/build/shared/charts/descriptors/logic/setTranslation.js +3 -1
  53. package/build/shared/charts/descriptors/logic/switchLocale.js +1 -0
  54. package/build/shared/charts/descriptors/logic/think.js +3 -1
  55. package/build/shared/charts/descriptors/logic/thinkV2.js +2 -0
  56. package/build/shared/charts/descriptors/message/question/question.js +50 -5
  57. package/build/shared/charts/descriptors/message/question/utils/validateQuestionAnswer.js +4 -2
  58. package/build/shared/charts/descriptors/nlu/cleanText.js +1 -0
  59. package/build/shared/charts/descriptors/nlu/fuzzySearch.js +23 -1
  60. package/build/shared/charts/descriptors/nlu/generativeSlotFiller/prompt.js +19 -9
  61. package/build/shared/charts/descriptors/service/GPTPrompt.js +59 -24
  62. package/build/shared/charts/descriptors/service/LLMEntityExtract.js +11 -2
  63. package/build/shared/charts/descriptors/service/handoverV2.js +84 -1
  64. package/build/shared/charts/descriptors/service/httpRequest.js +35 -2
  65. package/build/shared/charts/descriptors/voice/mappers/setSessionConfig.mapper.js +96 -17
  66. package/build/shared/charts/descriptors/voice/nodes/bargeIn.js +2 -0
  67. package/build/shared/charts/descriptors/voice/nodes/continuousAsr.js +2 -0
  68. package/build/shared/charts/descriptors/voice/nodes/dtmf.js +2 -0
  69. package/build/shared/charts/descriptors/voice/nodes/muteSpeechInput.js +1 -0
  70. package/build/shared/charts/descriptors/voice/nodes/noUserInput.js +2 -0
  71. package/build/shared/charts/descriptors/voice/nodes/sessionSpeechParameters.js +2 -0
  72. package/build/shared/charts/descriptors/voice/nodes/transfer.js +2 -0
  73. package/build/shared/charts/descriptors/voicegateway2/nodes/dtmf.js +2 -0
  74. package/build/shared/charts/descriptors/voicegateway2/nodes/hangup.js +2 -0
  75. package/build/shared/charts/descriptors/voicegateway2/nodes/muteSpeechInput.js +3 -0
  76. package/build/shared/charts/descriptors/voicegateway2/nodes/play.js +1 -0
  77. package/build/shared/charts/descriptors/voicegateway2/nodes/record.js +1 -0
  78. package/build/shared/charts/descriptors/voicegateway2/nodes/refer.js +1 -0
  79. package/build/shared/charts/descriptors/voicegateway2/nodes/sendMetadata.js +1 -0
  80. package/build/shared/charts/descriptors/voicegateway2/nodes/setSessionConfig.js +298 -8
  81. package/build/shared/charts/descriptors/voicegateway2/nodes/transfer.js +10 -6
  82. package/build/shared/charts/descriptors/voicegateway2/utils/helper.js +2 -2
  83. package/build/shared/charts/helpers/generativeAI/rephraseSentenceWithAi.js +4 -2
  84. package/build/shared/constants.js +10 -1
  85. package/build/shared/handoverClients/interfaces/THandoverEventType.js +1 -0
  86. package/build/shared/helper/logFullConfigToDebugMode.js +30 -0
  87. package/build/shared/helper/nlu/textCleaner.js +3 -1
  88. package/build/shared/interfaces/IOrganisation.js +1 -0
  89. package/build/shared/interfaces/IProfile.js +1 -0
  90. package/build/shared/interfaces/IProfileSchema.js +3 -0
  91. package/build/shared/interfaces/analytics/IAnalyticsSourceData.js +20 -20
  92. package/build/shared/interfaces/{restAPI/resources/journey/v2.0/IJourneyStep_2_0.js → analytics/IMilestoneAnalytics.js} +1 -1
  93. package/build/shared/interfaces/{restAPI/resources/journey/v2.0/IJourneyProgress_2_0.js → appsession/ISetAppStateOptions.js} +1 -1
  94. package/build/shared/interfaces/{restAPI/resources/journey/v2.0/IJourneyIndexItem_2_0.js → appsession/ISetAppStateOverlaySettings.js} +1 -1
  95. package/build/shared/interfaces/appsession/ISetAppStateOverlaySettingsMetaData.js +3 -0
  96. package/build/shared/interfaces/{restAPI/resources/journey/v2.0/IIndexJourneysRest_2_0.js → debugEvents/TDebugEventMessagePayload.js} +1 -1
  97. package/build/shared/interfaces/debugEvents/TDebugEventType.js +2 -0
  98. package/build/shared/interfaces/generativeAI/IGenerativeAIModels.js +33 -69
  99. package/build/shared/interfaces/handover.js +42 -1
  100. package/build/shared/interfaces/license.js +3 -2
  101. package/build/shared/interfaces/license.js.map +1 -1
  102. package/build/shared/interfaces/messageAPI/endpoints.js +2 -0
  103. package/build/shared/interfaces/messageAPI/handover.js +20 -1
  104. package/build/shared/interfaces/resources/IConnection.js +1 -0
  105. package/build/shared/interfaces/resources/IEndpoint.js +1 -2
  106. package/build/shared/interfaces/resources/ILargeLanguageModel.js +25 -4
  107. package/build/shared/interfaces/resources/IMilestone.js +1 -1
  108. package/build/shared/interfaces/resources/INodeDescriptorSet.js +12 -0
  109. package/build/shared/interfaces/resources/knowledgeStore/IKnowledgeSource.js +1 -1
  110. package/build/shared/interfaces/resources/settings/IAgentSettings.js +12 -7
  111. package/build/shared/interfaces/resources/settings/IGenerativeAISettings.js +4 -0
  112. package/build/shared/interfaces/resources/settings/IKnowledgeAISettings.js +18 -0
  113. package/build/shared/interfaces/resources/settings/index.js +4 -1
  114. package/build/shared/interfaces/restAPI/administration/organisations/v2.0/IReadCollectionsToBeDeletedRest_2_0.js +0 -1
  115. package/build/shared/interfaces/restAPI/administration/organisations/v2.0/IReadOrganisationKnowledgeChunksCountRest_2_0.js +3 -0
  116. package/build/shared/interfaces/restAPI/operations/nlu/v2.0/IGenerateNluScoresRest_2_0.js +57 -0
  117. package/build/shared/interfaces/restAPI/{resources/journey/v2.0/IJourney_2_0.js → operations/nlu/v2.0/index.js} +1 -1
  118. package/build/shared/interfaces/restAPI/resources/largeLanguageModel/v2.0/IAvailableModelsForLLMProvider_2_0 .js +18 -0
  119. package/build/shared/interfaces/restAPI/resources/largeLanguageModel/v2.0/IGetAvailableModelsForLLMRest_2_0 .js +3 -0
  120. package/build/shared/interfaces/security/IRole.js +2 -0
  121. package/build/shared/interfaces/security/ISystemCapabilities.js +3 -0
  122. package/build/shared/interfaces/security/index.js +1 -1
  123. package/build/shared/interfaces/trainer/ITrainerRecord.js +2 -2
  124. package/build/shared/interfaces/user.js +1 -1
  125. package/package.json +2 -2
  126. package/types/index.d.ts +1254 -670
  127. package/build/shared/interfaces/journeys/IJourney.js +0 -83
  128. package/build/shared/interfaces/journeys/IJourneyProgress.js +0 -40
  129. package/build/shared/interfaces/journeys/IJourneyTrackEvent.js +0 -35
  130. package/build/shared/interfaces/journeys/index.js +0 -14
  131. package/build/shared/interfaces/restAPI/resources/journey/v2.0/IJourneyTrackEvents_2_0.js +0 -3
  132. package/build/shared/interfaces/restAPI/resources/journey/v2.0/IReadJourneyProgressRest_2_0.js +0 -3
  133. package/build/shared/interfaces/restAPI/resources/journey/v2.0/IReadJourneyRest_2_0.js +0 -3
  134. package/build/shared/interfaces/restAPI/resources/journey/v2.0/ITrackJourneyEventRest_2_0.js +0 -3
  135. package/build/shared/interfaces/restAPI/resources/journey/v2.0/IUpdateSelectedJourneyRest_2_0.js +0 -3
  136. /package/build/shared/interfaces/restAPI/{resources/journey/v2.0 → operations}/index.js +0 -0
@@ -1,83 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.journeyQuerySchema = exports.journeySchema = exports.journeyDataSchema = exports.journeyStepGoals = void 0;
4
- /* Custom Modules */
5
- const createQuerySchema_1 = require("../../helper/createQuerySchema");
6
- /* Interfaces & Types */
7
- const IEntityMeta_1 = require("../resources/IEntityMeta");
8
- exports.journeyStepGoals = [
9
- "createAgent",
10
- "createFlow",
11
- "createEndpoint",
12
- "createLexicon",
13
- "createSnapshot",
14
- "createKnowledgeStore",
15
- "createKnowledgeSource",
16
- "openWebchat",
17
- "createCodeNode",
18
- "createHttpRequestNode",
19
- "createIfNode",
20
- "createQuestionNode",
21
- "createSayNode",
22
- "createLookupNode",
23
- "createKnowledgeSearchNode",
24
- "createSearchExtractOutputNode",
25
- "createGptConversationNode",
26
- "createLlmPromptNode",
27
- "updateCaseNode",
28
- "updateHttpRequestNode",
29
- "updateIfNode",
30
- "updateQuestionNode",
31
- "updateSayNode",
32
- "createIntent",
33
- "trainIntents",
34
- "activateLexicon",
35
- "useToken",
36
- "addKeyphrase",
37
- "expertModeOn",
38
- "openContextTab",
39
- "openInfoTab",
40
- "openIP",
41
- "sendMessage",
42
- "prepareSnapshotDownload",
43
- "restoreSnapshot",
44
- ];
45
- exports.journeyDataSchema = {
46
- title: "journeyDataSchema",
47
- type: "object",
48
- additionalProperties: false,
49
- properties: {
50
- name: { type: "string", minLength: 1, maxLength: 200 },
51
- link: { type: "string", maxLength: 1000 },
52
- summary: { type: "string", maxLength: 200 },
53
- steps: {
54
- type: "array",
55
- additionalItems: false,
56
- items: {
57
- type: "object",
58
- additionalProperties: false,
59
- properties: {
60
- referenceId: { type: "string", format: "uuid" },
61
- name: { type: "string", minLength: 1, maxLength: 200 },
62
- link: { type: "string", maxLength: 1000 },
63
- summary: { type: "string", maxLength: 200 },
64
- description: { type: "string", maxLength: 10000 },
65
- goals: {
66
- type: "array",
67
- additionalItems: false,
68
- maxItems: 25,
69
- items: { type: "string", format: "journey-step-goal" }
70
- }
71
- }
72
- }
73
- }
74
- }
75
- };
76
- exports.journeySchema = {
77
- title: "journeySchema",
78
- type: "object",
79
- additionalProperties: false,
80
- properties: Object.assign(Object.assign({ referenceId: { type: "string", format: "uuid" } }, exports.journeyDataSchema.properties), IEntityMeta_1.entityMetaSchema.properties)
81
- };
82
- exports.journeyQuerySchema = (0, createQuerySchema_1.createQuerySchema)("journeyQuerySchema", exports.journeySchema);
83
- //# sourceMappingURL=IJourney.js.map
@@ -1,40 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.journeyProgressSchema = exports.journeyProgressDataSchema = void 0;
4
- exports.journeyProgressDataSchema = {
5
- title: "journeyProgressDataSchema",
6
- type: "object",
7
- additionalProperties: false,
8
- properties: {
9
- userReference: { type: "string", format: "mongo-id" },
10
- organisationReference: { type: "string", format: "mongo-id" },
11
- isCurrent: { type: "boolean" },
12
- isComplete: { type: "boolean" },
13
- journeyReferenceId: { type: "string", format: "uuid" },
14
- journeySteps: {
15
- type: "array",
16
- additionalItems: false,
17
- items: {
18
- type: "object",
19
- additionalProperties: false,
20
- properties: {
21
- journeyStepReferenceId: { type: "string", format: "uuid" },
22
- isComplete: { type: "boolean" },
23
- completedGoals: {
24
- type: "array",
25
- additionalItems: false,
26
- maxItems: 25,
27
- items: { type: "string", format: "journey-step-goal" }
28
- }
29
- }
30
- }
31
- }
32
- }
33
- };
34
- exports.journeyProgressSchema = {
35
- title: "journeyProgressSchema",
36
- type: "object",
37
- additionalProperties: false,
38
- properties: Object.assign({}, exports.journeyProgressDataSchema.properties)
39
- };
40
- //# sourceMappingURL=IJourneyProgress.js.map
@@ -1,35 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.trackableJourneyEvent = void 0;
4
- exports.trackableJourneyEvent = [
5
- /* resources */
6
- "createAgent",
7
- "createFlow",
8
- "createEndpoint",
9
- "createLexicon",
10
- "createSnapshot",
11
- "createKnowledgeStore",
12
- "createKnowledgeSource",
13
- /* endpoint editor */
14
- "openWebchat",
15
- /* flow chart */
16
- "createNode",
17
- "updateNode",
18
- /* flow editor other */
19
- "createIntent",
20
- "trainIntents",
21
- "activateLexicon",
22
- "useToken",
23
- /* lexicon editor */
24
- "addKeyphrase",
25
- /* interaction panel (ui) */
26
- "expertModeOn",
27
- "openContextTab",
28
- "openInfoTab",
29
- "openIP",
30
- "sendMessage",
31
- /* snapshots */
32
- "prepareSnapshotDownload",
33
- "restoreSnapshot"
34
- ];
35
- //# sourceMappingURL=IJourneyTrackEvent.js.map
@@ -1,14 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.journeyProgressSchema = exports.journeyProgressDataSchema = exports.journeyStepGoals = exports.journeySchema = exports.journeyQuerySchema = exports.journeyDataSchema = exports.trackableJourneyEvent = void 0;
4
- var IJourneyTrackEvent_1 = require("./IJourneyTrackEvent");
5
- Object.defineProperty(exports, "trackableJourneyEvent", { enumerable: true, get: function () { return IJourneyTrackEvent_1.trackableJourneyEvent; } });
6
- var IJourney_1 = require("./IJourney");
7
- Object.defineProperty(exports, "journeyDataSchema", { enumerable: true, get: function () { return IJourney_1.journeyDataSchema; } });
8
- Object.defineProperty(exports, "journeyQuerySchema", { enumerable: true, get: function () { return IJourney_1.journeyQuerySchema; } });
9
- Object.defineProperty(exports, "journeySchema", { enumerable: true, get: function () { return IJourney_1.journeySchema; } });
10
- Object.defineProperty(exports, "journeyStepGoals", { enumerable: true, get: function () { return IJourney_1.journeyStepGoals; } });
11
- var IJourneyProgress_1 = require("./IJourneyProgress");
12
- Object.defineProperty(exports, "journeyProgressDataSchema", { enumerable: true, get: function () { return IJourneyProgress_1.journeyProgressDataSchema; } });
13
- Object.defineProperty(exports, "journeyProgressSchema", { enumerable: true, get: function () { return IJourneyProgress_1.journeyProgressSchema; } });
14
- //# sourceMappingURL=index.js.map
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=IJourneyTrackEvents_2_0.js.map
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=IReadJourneyProgressRest_2_0.js.map
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=IReadJourneyRest_2_0.js.map
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=ITrackJourneyEventRest_2_0.js.map
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=IUpdateSelectedJourneyRest_2_0.js.map