Package com.oracle.bmc.aidocument.model
Class CreateModelDetails.Builder
- java.lang.Object
-
- com.oracle.bmc.aidocument.model.CreateModelDetails.Builder
-
- Enclosing class:
- CreateModelDetails
public static class CreateModelDetails.Builder extends Object
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CreateModelDetails.BuilderaliasName(String aliasName)the alias name of the model.CreateModelDetailsbuild()CreateModelDetails.BuildercompartmentId(String compartmentId)The compartment identifier.CreateModelDetails.BuildercomponentModels(List<ComponentModel> componentModels)The OCID list of active custom Key Value models that need to be composed.CreateModelDetails.Buildercopy(CreateModelDetails model)CreateModelDetails.BuilderdefinedTags(Map<String,Map<String,Object>> definedTags)Defined tags for this resource.CreateModelDetails.Builderdescription(String description)An optional description of the model.CreateModelDetails.BuilderdisplayName(String displayName)A human-friendly name for the model, which can be changed.CreateModelDetails.BuilderfreeformTags(Map<String,String> freeformTags)A simple key-value pair that is applied without any predefined name, type, or scope.CreateModelDetails.BuilderinferenceUnits(Integer inferenceUnits)Number of replicas required for this model.CreateModelDetails.BuilderisQuickMode(Boolean isQuickMode)Set to true when experimenting with a new model type or dataset, so the model training is quick, with a predefined low number of passes through the training data.CreateModelDetails.Builderlanguage(String language)The document language for model training, abbreviated according to the BCP 47 syntax.CreateModelDetails.BuildermaxTrainingTimeInHours(Double maxTrainingTimeInHours)The maximum model training time in hours, expressed as a decimal fraction.CreateModelDetails.BuildermodelSubType(ModelSubType modelSubType)Applicable to only PRE_TRAINED_KEY_VALUE_EXTRACTION, PRE_TRAINED_DOCUMENT_ELEMENTS_EXTRACTION.CreateModelDetails.BuildermodelType(Model.ModelType modelType)The type of the Document model.CreateModelDetails.BuildermodelVersion(String modelVersion)The model versionCreateModelDetails.BuilderprojectId(String projectId)The OCID of the project that contains the model.CreateModelDetails.BuildertestingDataset(Dataset testingDataset)CreateModelDetails.BuildertrainingDataset(Dataset trainingDataset)CreateModelDetails.BuildervalidationDataset(Dataset validationDataset)
-
-
-
Method Detail
-
displayName
public CreateModelDetails.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 CreateModelDetails.Builder description(String description)
An optional description of the model.- Parameters:
description- the value to set- Returns:
- this builder
-
modelVersion
public CreateModelDetails.Builder modelVersion(String modelVersion)
The model version- Parameters:
modelVersion- the value to set- Returns:
- this builder
-
modelType
public CreateModelDetails.Builder modelType(Model.ModelType modelType)
The type of the Document model.- Parameters:
modelType- the value to set- Returns:
- this builder
-
modelSubType
public CreateModelDetails.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 CreateModelDetails.Builder inferenceUnits(Integer inferenceUnits)
Number of replicas required for this model.- Parameters:
inferenceUnits- the value to set- Returns:
- this builder
-
compartmentId
public CreateModelDetails.Builder compartmentId(String compartmentId)
The compartment identifier.- Parameters:
compartmentId- the value to set- Returns:
- this builder
-
isQuickMode
public CreateModelDetails.Builder isQuickMode(Boolean isQuickMode)
Set to true when experimenting with a new model type or dataset, so the 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 CreateModelDetails.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 CreateModelDetails.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
-
trainingDataset
public CreateModelDetails.Builder trainingDataset(Dataset trainingDataset)
-
testingDataset
public CreateModelDetails.Builder testingDataset(Dataset testingDataset)
-
validationDataset
public CreateModelDetails.Builder validationDataset(Dataset validationDataset)
-
componentModels
public CreateModelDetails.Builder componentModels(List<ComponentModel> componentModels)
The OCID list of active custom Key Value models that need to be composed.- Parameters:
componentModels- the value to set- Returns:
- this builder
-
aliasName
public CreateModelDetails.Builder aliasName(String aliasName)
the alias name of the model.- Parameters:
aliasName- the value to set- Returns:
- this builder
-
projectId
public CreateModelDetails.Builder projectId(String projectId)
The OCID of the project that contains the model.- Parameters:
projectId- the value to set- Returns:
- this builder
-
freeformTags
public CreateModelDetails.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 CreateModelDetails.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
-
build
public CreateModelDetails build()
-
copy
public CreateModelDetails.Builder copy(CreateModelDetails model)
-
-