Memary

环境要求

• Python 版本需 <= 3.11.9
• 已安装 pip
• 使用本地模型时需自行安装 Ollama 并下载模型（如 Llama 3 8B/40B、LLaVA）
• 准备 OpenAI、Perplexity、Google Maps、Alpha Vantage 等 API Key（部分为可选）
• 一个图数据库凭证：FalkorDB 或 Neo4j 二选一

安装与启动步骤

1. 1确认 Python 版本

   Memary 要求 Python 版本不高于 3.11.9，先确认当前版本是否符合，不符合需先切换环境。

   python --version

   复制

2. 2用 pip 安装 memary

   官方推荐的最简安装方式，直接安装 memary 包，无需克隆仓库。

   pip install memary

   复制

3. 3本地安装依赖

   选择本地运行方式时，先创建指定 Python 版本的虚拟环境，再安装 requirements.txt 中的依赖。

   pip install -r requirements.txt

   复制

4. 4创建 .env 凭证文件

   在项目根目录确保存在 .env，填入模型与数据库所需凭证；图数据库填 FalkorDB 或 Neo4j 其中一组即可。

5. 5获取各平台 API Key

   按 README 给出的入口分别申请：OpenAI、FalkorDB 或 Neo4j、Perplexity、Google Maps、Alpha Vantage。

6. 6编辑用户画像

   把 streamlit_app/data/user_persona.txt 按同目录下 user_persona_template.txt 的说明，把花括号替换成真实信息。

7. 7启动 Streamlit 应用

   进入 streamlit_app 目录后启动应用；系统画像 system_persona.txt 需要时也可一并修改。

   cd streamlit_app
   streamlit run app.py

   复制

8. 8代码中调用 ChatAgent

   在自己的项目中导入 ChatAgent，传入画像、历史对话与记忆流等 JSON 路径，即可为 Agent 加上记忆层。

   from memary.agent.chat_agent import ChatAgent
   
   system_persona_txt = "data/system_persona.txt"
   user_persona_txt = "data/user_persona.txt"
   past_chat_json = "data/past_chat.json"
   memory_stream_json = "data/memory_stream.json"
   entity_knowledge_store_json = "data/entity_knowledge_store.json"
   chat_agent = ChatAgent(
       "Personal Agent",
       memory_stream_json,
       entity_knowledge_store_json,
       system_persona_txt,
       user_persona_txt,
       past_chat_json,
   )

   复制

关键配置

如何确认成功

执行 streamlit run app.py 后终端会输出访问地址，浏览器打开该地址能看到 Memary 的聊天界面即启动成功。

常见问题

注意事项

• Memary 默认使用本地 Ollama 模型，除非显式指定使用 OpenAI 模型。
• 使用 Ollama 属于可选项，需要按 Ollama 官方仓库说明自行安装并拉取模型。
• user_persona.txt 需按 user_persona_template.txt 的格式，把花括号内容替换为实际信息。
• README 中未给出固定端口与具体启动参数，实际访问地址以 streamlit 启动后终端输出为准。