unique_toolkit 0.5.38__py3-none-any.whl → 0.5.40__py3-none-any.whl

unique_toolkit/content/service.py

@@ -29,6 +29,7 @@ class ContentService(BaseService):
 
     def __init__(self, event: Event, logger: Optional[logging.Logger] = None):
         super().__init__(event, logger)
+        self.metadata_filter = event.payload.metadata_filter
 
     DEFAULT_SEARCH_LANGUAGE = "english"
 
@@ -42,6 +43,7 @@ class ContentService(BaseService):
         scope_ids: Optional[list[str]] = None,
         chat_only: Optional[bool] = None,
         metadata_filter: Optional[dict] = None,
+        content_ids: Optional[list[str]] = None,
     ) -> list[ContentChunk]:
         """
         Performs a synchronous search for content chunks in the knowledge base.
@@ -54,14 +56,17 @@ 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.
-
+            metadata_filter (Optional[dict]): UniqueQL metadata filter. If unspecified/None, it tries to use the metadata filter from the event. Defaults to None.
+            content_ids (Optional[list[str]]): The content IDs to search. Defaults to None.
         Returns:
             list[ContentChunk]: The search results.
         """
         if not scope_ids:
             self.logger.warning("No scope IDs provided for search.")
 
+        if metadata_filter is None:
+            metadata_filter = self.metadata_filter
+
         try:
             searches = unique_sdk.Search.create(
                 user_id=self.event.user_id,
@@ -79,6 +84,7 @@ class ContentService(BaseService):
                 language=search_language,
                 chatOnly=chat_only,
                 metaDataFilter=metadata_filter,
+                contentIds=content_ids,
             )
         except Exception as e:
             self.logger.error(f"Error while searching content chunks: {e}")
@@ -101,6 +107,7 @@ class ContentService(BaseService):
         scope_ids: Optional[list[str]] = None,
         chat_only: Optional[bool] = None,
         metadata_filter: Optional[dict] = None,
+        content_ids: Optional[list[str]] = None,
     ):
         """
         Performs an asynchronous search for content chunks in the knowledge base.
@@ -113,14 +120,17 @@ 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.
-
+            metadata_filter (Optional[dict]): UniqueQL metadata filter. If unspecified/None, it tries to use the metadata filter from the event. Defaults to None.
+            content_ids (Optional[list[str]]): The content IDs to search. Defaults to None.
         Returns:
             list[ContentChunk]: The search results.
         """
         if not scope_ids:
             self.logger.warning("No scope IDs provided for search.")
 
+        if metadata_filter is None:
+            metadata_filter = self.metadata_filter
+
         try:
             searches = await unique_sdk.Search.create_async(
                 user_id=self.event.user_id,
@@ -138,6 +148,7 @@ class ContentService(BaseService):
                 language=search_language,
                 chatOnly=chat_only,
                 metaDataFilter=metadata_filter,
+                contentIds=content_ids,
             )
         except Exception as e:
             self.logger.error(f"Error while searching content chunks: {e}")

unique_toolkit/language_model/service.py

@@ -37,6 +37,7 @@ class LanguageModelService(BaseService):
         temperature: float = DEFAULT_COMPLETE_TEMPERATURE,
         timeout: int = DEFAULT_COMPLETE_TIMEOUT,
         tools: Optional[list[LanguageModelTool]] = None,
+        other_options: Optional[dict] = None,
     ):
         """
         Calls the completion endpoint synchronously without streaming the response.
@@ -47,25 +48,26 @@ class LanguageModelService(BaseService):
             temperature (float): The temperature value. Defaults to 0.
             timeout (int): The timeout value in milliseconds. Defaults to 240_000.
             tools (Optional[list[LanguageModelTool]]): The tools to use. Defaults to None.
+            other_options (Optional[dict]): The other options to use. Defaults to None.
 
         Returns:
             LanguageModelResponse: The LanguageModelResponse object.
         """
