Struct SearchRequestBuilder 

pub struct SearchRequestBuilder { /* private fields */ }

Fluent builder for constructing a SearchRequest.

Supports three construction patterns:

1. DSL string (via query_dsl): Pass a unified query DSL string. The engine parses it at search time.
2. Single mode (via lexical_query or vector_query): Set one search mode.
3. Hybrid (via both lexical_query and vector_query): Set both for hybrid search.

If query_dsl is called, the builder produces a SearchQuery::Dsl variant. Otherwise, it determines the variant from which query methods were called.

Implementations

impl SearchRequestBuilder

pub fn new() -> Self

Create a new builder with default settings.

pub fn query_dsl(self, dsl: impl Into<String>) -> Self

Set a unified query DSL string.

When set, the built request uses SearchQuery::Dsl and any lexical/vector queries set via other methods are ignored.

pub fn lexical_query(self, query: LexicalSearchQuery) -> Self

Set the lexical search query.

If vector_query is also set, the result is SearchQuery::Hybrid. Otherwise SearchQuery::Lexical.

pub fn vector_query(self, query: VectorSearchQuery) -> Self

Set the vector search query.

If lexical_query is also set, the result is SearchQuery::Hybrid. Otherwise SearchQuery::Vector.

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

Set the maximum number of results to return.

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

Set the number of results to skip (for pagination).

pub fn fusion_algorithm(self, fusion: FusionAlgorithm) -> Self

Set the fusion algorithm for hybrid search.

For FusionAlgorithm::WeightedSum, the weights are clamped to 0.0..=1.0 to prevent NaN/Inf propagation.

pub fn filter_query(self, query: Box<dyn Query>) -> Self

Set a filter query to restrict the search space.

The filter applies to both lexical and vector searches.

pub fn add_field_boost(self, field: impl Into<String>, boost: f32) -> Self

Add a field-level boost for lexical search.

pub fn lexical_min_score(self, min_score: f32) -> Self

Set the minimum score threshold for lexical search.

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

Set the timeout for lexical search in milliseconds.

pub fn lexical_parallel(self, parallel: bool) -> Self

Enable or disable parallel lexical search.

pub fn sort_by(self, sort_by: SortField) -> Self

Set the sort order for lexical search results.

pub fn vector_score_mode(self, score_mode: VectorScoreMode) -> Self

Set the score combination mode for vector search.

pub fn vector_min_score(self, min_score: f32) -> Self

Set the minimum score threshold for vector search.

pub fn build(self) -> SearchRequest

Consume the builder and return the constructed SearchRequest.

Trait Implementations

impl Default for SearchRequestBuilder

fn default() -> Self

Returns the “default value” for a type.