Skip to content

docs(guardrails): say that BYO middleware reads no files - #1191

Closed
apetraru-uipath wants to merge 1 commit into
mainfrom
docs/guardrails-byo-files
Closed

apetraru-uipath wants to merge 1 commit into
mainfrom
docs/guardrails-byo-files

Conversation

@apetraru-uipath

@apetraru-uipath apetraru-uipath commented Nov 4, 2026 •

Copy link
Copy Markdown
Contributor

What changed?

Docs only, docs/guardrails.md: the Files (attachments) section said a BYO connector reads the files when it declares document support. The Agents backend evaluates BYO guardrails on the text only and never passes them the files, so the sentence now says UiPathByoGuardrailMiddleware accepts detection_scope but BYO guardrails evaluate text only.

These pages are published through uipath-python, whose Publish Docs has failed since 2026-10-26 on a Git LFS clone of this repo. UiPath/uipath-python#1975 fixes that and makes the same BYO correction in the core docs. Merging this one dispatches a republish, which succeeds only once #1975 is in.

How has this been tested?

Built the full uipath.github.io site locally the way Publish Docs does (plugin clones, symlinks, uv run mkdocs build) with this page: it builds, and the rendered langchain/guardrails page shows the new BYO sentence.

Are there any breaking changes?

  • None

No version bump: docs only (precedent #1068).

🤖 Generated with Claude Code

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

No active review issues are recorded for this documentation-only guardrail clarification and middleware reference update.

No open issues 🎉

What changed in this PR

This documentation-only PR clarifies BYO guardrail behavior and completes the LangChain guardrail middleware reference. It makes no runtime or API changes.

Changes:

  • Clarifies that BYO guardrails evaluate text only, even though UiPathByoGuardrailMiddleware accepts detection_scope.
  • Adds UiPathPromptInjectionMiddleware to the middleware table and parameter list, documenting its LLM-only, PRE-only scope and threshold range and default.
File Description
docs/​guardrails.md Corrects BYO file-handling documentation and adds the prompt-injection middleware reference.

Review effort: Balanced

@apetraru-uipath
apetraru-uipath force-pushed the docs/guardrails-byo-files branch from 4d55a3d to fc355ff Compare November 4, 2026 15:12
@apetraru-uipath apetraru-uipath changed the title docs(guardrails): BYO middleware reads no files; list the prompt injection middleware docs(guardrails): say that BYO middleware reads no files and list prompt injection Nov 4, 2026
The Files (attachments) section said a BYO connector reads the files
when it declares document support. The Agents backend evaluates BYO
guardrails on the text only and never passes them the files.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@apetraru-uipath
apetraru-uipath force-pushed the docs/guardrails-byo-files branch from fc355ff to e924043 Compare November 4, 2026 20:15
@apetraru-uipath apetraru-uipath changed the title docs(guardrails): say that BYO middleware reads no files and list prompt injection docs(guardrails): say that BYO middleware reads no files Nov 4, 2026
@sonarqubecloud

sonarqubecloud Bot commented Nov 4, 2026

Copy link
Copy Markdown

@apetraru-uipath

Copy link
Copy Markdown
Contributor Author

Superseded by #1195.

@apetraru-uipath
apetraru-uipath deleted the docs/guardrails-byo-files branch November 4, 2026 21:07
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.

2 participants