Struct HybridQuery 

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

Native Redis hybrid query dispatched via FT.HYBRID.

This query combines text search and vector similarity search with configurable fusion methods. It requires Redis 8.4.0+ and produces FT.HYBRID commands (not FT.SEARCH).

Example

use redis_vl::query::{HybridQuery, HybridCombinationMethod, Vector};

let query = HybridQuery::new(
    "a medical professional",
    "description",
    Vector::new(vec![0.1, 0.1, 0.5]),
    "user_embedding",
)
.with_num_results(10)
.with_combination_method(HybridCombinationMethod::Rrf)
.with_yield_combined_score_as("hybrid_score")
.with_return_fields(["user", "age", "job"]);

Implementations

impl<'a> HybridQuery<'a>

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

Creates a hybrid query with the given text, text field, vector, and vector field.

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", "TFIDF.DOCNORM").

pub fn with_yield_text_score_as(self, alias: impl Into<String>) -> Self

Sets the alias for the text search score in results.

pub fn with_knn(self, ef_runtime: Option<usize>) -> Self

Sets the vector search method to KNN with optional EF runtime.

pub fn with_range(self, radius: f32, epsilon: Option<f32>) -> Self

Sets the vector search method to RANGE.

pub fn with_yield_vsim_score_as(self, alias: impl Into<String>) -> Self

Sets the alias for the vector similarity score in results.

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

Attaches a filter expression.

pub fn with_combination_method(self, method: HybridCombinationMethod) -> Self

Selects the hybrid combination method.

pub fn with_rrf(self, window: Option<usize>, constant: Option<usize>) -> Self

Sets RRF parameters.

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

Sets LINEAR combination with an alpha weight for the text score.

pub fn with_yield_combined_score_as(self, alias: impl Into<String>) -> Self

Sets the alias for the combined score in results.

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 with_vector_param_name(self, name: impl Into<String>) -> Self

Sets the parameter name used for the vector blob.

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

Returns the encoded query vector.

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

Builds an FT.HYBRID command for this query.

The command targets the given index_name and encodes all hybrid query clauses (SEARCH, VSIM, COMBINE, LOAD, LIMIT).

The wire format follows the redis-py HybridQuery / HybridSearchQuery / HybridVsimQuery / CombineResultsMethod protocol:

FT.HYBRID index
  SEARCH query_string [SCORER s] [YIELD_SCORE_AS a]
  VSIM @vec_field $param [method count kv…] [FILTER f] [YIELD_SCORE_AS a]
  [COMBINE method count kv…]
  [LOAD count @field…]
  [LIMIT offset num]
  PARAMS count key value…

Trait Implementations

impl<'a> Clone for HybridQuery<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for HybridQuery<'a>

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

Formats the value using the given formatter.