Struct VectorIndexQuery 

pub struct VectorIndexQuery {
    pub query: Vector,
    pub params: VectorIndexQueryParams,
    pub field_name: Option<String>,
}

Low-level query for a single-vector search against a vector index.

This type represents a single nearest-neighbor query at the index level, in contrast to the high-level VectorSearchRequest which can contain multiple query vectors and aggregation settings.

Naming convention: low-level index operations use “Query” (e.g., VectorIndexQuery, VectorIndexQueryParams), while high-level store/engine operations use “Request” (e.g., VectorSearchRequest).

Fields

query: Vector

The query vector.

params: VectorIndexQueryParams

Search configuration.

field_name: Option<String>

Optional field name to filter search results. If None, searches across all fields.

Implementations

impl VectorIndexQuery

pub fn new(query: Vector) -> Self

Create a new vector search request.

pub fn top_k(self, top_k: usize) -> Self

Set the number of results to return.

pub fn min_similarity(self, threshold: f32) -> Self

Set minimum similarity threshold.

pub fn include_scores(self, include: bool) -> Self

Set whether to include scores in results.

pub fn include_vectors(self, include: bool) -> Self

Set whether to include vectors in results.

pub fn timeout_ms(self, timeout: u64) -> Self

Set search timeout in milliseconds.

pub fn field_name(self, field_name: String) -> Self

Set field name to filter search results.

Trait Implementations

impl Clone for VectorIndexQuery

fn clone(&self) -> VectorIndexQuery

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VectorIndexQuery

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

Formats the value using the given formatter.