List
|
|||||
|
|
Lists all models in the specified dataset. Requires the READER dataset role
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- View and manage your data in Google BigQuery
- View and manage your data across Google Cloud Platform services
- View your data across Google Cloud Platform services
Input
This building block consumes 4 input parameters
Name | Format | Description |
---|---|---|
projectId Required |
STRING |
Project ID of the models to list |
datasetId Required |
STRING |
Dataset ID of the models to list |
pageToken |
STRING |
Page token, returned by a previous call to request the next page of results |
maxResults |
INTEGER |
The maximum number of results per page |
= Parameter name
= Format
projectId STRING Required Project ID of the models to list |
datasetId STRING Required Dataset ID of the models to list |
pageToken STRING Page token, returned by a previous call to request the next page of results |
maxResults INTEGER The maximum number of results per page |
Output
This building block provides 26 output parameters
Name | Format | Description |
---|---|---|
models[] |
OBJECT |
|
models[].lastModifiedTime |
INTEGER |
Output only. The time when this model was last modified, in millisecs since the epoch |
models[].labels |
OBJECT |
[Optional] 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 |
models[].labels.customKey.value |
STRING |
[Optional] 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 |
models[].labelColumns[] |
OBJECT |
A field or a column |
models[].labelColumns[].name |
STRING |
Optional. The name of this field. Can be absent for struct fields |
models[].labelColumns[].type |
OBJECT |
The type of a variable, e.g., a function argument.
Examples:
INT64: {type_kind="INT64"}
ARRAY |
models[].modelType |
ENUMERATION |
Output only. Type of the model resource |
models[].featureColumns[] |
OBJECT |
A field or a column |
models[].featureColumns[].name |
STRING |
Optional. The name of this field. Can be absent for struct fields |
models[].featureColumns[].type |
OBJECT |
The type of a variable, e.g., a function argument.
Examples:
INT64: {type_kind="INT64"}
ARRAY |
models[].expirationTime |
INTEGER |
[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 |
models[].trainingRuns[] |
OBJECT |
Information about a single training query run for the model |
models[].trainingRuns[].trainingOptions |
OBJECT |
|
models[].trainingRuns[].startTime |
ANY |
The start time of this training run |
models[].trainingRuns[].evaluationMetrics |
OBJECT |
Evaluation metrics of a model. These are either computed on all training data or just the eval data based on whether eval data was used during training. These are not present for imported models |
models[].modelReference |
OBJECT |
Id path of a model |
models[].modelReference.projectId |
STRING |
[Required] The ID of the project containing this model |
models[].modelReference.datasetId |
STRING |
[Required] The ID of the dataset containing this model |
models[].modelReference.modelId |
STRING |
[Required] The ID of the model. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters |
models[].description |
STRING |
[Optional] A user-friendly description of this model |
models[].etag |
STRING |
Output only. A hash of this resource |
models[].creationTime |
INTEGER |
Output only. The time when this model was created, in millisecs since the epoch |
models[].location |
STRING |
Output only. The geographic location where the model resides. This value is inherited from the dataset |
models[].friendlyName |
STRING |
[Optional] A descriptive name for this model |
nextPageToken |
STRING |
A token to request the next page of results |
= Parameter name
= Format
models[] OBJECT |
models[].lastModifiedTime INTEGER Output only. The time when this model was last modified, in millisecs since the epoch |
models[].labels OBJECT [Optional] 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 |
models[].labels.customKey.value STRING [Optional] 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 |
models[].labelColumns[] OBJECT A field or a column |
models[].labelColumns[].name STRING Optional. The name of this field. Can be absent for struct fields |
models[].labelColumns[].type OBJECT The type of a variable, e.g., a function argument.
Examples:
INT64: {type_kind="INT64"}
ARRAY |
models[].modelType ENUMERATION Output only. Type of the model resource |
models[].featureColumns[] OBJECT A field or a column |
models[].featureColumns[].name STRING Optional. The name of this field. Can be absent for struct fields |
models[].featureColumns[].type OBJECT The type of a variable, e.g., a function argument.
Examples:
INT64: {type_kind="INT64"}
ARRAY |
models[].expirationTime INTEGER [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 |
models[].trainingRuns[] OBJECT Information about a single training query run for the model |
models[].trainingRuns[].trainingOptions OBJECT |
models[].trainingRuns[].startTime ANY The start time of this training run |
models[].trainingRuns[].evaluationMetrics OBJECT Evaluation metrics of a model. These are either computed on all training data or just the eval data based on whether eval data was used during training. These are not present for imported models |
models[].modelReference OBJECT Id path of a model |
models[].modelReference.projectId STRING [Required] The ID of the project containing this model |
models[].modelReference.datasetId STRING [Required] The ID of the dataset containing this model |
models[].modelReference.modelId STRING [Required] The ID of the model. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters |
models[].description STRING [Optional] A user-friendly description of this model |
models[].etag STRING Output only. A hash of this resource |
models[].creationTime INTEGER Output only. The time when this model was created, in millisecs since the epoch |
models[].location STRING Output only. The geographic location where the model resides. This value is inherited from the dataset |
models[].friendlyName STRING [Optional] A descriptive name for this model |
nextPageToken STRING A token to request the next page of results |