@cognigy/rest-api-client 2026.1.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 (107) hide show
  1. package/CHANGELOG.md +5 -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 +134 -383
  5. package/build/apigroups/SimulationAPIGroup_2_0.js +24 -23
  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/shared/charts/descriptors/connectionNodes/smtp/index.js +5 -1
  16. package/build/shared/charts/descriptors/connectionNodes/smtp/oAuth2ClientCredentialsConnection.js +15 -0
  17. package/build/shared/charts/descriptors/connectionNodes/smtp/oAuth2JwtBearerConnection.js +13 -0
  18. package/build/shared/charts/descriptors/connectionNodes/smtp/sendEmail.js +54 -10
  19. package/build/shared/charts/descriptors/connectionNodes/speechProviders/elevenlabsSpeechProviderConnection.js +52 -0
  20. package/build/shared/charts/descriptors/connectionNodes/speechProviders/index.js +8 -7
  21. package/build/shared/charts/descriptors/index.js +4 -0
  22. package/build/shared/charts/descriptors/message/question/question.js +249 -59
  23. package/build/shared/charts/descriptors/service/aiAgent/aiAgentJob.js +17 -15
  24. package/build/shared/charts/descriptors/service/aiAgent/aiAgentJobCallMCPTool.js +6 -4
  25. package/build/shared/charts/descriptors/service/aiAgent/aiAgentJobMCPTool.js +57 -1
  26. package/build/shared/charts/descriptors/service/aiAgent/helpers/createToolDefinitions.js +7 -0
  27. package/build/shared/charts/descriptors/service/aiAgentV2.js +89 -0
  28. package/build/shared/charts/descriptors/service/index.js +5 -1
  29. package/build/shared/charts/descriptors/service/llmPrompt/LLMPromptV2.js +15 -13
  30. package/build/shared/charts/descriptors/service/llmPrompt/llmPromptMCPTool.js +57 -1
  31. package/build/shared/charts/descriptors/voice/mappers/setSessionConfig.mapper.js +67 -13
  32. package/build/shared/charts/descriptors/voice/mappers/transfer.mapper.js +25 -3
  33. package/build/shared/charts/descriptors/voice/nodes/sessionSpeechParameters.js +65 -0
  34. package/build/shared/charts/descriptors/voicegateway2/nodes/play.js +7 -0
  35. package/build/shared/charts/descriptors/voicegateway2/nodes/setSessionConfig.js +137 -1
  36. package/build/shared/charts/descriptors/voicegateway2/nodes/transfer.js +135 -2
  37. package/build/shared/errors/ErrorCode.js +2 -1
  38. package/build/shared/errors/ErrorCollection.js +1 -0
  39. package/build/shared/helper/BaseContext.js +1 -1
  40. package/build/shared/interfaces/generativeAI/IGenerativeAIModels.js +1 -0
  41. package/build/shared/interfaces/handover.js +1 -0
  42. package/build/shared/interfaces/handoverProviders.js +0 -1
  43. package/build/shared/interfaces/messageAPI/endpoints.js +3 -0
  44. package/build/shared/interfaces/resources/IAuditEvent.js +1 -0
  45. package/build/shared/interfaces/resources/knowledgeStore/IKnowledgeSource.js +1 -1
  46. package/build/shared/interfaces/resources/settings/IAudioPreviewSettings.js +7 -1
  47. package/build/shared/interfaces/restAPI/analytics/IDeleteConversationsBySessionRest_2_1.js +3 -0
  48. package/build/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/connector/IRunKnowledgeConnectorRest_2_0.js +3 -0
  49. package/build/shared/interfaces/restAPI/simulation/simulationOverview/IGetSimulationOverviewMetricsRestData_2_0.js +3 -0
  50. package/build/shared/interfaces/restAPI/simulation/simulationOverview/IGetSuccessRateTrendRestData_2_0.js +3 -0
  51. package/build/shared/interfaces/restAPI/simulation/simulationOverview/IGetUpcomingScheduledRunsRestData_2_0.js +3 -0
  52. package/build/shared/interfaces/security/ISessionScope.js +3 -0
  53. package/build/spec/aiAgentV2.spec.js +564 -0
  54. package/dist/esm/apigroups/InsightsAPIGroup_2_1.js +13 -0
  55. package/dist/esm/apigroups/ResourcesAPIGroup_2_0.js +134 -383
  56. package/dist/esm/apigroups/SimulationAPIGroup_2_0.js +24 -23
  57. package/dist/esm/apigroups/aiAgentsV2/agent.js +2 -0
  58. package/dist/esm/apigroups/aiAgentsV2/agentAPI.js +24 -0
  59. package/dist/esm/apigroups/aiAgentsV2/agentPersona.js +2 -0
  60. package/dist/esm/apigroups/aiAgentsV2/agentPersonaAPI.js +24 -0
  61. package/dist/esm/apigroups/aiAgentsV2/aiAgentV2API.js +2 -0
  62. package/dist/esm/apigroups/aiAgentsV2/tool.js +2 -0
  63. package/dist/esm/apigroups/aiAgentsV2/toolAPI.js +21 -0
  64. package/dist/esm/apigroups/aiAgentsV2/toolDescriptor.js +2 -0
  65. package/dist/esm/apigroups/aiAgentsV2/toolDescriptorAPI.js +9 -0
  66. package/dist/esm/apigroups/index.js +1 -0
  67. package/dist/esm/shared/charts/descriptors/connectionNodes/smtp/index.js +5 -1
  68. package/dist/esm/shared/charts/descriptors/connectionNodes/smtp/oAuth2ClientCredentialsConnection.js +12 -0
  69. package/dist/esm/shared/charts/descriptors/connectionNodes/smtp/oAuth2JwtBearerConnection.js +10 -0
  70. package/dist/esm/shared/charts/descriptors/connectionNodes/smtp/sendEmail.js +54 -10
  71. package/dist/esm/shared/charts/descriptors/connectionNodes/speechProviders/elevenlabsSpeechProviderConnection.js +49 -0
  72. package/dist/esm/shared/charts/descriptors/connectionNodes/speechProviders/index.js +3 -3
  73. package/dist/esm/shared/charts/descriptors/index.js +5 -1
  74. package/dist/esm/shared/charts/descriptors/message/question/question.js +249 -59
  75. package/dist/esm/shared/charts/descriptors/service/aiAgent/aiAgentJob.js +17 -15
  76. package/dist/esm/shared/charts/descriptors/service/aiAgent/aiAgentJobCallMCPTool.js +6 -4
  77. package/dist/esm/shared/charts/descriptors/service/aiAgent/aiAgentJobMCPTool.js +56 -0
  78. package/dist/esm/shared/charts/descriptors/service/aiAgent/helpers/createToolDefinitions.js +7 -0
  79. package/dist/esm/shared/charts/descriptors/service/aiAgentV2.js +87 -0
  80. package/dist/esm/shared/charts/descriptors/service/index.js +2 -0
  81. package/dist/esm/shared/charts/descriptors/service/llmPrompt/LLMPromptV2.js +22 -20
  82. package/dist/esm/shared/charts/descriptors/service/llmPrompt/llmPromptMCPTool.js +56 -0
  83. package/dist/esm/shared/charts/descriptors/voice/mappers/setSessionConfig.mapper.js +67 -13
  84. package/dist/esm/shared/charts/descriptors/voice/mappers/transfer.mapper.js +25 -3
  85. package/dist/esm/shared/charts/descriptors/voice/nodes/sessionSpeechParameters.js +65 -0
  86. package/dist/esm/shared/charts/descriptors/voicegateway2/nodes/play.js +7 -0
  87. package/dist/esm/shared/charts/descriptors/voicegateway2/nodes/setSessionConfig.js +137 -1
  88. package/dist/esm/shared/charts/descriptors/voicegateway2/nodes/transfer.js +135 -2
  89. package/dist/esm/shared/errors/ErrorCode.js +2 -1
  90. package/dist/esm/shared/errors/ErrorCollection.js +1 -0
  91. package/dist/esm/shared/helper/BaseContext.js +1 -1
  92. package/dist/esm/shared/interfaces/generativeAI/IGenerativeAIModels.js +1 -0
  93. package/dist/esm/shared/interfaces/handover.js +1 -0
  94. package/dist/esm/shared/interfaces/handoverProviders.js +0 -1
  95. package/dist/esm/shared/interfaces/messageAPI/endpoints.js +3 -0
  96. package/dist/esm/shared/interfaces/resources/IAuditEvent.js +1 -0
  97. package/dist/esm/shared/interfaces/resources/knowledgeStore/IKnowledgeSource.js +1 -1
  98. package/dist/esm/shared/interfaces/resources/settings/IAudioPreviewSettings.js +7 -1
  99. package/dist/esm/shared/interfaces/restAPI/analytics/IDeleteConversationsBySessionRest_2_1.js +2 -0
  100. package/dist/esm/shared/interfaces/restAPI/resources/knowledgeStore/v2.0/connector/IRunKnowledgeConnectorRest_2_0.js +2 -0
  101. package/dist/esm/shared/interfaces/restAPI/simulation/simulationOverview/IGetSimulationOverviewMetricsRestData_2_0.js +2 -0
  102. package/dist/esm/shared/interfaces/restAPI/simulation/simulationOverview/IGetSuccessRateTrendRestData_2_0.js +2 -0
  103. package/dist/esm/shared/interfaces/restAPI/simulation/simulationOverview/IGetUpcomingScheduledRunsRestData_2_0.js +2 -0
  104. package/dist/esm/shared/interfaces/security/ISessionScope.js +2 -0
  105. package/dist/esm/spec/aiAgentV2.spec.js +563 -0
  106. package/package.json +6 -3
  107. package/types/index.d.ts +667 -30
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;
@@ -2370,6 +2373,7 @@ export interface IAgentAssistSettings {
2370
2373
  enableTranscriptTileChatInput?: boolean;
2371
2374
  redactTranscriptTileMessages?: boolean;
2372
2375
  enableAgentCopilotAuthentication?: boolean;
2376
+ blockNonJWTRequests?: boolean;
2373
2377
  agentCopilotAuthentication?: string;
2374
2378
  /**
2375
2379
  * Optional OAuth2 connection id for providers that require it (e.g., Genesys)
@@ -2857,7 +2861,8 @@ declare const generativeAIModels: readonly [
2857
2861
  "text-embedding-ada-002",
2858
2862
  "luminous-embedding-128",
2859
2863
  "amazon.titan-embed-text-v2:0",
2860
- "Pharia-1-Embedding-4608"
2864
+ "Pharia-1-Embedding-4608",
2865
+ "gemini-embedding-001"
2861
2866
  ];
2862
2867
  /**
2863
2868
  * @openapi
@@ -2883,6 +2888,7 @@ declare const generativeAIModels: readonly [
2883
2888
  * - luminous-extended-control
2884
2889
  * - luminous-embedding-128
2885
2890
  * - Pharia-1-Embedding-4608
2891
+ * - gemini-embedding-001
2886
2892
  * - claude-3-opus-20240229
2887
2893
  * - custom-model
2888
2894
  * - custom-embedding-model
@@ -2963,7 +2969,8 @@ declare const audioPreviewProviders: readonly [
2963
2969
  "microsoft",
2964
2970
  "google",
2965
2971
  "aws",
2966
- "deepgram"
2972
+ "deepgram",
2973
+ "elevenlabs"
2967
2974
  ];
2968
2975
  export declare type TAudioPreviewProvider = typeof audioPreviewProviders[number];
2969
2976
  /**
@@ -3104,9 +3111,11 @@ export interface IVoiceGateway2RecognizerParams {
3104
3111
  asrTimeout?: number;
3105
3112
  nuanceOptions?: TVoiceGateway2NuanceOptions;
3106
3113
  deepgramOptions?: TVoiceGateway2DeepgramOptions;
3114
+ deepgramfluxOptions?: TVoiceGateway2DeepgramfluxOptions;
3107
3115
  ibmOptions?: TVoiceGateway2IbmOptions;
3108
3116
  nvidiaOptions?: TVoiceGateway2NvidiaOptions;
3109
3117
  sonioxOptions?: TVoiceGateway2SonioxOptions;
3118
+ speechmaticsOptions?: TVoiceGateway2SpeechmaticsOptions;
3110
3119
  openaiOptions?: TVoiceGateway2OpenaiOptions;
3111
3120
  model?: string;
3112
3121
  }
@@ -3166,6 +3175,53 @@ export declare type TVoiceGateway2DeepgramOptions = {
3166
3175
  vadTurnoff?: number;
3167
3176
  tag?: string;
3168
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
+ };
3169
3225
  export declare type TVoiceGateway2NvidiaOptions = {
3170
3226
  rivaUri?: string;
3171
3227
  maxAlternatives?: number;
@@ -3184,10 +3240,6 @@ export declare type TVoiceGateway2SonioxOptions = {
3184
3240
  metadata?: object;
3185
3241
  storage?: object;
3186
3242
  };
3187
- export declare type TVoiceGateway2OpenaiOptions = {
3188
- model?: string;
3189
- apiKey?: string;
3190
- };
3191
3243
  export declare type TVoiceGateway2IbmOptions = {
3192
3244
  sttApiKey?: string;
3193
3245
  sttRegion?: string;
@@ -3427,6 +3479,9 @@ export interface ICallEventFailoverSettings {
3427
3479
  deepgramEndpointing?: boolean;
3428
3480
  deepgramEndpointingValue?: number;
3429
3481
  dialTranscribeDeepgramTier?: string;
3482
+ deepgramfluxEndpointing?: boolean;
3483
+ deepgramfluxEndOfTurnThreshold?: number;
3484
+ deepgramfluxEndOfTurnTimeoutMs?: number;
3430
3485
  mediaPath?: TVoiceGateway2MediaPath;
3431
3486
  anchorMedia?: boolean;
3432
3487
  }
@@ -7779,6 +7834,9 @@ export interface IWebrtcWidgetConfig {
7779
7834
  * enableAgentCopilotAuthentication:
7780
7835
  * type: boolean
7781
7836
  * description: Enable authentication for agent copilot
7837
+ * blockNonJWTRequests:
7838
+ * type: boolean
7839
+ * description: Block requests made to the endpoint without a JWT token
7782
7840
  * agentCopilotAuthentication:
7783
7841
  * type: string
7784
7842
  * description: Authentication connection reference Id for agent copilot
@@ -9519,8 +9577,8 @@ export interface IOutputEventPayload {
9519
9577
  disableSensitiveLogging?: boolean;
9520
9578
  }
9521
9579
  export interface IOutputEventMetadata {
9522
- flowReferenceId: string;
9523
- outputType: "node" | "intent";
9580
+ flowReferenceId?: string;
9581
+ outputType?: "node" | "intent";
9524
9582
  nodeLabel?: string;
9525
9583
  nodeType?: string;
9526
9584
  nodeId?: string;
@@ -9528,6 +9586,7 @@ export interface IOutputEventMetadata {
9528
9586
  intentId?: string;
9529
9587
  intentReferenceId?: string;
9530
9588
  intent?: string;
9589
+ isMockedCodeExecution?: boolean;
9531
9590
  }
9532
9591
  export interface ISwitchedFlowEventPayload {
9533
9592
  fromFlowId: string;
@@ -9766,6 +9825,13 @@ export interface ILoadAiAgentNodeParams extends INodeFunctionBaseParams {
9766
9825
  keyWarning: string;
9767
9826
  };
9768
9827
  }
9828
+ export interface IAiAgentV2TurnReply {
9829
+ response?: string;
9830
+ toolCalls?: Array<{
9831
+ arguments?: Record<string, any>;
9832
+ name?: string;
9833
+ }>;
9834
+ }
9769
9835
  export interface ISendTileUpdateParams extends INodeFunctionBaseParams {
9770
9836
  tile: any;
9771
9837
  }
@@ -9910,6 +9976,10 @@ export interface IQuestionNodeSharedConfig extends INodeWithAiRephraseConfig {
9910
9976
  escalateAnswersSendOnQueueEvent: boolean;
9911
9977
  escalateAnswersSendOnActiveEvent: boolean;
9912
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>;
9913
9983
  escalateIntentsValidIntents: string[];
9914
9984
  escalateIntentsThreshold: number;
9915
9985
  escalateIntentsGotoTarget: string;
@@ -10206,6 +10276,13 @@ export interface ISessionStateWithoutMeta {
10206
10276
  mcpToolNode?: string;
10207
10277
  mcpHeaders?: Record<string, string>;
10208
10278
  timeout?: number;
10279
+ authType?: "none" | "oAuth2";
10280
+ oAuth2Connection?: {
10281
+ oAuth2Url: string;
10282
+ oAuth2ClientId: string;
10283
+ oAuth2ClientSecret: string;
10284
+ oAuth2Scope?: string;
10285
+ };
10209
10286
  };
10210
10287
  tokenUsage?: TSessionUsageInformation;
10211
10288
  }
@@ -10524,6 +10601,14 @@ export interface IAzureOpenAIProviderOauth2Fields {
10524
10601
  additionalHeaderName?: string;
10525
10602
  additionalHeaderValue?: string;
10526
10603
  }
10604
+ export interface IGoogleVertexAIProviderFields {
10605
+ googleCredentialsFileName: string;
10606
+ credentialsStringified: string;
10607
+ fileToken: string;
10608
+ clientEmail: string;
10609
+ privateKey: string;
10610
+ projectId: string;
10611
+ }
10527
10612
  export interface IAlephAlphaProviderFields {
10528
10613
  token: string;
10529
10614
  }
@@ -10569,7 +10654,7 @@ export interface ILLMProviderMeta extends IAzureOpenAIMeta {
10569
10654
  }
10570
10655
  export interface ISearchLLMCredentials {
10571
10656
  provider: TGenerativeAIProviders;
10572
- connectionFields: IAzureOpenAIProviderFieldsV2 | IProviderOauth2Fields | IAwsBedrockProviderFields | IAwsBedrockIamProviderFields | IAlephAlphaProviderFields;
10657
+ connectionFields: IAzureOpenAIProviderFieldsV2 | IProviderOauth2Fields | IAwsBedrockProviderFields | IAwsBedrockIamProviderFields | IAlephAlphaProviderFields | IGoogleVertexAIProviderFields;
10573
10658
  providerMetaData: ILLMProviderMeta;
10574
10659
  }
10575
10660
  export interface ISearchTagsData {
@@ -11278,10 +11363,24 @@ export interface IEmailServiceOAuth2ConnectionFields {
11278
11363
  expiryDate?: string;
11279
11364
  accessUrl?: string;
11280
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
+ }
11281
11378
  export interface ISMTPEmailConnection {
11282
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";
11283
- authType: "basic" | "oauth2";
11380
+ authType: "basic" | "oauth2" | "oauth2_client_credentials" | "oauth2_jwt_bearer";
11284
11381
  oAuth2Connection?: IEmailServiceOAuth2ConnectionFields;
11382
+ oAuth2ClientCredentialsConnection?: IEmailServiceOAuth2ClientCredentialsConnectionFields;
11383
+ oAuth2JwtBearerConnection?: IEmailServiceOAuth2JwtBearerConnectionFields;
11285
11384
  connection: ISMTPConnectionFields;
11286
11385
  serviceConnection: IEmailServiceConnectionFields;
11287
11386
  organisationId?: string;
@@ -11661,6 +11760,13 @@ export interface INodeExecutionAPI extends Omit<IActions, "parseCognigyScriptCon
11661
11760
  timeout: number;
11662
11761
  cacheTools: boolean;
11663
11762
  mcpHeaders?: Record<string, string>;
11763
+ authType?: "none" | "oAuth2";
11764
+ oAuth2Connection?: {
11765
+ oAuth2Url: string;
11766
+ oAuth2ClientId: string;
11767
+ oAuth2ClientSecret: string;
11768
+ oAuth2Scope?: string;
11769
+ };
11664
11770
  }) => Promise<{
11665
11771
  tools: any[];
11666
11772
  fromCache: boolean;
@@ -11673,10 +11779,26 @@ export interface INodeExecutionAPI extends Omit<IActions, "parseCognigyScriptCon
11673
11779
  mcpServerUrl: string;
11674
11780
  timeout: number;
11675
11781
  mcpHeaders?: Record<string, string>;
11782
+ authType?: "none" | "oAuth2";
11783
+ oAuth2Connection?: {
11784
+ oAuth2Url: string;
11785
+ oAuth2ClientId: string;
11786
+ oAuth2ClientSecret: string;
11787
+ oAuth2Scope?: string;
11788
+ };
11676
11789
  }) => Promise<{
11677
11790
  [x: string]: unknown;
11678
11791
  }>;
11679
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>;
11680
11802
  }
11681
11803
  export interface INodeExecutionCognigyObject extends IExecutionObjects {
11682
11804
  api: INodeExecutionAPI;
@@ -12167,6 +12289,9 @@ export interface IKnowledgeDescriptor {
12167
12289
  * extension:
12168
12290
  * type: string
12169
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
12170
12295
  * extensionImg:
12171
12296
  * type: string
12172
12297
  * description: The image URL of the extension that this knowledge descriptor belongs to
@@ -12174,6 +12299,7 @@ export interface IKnowledgeDescriptor {
12174
12299
  export interface IKnowledgeDescriptorAggregatedItem extends IKnowledgeDescriptor {
12175
12300
  extension: string;
12176
12301
  extensionImg: string;
12302
+ version: string;
12177
12303
  }
12178
12304
  export declare type IExtensionType = "nodes";
12179
12305
  export interface IExtension extends IExtensionData, IExtensionNodePackage {
@@ -12485,16 +12611,10 @@ export interface IHandoverServiceProperties {
12485
12611
  value: "basic";
12486
12612
  };
12487
12613
  }
12488
- export interface IHandoverProviderProperties {
12489
- key: "basicActionTile";
12490
- type: "cognigyText";
12491
- label: "UI__NODE_EDITOR__ASSIST_INFO__ACTION_TITLE__LABEL";
12492
- description: "UI__NODE_EDITOR__ASSIST_INFO__ACTION_TITLE__DESCRIPTION";
12493
- defaultValue: "";
12494
- condition: {
12495
- key: "cardType";
12496
- value: "basic";
12497
- };
12614
+ export declare type HandoverProviderPropertyValue = string | boolean;
12615
+ export interface IHandoverProviderProperty {
12616
+ key: string;
12617
+ value: HandoverProviderPropertyValue;
12498
12618
  }
12499
12619
  export interface IRCEHandoverSettings {
12500
12620
  /**
@@ -12690,7 +12810,7 @@ export interface IHandoverProvider {
12690
12810
  lastChanged: number;
12691
12811
  createdBy: TMongoId;
12692
12812
  lastChangedBy: TMongoId;
12693
- properties: IHandoverProviderProperties[];
12813
+ properties: IHandoverProviderProperty[];
12694
12814
  settings: IHandoverProviderSettings;
12695
12815
  }
12696
12816
  export interface IGraphHandoverProvider extends IHandoverProvider {
@@ -12741,8 +12861,8 @@ export interface ISimulation extends IProjectMetadata {
12741
12861
  export interface IGraphSimulation extends ISimulation {
12742
12862
  type: "simulation";
12743
12863
  }
12744
- export declare type IGraphResourceWithReferenceId = IGraphAgentAssistConfig | IGraphConnection | IGraphFlow | IGraphFunction | IGraphLargeLanguageModel | IGraphLexicon | IGraphLocale | IGraphNLUConnector | IGraphSnippet | IGraphAgentAssistConfig | IGraphKnowledgeStore | IGraphGoal | IGraphHandoverProvider | IGraphAiAgent;
12745
- 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;
12746
12866
  export declare type IGraphResource = IGraphResourceWithReferenceId | IGraphResourceWithoutReferenceId;
12747
12867
  /**
12748
12868
  * @openapi
@@ -17020,6 +17140,13 @@ export interface IVoiceConfigParams {
17020
17140
  deepgramEndpointing: boolean;
17021
17141
  deepgramEndpointingValue: number;
17022
17142
  deepgramSmartFormatting: boolean;
17143
+ deepgramfluxEndpointing: boolean;
17144
+ deepgramfluxEndOfTurnThreshold: number;
17145
+ deepgramfluxEndOfTurnTimeoutMs: number;
17146
+ speechmaticsEndpointing: boolean;
17147
+ speechmaticsEndpointingValue: number;
17148
+ openaiEndpointing: boolean;
17149
+ openaiEndpointingValue: number;
17023
17150
  atmosphereAction: TVoiceGateway2DubActionType;
17024
17151
  atmosphereUrl: string;
17025
17152
  atmosphereLoop: boolean;
@@ -17096,6 +17223,9 @@ export interface IVoiceConfigParams {
17096
17223
  deepgramEndpointing: boolean;
17097
17224
  deepgramEndpointingValue: number;
17098
17225
  deepgramSmartFormatting: boolean;
17226
+ deepgramfluxEndpointing: boolean;
17227
+ deepgramfluxEndOfTurnThreshold: number;
17228
+ deepgramfluxEndOfTurnTimeoutMs: number;
17099
17229
  }
17100
17230
  export interface ISessionSpeechParams extends INodeFunctionBaseParams {
17101
17231
  config: IVoiceConfigParams;
@@ -17515,6 +17645,13 @@ export interface ITransferNodeParams extends INodeFunctionBaseParams {
17515
17645
  deepgramEndpointing: boolean;
17516
17646
  deepgramEndpointingValue: number;
17517
17647
  deepgramSmartFormatting: boolean;
17648
+ deepgramfluxEndpointing: boolean;
17649
+ deepgramfluxEndOfTurnThreshold: number;
17650
+ deepgramfluxEndOfTurnTimeoutMs: number;
17651
+ speechmaticsEndpointing: boolean;
17652
+ speechmaticsEndpointingValue: number;
17653
+ openaiEndpointing: boolean;
17654
+ openaiEndpointingValue: number;
17518
17655
  amdEnabled: boolean;
17519
17656
  amdRedirectOnMachineDetected: boolean;
17520
17657
  amdRedirectText: string;
@@ -18136,7 +18273,7 @@ export interface IGoogleGeminiMeta_2_0 {
18136
18273
  * properties:
18137
18274
  * customModel:
18138
18275
  * type: string
18139
- * example: claude-3-opus-20240229
18276
+ * example: claude-opus-4-0
18140
18277
  * description: The custom model name. This does not work with embedding models
18141
18278
  * azureOpenAI:
18142
18279
  * type: object
@@ -18579,6 +18716,7 @@ export interface IKnowledgeSourceMetaData {
18579
18716
  type: string;
18580
18717
  };
18581
18718
  contentHashOrTimestamp?: string;
18719
+ externalIdentifier?: string;
18582
18720
  }
18583
18721
  /**
18584
18722
  * @openapi
@@ -18718,7 +18856,7 @@ export interface IKnowledgeSource_2_0 {
18718
18856
  metaData: IKnowledgeSourceMetaData;
18719
18857
  data: Record<string, unknown>;
18720
18858
  storeReference: TMongoId;
18721
- connectorReference?: TMongoId;
18859
+ connectorReference?: TMongoId | null;
18722
18860
  projectReference: TMongoId;
18723
18861
  organisationReference: TMongoId;
18724
18862
  createdAt: number;
@@ -19140,6 +19278,14 @@ export interface IUpdateKnowledgeConnectorRestData_2_0 extends IUpdateKnowledgeC
19140
19278
  }
19141
19279
  export interface IUpdateKnowledgeConnectorRestReturnValue_2_0 {
19142
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
+ }
19143
19289
  /**
19144
19290
  * @openapi
19145
19291
  *
@@ -19378,7 +19524,7 @@ export interface IHandoverProvider_2_0 {
19378
19524
  lastChangedAt: number;
19379
19525
  createdBy: TMongoId;
19380
19526
  lastChangedBy: TMongoId;
19381
- properties: IHandoverProviderProperties[];
19527
+ properties: IHandoverProviderProperty[];
19382
19528
  settings: IHandoverProviderSettings_2_0;
19383
19529
  }
19384
19530
  export interface IHandoverProviderSettings_2_0 {
@@ -19603,7 +19749,421 @@ export interface IGenerateDesignTimeLLMOutputRestData_2_0 extends IGenerateDesig
19603
19749
  export interface IGenerateDesignTimeLLMOutputRestReturnValue_2_0 {
19604
19750
  output: string | object;
19605
19751
  }
19606
- export interface ResourcesAPIGroup_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 {
19607
20167
  searchResources: TRestAPIOperation<ISearchResourcesRestData_2_0, ISearchResourcesRestReturnValue_2_0>;
19608
20168
  indexFlows: TRestAPIOperation<TRestAPIOptionalParameter<IIndexFlowsRestData_2_0>, IIndexFlowsRestReturnValue_2_0>;
19609
20169
  batchFlows: TRestAPIOperation<IBatchFlowsRestData_2_0, IBatchFlowsRestReturnValue_2_0>;
@@ -19859,6 +20419,7 @@ export interface ResourcesAPIGroup_2_0 {
19859
20419
  readKnowledgeConnector: TRestAPIOperation<IReadKnowledgeConnectorRestData_2_0, IReadKnowledgeConnectorRestReturnValue_2_0>;
19860
20420
  updateKnowledgeConnector: TRestAPIOperation<IUpdateKnowledgeConnectorRestData_2_0, IUpdateKnowledgeConnectorRestReturnValue_2_0>;
19861
20421
  deleteKnowledgeConnector: TRestAPIOperation<IDeleteKnowledgeConnectorRestData_2_0, IDeleteKnowledgeConnectorRestReturnValue_2_0>;
20422
+ runKnowledgeConnector: TRestAPIOperation<IRunKnowledgeConnectorRestData_2_0, IRunKnowledgeConnectorRestReturnValue_2_0>;
19862
20423
  uploadResumable: TTusAPIOperation<IUploadResumableRestData_2_0, IUploadResumableRestReturnValue_2_0>;
19863
20424
  generateNluScores: TRestAPIOperation<IGenerateNluScoresRestData_2_0, IGenerateNluScoresRestReturnValue_2_0>;
19864
20425
  generateDesignTimeLLMOutput: TRestAPIOperation<IGenerateDesignTimeLLMOutputRestData_2_0, IGenerateDesignTimeLLMOutputRestReturnValue_2_0>;
@@ -21920,7 +22481,8 @@ declare const actionTypes: readonly [
21920
22481
  "loginFailed",
21921
22482
  "loginError",
21922
22483
  "unauthorized",
21923
- "disableCreditCardRedaction"
22484
+ "disableCreditCardRedaction",
22485
+ "runKnowledgeConnector"
21924
22486
  ];
21925
22487
  export declare type TActionType = typeof actionTypes[number];
21926
22488
  /**
@@ -24283,11 +24845,16 @@ export interface IIndexSimulationRunBatchesRestDataQuery_2_0 {
24283
24845
  sort?: string;
24284
24846
  next?: string;
24285
24847
  previous?: string;
24848
+ scenariosIds?: string[];
24849
+ status?: string;
24850
+ timespan?: string;
24851
+ timezone?: string;
24852
+ endPointType?: string;
24286
24853
  }
24287
24854
  export interface IIndexSimulationRunBatchesRestData_2_0 extends IIndexSimulationRunBatchesRestDataQuery_2_0 {
24288
24855
  }
24289
24856
  export interface IIndexSimulationRunBatchesRestReturnValue_2_0 {
24290
- simulationRunBatches: ISimulationRunBatchRest_2_0[];
24857
+ data: ISimulationRunBatchRest_2_0[];
24291
24858
  }
24292
24859
  export interface IGetAllSimulationRunBatchesRestDataQuery_2_0 {
24293
24860
  projectId: string;
@@ -24633,6 +25200,73 @@ export interface IStopSimulationRunBatchRestData_2_0 extends IStopSimulationRunB
24633
25200
  export interface IStopSimulationRunBatchRestReturnValue_2_0 {
24634
25201
  simulationRunBatchId: ISimulationRunBatchRest_2_0;
24635
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
+ }
24636
25270
  declare enum ESchedulerFrequencyRest_2_0 {
24637
25271
  DAILY = "daily",
24638
25272
  EVERY_THREE_DAYS = "every three days",
@@ -24737,6 +25371,9 @@ export interface SimulationAPIGroup_2_0 {
24737
25371
  regeneratePersonaField: TRestAPIOperation<IRegeneratePersonaFieldRestData_2_0, IRegeneratePersonaFieldRestReturnValue_2_0>;
24738
25372
  generateBulkPersona: TRestAPIOperation<IGenerateBulkPersonaRestData_2_0, IGenerateBulkPersonaRestReturnValue_2_0>;
24739
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>;
24740
25377
  getScheduler: TRestAPIOperation<IGetSchedulerRestData_2_0, IGetSchedulerRestReturnValue_2_0>;
24741
25378
  createScheduler: TRestAPIOperation<ICreateSchedulerRestData_2_0, ICreateSchedulerRestReturnValue_2_0>;
24742
25379
  updateScheduler: TRestAPIOperation<IUpdateSchedulerRestData_2_0, IUpdateSchedulerRestReturnValue_2_0>;