Skip to main content

Character Memory

PyPI version Python versions License

Screenshot 2026-09-02 alle 23 19 44

AI Characters that live, remember and forget


Unlike other memory systems, Character Memory is not created for perfect recall, but to recall like a human, make bonds with users and keep track of the character's lifetime.

Like humans, in CharacterMemory, memories are recalled based on how emotionally impactful an episode was, in which location the character is, how recent is the memory and how often he recalls it.

Quick Start

Character Memory is both a library for developers and a ready-to-integrate tool for third party applications It provides a:

  • pip package, used by developers to integrate the library
  • MCP server, to integrate tools to read and edit memory into Agents
  • API to query and save memory
  • A Web Interface to create characters, view memories and chat with them

Installation

pip install charactermemory              # the library
pip install 'charactermemory[server]'    # + FastAPI server, WebUI and MCP endpoint

The library talks to any OpenAI-compatible /v1 endpoint for both the chat model and the embeddings server:

export OPENAI_BASE_URL="http://127.0.0.1:9999/v1"
export OPENAI_API_KEY="anything"
export OPENAI_MODEL="my-chat-model"
export OPENAI_EMBEDDINGS_BASE_URL="http://127.0.0.1:9999/v1"
export OPENAI_EMBEDDINGS_MODEL="my-embeddings-model"

Use it as a library

A character is just a directory: Information/ lore files, Dialogues/ examples, and an optional config.yaml with persona, prompts and memory toggles.

from character_memory import CharacterAgent, LLMConfig, EmbeddingConfig, MemoryConfig

agent = CharacterAgent(directory="assets/Kurisu", name="Kurisu")
agent.load_from_config(LLMConfig(), EmbeddingConfig(), MemoryConfig())
agent.build()   # load or build the memory indexes (idempotent)

chat = agent.create_chat(user="michael", title="phonewave intro")
chat.add_message("user", "Hi, I'm Michael, a nuclear engineer called in by Daru.")

for chunk in agent.generate_answer(chat, stream=True):   # persisted + auto-extracted
    print(chunk, end="", flush=True)

Or run the server (WebUI + MCP)

charactermemory-server    # serves /context, /save, /gui and /mcp on :8000

Open http://localhost:8000/gui to create characters, browse and edit their memories and explore the knowledge graph, or point an MCP client (Claude Desktop, Cursor, …) at http://localhost:8000/mcp?character=Kurisu.

The full walkthrough of all four usage modes (full library, context-only, MCP server, HTTP API + WebUI) is in docs/getting_started.md.


General Idea

Character Memory provides the following built-in memory systems (which can be enabled/disabled):

  1. Character Info: documents about the base character's lore, preferences and general information. Allows for lore consistency.
  2. Dialogue Examples: documents about examples of conversations between the character and other characters, used to copy it conversation style
  3. Fact Memory: save facts like "User is an engineer"
  4. Episodes Memory: save episodes like "I talked with the user about quantum physics"
  5. User directives: instructions given by the user that recall when needed, for example "When I ask you to do X, do Y". Mainly used for agent/assistant-like characters.
  6. Conversation Events: just saves conversations with the user. Recall on this memory is only done when necessary
  7. Emotions: keep track of current character's base emotions and emotions towards a user specifically
  8. World: keep track of the character's location, routines, sleep, hunger and energy
  9. Calendar: keep track of events
  10. User Summary: a rolling summary of the user
  • Recall is usually done via Embeddings (Similarity) + BM25 (Lexical) search on all the memories, but also considering emotions, recency and other parameters. Some memories are made to stay regardless.
  • Every 5 or 10 turns (user-defined), an LLM extraction process begins, which, considering already existing context, adds entries for all of the memories that need it.
  • New extracted memories are compared to old memories, and a deduplication process begins if too similar memories or conflicting memories are detected.

Knowledge Graph Retrieval

Knowledge Graph Retrieval provides an aggregation of retrieval-based memories and connects them in order to provide a more advanced retrieval. There are multiple node types:

  • Self node: maps the character itself, central and main node of the graph.
  • Person node: maps person and their relationship with them, activates when a person is metioned or the character is talking to that person
  • Episode node: maps episodes
  • Fact node: maps facts
  • Location node: maps locations, activates automatically when the character is in that location, or the location is mentioned
  • Entity Node: maps entities, special objects or things in the conversation

Depending on the nodes they connect, edges can map the emotions about an event, relationship with other poeple, two events that get recalled together, the importance and how recent an event is.

image

At the end,

  • People with strong bonds are more likely to be recalled
  • Episodes that cause strong emotions, or that caused similar emotions to current are more likely to be recalled
  • Episodes that are related to a common entity are more likely to be recalled
  • Episodes that happened in the same location the character currently is, are more likely to be recalled

The knowledge graph requires one additional LLM call after every extraction. (And tens of LLM calls to ingest existing memories)

PostgreSQL and pgvector

Optional production storage is available with pip install 'charactermemory[postgres]'. Set storage.backend: postgres and retrieval.backend: postgres to store conversations, memories, and hybrid search indexes in PostgreSQL. SQLite + FAISS remain the defaults. See setup, configuration, recovery, and concurrency measurements and the local Compose example.

Download files

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

Source Distribution

charactermemory-0.1.1.tar.gz (536.6 kB view details)

Uploaded Source

Built Distribution

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

charactermemory-0.1.1-py3-none-any.whl (525.2 kB view details)

Uploaded Python 3

File details

Details for the file charactermemory-0.1.1.tar.gz.

File metadata

  • Download URL: charactermemory-0.1.1.tar.gz
  • Upload date:
  • Size: 536.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.12.10 {"installer":{"name":"uv","version":"0.12.10","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Arch Linux","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for charactermemory-0.1.1.tar.gz
Algorithm Hash digest
SHA256 a330adaf4ad1f45f5c90e6a742df2e76f5a8977a37f896d1185c62b42c2fa1e1
MD5 dcde55c4533da9f585c0ece9dfa36eb4
BLAKE2b-256 af0697674f229a4f1b4238f7029398b3b20f85bdafde0e53f24978ba554d369d

See more details on using hashes here.

File details

Details for the file charactermemory-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: charactermemory-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 525.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.12.10 {"installer":{"name":"uv","version":"0.12.10","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Arch Linux","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for charactermemory-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 84aca5abb0939e39b08e77dddc8f7debcaa80fdfb89716e95735066825eb8cad
MD5 6215ad8ea9aad4a2c1fada676eb6d777
BLAKE2b-256 b2fb7e3aa942e9cd84ea0789388a110155656c104a03d1cd5cdfe57e59045ef9

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.1.1 This release

2 files

0.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page