Files
ruoyi-ai/docs/model-configuration.md

2.1 KiB
Raw Blame History

模型与 API Key 配置

模型的 API Key 统一在 ruoyi-admin → 对话管理 → 模型管理 中配置。

  1. 在“厂商管理”中选择并启用对应厂商,填写服务 API 地址。
  2. 在“模型管理”中新建或编辑模型,选择厂商、分类,填写服务商提供的模型 ID。
  3. 在“密钥”框直接粘贴真实 API Key,保存模型。
  4. 在 ruoyi-web 中选择模型使用;向量和重排模型则在对应知识库配置中选择。

需要 API Key 的厂商适配器使用该模型保存的 Key,不要求固定的 Key 前缀或环境变量名称。自定义 OpenAI、Anthropic 服务的地址与 Key 也在模型管理中配置,无需设置配对环境变量。无需鉴权的本地模型可以不填 Key。

修改与批量更新

  • 编辑模型时回显已保存的 Key,默认以密码形式隐藏,点击眼睛可查看原文;每次重新打开编辑框都会恢复隐藏。
  • 密钥按输入内容原样保存,不限制前缀或格式,也不去除首尾空格。清空后保存会清除原 Key。
  • 按厂商批量更新接口会将提交的 Key 保存到该厂商的模型中。
  • 保存后新的模型调用会读取最新配置,无需重启后端。正在进行的请求继续使用开始时的配置。
  • 模型列表、聊天用户端和导出文件不返回 Key。

已有模型

如果模型中原来保存的是 env:ATLAS_API_KEY 等文本,请在后台将其替换为真实 Key。密钥字段按填写内容直接使用,不解析 env: 引用。无需重新导入数据库。

示例

场景 厂商编码 密钥框填写内容
千问聊天、向量或重排 qianwen 阿里云百炼的 API Key
DeepSeek deepseek DeepSeek 控制台创建的 API Key
Atlas 多媒体 atlas Atlas 控制台创建的 API Key
Dify 聊天应用 dify 对应应用的 app-... Key
自定义 OpenAI / Anthropic custom_api / custom_anthropic 对应服务的 API Key

填写的地址、模型 ID 和 Key 应对应同一个服务账号。模型是否可用、支持哪些能力以及额度限制,以服务商实际响应为准。