Skip to content

fix: settle Responses cached token usage - #6892

Merged
seefs001 merged 1 commit into
QuantumNous:mainfrom
LiaoQi98:codex/fix-responses-cached-token-billing
Aug 18, 2026
Merged

seefs001 merged 1 commit into
QuantumNous:mainfrom
LiaoQi98:codex/fix-responses-cached-token-billing

Conversation

@LiaoQi98

@LiaoQi98 LiaoQi98 commented Aug 17, 2026 •

Copy link
Copy Markdown
Contributor

⚠️ 提交说明 / PR Notice

Important

  • 请提供人工撰写的简洁摘要,避免直接粘贴未经整理的 AI 输出。

Note

This change and PR description were AI-assisted with Codex for LiaoQi98. The PR is opened as a draft for human and maintainer review.

📝 变更描述 / Description

Responses → Chat conversion already exposes input_tokens_details.cached_tokens to clients, but settlement prefers the preserved Responses BillingUsage snapshot. That snapshot keeps cache details under InputTokensDetails, while quota calculation reads PromptTokensDetails, so cached input was charged at the normal input ratio.

This change normalizes Responses input details onto the settlement-only usage copy before quota calculation. Existing non-zero canonical prompt details remain authoritative, prompt_cache_hit_tokens is retained as a compatibility fallback, and the original billing snapshot remains unchanged for auditing.

Regression coverage verifies that 100 input tokens with 40 cached tokens, a 0.25 cache ratio, and 10 output tokens now settle to quota 90 instead of 120.

🚀 变更类型 / Type of change

  • 🐛 Bug 修复 (Bug fix) - 请关联对应 Issue,避免将设计取舍、理解偏差或预期不一致直接归类为 bug
  • ✨ 新功能 (New feature) - 重大特性建议先通过 Issue 沟通
  • ⚡ 性能优化 / 重构 (Refactor)
  • 📝 文档更新 (Documentation)

🔗 关联任务 / Related Issue

✅ 提交前检查项 / Checklist

  • 人工确认: 我已亲自整理并撰写此描述,没有直接粘贴未经处理的 AI 输出。
  • 非重复提交: 我已搜索现有的 Issues 与 PRs,确认不是重复提交。
  • Bug fix 说明: 若此 PR 标记为 Bug fix,我已提交或关联对应 Issue,且不会将设计取舍、预期不一致或理解偏差直接归类为 bug。
  • 变更理解: 我已理解这些更改的工作原理及可能影响。
  • 范围聚焦: 本 PR 未包含任何与当前任务无关的代码改动。
  • 本地验证: 已在本地运行并通过测试或手动验证,维护者可以据此复核结果。
  • 安全合规: 代码中无敏感凭据,且符合项目代码规范。

📸 运行证明 / Proof of Work

go test ./service -run 'TestCalculateTextQuotaSummaryUsesOpenAIResponsesInputTokenDetails|TestUsageFromOpenAIBillingUsage' -count=1
ok  github.com/QuantumNous/new-api/service

go test ./service -count=1
ok  github.com/QuantumNous/new-api/service

git diff --check
passed

An additional go test ./... -count=1 run passed the backend packages, but the root package setup could not compile because the generated local web/dist directory was absent.

Summary by CodeRabbit

  • Bug Fixes

    • Improved billing usage handling for OpenAI Responses.
    • More accurately reports cached, text, image, audio, and cache-related input token usage.
    • Correctly falls back to available prompt cache counts when detailed data is missing.
    • Ensures cached-input quota calculations remain accurate without altering billing records.
  • Tests

    • Added coverage for billing normalization, cache details, fallback behavior, and quota calculations.

@coderabbitai

coderabbitai Bot commented Aug 17, 2026 •

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 5dc869ce-e8de-4c5e-8178-89ee04549259

📥 Commits

Reviewing files that changed from the base of the PR and between e2c7aa7 and 1a9daa0.

📒 Files selected for processing (2)
  • service/billing_usage.go
  • service/text_quota_test.go

