Struct lance_index::vector::Query

pub struct Query {
    pub column: String,
    pub key: ArrayRef,
    pub k: usize,
    pub nprobes: usize,
    pub ef: Option<usize>,
    pub refine_factor: Option<u32>,
    pub metric_type: MetricType,
    pub use_index: bool,
}

Query parameters for the vector indices

Fields

column: String

The column to be searched.

key: ArrayRef

The vector to be searched.

k: usize

Top k results to return.

nprobes: usize

The number of probes to load and search.

ef: Option<usize>

The number of candidates to reserve while searching. this is an optional parameter for HNSW related index types.

refine_factor: Option<u32>

If presented, apply a refine step. TODO: should we support fraction / float number here?

metric_type: MetricType

Distance metric type

use_index: bool

Whether to use an ANN index if available

Trait Implementations

impl Clone for Query

fn clone(&self) -> Query

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Query

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.