Skip to content

Commit d0c1550

Browse files
GiovanniGiacomettiGiovanniGiacometti
committed
Specification meaning clearer
1 parent 3255d0e commit d0c1550

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed

‎md-docs/user_guide/monitoring/detection_event.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,16 @@ An event is characterized by the following attributes:
99
| Eventy Type | The type of the event. It's possible values are: <div class="nice-list"><ul><li> `Warning On`: the monitoring entity is experiencing slight changes that might lead to a drift.</li><li> `Warning Off`: the monitoring entity has returned to the reference distribution. </li><li> `Drift On`: the monitoring entity has drifted from the reference distribution.</li><li> `Drift Off`: the monitoring entity has returned to the reference distribution.</li> </ul></div> |
1010
| Severity | The severity of the event. It's provided only for drift events and it can be `Low`, `Medium`, or `High`. |
1111
| Monitoring Target | The [Monitoring Target](index.md#monitoring-metrics) being monitored. |
12-
| Monitoring Metric | The [Monitoring Metric](index.md#monitoring-metrics) being monitored. |
12+
| Monitoring Metric | The [Monitoring Metric](index.md#monitoring-metrics) being monitored.
13+
| Specification | The specification of the Monitoring Metric being monitored, if existing. | |
1314
| Model Name | The name of the model that raised the event. It's present only if the event is related to a model. |
1415
| Model Version | The version of the model that raised the event. It's present only if the event is related to a model. |
1516
| Insert datetime | The time when the event was raised. |
1617
| Sample timestamp | The timestamp of the sample that triggered the event. |
1718
| Sample customer ID | The ID of the sample that triggered the event. |
1819
| User feedback | The feedback provided by the user on whether the event was expected or not. |
1920
| Segment ID | The ID of the Segment being monitored. |
20-
| Specification | The specification of the Segment being monitored. It's present only if the Monitoring Metric supports it. |
21+
2122

2223

2324
## Retrieve Detection Events

‎md-docs/user_guide/monitoring/detection_event_rules.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,11 @@ Rules are specific to a task and are characterized by the following attributes:
1414
| Severity | The severity of the event that triggers the rule. It is only applicable to drift events. If not specified, the rule will be triggered by drift events of any severity. |
1515
| Monitoring Target | The [Monitoring Target](index.md#monitoring-targets) whose event should trigger the rule. |
1616
| Monitoring Metric | The [Monitoring Metric](index.md#monitoring-metrics) whose event should trigger the rule. |
17+
| Specification | The specification of the Monitoring Metric being monitored, if existing.
1718
| 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 (such as `ERROR` or `PREDICTION`). |
1819
| Actions | A list of actions to be executed sequentially when the rule is triggered. |
1920
| Segment ID | It refers to the ID of the Segment where the rule is set. |
20-
| Specification | The specification of the Segment being monitored. It's present only if the Monitoring Metric supports it. |
21+
|
2122

2223
## Detection Event Actions
2324
Three types of actions are currently supported: notification, plot configuration and retrain.

0 commit comments

Comments
 (0)