Skip to content

Commit 9f3f666

Browse files
Add docs for Mqtt notification
1 parent 88f57da commit 9f3f666

File tree

3 files changed

+28
-1
lines changed

3 files changed

+28
-1
lines changed

md-docs/api/python/enums.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,10 @@ DetectionEventActionType()
100100

101101
- DISCORD_NOTIFICATION
102102
- SLACK_NOTIFICATION
103+
- EMAIL_NOTIFICATION
104+
- TEAMS_NOTIFICATION
105+
- MQTT_NOTIFICATION
106+
- RETRAIN
103107

104108
----
105109

@@ -283,6 +287,7 @@ MonitoringTarget()
283287
- PREDICTION
284288
- USER_INPUT
285289
- USER_INPUT_RETRIEVED_CONTEXT
290+
- RETRIEVED_CONTEXT
286291
- USER_INPUT_MODEL_OUTPUT
287292
- MODEL_OUTPUT_RETRIEVED_CONTEXT
288293

md-docs/api/python/models.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -610,6 +610,27 @@ of a monitoring quantity (target or metric)
610610
----
611611

612612

613+
## MqttNotificationAction
614+
```python
615+
MqttNotificationAction()
616+
```
617+
618+
619+
---
620+
Base Model for Mqtt Notification Action
621+
622+
623+
**Attributes**
624+
625+
* **type** : DetectionEventActionType.MQTT_NOTIFICATION
626+
* **connection_string** : str
627+
* **topic** : str
628+
* **payload** : str
629+
630+
631+
----
632+
633+
613634
## MulticlassClassificationTaskCostInfo
614635
```python
615636
MulticlassClassificationTaskCostInfo()

md-docs/user_guide/detection_event_rules.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,11 @@ Two types of actions are currently supported: notification and retrain.
2222
- `DiscordNotificationAction`: sends a notification to a Discord channel via webhook.
2323
- `EmailNotificationAction`: sends an email to the provided email address.
2424
- `TeamsNotificationAction`: sends a notification to Microsoft Teams via webhook.
25+
- `MqttNotificationAction`: sends a notification to an MQTT broker.
2526

2627
### Retrain Actions
2728

28-
Retrain actions let you to retrain your model, therefore, they are only available when the rule monitoring target is a model.
29+
Retrain actions let you retrain your model, therefore, they are only available when the rule monitoring target is a model.
2930
The retrain action does not need any parameter because it is automatically inferred from the `model_name` attribute of the rule.
3031
Of course, it is mandatory that the model has a retrain trigger associated in order to add a retrain action to the rule.
3132

0 commit comments

Comments
 (0)