Package com.oracle.bmc.generativeai.model

Class Model

  • @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.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm) and [Getting Access to Generative AI Resources](https://docs.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).

    • Method Detail

      • builder

        public static Model.Builder builder()
        Create a new builder.

      • getId

        public String getId()
        An ID that uniquely identifies a pretrained or fine-tuned model.
        Returns:
        the value

      • getDescription

        public String getDescription()
        An optional description of the model.
        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        The compartment OCID for fine-tuned models.

        For pretrained models, this value is null.

        Returns:
        the value

      • getCapabilities

        public List<ModelCapability> getCapabilities()
        Describes what this model can be used for.
        Returns:
        the value

      • getLifecycleState

        public Model.LifecycleState getLifecycleState()
        The lifecycle state of the model.
        Returns:
        the value

      • getLifecycleDetails

        public String getLifecycleDetails()
        A message describing the current state of the model in more detail that can provide actionable information.
        Returns:
        the value

      • getVendor

        public String getVendor()
        The provider of the base model.
        Returns:
        the value

      • getVersion

        public String getVersion()
        The version of the model.
        Returns:
        the value

      • getDisplayName

        public String getDisplayName()
        A user-friendly name.
        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        The date and time that the model was created in the format of an RFC3339 datetime string.
        Returns:
        the value

      • getTimeUpdated

        public Date getTimeUpdated()
        The date and time that the model was updated in the format of an RFC3339 datetime string.
        Returns:
        the value

      • getBaseModelId

        public String getBaseModelId()
        The OCID of the base model that’s used for fine-tuning.

        For pretrained models, the value is null.

        Returns:
        the value

      • getType

        public Model.Type getType()
        The model type indicating whether this is a pretrained/base model or a custom/fine-tuned model.
        Returns:
        the value

      • getIsLongTermSupported

        public Boolean getIsLongTermSupported()
        Whether a model is supported long-term.

        Only applicable to base models.

        Returns:
        the value

      • getTimeDeprecated

        public Date getTimeDeprecated()
        Corresponds to the time when the custom model and its associated foundation model will be deprecated.
        Returns:
        the value

      • getTimeOnDemandRetired

        public Date getTimeOnDemandRetired()
        The timestamp indicating when the base model will no longer be available for on-demand usage.
        Returns:
        the value

      • getTimeDedicatedRetired

        public Date getTimeDedicatedRetired()
        The timestamp indicating when the custom model and its associated foundation model will be fully retired.
        Returns:
        the value

      • getPreviousState

        public Model getPreviousState()

      • getFreeformTags

        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"}

        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 more information, see Resource Tags.

        Example: {"Operations": {"CostCenter": "42"}}

        Returns:
        the value

      • getSystemTags

        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"}}

        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