Interface FindNeighborsRequest.QueryOrBuilder (3.45.0)

Version 3.45.0

• 3.52.0 (latest)
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.0.0
• 2.9.8
• 2.8.9
• 2.7.4
• 2.5.3
• 2.4.0

public static interface FindNeighborsRequest.QueryOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getApproximateNeighborCount()

public abstract int getApproximateNeighborCount()

The number of neighbors to find via approximate search before exact reordering is performed. If not set, the default value from scam config is used; if set, this value must be > 0.

int32 approximate_neighbor_count = 4;

Returns
Type	Description
int	The approximateNeighborCount.

getDatapoint()

public abstract IndexDatapoint getDatapoint()

Required. The datapoint/vector whose nearest neighbors should be searched for.

.google.cloud.aiplatform.v1.IndexDatapoint datapoint = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
IndexDatapoint	The datapoint.

getDatapointOrBuilder()

public abstract IndexDatapointOrBuilder getDatapointOrBuilder()

Required. The datapoint/vector whose nearest neighbors should be searched for.

.google.cloud.aiplatform.v1.IndexDatapoint datapoint = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
IndexDatapointOrBuilder

getFractionLeafNodesToSearchOverride()

public abstract double getFractionLeafNodesToSearchOverride()

The fraction of the number of leaves to search, set at query time allows user to tune search performance. This value increase result in both search accuracy and latency increase. The value should be between 0.0 and 1.0. If not set or set to 0.0, query uses the default value specified in NearestNeighborSearchConfig.TreeAHConfig.fraction_leaf_nodes_to_search.

double fraction_leaf_nodes_to_search_override = 5;

Returns
Type	Description
double	The fractionLeafNodesToSearchOverride.

getNeighborCount()

public abstract int getNeighborCount()

The number of nearest neighbors to be retrieved from database for each query. If not set, will use the default from the service configuration (https://cloud.google.com/vertex-ai/docs/matching-engine/configuring-indexes#nearest-neighbor-search-config).

int32 neighbor_count = 2;

Returns
Type	Description
int	The neighborCount.

getPerCrowdingAttributeNeighborCount()

public abstract int getPerCrowdingAttributeNeighborCount()

Crowding is a constraint on a neighbor list produced by nearest neighbor search requiring that no more than some value k' of the k neighbors returned have the same value of crowding_attribute. It's used for improving result diversity. This field is the maximum number of matches with the same crowding tag.

int32 per_crowding_attribute_neighbor_count = 3;

Returns
Type	Description
int	The perCrowdingAttributeNeighborCount.

hasDatapoint()

public abstract boolean hasDatapoint()

Required. The datapoint/vector whose nearest neighbors should be searched for.

.google.cloud.aiplatform.v1.IndexDatapoint datapoint = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the datapoint field is set.