administrator/frigate
1
0
Fork 0
mirror of https://github.com/blakeblackshear/frigate.git synced 2026-04-27 17:17:40 +03:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

docs

Browse Source
This commit is contained in:
Josh Hawkins 2025-07-07 08:52:11 -05:00
parent 4ddb5f694b
commit 938c7fbdf6
2 changed files with 18 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/docs/configuration/reference.md
View File

@ -840,6 +840,23 @@ cameras:
# By default the cameras are sorted alphabetically.
order: 0
# Optional: Configuration for triggers to automate actions based on semantic search results.
triggers:
# Required: Unique identifier for the trigger (generated automatically from nickname if not specified).
trigger_name:
# Required: Enable or disable the trigger. (default: shown below)
enabled: true
# Type of trigger, either `thumbnail` for image-based matching or `description` for text-based matching. (default: none)
type: thumbnail
# Reference data for matching, either an event ID for `thumbnail` or a text string for `description`. (default: none)
data: 1751565549.853251-b69j73
# Similarity threshold for triggering. (default: none)
threshold: 0.7
# List of actions to perform when the trigger fires. (default: none)
# Available options: `notification` (send a webpush notification)
actions:
- notification
# Optional: Configuration for AI generated tracked object descriptions
genai:
# Optional: Enable AI description generation (default: shown below)

35
docs/docs/configuration/semantic_search.md
View File

@ -105,45 +105,12 @@ See the [Hardware Accelerated Enrichments](/configuration/hardware_acceleration_
## Triggers
Triggers in Frigate enable automated actions based on semantic search results for tracked objects. By defining triggers, you can configure Frigate to execute specific actions when a tracked object's image or description matches a predefined image or text, based on a similarity threshold. Triggers are managed per camera and can be configured via the Frigate UI in the Settings page under the Triggers tab.
Triggers utilize semantic search to automate actions when a tracked object matches a specified image or description. Triggers can be configured so that Frigate executes a specific actions when a tracked object's image or description matches a predefined image or text, based on a similarity threshold. Triggers are managed per camera and can be configured via the Frigate UI in the Settings page under the Triggers tab.
### Configuration
Triggers are defined within the `semantic_search` configuration for each camera in your Frigate configuration file or through the UI. Each trigger consists of a `type` (either `thumbnail` or `description`), a `data` field (the reference image event ID or text), a `threshold` for similarity matching, and a list of `actions` to perform when the trigger fires.
#### Example Configuration
You can configure triggers directly in your config file, but this is more easily managed through the Frigate UI.
```yaml
cameras:
front_door:
semantic_search:
triggers:
red_car:
enabled: true
type: thumbnail
data: 1751565549.853251-b69j73
threshold: 0.7
actions:
- notification
person_at_front_door:
enabled: true
type: description
data: "Person in a red shirt standing at the front door"
threshold: 0.8
actions:
- notification
```
Fields:
- **enabled**: Boolean to enable or disable the trigger.
- **type**: Either `thumbnail` (matches based on an image embedding) or `description` (matches based on a text embedding).
- **data**: The reference data for matching, either an event ID for a thumbnail or a text string for a description.
- **threshold**: A value between 0 and 1 indicating the minimum similarity score required to fire the trigger (e.g., 0.7 for 70% similarity).
- **actions**: A list of actions to perform when the trigger fires. Valid actions are `notification` ([native notifications](/configuration/notifications.md) must be enabled). Frigate will always post an update to the `frigate/triggers` topic.
#### Managing Triggers in the UI
1. Navigate to the **Settings** page and select the **Triggers** tab.