Struct Bm25Params 

pub struct Bm25Params { /* private fields */ }

Validated BM25 hyperparameters for document-side local encoding.

Only documents are affected: query text always embeds with unit term weights, and IDF is applied by the backend from the sparse vector’s modifier: idf. This is a client-side, write-path-only knob — it is not a collection/wire setting, and it does not change server-side qdrant/bm25 inference. Vectors written before a change stay as written; re-ingest to apply new parameters.

Construct via Bm25Params::new (or Bm25Params::resolve for optional overrides); invalid values fail closed with QQL-VALIDATION-CONFIG.

Implementations

impl Bm25Params

pub fn new(k1: f64, b: f64, avg_len: f64) -> Result<Self, QqlError>

Validate and build explicit BM25 parameters.

k1 must be finite and >= 0 (like Qdrant’s validator; 0 gives binary weighting), b finite and within [0, 1], and avg_len finite and > 0. NaN and ±Inf are rejected for all three.

pub fn resolve( k1: Option<f64>, b: Option<f64>, avg_len: Option<f64>, ) -> Result<Self, QqlError>

Resolve optional overrides on top of Bm25Params::default; None keeps the corresponding Qdrant qdrant/bm25 default.

pub fn k1(&self) -> f64

Term-frequency saturation (k1).

pub fn b(&self) -> f64

Document-length normalization factor (b), 0 = none, 1 = full.

pub fn avg_len(&self) -> f64

Expected average document length in tokens (avg_len).

Trait Implementations

impl Clone for Bm25Params

fn clone(&self) -> Bm25Params

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Bm25Params

impl Debug for Bm25Params

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

Formats the value using the given formatter.

impl Default for Bm25Params

fn default() -> Self

Qdrant’s qdrant/bm25 defaults: k1 = 1.2, b = 0.75, avg_len = 256. Unset configuration keeps this exact behavior.

impl PartialEq for Bm25Params

fn eq(&self, other: &Bm25Params) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Bm25Params