feat: add product_insight.bounding_box field

migrations/002_add_bounding_box.py

@@ -0,0 +1,23 @@
+"""Peewee migrations -- 002_add_bounding_box.py."""
+
+from contextlib import suppress
+
+import peewee as pw
+from peewee_migrate import Migrator
+
+with suppress(ImportError):
+    import playhouse.postgres_ext as pw_pext
+
+
+def migrate(migrator: Migrator, database: pw.Database, *, fake=False):
+    """Write your migrations here."""
+
+    migrator.add_fields(
+        "product_insight", bounding_box=pw_pext.BinaryJSONField(index=True, null=True)
+    )
+
+
+def rollback(migrator: Migrator, database: pw.Database, *, fake=False):
+    """Write your rollback migrations here."""
+
+    migrator.remove_fields("product_insight", "bounding_box")

robotoff/insights/importer.py

@@ -420,6 +420,12 @@ def generate_insights(
                     candidate.source_image,
                 )
 
+            # Copy bounding box information to reserved field,
+            # `data->bounding_box` for insights is deprecated and will be
+            # removed in a future release
+            if "bounding_box" in candidate.data:
+                candidate.bounding_box = candidate.data["bounding_box"]
+
             if candidate.data.get("is_annotation"):
                 username = candidate.data.get("username")
                 if username:

robotoff/models.py

@@ -194,6 +194,15 @@ class ProductInsight(BaseModel):
     # Confidence score of the insight, may be null
     confidence = peewee.FloatField(null=True, index=True)
 
+    # bounding box corresponding to the area of the image related
+    # to the insight that was detected.
+    # For example:
+    # - for logo insights, it's the bounding box of the predicted
+    #   logo
+    # - for OCR-based insights, it's the text that triggered the
+    #   creation of the insight
+    bounding_box = BinaryJSONField(null=True, default=list)
+
     def get_product_id(self) -> ProductIdentifier:
         return ProductIdentifier(self.barcode, ServerType[self.server_type])
 

tests/integration/models_utils.py

@@ -57,6 +57,7 @@ class Meta:
     confidence: Optional[float] = None
     predictor: Optional[str] = None
     predictor_version: Optional[str] = None
+    bounding_box: Optional[list[float]] = None
 
 
 class PredictionFactory(PeeweeModelFactory):