Package com.google.genai.types

Class TuningJob

java.lang.Object
com.google.genai.JsonSerializable
com.google.genai.types.TuningJob
public abstract class TuningJob extends JsonSerializable
A tuning job.

  • Constructor Details

    • TuningJob

      public TuningJob()

  • Method Details

    • name

      public abstract Optional<String> name()
      Output only. Identifier. Resource name of a TuningJob. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`

    • state

      public abstract Optional<JobState> state()
      Output only. The detailed state of the job.

    • createTime

      public abstract Optional<Instant> createTime()
      Output only. Time when the TuningJob was created.

    • startTime

      public abstract Optional<Instant> startTime()
      Output only. Time when the TuningJob for the first time entered the `JOB_STATE_RUNNING` state.

    • endTime

      public abstract Optional<Instant> endTime()
      Output only. Time when the TuningJob entered any of the following JobStates: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`, `JOB_STATE_EXPIRED`.

    • updateTime

      public abstract Optional<Instant> updateTime()
      Output only. Time when the TuningJob was most recently updated.

    • error

      public abstract Optional<GoogleRpcStatus> error()
      Output only. Only populated when job's state is `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.

    • description

      public abstract Optional<String> description()
      Optional. The description of the TuningJob.

    • baseModel

      public abstract Optional<String> baseModel()
      The base model that is being tuned. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/tuning#supported_models).

    • tunedModel

      public abstract Optional<TunedModel> tunedModel()
      Output only. The tuned model resources associated with this TuningJob.

    • supervisedTuningSpec

      public abstract Optional<SupervisedTuningSpec> supervisedTuningSpec()
      Tuning Spec for Supervised Fine Tuning.

    • tuningDataStats

      public abstract Optional<TuningDataStats> tuningDataStats()
      Output only. The tuning data statistics associated with this TuningJob.

    • encryptionSpec

      public abstract Optional<EncryptionSpec> encryptionSpec()
      Customer-managed encryption key options for a TuningJob. If this is set, then all resources created by the TuningJob will be encrypted with the provided encryption key.

    • partnerModelTuningSpec

      public abstract Optional<PartnerModelTuningSpec> partnerModelTuningSpec()
      Tuning Spec for open sourced and third party Partner models.

    • distillationSpec

      public abstract Optional<DistillationSpec> distillationSpec()
      Tuning Spec for Distillation.

    • experiment

      public abstract Optional<String> experiment()
      Output only. The Experiment associated with this TuningJob.

    • labels

      public abstract Optional<Map<String,String>> labels()
      Optional. The labels with user-defined metadata to organize TuningJob and generated resources such as Model and Endpoint. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.

    • pipelineJob

      public abstract Optional<String> pipelineJob()
      Output only. The resource name of the PipelineJob associated with the TuningJob. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`.

    • satisfiesPzi

      public abstract Optional<Boolean> satisfiesPzi()
      Output only. Reserved for future use.

    • satisfiesPzs

      public abstract Optional<Boolean> satisfiesPzs()
      Output only. Reserved for future use.

    • serviceAccount

      public abstract Optional<String> serviceAccount()
      The service account that the tuningJob workload runs as. If not specified, the Vertex AI Secure Fine-Tuned Service Agent in the project will be used. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-secure-fine-tuning-service-agent Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account.

    • tunedModelDisplayName

      public abstract Optional<String> tunedModelDisplayName()
      Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters.

    • builder

      public static TuningJob.Builder builder()
      Instantiates a builder for TuningJob.

    • toBuilder

      public abstract TuningJob.Builder toBuilder()
      Creates a builder with the same values as this instance.

    • fromJson

      public static TuningJob fromJson(String jsonString)
      Deserializes a JSON string to a TuningJob object.