BigQuery Client - Class Model (1.27.0)

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.

Retrieves the model's details. If no model data is cached, a network request will be made to retrieve it.

Please note that Model instances created by list calls may not contain a full representation of the model resource. To obtain a full resource on a Model instance, call Google\Cloud\BigQuery\Model::reload().

Example:

$info = $model->info();
echo $info['modelType'];

Triggers a network request to reload the model's details.

Example:

$model->reload();
$info = $model->info();
echo $info['modelType'];

Retrieves the model's ID.

Example:

 echo $model->id();

Retrieves the model's identity.

An identity provides a description of a resource that is nested in nature.

Example:

echo $model->identity()['modelId'];

Delete the model.

Please note that by default the library will not attempt to retry this call on your behalf.

Example:

$model->delete();

Check whether or not the model exists.

Example:

echo $model->exists();

Update the model.

Providing an etag key as part of $metadata will enable simultaneous update protection. This is useful in preventing override of modifications made by another user. The resource's current etag can be obtained via a GET request on the resource.

Please note that by default this call will not automatically retry on your behalf unless an etag is set.

Example:

$model->update([
 'friendlyName' => 'My ML model'
]);

Returns an extract job configuration to be passed to either BigQueryClient::runJob() or BigQueryClient::startJob(). A configuration can be built using fluent setters or by providing a full set of options at once.

Example:

$destinationObject = $storage->bucket('myBucket')->object('modelOutput');
$extractJobConfig = $model->extract($destinationObject);