跳到主要内容

添加提供商

Hermes 已经可以通过自定义提供商路径与任何 OpenAI 兼容的端点通信。除非你希望为该服务提供一流的用户体验，否则不要添加内置提供商：

  • 提供商特定的身份验证或令牌刷新
  • 精选的模型目录
  • 设置 / hermes model 菜单项
  • provider:model 语法的提供商别名
  • 需要适配器的非 OpenAI API 格式

如果该提供商只是“另一个 OpenAI 兼容的基础 URL 和 API 密钥”，那么一个命名的自定义提供商可能就足够了。

心智模型​

一个内置提供商需要在多个层级上保持一致：

  1. hermes_cli/auth.py 决定如何查找凭据。
  2. hermes_cli/runtime_provider.py 将其转换为运行时数据：
    • provider
    • api_mode
    • base_url
    • api_key
    • source
  3. run_agent.py 使用 api_mode 来决定如何构建和发送请求。
  4. hermes_cli/models.py、hermes_cli/main.py 和 hermes_cli/setup.py 使提供商出现在 CLI 中。
  5. agent/auxiliary_client.py 和 agent/model_metadata.py 确保辅助任务和令牌预算正常工作。

重要的抽象是 api_mode。

  • 大多数提供商使用 chat_completions。
  • Codex 使用 codex_responses。
  • Anthropic 使用 anthropic_messages。
  • 一个新的非 OpenAI 协议通常意味着添加一个新的适配器和一个新的 api_mode 分支。

首先选择实现路径​

路径 A — OpenAI 兼容的提供商​

当提供商接受标准聊天补全风格的请求时使用此路径。

典型工作：

  • 添加身份验证元数据
  • 添加模型目录 / 别名
  • 添加运行时解析
  • 添加 CLI 菜单连接
  • 添加辅助模型默认值
  • 添加测试和用户文档

通常不需要新的适配器或新的 api_mode。

路径 B — 原生提供商​

当提供商的行为不像 OpenAI 聊天补全时使用此路径。

当前代码库中的示例：

  • codex_responses
  • anthropic_messages

此路径包括路径 A 的所有内容，外加：

  • agent/ 中的提供商适配器
  • run_agent.py 中用于请求构建、分发、用量提取、中断处理和响应规范化的分支
  • 适配器测试

文件清单​

每个内置提供商都必需的​

  1. hermes_cli/auth.py
  2. hermes_cli/models.py
  3. hermes_cli/runtime_provider.py
  4. hermes_cli/main.py
  5. hermes_cli/setup.py
  6. agent/auxiliary_client.py
  7. agent/model_metadata.py
  8. 测试
  9. 面向用户的文档，位于 website/docs/ 下

原生 / 非 OpenAI 提供商额外需要的​

  1. agent/<provider>_adapter.py
  2. run_agent.py
  3. pyproject.toml（如果需要提供商 SDK）

步骤 1：选择一个规范的提供商 ID​

选择一个单一的提供商 ID 并在各处使用它。

代码库中的示例：

  • openai-codex
  • kimi-coding
  • minimax-cn

同一个 ID 应出现在：

  • hermes_cli/auth.py 中的 PROVIDER_REGISTRY
  • hermes_cli/models.py 中的 _PROVIDER_LABELS
  • hermes_cli/auth.py 和 hermes_cli/models.py 中的 _PROVIDER_ALIASES
  • hermes_cli/main.py 中的 CLI --provider 选项
  • 设置 / 模型选择分支
  • 辅助模型默认值
  • 测试

如果这些文件中的 ID 不一致，提供商会感觉只连接了一半：身份验证可能工作，而 /model、设置或运行时解析却静默地找不到它。

步骤 2：在 hermes_cli/auth.py 中添加身份验证元数据​

对于 API 密钥提供商，向 PROVIDER_REGISTRY 添加一个 ProviderConfig 条目，包含：

  • id
  • name
  • auth_type="api_key"
  • inference_base_url
  • api_key_env_vars
  • 可选的 base_url_env_var

同时向 _PROVIDER_ALIASES 添加别名。

使用现有的提供商作为模板：

  • 简单的 API 密钥路径：Z.AI, MiniMax
  • 带端点检测的 API 密钥路径：Kimi, Z.AI
  • 原生令牌解析：Anthropic
  • OAuth / 身份验证存储路径：Nous, OpenAI Codex

这里需要回答的问题：

  • Hermes 应该检查哪些环境变量，优先级顺序是什么？
  • 提供商是否需要基础 URL 覆盖？
  • 它需要端点探测或令牌刷新吗？
  • 当凭据缺失时，身份验证错误应该提示什么？

