engramai 0.2.3

Neuroscience-grounded memory system for AI agents. ACT-R activation, Hebbian learning, Ebbinghaus forgetting, cognitive consolidation.
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
576
577
578
579
580
581
582
583
//! Embedding providers for semantic memory retrieval.
//!
//! This module provides vector embedding support using:
//! - Ollama (default): Local LLM server, no API key needed
//! - OpenAI: Cloud-based, requires OPENAI_API_KEY
//!
//! Embeddings enable semantic similarity search alongside ACT-R activation scoring.

use serde::{Deserialize, Serialize};
use std::time::Duration;

/// Configuration for the embedding provider.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct EmbeddingConfig {
    /// Provider name: "ollama" or "openai"
    pub provider: String,
    /// Model name for embeddings
    /// - Ollama: "nomic-embed-text" (768 dims)
    /// - OpenAI: "text-embedding-3-small" (1536 dims) or "text-embedding-ada-002"
    pub model: String,
    /// Ollama host URL (default: "http://localhost:11434")
    /// For OpenAI, this is the API base URL ("https://api.openai.com/v1")
    pub host: String,
    /// Embedding vector dimensions
    /// - nomic-embed-text: 768
    /// - text-embedding-3-small: 1536
    /// - text-embedding-ada-002: 1536
    pub dimensions: usize,
    /// Connection timeout in seconds
    pub timeout_secs: u64,
    /// OpenAI API key (optional, can also use OPENAI_API_KEY env var)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub api_key: Option<String>,
}

impl Default for EmbeddingConfig {
    fn default() -> Self {
        Self {
            provider: "ollama".into(),
            model: "nomic-embed-text".into(),
            host: "http://localhost:11434".into(),
            dimensions: 768,
            timeout_secs: 30,
            api_key: None,
        }
    }
}

impl EmbeddingConfig {
    /// Get the model identifier in protocol format: `{provider}/{model}`.
    ///
    /// This is the canonical model string used in `memory_embeddings` table
    /// per the Engram Embedding Protocol v2.
    pub fn model_id(&self) -> String {
        format!("{}/{}", self.provider, self.model)
    }
    
    /// Create config for OpenAI embeddings.
    ///
    /// Uses text-embedding-3-small by default (1536 dimensions).
    /// API key is read from OPENAI_API_KEY env var if not provided.
    pub fn openai(api_key: Option<String>) -> Self {
        Self {
            provider: "openai".into(),
            model: "text-embedding-3-small".into(),
            host: "https://api.openai.com/v1".into(),
            dimensions: 1536,
            timeout_secs: 30,
            api_key,
        }
    }
    
    /// Create config for OpenAI ada-002 embeddings.
    pub fn openai_ada(api_key: Option<String>) -> Self {
        Self {
            provider: "openai".into(),
            model: "text-embedding-ada-002".into(),
            host: "https://api.openai.com/v1".into(),
            dimensions: 1536,
            timeout_secs: 30,
            api_key,
        }
    }
    
    /// Create config for Ollama with custom model.
    pub fn ollama(model: &str, dimensions: usize) -> Self {
        Self {
            provider: "ollama".into(),
            model: model.into(),
            host: "http://localhost:11434".into(),
            dimensions,
            timeout_secs: 30,
            api_key: None,
        }
    }
}

/// Ollama API request for embeddings.
#[derive(Serialize)]
struct OllamaEmbedRequest<'a> {
    model: &'a str,
    input: &'a str,
}

/// Ollama batch request.
#[derive(Serialize)]
struct OllamaBatchRequest<'a> {
    model: &'a str,
    input: Vec<&'a str>,
}

/// Ollama API response for embeddings.
#[derive(Deserialize)]
struct OllamaEmbedResponse {
    embeddings: Vec<Vec<f32>>,
}

/// OpenAI API request for embeddings.
#[derive(Serialize)]
struct OpenAIEmbedRequest<'a> {
    model: &'a str,
    input: Vec<&'a str>,
}

/// OpenAI API response for embeddings.
#[derive(Deserialize)]
struct OpenAIEmbedResponse {
    data: Vec<OpenAIEmbedding>,
}

#[derive(Deserialize)]
struct OpenAIEmbedding {
    embedding: Vec<f32>,
    index: usize,
}

/// Embedding provider supporting Ollama and OpenAI.
///
/// Uses reqwest::blocking since Memory methods are synchronous.
pub struct EmbeddingProvider {
    config: EmbeddingConfig,
    client: reqwest::blocking::Client,
}

