administrator/frigate
1
0
Fork 0
mirror of https://github.com/blakeblackshear/frigate.git synced 2026-03-10 10:33:11 +03:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

docs: Add detail to face recognition MQTT update docs (#21942)

Browse Source 
* Add detail to face recognition MQTT update docs

Clarify that the weighted average favors larger faces and
higher-confidence detections, that unknown attempts are excluded,
and document when name/score will be null/0.0.

* Fix score decimal in MQTT face recognition documentation

`0.0` in JSON is just `0`.

* Clarify score is a running weighted average

* Simplify MQTT tracked_object_update docs with inline comments

Move scoring logic details to face recognition docs and keep
MQTT reference concise with inline field comments and links.

* fix (expand) lpr doc link

* rm obvious lpr comments

---------

Co-authored-by: Kai Curry <kai@wjerk.com>
This commit is contained in:
Kai Curry 2026-02-23 12:46:55 -01:00 committed by GitHub
parent a7d8d13d9a
commit a6e11a59d6
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/docs/integrations/mqtt.md
View File

@ -120,7 +120,7 @@ Message published for each changed tracked object. The first message is publishe
### `frigate/tracked_object_update` ### `frigate/tracked_object_update`
Message published for updates to tracked object metadata, for example: Message published for updates to tracked object metadata. All messages include an `id` field which is the tracked object's event ID, and can be used to look up the event via the API or match it to items in the UI.
#### Generative AI Description Update #### Generative AI Description Update
@ -134,12 +134,14 @@ Message published for updates to tracked object metadata, for example:
#### Face Recognition Update #### Face Recognition Update
Published after each recognition attempt, regardless of whether the score meets `recognition_threshold`. See the [Face Recognition](/configuration/face_recognition) documentation for details on how scoring works.
```json ```json
{ {
"type": "face", "type": "face",
"id": "1607123955.475377-mxklsc", "id": "1607123955.475377-mxklsc",
"name": "John", "name": "John", // best matching person, or null if no match
"score": 0.95, "score": 0.95, // running weighted average across all recognition attempts
"camera": "front_door_cam", "camera": "front_door_cam",
"timestamp": 1607123958.748393 "timestamp": 1607123958.748393
} }
@ -147,11 +149,13 @@ Message published for updates to tracked object metadata, for example:
#### License Plate Recognition Update #### License Plate Recognition Update
Published when a license plate is recognized on a car object. See the [License Plate Recognition](/configuration/license_plate_recognition) documentation for details.
```json ```json
{ {
"type": "lpr", "type": "lpr",
"id": "1607123955.475377-mxklsc", "id": "1607123955.475377-mxklsc",
"name": "John's Car", "name": "John's Car", // known name for the plate, or null
"plate": "123ABC", "plate": "123ABC",
"score": 0.95, "score": 0.95,
"camera": "driveway_cam", "camera": "driveway_cam",