如果提供商需要的不仅仅是“查找一个 API 密钥”，请添加一个专用的凭据解析器，而不是将逻辑塞进不相关的分支。

步骤 3：在 hermes_cli/models.py 中添加模型目录和别名​

更新提供商目录，以便提供商在菜单和 provider:model 语法中工作。

典型的编辑：

  • _PROVIDER_MODELS
  • _PROVIDER_LABELS
  • _PROVIDER_ALIASES
  • list_available_providers() 内部的提供商显示顺序
  • provider_model_ids()（如果提供商支持实时获取 /models）

如果提供商暴露实时模型列表，优先使用它，并将 _PROVIDER_MODELS 作为静态回退。

这个文件也使得以下输入能够工作：

anthropic:claude-sonnet-4-6
kimi:model-name

如果这里缺少别名，提供商可能身份验证正确，但在 /model 解析中仍然失败。

步骤 4：在 hermes_cli/runtime_provider.py 中解析运行时数据​

resolve_runtime_provider() 是 CLI、网关、cron、ACP 和辅助客户端使用的共享路径。

添加一个分支，返回至少包含以下内容的字典：

{
    "provider": "your-provider",
    "api_mode": "chat_completions",  # 或你的原生模式
    "base_url": "https://...",
    "api_key": "...",
    "source": "env|portal|auth-store|explicit",
    "requested_provider": requested_provider,
}

如果提供商是 OpenAI 兼容的，api_mode 通常应保持为 chat_completions。

注意 API 密钥的优先级。Hermes 已经包含逻辑来避免将 OpenRouter 密钥泄露给不相关的端点。新提供商应同样明确哪个密钥对应哪个基础 URL。

步骤 5：在 hermes_cli/main.py 和 hermes_cli/setup.py 中连接 CLI​

提供商在出现在交互式流程中之前是不可发现的。

更新：

hermes_cli/main.py​

  • provider_labels
  • model 命令内部的提供商分发
  • --provider 参数选项
  • 如果提供商支持这些流程，则添加登录/注销选项
  • 一个 _model_flow_<provider>() 函数，如果合适则复用 _model_flow_api_key_provider()

hermes_cli/setup.py​

  • provider_choices
  • 提供商的身份验证分支
  • 模型选择分支
  • 任何提供商特定的解释性文本
  • 任何提供商应被排除在仅限 OpenRouter 的提示或路由设置之外的地方

如果只更新其中一个文件，hermes model 和 hermes setup 将会脱节。

步骤 6：保持辅助调用正常工作​

这里有两个文件很重要：

agent/auxiliary_client.py​

如果这是一个直接的 API 密钥提供商，向 _API_KEY_PROVIDER_AUX_MODELS 添加一个廉价 / 快速的默认辅助模型。

辅助任务包括：

  • 视觉摘要
  • 网页提取摘要
  • 上下文压缩摘要
  • 会话搜索摘要
  • 内存刷新

如果提供商没有合理的辅助默认值，辅助任务可能会严重回退或意外地使用昂贵的主模型。

agent/model_metadata.py​

添加提供商模型的上下文长度，以便令牌预算、压缩阈值和限制保持合理。

步骤 7：如果提供商是原生的，添加适配器和 run_agent.py 支持​

如果提供商不是普通的聊天补全，请将提供商特定的逻辑隔离在 agent/<provider>_adapter.py 中。

保持 run_agent.py 专注于编排。它应该调用适配器辅助函数，而不是在整个文件中内联手动构建提供商负载。

原生提供商通常需要在以下地方进行工作：

新的适配器文件​

典型职责：

  • 构建 SDK / HTTP 客户端
  • 解析令牌
  • 将 OpenAI 风格的对话消息转换为提供商的请求格式
  • 如果需要，转换工具模式
  • 将提供商响应规范化为 run_agent.py 期望的格式
  • 提取用量和完成原因数据

run_agent.py​

搜索 api_mode 并审核每个切换点。至少验证：

  • __init__ 选择新的 api_mode
  • 客户端构建适用于该提供商
  • _build_api_kwargs() 知道如何格式化请求
  • _api_call_with_interrupt() 分发到正确的客户端调用
  • 中断 / 客户端重建路径正常工作
  • 响应验证接受提供商的格式
  • 完成原因提取正确
  • 令牌用量提取正确
  • 回退模型激活可以干净地切换到新提供商
  • 摘要生成和内存刷新路径仍然有效

同时在 run_agent.py 中搜索 self.client.。任何假设标准 OpenAI 客户端存在的代码路径，当原生提供商使用不同的客户端对象或 self.client = None 时，都可能中断。

提示缓存和提供商特定的请求字段​

提示缓存和提供商特定的旋钮很容易退化。

