wenzetan/dsh-llm-newapi

English | 中文

为 DeepSeek Harness（dsh）增加 LLM 供应商 NewAPI 的插件。零 dsh 修改。

• 供应商 route id：newapi
• 显示名称：NewAPI
• 形态：LLM Provider 插件——实现 @deepseek-ai/dsh-llm 的 LlmAdapter seam；NewAPI 为 OpenAI 兼容网关（POST {baseURL}/chat/completions、GET {baseURL}/models，baseURL 含 /v1）
• 双侧结构：宿主侧（adapter + 模型发现）+ 浏览器侧（dsh web 设置面板中的「NewAPI」设置页，含「获取模型」）

设计决策与差异分析见 DESIGN.md；参考实现 deepseek-harness/packages/llm/llm-deepseek。

安装（dsh ≥ 0.1.0-rc）

发布通道与版本选择

项目采用双发布通道，默认从 npm registry 安装（或引用版本化 tag），不要跟随 main 分支 HEAD：

通道	版本形态	安装引用	适用场景
稳定版（推荐）	vX.Y.Z	dsh plugin --profile web add dsh-llm-newapi（npm latest）或 github:wenzetan/dsh-llm-newapi#latest	日常使用；已通过全部门禁并经人工确认晋升
测试版	vX.Y.Z-rc.N 等	dsh plugin --profile web add dsh-llm-newapi@next 或 github:wenzetan/dsh-llm-newapi#v0.8.2-rc.3	尝鲜/验证新功能；未确认，仅发 GitHub Pre-release 与 npm next
main 分支 HEAD（不推荐）	无 tag	github:wenzetan/dsh-llm-newapi	开发预览；未打 tag 的提交未走发布验证，可能是不稳定构建

💡 npm 的 latest dist-tag（以及 GitHub 的 latest tag）始终指向人工确认过的最新正式版——默认安装命令不会过期，本 README 无需随版本更新。仅在需要复现旧构建时才固定 #vX.Y.Z。不带 #tag 的 github: 简写会安装 main 分支 HEAD——那不是发布通道。

方式 A：npm registry（默认，推荐）

dsh plugin --profile web add dsh-llm-newapi        # 稳定版：npm latest（自动跟随已确认的发布）
# dsh plugin --profile web add dsh-llm-newapi@next  # 测试版

# 然后：注册 bundle——编辑 $DSH_HOME/profiles/web/package.json
#       （默认 ~/.dsh/profiles/web/package.json），
#       在 dsh.profile.bundles 数组加 "dsh-llm-newapi"——重启 dsh web

方式 B：GitHub 简写——#latest（移动）或 #vX.Y.Z（固定）

dsh plugin --profile web add "github:wenzetan/dsh-llm-newapi#latest"    # 最新确认的正式版
# dsh plugin --profile web add "github:wenzetan/dsh-llm-newapi#v0.8.1"  # 精确版本
# 同方式 A 的注册与重启

方式 C：Release tarball（免 GitHub 克隆）

dsh plugin --profile web add \
  https://github.com/wenzetan/dsh-llm-newapi/releases/download/v0.8.1/dsh-llm-newapi-0.8.1.tgz
# 同方式 A 的注册与重启；测试版用对应 -rc.N 的 Release 附件

方式 D：本地开发（link）

git clone https://github.com/wenzetan/dsh-llm-newapi && cd dsh-llm-newapi
npm install && npm run build && npm test
dsh plugin --profile web add link:$(pwd)
# 同方式 A 的注册与重启；改码后重跑 npm run build、提交 lib/ 并重启 dsh web

安装时的 missing peer 警告是预期行为，可忽略：react/cordis/dsh-llm/dsh-settings/schemastery 等运行时由 dsh 宿主 app 提供，插件声明为 peerDependencies 正是要求"不要装自己的副本"；profile 的 autoInstallPeers: false 让 pnpm 静态报 missing。所有 dsh 插件安装时都会出现这行 WARN（dsh-at-file 等同款），安装成功不受影响。切勿手动安装该列表或开启 autoInstallPeers——会导致 cordis 服务双实例、插件静默失效。

装好后：设置面板出现「NewAPI」页 → 填 API key 与网关地址（含 /v1）→「获取模型」拉取并勾选 chat 模型（embedding / rerank / ranker 自动过滤）→ 保存。模型选择器（composer）即出现 newapi 路由的模型。

配置（cordis.yml entry config；装机后 settings.yaml llm-newapi: 段热更新覆盖）