Included review availability: Your plan includes up to 10 reviews per rolling hour; 9 remain after this review.


Walkthrough

OpenAI billing usage conversion now maps input token details into canonical prompt token details. It preserves existing canonical values, supports cache-hit fallback values, and keeps source billing data unchanged. Tests cover normalization and cached-input quota calculation.

Changes

OpenAI billing normalization

Layer / File(s) Summary
Normalize OpenAI token details
service/billing_usage.go
The billing conversion fills missing prompt token detail fields from Responses input token details. It uses PromptCacheHitTokens as a cached-token fallback.
Validate quota usage normalization
service/text_quota_test.go
Tests verify detail precedence, source immutability, cache fallback, and separate quota calculation for uncached input, cached input, and output tokens.

Estimated code review effort: 3 (Moderate) | ~20 minutes

Merge Risk: ⚪ Minimal · up to 1a9da

The change corrects cached-token settlement while preserving existing billing data, and the reported regression and service tests pass. No actionable merge-blocking risk remains beyond normal checks and review.

Suggested reviewers: calcium-ion

Poem

A rabbit checks the token trail,
Cache marks shine where counts once fail.
Source data stays neat and true,
Quota math now follows through.
Hop, hop—tests confirm the view!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Linked Issues check ✅ Passed The changes normalize Responses token details for settlement, preserve canonical values, support fallback fields, and test quota calculation without mutating snapshots.
Out of Scope Changes check ✅ Passed The changes are limited to billing normalization and focused regression tests required by the linked issue.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly describes the main change: fixing settlement for cached token usage in Responses conversions.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@LiaoQi98
LiaoQi98 marked this pull request as ready for review August 18, 2026 08:36
@seefs001
seefs001 merged commit f116414 into QuantumNous:main Aug 18, 2026
2 checks passed
jerzygao pushed a commit to jerzygao/new-api that referenced this pull request Aug 19, 2026
…onse fade, relaykit fixes

