Reference documentation and code samples for the BigQuery Client class Model.
A BigQuery ML Model represents what an ML system has learned from the training data.
Namespace
Google \ Cloud \ BigQueryMethods
__construct
Parameters | |
---|---|
Name | Description |
connection | Google\Cloud\BigQuery\Connection\ConnectionInterface Represents a connection to BigQuery. This object is created by BigQueryClient, and should not be instantiated outside of this client. |
id | string The model's ID. |
datasetId | string The dataset's ID. |
projectId | string The project's ID. |
info | array [optional] The model data. |
location | array [optional] The location of the model. |
info
See also:
Parameter | |
---|---|
Name | Description |
options | array [optional] Configuration options. |
Returns | |
---|---|
Type | Description |
array |
reload
See also:
Parameter | |
---|---|
Name | Description |
options | array [optional] Configuration options. |
Returns | |
---|---|
Type | Description |
array |
id
Retrieves the model's ID.
Example:
echo $model->id();
Returns | |
---|---|
Type | Description |
string |
identity
Retrieves the model's identity.
An identity provides a description of a resource that is nested in nature.
Example:
echo $model->identity()['modelId'];
Returns | |
---|---|
Type | Description |
array |
delete
See also:
Parameter | |
---|---|
Name | Description |
options | array [optional] Configuration options. |
exists
Check whether or not the model exists.
Example:
echo $model->exists();
Parameter | |
---|---|
Name | Description |
options | array [optional] Configuration options. |
Returns | |
---|---|
Type | Description |
bool |
update
Parameters | |
---|---|
Name | Description |
metadata | array The available options for metadata are outlined at the Model Resource API docs |
options | array [optional] Configuration options. |
Returns | |
---|---|
Type | Description |
array |
extract
See also:
Parameters | |
---|---|
Name | Description |
destination | string|Google\Cloud\Storage\StorageObject The destination object. May be a Google\Cloud\Storage\StorageObject or a URI pointing to a Google Cloud Storage object in the format of |
options | array [optional] Please see the upstream API documentation for Job configuration for the available options. |
Returns | |
---|---|
Type | Description |
Google\Cloud\BigQuery\ExtractJobConfiguration |