docs: add Synap memory provider page#4005
Conversation
|
Thanks for opening a docs PR, Anish Yadav (@visy-ani)! When it's ready for review, please add the relevant reviewers:
|
There was a problem hiding this comment.
Pull request overview
Adds a new Synap provider documentation page under the OSS integrations docs, describing Synap’s “long-term memory” offering and showing example usage across multiple LangChain/LangGraph integration surfaces.
Changes:
- Adds a new
synap.mdxprovider page with installation/configuration guidance. - Documents five Synap “integration surfaces” (chat history, retriever, agent tools, callbacks, LangGraph node) with Python snippets.
- Adds scoping and resource links for Synap.
Comments suppressed due to low confidence (2)
src/oss/integrations/providers/synap.mdx:90
- This agent snippet references
llmandpromptwithout defining them, so it won’t run as-is. Consider adding minimal setup (or an explicit placeholder comment) so the snippet is copy/pasteable.
SynapSearchTool(sdk=sdk, user_id="alice", customer_id="acme_corp"),
SynapStoreTool(sdk=sdk, user_id="alice", customer_id="acme_corp"),
]
agent = create_tool_calling_agent(llm, tools, prompt)
executor = AgentExecutor(agent=agent, tools=tools)
src/oss/integrations/providers/synap.mdx:113
- The LangGraph snippet references
MyStatewithout defining it. If it’s a placeholder, call that out explicitly (or include a minimal state definition) so readers can adapt the example quickly.
graph = StateGraph(MyState)
graph.add_node("memory", create_synap_node(sdk, user_id="alice"))
| @@ -0,0 +1,126 @@ | |||
| # Synap | |||
| ## Installation | ||
|
|
||
| ```bash | ||
| pip install synap-langchain | ||
| ``` |
| ```python | ||
| from langchain_core.runnables.history import RunnableWithMessageHistory | ||
| from maximem_synap import MaximemSynapSDK | ||
| from synap_langchain import SynapChatMessageHistory | ||
|
|
||
| sdk = MaximemSynapSDK(api_key="your-api-key") | ||
|
|
| from synap_langchain import create_synap_node | ||
|
|
||
| graph = StateGraph(MyState) | ||
| graph.add_node("memory", create_synap_node(sdk, user_id="alice")) |
| ## More resources | ||
|
|
||
| - [Synap documentation](https://docs.maximem.ai) | ||
| - [LangChain integration guide](https://docs.maximem.ai/integrations/langchain) | ||
| - [PyPI: `synap-langchain`](https://pypi.org/project/synap-langchain/) |
|
Hi Mukil Loganathan (@langchain-infra) and Kathryn May (@katmayb) 👋 — would love a review on this whenever you have a moment! This adds Why this is useful: I addressed Copilot's review feedback in the latest push: added YAML frontmatter, made the chat history example self-contained (chain is now fully defined with |
Summary
Adds a provider page for Synap under
src/oss/integrations/providers/synap.mdx, matching the existingcala.mdxformat.Synap is a managed long-term memory layer for AI agents. The
synap-langchainpackage provides five LangChain surfaces (chat history, retriever, agent tools, callback handler, LangGraph node).