@bocha-ai/dsh-web-search-bocha

English | 中文

由 Bocha Web Search 支持的 WebSearchProvider 和可安装 Profile 组合包（bundle），用于 DeepSeek Harness。该包注册提供方 ID bocha，调用博查的 POST /v1/web-search 端点，并携带一个 dsh.bundle patch，安装后选择这个提供方。

该包只提供搜索。DeepSeek Harness 继续通过其 web 能力拥有面向模型的 web_search 工具、结果上限、引用、提供方选择和错误呈现。

安装

把组合包安装到 Profile：

dsh plugin --profile web add @bocha-ai/dsh-web-search-bocha

如需检查最终组合配置，可以执行下面的可选命令；它打印配置后就会退出：

dsh --profile web --dump-config

启动 Web 应用只需要执行：

dsh --profile web

API 密钥使用下面任一方式配置即可，不需要同时配置。

方式一：DSH credentials 文档

把密钥存入 $DSH_HOME/.credentials.yaml（通常是 ~/.dsh/.credentials.yaml）：

BOCHA_API_KEY: your-api-key

在 POSIX 上，该文件必须仅属主可访问：

chmod 600 ~/.dsh/.credentials.yaml

插件会在每次搜索时经由 Harness credentials 服务解析这个引用，因此轮换已存密钥后，下一次请求就会使用新值，无需重启。

方式二：环境变量

对于 CI、容器或按次覆盖，在启动 Harness 前导出密钥：

export BOCHA_API_KEY='your-api-key'

如果两种方式都配置了 BOCHA_API_KEY，继承的环境变量优先级高于受管凭据文档。

移除这个包会同时移除其提供方行和组合包层：

dsh plugin --profile web remove @bocha-ai/dsh-web-search-bocha

组合包行为

cordis.patch.yml 把基础 web 行的完整配置替换为 searchProvider: bocha，并插入加载本包的 web-search-bocha 行。现有提供方仍保持挂载，但 ctx.web 会把搜索路由到 bocha。随后应用的 Profile、Harness home 和命令行 patch 层可以替换任一行。

配置

| 配置键 | 默认值 | 含义 | |---|---|---| | apiKey | — | 可选的博查 API 密钥字面值。settings 描述会将它脱敏，但仍应优先使用 credentials 服务，以免明文密钥进入 Profile patch。 | | apiKeyEnv | BOCHA_API_KEY | 每次搜索都经由 Harness credentials 服务解析的凭据引用。 | | baseURL | https://api.bocha.cn | API 基址；追加 /v1/web-search。 | | freshness | noLimit | 每次搜索发送的时间过滤条件：noLimit、oneDay、oneWeek、oneMonth、oneYear，也可以是 2025-04-06 这样的单日，或 2025-01-01..2025-04-06 这样的日期区间。 | | summary | true | 请求博查返回较长的逐页面 summary。 | | count | 10 | Harness 请求不含 maxResults 时使用的默认数量；取值为 1 到 50 的整数。 |

后续 Profile patch 可以配置插入的行，无需改动这个包：

- id: web-search-bocha
  config:
    freshness: 2025-01-01..2025-04-06
    summary: true
    count: 10

映射与失败

该提供方读取 data.webPages.value[]。它把 url 映射到 WebSearchSource.url、name 映射到 title、summary 映射到 snippet（缺失时回退到 snippet），并把 datePublished 映射到 publishedAt；没有非空白 URL 的条目会被丢弃。博查的这个端点不返回单一生成答案，因此省略 WebSearchResult.content。

请求的 maxResults 会覆盖 count，并在发送请求前限制到博查的最大值 50。Harness web 能力仍会执行自身的最终来源数量限制。

HTTP 错误、提供方声明的非 200 代码、网络失败和无法处理的响应体会呈现为 WebError WEB_PROVIDER_ERROR。错误消息会保留博查返回的 log_id。中止形状的失败会呈现为 WEB_ABORTED，重定向会在访问目标之前被拒绝。

提供方会在每次搜索入口解析所引用的凭据，因此通过 UI 存入或轮换的密钥会在下一次请求生效，无需重启或重新注册提供方。引用的凭据缺失时会呈现为 WEB_PROVIDER_CREDENTIAL_MISSING。

开发

安装开发依赖、运行无密钥测试、构建并检查 npm 载荷：

npm install
npm test
npm run build
npm pack --dry-run

仅在有博查密钥时运行实时 smoke：

BOCHA_API_KEY='your-api-key' npm run test:e2e

模型体验

通过 DeepSeek Harness dsh-tool-web 间接影响；该工具在稳定的 web_search 工具契约下呈现此提供方经过数量限制的 URL、标题、摘要或 snippet 与发布日期。

KV Cache 影响

不会直接导致 KV Cache 失效；请求前缀变更由 Harness 工具消费方负责。

已知限制与暂缓事项

• 当前上游 DSH 不会在内置“插件”UI 中暴露第三方搜索设置：该卡片与 Host settings 白名单属于 DSH 内部实现。请通过本包的 Profile 行配置参数，并把 BOCHA_API_KEY 存进凭据文档或启动环境；发布此 npm 包不要求用户使用修改过的 DSH checkout。
• freshness 是部署配置，而不是面向模型的参数：同一个已挂载提供方的每次请求都使用相同的 freshness 值，因为提供方无关的 Harness 请求目前只携带 query 和 maxResults。
• 省略博查特有的 siteName 和其他媒体字段：Harness 的可移植来源类型没有站点名称、图片或视频字段。
• 一次 API 调用最多返回 50 个来源：较大的 Harness maxResults 请求会在传输前限制到博查记录的最大值。