Class: Google::Cloud::AIPlatform::V1::FindNeighborsRequest::Query

Inherits:

Object

• Object
• Google::Cloud::AIPlatform::V1::FindNeighborsRequest::Query

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/aiplatform/v1/match_service.rb

Overview

A query to find a number of the nearest neighbors (most similar vectors) of a vector.

Defined Under Namespace

Classes: RRF

Instance Attribute Summary

• #approximate_neighbor_count ⇒ ::Integer

  The number of neighbors to find via approximate search before exact reordering is performed.

• #datapoint ⇒ ::Google::Cloud::AIPlatform::V1::IndexDatapoint

  Required.

• #fraction_leaf_nodes_to_search_override ⇒ ::Float

  The fraction of the number of leaves to search, set at query time allows user to tune search performance.

• #neighbor_count ⇒ ::Integer

  The number of nearest neighbors to be retrieved from database for each query.

• #per_crowding_attribute_neighbor_count ⇒ ::Integer

  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.

• #rrf ⇒ ::Google::Cloud::AIPlatform::V1::FindNeighborsRequest::Query::RRF

  Optional.

Instance Attribute Details

#approximate_neighbor_count ⇒ ::Integer

# File 'proto_docs/google/cloud/aiplatform/v1/match_service.rb', line 86

class Query
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Parameters for RRF algorithm that combines search results.
  # @!attribute [rw] alpha
  #   @return [::Float]
  #     Required. Users can provide an alpha value to give more weight to dense
  #     vs sparse results. For example, if the alpha is 0, we only return
  #     sparse and if the alpha is 1, we only return dense.
  class RRF
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#datapoint ⇒ ::Google::Cloud::AIPlatform::V1::IndexDatapoint

# File 'proto_docs/google/cloud/aiplatform/v1/match_service.rb', line 86

class Query
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Parameters for RRF algorithm that combines search results.
  # @!attribute [rw] alpha
  #   @return [::Float]
  #     Required. Users can provide an alpha value to give more weight to dense
  #     vs sparse results. For example, if the alpha is 0, we only return
  #     sparse and if the alpha is 1, we only return dense.
  class RRF
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#fraction_leaf_nodes_to_search_override ⇒ ::Float

# File 'proto_docs/google/cloud/aiplatform/v1/match_service.rb', line 86

class Query
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Parameters for RRF algorithm that combines search results.
  # @!attribute [rw] alpha
  #   @return [::Float]
  #     Required. Users can provide an alpha value to give more weight to dense
  #     vs sparse results. For example, if the alpha is 0, we only return
  #     sparse and if the alpha is 1, we only return dense.
  class RRF
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#neighbor_count ⇒ ::Integer

# File 'proto_docs/google/cloud/aiplatform/v1/match_service.rb', line 86

class Query
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Parameters for RRF algorithm that combines search results.
  # @!attribute [rw] alpha
  #   @return [::Float]
  #     Required. Users can provide an alpha value to give more weight to dense
  #     vs sparse results. For example, if the alpha is 0, we only return
  #     sparse and if the alpha is 1, we only return dense.
  class RRF
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#per_crowding_attribute_neighbor_count ⇒ ::Integer

# File 'proto_docs/google/cloud/aiplatform/v1/match_service.rb', line 86

class Query
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Parameters for RRF algorithm that combines search results.
  # @!attribute [rw] alpha
  #   @return [::Float]
  #     Required. Users can provide an alpha value to give more weight to dense
  #     vs sparse results. For example, if the alpha is 0, we only return
  #     sparse and if the alpha is 1, we only return dense.
  class RRF
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#rrf ⇒ ::Google::Cloud::AIPlatform::V1::FindNeighborsRequest::Query::RRF

# File 'proto_docs/google/cloud/aiplatform/v1/match_service.rb', line 86

class Query
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Parameters for RRF algorithm that combines search results.
  # @!attribute [rw] alpha
  #   @return [::Float]
  #     Required. Users can provide an alpha value to give more weight to dense
  #     vs sparse results. For example, if the alpha is 0, we only return
  #     sparse and if the alpha is 1, we only return dense.
  class RRF
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end