Give support for sort_docs_on param in collection search

Author: ashish-spext

videodb/_constants.py

@@ -39,6 +39,7 @@ class SemanticSearchDefaultValues:
     score_threshold = 0.2
     rerank = False
     rerank_params = {}
+    sort_docs_on = None
 
 
 class Segmenter:

videodb/collection.py

@@ -390,6 +390,7 @@ def search(
         dynamic_score_percentage: Optional[float] = None,
         rerank: bool = SemanticSearchDefaultValues.rerank,
         rerank_params: dict = SemanticSearchDefaultValues.rerank_params,
+        sort_docs_on: str = SemanticSearchDefaultValues.sort_docs_on,
         filter: List[Dict[str, Any]] = [],
     ) -> SearchResult:
         """Search for a query in the collection.
@@ -402,6 +403,7 @@ def search(
         :param float dynamic_score_percentage: Percentage of dynamic score to consider (optional)
         :param bool rerank: Rerank search results (optional)
         :param dict rerank_params: Parameters for reranking (optional)
+        :param str sort_docs_on: Parameter to specify what metric to sort the docs of video on
         :raise SearchError: If the search fails
         :return: :class:`SearchResult <SearchResult>` object
         :rtype: :class:`videodb.search.SearchResult`
@@ -418,6 +420,7 @@ def search(
             rerank=rerank,
             rerank_params=rerank_params,
             filter=filter,
+            sort_docs_on=sort_docs_on
         )
 
     def search_title(self, query) -> List[Video]:

videodb/search.py

@@ -161,6 +161,7 @@ def search_inside_collection(
         dynamic_score_percentage: Optional[float] = None,
         rerank: bool = SemanticSearchDefaultValues.rerank,
         rerank_params: dict = SemanticSearchDefaultValues.rerank_params,
+        sort_docs_on: str = SemanticSearchDefaultValues.sort_docs_on,
         **kwargs,
     ):
         search_data = self._connection.post(
@@ -178,6 +179,7 @@ def search_inside_collection(
                 "dynamic_score_percentage": dynamic_score_percentage,
                 "rerank": rerank,
                 "rerank_params": rerank_params,
+                "sort_docs_on": sort_docs_on,
                 **kwargs,
             },
         )