Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/uipath-platform/pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
name = "uipath-platform"
version = "0.2.9"
version = "0.2.10"
description = "HTTP client library for programmatic access to UiPath Platform"
readme = { file = "README.md", content-type = "text/markdown" }
requires-python = ">=3.11"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,8 @@ def evaluate_guardrail(
"BYO (Bring Your Own) guardrails require byo_validator_name."
)
payload["byoValidatorName"] = guardrail.byo_validator_name
if guardrail.byo_connection_id:
payload["byoConnectionId"] = guardrail.byo_connection_id
Comment thread
valentinabojan marked this conversation as resolved.
spec = RequestSpec(
method="POST",
endpoint=Endpoint("/agentsruntime_/api/execution/guardrails/validate"),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,7 @@ class BuiltInValidatorGuardrail(BaseGuardrail):
default_factory=list, alias="validatorParameters"
)
byo_validator_name: str | None = Field(default=None, alias="byoValidatorName")
byo_connection_id: str | None = Field(default=None, alias="byoConnectionId")

model_config = ConfigDict(populate_by_name=True, extra="allow")

Expand Down
146 changes: 146 additions & 0 deletions packages/uipath-platform/tests/services/test_guardrails_service.py
Original file line number Diff line number Diff line change
Expand Up @@ -350,6 +350,109 @@ def capture_request(request):
assert request_payload["byoValidatorName"] == "my_databricks_pii"
assert result.result == GuardrailValidationResultType.PASSED

def test_evaluate_guardrail_byog_forwards_byo_connection_id(
self,
httpx_mock: HTTPXMock,
service: GuardrailsService,
base_url: str,
org: str,
tenant: str,
) -> None:
"""A BYOG guardrail forwards byoConnectionId so the backend can narrow
configuration resolution to the specific connection."""
captured_request = None

def capture_request(request):
nonlocal captured_request
captured_request = request
return httpx.Response(
status_code=200,
json={"result": "PASSED", "details": "Validation passed"},
)

httpx_mock.add_callback(
method="POST",
url=f"{base_url}{org}{tenant}/agentsruntime_/api/execution/guardrails/validate",
callback=capture_request,
)

byog_guardrail = BuiltInValidatorGuardrail(
id="byog-id",
name="Databricks PII (BYOG)",
enabled_for_evals=True,
selector=GuardrailSelector(scopes=[GuardrailScope.LLM]),
guardrail_type="builtInValidator",
validator_type="byo",
byo_validator_name="my_databricks_pii",
byo_connection_id="byog-conn-1",
validator_parameters=[],
)

service.evaluate_guardrail("some input", byog_guardrail)

assert captured_request is not None
request_payload = json.loads(captured_request.content)
assert request_payload["byoValidatorName"] == "my_databricks_pii"
assert request_payload["byoConnectionId"] == "byog-conn-1"

def test_evaluate_guardrail_byog_omits_connection_id_when_absent(
self,
httpx_mock: HTTPXMock,
service: GuardrailsService,
base_url: str,
org: str,
tenant: str,
) -> None:
"""byoConnectionId is only forwarded when present; a BYOG guardrail without
one resolves by validator name alone."""
captured_request = None

def capture_request(request):
nonlocal captured_request
captured_request = request
return httpx.Response(
status_code=200,
json={"result": "PASSED", "details": "Validation passed"},
)

httpx_mock.add_callback(
method="POST",
url=f"{base_url}{org}{tenant}/agentsruntime_/api/execution/guardrails/validate",
callback=capture_request,
)

byog_guardrail = BuiltInValidatorGuardrail(
id="byog-id",
name="Databricks PII (BYOG)",
enabled_for_evals=True,
selector=GuardrailSelector(scopes=[GuardrailScope.LLM]),
guardrail_type="builtInValidator",
validator_type="byo",
byo_validator_name="my_databricks_pii",
validator_parameters=[],
)

service.evaluate_guardrail("some input", byog_guardrail)

assert captured_request is not None
request_payload = json.loads(captured_request.content)
assert "byoConnectionId" not in request_payload

def test_evaluate_guardrail_byo_connection_id_from_alias(self) -> None:
"""byoConnectionId parses into the typed field via its camelCase alias."""
guardrail = BuiltInValidatorGuardrail.model_validate(
{
"$guardrailType": "builtInValidator",
"id": "byog-id",
"name": "BYOG",
"validatorType": "byo",
"byoValidatorName": "my_databricks_pii",
"byoConnectionId": "byog-conn-1",
"validatorParameters": [],
}
)
assert guardrail.byo_connection_id == "byog-conn-1"

def test_evaluate_guardrail_byo_without_name_raises(
self,
service: GuardrailsService,
Expand Down Expand Up @@ -426,6 +529,49 @@ def capture_request(request):
request_payload = json.loads(captured_request.content)
assert "byoValidatorName" not in request_payload

def test_evaluate_guardrail_non_byo_type_does_not_forward_connection_id(
self,
httpx_mock: HTTPXMock,
service: GuardrailsService,
base_url: str,
org: str,
tenant: str,
) -> None:
"""byoConnectionId is only forwarded for the "byo" sentinel, never leaked
into a non-BYOG validator payload even if the field happens to be set."""
captured_request = None

def capture_request(request):
nonlocal captured_request
captured_request = request
return httpx.Response(
status_code=200,
json={"result": "PASSED", "details": "Validation passed"},
)

httpx_mock.add_callback(
method="POST",
url=f"{base_url}{org}{tenant}/agentsruntime_/api/execution/guardrails/validate",
callback=capture_request,
)

guardrail = BuiltInValidatorGuardrail(
id="test-id",
name="PII detection guardrail",
enabled_for_evals=True,
selector=GuardrailSelector(scopes=[GuardrailScope.LLM]),
guardrail_type="builtInValidator",
validator_type="pii_detection",
byo_connection_id="stray-conn",
validator_parameters=[],
)

service.evaluate_guardrail("some input", guardrail)

assert captured_request is not None
request_payload = json.loads(captured_request.content)
assert "byoConnectionId" not in request_payload

def test_evaluate_guardrail_ootb_omits_byo_validator_name(
self,
httpx_mock: HTTPXMock,
Expand Down
2 changes: 1 addition & 1 deletion packages/uipath-platform/uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion packages/uipath/uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading