@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
@@ -0,0 +1,18 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.knowledgeAISettingsDataSchema = exports.fileExtractorOptions = void 0;
4
+ exports.fileExtractorOptions = [
5
+ "default",
6
+ "legacy",
7
+ "azure",
8
+ ];
9
+ exports.knowledgeAISettingsDataSchema = {
10
+ title: "knowledgeAISettingsDataSchema",
11
+ type: ["object", "null"],
12
+ additionalProperties: false,
13
+ properties: {
14
+ fileExtractor: { type: ["string", "null"], enum: [...exports.fileExtractorOptions] },
15
+ azureDIConnectionId: { type: ["string", "null"], format: "uuid" },
16
+ },
17
+ };
18
+ //# sourceMappingURL=IKnowledgeAISettings.js.map
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.translationProviders = exports.translationSettingsDataSchema = exports.audioPreviewProviders = exports.audioPreviewSettingsDataSchema = exports.generativeAISettingsDataSchema = exports.sharedSettingsSchema = exports.flowSettingsSchema = exports.flowSettingsDataSchema = exports.flowIntentMappingOrderType = exports.agentSettingsSchema = exports.agentSettingsDataSchema = void 0;
3
+ exports.fileExtractorOptions = exports.knowledgeAISettingsDataSchema = exports.translationProviders = exports.translationSettingsDataSchema = exports.audioPreviewProviders = exports.audioPreviewSettingsDataSchema = exports.generativeAISettingsDataSchema = exports.sharedSettingsSchema = exports.flowSettingsSchema = exports.flowSettingsDataSchema = exports.flowIntentMappingOrderType = exports.agentSettingsSchema = exports.agentSettingsDataSchema = void 0;
4
4
  var IAgentSettings_1 = require("./IAgentSettings");
5
5
  Object.defineProperty(exports, "agentSettingsDataSchema", { enumerable: true, get: function () { return IAgentSettings_1.agentSettingsDataSchema; } });
6
6
  Object.defineProperty(exports, "agentSettingsSchema", { enumerable: true, get: function () { return IAgentSettings_1.agentSettingsSchema; } });
