Package com.oracle.bmc.aidocument.model

Class Model

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20221109")
public final class Model
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    Machine-learned Model.
    Note: Objects should always be created or deserialized using the Model.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the Model.Builder, which maintain a set of all explicitly set fields called Model.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

    • Method Detail

      • builder

        public static Model.Builder builder()
        Create a new builder.

      • getId

        public String getId()
        A unique identifier that is immutable after creation.
        Returns:
        the value

      • getDisplayName

        public String getDisplayName()
        A human-friendly name for the model, which can be changed.
        Returns:
        the value

      • getDescription

        public String getDescription()
        An optional description of the model.
        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        The compartment identifier.
        Returns:
        the value

      • getModelType

        public Model.ModelType getModelType()
        The type of the Document model.
        Returns:
        the value

      • getModelSubType

        public ModelSubType getModelSubType()
        Applicable to only PRE_TRAINED_KEY_VALUE_EXTRACTION, PRE_TRAINED_DOCUMENT_ELEMENTS_EXTRACTION.
        Returns:
        the value

      • getInferenceUnits

        public Integer getInferenceUnits()
        Number of replicas required for this model.
        Returns:
        the value

      • getTenancyId

        public String getTenancyId()
        The tenancy id of the model.
        Returns:
        the value

      • getAliasName

        public String getAliasName()
        the alias name of the model.
        Returns:
        the value

      • getLabels

        public List<String> getLabels()
        The collection of labels used to train the custom model.
        Returns:
        the value

      • getIsQuickMode

        public Boolean getIsQuickMode()
        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.
        Returns:
        the value

      • getMaxTrainingTimeInHours

        public Double getMaxTrainingTimeInHours()
        The maximum model training time in hours, expressed as a decimal fraction.
        Returns:
        the value

      • getLanguage

        public String getLanguage()
        The document language for model training, abbreviated according to the BCP 47 syntax.
        Returns:
        the value

      • getTrainedTimeInHours

        public Double getTrainedTimeInHours()
        The total hours actually used for model training.
        Returns:
        the value

      • getTrainingDataset

        public Dataset getTrainingDataset()

      • getTestingDataset

        public Dataset getTestingDataset()

      • getValidationDataset

        public Dataset getValidationDataset()

      • getComponentModels

        public List<ComponentModel> getComponentModels()
        The OCID collection of active custom Key Value models that need to be composed.
        Returns:
        the value

      • getIsComposedModel

        public Boolean getIsComposedModel()
        Set to true when the model is created by using multiple key value extraction models.
        Returns:
        the value

      • getModelVersion

        public String getModelVersion()
        The version of the model.
        Returns:
        the value

      • getProjectId

        public String getProjectId()
        The OCID of the project that contains the model.
        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        When the model was created, as an RFC3339 datetime string.
        Returns:
        the value

      • getTimeUpdated

        public Date getTimeUpdated()
        When the model was updated, as an RFC3339 datetime string.
        Returns:
        the value

      • getLifecycleState

        public Model.LifecycleState getLifecycleState()
        The current state of the model.
        Returns:
        the value

      • getLifecycleDetails

        public String getLifecycleDetails()
        A message describing the current state in more detail, that can provide actionable information if training failed.
        Returns:
        the value

      • getFreeformTags

        public Map<String,​String> getFreeformTags()
        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”}

        Returns:
        the value

      • getDefinedTags

        public Map<String,​Map<String,​Object>> getDefinedTags()
        Defined tags for this resource.

        Each key is predefined and scoped to a namespace. For example: {“foo-namespace”: {“bar-key”: “value”}}

        Returns:
        the value

      • getSystemTags

        public Map<String,​Map<String,​Object>> getSystemTags()
        Usage of system tag keys.

        These predefined keys are scoped to namespaces. For example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

        Returns:
        the value

      • getLocks

        public List<ResourceLock> getLocks()
        Locks associated with this resource.
        Returns:
        the value

      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation

      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel