cupel 1.2.0

Context window management pipeline for LLM applications
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

use crate::model::ContextItem;

/// A value type associating a [`ContextItem`] with its computed relevance score.
///
/// # Examples
///
/// ```
/// use cupel::{ContextItemBuilder, ScoredItem};
///
/// let item = ContextItemBuilder::new("user message", 12).build()?;
/// let scored = ScoredItem { item, score: 0.85 };
///
/// assert_eq!(scored.item.content(), "user message");
/// assert_eq!(scored.score, 0.85);
/// # Ok::<(), cupel::CupelError>(())
/// ```
#[derive(Debug, Clone)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(deny_unknown_fields))]
pub struct ScoredItem {
    /// The context item.
    pub item: ContextItem,
    /// The computed relevance score (conventionally in [0.0, 1.0]).
    pub score: f64,
}