@cognigy/rest-api-client 0.19.0 → 0.20.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 (118) hide show
  1. package/build/RestAPIClient.js +7 -0
  2. package/build/apigroups/AdministrationAPIGroup_2_0.js +6 -1
  3. package/build/apigroups/JWTAuthAPIGroup_2_0.js +12 -0
  4. package/build/apigroups/ResourcesAPIGroup_2_0.js +19 -8
  5. package/build/apigroups/index.js +3 -1
  6. package/build/shared/charts/descriptors/agentAssist/index.js +3 -1
  7. package/build/shared/charts/descriptors/agentAssist/sendData.js +74 -0
  8. package/build/shared/charts/descriptors/analytics/addMemory.js +51 -0
  9. package/build/shared/charts/descriptors/analytics/completeGoal.js +4 -3
  10. package/build/shared/charts/descriptors/analytics/helper.js +20 -0
  11. package/build/shared/charts/descriptors/analytics/index.js +5 -3
  12. package/build/shared/charts/descriptors/analytics/{trackMilestone.js → trackGoal.js} +32 -25
  13. package/build/shared/charts/descriptors/data/copySlotsToContext.js +1 -1
  14. package/build/shared/charts/descriptors/index.js +14 -2
  15. package/build/shared/charts/descriptors/knowledgeSearch/knowledgeSearchV2.js +1 -1
  16. package/build/shared/charts/descriptors/knowledgeSearch/searchExtractOutput.js +26 -16
  17. package/build/shared/charts/descriptors/logic/disableSlotFillers.js +1 -1
  18. package/build/shared/charts/descriptors/logic/enableSlotFillers.js +1 -1
  19. package/build/shared/charts/descriptors/logic/thinkV2.js +111 -4
  20. package/build/shared/charts/descriptors/nlu/cleanText.js +1 -1
  21. package/build/shared/charts/descriptors/nlu/executeCognigyNLU.js +1 -1
  22. package/build/shared/charts/descriptors/nlu/fuzzySearch.js +1 -1
  23. package/build/shared/charts/descriptors/nlu/generativeSlotFiller/generativeSlotFiller.js +1 -1
  24. package/build/shared/charts/descriptors/nlu/generativeSlotFiller/generativeSlotFillerFallback.js +1 -1
  25. package/build/shared/charts/descriptors/nlu/generativeSlotFiller/generativeSlotFillerSuccess.js +1 -1
  26. package/build/shared/charts/descriptors/nlu/generativeSlotFiller/prompt.js +4 -5
  27. package/build/shared/charts/descriptors/nlu/matchPattern.js +1 -1
  28. package/build/shared/charts/descriptors/nlu/regexSlotFiller.js +1 -1
  29. package/build/shared/charts/descriptors/service/GPTConversation.js +1 -1
  30. package/build/shared/charts/descriptors/service/GPTPrompt.js +26 -32
  31. package/build/shared/charts/descriptors/service/LLMEntityExtract.js +1 -1
  32. package/build/shared/charts/descriptors/service/aiAgent/aiAgentHandover.js +92 -0
  33. package/build/shared/charts/descriptors/service/aiAgent/aiAgentJob.js +1146 -0
  34. package/build/shared/charts/descriptors/service/aiAgent/aiAgentJobDefault.js +31 -0
  35. package/build/shared/charts/descriptors/service/aiAgent/aiAgentJobTool.js +139 -0
  36. package/build/shared/charts/descriptors/service/aiAgent/aiAgentToolAnswer.js +120 -0
  37. package/build/shared/charts/descriptors/service/aiAgent/helper.js +222 -0
  38. package/build/shared/charts/descriptors/service/handoverV2.js +68 -13
  39. package/build/shared/charts/descriptors/service/index.js +11 -1
  40. package/build/shared/charts/descriptors/transcripts/addTranscriptStep.js +413 -0
  41. package/build/shared/charts/descriptors/transcripts/getTranscript.js +104 -0
  42. package/build/shared/charts/descriptors/transcripts/index.js +8 -0
  43. package/build/shared/charts/descriptors/voice/mappers/base.mapper.js +20 -0
  44. package/build/shared/charts/descriptors/voice/mappers/setSessionConfig.mapper.js +183 -107
  45. package/build/shared/charts/descriptors/voice/mappers/transfer.mapper.js +6 -9
  46. package/build/shared/charts/descriptors/voice/nodes/continuousAsr.js +3 -4
  47. package/build/shared/charts/descriptors/voicegateway/nodes/callRecording.js +8 -1
  48. package/build/shared/charts/descriptors/voicegateway/nodes/handover.js +4 -2
  49. package/build/shared/charts/descriptors/voicegateway/nodes/hangup.js +4 -2
  50. package/build/shared/charts/descriptors/voicegateway/nodes/helper/utils.js +14 -0
  51. package/build/shared/charts/descriptors/voicegateway/nodes/playURL.js +4 -5
  52. package/build/shared/charts/descriptors/voicegateway/nodes/sendMessage.js +8 -1
  53. package/build/shared/charts/descriptors/voicegateway/nodes/sendMetaData.js +7 -3
  54. package/build/shared/charts/descriptors/voicegateway/nodes/setSessionParams.js +8 -1
  55. package/build/shared/charts/descriptors/voicegateway2/nodes/setSessionConfig.js +15 -4
  56. package/build/shared/charts/descriptors/voicegateway2/nodes/transfer.js +15 -3
  57. package/build/shared/constants.js +7 -1
  58. package/build/shared/handoverClients/interfaces/THandoverEventType.js +1 -0
  59. package/build/shared/helper/logFullConfigToDebugMode.js +1 -1
  60. package/build/shared/helper/nlu/textCleaner.js +1 -1
  61. package/build/shared/interfaces/{restAPI/resources/milestone/v2.0/IMilestoneStep_2_0.js → IEndpointSettings.js} +1 -1
  62. package/build/shared/interfaces/IProfile.js +1 -0
  63. package/build/shared/interfaces/IProfileSchema.js +1 -0
  64. package/build/shared/interfaces/analytics/IAnalyticsSourceData.js +22 -20
  65. package/build/shared/interfaces/{restAPI/resources/milestone/v2.0/IMilestone_2_0.js → analytics/IGoalAnalytics.js} +1 -1
  66. package/build/shared/interfaces/generativeAI/IGenerativeAIModels.js +19 -2
  67. package/build/shared/interfaces/generativeAI/tools.js +3 -0
  68. package/build/shared/interfaces/handover.js +3 -1
  69. package/build/shared/interfaces/messageAPI/endpoints.js +6 -1
  70. package/build/shared/interfaces/messageAPI/handover.js +2 -0
  71. package/build/shared/interfaces/resources/IAiAgent.js +52 -0
  72. package/build/shared/interfaces/resources/IAuditEvent.js +2 -1
  73. package/build/shared/interfaces/resources/IEndpoint.js +2 -1
  74. package/build/shared/interfaces/resources/{IMilestone.js → IGoal.js} +14 -14
  75. package/build/shared/interfaces/resources/ILargeLanguageModel.js +29 -2
  76. package/build/shared/interfaces/resources/INodeDescriptorSet.js +4 -1
  77. package/build/shared/interfaces/resources/TResourceType.js +16 -8
  78. package/build/shared/interfaces/resources/settings/IGenerativeAISettings.js +5 -1
  79. package/build/shared/interfaces/restAPI/{resources/milestone/v2.0/ICloneMilestoneRest_2_0.js → administration/user/v2.0/IGetPinnedResources_2_0.js} +1 -1
  80. package/build/shared/interfaces/restAPI/administration/user/v2.0/IPinResourceRest_2_0.js +3 -0
  81. package/build/shared/interfaces/restAPI/resources/aiAgent/v2.0/IAiAgentHiringTemplate_2_0.js +32 -0
  82. package/build/shared/interfaces/restAPI/resources/aiAgent/v2.0/IAiAgent_2_0.js +3 -0
  83. package/build/shared/interfaces/restAPI/resources/aiAgent/v2.0/ICreateAiAgentRest_2_0.js +3 -0
  84. package/build/shared/interfaces/restAPI/resources/aiAgent/v2.0/IDeleteAiAgentRest_2_0.js +3 -0
  85. package/build/shared/interfaces/restAPI/resources/aiAgent/v2.0/IGetAiAgentHiringTemplates_2_0.js +3 -0
  86. package/build/shared/interfaces/restAPI/resources/aiAgent/v2.0/IHireAiAgent_2_0.js +3 -0
  87. package/build/shared/interfaces/restAPI/resources/aiAgent/v2.0/IIndexAiAgentRest_2_0.js +3 -0
  88. package/build/shared/interfaces/restAPI/resources/aiAgent/v2.0/IReadAiAgentRest_2_0.js +3 -0
  89. package/build/shared/interfaces/restAPI/resources/aiAgent/v2.0/IUpdateAiAgentRest_2_0.js +3 -0
  90. package/build/shared/interfaces/restAPI/resources/{milestone/v2.0/ICreateMilestoneRest_2_0.js → aiAgent/v2.0/IValidateAiAgentNameRest_2_0.js} +1 -1
  91. package/build/shared/interfaces/restAPI/resources/goal/v2.0/ICloneGoalRest_2_0.js +3 -0
  92. package/build/shared/interfaces/{analytics/IMilestoneAnalytics.js → restAPI/resources/goal/v2.0/ICreateGoalRest_2_0.js} +1 -1
  93. package/build/shared/interfaces/restAPI/resources/goal/v2.0/IDeleteGoalRest_2_0.js +3 -0
  94. package/build/shared/interfaces/restAPI/resources/goal/v2.0/IGoalIndexItem_2_0.js +3 -0
  95. package/build/shared/interfaces/restAPI/resources/goal/v2.0/IGoalStepMetric_2_0.js +3 -0
  96. package/build/shared/interfaces/restAPI/resources/goal/v2.0/IGoalStep_2_0.js +3 -0
  97. package/build/shared/interfaces/restAPI/resources/goal/v2.0/IGoal_2_0.js +3 -0
  98. package/build/shared/interfaces/restAPI/resources/goal/v2.0/IIndexGoalsRest_2_0.js +3 -0
  99. package/build/shared/interfaces/restAPI/resources/goal/v2.0/IReadGoalRest_2_0.js +3 -0
  100. package/build/shared/interfaces/restAPI/resources/goal/v2.0/IUpdateGoalRest_2_0.js +3 -0
  101. package/build/shared/interfaces/security/IPermission.js +6 -2
  102. package/build/shared/interfaces/security/IPinnedResource.js +3 -0
  103. package/build/shared/interfaces/security/index.js +1 -1
  104. package/build/shared/interfaces/transcripts/transcripts.js +33 -0
  105. package/package.json +1 -1
  106. package/types/index.d.ts +931 -224
  107. package/build/shared/interfaces/license.js.map +0 -1
  108. package/build/shared/interfaces/restAPI/resources/knowledgeSearchIndex/v2.0/ICreateKnowledgeSearchIndexRest_2_0.js +0 -3
  109. package/build/shared/interfaces/restAPI/resources/knowledgeSearchIndex/v2.0/IDeleteKnowledgeSearchIndexRest_2_0.js +0 -3
  110. package/build/shared/interfaces/restAPI/resources/milestone/v2.0/IDeleteMilestoneRest_2_0.js +0 -3
  111. package/build/shared/interfaces/restAPI/resources/milestone/v2.0/IIndexMilestonesRest_2_0.js +0 -3
  112. package/build/shared/interfaces/restAPI/resources/milestone/v2.0/IMilestoneIndexItem_2_0.js +0 -3
  113. package/build/shared/interfaces/restAPI/resources/milestone/v2.0/IMilestoneStepMetric_2_0.js +0 -3
  114. package/build/shared/interfaces/restAPI/resources/milestone/v2.0/IReadMilestoneRest_2_0.js +0 -3
  115. package/build/shared/interfaces/restAPI/resources/milestone/v2.0/IUpdateMilestoneRest_2_0.js +0 -3
  116. package/build/test.js +0 -27
  117. /package/build/shared/interfaces/restAPI/resources/{knowledgeSearchIndex → aiAgent}/v2.0/index.js +0 -0
  118. /package/build/shared/interfaces/restAPI/resources/{milestone → goal}/v2.0/index.js +0 -0
