com.oracle.bmc.ailanguage.model

Class Model.Builder

java.lang.Object

com.oracle.bmc.ailanguage.model.Model.Builder

Enclosing class:

Model

public static class Model.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
Model	build()
Model.Builder	compartmentId(String compartmentId) The OCID for the model’s compartment.
Model.Builder	copy(Model model)
Model.Builder	definedTags(Map<String,Map<String,Object>> definedTags) Defined tags for this resource.
Model.Builder	description(String description) A short description of the Model.
Model.Builder	displayName(String displayName) A user-friendly display name for the resource.
Model.Builder	evaluationResults(EvaluationResults evaluationResults)
Model.Builder	freeformTags(Map<String,String> freeformTags) Simple key-value pair that is applied without any predefined name, type or scope.
Model.Builder	id(String id) Unique identifier model OCID of a model that is immutable on creation
Model.Builder	lifecycleDetails(String lifecycleDetails) A message describing the current state in more detail.
Model.Builder	lifecycleState(Model.LifecycleState lifecycleState) The state of the model.
Model.Builder	modelDetails(ModelDetails modelDetails)
Model.Builder	projectId(String projectId) The OCID of the project to associate with the model.
Model.Builder	systemTags(Map<String,Map<String,Object>> systemTags) Usage of system tag keys.
Model.Builder	testStrategy(TestStrategy testStrategy)
Model.Builder	timeCreated(Date timeCreated) The time the the model was created.
Model.Builder	timeUpdated(Date timeUpdated) The time the model was updated.
Model.Builder	trainingDataset(DatasetDetails trainingDataset)
Model.Builder	version(String version) For pre trained models this will identify model type version used for model creation For custom this will identify model type version used for model creation and custom model on which training has to be done <<service>>::«service-name>>_<<model-type-version»::<<custom model on which this training has to be done>> ex: ai-lang::NER_V1::CUSTOM-V0

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)

Unique identifier model OCID of a model that is immutable on creation

Parameters:

id - the value to set

Returns:

this builder

displayName

public Model.Builder displayName(String displayName)

A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.

Parameters:

displayName - the value to set

Returns:

this builder

compartmentId

public Model.Builder compartmentId(String compartmentId)

The OCID for the model’s compartment.

Parameters:

compartmentId - the value to set

Returns:

this builder

projectId

public Model.Builder projectId(String projectId)

The OCID of the project to associate with the model.

Parameters:

projectId - the value to set

Returns:

this builder

description

public Model.Builder description(String description)

A short description of the Model.

Parameters:

description - the value to set

Returns:

this builder

modelDetails

public Model.Builder modelDetails(ModelDetails modelDetails)

timeCreated

public Model.Builder timeCreated(Date timeCreated)

The time the the model was created. An RFC3339 formatted datetime string.

Parameters:

timeCreated - the value to set

Returns:

this builder

timeUpdated

public Model.Builder timeUpdated(Date timeUpdated)

The time the model was updated. An RFC3339 formatted datetime string.

Parameters:

timeUpdated - the value to set

Returns:

this builder

lifecycleState

public Model.Builder lifecycleState(Model.LifecycleState lifecycleState)

The 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. For example, can be used to provide actionable information for a resource in failed state.

Parameters:

lifecycleDetails - the value to set

Returns:

this builder

trainingDataset

public Model.Builder trainingDataset(DatasetDetails trainingDataset)

evaluationResults

public Model.Builder evaluationResults(EvaluationResults evaluationResults)

testStrategy

public Model.Builder testStrategy(TestStrategy testStrategy)

version

public Model.Builder version(String version)

For pre trained models this will identify model type version used for model creation For custom this will identify model type version used for model creation and custom model on which training has to be done <<service>>::«service-name>>_<<model-type-version»::<<custom model on which this training has to be done>> ex: ai-lang::NER_V1::CUSTOM-V0

Parameters:

version - the value to set

Returns:

this builder

freeformTags

public Model.Builder freeformTags(Map<String,String> freeformTags)

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. 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. 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. Example: { "orcl-cloud": { "free-tier-retained": "true" } }

Parameters:

systemTags - the value to set

Returns:

this builder

build

public Model build()

copy

public Model.Builder copy(Model model)