Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::NearestNeighborQuery::Parameters (v0.47.0)

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

Parameters that can be overrided in each query to tune query latency and recall.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#approximate_neighbor_candidates

def approximate_neighbor_candidates() -> ::Integer
Returns
  • (::Integer) — Optional. The number of neighbors to find via approximate search before exact reordering is performed; if set, this value must be > neighbor_count.

#approximate_neighbor_candidates=

def approximate_neighbor_candidates=(value) -> ::Integer
Parameter
  • value (::Integer) — Optional. The number of neighbors to find via approximate search before exact reordering is performed; if set, this value must be > neighbor_count.
Returns
  • (::Integer) — Optional. The number of neighbors to find via approximate search before exact reordering is performed; if set, this value must be > neighbor_count.

#leaf_nodes_search_fraction

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

#leaf_nodes_search_fraction=

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