unique_toolkit 0.7.7__py3-none-any.whl → 1.23.0__py3-none-any.whl

unique_toolkit/short_term_memory/service.py

@@ -1,3 +1,5 @@
+from typing import overload
+
 from typing_extensions import deprecated
 
 from unique_toolkit._common.validate_required_values import validate_required_values
@@ -16,17 +18,35 @@ from .schemas import ShortTermMemory
 class ShortTermMemoryService:
     """
     Provides methods to manage short term memory.
+    """
+
+    @deprecated(
+        "Use __init__ with company_id and user_id instead or use the classmethod `from_event`"
+    )
+    @overload
+    def __init__(self, event: Event | ChatEvent | BaseEvent): ...
+
+    """
+        Initialize the ShortTermMemoryService with an event (deprecated)
+    """
+
+    @overload
+    def __init__(
+        self,
+        *,
+        company_id: str,
+        user_id: str,
+        chat_id: str | None,
+        message_id: str | None,
+    ): ...
 
-    Attributes:
-        user_id (str | None): The user ID.
-        company_id (str | None): The company ID.
-        chat_id (str | None): The chat ID.
-        message_id (str | None): The message ID.
+    """
+        Initialize the ShortTermMemoryService with a company_id, user_id, chat_id and message_id.
     """
 
     def __init__(
         self,
-        event: Event | BaseEvent | None = None,
+        event: Event | ChatEvent | BaseEvent | None = None,
         user_id: str | None = None,
         company_id: str | None = None,
         chat_id: str | None = None,
@@ -34,20 +54,33 @@ class ShortTermMemoryService:
     ):
         self._event = event
         if event:
-            self.company_id = event.company_id
-            self.user_id = event.user_id
+            self._company_id: str = event.company_id
+            self._user_id: str = event.user_id
             if isinstance(event, (ChatEvent, Event)):
-                self.chat_id = event.payload.chat_id
-                self.message_id = event.payload.user_message.id
+                self._chat_id = event.payload.chat_id
+                self._message_id = event.payload.user_message.id
         else:
             [company_id, user_id] = validate_required_values([company_id, user_id])
