Skip to main content

Contract-driven memory for AI agents โ€” typed schemas, explicit conflict policies, structured provenance, typed event timeline.

Project description

TypedMemory

Contract-driven memory for AI agents. Typed schemas. Explicit conflict policies. Structured provenance. Typed event timeline.

CI PyPI Python License: MIT

๐Ÿ“ฆ PyPI ยท ๐Ÿ“š Docs ยท ๐Ÿท๏ธ Releases ยท ๐Ÿ“ Changelog

TL;DR

Memory you can contract against. Four explicit contracts make TypedMemory:

  • DomainProfile โ€” typed schema; invalid writes are rejected, not "learned"
  • ConflictPolicy โ€” declarative behaviour on slot collision (REPLACE / SUPERSEDE / REINFORCE / FLAG / KEEP_BOTH / IGNORE)
  • Source โ€” structured provenance with (document_id, chunk_id, span) dedup identity
  • MemoryEvent โ€” first-class typed change feed (history / timeline / changed_since)

Built for domain apps where "the memory accepted nonsense" is a correctness bug.

The problem

AI agents start believing their own hallucinations. They:

  • contradict themselves silently โ€” the last write wins, the conflict disappears
  • overwrite past decisions with no audit trail โ€” you can't debug what you can't see
  • never resolve goals โ€” yesterday's "I'll do X" looks identical to today's "I did X"

TypedMemory makes that visible.

The contradiction-detection moment

$ pip install typedmem

$ typedmem --profile engineering_design add \
    "SQLite handles our single-writer load fine" --type risk --subject storage
$ typedmem --profile engineering_design add \
    "SQLite blocks under concurrent writes"     --type risk --subject storage

$ typedmem --profile engineering_design contradictions

1 contradiction cluster(s):

cluster 1 (2 memories):
  [risk] [storage] SQLite handles our load fine
  [risk] [storage] SQLite blocks under concurrent writes

Two memories cross-linked by the FLAG policy. Both still in the store โ€” no silent overwrite. Run typedmem history <id> on either to see exactly when and why the state changed.

5 lines for an agent

from typedmem import AgentMemory

mem = AgentMemory(profile="personal", path="agent.db")

mem.remember("User wants to learn Rust by year end")
mem.remember("User lives in Tokyo")

hits = mem.recall("what is the user trying to learn?")
#   โ†’ [ScoredMemory(content="User wants to learn Rust...", score=0.78)]

report = mem.reflect()
#   โ†’ AgentMemoryReflection(contradictions=[], drift_records=[], ...)

Four verbs over the whole pipeline: remember (extract + store), recall (semantic retrieval), reflect (run the evolver pipeline), forget (explicit delete).

More demos: examples/DEMO.md for the 30-second no-flags paste ยท examples/agent_loop_demo.py for the before-vs-after agent story.

Before vs After

Without TypedMemory With TypedMemory
Agent changes its mind Last write silently overwrites REPLACE policy + PreferenceDriftDetector flag instability; the change is recorded in the event log
Two facts contradict One overwrites the other; you'll never know FLAG cross-links both; typedmem contradictions surfaces the cluster
A decision gets revised Old decision lost SUPERSEDE keeps the audit trail (old.superseded_by โ†’ new.id); typedmem history shows the lifecycle
"How did the agent's view evolve?" You've lost it store.timeline(subject="storage_backend") returns every change with source, reason, and timestamp
Goals accumulate They sit there forever, mixing with current intent GoalResolver matches incoming events to active goals and flips them to resolved
Same fact arrives from 3 sources 3 duplicate memories REINFORCE merges into one, unions sources by (document_id, chunk_id, span), boosts confidence
Stale events pile up Search noise grows SummaryEvolver condenses non-destructively; originals link forward via metadata["summarizes"]

The four contracts

