Show / Hide Table of Contents

Class Model

Inheritance
System.Object
Model
Implements
Google.Apis.Requests.IDirectResponseSchema
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Google.Apis.Bigquery.v2.Data
Assembly: Google.Apis.Bigquery.v2.dll
Syntax
public class Model : IDirectResponseSchema

Properties

BestTrialId

The best trial_id across all training runs.

Declaration
[JsonProperty("bestTrialId")]
public virtual long? BestTrialId { get; set; }
Property Value
Type Description
System.Nullable<System.Int64>

CreationTime

Output only. The time when this model was created, in millisecs since the epoch.

Declaration
[JsonProperty("creationTime")]
public virtual long? CreationTime { get; set; }
Property Value
Type Description
System.Nullable<System.Int64>

DefaultTrialId

Output only. The default trial_id to use in TVFs when the trial_id is not passed in. For single-objective hyperparameter tuning, this is the best trial id. For multi-objective hyperparameter tuning, this is the smallest trial id among all Pareto optimal trials.

Declaration
[JsonProperty("defaultTrialId")]
public virtual long? DefaultTrialId { get; set; }
Property Value
Type Description
System.Nullable<System.Int64>

Description

Optional. A user-friendly description of this model.

Declaration
[JsonProperty("description")]
public virtual string Description { get; set; }
Property Value
Type Description
System.String

EncryptionConfiguration

Custom encryption configuration (e.g., Cloud KMS keys). This shows the encryption configuration of the model data while stored in BigQuery storage. This field can be used with PatchModel to update encryption key for an already encrypted model.

Declaration
[JsonProperty("encryptionConfiguration")]
public virtual EncryptionConfiguration EncryptionConfiguration { get; set; }
Property Value
Type Description
EncryptionConfiguration

ETag

Output only. A hash of this resource.

Declaration
[JsonProperty("etag")]
public virtual string ETag { get; set; }
Property Value
Type Description
System.String

ExpirationTime

Optional. The time when this model expires, in milliseconds since the epoch. If not present, the model will persist indefinitely. Expired models will be deleted and their storage reclaimed. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created models.

Declaration
[JsonProperty("expirationTime")]
public virtual long? ExpirationTime { get; set; }
Property Value
Type Description
System.Nullable<System.Int64>

FeatureColumns

Output only. Input feature columns that were used to train this model.

Declaration
[JsonProperty("featureColumns")]
public virtual IList<StandardSqlField> FeatureColumns { get; set; }
Property Value
Type Description
System.Collections.Generic.IList<StandardSqlField>

FriendlyName

Optional. A descriptive name for this model.

Declaration
[JsonProperty("friendlyName")]
public virtual string FriendlyName { get; set; }
Property Value
Type Description
System.String

HparamSearchSpaces

Output only. All hyperparameter search spaces in this model.

Declaration
[JsonProperty("hparamSearchSpaces")]
public virtual HparamSearchSpaces HparamSearchSpaces { get; set; }
Property Value
Type Description
HparamSearchSpaces

HparamTrials

Output only. Trials of a hyperparameter tuning model sorted by trial_id.

Declaration
[JsonProperty("hparamTrials")]
public virtual IList<HparamTuningTrial> HparamTrials { get; set; }
Property Value
Type Description
System.Collections.Generic.IList<HparamTuningTrial>

LabelColumns

Output only. Label columns that were used to train this model. The output of the model will have a "predicted_" prefix to these columns.

Declaration
[JsonProperty("labelColumns")]
public virtual IList<StandardSqlField> LabelColumns { get; set; }
Property Value
Type Description
System.Collections.Generic.IList<StandardSqlField>

Labels

The labels associated with this model. You can use these to organize and group your models. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.

Declaration
[JsonProperty("labels")]
public virtual IDictionary<string, string> Labels { get; set; }
Property Value
Type Description
System.Collections.Generic.IDictionary<System.String, System.String>

LastModifiedTime

Output only. The time when this model was last modified, in millisecs since the epoch.

Declaration
[JsonProperty("lastModifiedTime")]
public virtual long? LastModifiedTime { get; set; }
Property Value
Type Description
System.Nullable<System.Int64>

Location

Output only. The geographic location where the model resides. This value is inherited from the dataset.

Declaration
[JsonProperty("location")]
public virtual string Location { get; set; }
Property Value
Type Description
System.String

ModelReference

Required. Unique identifier for this model.

Declaration
[JsonProperty("modelReference")]
public virtual ModelReference ModelReference { get; set; }
Property Value
Type Description
ModelReference

ModelType

Output only. Type of the model resource.

Declaration
[JsonProperty("modelType")]
public virtual string ModelType { get; set; }
Property Value
Type Description
System.String

OptimalTrialIds

Output only. For single-objective hyperparameter tuning, it only contains the best trial. For multi-objective hyperparameter tuning, it contains all Pareto optimal trials sorted by trial_id.

Declaration
[JsonProperty("optimalTrialIds")]
public virtual IList<long?> OptimalTrialIds { get; set; }
Property Value
Type Description
System.Collections.Generic.IList<System.Nullable<System.Int64>>

TrainingRuns

Output only. Information for all training runs in increasing order of start_time.

Declaration
[JsonProperty("trainingRuns")]
public virtual IList<TrainingRun> TrainingRuns { get; set; }
Property Value
Type Description
System.Collections.Generic.IList<TrainingRun>

Implements

Google.Apis.Requests.IDirectResponseSchema
In This Article
Back to top