-            assert (
-                chat_id or message_id
-            ), "Either chat_id or message_id must be provided"
-            self.company_id = company_id
-            self.user_id = user_id
-            self.chat_id = chat_id
-            self.message_id = message_id
+
+            if not (chat_id or message_id):
+                raise ValueError("Chat_id or message_id must be provided")
+
+            self._company_id: str = company_id
+            self._user_id: str = user_id
+            self._chat_id: str | None = chat_id
+            self._message_id: str | None = message_id
+
+    @classmethod
+    def from_event(cls, event: ChatEvent):
+        """
+        Initialize the ShortTermMemoryService with a chat event.
+        """
+        return cls(
+            company_id=event.company_id,
+            user_id=event.user_id,
+            chat_id=event.payload.chat_id,
+            message_id=event.payload.user_message.id,
+        )
 
     @property
     @deprecated(
@@ -62,6 +95,110 @@ class ShortTermMemoryService:
         """
         return self._event
 
+    @property
+    @deprecated(
+        "The company_id property is deprecated and will be removed in a future version."
+    )
+    def company_id(self) -> str | None:
+        """
+        Get the company identifier (deprecated).
+
+        Returns:
+            str | None: The company identifier.
+        """
+        return self._company_id
+
+    @company_id.setter
+    @deprecated(
+        "The company_id setter is deprecated and will be removed in a future version."
+    )
+    def company_id(self, value: str) -> None:
+        """
+        Set the company identifier (deprecated).
+
+        Args:
+            value (str | None): The company identifier.
+        """
+        self._company_id = value
+
+    @property
+    @deprecated(
+        "The user_id property is deprecated and will be removed in a future version."
+    )
+    def user_id(self) -> str | None:
+        """
+        Get the user identifier (deprecated).
+
+        Returns:
+            str | None: The user identifier.
+        """
+        return self._user_id
+
+    @user_id.setter
+    @deprecated(
+        "The user_id setter is deprecated and will be removed in a future version."
+    )
+    def user_id(self, value: str) -> None:
+        """
+        Set the user identifier (deprecated).
+
+        Args:
+            value (str | None): The user identifier.
+        """
+        self._user_id = value
+
+    @property
+    @deprecated(
+        "The chat_id property is deprecated and will be removed in a future version."
+    )
+    def chat_id(self) -> str | None:
+        """
+        Get the chat identifier (deprecated).
+
+        Returns:
+            str | None: The chat identifier.
+        """
+        return self._chat_id
+
+    @chat_id.setter
+    @deprecated(
+        "The chat_id setter is deprecated and will be removed in a future version."
+    )
+    def chat_id(self, value: str | None) -> None:
+        """
+        Set the chat identifier (deprecated).
+
+        Args:
+            value (str | None): The chat identifier.
+        """
+        self._chat_id = value
+
+    @property
+    @deprecated(
+        "The message_id property is deprecated and will be removed in a future version."
+    )
+    def message_id(self) -> str | None:
+        """
+        Get the message identifier (deprecated).
+
+        Returns:
+            str | None: The message identifier.
+        """
+        return self._message_id
+
+    @message_id.setter
+    @deprecated(
+        "The message_id setter is deprecated and will be removed in a future version."
+    )
+    def message_id(self, value: str | None) -> None:
+        """
+        Set the message identifier (deprecated).
+
+        Args:
+            value (str | None): The message identifier.
+        """
+        self._message_id = value
+
     @classmethod
     @deprecated("Instantiate class directly from event")
     def from_chat_event(cls, chat_event: Event) -> "ShortTermMemoryService":
@@ -87,11 +224,11 @@ class ShortTermMemoryService:
         """
 
         return await find_latest_memory_async(
-            user_id=self.user_id,
-            company_id=self.company_id,
+            user_id=self._user_id,
+            company_id=self._company_id,
             key=key,
-            chat_id=self.chat_id,
-            message_id=self.message_id,
+            chat_id=self._chat_id,
+            message_id=self._message_id,
         )
 
     def find_latest_memory(self, key: str) -> ShortTermMemory:
@@ -109,11 +246,11 @@ class ShortTermMemoryService:
         """
 
         return find_latest_memory(
-            user_id=self.user_id,
-            company_id=self.company_id,
+            user_id=self._user_id,
+            company_id=self._company_id,
             key=key,
-            chat_id=self.chat_id,
-            message_id=self.message_id,
+            chat_id=self._chat_id,
+            message_id=self._message_id,
         )
 
     async def create_memory_async(self, key: str, value: str | dict):
@@ -132,12 +269,12 @@ class ShortTermMemoryService:
         """
 
         return await create_memory_async(
-            user_id=self.user_id,
-            company_id=self.company_id,
+            user_id=self._user_id,
+            company_id=self._company_id,
             key=key,
             value=value,
-            chat_id=self.chat_id,
-            message_id=self.message_id,
+            chat_id=self._chat_id,
+            message_id=self._message_id,
         )
 
     def create_memory(self, key: str, value: str | dict):
@@ -155,31 +292,31 @@ class ShortTermMemoryService:
         """
 
         return create_memory(
-            user_id=self.user_id,
-            company_id=self.company_id,
+            user_id=self._user_id,
+            company_id=self._company_id,
             key=key,
             value=value,
-            chat_id=self.chat_id,
-            message_id=self.message_id,
+            chat_id=self._chat_id,
+            message_id=self._message_id,
         )
 
     @deprecated("Use create_memory_async instead")
     async def set(self, key: str, value: str | dict):
         return await create_memory_async(
-            user_id=self.user_id,
-            company_id=self.company_id,
+            user_id=self._user_id,
+            company_id=self._company_id,
             key=key,
             value=value,
-            chat_id=self.chat_id,
-            message_id=self.message_id,
+            chat_id=self._chat_id,
+            message_id=self._message_id,
         )
 
     @deprecated("Use find_latest_memory_async instead")
     async def get(self, key: str) -> ShortTermMemory:
         return await find_latest_memory_async(
-            user_id=self.user_id,
-            company_id=self.company_id,
+            user_id=self._user_id,
+            company_id=self._company_id,
             key=key,
-            chat_id=self.chat_id,
-            message_id=self.message_id,
+            chat_id=self._chat_id,
+            message_id=self._message_id,
         )

unique_toolkit/smart_rules/compile.py

@@ -0,0 +1,56 @@
+import warnings
+
+from unique_toolkit.content.smart_rules import (
+    AndStatement,
+    BaseStatement,
+    Operator,
+    OrStatement,
+    Statement,
+    UniqueQL,
+    array_operator,
+    binary_operator,
+    calculate_current_date,
+    calculate_earlier_date,
+    calculate_later_date,
+    empty_operator,
+    eval_nested_operator,
+    eval_operator,
+    get_fallback_values,
+    is_array_of_strings,
+    null_operator,
+    parse_uniqueql,
+    replace_tool_parameters_patterns,
+    replace_user_metadata_patterns,
+    replace_variables,
+)
+
+warnings.warn(
+    "unique_toolkit.smart_rules.compile is deprecated. "
+    "Please use unique_toolkit.content.smart_rules instead.",
+    DeprecationWarning,
+    stacklevel=2,
+)
+
+__all__ = [
+    "AndStatement",
+    "BaseStatement",
+    "Operator",
+    "OrStatement",
+    "Statement",
+    "UniqueQL",
+    "array_operator",
+    "binary_operator",
+    "calculate_current_date",
+    "calculate_earlier_date",
+    "calculate_later_date",
+    "empty_operator",
+    "eval_nested_operator",
+    "eval_operator",
+    "get_fallback_values",
+    "is_array_of_strings",
+    "null_operator",
+    "parse_uniqueql",
+    "replace_tool_parameters_patterns",
+    "replace_user_metadata_patterns",
+    "replace_variables",
+]

unique_toolkit/test_utilities/events.py

@@ -0,0 +1,197 @@
+import random
+import string
+from datetime import datetime
+from typing import Any
+
+from unique_toolkit.app.schemas import (
+    BaseEvent,
+    ChatEvent,
+    ChatEventAdditionalParameters,
+    ChatEventAssistantMessage,
+    ChatEventPayload,
+    ChatEventUserMessage,
+    EventName,
+)
+from unique_toolkit.app.unique_settings import UniqueSettings
+
+
+def generated_numeric_string(length: int) -> str:
+    return "".join(random.choices(string.digits, k=length))
+
+
+def generated_alphanumeric_string(length: int) -> str:
+    return "".join(random.choices(string.ascii_letters + string.digits, k=length))
+
+
+def generated_chat_id() -> str:
+    return f"chat_{generated_alphanumeric_string(16)}"
+
+
+def generated_assistant_id() -> str:
+    return f"assistant_{generated_alphanumeric_string(16)}"
+
+
+def generated_user_message_id() -> str:
+    return f"msg_{generated_alphanumeric_string(16)}"
+
+
+class TestEventFactory:
+    """Factory for creating test event objects with sensible defaults.
+
+    Simplifies test setup by providing convenient methods to generate
+    chat events, messages, and related objects for testing.
+    """
+
+    def __init__(self, settings: UniqueSettings | None = None) -> None:
+        self._settings = settings
+
+    def _get_user_id(self) -> str:
+        if self._settings is None:
+            return generated_numeric_string(16)
+        else:
+            return self._settings.auth.user_id.get_secret_value()
+
+    def _get_company_id(self) -> str:
+        if self._settings is None:
+            return generated_numeric_string(16)
+        else:
+            return self._settings.auth.company_id.get_secret_value()
+
+    def get_chat_event_user_message(
+        self,
+        text: str,
+        *,
+        created_at: datetime | None = None,
+        language: str = "DE",
+        original_text: str | None = None,
+    ) -> ChatEventUserMessage:
+        if created_at is None:
+            created_at = datetime.now()
+
+        return ChatEventUserMessage(
+            id=generated_user_message_id(),
+            text=text,
+            original_text=original_text or text,
+            created_at=created_at.isoformat(),
+            language=language,
+        )
+
+    def get_chat_event_assistant_message(
+        self, *, created_at: datetime | None = None
+    ) -> ChatEventAssistantMessage:
+        if created_at is None:
+            created_at = datetime.now()
+
+        return ChatEventAssistantMessage(
+            id=generated_assistant_id(), created_at=created_at.isoformat()
+        )
+
+    def get_chat_event_additional_parameters(
+        self,
+        *,
+        translate_to_language: str | None = None,
+        content_id_to_translate: str | None = None,
+    ) -> ChatEventAdditionalParameters:
+        return ChatEventAdditionalParameters(
+            translate_to_language=translate_to_language,
+            content_id_to_translate=content_id_to_translate,
+        )
+
+    def get_base_event(
+        self,
+        *,
+        event: EventName = EventName.EXTERNAL_MODULE_CHOSEN,
+        user_id: str | None = None,
+        company_id: str | None = None,
+    ) -> BaseEvent:
+        return BaseEvent(
+            id=generated_alphanumeric_string(16),
+            event=event,
+            user_id=user_id or self._get_user_id(),
+            company_id=company_id or self._get_company_id(),
+        )
+
+    def get_chat_event_payload(
+        self,
+        *,
+        name: str,
+        description: str,
+        user_message_text: str,
+        user_message_created_at: datetime | None = None,
+        user_message_language: str = "DE",
+        user_message_original_text: str | None = None,
+        assistant_message_created_at: datetime | None = None,
+        configuration: dict[str, Any] | None = None,
+        chat_id: str | None = None,
+        assistant_id: str | None = None,
+    ) -> ChatEventPayload:
+        if chat_id is None:
+            chat_id = generated_chat_id()
+
+        if assistant_id is None:
+            assistant_id = generated_assistant_id()
+
+        assistant_message = self.get_chat_event_assistant_message(
+            created_at=assistant_message_created_at or datetime.now()
+        )
+        user_message = self.get_chat_event_user_message(
+            text=user_message_text,
+            created_at=user_message_created_at or datetime.now(),
+            language=user_message_language,
+            original_text=user_message_original_text,
+        )
+        return ChatEventPayload(
+            name=name,
+            description=description,
+            configuration=configuration or {},
+            chat_id=chat_id,
+            assistant_id=assistant_id,
+            user_message=user_message,
+            assistant_message=assistant_message,
+        )
+
+    def get_chat_event(
+        self,
+        *,
+        name: str,
+        event_name: EventName = EventName.EXTERNAL_MODULE_CHOSEN,
+        description: str,
+        user_message_text: str,
+        user_message_created_at: datetime = datetime.now(),
+        user_message_language: str = "DE",
+        user_message_original_text: str | None = None,
+        assistant_message_created_at: datetime | None = None,
+        configuration: dict[str, Any] | None = None,
+        chat_id: str | None = None,
+        assistant_id: str | None = None,
+        user_id: str | None = None,
+        company_id: str | None = None,
+        version: str = "1.0",
+    ) -> ChatEvent:
+        if chat_id is None:
+            chat_id = generated_chat_id()
+
+        if assistant_id is None:
+            assistant_id = generated_assistant_id()
+
+        payload = self.get_chat_event_payload(
+            name=name,
+            description=description,
+            user_message_text=user_message_text,
+            user_message_created_at=user_message_created_at,
+            user_message_language=user_message_language,
+            user_message_original_text=user_message_original_text,
+            assistant_message_created_at=assistant_message_created_at,
+            configuration=configuration or {},
+            chat_id=chat_id,
+            assistant_id=assistant_id,
+        )
+        return ChatEvent(
+            id=generated_alphanumeric_string(16),
+            event=event_name,
+            user_id=user_id or self._get_user_id(),
+            company_id=company_id or self._get_company_id(),
+            payload=payload,
+            created_at=int(datetime.now().timestamp()),
+            version=version,
+        )