Compare commits
38 Commits
afd6101c08
...
v1.0.4
| Author | SHA1 | Date | |
|---|---|---|---|
| 486809b08b | |||
| 58cb55b869 | |||
| 86fb4d5536 | |||
| 32d7869043 | |||
| 966d548245 | |||
| c2fcd5b1f8 | |||
| 0ed9dc107c | |||
| c4eda119ac | |||
| cd1a9520ff | |||
| 0aa7202c87 | |||
| 4841d901af | |||
| 30d7ffd94a | |||
| 037e7a011e | |||
| 0e2f734b0b | |||
| 7ccb25e8f1 | |||
| 42d16919fc | |||
| 005a90ca19 | |||
| 8a824e2000 | |||
| 8495cea5dc | |||
| abca723d3d | |||
| 63b85508c7 | |||
| 4e06d5e801 | |||
| 4e5a91d802 | |||
| 9e2d8ee43c | |||
| d1520cc0a5 | |||
| ab496bb298 | |||
| cd8bebba00 | |||
| 195454d2e3 | |||
| 42e429eb58 | |||
| 76e7d9594c | |||
| d8e8fd8124 | |||
| e5dbcf5d33 | |||
| 61231f7f6e | |||
| 4534444ad8 | |||
| 9a8f5cea5a | |||
| 637ac51754 | |||
| ac7c86fdee | |||
| fd7d9d330b |
+4
-2
@@ -8,11 +8,11 @@ LLM__QWEN__1__BASE_URL=
|
|||||||
LLM__QWEN__1__API_KEY=
|
LLM__QWEN__1__API_KEY=
|
||||||
LLM__QWEN__1__MODEL=
|
LLM__QWEN__1__MODEL=
|
||||||
LLM__QWEN__1__TIMEOUT_S=120
|
LLM__QWEN__1__TIMEOUT_S=120
|
||||||
# 可选(0 = 该闸不启用;TPM > 0 时 EST_TOKENS 必填 > 0):
|
# 可选(0 = 该闸不启用):
|
||||||
# LLM__QWEN__1__MAX_CONCURRENCY=8
|
# LLM__QWEN__1__MAX_CONCURRENCY=8
|
||||||
# LLM__QWEN__1__RPM=60
|
# LLM__QWEN__1__RPM=60
|
||||||
# LLM__QWEN__1__TPM=100000
|
# LLM__QWEN__1__TPM=100000
|
||||||
# LLM__QWEN__1__EST_TOKENS=2000
|
# LLM__QWEN__1__EST_TOKENS=2000 # 可选调优覆盖: TPM 入场预扣量;未填则库按 tpm//60 派生
|
||||||
# LLM__QWEN__1__TTFT_TIMEOUT_S=30 # 须与 INTER_TOKEN 成对;0 < inter < ttft < timeout
|
# LLM__QWEN__1__TTFT_TIMEOUT_S=30 # 须与 INTER_TOKEN 成对;0 < inter < ttft < timeout
|
||||||
# LLM__QWEN__1__INTER_TOKEN_TIMEOUT_S=15
|
# LLM__QWEN__1__INTER_TOKEN_TIMEOUT_S=15
|
||||||
# LLM__QWEN__1__ENABLE_THINKING=true # 三态: 缺省=不注入 / true=注入开启 / false=注入关闭
|
# LLM__QWEN__1__ENABLE_THINKING=true # 三态: 缺省=不注入 / true=注入开启 / false=注入关闭
|
||||||
@@ -54,6 +54,8 @@ PGW_TELEMETRY_BACKEND=none # sqlite | postgres | none(必填)
|
|||||||
# PGW_TELEMETRY_SQLITE_PATH=logs/telemetry.db # sqlite 时必填
|
# PGW_TELEMETRY_SQLITE_PATH=logs/telemetry.db # sqlite 时必填
|
||||||
# PGW_TELEMETRY_PG_DSN=postgresql://user:pass@host:5432/polygateway # postgres 时必填;严禁指向在用业务库(实验室约定: 专用库 polygateway)
|
# PGW_TELEMETRY_PG_DSN=postgresql://user:pass@host:5432/polygateway # postgres 时必填;严禁指向在用业务库(实验室约定: 专用库 polygateway)
|
||||||
# PGW_PRICING_PATH=config/prices.json # 可选: {"<model>": {"input_per_1m": x, "output_per_1m": y}};缺省 cost 恒 None
|
# PGW_PRICING_PATH=config/prices.json # 可选: {"<model>": {"input_per_1m": x, "output_per_1m": y}};缺省 cost 恒 None
|
||||||
|
# # 可选第三档 "cached_input_per_1m": z —— 供应商 prompt cache 命中部分的单价;
|
||||||
|
# # 不填即命中部分也按 input 全额计(库不猜折扣率),cost 会偏高
|
||||||
# PGW_CACHE_NAMESPACE=<项目名或租户前缀> # 缓存启用时必填(防跨项目毒化)
|
# PGW_CACHE_NAMESPACE=<项目名或租户前缀> # 缓存启用时必填(防跨项目毒化)
|
||||||
# PGW_CACHE_TTL_S=604800 # 缓存启用时必填,须 > 0
|
# PGW_CACHE_TTL_S=604800 # 缓存启用时必填,须 > 0
|
||||||
# PGW_STRUCTURED_MAX_RETRIES=2 # 缺省 2(M2.5);0 = 解析失败不重问(CHS 策略)
|
# PGW_STRUCTURED_MAX_RETRIES=2 # 缺省 2(M2.5);0 = 解析失败不重问(CHS 策略)
|
||||||
|
|||||||
@@ -1,5 +1,33 @@
|
|||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
|
## 1.0.4(2026-07-31)
|
||||||
|
|
||||||
|
响应可观测字段扩展(issue #3)。下游 dissect 要把每次调用落成一行审计记录,其中两列拿不到值:供应商侧 prompt cache 命中了多少 token、这次调用实际跑的是哪个模型版本。前者关系到能否把「缓存命中率差异带来的成本」与「实验条件本身带来的成本」分开,后者关系到实验快照的可复现性。本次把两者暴露到公共类型与遥测表,并让成本换算认识缓存单价。
|
||||||
|
|
||||||
|
### 新增(纯增字段,不破坏任何现有调用方)
|
||||||
|
|
||||||
|
- **`LLMResponse` 新增 `cached_prompt_tokens: int | None` 与 `model_reported: str | None`。** 前者是供应商 prompt cache 命中的输入 token 数(OpenAI 兼容格式的 `usage.prompt_tokens_details.cached_tokens`),后者是 API 响应体里的 `model` 字段(与 `.env` 配的别名可能分叉——供应商把别名指向新权重时,只有它认得出真正跑的那个版本)。两者均带默认值 `None`,逐字段传参的 fake 构造零改动。
|
||||||
|
- **`None` 与 `0` 是两回事,不可混同。** `None` = 该源不上报这个数(下游据此声明「本源不可做缓存成本校正」);`0` = 该源上报了一次真实零命中。网关报文一律不可信:形态异常(负数、字符串、`bool`、`prompt_tokens_details` 非 dict)一律归 `None` 且绝不抛异常——可观测字段缺失不得打断调用。
|
||||||
|
- **遥测表 `llm_calls` 新增 `cached_prompt_tokens` 与 `model_reported` 两列**,`TelemetryRecorder` 端口由 18 字段扩为 20。两个后端在初始化期对**已存在的旧表幂等补列**——`CREATE TABLE IF NOT EXISTS` 不会给旧表加列,不补则每行写入都被逐行 warning 丢弃、遥测静默全失。两侧都是**先探测缺列、只在真缺列时才 ALTER**(SQLite 查 `PRAGMA table_info`,Postgres 查 `pg_attribute`):`ADD COLUMN IF NOT EXISTS` 即使列已存在也会先取 ACCESS EXCLUSIVE 锁,而遥测是内联 await,让每个进程的首次写入都去锁共享审计表会拖垮业务调用;稳态下一条 ALTER 都不会发。**补列失败只降级为逐行丢弃,绝不会让 recorder 整体失能**(应用账号只有 INSERT 权限时,`ALTER TABLE` 的 ownership 检查早于存在性判断,列齐全也会失败)。
|
||||||
|
- **`PricingTable` 支持可选的缓存读取单价 `cached_input_per_1m`。** 配了该档且本次有命中时按 `(prompt - cached) × input + cached × cached_input` 分段计价,消除 cost 的系统性高估;**未配则不猜折扣率**,退化为现状全额输入价(P5 严禁默认值掩盖)。旧价格表文件与 embedding 侧的三参 `cost()` 调用零改动。命中数超过输入总数时按总数夹取并 warning,不产生负成本。
|
||||||
|
|
||||||
|
### 下游请读
|
||||||
|
|
||||||
|
- **`cache_hit` 与新字段是两个不同的东西。** `cache_hit` 指的始终是 **PolyGateway 自身的响应缓存**(未产生网关调用),而 `cached_prompt_tokens` 指的是**供应商服务器**复用了提示词前缀、那部分按更低单价计费——真实调用里天天发生,`cache_hit` 永远看不见它。字段名保持不变(改名会破坏迁移兼容),语义已在 docstring 中消歧。
|
||||||
|
- **统计供应商缓存命中率必须写 `WHERE cache_hit = false`。** 缓存命中行的这两个字段是**原样回放**的历史值(与 `model`、`prompt_tokens` 同一口径:`CacheMW` 只覆写与本次调用相关的时序字段),计入会重复计数。这与 1.0.3 里 `cost` 缺口口径的坑是同一类。
|
||||||
|
- 缓存命中行的 `cost` 仍恒为 `0.0`(未产生新调用),该短路排在任何单价换算之前,不受缓存单价档影响。
|
||||||
|
- 旧格式的缓存条目(缺这两个键)照常可重建为 `None`,不会回源;历史遥测行的新列为 NULL。
|
||||||
|
|
||||||
|
## 1.0.3(2026-07-30)
|
||||||
|
|
||||||
|
`est_tokens` 解耦(issue #2):一个常量此前被派了两份对"保守"定义相反的差事——TPM 入场预扣(押多了只是慢,安全)与 usage 缺失时的用量兜底(按上界记账只会账单虚高)。本次把两者拆开。
|
||||||
|
|
||||||
|
### 行为收紧/变更(下游请读)
|
||||||
|
|
||||||
|
- **`usage_source` 新增第三个值 `unavailable`。** 值域由 `measured`/`estimated` 两态变三态:`unavailable` 表示用量信息不可得(usage 帧缺失、失败尝试、终态失败),`estimated` 收窄为"有实测数字但可信度降级"(只剩打捞路径这一个生产者:收到 usage 帧但流被截断)。历史库里既有的 `estimated` 行语义不变、读兼容;按 `usage_source` 分支的下游代码需要认识新值。OCR 成功行**不受影响**,仍是 `measured`(0 token 是事实而非未知)。
|
||||||
|
- **用量不可得的行,`cost` 由数值变 NULL。** 此前 usage 帧缺失时库拿 `est_tokens`(按定义是最坏情形上界)当实测值,又整块塞进 `completion_tokens` 换算——输出单价通常是输入的数倍,实测双重高估约 26 倍;`est_tokens=0` 时则算出 `0.0`,让"免费"与"未知"在数据上不可区分。现在这类行如实记 `0/0` + `unavailable` + `cost=NULL`。`SUM(cost)` 天然跳过 NULL,账目缺口用 `WHERE usage_source = 'unavailable' AND cache_hit = false` 量化(**`cache_hit` 限定不可省**:缓存命中行未产生新调用,cost 仍是事实上的 `0.0`,本无缺口)。成本汇总若此前依赖"cost 非空"的隐含假设,请复核。
|
||||||
|
- **`est_tokens` 由必填降为可选调优覆盖。** 装配校验 `tpm > 0 ⇒ est_tokens > 0` 已删除——它把供应商配额(运维能从配额页抄到)与库的实现细节(预扣量,无人能正确取值)绑死。未填时库按 `max(1, tpm // 60)` 派生("一次调用约占一秒钟的配额份额",尺度无关:任何配额规模都收敛到约 60 个在途)。字段与 `{SCOPE}__{PROVIDER}__{N}__EST_TOKENS` 环境键**保留不删不改名**,显式填值仍然优先。此前为绕开该校验而把 `tpm` 限死为 0 的调用方,现可填真实 TPM。
|
||||||
|
|
||||||
## 1.0.2(2026-07-30)
|
## 1.0.2(2026-07-30)
|
||||||
|
|
||||||
1.0.1 的续作:那一版把三条跨字段守卫收进构造期后,独立验证发现 `from_env` 上还留着同一类的 15 条校验与 4 条规范化,一并收拢。
|
1.0.1 的续作:那一版把三条跨字段守卫收进构造期后,独立验证发现 `from_env` 上还留着同一类的 15 条校验与 4 条规范化,一并收拢。
|
||||||
|
|||||||
@@ -0,0 +1,6 @@
|
|||||||
|
{
|
||||||
|
"MiniMax-M3": {
|
||||||
|
"input_per_1m": 2.1,
|
||||||
|
"output_per_1m": 8.4
|
||||||
|
}
|
||||||
|
}
|
||||||
+1
-1
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
|
|||||||
|
|
||||||
[project]
|
[project]
|
||||||
name = "polygateway"
|
name = "polygateway"
|
||||||
version = "1.0.2"
|
version = "1.0.4"
|
||||||
description = "PolyGateway:实验室统一的大语言模型(LLM/VLM/OCR)调度与中转库——多源、限流、重试、熔断、缓存、遥测"
|
description = "PolyGateway:实验室统一的大语言模型(LLM/VLM/OCR)调度与中转库——多源、限流、重试、熔断、缓存、遥测"
|
||||||
requires-python = ">=3.11"
|
requires-python = ">=3.11"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
|
|||||||
@@ -302,7 +302,7 @@ flowchart TB
|
|||||||
### 4.4 一次调用的生命周期(walkthrough)
|
### 4.4 一次调用的生命周期(walkthrough)
|
||||||
|
|
||||||
1. **缓存命中**: TelemetryMW 记录(cache_hit=True, latency_ms=0)→ CacheMW 返回,不触达任何更内层。
|
1. **缓存命中**: TelemetryMW 记录(cache_hit=True, latency_ms=0)→ CacheMW 返回,不触达任何更内层。
|
||||||
2. **正常路径**: RetryMW 开始第一次尝试 → selector 选源(跳过冷却中的源)→ 该源熔断门(闭路)→ 限流 acquire permit(全局+该源,并发/RPM/TPM 三闸,token 按 `est_tokens` 预扣)→ transport 发请求、流式解析(看门狗包裹)、收 usage 帧 → permit 按实际 usage settle(多退少补)→ 回程写缓存 → 遥测记成功(含 ttft/max_inter_token/成本)。
|
2. **正常路径**: RetryMW 开始第一次尝试 → selector 选源(跳过冷却中的源)→ 该源熔断门(闭路)→ 限流 acquire permit(全局+该源,并发/RPM/TPM 三闸,token 按**有效预扣量** `SourceConfig.effective_est_tokens()` 预扣,取值规则见 §7.7)→ transport 发请求、流式解析(看门狗包裹)、收 usage 帧 → permit 按实际 usage settle(多退少补)→ 回程写缓存 → 遥测记成功(含 ttft/max_inter_token/成本)。
|
||||||
3. **瞬时错误**(超时/5xx/429/SSE 异常): transport 翻译为 `TransientError` → RetryMW 指数退避+jitter(取 Retry-After 提示与退避的较大值)后换源重试;每次尝试独立 call_id、独立过限流闸、失败即报熔断计数与遥测。
|
3. **瞬时错误**(超时/5xx/429/SSE 异常): transport 翻译为 `TransientError` → RetryMW 指数退避+jitter(取 Retry-After 提示与退避的较大值)后换源重试;每次尝试独立 call_id、独立过限流闸、失败即报熔断计数与遥测。
|
||||||
4. **源死亡**(401/403/欠费): `SourceDeadError` → 该源熔断 force_open + 本地冷却备忘 → 立即换下一源,不退避等待。
|
4. **源死亡**(401/403/欠费): `SourceDeadError` → 该源熔断 force_open + 本地冷却备忘 → 立即换下一源,不退避等待。
|
||||||
5. **请求被拒**(400/坏输入): `RequestRejectedError` → 不重试不换源,直接上抛;遥测记录。
|
5. **请求被拒**(400/坏输入): `RequestRejectedError` → 不重试不换源,直接上抛;遥测记录。
|
||||||
@@ -322,13 +322,36 @@ flowchart TB
|
|||||||
| `content` | str | 正式输出文本 |
|
| `content` | str | 正式输出文本 |
|
||||||
| `thinking` | str | 思考流内容(reasoning_content / think 标签,按 provider 注册表提取) |
|
| `thinking` | str | 思考流内容(reasoning_content / think 标签,按 provider 注册表提取) |
|
||||||
| `model` / `provider` | str | 溯源 |
|
| `model` / `provider` | str | 溯源 |
|
||||||
| `prompt_tokens` / `completion_tokens` | int | usage 帧读取;缺失时按估算标注 |
|
| `prompt_tokens` / `completion_tokens` | int | usage 帧读取;帧缺失时记 `0/0` 并由 `usage_source` 标注不可得(不编造估算值,见下) |
|
||||||
| `latency_ms` | int | 总延迟 |
|
| `latency_ms` | int | 总延迟 |
|
||||||
| `ttft_ms` / `max_inter_token_ms` | float? | 流式活性测量 |
|
| `ttft_ms` / `max_inter_token_ms` | float? | 流式活性测量 |
|
||||||
| `cache_hit` | bool | 是否缓存命中 |
|
| `cache_hit` | bool | 是否缓存命中 |
|
||||||
| `call_id` | str | UUID,每次**尝试**独立 |
|
| `call_id` | str | UUID,每次**尝试**独立 |
|
||||||
|
|
||||||
新增字段(库扩展,全部带默认值): `source_name`(多源溯源)、`cost`(pricing 换算,可为 None)、`usage_source`(measured/estimated)、`structured_data`(D14 阶梯通过后的解析产物;不参与缓存序列化,命中时由 CacheMW 复用 strategy 零网络重建)。
|
新增字段(库扩展,全部带默认值): `source_name`(多源溯源)、`cost`(pricing 换算,可为 None)、`usage_source`(三态,见下)、`structured_data`(D14 阶梯通过后的解析产物;不参与缓存序列化,命中时由 CacheMW 复用 strategy 零网络重建)、`cached_prompt_tokens` 与 `model_reported`(2026-07-31,issue #3,见下)。
|
||||||
|
|
||||||
|
**可观测字段(2026-07-31,issue #3;下游 dissect 的调用审计需求)**:
|
||||||
|
|
||||||
|
| 字段 | 含义 | 生产者 |
|
||||||
|
|---|---|---|
|
||||||
|
| `cached_prompt_tokens` | **供应商侧** prompt cache 命中的输入 token 数(OpenAI 兼容格式的 `usage.prompt_tokens_details.cached_tokens`)。`None` = 该源未上报;`0` = 上报了一次真实零命中——两者对下游处置不同(前者不可做缓存成本校正),故不可混同 | `openai_compat` 两条路径解析后经 `TransportResult` 上浮 |
|
||||||
|
| `model_reported` | API 响应体里的 `model` 字段;`None` = 未上报。与 `model`(`.env` 配置别名)可能分叉——供应商把别名指向新权重时,实验复现必须认这个串 | 流式取首个含 `model` 的 chunk(首次写入即固定),非流式取 body 顶层 |
|
||||||
|
|
||||||
|
`cache_hit` 指的始终是 **PolyGateway 自身响应缓存**,与供应商 prompt cache 无关;两者语义不同但名字相近,docstring 已消歧(改名会破坏迁移兼容,故只注释)。
|
||||||
|
|
||||||
|
**缓存命中行的口径(决策 B1)**: 与 `model`/`prompt_tokens` 同一规则——`CacheMW._rehydrate` 只覆写与本次调用相关的时序字段,这两个新字段**原样回放**历史值。故**统计供应商缓存命中率必须写 `WHERE cache_hit = false`**,否则回放行会被重复计数(与 §5.1 `cost` 缺口口径同款教训)。
|
||||||
|
|
||||||
|
**`usage_source` 三态值域(2026-07-30,est_tokens 解耦设计;此前为 measured/estimated 两态)**:
|
||||||
|
|
||||||
|
| 值 | 含义 | 生产者 | cost |
|
||||||
|
|---|---|---|---|
|
||||||
|
| `measured` | usage 帧完整可信 | 正常路径;OCR 成功行(0 token 是**事实**而非未知) | 按 token 换算 |
|
||||||
|
| `estimated` | 有实测数字但可信度降级 | 打捞路径(收到 usage 帧但流被截断,§7.1) | 按 token 换算 |
|
||||||
|
| `unavailable` | 用量信息不可得 | usage 帧缺失、失败尝试、终态失败 | **NULL** |
|
||||||
|
|
||||||
|
值域在 `types.py` 以模块级 frozenset 常量 `USAGE_SOURCES` 落地,**仅约束库内生产侧**(所有写入点从该常量取值),不在 `LLMResponse`/`Usage`/`TransportResult` 上加 `__post_init__` 值域校验——它们是运行时构造点,裸 `ValueError` 不属 §6 四分类、`RetryMW` 不捕会逃出 `chat()`;且 `LLMResponse` 是三项目已消费的公共类型,新增运行时校验属下游可见行为变更。历史库里既有的 `estimated` 行在新值域中依然合法可读。
|
||||||
|
|
||||||
|
**cost 口径的不变式**: **产生了真实网关调用、但用量不可得的行 → `cost` 为 NULL**(不再算出一个假的 `0.0` 把"免费"与"未知"混为一谈)。**缓存命中行不在此列**——`cache_hit=True` 时 cost 仍为 `0.0`,因为未产生新调用,`0.0` 是事实而非未知;`TelemetryEmitter` 里 `unavailable → None` 的短路**插在 `cache_hit` 分支之后**正是为此。故账目缺口的度量口径必须写成 `WHERE usage_source = 'unavailable' AND cache_hit = false`,漏掉后半个条件会把本无缺口的缓存命中行灌进来,度量偏高。
|
||||||
|
|
||||||
**API 稳定性约定(2026-07-20,迁移文档反向约束)**: ① 公共类型新增字段必须带默认值——三项目测试中逐字段传参的 fake 构造才能零改动;② 错误四分类从 `polygateway` 顶层命名空间导出——业务侧步级重试要引用它们(GovDoc/Video-Tree 现有 `(TimeoutError, OSError)` 异常元组迁移后会**静默失效**,必须显式替换为库异常);③ `GatewayClient` 提供显式 `aclose()` 与 async context manager 生命周期 API;④ 被取消的调用尽力而为记遥测(error="cancelled",finally 中记录,绝不因遥测延迟取消传播,写失败静默)。
|
**API 稳定性约定(2026-07-20,迁移文档反向约束)**: ① 公共类型新增字段必须带默认值——三项目测试中逐字段传参的 fake 构造才能零改动;② 错误四分类从 `polygateway` 顶层命名空间导出——业务侧步级重试要引用它们(GovDoc/Video-Tree 现有 `(TimeoutError, OSError)` 异常元组迁移后会**静默失效**,必须显式替换为库异常);③ `GatewayClient` 提供显式 `aclose()` 与 async context manager 生命周期 API;④ 被取消的调用尽力而为记遥测(error="cancelled",finally 中记录,绝不因遥测延迟取消传播,写失败静默)。
|
||||||
|
|
||||||
@@ -381,7 +404,7 @@ flowchart TB
|
|||||||
|
|
||||||
**职责**: 一次原始调用的全部协议细节——请求体组装(含 provider 注册表注入的 thinking 参数)、发送、流式 SSE 解析(增量 content/reasoning_content、usage 帧、[DONE] 检测)、HTTP/线路错误按 §6.2 翻译。**不含**重试/限流/缓存(那是中间件的事)。
|
**职责**: 一次原始调用的全部协议细节——请求体组装(含 provider 注册表注入的 thinking 参数)、发送、流式 SSE 解析(增量 content/reasoning_content、usage 帧、[DONE] 检测)、HTTP/线路错误按 §6.2 翻译。**不含**重试/限流/缓存(那是中间件的事)。
|
||||||
|
|
||||||
- `OpenAICompatTransport`(默认): httpx.AsyncClient(每源一个,预配 Authorization 与分段超时),SSE 解析移植三项目的模块级纯函数;强制 `stream_options.include_usage`。**SSE 缺 [DONE] 语义(2026-07-20 M1 设计)**: per-source `missing_done: "retry" | "salvage"`,默认 retry(防截断响应进缓存被固化);零内容提前断流(early_eof)恒 retry 不可配;打捞路径强制 `usage_source="estimated"`。CHS 迁移配 salvage 保留其现状行为。看门狗活性口径: 任何增量(content 或 reasoning_content)都算 token——ttft = 首个任意 token,思考流刷新 inter_token 计时(CHS 迁移约束 R1)。**非流式快路径**: 短请求可配 `stream=False`(三项目都写死 stream=True 强迫短请求走 SSE+看门狗,库放开)。
|
- `OpenAICompatTransport`(默认): httpx.AsyncClient(每源一个,预配 Authorization 与分段超时),SSE 解析移植三项目的模块级纯函数;强制 `stream_options.include_usage`。**SSE 缺 [DONE] 语义(2026-07-20 M1 设计)**: per-source `missing_done: "retry" | "salvage"`,默认 retry(防截断响应进缓存被固化);零内容提前断流(early_eof)恒 retry 不可配;打捞路径**仅在收到 usage 帧时**把 `measured` 降级为 `estimated`(**勘误 2026-07-30**: 原文"强制 estimated" 已改为有条件——没收到 usage 帧时用量本就是 `unavailable`,强制标 `estimated` 会让 `0/0` 被当作实测数字换算出一个假的 `0.0` 成本,§5.1)。CHS 迁移配 salvage 保留其现状行为。看门狗活性口径: 任何增量(content 或 reasoning_content)都算 token——ttft = 首个任意 token,思考流刷新 inter_token 计时(CHS 迁移约束 R1)。**非流式快路径**: 短请求可配 `stream=False`(三项目都写死 stream=True 强迫短请求走 SSE+看门狗,库放开)。
|
||||||
- `OpenAISDKTransport`(可选 extra): 薄封装,`max_retries=0` 关掉 SDK 自带重试(治理归中间件),`extra_body`/`model_extra` 通道非标字段。
|
- `OpenAISDKTransport`(可选 extra): 薄封装,`max_retries=0` 关掉 SDK 自带重试(治理归中间件),`extra_body`/`model_extra` 通道非标字段。
|
||||||
- `MonkeyOcrTransport`: 见 §7.10。
|
- `MonkeyOcrTransport`: 见 §7.10。
|
||||||
|
|
||||||
@@ -425,17 +448,23 @@ flowchart TB
|
|||||||
|
|
||||||
### 7.7 多源与选源
|
### 7.7 多源与选源
|
||||||
|
|
||||||
`SourceConfig`: name/provider/base_url/api_key/model/超时组/限额组(单源并发/RPM/TPM)/`est_tokens`(TPM 预扣常量,亦作 usage 缺失时的保守兜底,移植 CHS `config.py:55`;2026-07-20 缺口 G2 补)/enable_thinking。聚合自环境变量 `{SCOPE}__{PROVIDER}__{N}__{FIELD}`(§9)。`SourceSelector` 端口: `health_aware`(M2.5 新缺省: 成功率 EWMA / (1+在途) 的 P2C,0.05 探索地板,进程本地健康态,可选 `OutcomeAwareSelector` 扩展喂数)/ `round_robin` / `least_inflight`。**逻辑角色**: Video-Tree 式 SEARCH/JUDGE/VL/EVOLVE 多角色 = 命名的 client 配置组,`from_env()` 支持按角色前缀装配多个 client;禁止两个角色静默共享同一实例却在配置上看似独立(Video-Tree `evolve_llm = llm` 别名的教训——共享必须显式)。
|
`SourceConfig`: name/provider/base_url/api_key/model/超时组/限额组(单源并发/RPM/TPM)/`est_tokens`(TPM 预扣量的**可选调优覆盖**,移植 CHS `config.py:55`;2026-07-20 缺口 G2 补,2026-07-30 由必填降为可选)/enable_thinking。聚合自环境变量 `{SCOPE}__{PROVIDER}__{N}__{FIELD}`(§9)。
|
||||||
|
|
||||||
|
**TPM 有效预扣量(2026-07-30,est_tokens 解耦设计,G2 闭环)**: `try_acquire`(§7.3)传入的 est 来自 `SourceConfig.effective_est_tokens()` 这一份纯方法,五个调用点(`QuotaGate` 入场 + chat/embedding 各自的成功侧与失败侧结算)共用,保证预扣与结算恒取同一值(`delta == 0`,否则押金会被整笔退回、TPM 闸退化成进门即放行)。规则:显式 `est_tokens > 0` 则原样用;否则 `tpm > 0` 时派生 `max(1, tpm // 60)`;`tpm == 0`(该闸不启用)时为 0。
|
||||||
|
|
||||||
|
派生取 `tpm // 60` 的理由是**尺度无关**:任何配额规模都给出同一行为上限——"一次调用约占一秒钟的配额份额",故 `tpm=6000` 与 `tpm=600000` 都收敛到约 60 个在途。固定常量(如 1000)则与配额规模无关,在途上限随配额乱飘且取值无从解释。`est_tokens` **不再兼任 usage 缺失时的用量兜底**:那两份差事对"保守"的定义方向相反——限流语境下押多了只是慢(安全),计费语境下按上界记账只会系统性虚高(库把遥测拆成 prompt/completion 两列后又整块塞进 completion,而输出单价通常是输入的数倍,实测双重高估约 26 倍)。用量不可得现在如实记 `unavailable` + cost NULL(§5.1)。
|
||||||
|
|
||||||
|
**已知限制(既有行为,本次未修)**: 单源 `tpm == 0` 而 `{SCOPE}__GLOBAL__TPM > 0` 时,派生值为 0,全局 TPM 闸拿 0 预扣、入场保护形同虚设。修它需要把 `GlobalLimits` 注入 `QuotaGate`(改三处装配),属独立议题。`SourceSelector` 端口: `health_aware`(M2.5 新缺省: 成功率 EWMA / (1+在途) 的 P2C,0.05 探索地板,进程本地健康态,可选 `OutcomeAwareSelector` 扩展喂数)/ `round_robin` / `least_inflight`。**逻辑角色**: Video-Tree 式 SEARCH/JUDGE/VL/EVOLVE 多角色 = 命名的 client 配置组,`from_env()` 支持按角色前缀装配多个 client;禁止两个角色静默共享同一实例却在配置上看似独立(Video-Tree `evolve_llm = llm` 别名的教训——共享必须显式)。
|
||||||
|
|
||||||
**多 client 共享状态后端(2026-07-20,VT 迁移缺口 R5)**: 限流/熔断状态的 key 以 scope+source 为单位,与 client 实例解耦;多个逻辑角色的 client **显式注入同一个状态后端实例**时即共享全局并发/RPM/TPM 闸(Video-Tree `TREE_BUILD_API_CONCURRENCY` 跨 SEARCH+VL 共享 semaphore 的语义由此承接)。共享必须显式注入,禁止隐式全局。
|
**多 client 共享状态后端(2026-07-20,VT 迁移缺口 R5)**: 限流/熔断状态的 key 以 scope+source 为单位,与 client 实例解耦;多个逻辑角色的 client **显式注入同一个状态后端实例**时即共享全局并发/RPM/TPM 闸(Video-Tree `TREE_BUILD_API_CONCURRENCY` 跨 SEARCH+VL 共享 semaphore 的语义由此承接)。共享必须显式注入,禁止隐式全局。
|
||||||
|
|
||||||
### 7.8 遥测与成本
|
### 7.8 遥测与成本
|
||||||
|
|
||||||
**必录字段**(继承三项目 15 字段规范): call_id、parent_call_id、session_id、model、provider、source_name、messages(JSON)、response、thinking、prompt_tokens、completion_tokens、usage_source、latency_ms、ttft_ms、max_inter_token_ms、cache_hit、error、**cost**。链路: `session_id`/`parent_call_id` 由调用方传入贯穿(agent step → LLM call)。`messages` 落库前对多模态 part 先摘要(与缓存 key 共用同一摘要函数,§7.5)——Video-Tree 现状 base64 整段进 SQLite 导致 db 膨胀(`llm.py:330`),库内修复(2026-07-20,VT 迁移缺口 R12)。
|
**必录字段**(继承三项目 15 字段规范): call_id、parent_call_id、session_id、model、provider、source_name、messages(JSON)、response、thinking、prompt_tokens、completion_tokens、usage_source、latency_ms、ttft_ms、max_inter_token_ms、cache_hit、error、**cost**、**cached_prompt_tokens**、**model_reported**(后两者 2026-07-31 issue #3 新增,端口由 18 字段扩为 20;两个后端在初始化期对已存在的旧表幂等补列——`CREATE TABLE IF NOT EXISTS` 不会给旧表加列,不补则每行写入都被逐行 warning 丢弃。补列一律**先探测缺列再 ALTER**(`ADD COLUMN IF NOT EXISTS` 即使列已存在也先取 ACCESS EXCLUSIVE 锁,而遥测内联 await,锁共享审计表会拖垮业务调用),且**失败只逐行降级、绝不置结构性失能标志**。新列在 DDL 里必须排在 `created_at` **之后**,与 `ALTER TABLE ADD COLUMN` 的追加位置一致,否则新建库与升级库的物理列序分叉)。链路: `session_id`/`parent_call_id` 由调用方传入贯穿(agent step → LLM call)。`messages` 落库前对多模态 part 先摘要(与缓存 key 共用同一摘要函数,§7.5)——Video-Tree 现状 base64 整段进 SQLite 导致 db 膨胀(`llm.py:330`),库内修复(2026-07-20,VT 迁移缺口 R12)。
|
||||||
|
|
||||||
- 后端: `SQLiteRecorder`(默认;WAL + busy_timeout、`INSERT OR IGNORE` 幂等、`asyncio.to_thread` 桥接、初始化/写入失败全降级不冒泡)与 `PostgresRecorder`。
|
- 后端: `SQLiteRecorder`(默认;WAL + busy_timeout、`INSERT OR IGNORE` 幂等、`asyncio.to_thread` 桥接、初始化/写入失败全降级不冒泡)与 `PostgresRecorder`。
|
||||||
- **单一 helper 铁律**: 遥测调用点收敛为一个内部函数/上下文管理器;Video-Tree 与 GovDoc 各有 4-5 处逐字复制的 `record_llm_call(15 个参数)` 是本条的直接教训。
|
- **单一 helper 铁律**: 遥测调用点收敛为一个内部函数/上下文管理器;Video-Tree 与 GovDoc 各有 4-5 处逐字复制的 `record_llm_call(15 个参数)` 是本条的直接教训。
|
||||||
- 成本: `pricing.py` 维护 model → (input 单价, output 单价) 表,遥测时换算 `cost` 字段;查不到价格记 None 并 warning,**不阻塞调用**。
|
- 成本: `pricing.py` 维护 model → (input 单价, output 单价, **可选** cached_input 单价) 表,遥测时换算 `cost` 字段;查不到价格记 None 并 warning,**不阻塞调用**。缓存读取单价(2026-07-31,issue #3)只在配置了该档且本次有命中时启用,按 `(prompt - cached) × input + cached × cached_input` 分段计价;**未配该档绝不按经验折扣率猜**,退化为全额输入价(P5)。命中数超过输入总数时按总数夹取并 warning,不产生负成本。
|
||||||
|
|
||||||
### 7.9 结构化输出阶梯(D14)
|
### 7.9 结构化输出阶梯(D14)
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,152 @@
|
|||||||
|
# est_tokens 解耦设计(issue #2)
|
||||||
|
|
||||||
|
- **日期**: 2026-07-30
|
||||||
|
- **触发**: Gitea issue #2《est_tokens 应由库按实测自估,而不是让调用方填一个没有正确取值的常量》
|
||||||
|
- **档位**: 强制档(改公共 API 语义 + `usage_source` 公共值域 + 推翻一条已声明保留的迁移行为)→ 需人类审批门
|
||||||
|
- **修订的权威文档**(经独立审查补全):
|
||||||
|
- `ARCHITECTURE.md` §7.7 行 428(`SourceConfig.est_tokens` 描述)、§5.1 行 331(`usage_source` 值域)、**§4.4 行 305**("token 按 `est_tokens` 预扣")、**§7.1 行 384**("打捞路径强制 `usage_source="estimated"`",因 §3.2 #4 变为有条件)
|
||||||
|
- `migrations/chsanalyzer.md` 行 151 与 G2(行 185)
|
||||||
|
- **`.env.example` 行 11**("TPM > 0 时 EST_TOKENS 必填 > 0",约束已废除)
|
||||||
|
|
||||||
|
## 1. 问题:一个常量被派了两份互相矛盾的差事
|
||||||
|
|
||||||
|
`SourceConfig.est_tokens` 同时承担两个职责,而两者对"保守"的定义方向相反:
|
||||||
|
|
||||||
|
| 职责 | 语境 | "保守"意味着 | 填大的后果 |
|
||||||
|
|---|---|---|---|
|
||||||
|
| TPM 入场预扣 | 限流 | 多押金,宁可压吞吐也不击穿网关 | 安全(只是慢) |
|
||||||
|
| usage 缺失时的用量兜底 | 计费 | **不存在保守方向** | 账单虚高 |
|
||||||
|
|
||||||
|
CHS 原版 `config.py:55` 把它定义为"须 ≥ 最坏情形 token"——按定义是**上界**。拿上界当实测值记账,必然系统性高估。库把遥测拆成 `prompt_tokens`/`completion_tokens` 两列后又把整个估值塞进 `completion`(`openai_compat.py:146`),而 `pricing.py:70-72` 按 `prompt×input价 + completion×output价` 换算,输出单价通常是输入的数倍——**双重高估**。
|
||||||
|
|
||||||
|
实测算例:`est_tokens=4000`,单价输入 1 元/百万、输出 8 元/百万,真实消耗 400+100:
|
||||||
|
|
||||||
|
| | 记账 token | cost |
|
||||||
|
|---|---|---|
|
||||||
|
| 真实 | 400 / 100 | 0.0012 元 |
|
||||||
|
| 现状 | 0 / 4000 | 0.032 元(**26 倍**) |
|
||||||
|
|
||||||
|
第二个症状是装配约束:`types.py:125` 的 `tpm > 0 ⇒ est_tokens > 0` 把供应商配额(运维可从配额页抄到)与库的实现细节(预扣量,无人能正确取值)绑死。下游 CHSAnalyzer 删掉 `est_tokens` 配置项后,`tpm` 就再也不能填非 0,只能在自己的配置模型里把 `tpm` 限死为 0 绕开——库把内部细节泄漏进了配置面。
|
||||||
|
|
||||||
|
## 2. 备选方案对比
|
||||||
|
|
||||||
|
### 2.1 决策点一:usage 不可得时遥测记什么
|
||||||
|
|
||||||
|
| 方案 | 做法 | 权衡 |
|
||||||
|
|---|---|---|
|
||||||
|
| **A(选定)** | 记 `0/0`,`usage_source` 扩一个 `unavailable`,cost 记 NULL | 缺数据可被统计:`SUM(cost)` 跳过 NULL,`COUNT(*) WHERE usage_source='unavailable' AND cache_hit = false` 能量化账的缺口(**必须带 `cache_hit` 限定**:按 §3.2 #5 的裁决,缓存命中行可以既是 `unavailable` 又有 `cost=0.0`,它们本无账目缺口,不加限定就会灌水——与 §3.3 剔出 OCR 用的是同一把尺子)。代价:公共值域变更,需进 CHANGELOG,且该查询口径要一并写进 wiki(§8) |
|
||||||
|
| B | 记 `0/0`,沿用 `estimated` | 改动最小(等于把 `est_tokens>0` 路径统一到 `est_tokens=0` 的现状行为)。**否决**:cost 算出 `0.0`,"免费"与"未知"在数据上不可区分,缺口不可量化 |
|
||||||
|
| C | 保留 est 兜底,只修 `prompt`/`completion` 分配比例 | 保住 CHS"保守计量"意图。**否决**:比例是又一个没有正确取值的魔数,且未触及"拿上界当实测"这个根因,仍高估约 9 倍 |
|
||||||
|
|
||||||
|
### 2.2 决策点二:`est_tokens` 未填时的默认预扣量
|
||||||
|
|
||||||
|
先排除"不预扣":`try_acquire` 传 0 会让 TPM 窗口在请求飞出到 settle 回来的整段时间形同虚设,大批请求可同时入场,正是"防击穿网关"要防的场景,与 CLAUDE.md 降级方向铁律相悖。
|
||||||
|
|
||||||
|
| 方案 | 源甲 `tpm=6000` | 源乙 `tpm=600000` | 权衡 |
|
||||||
|
|---|---|---|---|
|
||||||
|
| **派生 `tpm//60`(选定)** | 押 100 → 60 个在途 | 押 10000 → 60 个在途 | 尺度无关:任何配额规模都给出同一行为上限,语义可写进 docstring("一次调用约占一秒钟的配额份额") |
|
||||||
|
| 固定常量 1000 | 押金占配额 1/6 → 仅 6 个在途,小请求场景白慢数倍 | 押金占 1/600 → 600 个在途,大请求场景照样撞 429 | **否决**:常量与配额规模无关,在途上限随配额乱飘,无法解释取值 |
|
||||||
|
|
||||||
|
### 2.3 派生逻辑的落点
|
||||||
|
|
||||||
|
| 方案 | 权衡 |
|
||||||
|
|---|---|
|
||||||
|
| **`SourceConfig.effective_est_tokens()`(选定)** | 纯方法只读自身字段,落 `types.py` 内核不违反依赖铁律;零装配变更、零端口变更;5 个调用点(`QuotaGate` 入场 + retry/embedding 各自的成功侧与失败侧结算)共用一份 |
|
||||||
|
| 注入 `GlobalLimits` 到 `QuotaGate`,派生取全局与单源 tpm 的较紧者 | 能覆盖"单源 `tpm=0` 而全局 `tpm>0`"的场景。**否决**:需改三处装配(`retry.py:186`/`embedding.py:116`/`ocr.py:119`),且它修的是一个**既有**缺口(见 §7),超出本任务范围 |
|
||||||
|
| 派生下沉到两个 limiter 后端 | **否决**:`try_acquire(source_key, est_tokens)` 的入参会变成谎言(后端忽略它),且逻辑要写两遍,违反 D3"语义契约只有一份"与 P7"决策与存储分离" |
|
||||||
|
|
||||||
|
## 3. 选定方案
|
||||||
|
|
||||||
|
### 3.1 `usage_source` 三态值域
|
||||||
|
|
||||||
|
| 值 | 含义 | 生产者 | cost |
|
||||||
|
|---|---|---|---|
|
||||||
|
| `measured` | usage 帧完整可信 | 正常路径 | 按 token 换算 |
|
||||||
|
| `estimated` | 有实测数字但可信度降级 | 打捞路径(收到 usage 帧但流被截断) | 按 token 换算 |
|
||||||
|
| `unavailable` | 用量信息不可得 | usage 帧缺失、失败尝试、终态失败 | **NULL**(缓存命中行例外,见 §3.2 #5) |
|
||||||
|
|
||||||
|
`estimated` 保留且有真实生产者(打捞),同时保证历史库里既有的 `estimated` 行读兼容。
|
||||||
|
|
||||||
|
**不变式的准确表述**: 产生了真实网关调用、但用量不可得的行 → cost 为 NULL。缓存命中行不在此列(见 §3.2 #5)。
|
||||||
|
|
||||||
|
**值域的强制落点**: `types.py` 模块级 frozenset 常量,仅约束**库内生产侧**——所有写入 `usage_source` 的位置从该常量取值,测试断言库内产出恒在三态内。**不在 `LLMResponse`/`Usage`/`TransportResult` 等 frozen dataclass 上加 `__post_init__` 值域校验**,两条理由:① 它们是运行时构造点(如 `retry.py:418`),裸 `ValueError` 不属 `errors.py` 四分类,`RetryMW` 不捕它,会直接逃出 `chat()`,违反错误分类驱动铁律;② `LLMResponse` 是三项目已消费的公共类型,新增运行时校验是下游可见行为变更,超出本任务。故 §6 的值域测试断言"库内所有生产点的产出值落在三态内",而非"越界字符串被拒"。
|
||||||
|
|
||||||
|
### 3.2 逐处改动
|
||||||
|
|
||||||
|
| # | 位置 | 改动 |
|
||||||
|
|---|---|---|
|
||||||
|
| 1 | `types.py:125` | 删除 `tpm > 0 ⇒ est_tokens > 0`;`est_tokens` 保留字段、语义降为"可选调优覆盖" |
|
||||||
|
| 2 | `types.py` `SourceConfig` | 新增 `effective_est_tokens()`:显式值 > 0 则原样返回;否则 `tpm > 0` 时返回 `max(1, tpm // 60)`,`tpm == 0` 时返回 0 |
|
||||||
|
| 3 | `openai_compat.py:146,176` | 两处兜底改为 `(0, 0, "unavailable")` / `(0, "unavailable")`,不再读 `source.est_tokens` |
|
||||||
|
| 4 | `openai_compat.py:336` | 打捞覆盖加条件:仅当 `usage_source == "measured"` 时降级为 `estimated`,否则保持 `unavailable`(否则 `0/0` 会被标 `estimated` 而算出假的 `0.0`) |
|
||||||
|
| 5 | `middleware/telemetry.py:130-135` | cost 分支增加短路:`usage_source == "unavailable"` → `None`。**插在 `cache_hit` 分支之后**:缓存命中未产生新调用,`0.0` 是事实而非未知,既有"缓存命中 0.0"语义保持不动。故 `cache_hit=True` 且 `usage_source="unavailable"` 的行 cost 仍是 `0.0`,与 §3.1 不变式不冲突(那条只管产生了真实调用的行) |
|
||||||
|
| 6 | `middleware/telemetry.py:58,100` | 失败尝试与终态失败的 `usage_source` 由 `estimated` 改 `unavailable`(用量确实不可得;这两行 cost 本已是 None,语义对齐不改金额) |
|
||||||
|
| 7 | `middleware/ratelimit.py:26` | `source.est_tokens` → `source.effective_est_tokens()` |
|
||||||
|
| 8 | `retry.py:370`、`embedding.py:294` | **失败侧**保守结算改用 `effective_est_tokens()`。必须同改:预扣派生值而结算退 `est_tokens=0` 会让 `delta` 为负、退掉全部押金,丢掉"失败可能已被计费"的保守意图 |
|
||||||
|
| 9 | `retry.py:338`、`embedding.py:271` | **成功侧**结算:`usage_source == "unavailable"` 时按 `effective_est_tokens()` 结算,而非 `prompt+completion`(此时恒为 0)。**这条是保持既有行为、不是新增保守**:改前 `_resolve_usage` 恰好返回 `est_tokens`,使 `actual == 预扣量`、`delta == 0`、押金留存;#3 把它改成 `(0, 0)` 后若不同改,成功调用的押金会被整笔退回,对"从不返回 usage 帧的网关源"构成系统性 TPM 计量失效——闸门退化成进门即放行、出门即清账,正是降级方向铁律要防的击穿 |
|
||||||
|
| 10 | `embedding.py:383,390` | 二值合并扩为三态:任一批 `unavailable` → 整体 `unavailable`;否则任一 `estimated` → `estimated`;否则 `measured`。同步更新 `types.py:273` 的行内注释 `# measured | estimated`,内核里不留与三态矛盾的注释 |
|
||||||
|
| 11 | `embedding.py:397` `_total_cost` | 存在 `unavailable` 批时整体 cost 记 NULL(逐批求和会给出一个偏低却看似有效的金额) |
|
||||||
|
|
||||||
|
### 3.3 明确不改的
|
||||||
|
|
||||||
|
**非 dead 的瞬时失败路径**(`retry.py:369` 的 `if not dead` 分支)按预扣量做**限流**结算的行为保留——那是限流语境,保守方向正确(失败请求可能已被网关计费),且该值只流向 `_settle_and_release`,不进遥测。其余三条失败分支(`RequestRejectedError`/`ResultInvalidError`/`SourceDeadError`)的 `actual` 停在初值 0(`retry.py:329`),属既有行为,本次**不动**——#8 已把行号钉死,实现时不要顺手把这三条也改成保守结算。`SourceConfig.est_tokens` 字段与 `{SCOPE}__{PROVIDER}__{N}__EST_TOKENS` 环境键**保留不删不改名**(迁移兼容硬约束,ARCHITECTURE §5.1)。`RateLimiter` 端口签名不变。
|
||||||
|
|
||||||
|
**`ocr.py:411` 的 `usage_source="measured"` 保留不改**(初稿曾列为改动项,独立审查后剔出)。库既有立场是 OCR 的 0 token 属**事实**而非未知——`types.py:51` "token 用量;OCR 等无计费调用填 0"、`ocr.py:9` "settle 恒为 0(OCR 无 token 计费)"——故 `measured` 是准确陈述。改成 `unavailable` 还会反噬 §2.1 的核心度量:`COUNT(*) WHERE usage_source='unavailable'` 本用于量化账目缺口,灌进本无缺口的 OCR 行就失去意义。
|
||||||
|
|
||||||
|
## 4. 旧版行为审计(迁移保留项的推翻声明)
|
||||||
|
|
||||||
|
| 旧版行为 | 出处 | 本次处置 |
|
||||||
|
|---|---|---|
|
||||||
|
| usage 缺失按 `est_tokens` 估算并标 `estimated`,不静默用 0 | CHS `invokers.py:241-254`;`migrations/chsanalyzer.md:151` 标记为**保留** | **有意放弃**。理由:CHS 只记单个 `total_tokens`,不存在 prompt/completion 分配问题;库拆两列后无法忠实分配,且 `est_tokens` 按 CHS 自身定义是最坏情形上界。"保守"在限流语境安全、在计费语境只有错误一个方向 |
|
||||||
|
| 缺失时不静默用 0(拒绝 VT 的"填 0 且不标注") | 同上;`m1-core-design.md:222` 行 10 | **保留**。本方案记 0 但带 `unavailable` 显式标记且 cost 为 NULL,反静默的原始意图完整保留——被放弃的只是"编一个数字"这个手段 |
|
||||||
|
| `est_tokens` 作 TPM 入场预扣常量 | CHS `config.py:55` | **保留**,仅由必填降为可选覆盖 |
|
||||||
|
| `tpm > 0 ⇒ est_tokens > 0` 装配校验 | `m1-core-plan.md:93` | **替换**为库内派生,校验删除 |
|
||||||
|
| 打捞路径强制 `estimated` | `m1-core-design.md` §6 | **保留**,补一个前置条件(§3.2 #4) |
|
||||||
|
| 遥测 `INSERT OR IGNORE` 幂等、写失败降级不冒泡、列只增 | `m1-core-design.md:218` | **保留**,本次无 DDL 变更 |
|
||||||
|
|
||||||
|
## 5. 非功能维度
|
||||||
|
|
||||||
|
**并发与取消**: `effective_est_tokens()` 是无状态纯方法(只读 frozen dataclass 字段),并发安全、无锁、可重复调用。本次改动不新增 `await` 点、不改变任何 `try/finally` 结构,取消穿透路径与 in-flight 释放语义原样不动。#8 与 #9 合起来保证**成功侧与非 dead 瞬时失败侧**的预扣与结算恒取同一派生值(`delta == 0`)——这是本设计里最容易漏的一致性约束(初稿只写了失败侧,独立审查发现成功侧缺口)。**取消 / RequestRejected / ResultInvalid / SourceDead 四侧不在此列**:它们的 `actual` 停在 `retry.py:329` 的初值 0、全额退回,属 §3.3 声明不动的既有行为。
|
||||||
|
|
||||||
|
**降级方向**: 不改变任何后端的降级方向。遥测侧仍是静默降级(`telemetry.py:161` 的 warning 不冒泡);限流侧仍是 `GovernanceBackendError` 上抛而非放行;TPM 计量不因 usage 帧缺失而静默失效(#9)。
|
||||||
|
|
||||||
|
否决 issue 建议的 p90 自估,主论据是 **`TelemetryRecorder` 目前是纯只写端口,自估需要新增读接口并强制所有后端(含 `none`)实现**,公共 API 扩张远大于它要省掉的一个可选字段,且尚无实测证据表明派生默认值不够用(§8)。初稿曾论证"那会把两条方向相反的降级铁律焊在一起",此论据经审查后**撤回**:p90 方案完全可以在遥测读失败时回退到纯派生值,限流侧仍能保持 fail-closed,故并非必然冲突。结论不变,理由收窄。
|
||||||
|
|
||||||
|
**幂等与重复**: `Permit.settle()`/`release()` 的幂等 flag 语义不变。#8 与 #9 使预扣与结算取自同一派生函数,同一请求重复结算仍是 no-op。
|
||||||
|
|
||||||
|
**持久化与原子性**: 无 DDL 变更(两 schema 的 `cost` 列已可空);无新增落盘点;Redis Lua 脚本不改(仍接收调用方算好的 est)。历史数据不迁移:旧行的 `estimated` 语义在新值域中依然合法可读。
|
||||||
|
|
||||||
|
## 6. 错误处理与测试策略
|
||||||
|
|
||||||
|
值域校验失败属配置/内部不变量违反 → `ValueError`(装配期 fail-loud),不进四分类运行时错误。本次不改变任何调用失败的分类归属。
|
||||||
|
|
||||||
|
| 测试 | 断言要点 | 文件 |
|
||||||
|
|---|---|---|
|
||||||
|
| 约束解绑 | `tpm=6000, est_tokens=0` 构造成功(改前抛 ValueError) | `tests/unit/test_types.py` |
|
||||||
|
| 派生尺度无关 | `tpm=6000→100`、`tpm=600000→10000`、`tpm=0→0`、显式值优先、`tpm=30→max(1,·)` 不为 0 | 同上 |
|
||||||
|
| cost 不再造假 | `est_tokens=4000` + usage 缺失 → `0/0/unavailable` 且 `record_llm_call` 收到 `cost=None`(改前 `0.032`) | `tests/unit/test_openai_compat.py`、`test_telemetry.py` |
|
||||||
|
| 缓存命中不受牵连 | `cache_hit=True` 且 `unavailable` → cost 仍为 `0.0`(锁定 §3.2 #5 的分支次序) | `test_telemetry.py` |
|
||||||
|
| 打捞前置条件 | 打捞 + usage 帧存在 → `estimated` 且 cost 非 None;打捞 + usage 缺失 → `unavailable` 且 cost 为 None(回归 §3.2 #4) | `test_openai_compat.py` |
|
||||||
|
| **失败侧**结算不退多 | 未填 `est_tokens` 且 `tpm>0` 时失败请求,TPM 窗口残留量等于派生预扣量而非 0(回归 §3.2 #8) | `tests/contracts/test_limiter_contract.py` |
|
||||||
|
| **成功侧**结算不退多 | usage 缺失的**成功**调用后,TPM 窗口残留量等于派生预扣量而非 0(回归 §3.2 #9,本设计最易漏的一条)。现有锚点 `test_retry.py:149` 的 `_src("a", tpm=1000, est_tokens=400)` 旁加一个 `est_tokens=0` + usage 缺失的用例 | `tests/unit/test_retry.py`、`test_limiter_contract.py` |
|
||||||
|
| 三态合并 | 混合批 `measured+unavailable` → 整体 `unavailable` 且 cost 为 NULL | `tests/unit/test_embedding.py` |
|
||||||
|
| OCR 不变 | OCR 成功行仍为 `measured` 且 settle 恒 0(防回归,锁定 §3.3 的剔出决定) | `tests/unit/test_ocr_client.py` |
|
||||||
|
| 值域封闭 | 库内所有生产点的产出恒落在三态内;公共 dataclass 不因越界值抛异常(锁定 §3.1 的落点决定) | `test_types.py` |
|
||||||
|
|
||||||
|
限流侧断言随 `tests/contracts/test_limiter_contract.py` 同时覆盖内存与 Redis 两后端(Redis 走真实实例,遵守共享后端不并跑纪律)。
|
||||||
|
|
||||||
|
## 7. 已知限制(本次不修,显式声明)
|
||||||
|
|
||||||
|
单源 `tpm == 0` 而全局 `tpm > 0` 时,`effective_est_tokens()` 返回 0,全局 TPM 闸拿 0 预扣、入场保护形同虚设。**这是既有行为**(现状约束只管 `cfg.tpm > 0`,该场景下 `est_tokens=0` 本就合法),本方案不引入也不修复它。修它需要把 `GlobalLimits` 注入 `QuotaGate`(§2.3 备选二),属独立议题,建议另开 issue。
|
||||||
|
|
||||||
|
## 8. 下游影响与发布
|
||||||
|
|
||||||
|
`est_tokens` 从必填降为可选后,CHSAnalyzer 可删掉"`tpm` 必须为 0"的绕行校验并填真实 TPM。`usage_source` 出现第三个值、且不可得行的 cost 由数值变 NULL,是下游可见的行为变更:成本汇总若此前依赖"cost 非空"隐含假设需复核。按 `docs-convention.md` §2,发版须同步 CHANGELOG 与 wiki 的 usage/成本口径说明,并在 issue #2 回帖结论。
|
||||||
|
|
||||||
|
遥测驱动的自适应预估(issue 原建议)不在本次范围,待默认派生值在真实负载下出现实测问题后再评估。
|
||||||
|
|
||||||
|
## 9. 规模判定
|
||||||
|
|
||||||
|
改动面(独立审查后重算):**6 个源文件**(`types.py`、`transports/openai_compat.py`、`middleware/telemetry.py`、`middleware/ratelimit.py`、`middleware/retry.py`、`embedding.py`;`ocr.py` 已剔出)、**7 个测试文件**、**3 份权威文档**(ARCHITECTURE.md、`migrations/chsanalyzer.md`、`.env.example`),外加按 `docs-convention.md` §2 必须同步的 CHANGELOG 与用户文档站 wiki(版本 bump 不得裸发)。
|
||||||
|
|
||||||
|
属跨多文件功能 → 本设计经人类审批后须走 `writing-plans` 出实施计划,不得直接进实现。
|
||||||
@@ -0,0 +1,164 @@
|
|||||||
|
# 响应可观测字段扩展设计(Issue #3)
|
||||||
|
|
||||||
|
- **日期**: 2026-07-31
|
||||||
|
- **来源**: Gitea Issue #3(下游 dissect 审计需求)
|
||||||
|
- **状态**: 已批准(2026-07-31,人类逐条确认 A2 / B1 / C1 / D1)
|
||||||
|
- **触发档位**: 强制(变更 `types.py` 公共类型 + `ports.py` 端口签名 + 遥测持久化 schema)
|
||||||
|
|
||||||
|
## 1. 目标与非目标
|
||||||
|
|
||||||
|
| 项 | 内容 |
|
||||||
|
|---|---|
|
||||||
|
| 目标 1 | `LLMResponse` 暴露供应商侧 prompt cache 命中的输入 token 数 |
|
||||||
|
| 目标 2 | `LLMResponse` 暴露 API 响应体实际返回的模型版本串 |
|
||||||
|
| 目标 3 | 两字段同步落 `llm_calls` 遥测表(端口 18 → 20 字段) |
|
||||||
|
| 目标 4 | `PricingTable` 支持可选的缓存读取单价,消除 cost 高估 |
|
||||||
|
| 非目标 1 | 不改 `EmbeddingResponse` / OCR 响应——embedding 与 OCR 无 prompt cache 语义,且 issue 未提;`cost()` 新增参数带默认值,embedding 调用点(`embedding.py:419`)零改动 |
|
||||||
|
| 非目标 2 | 不改 `cache_hit` 字段名/类型(破兼容),只在 docstring 消歧 |
|
||||||
|
| 非目标 3 | 不为 `reasoning_tokens` 等其他 usage 细项开口(YAGNI,无下游需求) |
|
||||||
|
|
||||||
|
### 1.1 Issue 前提的一处修正
|
||||||
|
|
||||||
|
Issue 称「两者的数据都已经存在于 `TransportResult.raw` 里」。核查结果:
|
||||||
|
|
||||||
|
| 数据 | 实际所在 | 结论 |
|
||||||
|
|---|---|---|
|
||||||
|
| `usage.prompt_tokens_details.cached_tokens` | `raw={"usage": ...}`(流式 `openai_compat.py:362`、非流式 `:444`) | ✅ 已在 raw 内 |
|
||||||
|
| 响应体顶层 `model` | **不在**。非流式 raw 只放 `body["usage"]`;流式 sink 只吸收 `usage` 与 `done` 两键(`_sse_delta`,`:44-47`),chunk 的 `model` 从未收集 | ❌ 需改 transport 采集 |
|
||||||
|
|
||||||
|
故本变更**不是纯字段暴露**,必须同时改 `transports/`。这决定了下面决策 A 的必要性。
|
||||||
|
|
||||||
|
## 2. 决策 A:字段的采集与传递路径
|
||||||
|
|
||||||
|
| 方案 | 做法 | 权衡 |
|
||||||
|
|---|---|---|
|
||||||
|
| A1 raw 约定键 | transport 往 `raw` 里塞 `{"model": ...}`;RetryMW 读 `raw.get("model")` 与 `raw["usage"]["prompt_tokens_details"]["cached_tokens"]` | 改动最小;但 `raw: dict[str, Any]` 变成隐式契约,键名靠约定;且 middleware 要懂 OpenAI 报文嵌套结构 |
|
||||||
|
| A2 TransportResult 强类型字段(**推荐**) | `TransportResult` 追加 `cached_prompt_tokens: int \| None = None`、`model_reported: str \| None = None`;解析逻辑留在 `openai_compat.py`;RetryMW 直接搬运 | 报文格式知识不出 `transports/`,middleware 只做搬运,符合 P7(middleware 只依赖端口、不懂具体报文);两字段带默认值,`monkey_ocr` 的 OCR 结果类型不受影响 |
|
||||||
|
| A3 middleware 解析 raw | RetryMW 内写 OpenAI 嵌套路径解析 | 把 provider 报文格式知识放进 middleware 层,新增非 OpenAI 兼容 transport 时会分叉;违反分层,否决 |
|
||||||
|
|
||||||
|
**选 A2**。`TransportResult` 是库内部流转类型(非三项目消费面),但仍按「新增必带默认值」处理,使 `openai_compat` 之外的构造点零改动;全库该类型仅 2 处构造(`openai_compat.py:354/436`)。
|
||||||
|
|
||||||
|
解析纪律(P5 一切外部输入校验后使用):`cached_tokens` 与 `model` 均来自网关响应,类型不可信。取值走防御 helper,不抛异常(可观测字段缺失绝不能打断主路径):
|
||||||
|
|
||||||
|
| 输入 | 结果 |
|
||||||
|
|---|---|
|
||||||
|
| `cached_tokens` 为非负 `int`(**含 `0`**) | 如实保留——`0` 是「该源上报了一次真实零命中」,与「未上报」的 `None` 语义不同,这正是本 issue 的核心诉求 |
|
||||||
|
| `cached_tokens` 为负数 / 非 `int` / `bool` | `None`(`bool` 必须显式排除:`isinstance(True, int)` 在 Python 里为真) |
|
||||||
|
| `usage` 或 `prompt_tokens_details` 非 dict | `None` |
|
||||||
|
| `model` 为非空 `str` | 保留 |
|
||||||
|
| `model` 为非 `str` / 空白串 | `None` |
|
||||||
|
|
||||||
|
## 3. 决策 B:缓存命中回放时两字段取什么值
|
||||||
|
|
||||||
|
| 方案 | LLMResponse 层 | 遥测层 | 权衡 |
|
||||||
|
|---|---|---|---|
|
||||||
|
| B1 原样回放(**推荐**) | 随缓存 JSON 回放原值 | 照记回放值 | 与既有口径一致——`CacheMW._rehydrate`(`cache.py:113-119`)只覆写与本次调用相关的时序字段(`latency_ms`/`ttft_ms`/`max_inter_token_ms`/`call_id`/`cache_hit`),`model`/`provider`/`prompt_tokens` 全部回放。新字段与它们同类(溯源 + 用量),按同一规则处理 |
|
||||||
|
| B2 命中时置 None | 覆写为 None | NULL | 语义上「本次未打供应商,无供应商侧事实」也成立,但与同层的 `prompt_tokens` 回放行为不一致,下游要记两套规则 |
|
||||||
|
| B3 混合 | `model_reported` 回放、`cached_prompt_tokens` 置 None | 同左 | 最难解释,否决 |
|
||||||
|
|
||||||
|
**选 B1**,并写入文档一条度量口径约束(与 `cost` 缺口口径同款教训,ARCHITECTURE §5.1):
|
||||||
|
|
||||||
|
> 统计供应商缓存命中率必须写 `WHERE cache_hit = false`——缓存命中行的 `cached_prompt_tokens` 是历史回放值,计入会重复计数。
|
||||||
|
|
||||||
|
`cost` 不受影响:遥测层 `cache_hit=True` 分支仍短路为 `0.0`,早于任何单价换算。
|
||||||
|
|
||||||
|
## 4. 决策 C:缓存读取单价(人类已选「增加可选档」)
|
||||||
|
|
||||||
|
| 方案 | 做法 | 权衡 |
|
||||||
|
|---|---|---|
|
||||||
|
| C1 ModelPrice 可选第三档(**推荐**) | `cached_input_per_1m: float \| None = None`;`cost()` 增可选参 `cached_prompt_tokens: int \| None = None` | 价格表旧文件零改动仍可加载;`embedding.py:419` 的三参调用零改动 |
|
||||||
|
| C2 cost() 收 LLMResponse | 换算函数直接吃响应对象 | `pricing.py` 会反向依赖 `types.py` 且难以单测纯函数,否决 |
|
||||||
|
|
||||||
|
换算规则与退化路径:
|
||||||
|
|
||||||
|
| 条件 | 计价方式 |
|
||||||
|
|---|---|
|
||||||
|
| 配了 `cached_input_per_1m` 且本次 `cached_prompt_tokens` 为正 | `(prompt - cached) × input + cached × cached_input` |
|
||||||
|
| 未配该档,或本次 `cached_prompt_tokens` 为 None/0 | 全额按 `input` 计(现状行为,不变) |
|
||||||
|
| `cached > prompt`(网关口径异常) | 按 `cached = prompt` 夹取并记一次 warning;不抛异常、不产生负成本 |
|
||||||
|
|
||||||
|
**不猜折扣率**:未配置缓存档时绝不按「五分之一」之类经验值折算(P5 严禁默认值掩盖)。`from_file` 的 fail-loud 校验对新档同样适用:出现该键但非数或为负 → `ValueError`。
|
||||||
|
|
||||||
|
## 5. 决策 D:遥测表扩列的落地方式
|
||||||
|
|
||||||
|
人类确认「现在不存在必须保留的生产库」。但两个后端的 DDL 都是 `CREATE TABLE IF NOT EXISTS`,**已存在的开发库/下游库不会自动获得新列**,INSERT 会失败。两侧的失败形态都是**逐行 warning 丢弃**(SQLite `sqlite.py:93`;PG `postgres.py:127`——`_failed` 结构性标志只在 `_ensure_ready` 建池/建表失败时置位,与写入路径无关),即每一次调用的遥测行都丢,却不会有任何一次硬失败提示,与「遥测必录」相悖。
|
||||||
|
|
||||||
|
| 方案 | 做法 | 权衡 |
|
||||||
|
|---|---|---|
|
||||||
|
| D1 初始化期幂等补列(**推荐**) | DDL 加新列;初始化时按需 `ALTER TABLE ADD COLUMN`——PG 用原生 `IF NOT EXISTS`,SQLite 先查 `PRAGMA table_info` 再按需 ALTER | 旧库自动升列,新库无副作用;两处各约 5 行;补列失败沿用现有降级策略(warning,不冒泡) |
|
||||||
|
| D2 只改 DDL,文档写「删表重建」 | 零代码 | 已建表的开发机/下游踩坑后只看到降级 warning,排查成本高;违反防御性 |
|
||||||
|
| D3 引入迁移框架(alembic) | 正规版本化迁移 | 新增依赖,与「依赖极简」铁律冲突,规模严重不匹配,否决 |
|
||||||
|
|
||||||
|
**选 D1**。列类型:SQLite `cached_prompt_tokens INTEGER` / `model_reported TEXT`;PG `INTEGER` / `TEXT`。两列均可空(NULL = 该源未上报),不设 NOT NULL 与默认值——0 与 NULL 的区分正是本 issue 的核心诉求。
|
||||||
|
|
||||||
|
**D1 的实现纪律(必须钉进计划,否则补列会把降级放大成永久失能)**:
|
||||||
|
|
||||||
|
| 约束 | 原因 |
|
||||||
|
|---|---|
|
||||||
|
| SQLite 的 ALTER 必须用**独立 try**,且置于 `self._conn = conn` **之后** | `__init__` 现有 try 的最后一句才是 `self._conn = conn`(`sqlite.py:74-84`);ALTER 抛异常会让 `_conn` 停在 `None`,`record_llm_call` 首行即 return —— 整个 recorder 永久 no-op,比逐行丢弃严重得多 |
|
||||||
|
| `duplicate column name` 视为成功吞掉 | `PRAGMA table_info` 探测 + ALTER 是 TOCTOU:多 worker 共用同一 db 文件时后到者必然撞上 |
|
||||||
|
| 不得为补列加宽 `except` | `sqlite.py:93` 只捕 `(OSError, sqlite3.Error)`,取消是天然穿透的;PG 侧的 `except asyncio.CancelledError: raise` 必须留在最前 |
|
||||||
|
| PG 用原生 `ALTER TABLE ... ADD COLUMN IF NOT EXISTS` | 无 TOCTOU;落在既有 `_init_lock` 保护的 `_ensure_ready` 内 |
|
||||||
|
|
||||||
|
端口 `TelemetryRecorder.record_llm_call` 由 18 字段扩为 20 字段(关键字参数),`ports.py:248` 的「18 字段冻结」注释与 ARCHITECTURE 相应表述同步更新。新增参数在 Protocol 上**不设默认值**——依据不是「漏改会报错」(本仓无 mypy,`make lint` 只有 ruff + import-linter,8 个测试 fake 全是 `**fields`,漏改根本不会自动红),而是**库外不存在第三方实现者**:三项目迁移文档明确删除各自的 TelemetryRecorder Protocol 与实现(`migrations/govdoc-saas.md:36`、`video-tree-trm5.md:36/51`),端口的唯一实现者就是库内两个后端,完整签名的成本为零。漏改的兜底靠 §8 的键集合断言测试,不靠类型检查。
|
||||||
|
|
||||||
|
## 6. 行为审计(既有行为逐条标注)
|
||||||
|
|
||||||
|
| 既有行为 | 处置 |
|
||||||
|
|---|---|
|
||||||
|
| `LLMResponse` 前 11 字段顺序即公共承诺 | **保留**,新字段追加到尾部(`structured_data` 之后) |
|
||||||
|
| 缓存序列化 `_serialize` 用 `asdict` 后 pop 掉 `structured_data`、`_rehydrate` 按 `_RESPONSE_FIELDS` 过滤 | **保留**。新字段自动进出;旧缓存条目缺这两键时,`LLMResponse(**fields)` 靠默认值构造成功(向后兼容已验证) |
|
||||||
|
| `cache_hit` 语义 = PolyGateway 自身响应缓存 | **保留**,仅补 docstring 消歧 |
|
||||||
|
| `TelemetryEmitter` 单一 `_record` helper(遥测必录铁律:禁止复制参数列表) | **保留**,新字段只在 `_record` 增两个参数,三个 `emit_*` 入口各传一次 |
|
||||||
|
| 失败尝试 / 终态失败行记 `usage_source="unavailable"` | **保留**,两个新字段在这些路径记 `None` |
|
||||||
|
| `pricing.cost()` 是唯一换算点(注释语)| **修正**:实际有 `TelemetryEmitter` 与 `embedding.py:419` 两个调用点,顺带订正该 docstring(限于一行注释,不做结构重构) |
|
||||||
|
| OCR / embedding 各自构造 `LLMResponse` | **保留**,两字段取默认 `None`(该路径无供应商 cache 概念) |
|
||||||
|
|
||||||
|
## 7. 非功能维度
|
||||||
|
|
||||||
|
| 维度 | 结论 |
|
||||||
|
|---|---|
|
||||||
|
| 并发与取消 | 纯数据字段,无新增 await 点、无共享状态。PG 补列在既有 `_init_lock` 保护的 `_ensure_ready` 内,并发首调用不会重复 ALTER;SQLite 的 `__init__` **不持** `_lock`(它只保护 `_write`/`close`),跨进程共库靠上面 D1 纪律里的「duplicate column 视为成功」兜底。取消穿透不变:PG 两处 `except asyncio.CancelledError: raise` 保持在最前,SQLite 侧只捕 `(OSError, sqlite3.Error)` 故天然穿透 |
|
||||||
|
| 降级方向 | 遥测属「静默降级」侧:补列失败 → warning 并沿用既有逐行丢弃,绝不冒泡到调用方,也绝不让 recorder 整体失能(见 D1 纪律)。解析失败 → 字段记 `None`,不影响响应返回 |
|
||||||
|
| 幂等与重复 | 补列幂等(PG `IF NOT EXISTS`;SQLite 先探测)。写入幂等性不变(`INSERT OR IGNORE` / `ON CONFLICT DO NOTHING` 按 `call_id`) |
|
||||||
|
| 持久化与原子性 | 单行 INSERT 原子性不变;新增两列不参与主键与冲突判定。缓存 JSON 是整值覆写,无部分写入 |
|
||||||
|
| 向后兼容 | 下游三项目 + dissect:纯增字段带默认值,逐字段传参的 fake 构造零改动;旧价格表文件、旧缓存条目、旧遥测表均可继续工作 |
|
||||||
|
|
||||||
|
## 8. 错误处理与测试策略
|
||||||
|
|
||||||
|
错误分类:本变更**不新增任何错误路径**。网关报文里这两项缺失或类型异常 → 记 `None`,不归入四分类(它们不是失败,是「该源没给」)。价格表配置错误仍走装配期 `ValueError`(fail-loud,不属运行时四分类)。
|
||||||
|
|
||||||
|
| 层 | 测试(先失败后通过) |
|
||||||
|
|---|---|
|
||||||
|
| types(unit) | 新字段默认值为 `None`;字段顺序不变(前 11 位置构造仍成立) |
|
||||||
|
| transports(unit) | 用真实网关响应二次构造样本:① 流式含 `prompt_tokens_details.cached_tokens` → 解析出正整数;② 非流式同上;③ 无该键 → `None`;④ 值为 `"abc"`/负数 → `None` 不抛;⑤ 流式 chunk 的 `model` 被 sink 采集;⑥ 顶层无 `model` → `None` |
|
||||||
|
| retry(unit) | `_build_response` 透传两字段;失败尝试路径不受影响 |
|
||||||
|
| cache(unit) | ① 新字段随序列化往返;② **旧格式**缓存条目(缺这两键)仍能 rehydrate;③ 命中回放值符合 B1 |
|
||||||
|
| pricing(unit) | ① 配缓存档 + 命中 → 成本低于全额;② 未配该档 → 与现状逐位相等;③ `cached > prompt` → 夹取且不为负;④ 三参旧调用签名仍可用(embedding 调用形态);⑤ 价格表含负缓存单价 → `ValueError` |
|
||||||
|
| telemetry(integration) | ① 20 字段写入 SQLite/PG 成功并可读回;② **旧表**(18 列)在初始化后自动补列并写入成功;③ 补列失败时降级为 warning 且 recorder 仍能工作(SQLite `_conn` 不得因此为 None) |
|
||||||
|
| 契约(**新增,不可省**) | 断言 `TelemetryEmitter` 传给 recorder 的实参键集合 == 两个后端的 `_COLUMNS`。理由:`row = tuple(fields[col] for col in _COLUMNS)` 位于两个后端的 try **之外**(`sqlite.py:90` / `postgres.py:121`),emitter 漏传新字段会抛 `KeyError`,被 `_record` 的 `except Exception` 吞成 warning → **静默丢遥测**。这是本变更最危险的失败形态,而现有 8 个 `**fields` 形态的 fake 一个都拦不住 |
|
||||||
|
|
||||||
|
> integration 层的 Redis/PG 测试遵守既有纪律:共享后端严禁并跑,`conda run -n PolyGateway --no-capture-output`。
|
||||||
|
|
||||||
|
## 9. 影响面清单
|
||||||
|
|
||||||
|
| 文件 | 改动 |
|
||||||
|
|---|---|
|
||||||
|
| `src/polygateway/types.py` | `LLMResponse` +2 字段;`TransportResult` +2 字段;`cache_hit` docstring 消歧 |
|
||||||
|
| `src/polygateway/transports/openai_compat.py` | sink 采集 `model`;两处 `TransportResult` 构造填新字段;新增防御解析 helper |
|
||||||
|
| `src/polygateway/middleware/retry.py` | `_build_response` 透传 2 字段 |
|
||||||
|
| `src/polygateway/middleware/telemetry.py` | `_record` + 三个 `emit_*` 各透传 2 字段;cost 换算传入 `cached_prompt_tokens` |
|
||||||
|
| `src/polygateway/pricing.py` | `ModelPrice` +可选档;`cost()` +可选参;`from_file` 校验;订正唯一换算点注释 |
|
||||||
|
| `src/polygateway/ports.py` | `TelemetryRecorder` 18 → 20 字段 |
|
||||||
|
| `src/polygateway/telemetry/{sqlite,postgres}.py` | DDL +2 列;`_COLUMNS` +2;初始化期幂等补列 |
|
||||||
|
| `tests/` | 四处天然拦截点必须同步(漏改即红): 两个 `_record_minimal` 手写 18 键 dict(`unit/test_telemetry.py:76` 起、`integration/test_postgres_telemetry.py:81-105`)与两个 `_EXPECTED_COLUMNS` 列序断言(`unit/test_telemetry.py:18-40`、`integration/test_postgres_telemetry.py:22-41`);`unit/test_ports.py:96` 的全签名 fake 同步(它**不会**红,Protocol 的 isinstance 不校验签名);新增契约测试 |
|
||||||
|
| `research-wiki/ARCHITECTURE.md` | §5.1 字段表 + 遥测表定义 + 「18 字段冻结」表述 |
|
||||||
|
| 「18 字段冻结」的其余措辞点 | `ports.py:248`、`pricing.py:6`(币种说明里引用了该数字)、`telemetry/sqlite.py:87`、`tests/unit/test_telemetry.py:1` |
|
||||||
|
| Wiki 站 + `CHANGELOG.md` | 按 `docs-convention.md` §2 清单同步(公共行为变更,版本 bump 不得裸发) |
|
||||||
|
| `.env.example:56` | 该行内联注释是仓内**唯一**的价格表格式说明(无独立模板文件,`config/prices.json` 是未入库的本地文件),补 `cached_input_per_1m` 可选档 |
|
||||||
|
|
||||||
|
## 10. 审批记录
|
||||||
|
|
||||||
|
2026-07-31 人类逐条确认: **A2**(TransportResult 强类型字段)、**B1**(缓存命中原样回放 + 度量口径带 `cache_hit = false`)、**C1**(ModelPrice 可选缓存单价档)、**D1**(DDL 加列 + 初始化期幂等补列)。设计获批,进入 `writing-plans`。
|
||||||
|
|
||||||
|
版本号按 `1.1.0` 推进(纯增字段不破坏下游,但触及端口签名与表结构,minor 位比 patch 位更能提示下游);发版前若人类另有指示以指示为准。
|
||||||
@@ -0,0 +1,23 @@
|
|||||||
|
---
|
||||||
|
type: design
|
||||||
|
node_id: design:est-tokens-decoupling
|
||||||
|
title: "est_tokens 解耦: 拆分限流预扣与遥测用量兜底(issue #2)"
|
||||||
|
date: 2026-07-30
|
||||||
|
---
|
||||||
|
|
||||||
|
# est_tokens 解耦: 拆分限流预扣与遥测用量兜底(issue #2)
|
||||||
|
|
||||||
|
全文见 [2026-07-30-est-tokens-decoupling-design.md](2026-07-30-est-tokens-decoupling-design.md)。缘起是 Gitea issue #2(下游 CHSAnalyzer 提出)。
|
||||||
|
|
||||||
|
- **缘起**: `SourceConfig.est_tokens` 被派了两份对"保守"定义相反的差事——TPM 入场预扣(多押金 = 安全)与 usage 帧缺失时的遥测用量兜底(计费没有安全方向)。CHS `config.py:55` 自己就把它定义为"须 ≥ 最坏情形 token"的**上界**,而库把遥测拆 `prompt`/`completion` 两列后又将整个估值塞进单价更贵的 `completion`(`openai_compat.py:146`),形成双重系统性高估:实测算例 26 倍。
|
||||||
|
- **第二个症状**: `types.py:125` 的 `tpm > 0 ⇒ est_tokens > 0` 把供应商配额(可从配额页抄)与库的实现细节(无人能正确取值)绑死,下游删掉猜测项后 `tpm` 只能填 0,被迫在自己配置模型里加校验绕开。
|
||||||
|
- **方案(两个决策点,人类审批)**: ① usage 不可得时记 `0/0` + `usage_source` 新增 `unavailable` + cost 记 NULL;② `est_tokens` 未填时由库派生 `tpm // 60`,字段降为可选调优覆盖(不删不改名,迁移兼容)。
|
||||||
|
- **值域三态各有生产者**: `measured`(正常)、`estimated`(打捞路径——收到 usage 帧但流被截断,数字真实而可信度降级)、`unavailable`(用量不可得)。故 `estimated` 不是空值域,历史行亦读兼容。
|
||||||
|
- **被否决 · usage 兜底记 0 但沿用 `estimated`**: cost 会算出 `0.0`,"免费"与"未知"在数据上不可区分,账目缺口无法量化。
|
||||||
|
- **被否决 · 保留 est 兜底只修 prompt/completion 分配比例**: 比例是又一个没有正确取值的魔数,且未触及"拿上界当实测"的根因,仍高估约 9 倍。
|
||||||
|
- **被否决 · 固定默认常量(如 1000)**: 与配额规模无关,在途上限随规模乱飘(`tpm=6000` 只剩 6 个在途、`tpm=600000` 放行 600 个)。派生值尺度无关且语义可文档化("一次调用约占一秒钟的配额份额")。
|
||||||
|
- **被否决 · issue 原建议的遥测 p90 自估**: `TelemetryRecorder` 是纯只写端口,自估需新增读接口并强制所有后端(含 `none`)实现,公共 API 扩张远大于它要省掉的一个可选字段,且无实测证据表明派生默认值不够用。**注**: 初稿曾以"把两条方向相反的降级铁律焊在一起"为主论据,经独立审查撤回——p90 可在遥测读失败时回退纯派生值,限流侧仍能 fail-closed。
|
||||||
|
- **被否决 · 派生逻辑取全局与单源 tpm 的较紧者**: 需改三处 `QuotaGate` 装配,且它修的是一个**既有**缺口(单源 `tpm=0` 而全局 `tpm>0` 时预扣为 0),属任务外,建议另开 issue。
|
||||||
|
- **有意放弃的迁移保留项**: `migrations/chsanalyzer.md:151` 曾把"usage 缺失按 est 估算"列为保留(理由"保守计量")。本设计推翻:CHS 只记单个 `total_tokens` 不存在分配问题,而"保守"在计费语境只有错误一个方向。反静默的原始意图仍保留——被放弃的只是"编一个数字"这个手段。
|
||||||
|
- **独立审查(两轮)抓出的两处实质缺陷**: ① 只改失败侧结算不够,`retry.py:338`/`embedding.py:271` 的**成功侧**取自同一返回值,改前 `actual` 恰等于预扣量使 `delta==0`,不同改则成功调用押金被整笔退回,对"从不回 usage 帧的网关源"构成系统性 TPM 失效;② OCR 行原判为"假陈述"是错的——`types.py:51` 与 `ocr.py:9` 明示 OCR 的 0 token 属**事实**,且改标 `unavailable` 会灌水本方案赖以成立的缺口度量,已剔出。
|
||||||
|
- **待办**: 经 `writing-plans` 出实施计划;发版须同步 CHANGELOG 与 wiki(缺口查询口径须带 `AND cache_hit = false`),并回帖 issue #2。
|
||||||
@@ -0,0 +1,40 @@
|
|||||||
|
---
|
||||||
|
type: design
|
||||||
|
node_id: design:response-observability-fields
|
||||||
|
title: "响应可观测字段扩展(Issue #3)"
|
||||||
|
date: 2026-07-31
|
||||||
|
---
|
||||||
|
|
||||||
|
# 响应可观测字段扩展(Issue #3)
|
||||||
|
|
||||||
|
全文见 `2026-07-31-response-observability-fields-design.md`。来源: Gitea Issue #3(下游 dissect 的调用审计需求)。
|
||||||
|
|
||||||
|
## 选定方案
|
||||||
|
|
||||||
|
| 决策 | 选定 | 关键理由 |
|
||||||
|
|---|---|---|
|
||||||
|
| A 采集路径 | `TransportResult` 追加 `cached_prompt_tokens` / `model_reported` 强类型字段,解析留在 `openai_compat.py` | OpenAI 报文格式知识不出 `transports/`,middleware 只做搬运(P7) |
|
||||||
|
| B 缓存命中语义 | 原样回放;度量口径必须带 `cache_hit = false` | 与 `_rehydrate` 既有口径一致——它只覆写时序字段,`model`/`prompt_tokens` 全回放 |
|
||||||
|
| C 缓存单价 | `ModelPrice` 加可选 `cached_input_per_1m`,`cost()` 加可选参 | 旧价格表与 `embedding.py:419` 三参调用零改动;未配置该档时**不猜折扣率**,退化为全额计价 |
|
||||||
|
| D 遥测扩列 | 端口 18 → 20 字段;DDL 加列 + 初始化期幂等补列 | `CREATE TABLE IF NOT EXISTS` 不会给旧库补列,INSERT 会**逐行 warning 丢弃**——遥测全失却无硬失败提示 |
|
||||||
|
|
||||||
|
## 被否决的备选
|
||||||
|
|
||||||
|
| 备选 | 否决原因 |
|
||||||
|
|---|---|
|
||||||
|
| A1 往 `raw` 里塞约定键 | `dict[str, Any]` 沦为隐式契约,且 middleware 要懂 OpenAI 嵌套结构 |
|
||||||
|
| A3 middleware 内解析 raw | 报文格式知识进 middleware,新增非 OpenAI 兼容 transport 时会分叉,违反分层 |
|
||||||
|
| B2 命中时置 None / B3 混合 | 与同层 `prompt_tokens` 的回放行为不一致,下游要记两套规则 |
|
||||||
|
| C2 `cost()` 直接收 `LLMResponse` | `pricing.py` 会反向依赖 `types.py`,且纯函数难单测 |
|
||||||
|
| D2 只改 DDL、文档写「删表重建」 | 已建表的开发机/下游只会看到降级 warning,排查成本高 |
|
||||||
|
| D3 引入 alembic 迁移框架 | 新增依赖违反「依赖极简」铁律,规模严重不匹配 |
|
||||||
|
|
||||||
|
## 独立审查修正(2026-07-31)
|
||||||
|
|
||||||
|
Codex CLI 安装损坏(vendor 二进制缺失),改由全新上下文的 Claude subagent 审。三条问题全部核实属实并已折回设计:
|
||||||
|
|
||||||
|
1. PG 缺列时**不是**结构性短路,而是逐行 warning(`_failed` 仅在 `_ensure_ready` 置位)。
|
||||||
|
2. SQLite 补列若塞进 `__init__` 现有 try,异常会让 `_conn` 停在 `None` → recorder 永久 no-op。已定纪律: 独立 try、置于 `self._conn = conn` 之后、duplicate column 视为成功。
|
||||||
|
3. 「端口无默认值 → 漏改即报错」不成立(无 mypy,8 个 fake 全是 `**fields`)。改为新增「emitter 实参键集合 == `_COLUMNS`」契约测试兜底——否则 `KeyError` 会被 `_record` 的 `except Exception` 吞成 warning,静默丢遥测。
|
||||||
|
|
||||||
|
相关: [[m1-core-design]]、[[est-tokens-decoupling]]
|
||||||
@@ -100,6 +100,26 @@
|
|||||||
"id": "design:settings-invariants-round-2",
|
"id": "design:settings-invariants-round-2",
|
||||||
"label": "GatewaySettings 装配校验补齐(第二轮)",
|
"label": "GatewaySettings 装配校验补齐(第二轮)",
|
||||||
"type": "design"
|
"type": "design"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "design:est-tokens-decoupling",
|
||||||
|
"label": "est_tokens 解耦: 拆分限流预扣与遥测用量兜底(issue #2)",
|
||||||
|
"type": "design"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "plan:est-tokens-decoupling",
|
||||||
|
"label": "est_tokens 解耦实施计划",
|
||||||
|
"type": "plan"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "design:response-observability-fields",
|
||||||
|
"label": "响应可观测字段扩展(Issue #3)",
|
||||||
|
"type": "design"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "plan:response-observability-fields",
|
||||||
|
"label": "响应可观测字段扩展实现计划",
|
||||||
|
"type": "plan"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"links": [
|
"links": [
|
||||||
@@ -165,6 +185,27 @@
|
|||||||
"relation": "implements",
|
"relation": "implements",
|
||||||
"evidence": "T0-T14 逐节实现设计 §4-§10/§15",
|
"evidence": "T0-T14 逐节实现设计 §4-§10/§15",
|
||||||
"added": "2026-07-22T09:33:05.357964+00:00"
|
"added": "2026-07-22T09:33:05.357964+00:00"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"source": "design:est-tokens-decoupling",
|
||||||
|
"target": "design:m1-core-design",
|
||||||
|
"relation": "refines",
|
||||||
|
"evidence": "精化 M1 冻结的 est_tokens 双职责语义: 保留 TPM 预扣、推翻 usage 缺失按 est 兜底(m1-core-design.md:59,222),改记 0/0 + unavailable + cost NULL",
|
||||||
|
"added": "2026-07-30T09:33:55.383401+00:00"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"source": "plan:est-tokens-decoupling",
|
||||||
|
"target": "design:est-tokens-decoupling",
|
||||||
|
"relation": "implements",
|
||||||
|
"evidence": "5 任务实现设计 §3.2 的 11 条改动项;任务排序经中间态破窗分析(先加能力→切调用点→三态生效→解绑约束)",
|
||||||
|
"added": "2026-07-30T09:39:26.442986+00:00"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"source": "plan:response-observability-fields",
|
||||||
|
"target": "design:response-observability-fields",
|
||||||
|
"relation": "implements",
|
||||||
|
"evidence": "计划 T1-T7 逐条实现设计的 A2/B1/C1/D1 四个决策",
|
||||||
|
"added": "2026-07-31T11:10:03.872049+00:00"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
+12
-4
@@ -1,15 +1,18 @@
|
|||||||
# Research Wiki 索引
|
# Research Wiki 索引
|
||||||
|
|
||||||
> 自动生成,更新时间:2026-07-30 04:44 UTC
|
> 自动生成,更新时间:2026-07-31 12:25 UTC
|
||||||
|
|
||||||
## design (14)
|
## design (18)
|
||||||
- [2026-07-20-m1-core-design](designs/2026-07-20-m1-core-design.md) `design:2026-07-20-m1-core-design`
|
- [2026-07-20-m1-core-design](designs/2026-07-20-m1-core-design.md) `design:2026-07-20-m1-core-design`
|
||||||
- [2026-07-20-m2-distributed-design](designs/2026-07-20-m2-distributed-design.md) `design:2026-07-20-m2-distributed-design`
|
- [2026-07-20-m2-distributed-design](designs/2026-07-20-m2-distributed-design.md) `design:2026-07-20-m2-distributed-design`
|
||||||
- [2026-07-21-m25-resilience-design](designs/2026-07-21-m25-resilience-design.md) `design:2026-07-21-m25-resilience-design`
|
- [2026-07-21-m25-resilience-design](designs/2026-07-21-m25-resilience-design.md) `design:2026-07-21-m25-resilience-design`
|
||||||
- [2026-07-21-m3-ocr-design](designs/2026-07-21-m3-ocr-design.md) `design:2026-07-21-m3-ocr-design`
|
- [2026-07-21-m3-ocr-design](designs/2026-07-21-m3-ocr-design.md) `design:2026-07-21-m3-ocr-design`
|
||||||
- [2026-07-22-m4-migration-design](designs/2026-07-22-m4-migration-design.md) `design:2026-07-22-m4-migration-design`
|
- [2026-07-22-m4-migration-design](designs/2026-07-22-m4-migration-design.md) `design:2026-07-22-m4-migration-design`
|
||||||
- [2026-07-29-settings-invariant-guards-design](designs/2026-07-29-settings-invariant-guards-design.md) `design:2026-07-29-settings-invariant-guards-design`
|
- [2026-07-29-settings-invariant-guards-design](designs/2026-07-29-settings-invariant-guards-design.md) `design:2026-07-29-settings-invariant-guards-design`
|
||||||
|
- [2026-07-30-est-tokens-decoupling-design](designs/2026-07-30-est-tokens-decoupling-design.md) `design:2026-07-30-est-tokens-decoupling-design`
|
||||||
- [2026-07-30-settings-invariants-round-2-design](designs/2026-07-30-settings-invariants-round-2-design.md) `design:2026-07-30-settings-invariants-round-2-design`
|
- [2026-07-30-settings-invariants-round-2-design](designs/2026-07-30-settings-invariants-round-2-design.md) `design:2026-07-30-settings-invariants-round-2-design`
|
||||||
|
- [2026-07-31-response-observability-fields-design](designs/2026-07-31-response-observability-fields-design.md) `design:2026-07-31-response-observability-fields-design`
|
||||||
|
- [est_tokens 解耦: 拆分限流预扣与遥测用量兜底(issue #2)](designs/est-tokens-decoupling.md) `design:est-tokens-decoupling`
|
||||||
- [GatewaySettings 装配校验补齐(第二轮)](designs/settings-invariants-round-2.md) `design:settings-invariants-round-2`
|
- [GatewaySettings 装配校验补齐(第二轮)](designs/settings-invariants-round-2.md) `design:settings-invariants-round-2`
|
||||||
- [GatewaySettings 跨字段不变量守卫的生效范围](designs/settings-invariant-guards.md) `design:settings-invariant-guards`
|
- [GatewaySettings 跨字段不变量守卫的生效范围](designs/settings-invariant-guards.md) `design:settings-invariant-guards`
|
||||||
- [M1 核心里程碑设计:公共签名冻结与治理栈落地](designs/m1-core-design.md) `design:m1-core-design`
|
- [M1 核心里程碑设计:公共签名冻结与治理栈落地](designs/m1-core-design.md) `design:m1-core-design`
|
||||||
@@ -17,6 +20,7 @@
|
|||||||
- [M2.5 治理韧性: 半死源隔离与健康感知调度](designs/m25-resilience.md) `design:m25-resilience`
|
- [M2.5 治理韧性: 半死源隔离与健康感知调度](designs/m25-resilience.md) `design:m25-resilience`
|
||||||
- [M3 OCR 端口族设计](designs/m3-ocr.md) `design:m3-ocr`
|
- [M3 OCR 端口族设计](designs/m3-ocr.md) `design:m3-ocr`
|
||||||
- [M4 迁移验证设计(GovDoc→CHS,发 v1.0)](designs/m4-migration.md) `design:m4-migration`
|
- [M4 迁移验证设计(GovDoc→CHS,发 v1.0)](designs/m4-migration.md) `design:m4-migration`
|
||||||
|
- [响应可观测字段扩展(Issue #3)](designs/response-observability-fields.md) `design:response-observability-fields`
|
||||||
|
|
||||||
## finding (11)
|
## finding (11)
|
||||||
- [2026-07-20-m2-soak-workload](findings/2026-07-20-m2-soak-workload.md) `finding:2026-07-20-m2-soak-workload`
|
- [2026-07-20-m2-soak-workload](findings/2026-07-20-m2-soak-workload.md) `finding:2026-07-20-m2-soak-workload`
|
||||||
@@ -31,20 +35,24 @@
|
|||||||
- [P6 混合浸泡首跑基线与记分板三重伪击穿修复](findings/p6-soak-baseline.md) `finding:p6-soak-baseline`
|
- [P6 混合浸泡首跑基线与记分板三重伪击穿修复](findings/p6-soak-baseline.md) `finding:p6-soak-baseline`
|
||||||
- [P7 OCR soak 验收: 99.73% 与 13 不变量全 PASS](findings/p7-ocr-soak.md) `finding:p7-ocr-soak`
|
- [P7 OCR soak 验收: 99.73% 与 13 不变量全 PASS](findings/p7-ocr-soak.md) `finding:p7-ocr-soak`
|
||||||
|
|
||||||
## plan (10)
|
## plan (14)
|
||||||
- [2026-07-20-m1-core-plan](plans/2026-07-20-m1-core-plan.md) `plan:2026-07-20-m1-core-plan`
|
- [2026-07-20-m1-core-plan](plans/2026-07-20-m1-core-plan.md) `plan:2026-07-20-m1-core-plan`
|
||||||
- [2026-07-20-m2-distributed-plan](plans/2026-07-20-m2-distributed-plan.md) `plan:2026-07-20-m2-distributed-plan`
|
- [2026-07-20-m2-distributed-plan](plans/2026-07-20-m2-distributed-plan.md) `plan:2026-07-20-m2-distributed-plan`
|
||||||
- [2026-07-21-m25-resilience-plan](plans/2026-07-21-m25-resilience-plan.md) `plan:2026-07-21-m25-resilience-plan`
|
- [2026-07-21-m25-resilience-plan](plans/2026-07-21-m25-resilience-plan.md) `plan:2026-07-21-m25-resilience-plan`
|
||||||
- [2026-07-21-m3-ocr-plan](plans/2026-07-21-m3-ocr-plan.md) `plan:2026-07-21-m3-ocr-plan`
|
- [2026-07-21-m3-ocr-plan](plans/2026-07-21-m3-ocr-plan.md) `plan:2026-07-21-m3-ocr-plan`
|
||||||
- [2026-07-22-m4-migration-plan](plans/2026-07-22-m4-migration-plan.md) `plan:2026-07-22-m4-migration-plan`
|
- [2026-07-22-m4-migration-plan](plans/2026-07-22-m4-migration-plan.md) `plan:2026-07-22-m4-migration-plan`
|
||||||
|
- [2026-07-30-est-tokens-decoupling-plan](plans/2026-07-30-est-tokens-decoupling-plan.md) `plan:2026-07-30-est-tokens-decoupling-plan`
|
||||||
|
- [2026-07-31-response-observability-fields](plans/2026-07-31-response-observability-fields.md) `plan:2026-07-31-response-observability-fields`
|
||||||
|
- [est_tokens 解耦实施计划](plans/est-tokens-decoupling.md) `plan:est-tokens-decoupling`
|
||||||
- [M1 核心里程碑实现计划](plans/m1-core-plan.md) `plan:m1-core-plan`
|
- [M1 核心里程碑实现计划](plans/m1-core-plan.md) `plan:m1-core-plan`
|
||||||
- [M2 分布式实现计划](plans/m2-distributed.md) `plan:m2-distributed`
|
- [M2 分布式实现计划](plans/m2-distributed.md) `plan:m2-distributed`
|
||||||
- [M2.5 治理韧性实现计划](plans/m25-resilience.md) `plan:m25-resilience`
|
- [M2.5 治理韧性实现计划](plans/m25-resilience.md) `plan:m25-resilience`
|
||||||
- [M3 OCR 实现计划](plans/m3-ocr.md) `plan:m3-ocr`
|
- [M3 OCR 实现计划](plans/m3-ocr.md) `plan:m3-ocr`
|
||||||
- [M4 迁移实现计划(T0-T14)](plans/m4-migration.md) `plan:m4-migration`
|
- [M4 迁移实现计划(T0-T14)](plans/m4-migration.md) `plan:m4-migration`
|
||||||
|
- [响应可观测字段扩展实现计划](plans/response-observability-fields.md) `plan:response-observability-fields`
|
||||||
|
|
||||||
## schema (1)
|
## schema (1)
|
||||||
- [表结构: llm_calls(遥测 18 字段)](schemas/llm-calls.md) `schema:llm-calls`
|
- [表结构: llm_calls(遥测 20 字段)](schemas/llm-calls.md) `schema:llm-calls`
|
||||||
|
|
||||||
## metric (2)
|
## metric (2)
|
||||||
- [OCR 治理调用成功率与错误分类分布](metrics/ocr-call-success.md) `metric:ocr-call-success`
|
- [OCR 治理调用成功率与错误分类分布](metrics/ocr-call-success.md) `metric:ocr-call-success`
|
||||||
|
|||||||
@@ -50,3 +50,17 @@
|
|||||||
- [2026-07-30 03:44 UTC] 重建索引: 36 篇页面
|
- [2026-07-30 03:44 UTC] 重建索引: 36 篇页面
|
||||||
- [2026-07-30 04:44 UTC] 新增 design: GatewaySettings 装配校验补齐(第二轮) (design:settings-invariants-round-2)
|
- [2026-07-30 04:44 UTC] 新增 design: GatewaySettings 装配校验补齐(第二轮) (design:settings-invariants-round-2)
|
||||||
- [2026-07-30 04:44 UTC] 重建索引: 38 篇页面
|
- [2026-07-30 04:44 UTC] 重建索引: 38 篇页面
|
||||||
|
- [2026-07-30 09:32 UTC] 新增 design: est_tokens 解耦: 拆分限流预扣与遥测用量兜底(issue #2) (design:est-tokens-decoupling)
|
||||||
|
- [2026-07-30 09:33 UTC] 重建索引: 40 篇页面
|
||||||
|
- [2026-07-30 09:33 UTC] 新增边: design:est-tokens-decoupling --refines--> design:m1-core-design
|
||||||
|
- [2026-07-30 09:33 UTC] 重建索引: 40 篇页面
|
||||||
|
- [2026-07-30 09:39 UTC] 新增 plan: est_tokens 解耦实施计划 (plan:est-tokens-decoupling)
|
||||||
|
- [2026-07-30 09:39 UTC] 新增边: plan:est-tokens-decoupling --implements--> design:est-tokens-decoupling
|
||||||
|
- [2026-07-30 09:39 UTC] 重建索引: 42 篇页面
|
||||||
|
- [2026-07-31 08:35 UTC] 新增 design: 响应可观测字段扩展(Issue #3) (design:response-observability-fields)
|
||||||
|
- [2026-07-31 08:37 UTC] 重建索引: 44 篇页面
|
||||||
|
- [2026-07-31 11:10 UTC] 新增 plan: 响应可观测字段扩展实现计划 (plan:response-observability-fields)
|
||||||
|
- [2026-07-31 11:10 UTC] 新增边: plan:response-observability-fields --implements--> design:response-observability-fields
|
||||||
|
- [2026-07-31 11:10 UTC] 重建索引: 46 篇页面
|
||||||
|
- [2026-07-31 11:11 UTC] 重建索引: 46 篇页面
|
||||||
|
- [2026-07-31 12:25 UTC] 重建索引: 46 篇页面
|
||||||
|
|||||||
@@ -92,7 +92,7 @@
|
|||||||
|
|
||||||
| 项目键(.env.example 实测) | 库对应 | 差异 |
|
| 项目键(.env.example 实测) | 库对应 | 差异 |
|
||||||
|---|---|---|
|
|---|---|---|
|
||||||
| `{SCOPE}__{PROVIDER}__{N}__{FIELD}` | 同名继承 | 无;`EST_TOKENS` 见 ⚠️ G2 |
|
| `{SCOPE}__{PROVIDER}__{N}__{FIELD}` | 同名继承 | 无;`EST_TOKENS` 键保留不改名,但 2026-07-30 起由必填降为可选(G2 已闭,详见该行) |
|
||||||
| `{SCOPE}__GLOBAL__MAX_CONCURRENCY/RPM/TPM`(config.py:249-271) | 全局闸限额 | ARCH §9 未定义 GLOBAL 段命名,M2 设计须定(建议原样继承) |
|
| `{SCOPE}__GLOBAL__MAX_CONCURRENCY/RPM/TPM`(config.py:249-271) | 全局闸限额 | ARCH §9 未定义 GLOBAL 段命名,M2 设计须定(建议原样继承) |
|
||||||
| `{SCOPE}__SELECTOR`(round_robin/least_inflight) | `SourceSelector` 策略选择 | 命名待 M1/M2 定稿,建议继承 |
|
| `{SCOPE}__SELECTOR`(round_robin/least_inflight) | `SourceSelector` 策略选择 | 命名待 M1/M2 定稿,建议继承 |
|
||||||
| `{SCOPE}__RETRY__MAX_ATTEMPTS/BACKOFF_BASE_S/BACKOFF_MAX_S` | RetryPolicy | ⚠️ G4:ARCH §9 只列平铺 `LLM_MAX_RETRIES` 等键,无 per-scope 形态 |
|
| `{SCOPE}__RETRY__MAX_ATTEMPTS/BACKOFF_BASE_S/BACKOFF_MAX_S` | RetryPolicy | ⚠️ G4:ARCH §9 只列平铺 `LLM_MAX_RETRIES` 等键,无 per-scope 形态 |
|
||||||
@@ -148,7 +148,7 @@ stack = ExtractionProviderStack(
|
|||||||
| Retry-After 仅支持秒数形态(invokers.py:127-141) | HTTP-date 返回 None | **有意放弃** date 形态(ARCH §6.2 同款) |
|
| Retry-After 仅支持秒数形态(invokers.py:127-141) | HTTP-date 返回 None | **有意放弃** date 形态(ARCH §6.2 同款) |
|
||||||
| 429 body 细分 insufficient_quota → SourceDead(invokers.py:144-166) | 欠费≠限流 | **保留**(ARCH §6.1 已承诺) |
|
| 429 body 细分 insufficient_quota → SourceDead(invokers.py:144-166) | 欠费≠限流 | **保留**(ARCH §6.1 已承诺) |
|
||||||
| 零 content 提前结束 → Transient "early_eof";有 content 缺 [DONE] → 打捞并埋点 "missing_done"(invokers.py:306-313) | 线路级异常定性(D2 的核心价值) | **保留** |
|
| 零 content 提前结束 → Transient "early_eof";有 content 缺 [DONE] → 打捞并埋点 "missing_done"(invokers.py:306-313) | 线路级异常定性(D2 的核心价值) | **保留** |
|
||||||
| usage 缺失按 est_tokens 估算并标 `estimated`,不静默用 0(invokers.py:241-254) | 保守计量 | **保留**(`usage_source` 已进 ARCH §5.1;依赖 G2) |
|
| usage 缺失按 est_tokens 估算并标 `estimated`,不静默用 0(invokers.py:241-254) | 保守计量 | **有意放弃**(2026-07-30 推翻原"保留"判定,est_tokens 解耦设计 §4)。理由:CHS 只记单个 `total_tokens`,不存在 prompt/completion 分配问题;库拆成两列后无法忠实分配,而 `est_tokens` 按 CHS 自身定义(config.py:55)是**最坏情形上界**——"保守"在限流语境安全(押多了只是慢),在计费语境只有虚高一个方向。库改为如实记 `0/0` + `usage_source="unavailable"` + cost NULL(ARCH §5.1)。**"不静默用 0"的原始意图完整保留**:被放弃的只是"编一个数字"这个手段,缺失依然有显式标注且可被 `WHERE usage_source='unavailable' AND cache_hit = false` 量化 |
|
||||||
| reasoning_content 刷新活性但不计入结果;ttft=首个任意 token(invokers.py:55-79, 336-364) | 防 thinking 模型被看门狗误杀 | **替换+增强**:库把 thinking 收进 `LLMResponse.thinking`(不再丢弃);活性语义必须保留(反向约束 M1) |
|
| reasoning_content 刷新活性但不计入结果;ttft=首个任意 token(invokers.py:55-79, 336-364) | 防 thinking 模型被看门狗误杀 | **替换+增强**:库把 thinking 收进 `LLMResponse.thinking`(不再丢弃);活性语义必须保留(反向约束 M1) |
|
||||||
| enable_thinking=True 不注入参数、False 注入关闭参数(invokers.py:230-238) | 与 D11 注册表"声明注入方式"方向相反 | **替换**(provider 注册表须支持"注入关闭参数"形态) |
|
| enable_thinking=True 不注入参数、False 注入关闭参数(invokers.py:230-238) | 与 D11 注册表"声明注入方式"方向相反 | **替换**(provider 注册表须支持"注入关闭参数"形态) |
|
||||||
| 图片 magic bytes 探测,非 PNG/JPEG 抛 RequestRejected(invokers.py:116-123) | 本地快速拒绝 | **保留**(移入库 transport) |
|
| 图片 magic bytes 探测,非 PNG/JPEG 抛 RequestRejected(invokers.py:116-123) | 本地快速拒绝 | **保留**(移入库 transport) |
|
||||||
@@ -182,7 +182,7 @@ stack = ExtractionProviderStack(
|
|||||||
| R5 | RequestRejected 二分(真实响应记成功/本地拒绝释放探针);换源重试跨源计数口径 | M2 | 须进 M2 设计 |
|
| R5 | RequestRejected 二分(真实响应记成功/本地拒绝释放探针);换源重试跨源计数口径 | M2 | 须进 M2 设计 |
|
||||||
| R6 | OCR ZIP 协议 + bbox 数值防御下沉;OCR Usage=0;glm 白名单预留 | M3 | §7.10 已覆盖 |
|
| R6 | OCR ZIP 协议 + bbox 数值防御下沉;OCR Usage=0;glm 白名单预留 | M3 | §7.10 已覆盖 |
|
||||||
| **G1** | ✅ 已闭(M3 核实): 库 `GatewayUnavailableError` 一族自 M1 起携 `scope/reason/retry_after_s/per_source_reasons`(errors.py:74-105),chat/embedding/OCR 三循环抛出点均已填充且有契约测试钉住;项目侧仅剩约 10 行翻译 shim(库异常 → ProviderUnavailableError)或 tracking.py 直接 except 库异常 | M2 | 已闭 |
|
| **G1** | ✅ 已闭(M3 核实): 库 `GatewayUnavailableError` 一族自 M1 起携 `scope/reason/retry_after_s/per_source_reasons`(errors.py:74-105),chat/embedding/OCR 三循环抛出点均已填充且有契约测试钉住;项目侧仅剩约 10 行翻译 shim(库异常 → ProviderUnavailableError)或 tracking.py 直接 except 库异常 | M2 | 已闭 |
|
||||||
| **G2** | ⚠️ `est_tokens`(TPM 预扣常量 + usage 缺失兜底,config.py:55)不在 ARCH §7.7 SourceConfig 字段清单;§7.3 `try_acquire(source, est_tokens)` 的 est 来源未定义 | M2 | **架构缺口**,修订 §7.7 |
|
| **G2** | ✅ 已闭(2026-07-30 核实): `est_tokens` 已进 ARCH §7.7 SourceConfig 字段清单,且 §7.3 `try_acquire` 的 est 来源已定义为 `SourceConfig.effective_est_tokens()`(显式值优先,否则按 `tpm // 60` 派生)。双职责一并拆开:该字段只剩 TPM 预扣的可选调优覆盖,usage 缺失不再由它兜底(见 §7 行 151 的推翻判定) | M2 | 已闭 |
|
||||||
| **G3** | ⚠️ §4.3 层序图文矛盾:图示 熔断→限流→重试(重试最内),但理由要求"每次重试重新过限流闸"且熔断/限流是 per-source 的、选源在重试循环内(governance.py:120-167 实践为每次尝试执行 选源→冷却备忘→permit→熔断门)。洋葱不澄清"逐次准入"机制则多源语义无法成立 | M2 | **架构缺口**,澄清 §4.3/§4.4 |
|
| **G3** | ⚠️ §4.3 层序图文矛盾:图示 熔断→限流→重试(重试最内),但理由要求"每次重试重新过限流闸"且熔断/限流是 per-source 的、选源在重试循环内(governance.py:120-167 实践为每次尝试执行 选源→冷却备忘→permit→熔断门)。洋葱不澄清"逐次准入"机制则多源语义无法成立 | M2 | **架构缺口**,澄清 §4.3/§4.4 |
|
||||||
| **G4** | ⚠️ per-scope 韧性配置命名(`{SCOPE}__RETRY__*`/`BREAKER__*`/`BACKPRESSURE__*`/`SELECTOR`/`GLOBAL__*`)未进 ARCH §9,现文只有平铺 `LLM_*` 键;CHSAnalyzer 的 VLM/OCR 两 scope 参数各异,平铺键无法表达 | M2 | **架构缺口**,修订 §9 |
|
| **G4** | ⚠️ per-scope 韧性配置命名(`{SCOPE}__RETRY__*`/`BREAKER__*`/`BACKPRESSURE__*`/`SELECTOR`/`GLOBAL__*`)未进 ARCH §9,现文只有平铺 `LLM_*` 键;CHSAnalyzer 的 VLM/OCR 两 scope 参数各异,平铺键无法表达 | M2 | **架构缺口**,修订 §9 |
|
||||||
| **G5** | ⚠️ 半开探针租约 TTL(探针持有者死亡后 TTL 过期自动可再探,scripts.py:96-105)与 `release_probe` 操作未见于 ARCH §7.4(只写单探针/epoch fencing);缺失则探针死锁 | M2 | **架构缺口**,修订 §7.4 |
|
| **G5** | ⚠️ 半开探针租约 TTL(探针持有者死亡后 TTL 过期自动可再探,scripts.py:96-105)与 `release_probe` 操作未见于 ARCH §7.4(只写单探针/epoch fencing);缺失则探针死锁 | M2 | **架构缺口**,修订 §7.4 |
|
||||||
|
|||||||
@@ -130,7 +130,7 @@ loop = AgentLoop(client, max_steps=...,
|
|||||||
| B10 | 缓存命中也记遥测(cache_hit=True, latency_ms=0)(client.py:309-331);每次 attempt 独立 call_id(client.py:337);thinking 帧 content 优先于 reasoning_content(client.py:79-91) | **保留**(库同款语义) |
|
| B10 | 缓存命中也记遥测(cache_hit=True, latency_ms=0)(client.py:309-331);每次 attempt 独立 call_id(client.py:337);thinking 帧 content 优先于 reasoning_content(client.py:79-91) | **保留**(库同款语义) |
|
||||||
| B11 | SSE 流提前断开且未见 `[DONE]` 时正常返回:`usage_sink["done"]` 写入后无人检查(client.py:115-117),截断响应被当成功**并写入缓存** | **修复**: 库把"断流无 [DONE]"定性 TransientError(§6.1),且坏结果不进缓存 |
|
| B11 | SSE 流提前断开且未见 `[DONE]` 时正常返回:`usage_sink["done"]` 写入后无人检查(client.py:115-117),截断响应被当成功**并写入缓存** | **修复**: 库把"断流无 [DONE]"定性 TransientError(§6.1),且坏结果不进缓存 |
|
||||||
| B12 | provider 差异靠字符串猜: `"deepseek" in provider`/`"qwen" in provider` 注入 thinking 参数(client.py:139-144)、`<think>` 剥离(client.py:348) | **替换**: provider 注册表(D11) |
|
| B12 | provider 差异靠字符串猜: `"deepseek" in provider`/`"qwen" in provider` 注入 thinking 参数(client.py:139-144)、`<think>` 剥离(client.py:348) | **替换**: provider 注册表(D11) |
|
||||||
| B13 | usage 帧缺失时 prompt/completion_tokens 落 0(client.py:354-355),无标注 | **升级**: 库 `usage_source=measured/estimated` |
|
| B13 | usage 帧缺失时 prompt/completion_tokens 落 0(client.py:354-355),无标注 | **升级**: 库 `usage_source` 三态 `measured/estimated/unavailable`(2026-07-30 est_tokens 解耦后由两态扩为三态)。GovDoc 原行为"落 0 且无标注"中的落 0 反而与库一致,被升级的是**标注**:缺失行记 `unavailable` 且 cost 为 NULL,缺口可被 `WHERE usage_source='unavailable' AND cache_hit = false` 量化 |
|
||||||
| B14 | 遥测 schema 无 source_name/cost/usage_source(telemetry_sqlite.py:29-48) | **升级**: 库超集 schema;GovDoc 骨架期无生产遥测数据,直接换新库文件,不做数据迁移 |
|
| B14 | 遥测 schema 无 source_name/cost/usage_source(telemetry_sqlite.py:29-48) | **升级**: 库超集 schema;GovDoc 骨架期无生产遥测数据,直接换新库文件,不做数据迁移 |
|
||||||
| B15 | 双层重试: 治理层 max_retries + AgentLoop 步级 step_retries(loop.py:308-356,默认延迟 (20,40)s) | **有意保留**(业务侧任务级重试,ARCHITECTURE §7.2 允许留在库外),但须按 §4 改 retryable_exceptions,否则静默失效 |
|
| B15 | 双层重试: 治理层 max_retries + AgentLoop 步级 step_retries(loop.py:308-356,默认延迟 (20,40)s) | **有意保留**(业务侧任务级重试,ARCHITECTURE §7.2 允许留在库外),但须按 §4 改 retryable_exceptions,否则静默失效 |
|
||||||
| B16 | `CancelledError` 穿透重试循环(client.py:396 `except Exception` 天然放行),取消的调用**不记遥测** | **保留**穿透;取消是否记遥测库未定义,见 §9-R6 |
|
| B16 | `CancelledError` 穿透重试循环(client.py:396 `except Exception` 天然放行),取消的调用**不记遥测** | **保留**穿透;取消是否记遥测库未定义,见 §9-R6 |
|
||||||
|
|||||||
@@ -0,0 +1,227 @@
|
|||||||
|
# est_tokens 解耦实施计划
|
||||||
|
|
||||||
|
- **目标**: 把 `SourceConfig.est_tokens` 的两个职责(TPM 入场预扣 / usage 缺失时的遥测用量兜底)拆开,并解绑 `tpm > 0 ⇒ est_tokens > 0` 装配约束。
|
||||||
|
- **方案概述**: usage 不可得时遥测记 `0/0` 并标新值 `unavailable`、cost 落 NULL(不再拿限流押金编计费数字);`est_tokens` 未填时由库按 `tpm // 60` 派生预扣量,字段降为可选调优覆盖(保留不删不改名)。全部依据已批准设计 `research-wiki/designs/2026-07-30-est-tokens-decoupling-design.md`,其 §3.2 的 11 条改动项已钉死行号。
|
||||||
|
- **涉及技术**: Python 3.11 frozen dataclass、pytest(含 `tests/contracts` 双后端契约测试)、真实 Redis(integration/contracts)、pydantic-settings 不涉及改动。
|
||||||
|
- **溯源**: Gitea issue #2;wiki 实体 `design:est-tokens-decoupling`。
|
||||||
|
|
||||||
|
## 1. 任务排序的硬约束(先读这节再动手)
|
||||||
|
|
||||||
|
三处改动互相牵制,**顺序错了会引入押金泄漏或计费造假**,且中间态不报错、只静默偏差:
|
||||||
|
|
||||||
|
| 若单独先做 | 后果 |
|
||||||
|
|---|---|
|
||||||
|
| 先改 usage 兜底为 `(0, 0)`,结算点还没切派生值 | 成功调用 `actual = 0` 而入场押了 `est_tokens`,`delta` 为负 → **押金整笔退回**,TPM 闸退化成进门即放行 |
|
||||||
|
| 先切入场(`ratelimit.py:26`)+ 解绑约束,而结算点还没切 | `est_tokens=0` 的源入场押派生值、结算退 0 → 同样泄漏。**注意机制**:若**只**解绑约束而 `ratelimit.py` 一行未动,后果不是泄漏而是入场**完全不预扣**(仍传 `est_tokens=0`)——那是设计 §2.2 已否决的"不预扣"退化形态。两者都要避免,故 T4 必须在 T2 之后 |
|
||||||
|
| 先改 `openai_compat.py:176` 而 `_merge` 还是二值逻辑 | embedding 的 `unavailable` 批被 `any(== "estimated")` 判 False 从而**误标 `measured`**,cost 照算 |
|
||||||
|
|
||||||
|
因此排序为:**先加能力(零行为变更)→ 再把所有调用点切到新能力(此时等价,因显式值优先)→ 再让三态生效 → 最后解绑约束**。Task 1-2 完成后行为逐字不变,Task 3 才是行为变更主体,Task 4 才让派生值真正启用。**不要合并或调换 Task 2 / 3 / 4 的顺序。**
|
||||||
|
|
||||||
|
## 2. 文件结构
|
||||||
|
|
||||||
|
| 文件 | 职责 | 涉及任务 |
|
||||||
|
|---|---|---|
|
||||||
|
| `src/polygateway/types.py` | 新增 `SourceConfig.effective_est_tokens()` 派生方法与 `usage_source` 三态值域常量;删除 `_validate_gates` 里的条件必填;修 `EmbeddingTransportResult` 行内注释 | T1、T3、T4 |
|
||||||
|
| `src/polygateway/middleware/ratelimit.py` | `QuotaGate.try_acquire` 入场预扣改用派生值 | T2 |
|
||||||
|
| `src/polygateway/middleware/retry.py` | 成功侧(`:338`)与失败侧(`:370`)结算改用派生值 | T2 |
|
||||||
|
| `src/polygateway/embedding.py` | 同上(`:271`/`:294`);`_merge` 三态合并;`_total_cost` 存在不可得批时整体 NULL | T2、T3 |
|
||||||
|
| `src/polygateway/transports/openai_compat.py` | 两处 usage 兜底改 `unavailable`;打捞覆盖加前置条件 | T3 |
|
||||||
|
| `src/polygateway/middleware/telemetry.py` | cost 短路(插在 `cache_hit` 之后);失败尝试与终态失败改标 `unavailable` | T3 |
|
||||||
|
| `src/polygateway/ocr.py` | **不改**(设计 §3.3 已剔出),仅加防回归测试 | T3 |
|
||||||
|
| `research-wiki/ARCHITECTURE.md` | §7.7 行 428、§5.1 行 331、§4.4 行 305、§7.1 行 384 | T5 |
|
||||||
|
| `research-wiki/migrations/chsanalyzer.md` | 行 151 保留项改判为有意放弃;G2(行 185)标注已解决 | T5 |
|
||||||
|
| `.env.example` | 行 11 删除"TPM > 0 时 EST_TOKENS 必填 > 0" | T5 |
|
||||||
|
| `CHANGELOG.md` | 行为变更小节(值域新增 + cost 口径 + 约束解绑) | T5 |
|
||||||
|
|
||||||
|
测试文件:`tests/unit/test_types.py`、`test_retry.py`、`test_openai_compat.py`、`test_telemetry.py`、`test_embedding.py`、`test_ocr_client.py`、`tests/contracts/test_limiter_contract.py`。
|
||||||
|
|
||||||
|
## 3. 保真校验
|
||||||
|
|
||||||
|
本计划**不新增**任何 `reference/` 移植代码,但触及 ARCHITECTURE §1.4 关键资产索引中的"遥测口径"与"限流结算",且**有意推翻**一条已声明保留的迁移行为(CHS `invokers.py:241-254` 的"usage 缺失按 est 估算",见设计 §4)。故设以下检查点,每个任务完成时逐条确认:
|
||||||
|
|
||||||
|
1. `Permit.settle()` 的"多退少补 + 幂等 flag"语义不得改变;`release()` 的 finally 必然执行不得改变。
|
||||||
|
2. **不得触碰** `backends/redis/limiter.py` 的 Lua 脚本与 `backends/memory/limiter.py` 的窗口/租约算法——本计划只改传入 `try_acquire` 的**数值来源**,不改闸门算法。
|
||||||
|
3. 不得改变 `errors.py` 四分类归属,不得新增运行时异常类型;值域违反不走异常路径(设计 §3.1 已裁决)。
|
||||||
|
4. `ocr.py` 的 `settle` 恒 0 与 `usage_source="measured"` 保持不变。
|
||||||
|
5. 遥测 18 字段冻结不变、无 DDL 变更(两 schema 的 `cost` 列已可空)。
|
||||||
|
|
||||||
|
## 4. 任务清单
|
||||||
|
|
||||||
|
### T1 — 加派生能力与值域常量(零行为变更)
|
||||||
|
|
||||||
|
- [x] **改** `src/polygateway/types.py`
|
||||||
|
|
||||||
|
新增模块级值域常量与 `SourceConfig` 方法。派生按**源自身 tpm**,全局 tpm 不参与(设计 §7 已声明为既有限制、本次不修):
|
||||||
|
|
||||||
|
```python
|
||||||
|
USAGE_SOURCES = frozenset({"measured", "estimated", "unavailable"})
|
||||||
|
"""usage_source 值域;仅约束库内生产侧取值,不在 frozen dataclass 上做运行时校验。"""
|
||||||
|
|
||||||
|
_EST_TOKENS_QUOTA_DIVISOR = 60
|
||||||
|
"""未显式配置时的预扣量除数: 假定一次调用约占一秒钟的 TPM 配额份额。"""
|
||||||
|
```
|
||||||
|
|
||||||
|
```python
|
||||||
|
def effective_est_tokens(self) -> int:
|
||||||
|
"""TPM 入场预扣量: 显式配置优先,否则按 tpm 派生(设计 §2.2)。"""
|
||||||
|
if self.est_tokens > 0:
|
||||||
|
return self.est_tokens
|
||||||
|
if self.tpm > 0:
|
||||||
|
return max(1, self.tpm // _EST_TOKENS_QUOTA_DIVISOR)
|
||||||
|
return 0
|
||||||
|
```
|
||||||
|
|
||||||
|
**验收标准**: 方法存在且为纯函数(不读全局、不 await);此任务**不修改任何调用点**,全库行为逐字不变。
|
||||||
|
|
||||||
|
**测试要求**(先失败后通过:方法不存在时 `AttributeError`)——`tests/unit/test_types.py`:
|
||||||
|
- `tpm=6000, est_tokens=0` → `100`;`tpm=600000, est_tokens=0` → `10000`(尺度无关:两者在途上限同为 60)
|
||||||
|
- `tpm=30, est_tokens=0` → `1`(下界不塌到 0)
|
||||||
|
- `tpm=0, est_tokens=0` → `0`(TPM 闸未启用,不预扣)
|
||||||
|
- `tpm=6000, est_tokens=4000` → `4000`(显式值优先于派生)
|
||||||
|
- `USAGE_SOURCES` 恰为三元集合
|
||||||
|
|
||||||
|
**值域封闭的两条实质断言**(设计 §6 要求;缺了它们 `USAGE_SOURCES` 会沦为零消费者的死常量,且 §3.1 的落点裁决无回归保护):
|
||||||
|
- **生产侧封闭**: 参数化覆盖库内全部 `usage_source` 生产点(`_resolve_usage`、`_resolve_embedding_usage`、`_merge`、`TelemetryEmitter.emit_*`),断言产出恒 ∈ `USAGE_SOURCES`。此断言在 T1 阶段即可写(此时产出仅 `measured`/`estimated`),T3 完成后自动覆盖 `unavailable`
|
||||||
|
- **不做运行时校验**: `LLMResponse(usage_source="garbage")` 构造**不抛异常**——锁定设计 §3.1 的裁决(公共 frozen dataclass 不加 `__post_init__` 值域校验,否则裸 `ValueError` 不属四分类、会逃出 `chat()`)。没有这条,后人很容易顺手补上校验而击穿 `chat()`
|
||||||
|
|
||||||
|
**验证**: `conda run --no-capture-output -n PolyGateway pytest tests/unit/test_types.py -v` → 全 PASS
|
||||||
|
|
||||||
|
### T2 — 五个调用点切到派生值(零行为变更)
|
||||||
|
|
||||||
|
此时 `est_tokens > 0` 仍是必填(约束未解绑),故 `effective_est_tokens()` 恒返回显式值,**行为与改前逐字相同**。这一步只是把数值来源换掉,为 T3 铺路。
|
||||||
|
|
||||||
|
- [x] **改** `src/polygateway/middleware/ratelimit.py:26` — `source.est_tokens` → `source.effective_est_tokens()`
|
||||||
|
- [x] **改** `src/polygateway/middleware/retry.py:370`(失败侧,`if not dead` 分支内)→ `source.effective_est_tokens()`
|
||||||
|
- [x] **改** `src/polygateway/embedding.py:294`(失败侧)→ 同上
|
||||||
|
- [x] **改** `src/polygateway/middleware/retry.py:338`(成功侧)— 加不可得分支:
|
||||||
|
|
||||||
|
```python
|
||||||
|
if result.usage_source == "unavailable":
|
||||||
|
actual = source.effective_est_tokens()
|
||||||
|
else:
|
||||||
|
actual = result.prompt_tokens + result.completion_tokens
|
||||||
|
```
|
||||||
|
|
||||||
|
- [x] **改** `src/polygateway/embedding.py:271`(成功侧)— 同构,`actual = result.prompt_tokens` 落在 else 分支。
|
||||||
|
|
||||||
|
`TransportResult.usage_source`(`types.py:75`)与 `EmbeddingTransportResult.usage_source`(`types.py:273`)均为必填字段,在这两处的 `result` 局部变量上直接可读。
|
||||||
|
|
||||||
|
**验收标准**: 五处均不再直接读 `source.est_tokens`;新分支在本任务中**永不触发**(尚无 `unavailable` 生产者),现有测试全绿即证明零行为变更。**不要**在本任务修改 `retry.py:329` 的 `actual = 0` 初值,也不要动 `RequestRejectedError`/`ResultInvalidError`/`SourceDeadError` 三条失败分支(设计 §3.3:它们的 `actual` 停在 0 属既有行为)。
|
||||||
|
|
||||||
|
**测试要求**(回归保护,先失败后通过不适用于零行为变更任务,故以"现有测试不得回归 + 新增等价性断言"为门):
|
||||||
|
- 新增 `tests/unit/test_retry.py`:`tpm=1000, est_tokens=400` 的源在 usage 正常返回时,settle 收到的 `actual` 等于实测 token 之和(锁定 else 分支);现有 `test_settle_uses_actual_usage` 必须继续通过
|
||||||
|
- `tests/contracts/test_limiter_contract.py` 全绿(双后端)
|
||||||
|
|
||||||
|
**验证**:
|
||||||
|
```
|
||||||
|
conda run --no-capture-output -n PolyGateway pytest tests/unit tests/contracts -v
|
||||||
|
```
|
||||||
|
→ 全 PASS。**Redis 契约测试用真实 Redis db3,不得与其他 Redis 测试并跑**(时序隔离)。
|
||||||
|
|
||||||
|
### T3 — 值域三态生效(行为变更主体)
|
||||||
|
|
||||||
|
- [x] **改** `src/polygateway/transports/openai_compat.py:146` — 兜底不再读 `est_tokens`:
|
||||||
|
|
||||||
|
```python
|
||||||
|
return 0, 0, "unavailable"
|
||||||
|
```
|
||||||
|
|
||||||
|
- [x] **改** `src/polygateway/transports/openai_compat.py:176` — embedding 兜底同理 `return 0, "unavailable"`
|
||||||
|
- [x] **改** `src/polygateway/transports/openai_compat.py:336` — 打捞覆盖加前置条件(否则 `0/0` 会被标 `estimated` 而算出假的 `0.0`):
|
||||||
|
|
||||||
|
```python
|
||||||
|
if salvaged and usage_source == "measured":
|
||||||
|
usage_source = "estimated" # 收到 usage 帧但流被截断: 数字真实、可信度降级
|
||||||
|
```
|
||||||
|
|
||||||
|
- [x] **改** `src/polygateway/middleware/telemetry.py:130-135` — cost 短路,**插在 `cache_hit` 分支之后**(缓存命中未产生新调用,`0.0` 是事实):
|
||||||
|
|
||||||
|
```python
|
||||||
|
if cache_hit:
|
||||||
|
cost: float | None = 0.0
|
||||||
|
elif usage_source == "unavailable":
|
||||||
|
cost = None # 用量不可得: 宁可算不出成本,也不算错成本
|
||||||
|
elif error is None and model and self._pricing is not None:
|
||||||
|
cost = self._pricing.cost(model, prompt_tokens, completion_tokens)
|
||||||
|
else:
|
||||||
|
cost = None
|
||||||
|
```
|
||||||
|
|
||||||
|
- [x] **改** `src/polygateway/middleware/telemetry.py:58` 与 `:100` — 失败尝试与终态失败的 `usage_source` 由 `"estimated"` 改 `"unavailable"`(cost 本已是 None,不改金额)
|
||||||
|
- [x] **改** `src/polygateway/embedding.py:383,390` — 二值合并扩三态(优先级:任一不可得 → 整体不可得):
|
||||||
|
|
||||||
|
```python
|
||||||
|
sources = {o.result.usage_source for o in outcomes}
|
||||||
|
if "unavailable" in sources:
|
||||||
|
merged_source = "unavailable"
|
||||||
|
elif "estimated" in sources:
|
||||||
|
merged_source = "estimated"
|
||||||
|
else:
|
||||||
|
merged_source = "measured"
|
||||||
|
```
|
||||||
|
|
||||||
|
- [x] **改** `src/polygateway/embedding.py:397` `_total_cost` — 存在 `unavailable` 批时整体返回 `None`(逐批求和会给出偏低却看似有效的金额)
|
||||||
|
- [x] **改** `src/polygateway/types.py:273` — 行内注释 `# measured | estimated` → 三态(内核里不留矛盾注释)
|
||||||
|
- [x] **改** `src/polygateway/transports/openai_compat.py:142` 与 `:172` — 两个函数的中文 docstring 仍写着"缺失/非法按 `est_tokens` 保守兜底并标 `estimated`",改完不改就留下两句主动陈述旧行为的文档(与 `types.py:273` 同一把尺子)
|
||||||
|
|
||||||
|
**验收标准**: 全库不再有任何位置把 `est_tokens` 写进遥测用量;`ocr.py` 一字未动。
|
||||||
|
|
||||||
|
**测试要求**(先失败后通过):
|
||||||
|
- `test_openai_compat.py`:`est_tokens=4000` + usage 帧缺失 → `(0, 0, "unavailable")`(**改前返回 `(0, 4000, "estimated")`,故先失败**;现有用例 `test_usage_missing_falls_back_to_est` 需改写)
|
||||||
|
- **改写** `tests/unit/test_embedding.py:105 test_missing_usage_falls_back_estimated` — 现断言 `prompt_tokens == 7 and usage_source == "estimated"`(夹具 `est_tokens=7`),改 `openai_compat.py:176` 后必然变红,须改为 `(0, "unavailable")`。这是一条**位于 `test_embedding.py` 里的 transport 级用例**,容易在只盯 `test_openai_compat.py` 时漏掉
|
||||||
|
- `test_openai_compat.py`:打捞 + usage 帧存在 → `estimated` **且 cost 非 None**;打捞 + usage 缺失 → `unavailable` **且 cost 为 None**。cost 配套断言不可省——#4 的真正目的就是防 `0/0` 被算成假的 `0.0`,只断言 `usage_source` 钉不住它
|
||||||
|
- `test_telemetry.py`:成功行 `usage_source="unavailable"` → `record_llm_call` 收到 `cost=None`(改前按 4000×输出单价算出 `0.032`)
|
||||||
|
- `test_telemetry.py`:`cache_hit=True` 且 `unavailable` → cost 仍为 `0.0`(锁定分支次序)
|
||||||
|
- `test_telemetry.py`:失败尝试与终态失败行 `usage_source == "unavailable"`
|
||||||
|
- `test_embedding.py`:混合批 `measured + unavailable` → 整体 `unavailable` 且 `cost is None`(改前误标 `measured`)
|
||||||
|
- `test_ocr_client.py`:OCR 成功行仍为 `measured` 且 settle 恒 0(**防回归**,锁定设计 §3.3 的剔出决定)
|
||||||
|
|
||||||
|
**验证**: `conda run --no-capture-output -n PolyGateway pytest tests/unit -v` → 全 PASS;`conda run --no-capture-output -n PolyGateway pytest tests/contracts -v` → 全 PASS(T2 的结算分支此时首次被激活,契约测试须复跑)
|
||||||
|
|
||||||
|
### T4 — 解绑装配约束(派生值真正启用)
|
||||||
|
|
||||||
|
- [x] **改** `src/polygateway/types.py:125-126` — 删除:
|
||||||
|
|
||||||
|
```python
|
||||||
|
if self.tpm > 0 and self.est_tokens <= 0:
|
||||||
|
raise ValueError("启用 TPM 闸时 est_tokens 必须 > 0(入场预扣依据)")
|
||||||
|
```
|
||||||
|
|
||||||
|
`_validate_gates` 的其余部分(`timeout_s > 0`、四个限额非负)**保留不动**。`est_tokens` 字段本身与 `{SCOPE}__{PROVIDER}__{N}__EST_TOKENS` 环境键保留不删不改名(迁移兼容硬约束);`config.py:40` 的键映射无需改动。
|
||||||
|
|
||||||
|
**验收标准**: `tpm=6000, est_tokens=0` 可构造;该源入场预扣 100,**成功侧与非 dead 瞬时失败侧**按 100 结算(delta=0)。**取消 / RequestRejected / ResultInvalid / SourceDead 四侧维持既有的 `actual=0` 全额退回**——`retry.py:355-359` 的取消分支不给 `actual` 赋值、停在 `:329` 初值,这是设计 §3.3 声明不动的既有行为,**不要**为了凑"三侧一致"去改它。
|
||||||
|
|
||||||
|
**测试要求**(先失败后通过:改前构造即抛 `ValueError`):
|
||||||
|
- **改写** `tests/unit/test_types.py:94 test_tpm_requires_est_tokens` — 它现在断言 `_make_source(tpm=10000, est_tokens=0)` 抛 `ValueError`,删约束后必然变红。保留后半条正向断言(`est_tokens=800` 仍原样返回),把前半条改为"构造成功且 `effective_est_tokens()` 返回派生值"
|
||||||
|
- `test_retry.py`:**成功侧**——未填 `est_tokens`、`tpm>0`、usage 帧缺失的成功调用后,TPM 窗口残留量等于派生预扣量而非 0(**这是设计中最易漏的一条**,回归 §3.2 #9;在 `test_retry.py:149` 的 `_src("a", tpm=1000, est_tokens=400)` 旁加 `est_tokens=0` 用例)
|
||||||
|
- `test_retry.py`:**失败侧**——同配置的非 dead 瞬时失败调用后,窗口残留量同为派生预扣量(回归 §3.2 #8)
|
||||||
|
- `tests/contracts/test_limiter_contract.py`:**只加后端级断言**——传入派生值时双后端的结算口径一致。**不要**在契约文件里写端到端用例:该文件直接驱动 limiter(形如 `limiter.try_acquire("s1", 0)`),不经 `QuotaGate`/`RetryMW`,照字面写会产出 `try_acquire(src.effective_est_tokens())` + `settle(同值)` 的退化用例——只测了后端算术,没测调用点是否真的切了派生值。上面两条端到端断言的载体是 `retry.py`,放 `test_retry.py`(内存后端)
|
||||||
|
|
||||||
|
**验证**: `make ci`(即 check + test,含 import-linter 契约)→ 全 PASS。**不要**在外层再套 `conda run`:`Makefile` 的 `check`/`test` 目标内部已各自 `conda run -n $(ENV)`,嵌套后外层的 `--no-capture-output` 也管不到内层缓冲
|
||||||
|
|
||||||
|
### T5 — 权威文档与发布物同步
|
||||||
|
|
||||||
|
- [x] **改** `research-wiki/ARCHITECTURE.md` 四处:§7.7 行 428(`est_tokens` 描述:可选调优覆盖 + 派生规则,删去"亦作 usage 缺失时的保守兜底")、§5.1 行 331(`usage_source` 三态 + cost NULL 口径)、§4.4 行 305("token 按 `est_tokens` 预扣" → 按有效预扣量)、§7.1 行 384(打捞路径强制 `estimated` → 仅在收到 usage 帧时降级)
|
||||||
|
- [x] **改** `research-wiki/migrations/chsanalyzer.md`:行 151 由"保留"改判"**有意放弃**"并写入设计 §4 的理由(CHS 只记单个 `total_tokens` 不存在分配问题;保守在计费语境无安全方向);G2(行 185)标注已由本设计解决
|
||||||
|
- [x] **改** `.env.example` 行 11:删除"TPM > 0 时 EST_TOKENS 必填 > 0",改注为"可选;未填则库按 tpm 派生"
|
||||||
|
- [x] **改** `CHANGELOG.md`:新增"行为收紧/变更"小节三条——`usage_source` 新增 `unavailable`、用量不可得行 cost 由数值变 NULL、`est_tokens` 降为可选
|
||||||
|
- [x] **改** wiki 用户文档站(按 `docs-convention.md` §2):usage/成本口径说明须写明缺口查询为 `WHERE usage_source='unavailable' AND cache_hit = false`(**必须带 `cache_hit` 限定**:缓存命中行按裁决 cost 为 `0.0` 且标 `unavailable`,本无账目缺口,不加限定则度量偏高)
|
||||||
|
- [x] **回帖** Gitea issue #2:结论与下游可删绕行校验的时点
|
||||||
|
|
||||||
|
**验收标准**: 全库 grep `EST_TOKENS 必填`、`est_tokens` 兜底相关表述无残留;ARCHITECTURE.md 无自相矛盾表述。
|
||||||
|
|
||||||
|
**测试要求**: 纯文档,无行为测试。以 `grep` 输出为验收证据。
|
||||||
|
|
||||||
|
**验证**: `make ci` → PASS;`grep -rn "EST_TOKENS 必填" . --exclude-dir=.git` → 无输出
|
||||||
|
|
||||||
|
## 5. 完成判定
|
||||||
|
|
||||||
|
- [x] T1-T5 全部 checkbox 勾选,每个任务一次语义化提交(`commit` skill)
|
||||||
|
- [x] `make ci` 全绿(含 ruff、import-linter 洋葱契约、pytest 覆盖率)
|
||||||
|
- [x] 设计 §6 测试表的 10 行断言全部有对应测试且可出示"先失败后通过"证据(T2 的零行为变更任务以"现有测试不回归 + 等价性断言"替代)
|
||||||
|
- [x] 派新上下文 verifier subagent 独立验证(`verification-before-completion`,里程碑级/跨多文件硬门)
|
||||||
|
- [x] 版本 bump 与 CHANGELOG 同步发布(不得裸发)
|
||||||
|
|
||||||
|
## 6. 明确不做
|
||||||
|
|
||||||
|
派生值取全局与单源 tpm 较紧者(需改三处 `QuotaGate` 装配,修的是既有缺口,设计 §7 已声明另开 issue);遥测驱动的 p90 自适应预估(设计 §5 已否决,待实测证据);`ocr.py` 的 usage 标记(设计 §3.3 已剔出);`retry.py` 另外三条失败分支的 `actual` 初值。
|
||||||
@@ -0,0 +1,224 @@
|
|||||||
|
# 实现计划: 响应可观测字段扩展(Issue #3)
|
||||||
|
|
||||||
|
- **目标**: 让 `LLMResponse` 与遥测表如实暴露「供应商 prompt cache 命中的输入 token 数」与「API 实际返回的模型版本串」。
|
||||||
|
- **方案概述**: 报文解析留在 `transports/`(新增两个强类型字段随 `TransportResult` 上浮),`RetryMW` 只搬运;遥测端口由 18 字段扩到 20 并给两个后端加幂等补列;`PricingTable` 增加可选缓存单价档消除 cost 高估。缓存命中行按既有口径原样回放。
|
||||||
|
- **依据设计**: `research-wiki/designs/2026-07-31-response-observability-fields-design.md`(2026-07-31 已获人类批准,决策 A2/B1/C1/D1)。
|
||||||
|
- **涉及技术**: Python 3.11 frozen dataclass、httpx SSE 解析、sqlite3、asyncpg、pytest。
|
||||||
|
- **保真校验**: 本计划**不涉及** `reference/` 参考实现迁移,保真校验不适用。但遥测后端属 ARCHITECTURE §1.4 资产,T5 明确约束「不得改变既有降级语义」。
|
||||||
|
|
||||||
|
## 文件结构
|
||||||
|
|
||||||
|
| 文件 | 职责 | 本次改动 |
|
||||||
|
|---|---|---|
|
||||||
|
| `src/polygateway/types.py` | 冻结公共类型 | `LLMResponse` / `TransportResult` 各 +2 字段;`cache_hit` docstring 消歧 |
|
||||||
|
| `src/polygateway/transports/openai_compat.py` | OpenAI 兼容报文解析 | 防御解析 helper;SSE sink 采集 `model`;两处 `TransportResult` 构造填新字段 |
|
||||||
|
| `src/polygateway/middleware/retry.py` | 尝试循环 | `_build_response` 搬运两字段 |
|
||||||
|
| `src/polygateway/middleware/cache.py` | 响应缓存 | **零代码改动**(自动透传),仅补测试固化行为 |
|
||||||
|
| `src/polygateway/pricing.py` | 单价换算 | `ModelPrice` +可选档;`cost()` +可选参;`from_file` 校验 |
|
||||||
|
| `src/polygateway/ports.py` | 端口契约 | `TelemetryRecorder` 18 → 20 字段 |
|
||||||
|
| `src/polygateway/telemetry/{sqlite,postgres}.py` | 遥测后端 | DDL +2 列;`_COLUMNS` +2;初始化期幂等补列 |
|
||||||
|
| `src/polygateway/middleware/telemetry.py` | 遥测唯一调用点 | `_record` 与三个 `emit_*` 搬运两字段;cost 换算传入缓存 token |
|
||||||
|
|
||||||
|
字段定义(全库唯一权威,后续任务一律引用此处):
|
||||||
|
|
||||||
|
```python
|
||||||
|
# LLMResponse 与 TransportResult 尾部,同名同类型同默认值
|
||||||
|
cached_prompt_tokens: int | None = None # 供应商 prompt cache 命中的输入 token;None = 该源未上报
|
||||||
|
model_reported: str | None = None # API 响应体的 model 字段;None = 未上报
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## T1. 类型层加字段
|
||||||
|
|
||||||
|
- [ ] **改**: `src/polygateway/types.py`
|
||||||
|
|
||||||
|
**行为**: 在 `LLMResponse` 尾部(`structured_data` 之后)与 `TransportResult` 尾部(`raw` 之后)各追加上面两个字段。`cache_hit` 的语义在 `LLMResponse` docstring 中写明是「**PolyGateway 自身响应缓存**命中,与供应商 prompt cache 无关,后者见 `cached_prompt_tokens`」。
|
||||||
|
|
||||||
|
**验收**: 前 11 个字段的顺序与名字一字不动;新字段有默认值,`LLMResponse(...)` 按前 11 位置参数构造仍成立;`TransportResult` 现有两处构造(`openai_compat.py:354/436`)不传新字段也能构造。
|
||||||
|
|
||||||
|
**测试**(`tests/unit/test_types.py`): ① 不传新字段时两个类型的新字段均为 `None`;② 按位置构造 `LLMResponse` 的前 11 字段仍可用(迁移兼容承诺)。
|
||||||
|
|
||||||
|
**验证**: `conda run -n PolyGateway --no-capture-output pytest tests/unit/test_types.py -v` → PASS。
|
||||||
|
|
||||||
|
**提交**: `feat: add cached prompt tokens and reported model to response types`
|
||||||
|
|
||||||
|
## T2. transport 采集与防御解析
|
||||||
|
|
||||||
|
- [ ] **改**: `src/polygateway/transports/openai_compat.py`
|
||||||
|
|
||||||
|
**行为**分三处:
|
||||||
|
|
||||||
|
1. 新增两个模块级防御 helper(网关返回一律不可信,解析失败**返回 None,不抛异常**):
|
||||||
|
|
||||||
|
```python
|
||||||
|
def _coerce_cached_tokens(usage: Any) -> int | None:
|
||||||
|
"""从 usage.prompt_tokens_details.cached_tokens 取非负整数;任何形态异常 → None。"""
|
||||||
|
|
||||||
|
def _coerce_model_reported(value: Any) -> str | None:
|
||||||
|
"""响应体 model 字段: 非空 str 才收,其余(含空串/非 str)→ None。"""
|
||||||
|
```
|
||||||
|
|
||||||
|
`_coerce_cached_tokens` 需容忍:`usage` 为 None、`prompt_tokens_details` 缺失或非 dict、`cached_tokens` 为 `bool`/`str`/负数/浮点。`bool` 必须排除(Python 中 `isinstance(True, int)` 为真)。**`0` 必须如实保留而非归 None**——真实零命中与未上报是两回事,这是 issue 的核心诉求。
|
||||||
|
|
||||||
|
2. 流式路径:`_sse_delta`(`:44-47`)当前只把 `usage` 旁路进 sink。补一条——chunk 里出现 `model` 时写 `usage_sink["model"]`(**首次写入即固定**,后续 chunk 不覆盖,避免末帧异常值污染)。`_stream_once` 的 `TransportResult` 构造(`:354`)填 `cached_prompt_tokens=_coerce_cached_tokens(sink.get("usage"))`、`model_reported=_coerce_model_reported(sink.get("model"))`。
|
||||||
|
|
||||||
|
3. 非流式路径:`TransportResult` 构造(`:436`)填 `_coerce_cached_tokens(body.get("usage"))` 与 `_coerce_model_reported(body.get("model"))`。
|
||||||
|
|
||||||
|
**验收**: `raw` 的内容保持原样不动(新字段是独立格子,不是杂物袋的扩充);OCR 与 embedding 的解析路径一行不改。
|
||||||
|
|
||||||
|
**测试**(`tests/unit/test_openai_compat.py`,用现有 fake 响应二次构造):
|
||||||
|
|
||||||
|
| 用例 | 期望 |
|
||||||
|
|---|---|
|
||||||
|
| 非流式 usage 含 `prompt_tokens_details.cached_tokens: 128` | `cached_prompt_tokens == 128` |
|
||||||
|
| 流式 usage 帧同上 | 同上 |
|
||||||
|
| 无 `prompt_tokens_details` / usage 帧缺失 | `None` |
|
||||||
|
| `cached_tokens` 为 `"abc"` / `-1` / `True` / `1.5` / `[]` / dict | `None`,且**不抛异常** |
|
||||||
|
| `cached_tokens` 为 `0` | `0`(真实零命中,**不得**归 None) |
|
||||||
|
| `prompt_tokens_details` 非 dict | `None` |
|
||||||
|
| 非流式 body 含 `model: "MiniMax-Text-01-250321"` | `model_reported` 为该串 |
|
||||||
|
| 流式首个含 model 的 chunk 后又出现不同 model | 取**首个** |
|
||||||
|
| body 无 `model` / `model` 为 `""` | `None` |
|
||||||
|
|
||||||
|
**验证**: `conda run -n PolyGateway --no-capture-output pytest tests/unit/test_openai_compat.py -v` → PASS(新增用例先失败后通过)。
|
||||||
|
|
||||||
|
**提交**: `feat: collect provider cache tokens and reported model in transport`
|
||||||
|
|
||||||
|
## T3. RetryMW 搬运与缓存回放固化
|
||||||
|
|
||||||
|
- [ ] **改**: `src/polygateway/middleware/retry.py`
|
||||||
|
|
||||||
|
**行为**: `_build_response`(`:419-438`)追加 `cached_prompt_tokens=result.cached_prompt_tokens`、`model_reported=result.model_reported`。`model=source.model` **保持不变**——别名仍是主字段,真实版本是旁证(设计非目标 2)。
|
||||||
|
|
||||||
|
`middleware/cache.py` **不改一行**:`_RESPONSE_FIELDS` 由 `dataclasses.fields(LLMResponse)` 动态生成(`:26`)、`_serialize` 用 `asdict`(`:139`),新字段自动进出;决策 B1 要求命中时原样回放,而 `_rehydrate` 的覆写清单(`:113-119`)本就不含新字段,零改动即是正确行为。本任务用测试把它钉死。
|
||||||
|
|
||||||
|
**测试**:
|
||||||
|
|
||||||
|
- `tests/unit/test_retry.py`: transport 返回带两字段的 `TransportResult` → `chat()` 返回的 `LLMResponse` 上两字段一致;transport 未上报时为 `None`。
|
||||||
|
- `tests/unit/test_cache.py`: ① 带两字段的响应写入缓存再命中,回放值与原值相等且 `cache_hit=True`;② **旧格式兼容**——手工构造缺这两个键的缓存 JSON 塞进后端,命中后能正常 rehydrate 且两字段为 `None`(不得抛异常回源)。
|
||||||
|
|
||||||
|
**验证**: `conda run -n PolyGateway --no-capture-output pytest tests/unit/test_retry.py tests/unit/test_cache.py -v` → PASS。
|
||||||
|
|
||||||
|
**提交**: `feat: carry the new observability fields through retry and cache`
|
||||||
|
|
||||||
|
## T4. 缓存读取单价
|
||||||
|
|
||||||
|
- [ ] **改**: `src/polygateway/pricing.py`
|
||||||
|
|
||||||
|
**行为**:
|
||||||
|
|
||||||
|
```python
|
||||||
|
class ModelPrice: # 追加第三档,可选
|
||||||
|
cached_input_per_1m: float | None = None
|
||||||
|
|
||||||
|
def cost(self, model: str, prompt_tokens: int, completion_tokens: int,
|
||||||
|
cached_prompt_tokens: int | None = None) -> float | None:
|
||||||
|
```
|
||||||
|
|
||||||
|
换算规则(设计 §4):配了缓存档**且** `cached_prompt_tokens` 为正 → `(prompt - cached) × input + cached × cached_input`;否则全额按 `input`(现状,逐位不变)。`cached > prompt` 时按 `prompt` 夹取并 `logger.warning` 一次(沿用 `_warned` 的去重思路,按 model 去重,防日志风暴),**绝不产生负成本**。
|
||||||
|
|
||||||
|
`from_file` 的 fail-loud 扩展:条目出现 `cached_input_per_1m` 键时必须可转 float 且非负,否则 `ValueError`;不出现该键 = 合法(旧价格表零改动)。`__post_init__` 同步校验非负。
|
||||||
|
|
||||||
|
顺带订正 `PricingTable` docstring(`pricing.py:36`)那句「cost() 是全库唯一换算点(经 TelemetryEmitter)」——实际有 `TelemetryEmitter`(`middleware/telemetry.py:137`)与 `embedding.py:419` 两个调用点(设计 §6 行为审计已声明)。**只改这一行注释,不做任何结构重构**。
|
||||||
|
|
||||||
|
**验收**: `embedding.py:419` 的三参调用形态**一行不改**仍可用;未配缓存档时,任意输入下 `cost()` 结果与改前逐位相等。
|
||||||
|
|
||||||
|
**测试**(`tests/unit/test_pricing.py`): ① 配缓存档 + 命中 → 成本严格低于全额且等于手算值;② 未配缓存档 + 命中 → 与不传该参数结果相等;③ `cached > prompt` → 结果等于全部按缓存价、非负、有 warning;④ `cached_prompt_tokens=None/0` → 全额;⑤ 三参旧调用签名可用;⑥ 价格表含 `cached_input_per_1m: -1` 或 `"x"` → `from_file` 抛 `ValueError`;⑦ 无该键的旧价格表照常加载。
|
||||||
|
|
||||||
|
**验证**: `conda run -n PolyGateway --no-capture-output pytest tests/unit/test_pricing.py -v` → PASS。
|
||||||
|
|
||||||
|
**提交**: `feat: support a cached input price tier in the pricing table`
|
||||||
|
|
||||||
|
## T5. 端口扩字段与后端补列
|
||||||
|
|
||||||
|
- [ ] **改**: `src/polygateway/ports.py`、`src/polygateway/telemetry/sqlite.py`、`src/polygateway/telemetry/postgres.py`
|
||||||
|
|
||||||
|
**行为**:
|
||||||
|
|
||||||
|
1. `TelemetryRecorder.record_llm_call`(`ports.py:250-271`)在 `cost` 之后追加 `cached_prompt_tokens: int | None` 与 `model_reported: str | None`,**不设默认值**(设计 §5:库外无第三方实现者)。同步该 Protocol 的「18 字段冻结」docstring。
|
||||||
|
|
||||||
|
2. 两个后端的 `_DDL` 加列(SQLite `INTEGER`/`TEXT`;PG `INTEGER`/`TEXT`,均可空、无默认值)。**新列在 DDL 里必须放在 `created_at` 之后(即表的最末尾),不得插在 `cost` 之后**——旧表走 `ALTER TABLE ADD COLUMN` 只能追加到末尾,若新建库把新列插在 `created_at` 前面,两条路径的物理列序就会分叉,而 `tests/integration/test_postgres_telemetry.py:117-128` 的 `test_schema_has_frozen_columns_in_order` 按 `ordinal_position` 逐位断言,且该表是与真实批跑共享的表、**严禁 DROP/TRUNCATE**(文件头隔离纪律),分叉后没有合规修法。
|
||||||
|
|
||||||
|
`_COLUMNS` 在 `"cost"` 之后追加同名两项即可——`_INSERT` 是显式列名拼装(`sqlite.py:62-65`/`postgres.py:67-71`),`_COLUMNS` 只需与自身的 `row = tuple(...)` 自洽,**与 DDL 物理列序无关**。
|
||||||
|
|
||||||
|
3. **幂等补列**,按设计 D1 纪律执行:
|
||||||
|
|
||||||
|
- **SQLite**(`sqlite.py:74-84`):补列代码必须放在 `self._conn = conn` **之后**、用**独立 try**,且**首行必须守卫 `if self._conn is None: return`**——初始化 try 吞掉失败时 `self._conn` 仍是 `None`(局部 `conn` 甚至未绑定),无守卫的补列块会抛 `AttributeError`/`NameError`,这两者不被 `sqlite3.Error` 捕获,会直接逃出 `__init__`,打破「初始化失败静默降级」的对外契约(既有测试 `tests/unit/test_telemetry.py:132-135` `test_unwritable_path_degrades_silently` 会红)。守卫之后:`PRAGMA table_info(llm_calls)` 取现有列名集合,缺哪列补哪列;捕获 `sqlite3.Error` 时消息含 `duplicate column` 视为成功(多进程共库的 TOCTOU),其余记 warning。**绝不允许**因补列失败把 `self._conn` 置回 `None`——那会让整个 recorder 永久 no-op。
|
||||||
|
- **Postgres**(`postgres.py:_ensure_ready` 内、`_DDL` 执行之后):两条 `ALTER TABLE llm_calls ADD COLUMN IF NOT EXISTS ...`,共享既有 `_init_lock` 与 `except asyncio.CancelledError: raise` 结构。
|
||||||
|
|
||||||
|
**验收(降级语义不得改变)**: SQLite 侧 `except` 不得加宽(取消天然穿透);PG 侧 `CancelledError` 分支保持在最前;写入失败仍是逐行 warning 丢弃,不冒泡。
|
||||||
|
|
||||||
|
**必须同步改的测试(共 5 处)**:
|
||||||
|
|
||||||
|
| 位置 | 内容 | 漏改会怎样 |
|
||||||
|
|---|---|---|
|
||||||
|
| `tests/unit/test_telemetry.py:76` 起 `_record_minimal` | 手写 18 键 dict | **红**(`KeyError`) |
|
||||||
|
| `tests/integration/test_postgres_telemetry.py:81-105` `_record_minimal` | 同上 | **红** |
|
||||||
|
| `tests/unit/test_telemetry.py:18-40` `_EXPECTED_COLUMNS` | 19 项列序断言(含 `created_at`) | **红**;新列追加到 `created_at` **之后** |
|
||||||
|
| `tests/integration/test_postgres_telemetry.py:22-41` `_EXPECTED_COLUMNS` | 同上 | **红**;同上 |
|
||||||
|
| `tests/unit/test_ports.py:96` `_DummyRecorder` | 唯一写全签名的 fake | **不会红**(它只被 `:131` 的 `isinstance` 使用,`runtime_checkable` Protocol 只校验方法名不校验签名),但仍应同步以免误导后来者 |
|
||||||
|
|
||||||
|
前四处是本次仅有的天然拦截点;端口加参数**不会**带来编译期保护(本仓无 mypy,其余 8 个 fake 全是 `**fields`)。
|
||||||
|
|
||||||
|
**测试**:
|
||||||
|
|
||||||
|
- `tests/unit/test_telemetry.py`(SQLite):① 20 字段写入后可读回两个新列的值(含 `None`);② **旧表升级**——先用 18 列 DDL 手工建表,再实例化 `SQLiteRecorder`,写入成功且新列有值;③ **补列失败路径**(设计 §8 第 ③ 条,最危险的分支,不可用成功路径顶替)——构造一个 ALTER 必然失败的场景(把 `llm_calls` 建成同名 view,或注入在 ALTER 上抛 `sqlite3.OperationalError` 的连接),断言构造**不抛异常**、`recorder._conn` 仍非 `None`、后续 `record_llm_call` 不抛(降级为逐行 warning);④ 初始化路径不可写时仍静默降级(`test_unwritable_path_degrades_silently` 保持绿)。
|
||||||
|
- `tests/integration/test_postgres_telemetry.py`:① 20 字段写入 PG 并 `SELECT` 回读;② 18 列旧表经初始化后自动补列并写入成功。
|
||||||
|
|
||||||
|
**验证**: `conda run -n PolyGateway --no-capture-output pytest tests/unit/test_telemetry.py tests/unit/test_ports.py -v` → PASS;PG 部分 `conda run -n PolyGateway --no-capture-output pytest tests/integration/test_postgres_telemetry.py -v` → PASS。**PG/Redis 属共享后端,严禁与其他会话或钩子测试并跑**,起跑前确认无并发占用。
|
||||||
|
|
||||||
|
**提交**: **与 T6 合并为一次提交**,不得单独落地。理由:T5 落地后 emitter 仍只传 18 键,后端的 `row = tuple(fields[col] for col in _COLUMNS)` 会抛 `KeyError`,被 `_record` 的 `except Exception`(`middleware/telemetry.py:164-165`)吞成 warning → **该 commit 处于全量遥测静默丢失的状态**,且现有测试无一能捕获。提交信息见 T6。
|
||||||
|
|
||||||
|
## T6. Emitter 搬运与契约测试(与 T5 同一次提交)
|
||||||
|
|
||||||
|
- [ ] **改**: `src/polygateway/middleware/telemetry.py`
|
||||||
|
|
||||||
|
**行为**: `_record`(`:108-125`)新增两个参数并透传给 `record_llm_call`;三个入口各自提供取值——
|
||||||
|
|
||||||
|
| 入口 | `cached_prompt_tokens` | `model_reported` |
|
||||||
|
|---|---|---|
|
||||||
|
| `emit_attempt` | `response.cached_prompt_tokens if response else None` | 同左 |
|
||||||
|
| `emit_cache_hit` | `response.cached_prompt_tokens`(B1 原样回放) | 同左 |
|
||||||
|
| `emit_terminal_failure` | `None` | `None` |
|
||||||
|
|
||||||
|
cost 换算(`:137`)改为把 `cached_prompt_tokens` 传进 `self._pricing.cost(...)`。`cache_hit → 0.0` 与 `usage_source == "unavailable" → None` 两条短路的**先后顺序一字不动**(ARCHITECTURE §5.1 cost 口径不变式)。
|
||||||
|
|
||||||
|
**测试**(`tests/unit/test_telemetry.py`):
|
||||||
|
|
||||||
|
- **契约测试(不可省)**: 用记录 kwargs 的 fake recorder 跑一次 `emit_attempt`,断言 `set(kwargs) == set(sqlite._COLUMNS) == set(postgres._COLUMNS)`。理由:`row = tuple(fields[col] for col in _COLUMNS)` 位于两个后端 try 之外(`sqlite.py:90`/`postgres.py:121`),emitter 漏传字段会抛 `KeyError` 并被 `_record` 的 `except Exception` 吞成 warning → 静默丢遥测;现有 8 个 `**fields` 形态的 fake 一个都拦不住。
|
||||||
|
- 三个入口各记一行,断言新字段取值符合上表。
|
||||||
|
- cost 回归:配了缓存档且响应带 `cached_prompt_tokens` → 落库 cost 低于全额;缓存命中行 cost 仍为 `0.0`;`unavailable` 行仍为 `None`。
|
||||||
|
|
||||||
|
**验证**: `conda run -n PolyGateway --no-capture-output pytest tests/unit/test_telemetry.py -v` → PASS;随后 `make ci` 全绿(含 ruff 与 import-linter)。
|
||||||
|
|
||||||
|
**提交**(含 T5 全部改动): `feat: record the observability fields end to end through telemetry`
|
||||||
|
|
||||||
|
## T7. 文档同步与发版
|
||||||
|
|
||||||
|
- [ ] **改**: `research-wiki/ARCHITECTURE.md`、`CHANGELOG.md`、`.env.example`、`pyproject.toml`、`src/polygateway/__init__.py`、四处「18 字段冻结」措辞点、Gitea Wiki 站
|
||||||
|
|
||||||
|
**行为**:
|
||||||
|
|
||||||
|
1. `ARCHITECTURE.md`:§5.1 新增字段表补两行;**§7.8「必录字段」的行内清单**(`:452`)补两项——该文件不含字面「18 字段冻结」,§7.8 与 D8(`:202`)才是遥测字段的落点;§7.8 末条「`pricing.py` 维护 model →(input 单价, output 单价)表」同步第三档。补一条度量口径警示(与 cost 缺口同款):**统计供应商缓存命中率必须带 `WHERE cache_hit = false`**,否则缓存回放行会被重复计入。
|
||||||
|
2. 代码里的「18 字段/18 列」措辞共 **6 处**,全部订正(`grep -rn "18 字段\|18 列" src/ tests/` 可复核):`ports.py:248`、`middleware/telemetry.py:31`、`pricing.py:6`、`telemetry/sqlite.py:87`、`telemetry/postgres.py:9`(「18 列 schema 与 SQLite 版同名同序」)、`tests/unit/test_telemetry.py:1`。
|
||||||
|
3. `.env.example:56` 是仓内**唯一**的价格表格式说明(无独立模板文件),补 `cached_input_per_1m` 可选档与「不填即全额计价、库不猜折扣率」的说明。
|
||||||
|
4. 版本 bump `1.0.3` → `1.1.0`,**两处必须同步**(`pyproject.toml:7` 与 `src/polygateway/__init__.py:34`;`tests/unit/test_package.py:11` 会断言二者相等)。
|
||||||
|
5. `CHANGELOG.md` 顶部新增 `## 1.1.0` 段,沿用既有写法(先讲问题、再讲变更、点明下游要读什么):两个新字段的语义与 `None`/`0` 之别、`cache_hit` 与供应商 prompt cache 的区分、遥测表新增两列与自动补列、价格表可选缓存档、度量口径的 `cache_hit = false` 约束。
|
||||||
|
6. Gitea Wiki 站(需单独 `git clone https://gitea.iomgaa.online/iomgaa/PolyGateway.wiki.git`)按 `docs-convention.md` §2 清单同步:`参考-公共API`(LLMResponse 字段表)、`参考-配置键`(价格表格式)、`指南-遥测与成本`(新列与成本校正口径)、`Home.md` 版本号与安装命令、`_Sidebar.md` 如有结构变化。
|
||||||
|
|
||||||
|
**验收**: 版本 bump 的提交**不允许单独存在**(docs-convention §2 门),必须与 wiki/CHANGELOG 同步在同一次交付内。
|
||||||
|
|
||||||
|
**验证**: `conda run -n PolyGateway --no-capture-output pytest tests/unit/test_package.py -v` → PASS;`make ci` 全绿。
|
||||||
|
|
||||||
|
**提交**: `chore: release 1.1.0 with the response observability fields`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 合并前门(逐条对应 CLAUDE.md §3)
|
||||||
|
|
||||||
|
- [ ] 每个行为变更都有「先失败后通过」的测试证据(T1-T6 各自的新增用例)。
|
||||||
|
- [ ] `make ci` 全绿(ruff + import-linter + pytest + 覆盖率)。
|
||||||
|
- [ ] 派**全新上下文**的 verifier subagent 独立验证(跨多文件,`verification-before-completion` 强制档)。
|
||||||
|
- [ ] 合并前整分支代码审查(`requesting-code-review`)。
|
||||||
|
- [ ] Gitea Issue #3 的关闭说明:两个字段的最终名字与语义、缓存命中行的回放口径、遥测新列与补列行为。
|
||||||
@@ -0,0 +1,17 @@
|
|||||||
|
---
|
||||||
|
type: plan
|
||||||
|
node_id: plan:est-tokens-decoupling
|
||||||
|
title: "est_tokens 解耦实施计划"
|
||||||
|
date: 2026-07-30
|
||||||
|
---
|
||||||
|
|
||||||
|
# est_tokens 解耦实施计划
|
||||||
|
|
||||||
|
全文见 [2026-07-30-est-tokens-decoupling-plan.md](2026-07-30-est-tokens-decoupling-plan.md)。实现设计 [est-tokens-decoupling](../designs/est-tokens-decoupling.md)。
|
||||||
|
|
||||||
|
- **5 个任务**: T1 加派生能力与三态值域常量(零行为变更)→ T2 五个入场/结算点切到派生值(零行为变更,因显式值优先)→ T3 值域三态生效(行为变更主体)→ T4 解绑 `tpm > 0 ⇒ est_tokens > 0`(派生值真正启用)→ T5 权威文档、CHANGELOG、wiki 与 issue 回帖。
|
||||||
|
- **排序是硬约束,不可调换**: 三处改动互相牵制且中间态**静默偏差、不报错**。先改 usage 兜底为 `(0,0)` 而结算点未切派生值 → 成功调用押金整笔退回(TPM 闸退化成进门即放行);先解绑约束而结算点未切 → 同样泄漏;先改 `openai_compat.py:176` 而 `_merge` 仍是二值 `any(=="estimated")` → `unavailable` 批被误标 `measured` 且 cost 照算。
|
||||||
|
- **T2 的等价性是安全阀**: 约束未解绑时 `effective_est_tokens()` 恒返回显式值,故 T1/T2 后行为逐字不变,现有测试全绿即为证明;T3 才是唯一的行为变更点。
|
||||||
|
- **保真校验(不新增移植,但触及关键资产)**: 不得改 Redis Lua 与内存后端的窗口/租约算法(只改传入 `try_acquire` 的数值来源)、不得改 `settle` 多退少补与幂等语义、不得改错误四分类归属、`ocr.py` 一字不动、遥测 18 字段冻结且无 DDL。
|
||||||
|
- **最易漏的测试**: T4 的"成功侧结算不退多"——未填 `est_tokens` 且 usage 帧缺失的**成功**调用后,TPM 窗口残留须等于派生预扣量而非 0。这正是独立审查在设计阶段抓出的缺陷,实施阶段必须有回归钉死。
|
||||||
|
- **发布口径**: 缺口度量必须写成 `WHERE usage_source='unavailable' AND cache_hit = false`——缓存命中行按裁决 cost 为 `0.0` 且标 `unavailable`,本无账目缺口,不加限定则度量偏高。
|
||||||
@@ -0,0 +1,30 @@
|
|||||||
|
---
|
||||||
|
type: plan
|
||||||
|
node_id: plan:response-observability-fields
|
||||||
|
title: 响应可观测字段扩展实现计划
|
||||||
|
date: 2026-07-31
|
||||||
|
---
|
||||||
|
|
||||||
|
# 响应可观测字段扩展实现计划
|
||||||
|
|
||||||
|
全文见 `2026-07-31-response-observability-fields.md`。实现 [[response-observability-fields]] 设计(A2/B1/C1/D1)。
|
||||||
|
|
||||||
|
## 任务序列
|
||||||
|
|
||||||
|
| 任务 | 内容 | 提交 |
|
||||||
|
|---|---|---|
|
||||||
|
| T1 | `types.py` 两个类型各 +2 字段;`cache_hit` docstring 消歧 | 独立 |
|
||||||
|
| T2 | `openai_compat.py` 防御解析 + SSE sink 采集 `model` + 两处构造填值 | 独立 |
|
||||||
|
| T3 | `retry.py` 搬运;`cache.py` 零改动但用测试固化 B1 回放语义 | 独立 |
|
||||||
|
| T4 | `pricing.py` 可选缓存单价档 + 夹取防负 | 独立 |
|
||||||
|
| T5+T6 | 端口 18→20、两后端 DDL 加列与幂等补列、emitter 搬运、契约测试 | **必须合一次提交** |
|
||||||
|
| T7 | ARCHITECTURE §7.8 / CHANGELOG / `.env.example:56` / 6 处「18 字段」措辞 / 版本 1.1.0 / Gitea Wiki 站 | 独立 |
|
||||||
|
|
||||||
|
## 独立审查抓出的四个坑(已折回计划)
|
||||||
|
|
||||||
|
1. **DDL 新列必须放在 `created_at` 之后**(表末尾)。旧表走 `ALTER ADD COLUMN` 只能追加到末尾,若新建库把新列插在 `created_at` 前,两条路径列序分叉 —— 而 `test_schema_has_frozen_columns_in_order` 按 `ordinal_position` 逐位断言,且该 PG 表与真实批跑共享、严禁 DROP,分叉后无合规修法。
|
||||||
|
2. **SQLite 补列块首行必须守卫 `if self._conn is None: return`**。否则初始化失败时补列块抛 `AttributeError`/`NameError`(不被 `sqlite3.Error` 捕获)逃出 `__init__`,打破「初始化失败静默降级」契约。
|
||||||
|
3. **T5 与 T6 不得分开提交**。中间状态下 emitter 只传 18 键,后端抛 `KeyError` 被吞成 warning,该 commit 全量遥测静默丢失。
|
||||||
|
4. **天然拦截点是四处而非三处**:两个 `_record_minimal` + 两个 `_EXPECTED_COLUMNS`;`test_ports.py:96` 的全签名 fake **不会**红(Protocol 的 isinstance 不校验签名),不能当作覆盖保证。
|
||||||
|
|
||||||
|
相关: [[response-observability-fields]]、[[est-tokens-decoupling]]
|
||||||
@@ -1,11 +1,11 @@
|
|||||||
---
|
---
|
||||||
type: schema
|
type: schema
|
||||||
node_id: schema:llm-calls
|
node_id: schema:llm-calls
|
||||||
title: "表结构: llm_calls(遥测 18 字段)"
|
title: "表结构: llm_calls(遥测 20 字段)"
|
||||||
date: 2026-07-20
|
date: 2026-07-20
|
||||||
---
|
---
|
||||||
|
|
||||||
# 表结构: llm_calls(遥测 18 字段)
|
# 表结构: llm_calls(遥测 20 字段)
|
||||||
|
|
||||||
|
|
||||||
## 列定义(冻结,M1 设计 §4.4 / ARCH §7.8)
|
## 列定义(冻结,M1 设计 §4.4 / ARCH §7.8)
|
||||||
@@ -16,14 +16,39 @@ date: 2026-07-20
|
|||||||
| parent_call_id / session_id | TEXT | 调用链路(agent step → LLM call) |
|
| parent_call_id / session_id | TEXT | 调用链路(agent step → LLM call) |
|
||||||
| model / provider / source_name | TEXT NOT NULL | 溯源;model 由旧 Protocol 的 model_name 更名(VT 迁移 §8) |
|
| model / provider / source_name | TEXT NOT NULL | 溯源;model 由旧 Protocol 的 model_name 更名(VT 迁移 §8) |
|
||||||
| messages / response / thinking | TEXT NOT NULL | messages 落库前多模态 part 摘要(与缓存 key 共用 digest_messages) |
|
| messages / response / thinking | TEXT NOT NULL | messages 落库前多模态 part 摘要(与缓存 key 共用 digest_messages) |
|
||||||
| prompt_tokens / completion_tokens | INTEGER NOT NULL | usage 帧;缺失按 est 兜底 |
|
| prompt_tokens / completion_tokens | INTEGER NOT NULL | usage 帧;帧缺失记 0/0(不编造估值,由 usage_source 标注) |
|
||||||
| usage_source | TEXT NOT NULL | measured / estimated |
|
| usage_source | TEXT NOT NULL | measured / estimated / unavailable(2026-07-30 起三态,见下) |
|
||||||
| latency_ms | INTEGER NOT NULL | 尝试耗时;缓存命中 0 |
|
| latency_ms | INTEGER NOT NULL | 尝试耗时;缓存命中 0 |
|
||||||
| ttft_ms / max_inter_token_ms | REAL | 流式活性测量 |
|
| ttft_ms / max_inter_token_ms | REAL | 流式活性测量 |
|
||||||
| cache_hit | INTEGER NOT NULL DEFAULT 0 | 命中标记 |
|
| cache_hit | INTEGER NOT NULL DEFAULT 0 | 命中标记 |
|
||||||
| error | TEXT | 异常信息;取消记 "cancelled" |
|
| error | TEXT | 异常信息;取消记 "cancelled" |
|
||||||
| cost | REAL | M1 恒 NULL,M2 pricing 换算 |
|
| cost | REAL | M2 起 pricing 换算;`usage_source='unavailable'` 的真实调用行为 NULL(缓存命中行例外,仍为 0.0) |
|
||||||
| created_at | TEXT NOT NULL DEFAULT (datetime('now')) | 落库时刻 |
|
| created_at | TEXT NOT NULL DEFAULT (datetime('now')) | 落库时刻 |
|
||||||
|
| cached_prompt_tokens | INTEGER | 供应商 prompt cache 命中的输入 token(2026-07-31,issue #3);NULL = 该源未上报,`0` = 上报了真实零命中,两者不可混同 |
|
||||||
|
| model_reported | TEXT | API 响应体实际返回的 model;NULL = 未上报。与 `model`(配置别名)可能分叉 |
|
||||||
|
|
||||||
|
## usage/成本口径(2026-07-30,est_tokens 解耦)
|
||||||
|
|
||||||
|
| usage_source | 含义 | 生产者 | cost |
|
||||||
|
|---|---|---|---|
|
||||||
|
| `measured` | usage 帧完整可信 | 正常路径;OCR 成功行(0 token 是事实) | 按 token 换算 |
|
||||||
|
| `estimated` | 有实测数字但可信度降级 | 打捞路径(收到 usage 帧但流被截断) | 按 token 换算 |
|
||||||
|
| `unavailable` | 用量信息不可得 | usage 帧缺失、失败尝试、终态失败 | NULL |
|
||||||
|
|
||||||
|
`SUM(cost)` 天然跳过 NULL,故账单汇总不再被虚构的估值污染;账目缺口的度量口径固定为 `WHERE usage_source = 'unavailable' AND cache_hit = false`。**`cache_hit` 限定不可省**:缓存命中行未产生新调用,cost 是事实上的 `0.0` 而非未知,本无账目缺口,漏掉该条件会让缺口度量偏高。
|
||||||
|
|
||||||
|
## 供应商 prompt cache 口径(2026-07-31,issue #3)
|
||||||
|
|
||||||
|
新增两列排在 `created_at` **之后**——旧表只能经 `ALTER TABLE ADD COLUMN` 追加到末尾,DDL 里若插在前面,新建库与升级库的物理列序会分叉(列序断言无合规修法)。两个后端在初始化期幂等补列:`CREATE TABLE IF NOT EXISTS` 不会给旧表加列,不补则每行写入被逐行 warning 丢弃、遥测静默全失。两侧都**先探测缺列再 ALTER**(`ADD COLUMN IF NOT EXISTS` 即使列已存在也先取 ACCESS EXCLUSIVE 锁,遥测是内联 await,锁共享审计表会拖垮业务调用),且**补列失败只降级为逐行丢弃,绝不让 recorder 整体失能**——两侧纪律必须对称。
|
||||||
|
|
||||||
|
`cache_hit` 指 **PolyGateway 自身响应缓存**,与供应商 prompt cache 是两回事。缓存命中行的这两列是**原样回放**的历史值(与 `model`/`prompt_tokens` 同一口径),故命中率度量口径固定为:
|
||||||
|
|
||||||
|
```sql
|
||||||
|
SELECT SUM(cached_prompt_tokens)::float / NULLIF(SUM(prompt_tokens), 0)
|
||||||
|
FROM llm_calls WHERE cache_hit = false AND cached_prompt_tokens IS NOT NULL;
|
||||||
|
```
|
||||||
|
|
||||||
|
`WHERE cache_hit = false` 不可省,理由与上面 cost 缺口口径同源:回放行计入即重复计数。
|
||||||
|
|
||||||
## 埋点位置(单一 helper 铁律)
|
## 埋点位置(单一 helper 铁律)
|
||||||
|
|
||||||
|
|||||||
@@ -31,7 +31,7 @@ from polygateway.types import (
|
|||||||
SourceConfig,
|
SourceConfig,
|
||||||
)
|
)
|
||||||
|
|
||||||
__version__ = "1.0.2"
|
__version__ = "1.0.4"
|
||||||
|
|
||||||
__all__ = [
|
__all__ = [
|
||||||
"DEFAULT_PROFILES",
|
"DEFAULT_PROFILES",
|
||||||
|
|||||||
@@ -268,6 +268,10 @@ class EmbeddingClient:
|
|||||||
source_name=source.name,
|
source_name=source.name,
|
||||||
operation="embedding",
|
operation="embedding",
|
||||||
)
|
)
|
||||||
|
if result.usage_source == "unavailable":
|
||||||
|
# 与 RetryMW 同口径: 用量不可得时按入场预扣量结算(设计 §3.2 #9)
|
||||||
|
actual = source.effective_est_tokens()
|
||||||
|
else:
|
||||||
actual = result.prompt_tokens
|
actual = result.prompt_tokens
|
||||||
await self._record_quietly(self._breaker.record_success(entry))
|
await self._record_quietly(self._breaker.record_success(entry))
|
||||||
await self._record_quietly(self._quota.mark_progress())
|
await self._record_quietly(self._quota.mark_progress())
|
||||||
@@ -291,7 +295,8 @@ class EmbeddingClient:
|
|||||||
reasons[source.name] = reason
|
reasons[source.name] = reason
|
||||||
await self._record_quietly(self._breaker.record_failure(entry, reason, dead))
|
await self._record_quietly(self._breaker.record_failure(entry, reason, dead))
|
||||||
if not dead:
|
if not dead:
|
||||||
actual = source.est_tokens # 保守: 失败请求可能已被网关计费(CHS 同款)
|
# 保守: 失败请求可能已被网关计费(CHS 同款);与入场预扣同源取值
|
||||||
|
actual = source.effective_est_tokens()
|
||||||
await self._emit(batch, source, call_id, started, session_id, parent_call_id, error=exc)
|
await self._emit(batch, source, call_id, started, session_id, parent_call_id, error=exc)
|
||||||
return _FailedBatch(exc, immediate=dead)
|
return _FailedBatch(exc, immediate=dead)
|
||||||
finally:
|
finally:
|
||||||
@@ -380,14 +385,21 @@ class EmbeddingClient:
|
|||||||
vectors = [_l2_normalize(v) for v in vectors]
|
vectors = [_l2_normalize(v) for v in vectors]
|
||||||
first = outcomes[0]
|
first = outcomes[0]
|
||||||
prompt_tokens = sum(o.result.prompt_tokens for o in outcomes)
|
prompt_tokens = sum(o.result.prompt_tokens for o in outcomes)
|
||||||
estimated = any(o.result.usage_source == "estimated" for o in outcomes)
|
# 三态合并优先级(解耦设计 §3.2 #10): 任一批不可得 → 整体不可得
|
||||||
|
sources = {o.result.usage_source for o in outcomes}
|
||||||
|
if "unavailable" in sources:
|
||||||
|
merged_source = "unavailable"
|
||||||
|
elif "estimated" in sources:
|
||||||
|
merged_source = "estimated"
|
||||||
|
else:
|
||||||
|
merged_source = "measured"
|
||||||
return EmbeddingResponse(
|
return EmbeddingResponse(
|
||||||
vectors=vectors,
|
vectors=vectors,
|
||||||
dim=first.result.dim,
|
dim=first.result.dim,
|
||||||
model=first.source.model,
|
model=first.source.model,
|
||||||
provider=first.source.provider,
|
provider=first.source.provider,
|
||||||
prompt_tokens=prompt_tokens,
|
prompt_tokens=prompt_tokens,
|
||||||
usage_source="estimated" if estimated else "measured",
|
usage_source=merged_source,
|
||||||
latency_ms=sum(o.latency_ms for o in outcomes),
|
latency_ms=sum(o.latency_ms for o in outcomes),
|
||||||
call_id=first.call_id,
|
call_id=first.call_id,
|
||||||
source_name=first.source.name,
|
source_name=first.source.name,
|
||||||
@@ -395,8 +407,15 @@ class EmbeddingClient:
|
|||||||
)
|
)
|
||||||
|
|
||||||
def _total_cost(self, outcomes: list[_BatchOutcome]) -> float | None:
|
def _total_cost(self, outcomes: list[_BatchOutcome]) -> float | None:
|
||||||
|
"""全批成本;任一批用量不可得则整体记 NULL(解耦设计 §3.2 #11)。
|
||||||
|
|
||||||
|
逐批求和会把不可得的批当 0 计入,给出一个偏低却看似有效的金额——
|
||||||
|
与"宁可算不出成本,也不算错成本"的不变式相悖。
|
||||||
|
"""
|
||||||
if self._pricing is None:
|
if self._pricing is None:
|
||||||
return None
|
return None
|
||||||
|
if any(o.result.usage_source == "unavailable" for o in outcomes):
|
||||||
|
return None
|
||||||
costs = [self._pricing.cost(o.source.model, o.result.prompt_tokens, 0) for o in outcomes]
|
costs = [self._pricing.cost(o.source.model, o.result.prompt_tokens, 0) for o in outcomes]
|
||||||
known = [c for c in costs if c is not None]
|
known = [c for c in costs if c is not None]
|
||||||
return sum(known) if known else None
|
return sum(known) if known else None
|
||||||
|
|||||||
@@ -23,7 +23,7 @@ class QuotaGate:
|
|||||||
|
|
||||||
async def try_acquire(self, source: SourceConfig) -> Permit | None:
|
async def try_acquire(self, source: SourceConfig) -> Permit | None:
|
||||||
try:
|
try:
|
||||||
return await self._limiter.try_acquire(source.name, source.est_tokens)
|
return await self._limiter.try_acquire(source.name, source.effective_est_tokens())
|
||||||
except GovernanceBackendError:
|
except GovernanceBackendError:
|
||||||
raise
|
raise
|
||||||
except Exception as exc:
|
except Exception as exc:
|
||||||
|
|||||||
@@ -335,6 +335,11 @@ class RetryMW:
|
|||||||
overlay=request.overlay,
|
overlay=request.overlay,
|
||||||
call_id=call_id,
|
call_id=call_id,
|
||||||
)
|
)
|
||||||
|
if result.usage_source == "unavailable":
|
||||||
|
# 用量不可得时按入场预扣量结算(delta==0),否则押金会被整笔退回,
|
||||||
|
# 对"从不返回 usage 帧"的源等于 TPM 闸失效(设计 §3.2 #9)
|
||||||
|
actual = source.effective_est_tokens()
|
||||||
|
else:
|
||||||
actual = result.prompt_tokens + result.completion_tokens
|
actual = result.prompt_tokens + result.completion_tokens
|
||||||
await self._record_quietly(self._breaker.record_success(entry))
|
await self._record_quietly(self._breaker.record_success(entry))
|
||||||
await self._record_quietly(self._quota.mark_progress())
|
await self._record_quietly(self._quota.mark_progress())
|
||||||
@@ -367,7 +372,8 @@ class RetryMW:
|
|||||||
self._pacer.on_backpressure(source.name)
|
self._pacer.on_backpressure(source.name)
|
||||||
await self._record_quietly(self._breaker.record_failure(entry, reason, dead))
|
await self._record_quietly(self._breaker.record_failure(entry, reason, dead))
|
||||||
if not dead:
|
if not dead:
|
||||||
actual = source.est_tokens # 保守: 失败请求可能已被网关计费(CHS 同款)
|
# 保守: 失败请求可能已被网关计费(CHS 同款);与入场预扣同源取值
|
||||||
|
actual = source.effective_est_tokens()
|
||||||
await self._emit(request, source, call_id, started, error=exc)
|
await self._emit(request, source, call_id, started, error=exc)
|
||||||
return _Failed(exc, immediate=dead)
|
return _Failed(exc, immediate=dead)
|
||||||
finally:
|
finally:
|
||||||
@@ -430,6 +436,8 @@ class RetryMW:
|
|||||||
source_name=source.name,
|
source_name=source.name,
|
||||||
cost=None,
|
cost=None,
|
||||||
usage_source=result.usage_source,
|
usage_source=result.usage_source,
|
||||||
|
cached_prompt_tokens=result.cached_prompt_tokens,
|
||||||
|
model_reported=result.model_reported,
|
||||||
)
|
)
|
||||||
|
|
||||||
async def _settle_and_release(self, permit: Permit, actual: int) -> None:
|
async def _settle_and_release(self, permit: Permit, actual: int) -> None:
|
||||||
|
|||||||
@@ -28,7 +28,7 @@ if TYPE_CHECKING:
|
|||||||
|
|
||||||
|
|
||||||
class TelemetryEmitter:
|
class TelemetryEmitter:
|
||||||
"""从请求与结果组装 18 字段并写入 recorder;一切写失败降级 warning。"""
|
"""从请求与结果组装 20 字段并写入 recorder;一切写失败降级 warning。"""
|
||||||
|
|
||||||
def __init__(self, recorder: TelemetryRecorder, *, pricing: PricingTable | None = None) -> None:
|
def __init__(self, recorder: TelemetryRecorder, *, pricing: PricingTable | None = None) -> None:
|
||||||
self._recorder = recorder
|
self._recorder = recorder
|
||||||
@@ -44,7 +44,7 @@ class TelemetryEmitter:
|
|||||||
response: LLMResponse | None,
|
response: LLMResponse | None,
|
||||||
error: str | None,
|
error: str | None,
|
||||||
) -> None:
|
) -> None:
|
||||||
"""逐次尝试记录(RetryMW 调用);失败尝试 usage 按 estimated 记 0。"""
|
"""逐次尝试记录(RetryMW 调用);失败尝试无用量可言,记 0 并标 unavailable。"""
|
||||||
await self._record(
|
await self._record(
|
||||||
request=request,
|
request=request,
|
||||||
call_id=call_id,
|
call_id=call_id,
|
||||||
@@ -55,12 +55,14 @@ class TelemetryEmitter:
|
|||||||
thinking=response.thinking if response else "",
|
thinking=response.thinking if response else "",
|
||||||
prompt_tokens=response.prompt_tokens if response else 0,
|
prompt_tokens=response.prompt_tokens if response else 0,
|
||||||
completion_tokens=response.completion_tokens if response else 0,
|
completion_tokens=response.completion_tokens if response else 0,
|
||||||
usage_source=response.usage_source if response else "estimated",
|
usage_source=response.usage_source if response else "unavailable",
|
||||||
latency_ms=latency_ms,
|
latency_ms=latency_ms,
|
||||||
ttft_ms=response.ttft_ms if response else None,
|
ttft_ms=response.ttft_ms if response else None,
|
||||||
max_inter_token_ms=response.max_inter_token_ms if response else None,
|
max_inter_token_ms=response.max_inter_token_ms if response else None,
|
||||||
cache_hit=False,
|
cache_hit=False,
|
||||||
error=error,
|
error=error,
|
||||||
|
cached_prompt_tokens=response.cached_prompt_tokens if response else None,
|
||||||
|
model_reported=response.model_reported if response else None,
|
||||||
)
|
)
|
||||||
|
|
||||||
async def emit_cache_hit(self, *, request: ChatRequest, response: LLMResponse) -> None:
|
async def emit_cache_hit(self, *, request: ChatRequest, response: LLMResponse) -> None:
|
||||||
@@ -81,6 +83,10 @@ class TelemetryEmitter:
|
|||||||
max_inter_token_ms=None,
|
max_inter_token_ms=None,
|
||||||
cache_hit=True,
|
cache_hit=True,
|
||||||
error=None,
|
error=None,
|
||||||
|
# 决策 B1: 与 model/prompt_tokens 同一口径,原样回放历史值。
|
||||||
|
# 统计供应商缓存命中率必须带 WHERE cache_hit = false,否则重复计数。
|
||||||
|
cached_prompt_tokens=response.cached_prompt_tokens,
|
||||||
|
model_reported=response.model_reported,
|
||||||
)
|
)
|
||||||
|
|
||||||
async def emit_terminal_failure(
|
async def emit_terminal_failure(
|
||||||
@@ -97,12 +103,14 @@ class TelemetryEmitter:
|
|||||||
thinking="",
|
thinking="",
|
||||||
prompt_tokens=0,
|
prompt_tokens=0,
|
||||||
completion_tokens=0,
|
completion_tokens=0,
|
||||||
usage_source="estimated",
|
usage_source="unavailable",
|
||||||
latency_ms=latency_ms,
|
latency_ms=latency_ms,
|
||||||
ttft_ms=None,
|
ttft_ms=None,
|
||||||
max_inter_token_ms=None,
|
max_inter_token_ms=None,
|
||||||
cache_hit=False,
|
cache_hit=False,
|
||||||
error=error,
|
error=error,
|
||||||
|
cached_prompt_tokens=None,
|
||||||
|
model_reported=None,
|
||||||
)
|
)
|
||||||
|
|
||||||
async def _record(
|
async def _record(
|
||||||
@@ -123,14 +131,22 @@ class TelemetryEmitter:
|
|||||||
max_inter_token_ms: float | None,
|
max_inter_token_ms: float | None,
|
||||||
cache_hit: bool,
|
cache_hit: bool,
|
||||||
error: str | None,
|
error: str | None,
|
||||||
|
cached_prompt_tokens: int | None,
|
||||||
|
model_reported: str | None,
|
||||||
) -> None:
|
) -> None:
|
||||||
try:
|
try:
|
||||||
# 成本换算(M2 §6): 成功行按单价换算;缓存命中 0.0(未产生新调用);
|
# 成本换算(M2 §6): 成功行按单价换算;缓存命中 0.0(未产生新调用);
|
||||||
# 失败/终态行 None;未注入价格表 = 恒 None(M1 现状)
|
# 失败/终态行 None;未注入价格表 = 恒 None(M1 现状)
|
||||||
if cache_hit:
|
if cache_hit:
|
||||||
cost: float | None = 0.0
|
cost: float | None = 0.0
|
||||||
|
elif usage_source == "unavailable":
|
||||||
|
# 用量不可得: 宁可算不出成本,也不算错成本(解耦设计 §3.1 不变式)。
|
||||||
|
# 必须排在 cache_hit 之后——缓存命中未产生新调用,0.0 是事实而非未知
|
||||||
|
cost = None
|
||||||
elif error is None and model and self._pricing is not None:
|
elif error is None and model and self._pricing is not None:
|
||||||
cost = self._pricing.cost(model, prompt_tokens, completion_tokens)
|
cost = self._pricing.cost(
|
||||||
|
model, prompt_tokens, completion_tokens, cached_prompt_tokens
|
||||||
|
)
|
||||||
else:
|
else:
|
||||||
cost = None
|
cost = None
|
||||||
# messages 落库前多模态摘要,与缓存 key 共用同一函数(VT R12)
|
# messages 落库前多模态摘要,与缓存 key 共用同一函数(VT R12)
|
||||||
@@ -154,6 +170,8 @@ class TelemetryEmitter:
|
|||||||
cache_hit=cache_hit,
|
cache_hit=cache_hit,
|
||||||
error=error,
|
error=error,
|
||||||
cost=cost,
|
cost=cost,
|
||||||
|
cached_prompt_tokens=cached_prompt_tokens,
|
||||||
|
model_reported=model_reported,
|
||||||
)
|
)
|
||||||
except asyncio.CancelledError:
|
except asyncio.CancelledError:
|
||||||
raise
|
raise
|
||||||
|
|||||||
@@ -245,7 +245,11 @@ class StructuredOutputStrategy(Protocol):
|
|||||||
|
|
||||||
@runtime_checkable
|
@runtime_checkable
|
||||||
class TelemetryRecorder(Protocol):
|
class TelemetryRecorder(Protocol):
|
||||||
"""遥测后端;18 字段冻结(M1 设计 §4.4),唯一调用点是 TelemetryEmitter。"""
|
"""遥测后端;20 字段冻结(M1 设计 §4.4 + issue #3),唯一调用点是 TelemetryEmitter。
|
||||||
|
|
||||||
|
新增参数不设默认值: 库外无第三方实现者(三项目迁移时删除了各自的同名
|
||||||
|
Protocol),完整签名的成本为零,而少写一列会被 emitter 的降级吞成 warning。
|
||||||
|
"""
|
||||||
|
|
||||||
async def record_llm_call(
|
async def record_llm_call(
|
||||||
self,
|
self,
|
||||||
@@ -268,4 +272,6 @@ class TelemetryRecorder(Protocol):
|
|||||||
cache_hit: bool,
|
cache_hit: bool,
|
||||||
error: str | None,
|
error: str | None,
|
||||||
cost: float | None,
|
cost: float | None,
|
||||||
|
cached_prompt_tokens: int | None,
|
||||||
|
model_reported: str | None,
|
||||||
) -> None: ...
|
) -> None: ...
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
**零内置单价**: 实验室走中转网关,计费非官方牌价;库内硬编码单价表
|
**零内置单价**: 实验室走中转网关,计费非官方牌价;库内硬编码单价表
|
||||||
必然过时并掩盖真实成本(P5 严禁默认值掩盖错误)。价格一律由使用方
|
必然过时并掩盖真实成本(P5 严禁默认值掩盖错误)。价格一律由使用方
|
||||||
提供——JSON 文件(`PGW_PRICING_PATH`)或 dict 注入;币种由使用方全表
|
提供——JSON 文件(`PGW_PRICING_PATH`)或 dict 注入;币种由使用方全表
|
||||||
统一口径,库不设币种字段(18 字段冻结)。查不到的 model → cost=None
|
统一口径,库不设币种字段(20 字段冻结)。查不到的 model → cost=None
|
||||||
且每 model 仅首次 warning(防日志风暴),不阻塞调用。
|
且每 model 仅首次 warning(防日志风暴),不阻塞调用。
|
||||||
"""
|
"""
|
||||||
|
|
||||||
@@ -22,22 +22,33 @@ if TYPE_CHECKING:
|
|||||||
|
|
||||||
@dataclass(frozen=True)
|
@dataclass(frozen=True)
|
||||||
class ModelPrice:
|
class ModelPrice:
|
||||||
"""每百万 token 的输入/输出单价(币种由使用方口径统一)。"""
|
"""每百万 token 的输入/输出单价(币种由使用方口径统一)。
|
||||||
|
|
||||||
|
`cached_input_per_1m` 是可选的**缓存读取单价**(issue #3): 供应商 prompt
|
||||||
|
cache 命中的那部分输入按更低单价计费。不填即不启用——库绝不按经验折扣率
|
||||||
|
猜一个数(P5 严禁默认值掩盖),未填时全额按 `input_per_1m` 计。
|
||||||
|
"""
|
||||||
|
|
||||||
input_per_1m: float
|
input_per_1m: float
|
||||||
output_per_1m: float
|
output_per_1m: float
|
||||||
|
cached_input_per_1m: float | None = None
|
||||||
|
|
||||||
def __post_init__(self) -> None:
|
def __post_init__(self) -> None:
|
||||||
if self.input_per_1m < 0 or self.output_per_1m < 0:
|
if self.input_per_1m < 0 or self.output_per_1m < 0:
|
||||||
raise ValueError("单价不能为负")
|
raise ValueError("单价不能为负")
|
||||||
|
if self.cached_input_per_1m is not None and self.cached_input_per_1m < 0:
|
||||||
|
raise ValueError("缓存读取单价不能为负")
|
||||||
|
|
||||||
|
|
||||||
class PricingTable:
|
class PricingTable:
|
||||||
"""model → 单价 的只读表;cost() 是全库唯一换算点(经 TelemetryEmitter)。"""
|
"""model → 单价 的只读表;cost() 有两个调用点: `TelemetryEmitter`(chat 主路径)
|
||||||
|
与 `embedding.py` 的批量换算。"""
|
||||||
|
|
||||||
def __init__(self, prices: Mapping[str, ModelPrice]) -> None:
|
def __init__(self, prices: Mapping[str, ModelPrice]) -> None:
|
||||||
self._prices = dict(prices)
|
self._prices = dict(prices)
|
||||||
self._warned: set[str] = set()
|
self._warned: set[str] = set()
|
||||||
|
# 独立集合: 与"未知 model"的告警去重键分开,避免 model 名恰好撞上时互相抑制
|
||||||
|
self._warned_clamp: set[str] = set()
|
||||||
|
|
||||||
@classmethod
|
@classmethod
|
||||||
def from_file(cls, path: Path | str) -> PricingTable:
|
def from_file(cls, path: Path | str) -> PricingTable:
|
||||||
@@ -53,21 +64,61 @@ class PricingTable:
|
|||||||
for model, entry in data.items():
|
for model, entry in data.items():
|
||||||
if not isinstance(entry, dict) or not {"input_per_1m", "output_per_1m"} <= set(entry):
|
if not isinstance(entry, dict) or not {"input_per_1m", "output_per_1m"} <= set(entry):
|
||||||
raise ValueError(f"价格表 {p} 条目 {model!r} 须含 input_per_1m 与 output_per_1m")
|
raise ValueError(f"价格表 {p} 条目 {model!r} 须含 input_per_1m 与 output_per_1m")
|
||||||
|
cached_raw = entry.get("cached_input_per_1m")
|
||||||
|
try:
|
||||||
|
cached = None if cached_raw is None else float(cached_raw)
|
||||||
|
except (TypeError, ValueError) as exc:
|
||||||
|
raise ValueError(
|
||||||
|
f"价格表 {p} 条目 {model!r} 的 cached_input_per_1m 必须是数字: {cached_raw!r}"
|
||||||
|
) from exc
|
||||||
|
if cached is not None and cached < 0:
|
||||||
|
raise ValueError(f"价格表 {p} 条目 {model!r} 的 cached_input_per_1m 不能为负")
|
||||||
prices[model] = ModelPrice(
|
prices[model] = ModelPrice(
|
||||||
input_per_1m=float(entry["input_per_1m"]),
|
input_per_1m=float(entry["input_per_1m"]),
|
||||||
output_per_1m=float(entry["output_per_1m"]),
|
output_per_1m=float(entry["output_per_1m"]),
|
||||||
|
cached_input_per_1m=cached,
|
||||||
)
|
)
|
||||||
return cls(prices)
|
return cls(prices)
|
||||||
|
|
||||||
def cost(self, model: str, prompt_tokens: int, completion_tokens: int) -> float | None:
|
def cost(
|
||||||
"""换算一次调用成本;未知 model 记 None 并仅首次 warning。"""
|
self,
|
||||||
|
model: str,
|
||||||
|
prompt_tokens: int,
|
||||||
|
completion_tokens: int,
|
||||||
|
cached_prompt_tokens: int | None = None,
|
||||||
|
) -> float | None:
|
||||||
|
"""换算一次调用成本;未知 model 记 None 并仅首次 warning。
|
||||||
|
|
||||||
|
`cached_prompt_tokens` 是供应商 prompt cache 命中的输入 token 数
|
||||||
|
(issue #3);仅当该 model 配了 `cached_input_per_1m` 时才分段计价,
|
||||||
|
否则全额按输入价——不猜折扣率。参数带默认值: embedding 侧的三参调用
|
||||||
|
形态不受影响。
|
||||||
|
"""
|
||||||
price = self._prices.get(model)
|
price = self._prices.get(model)
|
||||||
if price is None:
|
if price is None:
|
||||||
if model not in self._warned:
|
if model not in self._warned:
|
||||||
self._warned.add(model)
|
self._warned.add(model)
|
||||||
logger.warning("pricing 表无 model {!r} 的单价,cost 记 None", model)
|
logger.warning("pricing 表无 model {!r} 的单价,cost 记 None", model)
|
||||||
return None
|
return None
|
||||||
return (
|
billed_input = prompt_tokens / 1_000_000 * price.input_per_1m
|
||||||
prompt_tokens / 1_000_000 * price.input_per_1m
|
# 负数按"无命中"处理: cost() 是公共方法,不能假定调用方已过 transport 的校验
|
||||||
+ completion_tokens / 1_000_000 * price.output_per_1m
|
if price.cached_input_per_1m is not None and (cached_prompt_tokens or 0) > 0:
|
||||||
|
cached = self._clamp_cached(model, prompt_tokens, cached_prompt_tokens)
|
||||||
|
billed_input = (prompt_tokens - cached) / 1_000_000 * price.input_per_1m + (
|
||||||
|
cached / 1_000_000 * price.cached_input_per_1m
|
||||||
)
|
)
|
||||||
|
return billed_input + completion_tokens / 1_000_000 * price.output_per_1m
|
||||||
|
|
||||||
|
def _clamp_cached(self, model: str, prompt_tokens: int, cached: int) -> int:
|
||||||
|
"""命中数按输入总数夹取: 网关口径异常不得算出负成本(每 model 只警告一次)。"""
|
||||||
|
if cached <= prompt_tokens:
|
||||||
|
return cached
|
||||||
|
if model not in self._warned_clamp:
|
||||||
|
self._warned_clamp.add(model)
|
||||||
|
logger.warning(
|
||||||
|
"model {!r} 上报的缓存命中 {} 超过输入总数 {},按总数夹取计价",
|
||||||
|
model,
|
||||||
|
cached,
|
||||||
|
prompt_tokens,
|
||||||
|
)
|
||||||
|
return prompt_tokens
|
||||||
|
|||||||
@@ -6,7 +6,7 @@
|
|||||||
① 结构性失败(建池/建表)→ warning 一次后永久降级(池置 None 短路);
|
① 结构性失败(建池/建表)→ warning 一次后永久降级(池置 None 短路);
|
||||||
② 运行时单条写失败 → 逐条 warning 丢弃,不降级不重试(连接抖动由
|
② 运行时单条写失败 → 逐条 warning 丢弃,不降级不重试(连接抖动由
|
||||||
asyncpg 池自恢复;避免浸泡开头一次抖动导致后续全程失遥测)。
|
asyncpg 池自恢复;避免浸泡开头一次抖动导致后续全程失遥测)。
|
||||||
构造不连库(lazy),18 列 schema 与 SQLite 版同名同序。
|
构造不连库(lazy),20 列 schema 与 SQLite 版同名同序。
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
@@ -39,10 +39,24 @@ CREATE TABLE IF NOT EXISTS llm_calls (
|
|||||||
cache_hit BOOLEAN NOT NULL DEFAULT FALSE,
|
cache_hit BOOLEAN NOT NULL DEFAULT FALSE,
|
||||||
error TEXT,
|
error TEXT,
|
||||||
cost DOUBLE PRECISION,
|
cost DOUBLE PRECISION,
|
||||||
created_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
created_at TIMESTAMPTZ NOT NULL DEFAULT now(),
|
||||||
|
cached_prompt_tokens INTEGER,
|
||||||
|
model_reported TEXT
|
||||||
);
|
);
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
# 新列排在 created_at 之后: 与旧表 ALTER 追加的位置一致(见 sqlite.py 同款注释)
|
||||||
|
_BACKFILL = (
|
||||||
|
("cached_prompt_tokens", "ALTER TABLE llm_calls ADD COLUMN cached_prompt_tokens INTEGER"),
|
||||||
|
("model_reported", "ALTER TABLE llm_calls ADD COLUMN model_reported TEXT"),
|
||||||
|
)
|
||||||
|
|
||||||
|
# 探测现有列;尊重 search_path(to_regclass 按当前 search_path 解析)
|
||||||
|
_EXISTING_COLUMNS = (
|
||||||
|
"SELECT attname FROM pg_attribute "
|
||||||
|
"WHERE attrelid = to_regclass('llm_calls') AND attnum > 0 AND NOT attisdropped"
|
||||||
|
)
|
||||||
|
|
||||||
_COLUMNS = (
|
_COLUMNS = (
|
||||||
"call_id",
|
"call_id",
|
||||||
"parent_call_id",
|
"parent_call_id",
|
||||||
@@ -62,6 +76,8 @@ _COLUMNS = (
|
|||||||
"cache_hit",
|
"cache_hit",
|
||||||
"error",
|
"error",
|
||||||
"cost",
|
"cost",
|
||||||
|
"cached_prompt_tokens",
|
||||||
|
"model_reported",
|
||||||
)
|
)
|
||||||
|
|
||||||
_INSERT = (
|
_INSERT = (
|
||||||
@@ -104,6 +120,7 @@ class PostgresRecorder:
|
|||||||
self._pool = await asyncpg.create_pool(self._dsn, timeout=10)
|
self._pool = await asyncpg.create_pool(self._dsn, timeout=10)
|
||||||
async with self._pool.acquire() as conn:
|
async with self._pool.acquire() as conn:
|
||||||
await conn.execute(_DDL)
|
await conn.execute(_DDL)
|
||||||
|
await self._backfill_columns(conn)
|
||||||
self._schema_ready = True
|
self._schema_ready = True
|
||||||
return self._pool
|
return self._pool
|
||||||
except asyncio.CancelledError:
|
except asyncio.CancelledError:
|
||||||
@@ -113,6 +130,29 @@ class PostgresRecorder:
|
|||||||
logger.warning("Postgres 遥测初始化失败,后续记录降级为 no-op: {}", exc)
|
logger.warning("Postgres 遥测初始化失败,后续记录降级为 no-op: {}", exc)
|
||||||
return None
|
return None
|
||||||
|
|
||||||
|
async def _backfill_columns(self, conn: object) -> None:
|
||||||
|
"""给已存在的旧表补新列(issue #3);**先探测再 ALTER,失败绝不置 `_failed`**。
|
||||||
|
|
||||||
|
两条纪律各有实测理由:
|
||||||
|
① 不置 `_failed`: 应用账号只有 INSERT 权限时,`ALTER TABLE` 的 ownership
|
||||||
|
检查早于 `IF NOT EXISTS` 的存在性判断——列明明齐全也会失败。置位会让
|
||||||
|
整个 recorder 永久 no-op,与「补列失败只降级为逐行丢弃」的承诺相悖
|
||||||
|
(SQLite 侧同款守卫,两侧必须对称)。
|
||||||
|
② 先探测: `ADD COLUMN IF NOT EXISTS` 即便列已存在,也会**先取 ACCESS
|
||||||
|
EXCLUSIVE 锁**再判存在性(实测会被一个开着的读事务阻塞)。遥测是内联
|
||||||
|
await,让每个进程的首次写入都去抢共享审计表的排他锁,等于用记录基础设施
|
||||||
|
拖垮业务调用。探测走 ACCESS SHARE,稳态下一条 ALTER 都不会发。
|
||||||
|
"""
|
||||||
|
try:
|
||||||
|
existing = {row["attname"] for row in await conn.fetch(_EXISTING_COLUMNS)} # type: ignore[attr-defined]
|
||||||
|
for column, statement in _BACKFILL:
|
||||||
|
if column not in existing:
|
||||||
|
await conn.execute(statement) # type: ignore[attr-defined]
|
||||||
|
except asyncio.CancelledError:
|
||||||
|
raise
|
||||||
|
except Exception as exc:
|
||||||
|
logger.warning("Postgres 遥测补列失败(写入将逐行降级): {}", exc)
|
||||||
|
|
||||||
async def record_llm_call(self, **fields: object) -> None:
|
async def record_llm_call(self, **fields: object) -> None:
|
||||||
"""写一行遥测;单条失败逐条 warning 丢弃(两级降级之二),绝不冒泡。"""
|
"""写一行遥测;单条失败逐条 warning 丢弃(两级降级之二),绝不冒泡。"""
|
||||||
pool = await self._ensure_ready()
|
pool = await self._ensure_ready()
|
||||||
|
|||||||
@@ -34,10 +34,16 @@ CREATE TABLE IF NOT EXISTS llm_calls (
|
|||||||
cache_hit INTEGER NOT NULL DEFAULT 0,
|
cache_hit INTEGER NOT NULL DEFAULT 0,
|
||||||
error TEXT,
|
error TEXT,
|
||||||
cost REAL,
|
cost REAL,
|
||||||
created_at TEXT NOT NULL DEFAULT (datetime('now'))
|
created_at TEXT NOT NULL DEFAULT (datetime('now')),
|
||||||
|
cached_prompt_tokens INTEGER,
|
||||||
|
model_reported TEXT
|
||||||
);
|
);
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
# 新列必须排在 created_at 之后: 旧表只能经 ALTER 追加到末尾,新建库若把它们
|
||||||
|
# 插在前面,两条路径的物理列序会分叉(列序断言测试无合规修法)。
|
||||||
|
_BACKFILL_COLUMNS = (("cached_prompt_tokens", "INTEGER"), ("model_reported", "TEXT"))
|
||||||
|
|
||||||
_COLUMNS = (
|
_COLUMNS = (
|
||||||
"call_id",
|
"call_id",
|
||||||
"parent_call_id",
|
"parent_call_id",
|
||||||
@@ -57,6 +63,8 @@ _COLUMNS = (
|
|||||||
"cache_hit",
|
"cache_hit",
|
||||||
"error",
|
"error",
|
||||||
"cost",
|
"cost",
|
||||||
|
"cached_prompt_tokens",
|
||||||
|
"model_reported",
|
||||||
)
|
)
|
||||||
|
|
||||||
_INSERT = (
|
_INSERT = (
|
||||||
@@ -82,9 +90,37 @@ class SQLiteRecorder:
|
|||||||
self._conn = conn
|
self._conn = conn
|
||||||
except (OSError, sqlite3.Error) as exc:
|
except (OSError, sqlite3.Error) as exc:
|
||||||
logger.warning("SQLite 遥测初始化失败,后续记录降级为 no-op: {}", exc)
|
logger.warning("SQLite 遥测初始化失败,后续记录降级为 no-op: {}", exc)
|
||||||
|
self._backfill_columns()
|
||||||
|
|
||||||
|
def _backfill_columns(self) -> None:
|
||||||
|
"""给已存在的旧表补新列(issue #3);独立 try,失败只降级为逐行丢弃。
|
||||||
|
|
||||||
|
必须放在 `self._conn` 赋值**之后**并先判空: 初始化失败时连接为 None,
|
||||||
|
无守卫的补列会抛 AttributeError 逃出 `__init__`,把"静默降级"变成崩溃。
|
||||||
|
补列失败也绝不清空 `self._conn`——那会让整个 recorder 永久 no-op,
|
||||||
|
比逐行丢弃严重得多。
|
||||||
|
"""
|
||||||
|
if self._conn is None:
|
||||||
|
return
|
||||||
|
try:
|
||||||
|
existing = {row[1] for row in self._conn.execute("PRAGMA table_info(llm_calls)")}
|
||||||
|
except sqlite3.Error as exc:
|
||||||
|
logger.warning("SQLite 遥测列探测失败(写入将逐行降级): {}", exc)
|
||||||
|
return
|
||||||
|
for column, decl in _BACKFILL_COLUMNS:
|
||||||
|
if column in existing:
|
||||||
|
continue
|
||||||
|
# 逐列独立 try: 一列撞上 duplicate 不得让后面的列漏补
|
||||||
|
try:
|
||||||
|
self._conn.execute(f"ALTER TABLE llm_calls ADD COLUMN {column} {decl}")
|
||||||
|
self._conn.commit()
|
||||||
|
except sqlite3.Error as exc:
|
||||||
|
# duplicate column: 多进程共库时后到者必然撞上,属预期竞态,视为成功
|
||||||
|
if "duplicate column" not in str(exc).lower():
|
||||||
|
logger.warning("SQLite 遥测补列失败(写入将逐行降级): {}", exc)
|
||||||
|
|
||||||
async def record_llm_call(self, **fields: object) -> None:
|
async def record_llm_call(self, **fields: object) -> None:
|
||||||
"""写一行遥测;字段集合即 18 字段冻结签名(ports.TelemetryRecorder)。"""
|
"""写一行遥测;字段集合即 20 字段冻结签名(ports.TelemetryRecorder)。"""
|
||||||
if self._conn is None:
|
if self._conn is None:
|
||||||
return
|
return
|
||||||
row = tuple(fields[col] for col in _COLUMNS)
|
row = tuple(fields[col] for col in _COLUMNS)
|
||||||
|
|||||||
@@ -45,6 +45,12 @@ def _sse_delta(chunk: dict[str, Any], usage_sink: dict[str, Any]) -> tuple[bool,
|
|||||||
"""从 chunk 提取增量: (True, content) 或 (False, reasoning);usage 帧旁路进 sink。"""
|
"""从 chunk 提取增量: (True, content) 或 (False, reasoning);usage 帧旁路进 sink。"""
|
||||||
if chunk.get("usage"):
|
if chunk.get("usage"):
|
||||||
usage_sink["usage"] = chunk["usage"]
|
usage_sink["usage"] = chunk["usage"]
|
||||||
|
if "model" not in usage_sink:
|
||||||
|
# 首个**有效**值即固定: 末帧的异常值不得覆盖它;但首帧报空串也不能锁死
|
||||||
|
# sink——否则后续真实版本会丢(issue #3)
|
||||||
|
reported = _coerce_model_reported(chunk.get("model"))
|
||||||
|
if reported is not None:
|
||||||
|
usage_sink["model"] = reported
|
||||||
choices = chunk.get("choices") or []
|
choices = chunk.get("choices") or []
|
||||||
if not choices:
|
if not choices:
|
||||||
return None
|
return None
|
||||||
@@ -138,12 +144,60 @@ def _strip_think(content: str) -> tuple[str, str]:
|
|||||||
return _THINK_PATTERN.sub("", content).strip(), match.group(1).strip()
|
return _THINK_PATTERN.sub("", content).strip(), match.group(1).strip()
|
||||||
|
|
||||||
|
|
||||||
def _resolve_usage(usage: dict[str, Any], source: SourceConfig) -> tuple[int, int, str]:
|
def _resolve_usage(usage: dict[str, Any]) -> tuple[int, int, str]:
|
||||||
"""usage 帧读取;缺失/非法按 est_tokens 保守兜底并标 estimated(CHS invokers.py:241)。"""
|
"""usage 帧读取;缺失/非法记 0/0 并标 unavailable(est_tokens 解耦设计 §3.2 #3)。
|
||||||
|
|
||||||
|
不再拿 `est_tokens` 兜底: 它按 CHS 定义是"最坏情形上界",拿上界当实测值
|
||||||
|
只会系统性高估账单;宁可把用量记成显式的"不可得"(cost 随之为 NULL),
|
||||||
|
让缺口可被统计,也不编一个看似有效的数字。用量口径自此不依赖源配置,
|
||||||
|
故不再收 `SourceConfig`。
|
||||||
|
"""
|
||||||
prompt, completion = usage.get("prompt_tokens"), usage.get("completion_tokens")
|
prompt, completion = usage.get("prompt_tokens"), usage.get("completion_tokens")
|
||||||
if isinstance(prompt, int) and isinstance(completion, int) and prompt + completion > 0:
|
if isinstance(prompt, int) and isinstance(completion, int) and prompt + completion > 0:
|
||||||
return prompt, completion, "measured"
|
return prompt, completion, "measured"
|
||||||
return 0, source.est_tokens, "estimated"
|
return 0, 0, "unavailable"
|
||||||
|
|
||||||
|
|
||||||
|
def _coerce_cached_tokens(usage: Any) -> int | None:
|
||||||
|
"""取 usage.prompt_tokens_details.cached_tokens(issue #3);形态异常一律 None。
|
||||||
|
|
||||||
|
`0` 与 `None` 必须可区分: 前者是"该源上报了一次真实零命中",后者是"该源
|
||||||
|
不报这个数",下游对两者的处置不同(后者不可做缓存成本校正)。故只把
|
||||||
|
**负数与非整数**归 None,`0` 如实保留。`bool` 显式排除——isinstance(True, int)
|
||||||
|
在 Python 里为真,放行会把 `True` 记成 1 个命中 token。
|
||||||
|
"""
|
||||||
|
if not isinstance(usage, dict):
|
||||||
|
return None
|
||||||
|
details = usage.get("prompt_tokens_details")
|
||||||
|
if not isinstance(details, dict):
|
||||||
|
return None
|
||||||
|
cached = details.get("cached_tokens")
|
||||||
|
if isinstance(cached, bool) or not isinstance(cached, int) or cached < 0:
|
||||||
|
return None
|
||||||
|
return cached
|
||||||
|
|
||||||
|
|
||||||
|
def _coerce_model_reported(value: Any) -> str | None:
|
||||||
|
"""取响应体的 model 字段(issue #3);非 str 或空白串一律 None,收口时去空白。
|
||||||
|
|
||||||
|
去空白不是洁癖: 下游拿这个串做实验快照的 key,`" m "` 与 `"m"` 会造成假分叉。
|
||||||
|
"""
|
||||||
|
if not isinstance(value, str) or not value.strip():
|
||||||
|
return None
|
||||||
|
return value.strip()
|
||||||
|
|
||||||
|
|
||||||
|
def _resolve_stream_usage(sink: dict[str, Any], salvaged: bool) -> tuple[int, int, str]:
|
||||||
|
"""流式用量口径: 打捞路径把 measured 降级为 estimated,unavailable 原样保留。
|
||||||
|
|
||||||
|
前置条件不可省(解耦设计 §3.2 #4): usage 帧本就缺失时 `0/0` 会被洗成
|
||||||
|
`estimated`,进而按 token 换算出一个假的 `0.0` 成本。
|
||||||
|
"""
|
||||||
|
prompt, completion, usage_source = _resolve_usage(sink.get("usage") or {})
|
||||||
|
if salvaged and usage_source == "measured":
|
||||||
|
# 收到 usage 帧但流被截断: 数字真实、可信度降级(M1 设计 §6)
|
||||||
|
usage_source = "estimated"
|
||||||
|
return prompt, completion, usage_source
|
||||||
|
|
||||||
|
|
||||||
def _extract_vectors(
|
def _extract_vectors(
|
||||||
@@ -168,12 +222,12 @@ def _extract_vectors(
|
|||||||
return vectors
|
return vectors
|
||||||
|
|
||||||
|
|
||||||
def _resolve_embedding_usage(data: dict[str, Any], source: SourceConfig) -> tuple[int, str]:
|
def _resolve_embedding_usage(data: dict[str, Any]) -> tuple[int, str]:
|
||||||
"""usage 读取;缺失/非法按 est_tokens 保守兜底并标 estimated(与 chat 同口径)。"""
|
"""usage 读取;缺失/非法记 0 并标 unavailable(与 chat 同口径,设计 §3.2 #3)。"""
|
||||||
prompt = (data.get("usage") or {}).get("prompt_tokens")
|
prompt = (data.get("usage") or {}).get("prompt_tokens")
|
||||||
if isinstance(prompt, int) and prompt > 0:
|
if isinstance(prompt, int) and prompt > 0:
|
||||||
return prompt, "measured"
|
return prompt, "measured"
|
||||||
return source.est_tokens, "estimated"
|
return 0, "unavailable"
|
||||||
|
|
||||||
|
|
||||||
def _parse_embedding_payload(
|
def _parse_embedding_payload(
|
||||||
@@ -186,7 +240,7 @@ def _parse_embedding_payload(
|
|||||||
except json.JSONDecodeError as exc:
|
except json.JSONDecodeError as exc:
|
||||||
raise ResultInvalidError(f"{source.name} embedding 响应非 JSON: {exc}", **ctx) from exc
|
raise ResultInvalidError(f"{source.name} embedding 响应非 JSON: {exc}", **ctx) from exc
|
||||||
vectors = _extract_vectors(data, source, expected_count, ctx)
|
vectors = _extract_vectors(data, source, expected_count, ctx)
|
||||||
prompt_tokens, usage_source = _resolve_embedding_usage(data, source)
|
prompt_tokens, usage_source = _resolve_embedding_usage(data)
|
||||||
return EmbeddingTransportResult(
|
return EmbeddingTransportResult(
|
||||||
vectors=vectors,
|
vectors=vectors,
|
||||||
dim=len(vectors[0]),
|
dim=len(vectors[0]),
|
||||||
@@ -331,9 +385,7 @@ class OpenAICompatTransport:
|
|||||||
salvaged = self._check_done(sink, content_parts, thinking_parts, source)
|
salvaged = self._check_done(sink, content_parts, thinking_parts, source)
|
||||||
content, thinking = self._finalize_text(content_parts, thinking_parts, profile)
|
content, thinking = self._finalize_text(content_parts, thinking_parts, profile)
|
||||||
self._reject_empty_completion(content, source)
|
self._reject_empty_completion(content, source)
|
||||||
prompt, completion, usage_source = _resolve_usage(sink.get("usage") or {}, source)
|
prompt, completion, usage_source = _resolve_stream_usage(sink, salvaged)
|
||||||
if salvaged:
|
|
||||||
usage_source = "estimated" # 打捞路径强制 estimated(设计 §6)
|
|
||||||
return TransportResult(
|
return TransportResult(
|
||||||
content=content,
|
content=content,
|
||||||
thinking=thinking,
|
thinking=thinking,
|
||||||
@@ -343,6 +395,8 @@ class OpenAICompatTransport:
|
|||||||
ttft_ms=ttft_ms,
|
ttft_ms=ttft_ms,
|
||||||
max_inter_token_ms=(max_gap if ttft_ms is not None else None),
|
max_inter_token_ms=(max_gap if ttft_ms is not None else None),
|
||||||
raw={"usage": sink.get("usage")},
|
raw={"usage": sink.get("usage")},
|
||||||
|
cached_prompt_tokens=_coerce_cached_tokens(sink.get("usage")),
|
||||||
|
model_reported=_coerce_model_reported(sink.get("model")),
|
||||||
)
|
)
|
||||||
|
|
||||||
def _check_done(
|
def _check_done(
|
||||||
@@ -415,7 +469,7 @@ class OpenAICompatTransport:
|
|||||||
[message.get("content") or ""], [message.get("reasoning_content") or ""], profile
|
[message.get("content") or ""], [message.get("reasoning_content") or ""], profile
|
||||||
)
|
)
|
||||||
self._reject_empty_completion(content, source)
|
self._reject_empty_completion(content, source)
|
||||||
prompt, completion, usage_source = _resolve_usage(body.get("usage") or {}, source)
|
prompt, completion, usage_source = _resolve_usage(body.get("usage") or {})
|
||||||
return TransportResult(
|
return TransportResult(
|
||||||
content=content,
|
content=content,
|
||||||
thinking=thinking,
|
thinking=thinking,
|
||||||
@@ -425,6 +479,8 @@ class OpenAICompatTransport:
|
|||||||
ttft_ms=None,
|
ttft_ms=None,
|
||||||
max_inter_token_ms=None,
|
max_inter_token_ms=None,
|
||||||
raw={"usage": body.get("usage")},
|
raw={"usage": body.get("usage")},
|
||||||
|
cached_prompt_tokens=_coerce_cached_tokens(body.get("usage")),
|
||||||
|
model_reported=_coerce_model_reported(body.get("model")),
|
||||||
)
|
)
|
||||||
|
|
||||||
async def aclose(self) -> None:
|
async def aclose(self) -> None:
|
||||||
|
|||||||
@@ -9,6 +9,12 @@ from typing import Any
|
|||||||
|
|
||||||
_MISSING_DONE_DOMAIN = frozenset({"retry", "salvage"})
|
_MISSING_DONE_DOMAIN = frozenset({"retry", "salvage"})
|
||||||
|
|
||||||
|
USAGE_SOURCES = frozenset({"measured", "estimated", "unavailable"})
|
||||||
|
"""usage_source 值域;仅约束库内生产侧取值,不在 frozen dataclass 上做运行时校验。"""
|
||||||
|
|
||||||
|
_EST_TOKENS_QUOTA_DIVISOR = 60
|
||||||
|
"""未显式配置时的预扣量除数: 假定一次调用约占一秒钟的 TPM 配额份额。"""
|
||||||
|
|
||||||
|
|
||||||
@dataclass(frozen=True)
|
@dataclass(frozen=True)
|
||||||
class LLMResponse:
|
class LLMResponse:
|
||||||
@@ -24,12 +30,20 @@ class LLMResponse:
|
|||||||
ttft_ms: float | None
|
ttft_ms: float | None
|
||||||
max_inter_token_ms: float | None
|
max_inter_token_ms: float | None
|
||||||
cache_hit: bool
|
cache_hit: bool
|
||||||
|
"""**PolyGateway 自身响应缓存**命中(未产生网关调用);与供应商侧 prompt
|
||||||
|
cache 无关,后者见 `cached_prompt_tokens`。"""
|
||||||
call_id: str
|
call_id: str
|
||||||
# —— 库新增(只增不删,必带默认值;迁移兼容硬约束)——
|
# —— 库新增(只增不删,必带默认值;迁移兼容硬约束)——
|
||||||
source_name: str = ""
|
source_name: str = ""
|
||||||
cost: float | None = None
|
cost: float | None = None
|
||||||
usage_source: str = "measured"
|
usage_source: str = "measured"
|
||||||
structured_data: Any | None = None
|
structured_data: Any | None = None
|
||||||
|
cached_prompt_tokens: int | None = None
|
||||||
|
"""供应商 prompt cache 命中的输入 token 数(issue #3);None = 该源未上报,
|
||||||
|
与"上报了但是 0"(真实零命中)区分——两者对下游的处置不同。"""
|
||||||
|
model_reported: str | None = None
|
||||||
|
"""API 响应体里的 model 字段;None = 未上报。与 `model`(配置别名)可能
|
||||||
|
分叉——供应商把别名指向新权重时,实验复现必须认这个串。"""
|
||||||
|
|
||||||
|
|
||||||
@dataclass(frozen=True)
|
@dataclass(frozen=True)
|
||||||
@@ -76,6 +90,9 @@ class TransportResult:
|
|||||||
ttft_ms: float | None
|
ttft_ms: float | None
|
||||||
max_inter_token_ms: float | None
|
max_inter_token_ms: float | None
|
||||||
raw: dict[str, Any]
|
raw: dict[str, Any]
|
||||||
|
# —— 可观测字段(issue #3;带默认值,非 OpenAI 兼容的 transport 可不填)——
|
||||||
|
cached_prompt_tokens: int | None = None
|
||||||
|
model_reported: str | None = None
|
||||||
|
|
||||||
|
|
||||||
@dataclass(frozen=True)
|
@dataclass(frozen=True)
|
||||||
@@ -107,6 +124,14 @@ class SourceConfig:
|
|||||||
self._validate_gates()
|
self._validate_gates()
|
||||||
self._validate_watchdog()
|
self._validate_watchdog()
|
||||||
|
|
||||||
|
def effective_est_tokens(self) -> int:
|
||||||
|
"""TPM 入场预扣量: 显式配置优先,否则按 tpm 派生(设计 §2.2)。"""
|
||||||
|
if self.est_tokens > 0:
|
||||||
|
return self.est_tokens
|
||||||
|
if self.tpm > 0:
|
||||||
|
return max(1, self.tpm // _EST_TOKENS_QUOTA_DIVISOR)
|
||||||
|
return 0
|
||||||
|
|
||||||
def _validate_identity(self) -> None:
|
def _validate_identity(self) -> None:
|
||||||
for attr in ("name", "provider", "base_url", "api_key", "model"):
|
for attr in ("name", "provider", "base_url", "api_key", "model"):
|
||||||
if not getattr(self, attr).strip():
|
if not getattr(self, attr).strip():
|
||||||
@@ -122,8 +147,8 @@ class SourceConfig:
|
|||||||
for attr in ("max_concurrency", "rpm", "tpm", "est_tokens"):
|
for attr in ("max_concurrency", "rpm", "tpm", "est_tokens"):
|
||||||
if getattr(self, attr) < 0:
|
if getattr(self, attr) < 0:
|
||||||
raise ValueError(f"SourceConfig.{attr} 不能为负(0 表示不启用)")
|
raise ValueError(f"SourceConfig.{attr} 不能为负(0 表示不启用)")
|
||||||
if self.tpm > 0 and self.est_tokens <= 0:
|
# 注: 不再强制 `tpm > 0 ⇒ est_tokens > 0`——预扣量由 effective_est_tokens()
|
||||||
raise ValueError("启用 TPM 闸时 est_tokens 必须 > 0(入场预扣依据)")
|
# 自 tpm 派生,运维只需填供应商配额页上抄得到的 tpm(设计 §3.2 #1)
|
||||||
|
|
||||||
def _validate_watchdog(self) -> None:
|
def _validate_watchdog(self) -> None:
|
||||||
# CHS config.py:66-82: 流式看门狗成对配置且 0 < inter < ttft < timeout_s
|
# CHS config.py:66-82: 流式看门狗成对配置且 0 < inter < ttft < timeout_s
|
||||||
@@ -270,7 +295,7 @@ class EmbeddingTransportResult:
|
|||||||
vectors: list[list[float]]
|
vectors: list[list[float]]
|
||||||
dim: int
|
dim: int
|
||||||
prompt_tokens: int
|
prompt_tokens: int
|
||||||
usage_source: str # measured | estimated
|
usage_source: str # measured | estimated | unavailable
|
||||||
raw: dict[str, Any]
|
raw: dict[str, Any]
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -84,6 +84,23 @@ class TestTpmGate:
|
|||||||
await p2.release()
|
await p2.release()
|
||||||
assert (await limiter.source_stats("s1")).tpm_used == 600
|
assert (await limiter.source_stats("s1")).tpm_used == 600
|
||||||
|
|
||||||
|
async def test_settle_equal_to_prededuct_keeps_deposit(self, limiter_factory):
|
||||||
|
"""预扣量与结算量同为派生值时,双后端都必须留存押金(delta==0)。
|
||||||
|
|
||||||
|
这里只锁**后端算术**: 相等的两个数进出,窗口残留量恰为该值。
|
||||||
|
"调用点是否真的取了派生值"是编排行为,由 tests/unit/test_retry.py
|
||||||
|
经 RetryMW 端到端覆盖,不在本契约文件重复(否则只是自证同一个入参)。
|
||||||
|
"""
|
||||||
|
src = make_source(tpm=6000, est_tokens=0) # 派生值 = max(1, 6000 // 60) = 100
|
||||||
|
derived = src.effective_est_tokens()
|
||||||
|
assert derived == 100
|
||||||
|
limiter = limiter_factory([src], _NO_GLOBAL)
|
||||||
|
permit = await limiter.try_acquire("s1", derived)
|
||||||
|
assert permit is not None
|
||||||
|
await permit.settle(derived)
|
||||||
|
await permit.release()
|
||||||
|
assert (await limiter.source_stats("s1")).tpm_used == derived
|
||||||
|
|
||||||
async def test_failed_acquire_leaves_no_tpm_trace(self, limiter_factory):
|
async def test_failed_acquire_leaves_no_tpm_trace(self, limiter_factory):
|
||||||
src = make_source(tpm=500, est_tokens=400)
|
src = make_source(tpm=500, est_tokens=400)
|
||||||
limiter = limiter_factory([src], _NO_GLOBAL)
|
limiter = limiter_factory([src], _NO_GLOBAL)
|
||||||
|
|||||||
@@ -39,6 +39,8 @@ _EXPECTED_COLUMNS = [
|
|||||||
"error",
|
"error",
|
||||||
"cost",
|
"cost",
|
||||||
"created_at",
|
"created_at",
|
||||||
|
"cached_prompt_tokens",
|
||||||
|
"model_reported",
|
||||||
]
|
]
|
||||||
|
|
||||||
# run 级前缀: 同库并存的其他运行(迁移批跑/另一开发机)互不可见
|
# run 级前缀: 同库并存的其他运行(迁移批跑/另一开发机)互不可见
|
||||||
@@ -100,6 +102,8 @@ async def _record_minimal(
|
|||||||
"cache_hit": False,
|
"cache_hit": False,
|
||||||
"error": None,
|
"error": None,
|
||||||
"cost": None,
|
"cost": None,
|
||||||
|
"cached_prompt_tokens": None,
|
||||||
|
"model_reported": None,
|
||||||
}
|
}
|
||||||
fields.update(overrides)
|
fields.update(overrides)
|
||||||
await recorder.record_llm_call(**fields)
|
await recorder.record_llm_call(**fields)
|
||||||
@@ -115,6 +119,105 @@ async def _fetch(dsn: str, sql: str, *args):
|
|||||||
await conn.close()
|
await conn.close()
|
||||||
|
|
||||||
|
|
||||||
|
_LEGACY_DDL = """
|
||||||
|
CREATE TABLE {schema}.llm_calls (
|
||||||
|
call_id TEXT PRIMARY KEY,
|
||||||
|
parent_call_id TEXT,
|
||||||
|
session_id TEXT,
|
||||||
|
model TEXT NOT NULL,
|
||||||
|
provider TEXT NOT NULL,
|
||||||
|
source_name TEXT NOT NULL,
|
||||||
|
messages TEXT NOT NULL,
|
||||||
|
response TEXT NOT NULL,
|
||||||
|
thinking TEXT NOT NULL DEFAULT '',
|
||||||
|
prompt_tokens INTEGER NOT NULL,
|
||||||
|
completion_tokens INTEGER NOT NULL,
|
||||||
|
usage_source TEXT NOT NULL,
|
||||||
|
latency_ms INTEGER NOT NULL,
|
||||||
|
ttft_ms DOUBLE PRECISION,
|
||||||
|
max_inter_token_ms DOUBLE PRECISION,
|
||||||
|
cache_hit BOOLEAN NOT NULL DEFAULT FALSE,
|
||||||
|
error TEXT,
|
||||||
|
cost DOUBLE PRECISION,
|
||||||
|
created_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
||||||
|
)
|
||||||
|
"""
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
async def legacy_schema(dsn):
|
||||||
|
"""在**自建的临时 schema** 里造一张 18 列旧表,验证补列(issue #3)。
|
||||||
|
|
||||||
|
绝不碰共享的 public.llm_calls: 用 search_path 把 recorder 指向临时 schema,
|
||||||
|
teardown 只 DROP 自己建的 schema。
|
||||||
|
"""
|
||||||
|
import asyncpg
|
||||||
|
|
||||||
|
name = f"pgwtest_{uuid4().hex[:8]}"
|
||||||
|
conn = await asyncpg.connect(dsn, timeout=10)
|
||||||
|
try:
|
||||||
|
await conn.execute(f"CREATE SCHEMA {name}")
|
||||||
|
await conn.execute(_LEGACY_DDL.format(schema=name))
|
||||||
|
finally:
|
||||||
|
await conn.close()
|
||||||
|
sep = "&" if "?" in dsn else "?"
|
||||||
|
yield f"{dsn}{sep}options=-csearch_path%3D{name}", name
|
||||||
|
conn = await asyncpg.connect(dsn, timeout=10)
|
||||||
|
try:
|
||||||
|
await conn.execute(f"DROP SCHEMA {name} CASCADE")
|
||||||
|
finally:
|
||||||
|
await conn.close()
|
||||||
|
|
||||||
|
|
||||||
|
class TestObservabilityColumns:
|
||||||
|
"""issue #3: 两列写入可回读,且已存在的 18 列旧表会被自动补列。"""
|
||||||
|
|
||||||
|
async def test_values_round_trip(self, dsn):
|
||||||
|
recorder = PostgresRecorder(dsn)
|
||||||
|
try:
|
||||||
|
await _record_minimal(recorder, call_id=_cid("hit"), cached_prompt_tokens=64)
|
||||||
|
await _record_minimal(recorder, call_id=_cid("zero"), cached_prompt_tokens=0)
|
||||||
|
await _record_minimal(recorder, call_id=_cid("model"), model_reported="MiniMax-01")
|
||||||
|
rows = await _fetch(
|
||||||
|
dsn,
|
||||||
|
"SELECT call_id, cached_prompt_tokens, model_reported FROM llm_calls "
|
||||||
|
"WHERE call_id LIKE $1",
|
||||||
|
f"{_RUN_PREFIX}-%",
|
||||||
|
)
|
||||||
|
by_id = {r["call_id"]: r for r in rows}
|
||||||
|
assert by_id[_cid("hit")]["cached_prompt_tokens"] == 64
|
||||||
|
assert by_id[_cid("zero")]["cached_prompt_tokens"] == 0 # 真实零命中 ≠ NULL
|
||||||
|
assert by_id[_cid("model")]["cached_prompt_tokens"] is None
|
||||||
|
assert by_id[_cid("model")]["model_reported"] == "MiniMax-01"
|
||||||
|
finally:
|
||||||
|
await recorder.aclose()
|
||||||
|
|
||||||
|
async def test_legacy_table_is_upgraded_in_place(self, legacy_schema):
|
||||||
|
"""18 列旧表不补列的话,每行写入都会被逐行 warning 丢弃(遥测静默全失)。"""
|
||||||
|
schema_dsn, schema = legacy_schema
|
||||||
|
recorder = PostgresRecorder(schema_dsn)
|
||||||
|
try:
|
||||||
|
await _record_minimal(
|
||||||
|
recorder, call_id=_cid("legacy"), cached_prompt_tokens=7, model_reported="m-real"
|
||||||
|
)
|
||||||
|
cols = await _fetch(
|
||||||
|
schema_dsn,
|
||||||
|
"SELECT column_name FROM information_schema.columns "
|
||||||
|
"WHERE table_schema = $1 AND table_name = 'llm_calls' ORDER BY ordinal_position",
|
||||||
|
schema,
|
||||||
|
)
|
||||||
|
# ALTER 只能追加到末尾: 与新建库的列序一致才不会分叉
|
||||||
|
assert [r["column_name"] for r in cols] == _EXPECTED_COLUMNS
|
||||||
|
rows = await _fetch(
|
||||||
|
schema_dsn,
|
||||||
|
"SELECT cached_prompt_tokens, model_reported FROM llm_calls WHERE call_id = $1",
|
||||||
|
_cid("legacy"),
|
||||||
|
)
|
||||||
|
assert (rows[0]["cached_prompt_tokens"], rows[0]["model_reported"]) == (7, "m-real")
|
||||||
|
finally:
|
||||||
|
await recorder.aclose()
|
||||||
|
|
||||||
|
|
||||||
class TestSchema:
|
class TestSchema:
|
||||||
async def test_schema_has_frozen_columns_in_order(self, dsn):
|
async def test_schema_has_frozen_columns_in_order(self, dsn):
|
||||||
recorder = PostgresRecorder(dsn)
|
recorder = PostgresRecorder(dsn)
|
||||||
|
|||||||
@@ -150,6 +150,49 @@ class TestCacheFlow:
|
|||||||
assert terminal.calls == 2
|
assert terminal.calls == 2
|
||||||
|
|
||||||
|
|
||||||
|
class TestObservabilityFieldsOnHit:
|
||||||
|
"""issue #3 决策 B1: 命中行原样回放,与 model/prompt_tokens 同一口径。"""
|
||||||
|
|
||||||
|
async def test_fields_replayed_on_hit(self):
|
||||||
|
backend = InMemoryCache()
|
||||||
|
mw = _mw(backend)
|
||||||
|
terminal = _Terminal(
|
||||||
|
_resp(cached_prompt_tokens=64, model_reported="MiniMax-Text-01-250321")
|
||||||
|
)
|
||||||
|
await mw(ChatRequest(messages=_MSGS), terminal)
|
||||||
|
hit = await mw(ChatRequest(messages=_MSGS), terminal)
|
||||||
|
assert hit.cache_hit is True
|
||||||
|
assert hit.cached_prompt_tokens == 64
|
||||||
|
assert hit.model_reported == "MiniMax-Text-01-250321"
|
||||||
|
|
||||||
|
async def test_legacy_cache_entry_without_new_keys_rehydrates(self):
|
||||||
|
"""旧格式条目(无这两个键)必须照常重建为 None,不得抛异常回源。"""
|
||||||
|
backend = InMemoryCache()
|
||||||
|
mw = _mw(backend)
|
||||||
|
key = build_cache_key("m", _MSGS, "proj", None)
|
||||||
|
legacy = {
|
||||||
|
"content": "legacy",
|
||||||
|
"thinking": "",
|
||||||
|
"model": "m",
|
||||||
|
"provider": "p",
|
||||||
|
"prompt_tokens": 1,
|
||||||
|
"completion_tokens": 2,
|
||||||
|
"latency_ms": 30,
|
||||||
|
"ttft_ms": 5.0,
|
||||||
|
"max_inter_token_ms": 2.0,
|
||||||
|
"cache_hit": False,
|
||||||
|
"call_id": "orig",
|
||||||
|
"source_name": "s1",
|
||||||
|
"cost": None,
|
||||||
|
"usage_source": "measured",
|
||||||
|
}
|
||||||
|
await backend.set(key, json.dumps(legacy), ttl_s=100)
|
||||||
|
terminal = _Terminal(_resp())
|
||||||
|
hit = await mw(ChatRequest(messages=_MSGS), terminal)
|
||||||
|
assert hit.content == "legacy" and terminal.calls == 0 # 真的走了缓存
|
||||||
|
assert hit.cached_prompt_tokens is None and hit.model_reported is None
|
||||||
|
|
||||||
|
|
||||||
class _BrokenBackend:
|
class _BrokenBackend:
|
||||||
async def get(self, key):
|
async def get(self, key):
|
||||||
raise ConnectionError("redis down")
|
raise ConnectionError("redis down")
|
||||||
|
|||||||
@@ -102,12 +102,14 @@ class TestEmbedTransport:
|
|||||||
assert result.dim == 2
|
assert result.dim == 2
|
||||||
assert result.prompt_tokens == 5 and result.usage_source == "measured"
|
assert result.prompt_tokens == 5 and result.usage_source == "measured"
|
||||||
|
|
||||||
async def test_missing_usage_falls_back_estimated(self):
|
async def test_missing_usage_is_unavailable(self):
|
||||||
|
"""usage 缺失不再退到 `est_tokens`(夹具填 7),与 chat 同口径记 0 + unavailable。"""
|
||||||
|
|
||||||
def handler(request):
|
def handler(request):
|
||||||
return httpx.Response(200, json=_ok_body([[1.0]]))
|
return httpx.Response(200, json=_ok_body([[1.0]]))
|
||||||
|
|
||||||
result = await _transport_with(handler).embed(texts=["a"], source=_src(), call_id="c")
|
result = await _transport_with(handler).embed(texts=["a"], source=_src(), call_id="c")
|
||||||
assert result.prompt_tokens == 7 and result.usage_source == "estimated" # est_tokens
|
assert result.prompt_tokens == 0 and result.usage_source == "unavailable"
|
||||||
|
|
||||||
@pytest.mark.parametrize(
|
@pytest.mark.parametrize(
|
||||||
("status", "exc_type"),
|
("status", "exc_type"),
|
||||||
@@ -161,6 +163,7 @@ from polygateway.backends.memory.breaker import InMemoryGate # noqa: E402
|
|||||||
from polygateway.backends.memory.limiter import InMemoryLimiter # noqa: E402
|
from polygateway.backends.memory.limiter import InMemoryLimiter # noqa: E402
|
||||||
from polygateway.config import EmbeddingSettings # noqa: E402
|
from polygateway.config import EmbeddingSettings # noqa: E402
|
||||||
from polygateway.embedding import EmbeddingClient # noqa: E402
|
from polygateway.embedding import EmbeddingClient # noqa: E402
|
||||||
|
from polygateway.pricing import ModelPrice, PricingTable # noqa: E402
|
||||||
from polygateway.sources import RoundRobinSelector # noqa: E402
|
from polygateway.sources import RoundRobinSelector # noqa: E402
|
||||||
from polygateway.types import ( # noqa: E402
|
from polygateway.types import ( # noqa: E402
|
||||||
BackpressurePolicy,
|
BackpressurePolicy,
|
||||||
@@ -260,6 +263,28 @@ class TestEmbedBatching:
|
|||||||
assert resp.usage_source == "estimated" # 任一批 estimated 则整体 estimated
|
assert resp.usage_source == "estimated" # 任一批 estimated 则整体 estimated
|
||||||
assert resp.prompt_tokens == 2 + 9
|
assert resp.prompt_tokens == 2 + 9
|
||||||
|
|
||||||
|
async def test_unavailable_batch_dominates_and_voids_cost(self):
|
||||||
|
"""三态合并优先级(设计 §3.2 #10/#11): 任一批不可得 → 整体不可得且 cost NULL。
|
||||||
|
|
||||||
|
改前二值合并只看 `estimated`,measured+unavailable 会误标 measured;
|
||||||
|
`_total_cost` 逐批求和还会给出一个偏低却看似有效的金额。
|
||||||
|
"""
|
||||||
|
estimated = EmbeddingTransportResult(
|
||||||
|
vectors=[[1.0], [1.0]], dim=1, prompt_tokens=9, usage_source="estimated", raw={}
|
||||||
|
)
|
||||||
|
unavailable = EmbeddingTransportResult(
|
||||||
|
vectors=[[1.0], [1.0]], dim=1, prompt_tokens=0, usage_source="unavailable", raw={}
|
||||||
|
)
|
||||||
|
client, _ = _embed_client(
|
||||||
|
[_src()],
|
||||||
|
["ok", estimated, unavailable],
|
||||||
|
batch_size=2,
|
||||||
|
pricing=PricingTable({"embed-1": ModelPrice(input_per_1m=1.0, output_per_1m=0.0)}),
|
||||||
|
)
|
||||||
|
resp = await client.embed(["a", "b", "c", "d", "e", "f"])
|
||||||
|
assert resp.usage_source == "unavailable" # unavailable 压过 estimated 与 measured
|
||||||
|
assert resp.cost is None
|
||||||
|
|
||||||
|
|
||||||
class TestEmbedPostProcess:
|
class TestEmbedPostProcess:
|
||||||
async def test_normalize_l2(self):
|
async def test_normalize_l2(self):
|
||||||
|
|||||||
@@ -394,6 +394,21 @@ class TestTelemetry:
|
|||||||
assert recorder.rows[1]["error"] is None
|
assert recorder.rows[1]["error"] is None
|
||||||
assert recorder.rows[1]["prompt_tokens"] == 0
|
assert recorder.rows[1]["prompt_tokens"] == 0
|
||||||
|
|
||||||
|
async def test_success_row_stays_measured_and_settles_zero(self):
|
||||||
|
"""OCR 的 0 token 是**事实**而非未知(est_tokens 解耦设计 §3.3 剔出决定)。
|
||||||
|
|
||||||
|
三态化不得把 OCR 成功行改成 `unavailable`——那会灌水缺口度量
|
||||||
|
`COUNT(*) WHERE usage_source='unavailable'`;settle 恒 0 的差异①同样不动。
|
||||||
|
"""
|
||||||
|
recorder = _MemoryRecorder()
|
||||||
|
client, limiter, _ = _client([_src(tpm=1000, est_tokens=400)], ["text"], telemetry=recorder)
|
||||||
|
await client.recognize_text(b"jpg")
|
||||||
|
row = recorder.rows[0]
|
||||||
|
assert row["usage_source"] == "measured"
|
||||||
|
assert row["prompt_tokens"] == 0 and row["completion_tokens"] == 0
|
||||||
|
assert row["error"] is None
|
||||||
|
assert (await limiter.source_stats("m1")).tpm_used == 0 # settle(0) 全额退回预扣
|
||||||
|
|
||||||
|
|
||||||
class TestAssembly:
|
class TestAssembly:
|
||||||
_ENV = {
|
_ENV = {
|
||||||
|
|||||||
@@ -13,12 +13,14 @@ from polygateway.errors import (
|
|||||||
SourceDeadError,
|
SourceDeadError,
|
||||||
TransientError,
|
TransientError,
|
||||||
)
|
)
|
||||||
|
from polygateway.middleware.telemetry import TelemetryEmitter
|
||||||
|
from polygateway.pricing import ModelPrice, PricingTable
|
||||||
from polygateway.transports.openai_compat import (
|
from polygateway.transports.openai_compat import (
|
||||||
OpenAICompatTransport,
|
OpenAICompatTransport,
|
||||||
_iter_sse_deltas,
|
_iter_sse_deltas,
|
||||||
_sse_data_payload,
|
_sse_data_payload,
|
||||||
)
|
)
|
||||||
from polygateway.types import SourceConfig
|
from polygateway.types import ChatRequest, LLMResponse, SourceConfig
|
||||||
|
|
||||||
|
|
||||||
def _source(**overrides):
|
def _source(**overrides):
|
||||||
@@ -34,7 +36,7 @@ def _source(**overrides):
|
|||||||
return SourceConfig(**base)
|
return SourceConfig(**base)
|
||||||
|
|
||||||
|
|
||||||
def _chunk(content=None, reasoning=None, usage=None):
|
def _chunk(content=None, reasoning=None, usage=None, model=None):
|
||||||
delta = {}
|
delta = {}
|
||||||
if content is not None:
|
if content is not None:
|
||||||
delta["content"] = content
|
delta["content"] = content
|
||||||
@@ -43,6 +45,8 @@ def _chunk(content=None, reasoning=None, usage=None):
|
|||||||
body = {"choices": [{"delta": delta}]} if (delta or usage is None) else {"choices": []}
|
body = {"choices": [{"delta": delta}]} if (delta or usage is None) else {"choices": []}
|
||||||
if usage is not None:
|
if usage is not None:
|
||||||
body["usage"] = usage
|
body["usage"] = usage
|
||||||
|
if model is not None:
|
||||||
|
body["model"] = model
|
||||||
return f"data: {json.dumps(body)}\n\n"
|
return f"data: {json.dumps(body)}\n\n"
|
||||||
|
|
||||||
|
|
||||||
@@ -71,6 +75,53 @@ async def _complete(transport, source, *, stream=True, overlay=None):
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
# 单价刻意取"输出贵于输入"的真实形态: est_tokens 兜底把整估值塞进 completion
|
||||||
|
# 时,虚高才显形(设计 §1 的 26 倍算例即此单价)。
|
||||||
|
_PRICING = PricingTable({"qwen-max": ModelPrice(input_per_1m=1.0, output_per_1m=8.0)})
|
||||||
|
|
||||||
|
|
||||||
|
class _MemoryRecorder:
|
||||||
|
def __init__(self):
|
||||||
|
self.rows = []
|
||||||
|
|
||||||
|
async def record_llm_call(self, **fields):
|
||||||
|
self.rows.append(fields)
|
||||||
|
|
||||||
|
|
||||||
|
async def _recorded_cost(result, source):
|
||||||
|
"""把 transport 产物走一遍真实计费路径,返回落库的 cost。
|
||||||
|
|
||||||
|
`unavailable` → cost=None 的判定在 `TelemetryEmitter` 里(设计 §3.2 #5),
|
||||||
|
直接调 `PricingTable.cost` 对 `0/0` 只会得到 `0.0`——那正是本组用例要防的
|
||||||
|
假金额,故断言必须穿过 emitter 而不是单测 pricing。
|
||||||
|
"""
|
||||||
|
recorder = _MemoryRecorder()
|
||||||
|
response = LLMResponse(
|
||||||
|
content=result.content,
|
||||||
|
thinking=result.thinking,
|
||||||
|
model=source.model,
|
||||||
|
provider=source.provider,
|
||||||
|
prompt_tokens=result.prompt_tokens,
|
||||||
|
completion_tokens=result.completion_tokens,
|
||||||
|
latency_ms=1,
|
||||||
|
ttft_ms=result.ttft_ms,
|
||||||
|
max_inter_token_ms=result.max_inter_token_ms,
|
||||||
|
cache_hit=False,
|
||||||
|
call_id="cid-1",
|
||||||
|
source_name=source.name,
|
||||||
|
usage_source=result.usage_source,
|
||||||
|
)
|
||||||
|
await TelemetryEmitter(recorder, pricing=_PRICING).emit_attempt(
|
||||||
|
request=ChatRequest(messages=[{"role": "user", "content": "hi"}]),
|
||||||
|
source=source,
|
||||||
|
call_id="cid-1",
|
||||||
|
latency_ms=1,
|
||||||
|
response=response,
|
||||||
|
error=None,
|
||||||
|
)
|
||||||
|
return recorder.rows[0]["cost"]
|
||||||
|
|
||||||
|
|
||||||
class TestSsePureFunctions:
|
class TestSsePureFunctions:
|
||||||
def test_data_payload_filters_noise(self):
|
def test_data_payload_filters_noise(self):
|
||||||
assert _sse_data_payload("") is None
|
assert _sse_data_payload("") is None
|
||||||
@@ -129,13 +180,21 @@ class TestStreamHappyPath:
|
|||||||
assert result.content == "answer"
|
assert result.content == "answer"
|
||||||
assert result.thinking == "hmm"
|
assert result.thinking == "hmm"
|
||||||
|
|
||||||
async def test_usage_missing_falls_back_to_est(self):
|
async def test_usage_missing_is_unavailable_with_null_cost(self):
|
||||||
|
"""usage 帧缺失 → 0/0 + unavailable + cost NULL(设计 §3.2 #3)。
|
||||||
|
|
||||||
|
改前拿 `est_tokens` 当实测并整估值塞 completion,同一条调用记成
|
||||||
|
`0/4000` → cost 0.032(设计 §1 的 26 倍虚高)。
|
||||||
|
"""
|
||||||
|
|
||||||
def handler(request):
|
def handler(request):
|
||||||
return _sse_stream(_chunk(content="ok"))
|
return _sse_stream(_chunk(content="ok"))
|
||||||
|
|
||||||
result = await _complete(_transport_for(handler), _source(tpm=1000, est_tokens=333))
|
source = _source(tpm=1000, est_tokens=4000)
|
||||||
assert result.usage_source == "estimated"
|
result = await _complete(_transport_for(handler), source)
|
||||||
assert result.prompt_tokens == 0 and result.completion_tokens == 333
|
assert result.usage_source == "unavailable"
|
||||||
|
assert result.prompt_tokens == 0 and result.completion_tokens == 0
|
||||||
|
assert await _recorded_cost(result, source) is None
|
||||||
|
|
||||||
|
|
||||||
class TestMissingDoneSemantics:
|
class TestMissingDoneSemantics:
|
||||||
@@ -146,12 +205,28 @@ class TestMissingDoneSemantics:
|
|||||||
with pytest.raises(TransientError, match="missing_done|truncated"):
|
with pytest.raises(TransientError, match="missing_done|truncated"):
|
||||||
await _complete(_transport_for(self._no_done_handler), _source())
|
await _complete(_transport_for(self._no_done_handler), _source())
|
||||||
|
|
||||||
async def test_salvage_policy_keeps_content_as_estimated(self):
|
async def test_salvage_with_usage_frame_degrades_to_estimated(self):
|
||||||
result = await _complete(
|
"""打捞且收到 usage 帧: 数字真实、可信度降级 → estimated 且照常计费。"""
|
||||||
_transport_for(self._no_done_handler), _source(missing_done="salvage")
|
source = _source(missing_done="salvage", tpm=1000, est_tokens=4000)
|
||||||
)
|
result = await _complete(_transport_for(self._no_done_handler), source)
|
||||||
assert result.content == "partial"
|
assert result.content == "partial"
|
||||||
assert result.usage_source == "estimated" # 打捞路径强制 estimated
|
assert result.usage_source == "estimated"
|
||||||
|
assert result.prompt_tokens == 11 and result.completion_tokens == 7
|
||||||
|
assert await _recorded_cost(result, source) == pytest.approx(
|
||||||
|
11 / 1_000_000 * 1.0 + 7 / 1_000_000 * 8.0
|
||||||
|
)
|
||||||
|
|
||||||
|
async def test_salvage_without_usage_frame_stays_unavailable(self):
|
||||||
|
"""打捞且 usage 帧缺失: 0/0 不得被洗成 estimated,否则算出假的 0.0(设计 §3.2 #4)。"""
|
||||||
|
|
||||||
|
def handler(request):
|
||||||
|
return _sse_stream(_chunk(content="partial"), done=False)
|
||||||
|
|
||||||
|
source = _source(missing_done="salvage", tpm=1000, est_tokens=4000)
|
||||||
|
result = await _complete(_transport_for(handler), source)
|
||||||
|
assert result.content == "partial"
|
||||||
|
assert result.usage_source == "unavailable"
|
||||||
|
assert await _recorded_cost(result, source) is None
|
||||||
|
|
||||||
async def test_early_eof_always_transient_even_under_salvage(self):
|
async def test_early_eof_always_transient_even_under_salvage(self):
|
||||||
def handler(request):
|
def handler(request):
|
||||||
@@ -188,6 +263,137 @@ class TestEmptyCompletion:
|
|||||||
await _complete(_transport_for(handler), _source())
|
await _complete(_transport_for(handler), _source())
|
||||||
|
|
||||||
|
|
||||||
|
class TestObservabilityFields:
|
||||||
|
"""issue #3: 供应商 prompt cache 命中数与 API 实际返回的模型版本串。
|
||||||
|
|
||||||
|
网关报文一律不可信: 形态异常只归 None,绝不因一个可观测字段打断调用。
|
||||||
|
"""
|
||||||
|
|
||||||
|
def _cached_usage(self, cached):
|
||||||
|
return {**_USAGE, "prompt_tokens_details": {"cached_tokens": cached}}
|
||||||
|
|
||||||
|
async def test_stream_reads_cached_tokens(self):
|
||||||
|
def handler(request):
|
||||||
|
return _sse_stream(_chunk(content="ok"), _chunk(usage=self._cached_usage(128)))
|
||||||
|
|
||||||
|
result = await _complete(_transport_for(handler), _source())
|
||||||
|
assert result.cached_prompt_tokens == 128
|
||||||
|
|
||||||
|
async def test_non_stream_reads_cached_tokens(self):
|
||||||
|
def handler(request):
|
||||||
|
return httpx.Response(
|
||||||
|
200,
|
||||||
|
json={
|
||||||
|
"choices": [{"message": {"content": "42"}}],
|
||||||
|
"usage": self._cached_usage(128),
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
||||||
|
result = await _complete(_transport_for(handler), _source(), stream=False)
|
||||||
|
assert result.cached_prompt_tokens == 128
|
||||||
|
|
||||||
|
async def test_zero_cached_tokens_is_a_real_zero(self):
|
||||||
|
"""0(真实零命中)与 None(该源未上报)必须可区分——issue #3 的核心诉求。"""
|
||||||
|
|
||||||
|
def handler(request):
|
||||||
|
return _sse_stream(_chunk(content="ok"), _chunk(usage=self._cached_usage(0)))
|
||||||
|
|
||||||
|
result = await _complete(_transport_for(handler), _source())
|
||||||
|
assert result.cached_prompt_tokens == 0
|
||||||
|
|
||||||
|
async def test_usage_without_details_is_none(self):
|
||||||
|
def handler(request):
|
||||||
|
return _sse_stream(_chunk(content="ok"), _chunk(usage=_USAGE))
|
||||||
|
|
||||||
|
result = await _complete(_transport_for(handler), _source())
|
||||||
|
assert result.cached_prompt_tokens is None
|
||||||
|
|
||||||
|
async def test_missing_usage_frame_is_none(self):
|
||||||
|
def handler(request):
|
||||||
|
return _sse_stream(_chunk(content="ok"))
|
||||||
|
|
||||||
|
result = await _complete(_transport_for(handler), _source())
|
||||||
|
assert result.cached_prompt_tokens is None
|
||||||
|
|
||||||
|
@pytest.mark.parametrize("bad", ["abc", -1, True, 1.5, None, [], {"x": 1}])
|
||||||
|
async def test_malformed_cached_tokens_degrade_to_none(self, bad):
|
||||||
|
"""`True` 必须排除: Python 里 isinstance(True, int) 为真。"""
|
||||||
|
|
||||||
|
def handler(request):
|
||||||
|
return _sse_stream(_chunk(content="ok"), _chunk(usage=self._cached_usage(bad)))
|
||||||
|
|
||||||
|
result = await _complete(_transport_for(handler), _source())
|
||||||
|
assert result.cached_prompt_tokens is None
|
||||||
|
|
||||||
|
async def test_details_not_a_dict_is_none(self):
|
||||||
|
def handler(request):
|
||||||
|
usage = {**_USAGE, "prompt_tokens_details": "oops"}
|
||||||
|
return _sse_stream(_chunk(content="ok"), _chunk(usage=usage))
|
||||||
|
|
||||||
|
result = await _complete(_transport_for(handler), _source())
|
||||||
|
assert result.cached_prompt_tokens is None
|
||||||
|
|
||||||
|
async def test_non_stream_reads_reported_model(self):
|
||||||
|
def handler(request):
|
||||||
|
return httpx.Response(
|
||||||
|
200,
|
||||||
|
json={
|
||||||
|
"choices": [{"message": {"content": "42"}}],
|
||||||
|
"usage": _USAGE,
|
||||||
|
"model": "MiniMax-Text-01-250321",
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
||||||
|
result = await _complete(_transport_for(handler), _source(), stream=False)
|
||||||
|
assert result.model_reported == "MiniMax-Text-01-250321"
|
||||||
|
|
||||||
|
async def test_stream_keeps_the_first_reported_model(self):
|
||||||
|
"""末帧异常值不得覆盖首帧: 首次写入即固定。"""
|
||||||
|
|
||||||
|
def handler(request):
|
||||||
|
return _sse_stream(
|
||||||
|
_chunk(content="a", model="MiniMax-Text-01-250321"),
|
||||||
|
_chunk(content="b", model="something-else"),
|
||||||
|
_chunk(usage=_USAGE),
|
||||||
|
)
|
||||||
|
|
||||||
|
result = await _complete(_transport_for(handler), _source())
|
||||||
|
assert result.model_reported == "MiniMax-Text-01-250321"
|
||||||
|
|
||||||
|
async def test_empty_first_model_does_not_block_a_later_real_one(self):
|
||||||
|
"""首帧报空串不得锁死 sink: 守卫按"有效值"判断,否则真实版本会丢。"""
|
||||||
|
|
||||||
|
def handler(request):
|
||||||
|
return _sse_stream(
|
||||||
|
_chunk(content="a", model=""),
|
||||||
|
_chunk(content="b", model="MiniMax-Text-01-250321"),
|
||||||
|
_chunk(usage=_USAGE),
|
||||||
|
)
|
||||||
|
|
||||||
|
result = await _complete(_transport_for(handler), _source())
|
||||||
|
assert result.model_reported == "MiniMax-Text-01-250321"
|
||||||
|
|
||||||
|
@pytest.mark.parametrize("bad", [None, "", " ", 123, {}])
|
||||||
|
async def test_missing_or_malformed_model_is_none(self, bad):
|
||||||
|
def handler(request):
|
||||||
|
body = {"choices": [{"message": {"content": "42"}}], "usage": _USAGE}
|
||||||
|
if bad is not None:
|
||||||
|
body["model"] = bad
|
||||||
|
return httpx.Response(200, json=body)
|
||||||
|
|
||||||
|
result = await _complete(_transport_for(handler), _source(), stream=False)
|
||||||
|
assert result.model_reported is None
|
||||||
|
|
||||||
|
async def test_raw_payload_is_unchanged(self):
|
||||||
|
"""新字段是独立格子,不改动 raw 的既有内容。"""
|
||||||
|
|
||||||
|
def handler(request):
|
||||||
|
return _sse_stream(_chunk(content="ok"), _chunk(usage=self._cached_usage(5)))
|
||||||
|
|
||||||
|
result = await _complete(_transport_for(handler), _source())
|
||||||
|
assert set(result.raw) == {"usage"}
|
||||||
|
|
||||||
|
|
||||||
class TestNonStreamFastPath:
|
class TestNonStreamFastPath:
|
||||||
async def test_non_stream_parses_message(self):
|
async def test_non_stream_parses_message(self):
|
||||||
def handler(request):
|
def handler(request):
|
||||||
|
|||||||
@@ -114,6 +114,8 @@ class _DummyRecorder:
|
|||||||
cache_hit,
|
cache_hit,
|
||||||
error,
|
error,
|
||||||
cost,
|
cost,
|
||||||
|
cached_prompt_tokens,
|
||||||
|
model_reported,
|
||||||
) -> None: ...
|
) -> None: ...
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -56,6 +56,74 @@ class TestPricingTable:
|
|||||||
ModelPrice(input_per_1m=-1.0, output_per_1m=0.0)
|
ModelPrice(input_per_1m=-1.0, output_per_1m=0.0)
|
||||||
|
|
||||||
|
|
||||||
|
class TestCachedInputTier:
|
||||||
|
"""issue #3: 供应商 prompt cache 命中部分按更低单价计费,不配则不猜折扣。"""
|
||||||
|
|
||||||
|
_CACHED = PricingTable(
|
||||||
|
{"m": ModelPrice(input_per_1m=10.0, output_per_1m=20.0, cached_input_per_1m=2.0)}
|
||||||
|
)
|
||||||
|
_PLAIN = PricingTable({"m": ModelPrice(input_per_1m=10.0, output_per_1m=20.0)})
|
||||||
|
|
||||||
|
def test_hit_is_billed_at_the_cached_rate(self):
|
||||||
|
# 1M prompt 中 600k 命中: 400k×10 + 600k×2 = 4.0 + 1.2
|
||||||
|
assert self._CACHED.cost("m", 1_000_000, 0, 600_000) == pytest.approx(5.2)
|
||||||
|
|
||||||
|
def test_without_the_tier_the_result_is_unchanged(self):
|
||||||
|
"""未配缓存档 = 退化为现状全额计价,绝不按经验折扣率猜(P5)。"""
|
||||||
|
full = self._PLAIN.cost("m", 1_000_000, 0)
|
||||||
|
assert self._PLAIN.cost("m", 1_000_000, 0, 600_000) == full == pytest.approx(10.0)
|
||||||
|
|
||||||
|
@pytest.mark.parametrize("cached", [None, 0])
|
||||||
|
def test_no_hit_is_billed_in_full(self, cached):
|
||||||
|
assert self._CACHED.cost("m", 1_000_000, 0, cached) == pytest.approx(10.0)
|
||||||
|
|
||||||
|
def test_negative_cached_is_billed_in_full(self):
|
||||||
|
"""负数命中数不得抬高成本: cost() 是公共方法,外部输入须校验后使用(P5)。"""
|
||||||
|
assert self._CACHED.cost("m", 1_000_000, 0, -500_000) == pytest.approx(10.0)
|
||||||
|
|
||||||
|
def test_cached_over_prompt_is_clamped_and_never_negative(self):
|
||||||
|
"""网关口径异常时按输入总数夹取: 全部按缓存价,不得算出负成本。"""
|
||||||
|
clamped = self._CACHED.cost("m", 1_000_000, 0, 5_000_000)
|
||||||
|
assert clamped == pytest.approx(2.0) and clamped >= 0
|
||||||
|
|
||||||
|
def test_legacy_three_arg_call_still_works(self):
|
||||||
|
"""embedding.py 的三参调用形态必须零改动可用。"""
|
||||||
|
assert self._CACHED.cost("m", 1_000_000, 0) == pytest.approx(10.0)
|
||||||
|
|
||||||
|
def test_from_file_accepts_and_validates_the_tier(self, tmp_path):
|
||||||
|
path = tmp_path / "p.json"
|
||||||
|
path.write_text(
|
||||||
|
json.dumps(
|
||||||
|
{"m": {"input_per_1m": 10.0, "output_per_1m": 20.0, "cached_input_per_1m": 2.0}}
|
||||||
|
),
|
||||||
|
encoding="utf-8",
|
||||||
|
)
|
||||||
|
assert PricingTable.from_file(path).cost("m", 1_000_000, 0, 1_000_000) == pytest.approx(2.0)
|
||||||
|
|
||||||
|
@pytest.mark.parametrize("bad", [-1.0, "x"])
|
||||||
|
def test_from_file_rejects_a_bad_tier(self, tmp_path, bad):
|
||||||
|
path = tmp_path / "bad.json"
|
||||||
|
path.write_text(
|
||||||
|
json.dumps(
|
||||||
|
{"m": {"input_per_1m": 1.0, "output_per_1m": 2.0, "cached_input_per_1m": bad}}
|
||||||
|
),
|
||||||
|
encoding="utf-8",
|
||||||
|
)
|
||||||
|
with pytest.raises(ValueError, match="cached_input_per_1m"):
|
||||||
|
PricingTable.from_file(path)
|
||||||
|
|
||||||
|
def test_legacy_price_file_without_the_tier_still_loads(self, tmp_path):
|
||||||
|
path = tmp_path / "old.json"
|
||||||
|
path.write_text(
|
||||||
|
json.dumps({"m": {"input_per_1m": 1.0, "output_per_1m": 2.0}}), encoding="utf-8"
|
||||||
|
)
|
||||||
|
assert PricingTable.from_file(path).cost("m", 1_000_000, 0, 500_000) == pytest.approx(1.0)
|
||||||
|
|
||||||
|
def test_negative_tier_rejected_on_construction(self):
|
||||||
|
with pytest.raises(ValueError):
|
||||||
|
ModelPrice(input_per_1m=1.0, output_per_1m=1.0, cached_input_per_1m=-0.1)
|
||||||
|
|
||||||
|
|
||||||
class _MemoryRecorder:
|
class _MemoryRecorder:
|
||||||
def __init__(self):
|
def __init__(self):
|
||||||
self.rows = []
|
self.rows = []
|
||||||
|
|||||||
@@ -152,6 +152,76 @@ class TestSuccessPath:
|
|||||||
# 预扣 400,实际 15 → settle 后窗口只记 15
|
# 预扣 400,实际 15 → settle 后窗口只记 15
|
||||||
assert (await limiter.source_stats("a")).tpm_used == 15
|
assert (await limiter.source_stats("a")).tpm_used == 15
|
||||||
|
|
||||||
|
@pytest.mark.parametrize("usage_source", ["measured", "estimated"])
|
||||||
|
async def test_settle_uses_measured_sum_when_usage_available(self, usage_source):
|
||||||
|
"""用量可得(含打捞降级的 estimated)时结算恒取实测之和,不落派生兜底分支。"""
|
||||||
|
src = _src("a", tpm=1000, est_tokens=400)
|
||||||
|
result = TransportResult(
|
||||||
|
content="ok",
|
||||||
|
thinking="",
|
||||||
|
prompt_tokens=40,
|
||||||
|
completion_tokens=60,
|
||||||
|
usage_source=usage_source,
|
||||||
|
ttft_ms=12.0,
|
||||||
|
max_inter_token_ms=3.0,
|
||||||
|
raw={},
|
||||||
|
)
|
||||||
|
mw, limiter, *_ = _harness([src], [result])
|
||||||
|
await mw(_REQ)
|
||||||
|
# 预扣 400,实测 40+60 → settle 后窗口记 100(而非派生兜底的 400)
|
||||||
|
assert (await limiter.source_stats("a")).tpm_used == 100
|
||||||
|
|
||||||
|
async def test_settle_keeps_derived_deposit_when_usage_unavailable(self):
|
||||||
|
"""未填 est_tokens + usage 帧缺失的**成功**调用: 押金留存而非整笔退回。
|
||||||
|
|
||||||
|
入场预扣与结算须同取 `effective_est_tokens()`(delta==0),否则对
|
||||||
|
"从不返回 usage 帧"的源等于 TPM 闸进门即放行、出门即清账(设计 §3.2 #9)。
|
||||||
|
"""
|
||||||
|
src = _src("a", tpm=1000, est_tokens=0) # 派生预扣量 = max(1, 1000 // 60) = 16
|
||||||
|
result = TransportResult(
|
||||||
|
content="ok",
|
||||||
|
thinking="",
|
||||||
|
prompt_tokens=0,
|
||||||
|
completion_tokens=0,
|
||||||
|
usage_source="unavailable",
|
||||||
|
ttft_ms=12.0,
|
||||||
|
max_inter_token_ms=3.0,
|
||||||
|
raw={},
|
||||||
|
)
|
||||||
|
mw, limiter, *_ = _harness([src], [result])
|
||||||
|
await mw(_REQ)
|
||||||
|
assert src.effective_est_tokens() == 16
|
||||||
|
assert (await limiter.source_stats("a")).tpm_used == 16
|
||||||
|
|
||||||
|
|
||||||
|
class TestObservabilityPassthrough:
|
||||||
|
"""issue #3: transport 采到的两个可观测字段必须原样上浮到 LLMResponse。"""
|
||||||
|
|
||||||
|
async def test_fields_reach_the_response(self):
|
||||||
|
result = TransportResult(
|
||||||
|
content="ok",
|
||||||
|
thinking="",
|
||||||
|
prompt_tokens=10,
|
||||||
|
completion_tokens=5,
|
||||||
|
usage_source="measured",
|
||||||
|
ttft_ms=12.0,
|
||||||
|
max_inter_token_ms=3.0,
|
||||||
|
raw={},
|
||||||
|
cached_prompt_tokens=64,
|
||||||
|
model_reported="MiniMax-Text-01-250321",
|
||||||
|
)
|
||||||
|
mw, *_ = _harness([_src("a")], [result])
|
||||||
|
resp = await mw(_REQ)
|
||||||
|
assert resp.cached_prompt_tokens == 64
|
||||||
|
assert resp.model_reported == "MiniMax-Text-01-250321"
|
||||||
|
# model 仍是配置别名: 真实版本是旁证,不顶替溯源主字段
|
||||||
|
assert resp.model == "m"
|
||||||
|
|
||||||
|
async def test_absent_fields_stay_none(self):
|
||||||
|
mw, *_ = _harness([_src("a")], [_ok()])
|
||||||
|
resp = await mw(_REQ)
|
||||||
|
assert resp.cached_prompt_tokens is None and resp.model_reported is None
|
||||||
|
|
||||||
|
|
||||||
class TestRetryAndFailover:
|
class TestRetryAndFailover:
|
||||||
async def test_transient_switches_source_then_succeeds(self):
|
async def test_transient_switches_source_then_succeeds(self):
|
||||||
@@ -202,6 +272,18 @@ class TestRetryAndFailover:
|
|||||||
assert sleep.delays == [] # 源死亡不退避
|
assert sleep.delays == [] # 源死亡不退避
|
||||||
assert not (await gate.try_enter("a", "w")).allowed # a 已 force_open
|
assert not (await gate.try_enter("a", "w")).allowed # a 已 force_open
|
||||||
|
|
||||||
|
async def test_transient_failure_keeps_derived_deposit(self):
|
||||||
|
"""未填 est_tokens 的**非 dead 瞬时失败**同样按派生预扣量保守结算。
|
||||||
|
|
||||||
|
失败请求可能已被网关计费,退掉押金会低估用量(设计 §3.2 #8);
|
||||||
|
max_attempts=1 保证恰一次尝试,窗口残留量即单次预扣量。
|
||||||
|
"""
|
||||||
|
src = _src("a", tpm=1000, est_tokens=0) # 派生预扣量 = 16
|
||||||
|
mw, limiter, *_ = _harness([src], [TransientError("boom")], max_attempts=1)
|
||||||
|
with pytest.raises(AllSourcesExhausted):
|
||||||
|
await mw(_REQ)
|
||||||
|
assert (await limiter.source_stats("a")).tpm_used == 16
|
||||||
|
|
||||||
|
|
||||||
class TestNonRetryableOutcomes:
|
class TestNonRetryableOutcomes:
|
||||||
async def test_request_rejected_propagates_without_retry(self):
|
async def test_request_rejected_propagates_without_retry(self):
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
"""遥测子系统测试: SQLiteRecorder(18 列)+ TelemetryEmitter 单一 helper + TelemetryMW。"""
|
"""遥测子系统测试: SQLiteRecorder(20 列)+ TelemetryEmitter 单一 helper + TelemetryMW。"""
|
||||||
|
|
||||||
import asyncio
|
import asyncio
|
||||||
import sqlite3
|
import sqlite3
|
||||||
@@ -9,6 +9,7 @@ import pytest
|
|||||||
|
|
||||||
from polygateway.errors import CircuitOpenError, RequestRejectedError
|
from polygateway.errors import CircuitOpenError, RequestRejectedError
|
||||||
from polygateway.middleware.telemetry import TelemetryEmitter, TelemetryMW
|
from polygateway.middleware.telemetry import TelemetryEmitter, TelemetryMW
|
||||||
|
from polygateway.pricing import ModelPrice, PricingTable
|
||||||
from polygateway.telemetry.sqlite import SQLiteRecorder
|
from polygateway.telemetry.sqlite import SQLiteRecorder
|
||||||
from polygateway.types import ChatRequest, LLMResponse, SourceConfig
|
from polygateway.types import ChatRequest, LLMResponse, SourceConfig
|
||||||
|
|
||||||
@@ -34,6 +35,8 @@ _EXPECTED_COLUMNS = [
|
|||||||
"error",
|
"error",
|
||||||
"cost",
|
"cost",
|
||||||
"created_at",
|
"created_at",
|
||||||
|
"cached_prompt_tokens",
|
||||||
|
"model_reported",
|
||||||
]
|
]
|
||||||
|
|
||||||
|
|
||||||
@@ -68,6 +71,10 @@ def _source():
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
# 输出单价 8 元/百万: 改前 `unavailable` 行按兜底的 0/4000 换算恰好是 0.032
|
||||||
|
_PRICING = PricingTable({"m": ModelPrice(input_per_1m=1.0, output_per_1m=8.0)})
|
||||||
|
|
||||||
|
|
||||||
async def _record_minimal(recorder, call_id="c1", **overrides):
|
async def _record_minimal(recorder, call_id="c1", **overrides):
|
||||||
fields = {
|
fields = {
|
||||||
"call_id": call_id,
|
"call_id": call_id,
|
||||||
@@ -88,6 +95,8 @@ async def _record_minimal(recorder, call_id="c1", **overrides):
|
|||||||
"cache_hit": False,
|
"cache_hit": False,
|
||||||
"error": None,
|
"error": None,
|
||||||
"cost": None,
|
"cost": None,
|
||||||
|
"cached_prompt_tokens": None,
|
||||||
|
"model_reported": None,
|
||||||
}
|
}
|
||||||
fields.update(overrides)
|
fields.update(overrides)
|
||||||
await recorder.record_llm_call(**fields)
|
await recorder.record_llm_call(**fields)
|
||||||
@@ -129,6 +138,158 @@ class TestSQLiteRecorder:
|
|||||||
await _record_minimal(recorder) # 不抛
|
await _record_minimal(recorder) # 不抛
|
||||||
recorder.close()
|
recorder.close()
|
||||||
|
|
||||||
|
async def test_observability_columns_round_trip(self, tmp_path):
|
||||||
|
recorder = SQLiteRecorder(tmp_path / "t.db")
|
||||||
|
await _record_minimal(recorder, call_id="c-hit", cached_prompt_tokens=64)
|
||||||
|
await _record_minimal(recorder, call_id="c-zero", cached_prompt_tokens=0)
|
||||||
|
await _record_minimal(recorder, call_id="c-none", model_reported="MiniMax-Text-01")
|
||||||
|
recorder.close()
|
||||||
|
rows = dict(
|
||||||
|
sqlite3.connect(tmp_path / "t.db")
|
||||||
|
.execute("SELECT call_id, cached_prompt_tokens FROM llm_calls")
|
||||||
|
.fetchall()
|
||||||
|
)
|
||||||
|
assert rows["c-hit"] == 64
|
||||||
|
assert rows["c-zero"] == 0 # 真实零命中,读回仍是 0 而非 NULL
|
||||||
|
assert rows["c-none"] is None
|
||||||
|
|
||||||
|
|
||||||
|
class TestSQLiteColumnBackfill:
|
||||||
|
"""issue #3: 已存在的 18 列旧表必须自动补列,否则每行写入都被丢弃。"""
|
||||||
|
|
||||||
|
_LEGACY_DDL = """
|
||||||
|
CREATE TABLE llm_calls (
|
||||||
|
call_id TEXT PRIMARY KEY,
|
||||||
|
parent_call_id TEXT,
|
||||||
|
session_id TEXT,
|
||||||
|
model TEXT NOT NULL,
|
||||||
|
provider TEXT NOT NULL,
|
||||||
|
source_name TEXT NOT NULL,
|
||||||
|
messages TEXT NOT NULL,
|
||||||
|
response TEXT NOT NULL,
|
||||||
|
thinking TEXT NOT NULL DEFAULT '',
|
||||||
|
prompt_tokens INTEGER NOT NULL,
|
||||||
|
completion_tokens INTEGER NOT NULL,
|
||||||
|
usage_source TEXT NOT NULL,
|
||||||
|
latency_ms INTEGER NOT NULL,
|
||||||
|
ttft_ms REAL,
|
||||||
|
max_inter_token_ms REAL,
|
||||||
|
cache_hit INTEGER NOT NULL DEFAULT 0,
|
||||||
|
error TEXT,
|
||||||
|
cost REAL,
|
||||||
|
created_at TEXT NOT NULL DEFAULT (datetime('now'))
|
||||||
|
);
|
||||||
|
"""
|
||||||
|
|
||||||
|
async def test_legacy_table_is_upgraded_in_place(self, tmp_path):
|
||||||
|
db = tmp_path / "legacy.db"
|
||||||
|
legacy = sqlite3.connect(db)
|
||||||
|
legacy.execute(self._LEGACY_DDL)
|
||||||
|
legacy.commit()
|
||||||
|
legacy.close()
|
||||||
|
|
||||||
|
recorder = SQLiteRecorder(db)
|
||||||
|
await _record_minimal(recorder, cached_prompt_tokens=7, model_reported="m-real")
|
||||||
|
recorder.close()
|
||||||
|
|
||||||
|
conn = sqlite3.connect(db)
|
||||||
|
cols = [r[1] for r in conn.execute("PRAGMA table_info(llm_calls)")]
|
||||||
|
assert cols == _EXPECTED_COLUMNS # ALTER 追加到末尾,与新建库列序一致
|
||||||
|
assert conn.execute(
|
||||||
|
"SELECT cached_prompt_tokens, model_reported FROM llm_calls"
|
||||||
|
).fetchone() == (7, "m-real")
|
||||||
|
|
||||||
|
async def test_backfill_failure_keeps_the_recorder_usable(self, tmp_path):
|
||||||
|
"""补列失败只能逐行降级,绝不能把 recorder 整体变成 no-op(设计 D1 纪律)。
|
||||||
|
|
||||||
|
把 llm_calls 建成同名 view: `CREATE TABLE IF NOT EXISTS` 遇 view 静默
|
||||||
|
no-op(不抛),随后的 ALTER 才抛 "Cannot add a column to a view"——正是
|
||||||
|
补列失败这条分支。`_conn` 必须保持非 None,否则整个 recorder 永久失能。
|
||||||
|
"""
|
||||||
|
db = tmp_path / "view.db"
|
||||||
|
conn = sqlite3.connect(db)
|
||||||
|
conn.execute("CREATE TABLE real_rows (call_id TEXT)")
|
||||||
|
conn.execute("CREATE VIEW llm_calls AS SELECT call_id FROM real_rows")
|
||||||
|
conn.commit()
|
||||||
|
conn.close()
|
||||||
|
|
||||||
|
recorder = SQLiteRecorder(db) # 不得抛
|
||||||
|
assert recorder._conn is not None # 补列失败 ≠ recorder 失能(D1 纪律)
|
||||||
|
await _record_minimal(recorder) # 不得抛
|
||||||
|
recorder.close()
|
||||||
|
|
||||||
|
|
||||||
|
class _FakePgConn:
|
||||||
|
"""记录执行过的语句;可让 ALTER 抛错以模拟权限不足。"""
|
||||||
|
|
||||||
|
def __init__(self, existing: list[str], *, fail_alter: bool = False):
|
||||||
|
self.existing = existing
|
||||||
|
self.fail_alter = fail_alter
|
||||||
|
self.statements: list[str] = []
|
||||||
|
|
||||||
|
async def execute(self, sql, *args):
|
||||||
|
self.statements.append(sql)
|
||||||
|
if sql.startswith("ALTER TABLE") and self.fail_alter:
|
||||||
|
raise RuntimeError("must be owner of table llm_calls")
|
||||||
|
|
||||||
|
async def fetch(self, sql, *args):
|
||||||
|
self.statements.append(sql)
|
||||||
|
return [{"attname": name} for name in self.existing]
|
||||||
|
|
||||||
|
|
||||||
|
class _FakePgPool:
|
||||||
|
def __init__(self, conn):
|
||||||
|
self._conn = conn
|
||||||
|
|
||||||
|
def acquire(self):
|
||||||
|
conn = self._conn
|
||||||
|
|
||||||
|
class _Ctx:
|
||||||
|
async def __aenter__(self):
|
||||||
|
return conn
|
||||||
|
|
||||||
|
async def __aexit__(self, *exc):
|
||||||
|
return False
|
||||||
|
|
||||||
|
return _Ctx()
|
||||||
|
|
||||||
|
|
||||||
|
class TestPostgresBackfillDiscipline:
|
||||||
|
"""PG 补列必须与 SQLite 侧对称: 失败只逐行降级,且稳态不抢排他锁(issue #3)。"""
|
||||||
|
|
||||||
|
_LEGACY = ["call_id", "cost", "created_at"]
|
||||||
|
_CURRENT = ["call_id", "cost", "created_at", "cached_prompt_tokens", "model_reported"]
|
||||||
|
|
||||||
|
def _recorder(self, conn):
|
||||||
|
from polygateway.telemetry.postgres import PostgresRecorder
|
||||||
|
|
||||||
|
return PostgresRecorder("postgresql://u:p@h:5432/polygateway", pool=_FakePgPool(conn))
|
||||||
|
|
||||||
|
async def test_alter_failure_does_not_disable_the_recorder(self):
|
||||||
|
"""ALTER 失败(如账号只有 INSERT 权限)不得置 _failed —— 那会让遥测全灭。"""
|
||||||
|
conn = _FakePgConn(self._LEGACY, fail_alter=True)
|
||||||
|
recorder = self._recorder(conn)
|
||||||
|
await _record_minimal(recorder) # 不得抛
|
||||||
|
assert recorder._failed is False
|
||||||
|
assert any(s.startswith("INSERT INTO llm_calls") for s in conn.statements)
|
||||||
|
|
||||||
|
async def test_no_alter_when_columns_already_exist(self):
|
||||||
|
"""ADD COLUMN IF NOT EXISTS 即使列已存在也会先抢 ACCESS EXCLUSIVE 锁,
|
||||||
|
|
||||||
|
而遥测是内联 await——稳态下必须一条 ALTER 都不发,否则每个进程的首次
|
||||||
|
写入都会去锁共享审计表。
|
||||||
|
"""
|
||||||
|
conn = _FakePgConn(self._CURRENT)
|
||||||
|
await _record_minimal(self._recorder(conn))
|
||||||
|
assert not [s for s in conn.statements if s.startswith("ALTER TABLE")]
|
||||||
|
|
||||||
|
async def test_missing_columns_are_added_once(self):
|
||||||
|
conn = _FakePgConn(self._LEGACY)
|
||||||
|
await _record_minimal(self._recorder(conn))
|
||||||
|
altered = [s for s in conn.statements if s.startswith("ALTER TABLE")]
|
||||||
|
assert len(altered) == 2
|
||||||
|
assert all("IF NOT EXISTS" not in s for s in altered) # 探测已确认缺列,无需再判
|
||||||
|
|
||||||
|
|
||||||
class _MemoryRecorder:
|
class _MemoryRecorder:
|
||||||
def __init__(self):
|
def __init__(self):
|
||||||
@@ -138,6 +299,155 @@ class _MemoryRecorder:
|
|||||||
self.rows.append(fields)
|
self.rows.append(fields)
|
||||||
|
|
||||||
|
|
||||||
|
class TestEmitterRecorderContract:
|
||||||
|
"""emitter 的实参键集合必须与两个后端的 _COLUMNS 完全一致(issue #3)。
|
||||||
|
|
||||||
|
两个后端的 `row = tuple(fields[col] for col in _COLUMNS)` 都在 try **之外**,
|
||||||
|
emitter 漏传一个键就抛 KeyError,被 `_record` 的 except Exception 吞成 warning
|
||||||
|
→ 遥测静默全丢。而 8 个 `**fields` 形态的 fake 一个都拦不住,故显式断言。
|
||||||
|
"""
|
||||||
|
|
||||||
|
async def test_emitter_supplies_exactly_the_backend_columns(self):
|
||||||
|
from polygateway.telemetry.postgres import _COLUMNS as PG_COLUMNS
|
||||||
|
from polygateway.telemetry.sqlite import _COLUMNS as SQLITE_COLUMNS
|
||||||
|
|
||||||
|
rec = _MemoryRecorder()
|
||||||
|
await TelemetryEmitter(rec).emit_attempt(
|
||||||
|
request=_REQ,
|
||||||
|
source=_source(),
|
||||||
|
call_id="cid-1",
|
||||||
|
latency_ms=42,
|
||||||
|
response=_resp(),
|
||||||
|
error=None,
|
||||||
|
)
|
||||||
|
assert set(rec.rows[0]) == set(SQLITE_COLUMNS) == set(PG_COLUMNS)
|
||||||
|
|
||||||
|
@pytest.mark.parametrize("emit", ["attempt", "cache_hit", "terminal_failure"])
|
||||||
|
async def test_every_entry_point_supplies_the_same_keys(self, emit):
|
||||||
|
from polygateway.telemetry.sqlite import _COLUMNS as SQLITE_COLUMNS
|
||||||
|
|
||||||
|
rec = _MemoryRecorder()
|
||||||
|
emitter = TelemetryEmitter(rec)
|
||||||
|
if emit == "attempt":
|
||||||
|
await emitter.emit_attempt(
|
||||||
|
request=_REQ,
|
||||||
|
source=_source(),
|
||||||
|
call_id="c",
|
||||||
|
latency_ms=1,
|
||||||
|
response=None,
|
||||||
|
error="boom",
|
||||||
|
)
|
||||||
|
elif emit == "cache_hit":
|
||||||
|
await emitter.emit_cache_hit(request=_REQ, response=_resp())
|
||||||
|
else:
|
||||||
|
await emitter.emit_terminal_failure(
|
||||||
|
request=_REQ, call_id="c", latency_ms=1, error="dead"
|
||||||
|
)
|
||||||
|
assert set(rec.rows[0]) == set(SQLITE_COLUMNS)
|
||||||
|
|
||||||
|
|
||||||
|
class TestEmitterObservabilityFields:
|
||||||
|
"""issue #3: 三个入口各自的取值口径(设计 §5 表)。"""
|
||||||
|
|
||||||
|
async def test_attempt_carries_the_response_values(self):
|
||||||
|
rec = _MemoryRecorder()
|
||||||
|
await TelemetryEmitter(rec).emit_attempt(
|
||||||
|
request=_REQ,
|
||||||
|
source=_source(),
|
||||||
|
call_id="cid-1",
|
||||||
|
latency_ms=42,
|
||||||
|
response=_resp(cached_prompt_tokens=64, model_reported="m-real"),
|
||||||
|
error=None,
|
||||||
|
)
|
||||||
|
assert rec.rows[0]["cached_prompt_tokens"] == 64
|
||||||
|
assert rec.rows[0]["model_reported"] == "m-real"
|
||||||
|
|
||||||
|
async def test_failed_attempt_has_no_provider_facts(self):
|
||||||
|
rec = _MemoryRecorder()
|
||||||
|
await TelemetryEmitter(rec).emit_attempt(
|
||||||
|
request=_REQ,
|
||||||
|
source=_source(),
|
||||||
|
call_id="cid-2",
|
||||||
|
latency_ms=7,
|
||||||
|
response=None,
|
||||||
|
error="boom",
|
||||||
|
)
|
||||||
|
assert rec.rows[0]["cached_prompt_tokens"] is None
|
||||||
|
assert rec.rows[0]["model_reported"] is None
|
||||||
|
|
||||||
|
async def test_cache_hit_replays_the_recorded_values(self):
|
||||||
|
"""决策 B1: 命中行原样回放,故命中率统计必须带 WHERE cache_hit = false。"""
|
||||||
|
rec = _MemoryRecorder()
|
||||||
|
await TelemetryEmitter(rec).emit_cache_hit(
|
||||||
|
request=_REQ, response=_resp(cached_prompt_tokens=64, model_reported="m-real")
|
||||||
|
)
|
||||||
|
row = rec.rows[0]
|
||||||
|
assert row["cache_hit"] is True
|
||||||
|
assert row["cached_prompt_tokens"] == 64 and row["model_reported"] == "m-real"
|
||||||
|
|
||||||
|
async def test_terminal_failure_records_none(self):
|
||||||
|
rec = _MemoryRecorder()
|
||||||
|
await TelemetryEmitter(rec).emit_terminal_failure(
|
||||||
|
request=_REQ, call_id="c", latency_ms=1, error="dead"
|
||||||
|
)
|
||||||
|
assert rec.rows[0]["cached_prompt_tokens"] is None
|
||||||
|
assert rec.rows[0]["model_reported"] is None
|
||||||
|
|
||||||
|
|
||||||
|
class TestCostWithCachedTier:
|
||||||
|
"""issue #3: 命中部分按缓存单价计费,避免 cost 系统性高估。"""
|
||||||
|
|
||||||
|
_TABLE = PricingTable(
|
||||||
|
{"m": ModelPrice(input_per_1m=10.0, output_per_1m=20.0, cached_input_per_1m=2.0)}
|
||||||
|
)
|
||||||
|
|
||||||
|
async def test_cached_hit_lowers_the_recorded_cost(self):
|
||||||
|
rec = _MemoryRecorder()
|
||||||
|
emitter = TelemetryEmitter(rec, pricing=self._TABLE)
|
||||||
|
full = _resp(prompt_tokens=1_000_000, completion_tokens=0)
|
||||||
|
await emitter.emit_attempt(
|
||||||
|
request=_REQ,
|
||||||
|
source=_source(),
|
||||||
|
call_id="c1",
|
||||||
|
latency_ms=1,
|
||||||
|
response=full,
|
||||||
|
error=None,
|
||||||
|
)
|
||||||
|
await emitter.emit_attempt(
|
||||||
|
request=_REQ,
|
||||||
|
source=_source(),
|
||||||
|
call_id="c2",
|
||||||
|
latency_ms=1,
|
||||||
|
response=_resp(
|
||||||
|
prompt_tokens=1_000_000, completion_tokens=0, cached_prompt_tokens=600_000
|
||||||
|
),
|
||||||
|
error=None,
|
||||||
|
)
|
||||||
|
assert rec.rows[0]["cost"] == pytest.approx(10.0)
|
||||||
|
assert rec.rows[1]["cost"] == pytest.approx(5.2) # 400k×10 + 600k×2
|
||||||
|
|
||||||
|
async def test_cache_hit_row_still_costs_zero(self):
|
||||||
|
"""缓存命中未产生新调用 → cost 恒 0.0,该短路必须排在任何换算之前。"""
|
||||||
|
rec = _MemoryRecorder()
|
||||||
|
await TelemetryEmitter(rec, pricing=self._TABLE).emit_cache_hit(
|
||||||
|
request=_REQ,
|
||||||
|
response=_resp(prompt_tokens=1_000_000, cached_prompt_tokens=600_000),
|
||||||
|
)
|
||||||
|
assert rec.rows[0]["cost"] == 0.0
|
||||||
|
|
||||||
|
async def test_unavailable_usage_still_costs_none(self):
|
||||||
|
rec = _MemoryRecorder()
|
||||||
|
await TelemetryEmitter(rec, pricing=self._TABLE).emit_attempt(
|
||||||
|
request=_REQ,
|
||||||
|
source=_source(),
|
||||||
|
call_id="c",
|
||||||
|
latency_ms=1,
|
||||||
|
response=_resp(usage_source="unavailable", cached_prompt_tokens=5),
|
||||||
|
error=None,
|
||||||
|
)
|
||||||
|
assert rec.rows[0]["cost"] is None
|
||||||
|
|
||||||
|
|
||||||
class TestEmitter:
|
class TestEmitter:
|
||||||
async def test_attempt_success_row(self):
|
async def test_attempt_success_row(self):
|
||||||
rec = _MemoryRecorder()
|
rec = _MemoryRecorder()
|
||||||
@@ -168,7 +478,58 @@ class TestEmitter:
|
|||||||
)
|
)
|
||||||
row = rec.rows[0]
|
row = rec.rows[0]
|
||||||
assert row["error"].startswith("TransientError")
|
assert row["error"].startswith("TransientError")
|
||||||
assert row["response"] == "" and row["usage_source"] == "estimated"
|
# 失败尝试没有任何用量信息可言 → unavailable(设计 §3.2 #6)
|
||||||
|
assert row["response"] == "" and row["usage_source"] == "unavailable"
|
||||||
|
assert row["cost"] is None
|
||||||
|
|
||||||
|
async def test_terminal_failure_row_is_unavailable(self):
|
||||||
|
rec = _MemoryRecorder()
|
||||||
|
await TelemetryEmitter(rec, pricing=_PRICING).emit_terminal_failure(
|
||||||
|
request=_REQ, call_id="cid-t", latency_ms=5, error="cancelled"
|
||||||
|
)
|
||||||
|
row = rec.rows[0]
|
||||||
|
assert row["usage_source"] == "unavailable" and row["cost"] is None
|
||||||
|
|
||||||
|
@pytest.mark.parametrize(("prompt", "completion"), [(0, 0), (0, 4000)])
|
||||||
|
async def test_unavailable_success_row_has_null_cost(self, prompt, completion):
|
||||||
|
"""产生了真实调用但用量不可得 → cost 记 NULL(设计 §3.1 不变式)。
|
||||||
|
|
||||||
|
参数第二组是改前兜底写出的 `0/4000` 形态: 那时换算出 0.032 的假金额。
|
||||||
|
"""
|
||||||
|
rec = _MemoryRecorder()
|
||||||
|
await TelemetryEmitter(rec, pricing=_PRICING).emit_attempt(
|
||||||
|
request=_REQ,
|
||||||
|
source=_source(),
|
||||||
|
call_id="cid-u",
|
||||||
|
latency_ms=42,
|
||||||
|
response=_resp(
|
||||||
|
usage_source="unavailable", prompt_tokens=prompt, completion_tokens=completion
|
||||||
|
),
|
||||||
|
error=None,
|
||||||
|
)
|
||||||
|
assert rec.rows[0]["cost"] is None
|
||||||
|
|
||||||
|
async def test_measured_row_still_priced(self):
|
||||||
|
"""对照组: 同一价格表下 measured 行照常换算,证明 None 不是价格表没接上。"""
|
||||||
|
rec = _MemoryRecorder()
|
||||||
|
await TelemetryEmitter(rec, pricing=_PRICING).emit_attempt(
|
||||||
|
request=_REQ,
|
||||||
|
source=_source(),
|
||||||
|
call_id="cid-m",
|
||||||
|
latency_ms=42,
|
||||||
|
response=_resp(prompt_tokens=0, completion_tokens=4000),
|
||||||
|
error=None,
|
||||||
|
)
|
||||||
|
assert rec.rows[0]["cost"] == pytest.approx(0.032)
|
||||||
|
|
||||||
|
async def test_cache_hit_keeps_zero_cost_even_when_unavailable(self):
|
||||||
|
"""缓存命中未产生新调用,0.0 是事实而非未知 → 短路必须排在 cache_hit 之后。"""
|
||||||
|
rec = _MemoryRecorder()
|
||||||
|
await TelemetryEmitter(rec, pricing=_PRICING).emit_cache_hit(
|
||||||
|
request=_REQ,
|
||||||
|
response=_resp(cache_hit=True, usage_source="unavailable", completion_tokens=4000),
|
||||||
|
)
|
||||||
|
assert rec.rows[0]["cache_hit"] is True and rec.rows[0]["cost"] == 0.0
|
||||||
|
|
||||||
async def test_multimodal_messages_digested_before_storage(self):
|
async def test_multimodal_messages_digested_before_storage(self):
|
||||||
rec = _MemoryRecorder()
|
rec = _MemoryRecorder()
|
||||||
|
|||||||
@@ -1,10 +1,12 @@
|
|||||||
"""types.py 冻结签名的行为测试(M1 设计 §2)。"""
|
"""types.py 冻结签名的行为测试(M1 设计 §2)。"""
|
||||||
|
|
||||||
import dataclasses
|
import dataclasses
|
||||||
|
import inspect
|
||||||
|
|
||||||
import pytest
|
import pytest
|
||||||
|
|
||||||
from polygateway.types import (
|
from polygateway.types import (
|
||||||
|
USAGE_SOURCES,
|
||||||
BackpressurePolicy,
|
BackpressurePolicy,
|
||||||
BreakerConfig,
|
BreakerConfig,
|
||||||
ChatRequest,
|
ChatRequest,
|
||||||
@@ -47,6 +49,29 @@ class TestLLMResponse:
|
|||||||
assert resp.usage_source == "measured"
|
assert resp.usage_source == "measured"
|
||||||
assert resp.structured_data is None
|
assert resp.structured_data is None
|
||||||
|
|
||||||
|
def test_observability_fields_default_to_none(self):
|
||||||
|
"""issue #3: None = 该源未上报,与"上报了但是 0"区分(0 是真实零命中)。"""
|
||||||
|
resp = LLMResponse("c", "t", "m", "p", 1, 2, 3, None, None, False, "cid")
|
||||||
|
assert resp.cached_prompt_tokens is None
|
||||||
|
assert resp.model_reported is None
|
||||||
|
filled = LLMResponse(
|
||||||
|
"c",
|
||||||
|
"t",
|
||||||
|
"m",
|
||||||
|
"p",
|
||||||
|
1,
|
||||||
|
2,
|
||||||
|
3,
|
||||||
|
None,
|
||||||
|
None,
|
||||||
|
False,
|
||||||
|
"cid",
|
||||||
|
cached_prompt_tokens=0,
|
||||||
|
model_reported="MiniMax-Text-01-250321",
|
||||||
|
)
|
||||||
|
assert filled.cached_prompt_tokens == 0 # 真实零命中,不得与 None 混同
|
||||||
|
assert filled.model_reported == "MiniMax-Text-01-250321"
|
||||||
|
|
||||||
def test_frozen(self):
|
def test_frozen(self):
|
||||||
resp = LLMResponse("c", "t", "m", "p", 1, 2, 3, None, None, False, "cid")
|
resp = LLMResponse("c", "t", "m", "p", 1, 2, 3, None, None, False, "cid")
|
||||||
with pytest.raises(dataclasses.FrozenInstanceError):
|
with pytest.raises(dataclasses.FrozenInstanceError):
|
||||||
@@ -91,9 +116,11 @@ class TestSourceConfig:
|
|||||||
with pytest.raises(ValueError):
|
with pytest.raises(ValueError):
|
||||||
_make_source(timeout_s=0)
|
_make_source(timeout_s=0)
|
||||||
|
|
||||||
def test_tpm_requires_est_tokens(self):
|
def test_tpm_does_not_require_est_tokens(self):
|
||||||
with pytest.raises(ValueError):
|
"""`tpm > 0 ⇒ est_tokens > 0` 已解绑: 供应商配额可独立于库实现细节填写。"""
|
||||||
_make_source(tpm=10000, est_tokens=0)
|
derived = _make_source(tpm=10000, est_tokens=0)
|
||||||
|
assert derived.est_tokens == 0
|
||||||
|
assert derived.effective_est_tokens() == 166 # max(1, 10000 // 60)
|
||||||
assert _make_source(tpm=10000, est_tokens=800).est_tokens == 800
|
assert _make_source(tpm=10000, est_tokens=800).est_tokens == 800
|
||||||
|
|
||||||
def test_negative_gate_rejected(self):
|
def test_negative_gate_rejected(self):
|
||||||
@@ -117,6 +144,70 @@ class TestSourceConfig:
|
|||||||
_make_source(missing_done="ignore")
|
_make_source(missing_done="ignore")
|
||||||
|
|
||||||
|
|
||||||
|
class TestEffectiveEstTokens:
|
||||||
|
"""TPM 入场预扣量的派生(est_tokens 解耦设计 §2.2)。"""
|
||||||
|
|
||||||
|
def test_derives_from_tpm_scale_free(self):
|
||||||
|
"""派生量随配额同比缩放: 两种配额规模的在途上限同为 60 个调用。"""
|
||||||
|
assert _make_source(tpm=6000).effective_est_tokens() == 100
|
||||||
|
assert _make_source(tpm=600000).effective_est_tokens() == 10000
|
||||||
|
|
||||||
|
def test_derived_floor_is_one(self):
|
||||||
|
"""极小配额下派生量不得塌到 0——0 预扣等于 TPM 闸不设防(设计 §2.2)。"""
|
||||||
|
assert _make_source(tpm=30).effective_est_tokens() == 1
|
||||||
|
|
||||||
|
def test_zero_when_tpm_gate_disabled(self):
|
||||||
|
"""tpm=0 即 TPM 闸未启用,无需预扣。"""
|
||||||
|
assert _make_source().effective_est_tokens() == 0
|
||||||
|
|
||||||
|
def test_explicit_value_wins(self):
|
||||||
|
"""显式配置是调优覆盖,优先于派生。"""
|
||||||
|
assert _make_source(tpm=6000, est_tokens=4000).effective_est_tokens() == 4000
|
||||||
|
|
||||||
|
def test_is_pure_sync_function(self):
|
||||||
|
"""纯方法: 非协程、可重复调用、不改动自身字段(设计 §5 并发前提)。"""
|
||||||
|
assert not inspect.iscoroutinefunction(SourceConfig.effective_est_tokens)
|
||||||
|
src = _make_source(tpm=6000)
|
||||||
|
assert src.effective_est_tokens() == src.effective_est_tokens() == 100
|
||||||
|
assert src.est_tokens == 0 # 派生不回写字段
|
||||||
|
|
||||||
|
|
||||||
|
class TestUsageSourceDomain:
|
||||||
|
"""`usage_source` 三态值域常量(设计 §3.1)。"""
|
||||||
|
|
||||||
|
def test_domain_is_exactly_three_values(self):
|
||||||
|
assert set(USAGE_SOURCES) == {"measured", "estimated", "unavailable"}
|
||||||
|
assert isinstance(USAGE_SOURCES, frozenset) # 不可变: 调用方无法就地扩张值域
|
||||||
|
|
||||||
|
@pytest.mark.parametrize(
|
||||||
|
"build",
|
||||||
|
[
|
||||||
|
lambda v: LLMResponse(
|
||||||
|
"c", "t", "m", "p", 1, 2, 3, None, None, False, "cid", usage_source=v
|
||||||
|
),
|
||||||
|
lambda v: Usage(prompt_tokens=1, completion_tokens=2, usage_source=v),
|
||||||
|
lambda v: TransportResult(
|
||||||
|
content="c",
|
||||||
|
thinking="",
|
||||||
|
prompt_tokens=1,
|
||||||
|
completion_tokens=2,
|
||||||
|
usage_source=v,
|
||||||
|
ttft_ms=None,
|
||||||
|
max_inter_token_ms=None,
|
||||||
|
raw={},
|
||||||
|
),
|
||||||
|
],
|
||||||
|
)
|
||||||
|
def test_no_runtime_validation_on_public_dataclasses(self, build):
|
||||||
|
"""越界值构造**不得**抛异常(锁定设计 §3.1 的落点裁决)。
|
||||||
|
|
||||||
|
这些是运行时构造点(如 retry.py:418),裸 `ValueError` 不属 errors.py
|
||||||
|
四分类、`RetryMW` 不捕它,会直接逃出 `chat()`——故值域只约束生产侧,
|
||||||
|
不落在公共 frozen dataclass 的 `__post_init__` 上。
|
||||||
|
"""
|
||||||
|
assert build("garbage").usage_source == "garbage"
|
||||||
|
|
||||||
|
|
||||||
class TestResilienceConfigs:
|
class TestResilienceConfigs:
|
||||||
def test_retry_policy_validation(self):
|
def test_retry_policy_validation(self):
|
||||||
assert RetryPolicy(max_attempts=3, backoff_base_s=2.0, backoff_max_s=30.0)
|
assert RetryPolicy(max_attempts=3, backoff_base_s=2.0, backoff_max_s=30.0)
|
||||||
@@ -154,6 +245,8 @@ class TestAuxTypes:
|
|||||||
raw={"id": "x"},
|
raw={"id": "x"},
|
||||||
)
|
)
|
||||||
assert s.raw["id"] == "x"
|
assert s.raw["id"] == "x"
|
||||||
|
# issue #3: 新字段带默认值,不填也能构造(OCR 等其他 transport 零改动)
|
||||||
|
assert s.cached_prompt_tokens is None and s.model_reported is None
|
||||||
|
|
||||||
|
|
||||||
class TestOcrTypes:
|
class TestOcrTypes:
|
||||||
|
|||||||
@@ -0,0 +1,295 @@
|
|||||||
|
"""`usage_source` 值域封闭: 库内所有生产点的产出恒落在 `USAGE_SOURCES` 内。
|
||||||
|
|
||||||
|
设计 §3.1 裁定值域**只约束生产侧**——公共 frozen dataclass 不加运行时校验
|
||||||
|
(裸 `ValueError` 不属四分类,会逃出 `chat()`;该裁决的锁定断言在
|
||||||
|
`test_types.py::TestUsageSourceDomain`)。因此封闭性只能由"逐个驱动生产点、
|
||||||
|
断言其产出在三态内"来保证,本文件即该断言的载体。
|
||||||
|
|
||||||
|
独立成文件而非并入 `test_types.py`: 断言横跨 transports / embedding /
|
||||||
|
telemetry 三层,放进最内层内核的类型测试会让它反向依赖具体实现。
|
||||||
|
|
||||||
|
覆盖的生产点(设计 §3.2 逐处改动表的字面量产出方):
|
||||||
|
`_resolve_usage`、`_resolve_embedding_usage`、`_resolve_stream_usage`(打捞覆盖)、
|
||||||
|
`EmbeddingClient._merge`、`EmbeddingClient.embed` 空输入短路、
|
||||||
|
`OcrClient._emit`、`TelemetryEmitter.emit_attempt/emit_cache_hit/emit_terminal_failure`。
|
||||||
|
"""
|
||||||
|
|
||||||
|
import itertools
|
||||||
|
import json
|
||||||
|
|
||||||
|
import httpx
|
||||||
|
import pytest
|
||||||
|
|
||||||
|
from polygateway.backends.memory.breaker import InMemoryGate
|
||||||
|
from polygateway.backends.memory.limiter import InMemoryLimiter
|
||||||
|
from polygateway.embedding import EmbeddingClient, _BatchOutcome
|
||||||
|
from polygateway.middleware.telemetry import TelemetryEmitter
|
||||||
|
from polygateway.ocr import OcrClient
|
||||||
|
from polygateway.sources import RoundRobinSelector
|
||||||
|
from polygateway.transports.openai_compat import (
|
||||||
|
OpenAICompatTransport,
|
||||||
|
_resolve_embedding_usage,
|
||||||
|
_resolve_usage,
|
||||||
|
)
|
||||||
|
from polygateway.types import (
|
||||||
|
USAGE_SOURCES,
|
||||||
|
BackpressurePolicy,
|
||||||
|
BreakerConfig,
|
||||||
|
ChatRequest,
|
||||||
|
EmbeddingTransportResult,
|
||||||
|
GlobalLimits,
|
||||||
|
LLMResponse,
|
||||||
|
OcrTextTransportResult,
|
||||||
|
RetryPolicy,
|
||||||
|
SourceConfig,
|
||||||
|
)
|
||||||
|
|
||||||
|
_REQ = ChatRequest(messages=[{"role": "user", "content": "hi"}])
|
||||||
|
_DOMAIN = sorted(USAGE_SOURCES)
|
||||||
|
|
||||||
|
|
||||||
|
def _src():
|
||||||
|
return SourceConfig(
|
||||||
|
name="s1",
|
||||||
|
provider="p",
|
||||||
|
base_url="https://gw.example/v1",
|
||||||
|
api_key="sk",
|
||||||
|
model="m",
|
||||||
|
timeout_s=10.0,
|
||||||
|
est_tokens=4000, # 兜底口径的历史来源: 生产点不得因它落到三态之外
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class _MemoryRecorder:
|
||||||
|
def __init__(self):
|
||||||
|
self.rows = []
|
||||||
|
|
||||||
|
async def record_llm_call(self, **fields):
|
||||||
|
self.rows.append(fields)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize(
|
||||||
|
"usage",
|
||||||
|
[
|
||||||
|
{"prompt_tokens": 12, "completion_tokens": 34}, # 完整可信
|
||||||
|
{}, # 整帧缺失
|
||||||
|
{"prompt_tokens": 0, "completion_tokens": 0}, # 全 0(和不为正)
|
||||||
|
{"prompt_tokens": "12", "completion_tokens": 34}, # 类型非法
|
||||||
|
{"prompt_tokens": None, "completion_tokens": None},
|
||||||
|
{"prompt_tokens": 12}, # 半帧
|
||||||
|
],
|
||||||
|
)
|
||||||
|
def test_resolve_usage_stays_in_domain(usage):
|
||||||
|
assert _resolve_usage(usage)[2] in USAGE_SOURCES
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize(
|
||||||
|
"data",
|
||||||
|
[
|
||||||
|
{"usage": {"prompt_tokens": 12}},
|
||||||
|
{},
|
||||||
|
{"usage": None},
|
||||||
|
{"usage": {}},
|
||||||
|
{"usage": {"prompt_tokens": 0}},
|
||||||
|
{"usage": {"prompt_tokens": "12"}},
|
||||||
|
],
|
||||||
|
)
|
||||||
|
def test_resolve_embedding_usage_stays_in_domain(data):
|
||||||
|
assert _resolve_embedding_usage(data)[1] in USAGE_SOURCES
|
||||||
|
|
||||||
|
|
||||||
|
def _sse(*frames, done):
|
||||||
|
"""构造 SSE 响应;done=False 触发打捞路径(`_complete_stream` 的覆盖分支)。"""
|
||||||
|
text = "".join(f"data: {json.dumps(f)}\n\n" for f in frames) + (
|
||||||
|
"data: [DONE]\n\n" if done else ""
|
||||||
|
)
|
||||||
|
return httpx.Response(200, content=text.encode(), headers={"content-type": "text/event-stream"})
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize("usage", [{"prompt_tokens": 11, "completion_tokens": 7}, None])
|
||||||
|
async def test_salvage_override_stays_in_domain(usage):
|
||||||
|
"""打捞覆盖(`openai_compat._complete_stream`)是第三个字面量产出方。"""
|
||||||
|
frames = [{"choices": [{"delta": {"content": "partial"}}]}]
|
||||||
|
if usage is not None:
|
||||||
|
frames.append({"choices": [], "usage": usage})
|
||||||
|
transport = OpenAICompatTransport(
|
||||||
|
client_factory=lambda src: httpx.AsyncClient(
|
||||||
|
base_url=src.base_url,
|
||||||
|
transport=httpx.MockTransport(lambda request: _sse(*frames, done=False)),
|
||||||
|
)
|
||||||
|
)
|
||||||
|
source = SourceConfig(
|
||||||
|
name="s1",
|
||||||
|
provider="qwen",
|
||||||
|
base_url="https://gw.example/v1",
|
||||||
|
api_key="sk",
|
||||||
|
model="m",
|
||||||
|
timeout_s=10.0,
|
||||||
|
est_tokens=4000,
|
||||||
|
missing_done="salvage",
|
||||||
|
)
|
||||||
|
result = await transport.complete(
|
||||||
|
messages=[{"role": "user", "content": "hi"}],
|
||||||
|
source=source,
|
||||||
|
stream=True,
|
||||||
|
overlay={},
|
||||||
|
call_id="cid",
|
||||||
|
)
|
||||||
|
assert result.usage_source in USAGE_SOURCES
|
||||||
|
|
||||||
|
|
||||||
|
class _ScriptedOcrTransport:
|
||||||
|
async def recognize_text(self, *, image, source, call_id):
|
||||||
|
return OcrTextTransportResult(text="LINE-1", raw={"task_type": "text"})
|
||||||
|
|
||||||
|
async def parse_layout(self, *, image, source, call_id):
|
||||||
|
raise NotImplementedError
|
||||||
|
|
||||||
|
async def check_health(self, *, source):
|
||||||
|
raise NotImplementedError
|
||||||
|
|
||||||
|
|
||||||
|
async def test_ocr_emit_stays_in_domain():
|
||||||
|
"""`OcrClient._emit` 的字面量(ocr.py:411)同样纳入封闭性断言。
|
||||||
|
|
||||||
|
值取 `measured` 是设计 §3.3 的裁决(OCR 的 0 token 属事实);此处只断言
|
||||||
|
落在三态内,精确取值的防回归钉在 `test_ocr_client.py`。
|
||||||
|
"""
|
||||||
|
source = SourceConfig(
|
||||||
|
name="m1",
|
||||||
|
provider="monkey",
|
||||||
|
base_url="http://gw.example",
|
||||||
|
api_key="none",
|
||||||
|
model="monkey-ocr",
|
||||||
|
timeout_s=10.0,
|
||||||
|
)
|
||||||
|
recorder = _MemoryRecorder()
|
||||||
|
client = OcrClient(
|
||||||
|
scope="ocr",
|
||||||
|
sources=[source],
|
||||||
|
selector=RoundRobinSelector(),
|
||||||
|
limiter=InMemoryLimiter(
|
||||||
|
scope="ocr",
|
||||||
|
sources={source.name: source},
|
||||||
|
global_limits=GlobalLimits(max_concurrency=0, rpm=0, tpm=0),
|
||||||
|
lease_ttl_s=100.0,
|
||||||
|
),
|
||||||
|
breaker=InMemoryGate(
|
||||||
|
config=BreakerConfig(fail_threshold=3, cooldown_s=60.0, probe_ttl_s=120.0)
|
||||||
|
),
|
||||||
|
transport=_ScriptedOcrTransport(),
|
||||||
|
retry=RetryPolicy(max_attempts=1, backoff_base_s=0.001, backoff_max_s=0.01),
|
||||||
|
backpressure=BackpressurePolicy(stall_window_s=300.0, poll_interval_s=0.001),
|
||||||
|
telemetry=recorder,
|
||||||
|
)
|
||||||
|
await client.recognize_text(b"jpg")
|
||||||
|
assert recorder.rows[0]["usage_source"] in USAGE_SOURCES
|
||||||
|
|
||||||
|
|
||||||
|
def _merge_client():
|
||||||
|
"""构造仅用于调用 `_merge` 的最小 EmbeddingClient(不发起任何调用)。"""
|
||||||
|
source = _src()
|
||||||
|
return EmbeddingClient(
|
||||||
|
scope="embed",
|
||||||
|
sources=[source],
|
||||||
|
selector=RoundRobinSelector(),
|
||||||
|
limiter=InMemoryLimiter(
|
||||||
|
scope="embed",
|
||||||
|
sources={source.name: source},
|
||||||
|
global_limits=GlobalLimits(max_concurrency=0, rpm=0, tpm=0),
|
||||||
|
lease_ttl_s=100.0,
|
||||||
|
),
|
||||||
|
breaker=InMemoryGate(
|
||||||
|
config=BreakerConfig(fail_threshold=3, cooldown_s=60.0, probe_ttl_s=120.0)
|
||||||
|
),
|
||||||
|
transport=object(),
|
||||||
|
retry=RetryPolicy(max_attempts=1, backoff_base_s=0.001, backoff_max_s=0.01),
|
||||||
|
backpressure=BackpressurePolicy(stall_window_s=300.0, poll_interval_s=0.001),
|
||||||
|
batch_size=2,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize(("first", "second"), list(itertools.product(_DOMAIN, repeat=2)))
|
||||||
|
def test_merge_stays_in_domain(first, second):
|
||||||
|
"""任意两批 usage_source 组合(含尚无生产者的 unavailable)合并后仍在三态内。"""
|
||||||
|
source = _src()
|
||||||
|
outcomes = [
|
||||||
|
_BatchOutcome(
|
||||||
|
result=EmbeddingTransportResult(
|
||||||
|
vectors=[[1.0]], dim=1, prompt_tokens=1, usage_source=value, raw={}
|
||||||
|
),
|
||||||
|
source=source,
|
||||||
|
call_id="c",
|
||||||
|
latency_ms=1,
|
||||||
|
)
|
||||||
|
for value in (first, second)
|
||||||
|
]
|
||||||
|
assert _merge_client()._merge(outcomes).usage_source in USAGE_SOURCES
|
||||||
|
|
||||||
|
|
||||||
|
async def test_empty_input_short_circuit_stays_in_domain():
|
||||||
|
"""空输入短路自造响应(embedding.py:151),不经 transport 也须落在三态内。"""
|
||||||
|
resp = await _merge_client().embed([])
|
||||||
|
assert resp.usage_source in USAGE_SOURCES
|
||||||
|
|
||||||
|
|
||||||
|
def _resp(usage_source):
|
||||||
|
return LLMResponse(
|
||||||
|
content="ok",
|
||||||
|
thinking="",
|
||||||
|
model="m",
|
||||||
|
provider="p",
|
||||||
|
prompt_tokens=1,
|
||||||
|
completion_tokens=2,
|
||||||
|
latency_ms=30,
|
||||||
|
ttft_ms=None,
|
||||||
|
max_inter_token_ms=None,
|
||||||
|
cache_hit=False,
|
||||||
|
call_id="cid",
|
||||||
|
source_name="s1",
|
||||||
|
usage_source=usage_source,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize("emitted", _DOMAIN)
|
||||||
|
async def test_emit_attempt_success_stays_in_domain(emitted):
|
||||||
|
recorder = _MemoryRecorder()
|
||||||
|
await TelemetryEmitter(recorder).emit_attempt(
|
||||||
|
request=_REQ,
|
||||||
|
source=_src(),
|
||||||
|
call_id="cid",
|
||||||
|
latency_ms=10,
|
||||||
|
response=_resp(emitted),
|
||||||
|
error=None,
|
||||||
|
)
|
||||||
|
assert recorder.rows[0]["usage_source"] in USAGE_SOURCES
|
||||||
|
|
||||||
|
|
||||||
|
async def test_emit_attempt_failed_attempt_stays_in_domain():
|
||||||
|
"""失败尝试无 response,`usage_source` 取 emitter 自己的字面量。"""
|
||||||
|
recorder = _MemoryRecorder()
|
||||||
|
await TelemetryEmitter(recorder).emit_attempt(
|
||||||
|
request=_REQ,
|
||||||
|
source=_src(),
|
||||||
|
call_id="cid",
|
||||||
|
latency_ms=10,
|
||||||
|
response=None,
|
||||||
|
error="boom",
|
||||||
|
)
|
||||||
|
assert recorder.rows[0]["usage_source"] in USAGE_SOURCES
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize("emitted", _DOMAIN)
|
||||||
|
async def test_emit_cache_hit_stays_in_domain(emitted):
|
||||||
|
recorder = _MemoryRecorder()
|
||||||
|
await TelemetryEmitter(recorder).emit_cache_hit(request=_REQ, response=_resp(emitted))
|
||||||
|
assert recorder.rows[0]["usage_source"] in USAGE_SOURCES
|
||||||
|
|
||||||
|
|
||||||
|
async def test_emit_terminal_failure_stays_in_domain():
|
||||||
|
"""终态失败无具体源,`usage_source` 同样取 emitter 字面量。"""
|
||||||
|
recorder = _MemoryRecorder()
|
||||||
|
await TelemetryEmitter(recorder).emit_terminal_failure(
|
||||||
|
request=_REQ, call_id="cid", latency_ms=10, error="cancelled"
|
||||||
|
)
|
||||||
|
assert recorder.rows[0]["usage_source"] in USAGE_SOURCES
|
||||||
Reference in New Issue
Block a user