- id: llm-newapi
  name: dsh-llm-newapi
  config:
    baseURL: http://gw.local:3000/v1   # 含 /v1 前缀；缺省回退 env NEWAPI_BASE_URL → 占位符
    # models:                          # 建议性目录；默认空，用「获取模型」拉取 /models
    #   - id: deepseek-chat
    #     contextWindow: 65536
    # modelExcludePatterns:            # 发现时的 chat-only 过滤（整体替换默认）
    #   - embed                        #   默认 ['embed','rerank','ranker']（大小写不敏感 id 子串）
    #   - rerank                       #   置 [] 关闭过滤；多能力 id（bge-m3）需自行补充
    # defaultContextWindow: 128000     # 目录未覆盖时的上下文容量
    # maxTokens: 8192                  # 缺省不发 max_tokens，用各上游默认
    # providerHints:                   # models.dev 参数匹配的官方供应商仲裁
    #   defaults:                      #   家族前缀 → provider（覆盖内建 glm→zai 等）
    #     glm: zhipuai                 #   例：改用智谱开放平台的数据
    #   models:                        #   逐 id 精确 → provider（优先于家族）
    #     tencent/Hunyuan-MT-7B: nano-gpt

API 密钥：不是配置项——固定存于 credentials store 的 newapi 引用下，唯一配置面是 web 设置页（写后立即生效，每请求解析）。插件不从任何环境变量读 key：credentials 服务的顶层只读层就是继承环境，NEWAPI_API_KEY 式引用会被环境里同名变量遮蔽并锁死前端输入框，故引用名固定为 newapi。无密钥时首个请求以 MISSING_CREDENTIAL 失败并指向设置页，不在装载时报错。

模型发现：GET {baseURL}/models，只采纳可服务 chat-completions 的模型——embedding / rerank / ranker 家族按命名约定过滤（可配）。

Web 设置页：浏览器侧经 dsh.client manifest 被 dsh web 运行时动态发现（ClientModuleRegistry 扫描组合插件行），向 settings.section 多贡献 slot 注册（dsh 契约：功能自有设置页，加设置不改 shell）。注意这是设置面板中独立的「NewAPI」页，不嵌在官方 Models 页内部。输入框与按钮全部走 --dsw-alias-* 设计令牌（与官方 Models 页同配方），亮色 / 暗色主题自动适配。

配置校验：settings 写入点即拒绝适配器无法服务的段（如非 http(s) 的 baseURL、空过滤条目）——schema 表达不了的约束在写入时报错，不会「保存成功但静默沿用旧值」。

发布流程（测试版 → 人工确认 → 正式版）

• 测试版：把 package.json 版本写为 X.Y.Z-rc.N 并推送 tag vX.Y.Z-rc.N。完整四门禁（build / plugin-check / boot / release）后：GitHub Release 标记 Pre-release，npm 发布到 next dist-tag（latest 不动）。安装：dsh plugin --profile web add dsh-llm-newapi@next。
• 晋升正式（人工确认）：Actions → CI → Run workflow → 填 rc_tag（如 v0.8.2-rc.1）。promote job 校验该 rc 的 CI 全绿、稳定 tag 未占用后，在同一 commit 上创建 vX.Y.Z——自动走正式发布（完整 Release + npm latest）。GitHub 的 latest tag 同步移动到该 commit，github:wenzetan/dsh-llm-newapi#latest 始终解析到最新确认的正式版。
• 任何带 - 后缀的 tag 一律按测试版处理；稳定 tag 由 promote 独占创建，保证 latest 永远是人工确认过的版本。

构建与测试（本仓开发）

npm install && npm run build   # host: tsc 类型 + esbuild → lib/index.js；client: closure-factory → lib/client.js
npm test                       # cordis 实挂载 smoke：注册面 + chat-only 过滤 + fiber 释放
npm run cache:models-dev      # 本地缓存 models.dev/api.json 到 .cache/（gitignored，开发用）

models.dev 开发缓存：.cache/models-dev.api.json 不入库，供开发时翻看目录真实字段形状（limit.context/output、reasoning_options）；smoke 的可选块检测到它存在时，会用真实数据校验 matchModelsDev（缺失则跳过，CI 不受影响）。刷新优先直连 models.dev，其次走 HTTPS_PROXY 环境变量；两者皆不可达时自动从 GitHub 源（sst/models.dev 的模型 TOML）合成一份子集快照并标记 _source。

改源码后须重跑 npm run build 并提交 lib/——github: 安装从提交的产物运行，CI 的「Committed artifacts are current」步骤会在产物过期时拒绝。

状态

v0.8.1：预设思考等级——模型行高级区的等级字段改为下拉选择，用户可将某一档设为默认（defaultReasoningEffort 持久化），未预设时缺省取声明档位中的最高档（max>xhigh>high>medium>low>…）；resolveModel 声明 defaultEffort，composer 切换思考模式时自动选中该档。写入校验：预设必须属于该模型的等级列表。

v0.8.0：参数匹配引擎重构——家族 hints 内建 + 近似键匹配 + 可配置覆盖。内建家族默认（glm→zai、gpt→openai、claude→anthropic、deepseek→deepseek、gemini→google、grok→xai、qwen→alibaba、kimi→moonshotai、mimo→xiaomi、minimax→minimax、hunyuan→tencent）在候选中把官方条目置首并标「官方」；官方 vendor 内支持近似键（目录未收录该版本时取家族最接近条目，如 glm-5.3→zai 的 glm-5），跨 vendor 不近似以防噪声；providerHints 配置可覆盖/扩展（defaults 家族前缀 + models 逐 id 精确，逐 id 优先）。次序：hint 官方 → 精确键（目录序）→ registry 官方补充。实测 22 个模型 20 个官方直取（含真实思考等级），qwen27b-coder 无匹配（目录无此 id），tencent/Hunyuan-MT-7B 落 nano-gpt（官方 tencent 无此模型）。

v0.7.2：模型目录标题行新增「清空」按钮——与逐行删除控件同语义，一次移除全部模型行；同步重置展开态、容量输入缓冲与参数结果面板，空目录时按钮禁用，保存即写入空 models 数组。

v0.7.1：参数匹配默认选官方——多供应商命中时，官方厂商的条目置首并标「官方」（面板默认选第 0 项，即官方参数）；权威来源为 dsh-llm 注册表里其他路由的内置模型目录（如 deepseek 路由声明 deepseek-v4-flash，则 api.json 取 deepseek 供应商条目），按裸模型 id 匹配（多段式 id 查末段），路由集合变化时索引自动重建。

v0.7.0：显示名生成支持品牌拼写（glm→GLM、gpt→GPT、deepseek→DeepSeek），多段式 id 追加原文前缀括号（deepseek-ai/deepseek-v4-flash→DeepSeek V4 Flash[deepseek-ai]），尺寸后缀大写限定 b/k/m（gpt-4o 保持小写 o）；思考等级全链路——「从models.dev获取模型信息」现在同时带入 reasoning_options 的 effort 列表（null 丢弃），存入模型目录 reasoningEfforts 字段，resolveModel 据此声明可选思考等级（composer 出现等级选择器），显式等级经 OpenAI 兼容 reasoning_effort 字段上 wire；行内高级区只读展示，结果面板与 provider 选择器同步显示等级。

v0.6.3：获取模型的采纳链路全程按 id 排序——候选列表拉取后在客户端再排一次（不依赖宿主侧版本），「添加所选」后表单行合并为一份字母序列表（新旧行一起排），id 仍为空的半成品行固定沉底。

v0.6.2：获取模型自动生成显示名——网关 listing 未提供名称时按 ID 派生：多段式 id 只取最后一个 / 后内容，- 转空格，每个单词首字母大写，末尾单字母尺寸后缀转大写（qwen3-32b→Qwen3 32B、glm-4.5-air→Glm 4.5 Air、llama-3.1-70b→Llama 3.1 70B）；listing 自带名称仍优先。

v0.6.1：代理控件简化——取消预置下拉框，只保留单一文本框，默认值与占位符均为 http://127.0.0.1:7890（清空保存时回退该默认）。

v0.6.0：参数结果面板重排——模型 id 为固定 30ch 文本框（左对齐，超宽内容悬停横向滚动，行对齐不再漂移），右侧映射列显式左对齐；「从models.dev获取模型信息」完成后新增即时反馈：状态行显示「匹配 N · 未匹配 M」计数，且结果面板自动滚动进入视野（长模型列表不再把面板挤到视口外）。

v0.5.8：操作文案改为「从models.dev获取模型信息」（en: Fetch model info from models.dev）；修复误导性失败提示——代理开启但代理本身连不上（ECONNREFUSED）时，旧消息错误地建议「启用代理」，现按实际路由区分：代理路径失败点名「proxy at is unreachable; check that it is running, or change or disable the proxy setting」，直连路径失败才提示启用代理。

