forked from BasedHardware/omi
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathmemory_promotion.py
More file actions
616 lines (559 loc) · 23.5 KB
/
Copy pathmemory_promotion.py
File metadata and controls
616 lines (559 loc) · 23.5 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
"""Server-owned canonical promotion and graph-admission contracts.
Long-term memory is a state transition, never a create-time option. The
promotion planner may propose a compact structured graph plan, but deterministic
code binds that plan to the current short-term item revision, content, and
evidence before the authoritative apply transaction accepts it.
"""
from __future__ import annotations
import json
import math
from datetime import datetime
from typing import Any, Dict, List, Literal, cast
from pydantic import AwareDatetime, BaseModel, Field, field_validator, model_validator
from models.memory_contracts import deterministic_contract_id
PROMOTION_ADMISSION_VERSION = "canonical_memory_promotion_admission.v1"
PROMOTION_GRAPH_PLAN_VERSION = "canonical_memory_graph_plan.v1"
PROMOTION_GRAPH_PLAN_V2_VERSION = "canonical_memory_graph_plan.v2"
PROMOTION_GRAPH_ASSERTION_VERSION = "canonical_memory_graph_assertion.v1"
PROMOTION_GRAPH_ASSERTION_V2_VERSION = "canonical_memory_graph_assertion.v2"
PROMOTION_PLANNER_ID = "canonical_batched_promotion"
PROMOTION_PLANNER_VERSION = "v2"
PROMOTION_GRAPH_SUBJECT_MAX_LENGTH = 200
PROMOTION_GRAPH_PREDICATE_MAX_LENGTH = 64
PROMOTION_GRAPH_ARGUMENT_MAX_COUNT = 16
PROMOTION_GRAPH_ARGUMENT_KEY_MAX_LENGTH = 64
PROMOTION_GRAPH_ARGUMENTS_MAX_JSON_BYTES = 8 * 1024
PROMOTION_GRAPH_ARGUMENTS_MAX_DEPTH = 8
CanonicalGraphNodeType = Literal["person", "place", "organization", "thing", "concept"]
def canonical_graph_entity_id(label: str) -> str:
"""Return the stable graph endpoint id for a readable entity label."""
normalized = " ".join((label or "").split()).casefold()
if not normalized:
raise ValueError("canonical graph entity label must not be blank")
if normalized == "user":
return "user"
if normalized.startswith("ent_"):
return normalized
return "ent_" + deterministic_contract_id("canonical-graph-entity", {"label": normalized})[:20]
def _normalized_arguments(arguments: Dict[str, Any]) -> Dict[str, Any]:
normalized: Dict[str, Any] = {}
for key, value in sorted(arguments.items()):
normalized_key = key.strip()
if not normalized_key:
raise ValueError("promotion graph argument keys must not be blank")
if normalized_key in normalized:
raise ValueError("promotion graph argument keys must be unique after trimming")
normalized[normalized_key] = value
return normalized
def _validate_json_value(value: Any, *, depth: int, ancestors: set[int]) -> None:
if value is None or isinstance(value, (str, bool, int)):
return
if isinstance(value, float):
if not math.isfinite(value):
raise ValueError("promotion graph argument numbers must be finite JSON numbers")
return
if not isinstance(value, (list, dict)):
raise ValueError(
"promotion graph arguments must contain only JSON values "
"(null, boolean, number, string, array, or object)"
)
if depth > PROMOTION_GRAPH_ARGUMENTS_MAX_DEPTH:
raise ValueError(
f"promotion graph arguments exceed maximum JSON nesting depth " f"of {PROMOTION_GRAPH_ARGUMENTS_MAX_DEPTH}"
)
container = cast(list[Any] | Dict[Any, Any], value)
container_id = id(container)
if container_id in ancestors:
raise ValueError("promotion graph arguments must not contain cyclic containers")
ancestors.add(container_id)
try:
if isinstance(container, list):
for item in container:
_validate_json_value(item, depth=depth + 1, ancestors=ancestors)
return
for key, item in container.items():
if not isinstance(key, str):
raise ValueError("promotion graph argument object keys must be strings")
if len(key) > PROMOTION_GRAPH_ARGUMENT_KEY_MAX_LENGTH:
raise ValueError(
f"promotion graph argument keys must be at most "
f"{PROMOTION_GRAPH_ARGUMENT_KEY_MAX_LENGTH} characters"
)
_validate_json_value(item, depth=depth + 1, ancestors=ancestors)
finally:
ancestors.remove(container_id)
def _validate_and_normalize_arguments(value: Any, *, require_nonempty: bool = True) -> Dict[str, Any]:
if not isinstance(value, dict):
raise ValueError("promotion graph arguments must be a JSON object")
arguments = cast(Dict[str, Any], value)
if len(arguments) > PROMOTION_GRAPH_ARGUMENT_MAX_COUNT:
raise ValueError(f"promotion graph plan supports at most {PROMOTION_GRAPH_ARGUMENT_MAX_COUNT} arguments")
_validate_json_value(arguments, depth=0, ancestors=set())
normalized = _normalized_arguments(arguments)
if require_nonempty and not normalized:
raise ValueError("promotion graph plan requires at least one argument")
try:
payload_size = len(
json.dumps(
normalized,
sort_keys=True,
separators=(",", ":"),
ensure_ascii=True,
allow_nan=False,
).encode("utf-8")
)
except (OverflowError, RecursionError, TypeError, ValueError) as exc:
raise ValueError("promotion graph arguments must be encodable as canonical JSON") from exc
if payload_size > PROMOTION_GRAPH_ARGUMENTS_MAX_JSON_BYTES:
raise ValueError(
f"promotion graph arguments JSON payload must be at most "
f"{PROMOTION_GRAPH_ARGUMENTS_MAX_JSON_BYTES} bytes"
)
return normalized
class GraphRelationEndpoint(BaseModel):
"""A typed graph endpoint whose identity is derived from its source label."""
entity_id: str = ""
label: str
# This is the stable desktop graph vocabulary. Rejecting unknown model
# output here keeps a type change from silently degrading into a concept.
node_type: CanonicalGraphNodeType
@field_validator("label", "node_type")
@classmethod
def validate_nonblank(cls, value: str) -> str:
normalized = " ".join((value or "").split())
if not normalized:
raise ValueError("graph relation endpoint label and node_type must not be blank")
if len(normalized) > PROMOTION_GRAPH_SUBJECT_MAX_LENGTH:
raise ValueError("graph relation endpoint fields exceed the maximum length")
return normalized
@model_validator(mode="after")
def normalize_entity_id(self):
expected = canonical_graph_entity_id(self.label)
if self.entity_id and self.entity_id != expected:
raise ValueError("graph relation endpoint id must be derived from its label")
self.entity_id = expected
return self
class PromotionGraphPlan(BaseModel):
"""A non-empty graph assertion generated in the same L2 planning call."""
schema_version: Literal["canonical_memory_graph_plan.v1", "canonical_memory_graph_plan.v2"] = (
PROMOTION_GRAPH_PLAN_VERSION
)
subject_entity_id: str
predicate: str
arguments: Dict[str, Any] = Field(default_factory=dict)
subject: GraphRelationEndpoint | None = None
object: GraphRelationEndpoint | None = None
qualifiers: Dict[str, Any] = Field(default_factory=dict)
plan_hash: str = ""
@field_validator("subject_entity_id")
@classmethod
def validate_subject_entity_id(cls, value: str) -> str:
stripped = (value or "").strip()
if not stripped:
raise ValueError("promotion graph subject and predicate must not be blank")
if len(stripped) > PROMOTION_GRAPH_SUBJECT_MAX_LENGTH:
raise ValueError(
f"promotion graph subject_entity_id must be at most " f"{PROMOTION_GRAPH_SUBJECT_MAX_LENGTH} characters"
)
return stripped
@field_validator("predicate")
@classmethod
def validate_predicate(cls, value: str) -> str:
stripped = (value or "").strip()
if not stripped:
raise ValueError("promotion graph subject and predicate must not be blank")
if len(stripped) > PROMOTION_GRAPH_PREDICATE_MAX_LENGTH:
raise ValueError(
f"promotion graph predicate must be at most {PROMOTION_GRAPH_PREDICATE_MAX_LENGTH} characters"
)
return stripped
@field_validator("arguments", mode="before")
@classmethod
def validate_arguments(cls, value: Any) -> Dict[str, Any]:
return _validate_and_normalize_arguments(value, require_nonempty=False)
@field_validator("qualifiers", mode="before")
@classmethod
def validate_qualifiers(cls, value: Any) -> Dict[str, Any]:
return _validate_and_normalize_arguments(value, require_nonempty=False)
def hash_payload(self) -> Dict[str, Any]:
payload: Dict[str, Any] = {
"schema_version": self.schema_version,
"subject_entity_id": self.subject_entity_id,
"predicate": self.predicate,
"arguments": self.arguments,
}
if self.schema_version == PROMOTION_GRAPH_PLAN_V2_VERSION:
payload.update(
{
"subject": self.subject.model_dump(mode="json") if self.subject else None,
"object": self.object.model_dump(mode="json") if self.object else None,
"qualifiers": self.qualifiers,
}
)
return payload
@model_validator(mode="after")
def derive_or_validate_hash(self):
if self.schema_version == PROMOTION_GRAPH_PLAN_V2_VERSION:
if self.subject is None or self.object is None:
raise ValueError("v2 graph relation plans require typed subject and object endpoints")
if self.subject.entity_id != self.subject_entity_id:
raise ValueError("v2 graph relation subject must match subject_entity_id")
if self.subject.entity_id == self.object.entity_id:
raise ValueError("v2 graph relation plans must not contain self-loops")
if self.arguments and self.arguments != self.qualifiers:
raise ValueError("v2 graph relation arguments must match qualifiers")
self.arguments = self.qualifiers
elif not self.arguments:
raise ValueError("promotion graph plan requires at least one argument")
expected = deterministic_contract_id("canonical-promotion-graph-plan", self.hash_payload())
if self.plan_hash and self.plan_hash != expected:
raise ValueError("promotion graph plan hash mismatch")
self.plan_hash = expected
return self
class PromotionAdmissionReceipt(BaseModel):
"""Server-authored proof that one exact ST revision passed L2 admission."""
receipt_version: Literal["canonical_memory_promotion_admission.v1"] = PROMOTION_ADMISSION_VERSION
receipt_id: str = ""
planner_id: Literal["canonical_batched_promotion"] = PROMOTION_PLANNER_ID
planner_version: Literal["v2"] = PROMOTION_PLANNER_VERSION
decision: Literal["durable"] = "durable"
memory_id: str
source_item_revision: int
output_content_hash: str
evidence_ids: List[str]
graph_plan_hash: str
supersedes: List[str] = Field(default_factory=list)
@field_validator("memory_id", "output_content_hash", "graph_plan_hash")
@classmethod
def validate_nonblank(cls, value: str) -> str:
stripped = (value or "").strip()
if not stripped:
raise ValueError("promotion admission fields must not be blank")
return stripped
@field_validator("source_item_revision")
@classmethod
def validate_revision(cls, value: int) -> int:
if value < 1:
raise ValueError("source_item_revision must be positive")
return value
@field_validator("evidence_ids")
@classmethod
def validate_evidence(cls, value: List[str]) -> List[str]:
normalized = sorted({item.strip() for item in value if item and item.strip()})
if not normalized:
raise ValueError("promotion admission requires evidence")
return normalized
@field_validator("supersedes")
@classmethod
def normalize_supersedes(cls, value: List[str]) -> List[str]:
return sorted({item.strip() for item in value if item and item.strip()})
def identity_payload(self) -> Dict[str, Any]:
return {
"receipt_version": self.receipt_version,
"planner_id": self.planner_id,
"planner_version": self.planner_version,
"decision": self.decision,
"memory_id": self.memory_id,
"source_item_revision": self.source_item_revision,
"output_content_hash": self.output_content_hash,
"evidence_ids": self.evidence_ids,
"graph_plan_hash": self.graph_plan_hash,
"supersedes": self.supersedes,
}
@model_validator(mode="after")
def derive_or_validate_id(self):
expected = (
"padm_"
+ deterministic_contract_id(
"canonical-promotion-admission",
self.identity_payload(),
)[:32]
)
if self.receipt_id and self.receipt_id != expected:
raise ValueError("promotion admission receipt id mismatch")
self.receipt_id = expected
return self
class MemoryGraphAssertion(BaseModel):
"""Atomic, authoritative per-memory KG assertion.
Shared entity/edge indexes are projections of this document. Keeping the
assertion next to the memory commit means an active Long-term item can never
exist without a version-fenced graph representation.
"""
schema_version: Literal["canonical_memory_graph_assertion.v1", "canonical_memory_graph_assertion.v2"] = (
PROMOTION_GRAPH_ASSERTION_VERSION
)
assertion_id: str
uid: str
memory_id: str
item_revision: int
content_hash: str
evidence_ids: List[str]
subject_entity_id: str
predicate: str
arguments: Dict[str, Any]
subject: GraphRelationEndpoint | None = None
object: GraphRelationEndpoint | None = None
qualifiers: Dict[str, Any] = Field(default_factory=dict)
graph_plan_hash: str
commit_id: str
commit_sequence: int
status: Literal["active"] = "active"
created_at: AwareDatetime
@field_validator(
"assertion_id",
"uid",
"memory_id",
"content_hash",
"subject_entity_id",
"predicate",
"graph_plan_hash",
"commit_id",
)
@classmethod
def validate_nonblank(cls, value: str) -> str:
stripped = (value or "").strip()
if not stripped:
raise ValueError("graph assertion fields must not be blank")
return stripped
@field_validator("item_revision", "commit_sequence")
@classmethod
def validate_positive(cls, value: int) -> int:
if value < 1:
raise ValueError("graph assertion counters must be positive")
return value
@field_validator("evidence_ids")
@classmethod
def validate_evidence(cls, value: List[str]) -> List[str]:
normalized = sorted({item.strip() for item in value if item and item.strip()})
if not normalized:
raise ValueError("graph assertion requires evidence")
return normalized
@model_validator(mode="after")
def validate_plan_hash(self):
plan = PromotionGraphPlan(
schema_version=(
PROMOTION_GRAPH_PLAN_V2_VERSION
if self.schema_version == PROMOTION_GRAPH_ASSERTION_V2_VERSION
else PROMOTION_GRAPH_PLAN_VERSION
),
subject_entity_id=self.subject_entity_id,
predicate=self.predicate,
arguments=self.arguments,
subject=self.subject,
object=self.object,
qualifiers=self.qualifiers,
plan_hash=self.graph_plan_hash,
)
self.arguments = plan.arguments
self.subject = plan.subject
self.object = plan.object
self.qualifiers = plan.qualifiers
return self
def graph_records(self) -> Dict[str, List[Dict[str, Any]]]:
"""Derive stable graph nodes/edges without another model call."""
if self.schema_version == PROMOTION_GRAPH_ASSERTION_V2_VERSION:
assert self.subject is not None and self.object is not None
nodes = {
self.subject.entity_id: {
"id": self.subject.entity_id,
"label": self.subject.label,
"node_type": self.subject.node_type,
"aliases": [],
"memory_ids": [self.memory_id],
},
self.object.entity_id: {
"id": self.object.entity_id,
"label": self.object.label,
"node_type": self.object.node_type,
"aliases": [],
"memory_ids": [self.memory_id],
},
}
return {
"nodes": list(nodes.values()),
"edges": [
{
"id": "edge_"
+ deterministic_contract_id(
"canonical-graph-edge",
{
"source_id": self.subject.entity_id,
"target_id": self.object.entity_id,
"label": self.predicate,
},
)[:24],
"source_id": self.subject.entity_id,
"target_id": self.object.entity_id,
"label": self.predicate,
"memory_ids": [self.memory_id],
}
],
}
nodes: Dict[str, Dict[str, Any]] = {
self.subject_entity_id: {
"id": self.subject_entity_id,
"label": self.subject_entity_id,
"node_type": "entity",
"aliases": [],
"memory_ids": [self.memory_id],
}
}
edges: List[Dict[str, Any]] = []
for slot, raw_value in self.arguments.items():
if isinstance(raw_value, dict):
object_value = cast(Dict[str, Any], raw_value)
label = str(
object_value.get("label") or object_value.get("value") or object_value.get("entity_id") or slot
)
target_id = str(object_value.get("entity_id") or canonical_graph_entity_id(label))
else:
label = str(raw_value)
target_id = canonical_graph_entity_id(label)
nodes.setdefault(
target_id,
{
"id": target_id,
"label": label,
"node_type": "entity",
"aliases": [],
"memory_ids": [self.memory_id],
},
)
edge_label = self.predicate if len(self.arguments) == 1 else f"{self.predicate}:{slot}"
edges.append(
{
"id": "edge_"
+ deterministic_contract_id(
"canonical-graph-edge",
{
"source_id": self.subject_entity_id,
"target_id": target_id,
"label": edge_label,
},
)[:24],
"source_id": self.subject_entity_id,
"target_id": target_id,
"label": edge_label,
"memory_ids": [self.memory_id],
}
)
return {"nodes": list(nodes.values()), "edges": edges}
def build_promotion_admission_receipt(
*,
memory_id: str,
source_item_revision: int,
output_content_hash: str,
evidence_ids: List[str],
graph_plan: PromotionGraphPlan,
supersedes: List[str],
) -> PromotionAdmissionReceipt:
return PromotionAdmissionReceipt(
memory_id=memory_id,
source_item_revision=source_item_revision,
output_content_hash=output_content_hash,
evidence_ids=evidence_ids,
graph_plan_hash=graph_plan.plan_hash,
supersedes=supersedes,
)
def build_memory_graph_assertion(
*,
uid: str,
memory_id: str,
item_revision: int,
content_hash: str,
evidence_ids: List[str],
graph_plan: PromotionGraphPlan,
commit_id: str,
commit_sequence: int,
created_at: datetime,
) -> MemoryGraphAssertion:
assertion_id = (
"mga_"
+ deterministic_contract_id(
"canonical-memory-graph-assertion",
{
"uid": uid,
"memory_id": memory_id,
"item_revision": item_revision,
"content_hash": content_hash,
"graph_plan_hash": graph_plan.plan_hash,
},
)[:32]
)
return MemoryGraphAssertion(
schema_version=(
PROMOTION_GRAPH_ASSERTION_V2_VERSION
if graph_plan.schema_version == PROMOTION_GRAPH_PLAN_V2_VERSION
else PROMOTION_GRAPH_ASSERTION_VERSION
),
assertion_id=assertion_id,
uid=uid,
memory_id=memory_id,
item_revision=item_revision,
content_hash=content_hash,
evidence_ids=sorted(set(evidence_ids)),
subject_entity_id=graph_plan.subject_entity_id,
predicate=graph_plan.predicate,
arguments=graph_plan.arguments,
subject=graph_plan.subject,
object=graph_plan.object,
qualifiers=graph_plan.qualifiers,
graph_plan_hash=graph_plan.plan_hash,
commit_id=commit_id,
commit_sequence=commit_sequence,
created_at=created_at,
)
def valid_promotion_admission(
*,
memory_id: str,
source_item_revision: int,
output_content_hash: str,
evidence_ids: List[str],
subject_entity_id: str | None,
predicate: str | None,
arguments: Dict[str, Any],
supersedes: List[str],
promotion: Dict[str, Any],
) -> bool:
"""Validate the complete server-authored promotion proof for an ST item."""
try:
graph_plan = PromotionGraphPlan(**promotion["graph_plan"])
receipt = PromotionAdmissionReceipt(**promotion["admission_receipt"])
normalized_arguments = _validate_and_normalize_arguments(arguments)
except (KeyError, TypeError, ValueError):
return False
return (
receipt.memory_id == memory_id
and receipt.source_item_revision == source_item_revision
and receipt.output_content_hash == output_content_hash
and receipt.evidence_ids == sorted(set(evidence_ids))
and receipt.graph_plan_hash == graph_plan.plan_hash
and graph_plan.subject_entity_id == (subject_entity_id or "")
and graph_plan.predicate == (predicate or "")
and graph_plan.arguments == normalized_arguments
and receipt.supersedes == sorted(set(supersedes))
and memory_id not in receipt.supersedes
)
__all__ = [
"MemoryGraphAssertion",
"CanonicalGraphNodeType",
"PROMOTION_ADMISSION_VERSION",
"PROMOTION_GRAPH_ASSERTION_VERSION",
"PROMOTION_GRAPH_ASSERTION_V2_VERSION",
"PROMOTION_GRAPH_ARGUMENT_KEY_MAX_LENGTH",
"PROMOTION_GRAPH_ARGUMENT_MAX_COUNT",
"PROMOTION_GRAPH_ARGUMENTS_MAX_DEPTH",
"PROMOTION_GRAPH_ARGUMENTS_MAX_JSON_BYTES",
"PROMOTION_GRAPH_PLAN_VERSION",
"PROMOTION_GRAPH_PLAN_V2_VERSION",
"PROMOTION_GRAPH_PREDICATE_MAX_LENGTH",
"PROMOTION_GRAPH_SUBJECT_MAX_LENGTH",
"PROMOTION_PLANNER_ID",
"PROMOTION_PLANNER_VERSION",
"PromotionAdmissionReceipt",
"GraphRelationEndpoint",
"PromotionGraphPlan",
"build_memory_graph_assertion",
"build_promotion_admission_receipt",
"valid_promotion_admission",
]