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.
↳ approximate_neighbor_count
int
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.
↳ fraction_leaf_nodes_to_search_override
float
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.
getRrf
Optional. Represents RRF algorithm that combines search results.
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.
Returns
Type
Description
int
setPerCrowdingAttributeNeighborCount
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.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
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.
Returns
Type
Description
int
setApproximateNeighborCount
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.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
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.
Returns
Type
Description
float
setFractionLeafNodesToSearchOverride
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Ai Platform V1 Client - Class Query (1.35.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.35.0 (latest)](/php/docs/reference/cloud-ai-platform/latest/V1.FindNeighborsRequest.Query)\n- [1.34.0](/php/docs/reference/cloud-ai-platform/1.34.0/V1.FindNeighborsRequest.Query)\n- [1.33.0](/php/docs/reference/cloud-ai-platform/1.33.0/V1.FindNeighborsRequest.Query)\n- [1.32.1](/php/docs/reference/cloud-ai-platform/1.32.1/V1.FindNeighborsRequest.Query)\n- [1.31.0](/php/docs/reference/cloud-ai-platform/1.31.0/V1.FindNeighborsRequest.Query)\n- [1.30.0](/php/docs/reference/cloud-ai-platform/1.30.0/V1.FindNeighborsRequest.Query)\n- [1.26.0](/php/docs/reference/cloud-ai-platform/1.26.0/V1.FindNeighborsRequest.Query)\n- [1.23.0](/php/docs/reference/cloud-ai-platform/1.23.0/V1.FindNeighborsRequest.Query)\n- [1.22.0](/php/docs/reference/cloud-ai-platform/1.22.0/V1.FindNeighborsRequest.Query)\n- [1.21.0](/php/docs/reference/cloud-ai-platform/1.21.0/V1.FindNeighborsRequest.Query)\n- [1.20.0](/php/docs/reference/cloud-ai-platform/1.20.0/V1.FindNeighborsRequest.Query)\n- [1.19.0](/php/docs/reference/cloud-ai-platform/1.19.0/V1.FindNeighborsRequest.Query)\n- [1.18.0](/php/docs/reference/cloud-ai-platform/1.18.0/V1.FindNeighborsRequest.Query)\n- [1.17.0](/php/docs/reference/cloud-ai-platform/1.17.0/V1.FindNeighborsRequest.Query)\n- [1.16.0](/php/docs/reference/cloud-ai-platform/1.16.0/V1.FindNeighborsRequest.Query)\n- [1.15.0](/php/docs/reference/cloud-ai-platform/1.15.0/V1.FindNeighborsRequest.Query)\n- [1.14.0](/php/docs/reference/cloud-ai-platform/1.14.0/V1.FindNeighborsRequest.Query)\n- [1.13.1](/php/docs/reference/cloud-ai-platform/1.13.1/V1.FindNeighborsRequest.Query)\n- [1.12.0](/php/docs/reference/cloud-ai-platform/1.12.0/V1.FindNeighborsRequest.Query)\n- [1.11.0](/php/docs/reference/cloud-ai-platform/1.11.0/V1.FindNeighborsRequest.Query)\n- [1.10.0](/php/docs/reference/cloud-ai-platform/1.10.0/V1.FindNeighborsRequest.Query)\n- [1.9.0](/php/docs/reference/cloud-ai-platform/1.9.0/V1.FindNeighborsRequest.Query)\n- [1.8.0](/php/docs/reference/cloud-ai-platform/1.8.0/V1.FindNeighborsRequest.Query)\n- [1.7.0](/php/docs/reference/cloud-ai-platform/1.7.0/V1.FindNeighborsRequest.Query)\n- [1.6.0](/php/docs/reference/cloud-ai-platform/1.6.0/V1.FindNeighborsRequest.Query)\n- [1.5.0](/php/docs/reference/cloud-ai-platform/1.5.0/V1.FindNeighborsRequest.Query)\n- [1.4.0](/php/docs/reference/cloud-ai-platform/1.4.0/V1.FindNeighborsRequest.Query)\n- [1.3.0](/php/docs/reference/cloud-ai-platform/1.3.0/V1.FindNeighborsRequest.Query)\n- [1.2.0](/php/docs/reference/cloud-ai-platform/1.2.0/V1.FindNeighborsRequest.Query)\n- [1.1.0](/php/docs/reference/cloud-ai-platform/1.1.0/V1.FindNeighborsRequest.Query)\n- [1.0.0](/php/docs/reference/cloud-ai-platform/1.0.0/V1.FindNeighborsRequest.Query)\n- [0.39.0](/php/docs/reference/cloud-ai-platform/0.39.0/V1.FindNeighborsRequest.Query)\n- [0.38.0](/php/docs/reference/cloud-ai-platform/0.38.0/V1.FindNeighborsRequest.Query)\n- [0.37.1](/php/docs/reference/cloud-ai-platform/0.37.1/V1.FindNeighborsRequest.Query)\n- [0.32.0](/php/docs/reference/cloud-ai-platform/0.32.0/V1.FindNeighborsRequest.Query)\n- [0.31.0](/php/docs/reference/cloud-ai-platform/0.31.0/V1.FindNeighborsRequest.Query)\n- [0.30.0](/php/docs/reference/cloud-ai-platform/0.30.0/V1.FindNeighborsRequest.Query)\n- [0.29.0](/php/docs/reference/cloud-ai-platform/0.29.0/V1.FindNeighborsRequest.Query)\n- [0.28.0](/php/docs/reference/cloud-ai-platform/0.28.0/V1.FindNeighborsRequest.Query)\n- [0.27.0](/php/docs/reference/cloud-ai-platform/0.27.0/V1.FindNeighborsRequest.Query)\n- [0.26.2](/php/docs/reference/cloud-ai-platform/0.26.2/V1.FindNeighborsRequest.Query)\n- [0.25.0](/php/docs/reference/cloud-ai-platform/0.25.0/V1.FindNeighborsRequest.Query)\n- [0.24.0](/php/docs/reference/cloud-ai-platform/0.24.0/V1.FindNeighborsRequest.Query)\n- [0.23.0](/php/docs/reference/cloud-ai-platform/0.23.0/V1.FindNeighborsRequest.Query)\n- [0.22.0](/php/docs/reference/cloud-ai-platform/0.22.0/V1.FindNeighborsRequest.Query)\n- [0.21.0](/php/docs/reference/cloud-ai-platform/0.21.0/V1.FindNeighborsRequest.Query)\n- [0.20.0](/php/docs/reference/cloud-ai-platform/0.20.0/V1.FindNeighborsRequest.Query)\n- [0.19.0](/php/docs/reference/cloud-ai-platform/0.19.0/V1.FindNeighborsRequest.Query)\n- [0.18.0](/php/docs/reference/cloud-ai-platform/0.18.0/V1.FindNeighborsRequest.Query)\n- [0.17.0](/php/docs/reference/cloud-ai-platform/0.17.0/V1.FindNeighborsRequest.Query)\n- [0.16.0](/php/docs/reference/cloud-ai-platform/0.16.0/V1.FindNeighborsRequest.Query)\n- [0.15.0](/php/docs/reference/cloud-ai-platform/0.15.0/V1.FindNeighborsRequest.Query)\n- [0.13.0](/php/docs/reference/cloud-ai-platform/0.13.0/V1.FindNeighborsRequest.Query)\n- [0.12.0](/php/docs/reference/cloud-ai-platform/0.12.0/V1.FindNeighborsRequest.Query)\n- [0.11.1](/php/docs/reference/cloud-ai-platform/0.11.1/V1.FindNeighborsRequest.Query)\n- [0.10.0](/php/docs/reference/cloud-ai-platform/0.10.0/V1.FindNeighborsRequest.Query) \nReference documentation and code samples for the Google Cloud Ai Platform V1 Client class Query.\n\nA query to find a number of the nearest neighbors (most similar vectors)\nof a vector.\n\nGenerated from protobuf message `google.cloud.aiplatform.v1.FindNeighborsRequest.Query`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ AIPlatform \\\\ V1 \\\\ FindNeighborsRequest\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getRrf\n\nOptional. Represents RRF algorithm that combines search results.\n\n### hasRrf\n\n### setRrf\n\nOptional. Represents RRF algorithm that combines search results.\n\n### getDatapoint\n\nRequired. The datapoint/vector whose nearest neighbors should be searched\nfor.\n\n### hasDatapoint\n\n### clearDatapoint\n\n### setDatapoint\n\nRequired. The datapoint/vector whose nearest neighbors should be searched\nfor.\n\n### getNeighborCount\n\nThe number of nearest neighbors to be retrieved from database for each\nquery. If not set, will use the default from the service configuration\n(\u003chttps://cloud.google.com/vertex-ai/docs/matching-engine/configuring-indexes#nearest-neighbor-search-config\u003e).\n\n### setNeighborCount\n\nThe number of nearest neighbors to be retrieved from database for each\nquery. If not set, will use the default from the service configuration\n(\u003chttps://cloud.google.com/vertex-ai/docs/matching-engine/configuring-indexes#nearest-neighbor-search-config\u003e).\n\n### getPerCrowdingAttributeNeighborCount\n\nCrowding is a constraint on a neighbor list produced by nearest neighbor\nsearch requiring that no more than some value k' of the k neighbors\nreturned have the same value of crowding_attribute.\n\nIt's used for improving result diversity.\nThis field is the maximum number of matches with the same crowding tag.\n\n### setPerCrowdingAttributeNeighborCount\n\nCrowding is a constraint on a neighbor list produced by nearest neighbor\nsearch requiring that no more than some value k' of the k neighbors\nreturned have the same value of crowding_attribute.\n\nIt's used for improving result diversity.\nThis field is the maximum number of matches with the same crowding tag.\n\n### getApproximateNeighborCount\n\nThe number of neighbors to find via approximate search before\nexact reordering is performed. If not set, the default value from scam\nconfig is used; if set, this value must be \\\u003e 0.\n\n### setApproximateNeighborCount\n\nThe number of neighbors to find via approximate search before\nexact reordering is performed. If not set, the default value from scam\nconfig is used; if set, this value must be \\\u003e 0.\n\n### getFractionLeafNodesToSearchOverride\n\nThe fraction of the number of leaves to search, set at query time allows\nuser to tune search performance. This value increase result in both\nsearch accuracy and latency increase. The value should be between 0.0\nand 1.0. If not set or set to 0.0, query uses the default value specified\nin\nNearestNeighborSearchConfig.TreeAHConfig.fraction_leaf_nodes_to_search.\n\n### setFractionLeafNodesToSearchOverride\n\nThe fraction of the number of leaves to search, set at query time allows\nuser to tune search performance. This value increase result in both\nsearch accuracy and latency increase. The value should be between 0.0\nand 1.0. If not set or set to 0.0, query uses the default value specified\nin\nNearestNeighborSearchConfig.TreeAHConfig.fraction_leaf_nodes_to_search.\n\n### getRanking"]]
