feat: allow guardrail evaluation to carry attachment references by apetraru-uipath · Pull Request #1895 · UiPath/uipath-python

apetraru-uipath · 2026-09-12T22:44:32Z

What

Adds an optional attachments keyword to GuardrailsService.evaluate_guardrail and a GuardrailAttachment model (id, fileName, mimeType) so a caller can tell the guardrails backend which Orchestrator attachments a guardrail should inspect. When attachments are present the call also carries the run's folder key in x-uipath-folderkey (from the SDK config) so the backend can resolve them folder-scoped, and uses a 60 s timeout because the backend fetches and decodes each file inside the request.

Backward compatible: without attachments the request body is byte-identical to today. Bumps uipath-platform to 0.2.31 and uipath to 2.14.22 (its SDK_REFERENCE.md records the new parameter and its platform floor moves to 0.2.31).

v2 — references instead of urls (commit `db3cd201`)

The first version carried a resolved SAS url per attachment and redacted it from the @traced span. The backend now resolves attachment ids itself through Orchestrator (see UiPath/Agents#6256), so the url field and the redaction processor are gone and the model is just id / fileName / mimeType. New: the folder-key header. 36 tests pass; ruff, ruff format and mypy clean.

Review fixes

e831652c — SAS urls no longer reach the trace span. @traced records a function's arguments on the OpenTelemetry span by default, so every GuardrailAttachment.url (a short-lived SAS credential) was landing in input.value. An input_processor now redacts attachments[*].url and leaves the rest of the span intact — tighter than hide_input=True. Thanks Copilot.
49b50329 — lockfiles relocked after the version bump (uv lock --check in CI).
Added the two tests Copilot noted were missing: an attachment-bearing evaluation forwards the 60 s timeout; the default path does not.

Notes for reviewers

Backward compatible. Without attachments, or with an empty list, the request body is byte-identical to today.
Timeout. A validate call carrying attachments waits for the backend to fetch and decode each file. The default client timeout is 30 s and RequestSpec.timeout was constructed but never forwarded, so this passes 60 s explicitly when attachments are present.

Test plan

packages/uipath-platform — 35 tests pass (+8 over baseline). ruff check, ruff format --check, mypy src tests clean.

Pairs with UiPath/Agents#6256.

🤖 Generated with Claude Code

Copilot

🟡 Changes recommended

One or more issues must be addressed before approval.

Get a fresh assessment by requesting another Copilot review.

Pull request overview

Extends uipath-platform guardrail evaluation to send file attachment references to the backend.

Changes:

Adds and exports GuardrailAttachment.
Serializes attachments and applies an extended timeout.
Adds tests and bumps the package version.

File summaries

File	Description
packages/uipath-platform/tests/services/test_guardrails_service.py	Updated as part of this pull request.
packages/uipath-platform/src/uipath/platform/guardrails/guardrails.py	Updated as part of this pull request.
packages/uipath-platform/src/uipath/platform/guardrails/_guardrails_service.py	Updated as part of this pull request.
packages/uipath-platform/src/uipath/platform/guardrails/init.py	Updated as part of this pull request.
packages/uipath-platform/pyproject.toml	Updated as part of this pull request.

Review details

Files reviewed: 5/5 changed files
Comments generated: 3
Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@Traced

@Traced records a function's arguments on the OpenTelemetry span by default, so every GuardrailAttachment.url — a short-lived SAS credential — was landing in input.value. Flagged by Copilot on #1895. An input_processor now replaces attachments[*].url with "<redacted>" and leaves everything else (payload, guardrail, attachment identity) intact; that is tighter than hide_input=True, which would drop the useful part of the span too. Also adds the two tests Copilot noted were missing: that an attachment-bearing evaluation forwards the 60s timeout, and that the default path does not. uipath-platform: 35 tests pass (+4); ruff, ruff format, mypy clean. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>

@Traced

@Traced records a function's arguments on the OpenTelemetry span by default, so every GuardrailAttachment.url — a short-lived SAS credential — was landing in input.value. Flagged by Copilot on #1895. An input_processor now replaces attachments[*].url with "<redacted>" and leaves everything else (payload, guardrail, attachment identity) intact; that is tighter than hide_input=True, which would drop the useful part of the span too. Also adds the two tests Copilot noted were missing: that an attachment-bearing evaluation forwards the 60s timeout, and that the default path does not. uipath-platform: 35 tests pass (+4); ruff, ruff format, mypy clean. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>

github-actions · 2026-09-17T05:28:15Z

🚨 Heads up: `uipath-langchain` cross-tests are FAILING 🚨

Your changes may break the uipath-langchain-python integration.

⚠️ These checks are NOT enforced by branch protection rules. Please review the failures before merging.

🔍 Inspect the failed run →

@Traced

Adds an optional `attachments` keyword to GuardrailsService.evaluate_guardrail and a GuardrailAttachment model (id, fileName, mimeType, url), so a caller can tell the guardrails backend which files a guardrail should inspect instead of the backend seeing only attachment metadata embedded in the payload string. Also forwards a 60s timeout when attachments are present. The default client timeout is 30s and RequestSpec.timeout was constructed but never passed, so a validate call that waits on server-side file fetching would have timed out. An attachment url is a short-lived SAS credential, and @Traced records a function's arguments on the span by default, so an input_processor redacts attachments[*].url and leaves the rest of the span intact. Backward compatible: without `attachments` — or with an empty list — the request body is byte-identical to today, so an older backend is unaffected. The parameter is keyword-only and defaults to None, so existing callers are untouched. Bumps uipath-platform to 0.2.31. SDK_REFERENCE.md records the new parameter, which makes uipath a co-changed package, so it bumps to 2.14.21 and raises its floor to uipath-platform>=0.2.31. uipath-platform: 35 tests pass (+8); ruff, ruff format and mypy clean. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>

@Traced

Guardrail attachments are now referenced by their Orchestrator attachment id alone: GuardrailAttachment drops the `url` field the runtime used to resolve to a signed URL before sending it to the guardrails backend. Two problems with that: Orchestrator's signed URL shape is environment-dependent (a platform-proxied alpha.uipath.com URL on alpha, not *.blob.core.windows.net), so a host allow-list downstream silently dropped every attachment; and a caller-supplied URL meant the backend never verified the caller was entitled to the file it fetched. The backend now resolves each id through its own Orchestrator client, so Orchestrator's own access control applies. evaluate_guardrail sends the optional x-uipath-folderkey header (already defined as HEADER_FOLDER_KEY) alongside attachments when the SDK is configured with a folder key, so the backend can resolve folder-scoped attachments. The now-pointless URL-redaction input_processor on @Traced is removed along with the field it protected. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>

main released 2.14.21 while this branch was carrying the same number, so check-version-availability rejected the PR. The package still has to move because SDK_REFERENCE.md changed and its uipath-platform floor is now 0.2.31. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>

sonarqubecloud · 2026-09-17T05:53:28Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
100.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

valentinabojan · 2026-09-17T07:30:43Z

+    Passed to [`GuardrailsService.evaluate_guardrail`][uipath.platform.guardrails.GuardrailsService.evaluate_guardrail]
+    so the guardrails backend can read the file's contents rather than only its metadata.
+
+    Only the Orchestrator attachment id crosses the wire: helix resolves it through


Don't refer the helix project name in the SDK docs please

Addressed in #1903 — project name dropped and the surrounding comments trimmed.

valentinabojan · 2026-09-17T07:32:13Z

        execution_source = self._execution_context.execution_source
        if execution_source:
            source_headers[HEADER_GUARDRAILS_SOURCE] = execution_source
+        # When attachments are present, tell helix which folder the run executed in


Same here. Drop the helix terminology. In fact, do we need this comment at all? Let's reduce the comments' verbosity and keep only what's really needed and useful.

Addressed in #1903 — project name dropped and the surrounding comments trimmed.

Copilot AI lite review requested due to automatic review settings September 12, 2026 22:44

github-actions Bot added test:uipath-langchain Triggers tests in the uipath-langchain-python repository test:uipath-integrations labels Sep 12, 2026

apetraru-uipath mentioned this pull request Sep 12, 2026

feat(guardrails): send attached file references with llm-as-judge evaluation UiPath/uipath-langchain-python#1082

Merged

Copilot started reviewing on behalf of apetraru-uipath September 12, 2026 22:45 View session

Copilot AI reviewed Sep 12, 2026

View reviewed changes

Comment thread packages/uipath-platform/pyproject.toml Outdated

Comment thread packages/uipath-platform/src/uipath/platform/guardrails/_guardrails_service.py

Comment thread packages/uipath-platform/src/uipath/platform/guardrails/_guardrails_service.py

apetraru-uipath force-pushed the feat/guardrail-judge-file-support branch from e831652 to 7145cf9 Compare September 16, 2026 14:07

github-actions Bot added the test:uipath-runtime label Sep 16, 2026

apetraru-uipath force-pushed the feat/guardrail-judge-file-support branch from ba99f49 to e475e89 Compare September 16, 2026 14:58

apetraru-uipath enabled auto-merge (squash) September 16, 2026 15:28

apetraru-uipath and others added 3 commits September 17, 2026 08:43

apetraru-uipath force-pushed the feat/guardrail-judge-file-support branch from 2aeff72 to f7d65ad Compare September 17, 2026 05:44

valentinabojan reviewed Sep 17, 2026

View reviewed changes

valentinabojan approved these changes Sep 17, 2026

View reviewed changes

apetraru-uipath merged commit 1c886a1 into main Sep 17, 2026
187 checks passed

apetraru-uipath deleted the feat/guardrail-judge-file-support branch September 17, 2026 07:32

apetraru-uipath mentioned this pull request Sep 17, 2026

docs(guardrails): trim attachment comments and drop backend project names #1903

Merged

Navigation Menu

feat: allow guardrail evaluation to carry attachment references - #1895

feat: allow guardrail evaluation to carry attachment references#1895
apetraru-uipath merged 3 commits into
mainfrom
feat/guardrail-judge-file-support

apetraru-uipath commented Sep 12, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Sep 17, 2026

Uh oh!

sonarqubecloud Bot commented Sep 17, 2026

Uh oh!

valentinabojan Sep 17, 2026

Uh oh!

apetraru-uipath Sep 17, 2026

Uh oh!

valentinabojan Sep 17, 2026

Uh oh!

apetraru-uipath Sep 17, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

apetraru-uipath commented Sep 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What

v2 — references instead of urls (commit db3cd201)

Review fixes

Notes for reviewers

Test plan

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

🟡 Changes recommended

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Sep 17, 2026

🚨 Heads up: uipath-langchain cross-tests are FAILING 🚨

Uh oh!

sonarqubecloud Bot commented Sep 17, 2026

Quality Gate passed

Uh oh!

valentinabojan Sep 17, 2026

Choose a reason for hiding this comment

Uh oh!

apetraru-uipath Sep 17, 2026

Choose a reason for hiding this comment

Uh oh!

valentinabojan Sep 17, 2026

Choose a reason for hiding this comment

Uh oh!

apetraru-uipath Sep 17, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

apetraru-uipath commented Sep 12, 2026 •

edited

Loading

v2 — references instead of urls (commit `db3cd201`)

🚨 Heads up: `uipath-langchain` cross-tests are FAILING 🚨