Put scene index id and name of shots in search result at doc level and introduce metadata

Author: ashish-spext

videodb/search.py

@@ -34,8 +34,6 @@ def __init__(self, _connection, **kwargs):
     def _format_results(self):
         for result in self._results:
             self.collection_id = result.get("collection_id")
-            scene_index_id = result.get("scene_index_id")
-            scene_index_name = result.get("scene_index_name")
             for doc in result.get("docs"):
                 self.shots.append(
                     Shot(
@@ -47,8 +45,9 @@ def _format_results(self):
                         doc.get("end"),
                         doc.get("text"),
                         doc.get("score"),
-                        scene_index_id=scene_index_id,
-                        scene_index_name=scene_index_name,
+                        scene_index_id=doc.get("scene_index_id"),
+                        scene_index_name=doc.get("scene_index_name"),
+                        metadata=doc.get("metadata"),
                     )
                 )
 

videodb/shot.py

@@ -21,6 +21,7 @@ class Shot:
     :ivar str player_url: URL to play the shot in a player
     :ivar Optional[str] scene_index_id: ID of the scene index for scene search results
     :ivar Optional[str] scene_index_name: Name of the scene index for scene search results
+    :ivar Optional[dict] metadata: Additional metadata for the shot
     """
 
     def __init__(
@@ -35,6 +36,8 @@ def __init__(
         search_score: Optional[int] = None,
         scene_index_id: Optional[str] = None,
         scene_index_name: Optional[str] = None,
+        metadata: Optional[dict] = None,
+
     ) -> None:
         self._connection = _connection
         self.video_id = video_id
@@ -46,6 +49,7 @@ def __init__(
         self.search_score = search_score
         self.scene_index_id = scene_index_id
         self.scene_index_name = scene_index_name
+        self.metadata = metadata
         self.stream_url = None
         self.player_url = None
 
@@ -65,6 +69,9 @@ def __repr__(self) -> str:
         if self.scene_index_name:
             repr_str += f", scene_index_name={self.scene_index_name}"
 
+        if self.metadata:
+            repr_str += f", metadata={self.metadata}"
+
         repr_str += (
             f", stream_url={self.stream_url}, "
             f"player_url={self.player_url})"