Package com.oracle.bmc.aidocument.model

Class Model.Builder

  • Enclosing class:
    Model
    public static class Model.Builder
extends Object

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • id

        public Model.Builder id​(String id)
        A unique identifier that is immutable after creation.
        Parameters:
        id - the value to set
        Returns:
        this builder

      • displayName

        public Model.Builder displayName​(String displayName)
        A human-friendly name for the model, which can be changed.
        Parameters:
        displayName - the value to set
        Returns:
        this builder

      • description

        public Model.Builder description​(String description)
        An optional description of the model.
        Parameters:
        description - the value to set
        Returns:
        this builder

      • compartmentId

        public Model.Builder compartmentId​(String compartmentId)
        The compartment identifier.
        Parameters:
        compartmentId - the value to set
        Returns:
        this builder

      • modelType

        public Model.Builder modelType​(Model.ModelType modelType)
        The type of the Document model.
        Parameters:
        modelType - the value to set
        Returns:
        this builder

      • modelSubType

        public Model.Builder modelSubType​(ModelSubType modelSubType)
        Applicable to only PRE_TRAINED_KEY_VALUE_EXTRACTION, PRE_TRAINED_DOCUMENT_ELEMENTS_EXTRACTION.
        Parameters:
        modelSubType - the value to set
        Returns:
        this builder

      • inferenceUnits

        public Model.Builder inferenceUnits​(Integer inferenceUnits)
        Number of replicas required for this model.
        Parameters:
        inferenceUnits - the value to set
        Returns:
        this builder

      • tenancyId

        public Model.Builder tenancyId​(String tenancyId)
        The tenancy id of the model.
        Parameters:
        tenancyId - the value to set
        Returns:
        this builder

      • aliasName

        public Model.Builder aliasName​(String aliasName)
        the alias name of the model.
        Parameters:
        aliasName - the value to set
        Returns:
        this builder

      • labels

        public Model.Builder labels​(List<String> labels)
        The collection of labels used to train the custom model.
        Parameters:
        labels - the value to set
        Returns:
        this builder

      • isQuickMode

        public Model.Builder isQuickMode​(Boolean isQuickMode)
        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.
        Parameters:
        isQuickMode - the value to set
        Returns:
        this builder

      • maxTrainingTimeInHours

        public Model.Builder maxTrainingTimeInHours​(Double maxTrainingTimeInHours)
        The maximum model training time in hours, expressed as a decimal fraction.
        Parameters:
        maxTrainingTimeInHours - the value to set
        Returns:
        this builder

      • language

        public Model.Builder language​(String language)
        The document language for model training, abbreviated according to the BCP 47 syntax.
        Parameters:
        language - the value to set
        Returns:
        this builder

      • trainedTimeInHours

        public Model.Builder trainedTimeInHours​(Double trainedTimeInHours)
        The total hours actually used for model training.
        Parameters:
        trainedTimeInHours - the value to set
        Returns:
        this builder

      • componentModels

        public Model.Builder componentModels​(List<ComponentModel> componentModels)
        The OCID collection of active custom Key Value models that need to be composed.
        Parameters:
        componentModels - the value to set
        Returns:
        this builder

      • isComposedModel

        public Model.Builder isComposedModel​(Boolean isComposedModel)
        Set to true when the model is created by using multiple key value extraction models.
        Parameters:
        isComposedModel - the value to set
        Returns:
        this builder

      • modelVersion

        public Model.Builder modelVersion​(String modelVersion)
        The version of the model.
        Parameters:
        modelVersion - the value to set
        Returns:
        this builder

      • projectId

        public Model.Builder projectId​(String projectId)
        The OCID of the project that contains the model.
        Parameters:
        projectId - the value to set
        Returns:
        this builder

      • timeCreated

        public Model.Builder timeCreated​(Date timeCreated)
        When the model was created, as an RFC3339 datetime string.
        Parameters:
        timeCreated - the value to set
        Returns:
        this builder

      • timeUpdated

        public Model.Builder timeUpdated​(Date timeUpdated)
        When the model was updated, as an RFC3339 datetime string.
        Parameters:
        timeUpdated - the value to set
        Returns:
        this builder

      • lifecycleState

        public Model.Builder lifecycleState​(Model.LifecycleState lifecycleState)
        The current state of the model.
        Parameters:
        lifecycleState - the value to set
        Returns:
        this builder

      • lifecycleDetails

        public Model.Builder lifecycleDetails​(String lifecycleDetails)
        A message describing the current state in more detail, that can provide actionable information if training failed.
        Parameters:
        lifecycleDetails - the value to set
        Returns:
        this builder

      • freeformTags

        public Model.Builder freeformTags​(Map<String,​String> freeformTags)
        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”}

        Parameters:
        freeformTags - the value to set
        Returns:
        this builder

      • definedTags

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

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

        Parameters:
        definedTags - the value to set
        Returns:
        this builder

      • systemTags

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

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

        Parameters:
        systemTags - the value to set
        Returns:
        this builder

      • locks

        public Model.Builder locks​(List<ResourceLock> locks)
        Locks associated with this resource.
        Parameters:
        locks - the value to set
        Returns:
        this builder

      • build

        public Model build()