first commit
This commit is contained in:
142
requirements-analysis.md
Normal file
142
requirements-analysis.md
Normal file
@@ -0,0 +1,142 @@
|
||||
# 智能算法展示平台需求分析
|
||||
|
||||
## 1. 产品概述
|
||||
|
||||
智能算法展示平台是一个面向客户的算法能力可视化呈现系统，同时兼顾内部算法管理。平台通过「仿真输入 - 一键调用 - 效果可视化」的核心链路，让客户快速感知算法价值，同时为内部团队提供算法API管理能力。
|
||||
|
||||
**核心定位：**
|
||||
- **对外：** 算法能力展示窗口，适配ML/强化学习/计算机视觉等全类型算法
|
||||
- **对内：** 算法API管理台，支持算法API的注册、版本管理、调用监控、权限配置
|
||||
|
||||
## 2. 核心功能需求
|
||||
|
||||
### 2.1 前端客户展示层
|
||||
|
||||
#### 2.1.1 仿真输入获取模块
|
||||
- **OpenAI集成：** 接入OpenAI API，支持通过文本描述生成仿真输入数据
|
||||
- **多类型数据输入：** 支持图片、文本、结构化数据等多种类型的输入
|
||||
- **输入模板：** 提供预设的输入模板，方便客户快速测试
|
||||
|
||||
#### 2.1.2 算法调用模块
|
||||
- **算法目录：** 展示可用的算法列表，包含算法描述、适用场景等信息
|
||||
- **一键调用：** 支持选择算法和输入数据后一键执行
|
||||
- **参数配置：** 允许客户调整算法参数，测试不同参数下的效果
|
||||
|
||||
#### 2.1.3 效果展示模块
|
||||
- **多维度可视化：** 支持图表、图像对比、数值分析等多种展示方式
|
||||
- **效果对比：** 支持同输入下不同算法的效果对比，或同算法不同参数的效果对比
|
||||
- **历史记录：** 保存客户的测试历史，方便查看和比较
|
||||
|
||||
### 2.2 后端核心服务层
|
||||
|
||||
#### 2.2.1 API网关
|
||||
- **请求路由：** 根据请求路径和参数，将请求路由到对应的算法服务
|
||||
- **认证授权：** 验证用户身份和权限，确保API调用安全
|
||||
- **流量控制：** 限制API调用频率，防止系统过载
|
||||
|
||||
#### 2.2.2 服务管理
|
||||
- **服务管理：** 管理算法服务的基本配置和状态
|
||||
|
||||
#### 2.2.3 数据管理
|
||||
- **输入数据存储：** 存储客户上传的输入数据
|
||||
- **输出结果存储：** 存储算法执行的结果数据
|
||||
- **元数据管理：** 管理算法、输入、输出的元数据信息
|
||||
|
||||
#### 2.2.4 监控与日志
|
||||
- **调用监控：** 监控API调用情况，包括调用次数、响应时间、成功率等
|
||||
- **日志管理：** 记录系统运行日志，方便问题排查
|
||||
|
||||
### 2.3 算法API层
|
||||
|
||||
#### 2.3.1 算法注册
|
||||
- **算法信息管理：** 管理算法的基本信息，如名称、描述、版本等
|
||||
- **API规范定义：** 定义算法API的请求和响应格式
|
||||
- **部署配置：** 配置算法的部署方式和运行环境
|
||||
|
||||
#### 2.3.2 版本管理
|
||||
- **版本控制：** 支持算法的多版本管理，允许回滚到历史版本
|
||||
- **版本切换：** 允许在不同版本间切换，测试不同版本的效果
|
||||
|
||||
#### 2.3.3 权限配置
|
||||
- **访问控制：** 配置不同用户对算法的访问权限
|
||||
- **密钥管理：** 管理API调用所需的密钥
|
||||
|
||||
## 3. 非功能需求
|
||||
|
||||
### 3.1 性能需求
|
||||
- **响应时间：** 算法调用响应时间不超过5秒（不含算法执行时间）
|
||||
- **并发处理：** 支持至少100个并发请求
|
||||
- **可扩展性：** 系统架构支持水平扩展，以应对增长的用户量和算法数量
|
||||
|
||||
### 3.2 安全需求
|
||||
- **认证机制：** 实现基于JWT的认证机制
|
||||
- **数据加密：** 对敏感数据进行加密存储
|
||||
- **API安全：** 防止API滥用和恶意攻击
|
||||
|
||||
### 3.3 可用性需求
|
||||
- **系统可用性：** 系统可用性达到99.9%
|
||||
- **故障恢复：** 系统具备故障自动恢复能力
|
||||
|
||||
### 3.4 可维护性需求
|
||||
- **模块化设计：** 系统采用模块化设计，便于维护和升级
|
||||
- **日志管理：** 完善的日志系统，便于问题排查
|
||||
- **文档完整：** 提供完整的系统文档和API文档
|
||||
|
||||
## 4. 用户场景
|
||||
|
||||
### 4.1 客户场景
|
||||
1. **场景一：新客户了解算法能力**
|
||||
- 客户访问平台，浏览可用的算法列表
|
||||
- 选择感兴趣的算法，查看算法描述和适用场景
|
||||
- 使用平台提供的输入模板或通过OpenAI生成仿真输入
|
||||
- 一键调用算法，查看执行结果和可视化效果
|
||||
- 对比不同算法或不同参数下的效果
|
||||
|
||||
2. **场景二：潜在客户测试定制需求**
|
||||
- 客户上传自定义的输入数据
|
||||
- 选择相关算法进行测试
|
||||
- 调整算法参数，测试不同配置下的效果
|
||||
- 保存测试历史，与平台管理员沟通定制需求
|
||||
|
||||
### 4.2 内部管理员场景
|
||||
1. **场景一：算法注册与管理**
|
||||
- 管理员登录后台，注册新的算法
|
||||
- 配置算法的基本信息、API规范和部署参数
|
||||
- 管理算法的版本，发布新版本或回滚到历史版本
|
||||
- 配置算法的访问权限，控制谁可以访问该算法
|
||||
|
||||
2. **场景二：系统监控与分析**
|
||||
- 管理员查看API调用监控面板，了解系统运行状态
|
||||
- 分析算法调用情况，识别热门算法和潜在问题
|
||||
- 查看系统日志，排查和解决问题
|
||||
|
||||
## 5. 业务目标
|
||||
|
||||
### 5.1 对外目标
|
||||
- **提升算法可见性：** 通过可视化展示，让客户直观了解算法能力
|
||||
- **加速销售周期：** 减少客户评估算法的时间，加速销售决策
|
||||
- **扩大市场覆盖：** 通过在线展示，扩大算法的市场覆盖范围
|
||||
- **收集客户反馈：** 通过客户测试，收集算法改进的反馈
|
||||
|
||||
### 5.2 对内目标
|
||||
- **统一算法管理：** 集中管理所有算法API，提高管理效率
|
||||
- **优化资源分配：** 基于调用情况，优化算法资源分配
|
||||
- **促进算法迭代：** 通过监控和反馈，促进算法的持续迭代
|
||||
- **降低运营成本：** 自动化算法管理流程，降低运营成本
|
||||
|
||||
## 6. 范围限定
|
||||
|
||||
### 6.1 功能范围
|
||||
- **包含：** 算法展示、API管理、仿真输入、效果可视化、调用监控、开发SDK和工具
|
||||
- **不包含：** 算法开发环境、模型训练、数据标注工具
|
||||
|
||||
### 6.2 技术范围
|
||||
- **前端：** Vue3 + TypeScript + Vite + Pinia + Element Plus
|
||||
- **后端：** 基于Python的Web框架
|
||||
- **API管理：** OpenAPI规范，独立维护API文档
|
||||
- **数据存储：** PostgreSQL（结构化数据）、Redis（缓存）、MinIO（非结构化数据）
|
||||
|
||||
### 6.3 业务范围
|
||||
- **目标用户：** 外部客户、内部算法团队、销售团队
|
||||
- **适用算法：** ML算法、强化学习算法、计算机视觉算法等
|
||||
- **不适用：** 实时控制算法、需要特殊硬件的算法
|
||||
Reference in New Issue
Block a user