docs(config): document the recall-gate Runtime keys - #1689
Merged
Merged
Conversation
`RuntimeConfig.recall_gate_*` drives the optional recall-sufficiency gate added in v1.1.0, but the configuration reference listed none of the nine keys, so readers had no documented way to enable or tune the gate. Add the keys to the Runtime table in both locales with their defaults and bounds, and describe the gate's behaviour, its latency cost, and the ordering rule that the round-one and round-two similarity floors must keep.
Teingi
reviewed
Sep 21, 2026
Contributor
Author
|
@Teingi I have completed all works which related to your comment. Please review again. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Which issue or RFC does this PR close?
Closes #1688.
Rationale for this change
RuntimeConfig.recall_gate_*drives the optional recall-sufficiency gate shipped in v1.1.0, butdocs/{en,zh}/docs/operate/configuration.mdlisted none of those keys. The upgrade notes tell operators to enable the gate when needed, so the canonical reference left readers with no documented way to set or tune it: the keys were reachable only by reading the source.What changes are included in this PR?
POWERCONTEXT_SERVER_RUNTIME_RECALL_GATE_*keys to the Runtime table in both locales, with the defaults and bounds fromsrc/powercontext/builtin/runtime/config.py.POWERCONTEXT_SERVER_prefix plus nested_delimiter convention.Two notes on the issue text:
recall_gate_allow_with_rerankis not a threshold and was easy to miss, but it does gate expansion, so it is documented here too.powercontext config inittemplate insrc/powercontext/cli/config.py. That file emits a curated sample of settings rather than every Runtime key, and adding to it changes generated output, which belongs in a separate change rather than this documentation fix.Are there any user-facing changes?
Documentation only. No behaviour, API, or persisted-format change.
How was this change tested?
Verified the derived variable works against a real settings object in the repository virtual environment:
Re-read every default and bound from
src/powercontext/builtin/runtime/config.pyand the ordering validator next to it.Confirmed the assessment logic the new paragraph describes against
RecallSufficiencyGate.assessandRecallSufficiencyPolicy.from_runtime_config.Cross-checked the two locale tables row by row.
AI usage statement
Built with an AI assistant (WorkBuddy), which read the runtime configuration source, drafted both locale tables, and ran the environment-variable check above. Every documented default, bound, and route was verified against the source before writing.