unique_toolkit 0.7.8__tar.gz → 0.7.10__tar.gz

{unique_toolkit-0.7.8 → unique_toolkit-0.7.10}/CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), 
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.7.10] - 2025-04-22
+- Deprecate internal variables of services
+
+## [0.7.9] - 2025-04-17
+- add `AZURE_GPT_41_2025_0414` as part of the models
+
 ## [0.7.8] - 2025-04-08
 - add `AZURE_GPT_4o_2024_1120` as part of the models
 

{unique_toolkit-0.7.8 → unique_toolkit-0.7.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: unique_toolkit
-Version: 0.7.8
+Version: 0.7.10
 Summary: 
 License: Proprietary
 Author: Martin Fadler
@@ -111,6 +111,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), 
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.7.10] - 2025-04-22
+- Deprecate internal variables of services
+
+## [0.7.9] - 2025-04-17
+- add `AZURE_GPT_41_2025_0414` as part of the models
+
 ## [0.7.8] - 2025-04-08
 - add `AZURE_GPT_4o_2024_1120` as part of the models
 

{unique_toolkit-0.7.8 → unique_toolkit-0.7.10}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "unique_toolkit"
-version = "0.7.8"
+version = "0.7.10"
 description = ""
 authors = [
     "Martin Fadler <martin.fadler@unique.ch>",

{unique_toolkit-0.7.8 → unique_toolkit-0.7.10}/unique_toolkit/chat/service.py

@@ -69,13 +69,13 @@ class ChatService:
 
     def __init__(self, event: ChatEvent | Event):
         self._event = event
-        self.company_id = event.company_id
-        self.user_id = event.user_id
-        self.assistant_message_id = event.payload.assistant_message.id
-        self.user_message_id = event.payload.user_message.id
-        self.chat_id = event.payload.chat_id
-        self.assistant_id = event.payload.assistant_id
-        self.user_message_text = event.payload.user_message.text
+        self._company_id = event.company_id
+        self._user_id = event.user_id
+        self._assistant_message_id = event.payload.assistant_message.id
+        self._user_message_id = event.payload.user_message.id
+        self._chat_id = event.payload.chat_id
+        self._assistant_id = event.payload.assistant_id
+        self._user_message_text = event.payload.user_message.text
 
     @property
     @deprecated(
@@ -90,6 +90,188 @@ class ChatService:
         """
         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) -> 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) -> None:
+        """
+        Set the user identifier (deprecated).
+
+        Args:
+            value (str | None): The user identifier.
+        """
+        self._user_id = value
+
+    @property
+    @deprecated(
+        "The assistant_message_id property is deprecated and will be removed in a future version."
+    )
+    def assistant_message_id(self) -> str | None:
+        """
+        Get the assistant message identifier (deprecated).
+
+        Returns:
+            str | None: The assistant message identifier.
+        """
+        return self._assistant_message_id
+
+    @assistant_message_id.setter
+    @deprecated(
+        "The assistant_message_id setter is deprecated and will be removed in a future version."
+    )
+    def assistant_message_id(self, value: str | None) -> None:
+        """
+        Set the assistant message identifier (deprecated).
+
+        Args:
+            value (str | None): The assistant message identifier.
+        """
+        self._assistant_message_id = value
+
+    @property
+    @deprecated(
+        "The user_message_id property is deprecated and will be removed in a future version."
+    )
+    def user_message_id(self) -> str | None:
+        """
+        Get the user message identifier (deprecated).
+
+        Returns:
+            str | None: The user message identifier.
+        """
+        return self._user_message_id
+
+    @user_message_id.setter
+    @deprecated(
+        "The user_message_id setter is deprecated and will be removed in a future version."
+    )
+    def user_message_id(self, value: str | None) -> None:
+        """
+        Set the user message identifier (deprecated).
+
+        Args:
+            value (str | None): The user message identifier.
+        """
+        self._user_message_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 assistant_id property is deprecated and will be removed in a future version."
+    )
+    def assistant_id(self) -> str | None:
+        """
+        Get the assistant identifier (deprecated).
+
+        Returns:
+            str | None: The assistant identifier.
+        """
+        return self._assistant_id
+
+    @assistant_id.setter
+    @deprecated(
+        "The assistant_id setter is deprecated and will be removed in a future version."
+    )
+    def assistant_id(self, value: str | None) -> None:
+        """
+        Set the assistant identifier (deprecated).
+
+        Args:
+            value (str | None): The assistant identifier.
+        """
+        self._assistant_id = value
+
+    @property
+    @deprecated(
+        "The user_message_text property is deprecated and will be removed in a future version."
+    )
+    def user_message_text(self) -> str | None:
+        """
+        Get the user message text (deprecated).
+
+        Returns:
+            str | None: The user message text.
+        """
+        return self._user_message_text
+
+    @user_message_text.setter
+    @deprecated(
+        "The user_message_text setter is deprecated and will be removed in a future version."
+    )
+    def user_message_text(self, value: str | None) -> None:
+        """
+        Set the user message text (deprecated).
+
+        Args:
+            value (str | None): The user message text.
+        """
+        self._user_message_text = value
+
     async def update_debug_info_async(self, debug_info: dict):
         """
         Updates the debug information for the chat session.
@@ -99,12 +281,12 @@ class ChatService:
         """
 
         return await modify_message_async(
-            user_id=self.user_id,
-            company_id=self.company_id,
-            assistant_message_id=self.assistant_message_id,
-            chat_id=self.chat_id,
-            user_message_id=self.user_message_id,
-            user_message_text=self.user_message_text,
+            user_id=self._user_id,
+            company_id=self._company_id,
+            assistant_message_id=self._assistant_message_id,
+            chat_id=self._chat_id,
+            user_message_id=self._user_message_id,
+            user_message_text=self._user_message_text,
             assistant=False,
             debug_info=debug_info,
         )
@@ -118,12 +300,12 @@ class ChatService:
         """
 
         return modify_message(
-            user_id=self.user_id,
-            company_id=self.company_id,
-            assistant_message_id=self.assistant_message_id,
-            chat_id=self.chat_id,
-            user_message_id=self.user_message_id,
-            user_message_text=self.user_message_text,
+            user_id=self._user_id,
+            company_id=self._company_id,
+            assistant_message_id=self._assistant_message_id,
+            chat_id=self._chat_id,
+            user_message_id=self._user_message_id,
+            user_message_text=self._user_message_text,
             assistant=False,
             debug_info=debug_info,
         )
@@ -153,12 +335,12 @@ class ChatService:
             Exception: If the modification fails.
         """
         return modify_message(
-            user_id=self.user_id,
-            company_id=self.company_id,
-            assistant_message_id=self.assistant_message_id,
-            chat_id=self.chat_id,
-            user_message_id=self.user_message_id,
-            user_message_text=self.user_message_text,
+            user_id=self._user_id,
+            company_id=self._company_id,
+            assistant_message_id=self._assistant_message_id,
+            chat_id=self._chat_id,
+            user_message_id=self._user_message_id,
+            user_message_text=self._user_message_text,
             assistant=False,
             content=content,
             references=references,
@@ -192,12 +374,12 @@ class ChatService:
             Exception: If the modification fails.
         """
         return await modify_message_async(
-            user_id=self.user_id,
-            company_id=self.company_id,
-            assistant_message_id=self.assistant_message_id,
-            chat_id=self.chat_id,
-            user_message_id=self.user_message_id,
-            user_message_text=self.user_message_text,
+            user_id=self._user_id,
+            company_id=self._company_id,
+            assistant_message_id=self._assistant_message_id,
+            chat_id=self._chat_id,
+            user_message_id=self._user_message_id,
+            user_message_text=self._user_message_text,
             assistant=False,
             content=content,
             references=references,
@@ -233,12 +415,12 @@ class ChatService:
             Exception: If the modification fails.
         """
         return modify_message(
-            user_id=self.user_id,
-            company_id=self.company_id,
-            assistant_message_id=self.assistant_message_id,
-            chat_id=self.chat_id,
-            user_message_id=self.user_message_id,
-            user_message_text=self.user_message_text,
+            user_id=self._user_id,
+            company_id=self._company_id,
+            assistant_message_id=self._assistant_message_id,
+            chat_id=self._chat_id,
+            user_message_id=self._user_message_id,
+            user_message_text=self._user_message_text,
             assistant=True,
             content=content,
             original_content=original_content,
@@ -276,12 +458,12 @@ class ChatService:
         """
 
         return await modify_message_async(
-            user_id=self.user_id,
-            company_id=self.company_id,
-            assistant_message_id=self.assistant_message_id,
-            chat_id=self.chat_id,
-            user_message_id=self.user_message_id,
-            user_message_text=self.user_message_text,
+            user_id=self._user_id,
+            company_id=self._company_id,
+            assistant_message_id=self._assistant_message_id,
+            chat_id=self._chat_id,
+            user_message_id=self._user_message_id,
+            user_message_text=self._user_message_text,
             assistant=True,
             content=content,
             original_content=original_content,
@@ -302,9 +484,9 @@ class ChatService:
             Exception: If the loading fails.
         """
         return get_full_history(
-            event_user_id=self.user_id,
-            event_company_id=self.company_id,
-            event_payload_chat_id=self.chat_id,
+            event_user_id=self._user_id,
+            event_company_id=self._company_id,
+            event_payload_chat_id=self._chat_id,
         )
 
     async def get_full_history_async(self) -> list[ChatMessage]:
@@ -318,9 +500,9 @@ class ChatService:
             Exception: If the loading fails.
         """
         return await get_full_history_async(
-            event_user_id=self.user_id,
-            event_company_id=self.company_id,
-            event_payload_chat_id=self.chat_id,
+            event_user_id=self._user_id,
+            event_company_id=self._company_id,
+            event_payload_chat_id=self._chat_id,
         )
 
     def get_full_and_selected_history(
@@ -344,9 +526,9 @@ class ChatService:
             Exception: If the loading fails.
         """
         full_history = get_full_history(
-            event_user_id=self.user_id,
-            event_company_id=self.company_id,
-            event_payload_chat_id=self.chat_id,
+            event_user_id=self._user_id,
+            event_company_id=self._company_id,
+            event_payload_chat_id=self._chat_id,
         )
         selected_history = get_selection_from_history(
             full_history=full_history,
@@ -377,9 +559,9 @@ class ChatService:
             Exception: If the loading fails.
         """
         full_history = await get_full_history_async(
-            event_user_id=self.user_id,
-            event_company_id=self.company_id,
-            event_payload_chat_id=self.chat_id,
+            event_user_id=self._user_id,
+            event_company_id=self._company_id,
+            event_payload_chat_id=self._chat_id,
         )
         selected_history = get_selection_from_history(
             full_history=full_history,
@@ -414,10 +596,10 @@ class ChatService:
             Exception: If the creation fails.
         """
         chat_message = create_message(
-            user_id=self.user_id,
-            company_id=self.company_id,
-            chat_id=self.chat_id,
-            assistant_id=self.assistant_id,
+            user_id=self._user_id,
+            company_id=self._company_id,
+            chat_id=self._chat_id,
+            assistant_id=self._assistant_id,
             role=ChatMessageRole.ASSISTANT,
             content=content,
             original_content=original_content,
@@ -426,7 +608,7 @@ class ChatService:
             set_completed_at=set_completed_at,
         )
         # Update the assistant message id
-        self.assistant_message_id = chat_message.id
+        self._assistant_message_id = chat_message.id
         return chat_message
 
     async def create_assistant_message_async(
@@ -455,10 +637,10 @@ class ChatService:
         """
 
         chat_message = await create_message_async(
-            user_id=self.user_id,
-            company_id=self.company_id,
-            chat_id=self.chat_id,
-            assistant_id=self.assistant_id,
+            user_id=self._user_id,
+            company_id=self._company_id,
+            chat_id=self._chat_id,
+            assistant_id=self._assistant_id,
             role=ChatMessageRole.ASSISTANT,
             content=content,
             original_content=original_content,
@@ -467,7 +649,7 @@ class ChatService:
             set_completed_at=set_completed_at,
         )
         # Update the assistant message id
-        self.assistant_message_id = chat_message.id
+        self._assistant_message_id = chat_message.id
         return chat_message
 
     def create_user_message(
@@ -495,10 +677,10 @@ class ChatService:
             Exception: If the creation fails.
         """
         chat_message = create_message(
-            user_id=self.user_id,
-            company_id=self.company_id,
-            chat_id=self.chat_id,
-            assistant_id=self.assistant_id,
+            user_id=self._user_id,
+            company_id=self._company_id,
+            chat_id=self._chat_id,
+            assistant_id=self._assistant_id,
             role=ChatMessageRole.USER,
             content=content,
             original_content=original_content,
@@ -507,7 +689,7 @@ class ChatService:
             set_completed_at=set_completed_at,
         )
         # Update the user message id
-        self.user_message_id = chat_message.id
+        self._user_message_id = chat_message.id
         return chat_message
 
     async def create_user_message_async(
@@ -536,10 +718,10 @@ class ChatService:
         """
 
         chat_message = await create_message_async(
-            user_id=self.user_id,
-            company_id=self.company_id,
-            chat_id=self.chat_id,
-            assistant_id=self.assistant_id,
+            user_id=self._user_id,
+            company_id=self._company_id,
+            chat_id=self._chat_id,
+            assistant_id=self._assistant_id,
             role=ChatMessageRole.USER,
             content=content,
             original_content=original_content,
@@ -548,7 +730,7 @@ class ChatService:
             set_completed_at=set_completed_at,
         )
         # Update the user message id
-        self.user_message_id = chat_message.id
+        self._user_message_id = chat_message.id
         return chat_message
 
     def create_message_assessment(
@@ -580,8 +762,8 @@ class ChatService:
             Exception: If the creation fails
         """
         return create_message_assessment(
-            user_id=self.user_id,
-            company_id=self.company_id,
+            user_id=self._user_id,
+            company_id=self._company_id,
             assistant_message_id=assistant_message_id,
             status=status,
             type=type,
@@ -620,8 +802,8 @@ class ChatService:
             Exception: If the creation fails
         """
         return await create_message_assessment_async(
-            user_id=self.user_id,
-            company_id=self.company_id,
+            user_id=self._user_id,
+            company_id=self._company_id,
             assistant_message_id=assistant_message_id,
             status=status,
             type=type,
@@ -658,8 +840,8 @@ class ChatService:
             Exception: If the modification fails
         """
         return modify_message_assessment(
-            user_id=self.user_id,
-            company_id=self.company_id,
+            user_id=self._user_id,
+            company_id=self._company_id,
             assistant_message_id=assistant_message_id,
             status=status,
             type=type,
@@ -695,8 +877,8 @@ class ChatService:
             Exception: If the modification fails
         """
         return await modify_message_assessment_async(
-            user_id=self.user_id,
-            company_id=self.company_id,
+            user_id=self._user_id,
+            company_id=self._company_id,
             assistant_message_id=assistant_message_id,
             status=status,
             type=type,
@@ -729,12 +911,12 @@ class ChatService:
             assistant_id,
         ] = validate_required_values(
             [
-                self.company_id,
-                self.user_id,
-                self.assistant_message_id,
-                self.user_message_id,
-                self.chat_id,
-                self.assistant_id,
+                self._company_id,
+                self._user_id,
+                self._assistant_message_id,
+                self._user_message_id,
+                self._chat_id,
+                self._assistant_id,
             ]
         )
 
@@ -781,12 +963,12 @@ class ChatService:
             assistant_id,
         ] = validate_required_values(
             [
-                self.company_id,
-                self.user_id,
-                self.assistant_message_id,
-                self.user_message_id,
-                self.chat_id,
-                self.assistant_id,
+                self._company_id,
+                self._user_id,
+                self._assistant_message_id,
+                self._user_message_id,
+                self._chat_id,
+                self._assistant_id,
             ]
         )