oracle-ads 2.12.1__py3-none-any.whl → 2.12.3__py3-none-any.whl

ads/model/deployment/model_deployment_infrastructure.py

@@ -57,6 +57,8 @@ class ModelDeploymentInfrastructure(Builder):
         The web concurrency of model deployment
     subnet_id: str
         The subnet id of model deployment
+    private_endpoint_id: str
+        The private endpoint id of model deployment
 
     Methods
     -------
@@ -84,6 +86,8 @@ class ModelDeploymentInfrastructure(Builder):
         Sets the web concurrency of model deployment
     with_subnet_id(subnet_id)
         Sets the subnet id of model deployment
+    with_private_endpoint_id(private_endpoint)
+        Sets the private endpoint id of model deployment
 
     Example
     -------
@@ -100,6 +104,7 @@ class ModelDeploymentInfrastructure(Builder):
     ...        .with_bandwidth_mbps(10)
     ...        .with_web_concurrency(10)
     ...        .with_subnet_id(<subnet_id>)
+    ...        .with_private_endpoint_id(<private_endpoint_id>)
     ...        .with_access_log(
     ...            log_group_id=<log_group_id>,
     ...            log_id=<log_id>
@@ -143,6 +148,7 @@ class ModelDeploymentInfrastructure(Builder):
     CONST_WEB_CONCURRENCY = "webConcurrency"
     CONST_STREAM_CONFIG_DETAILS = "streamConfigurationDetails"
     CONST_SUBNET_ID = "subnetId"
+    CONST_PRIVATE_ENDPOINT_ID = "privateEndpointId"
 
     attribute_map = {
         CONST_PROJECT_ID: "project_id",
@@ -159,6 +165,7 @@ class ModelDeploymentInfrastructure(Builder):
         CONST_LOG_GROUP_ID: "log_group_id",
         CONST_WEB_CONCURRENCY: "web_concurrency",
         CONST_SUBNET_ID: "subnet_id",
+        CONST_PRIVATE_ENDPOINT_ID: "private_endpoint_id",
     }
 
     shape_config_details_attribute_map = {
@@ -186,6 +193,7 @@ class ModelDeploymentInfrastructure(Builder):
         CONST_SHAPE_NAME: f"{MODEL_CONFIG_DETAILS_PATH}.instance_configuration.instance_shape_name",
         CONST_SHAPE_CONFIG_DETAILS: f"{MODEL_CONFIG_DETAILS_PATH}.instance_configuration.model_deployment_instance_shape_config_details",
         CONST_SUBNET_ID: f"{MODEL_CONFIG_DETAILS_PATH}.instance_configuration.subnet_id",
+        CONST_PRIVATE_ENDPOINT_ID: f"{MODEL_CONFIG_DETAILS_PATH}.instance_configuration.private_endpoint_id",
         CONST_REPLICA: f"{MODEL_CONFIG_DETAILS_PATH}.scaling_policy.instance_count",
         CONST_BANDWIDTH_MBPS: f"{MODEL_CONFIG_DETAILS_PATH}.bandwidth_mbps",
         CONST_ACCESS_LOG: "category_log_details.access",
@@ -613,6 +621,32 @@ class ModelDeploymentInfrastructure(Builder):
         """
         return self.get_spec(self.CONST_SUBNET_ID, None)
 
+    def with_private_endpoint_id(self, private_endpoint_id: str) -> "ModelDeploymentInfrastructure":
+        """Sets the private endpoint id of model deployment.
+
+        Parameters
+        ----------
+        private_endpoint_id : str
+            The private endpoint id of model deployment.
+
+        Returns
+        -------
+        ModelDeploymentInfrastructure
+            The ModelDeploymentInfrastructure instance (self).
+        """
+        return self.set_spec(self.CONST_PRIVATE_ENDPOINT_ID, private_endpoint_id)
+
+    @property
+    def private_endpoint_id(self) -> str:
+        """The model deployment private endpoint id.
+
+        Returns
+        -------
+        str
+            The model deployment private endpoint id.
+        """
+        return self.get_spec(self.CONST_PRIVATE_ENDPOINT_ID, None)
+
     def init(self, **kwargs) -> "ModelDeploymentInfrastructure":
         """Initializes a starter specification for the ModelDeploymentInfrastructure.
 

ads/model/generic_model.py

@@ -2262,6 +2262,7 @@ class GenericModel(MetadataMixin, Introspectable, EvaluatorMixin):
         description: Optional[str] = None,
         deployment_instance_shape: Optional[str] = None,
         deployment_instance_subnet_id: Optional[str] = None,
+        deployment_instance_private_endpoint_id: Optional[str] = None,
         deployment_instance_count: Optional[int] = None,
         deployment_bandwidth_mbps: Optional[int] = None,
         deployment_log_group_id: Optional[str] = None,
@@ -2312,6 +2313,8 @@ class GenericModel(MetadataMixin, Introspectable, EvaluatorMixin):
             The shape of the instance used for deployment.
         deployment_instance_subnet_id: (str, optional). Default to None.
             The subnet id of the instance used for deployment.
+        deployment_instance_private_endpoint_id: (str, optional). Default to None.
+            The private endpoint id of instance used for deployment.
         deployment_instance_count: (int, optional). Defaults to 1.
             The number of instance used for deployment.
         deployment_bandwidth_mbps: (int, optional). Defaults to 10.
@@ -2432,6 +2435,8 @@ class GenericModel(MetadataMixin, Introspectable, EvaluatorMixin):
             or self.properties.deployment_image,
             deployment_instance_subnet_id=existing_infrastructure.subnet_id
             or self.properties.deployment_instance_subnet_id,
+            deployment_instance_private_endpoint_id=existing_infrastructure.private_endpoint_id
+            or self.properties.deployment_instance_private_endpoint_id,
         ).to_dict()
 
         property_dict.update(override_properties)
@@ -2465,6 +2470,7 @@ class GenericModel(MetadataMixin, Introspectable, EvaluatorMixin):
             .with_shape_name(self.properties.deployment_instance_shape)
             .with_replica(self.properties.deployment_instance_count)
             .with_subnet_id(self.properties.deployment_instance_subnet_id)
+            .with_private_endpoint_id(self.properties.deployment_instance_private_endpoint_id)
         )
 
         web_concurrency = (
@@ -2611,6 +2617,7 @@ class GenericModel(MetadataMixin, Introspectable, EvaluatorMixin):
         deployment_description: Optional[str] = None,
         deployment_instance_shape: Optional[str] = None,
         deployment_instance_subnet_id: Optional[str] = None,
+        deployment_instance_private_endpoint_id: Optional[str] = None,
         deployment_instance_count: Optional[int] = None,
         deployment_bandwidth_mbps: Optional[int] = None,
         deployment_log_group_id: Optional[str] = None,
@@ -2701,6 +2708,8 @@ class GenericModel(MetadataMixin, Introspectable, EvaluatorMixin):
             The shape of the instance used for deployment.
         deployment_instance_subnet_id: (str, optional). Default to None.
             The subnet id of the instance used for deployment.
+        deployment_instance_private_endpoint_id: (str, optional). Default to None.
+            The private endpoint id of instance used for deployment.
         deployment_instance_count: (int, optional). Defaults to 1.
             The number of instance used for deployment.
         deployment_bandwidth_mbps: (int, optional). Defaults to 10.
@@ -2846,6 +2855,7 @@ class GenericModel(MetadataMixin, Introspectable, EvaluatorMixin):
             description=deployment_description,
             deployment_instance_shape=self.properties.deployment_instance_shape,
             deployment_instance_subnet_id=self.properties.deployment_instance_subnet_id,
+            deployment_instance_private_endpoint_id=self.properties.deployment_instance_private_endpoint_id,
             deployment_instance_count=self.properties.deployment_instance_count,
             deployment_bandwidth_mbps=self.properties.deployment_bandwidth_mbps,
             deployment_log_group_id=self.properties.deployment_log_group_id,

ads/model/model_properties.py

@@ -29,6 +29,7 @@ class ModelProperties(BaseProperties):
     overwrite_existing_artifact: bool = None
     deployment_instance_shape: str = None
     deployment_instance_subnet_id: str = None
+    deployment_instance_private_endpoint_id: str = None
     deployment_instance_count: int = None
     deployment_bandwidth_mbps: int = None
     deployment_log_group_id: str = None

ads/model/service/oci_datascience_model.py

@@ -278,6 +278,34 @@ class OCIDataScienceModel(
                 raise ModelArtifactNotFoundError()
         return {}
 
+    @check_for_model_id(
+        msg="Model needs to be restored before the archived artifact content can be accessed."
+    )
+    def restore_archived_model_artifact(
+            self, restore_model_for_hours_specified: Optional[int] = None
+    ) -> None:
+        """Restores the archived model artifact.
+
+        Parameters
+        ----------
+        model_id : str
+            The unique identifier of the model to restore.
+        restore_model_for_hours_specified : Optional[int]
+            The duration (in hours) for which the model should be restored.
+
+        Returns
+        -------
+        None
+
+        Raises
+        ------
+        ModelArtifactNotFoundError
+            If model artifact not found.
+        """
+        return self.client.restore_archived_model_artifact(
+            model_id=self.id,
+            restore_model_for_hours_specified=restore_model_for_hours_specified).headers["opc-work-request-id"]
+
     @check_for_model_id(
         msg="Model needs to be saved to the Model Catalog before the artifact content can be read."
     )