Files
deepseek-harness/docs/user/guide/providers.zh.md
2026-08-10 13:07:46 +08:00

11 KiB
Raw Blame History

配置模型

English | 中文

Harness 出厂自带 DeepSeek同时预装了一个通用的多提供方适配器用来接入 pi-ai 已安装目录中的 Anthropic、OpenAI 等提供方,或任何 OpenAI 兼容的网关与自建服务。你有两个入口Web 界面的模型页,以及 $DSH_HOME/settings.yaml。两者写的是同一份文档,改完下一次请求即生效,不用重启。

提供方从哪里来

cordis.yml 决定装了哪些适配器settings 文档决定跑哪些提供方。出厂组合里有两个 LLM 适配器:

  • llm-deepseek 提供 deepseek-official 路由,是默认可用的那个。
  • llm-pi-ai休眠状态挂载:零路由,模型选择器里也不会多出条目,直到 settings 里的 llm-pi-ai: 段落给出提供方 profile路由才注册上来段落清空则一并撤下。

因此新增一个提供方通常不需要改 cordis.yml,写 settings 就够了——而模型页做的正是这件事。

在 Web 界面里配置

启动 pnpm run dsh web,打开设置 → 模型

模型页:DeepSeek 卡片,以及添加提供方与添加自定义提供方两个入口

填 DeepSeek 的密钥。 DeepSeek 卡片上只有一个 API 密钥输入框,填好保存即可开始用。

添加内置目录里的提供方。添加提供方,从 pi-ai 内置目录中选一个anthropic、openai 等),填入该提供方的 API 密钥。端点、协议和模型目录都由内置目录提供,你只需要给密钥。

只对以 API 密钥认证的提供方成立。目录里也有 Bedrock、Vertex、Azure、Codex它们分别需要 AWS 凭据与区域、ADC 项目配置、api-version、OAuth只填密钥框不会让它们工作——这类提供方靠 pi-ai 自己的环境发现认证,凭据按各自的原生方式准备。

添加自定义提供方。添加自定义提供方,用于内置目录没有的路由——公司网关、自建服务,或比内置目录更新的提供方。需要填 Provider ID请求里点名它、也作为凭据名的小写标识、API 地址、协议,以及至少一个模型。

自定义提供方表单:Provider ID、显示名称、API 地址、API 协议、API 密钥

让端点自己报模型。 展开模型目录后点获取可用模型,会按你当前表单里的地址与密钥去问端点(地址改了但没保存、密钥刚输入还没存下,都算数),把它报告的模型列成候选让你勾选。内置目录里的路由直接由目录作答,不联网。采纳只是把行写进草稿,最终还是你点保存才落盘。

密钥是只写的:页面拿到的永远是脱敏描述符,不是明文。写入的密钥存进 $DSH_HOME/.credentials.yamlprofile 里只记录引用它的变量名。

settings.yaml进阶配置

文档位于 $DSH_HOME/settings.yaml$DSH_HOME 默认是 ~/.dsh)。模型页写的就是这个文件,你也可以直接编辑它——两个来源没有主次之分。

llm-deepseek:
  reasoningEffort: high

llm-pi-ai:
  providers:
    # Catalog route: endpoint, protocol, and models come from pi-ai; you supply
    # the credential.
    openai:
      apiKeyEnv: OPENAI_API_KEY

    # Also a catalog route, moved to a private proxy, with its catalog narrowed
    # to one model and that model's capacity corrected. Every unset field still
    # comes from the catalog.
    anthropic:
      apiKeyEnv: ANTHROPIC_API_KEY
      baseURL: https://proxy.example.com:8443
      reasoning: high
      models:
        - id: claude-sonnet-4-5
          contextWindow: 200000

    # Catalog route with one model reshaped in place; the rest of the catalog
    # keeps serving (a models list would replace it instead).
    deepseek:
      apiKeyEnv: DEEPSEEK_API_KEY
      modelOverrides:
        deepseek-v4-pro:
          reasoningEfforts:
            off:
            high: high

    # Hand-declared route: pi-ai ships nothing under this key, so the profile
    # supplies the whole provider.
    acme-gateway:
      displayName: Acme Gateway
      apiKeyEnv: ACME_GATEWAY_API_KEY
      api: openai-completions
      baseURL: https://gateway.acme.example/v1
      # Reasoning dialect for an endpoint whose URL pi-ai cannot recognize.
      compat:
        thinkingFormat: deepseek
      models:
        - id: acme-large
          name: Acme Large
          contextWindow: 65536
          maxTokens: 4096
        - id: acme-think
          name: Acme Think
          # key = level offered in the picker, value = what goes on the wire;
          # only off may leave the value empty (supported, send nothing).
          reasoningEfforts:
            off:
            high: high
            max: ultra

settings 段落逐个提供方地盖在 cordis.yml 的同名配置之上,所以你可以只覆盖某个路由的一个字段,其余保持组合里的样子。

一份服务不了的 profile 会在写入处被拒绝:手工声明的路由必须给出 apibaseURL 和至少一个模型缺了会带着路由名和模型名报错而不是存下来再让整个命名空间静默失效。已经存好的文档被外部改坏时settings 会保留上一次的好值并告警。

