unique_toolkit 1.13.0__tar.gz → 1.14.1__tar.gz

{unique_toolkit-1.13.0 → unique_toolkit-1.14.1}/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).
 
+## [1.14.1] - 2025-10-08
+- Add utilities for testing
+
+## [1.14.0] - 2025-10-07
+- Manipulate Metadata with knowledge base service
+
 ## [1.13.0] - 2025-10-07
 - Delete contents with knowledge base service
 

{unique_toolkit-1.13.0 → unique_toolkit-1.14.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: unique_toolkit
-Version: 1.13.0
+Version: 1.14.1
 Summary: 
 License: Proprietary
 Author: Cedric Klinkert
@@ -118,6 +118,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).
 
+## [1.14.1] - 2025-10-08
+- Add utilities for testing
+
+## [1.14.0] - 2025-10-07
+- Manipulate Metadata with knowledge base service
+
 ## [1.13.0] - 2025-10-07
 - Delete contents with knowledge base service
 

{unique_toolkit-1.13.0 → unique_toolkit-1.14.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "unique_toolkit"
-version = "1.13.0"
+version = "1.14.1"
 description = ""
 authors = [
     "Cedric Klinkert <cedric.klinkert@unique.ch>",

{unique_toolkit-1.13.0 → unique_toolkit-1.14.1}/unique_toolkit/knowledge_base.py

@@ -3,6 +3,7 @@ import logging
 from pathlib import Path
 from typing import Any, overload
 
+import humps
 import unique_sdk
 
 from unique_toolkit._common.validate_required_values import validate_required_values
@@ -589,6 +590,138 @@ class KnowledgeBaseService:
 
         return self._resolve_visible_file_tree(content_infos=info.content_infos)
 
+    def _pop_forbidden_metadata_keys(self, metadata: dict[str, Any]) -> dict[str, Any]:
+        forbidden_keys = [
+            "key",
+            "url",
+            "title",
+            "folderId",
+            "mimeType",
+            "companyId",
+            "contentId",
+            "folderIdPath",
+            "externalFileOwner",
+        ]
+        for key in forbidden_keys:
+            metadata.pop(key, None)
+        return metadata
+
+    def update_content_metadata(
+        self,
+        *,
+        content_info: ContentInfo,
+        additional_metadata: dict[str, Any],
+    ) -> ContentInfo:
+        camelized_additional_metadata = humps.camelize(additional_metadata)
+        camelized_additional_metadata = self._pop_forbidden_metadata_keys(
+            camelized_additional_metadata
+        )
+
+        if content_info.metadata is not None:
+            content_info.metadata.update(camelized_additional_metadata)
+        else:
+            content_info.metadata = camelized_additional_metadata
+
+        return update_content(
+            user_id=self._user_id,
+            company_id=self._company_id,
+            content_id=content_info.id,
+            metadata=content_info.metadata,
+        )
+
+    def remove_content_metadata(
+        self,
+        *,
+        content_info: ContentInfo,
+        keys_to_remove: list[str],
+    ) -> ContentInfo:
+        """
+        Removes the specified keys irreversibly from the content metadata.
+        """
+
+        if content_info.metadata is None:
+            _LOGGER.warning(f"Content metadata is None for content {content_info.id}")
+            return content_info
+
+        for key in keys_to_remove:
+            content_info.metadata.pop(key, None)
+
+        return update_content(
+            user_id=self._user_id,
+            company_id=self._company_id,
+            content_id=content_info.id,
+            metadata=content_info.metadata or {},
+        )
+
+    @overload
+    def update_contents_metadata(
+        self,
+        *,
+        additional_metadata: dict[str, Any],
+        content_infos: list[ContentInfo],
+    ) -> list[ContentInfo]: ...
+
+    @overload
+    def update_contents_metadata(
+        self, *, additional_metadata: dict[str, Any], metadata_filter: dict[str, Any]
+    ) -> list[ContentInfo]: ...
+
+    def update_contents_metadata(
+        self,
+        *,
+        additional_metadata: dict[str, Any],
+        metadata_filter: dict[str, Any] | None = None,
+        content_infos: list[ContentInfo] | None = None,
+    ) -> list[ContentInfo]:
+        additional_metadata_camelized = humps.camelize(additional_metadata)
+        additional_metadata_camelized = self._pop_forbidden_metadata_keys(
+            additional_metadata_camelized
+        )
+
+        if content_infos is None:
+            content_infos = self.get_paginated_content_infos(
+                metadata_filter=metadata_filter,
+            ).content_infos
+
+        for info in content_infos:
+            self.update_content_metadata(
+                content_info=info, additional_metadata=additional_metadata_camelized
+            )
+
+        return content_infos
+
+    @overload
+    def remove_contents_metadata(
+        self,
+        *,
+        keys_to_remove: list[str],
+        content_infos: list[ContentInfo],
+    ) -> list[ContentInfo]: ...
+
+    @overload
+    def remove_contents_metadata(
+        self, *, keys_to_remove: list[str], metadata_filter: dict[str, Any]
+    ) -> list[ContentInfo]: ...
+
+    def remove_contents_metadata(
+        self,
+        *,
+        keys_to_remove: list[str],
+        metadata_filter: dict[str, Any] | None = None,
+        content_infos: list[ContentInfo] | None = None,
+    ) -> list[ContentInfo]:
+        if content_infos is None:
+            content_infos = self.get_paginated_content_infos(
+                metadata_filter=metadata_filter,
+            ).content_infos
+
+        for info in content_infos:
+            self.remove_content_metadata(
+                content_info=info, keys_to_remove=keys_to_remove
+            )
+
+        return content_infos
+
     @overload
     def delete_content(
         self,

unique_toolkit-1.14.1/unique_toolkit/test_utilities/events.py

@@ -0,0 +1,195 @@
+import random
+import string
+from datetime import datetime
+from typing import TYPE_CHECKING
+
+from unique_toolkit.app.schemas import (
+    BaseEvent,
+    ChatEvent,
+    ChatEventAdditionalParameters,
+    ChatEventAssistantMessage,
+    ChatEventPayload,
+    ChatEventUserMessage,
+    EventName,
+)
+
+if TYPE_CHECKING:
+    from typing import Any
+
+    from unique_toolkit.app.unique_settings import UniqueSettings
+
+
+def generated_numeric_string(length: int) -> str:
+    return "".join(random.choices(string.digits, k=length))
+
+
+def generated_alphanumeric_string(length: int) -> str:
+    return "".join(random.choices(string.ascii_letters + string.digits, k=length))
+
+
+def generated_chat_id() -> str:
+    return f"chat_{generated_alphanumeric_string(16)}"
+
+
+def generated_assistant_id() -> str:
+    return f"assistant_{generated_alphanumeric_string(16)}"
+
+
+def generated_user_message_id() -> str:
+    return f"msg_{generated_alphanumeric_string(16)}"
+
+
+class TestEventFactory:
+    """Factory for creating test event objects with sensible defaults.
+
+    Simplifies test setup by providing convenient methods to generate
+    chat events, messages, and related objects for testing.
+    """
+
+    def __init__(self, settings: UniqueSettings | None = None) -> None:
+        self._settings = settings
+
+    def _get_user_id(self) -> str:
+        if self._settings is None:
+            return generated_numeric_string(16)
+        else:
+            return self._settings.auth.user_id.get_secret_value()
+
+    def _get_company_id(self) -> str:
+        if self._settings is None:
+            return generated_numeric_string(16)
+        else:
+            return self._settings.auth.company_id.get_secret_value()
+
+    def get_chat_event_user_message(
+        self,
+        text: str,
+        *,
+        created_at: datetime | None = None,
+        language: str = "DE",
+        original_text: str | None = None,
+    ) -> ChatEventUserMessage:
+        if created_at is None:
+            created_at = datetime.now()
+
+        return ChatEventUserMessage(
+            id=generated_user_message_id(),
+            text=text,
+            original_text=original_text or text,
+            created_at=created_at.isoformat(),
+            language=language,
+        )
+
+    def get_chat_event_assistant_message(
+        self, *, created_at: datetime | None = None
+    ) -> ChatEventAssistantMessage:
+        if created_at is None:
+            created_at = datetime.now()
+
+        return ChatEventAssistantMessage(
+            id=generated_assistant_id(), created_at=created_at.isoformat()
+        )
+
+    def get_chat_event_additional_parameters(
+        self,
+        *,
+        translate_to_language: str | None = None,
+        content_id_to_translate: str | None = None,
+    ) -> ChatEventAdditionalParameters:
+        return ChatEventAdditionalParameters(
+            translate_to_language=translate_to_language,
+            content_id_to_translate=content_id_to_translate,
+        )
+
+    def get_base_event(
+        self,
+        *,
+        event: EventName = EventName.EXTERNAL_MODULE_CHOSEN,
+        user_id: str | None = None,
+        company_id: str | None = None,
+    ) -> BaseEvent:
+        return BaseEvent(
+            id=generated_alphanumeric_string(16),
+            event=event,
+            user_id=user_id or self._get_user_id(),
+            company_id=company_id or self._get_company_id(),
+        )
+
+    def get_chat_event_payload(
+        self,
+        *,
+        name: str,
+        description: str,
+        user_message_text: str,
+        user_message_created_at: datetime | None = None,
+        user_message_language: str = "DE",
+        user_message_original_text: str | None = None,
+        assistant_message_created_at: datetime | None = None,
+        configuration: dict[str, Any] | None = None,
+        chat_id: str | None = None,
+        assistant_id: str | None = None,
+    ) -> ChatEventPayload:
+        if chat_id is None:
+            chat_id = generated_chat_id()
+
+        if assistant_id is None:
+            assistant_id = generated_assistant_id()
+
+        assistant_message = self.get_chat_event_assistant_message(
+            created_at=assistant_message_created_at or datetime.now()
+        )
+        user_message = self.get_chat_event_user_message(
+            text=user_message_text,
+            created_at=user_message_created_at or datetime.now(),
+            language=user_message_language,
+            original_text=user_message_original_text,
+        )
+        return ChatEventPayload(
+            name=name,
+            description=description,
+            configuration=configuration or {},
+            chat_id=chat_id,
+            assistant_id=assistant_id,
+            user_message=user_message,
+            assistant_message=assistant_message,
+        )
+
+    def get_chat_event(
+        self,
+        *,
+        name: str,
+        event_name: EventName = EventName.EXTERNAL_MODULE_CHOSEN,
+        description: str,
+        user_message_text: str,
+        user_message_created_at: datetime = datetime.now(),
+        user_message_language: str = "DE",
+        user_message_original_text: str | None = None,
+        assistant_message_created_at: datetime | None = None,
+        configuration: dict[str, Any] | None = None,
+        chat_id: str = generated_chat_id(),
+        assistant_id: str = generated_assistant_id(),
+        user_id: str | None = None,
+        company_id: str | None = None,
+        version: str = "1.0",
+    ) -> ChatEvent:
+        payload = self.get_chat_event_payload(
+            name=name,
+            description=description,
+            user_message_text=user_message_text,
+            user_message_created_at=user_message_created_at,
+            user_message_language=user_message_language,
+            user_message_original_text=user_message_original_text,
+            assistant_message_created_at=assistant_message_created_at,
+            configuration=configuration or {},
+            chat_id=chat_id,
+            assistant_id=assistant_id,
+        )
+        return ChatEvent(
+            id=generated_alphanumeric_string(16),
+            event=event_name,
+            user_id=user_id or self._get_user_id(),
+            company_id=company_id or self._get_company_id(),
+            payload=payload,
+            created_at=int(datetime.now().timestamp()),
+            version=version,
+        )