impl EmbeddingProvider {
    /// Create a new embedding provider with the given configuration.
    pub fn new(config: EmbeddingConfig) -> Self {
        let client = reqwest::blocking::Client::builder()
            .timeout(Duration::from_secs(config.timeout_secs))
            .build()
            .expect("Failed to create HTTP client");
        
        Self { config, client }
    }
    
    /// Get the configuration.
    pub fn config(&self) -> &EmbeddingConfig {
        &self.config
    }
    
    /// Generate embedding for text.
    ///
    /// Routes to Ollama or OpenAI based on provider config.
    pub fn embed(&self, text: &str) -> Result<Vec<f32>, EmbeddingError> {
        match self.config.provider.as_str() {
            "openai" => self.embed_openai(&[text]).map(|mut v| v.pop().unwrap_or_default()),
            _ => self.embed_ollama(text),
        }
    }
    
    /// Generate embedding using Ollama.
    fn embed_ollama(&self, text: &str) -> Result<Vec<f32>, EmbeddingError> {
        let url = format!("{}/api/embed", self.config.host);
        
        let request = OllamaEmbedRequest {
            model: &self.config.model,
            input: text,
        };
        
        let response = self.client
            .post(&url)
            .json(&request)
            .send()
            .map_err(|e| {
                if e.is_connect() {
                    EmbeddingError::OllamaNotAvailable(self.config.host.clone())
                } else if e.is_timeout() {
                    EmbeddingError::Timeout
                } else {
                    EmbeddingError::Request(e.to_string())
                }
            })?;
        
        if !response.status().is_success() {
            let status = response.status();
            let body = response.text().unwrap_or_default();
            
            if status.as_u16() == 404 || body.contains("not found") {
                return Err(EmbeddingError::ModelNotFound(self.config.model.clone()));
            }
            
            return Err(EmbeddingError::Request(format!(
                "Ollama returned {}: {}",
                status, body
            )));
        }
        
        let embed_response: OllamaEmbedResponse = response.json()
            .map_err(|e| EmbeddingError::Parse(e.to_string()))?;
        
        embed_response
            .embeddings
            .into_iter()
            .next()
            .ok_or(EmbeddingError::EmptyResponse)
    }
    
    /// Generate embeddings using OpenAI API.
    fn embed_openai(&self, texts: &[&str]) -> Result<Vec<Vec<f32>>, EmbeddingError> {
        // Get API key from config or environment
        let api_key = self.config.api_key.clone()
            .or_else(|| std::env::var("OPENAI_API_KEY").ok())
            .ok_or_else(|| EmbeddingError::Request(
                "OpenAI API key not found. Set OPENAI_API_KEY env var or provide api_key in config.".into()
            ))?;
        
        let url = format!("{}/embeddings", self.config.host);
        
        let request = OpenAIEmbedRequest {
            model: &self.config.model,
            input: texts.to_vec(),
        };
        
        let response = self.client
            .post(&url)
            .header("Authorization", format!("Bearer {}", api_key))
            .header("Content-Type", "application/json")
            .json(&request)
            .send()
            .map_err(|e| {
                if e.is_connect() {
                    EmbeddingError::Request(format!("Cannot connect to OpenAI: {}", e))
                } else if e.is_timeout() {
                    EmbeddingError::Timeout
                } else {
                    EmbeddingError::Request(e.to_string())
                }
            })?;
        
        if !response.status().is_success() {
            let status = response.status();
            let body = response.text().unwrap_or_default();
            
            if status.as_u16() == 401 {
                return Err(EmbeddingError::Request("Invalid OpenAI API key".into()));
            }
            if status.as_u16() == 404 || body.contains("model_not_found") {
                return Err(EmbeddingError::ModelNotFound(self.config.model.clone()));
            }
            
            return Err(EmbeddingError::Request(format!(
                "OpenAI returned {}: {}",
                status, body
            )));
        }
        
        let embed_response: OpenAIEmbedResponse = response.json()
            .map_err(|e| EmbeddingError::Parse(e.to_string()))?;
        
        if embed_response.data.is_empty() {
            return Err(EmbeddingError::EmptyResponse);
        }
        
        // Sort by index to maintain order
        let mut data = embed_response.data;
        data.sort_by_key(|d| d.index);
        
        Ok(data.into_iter().map(|d| d.embedding).collect())
    }
    
    /// Batch embed multiple texts.
    ///
    /// More efficient than calling embed() multiple times.
    pub fn embed_batch(&self, texts: &[&str]) -> Result<Vec<Vec<f32>>, EmbeddingError> {
        match self.config.provider.as_str() {
            "openai" => self.embed_openai(texts),
            _ => self.embed_batch_ollama(texts),
        }
    }
    
