oci 2.146.0__py3-none-any.whl → 2.148.0__py3-none-any.whl

oci/data_science/data_science_client_composite_operations.py

@@ -1592,6 +1592,50 @@ class DataScienceClientCompositeOperations(object):
         except Exception as e:
             raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e)
 
+    def register_model_artifact_reference_and_wait_for_state(self, register_model_artifact_reference_details, model_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}):
+        """
+        Calls :py:func:`~oci.data_science.DataScienceClient.register_model_artifact_reference` and waits for the :py:class:`~oci.data_science.models.WorkRequest`
+        to enter the given state(s).
+
+        :param oci.data_science.models.RegisterModelArtifactReferenceDetails register_model_artifact_reference_details: (required)
+            register model artifact reference metadata
+
+        :param str model_id: (required)
+            The `OCID`__ of the model.
+
+            __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
+
+        :param list[str] wait_for_states:
+            An array of states to wait on. These should be valid values for :py:attr:`~oci.data_science.models.WorkRequest.status`
+
+        :param dict operation_kwargs:
+            A dictionary of keyword arguments to pass to :py:func:`~oci.data_science.DataScienceClient.register_model_artifact_reference`
+
+        :param dict waiter_kwargs:
+            A dictionary of keyword arguments to pass to the :py:func:`oci.wait_until` function. For example, you could pass ``max_interval_seconds`` or ``max_interval_seconds``
+            as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
+        """
+        operation_result = self.client.register_model_artifact_reference(register_model_artifact_reference_details, model_id, **operation_kwargs)
+        if not wait_for_states:
+            return operation_result
+        lowered_wait_for_states = [w.lower() for w in wait_for_states]
+        if 'opc-work-request-id' not in operation_result.headers:
+            return operation_result
+        wait_for_resource_id = operation_result.headers['opc-work-request-id']
+
+        try:
+            waiter_result = oci.wait_until(
+                self.client,
+                self.client.get_work_request(wait_for_resource_id),
+                evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states,
+                **waiter_kwargs
+            )
+            result_to_return = waiter_result
+
+            return result_to_return
+        except Exception as e:
+            raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e)
+
     def restore_archived_model_artifact_and_wait_for_state(self, model_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}):
         """
         Calls :py:func:`~oci.data_science.DataScienceClient.restore_archived_model_artifact` and waits for the :py:class:`~oci.data_science.models.WorkRequest`

oci/data_science/models/__init__.py

@@ -74,6 +74,7 @@ from .managed_egress_standalone_job_infrastructure_configuration_details import
 from .metadata import Metadata
 from .metric_expression_rule import MetricExpressionRule
 from .model import Model
+from .model_artifact_reference_details import ModelArtifactReferenceDetails
 from .model_configuration_details import ModelConfigurationDetails
 from .model_deploy_workload_configuration_details import ModelDeployWorkloadConfigurationDetails
 from .model_deployment import ModelDeployment
@@ -96,6 +97,7 @@ from .notebook_session_runtime_config_details import NotebookSessionRuntimeConfi
 from .notebook_session_shape_config_details import NotebookSessionShapeConfigDetails
 from .notebook_session_shape_summary import NotebookSessionShapeSummary
 from .notebook_session_summary import NotebookSessionSummary
+from .oss_model_artifact_reference_details import OSSModelArtifactReferenceDetails
 from .object_storage_mount_configuration_details import ObjectStorageMountConfigurationDetails
 from .ocir_container_job_environment_configuration_details import OcirContainerJobEnvironmentConfigurationDetails
 from .ocir_model_deployment_environment_configuration_details import OcirModelDeploymentEnvironmentConfigurationDetails
@@ -133,6 +135,7 @@ from .predefined_expression_threshold_scaling_configuration import PredefinedExp
 from .predefined_metric_expression_rule import PredefinedMetricExpressionRule
 from .project import Project
 from .project_summary import ProjectSummary
+from .register_model_artifact_reference_details import RegisterModelArtifactReferenceDetails
 from .retention_operation_details import RetentionOperationDetails
 from .retention_setting import RetentionSetting
 from .scaling_configuration import ScalingConfiguration
@@ -250,6 +253,7 @@ data_science_type_mapping = {
     "Metadata": Metadata,
     "MetricExpressionRule": MetricExpressionRule,
     "Model": Model,
+    "ModelArtifactReferenceDetails": ModelArtifactReferenceDetails,
     "ModelConfigurationDetails": ModelConfigurationDetails,
     "ModelDeployWorkloadConfigurationDetails": ModelDeployWorkloadConfigurationDetails,
     "ModelDeployment": ModelDeployment,
@@ -272,6 +276,7 @@ data_science_type_mapping = {
     "NotebookSessionShapeConfigDetails": NotebookSessionShapeConfigDetails,
     "NotebookSessionShapeSummary": NotebookSessionShapeSummary,
     "NotebookSessionSummary": NotebookSessionSummary,
+    "OSSModelArtifactReferenceDetails": OSSModelArtifactReferenceDetails,
     "ObjectStorageMountConfigurationDetails": ObjectStorageMountConfigurationDetails,
     "OcirContainerJobEnvironmentConfigurationDetails": OcirContainerJobEnvironmentConfigurationDetails,
     "OcirModelDeploymentEnvironmentConfigurationDetails": OcirModelDeploymentEnvironmentConfigurationDetails,
@@ -309,6 +314,7 @@ data_science_type_mapping = {
     "PredefinedMetricExpressionRule": PredefinedMetricExpressionRule,
     "Project": Project,
     "ProjectSummary": ProjectSummary,
+    "RegisterModelArtifactReferenceDetails": RegisterModelArtifactReferenceDetails,
     "RetentionOperationDetails": RetentionOperationDetails,
     "RetentionSetting": RetentionSetting,
     "ScalingConfiguration": ScalingConfiguration,

oci/data_science/models/metadata.py

@@ -36,25 +36,39 @@ class Metadata(object):
             The value to assign to the category property of this Metadata.
         :type category: str
 
+        :param keywords:
+            The value to assign to the keywords property of this Metadata.
+        :type keywords: list[str]
+
+        :param has_artifact:
+            The value to assign to the has_artifact property of this Metadata.
+        :type has_artifact: bool
+
         """
         self.swagger_types = {
             'key': 'str',
             'value': 'str',
             'description': 'str',
-            'category': 'str'
+            'category': 'str',
+            'keywords': 'list[str]',
+            'has_artifact': 'bool'
         }
 
         self.attribute_map = {
             'key': 'key',
             'value': 'value',
             'description': 'description',
-            'category': 'category'
+            'category': 'category',
+            'keywords': 'keywords',
+            'has_artifact': 'hasArtifact'
         }
 
         self._key = None
         self._value = None
         self._description = None
         self._category = None
