Skip to main content

Long-term memory tier for AI agents backed by Valkey Search: semantic recall with recency/importance ranking, scoped capacity eviction, and consolidation. Pairs with @betterdb/agent-cache.

Project description

@betterdb/agent-memory (Python)

betterdb-agent-memory is the long-term memory tier for AI agents, backed by Valkey Search. It is the Python port of @betterdb/agent-memory and pairs with betterdb-agent-cache (the short-term llm/tool/session cache tiers).

Where the cache tiers are exact-match and ephemeral, the memory tier is semantic and durable: it embeds content, stores it in an HNSW vector index, and recalls it by meaning with a composite score that blends similarity, recency (half-life decay), and importance.

Features

  • Semantic recall — KNN vector search with a tunable composite score.
  • Scoping — memories carry thread_id / agent_id / namespace / tags; recall, forget, and consolidation all filter by scope.
  • Reinforcement — recalled memories bump last_accessed_at + access_count, so frequently-used memories stay recallable.
  • Capacity evictionmax_items_per_scope evicts the lowest-scoring memories (importance + recency) once a scope exceeds its cap.
  • Consolidation — fold a set of older/low-importance memories into a single summary memory.
  • Live config — re-read recall.threshold / weights / halfLifeSeconds / maxItemsPerScope from a Valkey hash without a restart.
  • Observability — OpenTelemetry spans + Prometheus metrics.
  • Discovery — registers a marker so BetterDB Monitor can enumerate the tier.

Installation

pip install betterdb-agent-memory

You also need a Valkey server with the Search module loaded (e.g. valkey/valkey-bundle) and the valkey async client.

Quick start

import valkey.asyncio as valkey
from betterdb_agent_memory import AgentMemory, AgentMemoryOptions

async def embed(text: str) -> list[float]:
    # Replace with a real embedding model (OpenAI, sentence-transformers, ...).
    ...

async def main() -> None:
    client = valkey.Valkey(host="localhost", port=6379)
    agent = AgentMemory(AgentMemoryOptions(client=client, embed_fn=embed))
    await agent.initialize()

    await agent.memory.remember(
        "User prefers dark mode and concise answers.",
        importance=0.8,
        tags=["preference", "ui"],
        thread_id="t1",
    )

    hits = await agent.memory.recall("what UI settings does the user like?", thread_id="t1")
    for hit in hits:
        print(hit.score, hit.item.content)

    # Short-term cache tiers remain available:
    # agent.llm, agent.tool, agent.session

    await agent.close()

Using the memory tier standalone

If you only need the memory tier, construct MemoryStore directly:

from betterdb_agent_memory import MemoryStore

store = MemoryStore(client=client, name="myapp", embed_fn=embed)
await store.ensure_index()
await store.remember("hello", thread_id="t1")
hits = await store.recall("hi", thread_id="t1")

API

MemoryStore

  • await ensure_index() — create the {name}:mem:idx HNSW index if absent.
  • await remember(content, *, importance=None, tags=None, source=None, ttl=None, thread_id=None, agent_id=None, namespace=None) -> str
  • await recall(query, *, k=None, threshold=None, tags=None, weights=None, reinforce=None, thread_id=None, agent_id=None, namespace=None) -> list[MemoryHit]
  • await forget(id) -> bool
  • await forget_by_scope(*, thread_id=None, agent_id=None, namespace=None, tags=None) -> int
  • await consolidate(*, summarize, older_than_seconds=None, max_importance=None, delete_sources=None, summary_importance=None, tags=None, thread_id=None, agent_id=None, namespace=None) -> ConsolidateResult
  • current_config() -> MemoryConfigSnapshot
  • await refresh_config()
  • await ensure_discovery_ready()
  • await close()

AgentMemory

The batteries-included facade: an AgentCache (llm/tool/session) plus a MemoryStore sharing one client and name. initialize() creates the index and readies discovery for both tiers; close() tears both down.

Scoring

composite_score = w.similarity * similarity + w.recency * recency + w.importance * importance

where similarity = 1 - distance / 2 (cosine distance → 0..1) and recency decays with a true half-life (0.5 at one half_life_seconds). Default weights are {similarity: 0.6, recency: 0.25, importance: 0.15}, default threshold 0.25, default half-life 7 days.

License

MIT

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

betterdb_agent_memory-0.3.0.tar.gz (34.5 kB view details)

Uploaded Source

Built Distribution

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

betterdb_agent_memory-0.3.0-py3-none-any.whl (26.0 kB view details)

Uploaded Python 3

File details

Details for the file betterdb_agent_memory-0.3.0.tar.gz.

File metadata

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

File hashes

Hashes for betterdb_agent_memory-0.3.0.tar.gz
Algorithm Hash digest
SHA256 d0a262b3b18c7f5831c3c5efeb43dee51af77a91ac8f284e1a75ba579ae16412
MD5 80163a31e1a44217cd5daaf4a945b3a9
BLAKE2b-256 6fb3f1194eb92c44b8f0b4fc33e49a836eed660130cba1c617fdd85a490a3446

See more details on using hashes here.

Provenance

The following attestation bundles were made for betterdb_agent_memory-0.3.0.tar.gz:

Publisher: agent-memory-py-release.yml on BetterDB-inc/monitor

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

File details

Details for the file betterdb_agent_memory-0.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for betterdb_agent_memory-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e0606cf4e380bc61cfacc385ba4a2c6daae3f5183d9410b95b9d91c8ca929e67
MD5 5fd4d2e35dde1c26fa731df35effcd98
BLAKE2b-256 216658090f4a85a2453abc820c825eaaeaabdc15393a5cc912180e1b5f7e276b

See more details on using hashes here.

Provenance

The following attestation bundles were made for betterdb_agent_memory-0.3.0-py3-none-any.whl:

Publisher: agent-memory-py-release.yml on BetterDB-inc/monitor

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