From 4c0addeb083ee5705abe70133476d17224b4448e Mon Sep 17 00:00:00 2001 From: Blake Blackshear Date: Sun, 23 Apr 2023 15:05:23 -0500 Subject: [PATCH] update docs --- docs/docs/configuration/advanced.md | 1 - docs/docs/integrations/api.md | 18 +++++++++++++----- 2 files changed, 13 insertions(+), 6 deletions(-) diff --git a/docs/docs/configuration/advanced.md b/docs/docs/configuration/advanced.md index 818c4b9cd..40efd67e5 100644 --- a/docs/docs/configuration/advanced.md +++ b/docs/docs/configuration/advanced.md @@ -24,7 +24,6 @@ Examples of available modules are: - `frigate.app` - `frigate.mqtt` - `frigate.object_detection` -- `frigate.zeroconf` - `detector.` - `watchdog.` - `ffmpeg..` NOTE: All FFmpeg logs are sent as `error` level. diff --git a/docs/docs/integrations/api.md b/docs/docs/integrations/api.md index 2b89288db..cc5a6576a 100644 --- a/docs/docs/integrations/api.md +++ b/docs/docs/integrations/api.md @@ -172,11 +172,11 @@ Events from the database. Accepts the following query string parameters: Timeline of key moments of an event(s) from the database. Accepts the following query string parameters: -| param | Type | Description | -| -------------------- | ---- | --------------------------------------------- | -| `camera` | int | Name of camera | -| `source_id` | str | ID of tracked object | -| `limit` | int | Limit the number of events returned | +| param | Type | Description | +| ----------- | ---- | ----------------------------------- | +| `camera` | str | Name of camera | +| `source_id` | str | ID of tracked object | +| `limit` | int | Limit the number of events returned | ### `GET /api/events/summary` @@ -198,6 +198,14 @@ Sets retain to true for the event id. Submits the snapshot of the event to Frigate+ for labeling. +| param | Type | Description | +| -------------------- | ---- | ---------------------------------- | +| `include_annotation` | int | Submit annotation to Frigate+ too. | + +### `PUT /api/events//false_positive` + +Submits the snapshot of the event to Frigate+ for labeling and adds the detection as a false positive. + ### `DELETE /api/events//retain` Sets retain to false for the event id (event may be deleted quickly after removing).