一款基于 Electron、Vue 3 和 TypeScript 构建的智能长文档校对桌面应用程序
## 📝 项目简介 AutoDocxProofread（智能校对）是一款专为长文档校对而设计的桌面应用程序。它能够帮助用户有效检测 Word 文档中的错别字、标点符号错误、语法问题和文本一致性问题，并提供修改建议。 针对大模型在处理长文档时存在的遗忘和幻觉问题，软件设计了专门的架构来增强校对的准确性，并能一键导出校对修改后的文档。并且软件采用了并行处理架构，显著提升大模型处理长文档的速度。此外还引入了本地知识库功能，支持RAG功能给模型校对参考。 ### 核心优势 为什么需要使用这个软件？ 1. 相比使用claude code 调用skill 来对文档校对，这个软件界面更加直观，直接检视校对效果，并能够对结果逐个比对，选择接受或者拒绝校对意见。 2. 相比使用chatgpt、豆包等网页ai应用，这个项目校对流程优化固定，操作便捷，省去了和大模型反复交流的精力。 3. 相比于ms Office和wps等软件自带的校对系统，这个项目校对更加智能，对错误识别的种类更多样。 ### 使用展示 用户需要先在功能设置页面选择一个大模型后再开始校对操作。在文档校对页面，首先选择需要校对的文档后，再选择校对模式，选择使用的知识库（非必选），然后开始校对。软件会将校对的结果显示在右边栏，并在文本中高亮展示，以方便查看。然后可以选择是否接受这些修改，可以导出接受修改后的文档：  本应用可以自行设置api，兼容满足openai规范的api接口，推荐使用非推理模型，并且可以限制并发请求数量和请求评率：  可以设置校对的错误类型、严格程度和文本背景，也可以自行设置提示  本应用还可以浏览和管理校对记录：  深色模式：  > 注意：校对结果的准确度很大程度上取决于模型能力，软件无法保证校对结果的完全准确，还需要人工再次检验。 > 提示：结果导出功能可能存在疏漏，建议人工核验。 > 提示：全文润色功能适合较短篇幅的文档。逐句校对对token的消耗很大。 ### 主要功能 - **多种校对模式**： - 逐句精校：适合需要高精度校对的短文本 - 逐段校正：适合长篇文献的校对 - 全文润色：对整篇文档进行语言润色和优化 - **智能错误识别**： - 错别字检测 - 标点符号错误识别 - 语法问题检测 - **知识库系统**： - 创建和管理多个本地知识库 - 支持PDF、word和txt文档导入作为参考材料 - 基于向量数据库的RAG检索增强生成算法 - **更快的处理速度和用户友好的操作体验**： - 使用并行处理的方式优化处理效率，显著提升对于长文本的校对速度 - 清晰的错误展示和修改建议 - 一键应用修改建议，一键导出修改后的文档 - 校正参数可调，可以适应不同任务场景 - **便捷的 API 配置管理**： - 兼容openai接口，支持多种大语言模型 API - 灵活的 API 配置管理 - 支持对于并发数量和请求速度的设置 - **清晰的历史记录管理**： - 清晰查看历史记录，包括时间、校对模型、校对文件路径和具体的结果 - 支持对结果的批量管理 ## 🎯 使用指南 ### 1. 配置 API 首次使用需要配置支持的大语言模型 API： 1. 点击设置 2. 点击api选项 3. 填写 API 地址、密钥和模型名称 4. 点击"测试连接"验证配置 5. 点击"保存配置"保存设置 ### 2. 创建知识库 1. 点击导航栏中的"知识库" 2. 选择"Embedding模型"（需要选择专门的embedding模型） 3. 点击"添加知识库"按钮创建新知识库 4. 选择知识库后可添加PDF文件作为参考材料 ### 3. 文档校对 1. 选择"文档校对"选项卡 2. 点击"选择 DOCX 文件"按钮选择要校对的 Word 文档 3. （可选）选择知识库以增强校对准确性 4. 选择合适的校对模式： - **逐句精校**：适合需要高精度校对的短文本 - **逐段校正**：适合长篇文献的校对 - **全文润色**：对整篇文档进行语言润色和优化 5. 点击"开始校正"按钮开始校对过程 6. 在左侧栏查看校对结果和修改建议 7. 点击"应用修改"按钮接受建议的修改（也可以撤销） 8. 点击"导出结果"按钮保存修改后的文档 ### 4. 校正参数设置 1. 在“功能设置”页面点击提示词设置，可以选择不同的校正参数，例如文本背景、校正的严格程度和校正的错误类型 2. 也可以使用自己的提示词，使用自己的提示词的时候会关闭原始的的提示词，建议参考原始提示词进行修改，否则会影响软件的显示效果 3. 点击“恢复默认配置”可以重置上述设置 ### 更新记录 - v1.1.7 - 重构页面，使用体验更佳 - 中英文双语支持 - 新增更多的接口支持，支持模拟claude code接口请求 - v1.1.6 - 添加进度条，用户可以实时查看校对进度 - 优化api设置功能 - 优化提示词设置，更加清晰方便 - 点击校对结果可以直接跳转 - v1.1.5 - 优化文件导出功能的操作体验 - 优化文件导出逻辑，让错误替换更加准确 - v1.1.4 - 新增代理功能 - v1.1.3 - 新增了请求频率限制，优化对于第三方api转接站的支持 - 优化深色模式显示效果 - 新增token用量统计 - 优化界面效果，改善交互逻辑 - v1.1.2 - 修复全文润色模式中，不使用rag功能时无法正常校对的bug - 新增昼夜模式切换功能 - 模型并发限制可调，可以适应不同的api供应商对于并发的限制要求 - v1.1.1 - 修复rag功能可用性bug - v1.1.0 - 重构界面，优化使用逻辑 - 提升软件可用性 ## 🛠 技术栈 - **主框架**：[Electron](https://www.electronjs.org/) + [Vue 3](https://vuejs.org/) + [TypeScript](https://www.typescriptlang.org/) - **UI 组件库**：[Element Plus](https://element-plus.org/) - **构建工具**：[Vite](https://vitejs.dev/) + [Electron Forge](https://www.electronforge.io/) - **文档处理**：[Mammoth](https://github.com/mwilliamson/mammoth.js) + [Docxtemplater](https://github.com/open-xml-templating/docxtemplater) - **向量数据库**：[LanceDB](https://lancedb.com/) - **代码规范**：[ESLint](https://eslint.org/) + [Prettier](https://prettier.io/) - **版本管理**：[Standard Version](https://github.com/conventional-changelog/standard-version) ## 🚀 快速开始 ### 环境要求 - Node.js >= 16.x - npm 或 yarn ### 安装依赖 ```bash npm install ``` ### 开发模式运行 ```bash npm run start ``` ## 🔧 开发计划 - [ ] word文档格式校对 - [ ] 增强用户界面交互体验 （持续进行中） - [x] 优化.docx文件的处理算法 ## 📄 许可证 本项目采用 MIT 许可证 - 查看 [LICENSE](LICENSE) 文件了解详情 ## 🌺 致谢 部分代码使用了night-peiqi的https://github.com/night-peiqi/electron-vue3-typescript-template