package/types/index.d.ts CHANGED
@@ -414,6 +414,7 @@ export interface IGetAuthorizationCodeParameters {
414
414
  declare const organisationWidePermissions: readonly [
415
415
  "analyticsOdata",
416
416
  "apiKeys",
417
+ "auditEvents",
417
418
  "assignProject",
418
419
  "liveAgentAccount",
419
420
  "projects",
@@ -424,6 +425,7 @@ declare const organisationWidePermissions: readonly [
424
425
  export declare type TOrganisationWidePermissions = typeof organisationWidePermissions[number];
425
426
  declare const projectWidePermissions: readonly [
426
427
  "agentAssistConfigs",
428
+ "aiAgents",
427
429
  "analytics",
428
430
  "connections",
429
431
  "contactProfiles",
@@ -446,7 +448,7 @@ declare const projectWidePermissions: readonly [
446
448
  "logs",
447
449
  "memberDetails",
448
450
  "members",
449
- "milestones",
451
+ "goals",
450
452
  "nluConnectors",
451
453
  "packages",
452
454
  "playbooks",
@@ -912,6 +914,80 @@ declare const referenceKeys: readonly [
912
914
  export declare type TReferenceKeys = (typeof referenceKeys)[number];
913
915
  export declare type TReferenceAndEntityMetaKeys = TReferenceKeys | TEntityMetaKeys | "referenceId";
914
916
  export declare type TNonQueriableKeys<T> = TReferenceKeys;
917
+ declare const arrayTResourceType: readonly [
918
+ "agentassistconfig",
919
+ "agentSettings",
920
+ "chart",
921
+ "connection",
922
+ "connectionSchema",
923
+ "endpoint",
924
+ "extension",
925
+ "file",
926
+ "flow",
927
+ "flowSettings",
928
+ "flowState",
929
+ "function",
930
+ "intent",
931
+ "intentDefaultReply",
932
+ "intentLearningSentence",
933
+ "intentRelation",
934
+ "intentSentence",
935
+ "intentTrainGroup",
936
+ "largeLanguageModel",
937
+ "knowledgeStore",
938
+ "knowledgeSource",
939
+ "knowledgeChunk",
940
+ "lexicon",
941
+ "lexiconEntry",
942
+ "lexiconKeyphrase",
943
+ "lexiconSlot",
944
+ "locale",
945
+ "goal",
946
+ "nluconnector",
947
+ "nodeData",
948
+ "nodeDescriptorSet",
949
+ "package",
950
+ "playbook",
951
+ "playbookRun",
952
+ "slotFiller",
953
+ "snapshot",
954
+ "snippet",
955
+ "aiAgent"
956
+ ];
957
+ export declare type TResourceType = (typeof arrayTResourceType)[number];
958
+ declare const arrayTChartableResourceType: readonly [
959
+ "flow"
960
+ ];
961
+ export declare type TChartableResourceType = (typeof arrayTChartableResourceType)[number];
962
+ declare const searchableResourceTypes: readonly [
963
+ "endpoint",
964
+ "extension",
965
+ "flow",
966
+ "function",
967
+ "largeLanguageModel",
968
+ "lexicon",
969
+ "goal",
970
+ "nluconnector",
971
+ "playbook",
972
+ "project",
973
+ "snapshot"
974
+ ];
975
+ export declare type TSearchableResourceType = (typeof searchableResourceTypes)[number];
976
+ declare const pinnableResourceTypes: readonly [
977
+ "project"
978
+ ];
979
+ /**
980
+ * @openapi
981
+ * components:
982
+ * schemas:
983
+ * TPinnableResourceType:
984
+ * type: string
985
+ * description: The type of a pinnable resource
986
+ * example: project
987
+ * enum:
988
+ * - project
989
+ */
990
+ export declare type TPinnableResourceType = (typeof pinnableResourceTypes)[number];
915
991
  declare const organisationWideRoles: readonly [
916
992
  "admin",
917
993
  "apiKeys",
@@ -1010,6 +1086,8 @@ export interface ICrudPermissions {
1010
1086
  * $ref: '#/components/schemas/ICrudPermissions'
1011
1087
  * apiKeys:
1012
1088
  * $ref: '#/components/schemas/ICrudPermissions'
1089
+ * auditEvents:
1090
+ * $ref: '#/components/schemas/ICrudPermissions'
1013
1091
  * liveAgentAccount:
1014
1092
  * $ref: '#/components/schemas/ICrudPermissions'
1015
1093
  * projects:
@@ -1052,7 +1130,7 @@ export interface ICrudPermissions {
1052
1130
  * $ref: '#/components/schemas/ICrudPermissions'
1053
1131
  * members:
1054
1132
  * $ref: '#/components/schemas/ICrudPermissions'
1055
- * milestones:
1133
+ * goals:
1056
1134
  * $ref: '#/components/schemas/ICrudPermissions'
1057
1135
  * nluConnectors:
1058
1136
  * $ref: '#/components/schemas/ICrudPermissions'
@@ -1137,7 +1215,7 @@ export interface IOrganisationWideAcl {
1137
1215
  * $ref: '#/components/schemas/ICrudPermissions'
1138
1216
  * members:
1139
1217
  * $ref: '#/components/schemas/ICrudPermissions'
1140
- * milestones:
1218
+ * goals:
1141
1219
  * $ref: '#/components/schemas/ICrudPermissions'
1142
1220
  * nluConnectors:
1143
1221
  * $ref: '#/components/schemas/ICrudPermissions'
@@ -1348,7 +1426,7 @@ export declare type TIdpIdTokenSignedResponseAlg = typeof idpIdTokenSignedRespon
1348
1426
  * sets of information be made available as Claim Values.
1349
1427
  * The scopes openid, profile, email and offline_access are always
1350
1428
  * requested.
1351
- * idpFrontChannelUrl:
1429
+ * idpFrontChannelLogoutUrl:
1352
1430
  * type: string
1353
1431
  * format: url
1354
1432
  * idpIdTokenSignedResponseAlg:
@@ -1494,6 +1572,7 @@ export interface IRestAPIClientVersionConfiguration {
1494
1572
  management: "2.0";
1495
1573
  insights: "2.0";
1496
1574
  analytics: "2.0";
1575
+ jwt: "2.0";
1497
1576
  }
1498
1577
  export declare type THttpLib = "axios";
1499
1578
  /**
@@ -1549,64 +1628,6 @@ export interface IHttpAdapter {
1549
1628
  setConfig(config: IRestAPIClientConfig): void;
1550
1629
  }
1551
1630
  export declare type TTusAPIOperation<Data = void, ReturnValue = void> = (args: Data) => ReturnValue;
1552
- declare const arrayTResourceType: readonly [
1553
- "agentassistconfig",
1554
- "agentSettings",
1555
- "chart",
1556
- "connection",
1557
- "connectionSchema",
1558
- "endpoint",
1559
- "extension",
1560
- "file",
1561
- "flow",
1562
- "flowSettings",
1563
- "flowState",
1564
- "function",
1565
- "intent",
1566
- "intentDefaultReply",
1567
- "intentLearningSentence",
1568
- "intentRelation",
1569
- "intentSentence",
1570
- "intentTrainGroup",
1571
- "largeLanguageModel",
1572
- "knowledgeStore",
1573
- "knowledgeSource",
1574
- "knowledgeChunk",
1575
- "lexicon",
1576
- "lexiconEntry",
1577
- "lexiconKeyphrase",
1578
- "lexiconSlot",
1579
- "locale",
1580
- "milestone",
1581
- "nluconnector",
1582
- "nodeData",
1583
- "nodeDescriptorSet",
1584
- "package",
1585
- "playbook",
1586
- "playbookRun",
1587
- "slotFiller",
1588
- "snapshot",
1589
- "snippet"
1590
- ];
1591
- export declare type TResourceType = (typeof arrayTResourceType)[number];
1592
- declare const arrayTChartableResourceType: readonly [
1593
- "flow"
1594
- ];
1595
- export declare type TChartableResourceType = (typeof arrayTChartableResourceType)[number];
1596
- declare const searchableResourceTypes: readonly [
1597
- "endpoint",
1598
- "extension",
1599
- "flow",
1600
- "function",
1601
- "largeLanguageModel",
1602
- "lexicon",
1603
- "milestone",
1604
- "nluconnector",
1605
- "playbook",
1606
- "project",
1607
- "snapshot"
1608
- ];
1609
- export declare type TSearchableResourceType = (typeof searchableResourceTypes)[number];
1610
1631
  declare const arrayNLUConnectorType: readonly [
1611
1632
  "alexa",
1612
1633
  "dialogflow",
@@ -1967,7 +1988,7 @@ export interface IAnalyticsSnapshotMeta {
1967
1988
  snapshotName: string;
1968
1989
  snapshotId: TMongoId | any;
1969
1990
  }
1970
- export interface IAnalytiscEndpointMeta {
1991
+ export interface IAnalyticsEndpointMeta {
1971
1992
  endpointUrlToken: string;
1972
1993
  endpointName: string;
1973
1994
  endpointType: TEndpointType;
@@ -1978,7 +1999,7 @@ export interface IAnalyticsLocaleMeta {
1978
1999
  localeName: string;
1979
2000
  localeReferenceId: string;
1980
2001
  }
1981
- export interface IStepEvent extends IAnalyticsFlowMeta, IAnalytiscEndpointMeta, IAnalyticsLocaleMeta, Partial<IAnalyticsSnapshotMeta> {
2002
+ export interface IStepEvent extends IAnalyticsFlowMeta, IAnalyticsEndpointMeta, IAnalyticsLocaleMeta, Partial<IAnalyticsSnapshotMeta> {
1982
2003
  _id: TMongoId;
1983
2004
  userId: string;
1984
2005
  sessionId: string;
@@ -2246,7 +2267,7 @@ export interface IGenesysCloudOMHandoverSettings {
2246
2267
  }
2247
2268
  export interface IHandoverStatusInputObject {
2248
2269
  status: THandoverStatus;
2249
- eventType?: "queueUpdate" | "handoverInactivity" | "genericHandoverUpdate";
2270
+ eventType?: "queueUpdate" | "handoverInactivity" | "genericHandoverUpdate" | "handoverAlreadyInProgress";
2250
2271
  inactivityCount?: number;
2251
2272
  error?: {
2252
2273
  reason: "unsupported" | "error";
@@ -2254,7 +2275,7 @@ export interface IHandoverStatusInputObject {
2254
2275
  };
2255
2276
  data?: any;
2256
2277
  }
2257
- export declare type THandoverStatus = "queue" | "active" | "completed" | "cancelled" | "error" | "agentInject" | "genericHandoverUpdate";
2278
+ export declare type THandoverStatus = "queue" | "active" | "completed" | "cancelled" | "error" | "agentInject" | "handoverAlreadyInProgress" | "genericHandoverUpdate";
2258
2279
  export interface IEndpointTranslationSettings {
2259
2280
  translationEnabled: boolean;
2260
2281
  flowLanguage: string;
@@ -2325,6 +2346,10 @@ export interface IEndpoint extends IEntityMeta {
2325
2346
  * If set to `true`, disables input sanitization
2326
2347
  */
2327
2348
  disableInputSanitization: boolean;
2349
+ /**
2350
+ * If set to `true`, disables skipping of html tags with uri prop
2351
+ */
2352
+ disableSkipUriTags: boolean;
2328
2353
  /**
2329
2354
  * Optional endpoint specific settings e.g. Facebook Page token
2330
2355
  */
@@ -2479,6 +2504,7 @@ export interface ICallEventSettings {
2479
2504
  }
2480
2505
  export interface ICallEventFailoverSettings {
2481
2506
  enabled?: boolean;
2507
+ enabledForSpeech?: boolean;
2482
2508
  type?: TTransferType;
2483
2509
  headers?: string;
2484
2510
  to?: string;
@@ -2499,12 +2525,14 @@ export interface ICallEventFailoverSettings {
2499
2525
  deepgramEndpointing?: boolean;
2500
2526
  deepgramEndpointingValue?: number;
2501
2527
  dialTranscribeDeepgramTier?: string;
2528
+ anchorMedia?: boolean;
2502
2529
  }
2503
2530
  export interface ICallEvents {
2504
2531
  amd?: ICallEventSettings;
2505
2532
  callCreated?: ICallEventSettings;
2506
2533
  callCompleted?: ICallEventSettings;
2507
2534
  callFailed?: ICallEventSettings;
2535
+ callInProgress?: ICallEventSettings;
2508
2536
  callReconnected?: ICallEventSettings;
2509
2537
  userInputTimeout?: ICallEventSettings;
2510
2538
  recognizedSpeech?: ICallEventSettings;
@@ -2524,11 +2552,13 @@ export interface IVGProsodySettings {
2524
2552
  export interface IVGGenericSettings {
2525
2553
  prosodySettings?: IVGProsodySettings;
2526
2554
  showBestTranscriptOnly?: boolean;
2555
+ enableCallInProgress?: boolean;
2527
2556
  }
2528
2557
  export interface IVoiceGatewayEndpointSettings extends IEndpointSessionSettings {
2529
2558
  callEvents: ICallEvents;
2530
2559
  failover?: ICallEventFailoverSettings;
2531
2560
  genericSettings?: IVGGenericSettings;
2561
+ isFeatureAccmEnabled?: boolean;
2532
2562
  }
2533
2563
  export declare type AnyEndpointSettings = IFacebookEndpointSettings | IWorkplaceEndpointSettings | ISlackEndpointSettings | IGenericEndpointSettings | IAlexaEndpointSettings | IWebchat2EndpointSettings | IWebchat3EndpointSettings | ILineEndpointSettings | ITwilioEndpointSettings | ITwilioSmsEndpointSettings | IIntercomEndpointSettings | IRealtimeEndpointSettings | ISunshineConversationsEndpointSettings | IAvayaEndpointSettings | IUserlikeEndpointSettings | IBandwidthEndpointSettings | IAudioCodesEndpointSettings | IWhatsAppEndpointSettings | IAmazonLexEndpointSettings | IEightByEightEndpointSettings | IMicrosoftBotFrameworkEndpointSettings | IVoiceGatewayEndpointSettings | IGenesysBotConnectorEndpointSettings | INiceCXOneEndpointSettings | IAgentAssistVoiceEndpointSettings | {};
2534
2564
  export declare type TAvayaVoice = "man" | "woman" | string;
@@ -3222,15 +3252,29 @@ export interface IWebchat3EndpointColorsSettings {
3222
3252
  textLinkColor: string;
3223
3253
  }
3224
3254
  export interface IWebchat3EndpointBehaviorSettings {
3255
+ /**
3256
+ * If enabled, shows 'You are now talking to an AI
3257
+ * agent.' notification in the chat.
3258
+ *
3259
+ * Default: true
3260
+ */
3261
+ enableAIAgentNotice: boolean;
3262
+ /**
3263
+ * Text shown as a notice regarding non-human agent
3264
+ * in the chat.
3265
+ *
3266
+ * Default: `You're now chatting with an AI Agent.`
3267
+ */
3268
+ AIAgentNoticeText: string;
3225
3269
  /**
3226
3270
  * Whether to enable collecting
3227
3271
  * addtional meatadata from customers
3228
- */
3272
+ */
3229
3273
  enableCollectMetadata: boolean;
3230
3274
  /**
3231
3275
  * Whether to enable typing indicators
3232
3276
  * when the bot is replying
3233
- */
3277
+ */
3234
3278
  enableTypingIndicator: boolean;
3235
3279
  /**
3236
3280
  * The amount of ms per letter
@@ -3240,28 +3284,28 @@ export interface IWebchat3EndpointBehaviorSettings {
3240
3284
  /**
3241
3285
  * The placeholder text
3242
3286
  * we display in the input field
3243
- */
3287
+ */
3244
3288
  inputPlaceholder: string;
3245
3289
  /**
3246
3290
  * Whether the webchat should use STT.
3247
- */
3291
+ */
3248
3292
  enableSTT: boolean;
3249
3293
  /**
3250
3294
  * Whether the webchat should use
3251
3295
  * TTS and thereby display
3252
3296
  * a record button.
3253
- */
3297
+ */
3254
3298
  enableTTS: boolean;
3255
3299
  /**
3256
3300
  * This setting is used to decide whether
3257
3301
  * the input should be focused right
3258
3302
  * after a postback button is pressed
3259
- */
3303
+ */
3260
3304
  focusInputAfterPostback: boolean;
3261
3305
  /**
3262
3306
  * This setting is used to decide whether
3263
3307
  * a connectivity indicator should be displayed
3264
- */
3308
+ */
3265
3309
  enableConnectionStatusIndicator: boolean;
3266
3310
  }
3267
3311
  export interface IWebchat3EndpointStartBehaviorSettings {
@@ -4104,9 +4148,16 @@ declare const generativeAIModels: readonly [
4104
4148
  "claude-3-opus-20240229",
4105
4149
  "claude-3-haiku-20240307",
4106
4150
  "claude-3-sonnet-20240229",
4151
+ "claude-3-5-sonnet-20241022",
4107
4152
  "text-bison@001",
4108
4153
  "custom-model",
4109
4154
  "gemini-1.0-pro",
4155
+ "gemini-1.5-pro",
4156
+ "gemini-1.5-flash",
4157
+ "amazon.nova-lite-v1:0",
4158
+ "amazon.nova-pro-v1:0",
4159
+ "amazon.nova-micro-v1:0",
4160
+ "anthropic.claude-3-5-sonnet-20240620-v1:0",
4110
4161
  "text-embedding-3-small",
4111
4162
  "text-embedding-3-large",
4112
4163
  "text-embedding-ada-002",
@@ -4134,6 +4185,8 @@ declare const generativeAIModels: readonly [
4134
4185
  * - text-bison@001
4135
4186
  * - custom-model
4136
4187
  * - gemini-1.0-pro
4188
+ * - gemini-1.5-pro
4189
+ * - gemini-1.5-flash
4137
4190
  */
4138
4191
  export declare type TGenerativeAIModels = (typeof generativeAIModels)[number];
4139
4192
  declare const generativeAIProviders: readonly [
@@ -4165,15 +4218,16 @@ export declare type TGenerativeAIProviders = (typeof generativeAIProviders)[numb
4165
4218
  declare const generativeAIUseCases: readonly [
4166
4219
  "nlu",
4167
4220
  "knowledgeSearch",
4221
+ "aiAgent",
4168
4222
  "gptPromptNode",
4169
- "gptConversation",
4170
4223
  "aiEnhancedOutputs",
4171
4224
  "sentimentAnalysis",
4172
4225
  "intentSentenceGeneration",
4173
4226
  "flowGeneration",
4174
4227
  "generateNodeOutput",
4175
4228
  "lexiconGeneration",
4176
- "answerExtraction"
4229
+ "answerExtraction",
4230
+ "gptConversation"
4177
4231
  ];
4178
4232
  export declare type TGenerativeAIUseCases = typeof generativeAIUseCases[number];
4179
4233
  declare const modeType: readonly [
@@ -6375,6 +6429,10 @@ export interface ILexiconSlotIndexItem_2_0 {
6375
6429
  /** The MongoDB ObjectId */
6376
6430
  _id: TMongoId;
6377
6431
  name: string;
6432
+ createdAt: number;
6433
+ lastChanged: number;
6434
+ createdBy: TMongoId;
6435
+ lastChangedBy: TMongoId;
6378
6436
  }
6379
6437
  export interface IIndexLexiconSlotsRestDataParams_2_0 {
6380
6438
  lexiconId: TMongoId;
@@ -6591,6 +6649,9 @@ export interface IIndexEndpointsRestReturnValue_2_0 extends ICursorBasedPaginati
6591
6649
  * disableInputSanitization:
6592
6650
  * type: string
6593
6651
  * description: If true, disables input text sanitization after Input Transformer
6652
+ * disableSkipUriTags:
6653
+ * type: string
6654
+ * description: If true, disables skipping of uri tags
6594
6655
  * overrideSnapshotConnections:
6595
6656
  * type: boolean
6596
6657
  * settings:
@@ -6779,7 +6840,7 @@ export interface IIndexEndpointsRestReturnValue_2_0 extends ICursorBasedPaginati
6779
6840
  * type: object
6780
6841
  * persistentMenu:
6781
6842
  * type: object
6782
- * transformerSettings:
6843
+ * transformer:
6783
6844
  * type: object
6784
6845
  * properties:
6785
6846
  * abortOnError:
@@ -6952,6 +7013,10 @@ export interface IEndpoint_2_0 {
6952
7013
  * If set to `true`, disables input sanitization
6953
7014
  */
6954
7015
  disableInputSanitization: boolean;
7016
+ /**
7017
+ * If set to `true`, disables skipping of uri tags
7018
+ */
7019
+ disableSkipUriTags: boolean;
6955
7020
  /**
6956
7021
  * Optional endpoint specific settings e.g. Facebook Page token
6957
7022
  */
@@ -8373,6 +8438,16 @@ export interface IGoogleGeminiMeta {
8373
8438
  location: string;
8374
8439
  customModel?: string;
8375
8440
  }
8441
+ export declare type TLLMFallback = {
8442
+ order: number;
8443
+ isFallbackEnabled: boolean;
8444
+ fallbackLLMReferenceId: string;
8445
+ immediateFallBack: {
8446
+ failedRequests: number;
8447
+ durationInMinutes: number;
8448
+ emailNotificationList: string[];
8449
+ };
8450
+ };
8376
8451
  export interface ILargeLanguageModel extends IEntityMeta {
8377
8452
  _id: TMongoId;
8378
8453
  referenceId: string;
@@ -8381,6 +8456,7 @@ export interface ILargeLanguageModel extends IEntityMeta {
8381
8456
  modelType: TGenerativeAIModels;
8382
8457
  modelGroup?: TModeType;
8383
8458
  isCustomModel?: boolean;
8459
+ areFallbacksEnabled?: boolean;
8384
8460
  provider: TGenerativeAIProviders;
8385
8461
  connectionId: string;
8386
8462
  isDefault: boolean;
@@ -8393,6 +8469,7 @@ export interface ILargeLanguageModel extends IEntityMeta {
8393
8469
  alephAlpha?: IAlephAlphaMeta;
8394
8470
  anthropic?: IAnthropicMeta;
8395
8471
  awsBedrock?: IAwsBedrockMeta;
8472
+ fallbacks?: TLLMFallback[];
8396
8473
  }
8397
8474
  export interface IGraphLargeLanguageModelDependencyAttachment {
8398
8475
  _id: string;
@@ -8984,6 +9061,7 @@ export interface IVoiceGateway2CognigyFlowInputConfigParams {
8984
9061
  flowNoInputRetries?: number;
8985
9062
  flowNoInputSpeech?: string;
8986
9063
  flowNoInputUrl?: string;
9064
+ flowNoInputFail?: boolean;
8987
9065
  }
8988
9066
  export interface IGetNluPipelineParams {
8989
9067
  parseIntents?: boolean;
@@ -9069,6 +9147,12 @@ export interface IHandoverNodeV2Params extends INodeFunctionBaseParams {
9069
9147
  maximumQueuePosition: number;
9070
9148
  maximumEstimatedWaitTime: number;
9071
9149
  alternativeText: string;
9150
+ enableHandoverDisconnectMessageLiveAgent: boolean;
9151
+ enableHandoverConnectMessageLiveAgent: boolean;
9152
+ enableHandoverDisconnectMessageGenesys: boolean;
9153
+ enableHandoverConnectMessageGenesys: boolean;
9154
+ enableHandoverDisconnectMessageRingCentralEngage: boolean;
9155
+ enableHandoverConnectMessageRingCentralEngage: boolean;
9072
9156
  };
9073
9157
  nodeType?: "question" | "handoverToAgent";
9074
9158
  }
@@ -9101,6 +9185,51 @@ export interface IScheduledNodeParams extends INodeFunctionBaseParams {
9101
9185
  }
9102
9186
  export interface ISchedulingErrorNodeParams extends INodeFunctionBaseParams {
9103
9187
  }
9188
+ export interface ISpeakingStyle {
9189
+ completeness: string;
9190
+ formality: string;
9191
+ [key: string]: string;
9192
+ }
9193
+ declare const contactProfileOptions: readonly [
9194
+ "none",
9195
+ "selectedProfileFields",
9196
+ "completeProfile",
9197
+ "profileMemoriesOnly"
9198
+ ];
9199
+ export declare type TContactProfileOptions = typeof contactProfileOptions[number];
9200
+ export interface ISafetySettings {
9201
+ avoidHarmfulContent: boolean;
9202
+ avoidUngroundedContent: boolean;
9203
+ avoidCopyrightInfringements: boolean;
9204
+ preventJailbreakAndManipulation: boolean;
9205
+ }
9206
+ export interface IAiAgent extends IEntityMeta {
9207
+ name: string;
9208
+ referenceId: string;
9209
+ image: string;
9210
+ imageOptimizedFormat: boolean;
9211
+ knowledgeReferenceId: string;
9212
+ description: string;
9213
+ speakingStyle: ISpeakingStyle;
9214
+ safetySettings: ISafetySettings;
9215
+ instructions: string;
9216
+ contactProfilesOption: TContactProfileOptions;
9217
+ contactProfilesSelected: string[];
9218
+ projectReference: TMongoId;
9219
+ organisationReference: TMongoId;
9220
+ }
9221
+ export interface IAiAgentDependencies {
9222
+ type: "attachedKnowledgeStore";
9223
+ _id: TMongoId;
9224
+ }
9225
+ export interface IGraphAiAgent {
9226
+ type: "aiAgent";
9227
+ _id: TMongoId;
9228
+ name: string;
9229
+ referenceId: string;
9230
+ properties: Pick<IAiAgent, "createdAt" | "createdBy" | "lastChanged" | "lastChangedBy" | "knowledgeReferenceId">;
9231
+ dependencies?: IAiAgentDependencies[];
9232
+ }
9104
9233
  export interface ISendTileUpdateParams extends INodeFunctionBaseParams {
9105
9234
  tile: any;
9106
9235
  }
@@ -9381,6 +9510,40 @@ export interface INodeToExecute {
9381
9510
  };
9382
9511
  type?: "stopExecution" | "resetCognigyScriptInput" | "trackAnalyticsStep";
9383
9512
  }
9513
+ export declare type TCompletionPrompt = {
9514
+ prompt: string;
9515
+ };
9516
+ export declare type TChatMessage = {
9517
+ role: "user" | "system" | "assistant" | "tool";
9518
+ content: string;
9519
+ toolCallId?: string;
9520
+ };
9521
+ export declare type TChatPrompt = {
9522
+ messages: Array<TChatMessage>;
9523
+ };
9524
+ export declare type TSessionUsageInformation = {
9525
+ [key: string]: {
9526
+ llmDisplayName: string;
9527
+ providerType: string;
9528
+ modelType: string;
9529
+ usage: {
9530
+ inputTokens: number;
9531
+ outputTokens: number;
9532
+ };
9533
+ };
9534
+ };
9535
+ export interface IToolCall {
9536
+ id: string;
9537
+ type: string;
9538
+ index: number;
9539
+ function: IToolFunction;
9540
+ }
9541
+ export interface IToolFunction {
9542
+ name: string;
9543
+ arguments: {
9544
+ [key: string]: unknown;
9545
+ };
9546
+ }
9384
9547
  export interface ISessionState extends ISessionStateWithoutMeta {
9385
9548
  /**
9386
9549
  * The Mongo ObjectId. Typed as any due
@@ -9476,11 +9639,20 @@ export interface ISessionStateWithoutMeta {
9476
9639
  * Only filled & used if Generative AI feature is enabled.
9477
9640
  */
9478
9641
  lastConversationEntries?: ILastConversationEntry[];
9479
- analytics: ISessionStateAnalytcis;
9642
+ analytics: ISessionStateAnalytics;
9643
+ lastToolCall?: {
9644
+ llmProvider: TGenerativeAIProviders;
9645
+ toolCall: IToolCall;
9646
+ aiAgentJobNode: {
9647
+ flow: string;
9648
+ node: string;
9649
+ };
9650
+ };
9651
+ tokenUsage?: TSessionUsageInformation;
9480
9652
  }
9481
- export interface ISessionStateAnalytcis {
9482
- milestoneCycleIds: {
9483
- [milestoneId: string]: string;
9653
+ export interface ISessionStateAnalytics {
9654
+ goalCycleIds: {
9655
+ [goalId: string]: string;
9484
9656
  };
9485
9657
  }
9486
9658
  export interface ILastConversationEntry {
@@ -9493,6 +9665,124 @@ export interface IAppsSessionState {
9493
9665
  };
9494
9666
  customization: {};
9495
9667
  }
9668
+ export declare type ValueOf<T> = T[keyof T];
9669
+ /**
9670
+ * Options for reading the transcript
9671
+ * @param limit: the maximum number of entries to read
9672
+ * @param rolesWhiteList: (optional) the roles for which the entries should be included, if not provided or empty all entries will be read
9673
+ * @param excludeDataOnlyMessagesFilter: (optional) the roles for which data only messages (emtpy text field) will be excluded if type is input/output
9674
+ */
9675
+ export declare type TReadTranscriptOptions = {
9676
+ limit: number;
9677
+ rolesWhiteList?: TTranscriptRoles[];
9678
+ excludeDataOnlyMessagesFilter?: (TranscriptRole.USER | TranscriptRole.AGENT | TranscriptRole.ASSISTANT)[];
9679
+ };
9680
+ declare enum TranscriptRole {
9681
+ ASSISTANT = "assistant",
9682
+ USER = "user",
9683
+ AGENT = "agent",
9684
+ SYSTEM = "system",
9685
+ TOOL = "tool"
9686
+ }
9687
+ export declare type TTranscriptRoles = ValueOf<typeof TranscriptRole>;
9688
+ declare enum TranscriptEntryType {
9689
+ INPUT = "input",
9690
+ OUTPUT = "output",
9691
+ TOOL_CALL = "toolCall",
9692
+ TOOL_ANSWER = "toolAnswer",
9693
+ DEBUG_LOG = "debugLog"
9694
+ }
9695
+ export declare type TTranscriptEntryContent = TTranscriptUserInput | TTranscriptAssistantOutput | TTranscriptAgentOutput | TTranscriptAssistantToolCall | TTranscriptToolAnswer | TTranscriptDebugLog;
9696
+ export declare type TTranscriptEntry = TTranscriptEntryContent & {
9697
+ timestamp: number;
9698
+ traceId: string;
9699
+ };
9700
+ export declare type TTranscriptUserInput = {
9701
+ role: TranscriptRole.USER;
9702
+ type: TranscriptEntryType.INPUT;
9703
+ source: "user" | "system";
9704
+ payload: {
9705
+ text: string;
9706
+ data: any;
9707
+ };
9708
+ };
9709
+ export declare type TTranscriptAgentOutput = {
9710
+ role: TranscriptRole.AGENT;
9711
+ type: TranscriptEntryType.OUTPUT;
9712
+ source: "agent" | "system";
9713
+ payload: {
9714
+ text: string;
9715
+ data: any;
9716
+ };
9717
+ };
9718
+ export declare type TTranscriptAssistantOutput = {
9719
+ role: TranscriptRole.ASSISTANT;
9720
+ type: TranscriptEntryType.OUTPUT;
9721
+ source: "assistant" | "system";
9722
+ payload: {
9723
+ text: string;
9724
+ data: any;
9725
+ };
9726
+ };
9727
+ export declare type TTranscriptAssistantToolCall = {
9728
+ role: TranscriptRole.ASSISTANT;
9729
+ type: TranscriptEntryType.TOOL_CALL;
9730
+ source: "system";
9731
+ payload: {
9732
+ name: string;
9733
+ id: string;
9734
+ input: Object;
9735
+ };
9736
+ };
9737
+ export declare type TTranscriptToolAnswer = {
9738
+ role: TranscriptRole.TOOL;
9739
+ type: TranscriptEntryType.TOOL_ANSWER;
9740
+ source: "system";
9741
+ payload: {
9742
+ toolCallId: string;
9743
+ name?: string;
9744
+ content: string;
9745
+ };
9746
+ };
9747
+ export declare type TTranscriptDebugLog = {
9748
+ role: TranscriptRole.SYSTEM;
9749
+ type: TranscriptEntryType.DEBUG_LOG;
9750
+ source: "system";
9751
+ payload: {
9752
+ header?: string;
9753
+ message: string;
9754
+ metadata?: any;
9755
+ };
9756
+ };
9757
+ export interface IToolFunction {
9758
+ /**
9759
+ * The name of the function to be called.
9760
+ */
9761
+ name: string;
9762
+ /**
9763
+ * A description of what the function does, used by the model to choose when and
9764
+ * how to call the function.
9765
+ */
9766
+ description: string;
9767
+ /**
9768
+ * strict: true enables structured outputs.
9769
+ */
9770
+ strict?: boolean;
9771
+ /**
9772
+ * The parameters the functions accepts, ideally described as a JSON Schema object.
9773
+ */
9774
+ parameters?: IToolParameters;
9775
+ }
9776
+ export interface ITool {
9777
+ function: IToolFunction;
9778
+ /**
9779
+ * The type of the tool. Currently, only `function` is supported.
9780
+ */
9781
+ type: "function";
9782
+ }
9783
+ export interface IToolParameters {
9784
+ [key: string]: any;
9785
+ }
9496
9786
  export interface OpenAIChatMessage {
9497
9787
  role: "system" | "user" | "assistant";
9498
9788
  content: string;
@@ -9509,15 +9799,6 @@ export interface IGenerativeSlot {
9509
9799
  };
9510
9800
  invalid?: boolean;
9511
9801
  }
9512
- export declare type TCompletionPrompt = {
9513
- prompt: string;
9514
- };
9515
- export declare type TChatPrompt = {
9516
- messages: Array<{
9517
- role: "user" | "system" | "assistant";
9518
- content: string;
9519
- }>;
9520
- };
9521
9802
  export interface IRunGenerativeAIPromptOptions {
9522
9803
  /**
9523
9804
  * @deprecated should not inject the prompt anymore, use getPrompt() instead
@@ -9529,6 +9810,20 @@ export interface IRunGenerativeAIPromptOptions {
9529
9810
  * Instead of a prompt, we can also provide messages in OpenAI's chat format
9530
9811
  */
9531
9812
  chat?: OpenAIChatMessage[];
9813
+ /**
9814
+ * transcript - The transcript to use for the prompt.
9815
+ * If provided, the transcript will be converted to in the prompt runner.
9816
+ * Also, the system message will be expected in the `chat` property.
9817
+ */
9818
+ transcript?: TTranscriptEntry[];
9819
+ /**
9820
+ * tools - Function tools to provide to the llm.
9821
+ */
9822
+ tools?: ITool[];
9823
+ /**
9824
+ * toolChoice - Determine choice of tool usage.
9825
+ */
9826
+ toolChoice?: "auto" | "required" | "none";
9532
9827
  /** promptFiller - Injected Function to replace the possible prompt variable for the use case data on runtime . */
9533
9828
  promptParser?: (rawPrompt: TCompletionPrompt | TChatPrompt) => TCompletionPrompt | TChatPrompt;
9534
9829
  /** temperature - (Optional) The temperature range to determine how much the OpenAI should vary its response. Defaults to 0.7 */
@@ -9616,14 +9911,44 @@ export interface IRunGenerativeAIPromptOptions {
9616
9911
  * JSON object with options to pass to the LLM Request
9617
9912
  */
9618
9913
  customRequestOptions?: any;
9619
- }
9620
- export interface IAzureOpenAIProviderFieldsV2 {
9621
- apiKey: string;
9622
- }
9623
- export interface IAzureOpenAIProviderOauth2Fields {
9624
- clientId: string;
9625
- clientSecret: string;
9626
- oauthUrl: string;
9914
+ /**
9915
+ * The user can supply specific instructions for image processing
9916
+ */
9917
+ imageOptions?: {
9918
+ /**
9919
+ * Whether to process images at all
9920
+ */
9921
+ processImages?: boolean;
9922
+ /**
9923
+ * Configure how images older than the last turn are handled
9924
+ */
9925
+ transcriptImageHandling?: "minify" | "drop" | "keep";
9926
+ /**
9927
+ * Options for resizing images
9928
+ */
9929
+ resizingOptions?: {
9930
+ /**
9931
+ * Maximum Width for images to be sent to the provider
9932
+ */
9933
+ maxImageWidth?: number;
9934
+ /**
9935
+ * Maximum Height for images to be sent to the provider
9936
+ */
9937
+ maxImageHeight?: number;
9938
+ /**
9939
+ * Maximum File Size for images to be sent to the provider
9940
+ */
9941
+ maxImageFileSizeInBytes?: number;
9942
+ };
9943
+ };
9944
+ }
9945
+ export interface IAzureOpenAIProviderFieldsV2 {
9946
+ apiKey: string;
9947
+ }
9948
+ export interface IAzureOpenAIProviderOauth2Fields {
9949
+ clientId: string;
9950
+ clientSecret: string;
9951
+ oauthUrl: string;
9627
9952
  scope: string;
9628
9953
  }
9629
9954
  export interface IParams {
@@ -9684,6 +10009,7 @@ export interface IKnowledgeSearchReturnValue {
9684
10009
  {
9685
10010
  text: string;
9686
10011
  distance: number;
10012
+ storeReferenceId: string;
9687
10013
  sourceReferenceId: string;
9688
10014
  sourceMetaData: {
9689
10015
  sourceName: string;
@@ -9698,6 +10024,11 @@ export interface IKnowledgeSearchReturnValue {
9698
10024
  order: number;
9699
10025
  }
9700
10026
  ];
10027
+ tokenUsage: {
10028
+ inputTokens: number;
10029
+ outputTokens: number;
10030
+ totalTokens: number;
10031
+ };
9701
10032
  };
9702
10033
  }
9703
10034
  export interface IAddLexiconKeyphraseNodeParams extends INodeFunctionBaseParams {
@@ -9772,22 +10103,25 @@ export interface IGenerativeSlotFillerParams extends INodeFunctionBaseParams {
9772
10103
  timeout: number;
9773
10104
  };
9774
10105
  }
9775
- export interface IMilestoneAnalyticsPayload {
9776
- analyticsdata: IMilestoneEscalations;
10106
+ export interface IGoalAnalyticsPayload {
10107
+ analyticsdata: IGoalEscalations;
9777
10108
  data: IPayloadBaseMetaData;
9778
10109
  }
9779
- export interface IMilestoneAnalyticsData {
10110
+ export interface IGoalAnalyticsData {
9780
10111
  projectId: string;
9781
10112
  organisationId: string;
9782
10113
  sessionId: string;
9783
10114
  version: string;
9784
10115
  timestamp: Date;
9785
- milestoneCycleId: string;
10116
+ goalCycleId: string;
9786
10117
  stepId: string;
9787
- milestoneId: string;
10118
+ goalId: string;
9788
10119
  contactId: string;
9789
10120
  }
9790
- export interface IMilestoneEscalations extends IMilestoneAnalyticsData, IAnalytiscEndpointMeta, IAnalyticsLocaleMeta, IAnalyticsSnapshotMeta {
10121
+ export interface IGoalEscalations extends IGoalAnalyticsData, IAnalyticsEndpointMeta, IAnalyticsLocaleMeta, IAnalyticsSnapshotMeta {
10122
+ }
10123
+ export interface IEndpointSettings {
10124
+ isFeatureAccmEnabled?: boolean;
9791
10125
  }
9792
10126
  export interface IGetConversationTranscriptParams {
9793
10127
  turnLimit: number;
@@ -9830,7 +10164,7 @@ export interface IRephraseSentenceWithAIOptions {
9830
10164
  question?: string;
9831
10165
  answer?: string;
9832
10166
  }
9833
- export declare type TBrainSessionState = Partial<Pick<ISessionState, "frustration" | "lastFlowPath" | "apps" | "lastConversationEntries" | "analytics">>;
10167
+ export declare type TBrainSessionState = Partial<Pick<ISessionState, "frustration" | "lastFlowPath" | "apps" | "lastConversationEntries" | "analytics" | "lastToolCall" | "tokenUsage">>;
9834
10168
  export interface IActions {
9835
10169
  addConditionalEntrypoint?: (actions: IActions, flowId: string) => (addConditionalEntrypointParams: IAddConditionalEntrypointParams) => void;
9836
10170
  addHandoverInactivityTimer?: (params: {
@@ -9838,6 +10172,7 @@ export interface IActions {
9838
10172
  }) => Promise<void>;
9839
10173
  activateProfile?: () => Promise<any>;
9840
10174
  addLexiconKeyphrase?: (lexicon: string, keyphrase: string, slots: Array<string>, synonyms: Array<string>, data?: Object) => void;
10175
+ addContactMemory?: (memoryText: string) => void;
9841
10176
  addToContext?: (key: string, value: any, mode: "simple" | "array") => void;
9842
10177
  cancelHandoverRequest?: (cancelHandoverInProvider?: boolean) => Promise<void>;
9843
10178
  checkAgentAvailability?: (params: ICheckAgentAvailabilityNodeParams) => void;
@@ -9942,7 +10277,10 @@ export interface IActions {
9942
10277
  getAgentAssistConfigId: () => string;
9943
10278
  getNluEmbeddingCredentials: () => INluEmbeddingCredentials;
9944
10279
  getMetadata: () => IGetMetaDataActionValue;
9945
- sendTrackMilestone: (payload: IMilestoneAnalyticsPayload) => Promise<void>;
10280
+ sendTrackGoal: (payload: IGoalAnalyticsPayload) => Promise<void>;
10281
+ getEndpointSettings: () => IEndpointSettings;
10282
+ getTranscript: (options: TReadTranscriptOptions) => Promise<TTranscriptEntry[]>;
10283
+ addTranscriptStep: (content: TTranscriptEntryContent) => Promise<void>;
9946
10284
  }
9947
10285
  export interface IGetMetaDataActionValue {
9948
10286
  sessionId: string;
@@ -10569,6 +10907,10 @@ export interface INodeExecutionAPI extends Omit<IActions, "parseCognigyScriptCon
10569
10907
  getAgentAssistConfigId: () => string;
10570
10908
  countGPTTokens: (prompt: string) => number;
10571
10909
  getConversationTranscript?: (mode: string, options?: any) => any;
10910
+ getEndpointSettings: () => IEndpointSettings;
10911
+ updateSessionStateValues(values: Partial<ISessionState>): void;
10912
+ getLLMTokenUsageForSession(): TSessionUsageInformation | null;
10913
+ loadSessionState: () => Promise<Partial<ISessionStateWithoutMeta>>;
10572
10914
  }
10573
10915
  export interface INodeExecutionCognigyObject extends IExecutionObjects {
10574
10916
  api: INodeExecutionAPI;
@@ -10692,7 +11034,8 @@ declare const nodePreviewTypes: readonly [
10692
11034
  "sayNode",
10693
11035
  "custom",
10694
11036
  "resource",
10695
- "image"
11037
+ "image",
11038
+ "aiAgent"
10696
11039
  ];
10697
11040
  export declare type TNodePreviewType = (typeof nodePreviewTypes)[number];
10698
11041
  export interface INodePreview {
@@ -10755,11 +11098,13 @@ declare const nodeFieldTypes: readonly [
10755
11098
  "function",
10756
11099
  "json",
10757
11100
  "keyValuePairs",
11101
+ "toolParameters",
10758
11102
  "knowledgeStore",
10759
11103
  "knowledgeStoreSelect",
10760
11104
  "knowledgeSourceTags",
10761
11105
  "llmSelect",
10762
- "milestoneAndStepsSelect",
11106
+ "aiAgentSelect",
11107
+ "goalAndStepsSelect",
10763
11108
  "lexicon",
10764
11109
  "localeField",
10765
11110
  "node",
@@ -11166,39 +11511,39 @@ export interface IGraphPlaybook {
11166
11511
  name: string;
11167
11512
  properties: Pick<IPlaybook, "createdAt" | "createdBy" | "lastChanged" | "lastChangedBy">;
11168
11513
  }
11169
- export interface IMilestone extends IEntityMeta {
11514
+ export interface IGoal extends IEntityMeta {
11170
11515
  _id: TMongoId;
11171
11516
  name: string;
11172
11517
  version: string;
11173
- steps: IMilestoneStep[];
11518
+ steps: IGoalStep[];
11174
11519
  description: string;
11175
11520
  referenceId: string;
11176
11521
  projectReference: TMongoId;
11177
11522
  organisationReference: TMongoId;
11178
11523
  }
11179
- export interface IMilestoneStep {
11524
+ export interface IGoalStep {
11180
11525
  _id?: string;
11181
11526
  name?: string;
11182
11527
  description?: string;
11183
11528
  order?: number;
11184
11529
  type?: "start" | "completion";
11185
- metrics?: IMilestoneStepMetric[];
11530
+ metrics?: IGoalStepMetric[];
11186
11531
  }
11187
- export interface IMilestoneStepMetric {
11532
+ export interface IGoalStepMetric {
11188
11533
  _id?: string;
11189
11534
  name: string;
11190
11535
  description: string;
11191
- type?: "currency" | "duration";
11536
+ type?: "currency" | "duration" | "revenue";
11192
11537
  value?: number;
11193
11538
  }
11194
- export interface IGraphMilestone {
11195
- type: "milestone";
11539
+ export interface IGraphGoal {
11540
+ type: "goal";
11196
11541
  _id: TMongoId;
11197
11542
  referenceId: string;
11198
11543
  name: string;
11199
- properties: Pick<IMilestone, "createdAt" | "createdBy" | "lastChanged" | "lastChangedBy">;
11544
+ properties: Pick<IGoal, "createdAt" | "createdBy" | "lastChanged" | "lastChangedBy">;
11200
11545
  }
11201
- export declare type IGraphResourceWithReferenceId = IGraphAgentAssistConfig | IGraphConnection | IGraphFlow | IGraphFunction | IGraphLargeLanguageModel | IGraphLexicon | IGraphLocale | IGraphNLUConnector | IGraphSnippet | IGraphAgentAssistConfig | IGraphKnowledgeStore | IGraphMilestone;
11546
+ export declare type IGraphResourceWithReferenceId = IGraphAgentAssistConfig | IGraphConnection | IGraphFlow | IGraphFunction | IGraphLargeLanguageModel | IGraphLexicon | IGraphLocale | IGraphNLUConnector | IGraphSnippet | IGraphAgentAssistConfig | IGraphKnowledgeStore | IGraphGoal | IGraphAiAgent;
11202
11547
  export declare type IGraphResourceWithoutReferenceId = IGraphEndpoint | IGraphExtension | IGraphFile | IGraphPlaybook;
11203
11548
  export declare type IGraphResource = IGraphResourceWithReferenceId | IGraphResourceWithoutReferenceId;
11204
11549
  /**
@@ -15165,6 +15510,7 @@ export interface IVoiceConfigParams {
15165
15510
  flowNoInputRetries: number;
15166
15511
  flowNoInputSpeech: string;
15167
15512
  flowNoInputUrl: string;
15513
+ flowNoInputFail: boolean;
15168
15514
  dtmfEnable: boolean;
15169
15515
  dtmfInterDigitTimeout: number;
15170
15516
  dtmfMaxDigits: number;
@@ -15295,6 +15641,11 @@ export interface IUpdateProfileNodeParams extends INodeFunctionBaseParams {
15295
15641
  value: string;
15296
15642
  };
15297
15643
  }
15644
+ export interface IAddMemoryNodeParams extends INodeFunctionBaseParams {
15645
+ config: {
15646
+ memory: string;
15647
+ };
15648
+ }
15298
15649
  export interface IBlindModeNodeParams extends INodeFunctionBaseParams {
15299
15650
  config: {
15300
15651
  maskLogging: boolean;
@@ -15344,14 +15695,15 @@ export interface IRequestRatingNodeParams extends INodeFunctionBaseParams {
15344
15695
  ratingChatStatusMessage: string;
15345
15696
  };
15346
15697
  }
15347
- export interface ITrackMilestoneNodeParams extends INodeFunctionBaseParams {
15698
+ export interface ITrackGoalNodeParams extends INodeFunctionBaseParams {
15348
15699
  config: {
15349
- milestone: {
15350
- milestoneId: string;
15700
+ goal: {
15701
+ goalId: string;
15351
15702
  name: string;
15352
15703
  version: string;
15353
15704
  selectedSteps: {
15354
15705
  stepId: string;
15706
+ name: string;
15355
15707
  type: string;
15356
15708
  }[];
15357
15709
  };
@@ -15508,6 +15860,12 @@ export interface ISetSessionParamsParams extends INodeFunctionBaseParams {
15508
15860
  sttContextId: string;
15509
15861
  sttContextPhrases: string[];
15510
15862
  sttContextBoost: number;
15863
+ sttSpeechContexts: [
15864
+ {
15865
+ phrases: string[];
15866
+ boost: number;
15867
+ }
15868
+ ];
15511
15869
  sttDisablePunctuation: boolean;
15512
15870
  azureEnableAudioLogging: boolean;
15513
15871
  voiceName: string;
@@ -15645,6 +16003,7 @@ export interface ITransferNodeParams extends INodeFunctionBaseParams {
15645
16003
  transferReason: string;
15646
16004
  transferTarget: string;
15647
16005
  referredBy: string;
16006
+ anchorMedia: boolean;
15648
16007
  useTransferSipHeaders: boolean;
15649
16008
  transferSipHeaders: {
15650
16009
  [key: string]: string | object;
@@ -15762,10 +16121,11 @@ export interface ICognigyBasicNodes {
15762
16121
  deleteProfile: ICreateChartNodeBasicNodesData<"deleteProfile", IDeleteProfileNodeParams, TBASIC_EXTENSION>;
15763
16122
  mergeProfile: ICreateChartNodeBasicNodesData<"mergeProfile", IMergeProfileNodeParams, TBASIC_EXTENSION>;
15764
16123
  updateProfile: ICreateChartNodeBasicNodesData<"updateProfile", IUpdateProfileNodeParams, TBASIC_EXTENSION>;
16124
+ addMemory: ICreateChartNodeBasicNodesData<"addMemory", IAddMemoryNodeParams, TBASIC_EXTENSION>;
15765
16125
  overwriteAnalytics: ICreateChartNodeBasicNodesData<"overwriteAnalytics", IOverwriteAnalyticsParams, TBASIC_EXTENSION>;
15766
16126
  setRating: ICreateChartNodeBasicNodesData<"setRating", ISetRatingParams, TBASIC_EXTENSION>;
15767
16127
  requestRating: ICreateChartNodeBasicNodesData<"requestRating", IRequestRatingNodeParams, TBASIC_EXTENSION>;
15768
- trackMilestone: ICreateChartNodeBasicNodesData<"trackMilestone", ITrackMilestoneNodeParams, TBASIC_EXTENSION>;
16128
+ trackGoal: ICreateChartNodeBasicNodesData<"trackGoal", ITrackGoalNodeParams, TBASIC_EXTENSION>;
15769
16129
  executeFlow: ICreateChartNodeBasicNodesData<"executeFlow", IExecuteFlowNodeParams, TBASIC_EXTENSION>;
15770
16130
  goTo: ICreateChartNodeBasicNodesData<"goTo", IGoToNodeParams, TBASIC_EXTENSION>;
15771
16131
  if: ICreateChartNodeBasicNodesData<"if", IIfNodeParams, TBASIC_EXTENSION>;
@@ -16147,57 +16507,6 @@ export interface IIndexAgentAssistConfigsRestData_2_0 extends IRestPagination<IA
16147
16507
  }
16148
16508
  export interface IIndexAgentAssistConfigsRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<IAgentAssistConfig_2_0> {
16149
16509
  }
16150
- /**
16151
- * @openapi
16152
- *
16153
- * components:
16154
- * schemas:
16155
- * ILargeLanguageModelIndexItem_2_0:
16156
- * allOf:
16157
- * - type: object
16158
- * properties:
16159
- * referenceId:
16160
- * type: string
16161
- * description: The reference id of the LargeLanguageModel
16162
- * format: uuid
16163
- * name:
16164
- * type: string
16165
- * example: "LLM Name"
16166
- * description:
16167
- * type: string
16168
- * example: "LLM Name"
16169
- * modeltype:
16170
- * $ref: '#/components/schemas/TGenerativeAIModels'
16171
- * provider:
16172
- * $ref: '#/components/schemas/TGenerativeAIProviders'
16173
- * connectionId:
16174
- * type: string
16175
- * description: The reference id of the GenerativeAI Provider Connection
16176
- * format: uuid
16177
- * isDefault:
16178
- * type: boolean
16179
- * description: Sets the LLM to default (fallback) if no other LLM is set
16180
- * example: false
16181
- * - $ref: '#/components/schemas/IEntityMeta'
16182
- */
16183
- export interface ILargeLanguageModelIndexItem_2_0 {
16184
- referenceId: string;
16185
- _id: TMongoId;
16186
- name: string;
16187
- description: string;
16188
- modelType: TGenerativeAIModels;
16189
- provider: TGenerativeAIProviders;
16190
- connectionId: string;
16191
- isDefault: boolean;
16192
- createdAt: number;
16193
- lastChanged: number;
16194
- createdBy: TMongoId;
16195
- lastChangedBy: TMongoId;
16196
- }
16197
- export interface IIndexLargeLanguageModelsRestData_2_0 extends IRestPagination<ILargeLanguageModelIndexItem_2_0>, Partial<IProjectScope>, Partial<IGenerativeAIUseCase> {
16198
- }
16199
- export interface IIndexLargeLanguageModelsRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<ILargeLanguageModelIndexItem_2_0> {
16200
- }
16201
16510
  export interface IOpenAIMeta_2_0 {
16202
16511
  customModel?: string;
16203
16512
  }
@@ -16223,6 +16532,46 @@ export interface IGoogleVertexAIMeta_2_0 {
16223
16532
  apiEndPoint: string;
16224
16533
  publisher?: string;
16225
16534
  }
16535
+ /**
16536
+ * @openapi
16537
+ *
16538
+ * components:
16539
+ * schemas:
16540
+ * ILLMFallback_2_0:
16541
+ * type: object
16542
+ * properties:
16543
+ * isFallbackEnabled:
16544
+ * type: boolean
16545
+ * description: A flag that indicates whether the fallback configuration should be considered at all
16546
+ * fallbackLLMReferenceId:
16547
+ * type: string
16548
+ * description: The reference id of an existing largeLanguageModel
16549
+ * immediateFallBack:
16550
+ * type: object
16551
+ * properties:
16552
+ * failedRequests:
16553
+ * type: number
16554
+ * description: Number of failed requests to trigger the fallback LLM as 1st choice
16555
+ * durationInMinutes:
16556
+ * type: number
16557
+ * description: Duration in minutes for which the fallback LLM should be used as 1st choice
16558
+ * emailNotificationList:
16559
+ * type: array
16560
+ * items:
16561
+ * type: string
16562
+ * description: List of email addresses to notify when fallback is triggered
16563
+ * description: Configuration for LLM fallback
16564
+ */
16565
+ export interface ILLMFallback_2_0 {
16566
+ order: number;
16567
+ isFallbackEnabled: boolean;
16568
+ fallbackLLMReferenceId: string;
16569
+ immediateFallBack: {
16570
+ failedRequests: number;
16571
+ durationInMinutes: number;
16572
+ emailNotificationList: string[];
16573
+ };
16574
+ }
16226
16575
  /******************************************************************************/
16227
16576
  /**
16228
16577
  * IMPORTANT!
@@ -16325,6 +16674,11 @@ export interface IGoogleGeminiMeta_2_0 {
16325
16674
  * baseCustomUrl:
16326
16675
  * type: string
16327
16676
  * example: https://api.aleph-alpha.com
16677
+ * fallbacks:
16678
+ * type: array
16679
+ * description: (alpha feature) specifies a fallback LLM that will be used when the current LLM stops working.
16680
+ * items:
16681
+ * $ref: '#/components/schemas/ILLMFallback_2_0'
16328
16682
  *
16329
16683
  * ILargeLanguageModelCreate_2_0:
16330
16684
  * allOf:
@@ -16375,6 +16729,61 @@ export interface ILargeLanguageModel_2_0 {
16375
16729
  anthropic?: IAnthropicMeta_2_0;
16376
16730
  /** Meta data for the AwsBedrock connection */
16377
16731
  awsBedrock?: IAwsBedrockMeta_2_0;
16732
+ /** Fallback LLM configuration */
16733
+ fallbacks?: ILLMFallback_2_0[];
16734
+ }
16735
+ /**
16736
+ * @openapi
16737
+ *
16738
+ * components:
16739
+ * schemas:
16740
+ * ILargeLanguageModelIndexItem_2_0:
16741
+ * allOf:
16742
+ * - type: object
16743
+ * properties:
16744
+ * referenceId:
16745
+ * type: string
16746
+ * description: The reference id of the LargeLanguageModel
16747
+ * format: uuid
16748
+ * name:
16749
+ * type: string
16750
+ * example: "LLM Name"
16751
+ * description:
16752
+ * type: string
16753
+ * example: "LLM Name"
16754
+ * modeltype:
16755
+ * $ref: '#/components/schemas/TGenerativeAIModels'
16756
+ * provider:
16757
+ * $ref: '#/components/schemas/TGenerativeAIProviders'
16758
+ * connectionId:
16759
+ * type: string
16760
+ * description: The reference id of the GenerativeAI Provider Connection
16761
+ * format: uuid
16762
+ * isDefault:
16763
+ * type: boolean
16764
+ * description: Sets the LLM to default (fallback) if no other LLM is set
16765
+ * example: false
16766
+ * - $ref: '#/components/schemas/IEntityMeta'
16767
+ */
16768
+ export interface ILargeLanguageModelIndexItem_2_0 {
16769
+ referenceId: string;
16770
+ _id: TMongoId;
16771
+ name: string;
16772
+ description: string;
16773
+ modelType: TGenerativeAIModels;
16774
+ provider: TGenerativeAIProviders;
16775
+ connectionId: string;
16776
+ /** Fallback LLM configuration */
16777
+ fallbacks?: ILLMFallback_2_0[];
16778
+ isDefault: boolean;
16779
+ createdAt: number;
16780
+ lastChanged: number;
16781
+ createdBy: TMongoId;
16782
+ lastChangedBy: TMongoId;
16783
+ }
16784
+ export interface IIndexLargeLanguageModelsRestData_2_0 extends IRestPagination<ILargeLanguageModelIndexItem_2_0>, Partial<IProjectScope>, Partial<IGenerativeAIUseCase> {
16785
+ }
16786
+ export interface IIndexLargeLanguageModelsRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<ILargeLanguageModelIndexItem_2_0> {
16378
16787
  }
16379
16788
  export interface ICreateLargeLanguageModelRestDataBody_2_0 extends IProjectScope, Partial<Omit<ILargeLanguageModel_2_0, keyof IEntityMeta>> {
16380
16789
  }
@@ -16890,17 +17299,17 @@ export interface IUpdateKnowledgeChunkRestReturnValue_2_0 {
16890
17299
  *
16891
17300
  * components:
16892
17301
  * schemas:
16893
- * IMilestoneIndexItem_2_0:
17302
+ * IGoalIndexItem_2_0:
16894
17303
  * allOf:
16895
17304
  * - type: object
16896
17305
  * properties:
16897
17306
  * name:
16898
17307
  * type: string
16899
- * description: The name of the milestone
16900
- * example: New Milestone
17308
+ * description: The name of the goal
17309
+ * example: New Goal
16901
17310
  * - $ref: '#/components/schemas/IEntityMeta'
16902
17311
  */
16903
- export interface IMilestoneIndexItem_2_0 {
17312
+ export interface IGoalIndexItem_2_0 {
16904
17313
  _id: TMongoId;
16905
17314
  referenceId: string;
16906
17315
  name: string;
@@ -16910,16 +17319,16 @@ export interface IMilestoneIndexItem_2_0 {
16910
17319
  createdBy: TMongoId;
16911
17320
  lastChangedBy: TMongoId;
16912
17321
  }
16913
- export interface IIndexMilestonesRestData_2_0 extends IRestPagination<IMilestoneIndexItem_2_0>, Partial<IProjectScope> {
17322
+ export interface IIndexGoalsRestData_2_0 extends IRestPagination<IGoalIndexItem_2_0>, Partial<IProjectScope> {
16914
17323
  }
16915
- export interface IIndexMilestonesRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<IMilestoneIndexItem_2_0> {
17324
+ export interface IIndexGoalsRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<IGoalIndexItem_2_0> {
16916
17325
  }
16917
17326
  /**
16918
17327
  * @openapi
16919
17328
  *
16920
17329
  * components:
16921
17330
  * schemas:
16922
- * IMilestoneStepMetric_2_0:
17331
+ * IGoalStepMetric_2_0:
16923
17332
  * type: object
16924
17333
  * properties:
16925
17334
  * name:
@@ -16932,37 +17341,37 @@ export interface IIndexMilestonesRestReturnValue_2_0 extends ICursorBasedPaginat
16932
17341
  * example: Time taken to complete the step
16933
17342
  * type:
16934
17343
  * type: string
16935
- * description: Metric type
17344
+ * description: Metric type. Available values "currency", "duration", "revenue"
16936
17345
  * example: "duration"
16937
17346
  * value:
16938
17347
  * type: number
16939
17348
  * description: Metric value
16940
17349
  * example: 30
16941
17350
  */
16942
- export interface IMilestoneStepMetric_2_0 {
17351
+ export interface IGoalStepMetric_2_0 {
16943
17352
  name: string;
16944
17353
  description: string;
16945
- type?: "currency" | "duration";
17354
+ type?: "currency" | "duration" | "revenue";
16946
17355
  value?: number;
16947
17356
  }
16948
17357
  /**
16949
17358
  * @openapi
16950
17359
  * components:
16951
17360
  * schemas:
16952
- * IMilestoneStep_2_0:
17361
+ * IGoalStep_2_0:
16953
17362
  * type: object
16954
17363
  * properties:
16955
17364
  * name:
16956
17365
  * type: string
16957
- * description: The name of the milestone step
17366
+ * description: The name of the goal step
16958
17367
  * example: Step 1
16959
17368
  * description:
16960
17369
  * type: string
16961
- * description: The description of the milestone step
17370
+ * description: The description of the goal step
16962
17371
  * example: This is the first step
16963
17372
  * order:
16964
17373
  * type: number
16965
- * description: Step order in the milestone configuration
17374
+ * description: Step order in the goal configuration
16966
17375
  * example: 1
16967
17376
  * type:
16968
17377
  * type: string
@@ -16971,44 +17380,44 @@ export interface IMilestoneStepMetric_2_0 {
16971
17380
  * metrics:
16972
17381
  * type: array
16973
17382
  * items:
16974
- * $ref: '#/components/schemas/IMilestoneStepMetric_2_0'
17383
+ * $ref: '#/components/schemas/IGoalStepMetric_2_0'
16975
17384
  */
16976
- export interface IMilestoneStep_2_0 {
17385
+ export interface IGoalStep_2_0 {
16977
17386
  _id?: TMongoId;
16978
17387
  name?: string;
16979
17388
  description?: string;
16980
17389
  order?: number;
16981
17390
  type?: "start" | "completion";
16982
- metrics?: IMilestoneStepMetric_2_0[];
17391
+ metrics?: IGoalStepMetric_2_0[];
16983
17392
  }
16984
17393
  /**
16985
17394
  * @openapi
16986
17395
  *
16987
17396
  * components:
16988
17397
  * schemas:
16989
- * IMilestoneData_2_0:
17398
+ * IGoalData_2_0:
16990
17399
  * type: object
16991
17400
  * properties:
16992
17401
  * name:
16993
17402
  * type: string
16994
- * description: The name of the Milestone
16995
- * example: New Milestone
17403
+ * description: The name of the Goal
17404
+ * example: New Goal
16996
17405
  * description:
16997
17406
  * type: string
16998
- * description: The description of the milestone
16999
- * example: "This is a sample milestone"
17407
+ * description: The description of the goal
17408
+ * example: "This is a sample goal"
17000
17409
  * steps:
17001
17410
  * type: array
17002
17411
  * items:
17003
- * $ref: '#/components/schemas/IMilestoneStep_2_0'
17412
+ * $ref: '#/components/schemas/IGoalStep_2_0'
17004
17413
  *
17005
- * IMilestone_2_0:
17414
+ * IGoal_2_0:
17006
17415
  * allOf:
17007
- * - $ref: '#/components/schemas/IMilestoneData_2_0'
17416
+ * - $ref: '#/components/schemas/IGoalData_2_0'
17008
17417
  * - $ref: '#/components/schemas/IEntityMeta'
17009
17418
  *
17010
17419
  */
17011
- export interface IMilestone_2_0 {
17420
+ export interface IGoal_2_0 {
17012
17421
  _id: TMongoId;
17013
17422
  referenceId: string;
17014
17423
  name: string;
@@ -17018,36 +17427,36 @@ export interface IMilestone_2_0 {
17018
17427
  createdBy: TMongoId;
17019
17428
  lastChangedBy: TMongoId;
17020
17429
  description: string;
17021
- steps: IMilestoneStep_2_0[];
17430
+ steps: IGoalStep_2_0[];
17022
17431
  }
17023
- export interface ICreateMilestoneRestDataBody_2_0 extends IProjectScope, Partial<Omit<IMilestone_2_0, keyof IEntityMeta>> {
17432
+ export interface ICreateGoalRestDataBody_2_0 extends IProjectScope, Partial<Omit<IGoal_2_0, keyof IEntityMeta>> {
17024
17433
  }
17025
- export interface ICreateMilestoneRestData_2_0 extends ICreateMilestoneRestDataBody_2_0 {
17434
+ export interface ICreateGoalRestData_2_0 extends ICreateGoalRestDataBody_2_0 {
17026
17435
  }
17027
- export interface ICreateMilestoneRestReturnValue_2_0 extends IMilestone_2_0 {
17436
+ export interface ICreateGoalRestReturnValue_2_0 extends IGoal_2_0 {
17028
17437
  }
17029
- export interface IReadMilestoneRestDataParams_2_0 {
17030
- milestoneId: string;
17438
+ export interface IReadGoalRestDataParams_2_0 {
17439
+ goalId: string;
17031
17440
  }
17032
- export interface IReadMilestoneRestData_2_0 extends IReadMilestoneRestDataParams_2_0 {
17441
+ export interface IReadGoalRestData_2_0 extends IReadGoalRestDataParams_2_0 {
17033
17442
  }
17034
- export interface IReadMilestoneRestReturnValue_2_0 extends IMilestone_2_0 {
17443
+ export interface IReadGoalRestReturnValue_2_0 extends IGoal_2_0 {
17035
17444
  }
17036
- export interface IUpdateMilestoneRestDataParams_2_0 {
17037
- milestoneId: string;
17445
+ export interface IUpdateGoalRestDataParams_2_0 {
17446
+ goalId: string;
17038
17447
  }
17039
- export interface IUpdateMilestoneRestDataBody_2_0 extends Partial<Omit<IMilestone_2_0, keyof IEntityMeta>> {
17448
+ export interface IUpdateGoalRestDataBody_2_0 extends Partial<Omit<IGoal_2_0, keyof IEntityMeta>> {
17040
17449
  }
17041
- export interface IUpdateMilestoneRestData_2_0 extends IUpdateMilestoneRestDataBody_2_0, IUpdateMilestoneRestDataParams_2_0 {
17450
+ export interface IUpdateGoalRestData_2_0 extends IUpdateGoalRestDataBody_2_0, IUpdateGoalRestDataParams_2_0 {
17042
17451
  }
17043
- export interface IUpdateMilestoneRestReturnValue_2_0 {
17452
+ export interface IUpdateGoalRestReturnValue_2_0 {
17044
17453
  }
17045
- export interface IDeleteMilestoneRestDataParams_2_0 {
17046
- milestoneId: string;
17454
+ export interface IDeleteGoalRestDataParams_2_0 {
17455
+ goalId: string;
17047
17456
  }
17048
- export interface IDeleteMilestoneRestData_2_0 extends IDeleteMilestoneRestDataParams_2_0 {
17457
+ export interface IDeleteGoalRestData_2_0 extends IDeleteGoalRestDataParams_2_0 {
17049
17458
  }
17050
- export interface IDeleteMilestoneRestReturnValue_2_0 {
17459
+ export interface IDeleteGoalRestReturnValue_2_0 {
17051
17460
  }
17052
17461
  declare const uploadResumableTypes: readonly [
17053
17462
  "snapshots",
@@ -17154,6 +17563,204 @@ export interface IGenerateNluScoresRestData_2_0 extends IGenerateNluScoresRestDa
17154
17563
  }
17155
17564
  export interface IGenerateNluScoresRestReturnValue_2_0 {
17156
17565
  }
17566
+ /**
17567
+ * @openapi
17568
+ *
17569
+ * components:
17570
+ * schemas:
17571
+ * IAiAgentData_2_0:
17572
+ * type: object
17573
+ * properties:
17574
+ * name:
17575
+ * type: string
17576
+ * example: "Cognigy AI Agent"
17577
+ * image:
17578
+ * type: string
17579
+ * description: Avatar of the AI Agent.
17580
+ * example: "https://cognigy.com/ai-agent.png"
17581
+ * imageOptimizedFormat:
17582
+ * type: boolean
17583
+ * description: Whether the optimized image format defined by Cognigy is used.
17584
+ * example: true
17585
+ * knowledgeReferenceId:
17586
+ * type: string
17587
+ * format: uuid
17588
+ * description: A referenceId of a Knowledge Store this Agent will use as base knowledge.
17589
+ * example: "c7b3b3b3-3b3b-3b3b-3b3b-3b3b3b3b3b3b"
17590
+ * description:
17591
+ * type: string
17592
+ * maxLength: 1000
17593
+ * description: A short description of the AI Agent, up to 1000 characters.
17594
+ * example: "I am a virtual assistant that can help you with your questions."
17595
+ * speakingStyle:
17596
+ * type: object
17597
+ * properties:
17598
+ * completeness:
17599
+ * type: string
17600
+ * formality:
17601
+ * type: string
17602
+ * example: { "completeness": "concise", "formality": "formal" }
17603
+ * safetySettings:
17604
+ * type: object
17605
+ * properties:
17606
+ * avoidHarmfulContent:
17607
+ * type: boolean
17608
+ * avoidUngroundedContent:
17609
+ * type: boolean
17610
+ * avoidCopyrightInfringements:
17611
+ * type: boolean
17612
+ * preventJailbreakAndManipulation:
17613
+ * type: boolean
17614
+ * contactProfilesOption:
17615
+ * type: string
17616
+ * enum:
17617
+ * - "none"
17618
+ * - "selectedProfileFields"
17619
+ * - "completeProfile"
17620
+ * - "profileMemoriesOnly"
17621
+ * description: Option to enable or customize Contact profiles selection for the AI Agent.
17622
+ * example: "selectedProfileFields"
17623
+ * contactProfilesSelected:
17624
+ * type: array
17625
+ * items:
17626
+ * type: string
17627
+ * description: Selected contact profiles for the AI Agent, it is used only when contactProfilesOption is set to 'selectedProfileFields'.
17628
+ * example: ["name", "email"]
17629
+ * instructions:
17630
+ * type: string
17631
+ * description: Instructions for the AI Agent.
17632
+ * example: "I can help you with your questions, provide information and much more."
17633
+ * maxLength: 1000
17634
+ * IAiAgent_2_0:
17635
+ * allOf:
17636
+ * - $ref: '#/components/schemas/IAiAgentData_2_0'
17637
+ * - $ref: '#/components/schemas/IEntityMeta'
17638
+ */
17639
+ export interface IAiAgent_2_0 {
17640
+ _id: TMongoId;
17641
+ name: string;
17642
+ referenceId: string;
17643
+ image: string;
17644
+ imageOptimizedFormat: boolean;
17645
+ instructions: string;
17646
+ knowledgeReferenceId: string;
17647
+ description: string;
17648
+ speakingStyle: ISpeakingStyle;
17649
+ safetySettings: ISafetySettings;
17650
+ contactProfilesOption: TContactProfileOptions;
17651
+ contactProfilesSelected: string[];
17652
+ projectReference: TMongoId;
17653
+ organisationReference: TMongoId;
17654
+ createdAt: number;
17655
+ lastChanged: number;
17656
+ createdBy: TMongoId;
17657
+ lastChangedBy: TMongoId;
17658
+ }
17659
+ export interface ICreateAiAgentRestDataBody_2_0 extends IProjectScope, Partial<Omit<IAiAgent_2_0, keyof IEntityMeta | "referenceId" | "organistionId">> {
17660
+ }
17661
+ export interface ICreateAiAgentRestData_2_0 extends ICreateAiAgentRestDataBody_2_0 {
17662
+ }
17663
+ export interface ICreateAiAgentRestReturnValue_2_0 extends IAiAgent_2_0 {
17664
+ }
17665
+ export interface IUpdateAiAgentRestDataBody_2_0 extends Partial<Omit<IAiAgent_2_0, keyof IEntityMeta | "referenceId" | "organistionId">> {
17666
+ }
17667
+ export interface IUpdateAiAgentRestDataParams_2_0 {
17668
+ aiAgentId: string;
17669
+ }
17670
+ export interface IUpdateAiAgentRestData_2_0 extends IUpdateAiAgentRestDataBody_2_0, IUpdateAiAgentRestDataParams_2_0 {
17671
+ }
17672
+ export interface IUpdateAiAgentRestReturnValue_2_0 {
17673
+ }
17674
+ export interface IReadAiAgentRestDataParams_2_0 {
17675
+ aiAgentId: string;
17676
+ }
17677
+ export interface IReadAiAgentRestData_2_0 extends IReadAiAgentRestDataParams_2_0 {
17678
+ }
17679
+ export interface IReadAiAgentRestReturnValue_2_0 extends IAiAgent_2_0 {
17680
+ }
17681
+ export interface IIndexAiAgentsRestData_2_0 extends IRestPagination<IAiAgent_2_0>, IProjectScope {
17682
+ }
17683
+ export interface IIndexAiAgentsRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<IAiAgent_2_0> {
17684
+ }
17685
+ export interface IDeleteAiAgentRestDataParams_2_0 {
17686
+ aiAgentId: string;
17687
+ }
17688
+ export interface IDeleteAiAgentRestData_2_0 extends IDeleteAiAgentRestDataParams_2_0 {
17689
+ }
17690
+ export interface IDeleteAiAgentRestReturnValue_2_0 {
17691
+ }
17692
+ /**
17693
+ * @openapi
17694
+ * components:
17695
+ * schemas:
17696
+ * IAiAgentHiringTemplate_2_0:
17697
+ * type: object
17698
+ * properties:
17699
+ * templateId:
17700
+ * type: string
17701
+ * description: The ID of the AI Agent template to hire.
17702
+ * example: RetailAssistant-Rita
17703
+ * aiAgentName:
17704
+ * type: string
17705
+ * description: The name of the AI Agent.
17706
+ * example: Rita
17707
+ * aiAgentFileName:
17708
+ * type: string
17709
+ * description: The file name of the AI Agent.
17710
+ * example: Rita.tar
17711
+ * aiAgentImage:
17712
+ * type: string
17713
+ * description: The image of the AI Agent.
17714
+ * example: https://cognigy.com/rita.png
17715
+ * aiAgentDescription:
17716
+ * type: string
17717
+ * description: A short description of the AI Agent, up to 1000 characters.
17718
+ * example: "I am a virtual assistant that can help you with your questions."
17719
+ *
17720
+ */
17721
+ export interface IAiAgentHiringTemplate_2_0 {
17722
+ templateId: string;
17723
+ aiAgentName: string;
17724
+ aiAgentFileName: string;
17725
+ aiAgentImage: string;
17726
+ aiAgentDescription: string;
17727
+ }
17728
+ export interface IGetAiAgentHiringTemplatesRestData_2_0 {
17729
+ }
17730
+ export interface IGetAiAgentHiringTemplatesRestReturnValue_2_0 {
17731
+ templates: IAiAgentHiringTemplate_2_0[];
17732
+ }
17733
+ /**
17734
+ * @openapi
17735
+ * components:
17736
+ * schemas:
17737
+ * IAiAgentTemplateId_2_0:
17738
+ * type: object
17739
+ * properties:
17740
+ * templateId:
17741
+ * type: string
17742
+ * description: The ID of the AI Agent template to hire.
17743
+ * example: insurance-agent-olivia
17744
+ * overrideAiAgentReferenceId:
17745
+ * type: string
17746
+ * description: The reference ID of the AI Agent to override the AI Agent from the hired package.
17747
+ * example: 5f7b1b1b-7b1b-4b1b-9b1b-7b1b1b1b1b1b
17748
+ */
17749
+ export interface IHireAiAgentRestDataBody_2_0 extends IProjectScope {
17750
+ templateId: string;
17751
+ overrideAiAgentReferenceId?: string;
17752
+ }
17753
+ export interface IHireAiAgentRestData_2_0 extends IHireAiAgentRestDataBody_2_0 {
17754
+ }
17755
+ export interface IHireAiAgentRestReturnValue_2_0 {
17756
+ }
17757
+ export interface IValidateAiAgentNameRestDataBody_2_0 extends IProjectScope {
17758
+ name: string;
17759
+ }
17760
+ export interface IValidateAiAgentNameRestData_2_0 extends IValidateAiAgentNameRestDataBody_2_0 {
17761
+ }
17762
+ export interface IValidateAiAgentNameRestReturnValue_2_0 {
17763
+ }
17157
17764
  export interface ResourcesAPIGroup_2_0 {
17158
17765
  searchResources: TRestAPIOperation<ISearchResourcesRestData_2_0, ISearchResourcesRestReturnValue_2_0>;
17159
17766
  indexFlows: TRestAPIOperation<TRestAPIOptionalParameter<IIndexFlowsRestData_2_0>, IIndexFlowsRestReturnValue_2_0>;
@@ -17220,11 +17827,11 @@ export interface ResourcesAPIGroup_2_0 {
17220
17827
  readEndpoint: TRestAPIOperation<IReadEndpointRestData_2_0, IReadEndpointRestReturnValue_2_0>;
17221
17828
  updateEndpoint: TRestAPIOperation<IUpdateEndpointRestData_2_0, IUpdateEndpointRestReturnValue_2_0>;
17222
17829
  deleteEndpoint: TRestAPIOperation<IDeleteEndpointRestData_2_0, IDeleteEndpointRestReturnValue_2_0>;
17223
- indexMilestones: TRestAPIOperation<TRestAPIOptionalParameter<IIndexMilestonesRestData_2_0>, IIndexMilestonesRestReturnValue_2_0>;
17224
- createMilestone: TRestAPIOperation<ICreateMilestoneRestData_2_0, ICreateMilestoneRestReturnValue_2_0>;
17225
- readMilestone: TRestAPIOperation<IReadMilestoneRestData_2_0, IReadMilestoneRestReturnValue_2_0>;
17226
- updateMilestone: TRestAPIOperation<IUpdateMilestoneRestData_2_0, IUpdateMilestoneRestReturnValue_2_0>;
17227
- deleteMilestone: TRestAPIOperation<IDeleteMilestoneRestData_2_0, IDeleteMilestoneRestReturnValue_2_0>;
17830
+ indexGoals: TRestAPIOperation<TRestAPIOptionalParameter<IIndexGoalsRestData_2_0>, IIndexGoalsRestReturnValue_2_0>;
17831
+ createGoal: TRestAPIOperation<ICreateGoalRestData_2_0, ICreateGoalRestReturnValue_2_0>;
17832
+ readGoal: TRestAPIOperation<IReadGoalRestData_2_0, IReadGoalRestReturnValue_2_0>;
17833
+ updateGoal: TRestAPIOperation<IUpdateGoalRestData_2_0, IUpdateGoalRestReturnValue_2_0>;
17834
+ deleteGoal: TRestAPIOperation<IDeleteGoalRestData_2_0, IDeleteGoalRestReturnValue_2_0>;
17228
17835
  indexPlaybooks: TRestAPIOperation<TRestAPIOptionalParameter<IIndexPlaybooksRestData_2_0>, IIndexPlaybooksRestReturnValue_2_0>;
17229
17836
  batchPlaybooks: TRestAPIOperation<IBatchPlaybooksRestData_2_0, IBatchPlaybooksRestReturnValue_2_0>;
17230
17837
  createPlaybook: TRestAPIOperation<ICreatePlaybookRestData_2_0, ICreatePlaybookRestReturnValue_2_0>;
@@ -17363,6 +17970,14 @@ export interface ResourcesAPIGroup_2_0 {
17363
17970
  readAgentAssistConfig: TRestAPIOperation<IReadAgentAssistConfigRestData_2_0, IReadAgentAssistConfigRestReturnValue_2_0>;
17364
17971
  updateAgentAssistConfig: TRestAPIOperation<IUpdateAgentAssistConfigRestData_2_0, IUpdateAgentAssistConfigRestReturnValue_2_0>;
17365
17972
  deleteAgentAssistConfig: TRestAPIOperation<IDeleteAgentAssistConfigRestData_2_0, IDeleteAgentAssistConfigRestReturnValue_2_0>;
17973
+ createAiAgent: TRestAPIOperation<ICreateAiAgentRestData_2_0, ICreateAiAgentRestReturnValue_2_0>;
17974
+ updateAiAgent: TRestAPIOperation<IUpdateAiAgentRestData_2_0, IUpdateAiAgentRestReturnValue_2_0>;
17975
+ readAiAgent: TRestAPIOperation<IReadAiAgentRestData_2_0, IReadAiAgentRestReturnValue_2_0>;
17976
+ indexAiAgents: TRestAPIOperation<IIndexAiAgentsRestData_2_0, IIndexAiAgentsRestReturnValue_2_0>;
17977
+ deleteAiAgent: TRestAPIOperation<IDeleteAiAgentRestData_2_0, IDeleteAiAgentRestReturnValue_2_0>;
17978
+ validateAiAgentName: TRestAPIOperation<IValidateAiAgentNameRestData_2_0, IValidateAiAgentNameRestReturnValue_2_0>;
17979
+ getAiAgentHiringTemplates: TRestAPIOperation<IGetAiAgentHiringTemplatesRestData_2_0, IGetAiAgentHiringTemplatesRestReturnValue_2_0>;
17980
+ hireAiAgent: TRestAPIOperation<IHireAiAgentRestData_2_0, IHireAiAgentRestReturnValue_2_0>;
17366
17981
  generateNodeOutput: TRestAPIOperation<IGenerateNodeOutputRestData_2_0, IGenerateNodeOutputRestReturnValue_2_0>;
17367
17982
  indexLargeLanguageModels: TRestAPIOperation<IIndexLargeLanguageModelsRestData_2_0, IIndexLargeLanguageModelsRestReturnValue_2_0>;
17368
17983
  createLargeLanguageModel: TRestAPIOperation<ICreateLargeLanguageModelRestData_2_0, ICreateLargeLanguageModelRestReturnValue_2_0>;
@@ -17960,6 +18575,12 @@ export interface InsightsAPIGroup_2_0 {
17960
18575
  }>;
17961
18576
  }
17962
18577
  declare function InsightsAPIGroup_2_0(instance: Base): InsightsAPIGroup_2_0;
18578
+ export interface JWTAuthAPIGroup_2_0 {
18579
+ collaborationJWT: TRestAPIOperation<void, {
18580
+ token: string;
18581
+ }>;
18582
+ }
18583
+ declare function JWTAuthAPIGroup_2_0(instance: Base): JWTAuthAPIGroup_2_0;
17963
18584
  export interface IProfilePrivacyPolicy {
17964
18585
  accepted: boolean;
17965
18586
  meta?: {
@@ -17968,6 +18589,11 @@ export interface IProfilePrivacyPolicy {
17968
18589
  };
17969
18590
  };
17970
18591
  }
18592
+ export interface IMemory {
18593
+ id: string;
18594
+ timestamp: string;
18595
+ text: string;
18596
+ }
17971
18597
  /**
17972
18598
  * @openapi
17973
18599
  *
@@ -18007,6 +18633,22 @@ export interface IProfile_2_0 {
18007
18633
  *
18008
18634
  * components:
18009
18635
  * schemas:
18636
+ * IMemory:
18637
+ * type: object
18638
+ * properties:
18639
+ * id:
18640
+ * type: string
18641
+ * description: Unique identifier for the memory
18642
+ * example: "123456"
18643
+ * timestamp:
18644
+ * type: string
18645
+ * format: date-time
18646
+ * description: The timestamp of when the memory was created
18647
+ * example: "2024-09-23T08:37:00Z"
18648
+ * text:
18649
+ * type: string
18650
+ * description: The text content of the memory
18651
+ * example: "This is a memory."
18010
18652
  * IFlattenedProfile_2_0:
18011
18653
  * type: object
18012
18654
  * properties:
@@ -18021,6 +18663,11 @@ export interface IProfile_2_0 {
18021
18663
  * items:
18022
18664
  * type: string
18023
18665
  * example: buyer
18666
+ * memories:
18667
+ * type: array
18668
+ * items:
18669
+ * $ref: '#/components/schemas/IMemory'
18670
+ * description: Array of memories associated with the profile.
18024
18671
  * firstname:
18025
18672
  * type: string
18026
18673
  * example: Max
@@ -18039,11 +18686,12 @@ export interface IFlattenedProfile_2_0 {
18039
18686
  accepted_gdpr: boolean;
18040
18687
  privacy_policy: IProfilePrivacyPolicy;
18041
18688
  goals?: string[];
18689
+ memories?: IMemory[];
18042
18690
  firstname?: string;
18043
18691
  lastname?: string;
18044
18692
  email?: string;
18045
18693
  profilepic?: string;
18046
- [key: string]: string | number | boolean | string[] | IProfilePrivacyPolicy;
18694
+ [key: string]: string | number | boolean | string[] | IMemory[] | IProfilePrivacyPolicy | object;
18047
18695
  }
18048
18696
  /**
18049
18697
  * @openapi
@@ -18144,6 +18792,7 @@ export interface IProfileSchema_2_0 {
18144
18792
  accepted_gdpr: "boolean";
18145
18793
  privacy_policy: "object";
18146
18794
  goals: "object";
18795
+ memories: "object";
18147
18796
  [key: string]: "string" | "boolean" | "number" | "object";
18148
18797
  };
18149
18798
  details: IProfileSchemaEntry_2_0[];
@@ -19178,7 +19827,7 @@ declare const actionTypes: readonly [
19178
19827
  "cancelTask",
19179
19828
  "changePlaybookStepOrder",
19180
19829
  "cloneFlow",
19181
- "cloneMilestone",
19830
+ "cloneGoal",
19182
19831
  "cloneLargeLanguageModel",
19183
19832
  "configureIdentityProvider",
19184
19833
  "createKnowledgeSearchIndex",
@@ -19189,6 +19838,7 @@ declare const actionTypes: readonly [
19189
19838
  "deprecatePassword",
19190
19839
  "exportLexicons",
19191
19840
  "followSession",
19841
+ "hireAiAgent",
19192
19842
  "importIntents",
19193
19843
  "importIntoLexicon",
19194
19844
  "ingestKnowledgeStore",
@@ -19290,8 +19940,9 @@ export declare type TActionType = typeof actionTypes[number];
19290
19940
  * - trainerRecord
19291
19941
  * - user
19292
19942
  * - yesNoIntent
19943
+ * - aiAgent
19293
19944
  */
19294
- export declare type TResourceTypeAdditional = "aicopilotconfig" | "apiKey" | "analytics" | "connectionField" | "conversation" | "examplesentence" | "flowState" | "functionInstance" | "intent" | "keyphrase" | "learningsentence" | "lexiconEntry" | "lexiconKeyphrase" | "lexiconSlot" | "mergePackage" | "node" | "playbookStep" | "playbookStepAssert" | "profile" | "profileSchema" | "project" | "projectsettings" | "snippet" | "synonym" | "slotFiller" | "tag" | "task" | "trainerRecord" | "yesNoIntent" | "user";
19945
+ export declare type TResourceTypeAdditional = "aicopilotconfig" | "apiKey" | "analytics" | "connectionField" | "conversation" | "examplesentence" | "flowState" | "functionInstance" | "intent" | "keyphrase" | "learningsentence" | "lexiconEntry" | "lexiconKeyphrase" | "lexiconSlot" | "mergePackage" | "node" | "playbookStep" | "playbookStepAssert" | "profile" | "profileSchema" | "project" | "projectsettings" | "snippet" | "synonym" | "slotFiller" | "tag" | "task" | "trainerRecord" | "yesNoIntent" | "user" | "aiAgent";
19295
19946
  /**
19296
19947
  * @openapi
19297
19948
  * components:
@@ -20436,6 +21087,54 @@ export interface IDeleteOrganisationRestData_2_0 extends IDeleteOrganisationRest
20436
21087
  }
20437
21088
  export interface IDeleteOrganisationRestReturnValue_2_0 {
20438
21089
  }
21090
+ /**
21091
+ * @openapi
21092
+ *
21093
+ * components:
21094
+ * schemas:
21095
+ * IPinResourceRestDataBody_2_0:
21096
+ * type: object
21097
+ * properties:
21098
+ * resourceType:
21099
+ * $ref: '#/components/schemas/TPinnableResourceType'
21100
+ * resourceId:
21101
+ * $ref: '#/components/schemas/TMongoId'
21102
+ * pin:
21103
+ * type: boolean
21104
+ * */
21105
+ export interface IPinResourceRestDataBody_2_0 {
21106
+ resourceType: TPinnableResourceType;
21107
+ resourceId: TMongoId;
21108
+ pin: boolean;
21109
+ }
21110
+ export interface IPinResourceRestData_2_0 extends IPinResourceRestDataBody_2_0 {
21111
+ }
21112
+ export interface IPinResourceRestReturnValue_2_0 {
21113
+ }
21114
+ export interface IGetPinnedResourcesRestDataQuery_2_0 {
21115
+ resourceType: TPinnableResourceType;
21116
+ }
21117
+ export interface IGetPinnedResourcesRestData_2_0 extends IGetPinnedResourcesRestDataQuery_2_0 {
21118
+ }
21119
+ /**
21120
+ * @openapi
21121
+ *
21122
+ * components:
21123
+ * schemas:
21124
+ * IGetPinnedResourcesRestReturnValue_2_0:
21125
+ * type: object
21126
+ * properties:
21127
+ * type:
21128
+ * $ref: '#/components/schemas/TPinnableResourceType'
21129
+ * pinnedIds:
21130
+ * type: array
21131
+ * items:
21132
+ * $ref: '#/components/schemas/TMongoId'
21133
+ */
21134
+ export interface IGetPinnedResourcesRestReturnValue_2_0 {
21135
+ type: TPinnableResourceType;
21136
+ pinnedIds: TMongoId[];
21137
+ }
20439
21138
  export interface AdministrationAPIGroup_2_0 {
20440
21139
  requestPasswordReset: TRestAPIOperation<IRequestPasswordResetRestData_2_0, IRequestPasswordResetRestReturnValue_2_0>;
20441
21140
  validatePasswordResetToken: TRestAPIOperation<IValidatePasswordResetTokenRestData_2_0, IValidatePasswordResetTokenRestReturnValue_2_0>;
@@ -20488,6 +21187,8 @@ export interface AdministrationAPIGroup_2_0 {
20488
21187
  readVoiceGatewayAccount: TRestAPIOperation<void, IReadVoiceGatewayAccountRestReturnValue_2_0>;
20489
21188
  readOrganisationPolicies: TRestAPIOperation<void, IReadOrganisationRestReturnValue_2_0>;
20490
21189
  readOrganisationKnowledgeChunksCount: TRestAPIOperation<void, IReadOrganisationKnowledgeChunksCountRestReturnValue_2_0>;
21190
+ pinResourceMe: TRestAPIOperation<IPinResourceRestData_2_0, IPinResourceRestReturnValue_2_0>;
21191
+ getPinnedResourcesMe: TRestAPIOperation<IGetPinnedResourcesRestData_2_0, IGetPinnedResourcesRestReturnValue_2_0>;
20491
21192
  }
20492
21193
  declare function AdministrationAPIGroup_2_0(instance: Base): AdministrationAPIGroup_2_0;
20493
21194
  /**
@@ -20727,6 +21428,7 @@ export interface IUserManagementIndexItem_2_0 {
20727
21428
  lastChanged: number;
20728
21429
  createdBy: TMongoId;
20729
21430
  lastChangedBy: TMongoId;
21431
+ lastActive: number;
20730
21432
  }
20731
21433
  export interface IIndexUsersRestManagementData_2_0 extends IRestPagination<IUserManagementIndexItem_2_0>, IOrganisationScope {
20732
21434
  }
@@ -20881,7 +21583,7 @@ export interface AnalyticsAPIGroup_2_0 {
20881
21583
  updateAnalyticsRecords: TRestAPIOperation<IUpdateAnalyticsRecordsRestData_2_0, IUpdateAnalyticsRecordsRestReturnValue_2_0>;
20882
21584
  }
20883
21585
  declare function AnalyticsAPIGroup_2_0(instance: Base): AnalyticsAPIGroup_2_0;
20884
- export declare type TRestAPIGroupsTypeByConfiguration<T extends IRestAPIClientConfig> = TResourceAPIVersionType<T> & TInsightsAPIVersionType<T> & TMetricsAPIVersionType<T> & TSessionAPIVersionType<T> & TExternalAPIVersionType<T> & TAdministrationAPIVersionType<T> & TManagementAPIVersionType<T> & TAnalyticsAPIVersionType<T>;
21586
+ export declare type TRestAPIGroupsTypeByConfiguration<T extends IRestAPIClientConfig> = TResourceAPIVersionType<T> & TJWTAuthAPIVersionType<T> & TInsightsAPIVersionType<T> & TMetricsAPIVersionType<T> & TSessionAPIVersionType<T> & TExternalAPIVersionType<T> & TAdministrationAPIVersionType<T> & TManagementAPIVersionType<T> & TAnalyticsAPIVersionType<T>;
20885
21587
  export declare type TResourceAPIVersionType<T> = T extends {
20886
21588
  versions: {
20887
21589
  resources: "2.0";
@@ -20892,6 +21594,11 @@ export declare type TInsightsAPIVersionType<T> = T extends {
20892
21594
  insights: "2.0";
20893
21595
  };
20894
21596
  } ? InsightsAPIGroup_2_0 : InsightsAPIGroup_2_0;
21597
+ export declare type TJWTAuthAPIVersionType<T> = T extends {
21598
+ versions: {
21599
+ jwt: "2.0";
21600
+ };
21601
+ } ? JWTAuthAPIGroup_2_0 : JWTAuthAPIGroup_2_0;
20895
21602
  export declare type TMetricsAPIVersionType<T> = T extends {
20896
21603
  versions: {
20897
21604
  metrics: "1.0";