remem-ai 0.6.36

Local-first coding agent memory for Claude Code and OpenAI Codex
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
use anyhow::{Context, Result};
use rusqlite::{params, Connection, OptionalExtension, Statement};

use super::embedding::TextEmbedding;
pub use super::vector_candidates::VECTOR_SEARCH_CANDIDATE_LIMIT;

mod backfill;
mod coverage;
mod reindex;

pub use super::embedding::{
    LOCAL_EMBEDDING_DIMENSIONS as EMBEDDING_DIMENSIONS,
    LOCAL_EMBEDDING_MODEL as DEFAULT_EMBEDDING_MODEL,
};
pub use backfill::{
    backfill_missing_memory_embeddings, pending_memory_embedding_count,
    pending_memory_embedding_reindex_count, pending_memory_embedding_reindex_count_for_target,
    reindex_memory_embeddings, reindex_memory_embeddings_with_report, EmbeddingReindexReport,
};
pub(crate) use backfill::{
    reindex_memory_embeddings_with_session_report, EmbeddingBackfillSession,
};
pub use coverage::{
    active_embedding_coverage, active_embedding_coverage_for_status,
    active_embedding_coverage_for_target, prune_inactive_memory_embeddings,
    ActiveEmbeddingCoverage, InactiveEmbeddingPruneReport,
};

const EMBEDDING_REINDEX_WRITE_BATCH_SIZE: usize = 512;
const UPSERT_EMBEDDING_SQL: &str = "INSERT INTO memory_embeddings
         (memory_id, embedding, dimensions, model, content_hash, updated_at_epoch)
         VALUES (?1, ?2, ?3, ?4, ?5, ?6)
         ON CONFLICT(memory_id, model, dimensions) DO UPDATE SET
             embedding = excluded.embedding,
             content_hash = excluded.content_hash,
             updated_at_epoch = excluded.updated_at_epoch";

#[derive(Debug, Clone, PartialEq)]
pub struct VectorHit {
    pub memory_id: i64,
    pub distance: f32,
}

#[derive(Debug, Clone, PartialEq)]
pub struct VectorSearchOutcome {
    pub hits: Vec<VectorHit>,
    pub disabled_reason: Option<String>,
    pub candidates_scanned: usize,
    pub timings: Vec<crate::perf::PhaseTiming>,
}

impl VectorSearchOutcome {
    pub fn disabled(reason: impl Into<String>) -> Self {
        Self {
            hits: vec![],
            disabled_reason: Some(reason.into()),
            candidates_scanned: 0,
            timings: vec![],
        }
    }

    fn disabled_with_timings(
        reason: impl Into<String>,
        timings: Vec<crate::perf::PhaseTiming>,
    ) -> Self {
        Self {
            hits: vec![],
            disabled_reason: Some(reason.into()),
            candidates_scanned: 0,
            timings,
        }
    }

    pub fn ready(hits: Vec<VectorHit>) -> Self {
        let candidates_scanned = hits.len();
        Self::ready_with_scan_count(hits, candidates_scanned)
    }

    pub fn ready_with_scan_count(hits: Vec<VectorHit>, candidates_scanned: usize) -> Self {
        Self::ready_with_scan_count_and_timings(hits, candidates_scanned, vec![])
    }

    fn ready_with_scan_count_and_timings(
        hits: Vec<VectorHit>,
        candidates_scanned: usize,
        timings: Vec<crate::perf::PhaseTiming>,
    ) -> Self {
        Self {
            hits,
            disabled_reason: None,
            candidates_scanned,
            timings,
        }
    }
}

#[derive(Debug, Clone, Copy, Default)]
pub struct VectorSearchFilters<'a> {
    pub project: Option<&'a str>,
    pub memory_type: Option<&'a str>,
    pub branch: Option<&'a str>,
    pub include_stale: bool,
}

/// Load a native vector extension when one is configured.
///
/// The current production path is a portable SQLite table plus in-process
/// cosine scan. That keeps vector recall available in the single-binary build;
/// sqlite-vec can replace the scan later without changing the search contract.
pub fn load_vec_extension(_conn: &Connection) -> Result<()> {
    Ok(())
}

pub fn ensure_vec_table(conn: &Connection) -> Result<()> {
    create_embedding_table(conn)
}

pub fn upsert_embedding(conn: &Connection, memory_id: i64, embedding: &[f32]) -> Result<()> {
    if super::embedding::provider_disabled_or_error()? {
        return Ok(());
    }
    upsert_embedding_with_metadata(
        conn,
        memory_id,
        DEFAULT_EMBEDDING_MODEL,
        "",
        embedding,
        chrono::Utc::now().timestamp(),
    )
}