Most memory systems are learned โ€” they consolidate, refine, and optimize for retrieval recall. TypedMemory is contracted โ€” every state change is governed by rules you declare up front.

  • Schema is a contract. DomainProfile + TypeSpec declare which memory types exist, what fields they require, and what tags they allow. Writes that don't match are rejected (HTTP 422 from the server). The system does not "learn around" your schema.
  • Behaviour is a contract. Each type declares a ConflictPolicy โ€” what should happen when a new memory hits the same (workspace, type, subject) slot. REPLACE overwrites and logs. SUPERSEDE keeps both with a forward link. REINFORCE merges sources and bumps confidence. FLAG cross-links contradictions instead of silently picking a winner. Policies are declarative, deterministic, and yours.
  • Provenance is a contract. Every memory carries Source(document_id, chunk_id, span, authority) โ€” not optional metadata, but the dedup identity used by REINFORCE. Three sources backing the same fact merge into one memory with three sources, not three duplicates.
  • Evolution is a contract. Every successful add / update / delete / conflict / evolver action emits a typed MemoryEvent to an indexed log. store.history(id) answers "how did this memory change?". store.timeline(subject=โ€ฆ, source=โ€ฆ) filters across the log. store.changed_since(t) is the canonical change feed for sync consumers.

The agent's beliefs are auditable because the contracts are explicit. The whole point: when the memory got something wrong, you can prove what changed, when, why, and who did it.

What TypedMemory is not

TypedMemory is intentionally narrow:

  • Not a general-purpose retrieval engine. We don't compete on benchmark recall. If retrieval quality is your bottleneck, you're in the wrong place.
  • Not a hosted memory cloud. The v0.7 server is BYO-deploy: Cloud Run, Docker, systemd โ€” your hosting choice.
  • Not a plug-and-play layer for agent frameworks. We don't ship LangChain / CrewAI / AutoGen adapters. The wire format is REST + JSON; bring your own integration.
  • Not a "memory that learns" black box. No implicit consolidation, no learned dedup, no opaque merging. Every state change goes through a ConflictPolicy you declared.

If those omissions sound like features to you, you're the audience.

Use cases

Primary:

  • Debugging hallucinating agents. When an agent flips its story, run typedmem history <id> and see every state change with reason, timestamp, and previous content. Contradictions surface via mem.reflect() instead of disappearing under the next write.
  • Long-term agent memory โ€” preferences, goals, drift. mem.remember() captures each session's signal. mem.recall() lets the next session see the current state. mem.reflect() catches preferences that keep flipping and goals that match recent events.

Also good for:

  • Multi-document research / RAG with structured provenance โ€” Source(document_id, chunk_id, span, authority) per memory; REINFORCE merges duplicates across papers
  • Design-doc agents โ€” decisions SUPERSEDE rather than overwriting; full audit trail
  • Multi-tenant agents (legal + medical + customer-success on one machine) โ€” workspace isolates each domain

How it works

                              โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
                              โ”‚  DomainProfile   โ”‚  โ† schema: which types,
                              โ”‚  TypeSpec ร— N    โ”‚     which policies,
                              โ”‚  prompt + rules  โ”‚     which validations
                              โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜
                                       โ”‚
       text โ”€โ”€โ–บ Extractor โ”€โ”€โ–บ Memory โ”€โ”€โ”ดโ”€โ”€โ–บ MemoryStore โ”€โ”€โ–บ Retriever
                                            โ”‚
                                            โ–ผ
                                         Evolver
                              (contradictions, drift, goals,
                               non-destructive summarization)

Every memory has a type (claim, decision, observation, โ€ฆ), a confidence, a structured source, a lifecycle policy, and a workspace โ€” not a string in a vector database. Memories know how to update themselves on conflict, how to decay over time, and how to be summarized.

Zero runtime dependencies. Stdlib only. LLM clients, YAML profile loading, and richer embedders are optional extras.

Why this exists

Most "AI memory" libraries are wrappers around a vector database. That works for "remember what the user said," but it falls apart the moment you want an agent to:

  • track who said what, in which document, at which span (provenance)
  • handle the same fact from three sources without storing it three times (reinforcement)
  • recognize that a new decision supersedes the old one without losing the audit trail
  • summarize stale events without throwing away the originals
  • isolate legal memory from medical memory on the same machine
  • flag contradictions instead of silently overwriting them

