Update from Vibe Studio
This commit is contained in:
127
错别字检测系统使用说明.md
Normal file
127
错别字检测系统使用说明.md
Normal file
@@ -0,0 +1,127 @@
|
||||
# 错别字检测与修正系统 - 使用说明
|
||||
|
||||
## 系统概述
|
||||
|
||||
错别字检测与修正系统是一个基于AI技术的智能文本校对工具,能够自动识别中文文本中的错别字并提供修正建议。
|
||||
|
||||
## 功能特点
|
||||
|
||||
### 核心功能
|
||||
- **智能检测**:自动识别文本中的错别字
|
||||
- **上下文分析**:提供错误词在原文中的上下文信息
|
||||
- **修正建议**:为每个错别字提供准确的修正建议
|
||||
- **错误分类**:可选择启用错别字类型分类(如:同音字、形近字等)
|
||||
- **用户反馈**:支持用户对修正建议进行确认或否决
|
||||
- **批量处理**:支持多段文本的批量检测
|
||||
|
||||
### 交互功能
|
||||
- **实时反馈**:用户可以逐条确认或否决检测结果
|
||||
- **结果统计**:自动统计确认和否决的反馈数据
|
||||
- **本地存储**:反馈数据自动保存到本地存储
|
||||
|
||||
## 页面结构
|
||||
|
||||
### 1. 页面标题区
|
||||
- 居中显示蓝色标题"错别字检测与修正系统"
|
||||
|
||||
### 2. 参数输入区
|
||||
- **待检测文本**:大型文本输入框,支持多段文本
|
||||
- **配置选项**:
|
||||
- 是否启用分类:控制是否显示错别字类型
|
||||
- 是否启用建议:控制是否提供修正建议(默认启用)
|
||||
- 是否启用批量处理:控制是否支持多段文本处理
|
||||
|
||||
### 3. 操作按钮区
|
||||
- **检测按钮**:触发错别字检测流程
|
||||
- **重置按钮**:清空表单和结果
|
||||
|
||||
### 4. 内容展示区
|
||||
- **检测结果表格**:展示所有检测到的错别字
|
||||
- **表格列**:
|
||||
- 错误词:显示识别到的错别字(红色高亮)
|
||||
- 上下文:显示错别字在原文中的位置和上下文
|
||||
- 建议词:显示系统提供的修正建议(绿色高亮)
|
||||
- 错误类型:显示错别字分类(如适用)
|
||||
- 操作:提供确认/否决按钮供用户反馈
|
||||
- **反馈提交按钮**:提交用户反馈数据
|
||||
|
||||
## 使用方法
|
||||
|
||||
### 基本流程
|
||||
|
||||
1. **输入文本**
|
||||
- 在"待检测文本"区域输入需要检测的文本内容
|
||||
- 文本支持中文,可包含多段内容
|
||||
|
||||
2. **配置选项**
|
||||
- 根据需要开启/关闭各项功能开关
|
||||
- 默认启用"是否启用建议"
|
||||
|
||||
3. **开始检测**
|
||||
- 点击"检测"按钮
|
||||
- 系统将发送请求到Dify AI平台
|
||||
- 等待流式响应返回检测结果
|
||||
|
||||
4. **查看结果**
|
||||
- 检测完成后,结果将显示在下方表格中
|
||||
- 表格显示错误词、上下文、建议词、错误类型等信息
|
||||
|
||||
5. **提交反馈**
|
||||
- 对每条检测结果点击"确认"或"否决"
|
||||
- 点击"提交反馈"按钮保存反馈数据
|
||||
- 数据将自动保存到本地存储
|
||||
|
||||
### API配置
|
||||
|
||||
- **请求地址**:https://copilot.sino-bridge.com/v1/chat-messages
|
||||
- **鉴权方式**:Bearer Token (app-YOaqLN0ZBsMozXCoYJqogwiA)
|
||||
- **请求方式**:POST
|
||||
- **响应模式**:流式 (streaming)
|
||||
|
||||
## 技术实现
|
||||
|
||||
### 前端技术栈
|
||||
- React 18 + TypeScript
|
||||
- Ant Design 5.x(UI组件库)
|
||||
- Tailwind CSS 4.x(样式框架)
|
||||
- React Router DOM 6.x(路由管理)
|
||||
|
||||
### 核心特性
|
||||
- **流式数据处理**:实时接收和解析Dify平台的流式响应
|
||||
- **响应式设计**:自适应不同屏幕尺寸
|
||||
- **类型安全**:完整的TypeScript类型定义
|
||||
- **模块化设计**:清晰的API和组件分离
|
||||
|
||||
## 文件结构
|
||||
|
||||
```
|
||||
src/
|
||||
├── api/
|
||||
│ └── spell-check-system.ts # API接口定义
|
||||
├── pages/
|
||||
│ └── spell-check-system/
|
||||
│ └── index.tsx # 主页面组件
|
||||
└── router/
|
||||
└── index.tsx # 路由配置
|
||||
```
|
||||
|
||||
## 访问路径
|
||||
|
||||
- 主页导航:`/` → 选择"错别字检测与修正系统"卡片
|
||||
- 直接访问:`/#/spell-check-system`
|
||||
|
||||
## 注意事项
|
||||
|
||||
1. **文本长度**:建议单次检测的文本长度不超过合理范围,以保证检测效果
|
||||
2. **网络连接**:需要稳定的网络连接以访问Dify AI服务
|
||||
3. **浏览器兼容性**:推荐使用现代浏览器(Chrome、Firefox、Safari、Edge)
|
||||
4. **数据存储**:用户反馈数据仅保存在本地浏览器存储中
|
||||
|
||||
## 更新日志
|
||||
|
||||
### v1.0.0
|
||||
- 初始版本发布
|
||||
- 实现基础的错别字检测功能
|
||||
- 支持流式数据处理
|
||||
- 添加用户反馈系统
|
||||
- 集成Dify AI平台
|
||||
Reference in New Issue
Block a user