安装
在 DeepSeek Harness 里通过 dsh-market 安装
dsh plugin --profile web add dshmarket
或使用命令行
dsh plugin --profile web add @maxwell-feng/dsh-windows-ocr
装任何插件都等于在你的机器上跑第三方代码,权限和你本人一样大——能读你的文件、用你的凭据、访问网络。请先审阅源码,并尽量锁定 commit(github:owner/repo#sha)。
README
一个 DeepSeek Harness(dsh)插件:让纯文本模型也能"看"附件图片——图片在本机用 Windows 自带 OCR 引擎(Windows.Media.Ocr)识别,只有识别出的文字会发给模型 API。
隐私默认:图片字节在本机 OCR,不会发给服务商。只有当你明确想让真正的视觉模型接收原图时,才设置 passthrough: true。
- 不需要改任何模型配置——不用在
settings.yaml里给模型加input: [text, image]。 - 对 dsh 里的任何 provider/模型通用;默认所有附件图片在出站前都会先 OCR。
- 视觉模型透传是可选开启的(
passthrough: true)。 - 默认安全(fail-closed):插件没加载时,模型保持纯文本,图片附件会被拒绝——不存在静默泄漏;缺失 attachment 的图片块会被替换为拒绝文本,绝不会以原始
image块保留。
npm 安装
dsh plugin --profile web add @maxwell-feng/dsh-windows-ocr
(把 web 换成你的 profile,如 tui。)预编译发布(含 Sigstore provenance),无需源码构建或 allowBuilds 授权。从本仓库源码安装仍可用下方 agent 指南或手动步骤。
npm 安装会自行注册
windows-ocr这一行。 该包自带 bundle 补丁(dsh.bundle+ 它自己的cordis.patch.yml),已经插入了windows-ocr这个 loader 条目。请不要再往 profile 里手动- insert:一行同 id 的条目——dsh0.1.0-rc.7(cordis-plugin-loader1.0.2)会拒绝重复的 loader 条目 id,dsh web会以duplicate loader entry id: windows-ocr启动失败。
让 AI agent 快速安装
把这个仓库交给任何 AI agent,或直接粘贴下面的指令,agent 会替你完成安装与验证:
请按照 https://github.com/maxwell-feng/dsh-windows-ocr/blob/main/agents-install.md 安装本仓库的 dsh 插件。执行每一项前置检查,选择一种安装方式,然后完成强制验证:在纯文本模型会话里附加一张图片,确认模型能答出图片中的文字。
agents-install.md 是一份写给 AI agent 的分步手册:前置检查、两种安装方式(profile 永久 / --patch 临时)、强制功能验证,以及常见失败模式的排查。手动安装说明见下文。
为什么是插件而不是 skill
dsh 的 skill 只是注入模型上下文的 Markdown 指令:不能执行代码、不能钩住请求管线、更拦不住图片被序列化上传。这个功能恰好需要这些,所以它是一个 cordis 插件,钩住 llm 服务的两个公开接缝:
- 能力声明(shim)——包装
ctx.llm.resolveModelInfo(以及listModels)。宿主在三处用inputModalities.includes("image")拦截图片:发送准入、切换模型、read_image工具。shim 让回答变成"支持",文本模型即可收图。 - 请求改写——包装
registration.adapter.stream(ctx.llm.stream和prepareCall().stream两条路径的唯一汇聚点)。适配器序列化请求前,所有image内容块已被替换成 OCR 文本块,适配器的图片检查永远不会触发,附件字节不会为出站请求被读取,也永远不会生成image_url。
你附加图片
→ 准入层问 ctx.llm.resolveModelInfo(shim 返回含 "image" ✓)
→ 图片存入本地附件库(会话日志、UI 预览)
→ agent 组装请求 → adapter.stream(被包装)
→ 本地读取图片字节(ctx.attachments.readImage)→ Windows OCR
→ 图片块替换为 <image_ocr>…识别文字…</image_ocr>
→ 适配器序列化纯文本请求 → 发给服务商
环境要求
- Windows 10/11(自带 Windows PowerShell 5.1,无需安装任何东西)
- 你所用语言对应的 OCR 语言包(设置 → 时间和语言 → 语言)。英文一般自带;中文需要安装中文语言包(含 OCR 能力)。
- 已安装
dsh及 profile(在 dsh0.1.0-rc.7上验证)
安装
让 AI agent 安装
本仓库的 agents-install.md 是一份写给 AI agent(也适合细心的人工)的分步安装手册。把这份文档交给 agent——例如对它说"按照 https://github.com/maxwell-feng/dsh-windows-ocr 的 agents-install.md 安装这个插件"——agent 就能自主完成前置检查、安装、验证和故障排查。手册涵盖两种安装方式、必须做的功能验证(附加图片 → 模型回答 OCR 文字)以及常见的失败模式。
手动安装
两种官方加载方式,patch 行都用绝对路径指向插件文件(见 docs/user/develop/basic)。Windows 上路径必须是 file:// URL——裸写 C:/... 会被解析成 c: URL scheme 而被 loader 拒绝。
永久安装:profile 补丁层
在 profile 的 cordis.patch.yml(如 ~/.dsh/profiles/web/cordis.patch.yml)追加:
- insert:
- id: windows-ocr
name: 'file:///C:/绝对路径/windows-ocr/lib/index.js'
config:
language: ''
passthrough: false
然后重启 dsh web。删掉这几行即卸载——插件在卸载时会恢复被替换的 llm/adapter 原方法。
两种加载方式二选一:npm bundle(上文)或这里的手动 insert——绝不能同时用。两者注册的是同一个
windows-ocr条目 id,而 dsh0.1.0-rc.7在行重复出现时会以duplicate loader entry id: windows-ocr拒绝启动。如果这一行已经存在(例如已按 npm bundle 方式安装),请用下方的按 id 覆盖方式改配置,而不是再插入一行。
临时加载:--patch overlay
把同样的行写进一个 overlay 文件,启动时带上;profile 保持不动:
dsh --profile web --patch C:/path/to/overlay.yml
注意事项
dsh web报EADDRINUSE(3080 被占用)说明有旧实例还在跑:用netstat -ano | findstr :3080找到 PID,taskkill /PID <pid> /F关掉再启动。- 打包分发(npm / tarball /
github:user/repo)时按组合包方式打包(dsh.bundle+cordis.patch.yml,见docs/user/develop/basic/publish);git 安装还需要prepare构建脚本和 pnpmallowBuilds授权。
确认插件已加载:启动日志里应有 windows-ocr;或者直接跑下面的冒烟测试。
配置
所有配置都在 windows-ocr 这一行(本目录 cordis.patch.yml),可在你 profile 的 cordis.patch.yml 里覆盖:
| 键 | 默认 | 含义 |
|---|---|---|
language |
"" |
Windows OCR 的 BCP-47 语言标签,如 zh-Hans、en-US;空 = 用户配置文件语言 |
passthrough |
false |
false(默认):所有图片一律走 OCR;true:真视觉模型图片原样透传 |
ocrScript |
自带 lib/ocr.ps1 |
PowerShell OCR 脚本的绝对路径覆盖 |
timeoutMs |
60000 |
单张图片 OCR 超时(毫秒) |
maxCacheEntries |
200 |
单次运行 OCR 缓存上限(按附件 id) |
覆盖示例(~/.dsh/profiles/web/cordis.patch.yml)——用按 id 覆盖的行(不是 insert:)替换 windows-ocr 这一行的 config:
- id: windows-ocr
config:
language: zh-Hans
模型看到什么
每个图片块变成一个文本块(不转发本地文件名):
<image_ocr>
…识别出的文字行…
</image_ocr>
识别结果按附件 id 在 dsh 进程生命周期内缓存,重复轮次不会重复 OCR。
临时文件自动清理
每次 OCR 都会把输入图片和输出文本写入系统临时目录下新建的临时目录(windows-ocr-*)。该目录在 finally 中自动删除——成功、OCR 报错、超时都会删——每次产生的脚本、图片和输出文件都不会残留。插件启动时还会清扫上次进程崩溃遗留的孤儿 windows-ocr-* 目录。除插件自己的临时目录和 dsh 附件库外,不写任何其他位置。
冒烟测试(不需要 dsh)
# 1x1 PNG——验证 WinRT 加载、语言包可用性、识别链路
powershell.exe -NoProfile -ExecutionPolicy Bypass -File lib/ocr.ps1 -ImagePath test.png -OutFile out.txt
Get-Content out.txt
退出码 0 且 out.txt 为空/空白,说明 OCR 引擎正常(1×1 图本来就没有文字)。退出码 2/3 说明缺语言包。
在 dsh 里验证
- 在文本模型会话里附加一张图片并发送——模型应能引用识别出的文字作答。
- 确认图片没出站:web UI 打开 DevTools → Network,查看发往服务商 baseURL 的请求,确认 payload 里只有
text内容块(没有image_url/data URI)。
已知限制
- OCR 语言取决于系统安装的语言包(脚本退出码 2/3 时,插件降级为占位文本)。
- GIF:Windows OCR 只识别第一帧。
- 缓存按进程存活;长会话的 OCR 文本会缓存,受
maxCacheEntries限制。 - 热重载(HMR)会替换适配器;插件会在
llm/adapters-updated时重新包装新适配器,但 dsh 升级后建议完整重启。 - 模型选择 UI 上文本模型可能不带"图片"徽标(纯外观,
listModels已一致地 shim)。 - 移除插件后,文本模型的图片附件会重新被拒绝(fail-closed),不会被上传。
License
MIT