Package com.oracle.bmc.generativeai.model

Class Model.Builder

  • Enclosing class:
    Model
    public static class Model.Builder
extends Object

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • id

        public Model.Builder id​(String id)
        An ID that uniquely identifies a pretrained or fine-tuned model.
        Parameters:
        id - the value to set
        Returns:
        this builder

      • description

        public Model.Builder description​(String description)
        An optional description of the model.
        Parameters:
        description - the value to set
        Returns:
        this builder

      • compartmentId

        public Model.Builder compartmentId​(String compartmentId)
        The compartment OCID for fine-tuned models.

        For pretrained models, this value is null.

        Parameters:
        compartmentId - the value to set
        Returns:
        this builder

      • capabilities

        public Model.Builder capabilities​(List<ModelCapability> capabilities)
        Describes what this model can be used for.
        Parameters:
        capabilities - the value to set
        Returns:
        this builder

      • lifecycleState

        public Model.Builder lifecycleState​(Model.LifecycleState lifecycleState)
        The lifecycle 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 of the model in more detail that can provide actionable information.
        Parameters:
        lifecycleDetails - the value to set
        Returns:
        this builder

      • vendor

        public Model.Builder vendor​(String vendor)
        The provider of the base model.
        Parameters:
        vendor - the value to set
        Returns:
        this builder

      • version

        public Model.Builder version​(String version)
        The version of the model.
        Parameters:
        version - the value to set
        Returns:
        this builder

      • displayName

        public Model.Builder displayName​(String displayName)
        A user-friendly name.
        Parameters:
        displayName - the value to set
        Returns:
        this builder

      • timeCreated

        public Model.Builder timeCreated​(Date timeCreated)
        The date and time that the model was created in the format of an RFC3339 datetime string.
        Parameters:
        timeCreated - the value to set
        Returns:
        this builder

      • timeUpdated

        public Model.Builder timeUpdated​(Date timeUpdated)
        The date and time that the model was updated in the format of an RFC3339 datetime string.
        Parameters:
        timeUpdated - the value to set
        Returns:
        this builder

      • baseModelId

        public Model.Builder baseModelId​(String baseModelId)
        The OCID of the base model that’s used for fine-tuning.

        For pretrained models, the value is null.

        Parameters:
        baseModelId - the value to set
        Returns:
        this builder

      • type

        public Model.Builder type​(Model.Type type)
        The model type indicating whether this is a pretrained/base model or a custom/fine-tuned model.
        Parameters:
        type - the value to set
        Returns:
        this builder

      • isLongTermSupported

        public Model.Builder isLongTermSupported​(Boolean isLongTermSupported)
        Whether a model is supported long-term.

        Only applicable to base models.

        Parameters:
        isLongTermSupported - the value to set
        Returns:
        this builder

      • timeDeprecated

        public Model.Builder timeDeprecated​(Date timeDeprecated)
        Corresponds to the time when the custom model and its associated foundation model will be deprecated.
        Parameters:
        timeDeprecated - the value to set
        Returns:
        this builder

      • freeformTags

        public Model.Builder freeformTags​(Map<String,​String> freeformTags)
        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"}

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

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

        Parameters:
        definedTags - the value to set
        Returns:
        this builder

      • systemTags

        public Model.Builder systemTags​(Map<String,​Map<String,​Object>> systemTags)
        System tags for this resource.

        Each key is predefined and scoped to a namespace.

        Example: {"orcl-cloud": {"free-tier-retained": "true"}}

        Parameters:
        systemTags - the value to set
        Returns:
        this builder

      • build

        public Model build()