Class NearestNeighborQuery.Parameters (3.77.0)
public static final class NearestNeighborQuery.Parameters extends GeneratedMessageV3 implements NearestNeighborQuery.ParametersOrBuilder
Parameters that can be overrided in each query to tune query latency and
recall.
Protobuf type google.cloud.aiplatform.v1.NearestNeighborQuery.Parameters
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int APPROXIMATE_NEIGHBOR_CANDIDATES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int LEAF_NODES_SEARCH_FRACTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static NearestNeighborQuery.Parameters getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static NearestNeighborQuery.Parameters.Builder newBuilder()
public static NearestNeighborQuery.Parameters.Builder newBuilder(NearestNeighborQuery.Parameters prototype)
public static NearestNeighborQuery.Parameters parseDelimitedFrom(InputStream input)
public static NearestNeighborQuery.Parameters parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static NearestNeighborQuery.Parameters parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static NearestNeighborQuery.Parameters parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static NearestNeighborQuery.Parameters parseFrom(ByteString data)
public static NearestNeighborQuery.Parameters parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static NearestNeighborQuery.Parameters parseFrom(CodedInputStream input)
public static NearestNeighborQuery.Parameters parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static NearestNeighborQuery.Parameters parseFrom(InputStream input)
public static NearestNeighborQuery.Parameters parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static NearestNeighborQuery.Parameters parseFrom(ByteBuffer data)
public static NearestNeighborQuery.Parameters parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<NearestNeighborQuery.Parameters> parser()
Methods
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
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 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.
|
public Parser<NearestNeighborQuery.Parameters> getParserForType()
Overrides
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public NearestNeighborQuery.Parameters.Builder newBuilderForType()
protected NearestNeighborQuery.Parameters.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
public NearestNeighborQuery.Parameters.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
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-11 UTC.
[[["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-11 UTC."],[],[]]
