docs(pro): Responses compression coverage and revision-body toggle - #606
Conversation
Token compression now covers POST /v1/responses (GoModel-pro#7): document the endpoint, the structural exemptions there (replayed reasoning items and annotated text parts), and the new LOGGING_LOG_REVISION_BODIES flag (GoModel#603) that trades the stored rewritten-body copy for roughly half the audit growth. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
📝 WalkthroughWalkthroughUpdated ChangesPro token-compression documentation
Estimated code review effort: 1 (Trivial) | ~3 minutes Possibly related PRs
Suggested reviewers: Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/pro.mdx`:
- Around line 131-134: Update the audit-storage documentation near
LOGGING_LOG_REVISION_BODIES to explain its dependency on LOGGING_LOG_BODIES:
when master body logging is disabled, both original request and rewritten
revision bodies are omitted, while revision metadata remains available. Qualify
the statement that audit entries retain the original client request so it is not
presented as unconditional.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: 5c50b865-5052-4d5e-af51-b645793c20a0
📒 Files selected for processing (1)
docs/pro.mdx
| always recoverable. Storing the rewritten body copy is governed by | ||
| `LOGGING_LOG_REVISION_BODIES` (default `true`): turning it off keeps the | ||
| revision metadata — rewriter, sizes, tokens saved, the block report — while | ||
| roughly halving audit storage per compressed request. |
There was a problem hiding this comment.
🔒 Security & Privacy | 🟠 Major | ⚡ Quick win
Document the dependency on LOGGING_LOG_BODIES.
LOGGING_LOG_REVISION_BODIES only controls rewritten-body copies when master body logging is enabled. With LOGGING_LOG_BODIES=false, the original request and revision bodies are omitted; as written, “Audit entries keep the original client request” is unconditional and can mislead operators about PII retention. Clarify both settings’ interaction here.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/pro.mdx` around lines 131 - 134, Update the audit-storage documentation
near LOGGING_LOG_REVISION_BODIES to explain its dependency on
LOGGING_LOG_BODIES: when master body logging is disabled, both original request
and rewritten revision bodies are omitted, while revision metadata remains
available. Qualify the statement that audit entries retain the original client
request so it is not presented as unconditional.
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Confidence Score: 5/5The documentation-only change appears safe to merge after the dependent implementation changes identified in the PR description. The documented revision-body setting matches its configured default and persistence behavior, while the gateway exposes the Responses endpoint to registered request rewriters; no concrete documentation defect was identified.
 T-Rex LogsWhat T-Rex did
Reviews (1): Last reviewed commit: "docs(pro): Responses compression coverag..." | Re-trigger Greptile |
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Updates the Pro page for two in-flight changes:
POST /v1/responses(lands with GoModel-pro#7), with the Responses-specific exemptions in "What it never touches": replayed reasoning items (PRO_COMPRESSION_DROP_REASONINGis a no-op there — the API requires them back verbatim whenstoreis off) and citation-annotated text parts, whose offsets a rewrite would break.LOGGING_LOG_REVISION_BODIES(lands with perf(admin): slim audit payloads and gzip admin responses #603): defaulttrue; off keeps revision metadata but skips the stored rewritten-body copy, roughly halving audit storage per compressed request.Merge after GoModel-pro#7 and #603 so the docs don't run ahead of the binaries.
🤖 Generated with Claude Code
Summary by CodeRabbit