v0.5.7：修复发布包类型入口——declaration emit 残留 .ts specifier（rewriteRelativeImportExtensions 不作用于 d.ts），消费者类型解析断裂；host 构建现把 lib/types/*.d.ts 相对 .ts 改写为 .js。补 prepack 脚本。CI 新增 dsh-plugin-check 合规门禁（清单协议 / patch 格式 / 构建陷阱，verdict 须 pass；本仓库实测从 fail 翻绿）。

v0.5.6：修复「更新模型信息」HTTP 500——下载失败（直连不可达 models.dev、代理失效等）此前以异常抛出，传输层把它映射成不透明的 500；现在 handler 返回错误信封，设置页直接显示底层原因（DNS/拒连/超时）与「启用代理」提示。同时修复代理路径的双 undici 问题：npm undici 的 ProxyAgent 会被 Node 内置 fetch 的品牌检查拒绝，代理请求改走 npm undici 自带的 fetch。

v0.5.4：CI boot 门禁稳定化——runner 补装 pnpm（profile 插件流程依赖它，裸 runner 缺失导致门禁首跑失败）；门禁三断言（:3080 就绪、client bundle 200、RPC 通道非 405）在 tag 构建上全程绿。

v0.5.3：修复生产安装丢 undici——undici 此前同时出现在 dependencies 与 devDependencies，--omit=dev 安装（CI 自包含门禁的干净目录）会把同名 devDep 整体剔除而非回退 prod 声明，导致打包产物在隔离环境下不可解析；从 devDependencies 移除后 CI 门禁转绿。CI 新增 boot 门禁：全局安装 dsh → 全新 DSH_HOME 用 dsh plugin add 装 tarball → 后台启动 dsh web，要求 ：3080 就绪、/plugins/dsh-llm-newapi/client.js 可取、/llm-newapi/models-dev-params 非 405。

v0.5.2：修复「更新模型信息」HTTP 405——RPC 通道此前在 apply 里用急切 ctx.get('connection') 读取，插件挂载早于 web app 启动 connection 服务时拿到 undefined 而静默跳过注册；改用 ctx.inject(['connection'], …) 等服务就绪再注册（服务重载自动重跑），并以 smoke 场景固定「插件先挂载、服务后启动」的时序。

v0.5.1：undici 从 peerDependencies 移入 dependencies（宿主不提供 undici，autoInstallPeers: false 下 peer 解析不到导致整个插件树加载失败）；CI 新增自包含门禁——npm pack 产物解包到干净目录只装生产依赖，host bundle 的所有非宿主提供 bare import 必须可解析。

v0.5：发现结果按 id 排序，a/b 形式 id 的显示名取最后一段（wire id 不变）；新增「更新模型信息」——浏览器把模型 id（与代理草稿）发给宿主侧 RPC（/llm-newapi channel），由后端下载 https://models.dev/api.json 并按 id/末段匹配，返回 limit.context/limit.output；同名多供应商条目在结果面板由用户选择；应用时可选「覆盖」或「仅填空白」，未匹配行保持原值并计数提示。代理开关默认关闭、默认 http://127.0.0.1:7890，预置 7890/7897/10809 三个下拉项 + 自定义输入，启用状态与地址随设置段持久化（仅用于该下载，网关流量不走代理）。

v0.4：模型目录照官方 Models 页（ModelListEditor）重设计——每模型一张边框卡片（ID + 显示名称在行内），上下文窗口 / 输出上限折叠在行首 chevron 后，支持 K/M 缩写输入（256K→256000、1M→1000000）与逐字段输入缓冲；保存前本地校验（空 ID / 重复 ID / 容量不可解析即拒绝并点名行）；空状态提示与胶囊「添加模型」按钮；删除行时展开态与缓冲按行号重排。

v0.3：API key 改为纯前端配置（固定凭证引用 newapi，移除 apiKeyEnv 配置与 env 回退）；设置页改用 --dsw-alias-* 设计令牌，亮/暗主题自适应；settings 写入点增加 validate 拒绝；WireAssistantMessage.content 类型收紧为 string。宿主侧（adapter + chat-only 过滤发现）+ 浏览器侧（NewAPI 设置页）双侧结构不变；typecheck / build / smoke 全绿；产物入库 + CI 同步校验 + Release tarball。已知 npm rc 缺口用 overrides stub（见 DESIGN §8）。