Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::FindNeighborsRequest::Query (v0.43.0)

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::FindNeighborsRequest::Query.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#approximate_neighbor_count

def approximate_neighbor_count() -> ::Integer
Returns
  • (::Integer) — 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.

#approximate_neighbor_count=

def approximate_neighbor_count=(value) -> ::Integer
Parameter
  • value (::Integer) — 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.
Returns
  • (::Integer) — 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.

#datapoint

def datapoint() -> ::Google::Cloud::AIPlatform::V1::IndexDatapoint
Returns

#datapoint=

def datapoint=(value) -> ::Google::Cloud::AIPlatform::V1::IndexDatapoint
Parameter
Returns

#fraction_leaf_nodes_to_search_override

def fraction_leaf_nodes_to_search_override() -> ::Float
Returns
  • (::Float) — 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.

#fraction_leaf_nodes_to_search_override=

def fraction_leaf_nodes_to_search_override=(value) -> ::Float
Parameter
  • value (::Float) — 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.
Returns
  • (::Float) — 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.

#neighbor_count

def neighbor_count() -> ::Integer
Returns
  • (::Integer) — 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).

#neighbor_count=

def neighbor_count=(value) -> ::Integer
Parameter
  • value (::Integer) — 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).
Returns
  • (::Integer) — 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).

#per_crowding_attribute_neighbor_count

def per_crowding_attribute_neighbor_count() -> ::Integer
Returns
  • (::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. It's used for improving result diversity. This field is the maximum number of matches with the same crowding tag.

#per_crowding_attribute_neighbor_count=

def per_crowding_attribute_neighbor_count=(value) -> ::Integer
Parameter
  • value (::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. It's used for improving result diversity. This field is the maximum number of matches with the same crowding tag.
Returns
  • (::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. It's used for improving result diversity. This field is the maximum number of matches with the same crowding tag.

#rrf

def rrf() -> ::Google::Cloud::AIPlatform::V1::FindNeighborsRequest::Query::RRF
Returns

#rrf=

def rrf=(value) -> ::Google::Cloud::AIPlatform::V1::FindNeighborsRequest::Query::RRF
Parameter
Returns