Skip to content

Add Perseus Vault integration#538

Open
tcconnally wants to merge 6 commits into
deepset-ai:mainfrom
tcconnally:add-perseus-vault
Open

Add Perseus Vault integration#538
tcconnally wants to merge 6 commits into
deepset-ai:mainfrom
tcconnally:add-perseus-vault

Conversation

@tcconnally

@tcconnally tcconnally commented Jul 4, 2026

Copy link
Copy Markdown

This PR adds a catalog entry for Perseus Vault, a community Haystack 2.x integration providing local-first, encrypted, persistent memory for pipelines and agents.

Perseus Vault is a single-binary memory engine backed by an encrypted (AES-256-GCM) SQLite database with FTS5 + vector search that runs fully offline — no external vector DB or API keys required. The integration exposes PerseusVaultMemoryStore, PerseusVaultMemoryWriter, and PerseusVaultMemoryRetriever.

Adds a metadata file (integrations/perseus-vault-haystack.md) and an SVG logo (logos/perseus-vault.svg). Both pypi and repo fields are populated.

@tcconnally
tcconnally requested a review from a team as a code owner July 4, 2026 21:36
@vercel

vercel Bot commented Jul 4, 2026

Copy link
Copy Markdown

@tcconnally is attempting to deploy a commit to the deepset Team on Vercel.

A member of the Team first needs to authorize it.

@tcconnally

Copy link
Copy Markdown
Author

Friendly nudge on this one 🙂 — catalog metadata + logo are in place and the package (perseus-vault-haystack 0.1.0) is live on PyPI. Happy to adjust anything needed to get it listed. Thanks!

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

  • Adds a new Haystack integration catalog page and logo for Perseus Vault (community “Memory Store” integration) so it can be listed and documented alongside other integrations.

Changes:

  • Adds integrations/perseus-vault-haystack.md integration page with metadata, overview, install instructions, usage snippet, and license.
  • Adds logos/perseus-vault.svg logo asset referenced by the integration page.

Reviewed changes

Copilot reviewed 1 out of 2 changed files in this pull request and generated 1 comment.

File Description
integrations/perseus-vault-haystack.md New integration catalog entry + usage snippet + license section.
logos/perseus-vault.svg New SVG logo used by the integration page.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread integrations/perseus-vault-haystack.md Outdated
Comment on lines +48 to +55
from haystack import Pipeline, Document
from perseus_vault_haystack import (
PerseusVaultMemoryStore,
PerseusVaultMemoryWriter,
PerseusVaultMemoryRetriever,
)

store = PerseusVaultMemoryStore(db_path="~/.mimir/haystack.db")

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch — applied in 7964de5. The snippet now uses Path(...).expanduser() and creates the parent dir so it is copy/paste runnable.

@tcconnally

Copy link
Copy Markdown
Author

Thanks for the review @kacperlukawski! Addressed the Copilot note in 7964de5 — the usage example now expands ~ via Path(...).expanduser() and creates the parent directory, so it runs as-is on copy/paste. Ready for another look whenever you have a moment. 🙏

@vercel

vercel Bot commented Jul 11, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
haystack-integrations Ready Ready Preview, Comment Jul 11, 2026 3:13pm

Request Review

… page

The install section omitted the separate perseus-vault engine binary that the
components drive over stdio, so pip-install-only readers hit a RuntimeError.
Documented the releases-page download / $PATH step and swapped the usage
snippet for a write+read that returns an actual hit (verified against
perseus-vault-haystack 0.1.0 and perseus-vault v2.20.2).
@tcconnally

Copy link
Copy Markdown
Author

Pushed one more polish commit (484f217) to make the page fully self-contained:

  • Installation now documents the perseus-vault engine binary as a separate prerequisite (releases-page download + $PATH, or perseus_vault_binary=). The components drive that binary over stdio, so a pip-only reader would otherwise hit a RuntimeError.
  • Usage snippet swapped for a write+read that returns an actual hit, so the example demonstrably runs (per the draft template's "must actually run" note).

Verified end-to-end against perseus-vault-haystack 0.1.0 (PyPI) + perseus-vault v2.20.2. Ready for another look whenever convenient — thanks! 🙏

Brings the catalog entry to parity with the other Memory Store integrations:
Available Classes, a Haystack Agent example (retain/recall/reflect tools), an
automatic-memory wrapper example, and the pipeline example. Overview now leads
with the differentiators (local-first, encrypted at rest, no cloud, no API
keys). All referenced symbols ship in perseus-vault-haystack 0.2.0 on PyPI.
@tcconnally

Copy link
Copy Markdown
Author

Expanded the page to match the depth of the other Memory Store entries (2368c93):

  • Available Classes, a Haystack Agent example (ready-made retain_memory / recall_memory / reflect_memory tools via create_perseus_vault_tools), an Automatic Memory wrapper example, and the Pipeline example.
  • These landed in perseus-vault-haystack 0.2.0 (now on PyPI), which adds Agent tools, an auto recall/retain wrapper, and ChatMessage support alongside the existing Document API.
  • Overview leads with what's distinctive: fully local/offline, encrypted at rest (AES-256-GCM), single binary, no external vector DB, no API keys.

Every symbol referenced on the page ships in 0.2.0, and the pipeline example is verified to run end-to-end. Thanks again for the review! 🙏

The repo was renamed from mimir-haystack; use the canonical slug so links
don't rely on GitHub redirects.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants