use session_tag nomenclature

Author: tylerhutcherson

redisvl/extensions/llmcache/semantic.py

@@ -13,7 +13,7 @@
 class SemanticCache(BaseLLMCache):
     """Semantic Cache for Large Language Models."""
 
-    entry_id_field_name: str = "id"
+    entry_id_field_name: str = "_id"
     prompt_field_name: str = "prompt"
     vector_field_name: str = "prompt_vector"
     response_field_name: str = "response"

redisvl/extensions/session_manager/base_session.py

@@ -7,7 +7,7 @@
 
 
 class BaseSessionManager:
-    id_field_name: str = "id_field"
+    id_field_name: str = "_id"
     role_field_name: str = "role"
     content_field_name: str = "content"
     tool_field_name: str = "tool_call_id"
@@ -61,7 +61,7 @@ def get_recent(
         top_k: int = 5,
         as_text: bool = False,
         raw: bool = False,
-        tag_filter: Optional[FilterExpression] = None,
+        session_tag: Optional[str] = None,
     ) -> Union[List[str], List[Dict[str, str]]]:
         """Retreive the recent conversation history in sequential order.
 
@@ -72,8 +72,8 @@ def get_recent(
                 or list of alternating prompts and responses.
             raw (bool): Whether to return the full Redis hash entry or just the
                 prompt and response
-            tag_filter (Optional[FilterExpression]) : The tag filter to filter
-                results by. Default is None and all sessions are searched.
+            session_tag (str): Tag to be added to entries to link to a specific
+                session. Defaults to instance uuid.
 
         Returns:
             Union[str, List[str]]: A single string transcription of the session

redisvl/extensions/session_manager/semantic_session.py

@@ -64,7 +64,7 @@ def __init__(
 
         Args:
             name (str): The name of the session manager index.
-            session_tag (str): Tag to be added to entries to link to a specific
+            session_tag (Optional[str]): Tag to be added to entries to link to a specific
                 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.
@@ -105,7 +105,7 @@ def __init__(
 
         self._index.create(overwrite=False)
 
-        self._default_tag_filter = Tag(self.session_field_name) == self._session_tag
+        self._default_session_filter = Tag(self.session_field_name) == self._session_tag
 
     def clear(self) -> None:
         """Clears the chat session history."""
@@ -115,24 +115,23 @@ def delete(self) -> None:
         """Clear all conversation keys and remove the search index."""
         self._index.delete(drop=True)
 
-    def drop(self, id_field: Optional[str] = None) -> None:
+    def drop(self, id: Optional[str] = None) -> None:
         """Remove a specific exchange from the conversation history.
 
         Args:
-            id_field (Optional[str]): The id_field of the entry to delete.
+            id (Optional[str]): The id of the session entry to delete.
                 If None then the last entry is deleted.
         """
-        if id_field:
-            sep = self._index.key_separator
-            key = sep.join([self._index.schema.index.name, id_field])
-        else:
-            key = self.get_recent(top_k=1, raw=True)[0]["id"]  # type: ignore
-        self._index.client.delete(key)  # type: ignore
+        if id is None:
+            id = self.get_recent(top_k=1, raw=True)[0][self.id_field_name]  # type: ignore
+
+        self._index.client.delete(self._index.key(id))  # type: ignore
 
     @property
     def messages(self) -> Union[List[str], List[Dict[str, str]]]:
         """Returns the full chat history."""
         # TODO raw or as_text?
+        # TODO refactor method to use get_recent and support other session tags
         return_fields = [
             self.id_field_name,
             self.session_field_name,
@@ -143,7 +142,7 @@ def messages(self) -> Union[List[str], List[Dict[str, str]]]:
         ]
 
         query = FilterQuery(
-            filter_expression=self._default_tag_filter,
+            filter_expression=self._default_session_filter,
             return_fields=return_fields,
         )
 
@@ -159,7 +158,7 @@ def get_relevant(
         as_text: bool = False,
         top_k: int = 5,
         fall_back: bool = False,
-        tag_filter: Optional[FilterExpression] = None,
+        session_tag: Optional[str] = None,
         raw: bool = False,
     ) -> Union[List[str], List[Dict[str, str]]]:
         """Searches the chat history for information semantically related to
