Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class Parameters.
Parameters that can be overrided in each query to tune query latency and
recall.
Generated from protobuf message google.cloud.aiplatform.v1.NearestNeighborQuery.Parameters
Namespace
Google \ Cloud \ AIPlatform \ V1 \ NearestNeighborQuery
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ approximate_neighbor_candidates
int
Optional. The number of neighbors to find via approximate search before exact reordering is performed; if set, this value must be > neighbor_count.
↳ leaf_nodes_search_fraction
float
Optional. 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.
getApproximateNeighborCandidates
Optional. The number of neighbors to find via approximate search before
exact reordering is performed; if set, this value must be >
neighbor_count.
Returns
Type
Description
int
setApproximateNeighborCandidates
Optional. The number of neighbors to find via approximate search before
exact reordering is performed; if set, this value must be >
neighbor_count.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getLeafNodesSearchFraction
Optional. 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.
Returns
Type
Description
float
setLeafNodesSearchFraction
Optional. 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.
[[["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 Parameters (1.35.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.35.0 (latest)](/php/docs/reference/cloud-ai-platform/latest/V1.NearestNeighborQuery.Parameters)\n- [1.34.0](/php/docs/reference/cloud-ai-platform/1.34.0/V1.NearestNeighborQuery.Parameters)\n- [1.33.0](/php/docs/reference/cloud-ai-platform/1.33.0/V1.NearestNeighborQuery.Parameters)\n- [1.32.1](/php/docs/reference/cloud-ai-platform/1.32.1/V1.NearestNeighborQuery.Parameters)\n- [1.31.0](/php/docs/reference/cloud-ai-platform/1.31.0/V1.NearestNeighborQuery.Parameters)\n- [1.30.0](/php/docs/reference/cloud-ai-platform/1.30.0/V1.NearestNeighborQuery.Parameters)\n- [1.26.0](/php/docs/reference/cloud-ai-platform/1.26.0/V1.NearestNeighborQuery.Parameters)\n- [1.23.0](/php/docs/reference/cloud-ai-platform/1.23.0/V1.NearestNeighborQuery.Parameters)\n- [1.22.0](/php/docs/reference/cloud-ai-platform/1.22.0/V1.NearestNeighborQuery.Parameters)\n- [1.21.0](/php/docs/reference/cloud-ai-platform/1.21.0/V1.NearestNeighborQuery.Parameters)\n- [1.20.0](/php/docs/reference/cloud-ai-platform/1.20.0/V1.NearestNeighborQuery.Parameters)\n- [1.19.0](/php/docs/reference/cloud-ai-platform/1.19.0/V1.NearestNeighborQuery.Parameters)\n- [1.18.0](/php/docs/reference/cloud-ai-platform/1.18.0/V1.NearestNeighborQuery.Parameters)\n- [1.17.0](/php/docs/reference/cloud-ai-platform/1.17.0/V1.NearestNeighborQuery.Parameters)\n- [1.16.0](/php/docs/reference/cloud-ai-platform/1.16.0/V1.NearestNeighborQuery.Parameters)\n- [1.15.0](/php/docs/reference/cloud-ai-platform/1.15.0/V1.NearestNeighborQuery.Parameters)\n- [1.14.0](/php/docs/reference/cloud-ai-platform/1.14.0/V1.NearestNeighborQuery.Parameters)\n- [1.13.1](/php/docs/reference/cloud-ai-platform/1.13.1/V1.NearestNeighborQuery.Parameters)\n- [1.12.0](/php/docs/reference/cloud-ai-platform/1.12.0/V1.NearestNeighborQuery.Parameters)\n- [1.11.0](/php/docs/reference/cloud-ai-platform/1.11.0/V1.NearestNeighborQuery.Parameters)\n- [1.10.0](/php/docs/reference/cloud-ai-platform/1.10.0/V1.NearestNeighborQuery.Parameters)\n- [1.9.0](/php/docs/reference/cloud-ai-platform/1.9.0/V1.NearestNeighborQuery.Parameters)\n- [1.8.0](/php/docs/reference/cloud-ai-platform/1.8.0/V1.NearestNeighborQuery.Parameters)\n- [1.7.0](/php/docs/reference/cloud-ai-platform/1.7.0/V1.NearestNeighborQuery.Parameters)\n- [1.6.0](/php/docs/reference/cloud-ai-platform/1.6.0/V1.NearestNeighborQuery.Parameters)\n- [1.5.0](/php/docs/reference/cloud-ai-platform/1.5.0/V1.NearestNeighborQuery.Parameters)\n- [1.4.0](/php/docs/reference/cloud-ai-platform/1.4.0/V1.NearestNeighborQuery.Parameters)\n- [1.3.0](/php/docs/reference/cloud-ai-platform/1.3.0/V1.NearestNeighborQuery.Parameters)\n- [1.2.0](/php/docs/reference/cloud-ai-platform/1.2.0/V1.NearestNeighborQuery.Parameters)\n- [1.1.0](/php/docs/reference/cloud-ai-platform/1.1.0/V1.NearestNeighborQuery.Parameters)\n- [1.0.0](/php/docs/reference/cloud-ai-platform/1.0.0/V1.NearestNeighborQuery.Parameters)\n- [0.39.0](/php/docs/reference/cloud-ai-platform/0.39.0/V1.NearestNeighborQuery.Parameters)\n- [0.38.0](/php/docs/reference/cloud-ai-platform/0.38.0/V1.NearestNeighborQuery.Parameters)\n- [0.37.1](/php/docs/reference/cloud-ai-platform/0.37.1/V1.NearestNeighborQuery.Parameters)\n- [0.32.0](/php/docs/reference/cloud-ai-platform/0.32.0/V1.NearestNeighborQuery.Parameters)\n- [0.31.0](/php/docs/reference/cloud-ai-platform/0.31.0/V1.NearestNeighborQuery.Parameters)\n- [0.30.0](/php/docs/reference/cloud-ai-platform/0.30.0/V1.NearestNeighborQuery.Parameters)\n- [0.29.0](/php/docs/reference/cloud-ai-platform/0.29.0/V1.NearestNeighborQuery.Parameters)\n- [0.28.0](/php/docs/reference/cloud-ai-platform/0.28.0/V1.NearestNeighborQuery.Parameters)\n- [0.27.0](/php/docs/reference/cloud-ai-platform/0.27.0/V1.NearestNeighborQuery.Parameters)\n- [0.26.2](/php/docs/reference/cloud-ai-platform/0.26.2/V1.NearestNeighborQuery.Parameters)\n- [0.25.0](/php/docs/reference/cloud-ai-platform/0.25.0/V1.NearestNeighborQuery.Parameters)\n- [0.24.0](/php/docs/reference/cloud-ai-platform/0.24.0/V1.NearestNeighborQuery.Parameters)\n- [0.23.0](/php/docs/reference/cloud-ai-platform/0.23.0/V1.NearestNeighborQuery.Parameters)\n- [0.22.0](/php/docs/reference/cloud-ai-platform/0.22.0/V1.NearestNeighborQuery.Parameters)\n- [0.21.0](/php/docs/reference/cloud-ai-platform/0.21.0/V1.NearestNeighborQuery.Parameters)\n- [0.20.0](/php/docs/reference/cloud-ai-platform/0.20.0/V1.NearestNeighborQuery.Parameters)\n- [0.19.0](/php/docs/reference/cloud-ai-platform/0.19.0/V1.NearestNeighborQuery.Parameters)\n- [0.18.0](/php/docs/reference/cloud-ai-platform/0.18.0/V1.NearestNeighborQuery.Parameters)\n- [0.17.0](/php/docs/reference/cloud-ai-platform/0.17.0/V1.NearestNeighborQuery.Parameters)\n- [0.16.0](/php/docs/reference/cloud-ai-platform/0.16.0/V1.NearestNeighborQuery.Parameters)\n- [0.15.0](/php/docs/reference/cloud-ai-platform/0.15.0/V1.NearestNeighborQuery.Parameters)\n- [0.13.0](/php/docs/reference/cloud-ai-platform/0.13.0/V1.NearestNeighborQuery.Parameters)\n- [0.12.0](/php/docs/reference/cloud-ai-platform/0.12.0/V1.NearestNeighborQuery.Parameters)\n- [0.11.1](/php/docs/reference/cloud-ai-platform/0.11.1/V1.NearestNeighborQuery.Parameters)\n- [0.10.0](/php/docs/reference/cloud-ai-platform/0.10.0/V1.NearestNeighborQuery.Parameters) \nReference documentation and code samples for the Google Cloud Ai Platform V1 Client class Parameters.\n\nParameters that can be overrided in each query to tune query latency and\nrecall.\n\nGenerated from protobuf message `google.cloud.aiplatform.v1.NearestNeighborQuery.Parameters`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ AIPlatform \\\\ V1 \\\\ NearestNeighborQuery\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getApproximateNeighborCandidates\n\nOptional. The number of neighbors to find via approximate search before\nexact reordering is performed; if set, this value must be \\\u003e\nneighbor_count.\n\n### setApproximateNeighborCandidates\n\nOptional. The number of neighbors to find via approximate search before\nexact reordering is performed; if set, this value must be \\\u003e\nneighbor_count.\n\n### getLeafNodesSearchFraction\n\nOptional. The fraction of the number of leaves to search, set at query\ntime allows user to tune search performance. This value increase result\nin both search accuracy and latency increase. The value should be between\n0.0 and 1.0.\n\n### setLeafNodesSearchFraction\n\nOptional. The fraction of the number of leaves to search, set at query\ntime allows user to tune search performance. This value increase result\nin both search accuracy and latency increase. The value should be between\n0.0 and 1.0."]]
