Merge branch 'main' into feat/RAAE-191/scopeless-sessions

Author: justin-cechmanek

docs/examples/openai_qna.ipynb

@@ -651,7 +651,7 @@
     "client = redis.Redis.from_url(\"redis://localhost:6379\")\n",
     "schema = IndexSchema.from_yaml(\"wiki_schema.yaml\")\n",
     "\n",
-    "index = AsyncSearchIndex(schema, client)\n",
+    "index = await AsyncSearchIndex(schema).set_client(client)\n",
     "\n",
     "await index.create()"
    ]

docs/user_guide/getting_started_01.ipynb

@@ -486,7 +486,7 @@
     "client = Redis.from_url(\"redis://localhost:6379\")\n",
     "\n",
     "index = AsyncSearchIndex.from_dict(schema)\n",
-    "index.set_client(client)"
+    "await index.set_client(client)"
    ]
   },
   {

redisvl/extensions/llmcache/semantic.py

@@ -28,7 +28,7 @@ def __init__(
         vectorizer: Optional[BaseVectorizer] = None,
         redis_client: Optional[Redis] = None,
         redis_url: str = "redis://localhost:6379",
-        connection_args: Dict[str, Any] = {},
+        connection_kwargs: Dict[str, Any] = {},
         **kwargs,
     ):
         """Semantic Cache for Large Language Models.
@@ -43,14 +43,13 @@ def __init__(
                 cache. Defaults to 0.1.
             ttl (Optional[int], optional): The time-to-live for records cached
                 in Redis. Defaults to None.
-            vectorizer (BaseVectorizer, optional): The vectorizer for the cache.
+            vectorizer (Optional[BaseVectorizer], optional): The vectorizer for the cache.
                 Defaults to HFTextVectorizer.
-            redis_client(Redis, optional): A redis client connection instance.
+            redis_client(Optional[Redis], optional): A redis client connection instance.
                 Defaults to None.
-            redis_url (str, optional): The redis url. Defaults to
-                "redis://localhost:6379".
-            connection_args (Dict[str, Any], optional): The connection arguments
-                for the redis client. Defaults to None.
+            redis_url (str, optional): The redis url. Defaults to redis://localhost:6379.
+            connection_kwargs (Dict[str, Any]): The connection arguments
+                for the redis client. Defaults to empty {}.
 
         Raises:
             TypeError: If an invalid vectorizer is provided.
@@ -96,8 +95,8 @@ def __init__(
         # handle redis connection
         if redis_client:
             self._index.set_client(redis_client)
-        else:
-            self._index.connect(redis_url=redis_url, **connection_args)
+        elif redis_url:
+            self._index.connect(redis_url=redis_url, **connection_kwargs)
 
         # initialize other components
         self.default_return_fields = [

redisvl/extensions/router/semantic.py

@@ -86,8 +86,9 @@ def __init__(
         vectorizer: Optional[BaseVectorizer] = None,
         routing_config: Optional[RoutingConfig] = None,
         redis_client: Optional[Redis] = None,
-        redis_url: Optional[str] = None,
+        redis_url: str = "redis://localhost:6379",
         overwrite: bool = False,
+        connection_kwargs: Dict[str, Any] = {},
         **kwargs,
     ):
         """Initialize the SemanticRouter.
@@ -98,9 +99,10 @@ def __init__(
             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.
+            redis_url (str, optional): The redis url. Defaults to redis://localhost:6379.
             overwrite (bool, optional): Whether to overwrite existing index. Defaults to False.
-            **kwargs: Additional arguments.
+            connection_kwargs (Dict[str, Any]): The connection arguments
+                for the redis client. Defaults to empty {}.
         """
         # Set vectorizer default
         if vectorizer is None:
@@ -115,12 +117,12 @@ def __init__(
             vectorizer=vectorizer,
             routing_config=routing_config,
         )
-        self._initialize_index(redis_client, redis_url, overwrite)
+        self._initialize_index(redis_client, redis_url, overwrite, **connection_kwargs)
 
     def _initialize_index(
         self,
         redis_client: Optional[Redis] = None,
-        redis_url: Optional[str] = None,
+        redis_url: str = "redis://localhost:6379",
         overwrite: bool = False,
         **connection_kwargs,
     ):
@@ -132,8 +134,6 @@ def _initialize_index(
             self._index.set_client(redis_client)
         elif redis_url:
             self._index.connect(redis_url=redis_url, **connection_kwargs)
-        else:
-            raise ValueError("Must provide either a redis client or redis url string.")
 
         existed = self._index.exists()
         self._index.create(overwrite=overwrite)
@@ -479,19 +479,12 @@ def clear(self) -> None:
     def from_dict(
         cls,
         data: Dict[str, Any],
-        redis_client: Optional[Redis] = None,
-        redis_url: Optional[str] = None,
-        overwrite: bool = False,
         **kwargs,
     ) -> "SemanticRouter":
         """Create a SemanticRouter from a dictionary.
 
         Args:
             data (Dict[str, Any]): The dictionary containing the semantic router data.
-            redis_client (Optional[Redis]): Redis client for connection.
-            redis_url (Optional[str]): Redis URL for connection.
-            overwrite (bool): Whether to overwrite existing index.
-            **kwargs: Additional arguments.
 
         Returns:
             SemanticRouter: The semantic router instance.
@@ -533,9 +526,6 @@ def from_dict(
             routes=routes,
             vectorizer=vectorizer,
             routing_config=routing_config,
-            redis_client=redis_client,
-            redis_url=redis_url,
-            overwrite=overwrite,
             **kwargs,
         )
 
@@ -565,19 +555,12 @@ def to_dict(self) -> Dict[str, Any]:
     def from_yaml(
         cls,
         file_path: str,
-        redis_client: Optional[Redis] = None,
-        redis_url: Optional[str] = None,
-        overwrite: bool = False,
         **kwargs,
     ) -> "SemanticRouter":
         """Create a SemanticRouter from a YAML file.
 
         Args:
             file_path (str): The path to the YAML file.
-            redis_client (Optional[Redis]): Redis client for connection.
-            redis_url (Optional[str]): Redis URL for connection.
-            overwrite (bool): Whether to overwrite existing index.
-            **kwargs: Additional arguments.
 
         Returns:
             SemanticRouter: The semantic router instance.
@@ -603,9 +586,6 @@ def from_yaml(
             yaml_data = yaml.safe_load(f)
             return cls.from_dict(
                 yaml_data,
-                redis_client=redis_client,
-                redis_url=redis_url,
-                overwrite=overwrite,
                 **kwargs,
             )
 

redisvl/extensions/session_manager/semantic_session.py

@@ -1,5 +1,5 @@
 from time import time
-from typing import Dict, List, Optional, Union
+from typing import Any, Dict, List, Optional, Union
 
 from redis import Redis
 
@@ -51,6 +51,8 @@ def __init__(
         distance_threshold: float = 0.3,
         redis_client: Optional[Redis] = None,
         redis_url: str = "redis://localhost:6379",
+        connection_kwargs: Dict[str, Any] = {},
+        **kwargs,
     ):
         """Initialize session memory with index
 
@@ -66,12 +68,14 @@ def __init__(
                 session. Defaults to instance uuid.
             prefix (Optional[str]): Prefix for the keys for this session data.
                 Defaults to None and will be replaced with the index name.
-            vectorizer (Vectorizer): The vectorizer to create embeddings with.
+            vectorizer (Optional[BaseVectorizer]): The vectorizer used to create embeddings.
             distance_threshold (float): The maximum semantic distance to be
                 included in the context. Defaults to 0.3.
             redis_client (Optional[Redis]): A Redis client instance. Defaults to
                 None.
-            redis_url (str): The URL of the Redis instance. Defaults to 'redis://localhost:6379'.
+            redis_url (str, optional): The redis url. Defaults to redis://localhost:6379.
+            connection_kwargs (Dict[str, Any]): The connection arguments
+                for the redis client. Defaults to empty {}.
 
         The proposed schema will support a single vector embedding constructed
         from either the prompt or response in a single string.
@@ -93,10 +97,11 @@ def __init__(
 
         self._index = SearchIndex(schema=schema)
 
+        # handle redis connection
         if redis_client:
             self._index.set_client(redis_client)
-        else:
-            self._index.connect(redis_url=redis_url)
+        elif redis_url:
+            self._index.connect(redis_url=redis_url, **connection_kwargs)
 
         self._index.create(overwrite=False)
 

redisvl/extensions/session_manager/standard_session.py

@@ -1,5 +1,5 @@
 from time import time
-from typing import Dict, List, Optional, Union
+from typing import Any, Dict, List, Optional, Union
 
 from redis import Redis
 
@@ -28,6 +28,8 @@ def from_params(cls, name: str, prefix: str):
 
 
 class StandardSessionManager(BaseSessionManager):
+    session_field_name: str = "session_tag"
+    user_field_name: str = "user_tag"
 
     def __init__(
         self,
@@ -36,6 +38,8 @@ def __init__(
         prefix: Optional[str] = None,
         redis_client: Optional[Redis] = None,
         redis_url: str = "redis://localhost:6379",
+        connection_kwargs: Dict[str, Any] = {},
+        **kwargs,
     ):
         """Initialize session memory
 
@@ -52,7 +56,9 @@ def __init__(
                 Defaults to None and will be replaced with the index name.
             redis_client (Optional[Redis]): A Redis client instance. Defaults to
                 None.
-            redis_url (str): The URL of the Redis instance. Defaults to 'redis://localhost:6379'.
+            redis_url (str, optional): The redis url. Defaults to redis://localhost:6379.
+            connection_kwargs (Dict[str, Any]): The connection arguments
+                for the redis client. Defaults to empty {}.
 
         The proposed schema will support a single combined vector embedding
         constructed from the prompt & response in a single string.
@@ -71,10 +77,18 @@ def __init__(
 
         self._index.create(overwrite=False)
 
+        prefix = prefix or name
+
+        schema = StandardSessionIndexSchema.from_params(name, prefix)
+        self._index = SearchIndex(schema=schema)
+
+        # handle redis connection
         if redis_client:
-            self._client = redis_client
-        else:
-            self._client = Redis.from_url(redis_url)
+            self._index.set_client(redis_client)
+        elif redis_url:
+            self._index.connect(redis_url=redis_url, **connection_kwargs)
+
+        self._index.create(overwrite=False)
 
         self._default_tag_filter = Tag(self.session_field_name) == self._session_tag