Skip to content

docs(ce5b4532-32a2-4f88-b16b-eed14c4e219b): document OCR/document-parsing blocks under PII masking - #851

Open
claude[bot] wants to merge 1 commit into
mainfrom
docs/pii-masking-ocr-blocks
Open

claude[bot] wants to merge 1 commit into
mainfrom
docs/pii-masking-ocr-blocks

Conversation

@claude

@claude claude Bot commented Nov 3, 2026

Copy link
Copy Markdown

Summary

  • Adds a new "Operations blocked under PII masking" section to the Visual Data Masking page, documenting the five operations that are blocked when an organization has PII masking enabled (knowledge file uploads with OCR, Mistral OCR tool step, Reducto document parsing, advanced retrieval with vision, Patch agent extract-document-content).
  • Documents the 403 error code (ocr_blocked_by_pii_masking) and message returned when a blocked operation is attempted.
  • Documents the knowledge-sync fallback: auto-OCR syncs fall back to plain text extraction rather than failing completely.
  • Fixes the "How it works" summary sentence (line 30) to accurately state that certain operations are restricted, replacing the incorrect claim of "full agent functionality."

Linear: https://linear.app/relevance/issue/ce5b4532-32a2-4f88-b16b-eed14c4e219b/

Test plan

  • Verify new section renders correctly in Mintlify preview
  • Check CardGroup icons are valid in Mintlify's icon subset
  • Confirm all headings use sentence case
  • Verify no broken internal links

…sing blocks under PII masking

Adds a new "Operations blocked under PII masking" section to the Visual
Data Masking page describing the five operations blocked when PII masking
is enabled, the error code returned (ocr_blocked_by_pii_masking), the
knowledge-sync fallback to plain text, and which organizations are affected.

Also fixes the "How it works" summary sentence to accurately reflect that
certain operations are restricted rather than stating full agent
functionality is maintained.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@claude claude Bot added the docs-drafter Documentation drafted by Claude label Nov 3, 2026
@mintlify

mintlify Bot commented Nov 3, 2026 •

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
relevanceai 🟢 Ready View Preview Nov 3, 2026, 2:26 AM

💡 Tip: Enable Automations to automatically generate PRs for you.

@vercel

vercel Bot commented Nov 3, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
relevance-docs Ready Ready Preview Nov 3, 2026 2:27am UTC

Request Review

@github-actions

github-actions Bot commented Nov 3, 2026

Copy link
Copy Markdown
Contributor

🎯 Vibe check

Reviewed: 1 file (1 with issues, 0 clean)

Scores

Dimension Score What's holding it back
🟡 Consistency 7/10 "workforce" vs "Workforce" inconsistency within the same page — some occurrences correctly capitalize the product term, others don't. Same pattern for "agents" vs "Agents" in card titles.
🟢 Technical clarity 9/10 Excellent. Specific error codes, exact UI labels, edge cases, and a gotcha about workforce cascading behavior. One minor gap: no mention of whether toggling masking off mid-task takes effect immediately or requires a new task.
🟢 Non-technical clarity 8/10 Good intro and visual diagram. Two stacked <Warning> callouts before the body create friction — the AI-detection caveat is a beta limitation, not a danger requiring top-of-page treatment.
🟡 Structure 7/10 <CardGroup> used for non-navigable technical reference lists (blocked operations, masked/not-masked items). "What is and isn't masked" section sits after the enable steps, but readers need this context before deciding to enable.

Score key: 🟢 9–10, 🟡 6–8, 🔴 1–5.

✨ Overall vibe: Thorough, technically honest page with good coverage of edge cases, error codes, and the VDM-vs-PII-Redaction comparison table — all of which will save support tickets. The main structural drag is <CardGroup> applied to reference material that isn't navigable, and a handful of inconsistent product-term capitalizations that will trip up readers who notice "Workforce" handled differently across the same page.

🔧 Issues (6)
  • visual-data-masking.mdx:146 — ### For workforces → ### For Workforces. "Workforce" is a Relevance AI product term that must be capitalized when referring to the feature. The same page correctly capitalizes it on lines 184 and 377.

  • visual-data-masking.mdx:155 — <Step title="Open workforce settings"> → "Open Workforce settings". Same product-term rule.

  • visual-data-masking.mdx:149,152,169 — Body text "a workforce", "on a workforce", "for this workforce" should be "a Workforce" etc. Three instances in the "For workforces" section that are inconsistent with the rest of the page.

  • visual-data-masking.mdx:25 — <Card title="What agents see" icon="robot"> — "agents" lowercase, but line 179 on the same page uses <Card title="Agent conversation histories"> with "Agent" capitalized. When referring to the Relevance AI product, capitalize: "What Agents see".

  • visual-data-masking.mdx:11–13 — The second <Warning> (AI detection can miss PII) duplicates content already in the Beta Limitations section (lines 336–338) and in the FAQ (line 390). Having two warnings stacked before the intro body is heavy. Move or remove this warning — the beta limitations accordion and the FAQ cover it, and the first warning already tells readers to contact support.

  • visual-data-masking.mdx:120 — ### For agents → ### For Agents for consistency with the capitalization rule and with the "For Workforces" fix above.

🧩 Component suggestions (3)
  • visual-data-masking.mdx:38–54 — <CardGroup> for "Blocked operations" contains 5 cards with no href. CLAUDE.md says CardGroup is not appropriate for technical reference lists. These items aren't navigable choices — they're five operations with a reason each. A markdown table (| Operation | Why it's blocked |) would let readers scan and compare faster, and matches the table style already used elsewhere on the page (supported PII types, VDM vs PII Redaction).

  • visual-data-masking.mdx:178–194 — <CardGroup> for "What is masked" has 5 non-navigable cards. A simple bulleted list is cleaner for this reference content. The icons add visual weight without adding information — the titles alone carry the meaning.

  • visual-data-masking.mdx:200–225 — <CardGroup> for "What isn't masked" has 8 non-navigable cards, two of which contain multi-sentence descriptions with nuanced exceptions (the CSV export caveat, the OTEL structured-fields caveat). Those two cards are too content-dense for a card format. Consider a bulleted list for the straightforward items, with those two exceptions called out as <Note> or inline parentheticals. Alternatively, collapse this into a single table alongside the "What is masked" content: a two-column layout (| Scope | Masked? |) with a notes column for the exceptions.

🏗️ Page structure (1)
  • visual-data-masking.mdx — "What is and isn't masked" (line 172) appears after "Enabling Visual Data Masking" (line 118). A reader stepping through the page hits the enable steps before learning what actually gets masked — including the critical gotcha that API responses, LLM requests, and exported data are all unmasked. This section should move before the enable steps so readers know the scope of what they're enabling. Suggested order: How it works → Operations blocked → Supported PII types → What is and isn't masked → Configuration options → Enabling → Best practices → Beta limitations → FAQ.
✅ Clean files (0)

No files were entirely clean; see issues above.

🔋 Credit usage
Item Count
Files reviewed 1
Context pages read 2
Total lines processed ~780

Files read: visual-data-masking.mdx (429 lines), general.mdx (248 lines), streaming-events.mdx (~100 lines scanned for PII Redaction section)

This branch was successfully deployed

2 active deployments
Preview — 949b34bb Deployed Nov 3, 2026 by vercel[bot]
staging — 949b34bb Deployed Nov 3, 2026 by mintlify[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs-drafter Documentation drafted by Claude

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant