Class ModelServiceClient (2.27.0)

Version 2.27.0

• 2.34.0-rc (latest)
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.1
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0

Service for performing CRUD operations on models.

Recommendation models contain all the metadata necessary to generate a set of models for the Predict() API. A model is queried indirectly via a ServingConfig, which associates a model with a given Placement (e.g. Frequently Bought Together on Home Page).

This service allows you to do the following:

• Initiate training of a model.
• Pause training of an existing model.
• List all the available models along with their metadata.
• Control their tuning schedule.

Equality

Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.

Performance

Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.

Thread Safety

Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.

Constructors

ModelServiceClient(ModelServiceClient const &)

Copy and move support

Parameter
Name	Description
	ModelServiceClient const &

ModelServiceClient(ModelServiceClient &&)

Copy and move support

Parameter
Name	Description
	ModelServiceClient &&

ModelServiceClient(std::shared_ptr< ModelServiceConnection >, Options)

Parameters
Name	Description
connection	std::shared_ptr< ModelServiceConnection >
opts	Options

Operators

operator=(ModelServiceClient const &)

Copy and move support

Parameter
Name	Description
	ModelServiceClient const &

Returns
Type	Description
ModelServiceClient &

operator=(ModelServiceClient &&)

Copy and move support

Parameter
Name	Description
	ModelServiceClient &&

Returns
Type	Description
ModelServiceClient &

Functions

CreateModel(std::string const &, google::cloud::retail::v2::Model const &, Options)

Creates a new model.

Parameters
Name	Description
parent	std::string const & Required. The parent resource under which to create the model. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}
model	google::cloud::retail::v2::Model const & Required. The payload of the Model to create.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::retail::v2::Model > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.retail.v2.Model proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateModel(NoAwaitTag, std::string const &, google::cloud::retail::v2::Model const &, Options)

Creates a new model.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	NoAwaitTag
parent	std::string const &
model	google::cloud::retail::v2::Model const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

CreateModel(google::cloud::retail::v2::CreateModelRequest const &, Options)

Creates a new model.

Parameters
Name	Description
request	google::cloud::retail::v2::CreateModelRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.retail.v2.CreateModelRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::retail::v2::Model > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.retail.v2.Model proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateModel(NoAwaitTag, google::cloud::retail::v2::CreateModelRequest const &, Options)

Creates a new model.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::retail::v2::CreateModelRequest const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

CreateModel(google::longrunning::Operation const &, Options)

Creates a new model.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
operation	google::longrunning::Operation const &
opts	Options

Returns
Type	Description
future< StatusOr< google::cloud::retail::v2::Model > >

GetModel(std::string const &, Options)

Gets a model.

Parameters
Name	Description
name	std::string const & Required. The resource name of the Model to get. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog}/models/{model_id}
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::retail::v2::Model >	the result of the RPC. The response message type (google.cloud.retail.v2.Model) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetModel(google::cloud::retail::v2::GetModelRequest const &, Options)

Gets a model.

Parameters
Name	Description
request	google::cloud::retail::v2::GetModelRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.retail.v2.GetModelRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::retail::v2::Model >	the result of the RPC. The response message type (google.cloud.retail.v2.Model) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

PauseModel(std::string const &, Options)

Pauses the training of an existing model.

Parameters
Name	Description
name	std::string const & Required. The name of the model to pause. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::retail::v2::Model >	the result of the RPC. The response message type (google.cloud.retail.v2.Model) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

PauseModel(google::cloud::retail::v2::PauseModelRequest const &, Options)

Pauses the training of an existing model.

Parameters
Name	Description
request	google::cloud::retail::v2::PauseModelRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.retail.v2.PauseModelRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::retail::v2::Model >	the result of the RPC. The response message type (google.cloud.retail.v2.Model) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ResumeModel(std::string const &, Options)

Resumes the training of an existing model.

Parameters
Name	Description
name	std::string const & Required. The name of the model to resume. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::retail::v2::Model >	the result of the RPC. The response message type (google.cloud.retail.v2.Model) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ResumeModel(google::cloud::retail::v2::ResumeModelRequest const &, Options)

Resumes the training of an existing model.

Parameters
Name	Description
request	google::cloud::retail::v2::ResumeModelRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.retail.v2.ResumeModelRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::retail::v2::Model >	the result of the RPC. The response message type (google.cloud.retail.v2.Model) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DeleteModel(std::string const &, Options)

Deletes an existing model.

Parameters
Name	Description
name	std::string const & Required. The resource name of the Model to delete. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
Status	a Status object. If the request failed, the status contains the details of the failure.

DeleteModel(google::cloud::retail::v2::DeleteModelRequest const &, Options)

Deletes an existing model.

Parameters
Name	Description
request	google::cloud::retail::v2::DeleteModelRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.retail.v2.DeleteModelRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
Status	a Status object. If the request failed, the status contains the details of the failure.

ListModels(std::string const &, Options)

Lists all the models linked to this event store.

Parameters
Name	Description
parent	std::string const & Required. The parent for which to list models. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::retail::v2::Model >	a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.retail.v2.Model, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListModels(google::cloud::retail::v2::ListModelsRequest, Options)

Lists all the models linked to this event store.

Parameters
Name	Description
request	google::cloud::retail::v2::ListModelsRequest Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.retail.v2.ListModelsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::retail::v2::Model >	a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.retail.v2.Model, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

UpdateModel(google::cloud::retail::v2::Model const &, google::protobuf::FieldMask const &, Options)

Update of model metadata.

Only fields that currently can be updated are: filtering_option and periodic_tuning_state. If other values are provided, this API method ignores them.

Parameters
Name	Description
model	google::cloud::retail::v2::Model const & Required. The body of the updated Model.
update_mask	google::protobuf::FieldMask const & Optional. Indicates which fields in the provided 'model' to update. If not set, by default updates all fields.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::retail::v2::Model >	the result of the RPC. The response message type (google.cloud.retail.v2.Model) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateModel(google::cloud::retail::v2::UpdateModelRequest const &, Options)

Update of model metadata.

Only fields that currently can be updated are: filtering_option and periodic_tuning_state. If other values are provided, this API method ignores them.

Parameters
Name	Description
request	google::cloud::retail::v2::UpdateModelRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.retail.v2.UpdateModelRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::retail::v2::Model >	the result of the RPC. The response message type (google.cloud.retail.v2.Model) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

TuneModel(std::string const &, Options)

Tunes an existing model.

Parameters
Name	Description
name	std::string const & Required. The resource name of the model to tune. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::retail::v2::TuneModelResponse > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.retail.v2.TuneModelResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

TuneModel(NoAwaitTag, std::string const &, Options)

Tunes an existing model.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	NoAwaitTag
name	std::string const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

TuneModel(google::cloud::retail::v2::TuneModelRequest const &, Options)

Tunes an existing model.

Parameters
Name	Description
request	google::cloud::retail::v2::TuneModelRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.retail.v2.TuneModelRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::retail::v2::TuneModelResponse > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.retail.v2.TuneModelResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

TuneModel(NoAwaitTag, google::cloud::retail::v2::TuneModelRequest const &, Options)

Tunes an existing model.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::retail::v2::TuneModelRequest const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

TuneModel(google::longrunning::Operation const &, Options)

Tunes an existing model.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
operation	google::longrunning::Operation const &
opts	Options

Returns
Type	Description
future< StatusOr< google::cloud::retail::v2::TuneModelResponse > >