fix: search and vision interface

Author: ankit-v2-3

videodb/__init__.py

@@ -7,6 +7,7 @@
 from videodb._utils._video import play_stream
 from videodb._constants import (
     VIDEO_DB_API,
+    IndexType,
     SceneExtractionType,
     MediaType,
     SearchType,
@@ -30,6 +31,7 @@
     "VideodbError",
     "AuthenticationError",
     "InvalidRequestError",
+    "IndexType",
     "SearchError",
     "play_stream",
     "MediaType",

videodb/_constants.py

@@ -18,12 +18,12 @@ class SearchType:
 
 
 class IndexType:
-    semantic = "semantic"
+    spoken = "spoken"
     scene = "scene"
 
 
 class SceneExtractionType:
-    scene_based = "scene"
+    shot_based = "shot"
     time_based = "time"
 
 

videodb/collection.py

@@ -10,6 +10,7 @@
 )
 from videodb._constants import (
     ApiPath,
+    IndexType,
     SearchType,
 )
 from videodb.video import Video
@@ -100,6 +101,7 @@ def search(
         self,
         query: str,
         search_type: Optional[str] = SearchType.semantic,
+        index_type: Optional[str] = IndexType.spoken,
         result_threshold: Optional[int] = None,
         score_threshold: Optional[float] = None,
         dynamic_score_percentage: Optional[float] = None,
@@ -108,6 +110,8 @@ def search(
         return search.search_inside_collection(
             collection_id=self.id,
             query=query,
+            search_type=search_type,
+            index_type=index_type,
             result_threshold=result_threshold,
             score_threshold=score_threshold,
             dynamic_score_percentage=dynamic_score_percentage,

videodb/search.py

@@ -1,6 +1,7 @@
 from abc import ABC, abstractmethod
 from videodb._utils._video import play_stream
 from videodb._constants import (
+    IndexType,
     SearchType,
     ApiPath,
     SemanticSearchDefaultValues,
@@ -109,6 +110,8 @@ def search_inside_video(
         self,
         video_id: str,
         query: str,
+        search_type: str,
+        index_type: str,
         result_threshold: Optional[int] = None,
         score_threshold: Optional[float] = None,
         dynamic_score_percentage: Optional[float] = None,
@@ -117,7 +120,8 @@ def search_inside_video(
         search_data = self._connection.post(
             path=f"{ApiPath.video}/{video_id}/{ApiPath.search}",
             data={
-                "index_type": SearchType.semantic,
+                "search_type": search_type,
+                "index_type": index_type,
                 "query": query,
                 "score_threshold": score_threshold
                 or SemanticSearchDefaultValues.score_threshold,
@@ -133,6 +137,8 @@ def search_inside_collection(
         self,
         collection_id: str,
         query: str,
+        search_type: str,
+        index_type: str,
         result_threshold: Optional[int] = None,
         score_threshold: Optional[float] = None,
         dynamic_score_percentage: Optional[float] = None,
@@ -141,7 +147,8 @@ def search_inside_collection(
         search_data = self._connection.post(
             path=f"{ApiPath.collection}/{collection_id}/{ApiPath.search}",
             data={
-                "index_type": SearchType.semantic,
+                "search_type": search_type,
+                "index_type": index_type,
                 "query": query,
                 "score_threshold": score_threshold
                 or SemanticSearchDefaultValues.score_threshold,
@@ -162,6 +169,8 @@ def search_inside_video(
         self,
         video_id: str,
         query: str,
+        search_type: str,
+        index_type: str,
         result_threshold: Optional[int] = None,
         score_threshold: Optional[float] = None,
         dynamic_score_percentage: Optional[float] = None,
@@ -170,7 +179,8 @@ def search_inside_video(
         search_data = self._connection.post(
             path=f"{ApiPath.video}/{video_id}/{ApiPath.search}",
             data={
-                "index_type": SearchType.keyword,
+                "search_type": search_type,
+                "index_type": index_type,
                 "query": query,
                 "score_threshold": score_threshold,
                 "result_threshold": result_threshold,
@@ -190,6 +200,8 @@ def search_inside_video(
         self,
         video_id: str,
         query: str,
+        search_type: str,
+        index_type: str,
         result_threshold: Optional[int] = None,
         score_threshold: Optional[float] = None,
         dynamic_score_percentage: Optional[float] = None,
@@ -198,7 +210,8 @@ def search_inside_video(
         search_data = self._connection.post(
             path=f"{ApiPath.video}/{video_id}/{ApiPath.search}",
             data={
-                "index_type": SearchType.scene,
+                "search_type": search_type,
+                "index_type": IndexType.scene,
                 "query": query,
                 "score_threshold": score_threshold,
                 "result_threshold": result_threshold,

videodb/video.py

@@ -49,6 +49,7 @@ def search(
         self,
         query: str,
         search_type: Optional[str] = SearchType.semantic,
+        index_type: Optional[str] = IndexType.spoken,
         result_threshold: Optional[int] = None,
         score_threshold: Optional[float] = None,
         dynamic_score_percentage: Optional[float] = None,
@@ -58,6 +59,8 @@ def search(
         return search.search_inside_video(
             video_id=self.id,
             query=query,
+            search_type=search_type,
+            index_type=index_type,
             result_threshold=result_threshold,
             score_threshold=score_threshold,
             dynamic_score_percentage=dynamic_score_percentage,
@@ -152,7 +155,7 @@ def index_spoken_words(
         self._connection.post(
             path=f"{ApiPath.video}/{self.id}/{ApiPath.index}",
             data={
-                "index_type": IndexType.semantic,
+                "index_type": IndexType.spoken,
                 "language_code": language_code,
                 "force": force,
                 "callback_url": callback_url,
@@ -207,11 +210,11 @@ def _format_scene_collection(self, scene_collection_data: dict) -> SceneCollecti
 
     def extract_scenes(
         self,
-        extraction_type: SceneExtractionType = SceneExtractionType.scene_based,
+        extraction_type: SceneExtractionType = SceneExtractionType.shot_based,
         extraction_config: dict = {},
         force: bool = False,
         callback_url: str = None,
-    ):
+    ) -> Optional[SceneCollection]:
         scenes_data = self._connection.post(
             path=f"{ApiPath.video}/{self.id}/{ApiPath.scenes}",
             data={
@@ -225,10 +228,14 @@ def extract_scenes(
             return None
         return self._format_scene_collection(scenes_data.get("scene_collection"))
 
-    def get_scene_collection(self, collection_id: str):
+    def get_scene_collection(self, collection_id: str) -> Optional[SceneCollection]:
+        if not collection_id:
+            raise ValueError("collection_id is required")
         scenes_data = self._connection.get(
             path=f"{ApiPath.video}/{self.id}/{ApiPath.scenes}/{collection_id}"
         )
+        if not scenes_data:
+            return None
         return self._format_scene_collection(scenes_data.get("scene_collection"))
 
     def list_scene_collection(self):
@@ -238,13 +245,15 @@ def list_scene_collection(self):
         return scene_collections_data.get("scene_collections", [])
 
     def delete_scene_collection(self, collection_id: str) -> None:
+        if not collection_id:
+            raise ValueError("collection_id is required")
         self._connection.delete(
             path=f"{ApiPath.video}/{self.id}/{ApiPath.scenes}/{collection_id}"
         )
 
     def index_scenes(
         self,
-        extraction_type: SceneExtractionType = SceneExtractionType.scene_based,
+        extraction_type: SceneExtractionType = SceneExtractionType.shot_based,
         extraction_config: Dict = {},
         prompt: Optional[str] = None,
         model: Optional[str] = None,
@@ -253,7 +262,7 @@ def index_scenes(
         scenes: Optional[List[Scene]] = None,
         force: Optional[bool] = False,
         callback_url: Optional[str] = None,
-    ) -> Optional[List]:
+    ) -> Optional[str]:
         scenes_data = self._connection.post(
             path=f"{ApiPath.video}/{self.id}/{ApiPath.index}/{ApiPath.scene}",
             data={
@@ -270,7 +279,7 @@ def index_scenes(
         )
         if not scenes_data:
             return None
-        return scenes_data.get("scene_index_records", [])
+        return scenes_data.get("scene_index_id")
 
     def list_scene_index(self) -> List:
         index_data = self._connection.get(
@@ -287,6 +296,8 @@ def get_scene_index(self, scene_index_id: str) -> Optional[List]:
         return index_data.get("scene_index_records", [])
 
     def delete_scene_index(self, scene_index_id: str) -> None:
+        if not scene_index_id:
+            raise ValueError("scene_index_id is required")
         self._connection.delete(
             path=f"{ApiPath.video}/{self.id}/{ApiPath.index}/{ApiPath.scene}/{scene_index_id}"
         )