模型目录

models替换该路由的内置目录,不是往里追加;省略或留空则原样使用内置目录。每个条目会从同 id 的内置模型继承自己没写的字段,所以「收窄到两个模型」「更正一个容量」「加一个比内置目录更新的模型」都是一行编辑——但一旦声明了这份列表,该路由要继续服务的每个模型就都必须出现在其中,条目哪怕只写一个 id 也足够。

就地重塑目录里的几个模型、保留其余,归 modelOverrides 管:它以目录模型 id 为键,接受与 models 条目相同的字段,目录的其余部分原样继续服务。覆盖若点名了目录没有描述的模型,或与 models 列表并存,或写在自定义提供方上,都会被拒绝,而不是被静默跳过。

可配置的模型字段是 idnamecontextWindowmaxTokensreasoningEffortscompat。定价与输入模态没有消费方,随内置目录条目走。

按模型声明推理档位。 reasoningEfforts 列出模型提供的档位:每个键都会出现在输入框的档位选择器里,其值是分派在协议中实际发送的内容——high: high 原样透传名称,max: ultra 则为使用自有词汇的网关改名。没写的档位不会被提供。off 比较特殊:声明而不给值,选择器里会出现 Off选中它时什么也不发送完全不写选择器不提供 Off请求也不携带关闭开关——由提供方自己的默认行为决定。reasoningEfforts: false 声明一个不具备推理能力的模型,这也是从网关服务不了的目录模型上剥除推理的办法。不写这个字段,自定义模型不推理,目录模型保留目录给出的档位。

选定推理方言。 档位如何在协议中传输——单独一个 reasoning_effort、DeepSeek 的 thinking: {type} 加档位,诸如此类——通常靠端点 URL 来猜,而私有网关的 URL 什么也说明不了,于是 DeepSeek 风格的网关只会收到 OpenAI 方言的请求。compat.thinkingFormat 用来显式指定方言,compat.supportsReasoningEffort: false 则让该参数不再发给拒绝它的端点;两者既可设在路由上(作为其模型的默认值),也可按模型设置,且仅适用于 openai-completions 路由。

两处容量都没给出的模型,取路由级兜底 defaultContextWindow262144defaultMaxTokens32768。这两个数按定义就是猜测所以它们是路由字段网关服务的模型更小时改一次即可。

模型 id 不是生命周期配置:请求一个该路由没有配置的模型,会在任何网络请求之前以 UNKNOWN_MODEL 失败。

凭据

使用 apiKeyEnv——它是一个引用,每次请求时解析,密钥本身不进配置文件。省略它会让路由不带认证,对内置目录路由意味着交给 pi-ai 自己的环境发现。给了引用却解析不到,请求会以 MISSING_CREDENTIAL 失败,而不是退回去用环境里碰巧存在的某个不相干的 key 计费。

dsh 下,引用依次从继承环境、模型页的 $DSH_HOME/.credentials.yaml 存储、调用目录的 .env$DSH_HOME/.env 解析。未挂载凭据服务时,引用只读取同名环境变量。一份凭据供该路由上的所有模型使用。

让 agent智能体用上新提供方

配好的路由会出现在 Web 的模型选择器里,随时可切。

在那里切换同时也就选定了默认值:你选的模型会成为下一个新会话的起点,记录在 settings.yamlagent-default-model 段里。没有另一个单独的手势。

agent-default-model:
  provider: acme-gateway
  model: acme-large
  reasoningEffort: high   # optional

会话跑过一轮后,其自身日志仍是模型选择的权威;默认值只适用于尚无请求记录的会话。这个段落之下的出厂兜底是 base 组合包的 agent-default-model 组合条目(deepseek-official / deepseek-v4-flash)。自行组装的 cordis.yml 会挂载并配置 @deepseek-ai/dsh-agent-default-model;直接入口与 Host 支撑的入口都读取同一服务。

如果某个已存默认值指向的提供方后来被删掉了,输入框会显示选择模型并拒绝输入,而不是把消息发给一个没人服务的路由。

排错

  • MISSING_CREDENTIAL — profile 里的 apiKeyEnv 指向的变量没有值。用模型页存一次密钥,或导出该环境变量。
  • UNKNOWN_MODEL — 请求的模型不在该路由配置的目录里。把它加进 models,或改用目录里已有的 id。
  • UNSUPPORTED_REASONING_EFFORT — 请求向模型要了一个它不提供的档位。从输入框为该模型列出的档位里挑一个,或把缺的那个声明进该模型的 reasoningEfforts
  • settings-rejected — 写入的 profile 服务不了,错误信息会点名具体的路由和模型。手工声明的路由检查 apibaseURLmodels 是否齐全。
  • 获取可用模型返回 401 — 端点拒绝了这次探测。检查密钥;若地址指向的是 Anthropic 风格网关,注意探测只读 OpenAI 兼容的 GET /models,此时手工填写模型即可。

精确字段参考

每个插件当前支持的完整字段、类型与默认值见自动生成的插件配置目录。两个适配器各自的语义由它们的 README 负责:dsh-llm-pi-aidsh-llm-deepseekcordis.yml 本身的写法见配置文件