fix: add correct guardrail validation info on the node state (#459)

Co-authored-by: Valentina Bojan <valentina.bojan@uipath.com>

Author: valentinabojan

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "uipath-langchain"
-version = "0.4.23"
+version = "0.4.24"
 description = "Python SDK that enables developers to build and deploy LangGraph agents to the UiPath Cloud Platform"
 readme = { file = "README.md", content-type = "text/markdown" }
 requires-python = ">=3.11"

src/uipath_langchain/agent/guardrails/actions/escalate_action.py

@@ -89,7 +89,7 @@ async def _node(
                 "GuardrailDescription": guardrail.description,
                 "Component": _build_component_name(scope, guarded_component_name),
                 "ExecutionStage": _execution_stage_to_string(execution_stage),
-                "GuardrailResult": state.inner_state.guardrail_validation_result,
+                "GuardrailResult": state.inner_state.guardrail_validation_details,
             }
 
             # Add tenant and trace URL if base_url is configured

src/uipath_langchain/agent/guardrails/actions/log_action.py

@@ -49,7 +49,7 @@ def action_node(
         async def _node(_state: AgentGuardrailsGraphState) -> dict[str, Any]:
             message = (
                 self.message
-                or f"Guardrail [{guardrail.name}] validation failed for [{scope.name}] [{execution_stage.name}] with the following reason: {_state.inner_state.guardrail_validation_result}"
+                or f"Guardrail [{guardrail.name}] validation failed for [{scope.name}] [{execution_stage.name}] with the following reason: {_state.inner_state.guardrail_validation_details}"
             )
 
             logger.log(self.level, message)

src/uipath_langchain/agent/guardrails/guardrail_nodes.py

@@ -109,15 +109,21 @@ def _create_validation_command(
         return Command(
             goto=success_node,
             update={
-                "inner_state": {"guardrail_validation_result": guardrail_result.reason}
+                "inner_state": {
+                    "guardrail_validation_result": True,
+                    "guardrail_validation_details": guardrail_result.reason,
+                }
             },
         )
 
     if guardrail_result.result == GuardrailValidationResultType.VALIDATION_FAILED:
         return Command(
             goto=failure_node,
             update={
-                "inner_state": {"guardrail_validation_result": guardrail_result.reason}
+                "inner_state": {
+                    "guardrail_validation_result": False,
+                    "guardrail_validation_details": guardrail_result.reason,
+                }
             },
         )
 

src/uipath_langchain/agent/react/types.py

@@ -28,7 +28,8 @@ class InnerAgentGraphState(BaseModel):
 class InnerAgentGuardrailsGraphState(InnerAgentGraphState):
     """Extended inner state for guardrails subgraph."""
 
-    guardrail_validation_result: Optional[str] = None
+    guardrail_validation_result: Optional[bool] = None
+    guardrail_validation_details: Optional[str] = None
     agent_result: Optional[dict[str, Any]] = None
 
 

tests/agent/guardrails/actions/test_escalate_action.py

@@ -160,7 +160,7 @@ async def test_node_interrupts_with_correct_message_data(
             state = AgentGuardrailsGraphState(
                 messages=[HumanMessage(content="Test message")],
                 inner_state=InnerAgentGuardrailsGraphState(
-                    guardrail_validation_result="Validation failed"
+                    guardrail_validation_details="Validation failed"
                 ),
             )
         else:
@@ -171,7 +171,7 @@ async def test_node_interrupts_with_correct_message_data(
                     HumanMessage(content="Output message"),
                 ],
                 inner_state=InnerAgentGuardrailsGraphState(
-                    guardrail_validation_result="Validation failed"
+                    guardrail_validation_details="Validation failed"
                 ),
             )
 
@@ -238,7 +238,7 @@ async def test_node_post_agent_interrupts_with_correct_agent_result_data(
             ],
             inner_state=InnerAgentGuardrailsGraphState(
                 agent_result={"ok": True},
-                guardrail_validation_result="Validation failed",
+                guardrail_validation_details="Validation failed",
             ),
         )
 
@@ -855,7 +855,7 @@ async def test_node_interrupts_with_correct_data_pre_tool(self, mock_interrupt):
         )
         state = AgentGuardrailsGraphState(
             messages=[ai_message],
-            guardrail_validation_result="Validation failed",
+            guardrail_validation_details="Validation failed",
         )
 
         await node(state)

tests/agent/guardrails/actions/test_log_action.py

@@ -39,7 +39,10 @@ async def test_node_name_and_logs_custom_message(
         with caplog.at_level(logging.ERROR):
             result = await node(
                 AgentGuardrailsGraphState(
-                    messages=[], guardrail_validation_result="ignored"
+                    messages=[],
+                    inner_state=InnerAgentGuardrailsGraphState(
+                        guardrail_validation_details="ignored"
+                    ),
                 )
             )
 
@@ -88,7 +91,8 @@ async def test_default_message_includes_context(
                 AgentGuardrailsGraphState(
                     messages=[],
                     inner_state=InnerAgentGuardrailsGraphState(
-                        guardrail_validation_result="bad input"
+                        guardrail_validation_result=False,
+                        guardrail_validation_details="bad input",
                     ),
                 )
             )

tests/agent/guardrails/test_guardrail_nodes.py

@@ -106,7 +106,10 @@ async def test_llm_success_pre_and_post(
         cmd = await node(state)
         assert cmd.goto == "ok"
         assert cmd.update == {
-            "inner_state": {"guardrail_validation_result": "validation passed"}
+            "inner_state": {
+                "guardrail_validation_result": True,
+                "guardrail_validation_details": "validation passed",
+            }
         }
 
     @pytest.mark.asyncio
@@ -142,7 +145,10 @@ async def test_llm_failure_pre_and_post(
         cmd = await node(state)
         assert cmd.goto == "nope"
         assert cmd.update == {
-            "inner_state": {"guardrail_validation_result": "policy_violation"}
+            "inner_state": {
+                "guardrail_validation_result": False,
+                "guardrail_validation_details": "policy_violation",
+            }
         }
 
 
@@ -183,7 +189,10 @@ async def test_agent_init_success_pre_and_post(
         cmd = await node(state)
         assert cmd.goto == "ok"
         assert cmd.update == {
-            "inner_state": {"guardrail_validation_result": "validation passed"}
+            "inner_state": {
+                "guardrail_validation_result": True,
+                "guardrail_validation_details": "validation passed",
+            }
         }
         assert fake.guardrails.last_text == "payload"
 
@@ -223,7 +232,10 @@ async def test_agent_init_failure_pre_and_post(
         cmd = await node(state)
         assert cmd.goto == "nope"
         assert cmd.update == {
-            "inner_state": {"guardrail_validation_result": "policy_violation"}
+            "inner_state": {
+                "guardrail_validation_result": False,
+                "guardrail_validation_details": "policy_violation",
+            }
         }
 
 
@@ -268,7 +280,10 @@ async def test_agent_terminate_success_pre_and_post(
         cmd = await node(state)
         assert cmd.goto == "ok"
         assert cmd.update == {
-            "inner_state": {"guardrail_validation_result": "validation passed"}
+            "inner_state": {
+                "guardrail_validation_result": True,
+                "guardrail_validation_details": "validation passed",
+            }
         }
         assert fake.guardrails.last_text == str(agent_result)
 
@@ -311,7 +326,10 @@ async def test_agent_terminate_failure_pre_and_post(
         cmd = await node(state)
         assert cmd.goto == "nope"
         assert cmd.update == {
-            "inner_state": {"guardrail_validation_result": "policy_violation"}
+            "inner_state": {
+                "guardrail_validation_result": False,
+                "guardrail_validation_details": "policy_violation",
+            }
         }
 
 
@@ -360,15 +378,25 @@ async def test_tool_success_pre_and_post(
             )
             cmd = await node(state)
             assert cmd.goto == "ok"
-            assert cmd.update == {"inner_state": {"guardrail_validation_result": ""}}
+            assert cmd.update == {
+                "inner_state": {
+                    "guardrail_validation_result": True,
+                    "guardrail_validation_details": "",
+                }
+            }
             assert json.loads(fake.guardrails.last_text or "{}") == {"x": 1}
         else:
             state = AgentGuardrailsGraphState(
                 messages=[ToolMessage(content="tool output", tool_call_id="call_1")]
             )
             cmd = await node(state)
             assert cmd.goto == "ok"
-            assert cmd.update == {"inner_state": {"guardrail_validation_result": ""}}
+            assert cmd.update == {
+                "inner_state": {
+                    "guardrail_validation_result": True,
+                    "guardrail_validation_details": "",
+                }
+            }
             assert fake.guardrails.last_text == "tool output"
 
     @pytest.mark.asyncio
@@ -423,7 +451,10 @@ async def test_tool_failure_pre_and_post(
         cmd = await node(state)
         assert cmd.goto == "nope"
         assert cmd.update == {
-            "inner_state": {"guardrail_validation_result": "policy_violation"}
+            "inner_state": {
+                "guardrail_validation_result": False,
+                "guardrail_validation_details": "policy_violation",
+            }
         }
 
 
@@ -552,7 +583,10 @@ def test_create_validation_command_success(self):
 
         assert command.goto == "success_node"
         assert command.update == {
-            "inner_state": {"guardrail_validation_result": "validation passed"}
+            "inner_state": {
+                "guardrail_validation_result": True,
+                "guardrail_validation_details": "validation passed",
+            }
         }
 
     def test_create_validation_command_failure(self):
@@ -569,7 +603,10 @@ def test_create_validation_command_failure(self):
 
         assert command.goto == "failure_node"
         assert command.update == {
-            "inner_state": {"guardrail_validation_result": "policy_violation"}
+            "inner_state": {
+                "guardrail_validation_result": False,
+                "guardrail_validation_details": "policy_violation",
+            }
         }
 
     def test_create_validation_command_feature_disabled_raises_exception(self):