unique_toolkit 1.13.0__tar.gz → 1.14.0__tar.gz

{unique_toolkit-1.13.0 → unique_toolkit-1.14.0}/CHANGELOG.md

@@ -5,6 +5,9 @@ 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.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.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: unique_toolkit
-Version: 1.13.0
+Version: 1.14.0
 Summary: 
 License: Proprietary
 Author: Cedric Klinkert
@@ -118,6 +118,9 @@ 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.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.0}/pyproject.toml

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

{unique_toolkit-1.13.0 → unique_toolkit-1.14.0}/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,