Class NearestNeighborQuery.Parameters (3.38.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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > NearestNeighborQuery.Parameters

Static Fields

APPROXIMATE_NEIGHBOR_CANDIDATES_FIELD_NUMBER

public static final int APPROXIMATE_NEIGHBOR_CANDIDATES_FIELD_NUMBER
Field Value
TypeDescription
int

LEAF_NODES_SEARCH_FRACTION_FIELD_NUMBER

public static final int LEAF_NODES_SEARCH_FRACTION_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static NearestNeighborQuery.Parameters getDefaultInstance()
Returns
TypeDescription
NearestNeighborQuery.Parameters

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static NearestNeighborQuery.Parameters.Builder newBuilder()
Returns
TypeDescription
NearestNeighborQuery.Parameters.Builder

newBuilder(NearestNeighborQuery.Parameters prototype)

public static NearestNeighborQuery.Parameters.Builder newBuilder(NearestNeighborQuery.Parameters prototype)
Parameter
NameDescription
prototypeNearestNeighborQuery.Parameters
Returns
TypeDescription
NearestNeighborQuery.Parameters.Builder

parseDelimitedFrom(InputStream input)

public static NearestNeighborQuery.Parameters parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
NearestNeighborQuery.Parameters
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static NearestNeighborQuery.Parameters parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
NearestNeighborQuery.Parameters
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static NearestNeighborQuery.Parameters parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
NearestNeighborQuery.Parameters
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static NearestNeighborQuery.Parameters parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
NearestNeighborQuery.Parameters
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static NearestNeighborQuery.Parameters parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
NearestNeighborQuery.Parameters
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static NearestNeighborQuery.Parameters parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
NearestNeighborQuery.Parameters
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static NearestNeighborQuery.Parameters parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
NearestNeighborQuery.Parameters
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static NearestNeighborQuery.Parameters parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
NearestNeighborQuery.Parameters
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static NearestNeighborQuery.Parameters parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
NearestNeighborQuery.Parameters
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static NearestNeighborQuery.Parameters parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
NearestNeighborQuery.Parameters
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static NearestNeighborQuery.Parameters parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
NearestNeighborQuery.Parameters
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static NearestNeighborQuery.Parameters parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
NearestNeighborQuery.Parameters
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<NearestNeighborQuery.Parameters> parser()
Returns
TypeDescription
Parser<Parameters>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getApproximateNeighborCandidates()

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
TypeDescription
int

The approximateNeighborCandidates.

getDefaultInstanceForType()

public NearestNeighborQuery.Parameters getDefaultInstanceForType()
Returns
TypeDescription
NearestNeighborQuery.Parameters

getLeafNodesSearchFraction()

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
TypeDescription
double

The leafNodesSearchFraction.

getParserForType()

public Parser<NearestNeighborQuery.Parameters> getParserForType()
Returns
TypeDescription
Parser<Parameters>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public NearestNeighborQuery.Parameters.Builder newBuilderForType()
Returns
TypeDescription
NearestNeighborQuery.Parameters.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected NearestNeighborQuery.Parameters.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
NearestNeighborQuery.Parameters.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public NearestNeighborQuery.Parameters.Builder toBuilder()
Returns
TypeDescription
NearestNeighborQuery.Parameters.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException