Class MatchServiceClient (2.23.0-rc)

MatchService is a Google managed service for efficient vector similarity search at scale.

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

MatchServiceClient(MatchServiceClient const &)

Copy and move support

Parameter
Name	Description
	`MatchServiceClient const &`

MatchServiceClient(MatchServiceClient &&)

Copy and move support

Parameter
Name	Description
	`MatchServiceClient &&`

MatchServiceClient(std::shared_ptr< MatchServiceConnection >, Options)

Parameters
Name	Description
`connection`	`std::shared_ptr< MatchServiceConnection >`
`opts`	`Options`

Operators

operator=(MatchServiceClient const &)

Copy and move support

Parameter
Name	Description
	`MatchServiceClient const &`

Returns
Type	Description
`MatchServiceClient &`

operator=(MatchServiceClient &&)

Copy and move support

Parameter
Name	Description
	`MatchServiceClient &&`

Returns
Type	Description
`MatchServiceClient &`

Functions

FindNeighbors(google::cloud::aiplatform::v1::FindNeighborsRequest const &, Options)

Finds the nearest neighbors of each vector within the request.

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

ReadIndexDatapoints(google::cloud::aiplatform::v1::ReadIndexDatapointsRequest const &, Options)

Reads the datapoints/vectors of the given IDs.

A maximum of 1000 datapoints can be retrieved in a batch.

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