+        self._keywords = None
+        self._has_artifact = None
 
     @property
     def key(self):
@@ -68,6 +82,11 @@ class Metadata(object):
                  * estimatorClass
                  * hyperParameters
                  * testArtifactresults
+                 * fineTuningConfiguration
+                 * deploymentConfiguration
+                 * readme
+                 * license
+                 * evaluationConfiguration
 
 
         :return: The key of this Metadata.
@@ -87,6 +106,11 @@ class Metadata(object):
                  * estimatorClass
                  * hyperParameters
                  * testArtifactresults
+                 * fineTuningConfiguration
+                 * deploymentConfiguration
+                 * readme
+                 * license
+                 * evaluationConfiguration
 
 
         :param key: The key of this Metadata.
@@ -182,6 +206,54 @@ class Metadata(object):
         """
         self._category = category
 
+    @property
+    def keywords(self):
+        """
+        Gets the keywords of this Metadata.
+        list of keywords for searching
+
+
+        :return: The keywords of this Metadata.
+        :rtype: list[str]
+        """
+        return self._keywords
+
+    @keywords.setter
+    def keywords(self, keywords):
+        """
+        Sets the keywords of this Metadata.
+        list of keywords for searching
+
+
+        :param keywords: The keywords of this Metadata.
+        :type: list[str]
+        """
+        self._keywords = keywords
+
+    @property
+    def has_artifact(self):
+        """
+        Gets the has_artifact of this Metadata.
+        Is there any artifact present for the metadata.
+
+
+        :return: The has_artifact of this Metadata.
+        :rtype: bool
+        """
+        return self._has_artifact
+
+    @has_artifact.setter
+    def has_artifact(self, has_artifact):
+        """
+        Sets the has_artifact of this Metadata.
+        Is there any artifact present for the metadata.
+
+
+        :param has_artifact: The has_artifact of this Metadata.
+        :type: bool
+        """
+        self._has_artifact = has_artifact
+
     def __repr__(self):
         return formatted_flat_dict(self)
 

oci/data_science/models/model.py

@@ -31,6 +31,14 @@ class Model(object):
     #: This constant has a value of "INACTIVE"
     LIFECYCLE_STATE_INACTIVE = "INACTIVE"
 
+    #: A constant which can be used with the category property of a Model.
+    #: This constant has a value of "USER"
+    CATEGORY_USER = "USER"
+
+    #: A constant which can be used with the category property of a Model.
+    #: This constant has a value of "SERVICE"
+    CATEGORY_SERVICE = "SERVICE"
+
     def __init__(self, **kwargs):
         """
         Initializes a new Model object with values from keyword arguments.
