@@ -5,16 +5,16 @@ This section outlines how to configure automation to receive notifications or st
55When a detection event is produced, the ML cube Platform reviews all the detection event rules you have set
66and triggers those matching the event.
77
8- Rules are specific to a task and require the following parameters :
8+ Rules are specific to a task and are characterized by the following attributes :
99
10- - ` name ` : a descriptive label of the rule.
11- - ` task_id ` : the unique identifier of the task to which the rule belongs .
12- - ` detection_event_type ` : the [ DetectionEventType ] that the rule matches .
13- - ` severity ` : the [ DetectionEventSeverity ] of the event.
14- - ` monitoring_target ` : the monitoring target whose event should trigger the rule.
15- - ` model_name ` : the name of the model to which the rule applies. This is only required when the monitoring target is related to a model
10+ - ` Name ` : a descriptive label of the rule.
11+ - ` Detection Event Type ` : the type of event that triggers the rule.
12+ - ` Severity ` : the severity of the event that triggers the rule. If not specified, the rule will be triggered by events of any severity .
13+ - ` Monitoring Target ` : the monitoring target whose event should trigger the rule.
14+ - ` Monitoring Metric ` : the monitoring metric whose event should trigger the rule.
15+ - ` Model name ` : the name of the model to which the rule applies. This is only required when the monitoring target is related to a model
1616 (such as ` ERROR ` or ` PREDICTION ` ).
17- - ` actions ` : A sequential list of actions to be executed when the rule is triggered.
17+ - ` Actions ` : A list of actions to be executed sequentially when the rule is triggered.
1818
1919## Detection Event Actions
2020Three types of actions are currently supported: notification, plot configuration and retrain.
@@ -23,11 +23,11 @@ Three types of actions are currently supported: notification, plot configuration
2323
2424These actions send notifications to external services when a detection event is triggered. The following notification actions are available:
2525
26- - ` SlackNotificationAction ` : sends a notification to a Slack channel via webhook.
27- - ` DiscordNotificationAction ` : sends a notification to a Discord channel via webhook.
28- - ` EmailNotificationAction ` : sends an email to the provided email address.
29- - ` TeamsNotificationAction ` : sends a notification to Microsoft Teams via webhook.
30- - ` MqttNotificationAction ` : sends a notification to an MQTT broker.
26+ - ` Slack Notification ` : sends a notification to a Slack channel via webhook.
27+ - ` Discord Notification ` : sends a notification to a Discord channel via webhook.
28+ - ` Email Notification ` : sends an email to the provided email address.
29+ - ` Teams Notification ` : sends a notification to Microsoft Teams via webhook.
30+ - ` Mqtt Notification ` : sends a notification to an MQTT broker.
3131
3232### Plot Configuration
3333
@@ -37,7 +37,7 @@ data preceding the event, while the second one includes data following the event
3737### Retrain Action
3838
3939Retrain action lets you retrain your model. Therefore, it is only available when the monitoring target of the rule is related to a model.
40- The retrain action does not need any parameter because it is automatically inferred from the ` model_name ` attribute of the rule.
40+ The retrain action does not need any parameter because it is automatically inferred from the ` Model Name ` attribute of the rule.
4141Of course, the model must already have a retrain trigger associated before setting up this action.
4242
4343!!! example
@@ -63,7 +63,4 @@ Of course, the model must already have a retrain trigger associated before setti
6363 )
6464 ```
6565
66- [ add_historical_data ] : ../../api/python/client.md#add_historical_data
67- [ Detection Event ] : detection_event.md
68- [ DetectionEventType ] : ../../api/python/enums.md#detectioneventtype
69- [ DetectionEventSeverity ] : ../../api/python/enums.md#detectioneventseverity
66+ [ Detection Event ] : detection_event.md
0 commit comments