feat(guardrails): enrich observability data for guardrails (#518)

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

Author: valentinabojan

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "uipath-langchain"
-version = "0.5.23"
+version = "0.5.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

@@ -91,6 +91,7 @@ def action_node(
             "guardrail": guardrail,
             "scope": scope,
             "execution_stage": execution_stage,
+            "escalation_data": {},
         }
 
         async def _node(
@@ -103,13 +104,13 @@ async def _node(
             task_recipient = await resolve_recipient_value(self.recipient)
 
             if isinstance(self.recipient, StandardRecipient):
-                metadata["assigned_to"] = (
+                metadata["escalation_data"]["assigned_to"] = (
                     self.recipient.display_name
                     if self.recipient.display_name
                     else self.recipient.value
                 )
             elif isinstance(self.recipient, AssetRecipient):
-                metadata["assigned_to"] = (
+                metadata["escalation_data"]["assigned_to"] = (
                     task_recipient.value if task_recipient else None
                 )
 
@@ -184,6 +185,27 @@ async def _node(
                 )
             )
 
+            # Store reviewed inputs/outputs in metadata for observability
+            if escalation_result.data:
+                reviewed_inputs = escalation_result.data.get("ReviewedInputs")
+                reviewed_outputs = escalation_result.data.get("ReviewedOutputs")
+                reason = escalation_result.data.get("Reason")
+                if reviewed_inputs:
+                    metadata["escalation_data"]["reviewed_inputs"] = reviewed_inputs
+                if reviewed_outputs:
+                    metadata["escalation_data"]["reviewed_outputs"] = reviewed_outputs
+                if reason:
+                    metadata["escalation_data"]["reason"] = reason
+
+            # Store reviewed_by from completed_by_user
+            completed_by_user = getattr(escalation_result, "completed_by_user", None)
+            if completed_by_user:
+                reviewed_by = completed_by_user.get(
+                    "displayName"
+                ) or completed_by_user.get("emailAddress")
+                if reviewed_by:
+                    metadata["escalation_data"]["reviewed_by"] = reviewed_by
+
             if escalation_result.action == "Approve":
                 return _process_escalation_response(
                     state,
@@ -196,7 +218,7 @@ async def _node(
             raise AgentTerminationException(
                 code=UiPathErrorCode.EXECUTION_ERROR,
                 title="Escalation rejected",
-                detail=f"Please contact your administrator. Action was rejected after reviewing the task created by guardrail [{guardrail.name}], with reason: {escalation_result.data['Reason']}",
+                detail=f"Please contact your administrator. Action was rejected after reviewing the task created by guardrail [{guardrail.name}], with reason: {escalation_result.data.get('Reason', None)}",
             )
 
         _node.__metadata__ = metadata  # type: ignore[attr-defined]

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

@@ -75,7 +75,10 @@ def action_node(
             "guardrail": guardrail,
             "scope": scope,
             "execution_stage": execution_stage,
-            "excluded_fields": self.fields,
+            "excluded_fields": [field.path for field in self.fields]
+            if self.fields
+            else [],
+            "updated_data": {"input": None, "output": None},
         }
 
         async def _node(
@@ -89,8 +92,8 @@ async def _node(
                     guarded_component_name,
                 )
                 # Update metadata with filter results
-                metadata["updated_input"] = result.updated_input
-                metadata["updated_output"] = result.updated_output
+                metadata["updated_data"]["input"] = result.updated_input
+                metadata["updated_data"]["output"] = result.updated_output
                 return result.command
 
             raise AgentTerminationException(

tests/agent/guardrails/actions/test_escalate_action.py

@@ -1673,7 +1673,7 @@ async def test_standard_recipient_assigned_to_uses_value(self, mock_interrupt):
 
         metadata = getattr(node, "__metadata__", None)
         assert metadata is not None
-        assert metadata["assigned_to"] == "user@example.com"
+        assert metadata["escalation_data"]["assigned_to"] == "user@example.com"
 
     @pytest.mark.asyncio
     @patch("uipath_langchain.agent.guardrails.actions.escalate_action.interrupt")
@@ -1711,7 +1711,7 @@ async def test_standard_recipient_assigned_to_uses_display_name(
 
         metadata = getattr(node, "__metadata__", None)
         assert metadata is not None
-        assert metadata["assigned_to"] == "John Doe"
+        assert metadata["escalation_data"]["assigned_to"] == "John Doe"
 
     @pytest.mark.asyncio
     @patch("uipath_langchain.agent.tools.escalation_tool.resolve_recipient_value")
@@ -1756,4 +1756,4 @@ async def test_asset_recipient_assigned_to_uses_resolved_value(
         metadata = getattr(node, "__metadata__", None)
         assert metadata is not None
         # AssetRecipient uses resolved task_recipient.value
-        assert metadata["assigned_to"] == "resolved@example.com"
+        assert metadata["escalation_data"]["assigned_to"] == "resolved@example.com"

tests/agent/guardrails/actions/test_filter_action.py

@@ -519,7 +519,7 @@ def test_filter_action_node_has_excluded_fields_in_metadata(self):
         metadata = getattr(node, "__metadata__", None)
         assert metadata is not None
         assert "excluded_fields" in metadata
-        assert metadata["excluded_fields"] == fields
+        assert metadata["excluded_fields"] == ["sentence"]
 
     @pytest.mark.asyncio
     async def test_filter_input_updates_metadata_with_updated_input(self) -> None:
@@ -553,8 +553,8 @@ async def test_filter_input_updates_metadata_with_updated_input(self) -> None:
         metadata = getattr(node, "__metadata__", None)
         assert metadata is not None
         # updated_input should contain the filtered args (without 'sentence')
-        assert metadata["updated_input"] == {"other_param": "value"}
-        assert metadata["updated_output"] is None
+        assert metadata["updated_data"]["input"] == {"other_param": "value"}
+        assert metadata["updated_data"]["output"] is None
 
     @pytest.mark.asyncio
     async def test_filter_output_updates_metadata_with_updated_output(self) -> None:
@@ -583,5 +583,5 @@ async def test_filter_output_updates_metadata_with_updated_output(self) -> None:
         metadata = getattr(node, "__metadata__", None)
         assert metadata is not None
         # updated_output should contain the filtered output (without 'content')
-        assert metadata["updated_output"] == {"other": "data"}
-        assert metadata["updated_input"] is None
+        assert metadata["updated_data"]["output"] == {"other": "data"}
+        assert metadata["updated_data"]["input"] is None