xz-rerank 0.1.1

检索结果重排序 — 本地多信号融合 + 远程 Rerank API 适配
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
use async_trait::async_trait;
use std::collections::HashMap;
use std::time::Instant;

use crate::error::RerankError;
use crate::signals::{
    ContentQualitySignal, KeywordOverlapSignal, MetadataMatchSignal, RecencySignal,
    VectorSimilaritySignal,
};
use crate::traits::{Reranker, RerankerBackendType, RerankerInfo, RerankerPricing, SignalPlugin};
use crate::types::{
    ChannelRecencyRule, RecencyMode, RerankCandidate, RerankConfig, RerankHit, RerankResult,
    RerankStats, ScoreBreakdown, SignalScore, SignalWeights,
};

/// 本地多信号融合重排序器
pub struct LocalSignalReranker {
    weights: SignalWeights,
    signals: Vec<Box<dyn SignalPlugin>>,
    default_recency_mode: RecencyMode,
    channel_recency: Vec<ChannelRecencyRule>,
    info: RerankerInfo,
}

impl std::fmt::Debug for LocalSignalReranker {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("LocalSignalReranker")
            .field("weights", &self.weights)
            .field(
                "signal_names",
                &self.signals.iter().map(|s| s.name().to_string()).collect::<Vec<_>>(),
            )
            .field("default_recency_mode", &self.default_recency_mode)
            .finish()
    }
}

impl LocalSignalReranker {
    /// 创建新的本地重排序器
    pub fn new(weights: SignalWeights) -> Self {
        Self {
            weights,
            signals: Vec::new(),
            default_recency_mode: RecencyMode::ExponentialDecay { decay_rate: 0.01 },
            channel_recency: Vec::new(),
            info: RerankerInfo {
                name: "local-signal".into(),
                display_name: "Local Signal Reranker".into(),
                backend_type: RerankerBackendType::Local,
                supports_batch: true,
                max_candidates: None,
                pricing: Some(RerankerPricing { cost_per_search: 0.0 }),
            },
        }
    }

    /// 添加自定义信号
    pub fn with_signal(mut self, signal: Box<dyn SignalPlugin>) -> Self {
        self.signals.push(signal);
        self
    }

    /// 按通道配置近因性衰减
    pub fn with_channel_recency(mut self, rules: Vec<ChannelRecencyRule>) -> Self {
        self.channel_recency = rules;
        self
    }

    /// 设置默认近因性模式
    pub fn with_recency_mode(mut self, mode: RecencyMode) -> Self {
        self.default_recency_mode = mode;
        self
    }

    fn get_recency_mode_for(&self, channel: Option<&String>) -> RecencyMode {
        if let Some(ch) = channel {
            for rule in &self.channel_recency {
                if rule.channel == *ch {
                    return rule.mode.clone();
                }
            }
        }
        self.default_recency_mode.clone()
    }

    /// 并行计算所有信号的得分。
    ///
    /// 如果 `query_embedding_override` 为 `Some`,则在遇到 `vector_similarity`
    /// 信号时使用包含该查询向量的临时信号替代(避免修改 `&self` 下的信号列表)。
    async fn compute_scores(
        &self,
        query: &str,
        candidates: &[RerankCandidate],
        query_embedding_override: Option<&Vec<f32>>,
    ) -> Result<(Vec<Vec<f32>>, HashMap<String, u64>), RerankError> {
        use futures::future::join_all;

        let futures: Vec<_> = self
            .signals
            .iter()
            .map(|signal| {
                let signal_name = signal.name().to_string();
                let q = query.to_string();
                let c = candidates.to_vec();
                let qe: Option<Vec<f32>> = query_embedding_override.cloned();
                let is_vs = signal_name == "vector_similarity";
                async move {
                    let start = Instant::now();
                    let result = if is_vs {
                        if let Some(ref emb) = qe {
                            let emb: Vec<f32> = emb.clone();
                            let vs = VectorSimilaritySignal::with_query_embedding(emb);
                            vs.score_batch(&q, &c).await
                        } else {
                            signal.score_batch(&q, &c).await
                        }
                    } else {
                        signal.score_batch(&q, &c).await
                    };
                    let elapsed = start.elapsed().as_micros() as u64;
                    (signal_name, result, elapsed)
                }
            })
            .collect();

        let results = join_all(futures).await;
        let mut signal_scores = Vec::with_capacity(results.len());
        let mut timings = HashMap::new();
        for (name, result, elapsed) in results {
            signal_scores.push(result?);
            timings.insert(name, elapsed);
        }

        Ok((signal_scores, timings))
    }