@@ -114,6 +122,16 @@ class Model(object):
             The value to assign to the version_label property of this Model.
         :type version_label: str
 
+        :param category:
+            The value to assign to the category property of this Model.
+            Allowed values for this property are: "USER", "SERVICE", 'UNKNOWN_ENUM_VALUE'.
+            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+        :type category: str
+
+        :param is_model_by_reference:
+            The value to assign to the is_model_by_reference property of this Model.
+        :type is_model_by_reference: bool
+
         :param retention_setting:
             The value to assign to the retention_setting property of this Model.
         :type retention_setting: oci.data_science.models.RetentionSetting
@@ -151,6 +169,8 @@ class Model(object):
             'model_version_set_name': 'str',
             'version_id': 'int',
             'version_label': 'str',
+            'category': 'str',
+            'is_model_by_reference': 'bool',
             'retention_setting': 'RetentionSetting',
             'backup_setting': 'BackupSetting',
             'retention_operation_details': 'RetentionOperationDetails',
@@ -177,6 +197,8 @@ class Model(object):
             'model_version_set_name': 'modelVersionSetName',
             'version_id': 'versionId',
             'version_label': 'versionLabel',
+            'category': 'category',
+            'is_model_by_reference': 'isModelByReference',
             'retention_setting': 'retentionSetting',
             'backup_setting': 'backupSetting',
             'retention_operation_details': 'retentionOperationDetails',
@@ -202,6 +224,8 @@ class Model(object):
         self._model_version_set_name = None
         self._version_id = None
         self._version_label = None
+        self._category = None
+        self._is_model_by_reference = None
         self._retention_setting = None
         self._backup_setting = None
         self._retention_operation_details = None
@@ -703,6 +727,60 @@ class Model(object):
         """
         self._version_label = version_label
 
+    @property
+    def category(self):
+        """
+        **[Required]** Gets the category of this Model.
+        The category of the model.
+
+        Allowed values for this property are: "USER", "SERVICE", 'UNKNOWN_ENUM_VALUE'.
+        Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+
+
+        :return: The category of this Model.
+        :rtype: str
+        """
+        return self._category
+
+    @category.setter
+    def category(self, category):
+        """
+        Sets the category of this Model.
+        The category of the model.
+
+
+        :param category: The category of this Model.
+        :type: str
+        """
+        allowed_values = ["USER", "SERVICE"]
+        if not value_allowed_none_or_none_sentinel(category, allowed_values):
+            category = 'UNKNOWN_ENUM_VALUE'
+        self._category = category
+
+    @property
+    def is_model_by_reference(self):
+        """
+        **[Required]** Gets the is_model_by_reference of this Model.
+        Identifier to indicate whether a model artifact resides in the Service Tenancy or Customer Tenancy.
+
+
+        :return: The is_model_by_reference of this Model.
+        :rtype: bool
+        """
+        return self._is_model_by_reference
+
+    @is_model_by_reference.setter
+    def is_model_by_reference(self, is_model_by_reference):
+        """
+        Sets the is_model_by_reference of this Model.
+        Identifier to indicate whether a model artifact resides in the Service Tenancy or Customer Tenancy.
+
+
+        :param is_model_by_reference: The is_model_by_reference of this Model.
+        :type: bool
+        """
+        self._is_model_by_reference = is_model_by_reference
+
     @property
     def retention_setting(self):
         """

oci/data_science/models/model_artifact_reference_details.py

@@ -0,0 +1,101 @@
+# coding: utf-8
+# Copyright (c) 2016, 2025, Oracle and/or its affiliates.  All rights reserved.
+# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
+
+# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20190101
+
+
+from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel  # noqa: F401
+from oci.decorators import init_model_state_from_kwargs
+
+
+@init_model_state_from_kwargs
+class ModelArtifactReferenceDetails(object):
+    """
+    Reference to the location where the model artifact is stored.
+    """
+
+    #: A constant which can be used with the model_artifact_reference_type property of a ModelArtifactReferenceDetails.
+    #: This constant has a value of "OSS"
+    MODEL_ARTIFACT_REFERENCE_TYPE_OSS = "OSS"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new ModelArtifactReferenceDetails object with values from keyword arguments. This class has the following subclasses and if you are using this class as input
+        to a service operations then you should favor using a subclass over the base class:
+
+        * :class:`~oci.data_science.models.OSSModelArtifactReferenceDetails`
+
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param model_artifact_reference_type:
+            The value to assign to the model_artifact_reference_type property of this ModelArtifactReferenceDetails.
+            Allowed values for this property are: "OSS"
+        :type model_artifact_reference_type: str
+
+        """
+        self.swagger_types = {
+            'model_artifact_reference_type': 'str'
+        }
+
+        self.attribute_map = {
+            'model_artifact_reference_type': 'modelArtifactReferenceType'
+        }
+
+        self._model_artifact_reference_type = None
+
+    @staticmethod
+    def get_subtype(object_dictionary):
+        """
+        Given the hash representation of a subtype of this class,
+        use the info in the hash to return the class of the subtype.
+        """
+        type = object_dictionary['modelArtifactReferenceType']
+
+        if type == 'OSS':
+            return 'OSSModelArtifactReferenceDetails'
+        else:
+            return 'ModelArtifactReferenceDetails'
+
+    @property
+    def model_artifact_reference_type(self):
+        """
+        **[Required]** Gets the model_artifact_reference_type of this ModelArtifactReferenceDetails.
+        The type of the model artifact reference.
+
+        Allowed values for this property are: "OSS"
+
+
+        :return: The model_artifact_reference_type of this ModelArtifactReferenceDetails.
+        :rtype: str
+        """
+        return self._model_artifact_reference_type
+
+    @model_artifact_reference_type.setter
+    def model_artifact_reference_type(self, model_artifact_reference_type):
+        """
+        Sets the model_artifact_reference_type of this ModelArtifactReferenceDetails.
+        The type of the model artifact reference.
+
+
+        :param model_artifact_reference_type: The model_artifact_reference_type of this ModelArtifactReferenceDetails.
+        :type: str
+        """
+        allowed_values = ["OSS"]
+        if not value_allowed_none_or_none_sentinel(model_artifact_reference_type, allowed_values):
+            raise ValueError(
+                f"Invalid value for `model_artifact_reference_type`, must be None or one of {allowed_values}"
+            )
+        self._model_artifact_reference_type = model_artifact_reference_type
+
+    def __repr__(self):
+        return formatted_flat_dict(self)
+
+    def __eq__(self, other):
+        if other is None:
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other):
+        return not self == other

oci/data_science/models/model_summary.py

@@ -31,6 +31,14 @@ class ModelSummary(object):
     #: This constant has a value of "INACTIVE"
     LIFECYCLE_STATE_INACTIVE = "INACTIVE"
 
+    #: A constant which can be used with the category property of a ModelSummary.
+    #: This constant has a value of "USER"
+    CATEGORY_USER = "USER"
+
+    #: A constant which can be used with the category property of a ModelSummary.
+    #: This constant has a value of "SERVICE"
+    CATEGORY_SERVICE = "SERVICE"
+
     def __init__(self, **kwargs):
         """
         Initializes a new ModelSummary object with values from keyword arguments.
