docs: clarify redact() covers secrets only, PII is detection-only - #3706
Open
abhinav (erensh27) wants to merge 1 commit into
Open
docs: clarify redact() covers secrets only, PII is detection-only#3706abhinav (erensh27) wants to merge 1 commit into
abhinav (erensh27) wants to merge 1 commit into
Conversation
The class docstring implied redact() scrubs sensitive material broadly, but redaction iterates PATTERNS (secrets) only, while PII/CRI patterns (email, phone, SSN, credit card, IP) are detection-only via find_pii_matches / contains_pii. Documented the exact scope on the class, redact(), and redact_data_structure(). Fixes microsoft#3239
abhinav (erensh27)
requested review from
MohammadHaroonAbuomar and
liamcrumm
as code owners
August 11, 2026 10:22
|
Azure Pipelines: There may be pipelines that require an authorized user to comment /azp run to run. |
|
Welcome to the Agent Governance Toolkit! Thanks for your first pull request. |
PR Review Summary
Verdict: AI review comments are untrusted advisory output. The summary reports workflow-generated completion status only, not model-authored pass/fail claims. |
|
🟡 Contributor Check: MEDIUM
Automated check by AGT Contributor Check. |
github-actions
Bot
added
the
needs-review:MEDIUM
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
1 participant
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.
Fixes #3239
redact()/redact_data_structure()iterate onlyPATTERNS(secret-like material); PII/CRI is detected byfind_pii_matches()/contains_pii()but never removed byredact(). Clarified this scope in the class docstring,redact(), andredact_data_structure()so callers do not assume PII is scrubbed when persisting or returning data. (The SSN pattern divergence noted in the issue was already reconciled in a prior change.)