Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions md-docs/api/python/enums.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,10 @@ DetectionEventActionType()

- DISCORD_NOTIFICATION
- SLACK_NOTIFICATION
- EMAIL_NOTIFICATION
- TEAMS_NOTIFICATION
- MQTT_NOTIFICATION
- RETRAIN

----

Expand Down Expand Up @@ -283,6 +287,7 @@ MonitoringTarget()
- PREDICTION
- USER_INPUT
- USER_INPUT_RETRIEVED_CONTEXT
- RETRIEVED_CONTEXT
- USER_INPUT_MODEL_OUTPUT
- MODEL_OUTPUT_RETRIEVED_CONTEXT

Expand Down
21 changes: 21 additions & 0 deletions md-docs/api/python/models.md
Original file line number Diff line number Diff line change
Expand Up @@ -610,6 +610,27 @@ of a monitoring quantity (target or metric)
----


## MqttNotificationAction
```python
MqttNotificationAction()
```


---
Base Model for Mqtt Notification Action


**Attributes**

* **type** : DetectionEventActionType.MQTT_NOTIFICATION
* **connection_string** : str
* **topic** : str
* **payload** : str


----


## MulticlassClassificationTaskCostInfo
```python
MulticlassClassificationTaskCostInfo()
Expand Down
3 changes: 2 additions & 1 deletion md-docs/user_guide/detection_event_rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,11 @@ Two types of actions are currently supported: notification and retrain.
- `DiscordNotificationAction`: sends a notification to a Discord channel via webhook.
- `EmailNotificationAction`: sends an email to the provided email address.
- `TeamsNotificationAction`: sends a notification to Microsoft Teams via webhook.
- `MqttNotificationAction`: sends a notification to an MQTT broker.

### Retrain Actions

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

Expand Down