unique_toolkit 0.5.17__py3-none-any.whl → 0.5.18__py3-none-any.whl

unique_toolkit/app/schemas.py

@@ -51,6 +51,9 @@ class EventPayload(BaseModel):
     assistant_message: EventAssistantMessage
     text: Optional[str] = None
     additional_parameters: Optional[EventAdditionalParameters] = None
+    user_metadata: Optional[dict[str, Any]] = None
+    tool_parameters: Optional[dict[str, Any]] = None
+    metadata_filter: Optional[dict[str, Any]] = None
 
 
 class Event(BaseModel):

unique_toolkit/chat/service.py

@@ -28,6 +28,106 @@ class ChatService(BaseService):
     DEFAULT_PERCENT_OF_MAX_TOKENS = 0.15
     DEFAULT_MAX_MESSAGES = 4
 
+    async def update_debug_info_async(self, debug_info: dict):
+        """
+        Updates the debug information for the chat session.
+
+        Args:
+            debug_info (dict): The new debug information.
+        """
+        params = self._construct_message_params(assistant=False, debug_info=debug_info)
+        try:
+            await unique_sdk.Message.modify_async(**params)
+        except Exception as e:
+            self.logger.error(f"Failed to update debug info: {e}")
+            raise e
+
+    def update_debug_info(self, debug_info: dict):
+        """
+        Updates the debug information for the chat session.
+
+        Args:
+            debug_info (dict): The new debug information.
+        """
+        params = self._construct_message_params(assistant=False, debug_info=debug_info)
+        try:
+            unique_sdk.Message.modify(**params)
+        except Exception as e:
+            self.logger.error(f"Failed to update debug info: {e}")
+            raise e
+
+    def modify_user_message(
+        self,
+        content: str,
+        references: Optional[list[ContentReference]] = None,
+        debug_info: Optional[dict] = None,
+        message_id: Optional[str] = None,
+    ) -> ChatMessage:
+        """
+        Modifies a message in the chat session synchronously.
+
+        Args:
+            content (str): The new content for the message.
+            references (list[ContentReference]): list of ContentReference objects. Defaults to [].
+            debug_info (dict[str, Any]]]): Debug information. Defaults to {}.
+            message_id (str, optional): The message ID. Defaults to None, then the ChatState user message id is used.
+
+        Returns:
+            ChatMessage: The modified message.
+
+        Raises:
+            Exception: If the modification fails.
+        """
+        try:
+            params = self._construct_message_params(
+                assistant=False,
+                content=content,
+                references=references,
+                debug_info=debug_info,
+                message_id=message_id,
+            )
+            message = unique_sdk.Message.modify(**params)
+        except Exception as e:
+            self.logger.error(f"Failed to modify user message: {e}")
+            raise e
+        return ChatMessage(**message)
+
+    async def modify_user_message_async(
+        self,
+        content: str,
+        references: list[ContentReference] = [],
+        debug_info: dict = {},
+        message_id: Optional[str] = None,
+    ) -> ChatMessage:
+        """
+        Modifies a message in the chat session asynchronously.
+
+        Args:
+            content (str): The new content for the message.
+            message_id (str, optional): The message ID. Defaults to None, then the ChatState user message id is used.
+            references (list[ContentReference]): list of ContentReference objects. Defaults to None.
+            debug_info (Optional[dict[str, Any]]], optional): Debug information. Defaults to None.
+
+        Returns:
+            ChatMessage: The modified message.
+
+        Raises:
+            Exception: If the modification fails.
+        """
+        try:
+            params = self._construct_message_params(
+                assistant=False,
+                content=content,
+                references=references,
+                debug_info=debug_info,
+                message_id=message_id,
+            )
+            message = await unique_sdk.Message.modify_async(**params)
+        except Exception as e:
+            self.logger.error(f"Failed to modify user message: {e}")
+            raise e
+        return ChatMessage(**message)
+
     def modify_assistant_message(
         self,
         content: str,
@@ -50,19 +150,15 @@ class ChatService(BaseService):
         Raises:
             Exception: If the modification fails.
         """
-        message_id = message_id or self.event.payload.assistant_message.id
-
         try:
-            message = unique_sdk.Message.modify(
-                user_id=self.event.user_id,
-                company_id=self.event.company_id,
-                id=message_id,
-                chatId=self.event.payload.chat_id,
-                text=content,
-                references=self._map_references(references),
-                debugInfo=debug_info or {},
-                completedAt=_time_utils.get_datetime_now(),  # type: ignore
+            params = self._construct_message_params(
+                assistant=True,
+                content=content,
+                references=references,
+                debug_info=debug_info,
+                message_id=message_id,
             )
+            message = unique_sdk.Message.modify(**params)
         except Exception as e:
             self.logger.error(f"Failed to modify assistant message: {e}")
             raise e
@@ -90,19 +186,15 @@ class ChatService(BaseService):
         Raises:
             Exception: If the modification fails.
         """
-        message_id = message_id or self.event.payload.assistant_message.id
-
         try:
-            message = await unique_sdk.Message.modify_async(
-                user_id=self.event.user_id,
-                company_id=self.event.company_id,
-                id=message_id,
-                chatId=self.event.payload.chat_id,
-                text=content,
-                references=self._map_references(references),
-                debugInfo=debug_info or {},
-                completedAt=_time_utils.get_datetime_now(),  # type: ignore
+            params = self._construct_message_params(
+                assistant=True,
+                content=content,
+                references=references,
+                debug_info=debug_info,
+                message_id=message_id,
             )
+            message = await unique_sdk.Message.modify_async(**params)
         except Exception as e:
             self.logger.error(f"Failed to modify assistant message: {e}")
             raise e
@@ -384,3 +476,35 @@ class ChatService(BaseService):
 
         last_index = max(0, last_index)
         return messages[last_index:]
+
+    def _construct_message_params(
+        self,
+        assistant: bool = True,
+        content: Optional[str] = None,
+        references: Optional[list[ContentReference]] = None,
+        debug_info: Optional[dict] = None,
+        message_id: Optional[str] = None,
+    ):
+        if message_id:
+            # Message ID specified. No need to guess
+            message_id = message_id
+        elif assistant:
+            # Assistant message ID
+            message_id = self.event.payload.assistant_message.id
+        else:
+            # User message ID
+            message_id = self.event.payload.user_message.id
+            if content is None:
+                content = self.event.payload.user_message.text
+
+        params = {
+            "user_id": self.event.user_id,
+            "company_id": self.event.company_id,
+            "id": message_id,
+            "chatId": self.event.payload.chat_id,
+            "text": content,
+            "references": self._map_references(references) if references else [],
+            "debugInfo": debug_info,
+            "completedAt": _time_utils.get_datetime_now(),
+        }
+        return params

unique_toolkit/content/schemas.py

@@ -14,7 +14,12 @@ model_config = ConfigDict(
 
 
 class ContentMetadata(BaseModel):
-    model_config = model_config
+    model_config = ConfigDict(
+        alias_generator=camelize,
+        populate_by_name=True,
+        arbitrary_types_allowed=True,
+        extra="allow",
+    )
     key: str
     mime_type: str
 

unique_toolkit/content/service.py

@@ -40,6 +40,7 @@ class ContentService(BaseService):
         reranker_config: Optional[ContentRerankerConfig] = None,
         scope_ids: Optional[list[str]] = None,
         chat_only: Optional[bool] = None,
+        metadata_filter: Optional[dict] = None,
     ) -> list[ContentChunk]:
         """
         Performs a synchronous search for content chunks in the knowledge base.
@@ -52,6 +53,7 @@ class ContentService(BaseService):
             reranker_config (Optional[ContentRerankerConfig]): The reranker configuration. Defaults to None.
             scope_ids (Optional[list[str]]): The scope IDs. Defaults to None.
             chat_only (Optional[bool]): Whether to search only in the current chat. Defaults to None.
+            metadata_filter (Optional[dict]): UniqueQL metadata filter. Defaults to None.
 
         Returns:
             list[ContentChunk]: The search results.
@@ -75,6 +77,7 @@ class ContentService(BaseService):
                 ),
                 language=search_language,
                 chatOnly=chat_only,
+                metaDataFilter=metadata_filter,
             )
         except Exception as e:
             self.logger.error(f"Error while searching content chunks: {e}")
@@ -96,6 +99,7 @@ class ContentService(BaseService):
         reranker_config: Optional[ContentRerankerConfig] = None,
         scope_ids: Optional[list[str]] = None,
         chat_only: Optional[bool] = None,
+        metadata_filter: Optional[dict] = None,
     ):
         """
         Performs an asynchronous search for content chunks in the knowledge base.
@@ -108,6 +112,7 @@ class ContentService(BaseService):
             reranker_config (Optional[ContentRerankerConfig]): The reranker configuration. Defaults to None.
             scope_ids (Optional[list[str]]): The scope IDs. Defaults to None.
             chat_only (Optional[bool]): Whether to search only in the current chat. Defaults to None.
+            metadata_filter (Optional[dict]): UniqueQL metadata filter. Defaults to None.
 
         Returns:
             list[ContentChunk]: The search results.
@@ -131,6 +136,7 @@ class ContentService(BaseService):
                 ),
                 language=search_language,
                 chatOnly=chat_only,
+                metaDataFilter=metadata_filter,
             )
         except Exception as e:
             self.logger.error(f"Error while searching content chunks: {e}")