Brings in 5 upstream commits:
- fix: settle Responses cached token usage (QuantumNous#6892)
- feat(web): fade in streamed response words and harden playground editor (QuantumNous#6895)
- feat: channel test (QuantumNous#6917)
- refactor: advanced custom channel route editor (QuantumNous#6865)
- fix(relaykit): preserve parameterless tools in Claude conversion (QuantumNous#6862)

Conflicts resolved:
- controller/channel-billing.go: combined fork balance-alert logic with
  upstream's channelBalanceResult refactor — alert switch now nests inside
  the 'else if result.RawResponse == ""' guard using balance := result.Balance.
- setting/operation_setting/monitor_setting.go: additive — kept both the
  fork's BalanceAlertThreshold field/GetBalanceAlertThreshold and upstream's
  ChannelTestConcurrency field/Normalize/Validate functions.

Co-Authored-By: Claude <noreply@anthropic.com>
dreamlx added a commit to dreamlx/new-api that referenced this pull request Aug 19, 2026
Co-authored-by: Qi <108174052+LiaoQi98@users.noreply.github.com>
330079598 pushed a commit to 330079598/new-api that referenced this pull request Aug 19, 2026
0401lucky pushed a commit to 0401lucky/new-api that referenced this pull request Aug 24, 2026
junjundesk pushed a commit to junjundesk/new-api that referenced this pull request Aug 26, 2026
biubiubiu125 pushed a commit to biubiubiu125/newapi that referenced this pull request Aug 29, 2026
salem-2007 added a commit to salem-2007/new-api that referenced this pull request Sep 10, 2026
junjundesk pushed a commit to junjundesk/new-api that referenced this pull request Oct 3, 2026
piexian added a commit to piexian/new-api that referenced this pull request Oct 4, 2026
…s 77-80 (#16)

* fix: purge authentication data on hard user deletion (QuantumNous#6168)

* fix: purge authentication data on hard user deletion

* fix: fail closed when 2FA status lookup fails

* fix: reject stale Telegram login callbacks

* fix(twofa): prevent concurrent backup code and lockout bypasses

* fix(auth): harden user deletion and Telegram verification

(cherry picked from commit b6b97a6)

* fix: infer MiniMax vendor for MiniMax models (QuantumNous#6164)

* fix: infer MiniMax vendor for MiniMax models

* Delete model/pricing_default_test.go

---------

Co-authored-by: duanxufu <duanxufu@rededa.com>
(cherry picked from commit a63364d)

* fix(data-table): update table body immediately when toggling columns (QuantumNous#6253)

DataTableRow's React.memo did not depend on columnVisibility.
TanStack row references stay stable when visible columns change, so the
table body did not refresh after View -> Toggle columns until another
action rebuilt the column definitions.

Capture a visible column id signature (visibleColumnIds) outside the
memo and compare it, matching the existing isSelected snapshot pattern.
All tables that use DataTableRow pick up the fix.

(cherry picked from commit dc9aeab)

* fix: prevent duplicate tool calls in Responses-to-Chat streaming (QuantumNous#6225)

When a function call was already registered under its output_index key
via response.output_item.added, the synthetic events built from the
terminal response.completed output carry no output_index and resolve to
a different item-based key. ensureToolForEvent then created a second
tool index and resent the full arguments, so Chat Completions clients
received the same tool call twice.

Reuse the tool registered under itemIDToKey/callIDToKey before creating
a new one, and alias the new key to the existing tool.

Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
(cherry picked from commit 1086038)

* fix: drop realtime beta header for ga models and register new ones (QuantumNous#6032)

(cherry picked from commit 16bfae1)

* fix: prevent duplicate suno task refunds via cas status update (QuantumNous#6074)

* fix: prevent duplicate suno task refunds via cas status update

* fix: reconcile failed task refunds

---------

Co-authored-by: CaIon <i@caion.me>
(cherry picked from commit e0d5156)

* fix: log response body when parsed upstream error message is empty

When an upstream error response parses as valid JSON but yields no usable
error message (e.g. an aggregator gateway returning {"error":{"message":""}}),
RelayErrorHandler previously produced a bare "bad response status code N"
error with no trace of the original body, making the failure undiagnosable.
Log the body preview in that case, mirroring the existing behavior for
unparseable bodies.

(cherry picked from commit 84a79b6)

* feat: add gemini-3-pro-image and gemini-3.1-flash-image GA models (QuantumNous#6371)

(cherry picked from commit 8b41def)

* fix: 慢查询/错误 SQL 日志参数化 (QuantumNous#6493)

* fix: parameterize slow/error SQL logs to avoid leaking credentials

* fix: validate SQL_SLOW_THRESHOLD_MS range

* fix: sanitize database driver error messages in SQL logs

* refactor: sanitize at gorm log writer seam to keep caller attribution

(cherry picked from commit c3db414)

* feat: support zstd request decompression (QuantumNous#6545)

(cherry picked from commit 0f9f668)

* fix(aws): cancel Bedrock requests on client disconnect (QuantumNous#6589)

* fix(aws): cancel Bedrock requests on client disconnect

* fix(billing): log effective usage billing path

(cherry picked from commit bd585d7)

* feat(rate-limit): add user critical rate limit middleware for access token and aff transfer routes

(cherry picked from commit 1da23d6)

* fix(ali): stop injecting top_p into requests that omit it (QuantumNous#6674)

(cherry picked from commit 2399de9)

* fix(ollama): preserve reasoning and tool-call context (QuantumNous#6605)

(cherry picked from commit 8ad159a)

* fix: backend length validation (QuantumNous#5548)

(cherry picked from commit d49160f)

* fix: 修复 Gemini 风格 /v1/models 列表请求 (QuantumNous#6199)

* fix: support Gemini model listing on v1 route

* test: cover Gemini query key model listing

(cherry picked from commit 3d5dc36)

* fix(topup): settle recharge orders atomically

(cherry picked from commit 50e5377)

* fix(billing): 异步任务退款时同步减少 used_quota (QuantumNous#6795)

* fix(billing): 异步任务退款时同步减少 used_quota
退款时仅恢复了 quota(剩余额度),但未同步减少 used_quota(已用额度),
导致"总额度"(quota + used_quota)随退款次数持续虚增,超出用户实际充值金额。

修复三处退款路径:
- RefundTaskQuota:任务失败完整退款
- RecalculateTaskQuota:差额结算退款分支
- controller/midjourney.go:Midjourney 任务失败退款

新增 model.UpdateUserUsedQuota 公开函数,仅调整 used_quota 不影响 request_count。

* fix(billing): 任务退款时同步扣减渠道 used_quota

* fix(billing): complete async task refund accounting

* style(model): group internal Midjourney fields

---------

Co-authored-by: CaIon <i@caion.me>
(cherry picked from commit 58d4e9b)

* fix(ali): 修复阿里图片模型映射后仍使用原始模型名判断协议的问题 (QuantumNous#6772)

* feat(ali): support Qwen Image 3 requests

* refactor(ali): narrow Qwen Image 3 support

* fix(ali): focus image model mapping fix

(cherry picked from commit 93d2df8)

* fix(topup): reject uncreditable orders before payment (QuantumNous#6845)

* fix(topup): reject uncreditable orders before payment

* fix(topup): align zero-ratio Stripe validation

* fix(topup): mirror settlement conversions in validation

(cherry picked from commit 2a0ce34)

* fix: settle Responses cached token usage (QuantumNous#6892)

(cherry picked from commit f116414)

* fix(billing): 修复时间规则恒真表达式导致倍率全天生效 (QuantumNous#6934)

(cherry picked from commit ac381ac)

* fix(relay): 请求参数校验错误返回 HTTP 400 (QuantumNous#6774)

* fix(relay): return 400 for invalid request parameters

(cherry picked from commit 0f2a207)

* fix(ali): honor image response format (QuantumNous#5513) (QuantumNous#7048)

(cherry picked from commit 0bee5d4)

* fix(sqlite): enable WAL + working busy timeout + _txlock=immediate to stop concurrent write lockouts (QuantumNous#7030)

* fix(sqlite): enable WAL + working busy timeout + _txlock=immediate to stop concurrent write lockouts

(cherry picked from commit 1751f43)

* fix(relay): bound the wait for upstream response headers (fixes unbounded heap growth → OOM) (QuantumNous#6949)

* fix(relay): bound the wait for upstream response headers (fixes unbounded heap growth)

The relay transport sets a dial timeout, a TLS handshake timeout and an expect-continue
timeout, but nothing bounds how long it waits for the upstream *response headers* after
the request has been written. An upstream that accepts the connection and then never
answers -- without sending FIN/RST, which is what happens when a NAT/firewall silently
drops the flow or the provider hangs -- parks the goroutine in
net/http.(*persistConn).roundTrip forever.

That goroutine keeps the whole request alive, which in practice means three copies of the
request body stay reachable for the lifetime of the process: the raw bytes from
io.ReadAll in CreateBodyStorageFromReader, the decoded messages held as json.RawMessage,
and the re-marshalled upstream body from common.Marshal. BodyStorageCleanup cannot help
here: it runs after c.Next() returns, and for these requests c.Next() never returns.

Measured on v1.0.0-rc.23 in production (see QuantumNous#6947 for the full evidence):

  - 23 goroutines stuck in persistConn.roundTrip on a single 40h-old instance,
    blocked between 353 and 1894 minutes (5.9h to 31.5h)
  - 96.9% of the live heap, sampled after a forced GC, attributable to those three
    body copies (HeapAlloc 892 MiB surviving three GC cycles; HeapObjects dropping
    30x while bytes dropped only 25%)
  - the live floor grows with uptime: 33.7 MiB at 0.1h, 89.2 at 13.8h, 510.0 at 40.1h,
    955.2 at 146.8h, OOMKilled at 172.9h -- same image, same config, same load

Doubling the memory limit and adding GOMEMLIMIT only moved the OOM from 132h to 172.9h.

RELAY_TIMEOUT (http.Client.Timeout) cannot be used for this: it covers the whole response
read and would cut legitimate long streaming calls, which is why it defaults to 0.
ResponseHeaderTimeout only bounds the wait for the headers; streaming after they arrive is
unaffected.

The default is deliberately generous. Non-streaming upstreams usually send the response
headers only once generation has finished, so the value has to leave room for a long
completion. 1800s is 12x shorter than the shortest hang observed here while leaving
several times the headroom a normal non-streaming request needs; 0 restores the previous
unbounded behaviour.

The assignment goes next to the other transport.* lines rather than inside the else
branch: newRelayHTTPTransport() normally takes the http.DefaultTransport.Clone() path,
and DefaultTransport does not set ResponseHeaderTimeout either.

This repo already sets ResponseHeaderTimeout on its other outbound transports
(controller/model_sync.go, controller/ratio_sync.go); the relay path appears to have
been missed.

Refs QuantumNous#6947. Likely also the root cause of QuantumNous#6731, which reported the same symptom
(production OOM on /v1/responses after ~64h) but was closed for template reasons.

* review: clamp overflowing timeout values and switch the test to testify

Addresses the two CodeRabbit findings on this PR.

Overflow (common/init.go:113): a RELAY_RESPONSE_HEADER_TIMEOUT beyond ~9.2e9 seconds
overflows time.Duration and can wrap into a *tiny positive* timeout, which would cut
every relay request instead of only the stuck ones. The value is now clamped before the
conversion, with regression tests for both the negative and the overflowing input.

I did not add fail-on-startup validation for negative values, for two reasons: the
existing `if seconds > 0` guard already treats them as "disabled", and the neighbouring
env-driven timeouts in this file are less strict still -- RelayIdleConnTimeout is
converted with no guard at all. Failing startup on a bad value would be a behaviour
change out of step with the rest of the file; happy to add it if you'd prefer that
direction repo-wide.

Test style: switched to testify (require.Equal / require.Zero / require.Positive), which
is what every other test under service/ uses.

go build, go vet and go test ./common/... ./service/... pass.
(`go build ./...` fails on the `web/dist` embed both with and without this change -- the
frontend bundle is not checked in.)

(cherry picked from commit b518d00)

* fix: adapt relaykit hosttypes to types and add missing errors import

* fix(log): preserve quota in usage statistics (QuantumNous#7108)

* fix(log): preserve quota in usage statistics

(cherry picked from commit 8c8c415)

* fix(model): do not treat no-op system task state writes as lock loss (QuantumNous#7135)

(cherry picked from commit b7017c2)

* perf(common): 批量复制 RawMessage,优化请求深拷贝 (QuantumNous#7221)

* perf(relay): bulk-copy Responses raw JSON fields

* perf(common): share RawMessage deep-copy optimization

---------

Co-authored-by: CaIon <i@caion.me>
(cherry picked from commit 2cf177a)

* fix(audio): normalize file extension case in GetAudioDuration (QuantumNous#7321)

Uppercase or mixed-case extensions (e.g. .MP3, .WAV) fell through to the
default branch and returned "unsupported audio format", so audio token
usage could not be measured. Lowercase the extension before the switch.

Closes QuantumNous#7319

(cherry picked from commit 76f7daf)

* fix(ollama): preserve tool calls from final stream frame | 保留流式末尾帧的 tool calls (QuantumNous#7376)

(cherry picked from commit 8e5e091)

* fix(gemini): reject :countTokens as an unknown route instead of relaying it as generateContent (QuantumNous#7388)

(cherry picked from commit 81336fc)

* fix(relay): request stream usage on every cross-protocol conversion to OpenAI chat (QuantumNous#7389)

(cherry picked from commit 610334d)

* fix(billing): count upstream images by payload instead of data length

OpenaiImageHandler and the JSON-to-SSE fallback billed the gjson data.#
element count. An object-shaped data yielded 0 and kept the requested n
while the SSE fallback dropped the image and sent only [DONE]; one image
split into a url entry and a b64_json entry billed twice; entries carrying
only revised_prompt billed as images.

Count images by payload: an object with url or b64_json is one image and
arrays bill max(url entries, b64_json entries). The SSE fallback forwards
one completed event per image payload for both shapes. xAI inherits the
fix through OpenaiImageHandler.

(cherry picked from commit 07578fa)

* fix(relay): map Images output_tokens_details into img_o billing (QuantumNous#7410)

(cherry picked from commit e2bb05f)

* fix(task): accept any 2xx upstream status on task submission (QuantumNous#7478)

(cherry picked from commit d61d6be)

* fix(auth): reject non-standard roles when creating a user (QuantumNous#7531)

(cherry picked from commit 2506e1b)

* fix: isolate TLS configs across HTTP transports (QuantumNous#7627)

(cherry picked from commit feefe09)

* fix(model): migrate database constraints, options primary key, and avoid redundant migrations

* feat(channel): add Sub2API, NewAPI, vLLM, and SGLang channels (77-80) and Tencent TokenHub

---------

Co-authored-by: Seefs <40468931+seefs001@users.noreply.github.com>
Co-authored-by: fuxdev <15846422264@163.com>
Co-authored-by: duanxufu <duanxufu@rededa.com>
Co-authored-by: DawnMoon1542 <160485532+DawnMoon1542@users.noreply.github.com>
Co-authored-by: Niku <nikuliu@foxmail.com>
Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
Co-authored-by: feitianbubu <feitianbubu@qq.com>
Co-authored-by: CaIon <i@caion.me>
Co-authored-by: bigsong <35025755+bigsongeth@users.noreply.github.com>
Co-authored-by: ENCHIGO <38551565+ENCHIGO@users.noreply.github.com>
Co-authored-by: zhibisora <73344387+zhibisora@users.noreply.github.com>
Co-authored-by: wans10 <51012039+wans10@users.noreply.github.com>
Co-authored-by: Scott <908181134@qq.com>
Co-authored-by: Shawn Wang <32839114+enwaiax@users.noreply.github.com>
Co-authored-by: Qi <108174052+LiaoQi98@users.noreply.github.com>
Co-authored-by: zcxads666 <128150298+zcxads666@users.noreply.github.com>
Co-authored-by: Alex Xiang <ax2@zicode.com>
Co-authored-by: PuppetKL <154485567+PuppetKL@users.noreply.github.com>
Co-authored-by: Xayinn <129403670+LinineTy@users.noreply.github.com>
Co-authored-by: txgo <tianxi.liu@gmail.com>
Co-authored-by: jimmyleocn <42566991+jimmyleocn@users.noreply.github.com>
Co-authored-by: mingisrookie <99650899+mingisrookie@users.noreply.github.com>
Co-authored-by: Vladimir Babin <vovababin@gmail.com>
Co-authored-by: sxhstc <406739419@qq.com>
timwenx pushed a commit to timwenx/new-api that referenced this pull request Nov 18, 2026
Yuchengw added a commit to FelixSphere/unifyapi-console that referenced this pull request Nov 18, 2026
…es API (#296)

* fix: settle Responses cached token usage (QuantumNous#6892)

(cherry picked from commit f116414)

* test(billing): pin cache billing for chat calls served over the Responses API

The cherry-picked upstream fix (QuantumNous#6892) makes settlement read the cache counts
a Responses upstream reports under input_tokens_details. This test drives the
real producer (relayconvert.UsageFromResponsesUsage) into the gpt-6.2-sol
expression production carries and checks hand-typed quotas for the standard
tier, the 272K long-context tier and a cache-free call.

Why: the conversion is what lets gpt-6.2 take tools on /v1/chat/completions,
and it was left off for those models because it billed cached and cache-write
tokens at the full input price (117 converted gpt-6-astra calls in production
logged 0 cached tokens). The test fails on the pre-fix source with
"expected 6000, actual 0".

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>

---------

Co-authored-by: Qi <108174052+LiaoQi98@users.noreply.github.com>
Co-authored-by: Claude Fable 5.2 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Bug] Chat Completions → OpenAI Responses 转换中 cached_tokens 未参与结算

2 participants