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
//! Provider-agnostic reranking abstractions.
//!
//! Reranking models reorder a list of documents by relevance to a query.
//! The [`RerankModel`] trait defines the interface, and [`RerankResponse`]
//! carries both the scored results and token usage.
use crate::{
completion::Usage,
wasm_compat::{WasmCompatSend, WasmCompatSync},
};
use serde::{Deserialize, Serialize};
crate::provider_response::provider_error_enum!(
RerankError, "reranking" {
/// URL construction or parsing failed while preparing a provider request.
#[error("UrlError: {0}")]
UrlError(#[from] url::ParseError),
}
);
/// Trait for reranking models that score documents by relevance to a query.
pub trait RerankModel: WasmCompatSend + WasmCompatSync {
/// The maximum number of documents that can be reranked in a single request.
const MAX_DOCUMENTS: usize;
/// Provider client type used to construct this rerank model.
type Client;
/// Construct a model handle from a provider client and model identifier.
fn make(client: &Self::Client, model: impl Into<String>) -> Self;
/// Rerank a list of documents against a query.
fn rerank(
&self,
query: &str,
documents: Vec<String>,
) -> impl std::future::Future<Output = Result<RerankResponse, RerankError>> + WasmCompatSend;
}
/// A single reranked document result.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct RerankResult {
/// Index of the document in the original input list.
pub index: usize,
/// The document text, if requested via `return_documents`.
pub document: Option<String>,
/// Relevance score between 0 and 1 (higher is more relevant).
pub relevance_score: f64,
}
/// Response from a reranking request.
#[derive(Debug, Clone)]
pub struct RerankResponse {
/// Reranked results sorted by relevance (highest first).
pub results: Vec<RerankResult>,
/// Model identifier used for this request.
pub model: String,
/// Token usage for this rerank request.
pub usage: Usage,
}