ai-agents-memory 1.1.1

Memory implementations for AI Agents framework
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
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
//! Conversation context for memory management

use serde::{Deserialize, Serialize};

use super::native::NativeRetentionInspection;
use super::token_budget::TokenAllocation;
use ai_agents_core::{ChatMessage, Role};

fn prefix_at_char_boundary(text: &str, max_chars: usize) -> &str {
    if max_chars == 0 {
        return "";
    }

    match text.char_indices().nth(max_chars) {
        Some((idx, _)) => &text[..idx],
        None => text,
    }
}

// Selects recent history from safe whole-turn boundaries. A protected signed suffix is retained
// even when it exceeds the caller's allocation; the runtime performs the final hard-limit check.
fn recent_suffix_start(messages: &[ChatMessage], token_budget: u32) -> usize {
    let Ok(inspection) = NativeRetentionInspection::inspect(messages) else {
        // The Vec-returning public helpers cannot surface malformed history. Keeping all input is
        // fail-closed with respect to deletion and lets the runtime's checked boundary reject it.
        return 0;
    };
    let mut start = inspection
        .protected_suffix_start()
        .unwrap_or(messages.len());
    let mut used_tokens = messages[start..]
        .iter()
        .map(estimate_message_tokens)
        .fold(0u32, u32::saturating_add);

    while start > 0 {
        let previous = inspection.previous_safe_prefix_len(start);
        if previous == start {
            break;
        }
        let group_tokens = messages[previous..start]
            .iter()
            .map(estimate_message_tokens)
            .fold(0u32, u32::saturating_add);
        if used_tokens.saturating_add(group_tokens) > token_budget {
            break;
        }
        used_tokens = used_tokens.saturating_add(group_tokens);
        start = previous;
    }

    start
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct ConversationContext {
    pub summary: Option<String>,
    pub messages: Vec<ChatMessage>,
    pub total_messages: usize,
    pub summarized_count: usize,
}

impl ConversationContext {
    pub fn new() -> Self {
        Self::default()
    }

    pub fn with_messages(messages: Vec<ChatMessage>) -> Self {
        let total = messages.len();
        Self {
            summary: None,
            messages,
            total_messages: total,
            summarized_count: 0,
        }
    }

    pub fn with_summary(mut self, summary: String, summarized_count: usize) -> Self {
        self.summary = Some(summary);
        self.summarized_count = summarized_count;
        self
    }

    pub fn to_llm_messages(&self) -> Vec<ChatMessage> {
        let mut result = Vec::new();

        if let Some(ref summary) = self.summary {
            result.push(ChatMessage {
                role: Role::System,
                content: format!("[Previous conversation summary]\n{}", summary),
                name: None,
                timestamp: None,
            });
        }

        result.extend(self.messages.clone());
        result
    }

    /// Build LLM messages with per-component token budgets.
    ///
    /// Provider-state-bearing native exchanges are selected as complete signed user-turn groups.
    /// The latest protected group is retained intact even when it exceeds the recent allocation;
    /// callers that enforce a hard request limit must reject that over-budget result explicitly.
    pub fn to_llm_messages_with_allocation(
        &self,
        allocation: &TokenAllocation,
    ) -> Vec<ChatMessage> {
        let mut result = Vec::new();

        // Summary - capped to allocation.summary tokens
        if let Some(ref summary) = self.summary {
            let summary_content = format!("[Previous conversation summary]\n{}", summary);
            let summary_tokens = estimate_tokens(&summary_content);

            let final_content = if summary_tokens > allocation.summary {
                let char_count = summary_content.chars().count() as f64;
                let ratio = char_count / summary_tokens as f64;
                let target_chars = (allocation.summary as f64 * ratio) as usize;
                let truncated = prefix_at_char_boundary(&summary_content, target_chars);
                format!("{}...", truncated)
            } else {
                summary_content
            };

            result.push(ChatMessage {
                role: Role::System,
                content: final_content,
                name: None,
                timestamp: None,
            });
        }

        // Recent messages - capped to allocation.recent_messages tokens
        let recent_start = recent_suffix_start(&self.messages, allocation.recent_messages);
        result.extend(self.messages[recent_start..].iter().cloned());

        // TODO:
        // Facts - reserved for 'Session Management' feature, not injected yet.

        result
    }

    /// Build a budgeted prompt without splitting provider-state-bearing signed user turns.
    ///
    /// A latest protected signed suffix remains intact when it alone exceeds `max_tokens`; the
    /// runtime is responsible for rejecting the resulting hard-limit overflow before transport.
    pub fn to_llm_messages_with_budget(&self, max_tokens: u32) -> Vec<ChatMessage> {
        let mut result = Vec::new();
        let mut used_tokens = 0u32;

        if let Some(ref summary) = self.summary {
            let summary_msg = ChatMessage {
                role: Role::System,
                content: format!("[Previous conversation summary]\n{}", summary),
                name: None,
                timestamp: None,
            };
            let tokens = estimate_message_tokens(&summary_msg);
            if tokens <= max_tokens {
                used_tokens = tokens;
                result.push(summary_msg);
            }
        }

        let message_budget = max_tokens.saturating_sub(used_tokens);
        let recent_start = recent_suffix_start(&self.messages, message_budget);
        result.extend(self.messages[recent_start..].iter().cloned());

        result
    }

    pub fn estimated_tokens(&self) -> u32 {
        let summary_tokens = self
            .summary
            .as_ref()
            .map(|s| estimate_tokens(s))
            .unwrap_or(0);

        let message_tokens: u32 = self.messages.iter().map(estimate_message_tokens).sum();

        summary_tokens + message_tokens
    }

    pub fn is_empty(&self) -> bool {
        self.summary.is_none() && self.messages.is_empty()
    }

    pub fn message_count(&self) -> usize {
        self.messages.len()
    }
}

/// Language-aware token estimation for multi-language support
pub fn estimate_tokens(text: &str) -> u32 {
    if text.is_empty() {
        return 0;
    }

    let ascii_chars = text.chars().filter(|c| c.is_ascii()).count();
    let cjk_chars = text.chars().filter(|c| is_cjk(*c)).count();
    let other_chars = text.chars().count() - ascii_chars - cjk_chars;

    let estimated =
        (ascii_chars as f64 / 4.0) + (cjk_chars as f64 * 1.5) + (other_chars as f64 * 1.0);

    estimated.ceil().max(1.0) as u32
}

fn is_cjk(c: char) -> bool {
    matches!(c,
        '\u{4E00}'..='\u{9FFF}' |   // CJK Unified Ideographs
        '\u{3400}'..='\u{4DBF}' |   // CJK Extension A
        '\u{AC00}'..='\u{D7AF}' |   // Korean Hangul
        '\u{3040}'..='\u{30FF}' |   // Japanese Hiragana/Katakana
        '\u{31F0}'..='\u{31FF}'     // Katakana Extensions
    )
}

pub fn estimate_message_tokens(message: &ChatMessage) -> u32 {
    let role_tokens = 4u32;
    let content_tokens = estimate_tokens(&message.content);
    let name_tokens = message
        .name
        .as_ref()
        .map(|n| estimate_tokens(n))
        .unwrap_or(0);
    role_tokens + content_tokens + name_tokens
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum CompressResult {
    NotNeeded,
    Compressed {
        messages_summarized: usize,
        new_summary_length: usize,
        tokens_saved: u32,
    },
    AlreadyCompressed,
    Failed {
        error: String,
    },
}

#[cfg(test)]
mod tests {
    use super::*;
    use ai_agents_core::{
        NativeCallBinding, NativeProviderState, NativeProviderTarget, ToolCall,
        encode_native_tool_call_markers, encode_native_tool_result_marker,
    };

    fn make_message(role: Role, content: &str) -> ChatMessage {
        ChatMessage {
            role,
            content: content.to_string(),
            name: None,
            timestamp: None,
        }
    }

    fn signed_turn(exchange_id: &str) -> Vec<ChatMessage> {
        let call = ToolCall {
            id: format!("{exchange_id}-call"),
            name: "lookup".to_string(),
            arguments: serde_json::json!({"query":"fixture"}),
        };
        let state = NativeProviderState::new(
            exchange_id,
            "google",
            "generateContent",
            NativeProviderTarget::new("https://example.invalid/v1beta/", "fixture-model").unwrap(),
            serde_json::json!({
                "role":"model",
                "parts":[{
                    "functionCall":{"name":"lookup","args":{"query":"fixture"}},
                    "thoughtSignature":"fixture-signature"
                }]
            }),
            vec![NativeCallBinding::new(&call.id, 0).unwrap()],
        )
        .unwrap();
        vec![
            make_message(Role::User, "signed user request"),
            ChatMessage::assistant(
                encode_native_tool_call_markers(std::slice::from_ref(&call), Some(&state)).unwrap(),
            ),
            ChatMessage::function(
                "lookup",
                encode_native_tool_result_marker(&call, serde_json::json!({"ok":true})).unwrap(),
            ),
            make_message(Role::Assistant, "signed turn final response"),
        ]
    }

    #[test]
    fn test_conversation_context_new() {
        let ctx = ConversationContext::new();
        assert!(ctx.is_empty());
        assert_eq!(ctx.message_count(), 0);
        assert!(ctx.summary.is_none());
    }

    #[test]
    fn test_conversation_context_with_messages() {
        let messages = vec![
            make_message(Role::User, "Hello"),
            make_message(Role::Assistant, "Hi there!"),
        ];
        let ctx = ConversationContext::with_messages(messages);
        assert_eq!(ctx.message_count(), 2);
        assert_eq!(ctx.total_messages, 2);
        assert!(!ctx.is_empty());
    }

    #[test]
    fn test_conversation_context_with_summary() {
        let messages = vec![make_message(Role::User, "Current message")];
        let ctx = ConversationContext::with_messages(messages)
            .with_summary("Previous discussion about weather".to_string(), 5);

        assert!(ctx.summary.is_some());
        assert_eq!(ctx.summarized_count, 5);

        let llm_messages = ctx.to_llm_messages();
        assert_eq!(llm_messages.len(), 2);
        assert!(
            llm_messages[0]
                .content
                .contains("Previous conversation summary")
        );
    }

    #[test]
    fn test_to_llm_messages_without_summary() {
        let messages = vec![
            make_message(Role::User, "Hello"),
            make_message(Role::Assistant, "Hi!"),
        ];
        let ctx = ConversationContext::with_messages(messages);

        let llm_messages = ctx.to_llm_messages();
        assert_eq!(llm_messages.len(), 2);
        assert_eq!(llm_messages[0].role, Role::User);
    }

    #[test]
    fn test_estimated_tokens() {
        let ctx = ConversationContext::with_messages(vec![
            make_message(Role::User, "Hello world"),
            make_message(Role::Assistant, "Hi there"),
        ]);

        let tokens = ctx.estimated_tokens();
        assert!(tokens > 0);
    }

    #[test]
    fn test_to_llm_messages_with_budget() {
        let messages: Vec<ChatMessage> = (0..10)
            .map(|i| make_message(Role::User, &format!("Message number {}", i)))
            .collect();
        let ctx = ConversationContext::with_messages(messages);

        let limited = ctx.to_llm_messages_with_budget(50);
        assert!(limited.len() < 10);
    }

    #[test]
    fn test_to_llm_messages_with_allocation_caps_summary() {
        let long_summary = "x".repeat(10000); // ~2500 tokens
        let messages = vec![make_message(Role::User, "Hello")];
        let ctx = ConversationContext::with_messages(messages).with_summary(long_summary, 50);

        let allocation = TokenAllocation {
            summary: 100,
            recent_messages: 2048,
            facts: 512,
            relationships: 0,
        };

        let result = ctx.to_llm_messages_with_allocation(&allocation);
        // Summary should be truncated
        let summary_msg = &result[0];
        let summary_tokens = estimate_tokens(&summary_msg.content);
        assert!(
            summary_tokens <= 120,
            "Summary should be roughly capped: got {}",
            summary_tokens
        );
        // Recent message should still be present
        assert!(result.len() >= 2);
    }

    #[test]
    fn test_to_llm_messages_with_allocation_caps_recent() {
        let messages: Vec<ChatMessage> = (0..50)
            .map(|i| {
                make_message(
                    Role::User,
                    &format!(
                        "Message number {} with some extra text to increase tokens",
                        i
                    ),
                )
            })
            .collect();
        let ctx = ConversationContext::with_messages(messages);

        let allocation = TokenAllocation {
            summary: 1024,
            recent_messages: 200,
            facts: 512,
            relationships: 0,
        };

        let result = ctx.to_llm_messages_with_allocation(&allocation);
        assert!(
            result.len() < 50,
            "Should have fewer messages due to cap: got {}",
            result.len()
        );
        // Messages should be the most recent
        let last = &result[result.len() - 1];
        assert!(
            last.content.contains("49"),
            "Last message should be the most recent"
        );
    }

    #[test]
    fn test_prefix_at_char_boundary_handles_unicode() {
        let text = "제 이름은 Jay이고 계약서를 확인하고 싶어요";
        let prefix = prefix_at_char_boundary(text, 7);
        assert_eq!(prefix.chars().count(), 7);
        assert!(text.starts_with(prefix));
    }

    #[test]
    fn test_to_llm_messages_with_allocation_no_summary() {
        let messages = vec![
            make_message(Role::User, "Hello"),
            make_message(Role::Assistant, "Hi!"),
        ];
        let ctx = ConversationContext::with_messages(messages);

        let allocation = TokenAllocation {
            summary: 1024,
            recent_messages: 2048,
            facts: 512,
            relationships: 0,
        };

        let result = ctx.to_llm_messages_with_allocation(&allocation);
        assert_eq!(result.len(), 2);
    }

    #[test]
    fn allocation_does_not_split_completed_signed_turn() {
        let mut messages = signed_turn("allocation-past");
        messages.push(make_message(Role::User, "latest"));
        let latest_tokens = estimate_message_tokens(messages.last().unwrap());
        let ctx = ConversationContext::with_messages(messages);
        let allocation = TokenAllocation {
            summary: 0,
            recent_messages: latest_tokens,
            facts: 0,
            relationships: 0,
        };

        let selected = ctx.to_llm_messages_with_allocation(&allocation);

        assert_eq!(selected.len(), 1);
        assert_eq!(selected[0].content, "latest");
    }

    #[test]
    fn allocation_keeps_latest_signed_turn_even_when_group_exceeds_budget() {
        let messages = signed_turn("allocation-active");
        let ctx = ConversationContext::with_messages(messages.clone());
        let allocation = TokenAllocation {
            summary: 0,
            recent_messages: 1,
            facts: 0,
            relationships: 0,
        };

        let selected = ctx.to_llm_messages_with_allocation(&allocation);

        assert_eq!(selected.len(), messages.len());
        assert_eq!(selected[0].content, "signed user request");
        assert!(selected[1].content.contains("fixture-signature"));
    }

    #[test]
    fn budget_keeps_latest_signed_turn_even_when_group_exceeds_budget() {
        let messages = signed_turn("budget-active");
        let ctx = ConversationContext::with_messages(messages.clone());

        let selected = ctx.to_llm_messages_with_budget(1);

        assert_eq!(selected.len(), messages.len());
        assert_eq!(selected[0].content, "signed user request");
        assert!(selected[1].content.contains("fixture-signature"));
    }

    #[test]
    fn test_estimate_tokens_english() {
        assert_eq!(estimate_tokens(""), 0);
        assert_eq!(estimate_tokens("test"), 1);
        assert_eq!(estimate_tokens("hello world"), 3);
    }

    #[test]
    fn test_estimate_tokens_korean() {
        let tokens = estimate_tokens("안녕하세요");
        assert!(
            tokens >= 5,
            "Korean text should have more tokens: {}",
            tokens
        );
    }

    #[test]
    fn test_estimate_tokens_japanese() {
        let tokens = estimate_tokens("こんにちは");
        assert!(
            tokens >= 5,
            "Japanese text should have more tokens: {}",
            tokens
        );
    }

    #[test]
    fn test_estimate_tokens_chinese() {
        let tokens = estimate_tokens("你好世界");
        assert!(
            tokens >= 4,
            "Chinese text should have more tokens: {}",
            tokens
        );
    }

    #[test]
    fn test_estimate_tokens_mixed() {
        let tokens = estimate_tokens("Hello 안녕 World 世界");
        assert!(tokens >= 6, "Mixed text: {}", tokens);
    }

    #[test]
    fn test_compress_result_variants() {
        let not_needed = CompressResult::NotNeeded;
        assert!(matches!(not_needed, CompressResult::NotNeeded));

        let compressed = CompressResult::Compressed {
            messages_summarized: 5,
            new_summary_length: 100,
            tokens_saved: 500,
        };
        if let CompressResult::Compressed {
            messages_summarized,
            ..
        } = compressed
        {
            assert_eq!(messages_summarized, 5);
        }

        let failed = CompressResult::Failed {
            error: "test error".to_string(),
        };
        if let CompressResult::Failed { error } = failed {
            assert_eq!(error, "test error");
        }
    }
}