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

unique_toolkit/agentic/tools/utils/execution/execution.py

@@ -16,7 +16,7 @@ P = ParamSpec("P")
 R = TypeVar("R")
 
 
-logger = logging.getLogger(__name__)
+_logger = logging.getLogger(__name__)
 
 
 class Result(Generic[R]):
@@ -87,7 +87,7 @@ class SafeTaskExecutor:
         self._ignored_exceptions = tuple(ignored_exceptions)
         self._log_exceptions = log_exceptions
         self._log_exc_info = log_exc_info
-        self._logger = logger
+        self._logger = logger or _logger
 
     def execute(
         self, f: Callable[P, R], *args: P.args, **kwargs: P.kwargs
@@ -98,7 +98,9 @@ class SafeTaskExecutor:
             if isinstance(e, self._ignored_exceptions):
                 raise e
             if self._log_exceptions:
-                logger.error(f"Error in {f.__name__}: {e}", exc_info=self._log_exc_info)
+                self._logger.error(
+                    f"Error in {f.__name__}: {e}", exc_info=self._log_exc_info
+                )
             return Result(False, exception=e)
 
     async def execute_async(
@@ -110,7 +112,9 @@ class SafeTaskExecutor:
             if isinstance(e, self._ignored_exceptions):
                 raise e
             if self._log_exceptions:
-                logger.error(f"Error in {f.__name__}: {e}", exc_info=self._log_exc_info)
+                self._logger.error(
+                    f"Error in {f.__name__}: {e}", exc_info=self._log_exc_info
+                )
             return Result(False, exception=e)
 
 

unique_toolkit/agentic/tools/utils/source_handling/schema.py

@@ -1,7 +1,7 @@
 # default schema follows logic in node-ingestion-worker: https://github.com/Unique-AG/monorepo/blob/76b4923611199a80abf9304639b3aa0538ec41ed/node/apps/node-ingestion-worker/src/ingestors/lib/text-manipulations.ts#L181C17-L181C28
 from pydantic import BaseModel
 
-from unique_toolkit.agentic.tools.config import get_configuration_dict
+from unique_toolkit._common.pydantic_helpers import get_configuration_dict
 
 SOURCE_TEMPLATE = "<source${index}>${document}${info}${text}</source${index}>"
 SECTIONS = {

unique_toolkit/chat/__init__.py

@@ -1,3 +1,5 @@
+import warnings
+
 from .constants import DOMAIN_NAME as DOMAIN_NAME
 from .schemas import ChatMessage as ChatMessage
 from .schemas import ChatMessageAssessment as ChatMessageAssessment
@@ -5,7 +7,12 @@ from .schemas import ChatMessageAssessmentLabel as ChatMessageAssessmentLabel
 from .schemas import ChatMessageAssessmentStatus as ChatMessageAssessmentStatus
 from .schemas import ChatMessageAssessmentType as ChatMessageAssessmentType
 from .schemas import ChatMessageRole as ChatMessageRole
-from .service import ChatService as ChatService
+
+# Import ChatService with deprecation warning suppressed for internal use
+with warnings.catch_warnings():
+    warnings.simplefilter("ignore", DeprecationWarning)
+    from .service import ChatService as ChatService
+
 from .utils import (
     convert_chat_history_to_injectable_string as convert_chat_history_to_injectable_string,
 )

unique_toolkit/chat/deprecated/service.py

@@ -0,0 +1,232 @@
+from typing_extensions import deprecated
+
+from unique_toolkit.app.schemas import ChatEvent, Event
+from unique_toolkit.chat.functions import (
+    modify_message,
+)
+
+
+class ChatServiceDeprecated:
+    def __init__(self, event: ChatEvent | Event):
+        self._event = event
+        self._company_id: str = event.company_id
+        self._user_id: str = event.user_id
+        self._assistant_message_id: str = event.payload.assistant_message.id
+        self._user_message_id: str = event.payload.user_message.id
+        self._chat_id: str = event.payload.chat_id
+        self._assistant_id: str = event.payload.assistant_id
+        self._user_message_text: str = event.payload.user_message.text
+
+    @property
+    @deprecated(
+        "The event property is deprecated and will be removed in a future version.",
+    )
+    def event(self) -> Event | ChatEvent:
+        """Get the event object (deprecated).
+
+        Returns:
+            Event | BaseEvent | None: The event object.
+
+        """
+        return self._event
+
+    @property
+    @deprecated(
+        "The company_id property is deprecated and will be removed in a future version.",
+    )
+    def company_id(self) -> str:
+        """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:
+        """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 assistant_message_id property is deprecated and will be removed in a future version.",
+    )
+    def assistant_message_id(self) -> str:
+        """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:
+        """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:
+        """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:
+        """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:
+        """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:
+        """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:
+        """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:
+        """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:
+        """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:
+        """Set the user message text (deprecated).
+
+        Args:
+            value (str | None): The user message text.
+
+        """
+        self._user_message_text = value
+
+    @deprecated("Use `replace_debug_info`")
+    def update_debug_info(self, debug_info: dict):
+        """Updates the debug information for the chat session.
+
+        Args:
+            debug_info (dict): The new debug information.
+
+        """
+        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,
+            assistant=False,
+            debug_info=debug_info,
+        )

unique_toolkit/chat/functions.py

@@ -1,13 +1,18 @@
 import logging
 import re
-from typing import Any
+from typing import Any, Sequence
 
 import unique_sdk
+from openai.types.chat import ChatCompletionToolChoiceOptionParam
+from openai.types.chat.chat_completion_message_param import ChatCompletionMessageParam
+from pydantic import BaseModel
 from typing_extensions import deprecated
 from unique_sdk._list_object import ListObject
 
 from unique_toolkit._common import _time_utils
-from unique_toolkit.chat.constants import DEFAULT_MAX_MESSAGES
+from unique_toolkit.chat.constants import (
+    DEFAULT_MAX_MESSAGES,
+)
 from unique_toolkit.chat.schemas import (
     ChatMessage,
     ChatMessageAssessment,
@@ -30,10 +35,11 @@ from unique_toolkit.language_model.constants import (
     DEFAULT_COMPLETE_TIMEOUT,
 )
 from unique_toolkit.language_model.functions import (
-    ChatCompletionMessageParam,
     _prepare_all_completions_params_util,
 )
-from unique_toolkit.language_model.infos import LanguageModelName
+from unique_toolkit.language_model.infos import (
+    LanguageModelName,
+)
 from unique_toolkit.language_model.schemas import (
     LanguageModelMessages,
     LanguageModelStreamResponse,
@@ -761,8 +767,9 @@ def stream_complete_with_references(
     debug_info: dict | None = None,
     temperature: float = DEFAULT_COMPLETE_TEMPERATURE,
     timeout: int = DEFAULT_COMPLETE_TIMEOUT,
-    tools: list[LanguageModelTool | LanguageModelToolDescription] | None = None,
+    tools: Sequence[LanguageModelTool | LanguageModelToolDescription] | None = None,
     start_text: str | None = None,
+    tool_choice: ChatCompletionToolChoiceOptionParam | None = None,
     other_options: dict | None = None,
 ) -> LanguageModelStreamResponse:
     """Streams a completion synchronously.
@@ -795,6 +802,7 @@ def stream_complete_with_references(
             temperature=temperature,
             tools=tools,
             other_options=other_options,
+            tool_choice=tool_choice,
             content_chunks=content_chunks or [],
         )
     )
@@ -871,7 +879,8 @@ async def stream_complete_with_references_async(
     debug_info: dict | None = None,
     temperature: float = DEFAULT_COMPLETE_TEMPERATURE,
     timeout: int = DEFAULT_COMPLETE_TIMEOUT,
-    tools: list[LanguageModelTool | LanguageModelToolDescription] | None = None,
+    tools: Sequence[LanguageModelTool | LanguageModelToolDescription] | None = None,
+    tool_choice: ChatCompletionToolChoiceOptionParam | None = None,
     start_text: str | None = None,
     other_options: dict | None = None,
 ) -> LanguageModelStreamResponse:
@@ -889,6 +898,7 @@ async def stream_complete_with_references_async(
             model_name=model_name,
             temperature=temperature,
             tools=tools,
+            tool_choice=tool_choice,
             other_options=other_options,
             content_chunks=content_chunks or [],
         )
@@ -916,6 +926,12 @@ async def stream_complete_with_references_async(
         raise e
 
 
+def _get_model_dump_or_none(model: BaseModel | None) -> dict | None:
+    if model is None:
+        return None
+    return model.model_dump()
+
+
 def create_message_log(
     user_id: str,
     company_id: str,
@@ -948,6 +964,9 @@ def create_message_log(
 
     """
     try:
+        references_list = (
+            map_references_with_original_index(references) if references else None
+        )
         message_log = unique_sdk.MessageLog.create(
             user_id=user_id,
             company_id=company_id,
@@ -955,13 +974,9 @@ def create_message_log(
             text=text,
             status=status.value,
             order=order,
-            details=details.model_dump() if details else None,
-            uncitedReferences=uncited_references.model_dump()
-            if uncited_references
-            else None,
-            references=map_references_with_original_index(references)
-            if references
-            else [],  # type: ignore
+            details=_get_model_dump_or_none(details),
+            uncitedReferences=_get_model_dump_or_none(uncited_references),
+            references=references_list,  # type: ignore
         )
         return MessageLog(**message_log)
     except Exception as e:
@@ -1001,6 +1016,9 @@ async def create_message_log_async(
 
     """
     try:
+        references_list = (
+            map_references_with_original_index(references) if references else None
+        )
         message_log = await unique_sdk.MessageLog.create_async(
             user_id=user_id,
             company_id=company_id,
@@ -1008,13 +1026,9 @@ async def create_message_log_async(
             text=text,
             status=status.value,
             order=order,
-            details=details.model_dump() if details else None,
-            uncitedReferences=uncited_references.model_dump()
-            if uncited_references
-            else None,
-            references=map_references_with_original_index(references)
-            if references
-            else [],  # type: ignore
+            details=_get_model_dump_or_none(details),
+            uncitedReferences=_get_model_dump_or_none(uncited_references),
+            references=references_list,  # type: ignore
         )
         return MessageLog(**message_log)
     except Exception as e:
@@ -1054,6 +1068,9 @@ def update_message_log(
 
     """
     try:
+        references_list = (
+            map_references_with_original_index(references) if references else None
+        )
         message_log = unique_sdk.MessageLog.update(
             user_id=user_id,
             company_id=company_id,
@@ -1061,13 +1078,9 @@ def update_message_log(
             text=text,
             status=status.value if status else None,
             order=order,
-            details=details.model_dump() if details else None,
-            uncitedReferences=uncited_references.model_dump()
-            if uncited_references
-            else None,
-            references=map_references_with_original_index(references)
-            if references
-            else [],  # type: ignore
+            details=_get_model_dump_or_none(details),
+            uncitedReferences=_get_model_dump_or_none(uncited_references),
+            references=references_list,  # type: ignore
         )
         return MessageLog(**message_log)
     except Exception as e:
@@ -1107,6 +1120,9 @@ async def update_message_log_async(
 
     """
     try:
+        references_list = (
+            map_references_with_original_index(references) if references else None
+        )
         message_log = await unique_sdk.MessageLog.update_async(
             user_id=user_id,
             company_id=company_id,
@@ -1114,13 +1130,9 @@ async def update_message_log_async(
             text=text,
             status=status.value if status else None,
             order=order,
-            details=details.model_dump() if details else None,
-            uncitedReferences=uncited_references.model_dump()
-            if uncited_references
-            else None,
-            references=map_references_with_original_index(references)
-            if references
-            else [],  # type: ignore
+            details=_get_model_dump_or_none(details),
+            uncitedReferences=_get_model_dump_or_none(uncited_references),
+            references=references_list,  # type: ignore
         )
         return MessageLog(**message_log)
     except Exception as e:
@@ -1280,7 +1292,7 @@ def update_message_execution(
     user_id: str,
     company_id: str,
     message_id: str,
-    status: MessageExecutionUpdateStatus,
+    status: MessageExecutionUpdateStatus | None = None,
     seconds_remaining: int | None = None,
     percentage_completed: int | None = None,
 ) -> MessageExecution:
@@ -1290,7 +1302,7 @@ def update_message_execution(
         user_id (str): The user ID.
         company_id (str): The company ID.
         message_id (str): The ID of the message to update execution for.
-        status (MessageExecutionUpdateStatus): The updated status (COMPLETED or FAILED).
+        status (MessageExecutionUpdateStatus | None): The updated status (COMPLETED or FAILED). Defaults to None.
         seconds_remaining (int | None): Updated estimated seconds remaining.
         percentage_completed (int | None): Updated percentage of completion (0-100).
 
@@ -1302,11 +1314,12 @@ def update_message_execution(
 
     """
     try:
+        status_value = status.value if status else None
         message_execution = unique_sdk.MessageExecution.update(
             user_id=user_id,
             company_id=company_id,
             messageId=message_id,
-            status=status.value,
+            status=status_value,
             secondsRemaining=seconds_remaining,
             percentageCompleted=percentage_completed,
         )
@@ -1320,7 +1333,7 @@ async def update_message_execution_async(
     user_id: str,
     company_id: str,
     message_id: str,
-    status: MessageExecutionUpdateStatus,
+    status: MessageExecutionUpdateStatus | None = None,
     seconds_remaining: int | None = None,
     percentage_completed: int | None = None,
 ) -> MessageExecution:
@@ -1330,7 +1343,7 @@ async def update_message_execution_async(
         user_id (str): The user ID.
         company_id (str): The company ID.
         message_id (str): The ID of the message to update execution for.
-        status (MessageExecutionUpdateStatus): The updated status (COMPLETED or FAILED).
+        status (MessageExecutionUpdateStatus | None): The updated status (COMPLETED or FAILED). Defaults to None.
         seconds_remaining (int | None): Updated estimated seconds remaining.
         percentage_completed (int | None): Updated percentage of completion (0-100).
 
@@ -1342,11 +1355,12 @@ async def update_message_execution_async(
 
     """
     try:
+        status_value = status.value if status else None
         message_execution = await unique_sdk.MessageExecution.update_async(
             user_id=user_id,
             company_id=company_id,
             messageId=message_id,
-            status=status.value,
+            status=status_value,
             secondsRemaining=seconds_remaining,
             percentageCompleted=percentage_completed,
         )

unique_toolkit/chat/rendering.py

@@ -0,0 +1,34 @@
+from urllib.parse import quote
+
+
+def create_prompt_button_string(
+    *,
+    button_text: str,
+    next_user_message: str,
+) -> str:
+    """
+    Create a prompt button string.
+
+    Args:
+        button_text: The text of the button.
+        next_user_message: The message to send when the button is clicked.
+
+    Returns:
+        A string that can be used to create a prompt button.
+        A prompt button includes the `next_user_message` to the user prompt windown.
+    """
+    next_user_message = quote(next_user_message)
+    return f"[{button_text}](https://prompt={next_user_message})"
+
+
+def create_latex_formula_string(latex_expression: str) -> str:
+    """
+    Create a LaTeX string.
+
+    Args:
+        latex_expression: The LaTeX expression to create.
+
+    Returns:
+        A string that can be used to create a LaTeX string.
+    """
+    return f"\\[{latex_expression}\\]"