diff --git a/README.md b/README.md index e69de29..db59374 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,313 @@ +# TSP智能助手 (TSP Assistant) + +[![Version](https://img.shields.io/badge/version-1.2.0-blue.svg)](version.json) +[![Python](https://img.shields.io/badge/python-3.8+-green.svg)](requirements.txt) +[![License](https://img.shields.io/badge/license-MIT-yellow.svg)](LICENSE) +[![Status](https://img.shields.io/badge/status-production-ready-brightgreen.svg)]() + +> 基于大语言模型的智能客服系统，专为TSP（Telematics Service Provider）车辆服务提供商设计 + +## 🚀 项目特色 + +### 🧠 智能Agent架构 +- **多工具集成**: 知识库搜索、工单管理、数据分析、通知推送等10+工具 +- **智能规划**: 基于目标驱动的任务规划和执行 +- **自主学习**: 从用户反馈中持续优化响应质量 +- **实时监控**: 主动监控系统状态和异常情况 + +### 💬 智能对话系统 +- **实时通信**: WebSocket支持，毫秒级响应 +- **上下文理解**: 多轮对话记忆和上下文关联 +- **VIN识别**: 自动识别车辆VIN码并获取实时数据 +- **知识库集成**: 基于TF-IDF和余弦相似度的智能检索 + +### 📊 数据驱动分析 +- **真实数据**: 基于数据库的真实性能趋势分析 +- **多维度统计**: 工单、预警、满意度、性能指标 +- **可视化展示**: Chart.js图表，直观的数据呈现 +- **系统监控**: 实时CPU、内存、健康状态监控 + +### 🔧 企业级管理 +- **多环境部署**: 开发、测试、生产环境隔离 +- **版本控制**: 完整的版本管理和变更日志 +- **热更新**: 支持前端文件热更新，无需重启服务 +- **自动备份**: 更新前自动备份，支持一键回滚 + +## 🏗️ 系统架构 + +``` +┌─────────────────┐ ┌─────────────────┐ ┌─────────────────┐ +│ 前端界面 │ │ 后端服务 │ │ 数据存储 │ +│ │ │ │ │ │ +│ • 仪表板 │◄──►│ • Flask API │◄──►│ • SQLite DB │ +│ • 智能对话 │ │ • WebSocket │ │ • 知识库 │ +│ • Agent管理 │ │ • Agent核心 │ │ • 工单系统 │ +│ • 数据分析 │ │ • LLM集成 │ │ • 车辆数据 │ +└─────────────────┘ └─────────────────┘ └─────────────────┘ +``` + +## 🎯 核心功能 + +### 1. 智能对话 💬 +- **多轮对话**: 支持上下文关联的连续对话 +- **VIN识别**: 自动识别车辆VIN并获取实时数据 +- **知识库检索**: 智能匹配相关技术文档和解决方案 +- **工单创建**: 对话中直接创建和关联工单 + +### 2. Agent管理 🤖 +- **工具管理**: 10+内置工具，支持自定义工具注册 +- **执行监控**: 实时监控Agent任务执行状态 +- **性能统计**: 工具使用频率和成功率分析 +- **智能规划**: 基于目标的任务分解和执行 + +### 3. 工单系统 📋 +- **AI建议**: 基于知识库生成工单处理建议 +- **人工审核**: 支持人工输入和AI建议对比 +- **相似度评估**: 自动计算AI与人工建议的相似度 +- **知识库更新**: 高相似度建议自动入库 + +### 4. 知识库管理 📚 +- **多格式支持**: TXT、PDF、DOC、DOCX、MD文件 +- **智能提取**: 自动从文档中提取Q&A对 +- **向量化检索**: TF-IDF + 余弦相似度搜索 +- **质量验证**: 支持知识条目验证和置信度设置 + +### 5. 数据分析 📊 +- **实时趋势**: 基于真实数据的性能趋势分析 +- **多维度统计**: 工单、预警、满意度等关键指标 +- **系统健康**: CPU、内存、响应时间监控 +- **可视化展示**: 丰富的图表和仪表板 + +### 6. 系统设置 ⚙️ +- **API管理**: 支持多种LLM提供商配置 +- **模型参数**: 温度、最大令牌数等参数调节 +- **端口配置**: Web服务和WebSocket端口管理 +- **日志级别**: 灵活的日志级别控制 + +## 🛠️ 技术栈 + +### 后端技术 +- **Python 3.8+**: 核心开发语言 +- **Flask**: Web框架和API服务 +- **SQLAlchemy**: ORM数据库操作 +- **WebSocket**: 实时通信支持 +- **psutil**: 系统资源监控 + +### 前端技术 +- **Bootstrap 5**: UI框架 +- **Chart.js**: 数据可视化 +- **JavaScript ES6+**: 前端逻辑 +- **WebSocket**: 实时通信客户端 + +### AI/ML技术 +- **大语言模型**: 支持OpenAI、通义千问等 +- **TF-IDF**: 文本向量化 +- **余弦相似度**: 语义相似度计算 +- **Agent框架**: 智能任务规划 + +### 部署运维 +- **Docker**: 容器化部署 +- **Nginx**: 反向代理和静态文件服务 +- **Systemd**: 服务管理 +- **Git**: 版本控制 + +## 🚀 快速开始 + +### 环境要求 +- Python 3.8+ +- Node.js 16+ (可选，用于前端构建) +- Git + +### 安装步骤 + +1. **克隆项目** +```bash +git clone http://jeason.online:3000/zhaojie/assist.git +cd assist +``` + +2. **安装依赖** +```bash +pip install -r requirements.txt +``` + +3. **初始化数据库** +```bash +python init_database.py +``` + +4. **启动服务** +```bash +python start_dashboard.py +``` + +5. **访问系统** +- 打开浏览器访问: `http://localhost:5000` +- 默认端口: 5000 (可在系统设置中修改) + +### Windows快速启动 +```cmd +# 双击运行 +快速启动.bat +``` + +## 📖 使用指南 + +### 基础操作 + +1. **智能对话** + - 在"智能对话"页面输入问题 + - 系统自动检索知识库并生成回答 + - 支持VIN码识别和车辆数据查询 + +2. **工单管理** + - 创建工单并获取AI建议 + - 人工输入解决方案 + - 系统自动评估相似度并更新知识库 + +3. **知识库维护** + - 手动添加Q&A对 + - 上传文档自动提取知识 + - 设置置信度和验证状态 + +4. **系统监控** + - 查看实时性能趋势 + - 监控系统健康状态 + - 管理预警和通知 + +### 高级功能 + +1. **Agent工具管理** + - 查看工具使用统计 + - 注册自定义工具 + - 监控执行历史 + +2. **数据分析** + - 多维度数据统计 + - 自定义时间范围 + - 导出分析报告 + +3. **系统配置** + - API和模型参数配置 + - 端口和日志级别设置 + - 环境变量管理 + +## 🔄 部署与更新 + +### 多环境部署 +```bash +# 开发环境 +python scripts/update_manager.py auto-update --source . --environment development + +# 测试环境 +python scripts/update_manager.py auto-update --source . --environment staging + +# 生产环境 +python scripts/update_manager.py auto-update --source . --environment production +``` + +### 版本管理 +```bash +# 更新版本号 +python version.py increment --type minor + +# 添加变更日志 +python version.py changelog --message "新功能描述" + +# 创建发布标签 +python version.py tag --message "Release v1.3.0" +``` + +### 热更新 +```bash +# 热更新（无需重启） +python scripts/update_manager.py hot-update --source ./new_version --environment production + +# 自动更新（智能选择） +python scripts/update_manager.py auto-update --source ./new_version --environment production +``` + +## 📊 系统监控 + +### 健康检查 +- **API状态**: `/api/health` +- **服务监控**: 自动健康检查和故障恢复 +- **性能指标**: 响应时间、吞吐量、错误率 + +### 日志管理 +- **应用日志**: `logs/tsp_assistant.log` +- **访问日志**: Nginx访问日志 +- **错误追踪**: 详细的错误堆栈信息 + +## 🔧 配置说明 + +### 环境变量 +```bash +# 数据库配置 +DATABASE_URL=sqlite:///tsp_assistant.db + +# LLM配置 +LLM_PROVIDER=openai +LLM_API_KEY=your_api_key +LLM_MODEL=gpt-3.5-turbo + +# 服务配置 +SERVER_PORT=5000 +WEBSOCKET_PORT=8765 +LOG_LEVEL=INFO +``` + +### 配置文件 +- `config/llm_config.py`: LLM客户端配置 +- `update_config.json`: 更新管理器配置 +- `version.json`: 版本信息配置 + +## 🤝 贡献指南 + +### 开发流程 +1. Fork项目到个人仓库 +2. 创建功能分支: `git checkout -b feature/new-feature` +3. 提交更改: `git commit -m "Add new feature"` +4. 推送分支: `git push origin feature/new-feature` +5. 创建Pull Request + +### 代码规范 +- Python代码遵循PEP 8规范 +- JavaScript使用ES6+语法 +- 提交信息使用约定式提交格式 +- 新功能需要添加相应的测试 + +## 📝 更新日志 + +### v1.2.0 (2025-09-16) +- ✅ 系统设置扩展：API管理、模型参数配置、端口管理 +- ✅ 真实数据分析：修复性能趋势图表显示问题 +- ✅ 工单AI建议功能：智能生成处理建议 +- ✅ 知识库搜索优化：提升检索准确率 +- ✅ Agent管理改进：工具使用统计和自定义工具 + +### v1.1.0 (2025-09-16) +- ✅ 工单AI建议功能 +- ✅ 知识库搜索优化 +- ✅ Agent管理改进 + +### v1.0.0 (2024-01-01) +- ✅ 初始版本发布 + +## 📄 许可证 + +本项目采用 MIT 许可证 - 查看 [LICENSE](LICENSE) 文件了解详情 + +## 📞 支持与联系 + +- **项目地址**: http://jeason.online:3000/zhaojie/assist +- **问题反馈**: 请在Issues中提交问题 +- **功能建议**: 欢迎提交Feature Request + +## 🙏 致谢 + +感谢所有为项目做出贡献的开发者和用户！ + +--- + +**TSP智能助手** - 让车辆服务更智能，让客户体验更美好！ 🚗✨