From 011a2dbfaf7c401ded7f325ecf267695cf4cbd39 Mon Sep 17 00:00:00 2001 From: Josh Hawkins <32435876+hawkeye217@users.noreply.github.com> Date: Sun, 23 Feb 2025 07:28:03 -0600 Subject: [PATCH] Docs: Clarify review labels and objects to track (#16758) --- docs/docs/configuration/review.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/docs/docs/configuration/review.md b/docs/docs/configuration/review.md index e321fcb8a..752c496a3 100644 --- a/docs/docs/configuration/review.md +++ b/docs/docs/configuration/review.md @@ -21,6 +21,21 @@ In 0.14 and later, all of that is bundled into a single review item which starts Not every segment of video captured by Frigate may be of the same level of interest to you. Video of people who enter your property may be a different priority than those walking by on the sidewalk. For this reason, Frigate 0.14 categorizes review items as _alerts_ and _detections_. By default, all person and car objects are considered alerts. You can refine categorization of your review items by configuring required zones for them. +:::note + +Alerts and detections categorize the tracked objects in review items, but Frigate must first detect those objects with your configured object detector (Coral, OpenVINO, etc). By default, the object tracker only detects `person`. Setting `labels` for `alerts` and `detections` does not automatically enable detection of new objects. To detect more than `person`, you should add the following to your config: + +```yaml +objects: + track: + - person + - car + - ... +``` + +See the [objects documentation](objects.md) for the list of objects that Frigate's default model tracks. +::: + ## Restricting alerts to specific labels By default a review item will only be marked as an alert if a person or car is detected. This can be configured to include any object or audio label using the following config: