update docs

Author: tylerhutcherson

docs/_static/js/sidebar.js

@@ -9,17 +9,22 @@ const toc = [
         { title: "Query and Filter", path: "/user_guide/hybrid_queries_02.html" },
         { title: "JSON vs Hash Storage", path: "/user_guide/hash_vs_json_05.html" },
         { title: "Vectorizers", path: "/user_guide/vectorizers_04.html" },
-        { title: "Rerankers", path: "/user_guide/rerankers_06.html"},
+        { title: "Rerankers", path: "/user_guide/rerankers_06.html" },
         { title: "Semantic Caching", path: "/user_guide/llmcache_03.html" },
     ]},
     { header: "API", toc: [
         { title: "Schema", path: "/api/schema.html"},
         { title: "Search Index", path: "/api/searchindex.html" },
         { title: "Query", path: "/api/query.html" },
         { title: "Filter", path: "/api/filter.html" },
+    ]},
+    { header: "Utils", toc: [
         { title: "Vectorizers", path: "/api/vectorizer.html" },
         { title: "Rerankers", path: "/api/reranker.html" },
-        { title: "LLMCache", path: "/api/cache.html" }
+    ]},
+    { header: "Extensions", toc: [
+        { title: "LLM Cache", path: "/api/cache.html" },
+        { title: "Semantic Router", path: "/api/router.html" },
     ]}
 ];
 

docs/api/cache.rst

@@ -1,7 +1,7 @@
 
-********
+*********
 LLM Cache
-********
+*********
 
 SemanticCache
 =============

docs/api/router.rst

@@ -1,31 +1,27 @@
 
-********
+***************
 Semantic Router
-********
+***************
 
 .. _semantic_router_api:
 
 
 Semantic Router
-=============
+===============
 
 .. currentmodule:: redisvl.extensions.router
 
 .. autoclass:: SemanticRouter
-   :show-inheritance:
    :members:
-   :inherited-members:
 
 
 Routing Config
-===============
+==============
 
 .. currentmodule:: redisvl.extensions.router
 
 .. autoclass:: RoutingConfig
-   :show-inheritance:
    :members:
-   :inherited-members:
 
 
 Route
@@ -34,6 +30,20 @@ Route
 .. currentmodule:: redisvl.extensions.router
 
 .. autoclass:: Route
-   :show-inheritance:
    :members:
-   :inherited-members:
+
+Route Match
+===========
+
+.. currentmodule:: redisvl.extensions.router.schema
+
+.. autoclass:: RouteMatch
+   :members:
+
+Distance Aggregation Method
+===========================
+
+.. currentmodule:: redisvl.extensions.router.schema
+
+.. autoclass:: DistanceAggregationMethod
+   :members:

redisvl/extensions/router/semantic.py

@@ -74,8 +74,8 @@ def __init__(
         self,
         name: str,
         routes: List[Route],
-        vectorizer: BaseVectorizer = HFTextVectorizer(),
-        routing_config: RoutingConfig = RoutingConfig(),
+        vectorizer: Optional[BaseVectorizer] = None,
+        routing_config: Optional[RoutingConfig] = None,
         redis_client: Optional[Redis] = None,
         redis_url: Optional[str] = None,
         overwrite: bool = False,
@@ -86,13 +86,20 @@ def __init__(
         Args:
             name (str): The name of the semantic router.
             routes (List[Route]): List of Route objects.
-            vectorizer (BaseVectorizer, optional): The vectorizer used to embed route references. Defaults to HFTextVectorizer().
-            routing_config (RoutingConfig, optional): Configuration for routing behavior. Defaults to RoutingConfig().
+            vectorizer (BaseVectorizer, optional): The vectorizer used to embed route references. Defaults to default HFTextVectorizer.
+            routing_config (RoutingConfig, optional): Configuration for routing behavior. Defaults to the default RoutingConfig.
             redis_client (Optional[Redis], optional): Redis client for connection. Defaults to None.
             redis_url (Optional[str], optional): Redis URL for connection. Defaults to None.
             overwrite (bool, optional): Whether to overwrite existing index. Defaults to False.
             **kwargs: Additional arguments.
         """
+        # Set vectorizer default
+        if vectorizer is None:
+            vectorizer = HFTextVectorizer()
+
+        if routing_config is None:
+            routing_config = RoutingConfig()
+
         super().__init__(
             name=name,
             routes=routes,