ailoop-context 1.0.0-rc.2

Conversation history management and compaction for ailoop
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

//! Failure surfaces of compaction and snapshot validation.

use thiserror::Error;

/// Failure surface of [`CompactionStrategy::compact`] (and therefore of
/// [`ContextManager::compact_if_needed`]).
///
/// The façade [`Conversation::run`](https://docs.rs/ailoop) /
/// [`Conversation::stream`](https://docs.rs/ailoop) wraps this in
/// [`EngineError::Context`](https://docs.rs/ailoop) when compaction
/// fails mid-run.
///
/// [`CompactionStrategy::compact`]: crate::CompactionStrategy::compact
/// [`ContextManager::compact_if_needed`]: crate::ContextManager::compact_if_needed
#[derive(Debug, Error)]
#[non_exhaustive]
pub enum CompactionError {
    /// History has fewer messages than `preserve_n_last`, so there is
    /// nothing the strategy can drop. Indicates a configuration bug
    /// rather than a transient failure: raise the budget or lower
    /// [`ContextManagerBuilder::preserve_n_last`].
    ///
    /// [`ContextManagerBuilder::preserve_n_last`]: crate::ContextManagerBuilder::preserve_n_last
    #[error("Not enough history to compact")]
    NotEnoughHistory,

    /// A strategy that calls a [`ailoop_core::CompletionModel`]
    /// (notably [`SummarizeStrategy`](crate::SummarizeStrategy))
    /// failed to produce a summary. The original error is rendered
    /// as a string to keep [`CompactionError`] a non-generic,
    /// object-safe enum usable behind `Box<dyn CompactionStrategy>`.
    #[error("Summarization failed: {0}")]
    SummarizationFailed(String),
}

/// Returned by [`ConversationSnapshot::new`] and
/// [`ContextManager::from_messages`] when the supplied parallel
/// vectors are inconsistent. Surfaces at restore time so a malformed
/// snapshot fails loudly instead of corrupting state silently.
///
/// [`ConversationSnapshot::new`]: crate::ConversationSnapshot::new
/// [`ContextManager::from_messages`]: crate::ContextManager::from_messages
#[derive(Debug, Error, PartialEq, Eq)]
#[non_exhaustive]
pub enum FromMessagesError {
    /// `messages` and `pinned` were not the same length. Both fields
    /// carry the observed lengths so callers can report the exact
    /// mismatch.
    #[error(
        "messages and pinned must have the same length (messages: {messages}, pinned: {pinned})"
    )]
    LengthMismatch {
        /// Observed length of the messages vector.
        messages: usize,
        /// Observed length of the pin mask.
        pinned: usize,
    },
}