Class GoogleCloudAiplatformV1beta1TuningJob

Represents a TuningJob that runs with Google owned models.

Inheritance

object

GoogleCloudAiplatformV1beta1TuningJob

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.Aiplatform.v1beta1.Data

Assembly: Google.Apis.Aiplatform.v1beta1.dll

Syntax

public class GoogleCloudAiplatformV1beta1TuningJob : IDirectResponseSchema

Properties

BaseModel

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

Declaration

[JsonProperty("baseModel")]
public virtual string BaseModel { get; set; }

Property Value

Type	Description
string

CreateTime

object representation of CreateTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }

Property Value

Type	Description
object

CreateTimeDateTimeOffset

DateTimeOffset representation of CreateTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

CreateTimeRaw

Output only. Time when the TuningJob was created.

Declaration

[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }

Property Value

Type	Description
string

CustomBaseModel

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.

Declaration

[JsonProperty("customBaseModel")]
public virtual string CustomBaseModel { get; set; }

Property Value

Type	Description
string

Description

Optional. The description of the TuningJob.

Declaration

[JsonProperty("description")]
public virtual string Description { get; set; }

Property Value

Type	Description
string

DistillationSpec

Tuning Spec for Distillation.

Declaration

[JsonProperty("distillationSpec")]
public virtual GoogleCloudAiplatformV1beta1DistillationSpec DistillationSpec { get; set; }

Property Value

Type	Description
GoogleCloudAiplatformV1beta1DistillationSpec

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

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.

Declaration

[JsonProperty("encryptionSpec")]
public virtual GoogleCloudAiplatformV1beta1EncryptionSpec EncryptionSpec { get; set; }

Property Value

Type	Description
GoogleCloudAiplatformV1beta1EncryptionSpec

EndTime

object representation of EndTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use EndTimeDateTimeOffset instead.")]
public virtual object EndTime { get; set; }

Property Value

Type	Description
object

EndTimeDateTimeOffset

DateTimeOffset representation of EndTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? EndTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

EndTimeRaw

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

Declaration

[JsonProperty("endTime")]
public virtual string EndTimeRaw { get; set; }

Property Value

Type	Description
string

Error

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

Declaration

[JsonProperty("error")]
public virtual GoogleRpcStatus Error { get; set; }

Property Value

Type	Description
GoogleRpcStatus

EvaluateDatasetRuns

Output only. Evaluation runs for the Tuning Job.

Declaration

[JsonProperty("evaluateDatasetRuns")]
public virtual IList<GoogleCloudAiplatformV1beta1EvaluateDatasetRun> EvaluateDatasetRuns { get; set; }

Property Value

Type	Description
IList<GoogleCloudAiplatformV1beta1EvaluateDatasetRun>

Experiment

Output only. The Experiment associated with this TuningJob.

Declaration

[JsonProperty("experiment")]
public virtual string Experiment { get; set; }

Property Value

Type	Description
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.

Declaration

[JsonProperty("labels")]
public virtual IDictionary<string, string> Labels { get; set; }

Property Value

Type	Description
IDictionary<string, string>

Name

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

Declaration

[JsonProperty("name")]
public virtual string Name { get; set; }

Property Value

Type	Description
string

OutputUri

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.

Declaration

[JsonProperty("outputUri")]
public virtual string OutputUri { get; set; }

Property Value

Type	Description
string

PartnerModelTuningSpec

Tuning Spec for open sourced and third party Partner models.

Declaration

[JsonProperty("partnerModelTuningSpec")]
public virtual GoogleCloudAiplatformV1beta1PartnerModelTuningSpec PartnerModelTuningSpec { get; set; }

Property Value

Type	Description
GoogleCloudAiplatformV1beta1PartnerModelTuningSpec

PipelineJob

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

Declaration

[JsonProperty("pipelineJob")]
public virtual string PipelineJob { get; set; }

Property Value

Type	Description
string

