Class ModelServiceClient (2.28.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`