- 1.35.0 (latest)
- 1.34.0
- 1.33.0
- 1.32.1
- 1.31.0
- 1.30.0
- 1.26.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.1
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.0
- 1.0.0
- 0.39.0
- 0.38.0
- 0.37.1
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.2
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.13.0
- 0.12.0
- 0.11.1
- 0.10.0
Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class Query.
A query to find a number of the nearest neighbors (most similar vectors) of a vector.
Generated from protobuf message google.cloud.aiplatform.v1.FindNeighborsRequest.Query
Namespace
Google \ Cloud \ AIPlatform \ V1 \ FindNeighborsRequestMethods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ rrf
↳ datapoint
Google\Cloud\AIPlatform\V1\IndexDatapoint
Required. The datapoint/vector whose nearest neighbors should be searched for.
↳ neighbor_count
int
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 ).
↳ per_crowding_attribute_neighbor_count
int
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.
hasRrf
setRrf
Optional. Represents RRF algorithm that combines search results.
$this
getDatapoint
Required. The datapoint/vector whose nearest neighbors should be searched for.
hasDatapoint
clearDatapoint
setDatapoint
Required. The datapoint/vector whose nearest neighbors should be searched for.
$this
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 ).
int
setNeighborCount
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 ).
var
int
$this
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.
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.
var
int
$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.
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.
var
int
$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.
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.
var
float
$this
getRanking
string
