Package com.oracle.bmc.ailanguage.model

Class Model

java.lang.Object

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

com.oracle.bmc.ailanguage.model.Model

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

Description of the a Model.
Note: Objects should always be created or deserialized using the Model.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 Model.Builder, which maintain a set of all explicitly set fields called Model.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	Model.Builder
static class	Model.LifecycleState	The state of the model.

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

Model(String id, String displayName, String compartmentId, String projectId, String description, ModelDetails modelDetails, Date timeCreated, Date timeUpdated, Model.LifecycleState lifecycleState, String lifecycleDetails, DatasetDetails trainingDataset, EvaluationResults evaluationResults, TestStrategy testStrategy, String version, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags)

Deprecated.

Method Summary

Modifier and Type	Method	Description
static Model.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getCompartmentId()	The OCID for the model’s compartment.
Map<String,Map<String,Object>>	getDefinedTags()	Defined tags for this resource.
String	getDescription()	A short description of the Model.
String	getDisplayName()	A user-friendly display name for the resource.
EvaluationResults	getEvaluationResults()
Map<String,String>	getFreeformTags()	Simple key-value pair that is applied without any predefined name, type or scope.
String	getId()	Unique identifier model OCID of a model that is immutable on creation
String	getLifecycleDetails()	A message describing the current state in more detail.
Model.LifecycleState	getLifecycleState()	The state of the model.
ModelDetails	getModelDetails()
String	getProjectId()	The OCID of the project to associate with the model.
Map<String,Map<String,Object>>	getSystemTags()	Usage of system tag keys.
TestStrategy	getTestStrategy()
Date	getTimeCreated()	The time the the model was created.
Date	getTimeUpdated()	The time the model was updated.
DatasetDetails	getTrainingDataset()
String	getVersion()	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 modelonwhichthistraininghastobedone» ex: ai-lang::NER_V1::CUSTOM-V0
int	hashCode()
Model.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

Model

@Deprecated
@ConstructorProperties({"id","displayName","compartmentId","projectId","description","modelDetails","timeCreated","timeUpdated","lifecycleState","lifecycleDetails","trainingDataset","evaluationResults","testStrategy","version","freeformTags","definedTags","systemTags"})
public Model(String id,
             String displayName,
             String compartmentId,
             String projectId,
             String description,
             ModelDetails modelDetails,
             Date timeCreated,
             Date timeUpdated,
             Model.LifecycleState lifecycleState,
             String lifecycleDetails,
             DatasetDetails trainingDataset,
             EvaluationResults evaluationResults,
             TestStrategy testStrategy,
             String version,
             Map<String,String> freeformTags,
             Map<String,Map<String,Object>> definedTags,
             Map<String,Map<String,Object>> systemTags)

Deprecated.

Method Detail

builder

public static Model.Builder builder()

Create a new builder.

toBuilder

public Model.Builder toBuilder()

getId

public String getId()

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

Returns:

the value

getDisplayName

public String getDisplayName()

A user-friendly display name for the resource.

It does not have to be unique and can be modified. Avoid entering confidential information.

Returns:

the value

getCompartmentId

public String getCompartmentId()

The OCID for the model’s compartment.

Returns:

the value

getProjectId

public String getProjectId()

The OCID of the project to associate with the model.

Returns:

the value

getDescription

public String getDescription()

A short description of the Model.

Returns:

the value

getModelDetails

public ModelDetails getModelDetails()

getTimeCreated

public Date getTimeCreated()

The time the the model was created.

An RFC3339 formatted datetime string.

Returns:

the value

getTimeUpdated

public Date getTimeUpdated()

The time the model was updated.

An RFC3339 formatted datetime string.

Returns:

the value

getLifecycleState

public Model.LifecycleState getLifecycleState()

The state of the model.

Returns:

the value

getLifecycleDetails

public String getLifecycleDetails()

A message describing the current state in more detail.

For example, can be used to provide actionable information for a resource in failed state.

Returns:

the value

getTrainingDataset

public DatasetDetails getTrainingDataset()

getEvaluationResults

public EvaluationResults getEvaluationResults()

getTestStrategy

public TestStrategy getTestStrategy()

getVersion

public String getVersion()

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 modelonwhichthistraininghastobedone» ex: ai-lang::NER_V1::CUSTOM-V0

Returns:

the value

getFreeformTags

public Map<String,String> getFreeformTags()

Simple key-value pair that is applied without any predefined name, type or scope.

Exists for cross-compatibility only. 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. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:

the value

getSystemTags

public Map<String,Map<String,Object>> getSystemTags()

Usage of system tag keys.

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

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