[DRCC] Create and Update Metadata artifact content changes (#1129)

Author: kumar-shivam-ranjan

ads/common/utils.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python
 
-# Copyright (c) 2020, 2024 Oracle and/or its affiliates.
+# Copyright (c) 2020, 2025 Oracle and/or its affiliates.
 # Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
 
 
@@ -152,22 +152,6 @@ def oci_key_location():
     )
 
 
-def text_sanitizer(content):
-    if isinstance(content, str):
-        return (
-            content.replace("“", '"')
-            .replace("”", '"')
-            .replace("’", "'")
-            .replace("‘", "'")
-            .replace("—", "-")
-            .encode("utf-8", "ignore")
-            .decode("utf-8", "ignore")
-        )
-    if isinstance(content, dict):
-        return json.dumps(content)
-    return str(content)
-
-
 @deprecated(
     "2.5.10",
     details="Deprecated, use: from ads.common.auth import AuthState; AuthState().oci_config_path",

ads/model/datascience_model.py

@@ -89,6 +89,11 @@ class InvalidArtifactType(Exception):  # pragma: no cover
     pass
 
 
+class InvalidArtifactPathTypeOrContentError(Exception):  # pragma: no cover
+    def __init__(self, msg="Invalid type of Metdata artifact content"):
+        super().__init__(msg)
+
+
 class CustomerNotificationType(ExtendedEnum):
     NONE = "NONE"
     ALL = "ALL"
@@ -2238,7 +2243,7 @@ def find_model_idx():
     def create_custom_metadata_artifact(
         self,
         metadata_key_name: str,
-        artifact_path_or_content: str,
+        artifact_path_or_content: Union[str, bytes],
         path_type: MetadataArtifactPathType = MetadataArtifactPathType.LOCAL,
     ) -> ModelMetadataArtifactDetails:
         """Creates model custom metadata artifact for specified model.
@@ -2248,13 +2253,22 @@ def create_custom_metadata_artifact(
         metadata_key_name: str
             The name of the model custom metadata key
 
-        artifact_path_or_content: str
-            The model custom metadata artifact path to be upload. It can also be the actual content of the custom metadata
+        artifact_path_or_content: Union[str,bytes]
+            The model custom metadata artifact path to be uploaded. It can also be the actual content of the custom metadata artifact
+            The type is string when it represents local path or oss path.
+            The type is bytes when it represents content itself
 
         path_type: MetadataArtifactPathType
             Can be either of MetadataArtifactPathType.LOCAL , MetadataArtifactPathType.OSS , MetadataArtifactPathType.CONTENT
             Specifies what type of path is to be provided for metadata artifact.
-            Can be either local , oss or the actual content itself
+
+        Example:
+        >>>       ds_model=DataScienceModel.from_id("ocid1.datasciencemodel.iad.xxyxz...")
+        >>>       ds_model.create_custom_metadata_artifact(
+        ...         "README",
+        ...         artifact_path_or_content="/Users/<username>/Downloads/README.md",
+        ...         path_type=MetadataArtifactPathType.LOCAL
+        ...       )
 
         Returns
         -------
@@ -2273,16 +2287,23 @@ def create_custom_metadata_artifact(
             }
 
         """
+        if path_type == MetadataArtifactPathType.CONTENT and not isinstance(
+            artifact_path_or_content, bytes
+        ):
+            raise InvalidArtifactPathTypeOrContentError(
+                f"Invalid type of artifact content: {type(artifact_path_or_content)}. It should be bytes."
+            )
+
         return self.dsc_model.create_custom_metadata_artifact(
             metadata_key_name=metadata_key_name,
-            artifact_path=artifact_path_or_content,
+            artifact_path_or_content=artifact_path_or_content,
             path_type=path_type,
         )
 
     def create_defined_metadata_artifact(
         self,
         metadata_key_name: str,
-        artifact_path_or_content: str,
+        artifact_path_or_content: Union[str, bytes],
         path_type: MetadataArtifactPathType = MetadataArtifactPathType.LOCAL,
     ) -> ModelMetadataArtifactDetails:
         """Creates model defined metadata artifact for specified model.
@@ -2292,14 +2313,24 @@ def create_defined_metadata_artifact(
         metadata_key_name: str
             The name of the model defined metadata key
 
-        artifact_path_or_content: str
-            The model defined metadata artifact path to be upload. It can also be the actual content of the defined metadata
+        artifact_path_or_content: Union[str,bytes]
+            The model defined metadata artifact path to be uploaded. It can also be the actual content of the defined metadata
+            The type is string when it represents local path or oss path.
+            The type is bytes when it represents content itself
 
         path_type: MetadataArtifactPathType
             Can be either of MetadataArtifactPathType.LOCAL , MetadataArtifactPathType.OSS , MetadataArtifactPathType.CONTENT
             Specifies what type of path is to be provided for metadata artifact.
             Can be either local , oss or the actual content itself
 
+        Example:
+        >>>       ds_model=DataScienceModel.from_id("ocid1.datasciencemodel.iad.xxyxz...")
+        >>>       ds_model.create_defined_metadata_artifact(
+        ...         "README",
+        ...         artifact_path_or_content="oci://path/to/bucket/README.md",
+        ...         path_type=MetadataArtifactPathType.OSS
+        ...       )
+
         Returns
         -------
         ModelMetadataArtifactDetails
@@ -2317,16 +2348,23 @@ def create_defined_metadata_artifact(
             }
 
         """
+        if path_type == MetadataArtifactPathType.CONTENT and not isinstance(
+            artifact_path_or_content, bytes
+        ):
+            raise InvalidArtifactPathTypeOrContentError(
+                f"Invalid type of artifact content: {type(artifact_path_or_content)}. It should be bytes."
+            )
+
         return self.dsc_model.create_defined_metadata_artifact(
             metadata_key_name=metadata_key_name,
-            artifact_path=artifact_path_or_content,
+            artifact_path_or_content=artifact_path_or_content,
             path_type=path_type,
         )
 
     def update_custom_metadata_artifact(
         self,
         metadata_key_name: str,
-        artifact_path_or_content: str,
+        artifact_path_or_content: Union[str, bytes],
         path_type: MetadataArtifactPathType = MetadataArtifactPathType.LOCAL,
     ) -> ModelMetadataArtifactDetails:
         """Update model custom metadata artifact for specified model.
@@ -2336,8 +2374,10 @@ def update_custom_metadata_artifact(
         metadata_key_name: str
             The name of the model custom metadata key
 
-        artifact_path_or_content: str
-            The model custom metadata artifact path. It can also be the actual content of the custom metadata
+        artifact_path_or_content: Union[str,bytes]
+            The model custom metadata artifact path to be uploaded. It can also be the actual content of the custom metadata
+            The type is string when it represents local path or oss path.
+            The type is bytes when it represents content itself
 
         path_type: MetadataArtifactPathType
             Can be either of MetadataArtifactPathType.LOCAL , MetadataArtifactPathType.OSS , MetadataArtifactPathType.CONTENT
@@ -2361,16 +2401,23 @@ def update_custom_metadata_artifact(
             }
 
         """
+        if path_type == MetadataArtifactPathType.CONTENT and not isinstance(
+            artifact_path_or_content, bytes
+        ):
+            raise InvalidArtifactPathTypeOrContentError(
+                f"Invalid type of artifact content: {type(artifact_path_or_content)}. It should be bytes."
+            )
+
         return self.dsc_model.update_custom_metadata_artifact(
             metadata_key_name=metadata_key_name,
-            artifact_path=artifact_path_or_content,
+            artifact_path_or_content=artifact_path_or_content,
             path_type=path_type,
         )
 
     def update_defined_metadata_artifact(
         self,
         metadata_key_name: str,
-        artifact_path_or_content: str,
+        artifact_path_or_content: Union[str, bytes],
         path_type: MetadataArtifactPathType = MetadataArtifactPathType.LOCAL,
     ) -> ModelMetadataArtifactDetails:
         """Update model defined metadata artifact for specified model.
@@ -2380,8 +2427,10 @@ def update_defined_metadata_artifact(
         metadata_key_name: str
             The name of the model defined metadata key
 
-        artifact_path_or_content: str
-            The model defined metadata artifact path. It can also be the actual content of the defined metadata
+        artifact_path_or_content: Union[str,bytes]
+            The model defined metadata artifact path to be uploaded. It can also be the actual content of the defined metadata
+            The type is string when it represents local path or oss path.
+            The type is bytes when it represents content itself
 
         path_type: MetadataArtifactPathType
             Can be either of MetadataArtifactPathType.LOCAL , MetadataArtifactPathType.OSS , MetadataArtifactPathType.CONTENT
@@ -2405,9 +2454,16 @@ def update_defined_metadata_artifact(
             }
 
         """
+        if path_type == MetadataArtifactPathType.CONTENT and not isinstance(
+            artifact_path_or_content, bytes
+        ):
+            raise InvalidArtifactPathTypeOrContentError(
+                f"Invalid type of artifact content: {type(artifact_path_or_content)}. It should be bytes."
+            )
+
         return self.dsc_model.update_defined_metadata_artifact(
             metadata_key_name=metadata_key_name,
-            artifact_path=artifact_path_or_content,
+            artifact_path_or_content=artifact_path_or_content,
             path_type=path_type,
         )
 
@@ -2442,8 +2498,10 @@ def get_custom_metadata_artifact(
         )
         artifact_file_path = os.path.join(target_dir, f"{metadata_key_name}")
 
-        if not override and os.path.exists(artifact_file_path):
-            raise FileExistsError(f"File already exists: {artifact_file_path}")
+        if not override and is_path_exists(artifact_file_path):
+            raise FileExistsError(
+                f"File already exists: {artifact_file_path}. Please use boolean override parameter to override the file content."
+            )
 
         with open(artifact_file_path, "wb") as _file:
             _file.write(file_content)
@@ -2481,8 +2539,10 @@ def get_defined_metadata_artifact(
         )
         artifact_file_path = os.path.join(target_dir, f"{metadata_key_name}")
 
-        if not override and os.path.exists(artifact_file_path):
-            raise FileExistsError(f"File already exists: {artifact_file_path}")
+        if not override and is_path_exists(artifact_file_path):
+            raise FileExistsError(
+                f"File already exists: {artifact_file_path}. Please use boolean override parameter to override the file content."
+            )
 
         with open(artifact_file_path, "wb") as _file:
             _file.write(file_content)