Package com.google.cloud.aiplatform.v1

Class FindNeighborsRequest.Query.Builder

    • Method Detail

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

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<FindNeighborsRequest.Query.Builder>

      • getDefaultInstanceForType

        public FindNeighborsRequest.Query getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

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

      • buildPartial

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

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<FindNeighborsRequest.Query.Builder>

      • mergeFrom

        public FindNeighborsRequest.Query.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<FindNeighborsRequest.Query.Builder>
        Throws:
        IOException

      • 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.

      • setDatapoint

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

      • setDatapoint

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

      • mergeDatapoint

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

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

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

      • 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.

      • setNeighborCount

        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;
        Parameters:
        value - The neighborCount to set.
        Returns:
        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:
        This builder for chaining.

      • 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.

      • setPerCrowdingAttributeNeighborCount

        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;
        Parameters:
        value - The perCrowdingAttributeNeighborCount to set.
        Returns:
        This builder for chaining.

      • 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:
        This builder for chaining.

      • 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.

      • setApproximateNeighborCount

        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;
        Parameters:
        value - The approximateNeighborCount to set.
        Returns:
        This builder for chaining.

      • 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:
        This builder for chaining.

      • 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.

      • setFractionLeafNodesToSearchOverride

        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;
        Parameters:
        value - The fractionLeafNodesToSearchOverride to set.
        Returns:
        This builder for chaining.

      • 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:
        This builder for chaining.

      • setUnknownFields

        public final FindNeighborsRequest.Query.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<FindNeighborsRequest.Query.Builder>

      • mergeUnknownFields

        public final FindNeighborsRequest.Query.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<FindNeighborsRequest.Query.Builder>