@@ -86,6 +94,16 @@ class ModelSummary(object):
             The value to assign to the version_label property of this ModelSummary.
         :type version_label: str
 
+        :param category:
+            The value to assign to the category property of this ModelSummary.
+            Allowed values for this property are: "USER", "SERVICE", 'UNKNOWN_ENUM_VALUE'.
+            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+        :type category: str
+
+        :param is_model_by_reference:
+            The value to assign to the is_model_by_reference property of this ModelSummary.
+        :type is_model_by_reference: bool
+
         :param freeform_tags:
             The value to assign to the freeform_tags property of this ModelSummary.
         :type freeform_tags: dict(str, str)
@@ -108,6 +126,8 @@ class ModelSummary(object):
             'model_version_set_name': 'str',
             'version_id': 'int',
             'version_label': 'str',
+            'category': 'str',
+            'is_model_by_reference': 'bool',
             'freeform_tags': 'dict(str, str)',
             'defined_tags': 'dict(str, dict(str, object))'
         }
@@ -125,6 +145,8 @@ class ModelSummary(object):
             'model_version_set_name': 'modelVersionSetName',
             'version_id': 'versionId',
             'version_label': 'versionLabel',
+            'category': 'category',
+            'is_model_by_reference': 'isModelByReference',
             'freeform_tags': 'freeformTags',
             'defined_tags': 'definedTags'
         }
@@ -141,6 +163,8 @@ class ModelSummary(object):
         self._model_version_set_name = None
         self._version_id = None
         self._version_label = None
+        self._category = None
+        self._is_model_by_reference = None
         self._freeform_tags = None
         self._defined_tags = None
 
@@ -460,6 +484,60 @@ class ModelSummary(object):
         """
         self._version_label = version_label
 
+    @property
+    def category(self):
+        """
+        **[Required]** Gets the category of this ModelSummary.
+        The category of the model.
+
+        Allowed values for this property are: "USER", "SERVICE", 'UNKNOWN_ENUM_VALUE'.
+        Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+
+
+        :return: The category of this ModelSummary.
+        :rtype: str
+        """
+        return self._category
+
+    @category.setter
+    def category(self, category):
+        """
+        Sets the category of this ModelSummary.
+        The category of the model.
+
+
+        :param category: The category of this ModelSummary.
+        :type: str
+        """
+        allowed_values = ["USER", "SERVICE"]
+        if not value_allowed_none_or_none_sentinel(category, allowed_values):
+            category = 'UNKNOWN_ENUM_VALUE'
+        self._category = category
+
+    @property
+    def is_model_by_reference(self):
+        """
+        **[Required]** Gets the is_model_by_reference of this ModelSummary.
+        Identifier to indicate whether a model artifact resides in the Service Tenancy or Customer Tenancy.
+
+
+        :return: The is_model_by_reference of this ModelSummary.
+        :rtype: bool
+        """
+        return self._is_model_by_reference
+
+    @is_model_by_reference.setter
+    def is_model_by_reference(self, is_model_by_reference):
+        """
+        Sets the is_model_by_reference of this ModelSummary.
+        Identifier to indicate whether a model artifact resides in the Service Tenancy or Customer Tenancy.
+
+
+        :param is_model_by_reference: The is_model_by_reference of this ModelSummary.
+        :type: bool
+        """
+        self._is_model_by_reference = is_model_by_reference
+
     @property
     def freeform_tags(self):
         """

