Controllable-RAG-Agent

环境要求

• Python 环境（需可运行 Jupyter Notebook）
• pip 包管理工具
• OpenAI API Key
• Groq API Key
• Docker 与 docker-compose（仅在使用容器方式时需要）

安装与启动步骤

1. 1克隆项目仓库

   把 GitHub 上的项目代码下载到本地，并进入项目根目录，后续所有命令都在这个目录下执行。

   git clone https://github.com/NirDiamant/Controllable-RAG-Agent.git
   cd Controllable-RAG-Agent

   复制

2. 2安装 Python 依赖

   用项目自带的 requirements.txt 一次性安装全部依赖包，建议先创建虚拟环境避免污染全局环境。

   pip install -r requirements.txt

   复制

3. 3配置 API 密钥

   在项目根目录新建 .env 文件，填入 OpenAI 与 Groq 的 API Key，可参考仓库中的 .env.example 文件格式。

   OPENAI_API_KEY=sk-xxxxxxxx
   GROQ_API_KEY=gsk_xxxxxxxx

   复制

4. 4打开教程 Notebook

   用 Jupyter 打开 sophisticated_rag_agent_harry_potter.ipynb，按顺序逐格运行，了解图构建、图检索与答案生成的完整流程。

5. 5启动可视化界面

   在本地运行 Streamlit 脚本，实时观察智能体的推理与检索过程，界面会自动在本地端口启动。

   streamlit run simulate_agent.py

   复制

6. 6用 Docker 启动（可选）

   若不想本地装依赖，可直接构建并启动 Docker 镜像，启动后同样通过浏览器访问可视化界面。

   docker-compose up --build

   复制

关键配置

如何确认成功

浏览器打开 http://localhost:8501/ 能看到智能体实时可视化界面，或在 Notebook 中逐格运行无报错、能返回答案。

常见问题

注意事项

• README 未给出具体的 Python 版本要求，建议使用较新的 Python 3 版本并在虚拟环境中安装依赖。
• .env 文件必须放在项目根目录，否则代码可能读取不到密钥。
• 可视化界面默认使用 8501 端口，若被占用需自行释放端口或调整 Streamlit 启动参数。
• API 密钥属于敏感信息，不要提交到 Git 仓库或公开分享。