Release 0 5 0

tests/test_search_legacy_routing.py

@@ -0,0 +1,70 @@
+import warnings
+
+from videodb.collection import Collection
+from videodb.video import Video
+import videodb.search as search_module
+
+
+class FakeConnection:
+    def __init__(self, response=None):
+        self.posts = []
+        self.response = response or {"results": []}
+
+    def post(self, path, data=None, **kwargs):
+        self.posts.append({"path": path, "data": data or {}, "kwargs": kwargs})
+        return self.response
+
+
+def setup_function():
+    search_module._RESPONSE_WARNING_EMITTED.clear()
+
+
+def test_video_search_routes_stitch_rerank_options_to_legacy_endpoint_without_local_warning():
+    conn = FakeConnection()
+    video = Video(conn, id="video-1", collection_id="collection-1")
+
+    with warnings.catch_warnings(record=True) as emitted:
+        warnings.simplefilter("always")
+        result = video.search(
+            "find moments",
+            stitch=False,
+            rerank=True,
+            rerank_params={"top_k": 3},
+        )
+
+    assert len(emitted) == 0
+    assert result.warnings == []
+    assert len(conn.posts) == 1
+    assert conn.posts[0]["path"] == "video/video-1/search"
+    assert conn.posts[0]["data"]["stitch"] is False
+    assert conn.posts[0]["data"]["rerank"] is True
+    assert conn.posts[0]["data"]["rerank_params"] == {"top_k": 3}
+
+
+def test_collection_search_routes_stitch_rerank_options_to_legacy_endpoint():
+    conn = FakeConnection()
+    collection = Collection(conn, id="collection-1")
+
+    collection.search(
+        "find moments",
+        stitch=False,
+        rerank=True,
+        rerank_params={"rank_fields": ["text"]},
+    )
+
+    assert len(conn.posts) == 1
+    assert conn.posts[0]["path"] == "collection/collection-1/search"
+    assert conn.posts[0]["data"]["stitch"] is False
+    assert conn.posts[0]["data"]["rerank"] is True
+    assert conn.posts[0]["data"]["rerank_params"] == {"rank_fields": ["text"]}
+
+
+def test_video_search_still_routes_to_v2_when_no_legacy_params_are_present():
+    conn = FakeConnection({"response_type": "shots", "results": []})
+    video = Video(conn, id="video-1", collection_id="collection-1")
+
+    video.search("find moments")
+
+    assert len(conn.posts) == 1
+    assert conn.posts[0]["path"] == "video/video-1/search/v2"
+    assert conn.posts[0]["data"] == {"query": "find moments"}

videodb/__about__.py

@@ -2,7 +2,7 @@
 
 
 
-__version__ = "0.4.5"
+__version__ = "0.5.0"
 __title__ = "videodb"
 __author__ = "videodb"
 __email__ = "contact@videodb.io"

videodb/__init__.py

@@ -8,6 +8,8 @@
 from videodb._constants import (
     VIDEO_DB_API,
     IndexType,
+    IndexCapability,
+    FieldGroup,
     SceneExtractionType,
     MediaType,
     SearchType,
@@ -25,6 +27,8 @@
     RTStreamChannelType,
 )
 from videodb.client import Connection
+from videodb.search import AskResponse, SearchResponse, SearchResult
+from videodb.understanding import Understanding, UnderstandingAnalyzer
 from videodb.capture_session import CaptureSession
 from videodb.websocket_client import WebSocketConnection
 from videodb.capture import CaptureClient, Channel, AudioChannel, VideoChannel, Channels, ChannelList
@@ -53,7 +57,14 @@
     "AuthenticationError",
     "InvalidRequestError",
     "IndexType",
+    "IndexCapability",
+    "FieldGroup",
     "SearchError",
+    "SearchResult",
+    "SearchResponse",
+    "AskResponse",
+    "Understanding",
+    "UnderstandingAnalyzer",
     "play_stream",
     "build_iframe_embed_code",
     "MediaType",

videodb/_constants.py

@@ -36,6 +36,23 @@ class IndexType:
     scene = "scene"
 
 
+class IndexCapability:
+    """Retrieval capabilities an index can be built for (``use_for``)."""
+
+    semantic = "semantic"
+    query = "query"
+    aggregate = "aggregate"
+
+
+class FieldGroup:
+    """Field groups that map artifact fields to retrieval capabilities."""
+
+    semantic = "semantic"
+    filter = "filter"
+    aggregate = "aggregate"
+    sort = "sort"
+
+
 class SceneExtractionType:
     shot_based = "shot"
     time_based = "time"
@@ -80,7 +97,14 @@ class ApiPath:
     upload_url = "upload_url"
     transcription = "transcription"
     index = "index"
+    indexes = "indexes"
+    records = "records"
+    understand = "understand"
     search = "search"
+    ask = "ask"
+    semantic_search = "semantic-search"
+    query = "query"
+    aggregate = "aggregate"
     compile = "compile"
     workflow = "workflow"
     timeline = "timeline"
@@ -123,6 +147,11 @@ class Status:
     in_progress = "in progress"
 
 
+INDEX_TERMINAL_STATUSES = {"ready", "failed"}
+UNDERSTANDING_TERMINAL_STATUSES = {"done", "failed"}
+ANALYZER_TERMINAL_STATUSES = {"done", "failed", "skipped", "cancelled"}
+
+
 class MeetingStatus:
     initializing = "initializing"
     processing = "processing"