Class FindNeighborsRequest.Query (3.50.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.v1beta1.FindNeighborsRequest.Query

Static Fields

APPROXIMATE_NEIGHBOR_COUNT_FIELD_NUMBER

public static final int APPROXIMATE_NEIGHBOR_COUNT_FIELD_NUMBER
Field Value
Type Description
int

DATAPOINT_FIELD_NUMBER

public static final int DATAPOINT_FIELD_NUMBER
Field Value
Type Description
int

FRACTION_LEAF_NODES_TO_SEARCH_OVERRIDE_FIELD_NUMBER

public static final int FRACTION_LEAF_NODES_TO_SEARCH_OVERRIDE_FIELD_NUMBER
Field Value
Type Description
int

NEIGHBOR_COUNT_FIELD_NUMBER

public static final int NEIGHBOR_COUNT_FIELD_NUMBER
Field Value
Type Description
int

PER_CROWDING_ATTRIBUTE_NEIGHBOR_COUNT_FIELD_NUMBER

public static final int PER_CROWDING_ATTRIBUTE_NEIGHBOR_COUNT_FIELD_NUMBER
Field Value
Type Description
int

RRF_FIELD_NUMBER

public static final int RRF_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static FindNeighborsRequest.Query getDefaultInstance()
Returns
Type Description
FindNeighborsRequest.Query

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static FindNeighborsRequest.Query.Builder newBuilder()
Returns
Type Description
FindNeighborsRequest.Query.Builder

newBuilder(FindNeighborsRequest.Query prototype)

public static FindNeighborsRequest.Query.Builder newBuilder(FindNeighborsRequest.Query prototype)
Parameter
Name Description
prototype FindNeighborsRequest.Query
Returns
Type Description
FindNeighborsRequest.Query.Builder

parseDelimitedFrom(InputStream input)

public static FindNeighborsRequest.Query parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
FindNeighborsRequest.Query
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FindNeighborsRequest.Query parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FindNeighborsRequest.Query
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static FindNeighborsRequest.Query parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
FindNeighborsRequest.Query
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static FindNeighborsRequest.Query parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FindNeighborsRequest.Query
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static FindNeighborsRequest.Query parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
FindNeighborsRequest.Query
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static FindNeighborsRequest.Query parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FindNeighborsRequest.Query
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static FindNeighborsRequest.Query parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
FindNeighborsRequest.Query
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static FindNeighborsRequest.Query parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FindNeighborsRequest.Query
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static FindNeighborsRequest.Query parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
FindNeighborsRequest.Query
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FindNeighborsRequest.Query parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FindNeighborsRequest.Query
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static FindNeighborsRequest.Query parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
FindNeighborsRequest.Query
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static FindNeighborsRequest.Query parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FindNeighborsRequest.Query
Exceptions
Type Description
InvalidProtocolBufferException

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
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
Type Description
int

The approximateNeighborCount.

getDatapoint()

public IndexDatapoint getDatapoint()

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

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

Returns
Type Description
IndexDatapoint

The datapoint.

getDatapointOrBuilder()

public IndexDatapointOrBuilder getDatapointOrBuilder()

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

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

Returns
Type Description
IndexDatapointOrBuilder

getDefaultInstanceForType()

public FindNeighborsRequest.Query getDefaultInstanceForType()
Returns
Type Description
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
Type Description
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
Type Description
int

The neighborCount.

getParserForType()

public Parser<FindNeighborsRequest.Query> getParserForType()
Returns
Type Description
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
Type Description
int

The perCrowdingAttributeNeighborCount.

getRankingCase()

public FindNeighborsRequest.Query.RankingCase getRankingCase()
Returns
Type Description
FindNeighborsRequest.Query.RankingCase

getRrf()

public FindNeighborsRequest.Query.RRF getRrf()

Optional. Represents RRF algorithm that combines search results.

.google.cloud.aiplatform.v1beta1.FindNeighborsRequest.Query.RRF rrf = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FindNeighborsRequest.Query.RRF

The rrf.

getRrfOrBuilder()

public FindNeighborsRequest.Query.RRFOrBuilder getRrfOrBuilder()

Optional. Represents RRF algorithm that combines search results.

.google.cloud.aiplatform.v1beta1.FindNeighborsRequest.Query.RRF rrf = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FindNeighborsRequest.Query.RRFOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasDatapoint()

public boolean hasDatapoint()

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

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

Returns
Type Description
boolean

Whether the datapoint field is set.

hasRrf()

public boolean hasRrf()

Optional. Represents RRF algorithm that combines search results.

.google.cloud.aiplatform.v1beta1.FindNeighborsRequest.Query.RRF rrf = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the rrf field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public FindNeighborsRequest.Query.Builder newBuilderForType()
Returns
Type Description
FindNeighborsRequest.Query.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected FindNeighborsRequest.Query.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
FindNeighborsRequest.Query.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public FindNeighborsRequest.Query.Builder toBuilder()
Returns
Type Description
FindNeighborsRequest.Query.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException