forked from BasedHardware/omi
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcanonical_consolidation.py
More file actions
997 lines (873 loc) · 37.6 KB
/
Copy pathcanonical_consolidation.py
File metadata and controls
997 lines (873 loc) · 37.6 KB
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
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
"""Canonical batched short-term consolidation (WS-O).
Deterministic code retrieves candidates, hydrates active memory_items, and assembles
LLM context. A single batched LLM agent is the sole decider of consolidation outcomes;
decisions are applied via ``apply_long_term_patch_firestore``.
"""
from __future__ import annotations
import json
import logging
import os
from dataclasses import dataclass, field
from datetime import datetime, timedelta, timezone
from typing import Any, Callable, Dict, List, Literal, Optional, Set, cast
from langchain_core.output_parsers import PydanticOutputParser
from pydantic import BaseModel, Field
from database._client import db as default_db_client
from database.memory_apply_store import MissingMemoryDocument, apply_long_term_patch_firestore
from database.memory_collections import MemoryCollections
from database.review_queue import (
create_review_conflict,
purge_stale_review_conflicts_for_memories,
should_escalate_conflict,
)
from database.vector_db import query_memory_vector_candidates
from jobs.short_term_lifecycle_worker import fetch_short_term_memory_items_firestore
from models.memory_evidence import SourceState
from models.memory_apply import ApplyStatus, MemoryControlState
from models.memory_contracts import DurablePatchDecision, LifecycleState, deterministic_contract_id
from models.memory_operations import MemoryOperation, MemoryOperationType
from models.memory_search_gateway import SearchMode
from models.memory_recurrence import CanonicalRecurrenceSignal
from models.product_memory import MemoryItem, MemoryItemStatus, MemoryLayer, ProcessingState
from utils.executors import llm_executor, submit_with_context
from utils.llm.clients import get_llm
from utils.log_sanitizer import sanitize_pii
from utils.memory.atom_keyword_index import delete_atom_keyword_doc
from utils.memory.canonical_memory_adapter import invalidate_kg_for_memory_retraction
from utils.memory.canonical_vector_sync import delete_canonical_memory_vector
from utils.memory.memory_system import MemorySystem, resolve_memory_system
logger = logging.getLogger(__name__)
CONSOLIDATION_BY = "canonical_batched_consolidation"
DEFAULT_CONSOLIDATION_BATCH_THRESHOLD = 10
DEFAULT_CANDIDATES_PER_ITEM = 8
CONSOLIDATION_DAILY_INTERVAL = timedelta(hours=24)
MEMORY_CANONICAL_CONSOLIDATION_ENABLED_ENV = "MEMORY_CANONICAL_CONSOLIDATION_ENABLED"
Payload = Dict[str, Any]
def _empty_candidate_map() -> Dict[str, List["ConsolidationCandidate"]]:
return {}
def _empty_str_list() -> List[str]:
return []
def _empty_consolidation_decisions() -> List["ConsolidationAgentDecision"]:
return []
def _empty_recurrence_signals() -> List[CanonicalRecurrenceSignal]:
return []
def _snapshot_payload(snapshot: Any) -> Payload:
if not getattr(snapshot, "exists", False):
return {}
raw = snapshot.to_dict()
return cast(Payload, raw) if isinstance(raw, dict) else {}
def _coerce_aware_utc(value: datetime) -> datetime:
if value.tzinfo is None or value.utcoffset() is None:
raise ValueError("timestamps must be timezone-aware")
return value.astimezone(timezone.utc)
def _read_control_state(uid: str, *, db_client: Any) -> MemoryControlState:
collections = MemoryCollections(uid=uid)
ref = db_client.document(collections.memory_apply_control_state)
snapshot = ref.get()
payload = _snapshot_payload(snapshot)
if payload:
return MemoryControlState(**payload)
control = MemoryControlState(uid=uid, head_commit_id="head0", account_generation=1, source_generation=1)
ref.set(control.model_dump(mode="json"))
return control
def _persist_control_state(control: MemoryControlState, *, db_client: Any) -> None:
db_client.document(MemoryCollections(uid=control.uid).memory_apply_control_state).set(
{
"last_consolidation_run_at": (
control.last_consolidation_run_at.isoformat() if control.last_consolidation_run_at is not None else None
),
"updated_at": control.updated_at.isoformat(),
},
merge=True,
)
def _is_promotable_for_consolidation(item: MemoryItem, *, now: datetime) -> bool:
current_time = _coerce_aware_utc(now)
if item.tier != MemoryLayer.short_term:
return False
if item.status != MemoryItemStatus.active:
return False
if item.processing_state != ProcessingState.processed:
return False
if item.source_state != SourceState.active:
return False
if (item.promotion or {}).get("required") is True:
return False
if item.expires_at is not None and item.expires_at <= current_time:
return False
return True
def consolidation_enabled() -> bool:
raw = os.getenv(MEMORY_CANONICAL_CONSOLIDATION_ENABLED_ENV, "true")
return raw.lower() == "true"
def consolidation_batch_threshold() -> int:
raw = os.getenv("MEMORY_CANONICAL_CONSOLIDATION_BATCH_THRESHOLD", str(DEFAULT_CONSOLIDATION_BATCH_THRESHOLD))
try:
return max(1, int(raw))
except ValueError:
return DEFAULT_CONSOLIDATION_BATCH_THRESHOLD
def consolidation_batch_cap() -> int:
"""Max pending items per consolidation LLM call (defaults to batch threshold)."""
default = str(consolidation_batch_threshold())
raw = os.getenv("MEMORY_CANONICAL_CONSOLIDATION_BATCH_CAP", default)
try:
return max(1, int(raw))
except ValueError:
return consolidation_batch_threshold()
def max_consolidation_batches_per_pass() -> int:
"""Upper bound on LLM consolidation calls per maintenance pass (cost guard)."""
raw = os.getenv("MEMORY_CANONICAL_CONSOLIDATION_MAX_BATCHES_PER_PASS", "10")
try:
return max(1, int(raw))
except ValueError:
return 10
def candidates_per_item_limit() -> int:
raw = os.getenv("MEMORY_CANONICAL_CONSOLIDATION_CANDIDATES_PER_ITEM", str(DEFAULT_CANDIDATES_PER_ITEM))
try:
return max(1, min(20, int(raw)))
except ValueError:
return DEFAULT_CANDIDATES_PER_ITEM
def _is_active_consolidation_item(item: MemoryItem) -> bool:
return item.status == MemoryItemStatus.active and item.processing_state == ProcessingState.processed
def list_pending_consolidation_items(
uid: str,
*,
db_client: Any = None,
now: Optional[datetime] = None,
) -> List[MemoryItem]:
"""Active processed short_term items eligible for batched consolidation."""
client: Any = db_client if db_client is not None else default_db_client
current_time = _coerce_aware_utc(now or datetime.now(timezone.utc))
items = fetch_short_term_memory_items_firestore(uid=uid, db_client=client)
pending = [
item
for item in items
if _is_active_consolidation_item(item) and _is_promotable_for_consolidation(item, now=current_time)
]
return sorted(pending, key=lambda item: item.captured_at)
def consolidation_trigger_reason(
*,
pending_count: int,
last_consolidation_run_at: Optional[datetime],
now: datetime,
batch_threshold: Optional[int] = None,
) -> Optional[str]:
if pending_count <= 0:
return None
threshold = batch_threshold if batch_threshold is not None else consolidation_batch_threshold()
if pending_count >= threshold:
return "batch_threshold"
if pending_count <= 1:
return None
if last_consolidation_run_at is None:
return None
current_time = _coerce_aware_utc(now)
if current_time - _coerce_aware_utc(last_consolidation_run_at) >= CONSOLIDATION_DAILY_INTERVAL:
return "daily_elapsed"
return None
@dataclass(frozen=True)
class ConsolidationCandidate:
anchor_memory_id: str
memory_id: str
content: str
score: float
tier: str
captured_at: str
@dataclass
class ConsolidationContext:
uid: str
pending_items: List[MemoryItem]
candidates_by_anchor: Dict[str, List[ConsolidationCandidate]] = field(default_factory=_empty_candidate_map)
@property
def hydrated_memory_ids(self) -> Set[str]:
ids: Set[str] = {item.memory_id for item in self.pending_items}
for candidates in self.candidates_by_anchor.values():
for candidate in candidates:
ids.add(candidate.memory_id)
return ids
def _hydrate_memory_item(
uid: str, memory_id: str, *, db_client: Any, cache: Dict[str, Optional[MemoryItem]]
) -> Optional[MemoryItem]:
if memory_id in cache:
return cache[memory_id]
path = f"{MemoryCollections(uid=uid).memory_items}/{memory_id}"
payload = _snapshot_payload(db_client.document(path).get())
if not payload:
cache[memory_id] = None
return None
item = MemoryItem(**payload)
if not _is_active_consolidation_item(item):
cache[memory_id] = None
return None
cache[memory_id] = item
return item
def gather_consolidation_candidates(
uid: str,
pending_items: List[MemoryItem],
*,
db_client: Any = None,
candidate_limit: Optional[int] = None,
) -> ConsolidationContext:
"""Vector-search similar memories and hydrate active items (deterministic only)."""
client: Any = db_client if db_client is not None else default_db_client
per_item = candidate_limit if candidate_limit is not None else candidates_per_item_limit()
context = ConsolidationContext(uid=uid, pending_items=list(pending_items))
cache: Dict[str, Optional[MemoryItem]] = {item.memory_id: item for item in pending_items}
for anchor in pending_items:
content = (anchor.content or "").strip()
if not content:
context.candidates_by_anchor[anchor.memory_id] = []
continue
query_result = query_memory_vector_candidates(uid, content, mode=SearchMode.default, limit=per_item + 1)
candidates: List[ConsolidationCandidate] = []
seen: Set[str] = set()
for hit in query_result.hits:
if hit.memory_id == anchor.memory_id or hit.memory_id in seen:
continue
item = _hydrate_memory_item(uid, hit.memory_id, db_client=client, cache=cache)
if item is None:
continue
seen.add(hit.memory_id)
candidates.append(
ConsolidationCandidate(
anchor_memory_id=anchor.memory_id,
memory_id=item.memory_id,
content=item.content or "",
score=hit.score,
tier=item.tier.value,
captured_at=item.captured_at.isoformat(),
)
)
if len(candidates) >= per_item:
break
context.candidates_by_anchor[anchor.memory_id] = candidates
return context
def format_consolidation_llm_context(context: ConsolidationContext) -> str:
"""Serialize pending batch + vector candidates for the consolidation agent."""
memories: List[Payload] = []
candidate_groups: List[Payload] = []
payload: Payload = {"memories": memories, "candidate_groups": candidate_groups}
for item in context.pending_items:
memories.append(
{
"memory_id": item.memory_id,
"content": item.content,
"tier": item.tier.value,
"captured_at": item.captured_at.isoformat(),
"evidence_source_ids": sorted({ev.source_id for ev in item.evidence if ev.source_id}),
"corroboration_count": getattr(item, "corroboration_count", 0) or 0,
"subject_entity_id": getattr(item, "subject_entity_id", None),
"predicate": getattr(item, "predicate", None),
}
)
for anchor_id, candidates in context.candidates_by_anchor.items():
if not candidates:
continue
candidate_groups.append(
{
"anchor_memory_id": anchor_id,
"candidates": [
{
"memory_id": c.memory_id,
"content": c.content,
"score": round(c.score, 4),
"tier": c.tier,
"captured_at": c.captured_at,
}
for c in candidates
],
}
)
return json.dumps(payload, sort_keys=True, separators=(",", ":"))
class ConsolidationAgentDecision(BaseModel):
decision: Literal[
"update",
"merge",
"skip_duplicate",
"add_evidence",
"keep_both",
"review",
]
survivor_memory_id: str = Field(description="The memory_id that remains active after this decision")
supersedes: List[str] = Field(default_factory=list, description="memory_ids to mark superseded")
memory_text: Optional[str] = None
evidence_ids: List[str] = Field(default_factory=list)
corroboration_increment: bool = Field(
default=False,
description="When true, increment corroboration_count on survivor (duplicate/corroboration)",
)
review_required: bool = False
conflict_with: List[str] = Field(default_factory=list)
rationale: str = ""
class ConsolidationAgentBatch(BaseModel):
decisions: List[ConsolidationAgentDecision] = Field(default_factory=_empty_consolidation_decisions)
recurrence_signals: List[CanonicalRecurrenceSignal] = Field(default_factory=_empty_recurrence_signals)
reasoning: str = ""
CONSOLIDATION_AGENT_PROMPT = """You are Omi's canonical memory consolidation agent.
You receive a BATCH of short-term memories plus vector-similar candidates. Decide how
they relate: duplicate, merge, refine, contradict/supersede, corroborate, or coexist.
Rules:
- Reason over the WHOLE batch — not one pair at a time.
- Only supersede when a fact is genuinely outdated or false (not when two facts can coexist).
- Use skip_duplicate when a pending memory repeats an existing active fact.
- Use add_evidence or merge to combine near-duplicates across sources onto one survivor row.
- Use update when newer information replaces older (contradiction) — list outdated ids in supersedes.
- Use keep_both when facts are compatible and distinct.
- Set review_required=true for ambiguous contradictions (low confidence vs high-confidence existing).
- survivor_memory_id is the row that stays active; supersedes lists memory_ids to invalidate.
- Emit one decision per pending memory that needs action; omit memories that need no change.
Reference conflict-resolution patterns (adapt for batch reasoning):
- Preference flip (loves→hates): update, supersede old.
- Location change (NYC→LA): update, supersede old.
- Duplicate text: skip_duplicate on the newer id, survivor=existing.
- Compatible preferences (tennis + basketball): keep_both or no decision.
- Cross-source same fact: add_evidence or merge onto one survivor, corroboration_increment=true.
- recurrence_signals are only for the same unresolved open loop appearing on at
least two distinct days. One-off mentions never qualify. Cite only canonical
memory_item/conversation EvidenceRefs; do not include raw source content.
EvidenceRefs MUST be oldest-first, retaining the original first-seen evidence
anchor when later batches add evidence or refine wording. signal_id identifies
this observation; workflow derives enduring loop identity from canonical time
and that first evidence anchor rather than trusting model-authored identity.
Batch JSON:
{context_json}
{format_instructions}
"""
def _invoke_consolidation_llm(prompt: str) -> str:
response = get_llm("memory_conflict").invoke(prompt)
return cast(str, getattr(response, "content", str(response)))
def invoke_consolidation_agent(
context: ConsolidationContext,
*,
llm_invoke: Optional[Callable[[str], str]] = None,
) -> ConsolidationAgentBatch:
"""Single batched LLM call — sole decider for consolidation outcomes."""
parser = PydanticOutputParser(pydantic_object=ConsolidationAgentBatch)
prompt = CONSOLIDATION_AGENT_PROMPT.format(
context_json=format_consolidation_llm_context(context),
format_instructions=parser.get_format_instructions(),
)
try:
if llm_invoke is not None:
raw = llm_invoke(prompt)
else:
raw = submit_with_context(llm_executor, _invoke_consolidation_llm, prompt).result()
except Exception as exc:
logger.warning(
"consolidation_agent_invoke_failed uid=%s error=%s",
context.uid,
type(exc).__name__,
)
return ConsolidationAgentBatch(decisions=[], reasoning=f"invoke_failed:{type(exc).__name__}")
try:
return parser.parse(raw)
except Exception as exc:
logger.warning(
"consolidation_agent_parse_failed uid=%s error=%s",
context.uid,
type(exc).__name__,
)
return ConsolidationAgentBatch(decisions=[], reasoning=f"parse_failed:{type(exc).__name__}")
def _consolidation_apply_decision(decision: ConsolidationAgentDecision) -> str:
"""Map agent decisions to durable apply decision (in-place survivor updates use ``update``)."""
if decision.decision in {"merge", "add_evidence"}:
return DurablePatchDecision.update.value
if decision.decision == "skip_duplicate" and decision.corroboration_increment:
return DurablePatchDecision.update.value
return decision.decision
class ConsolidationApplySkipped(Exception):
"""Agent decision referenced a missing or inactive memory/evidence doc before any mutation."""
def __init__(self, reason: str):
self.reason = reason
super().__init__(reason)
class ConsolidationPartialApply(Exception):
"""Survivor patch committed but a supersede sub-step failed — must retry without advancing."""
def __init__(self, reason: str):
self.reason = reason
super().__init__(reason)
def _agent_batch_blocks_watermark(agent_batch: ConsolidationAgentBatch) -> bool:
"""True when agent output is unusable (invoke/parse failure)."""
return agent_batch.reasoning.startswith("parse_failed:") or agent_batch.reasoning.startswith("invoke_failed:")
def _should_advance_consolidation_watermark(
agent_batch: ConsolidationAgentBatch,
*,
watermark_blocked: bool = False,
) -> bool:
"""Advance on clean agent completion; fail-closed on parse/invoke or partial apply.
Clean runs include zero-action batches (``no_changes``) and passes that skipped
hallucinated references before mutation — advancing prevents hourly re-fire on the
daily-elapsed path. ``parse_failed:*`` / ``invoke_failed:*`` mean unusable agent
output and must retry. ``watermark_blocked`` covers partial survivor+supersede
applies that need retry.
"""
if watermark_blocked:
return False
if _agent_batch_blocks_watermark(agent_batch):
return False
return True
def _consolidation_decision_identity(
*,
uid: str,
decision: ConsolidationAgentDecision,
) -> Payload:
"""Stable consolidation identity for idempotency across maintenance passes."""
return {
"uid": uid,
"survivor": decision.survivor_memory_id,
"decision": decision.decision,
"supersedes": sorted(decision.supersedes),
"memory_text": (decision.memory_text or "")[:200],
"corroboration_increment": bool(decision.corroboration_increment),
}
def _dedupe_evidence_ids(*ids: str) -> List[str]:
seen: Set[str] = set()
ordered: List[str] = []
for evidence_id in ids:
if evidence_id and evidence_id not in seen:
seen.add(evidence_id)
ordered.append(evidence_id)
return ordered
def _ensure_consolidation_operation(
*,
uid: str,
decision: ConsolidationAgentDecision,
control: MemoryControlState,
run_id: str,
evidence_ids: List[str],
db_client: Any,
) -> MemoryOperation:
apply_decision = _consolidation_apply_decision(decision)
logical_payload: Payload = {
"decision": apply_decision,
"target_memory_id": decision.survivor_memory_id,
"memory_text": decision.memory_text,
"result_status": LifecycleState.active.value,
"supersedes": sorted(decision.supersedes),
}
source_packet_id = deterministic_contract_id(
"canonical-consolidation-operation",
_consolidation_decision_identity(uid=uid, decision=decision),
)
operation = MemoryOperation.new(
uid=uid,
operation_type=MemoryOperationType.long_term_apply,
source_packet_id=source_packet_id,
target_memory_id=decision.survivor_memory_id,
evidence_ids=evidence_ids,
logical_payload=logical_payload,
account_generation=control.account_generation,
source_generation=control.source_generation,
observed_head_commit_id=control.head_commit_id,
)
op_path = f"{MemoryCollections(uid=uid).memory_operations}/{operation.operation_id}"
op_ref = db_client.document(op_path)
if not op_ref.get().exists:
op_ref.set(operation.model_dump(mode="json"))
return operation
def _apply_superseded_item(
uid: str,
*,
memory_id: str,
superseded_by: str,
control: MemoryControlState,
run_id: str,
db_client: Any,
) -> None:
idempotency_key = deterministic_contract_id(
"canonical-consolidation-supersede",
{"uid": uid, "memory_id": memory_id, "superseded_by": superseded_by},
)
operation = MemoryOperation.new(
uid=uid,
operation_type=MemoryOperationType.long_term_apply,
source_packet_id=f"consolidation_supersede_{run_id}",
target_memory_id=memory_id,
evidence_ids=[],
logical_payload={
"decision": DurablePatchDecision.update.value,
"target_memory_id": memory_id,
"result_status": LifecycleState.superseded.value,
"supersedes": [],
},
account_generation=control.account_generation,
source_generation=control.source_generation,
observed_head_commit_id=control.head_commit_id,
)
op_path = f"{MemoryCollections(uid=uid).memory_operations}/{operation.operation_id}"
op_ref = db_client.document(op_path)
if not op_ref.get().exists:
op_ref.set(operation.model_dump(mode="json"))
patch_payload: Payload = {
"patch_id": f"patch_sup_{idempotency_key[:24]}",
"packet_id": f"consolidation_{run_id}",
"run_id": run_id,
"observed_head_commit_id": control.head_commit_id,
"idempotency_key": idempotency_key,
"decision": DurablePatchDecision.update.value,
"result_status": LifecycleState.superseded.value,
"target_memory_id": memory_id,
"memory_text": None,
"evidence_ids": [],
"supersedes": [],
"superseded_by": superseded_by,
}
result = apply_long_term_patch_firestore(
uid=uid,
operation_id=operation.operation_id,
patch_payload=patch_payload,
db_client=db_client,
)
if result.status == ApplyStatus.target_not_active:
raise ConsolidationApplySkipped(f"supersede target not active for {memory_id}: {result.reason}")
if result.status not in {ApplyStatus.committed, ApplyStatus.idempotent_skip}:
raise RuntimeError(f"supersede apply failed for {memory_id}: {result.status} ({result.reason})")
item = result.memory_items[0] if result.memory_items else None
if item is None:
payload = _snapshot_payload(db_client.document(f"{MemoryCollections(uid=uid).memory_items}/{memory_id}").get())
if payload:
item = MemoryItem(**payload)
if item is not None and item.tier == MemoryLayer.long_term:
delete_atom_keyword_doc(uid, item.memory_id, db_client=db_client)
delete_canonical_memory_vector(uid, memory_id)
invalidate_kg_for_memory_retraction(uid, [memory_id], db_client=db_client)
purge_stale_review_conflicts_for_memories(uid, [memory_id], reason="memory_superseded", db_client=db_client)
def _escalate_to_review_queue(
uid: str,
*,
decision: ConsolidationAgentDecision,
survivor: MemoryItem,
db_client: Any,
) -> None:
conflict_ids = decision.conflict_with or decision.supersedes
fact = {
"id": decision.survivor_memory_id,
"content": decision.memory_text or survivor.content,
"veracity": 0.4,
"importance": 0.5,
}
conflict_fact = {"veracity": 0.85}
if not decision.review_required and not should_escalate_conflict(fact, conflict_fact):
return
create_review_conflict(
uid,
fact=fact,
conflict_with=conflict_ids,
impact=0.5,
)
logger.info(
"consolidation_review_escalated uid=%s survivor=%s conflicts=%d",
uid,
decision.survivor_memory_id,
len(conflict_ids),
)
def _load_survivor_item(
uid: str,
memory_id: str,
*,
pending_by_id: Dict[str, MemoryItem],
db_client: Any,
) -> Optional[MemoryItem]:
if memory_id in pending_by_id:
return pending_by_id[memory_id]
path = f"{MemoryCollections(uid=uid).memory_items}/{memory_id}"
payload = _snapshot_payload(db_client.document(path).get())
if not payload:
return None
return MemoryItem(**payload)
def _validate_consolidation_survivor(survivor: Optional[MemoryItem], *, memory_id: str) -> None:
if survivor is None:
raise ConsolidationApplySkipped(f"missing survivor memory item: {memory_id}")
if survivor.status != MemoryItemStatus.active:
raise ConsolidationApplySkipped(f"survivor memory is not active: {memory_id}")
if survivor.processing_state != ProcessingState.processed:
raise ConsolidationApplySkipped(f"survivor memory is not processed: {memory_id}")
def _validate_supersede_targets(
uid: str,
*,
supersedes: List[str],
survivor_memory_id: str,
pending_by_id: Dict[str, MemoryItem],
db_client: Any,
) -> None:
"""Fail-closed before survivor mutation when any supersede target is missing/inactive."""
for memory_id in supersedes:
if memory_id == survivor_memory_id:
continue
item = _load_survivor_item(uid, memory_id, pending_by_id=pending_by_id, db_client=db_client)
_validate_consolidation_survivor(item, memory_id=memory_id)
def apply_consolidation_decision(
uid: str,
*,
decision: ConsolidationAgentDecision,
pending_by_id: Dict[str, MemoryItem],
control: MemoryControlState,
run_id: str,
now: datetime,
db_client: Any,
) -> List[str]:
"""Apply one agent decision via durable patch apply + supersede side effects."""
if resolve_memory_system(uid, db_client=db_client) != MemorySystem.CANONICAL:
raise ConsolidationApplySkipped("not_canonical_cohort")
if decision.decision == "review" or decision.review_required:
survivor = pending_by_id.get(decision.survivor_memory_id)
if survivor is not None:
_escalate_to_review_queue(uid, decision=decision, survivor=survivor, db_client=db_client)
return []
durable_decision = DurablePatchDecision(decision.decision)
if durable_decision == DurablePatchDecision.keep_both:
return []
apply_decision = _consolidation_apply_decision(decision)
survivor = _load_survivor_item(
uid,
decision.survivor_memory_id,
pending_by_id=pending_by_id,
db_client=db_client,
)
_validate_consolidation_survivor(survivor, memory_id=decision.survivor_memory_id)
_validate_supersede_targets(
uid,
supersedes=decision.supersedes,
survivor_memory_id=decision.survivor_memory_id,
pending_by_id=pending_by_id,
db_client=db_client,
)
evidence_ids = _dedupe_evidence_ids(
*(decision.evidence_ids or []),
*([ev.evidence_id for ev in survivor.evidence] if survivor else []),
)
if (
durable_decision
in {
DurablePatchDecision.update,
DurablePatchDecision.merge,
DurablePatchDecision.add_evidence,
DurablePatchDecision.skip_duplicate,
}
and not evidence_ids
):
if survivor:
evidence_ids = [ev.evidence_id for ev in survivor.evidence]
operation = _ensure_consolidation_operation(
uid=uid,
decision=decision,
control=control,
run_id=run_id,
evidence_ids=evidence_ids,
db_client=db_client,
)
idempotency_key = deterministic_contract_id(
"canonical-consolidation-decision",
_consolidation_decision_identity(uid=uid, decision=decision),
)
patch_payload: Dict[str, Any] = {
"patch_id": f"patch_cons_{idempotency_key[:24]}",
"packet_id": f"consolidation_{run_id}",
"run_id": run_id,
"observed_head_commit_id": control.head_commit_id,
"idempotency_key": idempotency_key,
"decision": apply_decision,
"result_status": LifecycleState.active.value,
"target_memory_id": decision.survivor_memory_id,
"memory_text": decision.memory_text,
"evidence_ids": evidence_ids,
"supersedes": sorted(decision.supersedes),
"rationale": sanitize_pii(decision.rationale or "")[:500],
}
if decision.corroboration_increment and survivor is not None:
current_count = getattr(survivor, "corroboration_count", 0) or 0
patch_payload["corroboration_count"] = current_count + 1
patch_payload["last_corroborated_at"] = now.isoformat()
result = apply_long_term_patch_firestore(
uid=uid,
operation_id=operation.operation_id,
patch_payload=patch_payload,
db_client=db_client,
)
if result.status == ApplyStatus.target_not_active:
raise ConsolidationApplySkipped(
f"survivor apply target not active for {decision.survivor_memory_id}: {result.reason}"
)
if result.status not in {ApplyStatus.committed, ApplyStatus.idempotent_skip}:
raise RuntimeError(
f"consolidation apply failed for {decision.survivor_memory_id}: {result.status} ({result.reason})"
)
applied: List[str] = [decision.survivor_memory_id]
control = _read_control_state(uid, db_client=db_client)
for superseded_id in decision.supersedes:
if superseded_id == decision.survivor_memory_id:
continue
try:
_apply_superseded_item(
uid,
memory_id=superseded_id,
superseded_by=decision.survivor_memory_id,
control=control,
run_id=run_id,
db_client=db_client,
)
except ConsolidationApplySkipped as exc:
# Survivor already committed — partial apply must retry; do not advance watermark.
raise ConsolidationPartialApply(
f"partial apply: survivor {decision.survivor_memory_id} committed; "
f"supersede {superseded_id} skipped: {exc}"
) from exc
except RuntimeError as exc:
raise ConsolidationPartialApply(
f"partial apply: survivor {decision.survivor_memory_id} committed; "
f"supersede {superseded_id} failed: {exc}"
) from exc
applied.append(superseded_id)
control = _read_control_state(uid, db_client=db_client)
return applied
@dataclass
class ConsolidationReport:
uid: str
skipped_reason: Optional[str] = None
trigger_reason: Optional[str] = None
pending_count: int = 0
decisions_applied: int = 0
decisions_skipped: int = 0
decisions_partial: int = 0
batched_memory_ids: List[str] = field(default_factory=_empty_str_list)
superseded_memory_ids: List[str] = field(default_factory=_empty_str_list)
review_escalations: int = 0
last_consolidation_run_at: Optional[datetime] = None
watermark_blocked: bool = False
recurrence_signals: List[CanonicalRecurrenceSignal] = field(default_factory=_empty_recurrence_signals)
def run_canonical_consolidation(
uid: str,
*,
db_client: Any = None,
now: Optional[datetime] = None,
run_id: str,
llm_invoke: Optional[Callable[[str], str]] = None,
batch_threshold: Optional[int] = None,
recurrence_signal_sink: Optional[Callable[..., int]] = None,
) -> ConsolidationReport:
"""Batched consolidation entry point for one canonical user."""
client: Any = db_client if db_client is not None else default_db_client
current_time = _coerce_aware_utc(now or datetime.now(timezone.utc))
if resolve_memory_system(uid, db_client=client) != MemorySystem.CANONICAL:
return ConsolidationReport(uid=uid, skipped_reason="not_canonical_cohort")
if not consolidation_enabled():
return ConsolidationReport(uid=uid, skipped_reason="consolidation_disabled")
pending = list_pending_consolidation_items(uid, db_client=client, now=current_time)
control = _read_control_state(uid, db_client=client)
trigger = consolidation_trigger_reason(
pending_count=len(pending),
last_consolidation_run_at=control.last_consolidation_run_at,
now=current_time,
batch_threshold=batch_threshold,
)
if trigger is None:
return ConsolidationReport(
uid=uid,
skipped_reason="consolidation_not_due",
pending_count=len(pending),
last_consolidation_run_at=control.last_consolidation_run_at,
)
report = ConsolidationReport(
uid=uid,
trigger_reason=trigger,
pending_count=len(pending),
last_consolidation_run_at=control.last_consolidation_run_at,
)
if not pending:
return report
batch_cap = consolidation_batch_cap()
max_batches = max_consolidation_batches_per_pass()
batched_ids: List[str] = []
watermark_blocked = False
last_agent_batch: Optional[ConsolidationAgentBatch] = None
offset = 0
batches_run = 0
recurrence_signals_by_id: Dict[str, CanonicalRecurrenceSignal] = {}
while offset < len(pending) and batches_run < max_batches:
pending_batch = pending[offset : offset + batch_cap]
if not pending_batch:
break
context = gather_consolidation_candidates(uid, pending_batch, db_client=client)
agent_batch = invoke_consolidation_agent(context, llm_invoke=llm_invoke)
last_agent_batch = agent_batch
pending_by_id = {item.memory_id: item for item in pending_batch}
if _agent_batch_blocks_watermark(agent_batch):
watermark_blocked = True
break
for signal in agent_batch.recurrence_signals:
recurrence_signals_by_id[signal.stable_loop_key] = signal
if recurrence_signal_sink is not None and agent_batch.recurrence_signals:
try:
recurrence_signal_sink(
uid,
agent_batch.recurrence_signals,
firestore_client=client,
)
except Exception as exc:
watermark_blocked = True
logger.warning(
'consolidation_recurrence_handoff_blocked uid=%s reason=%s',
uid,
type(exc).__name__,
)
break
for decision in agent_batch.decisions:
if decision.decision == "review" or decision.review_required:
survivor = pending_by_id.get(decision.survivor_memory_id)
if survivor is not None:
_escalate_to_review_queue(uid, decision=decision, survivor=survivor, db_client=client)
report.review_escalations += 1
continue
control = _read_control_state(uid, db_client=client)
try:
applied_ids = apply_consolidation_decision(
uid,
decision=decision,
pending_by_id=pending_by_id,
control=control,
run_id=run_id,
now=current_time,
db_client=client,
)
except ConsolidationPartialApply as exc:
report.decisions_partial += 1
watermark_blocked = True
logger.warning(
"consolidation_decision_partial uid=%s survivor=%s reason=%s",
uid,
sanitize_pii(decision.survivor_memory_id),
sanitize_pii(str(exc)),
)
break
except (ConsolidationApplySkipped, MissingMemoryDocument) as exc:
report.decisions_skipped += 1
logger.warning(
"consolidation_decision_skipped uid=%s survivor=%s reason=%s",
uid,
sanitize_pii(decision.survivor_memory_id),
sanitize_pii(str(exc)),
)
continue
if applied_ids:
report.decisions_applied += 1
for memory_id in applied_ids:
if memory_id in decision.supersedes:
report.superseded_memory_ids.append(memory_id)
if watermark_blocked:
break
batched_ids.extend(item.memory_id for item in pending_batch)
offset += batch_cap
batches_run += 1
report.batched_memory_ids = list(dict.fromkeys(batched_ids))
report.watermark_blocked = watermark_blocked
report.recurrence_signals = list(recurrence_signals_by_id.values())
# Skipped hallucinated refs still advance when no partial/parse failure: agent output was usable;
# retrying the same batch would reproduce the same bad decision. parse_failed and partial apply block.
if last_agent_batch is not None and _should_advance_consolidation_watermark(
last_agent_batch, watermark_blocked=watermark_blocked
):
updated_control = _read_control_state(uid, db_client=client).model_copy(
update={"last_consolidation_run_at": current_time, "updated_at": current_time}
)
_persist_control_state(updated_control, db_client=client)
report.last_consolidation_run_at = current_time
else:
report.last_consolidation_run_at = control.last_consolidation_run_at
return report