Add substring util (#806)

Author: VipulMascarenhas

ads/aqua/deployment.py

@@ -22,6 +22,7 @@
     UNKNOWN_DICT,
     get_resource_name,
     get_model_by_reference_paths,
+    get_ocid_substring,
 )
 from ads.aqua.finetune import FineTuneCustomMetadata
 from ads.aqua.data import AquaResourceIdentifier
@@ -393,9 +394,9 @@ def create(
 
         model_type = "custom" if is_fine_tuned_model else "service"
         deployment_id = deployment.dsc_model_deployment.id
-        telemetry_kwargs = (
-            {"ocid": deployment_id[-8:]} if len(deployment_id) > 8 else {}
-        )
+        # we arbitrarily choose last 8 characters of OCID to identify MD in telemetry
+        telemetry_kwargs = {"ocid": get_ocid_substring(deployment_id, key_len=8)}
+
         # tracks unique deployments that were created in the user compartment
         self.telemetry.record_event_async(
             category=f"aqua/{model_type}/deployment",
@@ -461,10 +462,11 @@ def list(self, **kwargs) -> List["AquaDeployment"]:
                 state = model_deployment.lifecycle_state.upper()
                 if state in ["ACTIVE", "FAILED"]:
                     # tracks unique deployments that were listed in the user compartment
+                    # we arbitrarily choose last 8 characters of OCID to identify MD in telemetry
                     self.telemetry.record_event_async(
                         category=f"aqua/deployment",
                         action="list",
-                        detail=deployment_id[-8:] if len(deployment_id) > 8 else "",
+                        detail=get_ocid_substring(deployment_id, key_len=8),
                         value=state,
                     )
 

ads/aqua/utils.py

@@ -741,3 +741,9 @@ def known_realm():
 
     """
     return os.environ.get("CONDA_BUCKET_NS") in AQUA_GA_LIST
+
+
+def get_ocid_substring(ocid: str, key_len: int) -> str:
+    """This helper function returns the last n characters of the ocid specified by key_len parameter.
+    If ocid is None or length is less than key_len, it returns an empty string."""
+    return ocid[-key_len:] if ocid and len(ocid) > key_len else ""