    fn weighted_sum(&self, signal_scores: &[Vec<f32>], weights: &SignalWeights) -> Vec<f32> {
        let n = signal_scores.first().map(|s| s.len()).unwrap_or(0);
        let mut final_scores = vec![0.0f32; n];

        for (signal_idx, signal_score_vec) in signal_scores.iter().enumerate() {
            let weight_key = self.signals.get(signal_idx).map(|s| s.weight_key()).unwrap_or("");
            let w = weights.get_weight_by_name(weight_key);
            for (i, &s) in signal_score_vec.iter().enumerate() {
                final_scores[i] += s * w;
            }
        }

        final_scores
    }
}

impl Default for LocalSignalReranker {
    /// 返回默认的本地信号重排序器
    ///
    /// 使用默认权重 [`SignalWeights::default`] 并注册所有内置信号
    ///(关键词重叠、向量相似度、元数据匹配、内容质量、时间近因性)。
    fn default() -> Self {
        let weights = SignalWeights::default();
        Self {
            weights: weights.clone(),
            signals: vec![
                Box::new(KeywordOverlapSignal),
                Box::new(VectorSimilaritySignal::new()),
                Box::new(MetadataMatchSignal::default()),
                Box::new(ContentQualitySignal),
                Box::new(RecencySignal::new(RecencyMode::ExponentialDecay { decay_rate: 0.01 })),
            ],
            default_recency_mode: RecencyMode::ExponentialDecay { decay_rate: 0.01 },
            channel_recency: Vec::new(),
            info: RerankerInfo {
                name: "local-signal".into(),
                display_name: "Local Signal Reranker".into(),
                backend_type: RerankerBackendType::Local,
                supports_batch: true,
                max_candidates: None,
                pricing: Some(RerankerPricing { cost_per_search: 0.0 }),
            },
        }
    }
}

#[async_trait]
impl Reranker for LocalSignalReranker {
    async fn rerank(
        &self,
        query: &str,
        candidates: Vec<RerankCandidate>,
        config: &RerankConfig,
    ) -> Result<RerankResult, RerankError> {
        let start = Instant::now();

        if candidates.is_empty() {
            return Err(RerankError::EmptyCandidates);
        }

        let total_candidates = candidates.len();

        // 1. 并行计算所有信号(若 config 提供了 query_embedding,则注入到 VectorSimilaritySignal)
        let (mut signal_scores, mut signal_timings) =
            self.compute_scores(query, &candidates, config.query_embedding.as_ref()).await?;

        // 2. 如果 config 指定了 recency_mode,用请求级 RecencySignal 覆盖;
        //    否则按通道查找 recency mode(get_recency_mode_for)
        if let Some(recency_idx) = self.signals.iter().position(|s| s.name() == "recency") {
            if let Some(ref mode) = config.recency_mode {
                let recency_signal = RecencySignal::new(mode.clone());
                let recency_start = Instant::now();
                signal_scores[recency_idx] = recency_signal.score_batch(query, &candidates).await?;
                signal_timings
                    .insert("recency".to_string(), recency_start.elapsed().as_micros() as u64);
            } else {
                let now_ms = std::time::SystemTime::now()
                    .duration_since(std::time::UNIX_EPOCH)
                    .unwrap_or_default()
                    .as_millis() as u64;

                let recency_start = Instant::now();
                let mut recency_scores = Vec::with_capacity(candidates.len());
                for candidate in &candidates {
                    let mode = self.get_recency_mode_for(candidate.channel.as_ref());
                    let signal = RecencySignal::new(mode).with_now(now_ms);
                    recency_scores.push(signal.score(query, candidate).await?);
                }
                signal_scores[recency_idx] = recency_scores;
                signal_timings
                    .insert("recency".to_string(), recency_start.elapsed().as_micros() as u64);
            }
        }

        // 3. 加权求和(按信号名称查找权重)
        let final_scores = self.weighted_sum(&signal_scores, &self.weights);

        // 4. 组合并排序
        let mut scored: Vec<(usize, f32)> =
            final_scores.iter().enumerate().map(|(i, &s)| (i, s)).collect();

        scored.sort_by(|a, b| b.1.total_cmp(&a.1));

        // 5. 应用 min_score 过滤和 top_k 截断
        let min_score = config.min_score.unwrap_or(0.0);
        let mut filtered_out = 0usize;
        let mut hits = Vec::new();

        for (idx, score) in scored {
            if score < min_score {
                filtered_out += 1;
                continue;
            }
            if hits.len() >= config.top_k {
                continue;
            }

            let candidate = &candidates[idx];

            let score_breakdown = if config.include_score_breakdown {
                let signals: Vec<SignalScore> = signal_scores
                    .iter()
                    .enumerate()
                    .map(|(si, scores)| {
                        let raw_score = scores[idx];
                        let weight = self
                            .signals
                            .get(si)
                            .map(|s| self.weights.get_weight_by_name(s.weight_key()))
                            .unwrap_or(0.0);
                        SignalScore {
                            name: self.get_signal_name(si),
                            raw_score,
                            weight,
                            contribution: raw_score * weight,
                        }
                    })
                    .collect();

                Some(ScoreBreakdown { signals, final_score: score })
            } else {
                None
            };

            hits.push(RerankHit {
                candidate_id: candidate.id.clone(),
                score,
                score_breakdown,
                candidate: candidate.clone(),
            });
        }

        // 计算统计信息
        let final_scores_vec: Vec<f32> = hits.iter().map(|h| h.score).collect();
        let n = final_scores_vec.len();
        let max_score = final_scores_vec.first().copied().unwrap_or(0.0);
        let min_score_final = final_scores_vec.last().copied().unwrap_or(0.0);
        let avg_score = if n > 0 { final_scores_vec.iter().sum::<f32>() / n as f32 } else { 0.0 };
        let mut sorted = final_scores_vec.clone();
        sorted.sort_by(|a, b| a.total_cmp(b));
        let median_score = if n > 0 { sorted[n / 2] } else { 0.0 };

        Ok(RerankResult {
            hits,
            stats: RerankStats {
                total_candidates,
                filtered_out,
                max_score,
                min_score: min_score_final,
                avg_score,
                median_score,
                signal_timings,
            },
            reranker: self.info.name.clone(),
            latency_ms: start.elapsed().as_millis() as u64,
        })
    }

