Simplify version validation

Author: Nitin Kanukolanu

docs/user_guide/01_getting_started.ipynb

@@ -761,7 +761,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": ".venv",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
   },
@@ -775,10 +775,9 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.13.2"
-  },
-  "orig_nbformat": 4
+   "version": "3.12.6"
+  }
  },
  "nbformat": 4,
- "nbformat_minor": 2
+ "nbformat_minor": 4
 }

docs/user_guide/index.md

@@ -22,3 +22,4 @@ User guides provide helpful resources for using RedisVL and its different compon
 07_message_history
 08_semantic_router
 ```
+# TODO: Nitin Add the new user guide for SVS-VAMANA

redisvl/exceptions.py

@@ -37,21 +37,17 @@ class RedisModuleVersionError(RedisVLError):
     """Error when Redis or module versions are incompatible with requested features."""
 
     @classmethod
-    def for_svs_vamana(cls, capabilities, min_redis_version: str):
+    def for_svs_vamana(cls, min_redis_version: str):
         """Create error for unsupported SVS-VAMANA.
 
         Args:
-            capabilities: VectorSupport instance with version info
             min_redis_version: Minimum required Redis version
 
         Returns:
             RedisModuleVersionError with formatted message
         """
         message = (
             f"SVS-VAMANA requires Redis >= {min_redis_version} with RediSearch >= 2.8.10. "
-            f"Current: Redis {capabilities.redis_version}, "
-            f"RediSearch {capabilities.search_version_str}, "
-            f"SearchLight {capabilities.searchlight_version_str}. "
             f"Options: 1) Upgrade Redis Stack, "
             f"2) Use algorithm='hnsw' or 'flat', "
             f"3) Remove compression parameters"

redisvl/index/index.py

@@ -83,9 +83,9 @@
 from redisvl.query.filter import FilterExpression
 from redisvl.redis.connection import (
     RedisConnectionFactory,
-    check_vector_capabilities,
-    check_vector_capabilities_async,
     convert_index_info_to_schema,
+    supports_svs,
+    supports_svs_async,
 )
 from redisvl.redis.constants import SVS_MIN_REDIS_VERSION
 from redisvl.schema import IndexSchema, StorageType
@@ -552,10 +552,8 @@ def _check_svs_support(self) -> None:
         Raises:
             RedisModuleVersionError: If SVS-VAMANA requirements are not met.
         """
-        caps = check_vector_capabilities(self._redis_client)
-
-        if not caps.svs_vamana_supported:
-            raise RedisModuleVersionError.for_svs_vamana(caps, SVS_MIN_REDIS_VERSION)
+        if not supports_svs(self._redis_client):
+            raise RedisModuleVersionError.for_svs_vamana(SVS_MIN_REDIS_VERSION)
 
     def create(self, overwrite: bool = False, drop: bool = False) -> None:
         """Create an index in Redis with the current schema and properties.
@@ -1335,10 +1333,8 @@ async def _check_svs_support_async(self) -> None:
             RedisModuleVersionError: If SVS-VAMANA requirements are not met.
         """
         client = await self._get_client()
-        caps = await check_vector_capabilities_async(client)
-
-        if not caps.svs_vamana_supported:
-            raise RedisModuleVersionError.for_svs_vamana(caps, SVS_MIN_REDIS_VERSION)
+        if not await supports_svs_async(client):
+            raise RedisModuleVersionError.for_svs_vamana(SVS_MIN_REDIS_VERSION)
 
     async def create(self, overwrite: bool = False, drop: bool = False) -> None:
         """Asynchronously create an index in Redis with the current schema

redisvl/redis/connection.py

@@ -19,7 +19,7 @@
 from redisvl.redis.constants import (
     REDIS_URL_ENV_VAR,
     SVS_MIN_REDIS_VERSION,
-    SVS_REQUIRED_MODULES,
+    SVS_MIN_SEARCH_VERSION,
 )
 from redisvl.redis.utils import convert_bytes, is_cluster_url
 from redisvl.types import AsyncRedisClient, RedisClient, SyncRedisClient
@@ -72,16 +72,16 @@ def _strip_cluster_from_url_and_kwargs(
     return cleaned_url, cleaned_kwargs
 
 
-def compare_versions(version1: str, version2: str):
+def is_version_gte(version1: str, version2: str) -> bool:
     """
-    Compare two Redis version strings numerically.
+    Check if version1 >= version2.
 
     Parameters:
-    version1 (str): The first version string (e.g., "7.2.4").
-    version2 (str): The second version string (e.g., "6.2.1").
+        version1 (str): The first version string (e.g., "7.2.4").
+        version2 (str): The second version string (e.g., "6.2.1").
 
     Returns:
-    int: -1 if version1 < version2, 0 if version1 == version2, 1 if version1 > version2.
+        bool: True if version1 >= version2, False otherwise.
     """
     v1_parts = list(map(int, version1.split(".")))
     v2_parts = list(map(int, version2.split(".")))
@@ -106,44 +106,14 @@ def unpack_redis_modules(module_list: List[Dict[str, Any]]) -> Dict[str, Any]:
     return {module["name"]: module["ver"] for module in module_list}
 
 
-@dataclass
-class VectorSupport:
-    """Redis server capabilities for vector operations."""
-
-    redis_version: str
-    search_version: int
-    searchlight_version: int
-    svs_vamana_supported: bool
-
-    @property
-    def search_version_str(self) -> str:
-        """Format search module version as string."""
-        return format_module_version(self.search_version)
-
-    @property
-    def searchlight_version_str(self) -> str:
-        """Format searchlight module version as string."""
-        return format_module_version(self.searchlight_version)
-
-
-def format_module_version(version: int) -> str:
-    """Format module version from integer (20810) to string (2.8.10)."""
-    if version == 0:
-        return "not installed"
-    major = version // 10000
-    minor = (version % 10000) // 100
-    patch = version % 100
-    return f"{major}.{minor}.{patch}"
-
-
-def check_vector_capabilities(client: SyncRedisClient) -> VectorSupport:
-    """Check Redis server capabilities for vector features.
+def supports_svs(client: SyncRedisClient) -> bool:
+    """Check if Redis server supports SVS-VAMANA.
 
     Args:
         client: Sync Redis client instance
 
     Returns:
-        VectorSupport with version info and supported features
+        True if SVS-VAMANA is supported, False otherwise
     """
     info = client.info("server")  # type: ignore[union-attr]
     redis_version = info.get("redis_version", "0.0.0")  # type: ignore[union-attr]
@@ -153,25 +123,26 @@ def check_vector_capabilities(client: SyncRedisClient) -> VectorSupport:
     searchlight_ver = modules.get("searchlight", 0)
 
     # Check if SVS-VAMANA requirements are met
-    redis_ok = compare_versions(redis_version, SVS_MIN_REDIS_VERSION)
-    modules_ok = search_ver >= 20810 or searchlight_ver >= 20810
-
-    return VectorSupport(
-        redis_version=redis_version,
-        search_version=search_ver,
-        searchlight_version=searchlight_ver,
-        svs_vamana_supported=redis_ok and modules_ok,
+    redis_ok = is_version_gte(redis_version, SVS_MIN_REDIS_VERSION)
+
+    # Check either search or searchlight module (only one is typically installed)
+    # RediSearch is the open-source module, SearchLight is the enterprise version
+    modules_ok = (
+        search_ver >= SVS_MIN_SEARCH_VERSION
+        or searchlight_ver >= SVS_MIN_SEARCH_VERSION
     )
 
+    return redis_ok and modules_ok
+
 
-async def check_vector_capabilities_async(client: AsyncRedisClient) -> VectorSupport:
-    """Async version of check_vector_capabilities.
+async def supports_svs_async(client: AsyncRedisClient) -> bool:
+    """Async version of _supports_svs.
 
     Args:
         client: Async Redis client instance
 
     Returns:
-        VectorSupport with version info and supported features
+        True if SVS-VAMANA is supported, False otherwise
     """
     info = await client.info("server")  # type: ignore[union-attr]
     redis_version = info.get("redis_version", "0.0.0")  # type: ignore[union-attr]
@@ -181,16 +152,17 @@ async def check_vector_capabilities_async(client: AsyncRedisClient) -> VectorSup
     searchlight_ver = modules.get("searchlight", 0)
 
     # Check if SVS-VAMANA requirements are met
-    redis_ok = compare_versions(redis_version, SVS_MIN_REDIS_VERSION)
-    modules_ok = search_ver >= 20810 or searchlight_ver >= 20810
-
-    return VectorSupport(
-        redis_version=redis_version,
-        search_version=search_ver,
-        searchlight_version=searchlight_ver,
-        svs_vamana_supported=redis_ok and modules_ok,
+    redis_ok = is_version_gte(redis_version, SVS_MIN_REDIS_VERSION)
+
+    # Check either search or searchlight module (only one is typically installed)
+    # RediSearch is the open-source module, SearchLight is the enterprise version
+    modules_ok = (
+        search_ver >= SVS_MIN_SEARCH_VERSION
+        or searchlight_ver >= SVS_MIN_SEARCH_VERSION
     )
 
+    return redis_ok and modules_ok
+
 
 def get_address_from_env() -> str:
     """Get Redis URL from environment variable."""

redisvl/redis/constants.py

@@ -12,6 +12,8 @@
 
 # Minimum Redis version for SVS-VAMANA
 SVS_MIN_REDIS_VERSION = "8.2.0"
+# Minimum search module version for SVS-VAMANA (2.8.10)
+SVS_MIN_SEARCH_VERSION = 20810
 
 # default tag separator
 REDIS_TAG_SEPARATOR = ","

redisvl/utils/migration.py

@@ -10,7 +10,8 @@
 from typing import TYPE_CHECKING, Any, Callable, Dict, List, Optional, Union
 
 from redisvl.exceptions import RedisModuleVersionError
-from redisvl.redis.connection import check_vector_capabilities
+from redisvl.redis.connection import supports_svs
+from redisvl.redis.constants import SVS_MIN_REDIS_VERSION
 from redisvl.schema import IndexSchema
 from redisvl.utils.compression import CompressionAdvisor
 from redisvl.utils.log import get_logger
@@ -101,11 +102,8 @@ def progress(current, total):
         from redisvl.query.filter import FilterExpression
 
         # Check SVS-VAMANA support
-        caps = check_vector_capabilities(old_index._redis_client)
-        if not caps.svs_vamana_supported:
-            raise RedisModuleVersionError.for_svs_vamana(
-                caps.redis_version, caps.search_version
-            )
+        if not supports_svs(old_index._redis_client):
+            raise RedisModuleVersionError.for_svs_vamana(SVS_MIN_REDIS_VERSION)
 
         # Find vector fields in the old schema
         vector_fields = [
@@ -294,15 +292,12 @@ async def progress(current, total):
         from redisvl.index import AsyncSearchIndex
         from redisvl.query import FilterQuery
         from redisvl.query.filter import FilterExpression
-        from redisvl.redis.connection import check_vector_capabilities_async
+        from redisvl.redis.connection import supports_svs_async
 
         # Check SVS-VAMANA support
         client = await old_index._get_client()
-        caps = await check_vector_capabilities_async(client)
-        if not caps.svs_vamana_supported:
-            raise RedisModuleVersionError.for_svs_vamana(
-                caps.redis_version, caps.search_version
-            )
+        if not await supports_svs_async(client):
+            raise RedisModuleVersionError.for_svs_vamana(SVS_MIN_REDIS_VERSION)
 
         # Find vector fields
         vector_fields = [

tests/conftest.py

@@ -7,7 +7,7 @@
 from testcontainers.compose import DockerCompose
 
 from redisvl.index.index import AsyncSearchIndex, SearchIndex
-from redisvl.redis.connection import RedisConnectionFactory, compare_versions
+from redisvl.redis.connection import RedisConnectionFactory, is_version_gte
 from redisvl.redis.utils import array_to_buffer
 from redisvl.utils.vectorize import HFTextVectorizer
 
@@ -609,7 +609,7 @@ def skip_if_redis_version_below(client, min_version: str, message: str = None):
         message: Custom skip message
     """
     redis_version = get_redis_version(client)
-    if not compare_versions(redis_version, min_version):
+    if not is_version_gte(redis_version, min_version):
         skip_msg = message or f"Redis version {redis_version} < {min_version} required"
         pytest.skip(skip_msg)
 
@@ -626,7 +626,7 @@ async def skip_if_redis_version_below_async(
         message: Custom skip message
     """
     redis_version = await get_redis_version_async(client)
-    if not compare_versions(redis_version, min_version):
+    if not is_version_gte(redis_version, min_version):
         skip_msg = message or f"Redis version {redis_version} < {min_version} required"
         pytest.skip(skip_msg)
 

tests/integration/test_semantic_router.py

@@ -11,7 +11,7 @@
     Route,
     RoutingConfig,
 )
-from redisvl.redis.connection import compare_versions
+from redisvl.redis.connection import is_version_gte
 from tests.conftest import skip_if_no_redisearch, skip_if_redis_version_below
 
 
@@ -159,7 +159,7 @@ def test_add_route(semantic_router):
     assert "political speech" in route.references
 
     redis_version = semantic_router._index.client.info()["redis_version"]
-    if compare_versions(redis_version, "7.0.0"):
+    if is_version_gte(redis_version, "7.0.0"):
         match = semantic_router("political speech")
         print(match, flush=True)
         assert match is not None

tests/integration/test_svs_integration.py

@@ -25,7 +25,7 @@
 from redisvl.exceptions import RedisModuleVersionError
 from redisvl.index import SearchIndex
 from redisvl.query import VectorQuery
-from redisvl.redis.connection import check_vector_capabilities
+from redisvl.redis.connection import supports_svs
 from redisvl.redis.utils import array_to_buffer
 from redisvl.schema import IndexSchema
 from redisvl.utils import CompressionAdvisor
@@ -138,13 +138,10 @@ class TestSVSCapabilityDetection:
 
     def test_check_svs_capabilities(self, client):
         """Test that SVS-VAMANA is supported on the test Redis instance."""
-        caps = check_vector_capabilities(client)
-
         # These tests require Redis 8.2+ with RediSearch 2.8.10+
-        assert caps.svs_vamana_supported is True, (
-            f"SVS-VAMANA not supported. "
-            f"Redis: {caps.redis_version}, "
-            f"RediSearch: {caps.search_version}"
+        assert supports_svs(client) is True, (
+            "SVS-VAMANA not supported. "
+            "Requires Redis >= 8.2.0 with RediSearch >= 2.8.10"
         )