o
    ɶdn                     @   s8   d dl mZmZmZ d dlmZ eG dd deZdS )    )formatted_flat_dictNONE_SENTINEL#value_allowed_none_or_none_sentinel)init_model_state_from_kwargsc                   @   s  e Zd ZdZdZdZdZdZdZdZ	dZ
d	Zd
d Zedd Zejdd Zedd Zejdd Zedd Zejdd Zedd Zejdd Zedd Zejdd Zedd Zejdd Zedd Zejd d Zed!d" Zejd#d" Zed$d% Zejd&d% Zed'd( Zejd)d( Zed*d+ Zejd,d+ Zed-d. Zejd/d. Zed0d1 Zejd2d1 Zed3d4 Zejd5d4 Zed6d7 Zejd8d7 Zed9d: Zejd;d: Zed<d= Zejd>d= Zed?d@ Z e jdAd@ Z edBdC Z!e!jdDdC Z!edEdF Z"e"jdGdF Z"edHdI Z#e#jdJdI Z#edKdL Z$e$jdMdL Z$edNdO Z%e%jdPdO Z%edQdR Z&e&jdSdR Z&edTdU Z'e'jdVdU Z'edWdX Z(e(jdYdX Z(dZd[ Z)d\d] Z*d^d_ Z+d`S )aModelz 
    Machine-learned Model.
    KEY_VALUE_EXTRACTIONDOCUMENT_CLASSIFICATIONCREATINGUPDATINGACTIVEDELETINGDELETEDFAILEDc                 K   s  i ddddddddddddddd	d
dddddddddddddddddddddddddddd	| _ i dddddddddddd dd!d	d	dd"dd#dd$dd%dd&dd'dd(dd)dd*d+d,d-d.d/d0d1d2d3d	| _d4| _d4| _d4| _d4| _d4| _d4| _d4| _d4| _	d4| _
d4| _d4| _d4| _d4| _d4| _d4| _d4| _d4| _d4| _d4| _d4| _d4| _d4| _d4| _d4| _d4| _d4| _d4S )5a  
        Initializes a new Model object with values from keyword arguments.
        The following keyword arguments are supported (corresponding to the getters/setters of this class):

        :param id:
            The value to assign to the id property of this Model.
        :type id: str

        :param display_name:
            The value to assign to the display_name property of this Model.
        :type display_name: str

        :param description:
            The value to assign to the description property of this Model.
        :type description: str

        :param compartment_id:
            The value to assign to the compartment_id property of this Model.
        :type compartment_id: str

        :param model_type:
            The value to assign to the model_type property of this Model.
            Allowed values for this property are: "KEY_VALUE_EXTRACTION", "DOCUMENT_CLASSIFICATION", 'UNKNOWN_ENUM_VALUE'.
            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
        :type model_type: str

        :param tenancy_id:
            The value to assign to the tenancy_id property of this Model.
        :type tenancy_id: str

        :param alias_name:
            The value to assign to the alias_name property of this Model.
        :type alias_name: str

        :param labels:
            The value to assign to the labels property of this Model.
        :type labels: list[str]

        :param is_quick_mode:
            The value to assign to the is_quick_mode property of this Model.
        :type is_quick_mode: bool

        :param max_training_time_in_hours:
            The value to assign to the max_training_time_in_hours property of this Model.
        :type max_training_time_in_hours: float

        :param trained_time_in_hours:
            The value to assign to the trained_time_in_hours property of this Model.
        :type trained_time_in_hours: float

        :param training_dataset:
            The value to assign to the training_dataset property of this Model.
        :type training_dataset: oci.ai_document.models.Dataset

        :param testing_dataset:
            The value to assign to the testing_dataset property of this Model.
        :type testing_dataset: oci.ai_document.models.Dataset

        :param validation_dataset:
            The value to assign to the validation_dataset property of this Model.
        :type validation_dataset: oci.ai_document.models.Dataset

        :param component_models:
            The value to assign to the component_models property of this Model.
        :type component_models: list[oci.ai_document.models.ComponentModel]

        :param is_composed_model:
            The value to assign to the is_composed_model property of this Model.
        :type is_composed_model: bool

        :param model_version:
            The value to assign to the model_version property of this Model.
        :type model_version: str

        :param project_id:
            The value to assign to the project_id property of this Model.
        :type project_id: str

        :param time_created:
            The value to assign to the time_created property of this Model.
        :type time_created: datetime

        :param time_updated:
            The value to assign to the time_updated property of this Model.
        :type time_updated: datetime

        :param lifecycle_state:
            The value to assign to the lifecycle_state property of this Model.
            Allowed values for this property are: "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED", 'UNKNOWN_ENUM_VALUE'.
            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
        :type lifecycle_state: str

        :param lifecycle_details:
            The value to assign to the lifecycle_details property of this Model.
        :type lifecycle_details: str

        :param metrics:
            The value to assign to the metrics property of this Model.
        :type metrics: oci.ai_document.models.ModelMetrics

        :param freeform_tags:
            The value to assign to the freeform_tags property of this Model.
        :type freeform_tags: dict(str, str)

        :param defined_tags:
            The value to assign to the defined_tags property of this Model.
        :type defined_tags: dict(str, dict(str, object))

        :param system_tags:
            The value to assign to the system_tags property of this Model.
        :type system_tags: dict(str, dict(str, object))

        idstrdisplay_namedescriptioncompartment_id
model_type
tenancy_id
alias_namelabelsz	list[str]is_quick_modeboolmax_training_time_in_hoursfloattrained_time_in_hourstraining_datasetZDatasettesting_datasetvalidation_datasetcomponent_modelszlist[ComponentModel]is_composed_modelmodel_versiondatetimeZModelMetricszdict(str, str)zdict(str, dict(str, object)))	
project_idtime_createdtime_updatedlifecycle_statelifecycle_detailsmetricsfreeform_tagsdefined_tagssystem_tagsZdisplayNameZcompartmentIdZ	modelTypeZ	tenancyIdZ	aliasNameZisQuickModeZmaxTrainingTimeInHoursZtrainedTimeInHoursZtrainingDatasetZtestingDatasetZvalidationDatasetZcomponentModelsZisComposedModelZmodelVersionZ	projectIdZtimeCreatedZtimeUpdatedZlifecycleStateZlifecycleDetailsr)   ZfreeformTagsZdefinedTagsZ
systemTagsN)Zswagger_typesZattribute_map_id_display_name_description_compartment_id_model_type_tenancy_id_alias_name_labels_is_quick_mode_max_training_time_in_hours_trained_time_in_hours_training_dataset_testing_dataset_validation_dataset_component_models_is_composed_model_model_version_project_id_time_created_time_updated_lifecycle_state_lifecycle_details_metrics_freeform_tags_defined_tags_system_tags)selfkwargs rI   @usr/lib/python3.10/site-packages/oci/ai_document/models/model.py__init__2   s   r	

	


zModel.__init__c                 C      | j S )z
        **[Required]** Gets the id of this Model.
        A unique identifier that is immutable after creation.


        :return: The id of this Model.
        :rtype: str
        r-   rG   rI   rI   rJ   r         
zModel.idc                 C   
   || _ dS )z
        Sets the id of this Model.
        A unique identifier that is immutable after creation.


        :param id: The id of this Model.
        :type: str
        NrM   )rG   r   rI   rI   rJ   r        

c                 C   rL   )z
        Gets the display_name of this Model.
        A human-friendly name for the model, which can be changed.


        :return: The display_name of this Model.
        :rtype: str
        r.   rN   rI   rI   rJ   r     rO   zModel.display_namec                 C   rP   )z
        Sets the display_name of this Model.
        A human-friendly name for the model, which can be changed.


        :param display_name: The display_name of this Model.
        :type: str
        NrR   )rG   r   rI   rI   rJ   r     rQ   c                 C   rL   )z
        Gets the description of this Model.
        An optional description of the model.


        :return: The description of this Model.
        :rtype: str
        r/   rN   rI   rI   rJ   r   )  rO   zModel.descriptionc                 C   rP   )z
        Sets the description of this Model.
        An optional description of the model.


        :param description: The description of this Model.
        :type: str
        NrS   )rG   r   rI   rI   rJ   r   5  rQ   c                 C   rL   )z
        **[Required]** Gets the compartment_id of this Model.
        The compartment identifier.


        :return: The compartment_id of this Model.
        :rtype: str
        r0   rN   rI   rI   rJ   r   A  rO   zModel.compartment_idc                 C   rP   )z
        Sets the compartment_id of this Model.
        The compartment identifier.


        :param compartment_id: The compartment_id of this Model.
        :type: str
        NrT   )rG   r   rI   rI   rJ   r   M  rQ   c                 C   rL   )a  
        **[Required]** Gets the model_type of this Model.
        The type of the Document model.

        Allowed values for this property are: "KEY_VALUE_EXTRACTION", "DOCUMENT_CLASSIFICATION", 'UNKNOWN_ENUM_VALUE'.
        Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.


        :return: The model_type of this Model.
        :rtype: str
        )r1   rN   rI   rI   rJ   r   Y     zModel.model_typec                 C   s    ddg}t ||sd}|| _dS )z
        Sets the model_type of this Model.
        The type of the Document model.


        :param model_type: The model_type of this Model.
        :type: str
        r   r   UNKNOWN_ENUM_VALUEN)r   r1   )rG   r   allowed_valuesrI   rI   rJ   r   h     


c                 C   rL   )z
        Gets the tenancy_id of this Model.
        The tenancy id of the model.


        :return: The tenancy_id of this Model.
        :rtype: str
        r2   rN   rI   rI   rJ   r   w  rO   zModel.tenancy_idc                 C   rP   )z
        Sets the tenancy_id of this Model.
        The tenancy id of the model.


        :param tenancy_id: The tenancy_id of this Model.
        :type: str
        NrY   )rG   r   rI   rI   rJ   r     rQ   c                 C   rL   )z
        Gets the alias_name of this Model.
        the alias name of the model.


        :return: The alias_name of this Model.
        :rtype: str
        r3   rN   rI   rI   rJ   r     rO   zModel.alias_namec                 C   rP   )z
        Sets the alias_name of this Model.
        the alias name of the model.


        :param alias_name: The alias_name of this Model.
        :type: str
        NrZ   )rG   r   rI   rI   rJ   r     rQ   c                 C   rL   )z
        Gets the labels of this Model.
        The collection of labels used to train the custom model.


        :return: The labels of this Model.
        :rtype: list[str]
        r4   rN   rI   rI   rJ   r     rO   zModel.labelsc                 C   rP   )z
        Sets the labels of this Model.
        The collection of labels used to train the custom model.


        :param labels: The labels of this Model.
        :type: list[str]
        Nr[   )rG   r   rI   rI   rJ   r     rQ   c                 C   rL   )a'  
        Gets the is_quick_mode of this Model.
        Set to true when experimenting with a new model type or dataset, so model training is quick, with a predefined low number of passes through the training data.


        :return: The is_quick_mode of this Model.
        :rtype: bool
        r5   rN   rI   rI   rJ   r     rO   zModel.is_quick_modec                 C   rP   )a3  
        Sets the is_quick_mode of this Model.
        Set to true when experimenting with a new model type or dataset, so model training is quick, with a predefined low number of passes through the training data.


        :param is_quick_mode: The is_quick_mode of this Model.
        :type: bool
        Nr\   )rG   r   rI   rI   rJ   r     rQ   c                 C   rL   )z
        Gets the max_training_time_in_hours of this Model.
        The maximum model training time in hours, expressed as a decimal fraction.


        :return: The max_training_time_in_hours of this Model.
        :rtype: float
        r6   rN   rI   rI   rJ   r     rO   z Model.max_training_time_in_hoursc                 C   rP   )a  
        Sets the max_training_time_in_hours of this Model.
        The maximum model training time in hours, expressed as a decimal fraction.


        :param max_training_time_in_hours: The max_training_time_in_hours of this Model.
        :type: float
        Nr]   )rG   r   rI   rI   rJ   r     rQ   c                 C   rL   )z
        Gets the trained_time_in_hours of this Model.
        The total hours actually used for model training.


        :return: The trained_time_in_hours of this Model.
        :rtype: float
        r7   rN   rI   rI   rJ   r     rO   zModel.trained_time_in_hoursc                 C   rP   )z
        Sets the trained_time_in_hours of this Model.
        The total hours actually used for model training.


        :param trained_time_in_hours: The trained_time_in_hours of this Model.
        :type: float
        Nr^   )rG   r   rI   rI   rJ   r     rQ   c                 C   rL   )z
        Gets the training_dataset of this Model.

        :return: The training_dataset of this Model.
        :rtype: oci.ai_document.models.Dataset
        r8   rN   rI   rI   rJ   r        zModel.training_datasetc                 C   rP   )z
        Sets the training_dataset of this Model.

        :param training_dataset: The training_dataset of this Model.
        :type: oci.ai_document.models.Dataset
        Nr_   )rG   r   rI   rI   rJ   r        
c                 C   rL   )z
        Gets the testing_dataset of this Model.

        :return: The testing_dataset of this Model.
        :rtype: oci.ai_document.models.Dataset
        r9   rN   rI   rI   rJ   r     r`   zModel.testing_datasetc                 C   rP   )z
        Sets the testing_dataset of this Model.

        :param testing_dataset: The testing_dataset of this Model.
        :type: oci.ai_document.models.Dataset
        Nrb   )rG   r   rI   rI   rJ   r   %  ra   c                 C   rL   )z
        Gets the validation_dataset of this Model.

        :return: The validation_dataset of this Model.
        :rtype: oci.ai_document.models.Dataset
        r:   rN   rI   rI   rJ   r   /  r`   zModel.validation_datasetc                 C   rP   )z
        Sets the validation_dataset of this Model.

        :param validation_dataset: The validation_dataset of this Model.
        :type: oci.ai_document.models.Dataset
        Nrc   )rG   r   rI   rI   rJ   r   9  ra   c                 C   rL   )aa  
        Gets the component_models of this Model.
        The `OCID`__ collection of active custom Key Value models that need to be composed.

        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm


        :return: The component_models of this Model.
        :rtype: list[oci.ai_document.models.ComponentModel]
        r;   rN   rI   rI   rJ   r    C     zModel.component_modelsc                 C   rP   )ap  
        Sets the component_models of this Model.
        The `OCID`__ collection of active custom Key Value models that need to be composed.

        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm


        :param component_models: The component_models of this Model.
        :type: list[oci.ai_document.models.ComponentModel]
        Nrd   )rG   r    rI   rI   rJ   r    Q     
c                 C   rL   )z
        Gets the is_composed_model of this Model.
        Set to true when the model is created by using multiple key value extraction models.


        :return: The is_composed_model of this Model.
        :rtype: bool
        r<   rN   rI   rI   rJ   r!   _  rO   zModel.is_composed_modelc                 C   rP   )z
        Sets the is_composed_model of this Model.
        Set to true when the model is created by using multiple key value extraction models.


        :param is_composed_model: The is_composed_model of this Model.
        :type: bool
        Nrg   )rG   r!   rI   rI   rJ   r!   k  rQ   c                 C   rL   )z
        **[Required]** Gets the model_version of this Model.
        The version of the model.


        :return: The model_version of this Model.
        :rtype: str
        r=   rN   rI   rI   rJ   r"   w  rO   zModel.model_versionc                 C   rP   )z
        Sets the model_version of this Model.
        The version of the model.


        :param model_version: The model_version of this Model.
        :type: str
        Nrh   )rG   r"   rI   rI   rJ   r"     rQ   c                 C   rL   )a  
        **[Required]** Gets the project_id of this Model.
        The `OCID`__ of the project that contains the model.

        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm


        :return: The project_id of this Model.
        :rtype: str
        r>   rN   rI   rI   rJ   r$     re   zModel.project_idc                 C   rP   )a  
        Sets the project_id of this Model.
        The `OCID`__ of the project that contains the model.

        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm


        :param project_id: The project_id of this Model.
        :type: str
        Nri   )rG   r$   rI   rI   rJ   r$     rf   c                 C   rL   )z
        **[Required]** Gets the time_created of this Model.
        When the model was created, as an RFC3339 datetime string.


        :return: The time_created of this Model.
        :rtype: datetime
        r?   rN   rI   rI   rJ   r%     rO   zModel.time_createdc                 C   rP   )z
        Sets the time_created of this Model.
        When the model was created, as an RFC3339 datetime string.


        :param time_created: The time_created of this Model.
        :type: datetime
        Nrj   )rG   r%   rI   rI   rJ   r%     rQ   c                 C   rL   )z
        Gets the time_updated of this Model.
        When the model was updated, as an RFC3339 datetime string.


        :return: The time_updated of this Model.
        :rtype: datetime
        r@   rN   rI   rI   rJ   r&     rO   zModel.time_updatedc                 C   rP   )z
        Sets the time_updated of this Model.
        When the model was updated, as an RFC3339 datetime string.


        :param time_updated: The time_updated of this Model.
        :type: datetime
        Nrk   )rG   r&   rI   rI   rJ   r&     rQ   c                 C   rL   )a  
        **[Required]** Gets the lifecycle_state of this Model.
        The current state of the model.

        Allowed values for this property are: "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED", 'UNKNOWN_ENUM_VALUE'.
        Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.


        :return: The lifecycle_state of this Model.
        :rtype: str
        )rA   rN   rI   rI   rJ   r'     rU   zModel.lifecycle_statec                 C   s    g d}t ||sd}|| _dS )z
        Sets the lifecycle_state of this Model.
        The current state of the model.


        :param lifecycle_state: The lifecycle_state of this Model.
        :type: str
        )r	   r
   r   r   r   r   rV   N)r   rA   )rG   r'   rW   rI   rI   rJ   r'     rX   c                 C   rL   )a  
        Gets the lifecycle_details of this Model.
        A message describing the current state in more detail, that can provide actionable information if training failed.


        :return: The lifecycle_details of this Model.
        :rtype: str
        rB   rN   rI   rI   rJ   r(     rO   zModel.lifecycle_detailsc                 C   rP   )a  
        Sets the lifecycle_details of this Model.
        A message describing the current state in more detail, that can provide actionable information if training failed.


        :param lifecycle_details: The lifecycle_details of this Model.
        :type: str
        Nrl   )rG   r(   rI   rI   rJ   r(     rQ   c                 C   rL   )z
        Gets the metrics of this Model.

        :return: The metrics of this Model.
        :rtype: oci.ai_document.models.ModelMetrics
        rC   rN   rI   rI   rJ   r)     r`   zModel.metricsc                 C   rP   )z
        Sets the metrics of this Model.

        :param metrics: The metrics of this Model.
        :type: oci.ai_document.models.ModelMetrics
        Nrm   )rG   r)   rI   rI   rJ   r)     ra   c                 C   rL   )a;  
        Gets the freeform_tags of this Model.
        A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only.
        For example: `{"bar-key": "value"}`


        :return: The freeform_tags of this Model.
        :rtype: dict(str, str)
        rD   rN   rI   rI   rJ   r*   %     zModel.freeform_tagsc                 C   rP   )aG  
        Sets the freeform_tags of this Model.
        A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only.
        For example: `{"bar-key": "value"}`


        :param freeform_tags: The freeform_tags of this Model.
        :type: dict(str, str)
        Nrn   )rG   r*   rI   rI   rJ   r*   2     