@@ -177,8 +176,8 @@ def get_relevant(
             top_k (int): The number of previous messages to return. Default is 5.
             fallback (bool): Whether to drop back to recent conversation history
                 if no relevant context is found.
-            tag_filter (Optional[FilterExpression]): The tag filter to filter results
-                by. Defaults to None and all messages will be searched.
+            session_tag (Optional[str]): Tag to be added to entries to link to a specific
+                session. Defaults to instance uuid.
             raw (bool): Whether to return the full Redis hash entry or just the
                 message.
 
@@ -202,14 +201,20 @@ def get_relevant(
             self.vector_field_name,
         ]
 
+        session_filter = (
+            Tag(self.session_field_name) == session_tag
+            if session_tag
+            else self._default_session_filter
+        )
+
         query = RangeQuery(
             vector=self._vectorizer.embed(prompt),
             vector_field_name=self.vector_field_name,
             return_fields=return_fields,
             distance_threshold=self._distance_threshold,
             num_results=top_k,
             return_score=True,
-            filter_expression=tag_filter or self._default_tag_filter,
+            filter_expression=session_filter,
         )
         hits = self._index.query(query)
 
@@ -225,7 +230,7 @@ def get_recent(
         top_k: int = 5,
         as_text: bool = False,
         raw: bool = False,
-        tag_filter: Optional[FilterExpression] = None,
+        session_tag: Optional[str] = None,
     ) -> Union[List[str], List[Dict[str, str]]]:
         """Retreive the recent conversation history in sequential order.
 
@@ -235,8 +240,8 @@ def get_recent(
                 or list of alternating prompts and responses.
             raw (bool): Whether to return the full Redis hash entry or just the
                 prompt and response
-            tag_filter (Optional[FilterExpression]): The tag filter to filter
-                results by. Defaults to None and all messages will be searched.
+            session_tag (Optional[str]): Tag to be added to entries to link to a specific
+                session. Defaults to instance uuid.
 
         Returns:
             Union[str, List[str]]: A single string transcription of the session
@@ -257,8 +262,14 @@ def get_recent(
             self.timestamp_field_name,
         ]
 
+        session_filter = (
+            Tag(self.session_field_name) == session_tag
+            if session_tag
+            else self._default_session_filter
+        )
+
         query = FilterQuery(
-            filter_expression=tag_filter or self._default_tag_filter,
+            filter_expression=session_filter,
             return_fields=return_fields,
             num_results=top_k,
         )
@@ -288,6 +299,8 @@ def store(
         Args:
             prompt (str): The user prompt to the LLM.
             response (str): The corresponding LLM response.
+            session_tag (Optional[str]): Tag to be added to entries to link to a specific
+                session. Defaults to instance uuid.
         """
         self.add_messages(
             [
@@ -306,6 +319,8 @@ def add_messages(
 
         Args:
             messages (List[Dict[str, str]]): The list of user prompts and LLM responses.
+            session_tag (Optional[str]): Tag to be added to entries to link to a specific
+                session. Defaults to instance uuid.
         """
         sep = self._index.key_separator
         session_tag = session_tag or self._session_tag
@@ -337,5 +352,7 @@ def add_message(
 
         Args:
             message (Dict[str,str]): The user prompt or LLM response.
+            session_tag (Optional[str]): Tag to be added to entries to link to a specific
+                session. Defaults to instance uuid.
         """
         self.add_messages([message], session_tag)

redisvl/extensions/session_manager/standard_session.py

@@ -6,7 +6,7 @@
 from redisvl.extensions.session_manager import BaseSessionManager
 from redisvl.index import SearchIndex
 from redisvl.query import FilterQuery
-from redisvl.query.filter import FilterExpression, Tag
+from redisvl.query.filter import Tag
 from redisvl.schema.schema import IndexSchema
 
 
@@ -29,7 +29,6 @@ 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,
@@ -51,7 +50,7 @@ def __init__(
         Args:
             name (str): The name of the session manager index.
             session_tag (Optional[str]): Tag to be added to entries to link to a specific
-                session.
+                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.
             redis_client (Optional[Redis]): A Redis client instance. Defaults to
@@ -69,28 +68,17 @@ def __init__(
         prefix = prefix or name
 
         schema = StandardSessionIndexSchema.from_params(name, prefix)
-        self._index = SearchIndex(schema=schema)
-        if redis_client:
-            self._index.set_client(redis_client)
-        else:
-            self._index.connect(redis_url=redis_url)
 
-        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._index.set_client(redis_client)
-        elif redis_url:
-            self._index.connect(redis_url=redis_url, **connection_kwargs)
+        else:
+            self._index.connect(redis_url=redis_url)
 
         self._index.create(overwrite=False)
 
-        self._default_tag_filter = Tag(self.session_field_name) == self._session_tag
+        self._default_session_filter = Tag(self.session_field_name) == self._session_tag
 
     def clear(self) -> None:
         """Clears the chat session history."""
@@ -100,24 +88,23 @@ def delete(self) -> None:
         """Clear all conversation keys and remove the search index."""
         self._index.delete(drop=True)
 
-    def drop(self, id_field: Optional[str] = None) -> None:
+    def drop(self, id: Optional[str] = None) -> None:
         """Remove a specific exchange from the conversation history.
 
         Args:
-            id_field (Optional[str]): The id_field of the entry to delete.
+            id (Optional[str]): The id of the session entry to delete.
                 If None then the last entry is deleted.
         """
-        if id_field:
-            sep = self._index.key_separator
-            key = sep.join([self._index.schema.index.name, id_field])
-        else:
-            key = self.get_recent(top_k=1, raw=True)[0]["id"]  # type: ignore
-        self._index.client.delete(key)  # type: ignore
+        if id is None:
+            id = self.get_recent(top_k=1, raw=True)[0][self.id_field_name]  # type: ignore
+
+        self._index.client.delete(self._index.key(id))  # type: ignore
 
     @property
     def messages(self) -> Union[List[str], List[Dict[str, str]]]:
         """Returns the full chat history."""
         # TODO raw or as_text?
+        # TODO refactor this method to use get_recent and support other session tags?
         return_fields = [
             self.id_field_name,
             self.session_field_name,
@@ -128,7 +115,7 @@ def messages(self) -> Union[List[str], List[Dict[str, str]]]:
         ]
 
         query = FilterQuery(
-            filter_expression=self._default_tag_filter,
+            filter_expression=self._default_session_filter,
             return_fields=return_fields,
         )
 
@@ -143,7 +130,7 @@ def get_recent(
         top_k: int = 5,
         as_text: bool = False,
         raw: bool = False,
-        tag_filter: Optional[FilterExpression] = None,
+        session_tag: Optional[str] = None,
     ) -> Union[List[str], List[Dict[str, str]]]:
         """Retreive the recent conversation history in sequential order.
 
@@ -153,8 +140,8 @@ def get_recent(
                 or list of alternating prompts and responses.
             raw (bool): Whether to return the full Redis hash entry or just the
                 prompt and response
-            tag_filter (Optional[FilterExpression]) : The tag filter to filter
-                results by. Default is None and all sessions are searched.
+            session_tag (Optional[str]): Tag to be added to entries to link to a specific
+                session. Defaults to instance uuid.
 
         Returns:
             Union[str, List[str]]: A single string transcription of the session
@@ -175,8 +162,14 @@ def get_recent(
             self.timestamp_field_name,
         ]
 
+        session_filter = (
+            Tag(self.session_field_name) == session_tag
+            if session_tag
+            else self._default_session_filter
+        )
+
         query = FilterQuery(
-            filter_expression=tag_filter or self._default_tag_filter,
+            filter_expression=session_filter,
             return_fields=return_fields,
             num_results=top_k,
         )
@@ -199,7 +192,8 @@ def store(
         Args:
             prompt (str): The user prompt to the LLM.
             response (str): The corresponding LLM response.
-            session_tag (Optional[str]): The tag to mark the message with. Defaults to None.
+            session_tag (Optional[str]): Tag to be added to entries to link to a specific
+                session. Defaults to instance uuid.
         """
         self.add_messages(
             [
@@ -218,7 +212,8 @@ def add_messages(
 
         Args:
             messages (List[Dict[str, str]]): The list of user prompts and LLM responses.
-            session_tag (Optional[str]): The tag to mark the messages with. Defaults to None.
+            session_tag (Optional[str]): Tag to be added to entries to link to a specific
+                session. Defaults to instance uuid.
         """
         sep = self._index.key_separator
         session_tag = session_tag or self._session_tag
@@ -249,6 +244,7 @@ def add_message(
 
         Args:
             message (Dict[str,str]): The user prompt or LLM response.
-            session_tag (Optional[str]): The tag to mark the message with. Defaults to None.
+            session_tag (Optional[str]): Tag to be added to entries to link to a specific
+                session. Defaults to instance uuid.
         """
         self.add_messages([message], session_tag)