com.google.cloud.aiplatform.v1beta1

Class FindNeighborsRequest.Query

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.aiplatform.v1beta1.FindNeighborsRequest.Query

All Implemented Interfaces:

FindNeighborsRequest.QueryOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

FindNeighborsRequest

public static final class FindNeighborsRequest.Query
extends com.google.protobuf.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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FindNeighborsRequest.Query.Builder A query to find a number of the nearest neighbors (most similar vectors) of a vector.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	APPROXIMATE_NEIGHBOR_COUNT_FIELD_NUMBER
static int	DATAPOINT_FIELD_NUMBER
static int	FRACTION_LEAF_NODES_TO_SEARCH_OVERRIDE_FIELD_NUMBER
static int	NEIGHBOR_COUNT_FIELD_NUMBER
static int	PER_CROWDING_ATTRIBUTE_NEIGHBOR_COUNT_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
int	getApproximateNeighborCount() The number of neighbors to find via approximate search before exact reordering is performed.
IndexDatapoint	getDatapoint() Required.
IndexDatapointOrBuilder	getDatapointOrBuilder() Required.
static FindNeighborsRequest.Query	getDefaultInstance()
FindNeighborsRequest.Query	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
double	getFractionLeafNodesToSearchOverride() The fraction of the number of leaves to search, set at query time allows user to tune search performance.
int	getNeighborCount() The number of nearest neighbors to be retrieved from database for each query.
com.google.protobuf.Parser<FindNeighborsRequest.Query>	getParserForType()
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.
int	getSerializedSize()
boolean	hasDatapoint() Required.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static FindNeighborsRequest.Query.Builder	newBuilder()
static FindNeighborsRequest.Query.Builder	newBuilder(FindNeighborsRequest.Query prototype)
FindNeighborsRequest.Query.Builder	newBuilderForType()
protected FindNeighborsRequest.Query.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static FindNeighborsRequest.Query	parseDelimitedFrom(InputStream input)
static FindNeighborsRequest.Query	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FindNeighborsRequest.Query	parseFrom(byte[] data)
static FindNeighborsRequest.Query	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FindNeighborsRequest.Query	parseFrom(ByteBuffer data)
static FindNeighborsRequest.Query	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FindNeighborsRequest.Query	parseFrom(com.google.protobuf.ByteString data)
static FindNeighborsRequest.Query	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FindNeighborsRequest.Query	parseFrom(com.google.protobuf.CodedInputStream input)
static FindNeighborsRequest.Query	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FindNeighborsRequest.Query	parseFrom(InputStream input)
static FindNeighborsRequest.Query	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<FindNeighborsRequest.Query>	parser()
FindNeighborsRequest.Query.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

DATAPOINT_FIELD_NUMBER

public static final int DATAPOINT_FIELD_NUMBER

See Also:

Constant Field Values

NEIGHBOR_COUNT_FIELD_NUMBER

public static final int NEIGHBOR_COUNT_FIELD_NUMBER

See Also:

Constant Field Values

PER_CROWDING_ATTRIBUTE_NEIGHBOR_COUNT_FIELD_NUMBER

public static final int PER_CROWDING_ATTRIBUTE_NEIGHBOR_COUNT_FIELD_NUMBER

See Also:

Constant Field Values

APPROXIMATE_NEIGHBOR_COUNT_FIELD_NUMBER

public static final int APPROXIMATE_NEIGHBOR_COUNT_FIELD_NUMBER

See Also:

Constant Field Values

FRACTION_LEAF_NODES_TO_SEARCH_OVERRIDE_FIELD_NUMBER

public static final int FRACTION_LEAF_NODES_TO_SEARCH_OVERRIDE_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

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];

Specified by:

hasDatapoint in interface FindNeighborsRequest.QueryOrBuilder

Returns:

Whether the datapoint field is set.

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];

Specified by:

getDatapoint in interface FindNeighborsRequest.QueryOrBuilder

Returns:

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];

Specified by:

getDatapointOrBuilder in interface FindNeighborsRequest.QueryOrBuilder

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;

Specified by:

getNeighborCount in interface FindNeighborsRequest.QueryOrBuilder

Returns:

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;

Specified by:

getPerCrowdingAttributeNeighborCount in interface FindNeighborsRequest.QueryOrBuilder

Returns:

The perCrowdingAttributeNeighborCount.

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;

Specified by:

getApproximateNeighborCount in interface FindNeighborsRequest.QueryOrBuilder

Returns:

The approximateNeighborCount.

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;

Specified by:

getFractionLeafNodesToSearchOverride in interface FindNeighborsRequest.QueryOrBuilder

Returns:

The fractionLeafNodesToSearchOverride.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static FindNeighborsRequest.Query parseFrom(ByteBuffer data)
                                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static FindNeighborsRequest.Query parseFrom(ByteBuffer data,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static FindNeighborsRequest.Query parseFrom(com.google.protobuf.ByteString data)
                                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static FindNeighborsRequest.Query parseFrom(com.google.protobuf.ByteString data,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static FindNeighborsRequest.Query parseFrom(byte[] data)
                                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static FindNeighborsRequest.Query parseFrom(byte[] data,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static FindNeighborsRequest.Query parseFrom(InputStream input)
                                            throws IOException

Throws:

IOException

parseFrom

public static FindNeighborsRequest.Query parseFrom(InputStream input,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws IOException

Throws:

IOException

parseDelimitedFrom

public static FindNeighborsRequest.Query parseDelimitedFrom(InputStream input)
                                                     throws IOException

Throws:

IOException

parseDelimitedFrom

public static FindNeighborsRequest.Query parseDelimitedFrom(InputStream input,
                                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                     throws IOException

Throws:

IOException

parseFrom

public static FindNeighborsRequest.Query parseFrom(com.google.protobuf.CodedInputStream input)
                                            throws IOException

Throws:

IOException

parseFrom

public static FindNeighborsRequest.Query parseFrom(com.google.protobuf.CodedInputStream input,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws IOException

Throws:

IOException

newBuilderForType

public FindNeighborsRequest.Query.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static FindNeighborsRequest.Query.Builder newBuilder()

newBuilder

public static FindNeighborsRequest.Query.Builder newBuilder(FindNeighborsRequest.Query prototype)

toBuilder

public FindNeighborsRequest.Query.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected FindNeighborsRequest.Query.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static FindNeighborsRequest.Query getDefaultInstance()

parser

public static com.google.protobuf.Parser<FindNeighborsRequest.Query> parser()

getParserForType

public com.google.protobuf.Parser<FindNeighborsRequest.Query> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public FindNeighborsRequest.Query getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder