@cognigy/rest-api-client 2025.25.0 → 2026.2.0-rc1

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 (169) hide show
  1. package/CHANGELOG.md +10 -0
  2. package/README.md +15 -0
  3. package/build/apigroups/InsightsAPIGroup_2_1.js +27 -0
  4. package/build/apigroups/ResourcesAPIGroup_2_0.js +140 -375
  5. package/build/apigroups/SimulationAPIGroup_2_0.js +33 -18
  6. package/build/apigroups/aiAgentsV2/agent.js +3 -0
  7. package/build/apigroups/aiAgentsV2/agentAPI.js +38 -0
  8. package/build/apigroups/aiAgentsV2/agentPersona.js +3 -0
  9. package/build/apigroups/aiAgentsV2/agentPersonaAPI.js +38 -0
  10. package/build/apigroups/aiAgentsV2/tool.js +3 -0
  11. package/build/apigroups/aiAgentsV2/toolAPI.js +35 -0
  12. package/build/apigroups/aiAgentsV2/toolDescriptor.js +3 -0
  13. package/build/apigroups/aiAgentsV2/toolDescriptorAPI.js +13 -0
  14. package/build/apigroups/index.js +3 -1
  15. package/build/authentication/AuthenticationAPI.js +1 -0
  16. package/build/shared/charts/createNodeDescriptor.js +1 -0
  17. package/build/shared/charts/descriptors/analytics/overwriteAnalytics.js +14 -0
  18. package/build/shared/charts/descriptors/analytics/updateProfile.js +5 -0
  19. package/build/shared/charts/descriptors/connectionNodes/smtp/emailNotification.js +7 -0
  20. package/build/shared/charts/descriptors/connectionNodes/smtp/index.js +5 -1
  21. package/build/shared/charts/descriptors/connectionNodes/smtp/oAuth2ClientCredentialsConnection.js +15 -0
  22. package/build/shared/charts/descriptors/connectionNodes/smtp/oAuth2JwtBearerConnection.js +13 -0
  23. package/build/shared/charts/descriptors/connectionNodes/smtp/sendEmail.js +63 -10
  24. package/build/shared/charts/descriptors/connectionNodes/speechProviders/elevenlabsSpeechProviderConnection.js +52 -0
  25. package/build/shared/charts/descriptors/connectionNodes/speechProviders/index.js +8 -7
  26. package/build/shared/charts/descriptors/index.js +6 -0
  27. package/build/shared/charts/descriptors/message/question/question.js +254 -59
  28. package/build/shared/charts/descriptors/message/say.js +3 -0
  29. package/build/shared/charts/descriptors/service/agentTools/executeWorkflowTool.js +239 -0
  30. package/build/shared/charts/descriptors/service/agentTools/handoverToHumanAgentTool.js +783 -0
  31. package/build/shared/charts/descriptors/service/agentTools/sendEmailTool.js +33 -4
  32. package/build/shared/charts/descriptors/service/aiAgent/aiAgentJob.js +25 -20
  33. package/build/shared/charts/descriptors/service/aiAgent/aiAgentJobCallMCPTool.js +10 -6
  34. package/build/shared/charts/descriptors/service/aiAgent/aiAgentJobMCPTool.js +57 -1
  35. package/build/shared/charts/descriptors/service/aiAgent/helpers/createToolDefinitions.js +10 -1
  36. package/build/shared/charts/descriptors/service/aiAgent/helpers/parseMcpHeaders.js +26 -0
  37. package/build/shared/charts/descriptors/service/aiAgentV2.js +89 -0
  38. package/build/shared/charts/descriptors/service/handoverV2.js +1 -1
  39. package/build/shared/charts/descriptors/service/httpRequest.js +3 -0
  40. package/build/shared/charts/descriptors/service/index.js +9 -1
  41. package/build/shared/charts/descriptors/service/llmPrompt/LLMPromptV2.js +26 -17
  42. package/build/shared/charts/descriptors/service/llmPrompt/llmPromptMCPTool.js +57 -1
  43. package/build/shared/charts/descriptors/voice/mappers/setSessionConfig.mapper.js +75 -15
  44. package/build/shared/charts/descriptors/voice/mappers/transfer.mapper.js +27 -5
  45. package/build/shared/charts/descriptors/voice/nodes/sessionSpeechParameters.js +67 -2
  46. package/build/shared/charts/descriptors/voicegateway2/nodes/play.js +7 -0
  47. package/build/shared/charts/descriptors/voicegateway2/nodes/setSessionConfig.js +149 -4
  48. package/build/shared/charts/descriptors/voicegateway2/nodes/transfer.js +137 -4
  49. package/build/shared/errors/ErrorCode.js +2 -1
  50. package/build/shared/errors/ErrorCollection.js +1 -0
  51. package/build/shared/helper/BaseContext.js +1 -1
  52. package/build/shared/interfaces/amqpInterface.js +1 -0
  53. package/build/shared/interfaces/generativeAI/IGenerativeAIModels.js +1 -0
  54. package/build/shared/interfaces/handover.js +1 -0
  55. package/build/shared/interfaces/handoverProviders.js +0 -1
  56. package/build/shared/interfaces/messageAPI/endpoints.js +4 -1
  57. package/build/shared/interfaces/resources/IAuditEvent.js +1 -0
  58. package/build/shared/interfaces/resources/IChart.js +10 -1
  59. package/build/shared/interfaces/resources/IChartNode.js +32 -4
  60. package/build/shared/interfaces/resources/IEndpoint.js +1 -0
  61. package/build/shared/interfaces/resources/INodeDescriptorSet.js +8 -0
  62. package/build/shared/interfaces/resources/TResourceType.js +1 -0
  63. package/build/shared/interfaces/resources/chart/IChartExecutableNode.js +10 -1
  64. package/build/shared/interfaces/resources/knowledgeStore/IKnowledgeConnector.js +49 -0
  65. package/build/shared/interfaces/resources/knowledgeStore/IKnowledgeSource.js +1 -1
  66. package/build/shared/interfaces/resources/settings/IAudioPreviewSettings.js +7 -1
  67. package/build/shared/interfaces/restAPI/administration/user/v2.0/IExchangeCXoneTokenRest_2_0.js +3 -0
  68. package/build/shared/interfaces/restAPI/analytics/IDeleteConversationsBySessionRest_2_1.js +3 -0
  69. package/build/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/connector/ICreateKnowledgeConnectorRest_2_0.js +3 -0
  70. package/build/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/connector/IDeleteKnowledgeConnectorRest_2_0.js +3 -0
  71. package/build/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/connector/IIndexKnowledgeConnectorsRest_2_0.js +3 -0
  72. package/build/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/connector/IKnowledgeConnector_2_0.js +3 -0
  73. package/build/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/connector/IReadKnowledgeConnectorRest_2_0.js +3 -0
  74. package/build/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/connector/IRunKnowledgeConnectorRest_2_0.js +3 -0
  75. package/build/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/connector/IUpdateKnowledgeConnectorRest_2_0.js +3 -0
  76. package/build/shared/interfaces/restAPI/simulation/scheduler/ICreateSchedulerRest_2_0.js +3 -0
  77. package/build/shared/interfaces/restAPI/simulation/scheduler/IGetSchedulerRest_2_0.js +3 -0
  78. package/build/shared/interfaces/restAPI/simulation/scheduler/ISchedulerRest_2_0.js +12 -0
  79. package/build/shared/interfaces/restAPI/simulation/scheduler/IUpdateSchedulerRest_2_0.js +3 -0
  80. package/build/shared/interfaces/restAPI/simulation/simulationOverview/IGetSimulationOverviewMetricsRestData_2_0.js +3 -0
  81. package/build/shared/interfaces/restAPI/simulation/simulationOverview/IGetSuccessRateTrendRestData_2_0.js +3 -0
  82. package/build/shared/interfaces/restAPI/simulation/simulationOverview/IGetUpcomingScheduledRunsRestData_2_0.js +3 -0
  83. package/build/shared/interfaces/security/ISessionScope.js +3 -0
  84. package/build/spec/aiAgentV2.spec.js +564 -0
  85. package/dist/esm/apigroups/InsightsAPIGroup_2_1.js +13 -0
  86. package/dist/esm/apigroups/ResourcesAPIGroup_2_0.js +140 -375
  87. package/dist/esm/apigroups/SimulationAPIGroup_2_0.js +33 -18
  88. package/dist/esm/apigroups/aiAgentsV2/agent.js +2 -0
  89. package/dist/esm/apigroups/aiAgentsV2/agentAPI.js +24 -0
  90. package/dist/esm/apigroups/aiAgentsV2/agentPersona.js +2 -0
  91. package/dist/esm/apigroups/aiAgentsV2/agentPersonaAPI.js +24 -0
  92. package/dist/esm/apigroups/aiAgentsV2/aiAgentV2API.js +2 -0
  93. package/dist/esm/apigroups/aiAgentsV2/tool.js +2 -0
  94. package/dist/esm/apigroups/aiAgentsV2/toolAPI.js +21 -0
  95. package/dist/esm/apigroups/aiAgentsV2/toolDescriptor.js +2 -0
  96. package/dist/esm/apigroups/aiAgentsV2/toolDescriptorAPI.js +9 -0
  97. package/dist/esm/apigroups/index.js +1 -0
  98. package/dist/esm/authentication/AuthenticationAPI.js +1 -0
  99. package/dist/esm/shared/charts/createNodeDescriptor.js +1 -0
  100. package/dist/esm/shared/charts/descriptors/analytics/overwriteAnalytics.js +14 -0
  101. package/dist/esm/shared/charts/descriptors/analytics/updateProfile.js +5 -0
  102. package/dist/esm/shared/charts/descriptors/connectionNodes/smtp/emailNotification.js +7 -0
  103. package/dist/esm/shared/charts/descriptors/connectionNodes/smtp/index.js +5 -1
  104. package/dist/esm/shared/charts/descriptors/connectionNodes/smtp/oAuth2ClientCredentialsConnection.js +12 -0
  105. package/dist/esm/shared/charts/descriptors/connectionNodes/smtp/oAuth2JwtBearerConnection.js +10 -0
  106. package/dist/esm/shared/charts/descriptors/connectionNodes/smtp/sendEmail.js +63 -10
  107. package/dist/esm/shared/charts/descriptors/connectionNodes/speechProviders/elevenlabsSpeechProviderConnection.js +49 -0
  108. package/dist/esm/shared/charts/descriptors/connectionNodes/speechProviders/index.js +3 -3
  109. package/dist/esm/shared/charts/descriptors/index.js +7 -1
  110. package/dist/esm/shared/charts/descriptors/message/question/question.js +254 -59
  111. package/dist/esm/shared/charts/descriptors/message/say.js +3 -0
  112. package/dist/esm/shared/charts/descriptors/service/agentTools/executeWorkflowTool.js +237 -0
  113. package/dist/esm/shared/charts/descriptors/service/agentTools/handoverToHumanAgentTool.js +770 -0
  114. package/dist/esm/shared/charts/descriptors/service/agentTools/sendEmailTool.js +33 -4
  115. package/dist/esm/shared/charts/descriptors/service/aiAgent/aiAgentJob.js +25 -20
  116. package/dist/esm/shared/charts/descriptors/service/aiAgent/aiAgentJobCallMCPTool.js +10 -6
  117. package/dist/esm/shared/charts/descriptors/service/aiAgent/aiAgentJobMCPTool.js +56 -0
  118. package/dist/esm/shared/charts/descriptors/service/aiAgent/helpers/createToolDefinitions.js +10 -1
  119. package/dist/esm/shared/charts/descriptors/service/aiAgent/helpers/parseMcpHeaders.js +25 -0
  120. package/dist/esm/shared/charts/descriptors/service/aiAgentV2.js +87 -0
  121. package/dist/esm/shared/charts/descriptors/service/handoverV2.js +1 -1
  122. package/dist/esm/shared/charts/descriptors/service/httpRequest.js +3 -0
  123. package/dist/esm/shared/charts/descriptors/service/index.js +4 -0
  124. package/dist/esm/shared/charts/descriptors/service/llmPrompt/LLMPromptV2.js +33 -24
  125. package/dist/esm/shared/charts/descriptors/service/llmPrompt/llmPromptMCPTool.js +56 -0
  126. package/dist/esm/shared/charts/descriptors/voice/mappers/setSessionConfig.mapper.js +75 -15
  127. package/dist/esm/shared/charts/descriptors/voice/mappers/transfer.mapper.js +27 -5
  128. package/dist/esm/shared/charts/descriptors/voice/nodes/sessionSpeechParameters.js +67 -2
  129. package/dist/esm/shared/charts/descriptors/voicegateway2/nodes/play.js +7 -0
  130. package/dist/esm/shared/charts/descriptors/voicegateway2/nodes/setSessionConfig.js +149 -4
  131. package/dist/esm/shared/charts/descriptors/voicegateway2/nodes/transfer.js +137 -4
  132. package/dist/esm/shared/errors/ErrorCode.js +2 -1
  133. package/dist/esm/shared/errors/ErrorCollection.js +1 -0
  134. package/dist/esm/shared/helper/BaseContext.js +1 -1
  135. package/dist/esm/shared/interfaces/amqpInterface.js +1 -0
  136. package/dist/esm/shared/interfaces/generativeAI/IGenerativeAIModels.js +1 -0
  137. package/dist/esm/shared/interfaces/handover.js +1 -0
  138. package/dist/esm/shared/interfaces/handoverProviders.js +0 -1
  139. package/dist/esm/shared/interfaces/messageAPI/endpoints.js +4 -1
  140. package/dist/esm/shared/interfaces/resources/IAuditEvent.js +1 -0
  141. package/dist/esm/shared/interfaces/resources/IChart.js +10 -1
  142. package/dist/esm/shared/interfaces/resources/IChartNode.js +32 -4
  143. package/dist/esm/shared/interfaces/resources/IEndpoint.js +1 -0
  144. package/dist/esm/shared/interfaces/resources/INodeDescriptorSet.js +8 -0
  145. package/dist/esm/shared/interfaces/resources/TResourceType.js +1 -0
  146. package/dist/esm/shared/interfaces/resources/chart/IChartExecutableNode.js +10 -1
  147. package/dist/esm/shared/interfaces/resources/knowledgeStore/IKnowledgeConnector.js +46 -0
  148. package/dist/esm/shared/interfaces/resources/knowledgeStore/IKnowledgeSource.js +1 -1
  149. package/dist/esm/shared/interfaces/resources/settings/IAudioPreviewSettings.js +7 -1
  150. package/dist/esm/shared/interfaces/restAPI/administration/user/v2.0/IExchangeCXoneTokenRest_2_0.js +2 -0
  151. package/dist/esm/shared/interfaces/restAPI/analytics/IDeleteConversationsBySessionRest_2_1.js +2 -0
  152. package/dist/esm/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/connector/ICreateKnowledgeConnectorRest_2_0.js +2 -0
  153. package/dist/esm/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/connector/IDeleteKnowledgeConnectorRest_2_0.js +2 -0
  154. package/dist/esm/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/connector/IIndexKnowledgeConnectorsRest_2_0.js +2 -0
  155. package/dist/esm/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/connector/IKnowledgeConnector_2_0.js +2 -0
  156. package/dist/esm/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/connector/IReadKnowledgeConnectorRest_2_0.js +2 -0
  157. package/dist/esm/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/connector/IRunKnowledgeConnectorRest_2_0.js +2 -0
  158. package/dist/esm/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/connector/IUpdateKnowledgeConnectorRest_2_0.js +2 -0
  159. package/dist/esm/shared/interfaces/restAPI/simulation/scheduler/ICreateSchedulerRest_2_0.js +2 -0
  160. package/dist/esm/shared/interfaces/restAPI/simulation/scheduler/IGetSchedulerRest_2_0.js +2 -0
  161. package/dist/esm/shared/interfaces/restAPI/simulation/scheduler/ISchedulerRest_2_0.js +9 -0
  162. package/dist/esm/shared/interfaces/restAPI/simulation/scheduler/IUpdateSchedulerRest_2_0.js +2 -0
  163. package/dist/esm/shared/interfaces/restAPI/simulation/simulationOverview/IGetSimulationOverviewMetricsRestData_2_0.js +2 -0
  164. package/dist/esm/shared/interfaces/restAPI/simulation/simulationOverview/IGetSuccessRateTrendRestData_2_0.js +2 -0
  165. package/dist/esm/shared/interfaces/restAPI/simulation/simulationOverview/IGetUpcomingScheduledRunsRestData_2_0.js +2 -0
  166. package/dist/esm/shared/interfaces/security/ISessionScope.js +2 -0
  167. package/dist/esm/spec/aiAgentV2.spec.js +563 -0
  168. package/package.json +6 -3
  169. package/types/index.d.ts +1198 -44
package/types/index.d.ts CHANGED
@@ -1,5 +1,6 @@
1
1
  // Generated by dts-bundle-generator v6.12.0
2
2
 
3
+ import { IToolDescriptor } from '@cognigy/extension-tools';
3
4
  import { AxiosResponseHeaders } from 'axios';
4
5
 
5
6
  export declare type Options = {
@@ -534,9 +535,10 @@ export declare enum ErrorCode {
534
535
  BAD_REQUEST = 400,
535
536
  UNAUTHORIZED_ERROR = 401,
536
537
  PAYMENT_REQUIRED_ERROR = 402,
538
+ FORBIDDEN_ERROR = 403,
539
+ NOT_FOUND = 404,
537
540
  PAYLOAD_TOO_LARGE_ERROR = 413,
538
541
  TOO_MANY_REQUESTS_ERROR = 429,
539
- FORBIDDEN_ERROR = 403,
540
542
  BAD_GATEWAY = 502,
541
543
  SERVICE_UNAVAILABLE_ERROR = 503,
542
544
  GATEWAY_TIMEOUT_ERROR = 504,
@@ -872,6 +874,7 @@ export interface IErrorCollection {
872
874
  [ErrorCode.INVALID_ARGUMENT_ERROR]: typeof InvalidArgumentError;
873
875
  [ErrorCode.METHOD_NOT_ALLOWED_ERROR]: typeof MethodNotAllowedError;
874
876
  [ErrorCode.MISSING_ARGUMENT_ERROR]: typeof MissingArgumentError;
877
+ [ErrorCode.NOT_FOUND]: typeof ResourceNotFoundError;
875
878
  [ErrorCode.NETWORK_ERROR]: typeof NetworkError;
876
879
  [ErrorCode.NOT_IMPLEMENTED_ERROR]: typeof NotImplementedError;
877
880
  [ErrorCode.PAYLOAD_TOO_LARGE_ERROR]: typeof PayloadTooLargeError;
@@ -935,6 +938,7 @@ declare const referenceKeys: readonly [
935
938
  "resourceReference",
936
939
  "snapshotReference",
937
940
  "subResourceReference",
941
+ "connectorReference",
938
942
  "storeReference",
939
943
  "sourceReference"
940
944
  ];
@@ -965,6 +969,7 @@ declare const arrayTResourceType: readonly [
965
969
  "knowledgeStore",
966
970
  "knowledgeSource",
967
971
  "knowledgeChunk",
972
+ "knowledgeConnector",
968
973
  "lexicon",
969
974
  "lexiconEntry",
970
975
  "lexiconKeyphrase",
@@ -1609,6 +1614,20 @@ export interface IExchangeOneTimeTokenForRefreshTokenRestData_2_0 extends IExcha
1609
1614
  export interface IExchangeOneTimeTokenForRefreshTokenRestReturnValue_2_0 {
1610
1615
  refreshToken: string;
1611
1616
  }
1617
+ /**
1618
+ * @openapi
1619
+ *
1620
+ * components:
1621
+ * schemas:
1622
+ * IExchangeCXoneTokenRestReturnValue_2_0:
1623
+ * type: object
1624
+ * properties:
1625
+ * refreshToken:
1626
+ * type: string
1627
+ */
1628
+ export interface IExchangeCXoneTokenRestReturnValue_2_0 {
1629
+ refreshToken: string;
1630
+ }
1612
1631
  export interface AuthenticationAPI {
1613
1632
  authenticationHandler?: IAuthenticationAdapter;
1614
1633
  setCredentials: (credentials: TAuthenticationCredentials) => void;
@@ -1621,6 +1640,7 @@ export interface AuthenticationAPI {
1621
1640
  webfinger: TRestAPIOperation<IWebfingerRestData, IWebfingerRestReturnValue>;
1622
1641
  getAuthorizationCode?: (data: IGetAuthorizationCodeParameters) => Promise<IGetAuthorizationCodeResponse>;
1623
1642
  exchangeOneTimeTokenForRefreshToken: TRestAPIOperation<IExchangeOneTimeTokenForRefreshTokenRestData_2_0, IExchangeOneTimeTokenForRefreshTokenRestReturnValue_2_0>;
1643
+ exchangeCXoneToken: TRestAPIOperation<{}, IExchangeCXoneTokenRestReturnValue_2_0>;
1624
1644
  generateManagementUIAuthToken: TRestAPIOperation<void, {
1625
1645
  token: string;
1626
1646
  }>;
@@ -2353,6 +2373,7 @@ export interface IAgentAssistSettings {
2353
2373
  enableTranscriptTileChatInput?: boolean;
2354
2374
  redactTranscriptTileMessages?: boolean;
2355
2375
  enableAgentCopilotAuthentication?: boolean;
2376
+ blockNonJWTRequests?: boolean;
2356
2377
  agentCopilotAuthentication?: string;
2357
2378
  /**
2358
2379
  * Optional OAuth2 connection id for providers that require it (e.g., Genesys)
@@ -2530,6 +2551,10 @@ export interface IEndpoint extends IEntityMeta {
2530
2551
  label: string;
2531
2552
  active: boolean;
2532
2553
  };
2554
+ /**
2555
+ * Whether to enable mocking code for the node execution
2556
+ */
2557
+ enableMocking?: boolean;
2533
2558
  }
2534
2559
  export interface IGraphEndpoint {
2535
2560
  type: "endpoint";
@@ -2836,7 +2861,8 @@ declare const generativeAIModels: readonly [
2836
2861
  "text-embedding-ada-002",
2837
2862
  "luminous-embedding-128",
2838
2863
  "amazon.titan-embed-text-v2:0",
2839
- "Pharia-1-Embedding-4608"
2864
+ "Pharia-1-Embedding-4608",
2865
+ "gemini-embedding-001"
2840
2866
  ];
2841
2867
  /**
2842
2868
  * @openapi
@@ -2862,6 +2888,7 @@ declare const generativeAIModels: readonly [
2862
2888
  * - luminous-extended-control
2863
2889
  * - luminous-embedding-128
2864
2890
  * - Pharia-1-Embedding-4608
2891
+ * - gemini-embedding-001
2865
2892
  * - claude-3-opus-20240229
2866
2893
  * - custom-model
2867
2894
  * - custom-embedding-model
@@ -2942,7 +2969,8 @@ declare const audioPreviewProviders: readonly [
2942
2969
  "microsoft",
2943
2970
  "google",
2944
2971
  "aws",
2945
- "deepgram"
2972
+ "deepgram",
2973
+ "elevenlabs"
2946
2974
  ];
2947
2975
  export declare type TAudioPreviewProvider = typeof audioPreviewProviders[number];
2948
2976
  /**
@@ -3045,7 +3073,6 @@ export interface IVoiceGateway2SynthesizerParams {
3045
3073
  model?: string;
3046
3074
  }
3047
3075
  export declare type TVoiceGateway2GoogleModel = "latest_short" | "latest_long" | "command_and_search" | "phone_call" | "video" | "medical_dictation" | "medical_conversation" | "default";
3048
- export declare type VoiceGatewayDeepgramModel = "base" | "base-phonecall" | "base-meeting" | "base-finance" | "base-voicemail" | "base-conversationalai" | "base-video" | "enhanced" | "enhanced-phonecall" | "enhanced-meeting" | "enhanced-finance" | "nova" | "nova-phonecall" | "nova-2" | "nova-2-meeting" | "nova-2-phonecall" | "nova-2-voicemail" | "nova-2-finance" | "nova-2-conversationalai" | "nova-2-medical" | "nova-2-drivethru" | "nova-2-automotive" | "whisper" | "whisper-tiny" | "whisper-base" | "whisper-small" | "whisper-large";
3049
3076
  export interface IVoiceGateway2RecognizerParams {
3050
3077
  vendor?: string;
3051
3078
  language?: string;
@@ -3084,10 +3111,13 @@ export interface IVoiceGateway2RecognizerParams {
3084
3111
  asrTimeout?: number;
3085
3112
  nuanceOptions?: TVoiceGateway2NuanceOptions;
3086
3113
  deepgramOptions?: TVoiceGateway2DeepgramOptions;
3114
+ deepgramfluxOptions?: TVoiceGateway2DeepgramfluxOptions;
3087
3115
  ibmOptions?: TVoiceGateway2IbmOptions;
3088
3116
  nvidiaOptions?: TVoiceGateway2NvidiaOptions;
3089
3117
  sonioxOptions?: TVoiceGateway2SonioxOptions;
3090
- model?: TVoiceGateway2GoogleModel | VoiceGatewayDeepgramModel | string;
3118
+ speechmaticsOptions?: TVoiceGateway2SpeechmaticsOptions;
3119
+ openaiOptions?: TVoiceGateway2OpenaiOptions;
3120
+ model?: string;
3091
3121
  }
3092
3122
  export declare type TVoiceGateway2NuanceOptions = {
3093
3123
  clientId?: string;
@@ -3145,6 +3175,53 @@ export declare type TVoiceGateway2DeepgramOptions = {
3145
3175
  vadTurnoff?: number;
3146
3176
  tag?: string;
3147
3177
  };
3178
+ export declare type TVoiceGateway2DeepgramfluxOptions = {
3179
+ apiKey?: string;
3180
+ keywords?: string[];
3181
+ endpointing?: number | boolean;
3182
+ endOfTurnThreshold?: number;
3183
+ endOfTurnTimeoutMs?: number;
3184
+ };
3185
+ export declare type TVoiceGateway2SpeechmaticsOptions = {
3186
+ transcription_config?: {
3187
+ language?: string;
3188
+ additional_vocab?: string[];
3189
+ diarization?: string;
3190
+ speaker_diarization_config?: {
3191
+ speaker_sensitivity?: number;
3192
+ max_speakers?: number;
3193
+ };
3194
+ enable_partials?: boolean;
3195
+ max_delay?: number;
3196
+ max_delay_mode?: "fixed" | "flexible";
3197
+ output_locale?: string;
3198
+ punctuation_overrides?: {
3199
+ permitted_marks?: string[];
3200
+ sensitivity?: number;
3201
+ };
3202
+ operating_point?: string;
3203
+ enable_entities?: boolean;
3204
+ audio_filtering_config?: {
3205
+ volume_threshold: number;
3206
+ };
3207
+ transcript_filtering_config?: {
3208
+ remove_disfluencies: boolean;
3209
+ };
3210
+ };
3211
+ translation_config?: {
3212
+ target_languages: string[];
3213
+ enable_partials?: boolean;
3214
+ };
3215
+ audio_events_config?: {
3216
+ types?: string[];
3217
+ };
3218
+ endpointing?: number;
3219
+ };
3220
+ export declare type TVoiceGateway2OpenaiOptions = {
3221
+ model?: string;
3222
+ apiKey?: string;
3223
+ endpointing?: number;
3224
+ };
3148
3225
  export declare type TVoiceGateway2NvidiaOptions = {
3149
3226
  rivaUri?: string;
3150
3227
  maxAlternatives?: number;
@@ -3402,6 +3479,9 @@ export interface ICallEventFailoverSettings {
3402
3479
  deepgramEndpointing?: boolean;
3403
3480
  deepgramEndpointingValue?: number;
3404
3481
  dialTranscribeDeepgramTier?: string;
3482
+ deepgramfluxEndpointing?: boolean;
3483
+ deepgramfluxEndOfTurnThreshold?: number;
3484
+ deepgramfluxEndOfTurnTimeoutMs?: number;
3405
3485
  mediaPath?: TVoiceGateway2MediaPath;
3406
3486
  anchorMedia?: boolean;
3407
3487
  }
@@ -7754,6 +7834,9 @@ export interface IWebrtcWidgetConfig {
7754
7834
  * enableAgentCopilotAuthentication:
7755
7835
  * type: boolean
7756
7836
  * description: Enable authentication for agent copilot
7837
+ * blockNonJWTRequests:
7838
+ * type: boolean
7839
+ * description: Block requests made to the endpoint without a JWT token
7757
7840
  * agentCopilotAuthentication:
7758
7841
  * type: string
7759
7842
  * description: Authentication connection reference Id for agent copilot
@@ -7845,6 +7928,8 @@ export interface IEndpoint_2_0 {
7845
7928
  sipConnectivityInfo?: ISipConnectivityInfo;
7846
7929
  /** The label of the webrtc widget */
7847
7930
  webrtcWidgetConfig?: IWebrtcWidgetConfig;
7931
+ /** Whether to enable mocking code for the node execution */
7932
+ enableMocking: boolean;
7848
7933
  }
7849
7934
  export interface ITransformerFunction_2_0 {
7850
7935
  /**
@@ -9209,6 +9294,10 @@ export interface IGraphAgentAssistConfig {
9209
9294
  * items:
9210
9295
  * type: string
9211
9296
  * description: MongoDB ObjectId representing a project
9297
+ * example:
9298
+ * - "68edf5dd4c931f68d31111"
9299
+ * - "690b02fc100e454245adde111"
9300
+ * - "68e6eda61ff68d2111"
9212
9301
  *
9213
9302
  * IGlobalResourceFields_2_0:
9214
9303
  * allOf:
@@ -9440,6 +9529,7 @@ export interface ICodeNodeParams extends ICodeNodeBasicParams {
9440
9529
  hasError?: boolean;
9441
9530
  transpiled?: string;
9442
9531
  };
9532
+ IsMockCodeExecution?: boolean;
9443
9533
  }
9444
9534
  export interface ICodeNodeBasicParams extends INodeFunctionBaseParams {
9445
9535
  config: {
@@ -9487,8 +9577,8 @@ export interface IOutputEventPayload {
9487
9577
  disableSensitiveLogging?: boolean;
9488
9578
  }
9489
9579
  export interface IOutputEventMetadata {
9490
- flowReferenceId: string;
9491
- outputType: "node" | "intent";
9580
+ flowReferenceId?: string;
9581
+ outputType?: "node" | "intent";
9492
9582
  nodeLabel?: string;
9493
9583
  nodeType?: string;
9494
9584
  nodeId?: string;
@@ -9496,6 +9586,7 @@ export interface IOutputEventMetadata {
9496
9586
  intentId?: string;
9497
9587
  intentReferenceId?: string;
9498
9588
  intent?: string;
9589
+ isMockedCodeExecution?: boolean;
9499
9590
  }
9500
9591
  export interface ISwitchedFlowEventPayload {
9501
9592
  fromFlowId: string;
@@ -9734,6 +9825,13 @@ export interface ILoadAiAgentNodeParams extends INodeFunctionBaseParams {
9734
9825
  keyWarning: string;
9735
9826
  };
9736
9827
  }
9828
+ export interface IAiAgentV2TurnReply {
9829
+ response?: string;
9830
+ toolCalls?: Array<{
9831
+ arguments?: Record<string, any>;
9832
+ name?: string;
9833
+ }>;
9834
+ }
9737
9835
  export interface ISendTileUpdateParams extends INodeFunctionBaseParams {
9738
9836
  tile: any;
9739
9837
  }
@@ -9878,6 +9976,10 @@ export interface IQuestionNodeSharedConfig extends INodeWithAiRephraseConfig {
9878
9976
  escalateAnswersSendOnQueueEvent: boolean;
9879
9977
  escalateAnswersSendOnActiveEvent: boolean;
9880
9978
  escalateIntentsAction: "none" | "goto" | "execute" | "skip" | "text" | "handover";
9979
+ escalateIntentsHandoverProvider: THandoverProvider | "legacyEndpoint" | null;
9980
+ escalateIntentsHandoverProviderConfig: Record<string, any>;
9981
+ escalateAnswersHandoverProvider: THandoverProvider | "legacyEndpoint" | null;
9982
+ escalateAnswersHandoverProviderConfig: Record<string, any>;
9881
9983
  escalateIntentsValidIntents: string[];
9882
9984
  escalateIntentsThreshold: number;
9883
9985
  escalateIntentsGotoTarget: string;
@@ -10174,6 +10276,13 @@ export interface ISessionStateWithoutMeta {
10174
10276
  mcpToolNode?: string;
10175
10277
  mcpHeaders?: Record<string, string>;
10176
10278
  timeout?: number;
10279
+ authType?: "none" | "oAuth2";
10280
+ oAuth2Connection?: {
10281
+ oAuth2Url: string;
10282
+ oAuth2ClientId: string;
10283
+ oAuth2ClientSecret: string;
10284
+ oAuth2Scope?: string;
10285
+ };
10177
10286
  };
10178
10287
  tokenUsage?: TSessionUsageInformation;
10179
10288
  }
@@ -10492,6 +10601,14 @@ export interface IAzureOpenAIProviderOauth2Fields {
10492
10601
  additionalHeaderName?: string;
10493
10602
  additionalHeaderValue?: string;
10494
10603
  }
10604
+ export interface IGoogleVertexAIProviderFields {
10605
+ googleCredentialsFileName: string;
10606
+ credentialsStringified: string;
10607
+ fileToken: string;
10608
+ clientEmail: string;
10609
+ privateKey: string;
10610
+ projectId: string;
10611
+ }
10495
10612
  export interface IAlephAlphaProviderFields {
10496
10613
  token: string;
10497
10614
  }
@@ -10537,7 +10654,7 @@ export interface ILLMProviderMeta extends IAzureOpenAIMeta {
10537
10654
  }
10538
10655
  export interface ISearchLLMCredentials {
10539
10656
  provider: TGenerativeAIProviders;
10540
- connectionFields: IAzureOpenAIProviderFieldsV2 | IProviderOauth2Fields | IAwsBedrockProviderFields | IAwsBedrockIamProviderFields | IAlephAlphaProviderFields;
10657
+ connectionFields: IAzureOpenAIProviderFieldsV2 | IProviderOauth2Fields | IAwsBedrockProviderFields | IAwsBedrockIamProviderFields | IAlephAlphaProviderFields | IGoogleVertexAIProviderFields;
10541
10658
  providerMetaData: ILLMProviderMeta;
10542
10659
  }
10543
10660
  export interface ISearchTagsData {
@@ -10659,6 +10776,10 @@ export interface IGenerativeSlotFillerParams extends INodeFunctionBaseParams {
10659
10776
  }
10660
10777
  export interface IEndpointSettings {
10661
10778
  isFeatureAccmEnabled?: boolean;
10779
+ /**
10780
+ * Whether to enable mocking code for the node execution
10781
+ */
10782
+ enableMocking?: boolean;
10662
10783
  }
10663
10784
  export interface IChartExecutableNode<C extends INodeFunctionBaseParams = INodeFunctionBaseParams> extends IProjectScope, IOrganisationScope {
10664
10785
  id: string;
@@ -10691,6 +10812,16 @@ export interface IChartExecutableNode<C extends INodeFunctionBaseParams = INodeF
10691
10812
  */
10692
10813
  isDisabled: boolean;
10693
10814
  analyticsLabel?: string;
10815
+ /**
10816
+ * Mock object to replace the node function with a mock function,
10817
+ * when the mock mode is enabled for the node and the endpoint settings allow it.
10818
+ */
10819
+ mock: {
10820
+ isEnabled: boolean;
10821
+ code: string;
10822
+ transpiled?: string;
10823
+ hasError?: boolean;
10824
+ };
10694
10825
  }
10695
10826
  /**
10696
10827
  * @param meta.contactNumber DirectQuery views this is as an identifier similar to a session ID
@@ -10971,6 +11102,7 @@ export interface IGetMetaDataActionValue {
10971
11102
  snapshotName: string;
10972
11103
  isFollowSessionActive: boolean;
10973
11104
  contactId: string;
11105
+ enableMocking: boolean;
10974
11106
  }
10975
11107
  export interface ICognigyNLPProperties {
10976
11108
  /** The original text of the user */
@@ -11231,10 +11363,24 @@ export interface IEmailServiceOAuth2ConnectionFields {
11231
11363
  expiryDate?: string;
11232
11364
  accessUrl?: string;
11233
11365
  }
11366
+ export interface IEmailServiceOAuth2ClientCredentialsConnectionFields {
11367
+ tokenEndpointUrl: string;
11368
+ clientId: string;
11369
+ clientSecret: string;
11370
+ scope?: string;
11371
+ user: string;
11372
+ }
11373
+ export interface IEmailServiceOAuth2JwtBearerConnectionFields {
11374
+ tokenEndpointUrl: string;
11375
+ jwt: string;
11376
+ user: string;
11377
+ }
11234
11378
  export interface ISMTPEmailConnection {
11235
11379
  smtpType: "otherSmtp" | "126" | "163" | "1und1" | "AOL" | "DebugMail" | "DynectEmail" | "FastMail" | "GandiMail" | "Gmail" | "Godaddy" | "GodaddyAsia" | "GodaddyEurope" | "hot.ee" | "Hotmail" | "iCloud" | "mail.ee" | "Mail.ru" | "Maildev" | "Mailgun" | "Mailjet" | "Mailosaur" | "Mandrill" | "Naver" | "OpenMailBox" | "Outlook365" | "Postmark" | "QQ" | "QQex" | "SendCloud" | "SendGrid" | "SendinBlue" | "SendPulse" | "SES" | "SES-US-EAST-1" | "SES-US-WEST-2" | "SES-EU-WEST-1" | "Sparkpost" | "Yahoo" | "Yandex" | "Zoho" | "qiye.aliyun";
11236
- authType: "basic" | "oauth2";
11380
+ authType: "basic" | "oauth2" | "oauth2_client_credentials" | "oauth2_jwt_bearer";
11237
11381
  oAuth2Connection?: IEmailServiceOAuth2ConnectionFields;
11382
+ oAuth2ClientCredentialsConnection?: IEmailServiceOAuth2ClientCredentialsConnectionFields;
11383
+ oAuth2JwtBearerConnection?: IEmailServiceOAuth2JwtBearerConnectionFields;
11238
11384
  connection: ISMTPConnectionFields;
11239
11385
  serviceConnection: IEmailServiceConnectionFields;
11240
11386
  organisationId?: string;
@@ -11246,6 +11392,7 @@ export interface ISendEmailNodeParams extends INodeFunctionBaseParams {
11246
11392
  googleWarning: string;
11247
11393
  recipient: string;
11248
11394
  from: string;
11395
+ senderName: string;
11249
11396
  message: string;
11250
11397
  subject: string;
11251
11398
  replyTo: string;
@@ -11269,7 +11416,7 @@ export interface ISendEmailNodeParams extends INodeFunctionBaseParams {
11269
11416
  } & (ISMTPEmailConnection);
11270
11417
  }
11271
11418
  export interface IEmailNotificationNodeParams extends INodeFunctionBaseParams {
11272
- config: Pick<ISendEmailNodeParams["config"], "recipient" | "message" | "subject" | "cc" | "bcc" | "priority" | "async" | "storeLocation" | "inputKey" | "contextKey" | "stopOnError">;
11419
+ config: Pick<ISendEmailNodeParams["config"], "senderName" | "recipient" | "message" | "subject" | "cc" | "bcc" | "priority" | "async" | "storeLocation" | "inputKey" | "contextKey" | "stopOnError">;
11273
11420
  }
11274
11421
  export interface ISQLConnectionFields {
11275
11422
  host: string;
@@ -11613,6 +11760,13 @@ export interface INodeExecutionAPI extends Omit<IActions, "parseCognigyScriptCon
11613
11760
  timeout: number;
11614
11761
  cacheTools: boolean;
11615
11762
  mcpHeaders?: Record<string, string>;
11763
+ authType?: "none" | "oAuth2";
11764
+ oAuth2Connection?: {
11765
+ oAuth2Url: string;
11766
+ oAuth2ClientId: string;
11767
+ oAuth2ClientSecret: string;
11768
+ oAuth2Scope?: string;
11769
+ };
11616
11770
  }) => Promise<{
11617
11771
  tools: any[];
11618
11772
  fromCache: boolean;
@@ -11625,10 +11779,26 @@ export interface INodeExecutionAPI extends Omit<IActions, "parseCognigyScriptCon
11625
11779
  mcpServerUrl: string;
11626
11780
  timeout: number;
11627
11781
  mcpHeaders?: Record<string, string>;
11782
+ authType?: "none" | "oAuth2";
11783
+ oAuth2Connection?: {
11784
+ oAuth2Url: string;
11785
+ oAuth2ClientId: string;
11786
+ oAuth2ClientSecret: string;
11787
+ oAuth2Scope?: string;
11788
+ };
11628
11789
  }) => Promise<{
11629
11790
  [x: string]: unknown;
11630
11791
  }>;
11631
11792
  sendTrackGoal: (payload: IGoalAnalyticsPayload) => Promise<void>;
11793
+ /**
11794
+ * POC for AI Agent V2 service
11795
+ */
11796
+ sendAiAgentV2Turn: (params: {
11797
+ agentReferenceId: string;
11798
+ userInput: string;
11799
+ conversationHistory: string;
11800
+ openaiApiKey: string;
11801
+ }) => Promise<IAiAgentV2TurnReply>;
11632
11802
  }
11633
11803
  export interface INodeExecutionCognigyObject extends IExecutionObjects {
11634
11804
  api: INodeExecutionAPI;
@@ -11774,6 +11944,7 @@ declare const nodeFieldTypes: readonly [
11774
11944
  "checkAgentAvailabilityConfig",
11775
11945
  "chipInput",
11776
11946
  "code",
11947
+ "mockCode",
11777
11948
  "cognigyLLMText",
11778
11949
  "cognigyText",
11779
11950
  "cognigyTextArray",
@@ -11936,6 +12107,9 @@ export interface INodeDescriptor<T extends INodeFunctionBaseParams = any, U exte
11936
12107
  sections?: INodeSection[];
11937
12108
  /** The form defines how fields and sections should be render in order */
11938
12109
  form?: INodeFieldAndSectionFormElement[];
12110
+ mocking?: {
12111
+ defaultMockCode?: string;
12112
+ };
11939
12113
  }
11940
12114
  export interface IAppTemplate extends IEntityMeta {
11941
12115
  /** The object id of this app template */
@@ -12115,6 +12289,9 @@ export interface IKnowledgeDescriptor {
12115
12289
  * extension:
12116
12290
  * type: string
12117
12291
  * description: The extension name that this knowledge descriptor belongs to
12292
+ * version:
12293
+ * type: string
12294
+ * description: The version of the extension that this knowledge descriptor belongs to
12118
12295
  * extensionImg:
12119
12296
  * type: string
12120
12297
  * description: The image URL of the extension that this knowledge descriptor belongs to
@@ -12122,6 +12299,7 @@ export interface IKnowledgeDescriptor {
12122
12299
  export interface IKnowledgeDescriptorAggregatedItem extends IKnowledgeDescriptor {
12123
12300
  extension: string;
12124
12301
  extensionImg: string;
12302
+ version: string;
12125
12303
  }
12126
12304
  export declare type IExtensionType = "nodes";
12127
12305
  export interface IExtension extends IExtensionData, IExtensionNodePackage {
@@ -12433,16 +12611,10 @@ export interface IHandoverServiceProperties {
12433
12611
  value: "basic";
12434
12612
  };
12435
12613
  }
12436
- export interface IHandoverProviderProperties {
12437
- key: "basicActionTile";
12438
- type: "cognigyText";
12439
- label: "UI__NODE_EDITOR__ASSIST_INFO__ACTION_TITLE__LABEL";
12440
- description: "UI__NODE_EDITOR__ASSIST_INFO__ACTION_TITLE__DESCRIPTION";
12441
- defaultValue: "";
12442
- condition: {
12443
- key: "cardType";
12444
- value: "basic";
12445
- };
12614
+ export declare type HandoverProviderPropertyValue = string | boolean;
12615
+ export interface IHandoverProviderProperty {
12616
+ key: string;
12617
+ value: HandoverProviderPropertyValue;
12446
12618
  }
12447
12619
  export interface IRCEHandoverSettings {
12448
12620
  /**
@@ -12638,7 +12810,7 @@ export interface IHandoverProvider {
12638
12810
  lastChanged: number;
12639
12811
  createdBy: TMongoId;
12640
12812
  lastChangedBy: TMongoId;
12641
- properties: IHandoverProviderProperties[];
12813
+ properties: IHandoverProviderProperty[];
12642
12814
  settings: IHandoverProviderSettings;
12643
12815
  }
12644
12816
  export interface IGraphHandoverProvider extends IHandoverProvider {
@@ -12689,8 +12861,8 @@ export interface ISimulation extends IProjectMetadata {
12689
12861
  export interface IGraphSimulation extends ISimulation {
12690
12862
  type: "simulation";
12691
12863
  }
12692
- export declare type IGraphResourceWithReferenceId = IGraphAgentAssistConfig | IGraphConnection | IGraphFlow | IGraphFunction | IGraphLargeLanguageModel | IGraphLexicon | IGraphLocale | IGraphNLUConnector | IGraphSnippet | IGraphAgentAssistConfig | IGraphKnowledgeStore | IGraphGoal | IGraphHandoverProvider | IGraphAiAgent;
12693
- export declare type IGraphResourceWithoutReferenceId = IGraphEndpoint | IGraphExtension | IGraphFile | IGraphPlaybook | IGraphSimulation;
12864
+ export declare type IGraphResourceWithReferenceId = IGraphAgentAssistConfig | IGraphConnection | IGraphFlow | IGraphFunction | IGraphLargeLanguageModel | IGraphLexicon | IGraphLocale | IGraphNLUConnector | IGraphSnippet | IGraphAgentAssistConfig | IGraphKnowledgeStore | IGraphGoal | IGraphHandoverProvider | IGraphAiAgent | IGraphSimulation;
12865
+ export declare type IGraphResourceWithoutReferenceId = IGraphEndpoint | IGraphExtension | IGraphFile | IGraphPlaybook;
12694
12866
  export declare type IGraphResource = IGraphResourceWithReferenceId | IGraphResourceWithoutReferenceId;
12695
12867
  /**
12696
12868
  * @openapi
@@ -13474,7 +13646,17 @@ export interface IChart_2_0 {
13474
13646
  * analyticsLabel:
13475
13647
  * type: string
13476
13648
  * example: "condition"
13477
-
13649
+ * mock:
13650
+ * type: object
13651
+ * properties:
13652
+ * isEnabled:
13653
+ * type: boolean
13654
+ * example: false
13655
+ * code:
13656
+ * type: string
13657
+ * example: "console.log('Hello, world!');"
13658
+ * description: Mock code to be executed when the mock mode is enabled.
13659
+ * nullable: false
13478
13660
  *
13479
13661
  * IChartNode_2_0:
13480
13662
  * allOf:
@@ -13498,6 +13680,10 @@ export interface IChartNode_2_0<T extends INodeFunctionBaseParams = any> {
13498
13680
  extension: string;
13499
13681
  localeReference: string;
13500
13682
  analyticsLabel?: string;
13683
+ mock: {
13684
+ isEnabled: boolean;
13685
+ code: string;
13686
+ };
13501
13687
  }
13502
13688
  declare enum ConvertActionType {
13503
13689
  ADDED = "added",
@@ -13506,6 +13692,12 @@ declare enum ConvertActionType {
13506
13692
  }
13507
13693
  export declare type TConvertAction = (typeof ConvertActionType)[keyof typeof ConvertActionType];
13508
13694
  export declare type TNodeConversionMetadata = Record<string, TConvertAction>;
13695
+ export interface IMockData {
13696
+ isEnabled: boolean;
13697
+ code: string;
13698
+ transpiled?: string;
13699
+ hasError?: boolean;
13700
+ }
13509
13701
  export interface IChartNodeBase {
13510
13702
  _id: TMongoId;
13511
13703
  referenceId: string;
@@ -13533,6 +13725,7 @@ export interface IChartNodeBase {
13533
13725
  resourceReference: TMongoId;
13534
13726
  projectReference: TMongoId;
13535
13727
  organisationReference: TMongoId;
13728
+ mock: IMockData;
13536
13729
  }
13537
13730
  export interface IChartNode<T extends string = string, D extends INodeFunctionBaseParams = any, E extends string = string> extends IChartNodeBase {
13538
13731
  type: T;
@@ -14480,7 +14673,7 @@ export interface INodeField_2_0 {
14480
14673
  };
14481
14674
  }
14482
14675
  export declare type TNodeTag = "basic" | "logic" | "message" | "profile" | "service" | "nlu" | "data" | string;
14483
- export declare type TNodeFieldType_2_0 = "text" | "rule" | "select" | "xml" | "typescript" | "json" | "textArray" | "chipInput" | "date" | "datetime" | "time" | "cognigyText" | "checkbox" | "toggle" | "slider" | "number" | "daterange" | "say" | "code" | "connection" | "condition" | "flow" | "node" | "flowNode" | "lexicon" | "switchNode" | "caseNode" | "sttSelect" | "sttTierModelSelect" | "ttsSelect" | "sttLanguageAzureSelect" | "sttLanguageGoogleSelect";
14676
+ export declare type TNodeFieldType_2_0 = "text" | "rule" | "select" | "xml" | "typescript" | "json" | "textArray" | "chipInput" | "date" | "datetime" | "time" | "cognigyText" | "checkbox" | "toggle" | "slider" | "number" | "daterange" | "say" | "code" | "connection" | "condition" | "flow" | "node" | "flowNode" | "lexicon" | "switchNode" | "caseNode" | "sttSelect" | "sttTierModelSelect" | "ttsSelect" | "sttLanguageAzureSelect" | "sttLanguageGoogleSelect" | "mock";
14484
14677
  export interface INodeDependencies_2_0 {
14485
14678
  /** A list of Node types */
14486
14679
  children: string[];
@@ -16943,10 +17136,17 @@ export interface IVoiceConfigParams {
16943
17136
  sttGoogleLang1: string;
16944
17137
  sttGoogleLang2: string;
16945
17138
  sttGoogleLang3: string;
16946
- sttDeepgramModel: VoiceGatewayDeepgramModel;
17139
+ sttModel: string;
16947
17140
  deepgramEndpointing: boolean;
16948
17141
  deepgramEndpointingValue: number;
16949
17142
  deepgramSmartFormatting: boolean;
17143
+ deepgramfluxEndpointing: boolean;
17144
+ deepgramfluxEndOfTurnThreshold: number;
17145
+ deepgramfluxEndOfTurnTimeoutMs: number;
17146
+ speechmaticsEndpointing: boolean;
17147
+ speechmaticsEndpointingValue: number;
17148
+ openaiEndpointing: boolean;
17149
+ openaiEndpointingValue: number;
16950
17150
  atmosphereAction: TVoiceGateway2DubActionType;
16951
17151
  atmosphereUrl: string;
16952
17152
  atmosphereLoop: boolean;
@@ -17019,10 +17219,13 @@ export interface IVoiceConfigParams {
17019
17219
  azureSttContextId: string;
17020
17220
  azureEnableAudioLogging: boolean;
17021
17221
  googleModel: TVoiceGateway2GoogleModel;
17022
- sttDeepgramModel: VoiceGatewayDeepgramModel;
17222
+ sttModel: string;
17023
17223
  deepgramEndpointing: boolean;
17024
17224
  deepgramEndpointingValue: number;
17025
17225
  deepgramSmartFormatting: boolean;
17226
+ deepgramfluxEndpointing: boolean;
17227
+ deepgramfluxEndOfTurnThreshold: number;
17228
+ deepgramfluxEndOfTurnTimeoutMs: number;
17026
17229
  }
17027
17230
  export interface ISessionSpeechParams extends INodeFunctionBaseParams {
17028
17231
  config: IVoiceConfigParams;
@@ -17435,13 +17638,20 @@ export interface ITransferNodeParams extends INodeFunctionBaseParams {
17435
17638
  recognitionChannel: number;
17436
17639
  sttLanguage: string;
17437
17640
  sttVendor: string;
17438
- sttDeepgramModel: VoiceGatewayDeepgramModel;
17641
+ sttModel: string;
17439
17642
  sttDisablePunctuation: boolean;
17440
17643
  googleModel: TVoiceGateway2GoogleModel;
17441
17644
  sttLabel: string;
17442
17645
  deepgramEndpointing: boolean;
17443
17646
  deepgramEndpointingValue: number;
17444
17647
  deepgramSmartFormatting: boolean;
17648
+ deepgramfluxEndpointing: boolean;
17649
+ deepgramfluxEndOfTurnThreshold: number;
17650
+ deepgramfluxEndOfTurnTimeoutMs: number;
17651
+ speechmaticsEndpointing: boolean;
17652
+ speechmaticsEndpointingValue: number;
17653
+ openaiEndpointing: boolean;
17654
+ openaiEndpointingValue: number;
17445
17655
  amdEnabled: boolean;
17446
17656
  amdRedirectOnMachineDetected: boolean;
17447
17657
  amdRedirectText: string;
@@ -18063,7 +18273,7 @@ export interface IGoogleGeminiMeta_2_0 {
18063
18273
  * properties:
18064
18274
  * customModel:
18065
18275
  * type: string
18066
- * example: claude-3-opus-20240229
18276
+ * example: claude-opus-4-0
18067
18277
  * description: The custom model name. This does not work with embedding models
18068
18278
  * azureOpenAI:
18069
18279
  * type: object
@@ -18169,9 +18379,13 @@ export interface IGoogleGeminiMeta_2_0 {
18169
18379
  * - $ref: '#/components/schemas/IGlobalLargeLanguageModelData_2_0'
18170
18380
  * - $ref: '#/components/schemas/IEntityMeta'
18171
18381
  * ILargeLanguageModel_2_0:
18172
- * allOf:
18173
- * - $ref: '#/components/schemas/ILargeLanguageModelData_2_0'
18174
- * - $ref: '#/components/schemas/IEntityMeta'
18382
+ * oneOf:
18383
+ * - allOf:
18384
+ * - $ref: '#/components/schemas/ILargeLanguageModelData_2_0'
18385
+ * - $ref: '#/components/schemas/IEntityMeta'
18386
+ * - allOf:
18387
+ * - $ref: '#/components/schemas/IGlobalLargeLanguageModelData_2_0'
18388
+ * - $ref: '#/components/schemas/IEntityMeta'
18175
18389
  */
18176
18390
  export interface ILargeLanguageModel_2_0 extends IGlobalResource {
18177
18391
  referenceId: string;
@@ -18501,6 +18715,8 @@ export interface IKnowledgeSourceMetaData {
18501
18715
  id: string;
18502
18716
  type: string;
18503
18717
  };
18718
+ contentHashOrTimestamp?: string;
18719
+ externalIdentifier?: string;
18504
18720
  }
18505
18721
  /**
18506
18722
  * @openapi
@@ -18527,6 +18743,7 @@ export interface IKnowledgeSourceMetaData {
18527
18743
  * - pdf
18528
18744
  * - txt
18529
18745
  * - ctxt
18746
+ * - extension
18530
18747
  * description: The type of source for the Knowledge store
18531
18748
  * metaData:
18532
18749
  * type: object
@@ -18579,6 +18796,15 @@ export interface IKnowledgeSourceMetaData {
18579
18796
  * properties:
18580
18797
  * metaData:
18581
18798
  * type: object
18799
+ * data:
18800
+ * type: object
18801
+ * additionalProperties: true
18802
+ * description: Custom metadata object to store additional information in the KnowledgeSource
18803
+ * example:
18804
+ * _id: "x4xU6hMntv23p"
18805
+ * sys_CreatedAt: "2019-12-16T11:40:45.7212"
18806
+ * sys_UpdatedAt: "2025-10-01T07:46:04.5932"
18807
+ * Type: "FAQ"
18582
18808
  * chunkCount:
18583
18809
  * type: integer
18584
18810
  * status:
@@ -18587,6 +18813,10 @@ export interface IKnowledgeSourceMetaData {
18587
18813
  * - ready
18588
18814
  * - ingesting
18589
18815
  * - disabled
18816
+ * connectorReference:
18817
+ * type: string
18818
+ * format: uuid
18819
+ * description: The connector Id associated with the KnowledgeSource. This is only applicable for KnowledgeSources of type "extension"
18590
18820
  *
18591
18821
  * IKnowledgeSourceGeneratedData_2_0:
18592
18822
  * type: object
@@ -18595,6 +18825,20 @@ export interface IKnowledgeSourceMetaData {
18595
18825
  * type: string
18596
18826
  * format: uuid
18597
18827
  *
18828
+ * IKnowledgeSourceDataTypeExtension_2_0:
18829
+ * type: object
18830
+ * properties:
18831
+ * connectorId:
18832
+ * type: string
18833
+ * format: uuid
18834
+ * description: The connector Id associated with the KnowledgeSource. This is only applicable for KnowledgeSources of type "extension"
18835
+ * example:
18836
+ * name: "mysource"
18837
+ * description: "mysource description"
18838
+ * type: "extension"
18839
+ * metaData:
18840
+ * tags: ["tag1"]
18841
+ * connectorId: "uuid"
18598
18842
  * IKnowledgeSource_2_0:
18599
18843
  * allOf:
18600
18844
  * - $ref: '#/components/schemas/IKnowledgeSourceData_2_0'
@@ -18612,6 +18856,7 @@ export interface IKnowledgeSource_2_0 {
18612
18856
  metaData: IKnowledgeSourceMetaData;
18613
18857
  data: Record<string, unknown>;
18614
18858
  storeReference: TMongoId;
18859
+ connectorReference?: TMongoId | null;
18615
18860
  projectReference: TMongoId;
18616
18861
  organisationReference: TMongoId;
18617
18862
  createdAt: number;
@@ -18798,6 +19043,249 @@ export interface IRunKnowledgeExtensionRestData_2_0 extends IRunKnowledgeExtensi
18798
19043
  }
18799
19044
  export interface IRunKnowledgeExtensionRestReturnValue_2_0 extends ICreatedTask_2_0 {
18800
19045
  }
19046
+ declare const knowledgeConnectorExecutionStatus: readonly [
19047
+ "none",
19048
+ "queued",
19049
+ "active",
19050
+ "done",
19051
+ "error"
19052
+ ];
19053
+ export declare type KnowledgeConnectorExecutionStatus = typeof knowledgeConnectorExecutionStatus[number];
19054
+ /**
19055
+ * @openapi
19056
+ *
19057
+ * components:
19058
+ * schemas:
19059
+ * IKnowledgeConnectorCreatePayload_2_0:
19060
+ * allOf:
19061
+ * - $ref: '#/components/schemas/IKnowledgeConnectorExtensionReference_2_0'
19062
+ * - $ref: '#/components/schemas/IKnowledgeConnectorData_2_0'
19063
+ *
19064
+ * IKnowledgeConnectorUpdatePayload_2_0:
19065
+ * allOf:
19066
+ * - $ref: '#/components/schemas/IKnowledgeConnectorData_2_0'
19067
+ *
19068
+ * IKnowledgeConnectorExtensionReference_2_0:
19069
+ * type: object
19070
+ * properties:
19071
+ * extension:
19072
+ * type: string
19073
+ * description: The name of the extension
19074
+ * example: "confluence"
19075
+ * version:
19076
+ * type: string
19077
+ * description: The version of extension identifier
19078
+ * example: "1.1.0"
19079
+ * type:
19080
+ * type: string
19081
+ * description: The Knowledge Connector type identifier within an extension
19082
+ * example: "MyConfluenceConnector"
19083
+ *
19084
+ * IKnowledgeConnectorData_2_0:
19085
+ * type: object
19086
+ * properties:
19087
+ * config:
19088
+ * type: object
19089
+ * description: The configuration of the KnowledgeConnector
19090
+ * name:
19091
+ * type: string
19092
+ * description: The name of the KnowledgeConnector
19093
+ * example: "My Knowledge Connector"
19094
+ * schedule:
19095
+ * type: object
19096
+ * properties:
19097
+ * enabled:
19098
+ * type: boolean
19099
+ * description: If scheduled execution is enabled or not
19100
+ * example: true
19101
+ * start:
19102
+ * $ref: '#/components/schemas/TTimestamp'
19103
+ * description: Start date and time to calculate scheduled execution
19104
+ * hour:
19105
+ * type: number
19106
+ * description: Hour to start the scheduled execution
19107
+ * example: 1
19108
+ * minute:
19109
+ * type: number
19110
+ * description: Minute to start the scheduled execution
19111
+ * example: 1
19112
+ * weekDays:
19113
+ * type: array
19114
+ * items:
19115
+ * type: number
19116
+ * description: Repeat x days of the week, Monday = 0 ... Sunday = 6
19117
+ * example: [0,3]
19118
+ *
19119
+ * IKnowledgeConnectorExecution_2_0:
19120
+ * type: object
19121
+ * properties:
19122
+ * lastExecution:
19123
+ * $ref: '#/components/schemas/TTimestamp'
19124
+ * description: Unix-timestamp when the last execution was triggered
19125
+ * lastExecutionStatus:
19126
+ * type: string
19127
+ * description: Last execution status of the KnowledgeConnector
19128
+ * enum:
19129
+ * - none
19130
+ * - queued
19131
+ * - active
19132
+ * - done
19133
+ * - error
19134
+ *
19135
+ * IKnowledgeConnector_2_0:
19136
+ * allOf:
19137
+ * - $ref: '#/components/schemas/IKnowledgeConnectorExtensionReference_2_0'
19138
+ * - $ref: '#/components/schemas/IKnowledgeConnectorData_2_0'
19139
+ * - $ref: '#/components/schemas/IKnowledgeConnectorExecution_2_0'
19140
+ * - $ref: '#/components/schemas/IEntityMeta'
19141
+ */
19142
+ export interface IKnowledgeConnector_2_0 {
19143
+ /**
19144
+ * Extension nam
19145
+ */
19146
+ extension: string;
19147
+ /**
19148
+ * The type identifier of Knowledge Connector within an Extension
19149
+ */
19150
+ type: string;
19151
+ /**
19152
+ * The version of the Knowledge Connector Extension
19153
+ */
19154
+ version: string;
19155
+ /**
19156
+ * The configuration of the KnowledgeConnector
19157
+ */
19158
+ config: Record<string, unknown>;
19159
+ /**
19160
+ * The name of the KnowledgeConnector
19161
+ */
19162
+ name: string;
19163
+ /**
19164
+ * Schedule configuration
19165
+ */
19166
+ schedule: {
19167
+ /**
19168
+ * If scheduled execution is enabled or not
19169
+ */
19170
+ enabled: boolean;
19171
+ /**
19172
+ * Start date and time to calculate scheduled execution
19173
+ */
19174
+ start: number;
19175
+ /**
19176
+ * Hour to start the scheduled execution
19177
+ */
19178
+ hour: number;
19179
+ /**
19180
+ * Minute to start the scheduled execution
19181
+ */
19182
+ minute: number;
19183
+ /**
19184
+ * Repeat x days of the week
19185
+ */
19186
+ weekDays: Array<number>;
19187
+ };
19188
+ _id: TMongoId;
19189
+ referenceId: TMongoId;
19190
+ /**
19191
+ * The knowledge store Id to which the KnowledgeSource belongs to
19192
+ */
19193
+ storeReference: TMongoId;
19194
+ /**
19195
+ * The project Id to which the KnowledgeSource belongs to
19196
+ */
19197
+ projectReference: TMongoId;
19198
+ /**
19199
+ * The organisation Id to which the KnowledgeSource belongs to
19200
+ */
19201
+ organisationReference: TMongoId;
19202
+ /**
19203
+ * Time of last execution
19204
+ */
19205
+ lastExecution: number;
19206
+ /**
19207
+ * Last execution status of the KnowledgeConnector
19208
+ */
19209
+ lastExecutionStatus: KnowledgeConnectorExecutionStatus;
19210
+ /**
19211
+ * Unix-timestamp when the enKnowledgeSourcetity was created initially
19212
+ */
19213
+ createdAt: number;
19214
+ /**
19215
+ * Unix-timestamp when the KnowledgeSource was changed last time
19216
+ */
19217
+ lastChanged: number;
19218
+ /**
19219
+ * Id of the user who created the KnowledgeSource initially
19220
+ */
19221
+ createdBy: TMongoId;
19222
+ /**
19223
+ * Id of the user who did the last modification
19224
+ */
19225
+ lastChangedBy: TMongoId;
19226
+ }
19227
+ export interface ICreateKnowledgeConnectorRestDataParams_2_0 {
19228
+ knowledgeStoreId: string;
19229
+ }
19230
+ export interface ICreateKnowledgeConnectorRestDataBody_2_0 {
19231
+ extension: string;
19232
+ type: string;
19233
+ version: string;
19234
+ config: object;
19235
+ name: string;
19236
+ schedule: {
19237
+ enabled: boolean;
19238
+ start: number;
19239
+ hour: number;
19240
+ minute: number;
19241
+ weekDays: Array<number>;
19242
+ };
19243
+ }
19244
+ export interface ICreateKnowledgeConnectorRestData_2_0 extends ICreateKnowledgeConnectorRestDataParams_2_0, ICreateKnowledgeConnectorRestDataBody_2_0 {
19245
+ }
19246
+ export interface ICreateKnowledgeConnectorRestReturnValue_2_0 extends IKnowledgeConnector_2_0 {
19247
+ }
19248
+ export interface IIndexKnowledgeConnectorsRestDataParams_2_0 {
19249
+ knowledgeStoreId: string;
19250
+ }
19251
+ export interface IIndexKnowledgeConnectorsRestData_2_0 extends IIndexKnowledgeConnectorsRestDataParams_2_0, IRestPagination<IKnowledgeConnector_2_0> {
19252
+ }
19253
+ export interface IIndexKnowledgeConnectorsRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<IKnowledgeConnector_2_0> {
19254
+ }
19255
+ export interface IReadKnowledgeConnectorRestDataParams_2_0 {
19256
+ knowledgeStoreId: string;
19257
+ connectorId: string;
19258
+ }
19259
+ export interface IReadKnowledgeConnectorRestData_2_0 extends IReadKnowledgeConnectorRestDataParams_2_0 {
19260
+ }
19261
+ export interface IReadKnowledgeConnectorRestReturnValue_2_0 extends IKnowledgeConnector_2_0 {
19262
+ }
19263
+ export interface IDeleteKnowledgeConnectorRestDataParams_2_0 {
19264
+ knowledgeStoreId: string;
19265
+ connectorId: string;
19266
+ }
19267
+ export interface IDeleteKnowledgeConnectorRestData_2_0 extends IDeleteKnowledgeConnectorRestDataParams_2_0 {
19268
+ }
19269
+ export interface IDeleteKnowledgeConnectorRestReturnValue_2_0 {
19270
+ }
19271
+ export interface IUpdateKnowledgeConnectorRestDataBody_2_0 extends Partial<Pick<IKnowledgeConnector_2_0, "version" | "name" | "config" | "schedule">> {
19272
+ }
19273
+ export interface IUpdateKnowledgeConnectorRestDataParams_2_0 {
19274
+ knowledgeStoreId: string;
19275
+ connectorId: string;
19276
+ }
19277
+ export interface IUpdateKnowledgeConnectorRestData_2_0 extends IUpdateKnowledgeConnectorRestDataBody_2_0, IUpdateKnowledgeConnectorRestDataParams_2_0 {
19278
+ }
19279
+ export interface IUpdateKnowledgeConnectorRestReturnValue_2_0 {
19280
+ }
19281
+ export interface IRunKnowledgeConnectorRestDataParams_2_0 {
19282
+ knowledgeStoreId: string;
19283
+ connectorId: string;
19284
+ }
19285
+ export interface IRunKnowledgeConnectorRestData_2_0 extends IRunKnowledgeConnectorRestDataParams_2_0 {
19286
+ }
19287
+ export interface IRunKnowledgeConnectorRestReturnValue_2_0 extends ICreatedTask_2_0 {
19288
+ }
18801
19289
  /**
18802
19290
  * @openapi
18803
19291
  *
@@ -19036,7 +19524,7 @@ export interface IHandoverProvider_2_0 {
19036
19524
  lastChangedAt: number;
19037
19525
  createdBy: TMongoId;
19038
19526
  lastChangedBy: TMongoId;
19039
- properties: IHandoverProviderProperties[];
19527
+ properties: IHandoverProviderProperty[];
19040
19528
  settings: IHandoverProviderSettings_2_0;
19041
19529
  }
19042
19530
  export interface IHandoverProviderSettings_2_0 {
@@ -19261,15 +19749,429 @@ export interface IGenerateDesignTimeLLMOutputRestData_2_0 extends IGenerateDesig
19261
19749
  export interface IGenerateDesignTimeLLMOutputRestReturnValue_2_0 {
19262
19750
  output: string | object;
19263
19751
  }
19264
- export interface ResourcesAPIGroup_2_0 {
19265
- searchResources: TRestAPIOperation<ISearchResourcesRestData_2_0, ISearchResourcesRestReturnValue_2_0>;
19266
- indexFlows: TRestAPIOperation<TRestAPIOptionalParameter<IIndexFlowsRestData_2_0>, IIndexFlowsRestReturnValue_2_0>;
19267
- batchFlows: TRestAPIOperation<IBatchFlowsRestData_2_0, IBatchFlowsRestReturnValue_2_0>;
19268
- createFlow: TRestAPIOperation<ICreateFlowRestData_2_0, ICreateFlowRestReturnValue_2_0>;
19269
- readFlow: TRestAPIOperation<IReadFlowRestData_2_0, IReadFlowRestReturnValue_2_0>;
19270
- updateFlow: TRestAPIOperation<IUpdateFlowRestData_2_0, IUpdateFlowRestReturnValue_2_0>;
19271
- deleteFlow: TRestAPIOperation<IDeleteFlowRestData_2_0, IDeleteFlowRestReturnValue_2_0>;
19272
- cloneFlow: TRestAPIOperation<ICloneFlowRestData_2_0, ICloneFlowRestReturnValue_2_0>;
19752
+ export declare type Agent = {
19753
+ /**
19754
+ * Unique identifier of the Agent. Used in all API calls.
19755
+ */
19756
+ id: string;
19757
+ /**
19758
+ * Reference ID of the Agent. Used together with the projectId
19759
+ * to address the Agent during runtime.
19760
+ */
19761
+ referenceId: string;
19762
+ /**
19763
+ * Cognigy.AI project ID.
19764
+ */
19765
+ projectId: string;
19766
+ /**
19767
+ * Cognigy.AI organisation/tenant ID.
19768
+ */
19769
+ organisationId: string;
19770
+ /**
19771
+ * All data of an Agent is localized. Contains localized data
19772
+ * with properties for each locale.
19773
+ */
19774
+ localizedData: LocalizedAgentData[];
19775
+ createdBy: string;
19776
+ createdAt: number;
19777
+ lastChangedBy: string;
19778
+ lastChangedAt: number;
19779
+ };
19780
+ export declare type LocalizedAgentData = {
19781
+ /**
19782
+ * Cognigy.AI locale reference ID.
19783
+ */
19784
+ localeReferenceId: string;
19785
+ /**
19786
+ * Name of the Agent. Will be displayed in the UI.
19787
+ */
19788
+ name: string;
19789
+ /**
19790
+ * Description of the Agent. Will be displayed in the UI.
19791
+ */
19792
+ description: string;
19793
+ /**
19794
+ * Instructions of the Agent. Will be fed to the LLM as part
19795
+ * of the system prompt.
19796
+ */
19797
+ instructions: string;
19798
+ /**
19799
+ * References a single Agent Persona object.
19800
+ */
19801
+ personaReferenceId: string;
19802
+ /**
19803
+ * References all attached Tools this Agent can use during
19804
+ * execution in conjunction with its instructions.
19805
+ */
19806
+ toolReferenceIds: string[];
19807
+ /**
19808
+ * In place knowledge information for this Agent.
19809
+ */
19810
+ knowledge: LocalizedAgentKnowledge;
19811
+ };
19812
+ export declare type LocalizedAgentKnowledge = {
19813
+ /**
19814
+ * Always available knowledge for the Agent. This is not RAG
19815
+ * but will be part of the system prompt directly.
19816
+ */
19817
+ context: string;
19818
+ /**
19819
+ * Additional RAG mode for the Agent. "always" means that the
19820
+ * Agent will always use the configured RAG system. "never" means
19821
+ * that we won't use RAG at all.
19822
+ */
19823
+ ragMode: "always" | "never";
19824
+ /**
19825
+ * The type of RAG system to use. "cognigy" means using Cognigy.AIs
19826
+ * Knowledge AI capabilities. "expert" and "knowledgeHub" allow integrations
19827
+ * with Nice software products.
19828
+ */
19829
+ ragType: "cognigy" | "expert" | "knowledgeHub";
19830
+ /**
19831
+ * Rag parameters are specific to the RAG system that was selected.
19832
+ * The shape of this object is different per RAG type.
19833
+ */
19834
+ ragParameters: Record<string, string>;
19835
+ };
19836
+ export interface AIAgentsV2_AgentV1API {
19837
+ indexAgents: TRestAPIOperation<TRestAPIOptionalParameter<IIndexAgentsRestData_1_0>, IIndexAgentsRestReturnValue_1_0>;
19838
+ createAgent: TRestAPIOperation<ICreateAgentRestData_1_0, ICreateAgentRestReturnValue_1_0>;
19839
+ readAgent: TRestAPIOperation<IReadAgentRestData_1_0, IReadAgentRestReturnValue_1_0>;
19840
+ deleteAgent: TRestAPIOperation<IDeleteAgentRestData_1_0, IDeleteAgentRestReturnValue_1_0>;
19841
+ updateAgent: TRestAPIOperation<IUpdateAgentRestData_1_0, IUpdateAgentRestReturnValue_1_0>;
19842
+ }
19843
+ /**
19844
+ * Update Agent
19845
+ */
19846
+ export interface IUpdateAgentRestDataParams_1_0 {
19847
+ agentId: string;
19848
+ }
19849
+ export interface IUpdateAgentRestDataBody_1_0 extends Pick<LocalizedAgentData, "localeReferenceId" | "name" | "description" | "instructions" | "personaReferenceId" | "toolReferenceIds" | "knowledge"> {
19850
+ }
19851
+ export interface IUpdateAgentRestData_1_0 extends IUpdateAgentRestDataBody_1_0, IUpdateAgentRestDataParams_1_0 {
19852
+ }
19853
+ export interface IUpdateAgentRestReturnValue_1_0 extends IAgentIndexItem_1_0 {
19854
+ }
19855
+ /**
19856
+ * Delete Agent
19857
+ */
19858
+ export interface IDeleteAgentRestDataParams_1_0 {
19859
+ agentId: string;
19860
+ }
19861
+ export interface IDeleteAgentRestData_1_0 extends IDeleteAgentRestDataParams_1_0 {
19862
+ }
19863
+ export interface IDeleteAgentRestReturnValue_1_0 {
19864
+ }
19865
+ /**
19866
+ * Read Agent
19867
+ */
19868
+ export interface IReadAgentRestDataParams_1_0 {
19869
+ agentId: string;
19870
+ }
19871
+ export interface IReadAgentRestData_1_0 extends IReadAgentRestDataParams_1_0 {
19872
+ }
19873
+ export interface IReadAgentRestReturnValue_1_0 extends IAgentIndexItem_1_0 {
19874
+ }
19875
+ /**
19876
+ * Create Agent
19877
+ */
19878
+ export interface ICreateAgentRestData_1_0 extends Pick<Agent, "projectId">, Pick<LocalizedAgentData, "localeReferenceId" | "name" | "description" | "instructions" | "personaReferenceId" | "toolReferenceIds" | "knowledge"> {
19879
+ }
19880
+ export interface ICreateAgentRestReturnValue_1_0 extends IAgentIndexItem_1_0 {
19881
+ }
19882
+ /**
19883
+ * List Agent
19884
+ */
19885
+ export interface IIndexAgentsRestData_1_0 extends IRestPagination<IAgentIndexItem_1_0> {
19886
+ }
19887
+ export interface IAgentIndexItem_1_0 extends Pick<Agent, "id" | "referenceId" | "projectId" | "organisationId" | "createdBy" | "createdAt" | "lastChangedBy" | "lastChangedAt">, Pick<LocalizedAgentData, "localeReferenceId" | "name" | "description" | "instructions" | "personaReferenceId" | "toolReferenceIds" | "knowledge"> {
19888
+ }
19889
+ export interface IIndexAgentsRestReturnValue_1_0 extends ICursorBasedPaginationReturnValue<IAgentIndexItem_1_0> {
19890
+ }
19891
+ export declare type AgentPersona = {
19892
+ /**
19893
+ * Unique identifier of the Agent Persona. Used in all API calls.
19894
+ */
19895
+ id: string;
19896
+ /**
19897
+ * Reference ID of the Agent Persona. Used together with the projectId
19898
+ * to address the Agent Persona during runtime.
19899
+ */
19900
+ referenceId: string;
19901
+ /**
19902
+ * Name of the Agent Persona, e.g. "Robert"
19903
+ */
19904
+ name: string;
19905
+ /**
19906
+ * Icon or image for the Agent Persona. This can either contain an image URL
19907
+ * e.g. starting with https:// or it can contain a base64 encoded image string.
19908
+ */
19909
+ image: string;
19910
+ /**
19911
+ * Whether the image is stored in our optimized format, uses an alpha channel
19912
+ * and whether the AgentPersona can be rendered differently.
19913
+ */
19914
+ imageOptimizedFormat: boolean;
19915
+ /**
19916
+ * Description of the Agent Persona, e.g. the background story of the persona
19917
+ * could be added here.
19918
+ */
19919
+ description: string;
19920
+ /**
19921
+ * Defines the tone-of-voide for the Agent Persona, e.g. formal, informal etc.
19922
+ */
19923
+ speakingStyle: AgentPersonaSpeakingStyle;
19924
+ /**
19925
+ * Voice configuration for the Agent Persona, defining TTS voice settings.
19926
+ */
19927
+ voiceConfig: AgentPersonaVoiceConfig;
19928
+ /**
19929
+ * Cognigy.AI project ID.
19930
+ */
19931
+ projectId: string;
19932
+ /**
19933
+ * Cognigy.AI organisation/tenant ID.
19934
+ */
19935
+ organisationId: string;
19936
+ createdBy: string;
19937
+ createdAt: number;
19938
+ lastChangedBy: string;
19939
+ lastChangedAt: number;
19940
+ };
19941
+ export declare type AgentPersonaSpeakingStyle = {
19942
+ completeness: string;
19943
+ formality: string;
19944
+ };
19945
+ export declare type AgentPersonaVoiceConfig = {
19946
+ ttsVoice: string;
19947
+ ttsLanguage: string;
19948
+ ttsVendor: string;
19949
+ ttsModel: string;
19950
+ ttsLabel: string;
19951
+ ttsDisableCache: boolean;
19952
+ };
19953
+ export interface AIAgentsV2_AgentPersonaV1API {
19954
+ indexAgentPersonas: TRestAPIOperation<TRestAPIOptionalParameter<IIndexAgentPersonasRestData_1_0>, IIndexAgentPersonasRestReturnValue_1_0>;
19955
+ createAgentPersona: TRestAPIOperation<ICreateAgentPersonaRestData_1_0, ICreateAgentPersonaRestReturnValue_1_0>;
19956
+ readAgentPersona: TRestAPIOperation<IReadAgentPersonaRestData_1_0, IReadAgentPersonaRestReturnValue_1_0>;
19957
+ deleteAgentPersona: TRestAPIOperation<IDeleteAgentPersonaRestData_1_0, IDeleteAgentPersonaRestReturnValue_1_0>;
19958
+ updateAgentPersona: TRestAPIOperation<IUpdateAgentPersonaRestData_1_0, IUpdateAgentPersonaRestReturnValue_1_0>;
19959
+ }
19960
+ /**
19961
+ * Update Agent Persona
19962
+ */
19963
+ export interface IUpdateAgentPersonaRestDataParams_1_0 {
19964
+ agentPersonaId: string;
19965
+ }
19966
+ export interface IUpdateAgentPersonaRestData_1_0 extends IUpdateAgentPersonaRestDataParams_1_0, Pick<AgentPersona, "name" | "image" | "imageOptimizedFormat" | "description" | "speakingStyle" | "voiceConfig"> {
19967
+ }
19968
+ export interface IUpdateAgentPersonaRestReturnValue_1_0 extends IAgentPersonaIndexItem_1_0 {
19969
+ }
19970
+ /**
19971
+ * Delete Agent Persona
19972
+ */
19973
+ export interface IDeleteAgentPersonaRestDataParams_1_0 {
19974
+ agentPersonaId: string;
19975
+ }
19976
+ export interface IDeleteAgentPersonaRestData_1_0 extends IDeleteAgentPersonaRestDataParams_1_0 {
19977
+ }
19978
+ export interface IDeleteAgentPersonaRestReturnValue_1_0 {
19979
+ }
19980
+ /**
19981
+ * Read Agent Persona
19982
+ */
19983
+ export interface IReadAgentPersonaRestDataParams_1_0 {
19984
+ agentPersonaId: string;
19985
+ }
19986
+ export interface IReadAgentPersonaRestData_1_0 extends IReadAgentPersonaRestDataParams_1_0 {
19987
+ }
19988
+ export interface IReadAgentPersonaRestReturnValue_1_0 extends AgentPersona {
19989
+ }
19990
+ /**
19991
+ * Create Agent Persona
19992
+ */
19993
+ export interface ICreateAgentPersonaRestData_1_0 extends Pick<AgentPersona, "name" | "image" | "imageOptimizedFormat" | "description" | "speakingStyle" | "voiceConfig" | "projectId"> {
19994
+ }
19995
+ export interface ICreateAgentPersonaRestReturnValue_1_0 extends IAgentPersonaIndexItem_1_0 {
19996
+ }
19997
+ /**
19998
+ * List Agent Personas
19999
+ */
20000
+ export interface IIndexAgentPersonasRestData_1_0 extends IRestPagination<IAgentPersonaIndexItem_1_0> {
20001
+ }
20002
+ export interface IAgentPersonaIndexItem_1_0 extends Pick<AgentPersona, "id" | "referenceId" | "name" | "image" | "imageOptimizedFormat" | "description" | "speakingStyle" | "voiceConfig" | "projectId" | "organisationId" | "createdBy" | "createdAt" | "lastChangedBy" | "lastChangedAt"> {
20003
+ }
20004
+ export interface IIndexAgentPersonasRestReturnValue_1_0 extends ICursorBasedPaginationReturnValue<IAgentPersonaIndexItem_1_0> {
20005
+ }
20006
+ export interface ToolDescriptor extends IToolDescriptor {
20007
+ /**
20008
+ * The image URL field is actually not present in the tool descriptor
20009
+ * that the customer defines in the extension - it is part of the surrounding
20010
+ * extension, but the backend API returning tool descriptors actually includes
20011
+ * it in the response for convenience.
20012
+ */
20013
+ imageUrl: string;
20014
+ }
20015
+ export interface AIAgentsV2_ToolDescriptorV1API {
20016
+ indexToolDescriptors: TRestAPIOperation<TRestAPIOptionalParameter<IIndexToolDescriptorsRestData_1_0>, IIndexToolDescriptorsRestReturnValue_1_0>;
20017
+ }
20018
+ /**
20019
+ * List Tool Descriptors
20020
+ */
20021
+ export interface IIndexToolDescriptorsRestData_1_0 extends IRestPagination<IToolDescriptorIndexItem_1_0> {
20022
+ }
20023
+ export interface IToolDescriptorIndexItem_1_0 extends Pick<ToolDescriptor, "type" | "imageUrl" | "defaultLabel" | "defaultDescription" | "defaultParameters"> {
20024
+ id: string;
20025
+ extension: string;
20026
+ projectId: string;
20027
+ organisationId: string;
20028
+ }
20029
+ export declare type IIndexToolDescriptorsRestReturnValue_1_0 = ICursorBasedPaginationReturnValue<IToolDescriptorIndexItem_1_0>;
20030
+ export declare type Tool = {
20031
+ /**
20032
+ * Unique identifier of the Tool. Used in all API calls.
20033
+ */
20034
+ id: string;
20035
+ /**
20036
+ * Reference ID of the Tool. Used together with the projectId
20037
+ * to address the Tool during runtime.
20038
+ */
20039
+ referenceId: string;
20040
+ /**
20041
+ * The technical type of the tool, e.g. "createZendeskTicket".
20042
+ */
20043
+ type: string;
20044
+ /**
20045
+ * Name of the Extension the Tool Descriptor belongs to this tool was
20046
+ * based on.
20047
+ */
20048
+ extension: string;
20049
+ /**
20050
+ * Name of the Tool. Will be displayed in the UI as well as used by the LLM.
20051
+ */
20052
+ name: string;
20053
+ /**
20054
+ * Description of the Tool. Will be used by the LLM to determine when to use this Tool.
20055
+ */
20056
+ description: string;
20057
+ /**
20058
+ * Parameters of the Tool. Defines which parameters need to be provided and
20059
+ * instructs the LLM how to fill those parameters.
20060
+ */
20061
+ parameters: ToolParameter[];
20062
+ /**
20063
+ * Cognigy.AI project ID.
20064
+ */
20065
+ projectId: string;
20066
+ /**
20067
+ * Cognigy.AI organisation/tenant ID.
20068
+ */
20069
+ organisationId: string;
20070
+ createdBy: string;
20071
+ createdAt: number;
20072
+ lastChangedBy: string;
20073
+ lastChangedAt: number;
20074
+ };
20075
+ /**
20076
+ * The current tool / tool parameter implementation is wrong:
20077
+ * https://github.com/Cognigy/ai-agents-v2/blob/b268349a3d9dac9ad436dd785ceb50f8de33eca0/internal/tools/tool.go#L53
20078
+ */
20079
+ export declare type ToolParameter = {
20080
+ /**
20081
+ * Name of the parameter. Will be displayed in the UI but also used by the
20082
+ * LLM in case it should fill the parameter.
20083
+ */
20084
+ name: string;
20085
+ /**
20086
+ * Description of the parameter. Will be displayed in the UI and used
20087
+ * by the LLM in case it should fill the parameter. The LLM will then
20088
+ * use it in order to determine what value to provide for this parameter.
20089
+ */
20090
+ description: string;
20091
+ /**
20092
+ * Defines whether this tool parameter should be filled by the agent (via the LLM)
20093
+ * or should be provided during design-time by the user.
20094
+ *
20095
+ * Example: A user provided parameter would e.g. be an URL for an API endpoint. This
20096
+ * URL would be hardcoded. An example for an agent provided parameter would be a text
20097
+ * of a ticket we want to create via a ticketing tool. This text would be generated
20098
+ * by the LLM based on the actual end-user input.
20099
+ */
20100
+ mode: "dynamic" | "aiFilled";
20101
+ /**
20102
+ * The type of the parameter. Used to inform the LLM what kind of value
20103
+ * it should provide.
20104
+ */
20105
+ type: "string" | "number" | "boolean" | "object" | "array";
20106
+ /**
20107
+ * The actual value of the parameter. The tools Tool Descriptor has a "type" property
20108
+ * which defines what the values can be.
20109
+ *
20110
+ * Example: If the Tool Descriptor for this parameter contains type "select" with options "A", "B", "C",
20111
+ * the value here would be a string containing either "A", "B" or "C".
20112
+ */
20113
+ value: unknown;
20114
+ };
20115
+ export interface AIAgentsV2_ToolV1API {
20116
+ indexTools: TRestAPIOperation<TRestAPIOptionalParameter<IIndexToolsRestData_1_0>, IIndexToolsRestReturnValue_1_0>;
20117
+ createTool: TRestAPIOperation<ICreateToolRestData_1_0, ICreateToolRestReturnValue_1_0>;
20118
+ readTool: TRestAPIOperation<IReadToolRestData_1_0, IReadToolRestReturnValue_1_0>;
20119
+ updateTool: TRestAPIOperation<IUpdateToolRestData_1_0, IUpdateToolRestReturnValue_1_0>;
20120
+ deleteTool: TRestAPIOperation<IDeleteToolRestData_1_0, IDeleteToolRestReturnValue_1_0>;
20121
+ }
20122
+ /**
20123
+ * Update Tool
20124
+ */
20125
+ export interface IUpdateToolRestDataParams_1_0 {
20126
+ toolId: string;
20127
+ }
20128
+ export interface IUpdateToolRestDataBody_1_0 extends Pick<Tool, "name" | "description" | "parameters"> {
20129
+ }
20130
+ export interface IUpdateToolRestData_1_0 extends IUpdateToolRestDataBody_1_0, IUpdateToolRestDataParams_1_0 {
20131
+ }
20132
+ export interface IUpdateToolRestReturnValue_1_0 extends IToolIndexItem_1_0 {
20133
+ }
20134
+ /**
20135
+ * Delete Tool
20136
+ */
20137
+ export interface IDeleteToolRestData_1_0 {
20138
+ toolId: string;
20139
+ }
20140
+ export interface IDeleteToolRestReturnValue_1_0 {
20141
+ }
20142
+ /**
20143
+ * Read Tool
20144
+ */
20145
+ export interface IReadToolRestData_1_0 {
20146
+ toolId: string;
20147
+ }
20148
+ export interface IReadToolRestReturnValue_1_0 extends Pick<Tool, "id" | "referenceId" | "type" | "extension" | "name" | "description" | "parameters" | "projectId" | "createdAt" | "createdBy" | "lastChangedAt" | "lastChangedBy"> {
20149
+ }
20150
+ /**
20151
+ * Create Tool
20152
+ */
20153
+ export interface ICreateToolRestData_1_0 extends Pick<Tool, "type" | "extension" | "name" | "description" | "parameters" | "projectId"> {
20154
+ }
20155
+ export interface ICreateToolRestReturnValue_1_0 extends Pick<Tool, "id" | "referenceId" | "type" | "extension" | "parameters" | "name" | "description" | "projectId" | "organisationId" | "createdAt" | "createdBy" | "lastChangedAt" | "lastChangedBy"> {
20156
+ }
20157
+ /**
20158
+ * List Tools
20159
+ */
20160
+ export interface IIndexToolsRestData_1_0 extends IRestPagination<IToolIndexItem_1_0> {
20161
+ }
20162
+ export interface IToolIndexItem_1_0 extends Pick<Tool, "id" | "referenceId" | "type" | "extension" | "name" | "description" | "parameters" | "projectId" | "organisationId" | "createdAt" | "createdBy" | "lastChangedAt" | "lastChangedBy"> {
20163
+ }
20164
+ export interface IIndexToolsRestReturnValue_1_0 extends ICursorBasedPaginationReturnValue<IToolIndexItem_1_0> {
20165
+ }
20166
+ export interface ResourcesAPIGroup_2_0 extends AIAgentsV2_AgentV1API, AIAgentsV2_AgentPersonaV1API, AIAgentsV2_ToolDescriptorV1API, AIAgentsV2_ToolV1API {
20167
+ searchResources: TRestAPIOperation<ISearchResourcesRestData_2_0, ISearchResourcesRestReturnValue_2_0>;
20168
+ indexFlows: TRestAPIOperation<TRestAPIOptionalParameter<IIndexFlowsRestData_2_0>, IIndexFlowsRestReturnValue_2_0>;
20169
+ batchFlows: TRestAPIOperation<IBatchFlowsRestData_2_0, IBatchFlowsRestReturnValue_2_0>;
20170
+ createFlow: TRestAPIOperation<ICreateFlowRestData_2_0, ICreateFlowRestReturnValue_2_0>;
20171
+ readFlow: TRestAPIOperation<IReadFlowRestData_2_0, IReadFlowRestReturnValue_2_0>;
20172
+ updateFlow: TRestAPIOperation<IUpdateFlowRestData_2_0, IUpdateFlowRestReturnValue_2_0>;
20173
+ deleteFlow: TRestAPIOperation<IDeleteFlowRestData_2_0, IDeleteFlowRestReturnValue_2_0>;
20174
+ cloneFlow: TRestAPIOperation<ICloneFlowRestData_2_0, ICloneFlowRestReturnValue_2_0>;
19273
20175
  addFlowLocalization: TRestAPIOperation<IAddFlowLocalizationRestData_2_0, IAddFlowLocalizationRestReturnValue_2_0>;
19274
20176
  removeFlowLocalization: TRestAPIOperation<IRemoveFlowLocalizationRestData_2_0, IRemoveFlowLocalizationRestReturnValue_2_0>;
19275
20177
  createChildFlow: TRestAPIOperation<TRestAPIOptionalParameter<ICreateFlowFromChildrenRestData_2_0>, ICreateFlowFromChildrenRestReturnValue_2_0>;
@@ -19512,6 +20414,12 @@ export interface ResourcesAPIGroup_2_0 {
19512
20414
  readKnowledgeChunk: TRestAPIOperation<IReadKnowledgeChunkRestData_2_0, IReadKnowledgeChunkRestReturnValue_2_0>;
19513
20415
  deleteKnowledgeChunk: TRestAPIOperation<IDeleteKnowledgeChunkRestData_2_0, IDeleteKnowledgeChunkRestReturnValue_2_0>;
19514
20416
  updateKnowledgeChunk: TRestAPIOperation<IUpdateKnowledgeChunkRestData_2_0, IUpdateKnowledgeChunkRestReturnValue_2_0>;
20417
+ indexKnowledgeConnectors: TRestAPIOperation<IIndexKnowledgeConnectorsRestData_2_0, IIndexKnowledgeConnectorsRestReturnValue_2_0>;
20418
+ createKnowledgeConnector: TRestAPIOperation<ICreateKnowledgeConnectorRestData_2_0, ICreateKnowledgeConnectorRestReturnValue_2_0>;
20419
+ readKnowledgeConnector: TRestAPIOperation<IReadKnowledgeConnectorRestData_2_0, IReadKnowledgeConnectorRestReturnValue_2_0>;
20420
+ updateKnowledgeConnector: TRestAPIOperation<IUpdateKnowledgeConnectorRestData_2_0, IUpdateKnowledgeConnectorRestReturnValue_2_0>;
20421
+ deleteKnowledgeConnector: TRestAPIOperation<IDeleteKnowledgeConnectorRestData_2_0, IDeleteKnowledgeConnectorRestReturnValue_2_0>;
20422
+ runKnowledgeConnector: TRestAPIOperation<IRunKnowledgeConnectorRestData_2_0, IRunKnowledgeConnectorRestReturnValue_2_0>;
19515
20423
  uploadResumable: TTusAPIOperation<IUploadResumableRestData_2_0, IUploadResumableRestReturnValue_2_0>;
19516
20424
  generateNluScores: TRestAPIOperation<IGenerateNluScoresRestData_2_0, IGenerateNluScoresRestReturnValue_2_0>;
19517
20425
  generateDesignTimeLLMOutput: TRestAPIOperation<IGenerateDesignTimeLLMOutputRestData_2_0, IGenerateDesignTimeLLMOutputRestReturnValue_2_0>;
@@ -21573,7 +22481,8 @@ declare const actionTypes: readonly [
21573
22481
  "loginFailed",
21574
22482
  "loginError",
21575
22483
  "unauthorized",
21576
- "disableCreditCardRedaction"
22484
+ "disableCreditCardRedaction",
22485
+ "runKnowledgeConnector"
21577
22486
  ];
21578
22487
  export declare type TActionType = typeof actionTypes[number];
21579
22488
  /**
@@ -23669,6 +24578,7 @@ export interface IScheduleSimulationRestDataBody_2_0 {
23669
24578
  userId?: string;
23670
24579
  finalPing?: number;
23671
24580
  data?: Record<string, unknown>;
24581
+ enableMocking?: boolean;
23672
24582
  };
23673
24583
  projectReference: string;
23674
24584
  numberOfExecutions: number;
@@ -23739,6 +24649,44 @@ export interface ISimulationErrorInfoRest_2_0 {
23739
24649
  message?: string;
23740
24650
  technicalDetails?: string;
23741
24651
  }
24652
+ /**
24653
+ * Token usage for a specific purpose (user message generation, success criteria evaluation, etc.)
24654
+ */
24655
+ export interface ITokenUsageByPurposeItemRest_2_0 {
24656
+ inputTokens: number;
24657
+ outputTokens: number;
24658
+ totalTokens: number;
24659
+ }
24660
+ /**
24661
+ * Token usage breakdown by purpose/category
24662
+ */
24663
+ export interface ITokensByPurposeRest_2_0 {
24664
+ /** Tokens used for generating user messages during conversation */
24665
+ userMessageGeneration: ITokenUsageByPurposeItemRest_2_0;
24666
+ /** Tokens used for evaluating success criteria */
24667
+ successCriteriaEvaluation: ITokenUsageByPurposeItemRest_2_0;
24668
+ /** Tokens used for sentiment analysis */
24669
+ sentimentAnalysis: ITokenUsageByPurposeItemRest_2_0;
24670
+ }
24671
+ export interface ITokenUsageRest_2_0 {
24672
+ inputTokens: number;
24673
+ outputTokens: number;
24674
+ totalTokens: number;
24675
+ calculationMethod: "api" | "estimate";
24676
+ llmReferenceId: string;
24677
+ /** Human-readable name of the LLM (e.g., "Production GPT-4") */
24678
+ llmName: string;
24679
+ /** LLM provider (e.g., "openAI", "anthropic", "azureOpenAI") */
24680
+ llmProvider: string;
24681
+ /** LLM model type (e.g., "gpt-4", "claude-3") */
24682
+ llmModelType: string;
24683
+ /** Human-readable name of the simulation */
24684
+ simulationName: string;
24685
+ turnsWithTokenUsage: number;
24686
+ averageTokensPerTurn: number;
24687
+ /** Detailed breakdown of token usage by purpose (user message generation, success criteria, sentiment analysis) */
24688
+ tokensByPurpose?: ITokensByPurposeRest_2_0;
24689
+ }
23742
24690
  export interface ISuccessRateRest_2_0 {
23743
24691
  percentage: number;
23744
24692
  fraction: string;
@@ -23773,6 +24721,7 @@ export interface ISimulationRunRest_2_0 {
23773
24721
  isConversationEnded?: boolean;
23774
24722
  errorInfo?: ISimulationErrorInfoRest_2_0;
23775
24723
  status?: ESimulationStatusRest_2_0;
24724
+ tokenUsage?: ITokenUsageRest_2_0;
23776
24725
  };
23777
24726
  createdAt: number;
23778
24727
  createdBy: string;
@@ -23801,6 +24750,47 @@ export interface IAverageSuccessRateForRunsRest_2_0 {
23801
24750
  total: number;
23802
24751
  average: number;
23803
24752
  }
24753
+ /**
24754
+ * Token usage breakdown for a specific purpose
24755
+ */
24756
+ export interface ITokenUsageByPurposeRest_2_0 {
24757
+ inputTokens: number;
24758
+ outputTokens: number;
24759
+ totalTokens: number;
24760
+ }
24761
+ /**
24762
+ * Aggregated token usage breakdown by purpose for batch
24763
+ */
24764
+ export interface IBatchTokensByPurposeRest_2_0 {
24765
+ /** Tokens used for generating user messages during conversation */
24766
+ userMessageGeneration: ITokenUsageByPurposeRest_2_0;
24767
+ /** Tokens used for evaluating success criteria */
24768
+ successCriteriaEvaluation: ITokenUsageByPurposeRest_2_0;
24769
+ /** Tokens used for sentiment analysis */
24770
+ sentimentAnalysis: ITokenUsageByPurposeRest_2_0;
24771
+ }
24772
+ export interface IBatchTokenUsageRest_2_0 {
24773
+ totalInputTokens: number;
24774
+ totalOutputTokens: number;
24775
+ totalTokens: number;
24776
+ averageInputTokensPerRun: number;
24777
+ averageOutputTokensPerRun: number;
24778
+ averageTokensPerRun: number;
24779
+ averageTokensPerTurn: number;
24780
+ runsWithTokenUsage: number;
24781
+ calculationMethod: "api" | "estimate" | "mixed";
24782
+ llmReferenceId: string;
24783
+ /** Human-readable name of the LLM (e.g., "Production GPT-4") */
24784
+ llmName: string;
24785
+ /** LLM provider (e.g., "openAI", "anthropic", "azureOpenAI") */
24786
+ llmProvider: string;
24787
+ /** LLM model type (e.g., "gpt-4", "claude-3") */
24788
+ llmModelType: string;
24789
+ /** Human-readable name of the simulation */
24790
+ simulationName: string;
24791
+ /** Detailed breakdown of token usage by purpose (aggregated across all runs) */
24792
+ tokensByPurpose?: IBatchTokensByPurposeRest_2_0;
24793
+ }
23804
24794
  export interface IBatchMetricsRest_2_0 {
23805
24795
  _v: number;
23806
24796
  efficiencyScore?: IEfficiencyScoreRest_2_0[];
@@ -23815,6 +24805,7 @@ export interface IBatchMetricsRest_2_0 {
23815
24805
  failed: number;
23816
24806
  notExecuted?: number;
23817
24807
  };
24808
+ tokenUsage?: IBatchTokenUsageRest_2_0;
23818
24809
  }
23819
24810
  export interface ISimulationRunBatchRest_2_0 {
23820
24811
  id: string;
@@ -23854,11 +24845,16 @@ export interface IIndexSimulationRunBatchesRestDataQuery_2_0 {
23854
24845
  sort?: string;
23855
24846
  next?: string;
23856
24847
  previous?: string;
24848
+ scenariosIds?: string[];
24849
+ status?: string;
24850
+ timespan?: string;
24851
+ timezone?: string;
24852
+ endPointType?: string;
23857
24853
  }
23858
24854
  export interface IIndexSimulationRunBatchesRestData_2_0 extends IIndexSimulationRunBatchesRestDataQuery_2_0 {
23859
24855
  }
23860
24856
  export interface IIndexSimulationRunBatchesRestReturnValue_2_0 {
23861
- simulationRunBatches: ISimulationRunBatchRest_2_0[];
24857
+ data: ISimulationRunBatchRest_2_0[];
23862
24858
  }
23863
24859
  export interface IGetAllSimulationRunBatchesRestDataQuery_2_0 {
23864
24860
  projectId: string;
@@ -24204,6 +25200,158 @@ export interface IStopSimulationRunBatchRestData_2_0 extends IStopSimulationRunB
24204
25200
  export interface IStopSimulationRunBatchRestReturnValue_2_0 {
24205
25201
  simulationRunBatchId: ISimulationRunBatchRest_2_0;
24206
25202
  }
25203
+ export interface IGetSimulationOverviewMetricsRestDataQuery_2_0 {
25204
+ projectId: string;
25205
+ scenarioIds?: string[];
25206
+ timeWindow?: "7d" | "30d" | "3m";
25207
+ }
25208
+ export interface IGetSimulationOverviewMetricsRestData_2_0 extends IGetSimulationOverviewMetricsRestDataQuery_2_0 {
25209
+ }
25210
+ export interface IGetSimulationOverviewMetricsRestReturnValue_2_0 {
25211
+ totalScenarios: number;
25212
+ totalSimulations: number;
25213
+ avgSuccessRate: number;
25214
+ scheduledRuns: number;
25215
+ }
25216
+ export interface IGetSuccessRateTrendRestDataQuery_2_0 {
25217
+ projectId: string;
25218
+ scenarioIds?: string[];
25219
+ timeWindow?: "7d" | "30d" | "3m";
25220
+ }
25221
+ export interface IGetSuccessRateTrendRestData_2_0 extends IGetSuccessRateTrendRestDataQuery_2_0 {
25222
+ }
25223
+ export interface IGetSuccessRateTrendRestReturnValue_2_0 {
25224
+ data: Array<{
25225
+ date: string;
25226
+ totalRuns: number;
25227
+ successfulRuns: number;
25228
+ failedRuns: number;
25229
+ successRate: number;
25230
+ successPercentage: number;
25231
+ }>;
25232
+ }
25233
+ export interface IGetUpcomingScheduledRunsRestDataQuery_2_0 {
25234
+ projectId: string;
25235
+ scenarioIds?: string[];
25236
+ limit?: number;
25237
+ }
25238
+ export interface IGetUpcomingScheduledRunsRestData_2_0 extends IGetUpcomingScheduledRunsRestDataQuery_2_0 {
25239
+ }
25240
+ export interface IGetUpcomingScheduledRunsRestReturnValue_2_0 {
25241
+ data: Array<{
25242
+ _id: string;
25243
+ id: string;
25244
+ simulationReference: string;
25245
+ scenarioName?: string;
25246
+ runName?: string;
25247
+ nextScheduledRun: string;
25248
+ frequency: string;
25249
+ time?: string;
25250
+ enableSchedule?: boolean;
25251
+ numberOfRuns?: number;
25252
+ cronScheduler?: string;
25253
+ emailNotifications?: string[];
25254
+ projectReference?: string;
25255
+ organisationReference?: string;
25256
+ createdBy?: string;
25257
+ lastChangedBy?: string;
25258
+ createdAt?: number;
25259
+ lastChanged?: number;
25260
+ runConfig?: {
25261
+ flowReferenceId?: string;
25262
+ localeReferenceId?: string;
25263
+ entrypoint?: string;
25264
+ largeLanguageModelReferenceId?: string;
25265
+ finalPing?: number;
25266
+ enableMocking?: boolean;
25267
+ };
25268
+ }>;
25269
+ }
25270
+ declare enum ESchedulerFrequencyRest_2_0 {
25271
+ DAILY = "daily",
25272
+ EVERY_THREE_DAYS = "every three days",
25273
+ WEEKLY = "weekly",
25274
+ BIWEEKLY = "biweekly",
25275
+ MONTHLY = "monthly"
25276
+ }
25277
+ export interface ISchedulerRunConfigRest_2_0 {
25278
+ flowReferenceId: string;
25279
+ localeReferenceId?: string;
25280
+ entrypoint: string;
25281
+ largeLanguageModelReferenceId: string;
25282
+ userId?: string;
25283
+ finalPing?: number;
25284
+ data?: Record<string, unknown>;
25285
+ enableMocking?: boolean;
25286
+ }
25287
+ export interface ISchedulerRest_2_0 extends IProjectMetadataRest_2_0 {
25288
+ id: string;
25289
+ runConfig: ISchedulerRunConfigRest_2_0;
25290
+ enableSchedule: boolean;
25291
+ frequency: ESchedulerFrequencyRest_2_0;
25292
+ time: string;
25293
+ numberOfRuns: number;
25294
+ nextScheduledRun: string;
25295
+ emailNotifications: string[];
25296
+ scenarioName: string;
25297
+ runName: string;
25298
+ simulationReference: string;
25299
+ endDate?: string;
25300
+ createdAt: number;
25301
+ lastChanged: number;
25302
+ createdBy: string;
25303
+ lastChangedBy: string;
25304
+ }
25305
+ export interface ICreateSchedulerRestDataParams_2_0 {
25306
+ simulationReference: string;
25307
+ }
25308
+ export interface ICreateSchedulerRestDataBody_2_0 {
25309
+ runConfig: ISchedulerRunConfigRest_2_0;
25310
+ enableSchedule: boolean;
25311
+ frequency: ESchedulerFrequencyRest_2_0;
25312
+ time: string;
25313
+ numberOfRuns: number;
25314
+ emailNotifications?: string[];
25315
+ scenarioName?: string;
25316
+ runName: string;
25317
+ endDate?: string;
25318
+ }
25319
+ export interface ICreateSchedulerRestData_2_0 extends ICreateSchedulerRestDataParams_2_0, ICreateSchedulerRestDataBody_2_0 {
25320
+ }
25321
+ export interface ICreateSchedulerRestReturnValue_2_0 {
25322
+ scheduler: ISchedulerRest_2_0;
25323
+ }
25324
+ export interface IUpdateSchedulerRestDataParams_2_0 {
25325
+ simulationReference: string;
25326
+ schedulerId: string;
25327
+ }
25328
+ export interface IUpdateSchedulerRestDataBody_2_0 {
25329
+ runConfig?: ISchedulerRunConfigRest_2_0;
25330
+ enableSchedule?: boolean;
25331
+ frequency?: ESchedulerFrequencyRest_2_0;
25332
+ time?: string;
25333
+ numberOfRuns?: number;
25334
+ nextScheduledRun?: string;
25335
+ emailNotifications?: string[];
25336
+ scenarioName?: string;
25337
+ runName?: string;
25338
+ endDate?: string;
25339
+ }
25340
+ export interface IUpdateSchedulerRestData_2_0 extends IUpdateSchedulerRestDataParams_2_0, IUpdateSchedulerRestDataBody_2_0 {
25341
+ projectId?: string;
25342
+ }
25343
+ export interface IUpdateSchedulerRestReturnValue_2_0 {
25344
+ scheduler: ISchedulerRest_2_0;
25345
+ }
25346
+ export interface IGetSchedulerRestDataParams_2_0 {
25347
+ simulationReference: string;
25348
+ }
25349
+ export interface IGetSchedulerRestData_2_0 extends IGetSchedulerRestDataParams_2_0 {
25350
+ projectId?: string;
25351
+ }
25352
+ export interface IGetSchedulerRestReturnValue_2_0 {
25353
+ scheduler: ISchedulerRest_2_0 | null;
25354
+ }
24207
25355
  export interface SimulationAPIGroup_2_0 {
24208
25356
  indexSimulations: TRestAPIOperation<IIndexSimulationsRestData_2_0, IIndexSimulationsRestReturnValue_2_0>;
24209
25357
  createSimulation: TRestAPIOperation<ICreateSimulationRestData_2_0, ICreateSimulationRestReturnValue_2_0>;
@@ -24223,6 +25371,12 @@ export interface SimulationAPIGroup_2_0 {
24223
25371
  regeneratePersonaField: TRestAPIOperation<IRegeneratePersonaFieldRestData_2_0, IRegeneratePersonaFieldRestReturnValue_2_0>;
24224
25372
  generateBulkPersona: TRestAPIOperation<IGenerateBulkPersonaRestData_2_0, IGenerateBulkPersonaRestReturnValue_2_0>;
24225
25373
  generatePersonaFromTranscript: TRestAPIOperation<IGeneratePersonaFromTranscriptRestData_2_0, IGeneratePersonaFromTranscriptRestReturnValue_2_0>;
25374
+ getSimulationOverviewMetrics: TRestAPIOperation<IGetSimulationOverviewMetricsRestData_2_0, IGetSimulationOverviewMetricsRestReturnValue_2_0>;
25375
+ getSuccessRateTrend: TRestAPIOperation<IGetSuccessRateTrendRestData_2_0, IGetSuccessRateTrendRestReturnValue_2_0>;
25376
+ getUpcomingScheduledRuns: TRestAPIOperation<IGetUpcomingScheduledRunsRestData_2_0, IGetUpcomingScheduledRunsRestReturnValue_2_0>;
25377
+ getScheduler: TRestAPIOperation<IGetSchedulerRestData_2_0, IGetSchedulerRestReturnValue_2_0>;
25378
+ createScheduler: TRestAPIOperation<ICreateSchedulerRestData_2_0, ICreateSchedulerRestReturnValue_2_0>;
25379
+ updateScheduler: TRestAPIOperation<IUpdateSchedulerRestData_2_0, IUpdateSchedulerRestReturnValue_2_0>;
24226
25380
  }
24227
25381
  declare function SimulationAPIGroup_2_0(instance: Base): SimulationAPIGroup_2_0;
24228
25382
  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> & TAIOpsCenterAPIVersionType<T> & TSimulationAPIVersionType<T>;