构建模型提供商插件
模型提供商插件声明一个推理后端——一个兼容 OpenAI 的端点、Anthropic Messages 服务器、Codex 风格的 Responses API,或 Bedrock 原生接口——Hermes 可以通过它路由 AIAgent 调用。每个内置提供商(OpenRouter、Anthropic、GMI、DeepSeek、Nvidia……)都以此类插件形式提供。第三方可以通过在 $HERMES_HOME/plugins/model-providers/ 下放置目录来添加自己的提供商,无需对仓库进行任何修改。
:::tip 模型提供商插件是第三种提供商插件。其他类型包括内存提供商插件(跨会话知识)和上下文引擎插件(上下文压缩策略)。三者都遵循相同的”放置目录、声明配置文件、无需编辑仓库”模式。 :::
发现机制
providers/__init__.py._discover_providers() 在首次调用 get_provider_profile() 或 list_providers() 时延迟执行。发现顺序:
- 内置插件 —
<repo>/plugins/model-providers/<name>/— 随 Hermes 一起提供 - 用户插件 —
$HERMES_HOME/plugins/model-providers/<name>/— 放入任意目录;后续会话无需重启 - 旧式单文件 —
<repo>/providers/<name>.py— 向后兼容树外可编辑安装
用户插件覆盖同名的内置插件,因为 register_provider() 采用后写者胜出策略。将 $HERMES_HOME/plugins/model-providers/gmi/ 目录放入以替换内置 GMI 配置文件,无需接触仓库。
目录结构
plugins/model-providers/my-provider/
├── __init__.py # 在模块级别调用 register_provider(profile)
├── plugin.yaml # kind: model-provider + 元数据(可选但推荐)
└── README.md # 安装说明(可选)
唯一必需的文件是 __init__.py。plugin.yaml 被 hermes plugins 用于内省,被通用 PluginManager 用于将插件路由到正确的加载器;没有它,通用加载器会退回到基于源码文本的启发式判断。
最小示例——一个简单的 API 密钥提供商
# plugins/model-providers/acme-inference/__init__.py
from providers import register_provider
from providers.base import ProviderProfile
acme = ProviderProfile(
name="acme-inference",
aliases=("acme",),
display_name="Acme Inference",
description="Acme — 兼容 OpenAI 的直接 API",
signup_url="https://acme.example.com/keys",
env_vars=("ACME_API_KEY", "ACME_BASE_URL"),
base_url="https://api.acme.example.com/v1",
auth_type="api_key",
default_aux_model="acme-small-fast",
fallback_models=(
"acme-large-v3",
"acme-medium-v3",
"acme-small-fast",
),
)
register_provider(acme)# plugins/model-providers/acme-inference/plugin.yaml
name: acme-inference
kind: model-provider
version: 1.0.0
description: Acme Inference — 兼容 OpenAI 的直接 API
author: Your Name仅此而已。放入这两个文件后,以下集成将自动连线,无需其他修改:
| 集成 | 位置 | 获得的内容 |
|---|---|---|
| 凭据解析 | hermes_cli/auth.py | PROVIDER_REGISTRY["acme-inference"] 从配置文件填充 |
--provider CLI 标志 | hermes_cli/main.py | 接受 acme-inference |
hermes model 选择器 | hermes_cli/models.py | 出现在 CANONICAL_PROVIDERS 中,模型列表从 {base_url}/models 获取 |
hermes doctor | hermes_cli/doctor.py | 健康检查 ACME_API_KEY + {base_url}/models 探测 |
hermes setup | hermes_cli/config.py | ACME_API_KEY 出现在 OPTIONAL_ENV_VARS 和安装向导中 |
| URL 反向映射 | agent/model_metadata.py | 主机名 → 提供商名称,用于自动检测 |
| 辅助模型 | agent/auxiliary_client.py | 使用 default_aux_model 进行压缩/摘要 |
| 运行时解析 | hermes_cli/runtime_provider.py | 返回正确的 base_url、api_key、api_mode |
| 传输层 | agent/transports/chat_completions.py | 配置文件路径通过 prepare_messages / build_extra_body / build_api_kwargs_extras 生成 kwargs |
ProviderProfile 字段
完整定义见 providers/base.py。最常用的字段:
| 字段 | 类型 | 用途 |
|---|---|---|
name | str | 规范 ID — 匹配 --provider 选项和 HERMES_INFERENCE_PROVIDER |
aliases | tuple[str, ...] | 由 get_provider_profile() 解析的别名(例如 grok → xai) |
api_mode | str | chat_completions | codex_responses | anthropic_messages | bedrock_converse |
display_name | str | 在 hermes model 选择器中显示的人类标签 |
description | str | 选择器副标题 |
signup_url | str | 首次安装时显示(“在此获取 API 密钥”) |
env_vars | tuple[str, ...] | API 密钥环境变量,按优先级排序;最后一个 *_BASE_URL 条目用作基础 URL 覆盖 |
base_url | str | 默认推理端点 |
models_url | str | 明确的模型目录 URL(回退到 {base_url}/models) |
auth_type | str | api_key | oauth_device_code | oauth_external | copilot | aws_sdk | external_process |
fallback_models | tuple[str, ...] | 在线目录获取失败时使用的精选列表 |
default_headers | dict[str, str] | 每次请求都发送(例如 Copilot 的 Editor-Version) |
fixed_temperature | Any | None = 使用调用者设置的值;OMIT_TEMPERATURE 哨兵 = 完全不发送 temperature(Kimi) |
default_max_tokens | int | None | 提供商级别的 max_tokens 上限(Nvidia:16384) |
default_aux_model | str | 用于辅助任务(压缩、视觉、摘要)的廉价模型 |
可覆盖的钩子
继承 ProviderProfile 以处理非平凡的 quirks:
from typing import Any
from providers.base import ProviderProfile
class AcmeProfile(ProviderProfile):
def prepare_messages(self, messages: list[dict[str, Any]]) -> list[dict[str, Any]]:
"""提供商特有的消息预处理。在 codex 清理之后、
开发者角色交换之前运行。默认:透传。"""
# 示例:Qwen 将纯文本内容规范化为多部分数组
# 并注入 cache_control;Kimi 重写工具调用 JSON
return messages
def build_extra_body(self, *, session_id=None, **context) -> dict:
"""提供商特有的 extra_body 字段,合并到 API 调用中。
上下文包括:session_id、provider_preferences、model、base_url、
reasoning_config。默认:空字典。"""
# 示例:OpenRouter 的 provider-preferences 块、
# Gemini 的 thinking_config 转换。
return {}
def build_api_kwargs_extras(self, *, reasoning_config=None, **context):
"""返回 (extra_body_additions, top_level_kwargs)。当某些
字段需要放在顶层(Kimi 的 reasoning_effort)而某些需要放在
extra_body(OpenRouter 的 reasoning 字典)时使用。
默认:({}, {})。"""
return {}, {}
def fetch_models(self, *, api_key=None, timeout=8.0) -> list[str] | None:
"""在线目录获取。默认访问 {models_url 或 base_url}/models,
使用 Bearer 认证。覆盖用于:自定义认证(Anthropic)、
无 REST 端点(Bedrock → None)或公共/未认证目录(OpenRouter)。"""
return super().fetch_models(api_key=api_key, timeout=timeout)钩子参考示例
查看这些内置插件以了解惯用模式:
| 插件 | 查看原因 |
|---|---|
plugins/model-providers/openrouter/ | 聚合器,包含提供商偏好设置、公共模型目录 |
plugins/model-providers/gemini/ | thinking_config 转换(原生 + 兼容 OpenAI 的嵌套形式) |
plugins/model-providers/kimi-coding/ | OMIT_TEMPERATURE、extra_body.thinking、顶层 reasoning_effort |
plugins/model-providers/qwen-oauth/ | 消息规范化、cache_control 注入、VL 高分辨率 |
plugins/model-providers/nous/ | 归属标签、“禁用时省略 reasoning” |
plugins/model-providers/custom/ | Ollama num_ctx + think: false quirks |
plugins/model-providers/bedrock/ | api_mode="bedrock_converse"、fetch_models 返回 None(无 REST 端点) |
用户覆盖——无需编辑仓库即可替换内置插件
假设您想将 gmi 指向私有暂存端点进行测试。创建 ~/.hermes/plugins/model-providers/gmi/__init__.py:
from providers import register_provider
from providers.base import ProviderProfile
register_provider(ProviderProfile(
name="gmi",
aliases=("gmi-cloud", "gmicloud"),
env_vars=("GMI_API_KEY",),
base_url="https://gmi-staging.internal.example.com/v1",
auth_type="api_key",
default_aux_model="google/gemini-3.1-flash-lite-preview",
))下次会话,get_provider_profile("gmi").base_url 返回暂存 URL。无需仓库补丁,无需重建。因为用户插件在发现顺序中晚于内置插件,所以用户的 register_provider() 调用胜出。
api_mode 选择
支持四种模式。Hermes 按以下优先级选择:
- 用户显式覆盖(
config.yaml中设置了model.api_mode时) - OpenCode 的按模型分发(Zen 和 Go 的
opencode_model_api_mode) - URL 自动检测 —
/anthropic后缀 →anthropic_messages、api.openai.com→codex_responses、api.x.ai→codex_responses、Kimi 域名上的/coding→chat_completions - 配置文件的
api_mode作为 URL 检测失败的备用方案 - 默认
chat_completions
设置 profile.api_mode 以匹配您的提供商默认提供的模式——它作为一个提示。用户 URL 覆盖仍然优先。
认证类型
auth_type | 含义 | 谁在使用 |
|---|---|---|
api_key | 单个环境变量携带静态 API 密钥 | 大多数提供商 |
oauth_device_code | 设备代码 OAuth 流程 | — |
oauth_external | 用户在别处登录,令牌存入 auth.json | Anthropic OAuth、MiniMax OAuth、Gemini Cloud Code、Qwen Portal、Nous Portal |
copilot | GitHub Copilot 令牌刷新循环 | 仅 copilot 插件 |
aws_sdk | AWS SDK 凭据链(IAM 角色、配置文件、环境变量) | 仅 bedrock 插件 |
external_process | 由代理生成的子进程处理认证 | 仅 copilot-acp 插件 |
auth_type 控制哪些代码路径将您的提供商视为”简单的 API 密钥提供商”——如果不是 api_key,PluginManager 仍然记录清单,但 Hermes 的 CLI 级自动化(doctor 检查、--provider 标志、安装向导委托)可能会跳过它。
发现时机
提供商发现是延迟的——由进程中的首次 get_provider_profile() 或 list_providers() 调用触发。实际上,这在启动时早期发生(auth.py 模块加载会急切地扩展 PROVIDER_REGISTRY)。如果您需要验证插件是否已加载,请运行:
hermes doctor——成功的 auth_type="api_key" 配置文件会在提供商连接部分显示,并带有 /models 探测。
程序化检查:
from providers import list_providers
for p in list_providers():
print(p.name, p.base_url, p.api_mode)测试您的插件
将 HERMES_HOME 指向临时目录,以免污染真实配置:
export HERMES_HOME=/tmp/hermes-plugin-test
mkdir -p $HERMES_HOME/plugins/model-providers/my-provider
cat > $HERMES_HOME/plugins/model-providers/my-provider/__init__.py <<'EOF'
from providers import register_provider
from providers.base import ProviderProfile
register_provider(ProviderProfile(
name="my-provider",
env_vars=("MY_API_KEY",),
base_url="https://api.my-provider.example.com/v1",
auth_type="api_key",
))
EOF
export MY_API_KEY=your-test-key
hermes -z "hello" --provider my-provider -m some-model通用 PluginManager 集成
通用的 PluginManager(hermes plugins 操作的对象)能看到模型提供商插件,但不会导入它们——providers/__init__.py 负责其生命周期。管理器记录清单用于内省,并按 kind: model-provider 分类。当您将未标记的用户插件放入 $HERMES_HOME/plugins/,且该插件恰好调用了带有 ProviderProfile 的 register_provider,管理器会通过源码文本启发式自动将其强制转换为 kind: model-provider——因此即使没有 plugin.yaml,插件也能正确路由。
通过 pip 分发
与任何 Hermes 插件一样,模型提供商可以作为 pip 包分发。在您的 pyproject.toml 中添加入口点:
[project.entry-points."hermes.plugins"]
acme-inference = "acme_hermes_plugin:register"……其中 acme_hermes_plugin:register 是一个调用 register_provider(profile) 的函数。通用 PluginManager 在 discover_and_load() 期间拾取入口点插件。对于 kind: model-provider 的 pip 插件,您仍然需要在清单中声明 kind(或依赖源码文本启发式)。
有关入口点设置的完整信息,请参阅构建 Hermes 插件。
相关页面
- 提供商运行时 — 解析优先级 + 每一层读取配置文件的位置
- 添加提供商 — 新推理后端的端到端检查清单(涵盖快速插件路径和完整的 CLI/认证集成)
- 内存提供商插件
- 上下文引擎插件
- 构建 Hermes 插件 — 通用插件创作指南