    /// Batch embed using Ollama.
    fn embed_batch_ollama(&self, texts: &[&str]) -> Result<Vec<Vec<f32>>, EmbeddingError> {
        let url = format!("{}/api/embed", self.config.host);
        
        let request = OllamaBatchRequest {
            model: &self.config.model,
            input: texts.to_vec(),
        };
        
        let response = self.client
            .post(&url)
            .json(&request)
            .send()
            .map_err(|e| {
                if e.is_connect() {
                    EmbeddingError::OllamaNotAvailable(self.config.host.clone())
                } else if e.is_timeout() {
                    EmbeddingError::Timeout
                } else {
                    EmbeddingError::Request(e.to_string())
                }
            })?;
        
        if !response.status().is_success() {
            let status = response.status();
            let body = response.text().unwrap_or_default();
            
            if status.as_u16() == 404 || body.contains("not found") {
                return Err(EmbeddingError::ModelNotFound(self.config.model.clone()));
            }
            
            return Err(EmbeddingError::Request(format!(
                "Ollama returned {}: {}",
                status, body
            )));
        }
        
        let embed_response: OllamaEmbedResponse = response.json()
            .map_err(|e| EmbeddingError::Parse(e.to_string()))?;
        
        Ok(embed_response.embeddings)
    }
    
    /// Check if the embedding provider is available.
    ///
    /// For Ollama: checks if the server is running.
    /// For OpenAI: checks if the API key is available and valid.
    pub fn is_available(&self) -> bool {
        match self.config.provider.as_str() {
            "openai" => self.is_openai_available(),
            _ => self.is_ollama_available(),
        }
    }
    
    /// Check if Ollama is running.
    fn is_ollama_available(&self) -> bool {
        let url = format!("{}/api/tags", self.config.host);
        
        match self.client.get(&url).send() {
            Ok(response) => response.status().is_success(),
            Err(_) => false,
        }
    }
    
    /// Check if OpenAI API is available.
    fn is_openai_available(&self) -> bool {
        // Check if API key exists
        let api_key = self.config.api_key.clone()
            .or_else(|| std::env::var("OPENAI_API_KEY").ok());
        
        if api_key.is_none() {
            return false;
        }
        
        // Optionally do a lightweight API check (list models)
        // For now, just check if key exists
        true
    }
    
    /// Check if the configured model is available.
    pub fn is_model_available(&self) -> Result<bool, EmbeddingError> {
        let url = format!("{}/api/show", self.config.host);
        
        #[derive(Serialize)]
        struct ShowRequest<'a> {
            name: &'a str,
        }
        
        let response = self.client
            .post(&url)
            .json(&ShowRequest { name: &self.config.model })
            .send()
            .map_err(|e| {
                if e.is_connect() {
                    EmbeddingError::OllamaNotAvailable(self.config.host.clone())
                } else {
                    EmbeddingError::Request(e.to_string())
                }
            })?;
        
        Ok(response.status().is_success())
    }
    
    /// Get embedding dimensions from Ollama model info.
    pub fn get_dimensions(&self) -> Result<usize, EmbeddingError> {
        let url = format!("{}/api/show", self.config.host);
        
        #[derive(Serialize)]
        struct ShowRequest<'a> {
            name: &'a str,
        }
        
        #[derive(Deserialize)]
        struct ShowResponse {
            details: Option<ModelDetails>,
        }
        
        #[derive(Deserialize)]
        struct ModelDetails {
            embedding_length: Option<usize>,
        }
        
        let response = self.client
            .post(&url)
            .json(&ShowRequest { name: &self.config.model })
            .send()
            .map_err(|e| {
                if e.is_connect() {
                    EmbeddingError::OllamaNotAvailable(self.config.host.clone())
                } else {
                    EmbeddingError::Request(e.to_string())
                }
            })?;
        
        if !response.status().is_success() {
            return Err(EmbeddingError::ModelNotFound(self.config.model.clone()));
        }
        
        let show_response: ShowResponse = response.json()
            .map_err(|e| EmbeddingError::Parse(e.to_string()))?;
        
        Ok(show_response
            .details
            .and_then(|d| d.embedding_length)
            .unwrap_or(self.config.dimensions))
    }
    
    /// Compute cosine similarity between two vectors.
    ///
    /// Returns a value between -1.0 and 1.0, where 1.0 means identical.
    pub fn cosine_similarity(a: &[f32], b: &[f32]) -> f32 {
        if a.len() != b.len() || a.is_empty() {
            return 0.0;
        }
        
        let dot: f32 = a.iter().zip(b.iter()).map(|(x, y)| x * y).sum();
        let norm_a: f32 = a.iter().map(|x| x * x).sum::<f32>().sqrt();
        let norm_b: f32 = b.iter().map(|x| x * x).sum::<f32>().sqrt();
        
        if norm_a == 0.0 || norm_b == 0.0 {
            return 0.0;
        }
        
        dot / (norm_a * norm_b)
    }
}