/// Upsert the index embedding for one memory row from the authoritative
/// passage (canonical fields + index-only `search_context`). The stored
/// `content_hash` is the versioned `memory_index_hash` of the same snapshot.
pub fn upsert_memory_embedding(
    conn: &Connection,
    memory_id: i64,
    title: &str,
    content: &str,
    memory_type: &str,
    topic_key: Option<&str>,
    search_context: &str,
) -> Result<()> {
    if super::embedding::provider_disabled_or_error()? {
        return Ok(());
    }
    let embedding = match super::embedding::embed_memory_index(
        title,
        content,
        memory_type,
        topic_key,
        search_context,
    ) {
        Ok(embedding) => embedding,
        Err(error) if super::embedding::is_embedding_provider_off_error(&error) => return Ok(()),
        Err(error) if super::embedding::is_local_embedding_model_unavailable_error(&error) => {
            crate::log::error(
                "embedding",
                &format!("memory embedding deferred for memory id={memory_id}: {error}"),
            );
            return Ok(());
        }
        Err(error) => return Err(error),
    };
    let content_hash =
        super::embedding::memory_index_hash(title, content, memory_type, topic_key, search_context);
    upsert_embedding_with_metadata(
        conn,
        memory_id,
        embedding.model(),
        &content_hash,
        embedding.values(),
        chrono::Utc::now().timestamp(),
    )
    .with_context(|| format!("memory embedding upsert failed for memory id={memory_id}"))
}

/// Row-atomic upsert used by the enrichment success CAS: the caller already
/// prepared the vector and index hash for the committed snapshot.
pub(crate) fn upsert_index_embedding(
    conn: &Connection,
    memory_id: i64,
    model: &str,
    index_hash: &str,
    values: &[f32],
) -> Result<()> {
    upsert_embedding_with_metadata(
        conn,
        memory_id,
        model,
        index_hash,
        values,
        chrono::Utc::now().timestamp(),
    )
    .with_context(|| format!("index embedding upsert failed for memory id={memory_id}"))
}

pub fn upsert_memory_embedding_for_row(conn: &Connection, memory_id: i64) -> Result<()> {
    let row: (Option<String>, String, String, String, Option<String>) = conn
        .query_row(
            "SELECT topic_key, title, content, memory_type,
                    CASE WHEN search_context_source_hash IS NOT NULL
                         THEN search_context ELSE '' END
             FROM memories
             WHERE id = ?1",
            [memory_id],
            |row| {
                Ok((
                    row.get(0)?,
                    row.get(1)?,
                    row.get(2)?,
                    row.get(3)?,
                    row.get(4)?,
                ))
            },
        )
        .with_context(|| format!("load memory row for embedding id={memory_id}"))?;
    let (topic_key, title, content, memory_type, search_context) = row;
    upsert_memory_embedding(
        conn,
        memory_id,
        &title,
        &content,
        &memory_type,
        topic_key.as_deref(),
        search_context.as_deref().unwrap_or(""),
    )
}

pub fn embedding_count(conn: &Connection) -> Result<i64> {
    if !table_exists(conn, "memory_embeddings")? {
        return Ok(0);
    }
    Ok(
        conn.query_row("SELECT COUNT(*) FROM memory_embeddings", [], |row| {
            row.get(0)
        })?,
    )
}

pub fn embed_query_text(query: &str) -> Vec<f32> {
    super::embedding::embed_query_text_local(query)
}

pub fn embed_memory_text(
    title: &str,
    content: &str,
    memory_type: &str,
    topic_key: Option<&str>,
) -> Vec<f32> {
    super::embedding::embed_memory_text_local(title, content, memory_type, topic_key)
}

pub fn vector_search(
    conn: &Connection,
    query_embedding: &[f32],
    limit: usize,
) -> Result<Vec<(i64, f32)>> {
    Ok(
        vector_search_filtered(conn, query_embedding, VectorSearchFilters::default(), limit)?
            .hits
            .into_iter()
            .map(|hit| (hit.memory_id, hit.distance))
            .collect(),
    )
}

pub fn vector_search_filtered(
    conn: &Connection,
    query_embedding: &[f32],
    filters: VectorSearchFilters<'_>,
    limit: usize,
) -> Result<VectorSearchOutcome> {
    if query_embedding.len() != EMBEDDING_DIMENSIONS {
        anyhow::bail!(
            "query embedding must be {} dimensions, got {}",
            EMBEDDING_DIMENSIONS,
            query_embedding.len()
        );
    }
    let embedding = TextEmbedding::new(DEFAULT_EMBEDDING_MODEL, query_embedding.to_vec())?;
    vector_search_embedding_filtered(conn, &embedding, filters, limit)
}