    fn reranker_info(&self) -> &RerankerInfo {
        &self.info
    }
}

impl LocalSignalReranker {
    fn get_signal_name(&self, idx: usize) -> String {
        self.signals
            .get(idx)
            .map(|s| s.name().to_string())
            .unwrap_or_else(|| format!("signal_{idx}"))
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::collections::HashMap;

    #[test]
    fn test_sort_with_nan_scores_descending() {
        let mut scored: Vec<(usize, f32)> =
            vec![(0, f32::NAN), (1, 0.5), (2, f32::NAN), (3, -1.0), (4, f32::NAN)];

        scored.sort_by(|a, b| b.1.total_cmp(&a.1));

        assert_eq!(scored.len(), 5);
        assert!(scored[0].1.is_nan());
    }

    #[test]
    fn test_sort_with_nan_scores_ascending() {
        let mut sorted: Vec<f32> = vec![f32::NAN, 0.5, f32::NAN, -1.0, f32::NAN];

        sorted.sort_by(|a, b| a.total_cmp(b));

        assert_eq!(sorted.len(), 5);
    }

    #[tokio::test]
    async fn test_recency_no_decay_override_equal_scores() {
        let weights = SignalWeights {
            keyword_overlap: 0.0,
            vector_similarity: 0.0,
            metadata_match: 0.0,
            content_quality: 0.0,
            recency: 1.0,
            custom_weights: std::collections::HashMap::new(),
        };

        let reranker = LocalSignalReranker::new(weights).with_signal(Box::new(RecencySignal::new(
            RecencyMode::ExponentialDecay { decay_rate: 0.01 },
        )));

        let now_ms = std::time::SystemTime::now()
            .duration_since(std::time::UNIX_EPOCH)
            .ok()
            .map(|d| d.as_millis() as u64)
            .unwrap_or(0);

        let recent = RerankCandidate {
            id: "recent".into(),
            content: "doc".into(),
            metadata: HashMap::new(),
            retrieval_score: None,
            channel: None,
            created_at: Some(now_ms - 60_000), // 1 minute ago
            embedding: None,
        };

        let old = RerankCandidate {
            id: "old".into(),
            content: "doc".into(),
            metadata: HashMap::new(),
            retrieval_score: None,
            channel: None,
            created_at: Some(now_ms - 86_400_000), // 1 day ago
            embedding: None,
        };

        let config = RerankConfig {
            top_k: 10,
            min_score: None,
            include_score_breakdown: false,
            recency_mode: Some(RecencyMode::NoDecay),
            query_embedding: None,
        };

        let result = reranker.rerank("test", vec![recent, old], &config).await;

        let result = match result {
            Ok(r) => r,
            Err(e) => panic!("rerank failed: {e}"),
        };

        assert_eq!(result.hits.len(), 2, "should return both candidates");
        let scores: Vec<f32> = result.hits.iter().map(|h| h.score).collect();
        let diff = (scores[0] - scores[1]).abs();
        assert!(
            diff < 1e-6,
            "with NoDecay override, recent and old docs must have equal scores; got diff={diff}, scores={scores:?}"
        );
    }
}