构建图像生成提供者插件

图像生成（image-gen）提供者插件注册一个后端，用于服务每一次 image_generate 工具调用——无论是 DALL·E、gpt-image、Grok、Flux、Imagen、Stable Diffusion、fal、Replicate、本地 ComfyUI 环境，还是其他任何后端。内置提供者（OpenAI、OpenAI-Codex、xAI）均作为插件提供。你可以通过在 plugins/image_gen/<name>/ 中放置一个目录来添加新的提供者，或覆盖已有的捆绑提供者。

提示

图像生成是 Hermes 支持的几种后端插件之一。其他插件（具有更专用的抽象基类 ABC）包括 记忆提供者插件、上下文引擎插件 和 模型提供者插件。通用的工具/钩子/CLI 插件请参阅 构建 Hermes 插件。

发现机制工作原理

Hermes 会在以下三个位置扫描图像生成后端：

1. 捆绑（Bundled） — <repo>/plugins/image_gen/<name>/（随 kind: backend 自动加载，始终可用）
2. 用户（User） — ~/.hermes/plugins/image_gen/<name>/（通过 plugins.enabled 选择启用）
3. Pip — 声明了 hermes_agent.plugins 入口点的包

每个插件的 register(ctx) 函数都会调用 ctx.register_image_gen_provider(...)——这将其放入 agent/image_gen_registry.py 中的注册表。活跃提供者由 config.yaml 中的 image_gen.provider 选定；hermes tools 会引导用户进行选择。

image_generate 工具包装器向注册表请求活跃提供者并分派到该提供者。如果没有注册任何提供者，该工具会显示一条有用的错误信息，指向 hermes tools。

目录结构

plugins/image_gen/my-backend/
├── __init__.py      # ImageGenProvider subclass + register()
└── plugin.yaml      # Manifest with kind: backend

此时，捆绑插件已完整。位于 ~/.hermes/plugins/image_gen/<name>/ 的用户插件需要添加到 config.yaml 中的 plugins.enabled 列表中（或者运行 hermes plugins enable <name>）。

ImageGenProvider 抽象基类 (ABC)

继承 agent.image_gen_provider.ImageGenProvider。唯一必需的成员是 name 属性和 generate() 方法——其他所有成员都有合理的默认值：

# plugins/image_gen/my-backend/__init__.py
from typing import Any, Dict, List, Optional
import os

from agent.image_gen_provider import (
    DEFAULT_ASPECT_RATIO,
    ImageGenProvider,
    error_response,
    resolve_aspect_ratio,
    save_b64_image,
    success_response,
)


class MyBackendImageGenProvider(ImageGenProvider):
    @property
    def name(self) -> str:
        # Stable id used in image_gen.provider config. Lowercase, no spaces.
        return "my-backend"

    @property
    def display_name(self) -> str:
        # Human label shown in `hermes tools`. Defaults to name.title() if omitted.
        return "My Backend"

    def is_available(self) -> bool:
        # Return False if credentials or deps are missing.
        # The tool's availability gate calls this before dispatch.
        if not os.environ.get("MY_BACKEND_API_KEY"):
            return False
        try:
            import my_backend_sdk  # noqa: F401
        except ImportError:
            return False
        return True

    def list_models(self) -> List[Dict[str, Any]]:
        # Catalog shown in `hermes tools` model picker.
        return [
            {
                "id": "my-model-fast",
                "display": "My Model (Fast)",
                "speed": "~5s",
                "strengths": "Quick iteration",
                "price": "$0.01/image",
            },
            {
                "id": "my-model-hq",
                "display": "My Model (HQ)",
                "speed": "~30s",
                "strengths": "Highest fidelity",
                "price": "$0.04/image",
            },
        ]

    def default_model(self) -> Optional[str]:
        return "my-model-fast"

    def get_setup_schema(self) -> Dict[str, Any]:
        # Metadata for the `hermes tools` picker — keys to prompt for at setup.
        return {
            "name": "My Backend",
            "badge": "paid",        # optional; shown as a short tag in the picker
            "tag": "One-line description shown under the name",
            "env_vars": [
                {
                    "key": "MY_BACKEND_API_KEY",
                    "prompt": "My Backend API key",
                    "url": "https://my-backend.example.com/api-keys",
                },
            ],
        }

    def generate(
        self,
        prompt: str,
        aspect_ratio: str = DEFAULT_ASPECT_RATIO,
        **kwargs: Any,
    ) -> Dict[str, Any]:
        prompt = (prompt or "").strip()
        aspect_ratio = resolve_aspect_ratio(aspect_ratio)

        if not prompt:
            return error_response(
                error="Prompt is required",
                error_type="invalid_input",
                provider=self.name,
                prompt="",
                aspect_ratio=aspect_ratio,
            )

        # Model selection precedence: env var → config → default. The helper
        # _resolve_model() in the built-in openai plugin is a good reference.
        model_id = kwargs.get("model") or self.default_model() or "my-model-fast"

        try:
            import my_backend_sdk
            client = my_backend_sdk.Client(api_key=os.environ["MY_BACKEND_API_KEY"])
            result = client.generate(
                prompt=prompt,
                model=model_id,
                aspect_ratio=aspect_ratio,
            )

            # Two shapes supported:
            #   - URL string: return it as `image`
            #   - base64 data: save under $HERMES_HOME/cache/images/ via save_b64_image()
            if result.get("image_b64"):
                path = save_b64_image(
                    result["image_b64"],
                    prefix=self.name,
                    extension="png",
                )
                image = str(path)
            else:
                image = result["image_url"]

            return success_response(
                image=image,
                model=model_id,
                prompt=prompt,
                aspect_ratio=aspect_ratio,
                provider=self.name,
            )
        except Exception as exc:
            return error_response(
                error=str(exc),
                error_type=type(exc).__name__,
                provider=self.name,
                model=model_id,
                prompt=prompt,
                aspect_ratio=aspect_ratio,
            )


def register(ctx) -> None:
    """Plugin entry point — called once at load time."""
    ctx.register_image_gen_provider(MyBackendImageGenProvider())

plugin.yaml

name: my-backend
version: 1.0.0
description: My image backend — text-to-image via My Backend SDK
author: Your Name
kind: backend
requires_env:
  - MY_BACKEND_API_KEY

kind: backend 是将插件路由到图像生成注册路径的关键。requires_env 会在执行 hermes plugins install 时提示用户配置。

ABC 参考

完整契约位于 agent/image_gen_provider.py。你通常会被重写的方法如下：

成员	必需	默认值	用途
name	✅	—	在 image_gen.provider 配置中使用的稳定 ID
display_name	—	name.title()	在 hermes tools 中显示的标签
is_available()	—	True	用于检查缺失凭据/依赖项的门控
list_models()	—	[]	供 hermes tools 模型选择器使用的目录
default_model()	—	list_models() 中的第一个	未配置模型时的回退选项
get_setup_schema()	—	最小化	选择器元数据 + 环境变量提示
generate(prompt, aspect_ratio, **kwargs)	✅	—	实际调用

响应格式

generate() 必须返回通过 success_response() 或 error_response() 构建的字典。两者均位于 agent/image_gen_provider.py 中。

成功：

success_response(
    image=<url-or-absolute-path>,
    model=<model-id>,
    prompt=<echoed-prompt>,
    aspect_ratio="landscape" | "square" | "portrait",
    provider=<your-provider-name>,
    extra={...},  # optional backend-specific fields
)

错误：

error_response(
    error="human-readable message",
    error_type="provider_error" | "invalid_input" | "<exception class name>",
    provider=<your-provider-name>,
    model=<model-id>,
    prompt=<prompt>,
    aspect_ratio=<resolved aspect>,
)

工具包装器将该字典序列化为 JSON 并交给 LLM。错误会作为工具结果呈现；LLM 决定如何向用户解释这些错误。

处理 base64 与 URL 输出

某些后端返回图像 URL（如 fal、Replicate）；其他后端返回 base64 负载（如 OpenAI gpt-image-2）。对于 base64 情况，请使用 save_b64_image()——它将文件写入 $HERMES_HOME/cache/images/<prefix>_<timestamp>_<uuid>.<ext> 并返回绝对 Path。在 success_response() 中将该路径（作为 str）作为 image= 参数传递。网关交付（Telegram 照片气泡、Discord 附件）既能识别 URL 也能识别绝对路径。

用户覆盖

在 ~/.hermes/plugins/image_gen/<name>/ 中放置一个用户插件，其 name 属性与某个捆绑插件相同，并通过 hermes plugins enable <name> 启用它——注册表采用“最后写入者胜出”原则，因此你的版本将替换内置版本。这对于将 openai 插件指向私有代理，或换入自定义模型目录非常有用。

测试

export HERMES_HOME=/tmp/hermes-imggen-test
mkdir -p $HERMES_HOME/plugins/image_gen/my-backend
# …copy __init__.py + plugin.yaml into that dir…

export MY_BACKEND_API_KEY=your-test-key
hermes plugins enable my-backend

# Pick it as the active provider
echo "image_gen:" >> $HERMES_HOME/config.yaml
echo "  provider: my-backend" >> $HERMES_HOME/config.yaml

# Exercise it
hermes -z "Generate an image of a corgi in a spacesuit"

或者交互式测试：hermes tools → “Image Generation” → 选择 my-backend → 如果提示则输入 API 密钥。

参考实现

• plugins/image_gen/openai/__init__.py — 将 gpt-image-2 分为低/中/高三个层级，作为共享同一 API 模型但具有不同 quality 参数的三个虚拟模型 ID。这是在单一后端下分层模型以及 config.yaml 优先级链的良好示例。
• plugins/image_gen/xai/__init__.py — 通过 xAI 使用 Grok Imagine。形态不同（URL 输出，更简单的目录）。
• plugins/image_gen/openai-codex/__init__.py — Codex 风格的 Responses API 变体，复用 OpenAI SDK 但使用不同的路由基础 URL。

通过 pip 分发

# pyproject.toml
[project.entry-points."hermes_agent.plugins"]
my-backend-imggen = "my_backend_imggen_package"

my_backend_imggen_package 必须暴露一个顶层的 register 函数。完整设置请参阅通用插件指南中的 通过 pip 分发。

相关页面

• 图像生成 — 面向用户的功能文档
• 插件概览 — 一览所有插件类型
• 构建 Hermes 插件 — 通用工具/钩子/斜杠命令指南