Package com.google.cloud.aiplatform.v1

Class 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.v1.FindNeighborsRequest.Query
    See Also:
    Serialized Form

    • Field Detail

      • 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.v1.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.v1.IndexDatapoint datapoint = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getDatapoint in interface FindNeighborsRequest.QueryOrBuilder
        Returns:
        The datapoint.

      • 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

      • newBuilderForType

        public FindNeighborsRequest.Query.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • 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

      • 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