代码库中已有的示例：

  • Anthropic 有一个原生提示缓存路径
  • OpenRouter 获取提供商路由字段
  • 并非每个提供商都应该接收每个请求端选项

添加原生提供商时，请仔细检查 Hermes 是否只发送该提供商实际理解的字段。

步骤 8：测试​

至少，要触及保护提供商连接的测试。

常见位置：

  • tests/test_runtime_provider_resolution.py
  • tests/test_cli_provider_resolution.py
  • tests/test_cli_model_command.py
  • tests/test_setup_model_selection.py
  • tests/test_provider_parity.py
  • tests/test_run_agent.py
  • 对于原生提供商，还有 tests/test_<provider>_adapter.py

对于仅文档的示例，确切的文件集可能有所不同。重点是覆盖：

  • 身份验证解析
  • CLI 菜单 / 提供商选择
  • 运行时提供商解析
  • 代理执行路径
  • provider:model 解析
  • 任何适配器特定的消息转换

运行测试时禁用 xdist：

source venv/bin/activate
python -m pytest tests/test_runtime_provider_resolution.py tests/test_cli_provider_resolution.py tests/test_cli_model_command.py tests/test_setup_model_selection.py -n0 -q

对于更深入的更改，在推送前运行完整的测试套件：

source venv/bin/activate
python -m pytest tests/ -n0 -q

步骤 9：实时验证​

测试之后，运行一个真实的冒烟测试。

source venv/bin/activate
python -m hermes_cli.main chat -q "Say hello" --provider your-provider --model your-model

如果更改了菜单，也测试交互式流程：

source venv/bin/activate
python -m hermes_cli.main model
python -m hermes_cli.main setup

对于原生提供商，至少验证一个工具调用，而不仅仅是纯文本响应。

步骤 10：更新面向用户的文档​

如果提供商打算作为一流选项发布，也请更新用户文档：

  • website/docs/getting-started/quickstart.md
  • website/docs/user-guide/configuration.md
  • website/docs/reference/environment-variables.md

开发者可以完美地连接提供商，但仍然可能让用户无法发现所需的环境变量或设置流程。

OpenAI 兼容提供商清单​

如果提供商是标准聊天补全，请使用此清单。

  • 在 hermes_cli/auth.py 中添加了 ProviderConfig
  • 在 hermes_cli/auth.py 和 hermes_cli/models.py 中添加了别名
  • 在 hermes_cli/models.py 中添加了模型目录
  • 在 hermes_cli/runtime_provider.py 中添加了运行时分支
  • 在 hermes_cli/main.py 中添加了 CLI 连接
  • 在 hermes_cli/setup.py 中添加了设置连接
  • 在 agent/auxiliary_client.py 中添加了辅助模型
  • 在 agent/model_metadata.py 中添加了上下文长度
  • 更新了运行时 / CLI 测试
  • 更新了用户文档

原生提供商清单​

当提供商需要新的协议路径时，请使用此清单。

  • OpenAI 兼容清单中的所有内容
  • 在 agent/<provider>_adapter.py 中添加了适配器
  • 在 run_agent.py 中支持新的 api_mode
  • 中断 / 重建路径正常工作
  • 用量和完成原因提取正常工作
  • 回退路径正常工作
  • 添加了适配器测试
  • 实时冒烟测试通过

常见陷阱​

1. 将提供商添加到身份验证但未添加到模型解析​

这会导致凭据解析正确，而 /model 和 provider:model 输入失败。

2. 忘记 config["model"] 可以是字符串或字典​

许多 provider-selection 代码必须对这两种形式进行规范化处理。

3. 假设必须使用内置 provider​

如果服务只是 OpenAI 兼容的，自定义 provider 可能已经能用更少的维护工作解决用户的问题。

4. 忘记辅助路径​

主要聊天路径可能正常工作，但摘要、记忆清理或视觉辅助功能可能失败，因为辅助路由从未更新。

5. 隐藏在 run_agent.py 中的原生 provider 分支​

搜索 api_mode 和 self.client.。不要假设显而易见的请求路径是唯一的一条。

6. 将仅适用于 OpenRouter 的调节参数发送给其他 providers​

像 provider routing 这样的字段只应出现在支持它们的 providers 上。

7. 更新了 hermes model 但没有更新 hermes setup​

这两个流程都需要了解 provider 的信息。

实现时的良好搜索目标​

如果你正在查找 provider 触及的所有地方，请搜索以下符号：

  • PROVIDER_REGISTRY
  • _PROVIDER_ALIASES
  • _PROVIDER_MODELS
  • resolve_runtime_provider
  • _model_flow_
  • provider_choices
  • api_mode
  • _API_KEY_PROVIDER_AUX_MODELS
  • self.client.

相关文档​