Send feedback
Class NearestNeighborQuery.Parameters.Builder (3.79.0)
Version latestkeyboard_arrow_down
public static final class NearestNeighborQuery . Parameters . Builder extends GeneratedMessageV3 . Builder<NearestNeighborQuery . Parameters . Builder > implements NearestNeighborQuery . ParametersOrBuilder
Parameters that can be overrided in each query to tune query latency and
recall.
Protobuf type google.cloud.aiplatform.v1beta1.NearestNeighborQuery.Parameters
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
public static final Descriptors . Descriptor getDescriptor ()
Methods
public NearestNeighborQuery . Parameters . Builder addRepeatedField ( Descriptors . FieldDescriptor field , Object value )
Overrides
public NearestNeighborQuery . Parameters build ()
public NearestNeighborQuery . Parameters buildPartial ()
public NearestNeighborQuery . Parameters . Builder clear ()
Overrides
public NearestNeighborQuery . Parameters . Builder clearApproximateNeighborCandidates ()
Optional. The number of neighbors to find via approximate search before
exact reordering is performed; if set, this value must be >
neighbor_count.
int32 approximate_neighbor_candidates = 1 [(.google.api.field_behavior) = OPTIONAL];
public NearestNeighborQuery . Parameters . Builder clearField ( Descriptors . FieldDescriptor field )
Overrides
public NearestNeighborQuery . Parameters . Builder clearLeafNodesSearchFraction ()
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.
double leaf_nodes_search_fraction = 2 [(.google.api.field_behavior) = OPTIONAL];
public NearestNeighborQuery . Parameters . Builder clearOneof ( Descriptors . OneofDescriptor oneof )
Overrides
public NearestNeighborQuery . Parameters . Builder clone ()
Overrides
public int getApproximateNeighborCandidates ()
Optional. The number of neighbors to find via approximate search before
exact reordering is performed; if set, this value must be >
neighbor_count.
int32 approximate_neighbor_candidates = 1 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
int The approximateNeighborCandidates.
public NearestNeighborQuery . Parameters getDefaultInstanceForType ()
public Descriptors . Descriptor getDescriptorForType ()
Overrides
public double 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.
double leaf_nodes_search_fraction = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
double The leafNodesSearchFraction.
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
public final boolean isInitialized ()
Overrides
public NearestNeighborQuery . Parameters . Builder mergeFrom ( NearestNeighborQuery . Parameters other )
public NearestNeighborQuery . Parameters . Builder mergeFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Overrides
public NearestNeighborQuery . Parameters . Builder mergeFrom ( Message other )
Parameter
Name Description
otherMessage
Overrides
public final NearestNeighborQuery . Parameters . Builder mergeUnknownFields ( UnknownFieldSet unknownFields )
Overrides
public NearestNeighborQuery . Parameters . Builder setApproximateNeighborCandidates ( int value )
Optional. The number of neighbors to find via approximate search before
exact reordering is performed; if set, this value must be >
neighbor_count.
int32 approximate_neighbor_candidates = 1 [(.google.api.field_behavior) = OPTIONAL];
Parameter
Name Description
valueint The approximateNeighborCandidates to set.
public NearestNeighborQuery . Parameters . Builder setField ( Descriptors . FieldDescriptor field , Object value )
Overrides
public NearestNeighborQuery . Parameters . Builder setLeafNodesSearchFraction ( double value )
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.
double leaf_nodes_search_fraction = 2 [(.google.api.field_behavior) = OPTIONAL];
Parameter
Name Description
valuedouble The leafNodesSearchFraction to set.
public NearestNeighborQuery . Parameters . Builder setRepeatedField ( Descriptors . FieldDescriptor field , int index , Object value )
Overrides
public final NearestNeighborQuery . Parameters . Builder setUnknownFields ( UnknownFieldSet unknownFields )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-29 UTC.
Need to tell us more?
[[["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-10-29 UTC."],[],[]]
