Class FindNeighborsRequest.Query (3.24.0)

public static final class FindNeighborsRequest.Query extends GeneratedMessageV3 implements FindNeighborsRequest.QueryOrBuilder

A query to find a number of the nearest neighbors (most similar vectors) of a vector.

Protobuf type google.cloud.aiplatform.v1.FindNeighborsRequest.Query

Static Fields

APPROXIMATE_NEIGHBOR_COUNT_FIELD_NUMBER

public static final int APPROXIMATE_NEIGHBOR_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

DATAPOINT_FIELD_NUMBER

public static final int DATAPOINT_FIELD_NUMBER
Field Value
TypeDescription
int

FRACTION_LEAF_NODES_TO_SEARCH_OVERRIDE_FIELD_NUMBER

public static final int FRACTION_LEAF_NODES_TO_SEARCH_OVERRIDE_FIELD_NUMBER
Field Value
TypeDescription
int

NEIGHBOR_COUNT_FIELD_NUMBER

public static final int NEIGHBOR_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

PER_CROWDING_ATTRIBUTE_NEIGHBOR_COUNT_FIELD_NUMBER

public static final int PER_CROWDING_ATTRIBUTE_NEIGHBOR_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static FindNeighborsRequest.Query getDefaultInstance()
Returns
TypeDescription
FindNeighborsRequest.Query

getDescriptor()

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

newBuilder()

public static FindNeighborsRequest.Query.Builder newBuilder()
Returns
TypeDescription
FindNeighborsRequest.Query.Builder

newBuilder(FindNeighborsRequest.Query prototype)

public static FindNeighborsRequest.Query.Builder newBuilder(FindNeighborsRequest.Query prototype)
Parameter
NameDescription
prototypeFindNeighborsRequest.Query
Returns
TypeDescription
FindNeighborsRequest.Query.Builder

parseDelimitedFrom(InputStream input)

public static FindNeighborsRequest.Query parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
FindNeighborsRequest.Query
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static FindNeighborsRequest.Query parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
FindNeighborsRequest.Query
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static FindNeighborsRequest.Query parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
FindNeighborsRequest.Query
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static FindNeighborsRequest.Query parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
FindNeighborsRequest.Query
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static FindNeighborsRequest.Query parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
FindNeighborsRequest.Query
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<FindNeighborsRequest.Query> parser()
Returns
TypeDescription
Parser<Query>

Methods

equals(Object obj)

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

getApproximateNeighborCount()

public int 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.

int32 approximate_neighbor_count = 4;

Returns
TypeDescription
int

The approximateNeighborCount.

getDatapoint()

public IndexDatapoint getDatapoint()

Required. The datapoint/vector whose nearest neighbors should be searched for.

.google.cloud.aiplatform.v1.IndexDatapoint datapoint = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
IndexDatapoint

The datapoint.

getDatapointOrBuilder()

public IndexDatapointOrBuilder getDatapointOrBuilder()

Required. The datapoint/vector whose nearest neighbors should be searched for.

.google.cloud.aiplatform.v1.IndexDatapoint datapoint = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
IndexDatapointOrBuilder

getDefaultInstanceForType()

public FindNeighborsRequest.Query getDefaultInstanceForType()
Returns
TypeDescription
FindNeighborsRequest.Query

getFractionLeafNodesToSearchOverride()

public double 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.

double fraction_leaf_nodes_to_search_override = 5;

Returns
TypeDescription
double

The fractionLeafNodesToSearchOverride.

getNeighborCount()

public int 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).

int32 neighbor_count = 2;

Returns
TypeDescription
int

The neighborCount.

getParserForType()

public Parser<FindNeighborsRequest.Query> getParserForType()
Returns
TypeDescription
Parser<Query>
Overrides

getPerCrowdingAttributeNeighborCount()

public int 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.

int32 per_crowding_attribute_neighbor_count = 3;

Returns
TypeDescription
int

The perCrowdingAttributeNeighborCount.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasDatapoint()

public boolean hasDatapoint()

Required. The datapoint/vector whose nearest neighbors should be searched for.

.google.cloud.aiplatform.v1.IndexDatapoint datapoint = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
boolean

Whether the datapoint field is set.

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 FindNeighborsRequest.Query.Builder newBuilderForType()
Returns
TypeDescription
FindNeighborsRequest.Query.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected FindNeighborsRequest.Query.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
FindNeighborsRequest.Query.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public FindNeighborsRequest.Query.Builder toBuilder()
Returns
TypeDescription
FindNeighborsRequest.Query.Builder

writeTo(CodedOutputStream output)

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