snowykami/meilisearch
1
0
Fork 0
mirror of https://github.com/meilisearch/meilisearch.git synced 2025-10-10 13:46:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add a function documentation

Browse Source
This commit is contained in:
ManyTheFish
2025-10-08 17:19:40 +02:00
parent d2071dde1f
commit ce832da16c
1 changed files with 6 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
crates/milli/src/score_details.rs
View File

@@ -66,6 +66,12 @@ impl ScoreDetails {
} }
} }
/// Calculate the global score of the details.
///
/// It is computed from the ranks of the ranking rules, excluding the sort/geo sort rules.
/// If the details contain a semantic score (ScoreDetails::Vector), it is used instead of the ranking score.
///
/// note: this function expects a maximum of one semantic score, otherwise only the last one will be used.
pub fn global_score<'a>(details: impl Iterator<Item = &'a Self> + 'a) -> f64 { pub fn global_score<'a>(details: impl Iterator<Item = &'a Self> + 'a) -> f64 {
// Filter out only the ranking scores (Rank values) and exclude sort/geo sort // Filter out only the ranking scores (Rank values) and exclude sort/geo sort
let mut semantic_score = None; let mut semantic_score = None;