Package com.google.cloud.aiplatform.v1

Interface FindNeighborsRequest.QueryOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
FindNeighborsRequest.Query, FindNeighborsRequest.Query.Builder
Enclosing class:
FindNeighborsRequest
public static interface FindNeighborsRequest.QueryOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasRrf

      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:
      Whether the rrf field is set.

    • getRrf

      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:
      The rrf.

    • getRrfOrBuilder

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

    • hasDatapoint

      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:
      Whether the datapoint field is set.

    • getDatapoint

      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:
      The datapoint.

    • getDatapointOrBuilder

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

    • getNeighborCount

      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:
      The neighborCount.

    • getPerCrowdingAttributeNeighborCount

      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:
      The perCrowdingAttributeNeighborCount.

    • getApproximateNeighborCount

      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:
      The approximateNeighborCount.

    • getFractionLeafNodesToSearchOverride

      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:
      The fractionLeafNodesToSearchOverride.

    • getRankingCase

      FindNeighborsRequest.Query.RankingCase getRankingCase()