Class FindNeighborsRequest.Query.Builder (3.48.0)

public static final class FindNeighborsRequest.Query.Builder extends GeneratedMessageV3.Builder<FindNeighborsRequest.Query.Builder> 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 Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public FindNeighborsRequest.Query.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
FindNeighborsRequest.Query.Builder
Overrides

build()

public FindNeighborsRequest.Query build()
Returns
Type Description
FindNeighborsRequest.Query

buildPartial()

public FindNeighborsRequest.Query buildPartial()
Returns
Type Description
FindNeighborsRequest.Query

clear()

public FindNeighborsRequest.Query.Builder clear()
Returns
Type Description
FindNeighborsRequest.Query.Builder
Overrides

clearApproximateNeighborCount()

public FindNeighborsRequest.Query.Builder clearApproximateNeighborCount()

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
FindNeighborsRequest.Query.Builder

This builder for chaining.

clearDatapoint()

public FindNeighborsRequest.Query.Builder clearDatapoint()

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

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

Returns
Type Description
FindNeighborsRequest.Query.Builder

clearField(Descriptors.FieldDescriptor field)

public FindNeighborsRequest.Query.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
FindNeighborsRequest.Query.Builder
Overrides

clearFractionLeafNodesToSearchOverride()

public FindNeighborsRequest.Query.Builder clearFractionLeafNodesToSearchOverride()

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
FindNeighborsRequest.Query.Builder

This builder for chaining.

clearNeighborCount()

public FindNeighborsRequest.Query.Builder clearNeighborCount()

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
FindNeighborsRequest.Query.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public FindNeighborsRequest.Query.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
FindNeighborsRequest.Query.Builder
Overrides

clearPerCrowdingAttributeNeighborCount()

public FindNeighborsRequest.Query.Builder clearPerCrowdingAttributeNeighborCount()

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
FindNeighborsRequest.Query.Builder

This builder for chaining.

clearRanking()

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

clearRrf()

public FindNeighborsRequest.Query.Builder clearRrf()

Optional. Represents RRF algorithm that combines search results.

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

Returns
Type Description
FindNeighborsRequest.Query.Builder

clone()

public FindNeighborsRequest.Query.Builder clone()
Returns
Type Description
FindNeighborsRequest.Query.Builder
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.v1.IndexDatapoint datapoint = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
IndexDatapoint

The datapoint.

getDatapointBuilder()

public IndexDatapoint.Builder getDatapointBuilder()

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

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

Returns
Type Description
IndexDatapoint.Builder

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
Type Description
IndexDatapointOrBuilder

getDefaultInstanceForType()

public FindNeighborsRequest.Query getDefaultInstanceForType()
Returns
Type Description
FindNeighborsRequest.Query

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

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.v1.FindNeighborsRequest.Query.RRF rrf = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FindNeighborsRequest.Query.RRF

The rrf.

getRrfBuilder()

public FindNeighborsRequest.Query.RRF.Builder getRrfBuilder()

Optional. Represents RRF algorithm that combines search results.

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

Returns
Type Description
FindNeighborsRequest.Query.RRF.Builder

getRrfOrBuilder()

public FindNeighborsRequest.Query.RRFOrBuilder getRrfOrBuilder()

Optional. Represents RRF algorithm that combines search results.

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

Returns
Type Description
FindNeighborsRequest.Query.RRFOrBuilder

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
Type Description
boolean

Whether the datapoint field is set.

hasRrf()

public boolean hasRrf()

Optional. Represents RRF algorithm that combines search results.

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

Returns
Type Description
boolean

Whether the rrf field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeDatapoint(IndexDatapoint value)

public FindNeighborsRequest.Query.Builder mergeDatapoint(IndexDatapoint value)

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

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

Parameter
Name Description
value IndexDatapoint
Returns
Type Description
FindNeighborsRequest.Query.Builder

mergeFrom(FindNeighborsRequest.Query other)

public FindNeighborsRequest.Query.Builder mergeFrom(FindNeighborsRequest.Query other)
Parameter
Name Description
other FindNeighborsRequest.Query
Returns
Type Description
FindNeighborsRequest.Query.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public FindNeighborsRequest.Query.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FindNeighborsRequest.Query.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public FindNeighborsRequest.Query.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
FindNeighborsRequest.Query.Builder
Overrides

mergeRrf(FindNeighborsRequest.Query.RRF value)

public FindNeighborsRequest.Query.Builder mergeRrf(FindNeighborsRequest.Query.RRF value)

Optional. Represents RRF algorithm that combines search results.

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

Parameter
Name Description
value FindNeighborsRequest.Query.RRF
Returns
Type Description
FindNeighborsRequest.Query.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final FindNeighborsRequest.Query.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
FindNeighborsRequest.Query.Builder
Overrides

setApproximateNeighborCount(int value)

public FindNeighborsRequest.Query.Builder setApproximateNeighborCount(int value)

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;

Parameter
Name Description
value int

The approximateNeighborCount to set.

Returns
Type Description
FindNeighborsRequest.Query.Builder

This builder for chaining.

setDatapoint(IndexDatapoint value)

public FindNeighborsRequest.Query.Builder setDatapoint(IndexDatapoint value)

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

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

Parameter
Name Description
value IndexDatapoint
Returns
Type Description
FindNeighborsRequest.Query.Builder

setDatapoint(IndexDatapoint.Builder builderForValue)

public FindNeighborsRequest.Query.Builder setDatapoint(IndexDatapoint.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue IndexDatapoint.Builder
Returns
Type Description
FindNeighborsRequest.Query.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public FindNeighborsRequest.Query.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
FindNeighborsRequest.Query.Builder
Overrides

setFractionLeafNodesToSearchOverride(double value)

public FindNeighborsRequest.Query.Builder setFractionLeafNodesToSearchOverride(double value)

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;

Parameter
Name Description
value double

The fractionLeafNodesToSearchOverride to set.

Returns
Type Description
FindNeighborsRequest.Query.Builder

This builder for chaining.

setNeighborCount(int value)

public FindNeighborsRequest.Query.Builder setNeighborCount(int value)

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;

Parameter
Name Description
value int

The neighborCount to set.

Returns
Type Description
FindNeighborsRequest.Query.Builder

This builder for chaining.

setPerCrowdingAttributeNeighborCount(int value)

public FindNeighborsRequest.Query.Builder setPerCrowdingAttributeNeighborCount(int value)

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;

Parameter
Name Description
value int

The perCrowdingAttributeNeighborCount to set.

Returns
Type Description
FindNeighborsRequest.Query.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public FindNeighborsRequest.Query.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
FindNeighborsRequest.Query.Builder
Overrides

setRrf(FindNeighborsRequest.Query.RRF value)

public FindNeighborsRequest.Query.Builder setRrf(FindNeighborsRequest.Query.RRF value)

Optional. Represents RRF algorithm that combines search results.

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

Parameter
Name Description
value FindNeighborsRequest.Query.RRF
Returns
Type Description
FindNeighborsRequest.Query.Builder

setRrf(FindNeighborsRequest.Query.RRF.Builder builderForValue)

public FindNeighborsRequest.Query.Builder setRrf(FindNeighborsRequest.Query.RRF.Builder builderForValue)

Optional. Represents RRF algorithm that combines search results.

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

Parameter
Name Description
builderForValue FindNeighborsRequest.Query.RRF.Builder
Returns
Type Description
FindNeighborsRequest.Query.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final FindNeighborsRequest.Query.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
FindNeighborsRequest.Query.Builder
Overrides