Class RankServiceClient (2.30.0)

Version 2.30.0

• 2.32.0-rc (latest)
• 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

Service for ranking text records.

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

RankServiceClient(RankServiceClient const &)

Copy and move support

Parameter
Name	Description
	RankServiceClient const &

RankServiceClient(RankServiceClient &&)

Copy and move support

Parameter
Name	Description
	RankServiceClient &&

RankServiceClient(std::shared_ptr< RankServiceConnection >, Options)

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

Operators

operator=(RankServiceClient const &)

Copy and move support

Parameter
Name	Description
	RankServiceClient const &

Returns
Type	Description
RankServiceClient &

operator=(RankServiceClient &&)

Copy and move support

Parameter
Name	Description
	RankServiceClient &&

Returns
Type	Description
RankServiceClient &

Functions

Rank(google::cloud::discoveryengine::v1::RankRequest const &, Options)

Ranks a list of text records based on the given input query.

Parameters
Name	Description
request	google::cloud::discoveryengine::v1::RankRequest 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.discoveryengine.v1.RankRequest. 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::discoveryengine::v1::RankResponse >	the result of the RPC. The response message type (google.cloud.discoveryengine.v1.RankResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.