{unique_toolkit-0.5.17.dist-info → unique_toolkit-0.5.18.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: unique_toolkit
-Version: 0.5.17
+Version: 0.5.18
 Summary: 
 License: MIT
 Author: Martin Fadler
@@ -13,12 +13,11 @@ Classifier: Programming Language :: Python :: 3.12
 Requires-Dist: numpy (>=1.26.4,<2.0.0)
 Requires-Dist: pydantic (>=2.8.2,<3.0.0)
 Requires-Dist: pyhumps (>=3.8.0,<4.0.0)
-Requires-Dist: pytest-mock (>=3.14.0,<4.0.0)
 Requires-Dist: python-dotenv (>=1.0.1,<2.0.0)
 Requires-Dist: regex (>=2024.5.15,<2025.0.0)
 Requires-Dist: tiktoken (>=0.7.0,<0.8.0)
 Requires-Dist: typing-extensions (>=4.9.0,<5.0.0)
-Requires-Dist: unique-sdk (>=0.9.4,<0.10.0)
+Requires-Dist: unique-sdk (>=0.9.6,<0.10.0)
 Description-Content-Type: text/markdown
 
 # Unique Toolkit
@@ -101,8 +100,13 @@ 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.5.18] - 2024-09-03
+- Adds option to use `metadata_filter` with search.
+- Adds `user_metadata`, `tool_parameters` and `metadata_filter` to `EventPayload`.
+- Adds `update_debug_info` and `modify_user_message` (and the corresponding `async` variants) to `ChatService`.
+
 ## [0.5.17] - 2024-08-30
