From ae7099c93166d2446634288f3cd41ae9156c9bec Mon Sep 17 00:00:00 2001
From: Jagruti <tiwarijagruti1@gmail.com>
Date: Tue, 13 Sep 2022 22:05:10 +0530
Subject: [PATCH 01/12] feat: added doc for 5 apis
---
doc/references/api.md | 231 ++++++++++++++++++++++++++++++++++++++++++
1 file changed, 231 insertions(+)
diff --git a/doc/references/api.md b/doc/references/api.md
index 89175f44c4..7d0a48d610 100644
--- a/doc/references/api.md
+++ b/doc/references/api.md
@@ -163,3 +163,234 @@ Generate spellcheck corrections. Either the barcode or the text to correct must
}
}
```
+
+## Collection
+
+### Prediction Collection [/predictions/]
+Get all the predictions [GET]
+
+The page, count, value_tag to the predictions must be supplied.
+
+- Parameters:
+ - page (int) - the page number to return (default: 1)
+ - count (int) - number of results to return (default: 25)
+
+ - barcode (str, optional) - the barcode of the product.
+ - value_tag (str) - the value_tag of the product.
+ - keep_types (List[str], optional) - a list of insight types
+
+- Response 200 (application/json)
+
+```
+{
+ 'count': 2,
+ 'predictions': [{
+ 'id': 33,
+ 'barcode': '0000000000002',
+ 'type': 'brand',
+ 'data': {
+ 'sample': 1
+ },
+ 'timestamp': '2022-09-13T15:24:11.764995',
+ 'value_tag': 'en:beers',
+ 'value': None,
+ 'source_image': None,
+ 'automatic_processing': None,
+ 'server_domain': 'api.openfoodfacts.localhost',
+ 'predictor': None
+ }, {
+ 'id': 32,
+ 'barcode': '0000000000001',
+ 'type': 'category',
+ 'data': {},
+ 'timestamp': '2022-09-13T15:24:11.758110',
+ 'value_tag': 'en:seeds',
+ 'value': None,
+ 'source_image': None,
+ 'automatic_processing': None,
+ 'server_domain': 'api.openfoodfacts.localhost',
+ 'predictor': None
+ }],
+ 'status': 'found'
+}
+```
+
+### Image Prediction Collection [/images/prediction/collection/]
+
+Get all image predictions [GET]
+
+The page, count must be supplied
+
+- Parameters:
+ - page (int) - the page number to return (default: 1)
+
+ - count (int) - number of results to return (default: 25)
+ - barcode (str, optional) - the barcode of the product.
+ - with_logo (bool, optional) - whether to return with or without logos (default=False)
+ - type (str, optional) - an insight types
+ - server_domain (str, optional) - server domain. Default to 'api.openfoodfacts.org'
+
+- Response 200 (application/json)
+
+```
+{
+ 'count': 1,
+ 'images': [{
+ 'id': 10,
+ 'type': 'category',
+ 'model_name': 'universal-logo-detector',
+ 'model_version': 'tf-universal-logo-detector-1.0',
+ 'data': {
+ 'objects': [{
+ 'label': 'brand',
+ 'score': 0.2,
+ 'bounding_box': [0.4, 0.4, 0.6, 0.6]
+ }]
+ },
+ 'timestamp': '2022-09-13T15:40:46.071377',
+ 'image': {
+ 'id': 11,
+ 'barcode': '123',
+ 'uploaded_at': '2022-09-13T15:40:46.072360',
+ 'image_id': 'image-01',
+ 'source_image': '/images/01.jpg',
+ 'width': 400,
+ 'height': 400,
+ 'deleted': False,
+ 'server_domain': 'api.openfoodfacts.localhost',
+ 'server_type': 'off'
+ },
+ 'max_confidence': None
+ }],
+ 'status': 'found'
+}
+```
+
+### Image Collection[/images/]
+
+Get all images [GET]
+
+The count, page must be supplied
+
+- Parameters
+ - page (int) - the page number to return (default: 1)
+ - count (int) - number of results to return (default: 25)
+ - barcode (str, optional) - the barcode of the product.
+ - with_predictions (bool, optional) - whether to return images with or without predictions (default=False)
+
+ - server_domain (str, optional) - server domain. Default to 'api.openfoodfacts.org'
+
+- Response 200 (application/json)
+
+ ```
+ {
+ 'count': 1,
+ 'images': [{
+ 'id': 14,
+ 'barcode': '123',
+ 'uploaded_at': '2022-09-13T16:11:39.272087',
+ 'image_id': 'image-01',
+ 'source_image': '/images/01.jpg',
+ 'width': 400,
+ 'height': 400,
+ 'deleted': False,
+ 'server_domain': 'api.openfoodfacts.localhost',
+ 'server_type': 'off'
+ }],
+ 'status': 'found'
+ }
+ ```
+
+### Logo Annotation Collection[/annotation/collection/]
+
+Get all images [GET]
+
+The count, page, value tag must be supplied
+
+- Parameters
+ - page (int) - the page number to return (default: 1)
+
+ - count (int) - number of results to return (default: 25)
+ - barcode (str, optional) - the barcode of the product.
+ - value_tag (str) - the value_tag of the product.
+ - keep_types (List[str], optional) - a list of insight types
+ - server_domain (str, optional) - server domain. Default to 'api.openfoodfacts.org'
+
+
+- Response 200 (application/json)
+
+ ```
+ {
+ 'count': 1,
+ 'annotation': [{
+ 'id': 9,
+ 'image_prediction': {
+ 'id': 16,
+ 'type': 'object_detection',
+ 'model_name': 'universal-logo-detector',
+ 'model_version': 'tf-universal-logo-detector-1.0',
+ 'data': {
+ 'objects': [{
+ 'label': 'brand',
+ 'score': 0.2,
+ 'bounding_box': [0.4, 0.4, 0.6, 0.6]
+ }]
+ },
+ 'timestamp': '2022-09-13T16:17:04.447213',
+ 'image': {
+ 'id': 18,
+ 'barcode': '295',
+ 'uploaded_at': '2022-09-13T16:17:04.447316',
+ 'image_id': 'image-03',
+ 'source_image': '/images/03.jpg',
+ 'width': 400,
+ 'height': 400,
+ 'deleted': False,
+ 'server_domain': 'api.openfoodfacts.localhost',
+ 'server_type': 'off'
+ },
+ 'max_confidence': None
+ },
+ 'index': 0,
+ 'bounding_box': [0.4, 0.4, 0.6, 0.6],
+ 'score': 0.7,
+ 'annotation_value': 'ab agriculture biologique',
+ 'annotation_value_tag': 'cheese',
+ 'taxonomy_value': 'en:ab-agriculture-biologique',
+ 'annotation_type': 'dairies',
+ 'username': None,
+ 'completed_at': None,
+ 'nearest_neighbors': {
+ 'logo_ids': [111111, 222222],
+ 'distances': [11.1, 12.4]
+ }
+ }],
+ 'status': 'found'
+ }
+ ```
+### Unanswered question Collection[/questions/unanswered/]
+
+Get all images [GET]
+
+The count, page must be supplied
+
+- Parameters
+ - page (int) - the page number to return (default: 1)
+ - count (int) - number of results to return (default: 25)
+
+ - type (str, optional) - an insight type
+ - server_domain (str, optional) - server domain. Default to 'api.openfoodfacts.org'
+
+- Response 200 (application/json)
+
+```
+ {
+ 'count': 5,
+ 'questions': [
+ ['en:soups', 3],
+ ['en:apricot', 2]
+ ],
+ 'status': 'found'
+}
+```
+
From a432f5ec3548f156c08807c05d374fe9bf2aa0fc Mon Sep 17 00:00:00 2001
From: Jagruti Tiwari <tiwarijagruti1@gmail.com>
Date: Wed, 14 Sep 2022 19:42:30 +0530
Subject: [PATCH 02/12] Update doc/references/api.md
Co-authored-by: Alex Garel <alex@garel.org>
---
doc/references/api.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/doc/references/api.md b/doc/references/api.md
index 7d0a48d610..d11b0d9894 100644
--- a/doc/references/api.md
+++ b/doc/references/api.md
@@ -176,7 +176,7 @@ The page, count, value_tag to the predictions must be supplied.
- count (int) - number of results to return (default: 25)
- barcode (str, optional) - the barcode of the product.
- - value_tag (str) - the value_tag of the product.
+ - value_tag (str) - the value_tag of the insight
- keep_types (List[str], optional) - a list of insight types
- Response 200 (application/json)
From 5c64b9b7f80df7e84acae0f9dca98b1ac07abbf7 Mon Sep 17 00:00:00 2001
From: Jagruti Tiwari <tiwarijagruti1@gmail.com>
Date: Wed, 14 Sep 2022 19:42:58 +0530
Subject: [PATCH 03/12] Update doc/references/api.md
Co-authored-by: Alex Garel <alex@garel.org>
---
doc/references/api.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/doc/references/api.md b/doc/references/api.md
index d11b0d9894..f25479e67a 100644
--- a/doc/references/api.md
+++ b/doc/references/api.md
@@ -223,8 +223,8 @@ The page, count must be supplied
- Parameters:
- page (int) - the page number to return (default: 1)
-
- count (int) - number of results to return (default: 25)
+
- barcode (str, optional) - the barcode of the product.
- with_logo (bool, optional) - whether to return with or without logos (default=False)
- type (str, optional) - an insight types
From d07d22ca3f8167c579d2ca49094bad1b5d48aaab Mon Sep 17 00:00:00 2001
From: Jagruti Tiwari <tiwarijagruti1@gmail.com>
Date: Wed, 14 Sep 2022 19:45:41 +0530
Subject: [PATCH 04/12] Update doc/references/api.md
Co-authored-by: Alex Garel <alex@garel.org>
---
doc/references/api.md | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/doc/references/api.md b/doc/references/api.md
index f25479e67a..3fa7dcb588 100644
--- a/doc/references/api.md
+++ b/doc/references/api.md
@@ -226,7 +226,9 @@ The page, count must be supplied
- count (int) - number of results to return (default: 25)
- barcode (str, optional) - the barcode of the product.
- - with_logo (bool, optional) - whether to return with or without logos (default=False)
+ - with_logo (bool, optional) -
+ if false (the default) returns only images predictions that have no logo annotation,
+ if true, returns all images predictions corresponding to criterias
- type (str, optional) - an insight types
- server_domain (str, optional) - server domain. Default to 'api.openfoodfacts.org'
From 85f6849b9499f5ae3ff6c52ee71fdf2d928ee882 Mon Sep 17 00:00:00 2001
From: Jagruti Tiwari <tiwarijagruti1@gmail.com>
Date: Wed, 14 Sep 2022 19:45:59 +0530
Subject: [PATCH 05/12] Update doc/references/api.md
Co-authored-by: Alex Garel <alex@garel.org>
---
doc/references/api.md | 6 +++++-
1 file changed, 5 insertions(+), 1 deletion(-)
diff --git a/doc/references/api.md b/doc/references/api.md
index 3fa7dcb588..1d2d33e3ef 100644
--- a/doc/references/api.md
+++ b/doc/references/api.md
@@ -217,7 +217,11 @@ The page, count, value_tag to the predictions must be supplied.
### Image Prediction Collection [/images/prediction/collection/]
-Get all image predictions [GET]
+Get all image predictions [GET].
+
+The list is ordered with the most recent first.
+
+Images predictions are predictions found in images, generally corresponding to a crop (part of the image). Like a nutriscore, a logo, etc...
The page, count must be supplied
From 5af0e51d5059a65d981eea8c03ec8b98726ddbe9 Mon Sep 17 00:00:00 2001
From: Jagruti Tiwari <tiwarijagruti1@gmail.com>
Date: Wed, 14 Sep 2022 19:46:32 +0530
Subject: [PATCH 06/12] Update doc/references/api.md
Co-authored-by: Alex Garel <alex@garel.org>
---
doc/references/api.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/doc/references/api.md b/doc/references/api.md
index 1d2d33e3ef..38b9e97054 100644
--- a/doc/references/api.md
+++ b/doc/references/api.md
@@ -233,7 +233,7 @@ The page, count must be supplied
- with_logo (bool, optional) -
if false (the default) returns only images predictions that have no logo annotation,
if true, returns all images predictions corresponding to criterias
- - type (str, optional) - an insight types
+ - type (str, optional) - an insight type to filter on
- server_domain (str, optional) - server domain. Default to 'api.openfoodfacts.org'
- Response 200 (application/json)
From c6745222f93dc747d44cbcaa827a83c0f9b10aa4 Mon Sep 17 00:00:00 2001
From: Jagruti Tiwari <tiwarijagruti1@gmail.com>
Date: Wed, 14 Sep 2022 19:46:50 +0530
Subject: [PATCH 07/12] Update doc/references/api.md
Co-authored-by: Alex Garel <alex@garel.org>
---
doc/references/api.md | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/doc/references/api.md b/doc/references/api.md
index 38b9e97054..1f41dacf54 100644
--- a/doc/references/api.md
+++ b/doc/references/api.md
@@ -282,7 +282,9 @@ The count, page must be supplied
- page (int) - the page number to return (default: 1)
- count (int) - number of results to return (default: 25)
- barcode (str, optional) - the barcode of the product.
- - with_predictions (bool, optional) - whether to return images with or without predictions (default=False)
+ - with_predictions (bool, optional) -
+ if false (the default) returns only images where no prediction was made
+ if true, returns all images corresponding to criterias
- server_domain (str, optional) - server domain. Default to 'api.openfoodfacts.org'
From 80fe457bf7ba9a6a61072f43703e1764941104f4 Mon Sep 17 00:00:00 2001
From: Jagruti Tiwari <tiwarijagruti1@gmail.com>
Date: Wed, 14 Sep 2022 19:47:19 +0530
Subject: [PATCH 08/12] Update doc/references/api.md
Co-authored-by: Alex Garel <alex@garel.org>
---
doc/references/api.md | 6 +++++-
1 file changed, 5 insertions(+), 1 deletion(-)
diff --git a/doc/references/api.md b/doc/references/api.md
index 1f41dacf54..891eb7e3f8 100644
--- a/doc/references/api.md
+++ b/doc/references/api.md
@@ -311,7 +311,11 @@ The count, page must be supplied
### Logo Annotation Collection[/annotation/collection/]
-Get all images [GET]
+Get all Logo annotations [GET]
+
+The list is ordered with the most recent first.
+
+Logo Annotations are annotations on image predictions to associate part of an image, which is a logo, to a characteristic of the product (eg: logo for eu organic, or QR-code, or logo for Lidl, etc.).
The count, page, value tag must be supplied
From 4709d432e52ebec245793913a2cfc6e2f1ba641a Mon Sep 17 00:00:00 2001
From: Jagruti Tiwari <tiwarijagruti1@gmail.com>
Date: Wed, 14 Sep 2022 19:47:37 +0530
Subject: [PATCH 09/12] Update doc/references/api.md
Co-authored-by: Alex Garel <alex@garel.org>
---
doc/references/api.md | 2 ++
1 file changed, 2 insertions(+)
diff --git a/doc/references/api.md b/doc/references/api.md
index 891eb7e3f8..69618f9020 100644
--- a/doc/references/api.md
+++ b/doc/references/api.md
@@ -276,6 +276,8 @@ The page, count must be supplied
Get all images [GET]
+The list is ordered with the most recent first.
+
The count, page must be supplied
- Parameters
From bd84e2ada9e9ef85f562bbed7536dd18a25a217c Mon Sep 17 00:00:00 2001
From: Jagruti Tiwari <tiwarijagruti1@gmail.com>
Date: Wed, 14 Sep 2022 19:48:11 +0530
Subject: [PATCH 10/12] Update doc/references/api.md
Co-authored-by: Alex Garel <alex@garel.org>
---
doc/references/api.md | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/doc/references/api.md b/doc/references/api.md
index 69618f9020..c6c61d3c7c 100644
--- a/doc/references/api.md
+++ b/doc/references/api.md
@@ -384,7 +384,9 @@ The count, page, value tag must be supplied
```
### Unanswered question Collection[/questions/unanswered/]
-Get all images [GET]
+Get the number unanswered questions for each tag_value for a given type of question [GET]
+
+The list is ordered from highest count to lowest.
The count, page must be supplied
From 3a32fec1323ca08cd59af356a18dc60dc584df3b Mon Sep 17 00:00:00 2001
From: Jagruti <tiwarijagruti1@gmail.com>
Date: Wed, 14 Sep 2022 20:30:09 +0530
Subject: [PATCH 11/12] fix: fixed the name json key naming in
image-prediction-collection API
---
doc/references/api.md | 88 +++++++++++++++++++++----------------------
robotoff/app/api.py | 2 +-
2 files changed, 45 insertions(+), 45 deletions(-)
diff --git a/doc/references/api.md b/doc/references/api.md
index c6c61d3c7c..f9f14d8ad1 100644
--- a/doc/references/api.md
+++ b/doc/references/api.md
@@ -215,6 +215,45 @@ The page, count, value_tag to the predictions must be supplied.
}
```
+### Image Collection[/images/]
+
+Get all images [GET]
+
+The list is ordered with the most recent first.
+
+The count, page must be supplied
+
+- Parameters
+ - page (int) - the page number to return (default: 1)
+ - count (int) - number of results to return (default: 25)
+ - barcode (str, optional) - the barcode of the product.
+ - with_predictions (bool, optional) -
+ if false (the default) returns only images where no prediction was made
+ if true, returns all images corresponding to criterias
+
+ - server_domain (str, optional) - server domain. Default to 'api.openfoodfacts.org'
+
+- Response 200 (application/json)
+
+ ```
+ {
+ 'count': 1,
+ 'images': [{
+ 'id': 14,
+ 'barcode': '123',
+ 'uploaded_at': '2022-09-13T16:11:39.272087',
+ 'image_id': 'image-01',
+ 'source_image': '/images/01.jpg',
+ 'width': 400,
+ 'height': 400,
+ 'deleted': False,
+ 'server_domain': 'api.openfoodfacts.localhost',
+ 'server_type': 'off'
+ }],
+ 'status': 'found'
+ }
+ ```
+
### Image Prediction Collection [/images/prediction/collection/]
Get all image predictions [GET].
@@ -241,8 +280,8 @@ The page, count must be supplied
```
{
'count': 1,
- 'images': [{
- 'id': 10,
+ 'image_predictions': [{
+ 'id': 20,
'type': 'category',
'model_name': 'universal-logo-detector',
'model_version': 'tf-universal-logo-detector-1.0',
@@ -253,11 +292,11 @@ The page, count must be supplied
'bounding_box': [0.4, 0.4, 0.6, 0.6]
}]
},
- 'timestamp': '2022-09-13T15:40:46.071377',
+ 'timestamp': '2022-09-14T14:57:33.952455',
'image': {
- 'id': 11,
+ 'id': 22,
'barcode': '123',
- 'uploaded_at': '2022-09-13T15:40:46.072360',
+ 'uploaded_at': '2022-09-14T14:57:33.953365',
'image_id': 'image-01',
'source_image': '/images/01.jpg',
'width': 400,
@@ -272,45 +311,6 @@ The page, count must be supplied
}
```
-### Image Collection[/images/]
-
-Get all images [GET]
-
-The list is ordered with the most recent first.
-
-The count, page must be supplied
-
-- Parameters
- - page (int) - the page number to return (default: 1)
- - count (int) - number of results to return (default: 25)
- - barcode (str, optional) - the barcode of the product.
- - with_predictions (bool, optional) -
- if false (the default) returns only images where no prediction was made
- if true, returns all images corresponding to criterias
-
- - server_domain (str, optional) - server domain. Default to 'api.openfoodfacts.org'
-
-- Response 200 (application/json)
-
- ```
- {
- 'count': 1,
- 'images': [{
- 'id': 14,
- 'barcode': '123',
- 'uploaded_at': '2022-09-13T16:11:39.272087',
- 'image_id': 'image-01',
- 'source_image': '/images/01.jpg',
- 'width': 400,
- 'height': 400,
- 'deleted': False,
- 'server_domain': 'api.openfoodfacts.localhost',
- 'server_type': 'off'
- }],
- 'status': 'found'
- }
- ```
-
### Logo Annotation Collection[/annotation/collection/]
Get all Logo annotations [GET]
diff --git a/robotoff/app/api.py b/robotoff/app/api.py
index 8d0c251340..4cbcc6e6f4 100644
--- a/robotoff/app/api.py
+++ b/robotoff/app/api.py
@@ -1206,7 +1206,7 @@ def on_get(self, req: falcon.Request, resp: falcon.Response):
response["image_predictions"] = []
response["status"] = "no_image_predictions"
else:
- response["images"] = images
+ response["image_predictions"] = images
response["status"] = "found"
resp.media = response
From 9d869c15cf377d1480cc2524aa2320db5821eaec Mon Sep 17 00:00:00 2001
From: Jagruti <tiwarijagruti1@gmail.com>
Date: Fri, 16 Sep 2022 19:51:57 +0530
Subject: [PATCH 12/12] fix: Updated the test case for
ImagePredictionCollection
---
tests/integration/test_api.py | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
diff --git a/tests/integration/test_api.py b/tests/integration/test_api.py
index 32db0bd163..b67f8bb00b 100644
--- a/tests/integration/test_api.py
+++ b/tests/integration/test_api.py
@@ -741,8 +741,8 @@ def test_image_prediction_collection(client):
assert result.status_code == 200
data = result.json
assert data["count"] == 1
- assert data["images"][0]["id"] == prediction_category_123.id
- assert data["images"][0]["image"]["barcode"] == "123"
+ assert data["image_predictions"][0]["id"] == prediction_category_123.id
+ assert data["image_predictions"][0]["image"]["barcode"] == "123"
# test with "type=label" and "with_logo=True"
result = client.simulate_get(
@@ -755,10 +755,10 @@ def test_image_prediction_collection(client):
assert result.status_code == 200
data = result.json
- data["images"].sort(key=lambda d: d["id"])
+ data["image_predictions"].sort(key=lambda d: d["id"])
assert data["count"] == 2
- assert data["images"][0]["id"] == prediction_label_789.id
- assert data["images"][1]["id"] == prediction_label_789_no_logo.id
+ assert data["image_predictions"][0]["id"] == prediction_label_789.id
+ assert data["image_predictions"][1]["id"] == prediction_label_789_no_logo.id
# test with "barcode=456" and "with_logo=True"
result = client.simulate_get(
@@ -785,7 +785,7 @@ def test_image_prediction_collection(client):
assert result.status_code == 200
data = result.json
assert data["count"] == 1
- assert data["images"][0]["id"] == prediction_label_789_no_logo.id
+ assert data["image_predictions"][0]["id"] == prediction_label_789_no_logo.id
def test_logo_annotation_collection_empty(client):