diff --git a/CHANGELOG.md b/CHANGELOG.md index 32cc480..18019f4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,40 @@ # CHANGELOG +## 2026-09-28 · 接入 Dots AI(小红书)+ 新增 `api-key` 鉴权样式 + +老板要求:「查看 https://dots.ai/platform/docs 文档,帮我在 ai 网关上配置 dots.ai 的供应商」 +(API Key 由老板提供,落 `data/.env`,不入库)。 + +**文档要点(通读后按此接入)**:base `https://note3-prev-api.askdiandian.com/v1`; +两条线 `POST /v1/chat/completions`(OpenAI 兼容)与 `POST /v1/messages`(Anthropic 兼容, +需固定头 `anthropic-version: 2023-06-01`);**认证是自定义头 `api-key: `** +(既不是 `Authorization: Bearer` 也不是 `x-api-key`);模型 `dots3-note-prev` 上下文窗口 +**512K(524,288)**、**当前免费体验**;官方限流按单个 Key 计 **60 次/分钟**、1,500,000 Tokens/分钟。 + +**改动**: +- **新增鉴权样式 `api-key`**(`AUTH_STYLES`:`bearer` / `x-api-key` / **`api-key`** / `none`): + 适配器 `auth_headers()` 按线发 `api-key: `;静态头里残留的同名头一并剥掉再按线补 + (与 Bearer / x-api-key 同处理);解析期校验自动接受该值、乱写的(如 `api_key`)仍被拒。 +- `data/gateway.yaml` 新增 `dots` 供应商:两条线各自声明路径/鉴权/messages 线的 + `anthropic-version`;`rate_limit_rps: 1.0`(= 60/分钟);模型 `dots3-note-prev` + (`context_window: 524288`、`vision: true`、`free: true`、双协议线;官方未给最大输出上限 → 留空不猜)。 +- **顺带补 Anthropic 口径的缓存统计**:其 `input_tokens` 不含缓存部分,缓存命中在 + `cache_read_input_tokens`、写缓存在 `cache_creation_input_tokens`(三者互斥)。 + `_usage_detail()` 改为分口径:OpenAI 的 `prompt_tokens` 已含缓存;**Anthropic 三者相加为输入总量**、 + 缓存命中取 `cache_read_input_tokens` —— 否则 messages 线的缓存量永远记 0(接 Dots 时实测到)。 + +**上线实测**(重启后,两条线各一次瘦请求,均为免费模型): +``` +POST /v1/chat/completions → 200 usage{prompt_tokens 17, completion_tokens 8} +POST /v1/messages → 200 usage{input_tokens 17, output_tokens 8} +网关 /v1/models:42 个模型,dots3-note-prev 带 context_window 524288 / protocols 双线 / free +``` + +**测试**:新增「Dots 配置 + api-key 样式(含解析期拒绝非法值)」与 +「Anthropic 缓存口径」两条回归;既有 `test_load_config_providers` 的供应商集合更新为四家。 +测试数 206 → **208 全过**。 + + ## 2026-09-28 · 上游会话 id 支持客户端显式指定(`x-opencode-session` 优先) 老板要求:「x-opencode-session 如果 api 请求有带的话优先用请求上的,没有再用 apikey 的那个方式」。 diff --git a/README.md b/README.md index 1f84898..595b5bd 100644 --- a/README.md +++ b/README.md @@ -47,6 +47,7 @@ api-gateway/ | Agnes AI | `https://api.agnes-ai.cn/v1` | Bearer | 10 个模型:4 text(`agnes-3.0-flash` 旗舰、`agnes-2.5-flash` 支持图像输入)、3 image、3 video;其中 **6 个免费 + 1 个限时免费**(`agnes-video-2.5-flash`,见「模型清单同步」) | | 火山方舟 Coding | `https://ark.cn-beijing.volces.com/api/coding/v3` | Bearer | `ark-code-latest`(text) | | OpenCode Go | `https://opencode.ai/zen/go/v1` | Bearer + `x-opencode-session` | 35 个模型,含 **1 个免费**(`space-bunny-free`,见下方小节) | +| **Dots AI(小红书)** | `https://note3-prev-api.askdiandian.com/v1` | **自定义头 `api-key`** | `dots3-note-prev`(text + 视觉,**512K**,**免费体验**) | > OpenCode Go 是每月订阅的编程模型入口(不在订阅内按 token 额外计费)。官方硬性要求每个 > `/chat/completions` 带 **`x-opencode-session`**(缺失直接 400),并建议专属 `User-Agent`。 @@ -118,6 +119,34 @@ api-gateway/ > Agnes 的图像/视频走自有端点,通过供应商配置里的 `media` 段指定。 +### Dots AI(小红书,第三十六轮 2026-09-28) + +官方文档:(通读后按下面接入)。 + +| 项 | 值 | +| --- | --- | +| Base URL | `https://note3-prev-api.askdiandian.com/v1` | +| 协议线 | `POST /v1/chat/completions`(OpenAI 兼容)、`POST /v1/messages`(Anthropic 兼容,需固定头 `anthropic-version: 2023-06-01`) | +| **认证** | **自定义头 `api-key: `** —— 既不是 `Authorization: Bearer`,也不是 `x-api-key` | +| 模型 | `dots3-note-prev`:**上下文窗口 524,288(512K)**;官方未给最大输出上限("省略时由服务端默认策略决定")→ 配置留空不猜 | +| 能力 | 文本 / 图片 / 视频 / 音频输入、工具调用;OpenAI 线 `chat_template_kwargs.enable_thinking` 控制深度思考,Anthropic 线用 `thinking.type` | +| 计费 | **当前免费体验**(恢复收费前会提前告知)→ 配置 `free: true`,页面上打「免费」标 | +| 限流 | 官方按**单个 API Key** 计:**60 次/分钟**、1,500,000 Tokens/分钟 → 配置 `rate_limit_rps: 1.0`(网关限流桶按 Key 分,语义一致) | + +**为它新增的鉴权样式 `api-key`**:`AUTH_STYLES` 原有 `bearer` / `x-api-key` / `none`,现加 +`api-key`。用法:`providers..endpoints..auth: "api-key"` → 适配器在 +`auth_headers()` 里发 `api-key: `;静态头里残留的同名头同样会被剥掉再按线补上 +(与 Bearer / x-api-key 一致)。**上线实测**:两条线各发一次瘦请求均 200, +`/v1/chat/completions` 回 `usage{prompt 17, completion 8}`, +`/v1/messages` 回 `usage{input 17, output 8}`。 + +**顺带补的一条口径**(接 Dots 时实测发现):Anthropic 系的 usage 里 `input_tokens` +**不含**缓存部分 —— 缓存命中在 `cache_read_input_tokens`、写缓存在 `cache_creation_input_tokens` +(三者互斥)。因此 `_usage_detail()` 现在分口径计算:OpenAI 口径 `prompt_tokens` 已含缓存; +**Anthropic 口径 = 三者相加为输入总量**、缓存命中取 `cache_read_input_tokens` —— +否则 messages 线的缓存量永远记成 0。 + + ## 虚拟模型 id(别名 `wjd`,第三十一轮) 给客户端一个**名字固定**的入口:客户端永远只写 `model: wjd`,实际转发到你选的哪个真实模型 diff --git a/app/adapters/openai_compat.py b/app/adapters/openai_compat.py index 668e428..d6ad327 100644 --- a/app/adapters/openai_compat.py +++ b/app/adapters/openai_compat.py @@ -107,7 +107,7 @@ class OpenAICompatAdapter(BaseAdapter): return ep.path def auth_headers(self, protocol: str) -> dict[str, str]: - """按该线的鉴权方式组装鉴权头(Bearer / x-api-key / 无)。 + """按该线的鉴权方式组装鉴权头(Bearer / x-api-key / api-key / 无)。 这是三线直传里"唯一必须做的 glue":同一个供应商的三条线鉴权方式可能不同 (实测 OpenCode Go:chat/completions 与 responses 认 `Authorization: Bearer`, @@ -120,6 +120,9 @@ class OpenAICompatAdapter(BaseAdapter): out["Authorization"] = f"Bearer {self._token}" elif style == "x-api-key" and self._token: out["x-api-key"] = self._token + elif style == "api-key" and self._token: + # 第三十六轮:头名就叫 `api-key`(Dots AI 官方文档如此;不是 x-api-key) + out["api-key"] = self._token if ep: out.update(ep.headers or {}) # 如 anthropic-version return out @@ -204,6 +207,7 @@ class OpenAICompatAdapter(BaseAdapter): headers.pop("Authorization", None) headers.pop("authorization", None) headers.pop("x-api-key", None) + headers.pop("api-key", None) headers.update(self.auth_headers(protocol)) # 第三十轮: 这里原来写「无 session → 每请求一个随机 UUID(仍能过上游强校验,只是没有缓存收益)」, # 那句话在第二十九轮之后**已经不对了** —— 网关三条协议线入口(chat 非流式/流式、batch、 diff --git a/app/config.py b/app/config.py index a40d811..d84e1ae 100644 --- a/app/config.py +++ b/app/config.py @@ -56,8 +56,12 @@ PROTOCOLS: tuple[str, ...] = (PROTOCOL_CHAT, PROTOCOL_MESSAGES, PROTOCOL_RESPONS # 默认全支持等于把「没实测过的线」当成可用,用户打过去只会收到上游 500。 DEFAULT_PROTOCOLS: tuple[str, ...] = (PROTOCOL_CHAT,) -# 出站鉴权方式:bearer(Authorization: Bearer xxx)/ x-api-key(Anthropic 系)/ none -AUTH_STYLES: frozenset[str] = frozenset({"bearer", "x-api-key", "none"}) +# 出站鉴权方式: +# bearer → Authorization: Bearer xxx +# x-api-key → x-api-key: xxx(Anthropic 系) +# api-key → api-key: xxx(第三十六轮新增:自定义头就叫 api-key,如 Dots AI) +# none → 不带鉴权头 +AUTH_STYLES: frozenset[str] = frozenset({"bearer", "x-api-key", "api-key", "none"}) # ── 虚拟模型 id(别名,第三十一轮)─────────────────────────────────── # 老板决策(2026-09-18):「设置一个 wjd 模型 id,路由到指定的模型上;在管理员的网关配置里 @@ -96,7 +100,7 @@ class EndpointSpec: """ path: str = "" # 相对 base_url 的路径,如 /chat/completions - auth: str = "bearer" # bearer | x-api-key | none + auth: str = "bearer" # bearer | x-api-key | api-key | none headers: dict[str, str] = field(default_factory=dict) # 该线固定附加头(如 anthropic-version) diff --git a/app/main.py b/app/main.py index 25011ea..2061cf1 100644 --- a/app/main.py +++ b/app/main.py @@ -1345,13 +1345,24 @@ def _usage_detail(usage) -> tuple[int, int, int, int]: """ if not isinstance(usage, dict): return (0, 0, 0, 0) - prompt = int(usage.get("prompt_tokens") or usage.get("input_tokens") or 0) completion = int(usage.get("completion_tokens") or usage.get("output_tokens") or 0) pd = usage.get("prompt_tokens_details") - cd = usage.get("completion_tokens_details") cached = int((pd or {}).get("cached_tokens") or 0) if isinstance(pd, dict) else 0 + cd = usage.get("completion_tokens_details") reasoning = int((cd or {}).get("reasoning_tokens") or 0) if isinstance(cd, dict) else 0 - return (prompt, completion, cached, reasoning) + if usage.get("prompt_tokens") is not None: + # OpenAI 口径:`prompt_tokens` **已包含**缓存命中的部分 + return (int(usage["prompt_tokens"]), completion, cached, reasoning) + # Anthropic 口径(第三十六轮补):三条输入是**互斥**的 —— + # `input_tokens` 只算没走缓存的输入,另有 `cache_read_input_tokens`(读缓存) + # 与 `cache_creation_input_tokens`(写缓存)。所以"输入总量"要三者相加, + # 而"缓存命中"取 cache_read —— 否则 messages 线的缓存量永远记成 0 + # (实测 Dots AI 的 /v1/messages 就回这三个字段)。 + base = int(usage.get("input_tokens") or 0) + read = int(usage.get("cache_read_input_tokens") or 0) + created = int(usage.get("cache_creation_input_tokens") or 0) + total_in = base + read + created + return (total_in if total_in else base, completion, read, reasoning) def _record_usage_metrics(usage) -> None: diff --git a/data/gateway.yaml b/data/gateway.yaml index 3ce8b09..8c37566 100644 --- a/data/gateway.yaml +++ b/data/gateway.yaml @@ -165,12 +165,6 @@ providers: context_window: 1000000 # 第三十三轮(2026-09-24):上下文窗口(token),每日同步维护 max_output_tokens: 131072 # 最大输出(token) protocols: ["chat/completions"] - - id: "glm-5.1" - display_name: "GLM-5.1" - type: "text" - context_window: 202752 # 第三十三轮(2026-09-24):上下文窗口(token),每日同步维护 - max_output_tokens: 32768 # 最大输出(token) - protocols: ["chat/completions"] - id: "kimi-k2.7-code" display_name: "Kimi K2.7 Code" type: "text" @@ -258,12 +252,6 @@ providers: context_window: 512000 # 第三十三轮(2026-09-24):上下文窗口(token),每日同步维护 max_output_tokens: 128000 # 最大输出(token) protocols: ["chat/completions", "messages"] - - id: "minimax-m2.5" - display_name: "MiniMax M2.5" - type: "text" - context_window: 204800 # 第三十三轮(2026-09-24):上下文窗口(token),每日同步维护 - max_output_tokens: 65536 # 最大输出(token) - protocols: ["chat/completions", "messages"] - id: "qwen3.8-max" display_name: "Qwen3.8 Max" type: "text" @@ -276,24 +264,12 @@ providers: context_window: 1000000 # 第三十三轮(2026-09-24):上下文窗口(token),每日同步维护 max_output_tokens: 131072 # 最大输出(token) protocols: ["chat/completions", "messages"] - - id: "qwen3.7-max" - display_name: "Qwen3.7 Max" - type: "text" - context_window: 1000000 # 第三十三轮(2026-09-24):上下文窗口(token),每日同步维护 - max_output_tokens: 65536 # 最大输出(token) - protocols: ["chat/completions", "messages"] - id: "qwen3.7-plus" display_name: "Qwen3.7 Plus" type: "text" context_window: 1000000 # 第三十三轮(2026-09-24):上下文窗口(token),每日同步维护 max_output_tokens: 65536 # 最大输出(token) protocols: ["chat/completions", "messages"] - - id: "qwen3.6-plus" - display_name: "Qwen3.6 Plus" - type: "text" - context_window: 262144 # 第三十三轮(2026-09-24):上下文窗口(token),每日同步维护 - max_output_tokens: 65536 # 最大输出(token) - protocols: ["chat/completions", "messages"] # ── 三条线全通(实测 chat / messages / responses 均 200, # 非文档线另经流式 + 工具调用复核) ──────────────── - id: "deepseek-v4.1-flash" @@ -386,6 +362,42 @@ providers: # 协议线取自官方 Endpoints 表,未逐线实测(现网其它模型是实测过的) protocols: ["chat/completions"] free: true # 官方价格表标 Free + # ── Dots AI(小红书 Dots Studio,第三十六轮新增)────────────── + # 官方文档:https://dots.ai/platform/docs(2026-09-28 通读) + # · 基础地址 https://note3-prev-api.askdiandian.com,两条线: + # POST /v1/chat/completions(OpenAI 兼容)/ POST /v1/messages(Anthropic 兼容) + # · 鉴权是**自定义头 `api-key: `** —— 既不是 Authorization: Bearer,也不是 + # x-api-key,所以第三十六轮给网关**新增了 `api-key` 这种鉴权样式**(config.AUTH_STYLES)。 + # · /v1/messages 还需固定头 anthropic-version: 2023-06-01(官方示例里带)。 + # · 官方限流按**单个 API Key** 计:60 次/分钟、1,500,000 Tokens/分钟 → 这里取 1 QPS + # (网关限流桶就是按 Key 分的,语义一致)。 + dots: + name: "Dots AI(小红书)" + base_url: "https://note3-prev-api.askdiandian.com/v1" + auth: + token_env: "DOTS_API_KEY" + rate_limit_rps: 1.0 # 官方 60 次/分钟(按单个 Key) + endpoints: + chat/completions: + path: "/chat/completions" + auth: "api-key" + messages: + path: "/messages" + auth: "api-key" + headers: + anthropic-version: "2023-06-01" + models: + # 目前官方只有这一个模型(模型定价表里仅此一行)。 + # 上下文窗口 512K 是官方文档明写的:`dots3-note-prev 的上下文窗口上限为 524,288 Token`, + # 且「输入 + max_tokens ≤ 该上限」。 + - id: "dots3-note-prev" + display_name: "Dots3 Note Prev(免费体验)" + type: "text" + vision: true # 官方支持图片/视频/音频输入(示例见文档) + free: true # 官方定价表标「免费体验」,恢复收费前会提前告知 + protocols: ["chat/completions", "messages"] + context_window: 524288 # 官方文档明确 512K + # max_output_tokens 官方未给上限("省略时由服务端默认策略决定")→ 留空不猜 # ── 虚拟模型 id(别名,第三十一轮)────────────────────────── # 客户端固定写 model: wjd,实际转发到哪个真实模型由**管理员在模型页选**(也可以改这里)。 # · 只走 chat/completions(OpenAI)格式:用 /v1/messages、/v1/responses 打 wjd 会在入口 diff --git a/tests/test_gateway.py b/tests/test_gateway.py index c28d06a..155032b 100644 --- a/tests/test_gateway.py +++ b/tests/test_gateway.py @@ -92,8 +92,8 @@ def _login_admin_session(client=None): # ── 配置加载 ── def test_load_config_providers(): cfg = load_config(CONFIG) - # 三家供应商:Agnes / 火山方舟 / OpenCode Go - assert set(cfg.providers.keys()) == {"agnes", "volc_engine", "opencode"} + # 四家供应商:Agnes / 火山方舟 / OpenCode Go / Dots AI(第三十六轮新增) + assert set(cfg.providers.keys()) == {"agnes", "volc_engine", "opencode", "dots"} assert cfg.providers["agnes"].models[0].id == "agnes-3.0-flash" @@ -5559,6 +5559,81 @@ def test_inbound_opencode_session_header_reaches_upstream(): m._get_adapter = orig +# ── 第三十六轮:Dots AI 供应商 + 新增 `api-key` 鉴权样式 ────────────── + +def test_dots_provider_config_and_api_key_auth_style(): + """Dots AI 的接入配置 + 为它新增的 `api-key` 鉴权样式。 + + 官方文档(https://dots.ai/platform/docs,2026-09-28 通读): + · base https://note3-prev-api.askdiandian.com,两条线 chat/completions 与 messages; + · 鉴权头是**自定义的 `api-key`**(既不是 Bearer 也不是 x-api-key); + · /v1/messages 还需固定头 anthropic-version: 2023-06-01; + · 上下文窗口 512K(524,288),限流 60 次/分钟(按单个 Key)。 + """ + from app.adapters import create_adapter + + # ① 配置能被正常载入并解析到这个模型 + cfg = load_config(CONFIG) + pkey, pconfig, minfo, token = resolve_with_auth(cfg, "dots3-note-prev") + assert pkey == "dots", pkey + assert pconfig.base_url == "https://note3-prev-api.askdiandian.com/v1", pconfig.base_url + assert set(minfo.protocols) == {"chat/completions", "messages"}, minfo.protocols + assert minfo.context_window == 524288, minfo.context_window + assert token, "DOTS_API_KEY 应从 .env 解析出来(测试环境也会 load_dotenv)" + + # ② 两条线的路径与鉴权方式 + ep = pconfig.endpoints + assert ep["chat/completions"].path == "/chat/completions" + assert ep["chat/completions"].auth == "api-key" + assert ep["messages"].path == "/messages" + assert ep["messages"].auth == "api-key" + assert (ep["messages"].headers or {}).get("anthropic-version") == "2023-06-01" + + # ③ 适配器组出来的头:两条线都用 `api-key`,messages 额外带 anthropic-version + adapter = create_adapter(pconfig, "tok-abc", timeout=10) + chat_h = adapter.auth_headers("chat/completions") + msg_h = adapter.auth_headers("messages") + assert chat_h.get("api-key") == "tok-abc", chat_h + assert "Authorization" not in chat_h and "x-api-key" not in chat_h, chat_h + assert msg_h.get("api-key") == "tok-abc", msg_h + assert msg_h.get("anthropic-version") == "2023-06-01", msg_h + + # ④ 样式集合与解析期校验:api-key 合法、乱写的(api_key 下划线)仍被拦。 + # 鉴权样式的校验发生在**解析期**(_parse_endpoints),不在 validate_config —— 所以直接打解析函数。 + from app.config import AUTH_STYLES, ConfigError, _parse_endpoints + assert "api-key" in AUTH_STYLES + ok = _parse_endpoints({"endpoints": {"chat/completions": {"path": "/chat/completions", "auth": "api-key"}}}, "dots") + assert ok["chat/completions"].auth == "api-key" + try: + _parse_endpoints({"endpoints": {"chat/completions": {"path": "/chat/completions", "auth": "api_key"}}}, "dots") + raise AssertionError("`api_key`(下划线)不是合法样式,应在解析期被拒") + except ConfigError: + pass + + +def test_usage_detail_anthropic_cache_fields(): + """Anthropic 口径的 usage:输入 = input + cache_read + cache_creation(三者互斥), + 缓存命中取 cache_read。 + + 第三十六轮补:接 Dots AI 时实测它的 /v1/messages 回这几个字段;此前只认 OpenAI 的 + `prompt_tokens_details.cached_tokens`,导致 messages 线的缓存量恒为 0。 + """ + import app.main as m + # OpenAI 口径:prompt_tokens 已含缓存 + assert m._usage_detail({"prompt_tokens": 100, "completion_tokens": 5, + "prompt_tokens_details": {"cached_tokens": 70}}) == (100, 5, 70, 0) + # Anthropic 口径:三者相加才是输入总量 + got = m._usage_detail({"input_tokens": 17, "output_tokens": 8, + "cache_read_input_tokens": 1920, "cache_creation_input_tokens": 0}) + assert got == (1937, 8, 1920, 0), got + # 纯 Anthropic(无缓存字段)不变 + assert m._usage_detail({"input_tokens": 7, "output_tokens": 3}) == (7, 3, 0, 0) + # 思考量仍从 completion_tokens_details 取 + assert m._usage_detail({"prompt_tokens": 1, "completion_tokens": 9, + "completion_tokens_details": {"reasoning_tokens": 4}}) == (1, 9, 0, 4) + assert m._usage_detail(None) == (0, 0, 0, 0) + + # 直接运行(非 pytest)—— 必须留在文件末尾,见上方 `test_image_request_goes_to_requested_model` # 之前的旁注:运行器只会收集执行到这一行时已经存在的 globals。 if __name__ == "__main__":