在本页面设置提示词
3 |
3 |
4 |
8 |
9 |
10 | Detail
11 |
12 |
13 | Delete
14 |
15 |
16 |
17 |
18 |
24 |
31 |
32 |
33 |
34 |
35 |
118 |
119 |
--------------------------------------------------------------------------------
/src/main/main.ts:
--------------------------------------------------------------------------------
1 | import { app, BrowserWindow, session } from 'electron' // app是必须引入的，
2 | import path from 'path'
3 |
4 | // 将LanceDB原生模块路径添加到PATH环境变量，确保运行时能正确加载
5 |
6 | import { registerIpcHandlers } from './ipcHandlers'
7 | import { initLanceDB } from './lancedb'
8 | // main.js 或主进程中的其他文件
9 | // main.js 或打包入口
10 |
11 | // 为pdf-parse库提供浏览器API的polyfill
12 | // 为了在nodejs环境下正常使用pdf-parse库而添加的
13 | if (typeof (global as any).DOMMatrix === 'undefined') {
14 | ;(global as any).DOMMatrix = class DOMMatrix {
15 | constructor() {
16 | // 空实现
17 | }
18 | }
19 | }
20 |
21 | if (typeof (global as any).ImageData === 'undefined') {
22 | ;(global as any).ImageData = class ImageData {
23 | constructor() {
24 | // 空实现
25 | }
26 | }
27 | }
28 |
29 | if (typeof (global as any).Path2D === 'undefined') {
30 | ;(global as any).Path2D = class Path2D {
31 | constructor() {
32 | // 空实现
33 | }
34 | }
35 | }
36 |
37 | // Handle creating/removing shortcuts on Windows when installing/uninstalling.
38 | if (require('electron-squirrel-startup')) {
39 | app.quit()
40 | }
41 |
42 | const createWindow = () => {
43 | // Create the browser window.
44 | const mainWindow = new BrowserWindow({
45 | width: 1300,
46 | height: 1200,
47 | title: 'AutoDocxProofreading',
48 | // autoHideMenuBar: true, // 禁用菜单栏
49 | icon: path.join(process.resourcesPath, 'assets', 'logo.ico'),
50 |
51 | ...(process.platform === 'linux' ? { icon: path.join(process.resourcesPath, 'assets', 'logo.ico') } : {}),
52 |
53 | webPreferences: {
54 | preload: path.join(__dirname, 'preload.js'),
55 | nodeIntegration: false,
56 | contextIsolation: true
57 | },
58 | // 设置窗口样式
59 | // remove the default titlebar
60 | titleBarStyle: 'hidden',
61 | // expose window controls in Windows/Linux
62 | ...(process.platform !== 'darwin' ? { titleBarOverlay: true } : {}),
63 | titleBarOverlay: {
64 | color: 'rgba(255, 255, 255, 0)',
65 | symbolColor: '#807e85ff',
66 | height: 60
67 | }
68 | })
69 |
70 | // load the index.html of the app.
71 | if (MAIN_WINDOW_VITE_DEV_SERVER_URL) {
72 | mainWindow.loadURL(MAIN_WINDOW_VITE_DEV_SERVER_URL)
73 | // Open the DevTools.
74 | mainWindow.webContents.openDevTools()
75 | } else {
76 | mainWindow.loadFile(path.join(__dirname, `../renderer/${MAIN_WINDOW_VITE_NAME}/index.html`))
77 | }
78 | }
79 |
80 | app.whenReady().then(async () => {
81 | // 当应用准备好之后，回调函数
82 | console.log('app is ready')
83 | console.log('then will create a window')
84 |
85 | console.log('中文测试')
86 | createWindow()
87 |
88 | // 设置 Content-Security-Policy（CSP），跨站脚本攻击 (XSS) 和其他代码注入攻击
89 | session.defaultSession.webRequest.onHeadersReceived((details, callback) => {
90 | callback({
91 | responseHeaders: {
92 | ...details.responseHeaders,
93 | 'Content-Security-Policy': ["script-src 'self'"]
94 | }
95 | })
96 | })
97 | // 当窗口被激活的时候，要判断是否有窗口打开，如果没有打开，那么就创建一个窗口（也是针对苹果系统作出的优化）
98 | app.on('activate', () => {
99 | // On macOS it's common to re-create a window in the app when the
100 | // dock icon is clicked and there are no other windows open.
101 | if (BrowserWindow.getAllWindows().length === 0) {
102 | createWindow()
103 | }
104 | })
105 |
106 | // 判断是否为开发环境
107 | const isDev = MAIN_WINDOW_VITE_DEV_SERVER_URL !== undefined
108 |
109 | let nativeModulePath
110 | if (isDev) {
111 | // 开发环境：假设原生模块在项目根目录的 resources/ 下
112 | // const projectRoot = app.getAppPath(); // 项目根目录
113 | // nativeModulePath = path.join(projectRoot, 'resources', 'lancedb-win32-x64-msvc');
114 | // 开发环境不设置
115 | } else {
116 | // 生产环境：原生模块应位于 resources/ 目录下（且需 unpacked）
117 | const installDir = path.dirname(app.getPath('exe'))
118 | const resourcesPath = path.join(installDir, 'resources')
119 | nativeModulePath = path.join(resourcesPath, 'lancedb-win32-x64-msvc')
120 | }
121 |
122 | process.env.LANCEDB_NATIVE_PATH = nativeModulePath
123 | process.env.PATH = `${nativeModulePath};${process.env.PATH}`
124 |
125 | try {
126 | await initLanceDB()
127 | console.log('LanceDB initialized successfully')
128 | } catch (error) {
129 | console.error('Failed to initialize LanceDB:', error)
130 | }
131 | })
132 |
133 | // Quit when all windows are closed, except on macOS. There, it's common
134 | // for applications and their menu bar to stay active until the user quits
135 | // explicitly with Cmd + Q.
136 | app.on('window-all-closed', () => {
137 | // 当所有的窗口都关闭的时候并且不是macos的时候，那么关闭软件
138 | if (process.platform !== 'darwin') {
139 | app.quit()
140 | }
141 | })
142 |
143 | registerIpcHandlers()
144 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # AutoDocxProof 智能文档校对应用
2 |
3 |
19 | Delete All
20 |
21 |
22 |
23 | {{ detailContent }}
25 |
26 |
29 |
30 |
4 | 
5 |
8 | 一款基于 Electron、Vue 3 和 TypeScript 构建的智能长文档校对桌面应用程序 9 |
10 | 11 | ## 📝 项目简介 12 | 13 | AutoDocxProofread（智能校对）是一款专为长文档校对而设计的桌面应用程序。它能够帮助用户有效检测 Word 文档中的错别字、标点符号错误、语法问题和文本一致性问题，并提供修改建议。 14 | 15 | 针对大模型在处理长文档时存在的遗忘和幻觉问题，软件设计了专门的架构来增强校对的准确性，并能直接导出校对后的文档。并且软件采用了并行处理架构，显著提升大模型处理长文档的速度。新版本引入了本地知识库功能，支持RAG功能给模型校对参考。 16 | 17 | ### 更新记录 18 | 19 | - v1.1.3 20 | - 新增了请求频率限制，优化对于第三方api转接站的支持 21 | - 优化深色模式显示效果 22 | - 新增token用量统计 23 | - 优化界面效果，改善交互逻辑 24 | - v1.1.2 25 | - 修复全文润色模式中，不使用rag功能时无法正常校对的bug 26 | - 新增昼夜模式切换功能 27 | - 模型并发限制可调，可以适应不同的api供应商对于并发的限制要求 28 | - v1.1.1 29 | - 修复rag功能可用性bug 30 | - v1.1.0 31 | - 重构界面，优化使用逻辑 32 | - 提升软件可用性 33 | 34 | ### 核心功能与软件优势 35 | 36 | - **多种校对模式**： 37 | - 逐句精校：适合需要高精度校对的短文本 38 | - 逐段校正：适合长篇文献的校对 39 | - 全文润色：对整篇文档进行语言润色和优化 40 | 41 | - **智能错误识别**： 42 | - 错别字检测 43 | - 标点符号错误识别 44 | - 语法问题检测 45 | 46 | - **知识库系统**： 47 | - 创建和管理多个本地知识库 48 | - 支持PDF、word和txt文档导入作为参考材料 49 | - 基于向量数据库的RAG检索增强生成算法 50 | 51 | - **更快的处理速度和用户友好的操作体验**： 52 | - 使用并行处理的方式优化处理效率，显著提升对于长文本的校对速度 53 | - 清晰的错误展示和修改建议 54 | - 一键应用修改建议 55 | - 响应式设计，支持窗口缩放 56 | 57 | - **便捷的 API 配置管理**： 58 | - 兼容openai接口，支持多种大语言模型 API 59 | - 灵活的 API 配置管理 60 | - 支持对于并发数量和请求速度的设置 61 | 62 | - **清晰的历史记录管理**： 63 | - 清晰查看历史记录，包括时间、校对模型、校对文件路径和具体的结果 64 | - 支持对结果的批量管理 65 | 66 | ### 使用展示 67 | 68 | 用户需要先在功能设置页面选择一个大模型后再开始校对操作。在文档校对页面，首先选择需要校对的文档后，再选择校对模式，选择使用的知识库（非必选），然后开始校对。软件会将校对的结果显示在右边栏，并在文本中高亮展示，以方便查看。然后可以选择是否接受这些修改，可以导出接受修改后的文档： 69 | 70 |  71 | 72 | 本应用可以自行设置api，兼容满足openai规范的api接口，推荐使用非推理模型，并且可以限制并发请求数量： 73 | 74 |  75 |  76 | 77 | 本应用还可以浏览和管理校对记录： 78 | 79 |  80 | 81 | 知识库管理界面： 82 | 83 |  84 | 85 | 昼夜模式切换效果： 86 | 87 |  88 | 89 | > 注意：校对结果的准确度很大程度上取决于模型能力，软件无法保证校对结果的完全准确，还需要人工再次检验。 90 | 91 | > 提示1：结果导出功能尚不完善，无法精准的将所有的结果应用到文档中，可能存在疏漏。 92 | 93 | > 提示2：全文润色功能适合较短篇幅的文档。逐句校对对token的消耗很大。 94 | 95 | ## 🛠 技术栈 96 | 97 | - **主框架**：[Electron](https://www.electronjs.org/) + [Vue 3](https://vuejs.org/) + [TypeScript](https://www.typescriptlang.org/) 98 | - **UI 组件库**：[Element Plus](https://element-plus.org/) 99 | - **构建工具**：[Vite](https://vitejs.dev/) + [Electron Forge](https://www.electronforge.io/) 100 | - **文档处理**：[Mammoth](https://github.com/mwilliamson/mammoth.js) + [Docxtemplater](https://github.com/open-xml-templating/docxtemplater) 101 | - **向量数据库**：[LanceDB](https://lancedb.com/) 102 | - **代码规范**：[ESLint](https://eslint.org/) + [Prettier](https://prettier.io/) 103 | - **版本管理**：[Standard Version](https://github.com/conventional-changelog/standard-version) 104 | 105 | ## 🚀 快速开始 106 | 107 | ### 环境要求 108 | 109 | - Node.js >= 16.x 110 | - npm 或 yarn 111 | 112 | ### 安装依赖 113 | 114 | ```bash 115 | npm install 116 | ``` 117 | 118 | ### 开发模式运行 119 | 120 | ```bash 121 | npm run start 122 | ``` 123 | 124 | ## 📦 项目结构 125 | 126 | ``` 127 | . 128 | ├── src/ 129 | │ ├── main/ # 主进程代码 130 | │ │ ├── chat.ts # AI 对话相关功能 131 | │ │ ├── database.ts # 数据库操作 132 | │ │ ├── ipcHandlers.ts # IPC 通信处理 133 | │ │ ├── lancedb.ts # 向量数据库操作 134 | │ │ ├── main.ts # 主进程入口 135 | │ │ ├── pdfUtils.ts # PDF文档处理 136 | │ │ ├── preload.ts # 预加载脚本 137 | │ │ ├── proof.ts # 文档校对核心逻辑 138 | │ │ └── wordProcess.ts # Word 文档处理 139 | │ └── renderer/ # 渲染进程代码 140 | │ ├── router/ # 路由配置 141 | │ ├── stores/ # Pinia存储目录 142 | │ ├── views/ # 页面组件 143 | │ ├── App.vue # 根组件 144 | │ └── renderer.ts # 渲染进程入口 145 | ├── assets/ # 静态资源 146 | ├── out/ # 构建输出目录 147 | └── forge.config.ts # Electron Forge 配置 148 | ``` 149 | 150 | ## 🎯 使用指南 151 | 152 | ### 1. 配置 API 153 | 154 | 首次使用需要配置支持的大语言模型 API： 155 | 156 | 1. 点击导航栏中的"工作区" 157 | 2. 选择"API 设置"选项卡 158 | 3. 填写 API 地址、密钥和模型名称 159 | 4. 点击"测试连接"验证配置 160 | 5. 点击"保存配置"保存设置 161 | 162 | ### 2. 创建知识库 163 | 164 | 1. 点击导航栏中的"知识库" 165 | 2. 选择"Embedding模型"（需要选择专门的embedding模型） 166 | 3. 点击"添加知识库"按钮创建新知识库 167 | 4. 选择知识库后可添加PDF文件作为参考材料 168 | 169 | ### 3. 文档校对 170 | 171 | 1. 点击导航栏中的"工作区" 172 | 2. 选择"文档校对"选项卡 173 | 3. 点击"选择 DOCX 文件"按钮选择要校对的 Word 文档 174 | 4. （可选）选择知识库以增强校对准确性 175 | 5. 选择合适的校对模式： 176 | - **逐句精校**：适合需要高精度校对的短文本 177 | - **逐段校正**：适合长篇文献的校对 178 | - **全文润色**：对整篇文档进行语言润色和优化 179 | 6. 点击"开始校正"按钮开始校对过程 180 | 7. 在右侧栏查看校对结果和修改建议 181 | 8. 点击"应用修改"按钮接受建议的修改 182 | 9. 点击"导出结果"按钮保存修改后的文档 183 | 184 | ## 🔧 开发计划 185 | 186 | 1. 大语言模型的格式化输出转word文档 187 | 2. 增强用户界面交互体验 188 | 3. 优化.docx文件的处理算法 189 | 190 | ## 📄 许可证 191 | 192 | 本项目采用 MIT 许可证 - 查看 [LICENSE](LICENSE) 文件了解详情 193 | 194 | ## 致谢 195 | 196 | 部分代码使用了night-peiqi的https://github.com/night-peiqi/electron-vue3-typescript-template 197 | -------------------------------------------------------------------------------- /src/renderer/electron.d.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * Electron API 类型支持应与 preload.ts 中的API一致 3 | * 你需要告诉 TypeScript,windows 类型中心增加的属性和接口情况 4 | * 防止运行时错误 5 | */ 6 | import { proofreadLargeDocument, ProofreadingCorrection } from './proof' 7 | import { apiSettings } from './ipcHandlers' 8 | 9 | export interface proofHistory { 10 | id?: number 11 | filePath: string 12 | apiURL: string 13 | modelName: string 14 | created_at?: string 15 | result: string 16 | } 17 | 18 | // LanceDB 相关接口类型定义 19 | export interface LanceDBInsertParams { 20 | repositoryName: string 21 | fileName: string 22 | text: string 23 | metadata: Record
3 |
4 |
74 |
75 |
76 |
77 |
108 |
109 |
--------------------------------------------------------------------------------
/src/main/preload.ts:
--------------------------------------------------------------------------------
1 | import { contextBridge, ipcRenderer } from 'electron'
2 | import { get } from 'http'
3 | import test from 'node:test'
4 | import { setNewPrompt } from './proof'
5 | import { apiSettings } from './database'
6 |
7 | console.log('this message from the preload')
8 |
9 | // contextBridge.exposeInMainWorld 是一个安全机制，它允许你在预加载脚本中定义一些函数或对象，并将它们注入到网页的全局 window 对象中。
10 | // 第一个参数 electronAPI 表示将要挂载到window上的属性名称
11 | // 第二个参数，是一个对象，包含了想要暴露给前端的函数或者值
12 | contextBridge.exposeInMainWorld('electronAPI', {
13 | // 定义了一个名叫message的方法，接受字符串参数message
14 | message: (message: string) => {
15 | // 向主进程发送消息，单向通信方式
16 | // 发送的消息，通道名称是message，数据是传入的message的字符串
17 | ipcRenderer.send('message', message) // 调用主进程的接口，向主进程发送一条 *异步* 消息
18 | },
19 | // 定义了一个名叫receiveAndReturn的方法，接受字符串参数message，然后返回一个字符串
20 | receiveAndReturn: (message: string) => {
21 | // 使用ipcRenderer.invoke()方法，调用主进程的接口，向主进程发送一条 *双向通讯请求* 的消息 （也是异步）
22 | // 向主进程发送消息，并返回处理结果，双向通信方式
23 | return ipcRenderer.invoke('receiveAndReturn', message) // invoke会等待主进程使用ipcMain。handle 返回一个promise的值
24 | // 由于返回的是一个promise 所以前端需要await它
25 | },
26 | test: process.version,
27 |
28 | selectDocxFile: () => ipcRenderer.invoke('select-docx-file'),
29 | // 可选：如果需要主进程读取文件内容
30 | readDocxFile: (filePath: string) => ipcRenderer.invoke('read-docx-file', filePath),
31 | APISettings: (url: string, key: string, modelName: string) =>
32 | ipcRenderer.invoke('set-api', url, key, modelName),
33 | getALLAPISettings: () => ipcRenderer.invoke('get-all-api-settings', {}),
34 | deleteOneAPI: (id: number) => ipcRenderer.invoke('delete-one-api-setting', id),
35 | testAPI: (url: string, key: string, modelName: string) => ipcRenderer.invoke('test-api', url, key, modelName),
36 | selectAPISetting: (url: string, key: string, modelName: string, parallel?: number, TimeLimit?: number | null) =>
37 | ipcRenderer.invoke('selectAPISetting', url, key, modelName, parallel, TimeLimit),
38 | getAPISettings: () => ipcRenderer.invoke('get-api-settings', {}),
39 | // 文档校对处理函数
40 | processDocx: (
41 | model: string,
42 | filePath: string,
43 | repositoryNameList?: string[],
44 | embeddingConfig?: apiSettings,
45 | setTimeLimit?: number,
46 | parallelSet?: number
47 | ) => {
48 | // 确保传递的参数是可序列化的
49 | const serializableParams = {
50 | model,
51 | filePath,
52 | repositoryNameList: repositoryNameList ? [...repositoryNameList] : undefined,
53 | embeddingConfig: embeddingConfig ? { ...embeddingConfig } : undefined,
54 | setTimeLimit: setTimeLimit || undefined,
55 | parallelSet: parallelSet || 30
56 | }
57 |
58 | return ipcRenderer.invoke(
59 | 'process-docx',
60 | serializableParams.model,
61 | serializableParams.filePath,
62 | serializableParams.repositoryNameList,
63 | serializableParams.embeddingConfig,
64 | serializableParams.setTimeLimit,
65 | serializableParams.parallelSet
66 | )
67 | },
68 |
69 | // 导出修正到文件中
70 | exportCorrectedDocx: (config: any) => {
71 | // 确保传递的参数是可序列化的
72 | const serializableConfig = JSON.parse(JSON.stringify(config))
73 | return ipcRenderer.invoke('exportCorrectedDocx', serializableConfig)
74 | },
75 | // 获取默认的提示词
76 | getDefaultPrompt: () => ipcRenderer.invoke('getDefaultPrompt'),
77 | // 设置新的提示词
78 | setNewPrompt: (prompt: string) => ipcRenderer.invoke('setPrompt', prompt),
79 | // 获取所有历史记录
80 | deleteAllHistory: () => ipcRenderer.invoke('deleteAllHistory'),
81 | // 获取所有历史记录
82 | getAllHistory: () => ipcRenderer.invoke('getAllHistory'),
83 | // 获取指定id的历史记录
84 | getHistoryById: (id: number) => ipcRenderer.invoke('getHistoryById', id),
85 | // 删除指定id的历史记录,
86 | deleteHistoryById: (id: number) => ipcRenderer.invoke('deleteHistoryById', id),
87 | // 插入一条历史记录
88 | insertOneHistory: (filePath: string, apiURL: string, modelName: string, resultCorrect: string) =>
89 | ipcRenderer.invoke('insertOneHistory', filePath, apiURL, modelName, resultCorrect),
90 |
91 | // LanceDB 相关接口
92 | lancedbInsert: (params: any, modelConfig: any) => ipcRenderer.invoke('lancedb:insert', params, modelConfig),
93 | lancedbQuery: (params: any, modelConfig: any) => ipcRenderer.invoke('lancedb:query', params, modelConfig),
94 | lancedbUpdate: (params: any, modelConfig: any) => ipcRenderer.invoke('lancedb:update', params, modelConfig),
95 | lancedbDelete: (params: any) => ipcRenderer.invoke('lancedb:delete', params),
96 | listRepositories: () => ipcRenderer.invoke('listRepositories'),
97 | createRepository: (params: any) => ipcRenderer.invoke('createRepository', params),
98 | deleteRepository: (repositoryName: string) => ipcRenderer.invoke('deleteRepository', repositoryName),
99 | deleteDocumentByName: (repositoryName: string, filename: string) =>
100 | ipcRenderer.invoke('deleteDocumentByName', repositoryName, filename),
101 | listFilenamesInRepository: (repositoryName: string) =>
102 | ipcRenderer.invoke('listFilenamesInRepository', repositoryName),
103 | // PDF 处理相关接口
104 | processPDF: (params: any, modelConfig: any) => ipcRenderer.invoke('pdf:process', params, modelConfig),
105 | selectAndProcessPDF: (repositoryName: string, modelConfig: any) =>
106 | ipcRenderer.invoke('pdf:select-and-process', repositoryName, modelConfig),
107 | getPDFChunks: (params: any) => ipcRenderer.invoke('pdf:get-chunks', params),
108 | setEmbeddingAPI: (apiKey: string, apiURL: string, modelName: string) =>
109 | ipcRenderer.invoke('setEmbeddingAPI', apiKey, apiURL, modelName),
110 | getEmbeddingAPI: () => ipcRenderer.invoke('getEmbeddingAPI'),
111 | getEnvPath: () => ipcRenderer.invoke('getEnvPath') // 调试用，检验打包后的
112 | })
113 |
--------------------------------------------------------------------------------
/src/main/database.ts:
--------------------------------------------------------------------------------
1 | import { app } from 'electron' // 新增导入
2 | import { Database, open } from 'sqlite'
3 | import sqlite3 from 'sqlite3'
4 | import path from 'path' // 新增导入
5 | import fs from 'fs'
6 | import { promises } from 'dns'
7 | import { b } from 'vite/dist/node/types.d-aGj9QkWt'
8 | import { getEmbedding } from './chat'
9 |
10 | // 定义数据类型（TypeScript 类型安全）
11 | export interface User {
12 | id?: number
13 | name: string
14 | email: string
15 | created_at?: string
16 | }
17 |
18 | export interface apiSettings {
19 | id?: number
20 | apiURL: string
21 | apiKey: string
22 | modelName: string
23 | created_at?: string
24 | }
25 |
26 | export interface proofHistory {
27 | id?: number
28 | filePath: string
29 | apiURL: string
30 | modelName: string
31 | created_at?: string
32 | result: string
33 | }
34 |
35 | // 该类实现了对api数据和历史记录的数据库的管理操作
36 | export class DB {
37 | private static instance: Database
38 | // 使用系统标准路径
39 | private static get DB_PATH(): string {
40 | // 获取系统标准用户数据目录
41 | const userDataPath = app.getPath('userData')
42 | // 创建 data 子目录（避免污染根目录）
43 | return path.join(userDataPath, 'data', 'app.db')
44 | }
45 | static async getInstance(): Promise
5 |
6 |
15 |
16 |
17 |
19 | 文档校对
20 |
21 |
22 |
23 |
25 | 历史记录
26 |
27 |
28 |
29 |
31 | 本地知识库
32 |
33 |
34 |
35 |
37 | 功能设置
38 |
39 |
40 |
41 |
42 |
43 |
44 |
46 | 关于应用
47 |
48 |
49 |
50 |
54 |
55 |
57 |
58 |
60 |
61 |
62 |
63 |
64 |
65 |
66 |
67 |
68 |
69 |
70 |
7 | 
8 | 智能校对
9 |
10 |
11 |
12 |
8 | 智能校对
9 | 明暗模式切换
51 | 52 |
71 |
73 |
211 |
237 |
238 |
417 |
418 |
419 |
--------------------------------------------------------------------------------
/src/renderer/views/About.vue:
--------------------------------------------------------------------------------
1 |
2 | Word文档章节标题提取器
212 | 213 |
214 |
215 |
220 |
221 |
222 |
226 |
227 | 点击选择或拖拽Word文档到此处
216 | 217 | 218 |支持格式：.docx
219 |
228 | 提示：此工具会自动提取Word文档中的章节标题（H1-H6级别）。
229 | 处理过程中可能会显示一些警告信息，这些是正常的，不会影响标题提取功能。
230 |
231 |
232 |
236 |
3 |
11 |
12 |
13 |
24 |
25 |
31 |
32 |
38 |
39 |
45 |
46 |
53 |
54 |
59 |
60 |
65 |
66 |
67 |
74 |
75 |
76 |
77 |
78 |
80 |
81 | Electron +
82 | Vue 3 +
83 | TypeScript
84 |
85 |
86 | Element Plus
87 |
88 |
89 | Vite +
90 | Electron Forge
91 |
92 |
93 | Mammoth
94 | +
95 | Docxtemplater
97 |
98 |
99 | LanceDB
100 |
101 |
102 | ESLint +
103 | Prettier
104 |
105 |
106 | Standard Version
108 |
109 |
110 |
111 |
112 |
113 |
114 |
115 | npm install
124 |
125 | npm run start
127 |
128 |
129 |
130 |
131 |
133 |
134 |
135 |
146 |
147 |
148 |
156 |
157 |
158 |
171 |
172 |
173 |
174 |
175 |
176 |
177 |
188 | 项目地址：https://github.com/CZ600/AutoDocxProofread
189 |
190 |
194 | https://github.com/night-peiqi/electron-vue3-typescript-template
195 |
196 |
199 |
200 |
201 |
202 |
203 |
204 |
267 |
268 |
347 |
--------------------------------------------------------------------------------
/src/main/lancedb.ts:
--------------------------------------------------------------------------------
1 | import { app } from 'electron'
2 | import path from 'path'
3 | import { getEmbedding } from './chat'
4 | import * as arrow from 'apache-arrow'
5 |
6 | let lancedb: typeof import('@lancedb/lancedb') | null = null
7 |
8 | async function getLanceDB() {
9 | if (!lancedb) {
10 | try {
11 | lancedb = await import('@lancedb/lancedb')
12 | } catch (error) {
13 | console.error('Failed to import LanceDB:', error)
14 | throw error
15 | }
16 | }
17 | return lancedb
18 | }
19 |
20 | const DB_PATH = path.join(app.getPath('userData'), 'vector-db')
21 | let db: lancedb.Connection | null = null
22 |
23 | // ========================
24 | // 🛠️ 工具函数
25 | // ========================
26 |
27 | /**
28 | * 安全地将 repositoryName 转为合法表名
29 | */
30 | function sanitizeTableName(name: string): string {
31 | if (!name || typeof name !== 'string') {
32 | throw new Error('Repository name must be a non-empty string')
33 | }
34 | return name.replace(/[^a-zA-Z0-9_]/g, '_').toLowerCase()
35 | }
36 |
37 | /**
38 | * 生成唯一 ID
39 | */
40 | function generateId(): number {
41 | return Date.now() * 1000 + Math.floor(Math.random() * 1000)
42 | }
43 |
44 | /**
45 | * 创建表的 schema
46 | */
47 | function createTableSchema(dimension: number): arrow.Schema {
48 | return new arrow.Schema([
49 | new arrow.Field('id', new arrow.Int32(), false),
50 | new arrow.Field('text', new arrow.Utf8(), true),
51 | new arrow.Field('filename', new arrow.Utf8(), true),
52 | new arrow.Field('vector', new arrow.FixedSizeList(dimension, new arrow.Field('item', new arrow.Float32())), false),
53 | new arrow.Field('metadata', new arrow.Utf8(), true) // 存储 JSON 字符串
54 | ])
55 | }
56 |
57 | // ========================
58 | // 🔌 数据库连接管理
59 | // ========================
60 |
61 | /**
62 | * 初始化数据库连接（幂等）
63 | */
64 | export async function initLanceDB(): Promise
6 | 
7 |
9 |
10 |
7 | 一款基于 Electron、Vue 3 和 TypeScript 构建的智能长文档校对桌面应用程序
8 |📝 项目简介
14 |15 | AutoDocxProofread（智能校对助手）是一款专为长文档校对而设计的桌面应用程序。它能够帮助用户有效检测 Word 16 | 文档中的错别字、标点符号错误、语法问题和文本一致性问题，并提供修改建议。 17 |
18 |19 | 针对大模型在处理长文档时存在的遗忘和幻觉问题，软件设计了专门的架构来增强校对的准确性，并能直接导出校对后的文档。并且软件采用了并行处理架构，显著提升大模型处理长文档的速度。新版本引入了本地知识库功能，支持RAG功能给模型校对参考。 20 |
21 | 22 |核心功能与软件优势
23 |-
26 |
- 逐句精校：适合需要高精度校对的短文本 27 |
- 逐段校正：适合长篇文献的校对 28 |
- 全文润色：对整篇文档进行语言润色和优化 29 |
-
33 |
- 错别字检测 34 |
- 标点符号错误识别 35 |
- 语法问题检测 36 |
-
40 |
- 创建和管理多个本地知识库 41 |
- 支持PDF、Word和TXT文档导入作为参考材料 42 |
- 基于向量数据库的RAG检索增强生成算法 43 |
-
47 |
- 使用并行处理的方式优化处理效率，显著提升对于长文本的校对速度 48 |
- 清晰的错误展示和修改建议 49 |
- 一键应用修改建议 50 |
- 响应式设计，支持窗口缩放 51 |
-
55 |
- 兼容 OpenAI 接口，支持多种大语言模型 API 56 |
- 灵活的 API 配置管理 57 |
-
61 |
- 清晰查看历史记录，包括时间、校对模型、校对文件路径和具体的结果 62 |
- 支持对结果的批量管理 63 |
🛠 技术栈
79 |🚀 快速开始
116 |环境要求
117 |-
118 |
- Node.js >= 16.x 119 |
- npm 或 yarn 120 |
安装依赖
123 |开发模式运行
126 |🎯 使用指南
132 |-
136 |
- 点击导航栏中的"工作区" 137 |
- 选择"API 设置"选项卡 138 |
- 填写 API 地址、密钥和模型名称 139 |
- 点击"测试连接"验证配置 140 |
- 点击"保存配置"保存设置 141 |
- 配置并发限制、选择是否开启请求频率限制 142 |
-
149 |
- 点击导航栏中的"知识库" 150 |
- 选择"Embedding模型"（需要选择专门的embedding模型） 151 |
- 点击"添加知识库"按钮创建新知识库 152 |
- 选择知识库后可添加PDF文件作为参考材料 153 |
-
159 |
- 点击导航栏中的"工作区" 160 |
- 选择"文档校对"选项卡 161 |
- 点击"选择 DOCX 文件"按钮选择要校对的 Word 文档 162 |
- （可选）选择知识库以增强校对准确性 163 |
- 选择合适的校对模式 164 |
- 点击"开始校正"按钮开始校对过程 165 |
- 在右侧栏查看校对结果和修改建议 166 |
- 点击"应用修改"按钮接受建议的修改 167 |
- 点击"导出结果"按钮保存修改后的文档 168 |
🔧 开发计划
178 |-
179 |
- 大语言模型的格式化输出转 Word 文档 180 |
- 增强用户界面交互体验 181 |
- 优化 .docx 文件的处理算法 182 |
📖 版本情况
185 |当前版本：v1.1.3
186 |本软件会持续更新，最新版本可以在本项目页面上下载
187 |📖 致谢
191 |部分代码使用了night-peiqi的项目：
192 |📄 许可证
197 |本项目采用 MIT 许可证 - 查看
3 |
4 |
5 |
6 |
7 |
36 |
37 |
39 | 添加知识库
40 |
41 |
42 |
43 |
44 |
45 |
46 |
63 |
64 |
65 |
107 |
108 |
109 |
110 |
111 |
8 |
9 |
10 |
12 | 知识库列表
13 |
14 |
15 |
16 |
17 |
18 |
20 |
22 |
27 |
28 |
29 |
30 |
34 |
35 |
31 |
33 |
47 |
62 |
48 |
49 |
51 |
53 |
58 |
59 |
60 |
61 |
54 | {{ item.modelName }}
55 |
56 |
57 |
66 |
67 |
75 |
76 |
77 |
68 |
69 |
71 |
74 | 欢迎使用知识库管理系统
72 |请选择或创建一个知识库开始使用
73 |
78 |
79 |
80 |
105 |
106 |
81 | 当前知识库：{{ activeIndex }}
82 |
83 |
88 |
89 |
90 |
91 |
92 |
93 |
94 | {{ row }}
95 |
96 |
97 |
98 | 删除
100 |
101 |
102 |
103 |
104 |