-- Add option to initiate `LanguageModel` with a string
+- Add option to initiate `LanguageModel` with a string.
 - Add option to call `LanguageModelService` functions also with a string instead of `LanguageModelName` enum for parameter `model_name`.
 
 ## [0.5.16] - 2024-08-29

{unique_toolkit-0.5.17.dist-info → unique_toolkit-0.5.18.dist-info}/RECORD

@@ -6,16 +6,16 @@ unique_toolkit/app/init_logging.py,sha256=Sh26SRxOj8i8dzobKhYha2lLrkrMTHfB1V4jR3
 unique_toolkit/app/init_sdk.py,sha256=Nv4Now4pMfM0AgRhbtatLpm_39rKxn0WmRLwmPhRl-8,1285
 unique_toolkit/app/performance/async_tasks.py,sha256=H0l3OAcosLwNHZ8d2pd-Di4wHIXfclEvagi5kfqLFPA,1941
 unique_toolkit/app/performance/async_wrapper.py,sha256=yVVcRDkcdyfjsxro-N29SBvi-7773wnfDplef6-y8xw,1077
-unique_toolkit/app/schemas.py,sha256=_PIROOUtdKvZFZdvkCORhj-MVWvfkopIQW7VIFmguRg,1364
+unique_toolkit/app/schemas.py,sha256=tzrmUFKZUdC1P3LxZ7DrElpkMtekUDoClb7jCRzGqNQ,1521
 unique_toolkit/app/verification.py,sha256=UZqTHg3PX_QxMjeLH_BVBYoMVqMnMpeMoqvyTBKDqj8,1996
 unique_toolkit/chat/__init__.py,sha256=1prdTVfLOf6NgU-Aa1VIO-XiR6OYuRm51LaVRfKDCqc,267
 unique_toolkit/chat/schemas.py,sha256=ff4M-XMagF0Evn3FcKHHP5xzDEyufZgq9Dmit3i8r_E,802
