前言¶
DeepSeek Harness (DSH) 的插件机制允许开发者扩展其核心功能。dsh-workspace-api 旨在解决“如何将 DSH 的工作区内容与智能体任务能力暴露给外部系统”的问题。它不依赖复杂的向量数据库或索引构建,直接利用 AI 代理的现场检索能力,为企业和开发者提供一个轻量级的企业知识问答入口。
这是什么¶
这是一个企业知识问答 Agent 插件,由 liaoyonghong 维护,采用 MIT 许可证。
它的核心价值是将企业文档(合同、手册、制度等)转化为可对话的聊天机器人。系统无需预建索引,AI 代理会根据用户的自然语言提问,实时检索并阅读文档,给出准确的回答并附带出处引用。同时,它提供了完整的 HTTP API 接口,支持文件目录管理(列表、树、搜索、读取),方便第三方应用集成。
安装与启用¶
安装该插件需通过 DSH CLI 执行以下命令:
dsh plugin --profile web add dsh-workspace-api
安装完成后,重启 dsh web 进程即可激活插件。
核心功能¶
插件主要提供两类能力:
1. 知识问答:支持自然语言提问,并返回带有文件名和行号的引用。
2. 文件管理:提供 HTTP 接口供外部系统查询目录树、搜索文件或读取文件内容。
典型用法¶
直接提问¶
在 DSH Web 界面的聊天框中直接提问,例如:
“根据企业文档,酒店住宿报销上限是多少?”
通过 API 提问¶
通过 HTTP 接口调用,插件默认运行在 DSH Web 端口(默认 127.0.0.1:3080),路径前缀为 /workspace-api。
同步请求示例(等待回答):
curl -X POST -H "Content-Type: application/json" \
-d '{"prompt":"根据企业文档,酒店住宿报销上限是多少?"}' \
"http://127.0.0.1:3080/workspace-api/task?wait=1"
返回结果示例:
{
"ok": true,
"task": {
"status": "done",
"result": "酒店报销上限:标准间每晚上限 HK$1200(出处:报销政策.md 第 3 行)",
"exitCode": 0
}
}
配置与安全¶
插件提供以下环境变量用于配置和增强安全性:
WORKSPACE_API_ROOT:指定文档根目录,默认为当前 DSH 工作区。TOKEN:访问令牌。默认仅监听 127.0.0.1,若需对外开放,务必设置TOKEN并在请求头中携带Authorization: Bearer your-secret-token。
适用场景与注意¶
- 适用场景:内部知识库问答、合同条款查询、系统操作说明、入职培训辅助等。
- 性能特点:基于 AI 代理现场检索,无需索引。文档数量在几十份以内效果最佳,超大语料建议叠加 RAG 向量检索。
- 文档格式:支持 txt、md、PDF、Word、Excel。扫描版 PDF 需先转成文字(OCR)才能被检索。
- 安全性:所有路径均经过真实路径校验,防止目录遍历攻击;任务代理拥有 DSH 文件能力,仅限可信调用方使用。
结语¶
dsh-workspace-api 为 DSH 插件生态提供了一个将文档能力标准化输出的方案。通过简单的配置和 API 调用,可以快速搭建企业内部的智能问答助手。