English | 中文
本指南假定你已按照根 README启动 Web UI。模型变更会在下一次请求时生效,不需要重启服务器。
打开设置 → 模型。DeepSeek 卡片提供一个 API 密钥字段;输入密钥并保存。
密钥是只写的。保存后,页面只会收到脱敏描述符,永远不会收到明文密钥。密钥存储在 $DSH_HOME/.credentials.yaml 中,settings 只保留它的凭据引用。
选择添加提供方,选取 dsh 自带的提供方;列表显示的是提供方 id,例如 anthropic、openai、Kimi 对应的 moonshotai、GLM 对应的 zai。输入其 API 密钥并保存。已安装目录会提供端点、协议和模型列表。
通过 OAuth 登录的提供方(例如 Codex)暂不支持。
对于公司网关、自建服务器或已安装目录中不存在的提供方,选择添加自定义提供方。提供小写 Provider ID、基础 URL、API 协议、凭据和至少一个模型。API 协议必须选网关实际使用的那一种,表单提供三种:openai-completions 对应 OpenAI Chat Completions,openai-responses 对应 OpenAI Responses API,anthropic-messages 对应 Anthropic Messages API。一个提供方只使用一种协议,网关同时提供两种时需要建两个提供方。
Provider ID 是永久的,因为请求、已保存会话、模型默认值和凭据引用都会使用它。如需重命名提供方,请添加新提供方并删除旧提供方。显示名称、基础 URL、协议、凭据和模型仍可编辑。
在模型目录中选择获取可用模型,即可询问端点它提供哪些模型。请求使用表单当前的 API 地址、协议和密钥,已保存的提供方则用已存储的密钥;响应会打开一个可搜索的选择框,搜索、勾选想要的模型,再点添加所选。保存或创建提供方之前不会存储任何内容。
探测读取的是常见网关公开的列表格式,但并非每个端点都用这些格式作答,所以它只是便利手段而非保证:探测失败或列表为空时,手动添加模型 ID 即可,效果完全一样。内置提供方一律由已安装目录作答,即使其 API 地址指向网关也是如此,要查看网关实际提供的模型,请通过自定义提供方探测。
已配置的提供方会出现在模型选择器中。选择模型也会将其设为新会话的默认值。已发送过请求的会话会保留自身日志中记录的模型。
如果已保存默认值指向已删除的提供方,输入框会显示选择模型,并在选择其他模型前阻止输入。
自动生成的插件配置目录列出每个插件的所有受支持字段与默认值;dsh-llm-pi-ai 就是本页所配置的那个提供方段落。dsh-llm-pi-ai 和 dsh-llm-deepseek 参考文档负责直接 settings.yaml 配置、目录解析、推理控制、凭据与适配器错误。
::: tip 表单刻意保持精简
模型页只开放让一条路由得以存在的字段:API 密钥、显示名称、API 地址、API 协议,以及每个模型的 ID、显示名称、上下文窗口和最大输出 token 数。其余所有字段——推理等级、图片输入、请求兼容性开关、请求头、超时、重试策略——都在 $DSH_HOME/settings.yaml 中设置,也就是模型页写入的同一份文档。可以直接编辑它;浏览器与服务器在同一台机器时,也可以点击设置页顶部的打开配置文件打开它。适配器会在下一次请求时重新读取,无需重启任何东西。下面各小节介绍多数网关会用到的字段。
:::
手动输入的模型在自己声明之前一律按纯文本对待,因为没有任何环节能去询问端点接受哪些模态。给这类模型附加图片,会在发送前就被拒绝,并点名该模型。
因此自定义提供方下的视觉模型需要加一行。表单没有对应字段;请在 $DSH_HOME/settings.yaml 中给该模型加上 input:
llm-pi-ai:
providers:
my-gateway:
apiKeyEnv: GATEWAY_API_KEY
api: openai-completions
baseURL: https://gateway.example/v1
models:
- id: legacy-chat
- id: vision-preview
input: [text, image]
input 接受 text 和 image,且只作用于该模型,因此一条路由可以同时服务两类模型。省略它——或写成空列表,两者同义——则保留已安装目录为该模型记录的模态;目录未描述的模型则回退到该路由的 defaultInput。
如果你手动录入的模型全都接受图片,可以在路由上设置一次回退值,不必逐个模型写:
llm-pi-ai:
providers:
vision-gateway:
apiKeyEnv: GATEWAY_API_KEY
api: openai-completions
baseURL: https://vision.example/v1
defaultInput: [text, image]
models:
- id: first-model
- id: second-model
defaultInput 是回退值而不是覆盖值,默认为 [text]:在内置提供方上,它只为其目录未描述的模型作答,因此绝不会把目录中本就具备图片能力的模型的该能力去掉。要收窄这类模型,请用它自己的 input。内置提供方没有可供填写的 models 列表,因此写在 modelOverrides 下,以模型 id 为键:
llm-pi-ai:
providers:
anthropic:
modelOverrides:
claude-sonnet-4-5:
input: [text]
除模型自身的列表外,每个列表都至少要写一项模态;模型自身的空列表与省略它同义。未知模态在任何位置写入都会被拒绝。
这两个字段都是对你端点的断言,而不是对它的检查。声明了端点并不提供的图片能力的模型不会在这里被拦下,改由提供方拒绝该请求。
对于声明了推理等级的模型,模型选择器会提供推理等级菜单。内置提供方的模型从已安装目录继承其等级。手动录入的模型不声明任何等级,因此模型菜单里不会出现推理等级项,由端点自身的默认值决定模型是否思考。请在 $DSH_HOME/settings.yaml 中用 reasoningEfforts 声明等级:
llm-pi-ai:
providers:
my-gateway:
apiKeyEnv: GATEWAY_API_KEY
api: openai-completions
baseURL: https://gateway.example/v1
reasoning: high
models:
- id: my-reasoner
reasoningEfforts:
off:
high: high
max: max
每个键都是菜单提供的一个等级,其值是在协议上以 reasoning_effort 发送的写法,因此 max: xhigh 可以为自有一套词汇的网关重命名某个等级。只有 off 可以留空,因为对多数端点来说,不思考就是不传该参数。路由的 reasoning 是会话尚未选择等级时采用的等级;在选择器中选定某个等级后,它会与模型一起保存为新会话的默认值。
留空的 off 什么都不发送,这只能让「按请求才思考」的模型停下来;给 off 一个值,则会把该值作为 reasoning_effort 发送。对于「不明确关闭就会思考」的模型——例如 OpenAI 兼容网关后面的 DeepSeek V4——需要 compat.thinkingFormat: deepseek:它让 off 发送 thinking: {type: disabled},其他每个等级则在 effort 之外再发送 thinking: {type: enabled}:
models:
- id: deepseek-v4-pro
compat:
thinkingFormat: deepseek
reasoningEfforts:
off:
high: high
max: max
网关并不提供推理能力的内置提供方模型,可在 modelOverrides 下用 reasoningEfforts: false 去掉其等级;之后再为它选择等级会被拒绝并报 UNSUPPORTED_REASONING_EFFORT。DeepSeek 自身的路由不需要以上任何配置:其模型已经提供 off、low、high 和 max,llm-deepseek.reasoningEffort 设置选择器的起始默认值:
llm-deepseek:
reasoningEffort: max
网关可能持有可用的密钥、地址也通得到,却仍然拒绝每一个请求。pi-ai 依据端点的 URL 决定请求的形状——系统提示词由哪个角色承载、输出上限写在哪个字段、思考级别如何传输——而对于它无法识别的地址,会当作 OpenAI 本身来对待。多数 OpenAI 兼容网关至少会拒绝 OpenAI 所接受的某一样东西。
其中两样占了绝大多数。声明了推理能力的模型,其系统提示词会以 role: "developer" 发出,很多网关直接拒绝;输出上限则写作 max_completion_tokens,只认 max_tokens 的服务端会拒绝。表单里没有这两个字段;请在 $DSH_HOME/settings.yaml 的路由上更正:
llm-pi-ai:
providers:
my-gateway:
apiKeyEnv: GATEWAY_API_KEY
api: openai-completions
baseURL: https://gateway.example/v1
compat:
supportsDeveloperRole: false
maxTokensField: max_tokens
models:
- id: my-model
路由的 compat 是其模型的默认值,模型自身的则逐字段胜出,因此更正某一个模型无需重述整条路由:
models:
- id: my-model
- id: my-reasoner
compat:
thinkingFormat: deepseek
两者都未设置的字段,沿用已安装 catalog 为该模型记录的值;catalog 也未描述的,落到 pi-ai 的检测。凡是写下的开关都要给值:冒号后留空的键(supportsDeveloperRole:)会被拒绝而不是被忽略,因为空值会抹掉 catalog 已知的信息,却又没有给出任何替代。任何协议都不接受的名字同样会被拒绝,报错会列出可用的那些。
每个开关归属于声明了它的那些协议,因此在某个 api 上合法的开关,在另一个上可能被拒绝——报错会点名该协议实际提供哪些。与上面的 input 一样,开关陈述的是关于你的端点的一个断言,而不是对它的检查:设置一个网关其实并不需要的开关,只是发出一个不同的请求而已。
全部开关、各自接受的取值,以及接受它们的协议,都列在生成的 dsh-llm-pi-ai 配置参考的 PiAiCompatProfile 之下——该参考派生自源码,因此不会落后于适配器实际接受的内容。
MISSING_CREDENTIAL:通过模型页存储提供方密钥,或提供被引用的环境变量。UNKNOWN_MODEL:选择已配置的模型,或向自定义提供方添加缺失的模型。GET /models 端点;对于不提供该端点的服务,请手动输入模型。data 数组也没有 models 对象:端点返回的列表格式不在探测的读取范围内。请手动输入模型。compat.supportsDeveloperRole: false 与 compat.maxTokensField: max_tokens。developer 角色发出,而网关拒绝该角色。设 compat.supportsDeveloperRole: false。settings.yaml 中给该模型加上 reasoningEfforts。off 无法让 DeepSeek 模型停止思考:留空的 off 不发送任何推理字段,默认思考的端点就继续思考。请在模型或路由上设置 compat.thinkingFormat: deepseek。input: [text, image];在 DeepSeek 自身的路由上,请选择声明了图片能力的模型 deepseek-v4-flash-vision-exp。image——可能是模型的 input,也可能是路由的 defaultInput——然后开启新会话:附加的图片会留在会话日志里,因此在会话离开它之前,同一个请求会不断重复。