PreTunedModel

The pre-tuned model for continuous tuning.

Declaration

[JsonProperty("preTunedModel")]
public virtual GoogleCloudAiplatformV1beta1PreTunedModel PreTunedModel { get; set; }

Property Value

Type	Description
GoogleCloudAiplatformV1beta1PreTunedModel

PreferenceOptimizationSpec

Tuning Spec for Preference Optimization.

Declaration

[JsonProperty("preferenceOptimizationSpec")]
public virtual GoogleCloudAiplatformV1beta1PreferenceOptimizationSpec PreferenceOptimizationSpec { get; set; }

Property Value

Type	Description
GoogleCloudAiplatformV1beta1PreferenceOptimizationSpec

SatisfiesPzi

Output only. Reserved for future use.

Declaration

[JsonProperty("satisfiesPzi")]
public virtual bool? SatisfiesPzi { get; set; }

Property Value

Type	Description
bool?

SatisfiesPzs

Output only. Reserved for future use.

Declaration

[JsonProperty("satisfiesPzs")]
public virtual bool? SatisfiesPzs { get; set; }

Property Value

Type	Description
bool?

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.

Declaration

[JsonProperty("serviceAccount")]
public virtual string ServiceAccount { get; set; }

Property Value

Type	Description
string

StartTime

object representation of StartTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use StartTimeDateTimeOffset instead.")]
public virtual object StartTime { get; set; }

Property Value

Type	Description
object

StartTimeDateTimeOffset

DateTimeOffset representation of StartTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? StartTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

StartTimeRaw

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

Declaration

[JsonProperty("startTime")]
public virtual string StartTimeRaw { get; set; }

Property Value

Type	Description
string

State

Output only. The detailed state of the job.

Declaration

[JsonProperty("state")]
public virtual string State { get; set; }

Property Value

Type	Description
string

SupervisedTuningSpec

Tuning Spec for Supervised Fine Tuning.

Declaration

[JsonProperty("supervisedTuningSpec")]
public virtual GoogleCloudAiplatformV1beta1SupervisedTuningSpec SupervisedTuningSpec { get; set; }

Property Value

Type	Description
GoogleCloudAiplatformV1beta1SupervisedTuningSpec

TunedModel

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

Declaration

[JsonProperty("tunedModel")]
public virtual GoogleCloudAiplatformV1beta1TunedModel TunedModel { get; set; }

Property Value

Type	Description
GoogleCloudAiplatformV1beta1TunedModel

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.

Declaration

[JsonProperty("tunedModelDisplayName")]
public virtual string TunedModelDisplayName { get; set; }

Property Value

Type	Description
string

TuningDataStats

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

Declaration

[JsonProperty("tuningDataStats")]
public virtual GoogleCloudAiplatformV1beta1TuningDataStats TuningDataStats { get; set; }

Property Value

Type	Description
GoogleCloudAiplatformV1beta1TuningDataStats

TuningJobState

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

Declaration

[JsonProperty("tuningJobState")]
public virtual string TuningJobState { get; set; }

Property Value

Type	Description
string

UpdateTime

object representation of UpdateTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use UpdateTimeDateTimeOffset instead.")]
public virtual object UpdateTime { get; set; }

Property Value

Type	Description
object

UpdateTimeDateTimeOffset

DateTimeOffset representation of UpdateTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? UpdateTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

UpdateTimeRaw

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

Declaration

[JsonProperty("updateTime")]
public virtual string UpdateTimeRaw { get; set; }

Property Value

Type	Description
string

VeoTuningSpec

Tuning Spec for Veo Tuning.

Declaration

[JsonProperty("veoTuningSpec")]
public virtual GoogleCloudAiplatformV1beta1VeoTuningSpec VeoTuningSpec { get; set; }

Property Value

Type	Description
GoogleCloudAiplatformV1beta1VeoTuningSpec

Implements

IDirectResponseSchema