-        options = self._add_tools_to_options({}, tools)
-        options["temperature"] = temperature
-        messages = messages.model_dump(exclude_none=True)
-        model = (
-            model_name.name if isinstance(model_name, LanguageModelName) else model_name
+        options, model, messages_dict, _ = self.prepare_completion_params_util(
+            messages=messages,
+            model_name=model_name,
+            temperature=temperature,
+            tools=tools,
+            other_options=other_options,
         )
 
         try:
             response = unique_sdk.ChatCompletion.create(
                 company_id=self.event.company_id,
-                # TODO change or extend types in unique_sdk
                 model=model,
                 messages=cast(
                     list[unique_sdk.Integrated.ChatCompletionRequestMessage],
-                    messages,
+                    messages_dict,
                 ),
                 timeout=timeout,
                 options=options,  # type: ignore
@@ -84,6 +86,7 @@ class LanguageModelService(BaseService):
         temperature: float = DEFAULT_COMPLETE_TEMPERATURE,
         timeout: int = DEFAULT_COMPLETE_TIMEOUT,
         tools: Optional[list[LanguageModelTool]] = None,
+        other_options: Optional[dict] = None,
         logger: Optional[logging.Logger] = logging.getLogger(__name__),
     ) -> LanguageModelResponse:
         """
@@ -100,6 +103,7 @@ class LanguageModelService(BaseService):
             temperature (float): The temperature setting for the completion. Defaults to 0.
             timeout (int): The timeout value in milliseconds for the request. Defaults to 240_000.
             tools (Optional[list[LanguageModelTool]]): Optional list of tools to include in the request.
+            other_options (Optional[dict]): The other options to use. Defaults to None.
             logger (Optional[logging.Logger], optional): The logger used to log errors. Defaults to the logger for the current module.
 
         Returns:
@@ -108,19 +112,21 @@ class LanguageModelService(BaseService):
         Raises:
             Exception: If an error occurs during the request, an exception is raised and logged.
         """
-        options = cls._add_tools_to_options({}, tools)
-        options["temperature"] = temperature
-        messages = messages.model_dump(exclude_none=True, exclude={"tool_calls"})
-        model = (
-            model_name.name if isinstance(model_name, LanguageModelName) else model_name
+        options, model, messages_dict, _ = cls.prepare_completion_params_util(
+            messages=messages,
+            model_name=model_name,
+            temperature=temperature,
+            tools=tools,
+            other_options=other_options,
         )
+
         try:
             response = await unique_sdk.ChatCompletion.create_async(
                 company_id=company_id,
                 model=model,
                 messages=cast(
                     list[unique_sdk.Integrated.ChatCompletionRequestMessage],
-                    messages,
+                    messages_dict,
                 ),
                 timeout=timeout,
                 options=options,  # type: ignore
@@ -137,6 +143,7 @@ class LanguageModelService(BaseService):
         temperature: float = DEFAULT_COMPLETE_TEMPERATURE,
         timeout: int = DEFAULT_COMPLETE_TIMEOUT,
         tools: Optional[list[LanguageModelTool]] = None,
+        other_options: Optional[dict] = None,
     ) -> LanguageModelResponse:
         """
         Calls the completion endpoint asynchronously without streaming the response.
@@ -151,7 +158,7 @@ class LanguageModelService(BaseService):
             temperature (float): The temperature setting for the completion. Defaults to 0.0.
             timeout (int): The timeout value in milliseconds for the request. Defaults to 240,000.
             tools (Optional[list[LanguageModelTool]]): Optional list of tools to include in the request.
-
+            other_options (Optional[dict]): The other options to use. Defaults to None.
         Returns:
             LanguageModelResponse: The response object containing the completed result.
 
@@ -165,6 +172,7 @@ class LanguageModelService(BaseService):
             temperature=temperature,
             timeout=timeout,
             tools=tools,
+            other_options=other_options,
             logger=self.logger,
         )
 
@@ -178,6 +186,7 @@ class LanguageModelService(BaseService):
         timeout: int = DEFAULT_COMPLETE_TIMEOUT,
         tools: Optional[list[LanguageModelTool]] = None,
         start_text: Optional[str] = None,
+        other_options: Optional[dict] = None,
     ):
         """
         Streams a completion in the chat session synchronously.
@@ -191,16 +200,19 @@ class LanguageModelService(BaseService):
             timeout (int): The timeout value in milliseconds. Defaults to 240_000.
             tools (Optional[list[LanguageModelTool]]): The tools to use. Defaults to None.
             start_text (Optional[str]): The start text. Defaults to None.
-
+            other_options (Optional[dict]): The other options to use. Defaults to None.
         Returns:
             The LanguageModelStreamResponse object once the stream has finished.
         """
-        options = self._add_tools_to_options({}, tools)
-        options["temperature"] = temperature
-        search_context = self._to_search_context(content_chunks)
-        messages = messages.model_dump(exclude_none=True, by_alias=True)
-        model = (
-            model_name.name if isinstance(model_name, LanguageModelName) else model_name
+        options, model, messages_dict, search_context = (
+            self.prepare_completion_params_util(
+                messages=messages,
+                model_name=model_name,
+                temperature=temperature,
+                tools=tools,
+                other_options=other_options,
+                content_chunks=content_chunks,
+            )
         )
 
         try:
@@ -211,11 +223,10 @@ class LanguageModelService(BaseService):
                 userMessageId=self.event.payload.user_message.id,
                 messages=cast(
                     list[unique_sdk.Integrated.ChatCompletionRequestMessage],
-                    messages,
+                    messages_dict,
                 ),
                 chatId=self.event.payload.chat_id,
                 searchContext=search_context,
-                # TODO change or extend types in unique_sdk
                 model=model,
                 timeout=timeout,
                 assistantId=self.event.payload.assistant_id,
@@ -238,6 +249,7 @@ class LanguageModelService(BaseService):
         timeout: int = DEFAULT_COMPLETE_TIMEOUT,
         tools: Optional[list[LanguageModelTool]] = None,
         start_text: Optional[str] = None,
+        other_options: Optional[dict] = None,
     ):
         """
         Streams a completion in the chat session asynchronously.
@@ -251,17 +263,19 @@ class LanguageModelService(BaseService):
             timeout (int): The timeout value in milliseconds. Defaults to 240_000.
             tools (Optional[list[LanguageModelTool]]): The tools to use. Defaults to None.
             start_text (Optional[str]): The start text. Defaults to None.
-
+            other_options (Optional[dict]): The other options to use. Defaults to None.
         Returns:
             The LanguageModelStreamResponse object once the stream has finished.
         """
-
-        options = self._add_tools_to_options({}, tools)
-        options["temperature"] = temperature
-        search_context = self._to_search_context(content_chunks)
-        messages = messages.model_dump(exclude_none=True, by_alias=True)
-        model = (
-            model_name.name if isinstance(model_name, LanguageModelName) else model_name
+        options, model, messages_dict, search_context = (
+            self.prepare_completion_params_util(
+                messages=messages,
+                model_name=model_name,
+                temperature=temperature,
+                tools=tools,
+                other_options=other_options,
+                content_chunks=content_chunks,
+            )
         )
 
         try:
@@ -272,7 +286,7 @@ class LanguageModelService(BaseService):
                 userMessageId=self.event.payload.user_message.id,
                 messages=cast(
                     list[unique_sdk.Integrated.ChatCompletionRequestMessage],
-                    messages,
+                    messages_dict,
                 ),
                 chatId=self.event.payload.chat_id,
                 searchContext=search_context,
@@ -280,7 +294,6 @@ class LanguageModelService(BaseService):
                 timeout=timeout,
                 assistantId=self.event.payload.assistant_id,
                 debugInfo=debug_info,
-                # TODO change or extend types in unique_sdk
                 options=options,  # type: ignore
                 startText=start_text,
             )
@@ -321,3 +334,47 @@ class LanguageModelService(BaseService):
                 for tool in tools
             ]
         return options
+
+    @classmethod
+    def prepare_completion_params_util(
+        cls,
+        messages: LanguageModelMessages,
+        model_name: LanguageModelName | str,
+        temperature: float,
+        tools: Optional[list[LanguageModelTool]] = None,
+        other_options: Optional[dict] = None,
+        content_chunks: Optional[list[ContentChunk]] = None,
+    ) -> tuple[dict, str, dict, Optional[dict]]:
+        """
+        Prepares common parameters for completion requests.
+
+        Returns:
+            tuple containing:
+            - options (dict): Combined options including tools and temperature
+            - model (str): Resolved model name
+            - messages_dict (dict): Processed messages
+            - search_context (Optional[dict]): Processed content chunks if provided
+        """
+
+        options = cls._add_tools_to_options({}, tools)
+        options["temperature"] = temperature
+        if other_options:
+            options.update(other_options)
+
+        model = (
+            model_name.name if isinstance(model_name, LanguageModelName) else model_name
+        )
+
+        # Different methods need different message dump parameters
+        messages_dict = messages.model_dump(
+            exclude_none=True,
+            by_alias=content_chunks is not None,  # Use by_alias for streaming methods
+        )
+
+        search_context = (
+            LanguageModelService._to_search_context(content_chunks)
+            if content_chunks is not None
+            else None
+        )
+
+        return options, model, messages_dict, search_context

{unique_toolkit-0.5.38.dist-info → unique_toolkit-0.5.40.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: unique_toolkit
-Version: 0.5.38
+Version: 0.5.40
 Summary: 
 License: Proprietary
 Author: Martin Fadler
@@ -17,7 +17,7 @@ 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.8,<0.10.0)
+Requires-Dist: unique-sdk (>=0.9.14,<0.10.0)
 Description-Content-Type: text/markdown
 
 # Unique Toolkit
@@ -100,6 +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.40] - 2024-12-11
+- Add `other_options` to `LanguageModelService.complete`, `LanguageModelService.complete_async`, `LanguageModelService.stream_complete` and `LanguageModelService.stream_complete_async`
+
+## [0.5.39] - 2024-12-09
+- Add `contentIds` to `Search.create` and `Search.create_async`
+- Use `metadata_filter` from event in `ContentService.search_content_chunks` and `ContentService.async_search_content_chunks` as default.
+
 ## [0.5.38] - 2024-11-26
 - Added string representation to `LanguageModelMessage` and `LanguageModelMessages` class
 

{unique_toolkit-0.5.38.dist-info → unique_toolkit-0.5.40.dist-info}/RECORD

@@ -17,7 +17,7 @@ unique_toolkit/chat/state.py,sha256=Cjgwv_2vhDFbV69xxsn7SefhaoIAEqLx3ferdVFCnOg,
 unique_toolkit/chat/utils.py,sha256=ihm-wQykBWhB4liR3LnwPVPt_qGW6ETq21Mw4HY0THE,854
 unique_toolkit/content/__init__.py,sha256=MSH2sxjQyKD2Sef92fzE5Dt9SihdzivB6yliSwJfTmQ,890
 unique_toolkit/content/schemas.py,sha256=zks_Pkki2VhxICJJgHZyc-LPmRuj5dLbw3pgcUT7SW8,2362
-unique_toolkit/content/service.py,sha256=e23GX2pzIppHCFPUHng-82pSELT8JKT4TRMCO6M2Lok,16968
+unique_toolkit/content/service.py,sha256=rznSUyOuB4nbo6bFworzFv86kzo6TVT4Nc8GMAeAJB4,17711
 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
@@ -38,9 +38,9 @@ unique_toolkit/evaluators/schemas.py,sha256=Jaue6Uhx75X1CyHKWj8sT3RE1JZXTqoLtfLt
 unique_toolkit/language_model/__init__.py,sha256=YuhyczGPj6w9xX-sOVUhmozvzIFxcckHFEkeMBecr5s,1784
 unique_toolkit/language_model/infos.py,sha256=kQK6F3r8xTN7oT6b39J7rxW-Y4iPXjx_Fr9bCOVQdm0,12509
 unique_toolkit/language_model/schemas.py,sha256=wg_ly66UvLOVNdrq8xr-0uN0HPY41UIk5mVPxdG-VGs,6687
-unique_toolkit/language_model/service.py,sha256=s5X6EStyYumiYqlD9gkW4GANif18d9QZOMysmUSfv8M,13433
+unique_toolkit/language_model/service.py,sha256=brNCPRA0XxgqHi2rI5i2lyFCkUiw4MNMe1VaR3UgWmY,15500
 unique_toolkit/language_model/utils.py,sha256=bPQ4l6_YO71w-zaIPanUUmtbXC1_hCvLK0tAFc3VCRc,1902
-unique_toolkit-0.5.38.dist-info/LICENSE,sha256=GlN8wHNdh53xwOPg44URnwag6TEolCjoq3YD_KrWgss,193
-unique_toolkit-0.5.38.dist-info/METADATA,sha256=gjQLXWLmCmcvUCIEAF6k2_LKj8muzzR6r2m9BvOQxqQ,14180
-unique_toolkit-0.5.38.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-unique_toolkit-0.5.38.dist-info/RECORD,,
+unique_toolkit-0.5.40.dist-info/LICENSE,sha256=GlN8wHNdh53xwOPg44URnwag6TEolCjoq3YD_KrWgss,193
+unique_toolkit-0.5.40.dist-info/METADATA,sha256=JwqJSWAYTZJJ0Z47C7iezCZgO3BUqysc5odUtlrkWKE,14620
+unique_toolkit-0.5.40.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+unique_toolkit-0.5.40.dist-info/RECORD,,