Struct VectorQuery 

pub struct VectorQuery<'a> { /* private fields */ }

Vector nearest-neighbor query.

Implementations

impl<'a> VectorQuery<'a>

pub fn new( vector: Vector<'a>, vector_field_name: impl Into<String>, num_results: usize, ) -> Self

Creates a vector nearest-neighbor query.

pub fn with_filter(self, filter_expression: FilterExpression) -> Self

Attaches a filter expression.

pub fn set_filter(&mut self, filter_expression: FilterExpression)

Replaces the filter expression in place.

pub fn with_ef_runtime(self, ef_runtime: usize) -> Self

Sets the runtime EF parameter (HNSW indexes).

pub fn set_ef_runtime(&mut self, ef_runtime: usize)

Replaces the runtime EF parameter in place.

pub fn ef_runtime(&self) -> Option<usize>

Returns the current EF runtime setting.

pub fn with_epsilon(self, epsilon: f64) -> Self

Sets the epsilon parameter for approximate search.

pub fn set_epsilon(&mut self, epsilon: f64)

Replaces the epsilon parameter in place.

pub fn epsilon(&self) -> Option<f64>

Returns the current epsilon setting.

pub fn with_hybrid_policy(self, policy: HybridPolicy) -> Self

Sets the hybrid search policy.

pub fn set_hybrid_policy(&mut self, policy: HybridPolicy)

Replaces the hybrid search policy in place.

pub fn hybrid_policy(&self) -> Option<HybridPolicy>

Returns the current hybrid policy setting.

pub fn with_batch_size(self, batch_size: usize) -> Self

Sets the batch size for BATCHES hybrid search policy.

pub fn set_batch_size(&mut self, batch_size: usize)

Replaces the batch size in place.

pub fn batch_size(&self) -> Option<usize>

Returns the current batch size setting.

pub fn with_search_window_size(self, size: usize) -> Self

Sets the search window size (SVS-VAMANA indexes).

pub fn set_search_window_size(&mut self, size: usize)

Replaces the search window size in place.

pub fn search_window_size(&self) -> Option<usize>

Returns the current search window size setting.

pub fn with_use_search_history(self, mode: SearchHistoryMode) -> Self

Sets the search history mode (SVS-VAMANA indexes).

pub fn set_use_search_history(&mut self, mode: SearchHistoryMode)

Replaces the search history mode in place.

pub fn use_search_history(&self) -> Option<SearchHistoryMode>

Returns the current search history mode.

pub fn with_search_buffer_capacity(self, capacity: usize) -> Self

Sets the search buffer capacity (SVS-VAMANA indexes).

pub fn set_search_buffer_capacity(&mut self, capacity: usize)

Replaces the search buffer capacity in place.

pub fn search_buffer_capacity(&self) -> Option<usize>

Returns the current search buffer capacity.

pub fn with_return_fields<I, S>(self, return_fields: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Replaces the return field list.

pub fn paging(self, offset: usize, num: usize) -> Self

Updates the query limit.

pub fn sort_by(self, field: impl Into<String>, direction: SortDirection) -> Self

Sets the sort field and direction.

pub fn in_order(self, in_order: bool) -> Self

Enables or disables INORDER.

pub fn with_dialect(self, dialect: u32) -> Self

Sets the query dialect.

pub fn vector(&self) -> &Vector<'a>

Returns the encoded query vector.

Trait Implementations

impl<'a> Clone for VectorQuery<'a>

fn clone(&self) -> VectorQuery<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for VectorQuery<'a>

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

Formats the value using the given formatter.

impl PageableQuery for VectorQuery<'_>

fn paged(&self, offset: usize, num: usize) -> Self

Returns a cloned query with an updated LIMIT clause.

impl QueryString for VectorQuery<'_>

fn to_redis_query(&self) -> String

Builds a Redis Search query string.

fn params(&self) -> Vec<QueryParam>

Query parameters used with Redis PARAMS.

fn return_fields(&self) -> Vec<String>

Return fields requested by the query.

fn sort_by(&self) -> Option<SortBy>

Sort order requested by the query.

fn limit(&self) -> Option<QueryLimit>

Limit clause requested by the query.

fn dialect(&self) -> u32

Query dialect.

fn in_order(&self) -> bool

Whether the query should use INORDER.

fn render(&self) -> QueryRender

Builds the full query render, including search options and params.

fn no_content(&self) -> bool

Whether the query should use NOCONTENT.

fn scorer(&self) -> Option<String>

Optional scorer.

fn kind(&self) -> QueryKind

The processed result shape for this query.

fn should_unpack_json(&self) -> bool

Whether JSON search results should be unpacked into top-level fields when no explicit projection is requested.

fn geofilter(&self) -> Option<GeoFilter>

Optional geo-spatial filter for FT.SEARCH GEOFILTER clause.