Class FindNeighborsRequest.Query (3.43.0)

Version 3.43.0

• 3.52.0 (latest)
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.0.0
• 2.9.8
• 2.8.9
• 2.7.4
• 2.5.3
• 2.4.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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > FindNeighborsRequest.Query

Implements

FindNeighborsRequest.QueryOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

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

AbstractMessage.equals(Object other)

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.

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

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

GeneratedMessageV3.getParserForType()

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.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

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.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

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

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException