From d090d955d291d7e08b363907a2275dc0ea8149a0 Mon Sep 17 00:00:00 2001 From: Test Account Date: Fri, 19 Apr 2024 14:03:51 -0700 Subject: [PATCH] Add external server return format to ReadMe (#175) This adds the Doods2 json format as an example of the required return data from the external server. Signed-off-by: Test Account Reviewed-on: https://gitea.azgeorgis.net/ALVINN/ALVINN_f7/pulls/175 Co-authored-by: Test Account Co-committed-by: Test Account --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7757617..a9a2de8 100644 --- a/README.md +++ b/README.md @@ -57,4 +57,14 @@ ALVINN can use an external object detection server instead of the built in model | --- | --- | --- | | `name` | identifier for external server | *none* | | `address` | ip or url of external server | *none* | -| `port` | port to access on external server | 9001 | \ No newline at end of file +| `port` | port to access on external server | 9001 | + +The external server's response must be json with a `detections` key that contains an array of the detected structure labels, bounding box data, and confidence values. +``` +{ + "detections": [ + {"top": 0.1, "left": 0.1, "bottom": 0.9, "right": 0.9, "label": "dog", "confidence": 90.0 } + ... + ], +} +``` \ No newline at end of file