docs: add Synap managed memory integration#471
Open
visy-ani wants to merge 5 commits intodeepset-ai:mainfrom
Open
docs: add Synap managed memory integration#471visy-ani wants to merge 5 commits intodeepset-ai:mainfrom
visy-ani wants to merge 5 commits intodeepset-ai:mainfrom
Conversation
There was a problem hiding this comment.
Pull request overview
Adds a new integration page to the Haystack integrations hub to document Synap as a managed “Memory Store” backend for cross-session agent memory.
Changes:
- Adds
integrations/synap.mdwith front matter metadata (name, repo, PyPI, issue tracker, etc.). - Documents installation and usage for
SynapRetrieverandSynapMemoryWriter, plus a “Full Pipeline Example”.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+99
to
+103
| from haystack import Document, Pipeline | ||
| from haystack.components.builders import ChatPromptBuilder | ||
| from haystack.components.generators.chat import OpenAIChatGenerator | ||
| from maximem_synap import MaximemSynapSDK | ||
| from synap_haystack import SynapMemoryWriter, SynapRetriever |
Comment on lines
+96
to
+110
| A complete retrieval-augmented pipeline that loads Synap context before the LLM and records turns afterward: | ||
|
|
||
| ```python | ||
| from haystack import Document, Pipeline | ||
| from haystack.components.builders import ChatPromptBuilder | ||
| from haystack.components.generators.chat import OpenAIChatGenerator | ||
| from maximem_synap import MaximemSynapSDK | ||
| from synap_haystack import SynapMemoryWriter, SynapRetriever | ||
|
|
||
| sdk = MaximemSynapSDK(api_key="sk-...") | ||
|
|
||
| retriever = SynapRetriever(sdk=sdk, user_id="user_123", customer_id="acme_corp") | ||
| writer = SynapMemoryWriter( | ||
| sdk=sdk, conversation_id="session_1", user_id="user_123", customer_id="acme_corp" | ||
| ) |
Comment on lines
+96
to
+114
| A complete retrieval-augmented pipeline that loads Synap context before the LLM and records turns afterward: | ||
|
|
||
| ```python | ||
| from haystack import Document, Pipeline | ||
| from haystack.components.builders import ChatPromptBuilder | ||
| from haystack.components.generators.chat import OpenAIChatGenerator | ||
| from maximem_synap import MaximemSynapSDK | ||
| from synap_haystack import SynapMemoryWriter, SynapRetriever | ||
|
|
||
| sdk = MaximemSynapSDK(api_key="sk-...") | ||
|
|
||
| retriever = SynapRetriever(sdk=sdk, user_id="user_123", customer_id="acme_corp") | ||
| writer = SynapMemoryWriter( | ||
| sdk=sdk, conversation_id="session_1", user_id="user_123", customer_id="acme_corp" | ||
| ) | ||
|
|
||
| pipeline = Pipeline() | ||
| pipeline.add_component("memory", retriever) | ||
| pipeline.add_component("llm", OpenAIChatGenerator(model="gpt-4o")) |
Comment on lines
+99
to
+105
| from haystack import Document, Pipeline | ||
| from haystack.components.builders import ChatPromptBuilder | ||
| from haystack.components.generators.chat import OpenAIChatGenerator | ||
| from maximem_synap import MaximemSynapSDK | ||
| from synap_haystack import SynapMemoryWriter, SynapRetriever | ||
|
|
||
| sdk = MaximemSynapSDK(api_key="sk-...") |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Author
|
Hi @kacperlukawski and @bilgeyucel — would love a review when you have a moment! This adds a All Copilot-flagged issues have been addressed: hardcoded API keys replaced with |
Author
|
Hi @kacperlukawski and @bilgeyucel 👋 — gentle follow-up on this whenever you get a moment. The page is ready for review and all bot feedback has been addressed. Happy to make any further changes you'd like. Thanks! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds Synap to the Haystack integrations hub as a Memory Store.
Synap is a managed memory layer for AI agents. The Haystack integration provides two native
@componentclasses:SynapRetriever: retrieves facts, preferences, and episodes from the user's Synap memory and returns them as HaystackDocumentobjectsSynapMemoryWriter: records conversation turns to Synap so they are available for retrieval in future sessionsMemory is scoped to
user_idandcustomer_id, ensuring strict isolation in multi-tenant applications.Install:
pip install maximem-synap-haystackPyPI: https://pypi.org/project/maximem-synap-haystack/
Docs: https://docs.maximem.ai/integrations/haystack
Open source: Integration package source at
maximem-ai/maximem_synap_sdk— contributions welcome