Model.Builder (Oracle Cloud Infrastructure Java SDK

java.lang.Object
- com.oracle.bmc.aidocument.model.Model.Builder

Enclosing class:: Model

public static class Model.Builder
extends Object

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Model.Builder`	`aliasName(String aliasName)` the alias name of the model.
`Model`	`build()`
`Model.Builder`	`compartmentId(String compartmentId)` The compartment identifier.
`Model.Builder`	`componentModels(List<ComponentModel> componentModels)` The OCID collection of active custom Key Value models that need to be composed.
`Model.Builder`	`copy(Model model)`
`Model.Builder`	`definedTags(Map<String,Map<String,Object>> definedTags)` Defined tags for this resource.
`Model.Builder`	`description(String description)` An optional description of the model.
`Model.Builder`	`displayName(String displayName)` A human-friendly name for the model, which can be changed.
`Model.Builder`	`freeformTags(Map<String,String> freeformTags)` A simple key-value pair that is applied without any predefined name, type, or scope.
`Model.Builder`	`id(String id)` A unique identifier that is immutable after creation.
`Model.Builder`	`isComposedModel(Boolean isComposedModel)` Set to true when the model is created by using multiple key value extraction models.
`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.
`Model.Builder`	`labels(List<String> labels)` The collection of labels used to train the custom model.
`Model.Builder`	`lifecycleDetails(String lifecycleDetails)` A message describing the current state in more detail, that can provide actionable information if training failed.
`Model.Builder`	`lifecycleState(Model.LifecycleState lifecycleState)` The current state of the model.
`Model.Builder`	`locks(List<ResourceLock> locks)` Locks associated with this resource.
`Model.Builder`	`maxTrainingTimeInHours(Double maxTrainingTimeInHours)` The maximum model training time in hours, expressed as a decimal fraction.
`Model.Builder`	`metrics(ModelMetrics metrics)`
`Model.Builder`	`modelType(Model.ModelType modelType)` The type of the Document model.
`Model.Builder`	`modelVersion(String modelVersion)` The version of the model.
`Model.Builder`	`projectId(String projectId)` The OCID of the project that contains the model.
`Model.Builder`	`systemTags(Map<String,Map<String,Object>> systemTags)` Usage of system tag keys.
`Model.Builder`	`tenancyId(String tenancyId)` The tenancy id of the model.
`Model.Builder`	`testingDataset(Dataset testingDataset)`
`Model.Builder`	`timeCreated(Date timeCreated)` When the model was created, as an RFC3339 datetime string.
`Model.Builder`	`timeUpdated(Date timeUpdated)` When the model was updated, as an RFC3339 datetime string.
`Model.Builder`	`trainedTimeInHours(Double trainedTimeInHours)` The total hours actually used for model training.
`Model.Builder`	`trainingDataset(Dataset trainingDataset)`
`Model.Builder`	`validationDataset(Dataset validationDataset)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 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
  - 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
  - trainedTimeInHours
```
public Model.Builder trainedTimeInHours(Double trainedTimeInHours)
```
    The total hours actually used for model training.
    
    Parameters:
    
    trainedTimeInHours - the value to set
    
    Returns:
    
    this builder
  - trainingDataset
```
public Model.Builder trainingDataset(Dataset trainingDataset)
```
  - testingDataset
```
public Model.Builder testingDataset(Dataset testingDataset)
```
  - validationDataset
```
public Model.Builder validationDataset(Dataset validationDataset)
```
  - 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
  - metrics
```
public Model.Builder metrics(ModelMetrics metrics)
```
  - 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()
```
  - copy
```
public Model.Builder copy(Model model)
```

Class Model.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

id

displayName

description

compartmentId

modelType

tenancyId

aliasName

labels

isQuickMode

maxTrainingTimeInHours

trainedTimeInHours

trainingDataset

testingDataset

validationDataset

componentModels

isComposedModel

modelVersion

projectId

timeCreated

timeUpdated

lifecycleState

lifecycleDetails

metrics

freeformTags

definedTags

systemTags

locks

build

copy