pub fn vector_search_embedding_filtered(
    conn: &Connection,
    query_embedding: &TextEmbedding,
    filters: VectorSearchFilters<'_>,
    limit: usize,
) -> Result<VectorSearchOutcome> {
    if limit == 0 {
        return Ok(VectorSearchOutcome::ready(vec![]));
    }
    crate::memory::retrieval_enrichment::ensure_retrieval_open(conn)?;
    if super::embedding::provider_disabled_or_error()? {
        return Ok(VectorSearchOutcome::disabled("embedding provider is off"));
    }
    if !table_exists(conn, "memory_embeddings")? {
        return Ok(VectorSearchOutcome::disabled(
            "memory_embeddings table is missing; run migrations/backfill",
        ));
    }
    let mut timings = Vec::new();
    let profile = query_embedding.profile();
    let candidate_ids = crate::perf::time_result(&mut timings, "vector_select_candidates", || {
        super::vector_candidates::select_candidate_ids(conn, filters, profile, limit)
    })?;
    let candidates_scanned = candidate_ids.len();
    if candidate_ids.is_empty() {
        if super::vector_candidates::matching_memory_count(conn, filters)? > 0 {
            if embedding_count(conn)? == 0 {
                return Ok(VectorSearchOutcome::disabled_with_timings(
                    "memory_embeddings table is empty; run `remem reindex-embeddings --limit 1000`",
                    timings,
                ));
            }
            return Ok(VectorSearchOutcome::disabled_with_timings(
                format!(
                    "memory_embeddings has no rows for model={} dimensions={}; run `remem reindex-embeddings --limit 1000`",
                    profile.model, profile.dimensions
                ),
                timings,
            ));
        }
        return Ok(VectorSearchOutcome::ready_with_scan_count_and_timings(
            vec![],
            0,
            timings,
        ));
    }
    let placeholders = std::iter::repeat_n("?", candidate_ids.len())
        .collect::<Vec<_>>()
        .join(", ");
    let sql = format!(
        "SELECT memory_id, embedding, dimensions
         FROM memory_embeddings INDEXED BY idx_memory_embeddings_profile_memory_id
         WHERE model = ?
           AND dimensions = ?
           AND memory_id IN ({placeholders})"
    );
    let mut param_values: Vec<Box<dyn rusqlite::types::ToSql>> = vec![
        Box::new(profile.model.to_string()),
        Box::new(profile.dimensions as i64),
    ];
    param_values.extend(
        candidate_ids
            .iter()
            .map(|id| Box::new(*id) as Box<dyn rusqlite::types::ToSql>),
    );
    let candidates = crate::perf::time_result(&mut timings, "vector_load_embeddings", || {
        let refs = crate::db::to_sql_refs(&param_values);
        let mut stmt = conn.prepare(&sql)?;
        let rows = stmt.query_map(refs.as_slice(), |row| {
            Ok((
                row.get::<_, i64>(0)?,
                row.get::<_, Vec<u8>>(1)?,
                row.get::<_, i64>(2)?,
            ))
        })?;
        crate::db::query::collect_rows(rows)
    })?;
    let mut hits = crate::perf::time_result(&mut timings, "vector_decode_cosine", || {
        let mut hits = Vec::new();
        for (memory_id, blob, dimensions) in candidates {
            let embedding = decode_embedding(&blob, dimensions)
                .with_context(|| format!("invalid embedding blob for memory id={memory_id}"))?;
            let distance = cosine_distance(query_embedding.values(), &embedding)?;
            hits.push(VectorHit {
                memory_id,
                distance,
            });
        }
        Ok(hits)
    })?;
    crate::perf::time_value(&mut timings, "vector_sort_truncate", || {
        hits.sort_by(|a, b| {
            a.distance
                .partial_cmp(&b.distance)
                .unwrap_or(std::cmp::Ordering::Equal)
                .then_with(|| a.memory_id.cmp(&b.memory_id))
        });
        hits.truncate(limit);
    });
    Ok(VectorSearchOutcome::ready_with_scan_count_and_timings(
        hits,
        candidates_scanned,
        timings,
    ))
}