TypedMemory handles these as first-class concepts, not bolt-ons.

Install

pip install typedmem                       # default install, zero deps
pip install 'typedmem[anthropic]'          # + AnthropicClient
pip install 'typedmem[openai]'             # + OpenAIClient
pip install 'typedmem[yaml]'               # + DomainProfile.from_yaml()
pip install 'typedmem[server]'             # + HTTP server (FastAPI + uvicorn)
pip install 'typedmem[gcp]'                # + Cloud Run / Google ID-token auth
pip install 'typedmem[all]'

Python 3.10+.

Run as a service (v0.7+)

Not a Python project? Use typedmem over HTTP:

pip install 'typedmem[server]'
typedmem --store agent.db serve --api-token $(openssl rand -hex 32)

REST API under /v1/, interactive docs at /docs. Same surface as the Python library โ€” add, get, delete, list, recall, history, timeline, changed-since, reflect. Works on Cloud Run + GCS FUSE, plain Docker, or systemd. Full deploy guide: docs/server.md.

60-second demo: an engineering design agent

import json
from typedmem import (
    DomainProfile, FakeClient, LLMExtractor, SQLiteMemoryStore,
)

profile = DomainProfile.builtin("engineering_design")
store = SQLiteMemoryStore.for_profile(profile, "design.db")

# Pretend the LLM extracted these from your design docs.
extractor = LLMExtractor(client=FakeClient([
    json.dumps([
        {"type": "decision", "content": "Use SQLite for storage",
         "subject": "storage_backend", "confidence": 0.9,
         "source": {"document_id": "design_v1.md"}},
        {"type": "risk", "content": "SQLite is single-writer",
         "subject": "storage_backend", "confidence": 0.8,
         "source": {"document_id": "design_v1.md"}},
    ]),
    json.dumps([
        {"type": "decision", "content": "Switch to PostgreSQL for concurrent writes",
         "subject": "storage_backend", "confidence": 0.9,
         "source": {"document_id": "design_v2.md"}},
        {"type": "risk", "content": "Postgres adds an external service",
         "subject": "storage_backend", "confidence": 0.85,
         "source": {"document_id": "design_v2.md"}},
    ]),
]), profile=profile)

for snippet in ("v1 text", "v2 text"):
    for m in extractor.extract(snippet):
        store.add(m)

# decision โ†’ SUPERSEDE: old preserved, new active.
print(store.by_type("decision"))                       # โ†’ just PostgreSQL
print(store.by_type("decision", include_superseded=True))  # โ†’ both

# risk โ†’ FLAG: two risks on the same subject get cross-linked.
for cluster in store.contradictions():
    for m in cluster:
        print(m.content)                                # โ†’ both risks

See examples/engineering_design_demo.py for the full version with audit trail and source provenance, or run:

typedmem profiles
typedmem --profile engineering_design add "..." --document-id design_v3.md
typedmem --profile engineering_design list --type decision
typedmem evolve --evolver contradictions

The mental model

Layer What it gives you Examples
Memory Typed object with content + confidence + workspace + sources + status Memory(type="claim", content=..., sources=[Source(...)])
Source Structured provenance with hashable identity (document_id, chunk_id, span) โ€” dedup key for REINFORCE
workspace Namespace on every memory One agent, multiple corpora, zero cross-contamination
ConflictPolicy What to do when a new memory hits the same (workspace, type, subject) slot REPLACE ยท KEEP_BOTH ยท SUPERSEDE ยท REINFORCE ยท FLAG ยท IGNORE
DomainProfile Schema for a domain: which types, what policy each obeys, what's required engineering_design ยท research_paper ยท legal ยท medical_literature ยท personal ยท โ€ฆ
Evolver Reads memories (not text); produces audit-trailed actions ContradictionSurfacer ยท PreferenceDriftDetector ยท GoalResolver ยท SummaryEvolver

Built-in profiles

