Skip to main content

Module score

Module score 

Source
Expand description

Scoring algorithms and query types for document relevance ranking. Scoring algorithms and query types for document relevance ranking.

This module provides BM25 variants, similarity metrics, and the Scorer / Query types used to rank Document results.

Modules§

bm25
BM25F multi-field relevance scoring implementation.
bm25_additional
Additional BM25 variants: Okapi BM25, BM25+, TF-IDF, Jaccard, and QueryRatio scorers.
common
Common scoring traits and utilities shared across scorer implementations.
names
Query scorer selector enum mapping scorer names to implementations.

Structs§

BM25FScorer
BM25F scorer implementation
BM25PlusScorer
BM25+ scorer implementation
JaccardScorer
Jaccard similarity scorer implementation
OkapiBM25Scorer
Okapi BM25 scorer implementation
Query
Search query carrying the term, scoring algorithm, similarity metric, and result size.
QueryRatioScorer
QueryRatio scorer implementation
Scored
Any value associated with a score.
Scorer
Configurable document scorer combining a similarity metric with an optional BM25 variant.
SearchResults
A collection of scored values, sorted in descending order by score.
TFIDFScorer
TFIDF scorer implementation

Enums§

QueryScorer
The type of scorer that the name index should use.
ScoreError
Error type returned when document scoring fails.
Similarity
String similarity algorithm applied to title comparisons.

Functions§

sort_documents
Sorts documents by relevance to query using the scorer specified in the query.