Struct AggregateHybridQuery 

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

Aggregate-based hybrid query that combines text and vector search via FT.AGGREGATE.

Mirrors the Python AggregateHybridQuery which scores documents as:

hybrid_score = alpha * vector_similarity + (1 - alpha) * text_score

where vector_similarity = (2 - vector_distance) / 2 and text_score = @__score (the scorer output).

Implementations

impl<'a> AggregateHybridQuery<'a>

pub fn new( text: impl Into<String>, text_field_name: impl Into<String>, vector: Vector<'a>, vector_field_name: impl Into<String>, ) -> Result<Self, String>

Creates an aggregate hybrid query.

Errors

Returns Err if text is empty or becomes empty after stopword removal.

pub fn with_alpha(self, alpha: f32) -> Self

Sets the weight of the vector similarity in the hybrid score.

pub fn with_num_results(self, num_results: usize) -> Self

Sets the number of results to return.

pub fn with_text_scorer(self, scorer: impl Into<String>) -> Self

Sets the text scorer algorithm (e.g. "BM25STD", "TFIDF").

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

Attaches a filter expression.

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 with_stopwords(self, stopwords: HashSet<String>) -> Self

Sets stopwords to filter from the query text.

pub fn with_text_weights(self, weights: HashMap<String, f32>) -> Self

Sets word weights for the text search.

pub fn set_text_weights(&mut self, weights: HashMap<String, f32>)

Updates text weights after construction (mirrors Python set_text_weights).

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

Sets the Redis dialect version.

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

Returns the encoded query vector.

pub fn alpha(&self) -> f32

Returns the configured alpha value.

pub fn text(&self) -> &str

Returns the query text.

pub fn build_aggregate_cmd(&self, index_name: &str) -> Cmd

Builds the complete FT.AGGREGATE command for this query.

Matches the Python AggregateRequest.build_args() ordering: query_string → SCORER → ADDSCORES → LOAD → DIALECT → aggregate plan (APPLY/SORTBY) → PARAMS.

Trait Implementations

impl<'a> Clone for AggregateHybridQuery<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for AggregateHybridQuery<'a>

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

Formats the value using the given formatter.