Profile Types Notable policies
core fact, note, goal, task, event Shared primitives all other profiles can opt into
personal + preference, observation preference โ†’ REPLACE (60d decay)
child_development + observation (tagged), milestone, concern observation tags: language/motor/emotional/cognitive/social
research_paper + claim, method, evidence, limitation, open_question evidence โ†’ REINFORCE (multiple papers corroborate)
engineering_design + decision, constraint, risk, assumption, todo decision โ†’ SUPERSEDE, risk โ†’ FLAG
legal + obligation, exception, deadline, definition, citation definition โ†’ SUPERSEDE
medical_literature + finding, population, intervention, outcome, limitation outcome โ†’ REINFORCE across studies

Custom profiles via Python dataclass, JSON, or YAML.

Storage

Three backends, one ABC:

Store Persistence Notes
InMemoryStore None Default; fastest
JSONLMemoryStore Append-only file Last-write-wins; tombstones; compact() rewrites
SQLiteMemoryStore SQLite file Indexed on (workspace, type, subject); persists embeddings; v0.6 adds a memory_events table (timeline); schema auto-migrates from v0.2+
from typedmem import SQLiteMemoryStore, DomainProfile

store = SQLiteMemoryStore.for_profile(
    DomainProfile.builtin("research_paper"),
    path="papers.db",
)

Retrieval

from typedmem import HashingEmbeddingProvider, Retriever

retriever = Retriever(store, embedder=HashingEmbeddingProvider())
hits = retriever.relevant(
    "blood pressure reduction",
    types=["evidence"],
    workspace="cardiology",
)

relevant() blends three signals: semantic (cosine), recency (exponential decay), confidence (with type-specific half-life). Without an embedder, falls back to token overlap.

Timeline (v0.6)

Retrieval answers "what's true now?". The timeline answers "how did we get here?". Every successful add / update / delete / conflict-resolution / evolver action emits a typed MemoryEvent into an indexed event log.

from datetime import datetime, timedelta, timezone

mem.remember("User prefers dark mode")
mem.remember("Actually, light mode in the morning")

# Everything that ever touched this memory:
mid = mem.recall("color theme")[0].memory.id
for e in mem.store.history(mid):
    print(f"{e.timestamp:%H:%M:%S}  {e.source}/{e.source_name}  {e.action}")
#   23:58:32  agent/AgentMemory.remember  added
#   23:58:33  agent/AgentMemory.remember  replaced

# Or filter by subject / type / workspace / source:
mem.store.timeline(subject="storage_backend", source="evolver")

# Or pull the canonical change feed since a point in time
# (for sync, replication, downstream notification):
since = datetime.now(timezone.utc) - timedelta(minutes=10)
for e in mem.store.changed_since(since):
    ship_to_downstream(e)

Each event carries memory_id, workspace, type, subject, action, source (one of "store" / "evolver" / "agent" / "user" / "system"), source_name, reason, input_ids, output_ids, payload, timestamp. Delete events outlive the memory row โ€” changed_since() surfaces deletions to consumers staying in sync.

Evolution

Evolvers read stored memories and produce auditable actions.

from typedmem import (
    ContradictionSurfacer, PreferenceDriftDetector,
    GoalResolver, SummaryEvolver,
    HashingEmbeddingProvider, AnthropicClient,
)

# 1. Pure read: walk the FLAG graph.
for cluster in store.contradictions():
    print(f"{len(cluster)} memories cross-link as contradictions")

# 2. Annotation: catch unstable preferences.
PreferenceDriftDetector(min_replaces=3, window_days=30).evolve(store)

# 3. Safe match: dry-run first, then commit.
embedder = HashingEmbeddingProvider()
plan = GoalResolver(embedder, threshold=0.85).evolve(store, dry_run=True)
print(plan.summary())
GoalResolver(embedder, threshold=0.85).evolve(store)            # commit

# 4. Non-destructive summary of stale events.
SummaryEvolver(AnthropicClient(), min_cluster_size=3).evolve(store)
# Originals untouched; new memory links via metadata["summarizes"].