@@ -18,4 +18,7 @@ Object.defineProperty(exports, "audioPreviewProviders", { enumerable: true, get:
18
18
  var ITranslationSettings_1 = require("./ITranslationSettings");
19
19
  Object.defineProperty(exports, "translationSettingsDataSchema", { enumerable: true, get: function () { return ITranslationSettings_1.translationSettingsDataSchema; } });
20
20
  Object.defineProperty(exports, "translationProviders", { enumerable: true, get: function () { return ITranslationSettings_1.translationProviders; } });
21
+ var IKnowledgeAISettings_1 = require("./IKnowledgeAISettings");
22
+ Object.defineProperty(exports, "knowledgeAISettingsDataSchema", { enumerable: true, get: function () { return IKnowledgeAISettings_1.knowledgeAISettingsDataSchema; } });
23
+ Object.defineProperty(exports, "fileExtractorOptions", { enumerable: true, get: function () { return IKnowledgeAISettings_1.fileExtractorOptions; } });
21
24
  //# sourceMappingURL=index.js.map
@@ -5,7 +5,6 @@ exports.servicesNames = void 0;
5
5
  exports.servicesNames = [
6
6
  "service-api",
7
7
  "service-resources",
8
- "service-journeys",
9
8
  "service-logs",
10
9
  "service-profiles",
11
10
  "service-security",
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=IReadOrganisationKnowledgeChunksCountRest_2_0.js.map
@@ -0,0 +1,57 @@
1
+ "use strict";
2
+ /**
3
+ * @openapi
4
+ *
5
+ * components:
6
+ * schemas:
7
+ * IGenerateNluScoreData_2_0:
8
+ * type: object
9
+ * required:
10
+ * - flowReferenceId
11
+ * - localeReferenceId
12
+ * - sentence
13
+ * properties:
14
+ * flowReferenceId:
15
+ * type: string
16
+ * format: uuid
17
+ * description: UUID of the flow reference.
18
+ * localeReferenceId:
19
+ * type: string
20
+ * format: uuid
21
+ * description: UUID of the locale reference.
22
+ * sentence:
23
+ * type: string
24
+ * description: Sentence to analyze for NLU scoring.
25
+ *
26
+ * IGeneratedNluScore_2_0:
27
+ * type: object
28
+ * properties:
29
+ * id:
30
+ * type: string
31
+ * description: Unique identifier of the score.
32
+ * name:
33
+ * type: string
34
+ * description: Name of the score type.
35
+ * score:
36
+ * type: number
37
+ * description: Numerical value of the score.
38
+ * negated:
39
+ * type: boolean
40
+ * description: Indicates if the score is negated.
41
+ * confirmationSentence:
42
+ * type: string
43
+ * description: Sentence used to confirm the score.
44
+ * confirmationSentences:
45
+ * type: array
46
+ * items:
47
+ * type: string
48
+ * description: Multiple sentences for confirmation if applicable.
49
+ * disambiguationSentence:
50
+ * type: string
51
+ * description: Sentence used for disambiguation.
52
+ * flow:
53
+ * type: string
54
+ * description: UUID of the flow associated with the score.
55
+ */
56
+ Object.defineProperty(exports, "__esModule", { value: true });
57
+ //# sourceMappingURL=IGenerateNluScoresRest_2_0.js.map
@@ -1,3 +1,3 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=IJourney_2_0.js.map
3
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1,18 @@
1
+ "use strict";
2
+ /**
3
+ * @openapi
4
+ * components:
5
+ * schemas:
6
+ * IAvailableModelItem_2_0:
7
+ * type: object
8
+ * properties:
9
+ * modelName:
10
+ * type: string
11
+ * modelId:
12
+ * type: string
13
+ * providerName:
14
+ * type: array
15
+ *
16
+ */
17
+ Object.defineProperty(exports, "__esModule", { value: true });
18
+ //# sourceMappingURL=IAvailableModelsForLLMProvider_2_0%20.js.map
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=IGetAvailableModelsForLLMRest_2_0%20.js.map
@@ -70,6 +70,7 @@ exports.organisationWideRoles = [
70
70
  * - data_privacy_admin
71
71
  * - data_privacy_editor
72
72
  * - data_privacy_viewer
73
+ * - knowledgeAdmin
73
74
  * - large_language_model_admin,
74
75
  * - lexicon_admin
75
76
  * - lexicon_editor
@@ -109,6 +110,7 @@ exports.projectWideRoles = [
109
110
  "function_admin",
110
111
  "function_editor",
111
112
  "intents",
113
+ "knowledgeAdmin",
112
114
  "large_language_model_admin",
113
115
  "lexicon_admin",
114
116
  "lexicon_editor",
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=ISystemCapabilities.js.map
@@ -1,7 +1,7 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.identityProviderSchema = exports.oidcIdentityProviderDataSchema = exports.samlIdentityProviderDataSchema = exports.CrudOperation = exports.operations = exports.availableRoles = exports.projectWideRoles = exports.organisationWideRoles = exports.availablePermissions = exports.COMPUTED_ACL_HASH_VERSION = void 0;
4
- exports.COMPUTED_ACL_HASH_VERSION = "v13";
4
+ exports.COMPUTED_ACL_HASH_VERSION = "v14";
5
5
  var IPermission_1 = require("./IPermission");
6
6
  Object.defineProperty(exports, "availablePermissions", { enumerable: true, get: function () { return IPermission_1.availablePermissions; } });
7
7
  var IRole_1 = require("./IRole");
@@ -69,7 +69,7 @@ exports.trainerRecordDataSchema = {
69
69
  intentFlow: { type: ["null", "string"] },
70
70
  intentId: { type: ["null", "string"] },
71
71
  intentMapperResults: {
72
- type: "object",
72
+ type: ["object", "null"],
73
73
  additionalProperties: true,
74
74
  properties: {
75
75
  finalIntentName: { type: ["null", "string"] },
@@ -96,7 +96,7 @@ exports.trainerRecordSchema = {
96
96
  properties: Object.assign(Object.assign(Object.assign({}, IEntityMeta_1.entityMetaSchema.properties), exports.trainerRecordDataSchema.properties), { expiresAt: { type: "object" }, projectReference: { format: "mongo-id" }, organisationReference: { format: "mongo-id" } }),
97
97
  };
98
98
  exports.trainerRecordInDbSchema = {
99
- title: "trainerRecordSchema",
99
+ title: "trainerRecordInDbSchema",
100
100
  type: "object",
101
101
  additionalProperties: false,
102
102
  properties: Object.assign(Object.assign(Object.assign({}, IEntityMeta_1.entityMetaSchema.properties), exports.trainerRecordDataSchema.properties), { snapshotReference: {
@@ -10,7 +10,7 @@ exports.userDataSchema = {
10
10
  additionalProperties: false,
11
11
  properties: {
12
12
  id: { type: "string", format: "email" },
13
- name: { type: "string", maxLength: 200 },
13
+ name: { type: "string", maxLength: 200, format: "resource-name" },
14
14
  acceptedTOS: { type: "boolean" },
15
15
  disabled: { type: "boolean" },
16
16
  roles: { type: "array", additionalItems: false, items: { type: "string", format: "organisation-wide-role" } },
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cognigy/rest-api-client",
3
- "version": "0.18.0",
3
+ "version": "0.19.0",
4
4
  "description": "Cognigy REST-Client",
5
5
  "main": "build/index.js",
6
6
  "module": "dist/rollup-plugin-babel.esm.js",
@@ -31,7 +31,7 @@
31
31
  "license": "Cognigy Proprietary License",
32
32
  "dependencies": {
33
33
  "ajv": "6.12.6",
34
- "axios": "1.6.8",
34
+ "axios": "1.7.4",
35
35
  "form-data": "4.0.0",
36
36
  "tus-js-client": "^3.1.1",
37
37
  "uuidv4": "6.2.13"