-unique_toolkit/chat/service.py,sha256=mjzj0GCpIbGMX_k1aei8BY-132DCPv53FI7TqbXfaKk,13544
+unique_toolkit/chat/service.py,sha256=nVZ8agpEsXI2-5bS61e1Eawd0abioEQPov2xahiJtfk,17848
 unique_toolkit/chat/state.py,sha256=Cjgwv_2vhDFbV69xxsn7SefhaoIAEqLx3ferdVFCnOg,1445
 unique_toolkit/chat/utils.py,sha256=ihm-wQykBWhB4liR3LnwPVPt_qGW6ETq21Mw4HY0THE,854
 unique_toolkit/content/__init__.py,sha256=MSH2sxjQyKD2Sef92fzE5Dt9SihdzivB6yliSwJfTmQ,890
-unique_toolkit/content/schemas.py,sha256=UlC5nBIaFkq9TD31LR6ioG9JRZ1ScmtABi0l06HZR70,2231
-unique_toolkit/content/service.py,sha256=NoH8FNP36Jt92RRswDZAfUV0UItrsrtokcqKP__ERRc,13656
+unique_toolkit/content/schemas.py,sha256=zks_Pkki2VhxICJJgHZyc-LPmRuj5dLbw3pgcUT7SW8,2362
+unique_toolkit/content/service.py,sha256=AHyMJTXm5IpYbg1uINzjGqvSL_5aJwEHwSH7Y5pkXBg,14028
 unique_toolkit/content/utils.py,sha256=Lake671plRsqNvO3pN_rmyVcpwbdED_KQpLcCnc4lv4,6902
 unique_toolkit/embedding/__init__.py,sha256=dr8M9jvslQTxPpxgaGwzxY0FildiWf-DidN_cahPAWw,191
 unique_toolkit/embedding/schemas.py,sha256=1GvKCaSk4jixzVQ2PKq8yDqwGEVY_hWclYtoAr6CC2g,96
@@ -26,7 +26,7 @@ unique_toolkit/language_model/infos.py,sha256=ETAUV0YTs6BjwuiTdhKz247CtL0W8Jwo3-
 unique_toolkit/language_model/schemas.py,sha256=h5zjZNk7O-wLKtRuiNtMCIbp5hEVXrAOviKonQcjFuI,4594
 unique_toolkit/language_model/service.py,sha256=8s2tiGLE5ryKQDOtEbNaFkc73NngANxvFNr-hD-dgps,10948
 unique_toolkit/language_model/utils.py,sha256=WBPj1XKkDgxy_-T8HCZvsfkkSzj_1w4UZzNmyvdbBLY,1081
-unique_toolkit-0.5.17.dist-info/LICENSE,sha256=bIeCWCYuoUU_MzNdg48-ubJSVm7qxakaRbzTiJ5uxrs,1065
-unique_toolkit-0.5.17.dist-info/METADATA,sha256=EQ-ycT-rGgOHG8Qu2Gr4OvMUl_i8Tdh2CT-M2e--gLM,10519
-unique_toolkit-0.5.17.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-unique_toolkit-0.5.17.dist-info/RECORD,,
+unique_toolkit-0.5.18.dist-info/LICENSE,sha256=bIeCWCYuoUU_MzNdg48-ubJSVm7qxakaRbzTiJ5uxrs,1065
+unique_toolkit-0.5.18.dist-info/METADATA,sha256=Bc1nuWyOLgX0SujW7MCpzcbG8WBlTqPiC3PPLU858WA,10748
+unique_toolkit-0.5.18.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+unique_toolkit-0.5.18.dist-info/RECORD,,