Package com.oracle.bmc.aidocument.model

Class CreateModelDetails

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.aidocument.model.CreateModelDetails

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20221109")
public final class CreateModelDetails
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

The information needed to create a new model.
Note: Objects should always be created or deserialized using the CreateModelDetails.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 CreateModelDetails.Builder, which maintain a set of all explicitly set fields called CreateModelDetails.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).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CreateModelDetails.Builder

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor

Description

CreateModelDetails(String displayName, String description, String modelVersion, Model.ModelType modelType, String compartmentId, Boolean isQuickMode, Double maxTrainingTimeInHours, Dataset trainingDataset, Dataset testingDataset, Dataset validationDataset, List<ComponentModel> componentModels, String aliasName, String projectId, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags)

Deprecated.

Method Summary

Modifier and Type	Method	Description
static CreateModelDetails.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getAliasName()	the alias name of the model.
String	getCompartmentId()	The compartment identifier.
List<ComponentModel>	getComponentModels()	The OCID list of active custom Key Value models that need to be composed.
Map<String,Map<String,Object>>	getDefinedTags()	Defined tags for this resource.
String	getDescription()	An optional description of the model.
String	getDisplayName()	A human-friendly name for the model, which can be changed.
Map<String,String>	getFreeformTags()	A simple key-value pair that is applied without any predefined name, type, or scope.
Boolean	getIsQuickMode()	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.
Double	getMaxTrainingTimeInHours()	The maximum model training time in hours, expressed as a decimal fraction.
Model.ModelType	getModelType()	The type of the Document model.
String	getModelVersion()	The model version
String	getProjectId()	The OCID of the project that contains the model.
Dataset	getTestingDataset()
Dataset	getTrainingDataset()
Dataset	getValidationDataset()
int	hashCode()
CreateModelDetails.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateModelDetails

@Deprecated
@ConstructorProperties({"displayName","description","modelVersion","modelType","compartmentId","isQuickMode","maxTrainingTimeInHours","trainingDataset","testingDataset","validationDataset","componentModels","aliasName","projectId","freeformTags","definedTags"})
public CreateModelDetails(String displayName,
                          String description,
                          String modelVersion,
                          Model.ModelType modelType,
                          String compartmentId,
                          Boolean isQuickMode,
                          Double maxTrainingTimeInHours,
                          Dataset trainingDataset,
                          Dataset testingDataset,
                          Dataset validationDataset,
                          List<ComponentModel> componentModels,
                          String aliasName,
                          String projectId,
                          Map<String,String> freeformTags,
                          Map<String,Map<String,Object>> definedTags)

Deprecated.

Method Detail

builder

public static CreateModelDetails.Builder builder()

Create a new builder.

toBuilder

public CreateModelDetails.Builder toBuilder()

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

getModelVersion

public String getModelVersion()

The model version

Returns:

the value

getModelType

public Model.ModelType getModelType()

The type of the Document model.

Returns:

the value

getCompartmentId

public String getCompartmentId()

The compartment identifier.

Returns:

the value

getIsQuickMode

public Boolean getIsQuickMode()

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.

Returns:

the value

getMaxTrainingTimeInHours

public Double getMaxTrainingTimeInHours()

The maximum model training time in hours, expressed as a decimal fraction.

Returns:

the value

getTrainingDataset

public Dataset getTrainingDataset()

getTestingDataset

public Dataset getTestingDataset()

getValidationDataset

public Dataset getValidationDataset()

getComponentModels

public List<ComponentModel> getComponentModels()

The OCID list of active custom Key Value models that need to be composed.

Returns:

the value

getAliasName

public String getAliasName()

the alias name of the model.

Returns:

the value

getProjectId

public String getProjectId()

The OCID of the project that contains the model.

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

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