@Generated(value="OracleSDKGenerator",
comments="API Version: 20231130")
public final class Model
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
You can create a custom model by using your dataset to fine-tune an out-of-the-box text generation base model. Have your dataset ready before you create a custom model. See Training Data Requirements.
To use any of the API operations, you must be authorized in an IAM policy. If you're not
authorized, talk to an administrator who gives OCI resource access to users. See [Getting Started
with
Policies](https://docs.cloud.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm)
and [Getting Access to Generative AI
Resources](https://docs.cloud.oracle.com/iaas/Content/generative-ai/iam-policies.htm).
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).
| Modifier and Type | Class and Description |
|---|---|
static class |
Model.Builder |
static class |
Model.LifecycleState
The lifecycle state of the model.
|
static class |
Model.Type
The model type indicating whether this is a pretrained/base model or a custom/fine-tuned
model.
|
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
Model(String id,
String description,
String compartmentId,
List<ModelCapability> capabilities,
Model.LifecycleState lifecycleState,
String lifecycleDetails,
String vendor,
String version,
String displayName,
Date timeCreated,
Date timeUpdated,
String baseModelId,
Model.Type type,
FineTuneDetails fineTuneDetails,
ModelMetrics modelMetrics,
Boolean isLongTermSupported,
Date timeDeprecated,
Model previousState,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags,
Map<String,Map<String,Object>> systemTags)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static Model.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
String |
getBaseModelId()
The OCID of the base model that’s used for fine-tuning.
|
List<ModelCapability> |
getCapabilities()
Describes what this model can be used for.
|
String |
getCompartmentId()
The compartment OCID for fine-tuned models.
|
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
String |
getDescription()
An optional description of the model.
|
String |
getDisplayName()
A user-friendly name.
|
FineTuneDetails |
getFineTuneDetails() |
Map<String,String> |
getFreeformTags()
Free-form tags for this resource.
|
String |
getId()
An ID that uniquely identifies a pretrained or fine-tuned model.
|
Boolean |
getIsLongTermSupported()
Whether a model is supported long-term.
|
String |
getLifecycleDetails()
A message describing the current state of the model in more detail that can provide
actionable information.
|
Model.LifecycleState |
getLifecycleState()
The lifecycle state of the model.
|
ModelMetrics |
getModelMetrics() |
Model |
getPreviousState() |
Map<String,Map<String,Object>> |
getSystemTags()
System tags for this resource.
|
Date |
getTimeCreated()
The date and time that the model was created in the format of an RFC3339 datetime string.
|
Date |
getTimeDeprecated()
Corresponds to the time when the custom model and its associated foundation model will be
deprecated.
|
Date |
getTimeUpdated()
The date and time that the model was updated in the format of an RFC3339 datetime string.
|
Model.Type |
getType()
The model type indicating whether this is a pretrained/base model or a custom/fine-tuned
model.
|
String |
getVendor()
The provider of the base model.
|
String |
getVersion()
The version of the model.
|
int |
hashCode() |
Model.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"id","description","compartmentId","capabilities","lifecycleState","lifecycleDetails","vendor","version","displayName","timeCreated","timeUpdated","baseModelId","type","fineTuneDetails","modelMetrics","isLongTermSupported","timeDeprecated","previousState","freeformTags","definedTags","systemTags"}) public Model(String id, String description, String compartmentId, List<ModelCapability> capabilities, Model.LifecycleState lifecycleState, String lifecycleDetails, String vendor, String version, String displayName, Date timeCreated, Date timeUpdated, String baseModelId, Model.Type type, FineTuneDetails fineTuneDetails, ModelMetrics modelMetrics, Boolean isLongTermSupported, Date timeDeprecated, Model previousState, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags)
public static Model.Builder builder()
Create a new builder.
public Model.Builder toBuilder()
public String getId()
An ID that uniquely identifies a pretrained or fine-tuned model.
public String getDescription()
An optional description of the model.
public String getCompartmentId()
The compartment OCID for fine-tuned models. For pretrained models, this value is null.
public List<ModelCapability> getCapabilities()
Describes what this model can be used for.
public Model.LifecycleState getLifecycleState()
The lifecycle state of the model.
public String getLifecycleDetails()
A message describing the current state of the model in more detail that can provide actionable information.
public String getVendor()
The provider of the base model.
public String getVersion()
The version of the model.
public String getDisplayName()
A user-friendly name.
public Date getTimeCreated()
The date and time that the model was created in the format of an RFC3339 datetime string.
public Date getTimeUpdated()
The date and time that the model was updated in the format of an RFC3339 datetime string.
public String getBaseModelId()
The OCID of the base model that’s used for fine-tuning. For pretrained models, the value is null.
public Model.Type getType()
The model type indicating whether this is a pretrained/base model or a custom/fine-tuned model.
public FineTuneDetails getFineTuneDetails()
public ModelMetrics getModelMetrics()
public Boolean getIsLongTermSupported()
Whether a model is supported long-term. Only applicable to base models.
public Date getTimeDeprecated()
Corresponds to the time when the custom model and its associated foundation model will be deprecated.
public Model getPreviousState()
public Map<String,String> getFreeformTags()
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
Example: {"Department": "Finance"}
public Map<String,Map<String,Object>> getDefinedTags()
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: {"Operations": {"CostCenter": "42"}}
public Map<String,Map<String,Object>> getSystemTags()
System tags for this resource. Each key is predefined and scoped to a namespace.
Example: {"orcl-cloud": {"free-tier-retained": "true"}}
public String toString()
toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents - true to include the full contents of byte arrayspublic boolean equals(Object o)
equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic int hashCode()
hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelCopyright © 2016–2024. All rights reserved.