models

Overview

Name	models
Type	Resource
Id	google.bigquery.models

Fields

Name	Datatype	Description
description	string	Optional. A user-friendly description of this model.
location	string	Output only. The geographic location where the model resides. This value is inherited from the dataset.
modelType	string	Output only. Type of the model resource.
transformColumns	array	Output only. This field will be populated if a TRANSFORM clause was used to train a model. TRANSFORM clause (if used) takes feature_columns as input and outputs transform_columns. transform_columns then are used to train the model.
encryptionConfiguration	object
trainingRuns	array	Information for all training runs in increasing order of start_time.
labelColumns	array	Output only. Label columns that were used to train this model. The output of the model will have a "predicted_" prefix to these columns.
expirationTime	string	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.
hparamTrials	array	Output only. Trials of a hyperparameter tuning model sorted by trial_id.
labels	object	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.
remoteModelInfo	object	Remote Model Info
hparamSearchSpaces	object	Hyperparameter search spaces. These should be a subset of training_options.
lastModifiedTime	string	Output only. The time when this model was last modified, in millisecs since the epoch.
friendlyName	string	Optional. A descriptive name for this model.
bestTrialId	string	The best trial_id across all training runs.
featureColumns	array	Output only. Input feature columns for the model inference. If the model is trained with TRANSFORM clause, these are the input of the TRANSFORM clause.
creationTime	string	Output only. The time when this model was created, in millisecs since the epoch.
etag	string	Output only. A hash of this resource.
optimalTrialIds	array	Output only. For single-objective hyperparameter tuning models, it only contains the best trial. For multi-objective hyperparameter tuning models, it contains all Pareto optimal trials sorted by trial_id.
defaultTrialId	string	Output only. The default trial_id to use in TVFs when the trial_id is not passed in. For single-objective hyperparameter tuning models, this is the best trial ID. For multi-objective hyperparameter tuning models, this is the smallest trial ID among all Pareto optimal trials.
modelReference	object

Methods

Name	Accessible by	Required Params	Description
get	SELECT	+datasetId, +modelId, projectId	Gets the specified model resource by model ID.
list	SELECT	+datasetId, projectId	Lists all models in the specified dataset. Requires the READER dataset role. After retrieving the list of models, you can get information about a particular model by calling the models.get method.
delete	DELETE	+datasetId, +modelId, projectId	Deletes the model specified by modelId from the dataset.
_list	EXEC	+datasetId, projectId	Lists all models in the specified dataset. Requires the READER dataset role. After retrieving the list of models, you can get information about a particular model by calling the models.get method.
patch	EXEC	+datasetId, +modelId, projectId	Patch specific fields in the specified model.