/// Errors that can occur during embedding operations.
#[derive(Debug, thiserror::Error)]
pub enum EmbeddingError {
    #[error("Ollama not available at {0}")]
    OllamaNotAvailable(String),
    
    #[error("Model '{0}' not found in Ollama")]
    ModelNotFound(String),
    
    #[error("Request failed: {0}")]
    Request(String),
    
    #[error("Failed to parse response: {0}")]
    Parse(String),
    
    #[error("Empty embedding response")]
    EmptyResponse,
    
    #[error("Request timed out")]
    Timeout,
    
    #[error("Storage error: {0}")]
    Storage(String),
}

impl From<rusqlite::Error> for EmbeddingError {
    fn from(e: rusqlite::Error) -> Self {
        EmbeddingError::Storage(e.to_string())
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    
    #[test]
    fn test_cosine_similarity_identical() {
        let a = vec![1.0, 2.0, 3.0];
        let b = vec![1.0, 2.0, 3.0];
        let sim = EmbeddingProvider::cosine_similarity(&a, &b);
        assert!((sim - 1.0).abs() < 1e-6);
    }
    
    #[test]
    fn test_cosine_similarity_orthogonal() {
        let a = vec![1.0, 0.0, 0.0];
        let b = vec![0.0, 1.0, 0.0];
        let sim = EmbeddingProvider::cosine_similarity(&a, &b);
        assert!(sim.abs() < 1e-6);
    }
    
    #[test]
    fn test_cosine_similarity_opposite() {
        let a = vec![1.0, 2.0, 3.0];
        let b = vec![-1.0, -2.0, -3.0];
        let sim = EmbeddingProvider::cosine_similarity(&a, &b);
        assert!((sim + 1.0).abs() < 1e-6);
    }
    
    #[test]
    fn test_cosine_similarity_empty() {
        let a: Vec<f32> = vec![];
        let b: Vec<f32> = vec![];
        let sim = EmbeddingProvider::cosine_similarity(&a, &b);
        assert_eq!(sim, 0.0);
    }
    
    #[test]
    fn test_cosine_similarity_different_lengths() {
        let a = vec![1.0, 2.0];
        let b = vec![1.0, 2.0, 3.0];
        let sim = EmbeddingProvider::cosine_similarity(&a, &b);
        assert_eq!(sim, 0.0);
    }
    
    #[test]
    fn test_config_default() {
        let config = EmbeddingConfig::default();
        assert_eq!(config.provider, "ollama");
        assert_eq!(config.model, "nomic-embed-text");
        assert_eq!(config.host, "http://localhost:11434");
        assert_eq!(config.dimensions, 768);
    }
    
    #[test]
    #[ignore] // Requires Ollama running
    fn test_embed_real() {
        let provider = EmbeddingProvider::new(EmbeddingConfig::default());
        
        if !provider.is_available() {
            println!("Ollama not available, skipping test");
            return;
        }
        
        let result = provider.embed("Hello, world!");
        assert!(result.is_ok());
        
        let embedding = result.unwrap();
        assert!(!embedding.is_empty());
        println!("Embedding dimensions: {}", embedding.len());
    }
    
    #[test]
    #[ignore] // Requires Ollama running
    fn test_semantic_similarity() {
        let provider = EmbeddingProvider::new(EmbeddingConfig::default());
        
        if !provider.is_available() {
            println!("Ollama not available, skipping test");
            return;
        }
        
        let dog = provider.embed("A dog is playing in the park").unwrap();
        let puppy = provider.embed("A puppy is running in the garden").unwrap();
        let car = provider.embed("The car is parked in the garage").unwrap();
        
        let sim_dog_puppy = EmbeddingProvider::cosine_similarity(&dog, &puppy);
        let sim_dog_car = EmbeddingProvider::cosine_similarity(&dog, &car);
        
        println!("dog-puppy similarity: {:.4}", sim_dog_puppy);
        println!("dog-car similarity: {:.4}", sim_dog_car);
        
        // Dog and puppy should be more similar than dog and car
        assert!(sim_dog_puppy > sim_dog_car);
    }
}