c                 C   rL   )a/  
        Gets the defined_tags of this Model.
        Defined tags for this resource. Each key is predefined and scoped to a namespace.
        For example: `{"foo-namespace": {"bar-key": "value"}}`


        :return: The defined_tags of this Model.
        :rtype: dict(str, dict(str, object))
        rE   rN   rI   rI   rJ   r+   ?  ro   zModel.defined_tagsc                 C   rP   )a:  
        Sets the defined_tags of this Model.
        Defined tags for this resource. Each key is predefined and scoped to a namespace.
        For example: `{"foo-namespace": {"bar-key": "value"}}`


        :param defined_tags: The defined_tags of this Model.
        :type: dict(str, dict(str, object))
        Nrq   )rG   r+   rI   rI   rJ   r+   L  rp   c                 C   rL   )a,  
        Gets the system_tags of this Model.
        Usage of system tag keys. These predefined keys are scoped to namespaces.
        For example: `{"orcl-cloud": {"free-tier-retained": "true"}}`


        :return: The system_tags of this Model.
        :rtype: dict(str, dict(str, object))
        rF   rN   rI   rI   rJ   r,   Y  ro   zModel.system_tagsc                 C   rP   )a6  
        Sets the system_tags of this Model.
        Usage of system tag keys. These predefined keys are scoped to namespaces.
        For example: `{"orcl-cloud": {"free-tier-retained": "true"}}`


        :param system_tags: The system_tags of this Model.
        :type: dict(str, dict(str, object))
        Nrr   )rG   r,   rI   rI   rJ   r,   f  rp   c                 C   s   t | S N)r   rN   rI   rI   rJ   __repr__s  s   zModel.__repr__c                 C   s   |d u rdS | j |j kS )NF)__dict__rG   otherrI   rI   rJ   __eq__v  s   zModel.__eq__c                 C   s
   | |k S rs   rI   rv   rI   rI   rJ   __ne__|  s   
zModel.__ne__N),__name__
__module____qualname____doc__ZMODEL_TYPE_KEY_VALUE_EXTRACTIONZ"MODEL_TYPE_DOCUMENT_CLASSIFICATIONZLIFECYCLE_STATE_CREATINGZLIFECYCLE_STATE_UPDATINGZLIFECYCLE_STATE_ACTIVEZLIFECYCLE_STATE_DELETINGZLIFECYCLE_STATE_DELETEDZLIFECYCLE_STATE_FAILEDrK   propertyr   setterr   r   r   r   r   r   r   r   r   r   r   r   r   r    r!   r"   r$   r%   r&   r'   r(   r)   r*   r+   r,   rt   rx   ry   rI   rI   rI   rJ   r      s     H






















	
	
	
	
	
	
















	
	





r   N)Zoci.utilr   r   r   Zoci.decoratorsr   objectr   rI   rI   rI   rJ   <module>   s   