Updated Documentation for the Review endpoints #14401
Draft
+448
−167
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for frigate-docs canceled.
|
NickM-27
requested changes
Oct 17, 2024
frigate/api/defs/severity_enum.py
Outdated
There was a problem hiding this comment.
this already exists, we should not be recereating it
frigate/frigate/review/maintainer.py
Line 42 in edaccd8
There was a problem hiding this comment.
But that enum does not containsignificant_motion. Is it okay to add it to the enum you've linked?
class SeverityEnum(str, Enum):
alert = "alert"
detection = "detection"
significant_motion = "significant_motion"There was a problem hiding this comment.
significant_motion does not exist currently so there is no reason for it to be added
| @@ -558,38 +556,48 @@ def audio_activity(params: ReviewActivityMotionQueryParams = Depends()): | |||
|
|
|||
| # change types for output | |||
| df.index = df.index.astype(int) // (10**9) | |||
| normalized = df.reset_index().to_dict("records") | |||
| normalized = json.loads(df.reset_index().to_json(orient="records")) | |||
There was a problem hiding this comment.
why is this being changed? it should stay the same just like motion
There was a problem hiding this comment.
I think it's due to the 'nan' values:
I left a FIXME comment above https://github.com/blakeblackshear/frigate/pull/14401/files#diff-8e868833994d25351027aea083642480ec208331a12238e7f009fd2e9b2e764fR550
Maybe we should fix it and then this does not happen anymore 🤔
Error:
Traceback (most recent call last):
File "/usr/local/lib/python3.9/dist-packages/uvicorn/protocols/http/h11_impl.py", line 406, in run_asgi
result = await app( # type: ignore[func-returns-value]
File "/usr/local/lib/python3.9/dist-packages/uvicorn/middleware/proxy_headers.py", line 70, in __call__
return await self.app(scope, receive, send)
File "/usr/local/lib/python3.9/dist-packages/fastapi/applications.py", line 1054, in __call__
await super().__call__(scope, receive, send)
File "/usr/local/lib/python3.9/dist-packages/starlette/applications.py", line 113, in __call__
await self.middleware_stack(scope, receive, send)
File "/usr/local/lib/python3.9/dist-packages/starlette/middleware/errors.py", line 187, in __call__
raise exc
File "/usr/local/lib/python3.9/dist-packages/starlette/middleware/errors.py", line 165, in __call__
await self.app(scope, receive, _send)
File "/usr/local/lib/python3.9/dist-packages/starlette/middleware/base.py", line 189, in __call__
response_sent.set()
File "/usr/lib/python3.9/contextlib.py", line 135, in __exit__
self.gen.throw(type, value, traceback)
File "/usr/local/lib/python3.9/dist-packages/starlette/_utils.py", line 83, in collapse_excgroups
raise exc
File "/usr/local/lib/python3.9/dist-packages/starlette/middleware/base.py", line 187, in __call__
response = await self.dispatch_func(request, call_next)
File "/usr/local/lib/python3.9/dist-packages/slowapi/middleware.py", line 136, in dispatch
response = await call_next(request)
File "/usr/local/lib/python3.9/dist-packages/starlette/middleware/base.py", line 163, in call_next
raise app_exc
File "/usr/local/lib/python3.9/dist-packages/starlette/middleware/base.py", line 149, in coro
await self.app(scope, receive_or_disconnect, send_no_error)
File "/usr/local/lib/python3.9/dist-packages/starlette/middleware/base.py", line 189, in __call__
response_sent.set()
File "/usr/lib/python3.9/contextlib.py", line 135, in __exit__
self.gen.throw(type, value, traceback)
File "/usr/local/lib/python3.9/dist-packages/starlette/_utils.py", line 83, in collapse_excgroups
raise exc
File "/usr/local/lib/python3.9/dist-packages/starlette/middleware/base.py", line 187, in __call__
response = await self.dispatch_func(request, call_next)
File "/workspace/frigate/frigate/api/fastapi_app.py", line 78, in frigate_middleware
response = await call_next(request)
File "/usr/local/lib/python3.9/dist-packages/starlette/middleware/base.py", line 163, in call_next
raise app_exc
File "/usr/local/lib/python3.9/dist-packages/starlette/middleware/base.py", line 149, in coro
await self.app(scope, receive_or_disconnect, send_no_error)
File "/usr/local/lib/python3.9/dist-packages/starlette/middleware/base.py", line 189, in __call__
response_sent.set()
File "/usr/lib/python3.9/contextlib.py", line 135, in __exit__
self.gen.throw(type, value, traceback)
File "/usr/local/lib/python3.9/dist-packages/starlette/_utils.py", line 83, in collapse_excgroups
raise exc
File "/usr/local/lib/python3.9/dist-packages/starlette/middleware/base.py", line 187, in __call__
response = await self.dispatch_func(request, call_next)
File "/usr/local/lib/python3.9/dist-packages/starlette_context/middleware/context_middleware.py", line 78, in dispatch
response = await call_next(request)
File "/usr/local/lib/python3.9/dist-packages/starlette/middleware/base.py", line 163, in call_next
raise app_exc
File "/usr/local/lib/python3.9/dist-packages/starlette/middleware/base.py", line 149, in coro
await self.app(scope, receive_or_disconnect, send_no_error)
File "/usr/local/lib/python3.9/dist-packages/starlette/middleware/exceptions.py", line 62, in __call__
await wrap_app_handling_exceptions(self.app, conn)(scope, receive, send)
File "/usr/local/lib/python3.9/dist-packages/starlette/_exception_handler.py", line 62, in wrapped_app
raise exc
File "/usr/local/lib/python3.9/dist-packages/starlette/_exception_handler.py", line 51, in wrapped_app
await app(scope, receive, sender)
File "/usr/local/lib/python3.9/dist-packages/starlette/routing.py", line 715, in __call__
await self.middleware_stack(scope, receive, send)
File "/usr/local/lib/python3.9/dist-packages/starlette/routing.py", line 735, in app
await route.handle(scope, receive, send)
File "/usr/local/lib/python3.9/dist-packages/starlette/routing.py", line 288, in handle
await self.app(scope, receive, send)
File "/usr/local/lib/python3.9/dist-packages/starlette/routing.py", line 76, in app
await wrap_app_handling_exceptions(app, request)(scope, receive, send)
File "/usr/local/lib/python3.9/dist-packages/starlette/_exception_handler.py", line 62, in wrapped_app
raise exc
File "/usr/local/lib/python3.9/dist-packages/starlette/_exception_handler.py", line 51, in wrapped_app
await app(scope, receive, sender)
File "/usr/local/lib/python3.9/dist-packages/starlette/routing.py", line 73, in app
response = await f(request)
File "/usr/local/lib/python3.9/dist-packages/fastapi/routing.py", line 301, in app
raw_response = await run_endpoint_function(
File "/usr/local/lib/python3.9/dist-packages/fastapi/routing.py", line 214, in run_endpoint_function
return await run_in_threadpool(dependant.call, **values)
File "/usr/local/lib/python3.9/dist-packages/starlette/concurrency.py", line 39, in run_in_threadpool
return await anyio.to_thread.run_sync(func, *args)
File "/usr/local/lib/python3.9/dist-packages/anyio/to_thread.py", line 56, in run_sync
return await get_async_backend().run_sync_in_worker_thread(
File "/usr/local/lib/python3.9/dist-packages/anyio/_backends/_asyncio.py", line 2405, in run_sync_in_worker_thread
return await future
File "/usr/local/lib/python3.9/dist-packages/anyio/_backends/_asyncio.py", line 914, in run
result = context.run(func, *args)
File "/workspace/frigate/frigate/api/review.py", line 560, in audio_activity
return JSONResponse(content=normalized)
File "/usr/local/lib/python3.9/dist-packages/starlette/responses.py", line 178, in __init__
super().__init__(content, status_code, headers, media_type, background)
File "/usr/local/lib/python3.9/dist-packages/starlette/responses.py", line 41, in __init__
self.body = self.render(content)
File "/usr/local/lib/python3.9/dist-packages/starlette/responses.py", line 181, in render
return json.dumps(
File "/usr/lib/python3.9/json/__init__.py", line 234, in dumps
return cls(
File "/usr/lib/python3.9/json/encoder.py", line 199, in encode
chunks = self.iterencode(o, _one_shot=True)
File "/usr/lib/python3.9/json/encoder.py", line 257, in iterencode
return _iterencode(o, 0)
ValueError: Out of range float values are not JSON compliant
There was a problem hiding this comment.
We are not currently using this in the UI, I think the part commented on should stay the same, perhaps it can be adjusted to work the same as the motion or otherwise we can just delete this API since it is currently not used
There was a problem hiding this comment.
Do you think we can remove it then? @blakeblackshear @hawkeye217 is this okay for you guys too? I prefer to have only code that is used.
|
sorry, didn't realize it was still in draft, the email link took me right to the file changes |
No worries. Those were good comments |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed change
This PR improves the documentation of the
Reviewcontroller endpointsExamples
Type of change
Additional information
Checklist
ruff format frigate)