1 line
15 KiB
JSON
1 line
15 KiB
JSON
{"repo": "2807706477/openagent", "files": {"README.md": {"e4bbf0dd5e0a8019efa076f24d56297fce8c342b": {"t": 1785746370.8630848, "n": 9467, "h": "1fcbf1db34502790", "c": "# openAgent - 企业级智能体应用平台\n\n\n🚀 **完全开源的大模型应用平台** \n- 集成智能问答、智能问数、知识库、工作流和智能体编排的大模型解决方案。\n- 采用Vue.js + FastAPI + PostgreSQL+Langchain/LangGraph架构。\n- 专为企业级应用设计，代码完全开源，支持私有化部署，可灵活扩展及二次开发。\n- 用户级数据隔离：每个用户的数据仅对其可见，确保数据安全。\n\n\n\n## 🏗️ 技术架构\n\n\n\n### 后端技术栈\n- **Web框架**: FastAPI + SQLAlchemy + Alembic\n- **数据库**: PostgreSQL 16+ (开源关系型数据库)\n- **向量数据库**: PostgreSQL + pgvector 扩展 (开源向量数据库)\n- **智能体编排**: LangGraph 状态图 + 条件路由\n- **工具调用**: Function Calling \n- **模型连接协议**: MCP (Model Context Protocol)\n- **RAG检索**: LangChain Vector Store \n- **对话记忆**: ConversationBufferMemory\n- **文档处理**: PyPDF2 + python-docx + markdown\n- **数据分析**: Pandas + NumPy\n\n### 前端技术栈\n- **框架**: Vue 3 + TypeScript + Vite\n- **UI组件**: Element Plus (开源UI库)\n- **HTTP客户端**: Axios\n- **工作流编辑器**: 自研可视化编辑器\n- **工作流引擎**: 基于DAG的流程执行引擎\n- **图形渲染**: Canvas API + SVG\n- **拖拽交互**: Vue Draggable\n- **节点连接**: 自定义连线算法\n\n\n\n## 本地部署指南\n\n\n### 环境要求\n- Python 3.10+\n- Node.js 18+\n- PostgreSQL 16+\n\n### 1. 安装数据库：PostgreSQL及pgvector插件（向量搜索)\n\n#### 方式一：Docker安装（推荐）\n使用 Docker + Docker Compose 部署 PostgreSQL 16 + pgvector 插件。\n\n**1. 创建docker-compose.yml文件**\n\n内容如下：\n\n```yaml\nversion: '3.8'\n\nservices:\n db:\n image: pgvector/pgvector:pg16\n container_name: pgvector-db\n environment:\n POSTGRES_USER: myuser\n POSTGRES_PASSWORD: your_password\n POSTGRES_DB: mydb\n ports:\n - \"5432:5432\"\n volumes:\n - pgdata:/var/lib/postgresql/data\n restart: unless-stopped\n\nvolumes:\n pgdata:\n```\n\n**说明：**\n- 使用 `pgvector/pgvector:pg16` 镜像，内置 PostgreSQL 16 + pgvector 插件\n- 数据保存在 Docker 卷 `pgdata` 中，重启不会丢失\n- 监听宿主机端口 5432，可用本地工具如 pgAdmin, DBeaver, psql 连接\n- 默认数据库名称：mydb\n- 默认用户名：myuser\n- 默认密码：your_password\n\n**2. 启动服务**\n\n在 `docker-compose.yml` 所在目录下运行：\n```bash\ndocker-compose up -d\n```\n\n查看容器状态：\n```bash\ndocker ps\n```\n\n输出应包含一个名为 `pgvector-db` 的容器，状态为 Up。\n\n**3. 验证 pgvector 安装成功**\n\n进入 PostgreSQL 容器：\n```bash\ndocker exec -it pgvector-db psql -U myuser -d mydb\n```\n\n启用 pgvector 插件：\n```sql\nCREATE EXTENSION IF NOT EXISTS vector;\n```\n \n插入并查询向量数据（示例，可以在客户端，如dbeaver等）**\n\n```sql\n-- 创建表，包含一个向量字段（维度为3）\nCREATE TABLE items (\n id SERIAL PRIMARY KEY,\n embedding vector(3)\n);\n\n-- 插入向量数据\nINSERT INTO items (embedding) VALUES\n ('[1,1,1]'),\n ('[2,2,2]'),\n ('[1,0,0]');\n\n-- 查询与 [1,1,1] 最接近的向量（基于欧几里得距离）\nSELECT id, embedding\nFROM items\nORDER BY embedding <-> '[1,1,1]'\nLIMIT 3;\n```\n-- 上述没报错且有结果返回，即安装成功\n\n### 2. 后端部署\n```bash\n# 克隆项目\ngit clone https://github.com/lkpAgent/chat-agent.git\ncd chat-agent/backend\n\n#创建python虚拟环境，推荐使用conda创建虚拟环境\nconda create -n chat-agent python=3.10\nconda activate chat-agent\n\n# 安装依赖\npip install -r requirements.txt\n\n# 配置环境变量,windows下直接复制.env.example文件为.env \ncp .env.example .env\n\n# 编辑.env文件，配置数据库连接和AI API密钥。相关配置信息见后面的配置说明\n\n# 配置完数据库信息后，初始化数据库表及创建登录账号(用户名: test@example.com, 密码: 123456)\ncd backend/tests\npython init_db.py\n\n# 启动后端服务，默认8000端口\npython -m uvicorn open_agent.main:app --reload --host 0.0.0.0 --port 8000\n# 或者直接运行main.py\n# cd backend/open_agent\n# python main.py\n\n```\n\n\n### 3. 前端部署\n```bash\n# 进入前端目录\ncd ../frontend\n\n# 安装依赖\nnpm install\n\n# 配置环境变量\ncp .env.example .env\n# 编辑.env文件，配置后端API地址\nVITE_API_BASE_URL = http://localhost:8000\n\n# 开发环境，启动前端服务，默认端口3000\nnpm run dev\n# 发布到生产环境，比如部署在{nginx_home}/html/yourdomain，则指定base路径编译\n# npm run build -- --base=yourdomain\n```\n启动成功后，访问http://localhost:3000，会进入到登录页面，默认账号密码为test@example.com/123456\n\n\n\n### 4. 访问应用\n- 前端地址: http://localhost:3000\n- 后端API: http://localhost:8000\n- API文档: http://localhost:8000/docs\n\n### 5. 后端配置说明\n\n#### 后端环境变量配置 (backend/.env)\n几个核心配置：系统数据库地址DATABASE_URL，向量数据库配置，CHAT大模型提供商：LLM_PROVIDER及相关配置，向量大模型提供商：EMBEDDING_PROVIDER\n几个工具API_KEY:tavilySearch,心知天气API\n\n```env\n\n# 数据库配置\n# ========================================\nDATABASE_URL=postgresql://your_username:your_password@your_host:your_port/your_db\n# 示例：\n# DATABASE_URL=postgresql://myuser:mypassword@127.0.0.1:5432/mydb\n\n# ========================================\n# 向量数据库配置\n# ========================================\nVECTOR_DB_TYPE=pgvector\nPGVECTOR_HOST=your_host\nPGVECTOR_PORT=your_port\nPGVECTOR_DATABASE=mydb\nPGVECTOR_USER=myuser\nPGVECTOR_PASSWORD=your_password\n \n# 大模型配置 (支持OpenAI协议的第三方服务) 只需要配置一种chat大模型以及embedding大模型\n# ========================================\n# chat大模型配置\n# ========================================\n# 可选择的提供商: openai, deepseek, doubao, zhipu, moonshot\nLLM_PROVIDER=doubao\n\n# Embedding模型配置\n# ========================================\n# 可选择的提供商: openai, deepseek, doubao, zhipu, moonshot\nEMBEDDING_PROVIDER=zhipu\n\n# OpenAI配置\nOPENAI_API_KEY=your-openai-api-key\nOPENAI_MODEL=gpt-4\nOPENAI_BASE_URL=https://api.openai.com/v1\nOPENAI_EMBEDDING_MODEL=text-embedding-ada-002\n\n\n# 智谱AI配置\nZHIPU_API_KEY=your-zhipu-api-key\nZHIPU_MODEL=glm-4\nZHIPU_EMBEDDING_MODEL=embedding-3\nZHIPU_BASE_URL=https://open.bigmodel.cn/api/paas/v4\n\n# DeepSeek配置\nDEEPSEEK_API_KEY=your-deepseek-api-key\nDEEPSEEK_BASE_URL=https://api.deepseek.com/v1\nDEEPSEEK_MODEL=deepseek-chat\nDEEPSEEK_EMBEDDING_MODEL=deepseek-embedding\n\n# 豆包配置\nDOUBAO_API_KEY=your-doubao-api-key\nDOUBAO_BASE_URL=https://ark.cn-beijing.volces.com/api/v3\nDOUBAO_MODEL=doubao-1-5-pro-32k-250115\nDOUBAO_EMBEDDING_MODEL=doubao-embedding\n\n# Moonshot配置\nMOONSHOT_API_KEY=your-moonshot-api-key\nMOONSHOT_BASE_URL=https://api.moonshot.cn/v1\nMOONSHOT_MODEL=moonshot-v1-8k\nMOONSHOT_EMBEDDING_MODEL=moonshot-embedding\n\n# 工具API配置\n## tavilySearch api\nTAVILY_API_KEY=your-tavily-api-key\n## 心知天气api\nWEATHER_API_KEY=your_xinzhi_api_key\n```\n\n\n## 📖 API文档\n\n### 主要API端点\n\n#### 认证相关\n- `POST /auth/login` - 用户登录\n- `POST /auth/register` - 用户注册\n- `POST /auth/refresh` - 刷新Token\n\n#### 对话管理\n- `GET /chat/conversations` - 获取对话列表\n- `POST /chat/conversations` - 创建新对话\n- `POST /chat/conversations/{id}/chat` - 发送消息\n\n#### 知识库管理\n- `POST /knowledge/upload` - 上传文档\n- `GET /knowledge/documents` - 获取文档列表\n- `DELETE /knowledge/documents/{id}` - 删除文档\n\n#### 智能查询\n- `POST /smart-query/query` - 智能数据查询\n- `POST /smart-query/upload` - 上传Excel文件\n- `GET /smart-query/files` - 获取文件列表\n\n### 完整API文档\n启动后端服务后访问: http://localhost:8000/docs\n\n## 🔧 开发指南\n\n### 项目结构\n```\nopen-agent/\n├── backend/ # 后端代码\n│ ├── open_agent/ # 主应用包\n│ │ ├── api/ # API路由\n│ │ ├── core/ # 核心配置\n│ │ ├── db/ # 数据库相关\n│ │ ├── models/ # 数据库模型\n│ │ ├── services/ # 业务逻辑\n│ │ ├── utils/ # 工具函数\n│ │ └── main.py # 应用入口\n│ ├── tests/ # 测试文件\n│ └── requirements.txt # Python依赖\n├── frontend/ # 前端代码\n│ ├── src/\n│ │ ├── components/ # Vue组件\n│ │ ├── views/ # 页面组件\n│ │ │ ├── chat/ # 对话页面\n│ │ │ ├── knowledge/ # 知识库页面\n│ │ │ ├── workflow/ # 工作流页面\n│ │ │ └── agent/ # 智能体页面\n│ │ ├── stores/ # Pinia状态管理\n│ │ ├── api/ # API调用\n│ │ ├── types/ # TypeScript类型\n│ │ └── router/ # 路由配置\n│ └── package.json # Node.js依赖\n├── data/ # 数据目录\n│ ├── uploads/ # 上传文件\n│ └── logs/ # 日志文件\n└── docs/ # 文档目录\n```\n\n\n## ✨ 核心能力\n\n\n\n### 🤖 智能问答\n\n\n- **多模型支持**：集成DeepSeek、智谱AI、豆包等国内主流AI服务商\n- **三种对话模式**：\n - 自由对话：直接与AI模型交互\n - RAG对话：基于知识库的检索增强生成\n - 智能体对话：多智能体协作处理复杂任务\n- **多轮对话**：支持连续对话，上下文理解和记忆\n- **对话历史**：完整的会话记录和管理\n\n## 🌟 技术特色\n\n### 基于LangGraph的智能体对话系统\n- **自主规划能力**：智能体能够根据任务需求自主调用工具并规划执行流程\n- **动态工具调用**：根据上下文自动选择最合适的工具并执行\n- **多步任务分解**：复杂任务自动拆解为多个子任务并顺序执行\n\n**示例场景**： \n当用户询问\"推荐长沙和北京哪个适宜旅游\"时：\n1. 智能体首先调用搜索工具查找相关信息\n2. 未找到合适结果时，自动规划调用天气查询工具\n3. 智能拆分为两次执行：先查询长沙天气，再查询北京天气\n4. 根据气温数据判断北京更适宜旅游\n5. 自动调用搜索工具查找北京景点信息\n6. 最终整合所有信息生成总结推荐\n\n第一步：调用搜索引擎搜索哪个城市更适宜旅游 \n\n\n第二步：搜索的内容没有找到合适的答案，意识到错了后，改变策划，重新调用天气工具，从天气的角度判断哪个城市更适合当下旅游 。\n并且自动进行任务拆解，对北京、长沙分别调用一次天气工具，获取到两个城市的天气情况。\n\n \n\n第三步：根据天气判断北京更适合旅游，再调用搜索引擎工具，搜索北京的特色景点。最后将工具调用结果与问题进行总结，完成本次对话过程。\n\n \n\n### 📊 智能问数\n\n\n- **Excel分析**：上传Excel文件进行智能数据分析\n- **自然语言查询**：用自然语言提问，自动生成Python代码\n- **数据库查询**：连接PostgreSQL等数据库进行智能问答\n- **多表关联**：支持复杂的多表/多文件联合查询\n- **可视化思维链**：大模型思考过程可视化呈现\n\n## 🌟 技术特色\n\n### 双引擎智能问数系统\n\n**基于Excel的智能问数**\n- 使用LangChain代码解释器插件，将Excel数据读取到Pandas DataFrame\n- 大模型将自然语言问题转换为Pandas语法并执行\n- 支持多表格文件联合查询和复杂数据分析\n\n**基于数据库的智能问数**\n- 实现PostgreSQL MCP（Model Context Protocol）接口\n- 大模型先提取表元数据，了解表结构和关系\n- 根据用户问题自动生成优化SQL查询语句\n- 支持多表关联查询和复杂数据检索\n\n基于Excel报表的智能问数\n \n基于数据库的智能问数\n \n### 📚 知识库管理\n\n\n\n- **文档处理**：支持PDF、Word、Markdown、TXT等格式\n- **向量存储**：基于PostgreSQL + pgvector的向量数据库\n- **智能检索**：向量相似度搜索和BM25算法关键词检索\n- **文档管理**：上传、删除、分类和标签管理\n- **RAG集成**：与对话系统无缝集成\n\n## 🌟 技术特色\n### 高级语义分割知识库处理\n- **智能段落分割**：基于大模型的语义理解分割技术，而非传统的文本相似度判断\n- **精准切分识别**：大模型直接识别最适合的切分位置并输出分割标记字符串\n- **高效处理流程**：仅输出分割位置字符串，再由代码执行实际分割操作\n- **性能优化**：避免了传统方法中大量的向量计算和相似度比较，提升处理速度\n- **质量保证**：大模型的深层语义理解确保分割边界的准确性和合理性\n### 双重召回检索机制\n- **多模态检索**：结合向量相似度匹配（语义搜索）与BM25关键词检索（字面匹配）\n- **混合排序策略**：采用加权融合算法，综合语义相关性和关键词匹配度进行结果排序\n- **召回增强**：双重召回机制有效解决了单纯向量检索的\"词汇不匹配\"问题\n- **精准度提升**：相比单一检索方式，显著提高相关文档的召回率和准确率 \n\n\n \n\n\n### 🔧 工作流编排\n\n- **可视化设计**：拖拽式工作流设计器\n- **节点类型**：支持AI对话、数据处理、条件判断等节点\n- **流程控制**：条件分支、循环、并行执行\n\n\n\n### 🤖 智能体编排\n- **多智能体协作**：不同专业领域的AI智能体协同工作\n- **角色定义**：自定义智能体的专业能力和知识领域\n- **任务分配**：智能分解复杂任务到合适的智能体\n- **结果整合**：汇总多个智能体的输出生成最终答案\n### 在线体验地址，可自己注册账号使用\nhttp://113.240.110.92:81/\n\n#### 💼 商业使用\n- ✅ 可用于商业项目\n- ✅ 可修改源码\n- ✅ 可私有化部署\n- ✅ 可集成到现有系统\n- ✅ 无需支付许可费用\n\n## 📄 许可证\n\n本项目采用 [MIT License](LICENSE) 许可证，这意味着：\n- 可以自由使用、修改、分发\n- 可以用于商业目的\n- 只需保留原始许可证声明\n- 作者不承担任何责任\n\n## 🙏 致谢\n\n\n\n**如果这个项目对你有帮助，请给它一个 ⭐️！**"}}}} |