oci/data_science/models/model_version_set.py

@@ -31,6 +31,14 @@ class ModelVersionSet(object):
     #: This constant has a value of "FAILED"
     LIFECYCLE_STATE_FAILED = "FAILED"
 
+    #: A constant which can be used with the category property of a ModelVersionSet.
+    #: This constant has a value of "USER"
+    CATEGORY_USER = "USER"
+
+    #: A constant which can be used with the category property of a ModelVersionSet.
+    #: This constant has a value of "SERVICE"
+    CATEGORY_SERVICE = "SERVICE"
+
     def __init__(self, **kwargs):
         """
         Initializes a new ModelVersionSet object with values from keyword arguments.
@@ -74,6 +82,12 @@ class ModelVersionSet(object):
             The value to assign to the created_by property of this ModelVersionSet.
         :type created_by: str
 
+        :param category:
+            The value to assign to the category property of this ModelVersionSet.
+            Allowed values for this property are: "USER", "SERVICE", 'UNKNOWN_ENUM_VALUE'.
+            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+        :type category: str
+
         :param freeform_tags:
             The value to assign to the freeform_tags property of this ModelVersionSet.
         :type freeform_tags: dict(str, str)
@@ -97,6 +111,7 @@ class ModelVersionSet(object):
             'time_created': 'datetime',
             'time_updated': 'datetime',
             'created_by': 'str',
+            'category': 'str',
             'freeform_tags': 'dict(str, str)',
             'defined_tags': 'dict(str, dict(str, object))',
             'system_tags': 'dict(str, dict(str, object))'
@@ -112,6 +127,7 @@ class ModelVersionSet(object):
             'time_created': 'timeCreated',
             'time_updated': 'timeUpdated',
             'created_by': 'createdBy',
+            'category': 'category',
             'freeform_tags': 'freeformTags',
             'defined_tags': 'definedTags',
             'system_tags': 'systemTags'
@@ -126,6 +142,7 @@ class ModelVersionSet(object):
         self._time_created = None
         self._time_updated = None
         self._created_by = None
+        self._category = None
         self._freeform_tags = None
         self._defined_tags = None
         self._system_tags = None
@@ -380,6 +397,36 @@ class ModelVersionSet(object):
         """
         self._created_by = created_by
 
+    @property
+    def category(self):
+        """
+        **[Required]** Gets the category of this ModelVersionSet.
+        The category of the model version set.
+
+        Allowed values for this property are: "USER", "SERVICE", 'UNKNOWN_ENUM_VALUE'.
+        Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+
+
+        :return: The category of this ModelVersionSet.
+        :rtype: str
+        """
+        return self._category
+
+    @category.setter
+    def category(self, category):
+        """
+        Sets the category of this ModelVersionSet.
+        The category of the model version set.
+
+
+        :param category: The category of this ModelVersionSet.
+        :type: str
+        """
+        allowed_values = ["USER", "SERVICE"]
+        if not value_allowed_none_or_none_sentinel(category, allowed_values):
+            category = 'UNKNOWN_ENUM_VALUE'
+        self._category = category
+
     @property
     def freeform_tags(self):
         """