TuningJob

@Serializable
data class TuningJob(val sdkHttpResponse: HttpResponse? = null, val name: String? = null, val state: JobState? = null, val createTime: Instant? = null, val startTime: Instant? = null, val endTime: Instant? = null, val updateTime: Instant? = null, val error: GoogleRpcStatus? = null, val description: String? = null, val baseModel: String? = null, val tunedModel: TunedModel? = null, val preTunedModel: PreTunedModel? = null, val supervisedTuningSpec: SupervisedTuningSpec? = null, val preferenceOptimizationSpec: PreferenceOptimizationSpec? = null, val distillationSpec: DistillationSpec? = null, val reinforcementTuningSpec: ReinforcementTuningSpec? = null, val tuningDataStats: TuningDataStats? = null, val encryptionSpec: EncryptionSpec? = null, val partnerModelTuningSpec: PartnerModelTuningSpec? = null, val customBaseModel: String? = null, val evaluateDatasetRuns: List<EvaluateDatasetRun>? = null, val experiment: String? = null, val fullFineTuningSpec: FullFineTuningSpec? = null, val labels: Map<String, String>? = null, val outputUri: String? = null, val pipelineJob: String? = null, val serviceAccount: String? = null, val tunedModelDisplayName: String? = null, val tuningJobState: TuningJobState? = null, val veoTuningSpec: VeoTuningSpec? = null, val tuningJobMetadata: TuningJobMetadata? = null, val veoLoraTuningSpec: VeoLoraTuningSpec? = null, val distillationSamplingSpec: DistillationSamplingSpec? = null)

A tuning job.

Constructors

Link copied to clipboard
constructor(sdkHttpResponse: HttpResponse? = null, name: String? = null, state: JobState? = null, createTime: Instant? = null, startTime: Instant? = null, endTime: Instant? = null, updateTime: Instant? = null, error: GoogleRpcStatus? = null, description: String? = null, baseModel: String? = null, tunedModel: TunedModel? = null, preTunedModel: PreTunedModel? = null, supervisedTuningSpec: SupervisedTuningSpec? = null, preferenceOptimizationSpec: PreferenceOptimizationSpec? = null, distillationSpec: DistillationSpec? = null, reinforcementTuningSpec: ReinforcementTuningSpec? = null, tuningDataStats: TuningDataStats? = null, encryptionSpec: EncryptionSpec? = null, partnerModelTuningSpec: PartnerModelTuningSpec? = null, customBaseModel: String? = null, evaluateDatasetRuns: List<EvaluateDatasetRun>? = null, experiment: String? = null, fullFineTuningSpec: FullFineTuningSpec? = null, labels: Map<String, String>? = null, outputUri: String? = null, pipelineJob: String? = null, serviceAccount: String? = null, tunedModelDisplayName: String? = null, tuningJobState: TuningJobState? = null, veoTuningSpec: VeoTuningSpec? = null, tuningJobMetadata: TuningJobMetadata? = null, veoLoraTuningSpec: VeoLoraTuningSpec? = null, distillationSamplingSpec: DistillationSamplingSpec? = null)

Properties

Link copied to clipboard
val baseModel: String? = null

The base model that is being tuned. See Supported models.

Link copied to clipboard
@Serializable(with = InstantSerializer::class)
val createTime: Instant? = null

Output only. Time when the TuningJob was created.

Link copied to clipboard
val customBaseModel: String? = null

Optional. The user-provided path to custom model weights. Set this field to tune a custom model. The path must be a Cloud Storage directory that contains the model weights in .safetensors format along with associated model metadata files. If this field is set, the base_model field must still be set to indicate which base model the custom model is derived from. This feature is only available for open source models.

Link copied to clipboard
val description: String? = null

Optional. The description of the TuningJob.

Link copied to clipboard

Tuning Spec for Distillation.

Link copied to clipboard

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.

Link copied to clipboard
@Serializable(with = InstantSerializer::class)
val endTime: Instant? = null

Output only. Time when the TuningJob entered any of the following JobStates: JOB_STATE_SUCCEEDED, JOB_STATE_FAILED, JOB_STATE_CANCELLED, JOB_STATE_EXPIRED.

Link copied to clipboard
val error: GoogleRpcStatus? = null

Output only. Only populated when job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.

Link copied to clipboard

Output only. Evaluation runs for the Tuning Job.

Link copied to clipboard
val experiment: String? = null

Output only. The Experiment associated with this TuningJob.

Link copied to clipboard

Tuning Spec for Full Fine Tuning.

Link copied to clipboard
val labels: Map<String, String>? = null

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.

Link copied to clipboard
val name: String? = null

Output only. Identifier. Resource name of a TuningJob. Format: projects/{project}/locations/{location}/tuningJobs/{tuning_job}

Link copied to clipboard
val outputUri: String? = null

Optional. Cloud Storage path to the directory where tuning job outputs are written to. This field is only available and required for open source models.

Link copied to clipboard

Tuning Spec for open sourced and third party Partner models.

Link copied to clipboard
val pipelineJob: String? = null

Output only. The resource name of the PipelineJob associated with the TuningJob. Format: projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}.

Link copied to clipboard

Tuning Spec for Preference Optimization.

Link copied to clipboard

The pre-tuned model for continuous tuning.

Link copied to clipboard

Tuning Spec for Reinforcement Tuning.

Link copied to clipboard

Used to retain the full HTTP response.

Link copied to clipboard
val serviceAccount: String? = null

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.

Link copied to clipboard
@Serializable(with = InstantSerializer::class)
val startTime: Instant? = null

Output only. Time when the TuningJob for the first time entered the JOB_STATE_RUNNING state.

Link copied to clipboard
val state: JobState? = null

Output only. The detailed state of the job.

Link copied to clipboard

Tuning Spec for Supervised Fine Tuning.

Link copied to clipboard
val tunedModel: TunedModel? = null

Output only. The tuned model resources associated with this TuningJob.

Link copied to clipboard

Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters. For continuous tuning, tuned_model_display_name will by default use the same display name as the pre-tuned model. If a new display name is provided, the tuning job will create a new model instead of a new version.

Link copied to clipboard

Output only. The tuning data statistics associated with this TuningJob.

Link copied to clipboard

Output only. Tuning Job metadata.

Link copied to clipboard

Output only. The detail state of the tuning job (while the overall JobState is running).

Link copied to clipboard
@Serializable(with = InstantSerializer::class)
val updateTime: Instant? = null

Output only. Time when the TuningJob was most recently updated.

Link copied to clipboard

Tuning Spec for Veo LoRA Tuning.

Link copied to clipboard

Tuning Spec for Veo Tuning.