Update Image Entity fields

mapillary · Aug 7, 2023 · ab63bb6 · ab63bb6
1 parent 531bb94
commit ab63bb6
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 20 deletions.
diff --git a/docs/docs/mapillary.config.api/mapillary.config.api.entities.md b/docs/docs/mapillary.config.api/mapillary.config.api.entities.md
@@ -150,12 +150,13 @@ Fields:
 14. thumb_256_url - string, URL to the 256px wide thumbnail
 15. thumb_1024_url - string, URL to the 1024px wide thumbnail
 16. thumb_2048_url - string, URL to the 2048px wide thumbnail
-17. merge_cc - int, id of the connected component of images that were aligned together
-18. mesh - { id: string, url: string } - URL to the mesh
-19. quality_score - float, how good the image is (experimental)
+17. thumb_original_url - string, URL to the original wide thumbnail.
+18. merge_cc - int, id of the connected component of images that were aligned together
+19. mesh - { id: string, url: string } - URL to the mesh
 20. sequence - string, ID of the sequence
 21. sfm_cluster - { id: string, url: string } - URL to the point cloud
 22. width - int, width of the original image uploaded
+23. detections - detection entity, detections from the image
 ```
 
 

diff --git a/docs/docs/mapillary/mapillary.interface.md b/docs/docs/mapillary/mapillary.interface.md
@@ -357,14 +357,13 @@ Gets an image for the given key argument
         16. thumb_2048_url - string, URL to the 2048px wide thumbnail
 
 
-        17. merge_cc - int, id of the connected component of images that were aligned
-    together
+        17. thumb_original_url - string, URL to the original wide thumbnail.
 
 
-        18. mesh - { id: string, url: string } - URL to the mesh
+        18. merge_cc - int, id of the connected component of images that were aligned together
 
 
-        19. quality_score - float, how good the image is (experimental)
+        19. mesh - { id: string, url: string } - URL to the mesh
 
 
         20. sequence - string, ID of the sequence
@@ -375,6 +374,9 @@ Gets an image for the given key argument
 
         22. width - int, width of the original image uploaded
 
+
+        23. detections - detection entity, detections from the image
+
     Refer to [https://www.mapillary.com/developer/api-documentation/#image](https://www.mapillary.com/developer/api-documentation/#image) for more details
 
 

diff --git a/src/mapillary/config/api/entities.py b/src/mapillary/config/api/entities.py
@@ -82,12 +82,13 @@ def get_image(image_id: str, fields: list) -> str:
             14. thumb_256_url - string, URL to the 256px wide thumbnail
             15. thumb_1024_url - string, URL to the 1024px wide thumbnail
             16. thumb_2048_url - string, URL to the 2048px wide thumbnail
-            17. merge_cc - int, id of the connected component of images that were aligned together
-            18. mesh - { id: string, url: string } - URL to the mesh
-            19. quality_score - float, how good the image is (experimental)
+            17. thumb_original_url - string, URL to the original wide thumbnail.
+            18. merge_cc - int, id of the connected component of images that were aligned together
+            19. mesh - { id: string, url: string } - URL to the mesh
             20. sequence - string, ID of the sequence
             21. sfm_cluster - { id: string, url: string } - URL to the point cloud
             22. width - int, width of the original image uploaded
+            23. detections - detection entity, detections from the image
         """
 
         fields = Entities.__field_validity(
@@ -134,12 +135,13 @@ def get_images(
             14. thumb_256_url - string, URL to the 256px wide thumbnail
             15. thumb_1024_url - string, URL to the 1024px wide thumbnail
             16. thumb_2048_url - string, URL to the 2048px wide thumbnail
-            17. merge_cc - int, id of the connected component of images that were aligned together
-            18. mesh - { id: string, url: string } - URL to the mesh
-            19. quality_score - float, how good the image is (experimental)
+            17. thumb_original_url - string, URL to the original wide thumbnail.
+            18. merge_cc - int, id of the connected component of images that were aligned together
+            19. mesh - { id: string, url: string } - URL to the mesh
             20. sequence - string, ID of the sequence
             21. sfm_cluster - { id: string, url: string } - URL to the point cloud
             22. width - int, width of the original image uploaded
+            23. detections - detection entity, detections from the image
 
         Raises::
 
@@ -379,12 +381,13 @@ def get_image_fields() -> list:
             "thumb_256_url",
             "thumb_1024_url",
             "thumb_2048_url",
+            "thumb_original_url",
             "merge_cc",
             "mesh",
-            "quality_score",
             "sequence",
             "sfm_cluster",
             "width",
+            "detections",
         ]
 
     @staticmethod

diff --git a/src/mapillary/interface.py b/src/mapillary/interface.py
@@ -934,13 +934,13 @@ def image_from_key(key: str, fields: list = []) -> str:
         14. thumb_256_url - string, URL to the 256px wide thumbnail
         15. thumb_1024_url - string, URL to the 1024px wide thumbnail
         16. thumb_2048_url - string, URL to the 2048px wide thumbnail
-        17. merge_cc - int, id of the connected component of images that were aligned
-            together
-        18. mesh - { id: string, url: string } - URL to the mesh
-        19. quality_score - float, how good the image is (experimental)
+        17. thumb_original_url - string, URL to the original wide thumbnail.
+        18. merge_cc - int, id of the connected component of images that were aligned together
+        19. mesh - { id: string, url: string } - URL to the mesh
         20. sequence - string, ID of the sequence
         21. sfm_cluster - { id: string, url: string } - URL to the point cloud
         22. width - int, width of the original image uploaded
+        23. detections - detection entity, detections from the image
 
         Refer to https://www.mapillary.com/developer/api-documentation/#image for more details
 

diff --git a/tests/config/api/test_entities.py b/tests/config/api/test_entities.py
@@ -437,8 +437,8 @@ def test_search_for_images__fields_param__selected(operation, expected):
                 "38.41055825094609,45.336701909968134&fields=altitude,atomic_scale,"
                 "camera_parameters,camera_type,captured_at,compass_angle,computed_altitude,"
                 "computed_compass_angle,computed_geometry,computed_rotation,exif_orientation,"
-                "geometry,height,thumb_256_url,thumb_1024_url,thumb_2048_url,merge_cc,mesh,"
-                "quality_score,sequence,sfm,width"
+                "geometry,height,thumb_256_url,thumb_1024_url,thumb_2048_url,thumb_original_url,"
+                "merge_cc,mesh,sequence,sfm,width,detections"
             ),
         )
     ],