pub fn find_similar_observations(
    conn: &Connection,
    query_embedding: &[f32],
    threshold: f32,
    limit: usize,
) -> Result<Vec<i64>> {
    let candidates = vector_search(conn, query_embedding, limit)?;
    let distance_threshold = 1.0 - threshold;
    let similar: Vec<i64> = candidates
        .into_iter()
        .filter(|(_, dist)| *dist < distance_threshold)
        .map(|(id, _)| id)
        .collect();

    Ok(similar)
}

fn create_embedding_table(conn: &Connection) -> Result<()> {
    conn.execute_batch(
        "CREATE TABLE IF NOT EXISTS memory_embeddings (
             memory_id INTEGER NOT NULL,
             embedding BLOB NOT NULL,
             dimensions INTEGER NOT NULL,
             model TEXT NOT NULL,
             content_hash TEXT NOT NULL,
             updated_at_epoch INTEGER NOT NULL,
             PRIMARY KEY(memory_id, model, dimensions),
             FOREIGN KEY(memory_id) REFERENCES memories(id) ON DELETE CASCADE
         );
         CREATE INDEX IF NOT EXISTS idx_memory_embeddings_model
             ON memory_embeddings(model, updated_at_epoch);
         CREATE INDEX IF NOT EXISTS idx_memory_embeddings_profile_memory_id
             ON memory_embeddings(model, dimensions, memory_id);",
    )?;
    Ok(())
}

fn upsert_embedding_with_metadata(
    conn: &Connection,
    memory_id: i64,
    model: &str,
    content_hash: &str,
    embedding: &[f32],
    updated_at_epoch: i64,
) -> Result<()> {
    let mut stmt = conn.prepare(UPSERT_EMBEDDING_SQL)?;
    execute_embedding_upsert(
        &mut stmt,
        memory_id,
        model,
        content_hash,
        embedding,
        updated_at_epoch,
    )
}

fn execute_embedding_upsert(
    stmt: &mut Statement<'_>,
    memory_id: i64,
    model: &str,
    content_hash: &str,
    embedding: &[f32],
    updated_at_epoch: i64,
) -> Result<()> {
    if model.trim().is_empty() {
        anyhow::bail!("embedding model must not be empty");
    }
    if embedding.is_empty() {
        anyhow::bail!("embedding vector must not be empty");
    }
    if embedding.iter().any(|value| !value.is_finite()) {
        anyhow::bail!("embedding vector contains non-finite values");
    }
    let blob = encode_embedding(embedding);
    let dimensions = embedding.len() as i64;
    stmt.execute(params![
        memory_id,
        blob,
        dimensions,
        model,
        content_hash,
        updated_at_epoch
    ])?;
    Ok(())
}

fn encode_embedding(embedding: &[f32]) -> Vec<u8> {
    let mut out = Vec::with_capacity(std::mem::size_of_val(embedding));
    for value in embedding {
        out.extend_from_slice(&value.to_le_bytes());
    }
    out
}

pub(crate) fn decode_embedding(blob: &[u8], dimensions: i64) -> Result<Vec<f32>> {
    if dimensions <= 0 {
        anyhow::bail!("embedding dimensions must be positive, got {dimensions}");
    }
    let dimensions = dimensions as usize;
    let expected_bytes = dimensions * std::mem::size_of::<f32>();
    if blob.len() != expected_bytes {
        anyhow::bail!(
            "embedding blob must be {} bytes, got {}",
            expected_bytes,
            blob.len()
        );
    }
    Ok(blob
        .chunks_exact(std::mem::size_of::<f32>())
        .map(|chunk| f32::from_le_bytes([chunk[0], chunk[1], chunk[2], chunk[3]]))
        .collect())
}

pub(crate) fn cosine_distance(a: &[f32], b: &[f32]) -> Result<f32> {
    if a.len() != b.len() {
        anyhow::bail!(
            "embedding dimensions differ: query={} stored={}",
            a.len(),
            b.len()
        );
    }
    let mut dot = 0.0f32;
    let mut a_norm = 0.0f32;
    let mut b_norm = 0.0f32;
    for (left, right) in a.iter().zip(b) {
        dot += left * right;
        a_norm += left * left;
        b_norm += right * right;
    }
    if a_norm == 0.0 || b_norm == 0.0 {
        return Ok(1.0);
    }
    Ok((1.0 - dot / (a_norm.sqrt() * b_norm.sqrt())).clamp(0.0, 2.0))
}

fn table_exists(conn: &Connection, table: &str) -> Result<bool> {
    Ok(conn
        .query_row(
            "SELECT 1 FROM sqlite_master WHERE type = 'table' AND name = ?1 LIMIT 1",
            params![table],
            |_| Ok(()),
        )
        .optional()?
        .is_some())
}

#[cfg(test)]
mod tests;