sort_docs_on for videodb search

Author: 0xrohitgarg

videodb/_constants.py

@@ -49,6 +49,7 @@ class ReframeMode:
 class SemanticSearchDefaultValues:
     result_threshold = 5
     score_threshold = 0.2
+    sort_docs_on = None
 
 
 class Segmenter:

videodb/collection.py

@@ -468,6 +468,7 @@ def search(
         score_threshold: Optional[float] = None,
         dynamic_score_percentage: Optional[float] = None,
         filter: List[Dict[str, Any]] = [],
+        sort_docs_on: Optional[str] = None,
         namespace: Optional[str] = None,
         scene_index_id: Optional[str] = None,
     ) -> Union[SearchResult, RTStreamSearchResult]:
@@ -480,6 +481,7 @@ def search(
         :param float score_threshold: Threshold score for the search (optional)
         :param float dynamic_score_percentage: Percentage of dynamic score to consider (optional)
         :param list filter: Additional metadata filters (optional)
+        :param str sort_docs_on: Sort docs within each video by "score" or "start" (optional)
         :param str namespace: Search namespace (optional, "rtstream" to search RTStreams)
         :param str scene_index_id: Filter by specific scene index (optional)
         :raise SearchError: If the search fails
@@ -532,6 +534,7 @@ def search(
             result_threshold=result_threshold,
             score_threshold=score_threshold,
             dynamic_score_percentage=dynamic_score_percentage,
+            sort_docs_on=sort_docs_on,
             filter=filter,
         )
 

videodb/search.py

@@ -155,6 +155,7 @@ def search_inside_collection(
         result_threshold: Optional[int] = None,
         score_threshold: Optional[float] = None,
         dynamic_score_percentage: Optional[float] = None,
+        sort_docs_on: Optional[str] = SemanticSearchDefaultValues.sort_docs_on,
         **kwargs,
     ):
         search_data = self._connection.post(
@@ -170,6 +171,7 @@ def search_inside_collection(
                 if result_threshold is not None
                 else SemanticSearchDefaultValues.result_threshold,
                 "dynamic_score_percentage": dynamic_score_percentage,
+                "sort_docs_on": sort_docs_on,
                 **kwargs,
             },
         )