unique_toolkit 1.9.0__py3-none-any.whl → 1.10.0__py3-none-any.whl

unique_toolkit/chat/service.py

@@ -1,9 +1,11 @@
 import logging
+from typing import Any
 
+import unique_sdk
 from openai.types.chat.chat_completion_message_param import ChatCompletionMessageParam
 from typing_extensions import deprecated
 
-from unique_toolkit.app.schemas import ChatEvent, Event
+from unique_toolkit._common.utils.files import is_file_content, is_image_content
 from unique_toolkit.chat.constants import (
     DEFAULT_MAX_MESSAGES,
     DEFAULT_PERCENT_OF_MAX_TOKENS,
@@ -47,7 +49,16 @@ from unique_toolkit.chat.schemas import (
     MessageLogStatus,
     MessageLogUncitedReferences,
 )
-from unique_toolkit.content.schemas import ContentChunk, ContentReference
+from unique_toolkit.content.functions import (
+    download_content_to_bytes,
+    search_contents,
+    upload_content_from_bytes,
+)
+from unique_toolkit.content.schemas import (
+    Content,
+    ContentChunk,
+    ContentReference,
+)
 from unique_toolkit.language_model.constants import (
     DEFAULT_COMPLETE_TEMPERATURE,
     DEFAULT_COMPLETE_TIMEOUT,
@@ -63,6 +74,7 @@ from unique_toolkit.language_model.schemas import (
     LanguageModelToolDescription,
 )
 
+from .deprecated.service import ChatServiceDeprecated
 from .functions import (
     stream_complete_with_references,
     stream_complete_with_references_async,
@@ -71,214 +83,9 @@ from .functions import (
 logger = logging.getLogger(f"toolkit.{DOMAIN_NAME}.{__name__}")
 
 
-class ChatService:
+class ChatService(ChatServiceDeprecated):
     """Provides all functionalities to manage the chat session."""
 
-    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
-
     async def update_debug_info_async(self, debug_info: dict):
         """Updates the debug information for the chat session.
 
@@ -297,25 +104,6 @@ class ChatService:
             debug_info=debug_info,
         )
 
-    @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,
-        )
-
     def replace_debug_info(self, debug_info: dict):
         """Replace the debug information in the last user message
 
@@ -334,6 +122,9 @@ class ChatService:
             debug_info=debug_info,
         )
 
+    # Message Methods
+    ############################################################################
+
     def modify_user_message(
         self,
         content: str,
@@ -496,108 +287,6 @@ class ChatService:
             set_completed_at=set_completed_at or False,
         )
 
-    def free_user_input(self) -> None:
-        """Unblocks the next user input"""
-        self.modify_assistant_message(set_completed_at=True)
-
-    def get_full_history(self) -> list[ChatMessage]:
-        """Loads the full chat history for the chat session synchronously.
-
-        Returns:
-            list[ChatMessage]: The full chat history.
-
-        Raises:
-            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,
-        )
-
-    async def get_full_history_async(self) -> list[ChatMessage]:
-        """Loads the full chat history for the chat session asynchronously.
-
-        Returns:
-            list[ChatMessage]: The full chat history.
-
-        Raises:
-            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,
-        )
-
-    def get_full_and_selected_history(
-        self,
-        token_limit: int,
-        percent_of_max_tokens: float = DEFAULT_PERCENT_OF_MAX_TOKENS,
-        max_messages: int = DEFAULT_MAX_MESSAGES,
-    ) -> tuple[list[ChatMessage], list[ChatMessage]]:
-        """Loads the chat history for the chat session synchronously.
-
-        Args:
-            token_limit (int): The maximum number of tokens to load.
-            percent_of_max_tokens (float): The percentage of the maximum tokens to load. Defaults to 0.15.
-            max_messages (int): The maximum number of messages to load. Defaults to 4.
-
-        Returns:
-            tuple[list[ChatMessage], list[ChatMessage]]: The selected and full chat history.
-
-        Raises:
-            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,
-        )
-        selected_history = get_selection_from_history(
-            full_history=full_history,
-            max_tokens=int(round(token_limit * percent_of_max_tokens)),
-            max_messages=max_messages,
-        )
-
-        return full_history, selected_history
-
-    async def get_full_and_selected_history_async(
-        self,
-        token_limit: int,
-        percent_of_max_tokens: float = DEFAULT_PERCENT_OF_MAX_TOKENS,
-        max_messages: int = DEFAULT_MAX_MESSAGES,
-    ) -> tuple[list[ChatMessage], list[ChatMessage]]:
-        """Loads the chat history for the chat session asynchronously.
-
-        Args:
-            token_limit (int): The maximum number of tokens to load.
-            percent_of_max_tokens (float): The percentage of the maximum tokens to load. Defaults to 0.15.
-            max_messages (int): The maximum number of messages to load. Defaults to 4.
-
-        Returns:
-            tuple[list[ChatMessage], list[ChatMessage]]: The selected and full chat history.
-
-        Raises:
-            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,
-        )
-        selected_history = get_selection_from_history(
-            full_history=full_history,
-            max_tokens=int(round(token_limit * percent_of_max_tokens)),
-            max_messages=max_messages,
-        )
-
-        return full_history, selected_history
-
     def create_assistant_message(
         self,
         content: str,
@@ -678,7 +367,6 @@ class ChatService:
         self._assistant_message_id = chat_message.id or "unknown"
         return chat_message
 
-    @deprecated("Not working at the moment.")
     def create_user_message(
         self,
         content: str,
@@ -759,6 +447,114 @@ class ChatService:
         self._user_message_id = chat_message.id or "unknown"
         return chat_message
 
+    def free_user_input(self) -> None:
+        """Unblocks the next user input"""
+        self.modify_assistant_message(set_completed_at=True)
+
+    # History Methods
+    ############################################################################
+
+    def get_full_history(self) -> list[ChatMessage]:
+        """Loads the full chat history for the chat session synchronously.
+
+        Returns:
+            list[ChatMessage]: The full chat history.
+
+        Raises:
+            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,
+        )
+
+    async def get_full_history_async(self) -> list[ChatMessage]:
+        """Loads the full chat history for the chat session asynchronously.
+
+        Returns:
+            list[ChatMessage]: The full chat history.
+
+        Raises:
+            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,
+        )
+
+    def get_full_and_selected_history(
+        self,
+        token_limit: int,
+        percent_of_max_tokens: float = DEFAULT_PERCENT_OF_MAX_TOKENS,
+        max_messages: int = DEFAULT_MAX_MESSAGES,
+    ) -> tuple[list[ChatMessage], list[ChatMessage]]:
+        """Loads the chat history for the chat session synchronously.
+
+        Args:
+            token_limit (int): The maximum number of tokens to load.
+            percent_of_max_tokens (float): The percentage of the maximum tokens to load. Defaults to 0.15.
+            max_messages (int): The maximum number of messages to load. Defaults to 4.
+
+        Returns:
+            tuple[list[ChatMessage], list[ChatMessage]]: The selected and full chat history.
+
+        Raises:
+            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,
+        )
+        selected_history = get_selection_from_history(
+            full_history=full_history,
+            max_tokens=int(round(token_limit * percent_of_max_tokens)),
+            max_messages=max_messages,
+        )
+
+        return full_history, selected_history
+
+    async def get_full_and_selected_history_async(
+        self,
+        token_limit: int,
+        percent_of_max_tokens: float = DEFAULT_PERCENT_OF_MAX_TOKENS,
+        max_messages: int = DEFAULT_MAX_MESSAGES,
+    ) -> tuple[list[ChatMessage], list[ChatMessage]]:
+        """Loads the chat history for the chat session asynchronously.
+
+        Args:
+            token_limit (int): The maximum number of tokens to load.
+            percent_of_max_tokens (float): The percentage of the maximum tokens to load. Defaults to 0.15.
+            max_messages (int): The maximum number of messages to load. Defaults to 4.
+
+        Returns:
+            tuple[list[ChatMessage], list[ChatMessage]]: The selected and full chat history.
+
+        Raises:
+            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,
+        )
+        selected_history = get_selection_from_history(
+            full_history=full_history,
+            max_tokens=int(round(token_limit * percent_of_max_tokens)),
+            max_messages=max_messages,
+        )
+
+        return full_history, selected_history
+
+    # Message Assessment Methods
+    ############################################################################
+
     def create_message_assessment(
         self,
         assistant_message_id: str,
@@ -913,6 +709,9 @@ class ChatService:
             label=label,
         )
 
+    # Message Log Methods
+    ############################################################################
+
     def create_message_log(
         self,
         message_id: str,
@@ -1149,6 +948,9 @@ class ChatService:
             references=references,
         )
 
+    # Message Execution Methods
+    ############################################################################
+
     def create_message_execution(
         self,
         message_id: str,
@@ -1465,6 +1267,9 @@ class ChatService:
             percentage_completed=percentage_completed,
         )
 
+    # Language Model Methods
+    ############################################################################
+
     @deprecated("Use complete_with_references instead")
     def stream_complete(
         self,
@@ -1628,3 +1433,53 @@ class ChatService:
         )
 
         return LanguageModelResponse.from_stream_response(await response)
+
+    # Chat Content Methods
+    ############################################################################
+
+    def upload_to_chat_from_bytes(
+        self,
+        *,
+        content: bytes,
+        content_name: str,
+        mime_type: str,
+        scope_id: str | None = None,
+        skip_ingestion: bool = False,
+        ingestion_config: unique_sdk.Content.IngestionConfig | None = None,
+        metadata: dict[str, Any] | None = None,
+    ) -> Content:
+        return upload_content_from_bytes(
+            user_id=self._user_id,
+            company_id=self._company_id,
+            content=content,
+            content_name=content_name,
+            mime_type=mime_type,
+            scope_id=scope_id,
+            chat_id=self._chat_id,
+            skip_ingestion=skip_ingestion,
+            ingestion_config=ingestion_config,
+            metadata=metadata,
+        )
+
+    def download_chat_content_to_bytes(self, *, content_id: str) -> bytes:
+        return download_content_to_bytes(
+            user_id=self._user_id,
+            company_id=self._company_id,
+            content_id=content_id,
+            chat_id=self._chat_id,
+        )
+
+    def download_chat_images_and_documents(self) -> tuple[list[Content], list[Content]]:
+        images: list[Content] = []
+        files: list[Content] = []
+        for c in search_contents(
+            user_id=self._user_id,
+            company_id=self._company_id,
+            chat_id=self._chat_id,
+            where={"ownerId": {"equals": self._chat_id}},
+        ):
+            if is_file_content(filename=c.key):
+                files.append(c)
+            if is_image_content(filename=c.key):
+                images.append(c)
+        return images, files

unique_toolkit/content/functions.py

@@ -13,8 +13,10 @@ from unique_toolkit.content.constants import DEFAULT_SEARCH_LANGUAGE
 from unique_toolkit.content.schemas import (
     Content,
     ContentChunk,
+    ContentInfo,
     ContentRerankerConfig,
     ContentSearchType,
+    PaginatedContentInfo,
 )
 from unique_toolkit.content.utils import map_contents, map_to_content_chunks
 
@@ -429,7 +431,7 @@ def _trigger_upload_content(
             scope_id=scope_id,
         )  # type: ignore
 
-    return Content(**created_content)
+    return Content.model_validate(created_content, by_alias=True, by_name=True)
 
 
 def request_content_by_id(
@@ -577,3 +579,59 @@ def download_content(
         raise Exception(error_msg)
 
     return content_path
+
+
+def get_content_info(
+    user_id: str,
+    company_id: str,
+    metadata_filter: dict[str, Any] | None = None,
+    skip: int | None = None,
+    take: int | None = None,
+    file_path: str | None = None,
+):
+    """Gets the info of a content."""
+    get_info_params = unique_sdk.Content.ContentInfoParams(
+        metadataFilter=metadata_filter,
+        skip=skip,
+        take=take,
+        filePath=file_path,
+    )
+
+    content_info = unique_sdk.Content.get_info(
+        user_id=user_id, company_id=company_id, **get_info_params
+    )
+    return PaginatedContentInfo.model_validate(
+        content_info, by_alias=True, by_name=True
+    )
+
+
+def update_content(
+    user_id: str,
+    company_id: str,
+    *,
+    content_id: str,
+    metadata: dict[str, Any],
+    file_path: str | None = None,
+    owner_id: str | None = None,
+    parent_folder_path: str | None = None,
+    title: str | None = None,
+) -> ContentInfo:
+    """Updates the metadata of a content."""
+
+    update_params = unique_sdk.Content.UpdateParams(
+        contentId=content_id, metadata=metadata
+    )
+
+    if file_path:
+        update_params["filePath"] = file_path
+    if owner_id:
+        update_params["ownerId"] = owner_id
+    if parent_folder_path:
+        update_params["parentFolderPath"] = parent_folder_path
+    if title:
+        update_params["title"] = title
+
+    content_info = unique_sdk.Content.update(
+        user_id=user_id, company_id=company_id, **update_params
+    )
+    return ContentInfo.model_validate(content_info, by_alias=True, by_name=True)

unique_toolkit/content/schemas.py

@@ -149,3 +149,26 @@ class ContentRerankerConfig(BaseModel):
     model_config = model_config
     deployment_name: str = Field(serialization_alias="deploymentName")
     options: dict | None = None
+
+
+class ContentInfo(BaseModel):
+    model_config = model_config
+    id: str
+    key: str
+    url: str | None = None
+    title: str | None = None
+    metadata: dict[str, Any] | None = None
+    mime_type: str
+    byte_size: int
+    owner_id: str
+    created_at: datetime
+    updated_at: datetime
+    expires_at: datetime | None = None
+    deleted_at: datetime | None = None
+    expired_at: datetime | None = None
+
+
+class PaginatedContentInfo(BaseModel):
+    model_config = model_config
+    content_info: list[ContentInfo]
+    total_count: int