@cognigy/rest-api-client 4.98.0 → 4.100.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +10 -0
- package/build/RestAPIClient.js +7 -0
- package/build/apigroups/AIOpsCenterAPIGroup_2_0.js +22 -0
- package/build/apigroups/ResourcesAPIGroup_2_0.js +11 -9
- package/build/apigroups/index.js +3 -1
- package/build/shared/charts/descriptors/agentAssist/htmlTemplates/knowledgeAssistTemplate.js +0 -44
- package/build/shared/charts/descriptors/agentAssist/htmlTemplates/secureForms/stage0.js +0 -45
- package/build/shared/charts/descriptors/agentAssist/htmlTemplates/secureForms/stage1.js +0 -43
- package/build/shared/charts/descriptors/agentAssist/htmlTemplates/secureForms/stageError.js +0 -45
- package/build/shared/charts/descriptors/connectionNodes/generativeAIProviders/index.js +6 -2
- package/build/shared/charts/descriptors/connectionNodes/generativeAIProviders/mistralProviderConnection.js +11 -0
- package/build/shared/charts/descriptors/index.js +7 -1
- package/build/shared/charts/descriptors/knowledgeSearch/searchExtractOutput.js +10 -1
- package/build/shared/charts/descriptors/service/GPTPrompt.js +14 -4
- package/build/shared/charts/descriptors/service/LLMEntityExtract.js +1 -1
- package/build/shared/charts/descriptors/service/LLMModerate.js +275 -0
- package/build/shared/charts/descriptors/service/aiAgent/aiAgentJob.js +185 -63
- package/build/shared/charts/descriptors/service/aiAgent/aiAgentJobCallMCPTool.js +180 -0
- package/build/shared/charts/descriptors/service/aiAgent/aiAgentJobMCPTool.js +196 -0
- package/build/shared/charts/descriptors/service/aiAgent/aiAgentToolAnswer.js +5 -1
- package/build/shared/charts/descriptors/service/index.js +9 -1
- package/build/shared/charts/descriptors/service/niceCXOneAAHAuthenticationConnection.js +12 -0
- package/build/shared/charts/descriptors/voice/mappers/hangup.mapper.js +9 -8
- package/build/shared/charts/descriptors/voice/mappers/setSessionConfig.mapper.js +9 -10
- package/build/shared/charts/descriptors/voice/nodes/hangup.js +1 -1
- package/build/shared/charts/descriptors/voicegateway/nodes/hangup.js +1 -1
- package/build/shared/charts/descriptors/voicegateway2/nodes/hangup.js +24 -2
- package/build/shared/charts/descriptors/voicegateway2/nodes/setSessionConfig.js +25 -5
- package/build/shared/interfaces/amqpInterface.js +3 -0
- package/build/shared/interfaces/generativeAI/IGenerativeAIModels.js +10 -1
- package/build/shared/interfaces/messageAPI/endpoints.js +44 -119
- package/build/shared/interfaces/resources/IEndpoint.js +23 -4
- package/build/shared/interfaces/resources/ILargeLanguageModel.js +10 -1
- package/build/shared/interfaces/resources/ISipConnectivityInfo.js +16 -0
- package/build/shared/interfaces/resources/IWebrtcWidgetConfig.js +11 -0
- package/build/shared/interfaces/restAPI/metrics/conversationCounter/v3.0/IConversationCounterPreAggregatedValue_3_0.js +3 -0
- package/build/shared/interfaces/restAPI/metrics/conversationCounter/v3.0/IGetConversationCounterOrganisationRest_3_0.js +3 -0
- package/build/shared/interfaces/restAPI/metrics/conversationCounter/v3.0/IGetConversationCounterRest_3_0.js +3 -0
- package/build/shared/interfaces/restAPI/metrics/conversationCounter/v3.0/index.js +3 -0
- package/build/shared/interfaces/restAPI/opsCenter/alerts/IIndexOpsCenterAlertsRest_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/opsCenter/alerts/IOpsCenterAlert.js +3 -0
- package/build/shared/interfaces/restAPI/opsCenter/component/IOpsCenterComponents.js +34 -0
- package/build/shared/interfaces/restAPI/opsCenter/errors/IDeleteOpsCenterErrorRest_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/opsCenter/errors/IGetOpsCenterErrorRest_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/opsCenter/errors/IIndexOpsCenterErrorsRest_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/opsCenter/errors/IOpsCenterError.js +3 -0
- package/build/shared/interfaces/restAPI/opsCenter/metrics/IGetOpsCenterMetrics.js +3 -0
- package/build/shared/interfaces/restAPI/opsCenter/metrics/IGetOpsCenterMetricsConfigRest_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/opsCenter/metrics/IGetOpsCenterMetricsRangeRest_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/opsCenter/metrics/IGetOpsCenterMetricsRest_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/opsCenter/metrics/IOpsCenterMetricsConfig.js +6 -0
- package/build/shared/interfaces/restAPI/opsCenter/observationConfig/IGetOpsCenterObservationConfigRest_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/opsCenter/observationConfig/IOpsCenterObservationConfig.js +4 -0
- package/build/shared/interfaces/restAPI/opsCenter/observationConfig/IPatchOpsCenterObservationConfigRest_2_0.js +3 -0
- package/build/shared/interfaces/restAPI/opsCenter/observationConfig/ISetupOpsCenterObservationConfigRest_2_0.js +3 -0
- package/build/shared/interfaces/security/IConversationCounterPreAggregatedValue.js +3 -0
- package/build/shared/interfaces/security/IIdentityProvider.js +1 -0
- package/build/shared/json-schema.js +2 -1
- package/dist/esm/RestAPIClient.js +7 -0
- package/dist/esm/apigroups/AIOpsCenterAPIGroup_2_0.js +18 -0
- package/dist/esm/apigroups/ResourcesAPIGroup_2_0.js +11 -9
- package/dist/esm/apigroups/index.js +1 -0
- package/dist/esm/shared/charts/descriptors/agentAssist/htmlTemplates/knowledgeAssistTemplate.js +0 -44
- package/dist/esm/shared/charts/descriptors/agentAssist/htmlTemplates/secureForms/stage0.js +0 -45
- package/dist/esm/shared/charts/descriptors/agentAssist/htmlTemplates/secureForms/stage1.js +0 -43
- package/dist/esm/shared/charts/descriptors/agentAssist/htmlTemplates/secureForms/stageError.js +0 -45
- package/dist/esm/shared/charts/descriptors/connectionNodes/generativeAIProviders/index.js +4 -1
- package/dist/esm/shared/charts/descriptors/connectionNodes/generativeAIProviders/mistralProviderConnection.js +8 -0
- package/dist/esm/shared/charts/descriptors/index.js +8 -2
- package/dist/esm/shared/charts/descriptors/knowledgeSearch/searchExtractOutput.js +12 -3
- package/dist/esm/shared/charts/descriptors/service/GPTPrompt.js +18 -8
- package/dist/esm/shared/charts/descriptors/service/LLMEntityExtract.js +1 -1
- package/dist/esm/shared/charts/descriptors/service/LLMModerate.js +273 -0
- package/dist/esm/shared/charts/descriptors/service/aiAgent/aiAgentJob.js +185 -63
- package/dist/esm/shared/charts/descriptors/service/aiAgent/aiAgentJobCallMCPTool.js +178 -0
- package/dist/esm/shared/charts/descriptors/service/aiAgent/aiAgentJobMCPTool.js +193 -0
- package/dist/esm/shared/charts/descriptors/service/aiAgent/aiAgentToolAnswer.js +5 -1
- package/dist/esm/shared/charts/descriptors/service/index.js +4 -0
- package/dist/esm/shared/charts/descriptors/service/niceCXOneAAHAuthenticationConnection.js +9 -0
- package/dist/esm/shared/charts/descriptors/voice/mappers/hangup.mapper.js +9 -8
- package/dist/esm/shared/charts/descriptors/voice/mappers/setSessionConfig.mapper.js +9 -10
- package/dist/esm/shared/charts/descriptors/voice/nodes/hangup.js +1 -1
- package/dist/esm/shared/charts/descriptors/voicegateway/nodes/hangup.js +1 -1
- package/dist/esm/shared/charts/descriptors/voicegateway2/nodes/hangup.js +24 -2
- package/dist/esm/shared/charts/descriptors/voicegateway2/nodes/setSessionConfig.js +25 -5
- package/dist/esm/shared/interfaces/amqpInterface.js +3 -0
- package/dist/esm/shared/interfaces/generativeAI/IGenerativeAIModels.js +10 -1
- package/dist/esm/shared/interfaces/messageAPI/endpoints.js +43 -118
- package/dist/esm/shared/interfaces/resources/IEndpoint.js +26 -7
- package/dist/esm/shared/interfaces/resources/ILargeLanguageModel.js +9 -0
- package/dist/esm/shared/interfaces/resources/ISipConnectivityInfo.js +13 -0
- package/dist/esm/shared/interfaces/resources/IWebrtcWidgetConfig.js +8 -0
- package/dist/esm/shared/interfaces/restAPI/metrics/conversationCounter/v3.0/IConversationCounterPreAggregatedValue_3_0.js +2 -0
- package/dist/esm/shared/interfaces/restAPI/metrics/conversationCounter/v3.0/IGetConversationCounterOrganisationRest_3_0.js +2 -0
- package/dist/esm/shared/interfaces/restAPI/metrics/conversationCounter/v3.0/IGetConversationCounterRest_3_0.js +2 -0
- package/dist/esm/shared/interfaces/restAPI/metrics/conversationCounter/v3.0/index.js +2 -0
- package/dist/esm/shared/interfaces/restAPI/opsCenter/alerts/IIndexOpsCenterAlertsRest_2_0.js +2 -0
- package/dist/esm/shared/interfaces/restAPI/opsCenter/alerts/IOpsCenterAlert.js +2 -0
- package/dist/esm/shared/interfaces/restAPI/opsCenter/component/IOpsCenterComponents.js +31 -0
- package/dist/esm/shared/interfaces/restAPI/opsCenter/errors/IDeleteOpsCenterErrorRest_2_0.js +2 -0
- package/dist/esm/shared/interfaces/restAPI/opsCenter/errors/IGetOpsCenterErrorRest_2_0.js +2 -0
- package/dist/esm/shared/interfaces/restAPI/opsCenter/errors/IIndexOpsCenterErrorsRest_2_0.js +2 -0
- package/dist/esm/shared/interfaces/restAPI/opsCenter/errors/IOpsCenterError.js +2 -0
- package/dist/esm/shared/interfaces/restAPI/opsCenter/metrics/IGetOpsCenterMetrics.js +2 -0
- package/dist/esm/shared/interfaces/restAPI/opsCenter/metrics/IGetOpsCenterMetricsConfigRest_2_0.js +2 -0
- package/dist/esm/shared/interfaces/restAPI/opsCenter/metrics/IGetOpsCenterMetricsRangeRest_2_0.js +2 -0
- package/dist/esm/shared/interfaces/restAPI/opsCenter/metrics/IGetOpsCenterMetricsRest_2_0.js +2 -0
- package/dist/esm/shared/interfaces/restAPI/opsCenter/metrics/IOpsCenterMetricsConfig.js +5 -0
- package/dist/esm/shared/interfaces/restAPI/opsCenter/observationConfig/IGetOpsCenterObservationConfigRest_2_0.js +2 -0
- package/dist/esm/shared/interfaces/restAPI/opsCenter/observationConfig/IOpsCenterObservationConfig.js +3 -0
- package/dist/esm/shared/interfaces/restAPI/opsCenter/observationConfig/IPatchOpsCenterObservationConfigRest_2_0.js +2 -0
- package/dist/esm/shared/interfaces/restAPI/opsCenter/observationConfig/ISetupOpsCenterObservationConfigRest_2_0.js +2 -0
- package/dist/esm/shared/interfaces/security/IConversationCounterPreAggregatedValue.js +2 -0
- package/dist/esm/shared/interfaces/security/IIdentityProvider.js +1 -0
- package/dist/esm/shared/json-schema.js +2 -1
- package/package.json +1 -1
- package/types/index.d.ts +392 -43
package/types/index.d.ts
CHANGED
|
@@ -1315,6 +1315,9 @@ export interface IAllowedLocale {
|
|
|
1315
1315
|
* idpCertificate:
|
|
1316
1316
|
* type: string
|
|
1317
1317
|
* description: The certificate from the ID used to sign the SAML requests. It is base64 encoded.
|
|
1318
|
+
* wantAuthnResponseSigned:
|
|
1319
|
+
* type: boolean
|
|
1320
|
+
* description: If the SAML authentification response should be signed, not all providers support this.
|
|
1318
1321
|
* decryptionPrivateKey:
|
|
1319
1322
|
* type: string
|
|
1320
1323
|
* description: An optional decryption key. This is necessary if the SAML request is encoded.
|
|
@@ -1362,6 +1365,11 @@ export interface ISamlIdentityProvider {
|
|
|
1362
1365
|
* Reference the organisation this identity provider belongs to.
|
|
1363
1366
|
*/
|
|
1364
1367
|
organisationReference: TMongoId;
|
|
1368
|
+
/**
|
|
1369
|
+
* If the SAML authentification response should be signed,
|
|
1370
|
+
* not all providers support this.
|
|
1371
|
+
*/
|
|
1372
|
+
wantAuthnResponseSigned?: boolean;
|
|
1365
1373
|
}
|
|
1366
1374
|
declare const idpTokenEndpointAuthMethods: readonly [
|
|
1367
1375
|
"client_secret_basic",
|
|
@@ -1605,6 +1613,7 @@ export interface IRestAPIClientVersionConfiguration {
|
|
|
1605
1613
|
insights: "2.0";
|
|
1606
1614
|
analytics: "2.0";
|
|
1607
1615
|
jwt: "2.0";
|
|
1616
|
+
opsCenter: "2.0";
|
|
1608
1617
|
}
|
|
1609
1618
|
export declare type THttpLib = "axios";
|
|
1610
1619
|
/**
|
|
@@ -2382,6 +2391,14 @@ export interface IEndpointTranslationSettings {
|
|
|
2382
2391
|
alwaysRemoveNoTranslateMarker: boolean;
|
|
2383
2392
|
setInputLanguageOnExecutionCount: number;
|
|
2384
2393
|
}
|
|
2394
|
+
export interface ISipConnectivityInfo {
|
|
2395
|
+
realm: string;
|
|
2396
|
+
username: string;
|
|
2397
|
+
password: string;
|
|
2398
|
+
applicationSid: string;
|
|
2399
|
+
wsUri?: string;
|
|
2400
|
+
clientSid: string;
|
|
2401
|
+
}
|
|
2385
2402
|
export interface IEndpoint extends IEntityMeta {
|
|
2386
2403
|
channel: TChannelType;
|
|
2387
2404
|
/**
|
|
@@ -2393,6 +2410,10 @@ export interface IEndpoint extends IEntityMeta {
|
|
|
2393
2410
|
* The ID of the Snapshot or Project to target
|
|
2394
2411
|
*/
|
|
2395
2412
|
entrypoint: TMongoId;
|
|
2413
|
+
/**
|
|
2414
|
+
* The custom icon for the endpoint.
|
|
2415
|
+
*/
|
|
2416
|
+
customIcon: string;
|
|
2396
2417
|
/** The URL Token we publish on the endpoints and use to retrieve the correct endpoint configurations */
|
|
2397
2418
|
URLToken: string;
|
|
2398
2419
|
/** The name of the endpoint resource */
|
|
@@ -2408,8 +2429,8 @@ export interface IEndpoint extends IEntityMeta {
|
|
|
2408
2429
|
*/
|
|
2409
2430
|
useConversations: boolean;
|
|
2410
2431
|
/**
|
|
2411
|
-
|
|
2412
|
-
|
|
2432
|
+
* Whether to mask sensitive IP address in input object and analytics data for this endpoint
|
|
2433
|
+
*/
|
|
2413
2434
|
maskIPAddress: boolean;
|
|
2414
2435
|
/**
|
|
2415
2436
|
* Whether to mask sensitive data in analytics for this endpoint
|
|
@@ -2464,6 +2485,13 @@ export interface IEndpoint extends IEntityMeta {
|
|
|
2464
2485
|
* with those of the Agent */
|
|
2465
2486
|
overrideSnapshotConnections: boolean;
|
|
2466
2487
|
fileStorageSettings: IFileStorageSettings;
|
|
2488
|
+
/** Whether to use the webrtc application exists for this endpoint */
|
|
2489
|
+
webrtcClient?: boolean;
|
|
2490
|
+
sipConnectivityInfo?: ISipConnectivityInfo;
|
|
2491
|
+
/** The label of the webrtc widget */
|
|
2492
|
+
webrtcWidgetConfig?: {
|
|
2493
|
+
label: string;
|
|
2494
|
+
};
|
|
2467
2495
|
}
|
|
2468
2496
|
export interface IGraphEndpoint {
|
|
2469
2497
|
type: "endpoint";
|
|
@@ -2658,7 +2686,7 @@ export interface IVoiceGatewayEndpointSettings extends IEndpointSessionSettings
|
|
|
2658
2686
|
genericSettings?: IVGGenericSettings;
|
|
2659
2687
|
isFeatureAccmEnabled?: boolean;
|
|
2660
2688
|
}
|
|
2661
|
-
export declare type AnyEndpointSettings = IFacebookEndpointSettings | IWorkplaceEndpointSettings | ISlackEndpointSettings | IGenericEndpointSettings | IAlexaEndpointSettings | IWebchat2EndpointSettings | IWebchat3EndpointSettings | ILineEndpointSettings | ITwilioEndpointSettings | ITwilioSmsEndpointSettings | IIntercomEndpointSettings | IRealtimeEndpointSettings | ISunshineConversationsEndpointSettings | IAvayaEndpointSettings | IUserlikeEndpointSettings | IBandwidthEndpointSettings | IAudioCodesEndpointSettings | IWhatsAppEndpointSettings | IAmazonLexEndpointSettings | IEightByEightEndpointSettings | IMicrosoftBotFrameworkEndpointSettings | IVoiceGatewayEndpointSettings | IGenesysBotConnectorEndpointSettings | INiceCXOneEndpointSettings | IAgentAssistVoiceEndpointSettings | {};
|
|
2689
|
+
export declare type AnyEndpointSettings = IFacebookEndpointSettings | IWorkplaceEndpointSettings | ISlackEndpointSettings | IGenericEndpointSettings | IAlexaEndpointSettings | IWebchat2EndpointSettings | IWebchat3EndpointSettings | ILineEndpointSettings | ITwilioEndpointSettings | ITwilioSmsEndpointSettings | IIntercomEndpointSettings | IRealtimeEndpointSettings | ISunshineConversationsEndpointSettings | IAvayaEndpointSettings | IUserlikeEndpointSettings | IBandwidthEndpointSettings | IAudioCodesEndpointSettings | IWhatsAppEndpointSettings | IAmazonLexEndpointSettings | IEightByEightEndpointSettings | IMicrosoftBotFrameworkEndpointSettings | IVoiceGatewayEndpointSettings | IGenesysBotConnectorEndpointSettings | INiceCXOneEndpointSettings | INiceCXOneAAHEndpointSettings | IAgentAssistVoiceEndpointSettings | {};
|
|
2662
2690
|
export declare type TAvayaVoice = "man" | "woman" | string;
|
|
2663
2691
|
declare const avayaSttTtsLanguages: readonly [
|
|
2664
2692
|
"cy-GB",
|
|
@@ -3439,6 +3467,12 @@ export interface IWebchat3EndpointBehaviorSettings {
|
|
|
3439
3467
|
* This setting enables output messages to appear progressively.
|
|
3440
3468
|
*/
|
|
3441
3469
|
progressiveMessageRendering: boolean;
|
|
3470
|
+
/**
|
|
3471
|
+
* This setting enables scroll-to-bottom button.
|
|
3472
|
+
*
|
|
3473
|
+
* Default: true
|
|
3474
|
+
*/
|
|
3475
|
+
enableScrollButton: boolean;
|
|
3442
3476
|
/**
|
|
3443
3477
|
* Whether the webchat renders Text messages as markdown
|
|
3444
3478
|
*/
|
|
@@ -3566,6 +3600,10 @@ export interface IWebchat3EndpointHomeScreenSettings {
|
|
|
3566
3600
|
*/
|
|
3567
3601
|
startConversationButtonText: string;
|
|
3568
3602
|
previousConversations: {
|
|
3603
|
+
/**
|
|
3604
|
+
* Enable the delete all conversations button
|
|
3605
|
+
*/
|
|
3606
|
+
enableDeleteAllConversations: boolean;
|
|
3569
3607
|
/**
|
|
3570
3608
|
* The text of the start new conversation button
|
|
3571
3609
|
*/
|
|
@@ -3673,6 +3711,10 @@ export interface IWebchat3EndpointChatOptionsSettings {
|
|
|
3673
3711
|
submitButtonText: string;
|
|
3674
3712
|
eventBannerText: string;
|
|
3675
3713
|
};
|
|
3714
|
+
/**
|
|
3715
|
+
* Enable to delete conversation
|
|
3716
|
+
*/
|
|
3717
|
+
enableDeleteConversation: boolean;
|
|
3676
3718
|
/**
|
|
3677
3719
|
* The configuration of the chat options footer
|
|
3678
3720
|
*/
|
|
@@ -4266,6 +4308,9 @@ export interface IGenesysBotConnectorEndpointSettings {
|
|
|
4266
4308
|
export interface INiceCXOneEndpointSettings {
|
|
4267
4309
|
verifyToken: string;
|
|
4268
4310
|
}
|
|
4311
|
+
export interface INiceCXOneAAHEndpointSettings {
|
|
4312
|
+
niceCXOneAAHConnection: string;
|
|
4313
|
+
}
|
|
4269
4314
|
declare const arrayNLUConnectorType_2_0: readonly [
|
|
4270
4315
|
"alexa",
|
|
4271
4316
|
"dialogflow",
|
|
@@ -4298,16 +4343,23 @@ declare const generativeAIModels: readonly [
|
|
|
4298
4343
|
"gemini-1.0-pro",
|
|
4299
4344
|
"gemini-1.5-pro",
|
|
4300
4345
|
"gemini-1.5-flash",
|
|
4346
|
+
"gemini-2.0-flash",
|
|
4347
|
+
"gemini-2.0-flash-lite",
|
|
4301
4348
|
"amazon.nova-lite-v1:0",
|
|
4302
4349
|
"amazon.nova-pro-v1:0",
|
|
4303
4350
|
"amazon.nova-micro-v1:0",
|
|
4304
4351
|
"anthropic.claude-3-5-sonnet-20240620-v1:0",
|
|
4305
4352
|
"claude-3-7-sonnet-20250219",
|
|
4353
|
+
"mistral-large-2411",
|
|
4354
|
+
"mistral-small-2503",
|
|
4355
|
+
"pixtral-large-2411",
|
|
4356
|
+
"pixtral-12b-2409",
|
|
4306
4357
|
"text-embedding-3-small",
|
|
4307
4358
|
"text-embedding-3-large",
|
|
4308
4359
|
"text-embedding-ada-002",
|
|
4309
4360
|
"luminous-embedding-128",
|
|
4310
|
-
"amazon.titan-embed-text-v2:0"
|
|
4361
|
+
"amazon.titan-embed-text-v2:0",
|
|
4362
|
+
"Pharia-1-Embedding-4608"
|
|
4311
4363
|
];
|
|
4312
4364
|
/**
|
|
4313
4365
|
* @openapi
|
|
@@ -4325,6 +4377,7 @@ declare const generativeAIModels: readonly [
|
|
|
4325
4377
|
* - text-embedding-ada-002
|
|
4326
4378
|
* - luminous-extended-control
|
|
4327
4379
|
* - luminous-embedding-128
|
|
4380
|
+
* - Pharia-1-Embedding-4608
|
|
4328
4381
|
* - claude-v1-100k
|
|
4329
4382
|
* - claude-instant-v1
|
|
4330
4383
|
* - claude-3-opus-20240229
|
|
@@ -4333,6 +4386,12 @@ declare const generativeAIModels: readonly [
|
|
|
4333
4386
|
* - gemini-1.0-pro
|
|
4334
4387
|
* - gemini-1.5-pro
|
|
4335
4388
|
* - gemini-1.5-flash
|
|
4389
|
+
* - gemini-2.0-flash
|
|
4390
|
+
* - gemini-2.0-flash-lite
|
|
4391
|
+
* - mistral-large-2411
|
|
4392
|
+
* - mistral-small-2503
|
|
4393
|
+
* - pixtral-large-2411
|
|
4394
|
+
* - pixtral-12b-2409
|
|
4336
4395
|
*/
|
|
4337
4396
|
export declare type TGenerativeAIModels = (typeof generativeAIModels)[number];
|
|
4338
4397
|
declare const generativeAIProviders: readonly [
|
|
@@ -4343,7 +4402,8 @@ declare const generativeAIProviders: readonly [
|
|
|
4343
4402
|
"anthropic",
|
|
4344
4403
|
"googleVertexAI",
|
|
4345
4404
|
"googleGemini",
|
|
4346
|
-
"awsBedrock"
|
|
4405
|
+
"awsBedrock",
|
|
4406
|
+
"mistral"
|
|
4347
4407
|
];
|
|
4348
4408
|
/**
|
|
4349
4409
|
* @openapi
|
|
@@ -4360,6 +4420,7 @@ declare const generativeAIProviders: readonly [
|
|
|
4360
4420
|
* - googleGemini
|
|
4361
4421
|
* - alephAlpha
|
|
4362
4422
|
* - awsBedrock
|
|
4423
|
+
* - mistral
|
|
4363
4424
|
*/
|
|
4364
4425
|
export declare type TGenerativeAIProviders = (typeof generativeAIProviders)[number];
|
|
4365
4426
|
declare const generativeAIUseCases: readonly [
|
|
@@ -5226,6 +5287,7 @@ export interface IAudioPreviewSettings_2_0 {
|
|
|
5226
5287
|
* - googleGemini
|
|
5227
5288
|
* - alephAlpha
|
|
5228
5289
|
* - awsBedrock
|
|
5290
|
+
* - mistral
|
|
5229
5291
|
*/
|
|
5230
5292
|
export declare type TGenerativeAIProviders_2_0 = TGenerativeAIProviders;
|
|
5231
5293
|
/**
|
|
@@ -7194,6 +7256,13 @@ export interface IEndpoint_2_0 {
|
|
|
7194
7256
|
overrideSnapshotConnections: boolean;
|
|
7195
7257
|
fileStorageSettings: IEndpointFileStorageSettings_2_0;
|
|
7196
7258
|
orgDataPrivacySettings?: IEndpoitOrgDataPrivacySettings_2_0;
|
|
7259
|
+
/** Whether to use the webrtc application exists for this endpoint */
|
|
7260
|
+
webrtcClient?: boolean;
|
|
7261
|
+
sipConnectivityInfo?: ISipConnectivityInfo;
|
|
7262
|
+
/** The label of the webrtc widget */
|
|
7263
|
+
webrtcWidgetConfig?: {
|
|
7264
|
+
label: string;
|
|
7265
|
+
};
|
|
7197
7266
|
}
|
|
7198
7267
|
export interface ITransformerFunction_2_0 {
|
|
7199
7268
|
/**
|
|
@@ -7351,6 +7420,7 @@ export interface IReadEndpointRestData_2_0 extends IReadEndpointRestDataParams_2
|
|
|
7351
7420
|
export interface IReadEndpointRestReturnValue_2_0 extends IEndpoint_2_0 {
|
|
7352
7421
|
}
|
|
7353
7422
|
export interface IUpdateEndpointRestDataBody_2_0 extends Partial<Omit<IEndpoint_2_0, keyof IEntityMeta | "URLToken">> {
|
|
7423
|
+
createWebrtcClient?: boolean;
|
|
7354
7424
|
}
|
|
7355
7425
|
export interface IUpdateEndpointRestDataParams_2_0 {
|
|
7356
7426
|
endpointId: string;
|
|
@@ -7361,6 +7431,7 @@ export interface IUpdateEndpointRestReturnValue_2_0 {
|
|
|
7361
7431
|
}
|
|
7362
7432
|
export interface IDeleteEndpointRestDataParams_2_0 {
|
|
7363
7433
|
endpointId: string;
|
|
7434
|
+
channelType?: TChannelType;
|
|
7364
7435
|
}
|
|
7365
7436
|
export interface IDeleteEndpointRestData_2_0 extends IDeleteEndpointRestDataParams_2_0 {
|
|
7366
7437
|
}
|
|
@@ -8658,6 +8729,9 @@ export interface IAlephAlphaMeta {
|
|
|
8658
8729
|
export interface IAnthropicMeta {
|
|
8659
8730
|
customModel?: string;
|
|
8660
8731
|
}
|
|
8732
|
+
export interface IMistralMeta {
|
|
8733
|
+
customModel?: string;
|
|
8734
|
+
}
|
|
8661
8735
|
export interface IAwsBedrockMeta {
|
|
8662
8736
|
region: string;
|
|
8663
8737
|
customModel?: string;
|
|
@@ -8710,6 +8784,7 @@ export interface ILargeLanguageModel extends IEntityMeta, IGlobalResource {
|
|
|
8710
8784
|
openAICompatible?: IOpenAICompatibleMeta;
|
|
8711
8785
|
alephAlpha?: IAlephAlphaMeta;
|
|
8712
8786
|
anthropic?: IAnthropicMeta;
|
|
8787
|
+
mistral?: IMistralMeta;
|
|
8713
8788
|
awsBedrock?: IAwsBedrockMeta;
|
|
8714
8789
|
fallbacks?: TLLMFallback[];
|
|
8715
8790
|
}
|
|
@@ -9911,6 +9986,9 @@ export interface ISessionStateWithoutMeta {
|
|
|
9911
9986
|
flow: string;
|
|
9912
9987
|
node: string;
|
|
9913
9988
|
};
|
|
9989
|
+
mcpServerUrl?: string;
|
|
9990
|
+
mcpToolNode?: string;
|
|
9991
|
+
timeout?: number;
|
|
9914
9992
|
};
|
|
9915
9993
|
tokenUsage?: TSessionUsageInformation;
|
|
9916
9994
|
}
|
|
@@ -10219,6 +10297,9 @@ export interface IAzureOpenAIProviderOauth2Fields {
|
|
|
10219
10297
|
oauthUrl: string;
|
|
10220
10298
|
scope: string;
|
|
10221
10299
|
}
|
|
10300
|
+
export interface IAlephAlphaProviderFields {
|
|
10301
|
+
token: string;
|
|
10302
|
+
}
|
|
10222
10303
|
export interface IAwsBedrockProviderFields {
|
|
10223
10304
|
accessKeyId: string;
|
|
10224
10305
|
secretAccessKey: string;
|
|
@@ -10255,7 +10336,7 @@ export interface IProviderOauth2Fields extends IAzureOpenAIProviderOauth2Fields
|
|
|
10255
10336
|
}
|
|
10256
10337
|
export interface ISearchLLMCredentials {
|
|
10257
10338
|
provider: TGenerativeAIProviders;
|
|
10258
|
-
connectionFields: IAzureOpenAIProviderFieldsV2 | IProviderOauth2Fields | IAwsBedrockProviderFields;
|
|
10339
|
+
connectionFields: IAzureOpenAIProviderFieldsV2 | IProviderOauth2Fields | IAwsBedrockProviderFields | IAlephAlphaProviderFields;
|
|
10259
10340
|
providerMetaData: IAzureOpenAIMeta;
|
|
10260
10341
|
}
|
|
10261
10342
|
export interface ISearchTagsData {
|
|
@@ -10395,6 +10476,38 @@ export interface IGoalEscalations extends IGoalAnalyticsData, IAnalyticsEndpoint
|
|
|
10395
10476
|
export interface IEndpointSettings {
|
|
10396
10477
|
isFeatureAccmEnabled?: boolean;
|
|
10397
10478
|
}
|
|
10479
|
+
export interface IChartExecutableNode<C extends INodeFunctionBaseParams = INodeFunctionBaseParams> extends IProjectScope, IOrganisationScope {
|
|
10480
|
+
id: string;
|
|
10481
|
+
_id?: string;
|
|
10482
|
+
type: string;
|
|
10483
|
+
label?: string;
|
|
10484
|
+
extension: string;
|
|
10485
|
+
behavior: {
|
|
10486
|
+
stopping: boolean;
|
|
10487
|
+
};
|
|
10488
|
+
fields: INodeFieldSet;
|
|
10489
|
+
children: string[];
|
|
10490
|
+
next: string | null;
|
|
10491
|
+
config: C["config"];
|
|
10492
|
+
/**
|
|
10493
|
+
* Whether the node contain trustedCode.
|
|
10494
|
+
* Our cognigy nodes have trustedCodes - custom modules do not
|
|
10495
|
+
* have trusted-codes by default. This determines whether the nodes
|
|
10496
|
+
* function is executed in service-ai or service-execution.
|
|
10497
|
+
*/
|
|
10498
|
+
trustedCode: boolean;
|
|
10499
|
+
pathToPackageExecutable: string;
|
|
10500
|
+
/**
|
|
10501
|
+
* Whether the node is a standard
|
|
10502
|
+
* Cognigy node, e.g. a sendText node.
|
|
10503
|
+
*/
|
|
10504
|
+
isCognigy: boolean;
|
|
10505
|
+
/**
|
|
10506
|
+
* Whether the node is disabled
|
|
10507
|
+
*/
|
|
10508
|
+
isDisabled: boolean;
|
|
10509
|
+
analyticsLabel?: string;
|
|
10510
|
+
}
|
|
10398
10511
|
export interface IGetConversationTranscriptParams {
|
|
10399
10512
|
turnLimit: number;
|
|
10400
10513
|
}
|
|
@@ -10437,6 +10550,11 @@ export interface IRephraseSentenceWithAIOptions {
|
|
|
10437
10550
|
answer?: string;
|
|
10438
10551
|
}
|
|
10439
10552
|
export declare type TBrainSessionState = Partial<Pick<ISessionState, "frustration" | "lastFlowPath" | "apps" | "lastConversationEntries" | "analytics" | "lastToolCall" | "tokenUsage">>;
|
|
10553
|
+
export declare type TNodeAnalyticsParams = {
|
|
10554
|
+
nodeId: IChartExecutableNode["id"];
|
|
10555
|
+
nodeLabel: IChartExecutableNode["label"];
|
|
10556
|
+
nodeType: IChartExecutableNode["type"];
|
|
10557
|
+
};
|
|
10440
10558
|
export interface IActions {
|
|
10441
10559
|
addConditionalEntrypoint?: (actions: IActions, flowId: string) => (addConditionalEntrypointParams: IAddConditionalEntrypointParams) => void;
|
|
10442
10560
|
addHandoverInactivityTimer?: (params: {
|
|
@@ -10510,7 +10628,7 @@ export interface IActions {
|
|
|
10510
10628
|
rephraseSentenceWithAI(sentence: string, options: IRephraseSentenceWithAIOptions): Promise<string>;
|
|
10511
10629
|
rephraseMultipleSentencesWithAI(sentences: string[], options: IRephraseSentenceWithAIOptions): Promise<string[]>;
|
|
10512
10630
|
requestHandover?: (text: string, cancel: string, userId: string, sessionId: string, requestHandover: string, inputAnalyticsData: IAnalyticsSourceData, handoverVersion?: IHandoverRequestStatus["handoverVersion"], repeatHandoverMessage?: boolean, sendResolveEvent?: boolean, resolveBehavior?: IHandoverRequestStatus["resolveBehavior"], nodeType?: IHandoverRequestStatus["nodeType"], agentAssistInitMessage?: string, providerResponse?: any, sendOnQueueEvent?: boolean, sendOnActiveEvent?: boolean) => void;
|
|
10513
|
-
runGenerativeAIPrompt?: (options: IRunGenerativeAIPromptOptions, useCase: TGenerativeAIUseCases) => Promise<any>;
|
|
10631
|
+
runGenerativeAIPrompt?: (options: IRunGenerativeAIPromptOptions, useCase: TGenerativeAIUseCases, nodeAnalyticsParams?: TNodeAnalyticsParams) => Promise<any>;
|
|
10514
10632
|
resetContext?: () => object;
|
|
10515
10633
|
resetFormBrain?: () => Promise<void>;
|
|
10516
10634
|
resetState?: () => Promise<string>;
|
|
@@ -10548,7 +10666,7 @@ export interface IActions {
|
|
|
10548
10666
|
thinkV2?: (nodeId: string) => (text: string, data: any) => void;
|
|
10549
10667
|
trackAnalyticsStep?: (stepLabel: string) => (trackArgs?: ITrackAnalyticsStepsArguments) => void;
|
|
10550
10668
|
updateProfile?: (profileSchemaField: string, value: any) => Promise<any>;
|
|
10551
|
-
knowledgeSearch: (data: IKnowledgeSearchData) => Promise<IKnowledgeSearchReturnValue>;
|
|
10669
|
+
knowledgeSearch: (data: IKnowledgeSearchData, nodeAnalyticsParams?: TNodeAnalyticsParams) => Promise<IKnowledgeSearchReturnValue>;
|
|
10552
10670
|
matchPattern: (patternType: IPatternTypes, phrase: string, locale?: string) => IPatternMatchResult;
|
|
10553
10671
|
getAgentAssistConfigId: () => string;
|
|
10554
10672
|
getNluEmbeddingCredentials: () => INluEmbeddingCredentials;
|
|
@@ -11186,7 +11304,8 @@ export interface INodeExecutionAPI extends Omit<IActions, "parseCognigyScriptCon
|
|
|
11186
11304
|
getAppSessionPin: () => Promise<string>;
|
|
11187
11305
|
validateDatepickerFunctionInSecureContext?: (codeToValidate: string) => string | null;
|
|
11188
11306
|
completeGoal: (goal: string) => void;
|
|
11189
|
-
knowledgeSearch: (data: IKnowledgeSearchData) => Promise<IKnowledgeSearchReturnValue>;
|
|
11307
|
+
knowledgeSearch: (data: IKnowledgeSearchData, nodeAnalyticsParams?: TNodeAnalyticsParams) => Promise<IKnowledgeSearchReturnValue>;
|
|
11308
|
+
runGenerativeAIPrompt: (options: IRunGenerativeAIPromptOptions, useCase: TGenerativeAIUseCases, nodeAnalyticsParams?: TNodeAnalyticsParams) => Promise<any>;
|
|
11190
11309
|
matchPattern: (patternType: IPatternTypes, phrase: string, locale?: string) => IPatternMatchResult;
|
|
11191
11310
|
getAgentAssistConfigId: () => string;
|
|
11192
11311
|
countGPTTokens: (prompt: string) => number;
|
|
@@ -11199,43 +11318,26 @@ export interface INodeExecutionAPI extends Omit<IActions, "parseCognigyScriptCon
|
|
|
11199
11318
|
title: string;
|
|
11200
11319
|
subComponent?: string;
|
|
11201
11320
|
}) => void;
|
|
11321
|
+
fetchMcpTools: (params: {
|
|
11322
|
+
mcpServerUrl: string;
|
|
11323
|
+
timeout: number;
|
|
11324
|
+
cacheTools: boolean;
|
|
11325
|
+
}) => Promise<any[]>;
|
|
11326
|
+
executeMcpTool: (params: {
|
|
11327
|
+
toolName: string;
|
|
11328
|
+
toolArgs: {
|
|
11329
|
+
[x: string]: unknown;
|
|
11330
|
+
};
|
|
11331
|
+
mcpServerUrl: string;
|
|
11332
|
+
timeout: number;
|
|
11333
|
+
}) => Promise<{
|
|
11334
|
+
[x: string]: unknown;
|
|
11335
|
+
}>;
|
|
11202
11336
|
}
|
|
11203
11337
|
export interface INodeExecutionCognigyObject extends IExecutionObjects {
|
|
11204
11338
|
api: INodeExecutionAPI;
|
|
11205
11339
|
flowReferenceId?: string;
|
|
11206
11340
|
}
|
|
11207
|
-
export interface IChartExecutableNode<C extends INodeFunctionBaseParams = INodeFunctionBaseParams> extends IProjectScope, IOrganisationScope {
|
|
11208
|
-
id: string;
|
|
11209
|
-
_id?: string;
|
|
11210
|
-
type: string;
|
|
11211
|
-
label?: string;
|
|
11212
|
-
extension: string;
|
|
11213
|
-
behavior: {
|
|
11214
|
-
stopping: boolean;
|
|
11215
|
-
};
|
|
11216
|
-
fields: INodeFieldSet;
|
|
11217
|
-
children: string[];
|
|
11218
|
-
next: string | null;
|
|
11219
|
-
config: C["config"];
|
|
11220
|
-
/**
|
|
11221
|
-
* Whether the node contain trustedCode.
|
|
11222
|
-
* Our cognigy nodes have trustedCodes - custom modules do not
|
|
11223
|
-
* have trusted-codes by default. This determines whether the nodes
|
|
11224
|
-
* function is executed in service-ai or service-execution.
|
|
11225
|
-
*/
|
|
11226
|
-
trustedCode: boolean;
|
|
11227
|
-
pathToPackageExecutable: string;
|
|
11228
|
-
/**
|
|
11229
|
-
* Whether the node is a standard
|
|
11230
|
-
* Cognigy node, e.g. a sendText node.
|
|
11231
|
-
*/
|
|
11232
|
-
isCognigy: boolean;
|
|
11233
|
-
/**
|
|
11234
|
-
* Whether the node is disabled
|
|
11235
|
-
*/
|
|
11236
|
-
isDisabled: boolean;
|
|
11237
|
-
analyticsLabel?: string;
|
|
11238
|
-
}
|
|
11239
11341
|
export interface INodeFunctionInputOptions {
|
|
11240
11342
|
handledIntentReconfirmation?: boolean;
|
|
11241
11343
|
nluLanguage?: TNluLanguage;
|
|
@@ -15089,7 +15191,7 @@ export interface IBatchConnectionsRestData_2_0 extends IBatchConnectionsRestData
|
|
|
15089
15191
|
}
|
|
15090
15192
|
export interface IBatchConnectionsRestReturnValue_2_0 {
|
|
15091
15193
|
}
|
|
15092
|
-
export interface ICreateConnectionRestDataBody_2_0 extends IProjectScope
|
|
15194
|
+
export interface ICreateConnectionRestDataBody_2_0 extends Partial<IProjectScope>, Partial<Omit<IConnection_2_0, keyof IEntityMeta>> {
|
|
15093
15195
|
}
|
|
15094
15196
|
export interface ICreateConnectionRestData_2_0 extends ICreateConnectionRestDataBody_2_0 {
|
|
15095
15197
|
}
|
|
@@ -16027,6 +16129,7 @@ export interface IVoiceConfigParams {
|
|
|
16027
16129
|
azureSpeechRecognitionMode: string;
|
|
16028
16130
|
azureEnableAudioLogging: boolean;
|
|
16029
16131
|
azureHintsBoost: number;
|
|
16132
|
+
azureProfanityOption: "masked" | "removed" | "raw";
|
|
16030
16133
|
googleDisablePunctuation: boolean;
|
|
16031
16134
|
googleInteractionType: string;
|
|
16032
16135
|
googleHintsBoost: number;
|
|
@@ -16519,6 +16622,7 @@ export interface IDtmfParams extends INodeFunctionBaseParams {
|
|
|
16519
16622
|
export interface IHangupParams extends INodeFunctionBaseParams {
|
|
16520
16623
|
config: {
|
|
16521
16624
|
hangupReason: string;
|
|
16625
|
+
hangupImmediately: boolean;
|
|
16522
16626
|
};
|
|
16523
16627
|
}
|
|
16524
16628
|
export interface IPlayParamsConfig extends IVoiceConfigParams {
|
|
@@ -17072,6 +17176,9 @@ export interface IGoogleVertexAIMeta_2_0 {
|
|
|
17072
17176
|
apiEndPoint: string;
|
|
17073
17177
|
publisher?: string;
|
|
17074
17178
|
}
|
|
17179
|
+
export interface IMistralMeta_2_0 {
|
|
17180
|
+
customModel?: string;
|
|
17181
|
+
}
|
|
17075
17182
|
/**
|
|
17076
17183
|
* @openapi
|
|
17077
17184
|
*
|
|
@@ -17291,6 +17398,8 @@ export interface ILargeLanguageModel_2_0 extends IGlobalResource {
|
|
|
17291
17398
|
anthropic?: IAnthropicMeta_2_0;
|
|
17292
17399
|
/** Meta data for the AwsBedrock connection */
|
|
17293
17400
|
awsBedrock?: IAwsBedrockMeta_2_0;
|
|
17401
|
+
/** Meta data for the Mistral connection */
|
|
17402
|
+
mistral?: IMistralMeta_2_0;
|
|
17294
17403
|
/** Fallback LLM configuration */
|
|
17295
17404
|
fallbacks?: ILLMFallback_2_0[];
|
|
17296
17405
|
}
|
|
@@ -22349,7 +22458,242 @@ export interface AnalyticsAPIGroup_2_0 {
|
|
|
22349
22458
|
updateAnalyticsRecords: TRestAPIOperation<IUpdateAnalyticsRecordsRestData_2_0, IUpdateAnalyticsRecordsRestReturnValue_2_0>;
|
|
22350
22459
|
}
|
|
22351
22460
|
declare function AnalyticsAPIGroup_2_0(instance: Base): AnalyticsAPIGroup_2_0;
|
|
22352
|
-
export declare type
|
|
22461
|
+
export declare type PrometheusResponsePayload = {
|
|
22462
|
+
status: "success" | "error";
|
|
22463
|
+
/** Actual response data */
|
|
22464
|
+
data: unknown;
|
|
22465
|
+
/** Only set if the status is "error". */
|
|
22466
|
+
errorType?: string;
|
|
22467
|
+
/** Only set if the status is "error" */
|
|
22468
|
+
error?: string;
|
|
22469
|
+
/** Only set if there were warnings while executing the request */
|
|
22470
|
+
warnings?: string[];
|
|
22471
|
+
/** Only set if there were info-level annotations while executing the request */
|
|
22472
|
+
infos?: string[];
|
|
22473
|
+
};
|
|
22474
|
+
export interface IGetOpsCenterMetrics extends PrometheusResponsePayload {
|
|
22475
|
+
}
|
|
22476
|
+
export interface IGetOpsCenterMetricsRestDataQuery_2_0 {
|
|
22477
|
+
identifier: string;
|
|
22478
|
+
time: string;
|
|
22479
|
+
projectIds?: string[];
|
|
22480
|
+
}
|
|
22481
|
+
export interface IGetOpsCenterMetricsRestData_2_0 extends IGetOpsCenterMetricsRestDataQuery_2_0 {
|
|
22482
|
+
}
|
|
22483
|
+
export interface IGetOpsCenterMetricsRestReturnValue_2_0 extends IGetOpsCenterMetrics {
|
|
22484
|
+
}
|
|
22485
|
+
declare const chartTypes: readonly [
|
|
22486
|
+
"bar-chart",
|
|
22487
|
+
"heat-map",
|
|
22488
|
+
"line-chart",
|
|
22489
|
+
"alerts-errors",
|
|
22490
|
+
"health-status-monitor"
|
|
22491
|
+
];
|
|
22492
|
+
declare const segmentConfigArray: readonly [
|
|
22493
|
+
"voice-gateway",
|
|
22494
|
+
"endpoints",
|
|
22495
|
+
"flows",
|
|
22496
|
+
"overview",
|
|
22497
|
+
"handover-provider"
|
|
22498
|
+
];
|
|
22499
|
+
declare const availableColorsArray: readonly [
|
|
22500
|
+
"default",
|
|
22501
|
+
"blue",
|
|
22502
|
+
"yellow",
|
|
22503
|
+
"green",
|
|
22504
|
+
"purple",
|
|
22505
|
+
"red"
|
|
22506
|
+
];
|
|
22507
|
+
export declare type Segment = (typeof segmentConfigArray)[number];
|
|
22508
|
+
export declare type ChartType = (typeof chartTypes)[number];
|
|
22509
|
+
export declare type AvailableColors = (typeof availableColorsArray)[number];
|
|
22510
|
+
export declare type GridSize = "auto" | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;
|
|
22511
|
+
export interface ChartConfig {
|
|
22512
|
+
color?: string;
|
|
22513
|
+
height: number;
|
|
22514
|
+
}
|
|
22515
|
+
export interface ChartMeta {
|
|
22516
|
+
xs: GridSize;
|
|
22517
|
+
sm: GridSize;
|
|
22518
|
+
md: GridSize;
|
|
22519
|
+
lg: GridSize;
|
|
22520
|
+
xl: GridSize;
|
|
22521
|
+
}
|
|
22522
|
+
export interface ChartQueryConfig {
|
|
22523
|
+
metric: string;
|
|
22524
|
+
isPositiveTrend: boolean;
|
|
22525
|
+
identifier?: string;
|
|
22526
|
+
queryTemplate: string;
|
|
22527
|
+
}
|
|
22528
|
+
export interface ChartSegmentConfig {
|
|
22529
|
+
type: ChartType;
|
|
22530
|
+
title?: string;
|
|
22531
|
+
description?: string;
|
|
22532
|
+
queryConfig?: ChartQueryConfig;
|
|
22533
|
+
showCounts?: boolean;
|
|
22534
|
+
chartConfig?: ChartConfig;
|
|
22535
|
+
meta?: ChartMeta;
|
|
22536
|
+
}
|
|
22537
|
+
export declare type TColorConfig = {
|
|
22538
|
+
[key in AvailableColors]: string[];
|
|
22539
|
+
};
|
|
22540
|
+
export interface IGetOpsCenterMetricsConfig {
|
|
22541
|
+
meta: Record<string, never>;
|
|
22542
|
+
config: {
|
|
22543
|
+
[key in Segment]: ChartSegmentConfig[];
|
|
22544
|
+
};
|
|
22545
|
+
colorConfig: TColorConfig;
|
|
22546
|
+
}
|
|
22547
|
+
export interface IGetOpsCenterMetricsConfigRestReturnValue_2_0 extends IGetOpsCenterMetricsConfig {
|
|
22548
|
+
}
|
|
22549
|
+
export interface IGetOpsCenterMetricsRangeRestDataQuery_2_0 {
|
|
22550
|
+
identifier: string;
|
|
22551
|
+
projectIds?: string[];
|
|
22552
|
+
start: string;
|
|
22553
|
+
end: string;
|
|
22554
|
+
step: string;
|
|
22555
|
+
}
|
|
22556
|
+
export interface IGetOpsCenterMetricsRangeRestData_2_0 extends IGetOpsCenterMetricsRangeRestDataQuery_2_0 {
|
|
22557
|
+
}
|
|
22558
|
+
export interface IGetOpsCenterMetricsRangeRestReturnValue_2_0 extends IGetOpsCenterMetrics {
|
|
22559
|
+
}
|
|
22560
|
+
export interface IDeleteOpsCenterErrorRestDataParams_2_0 {
|
|
22561
|
+
errorId: string;
|
|
22562
|
+
}
|
|
22563
|
+
export interface IDeleteOpsCenterErrorRestData_2_0 extends IDeleteOpsCenterErrorRestDataParams_2_0 {
|
|
22564
|
+
}
|
|
22565
|
+
export interface IDeleteOpsCenterErrorRestReturnValue_2_0 {
|
|
22566
|
+
}
|
|
22567
|
+
declare const arrayOfTMainComponent: readonly [
|
|
22568
|
+
"VoiceGateway",
|
|
22569
|
+
"Endpoint",
|
|
22570
|
+
"Flow",
|
|
22571
|
+
"HandoverProvider"
|
|
22572
|
+
];
|
|
22573
|
+
/**
|
|
22574
|
+
* Errors and Alerts always belong to one of the main components.
|
|
22575
|
+
*/
|
|
22576
|
+
export declare type MainComponent = (typeof arrayOfTMainComponent)[number];
|
|
22577
|
+
declare const arrayOfTSubComponent: readonly [
|
|
22578
|
+
"SpeechToText",
|
|
22579
|
+
"TextToSpeech",
|
|
22580
|
+
"InputTransformer",
|
|
22581
|
+
"OutputTransformer",
|
|
22582
|
+
"ExecutionFinishedTransformer",
|
|
22583
|
+
"InjectTransformer",
|
|
22584
|
+
"NotifyTransformer",
|
|
22585
|
+
"RealtimeTranslation",
|
|
22586
|
+
"MessageRoundtrip",
|
|
22587
|
+
"FlowNodeExecution",
|
|
22588
|
+
"NaturalLanguageUnderstanding",
|
|
22589
|
+
"OutboundHTTPCalls",
|
|
22590
|
+
"LargeLanguageModelCalls",
|
|
22591
|
+
"KnowledgeAIQueries",
|
|
22592
|
+
"OutboundHTTPCalls"
|
|
22593
|
+
];
|
|
22594
|
+
/**
|
|
22595
|
+
* Each subcomponent belongs to a main component
|
|
22596
|
+
*/
|
|
22597
|
+
export declare type SubComponent = (typeof arrayOfTSubComponent)[number];
|
|
22598
|
+
export interface IOpsCenterError {
|
|
22599
|
+
id: string;
|
|
22600
|
+
organisationId: string;
|
|
22601
|
+
projectId?: string;
|
|
22602
|
+
title: string;
|
|
22603
|
+
firstOccurredAt: Date;
|
|
22604
|
+
lastOccurredAt: Date;
|
|
22605
|
+
component?: MainComponent;
|
|
22606
|
+
subComponent?: SubComponent;
|
|
22607
|
+
count: number;
|
|
22608
|
+
}
|
|
22609
|
+
export interface IGetOpsCenterError extends Partial<IOpsCenterError> {
|
|
22610
|
+
}
|
|
22611
|
+
export interface IGetOpsCenterErrorRestDataParams_2_0 {
|
|
22612
|
+
errorId: string;
|
|
22613
|
+
}
|
|
22614
|
+
export interface IGetOpsCenterErrorRestData_2_0 extends IGetOpsCenterErrorRestDataParams_2_0 {
|
|
22615
|
+
}
|
|
22616
|
+
export interface IGetOpsCenterErrorRestReturnValue_2_0 extends IGetOpsCenterError {
|
|
22617
|
+
}
|
|
22618
|
+
export interface IIndexOpsCenterErrorsRestDataQuery_2_0 {
|
|
22619
|
+
projectIds?: string[];
|
|
22620
|
+
component?: MainComponent;
|
|
22621
|
+
subComponent?: SubComponent;
|
|
22622
|
+
offset?: number;
|
|
22623
|
+
limit?: number;
|
|
22624
|
+
totalCountOnly?: string;
|
|
22625
|
+
sort?: string;
|
|
22626
|
+
}
|
|
22627
|
+
export interface IIndexOpsCenterErrorsRestData_2_0 extends IIndexOpsCenterErrorsRestDataQuery_2_0 {
|
|
22628
|
+
}
|
|
22629
|
+
export interface IIndexOpsCenterErrorsRestReturnValue_2_0 {
|
|
22630
|
+
total?: number;
|
|
22631
|
+
totalErrorCount?: number;
|
|
22632
|
+
items?: IGetOpsCenterError[];
|
|
22633
|
+
}
|
|
22634
|
+
declare const notificationChannels: readonly [
|
|
22635
|
+
"email"
|
|
22636
|
+
];
|
|
22637
|
+
export declare type NotificationChannel = (typeof notificationChannels)[number];
|
|
22638
|
+
export interface NotificationConfig {
|
|
22639
|
+
channel: NotificationChannel;
|
|
22640
|
+
/** List of email addresses to send notifications to. */
|
|
22641
|
+
addresses: string[];
|
|
22642
|
+
}
|
|
22643
|
+
export interface AlertingConfig {
|
|
22644
|
+
configuredAlerts: {
|
|
22645
|
+
[K in string]: boolean;
|
|
22646
|
+
};
|
|
22647
|
+
}
|
|
22648
|
+
export interface IOpsCenterObservationConfig {
|
|
22649
|
+
organisationId: string;
|
|
22650
|
+
observationActive: boolean;
|
|
22651
|
+
notificationConfig: NotificationConfig;
|
|
22652
|
+
alertingConfig: AlertingConfig;
|
|
22653
|
+
}
|
|
22654
|
+
export interface IGetOpsCenterObservationConfigRestReturnValue_2_0 extends IOpsCenterObservationConfig {
|
|
22655
|
+
}
|
|
22656
|
+
export interface IPatchOpsCenterObservationConfigRestDataBody_2_0 extends Partial<Omit<IOpsCenterObservationConfig, "organisationId">> {
|
|
22657
|
+
}
|
|
22658
|
+
export interface IPatchOpsCenterObservationConfigRestData_2_0 extends IPatchOpsCenterObservationConfigRestDataBody_2_0 {
|
|
22659
|
+
}
|
|
22660
|
+
export interface IPatchOpsCenterObservationConfigRestReturnValue_2_0 extends IOpsCenterObservationConfig {
|
|
22661
|
+
}
|
|
22662
|
+
export interface ISetupOpsCenterObservationConfigRestReturnValue_2_0 extends IOpsCenterObservationConfig {
|
|
22663
|
+
}
|
|
22664
|
+
export interface IOpsCenterAlert {
|
|
22665
|
+
type: string;
|
|
22666
|
+
name: string;
|
|
22667
|
+
description: string;
|
|
22668
|
+
component: MainComponent;
|
|
22669
|
+
subComponent: SubComponent;
|
|
22670
|
+
state: string;
|
|
22671
|
+
activeAt: string;
|
|
22672
|
+
}
|
|
22673
|
+
export interface IIndexOpsCenterAlertsRestDataQuery_2_0 {
|
|
22674
|
+
component?: MainComponent;
|
|
22675
|
+
subComponent?: SubComponent;
|
|
22676
|
+
}
|
|
22677
|
+
export interface IIndexOpsCenterAlertsRestData_2_0 extends IIndexOpsCenterAlertsRestDataQuery_2_0 {
|
|
22678
|
+
}
|
|
22679
|
+
export interface IIndexOpsCenterAlertsRestReturnValue_2_0 {
|
|
22680
|
+
items: IOpsCenterAlert[];
|
|
22681
|
+
total: number;
|
|
22682
|
+
}
|
|
22683
|
+
export interface AIOpsCenterAPIGroup_2_0 {
|
|
22684
|
+
indexOpsCenterErrors: TRestAPIOperation<IIndexOpsCenterErrorsRestData_2_0, IIndexOpsCenterErrorsRestReturnValue_2_0>;
|
|
22685
|
+
getOpsCenterErrorById: TRestAPIOperation<IGetOpsCenterErrorRestData_2_0, IGetOpsCenterErrorRestReturnValue_2_0>;
|
|
22686
|
+
deleteOpsCenterErrorById: TRestAPIOperation<IDeleteOpsCenterErrorRestData_2_0, IDeleteOpsCenterErrorRestReturnValue_2_0>;
|
|
22687
|
+
getOpsCenterMetrics: TRestAPIOperation<IGetOpsCenterMetricsRestData_2_0, IGetOpsCenterMetricsRestReturnValue_2_0>;
|
|
22688
|
+
getOpsCenterMetricsConfig: TRestAPIOperation<void, IGetOpsCenterMetricsConfigRestReturnValue_2_0>;
|
|
22689
|
+
getOpsCenterMetricsRange: TRestAPIOperation<IGetOpsCenterMetricsRangeRestData_2_0, IGetOpsCenterMetricsRangeRestReturnValue_2_0>;
|
|
22690
|
+
getOpsCenterObservationConfig: TRestAPIOperation<void, IGetOpsCenterObservationConfigRestReturnValue_2_0>;
|
|
22691
|
+
setupOpsCenterObservationConfig: TRestAPIOperation<void, ISetupOpsCenterObservationConfigRestReturnValue_2_0>;
|
|
22692
|
+
patchOpsCenterObservationConfig: TRestAPIOperation<IPatchOpsCenterObservationConfigRestData_2_0, IPatchOpsCenterObservationConfigRestReturnValue_2_0>;
|
|
22693
|
+
indexOpsCenterAlerts: TRestAPIOperation<IIndexOpsCenterAlertsRestData_2_0, IIndexOpsCenterAlertsRestReturnValue_2_0>;
|
|
22694
|
+
}
|
|
22695
|
+
declare function AIOpsCenterAPIGroup_2_0(instance: Base): AIOpsCenterAPIGroup_2_0;
|
|
22696
|
+
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>;
|
|
22353
22697
|
export declare type TResourceAPIVersionType<T> = T extends {
|
|
22354
22698
|
versions: {
|
|
22355
22699
|
resources: "2.0";
|
|
@@ -22395,6 +22739,11 @@ export declare type TAnalyticsAPIVersionType<T> = T extends {
|
|
|
22395
22739
|
analytics: "2.0";
|
|
22396
22740
|
};
|
|
22397
22741
|
} ? AnalyticsAPIGroup_2_0 : AnalyticsAPIGroup_2_0;
|
|
22742
|
+
export declare type TAIOpsCenterAPIVersionType<T> = T extends {
|
|
22743
|
+
versions: {
|
|
22744
|
+
aiops: "1.0";
|
|
22745
|
+
};
|
|
22746
|
+
} ? AIOpsCenterAPIGroup_2_0 : AIOpsCenterAPIGroup_2_0;
|
|
22398
22747
|
export declare type TRestAPIClient<T extends IRestAPIClientConfig = IRestAPIClientConfig> = TRestAPIGroupsTypeByConfiguration<T> & AuthenticationAPI & IRestAPIClientProperties<T> & IHttpAdapterAPI;
|
|
22399
22748
|
export interface IRestAPIClientConstructor {
|
|
22400
22749
|
new <T extends IRestAPIClientConfig>(config?: T): TRestAPIClient<T>;
|