Every action emits a typed MemoryEvent into the store's indexed event log โ€” source="evolver", source_name="goal_resolver" (etc.), plus action, input_ids, output_ids, reason, timestamp. Query with store.history(memory_id), store.timeline(subject=..., source="evolver"), or store.changed_since(t). No black-box mutations, no metadata["evolution_history"] cap to worry about.

CLI

typedmem profiles                                            # list built-in domain profiles
typedmem --profile research_paper add "..." --document-id paper.pdf
typedmem --profile engineering_design list --type decision
typedmem search "blood pressure" --type evidence
typedmem evolve --evolver contradictions
typedmem evolve --evolver goals --apply --threshold 0.9      # dry-run by default
typedmem history MEMORY_ID                                   # per-memory event timeline
typedmem timeline --subject storage_backend --source evolver # filter the event log
typedmem changed-since 1h                                    # canonical change feed (also: 5m, 2h, 1d, 1w, or ISO 8601)
typedmem workspaces

CLI writes (add / delete) are tagged source="user" in the event log, so typedmem timeline --source user shows exactly what a human did at the terminal vs. what an agent or evolver did.

Default store: ~/.typedmem/memories.db (override with --store path.db or --store path.jsonl).

Status & roadmap

Latest: v0.6.0 โ€” typed memory timeline (this release): every change emits a MemoryEvent; store.history() / timeline() / changed_since() give you the canonical change feed.

Prior: v0.5.0 โ€” AgentMemory four-verb contract (remember / recall / reflect / forget); v0.4.x โ€” profiles, workspaces, evolvers, conflict-resolution audit trail.

Under consideration for v0.7+, only if real usage demands it:

  • VersionPolicy as a separate per-type axis (deferred from v0.6 โ€” overlapped messily with ConflictPolicy)
  • Sync / replication engine on top of changed_since()
  • Hybrid BM25 + semantic retrieval
  • Sentence-transformer embedder

What TypedMemory doesn't do and doesn't plan to:

  • ship document chunkers / loaders โ€” define the ingest() seam, bring your own (unstructured, langchain, plain regex)
  • ship its own vector DB โ€” the abstraction is ready for one, but brute-force cosine wins under ~50k memories
  • pull network dependencies into the default install โ€” every provider is an opt-in extra

License

MIT โ€” see LICENSE.

Contributing

Issues and PRs welcome. Please run pytest and the demos in examples/ before opening a PR; CI runs them on Python 3.10/3.11/3.12.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

typedmem-0.7.4.tar.gz (93.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

typedmem-0.7.4-py3-none-any.whl (76.5 kB view details)

Uploaded Python 3

File details

Details for the file typedmem-0.7.4.tar.gz.

File metadata

  • Download URL: typedmem-0.7.4.tar.gz
  • Upload date:
  • Size: 93.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for typedmem-0.7.4.tar.gz
Algorithm Hash digest
SHA256 45386a18d12fc97d6c68cbd58751ccae6703e60f5d2a7541813daaf9c44d74ad
MD5 f894ffe76ff94ce6a2aafef24f7f2970
BLAKE2b-256 ca2898e4c09b6fb6ce0b51515763707832e4d27430ec5bcbc0a3ff891611b090

See more details on using hashes here.

Provenance

The following attestation bundles were made for typedmem-0.7.4.tar.gz:

Publisher: release.yml on canis-minor/typedmem

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file typedmem-0.7.4-py3-none-any.whl.

File metadata

  • Download URL: typedmem-0.7.4-py3-none-any.whl
  • Upload date:
  • Size: 76.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for typedmem-0.7.4-py3-none-any.whl
Algorithm Hash digest
SHA256 ae455c3a257b45d1a47ed0dac612459404e0a6262d3ec14223e8765badffc682
MD5 eb891bcd6ba4e72910d121cc0bfe8b75
BLAKE2b-256 6a389d3fc2fca1bb6281cfff7a39f2a403f045dd5371efe21d6fb04bfd07fdb6

See more details on using hashes here.

Provenance

The following attestation bundles were made for typedmem-0.7.4-py3-none-any.whl:

Publisher: release.yml on canis-minor/typedmem

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page