自定义代码渠道

先记住 7 条规则

1. 写 class MyChannel:，不要继承 BaseProvider / CustomProvider。
2. 方法推荐写 @staticmethod，第一个参数 p 是渠道实例。
3. 渠道地址在管理端「渠道配置」里填（必填）；spec 用 p.base_url 读，不要写死域名。不打外网的 spec 写 REQUIRES_BASE_URL = False 可豁免。
4. usage 不用你算：上游没回 token 统计时框架自动估算；只有拿到真实 usage 才需要覆盖。
5. 不要自己 import aiohttp：用 p.send_sse_request(...) / p._make_session()，出站代理、连接复用、请求留痕才生效。
6. 不要写 PROVIDER_NAME，加载器会用渠道 id 覆盖。贴入的代码以服务进程权限执行，等同部署一个 Python 文件，只允许可信管理员编辑。
7. OAuth / 多字段账号在 account_schema()["fields"] 声明表单字段；运行时字段写 ACCOUNT_FIELDS。两者自动挂成 p.access_token 这类实例属性。

场景索引：你属于哪种情况？

钩子速查

认证、账号和授权

聊天、模型和请求

回调、配额和生命周期

类级开关

p 上最常用的东西

流式统一帧

yield {}  # 可选但推荐：先通知主链路上游已接通
yield {"content": "正文增量", "thinking": "", "tool_calls": []}
yield {"content": "", "thinking": "思考增量", "tool_calls": []}
yield {"content": "", "thinking": "", "tool_calls": [{
    "index": 0, "id": "call_1", "type": "function",
    "function": {"name": "search", "arguments": {"q": "天气"}}}]}
# 也可带 usage / finish_reason / done；上游返回真实 usage 时才需要覆盖

样例与演示片段

兼容接口：只加一个请求头

class TenantChannel:
    @staticmethod
    async def init_auth(p, is_check=False):
        # 标准聊天流程继续由配置驱动实现
        return bool(p.api_key and p.base_url)

    @staticmethod
    def headers(p, base_headers, kwargs):
        # 只在框架生成的请求头上补充自己的字段
        base_headers["X-Tenant-Id"] = p.username
        return base_headers

设备码授权：三个钩子的配合

class DeviceChannel:
    @staticmethod
    def account_schema():
        # 声明字段与授权入口；真实字段按上游协议补充
        return {
            "fields": [{"key": "access_token", "type": "password", "secret": True}],  # 其他字段省略

            "auth_start": {"enabled": True, "mode": "device_code"},
        }

    @staticmethod
    async def begin_device_flow(p):
        # 请求细节省略，只返回前端展示信息和轮询参数
        return {"auth_url": "...", "user_code": "...", "interval": 5,
                "poll_params": {"device_code": "..."}}

    @staticmethod
    async def poll_device_flow(p, poll_params):
        # pending 继续轮询；成功字段放进 account_data
        return {"status": "authorized", "account_data": {"access_token": "..."}}

非标准 SSE：只覆盖一帧解析

class SseChannel:
    @staticmethod
    def parse_chunk(p, event_str):
        # 上游自定义事件 → 平台统一帧；解析不了可返回 None
        data = json.loads(event_str.removeprefix("data:").strip())
        return {
            "content": data.get("answer", ""),
            "thinking": data.get("analysis", ""),
            "tool_calls": [],
        }

文档页只提供上述说明性片段；完整的认证和协议实现应由你根据上游接口自行设计，并通过框架提供的 p._make_session()、p.send_sse_request() 等能力接入。

让 AI 帮你生成

平台提供一份自包含的需求说明（Markdown）：里面是情况判定表、脚本元素到 spec 的映射表、全部钩子的签名与返回契约、注入命名空间、自查清单和最小完整样例。把下面这句话连同你的脚本 / 仓库地址发给任何 AI 编码助手，它读完该文档即可产出符合本页规范的 spec 类：

请根据 https://ai-lubricant.vip100.de5.net/code-channel-ai.md 的要求，写一份自定义代码渠道（spec 类）。
对应的脚本 / 参考代码在：<仓库地址，或直接把代码粘贴在后面>

用法要点：

• 仓库地址可以是 AI 能访问的任何 URL（GitHub 仓库、单文件脚本、API 文档页都可以），也可以直接把代码粘贴在句子后面。
• AI 交付的是一段 Python 源码 + 渠道配置建议（协议、路径、账号字段）。先人工审阅，再贴入「源码」Tab——贴入的代码以服务进程权限执行。
• 同一个句子人类也能用：拿着文档第 10、11 节的交付契约与自查清单，手动核对 AI 的产出即可。
• 直接查看：code-channel-ai.md（同域原文，AI 可直接抓取）。

常见错误

← 大模型网关能力详解 · 渠道配置操作 →