uipath-core 0.1.2__tar.gz → 0.1.4__tar.gz

{uipath_core-0.1.2 → uipath_core-0.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: uipath-core
-Version: 0.1.2
+Version: 0.1.4
 Summary: UiPath Core abstractions
 Project-URL: Homepage, https://uipath.com
 Project-URL: Repository, https://github.com/UiPath/uipath-core-python

{uipath_core-0.1.2 → uipath_core-0.1.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "uipath-core"
-version = "0.1.2"
+version = "0.1.4"
 description = "UiPath Core abstractions"
 readme = { file = "README.md", content-type = "text/markdown" }
 requires-python = ">=3.11"

{uipath_core-0.1.2 → uipath_core-0.1.4}/src/uipath/core/guardrails/__init__.py

@@ -15,6 +15,7 @@ from .guardrails import (
     FieldSource,
     GuardrailScope,
     GuardrailSelector,
+    GuardrailValidationResult,
     NumberRule,
     Rule,
     SelectorType,
@@ -41,4 +42,5 @@ __all__ = [
     "Rule",
     "GuardrailScope",
     "GuardrailSelector",
+    "GuardrailValidationResult",
 ]

{uipath_core-0.1.2 → uipath_core-0.1.4}/src/uipath/core/guardrails/_evaluators.py

@@ -4,8 +4,9 @@ This module provides functions for evaluating different types of guardrail rules
 against input and output data.
 """
 
+import inspect
 from enum import IntEnum
-from typing import Any
+from typing import Any, Callable
 
 from .guardrails import (
     AllFieldsSelector,
@@ -163,7 +164,7 @@ def format_guardrail_error_message(
 ) -> str:
     """Format a guardrail error message following the standard pattern."""
     source = "Input" if field_ref.source == FieldSource.INPUT else "Output"
-    message = f"{source} data didn't match the guardrail condition: [{field_ref.path}] {operator}"
+    message = f"{source} data didn't match the guardrail condition: [{field_ref.path}] comparing function [{operator}]"
     if expected_value and expected_value.strip():
         message += f" [{expected_value.strip()}]"
     return message
@@ -187,16 +188,18 @@ def evaluate_word_rule(
         field_str = field_value
 
         # Use the custom function to evaluate the rule
+        # If detects_violation returns True, it means the rule was violated (validation fails)
         try:
-            passed = rule.func(field_str)
+            violation_detected = rule.detects_violation(field_str)
         except Exception:
             # If function raises an exception, treat as failure
-            passed = False
+            violation_detected = True
 
-        if not passed:
-            reason = format_guardrail_error_message(
-                field_ref, "comparing function", None
+        if violation_detected:
+            operator = (
+                _humanize_guardrail_func(rule.detects_violation) or "violation check"
             )
+            reason = format_guardrail_error_message(field_ref, operator, None)
             return False, reason
 
     return True, "All word rule validations passed"
@@ -221,16 +224,18 @@ def evaluate_number_rule(
         field_num = float(field_value)
 
         # Use the custom function to evaluate the rule
+        # If detects_violation returns True, it means the rule was violated (validation fails)
         try:
-            passed = rule.func(field_num)
+            violation_detected = rule.detects_violation(field_num)
         except Exception:
             # If function raises an exception, treat as failure
-            passed = False
+            violation_detected = True
 
-        if not passed:
-            reason = format_guardrail_error_message(
-                field_ref, "comparing function", None
+        if violation_detected:
+            operator = (
+                _humanize_guardrail_func(rule.detects_violation) or "violation check"
             )
+            reason = format_guardrail_error_message(field_ref, operator, None)
             return False, reason
 
     return True, "All number rule validations passed"
@@ -256,16 +261,18 @@ def evaluate_boolean_rule(
         field_bool = field_value
 
         # Use the custom function to evaluate the rule
+        # If detects_violation returns True, it means the rule was violated (validation fails)
         try:
-            passed = rule.func(field_bool)
+            violation_detected = rule.detects_violation(field_bool)
         except Exception:
             # If function raises an exception, treat as failure
-            passed = False
+            violation_detected = True
 
-        if not passed:
-            reason = format_guardrail_error_message(
-                field_ref, "comparing function", None
+        if violation_detected:
+            operator = (
+                _humanize_guardrail_func(rule.detects_violation) or "violation check"
             )
+            reason = format_guardrail_error_message(field_ref, operator, None)
             return False, reason
 
     return True, "All boolean rule validations passed"
@@ -307,3 +314,72 @@ def evaluate_universal_rule(
         return False, "Universal rule validation triggered (input and output)"
     else:
         return False, f"Unknown apply_to value: {rule.apply_to}"
+
+
+def _humanize_guardrail_func(func: Callable[..., Any] | str | None) -> str | None:
+    """Build a user-friendly description of a guardrail predicate.
+
+    Deterministic guardrails store Python callables (often lambdas) to evaluate
+    conditions. For diagnostics, it's useful to include a readable hint about the
+    predicate that failed.
+
+    Args:
+        func: A Python callable used as a predicate, or a pre-rendered string
+            description (for example, ``"s:str -> bool: contains 'test'"``).
+
+    Returns:
+        A human-readable description, or ``None`` if one cannot be produced.
+    """
+    if func is None:
+        return None
+
+    if isinstance(func, str):
+        rendered = func.strip()
+        return rendered or None
+
+    name = getattr(func, "__name__", None)
+    if name and name != "<lambda>":
+        return name
+
+    # Best-effort extraction for lambdas / callables.
+    try:
+        sig = str(inspect.signature(func))
+    except (TypeError, ValueError):
+        sig = ""
+
+    try:
+        source_lines = inspect.getsourcelines(func)
+        source = "".join(source_lines[0]).strip()
+        # Collapse whitespace to keep the message compact.
+        source = " ".join(source.split())
+
+        # Remove "detects_violation=lambda" prefix if present
+        # Pattern: "detects_violation=lambda s: condition" -> "condition"
+        if "detects_violation=lambda" in source:
+            # Find the lambda part
+            lambda_start = source.find("detects_violation=lambda")
+            if lambda_start != -1:
+                # Get everything after "detects_violation=lambda"
+                lambda_part = source[
+                    lambda_start + len("detects_violation=lambda") :
+                ].strip()
+                # Find the colon that separates param from body
+                colon_idx = lambda_part.find(":")
+                if colon_idx != -1:
+                    # Extract just the body (condition)
+                    body = lambda_part[colon_idx + 1 :].strip()
+                    # Remove trailing comma if present
+                    body = body.rstrip(",").strip()
+                    source = body
+    except (OSError, TypeError):
+        source = ""
+
+    if source and sig:
+        return f"{sig}: {source}"
+    if source:
+        return source
+    if sig:
+        return sig
+
+    rendered = repr(func).strip()
+    return rendered or None

{uipath_core-0.1.2 → uipath_core-0.1.4}/src/uipath/core/guardrails/guardrails.py

@@ -92,7 +92,10 @@ class WordRule(BaseModel):
 
     rule_type: Literal["word"] = Field(alias="$ruleType")
     field_selector: FieldSelector = Field(alias="fieldSelector")
-    func: Callable[[str], bool] = Field(exclude=True)
+    detects_violation: Callable[[str], bool] = Field(
+        exclude=True,
+        description="Function that returns True if the string violates the rule (validation should fail).",
+    )
 
     model_config = ConfigDict(populate_by_name=True, extra="allow")
 
@@ -111,7 +114,10 @@ class NumberRule(BaseModel):
 
     rule_type: Literal["number"] = Field(alias="$ruleType")
     field_selector: FieldSelector = Field(alias="fieldSelector")
-    func: Callable[[float], bool] = Field(exclude=True)
+    detects_violation: Callable[[float], bool] = Field(
+        exclude=True,
+        description="Function that returns True if the number violates the rule (validation should fail).",
+    )
 
     model_config = ConfigDict(populate_by_name=True, extra="allow")
 
@@ -121,7 +127,10 @@ class BooleanRule(BaseModel):
 
     rule_type: Literal["boolean"] = Field(alias="$ruleType")
     field_selector: FieldSelector = Field(alias="fieldSelector")
-    func: Callable[[bool], bool] = Field(exclude=True)
+    detects_violation: Callable[[bool], bool] = Field(
+        exclude=True,
+        description="Function that returns True if the boolean violates the rule (validation should fail).",
+    )
 
     model_config = ConfigDict(populate_by_name=True, extra="allow")
 
@@ -164,7 +173,7 @@ class BaseGuardrail(BaseModel):
 class DeterministicGuardrail(BaseGuardrail):
     """Deterministic guardrail model."""
 
-    guardrail_type: Literal["custom"] = Field(alias="custom")
+    guardrail_type: Literal["custom"] = Field(alias="$guardrailType")
     rules: list[Rule]
 
     model_config = ConfigDict(populate_by_name=True, extra="allow")

{uipath_core-0.1.2 → uipath_core-0.1.4}/tests/guardrails/test_deterministic_guardrails_service.py

@@ -50,7 +50,7 @@ class TestDeterministicGuardrailsService:
                         selector_type="specific",
                         fields=[FieldReference(path="age", source=FieldSource.INPUT)],
                     ),
-                    func=lambda n: n >= 21.0,
+                    detects_violation=lambda n: n < 21.0,
                 ),
                 BooleanRule(
                     rule_type="boolean",
@@ -60,7 +60,7 @@ class TestDeterministicGuardrailsService:
                             FieldReference(path="isActive", source=FieldSource.INPUT)
                         ],
                     ),
-                    func=lambda b: b is True,
+                    detects_violation=lambda b: b is not True,
                 ),
             ],
         )
@@ -80,7 +80,7 @@ class TestDeterministicGuardrailsService:
         )
 
         assert result.validation_passed is True
-        assert "All deterministic guardrail rules passed" in result.reason
+        assert result.reason == "All deterministic guardrail rules passed"
 
     def test_evaluate_post_deterministic_guardrail_validation_failed_age(
         self,
@@ -103,7 +103,7 @@ class TestDeterministicGuardrailsService:
                         selector_type="specific",
                         fields=[FieldReference(path="age", source=FieldSource.INPUT)],
                     ),
-                    func=lambda n: n >= 21.0,
+                    detects_violation=lambda n: n < 21.0,
                 ),
                 BooleanRule(
                     rule_type="boolean",
@@ -113,7 +113,7 @@ class TestDeterministicGuardrailsService:
                             FieldReference(path="isActive", source=FieldSource.INPUT)
                         ],
                     ),
-                    func=lambda b: b is True,
+                    detects_violation=lambda b: b is not True,
                 ),
             ],
         )
@@ -133,7 +133,10 @@ class TestDeterministicGuardrailsService:
         )
 
         assert result.validation_passed is False
-        assert "age" in result.reason.lower()
+        assert (
+            result.reason
+            == "Input data didn't match the guardrail condition: [age] comparing function [(n): n < 21.0]"
+        )
 
     def test_evaluate_post_deterministic_guardrail_validation_failed_is_active(
         self,
@@ -156,7 +159,7 @@ class TestDeterministicGuardrailsService:
                         selector_type="specific",
                         fields=[FieldReference(path="age", source=FieldSource.INPUT)],
                     ),
-                    func=lambda n: n >= 21.0,
+                    detects_violation=lambda n: n < 21.0,
                 ),
                 BooleanRule(
                     rule_type="boolean",
@@ -166,7 +169,7 @@ class TestDeterministicGuardrailsService:
                             FieldReference(path="isActive", source=FieldSource.INPUT)
                         ],
                     ),
-                    func=lambda b: b is True,
+                    detects_violation=lambda b: b is not True,
                 ),
             ],
         )
@@ -186,8 +189,10 @@ class TestDeterministicGuardrailsService:
         )
 
         assert result.validation_passed is False
-        assert "isActive" in result.reason or "isactive" in result.reason.lower()
-        assert "comparing function" in result.reason.lower()
+        assert (
+            result.reason
+            == "Input data didn't match the guardrail condition: [isActive] comparing function [(b): b is not True]"
+        )
 
     def test_evaluate_post_deterministic_guardrail_matches_regex_positive(
         self,
@@ -212,7 +217,7 @@ class TestDeterministicGuardrailsService:
                             FieldReference(path="userName", source=FieldSource.INPUT)
                         ],
                     ),
-                    func=lambda s: bool(re.search(".*te.*3.*", s)),
+                    detects_violation=lambda s: not bool(re.search(".*te.*3.*", s)),
                 ),
             ],
         )
@@ -230,7 +235,7 @@ class TestDeterministicGuardrailsService:
         )
 
         assert result.validation_passed is True
-        assert "All deterministic guardrail rules passed" in result.reason
+        assert result.reason == "All deterministic guardrail rules passed"
 
     def test_evaluate_post_deterministic_guardrail_matches_regex_negative(
         self,
@@ -255,7 +260,7 @@ class TestDeterministicGuardrailsService:
                             FieldReference(path="userName", source=FieldSource.INPUT)
                         ],
                     ),
-                    func=lambda s: bool(re.search(".*te.*3.*", s)),
+                    detects_violation=lambda s: not bool(re.search(".*te.*3.*", s)),
                 ),
             ],
         )
@@ -273,7 +278,10 @@ class TestDeterministicGuardrailsService:
         )
 
         assert result.validation_passed is False
-        assert "userName" in result.reason
+        assert (
+            result.reason
+            == 'Input data didn\'t match the guardrail condition: [userName] comparing function [(s): not bool(re.search(".*te.*3.*", s))]'
+        )
 
     def test_evaluate_post_deterministic_guardrail_word_func_positive(
         self,
@@ -298,7 +306,7 @@ class TestDeterministicGuardrailsService:
                             FieldReference(path="userName", source=FieldSource.INPUT)
                         ],
                     ),
-                    func=lambda s: len(s) > 5,
+                    detects_violation=lambda s: len(s) <= 5,
                 ),
             ],
         )
@@ -316,7 +324,7 @@ class TestDeterministicGuardrailsService:
         )
 
         assert result.validation_passed is True
-        assert "All deterministic guardrail rules passed" in result.reason
+        assert result.reason == "All deterministic guardrail rules passed"
 
     def test_evaluate_post_deterministic_guardrail_word_func_negative(
         self,
@@ -341,7 +349,7 @@ class TestDeterministicGuardrailsService:
                             FieldReference(path="userName", source=FieldSource.INPUT)
                         ],
                     ),
-                    func=lambda s: len(s) > 5,
+                    detects_violation=lambda s: len(s) <= 5,
                 ),
             ],
         )
@@ -360,6 +368,52 @@ class TestDeterministicGuardrailsService:
 
         assert result.validation_passed is False
 
+    def test_evaluate_post_deterministic_guardrail_word_contains_substring_detects_violation(
+        self,
+        service: DeterministicGuardrailsService,
+    ) -> None:
+        """Test deterministic guardrail validation fails when string contains forbidden substring."""
+        deterministic_guardrail = DeterministicGuardrail(
+            id="test-deterministic-id",
+            name="Word Contains Guardrail",
+            description="Test word contains guardrail",
+            enabled_for_evals=True,
+            guardrail_type="custom",
+            selector=GuardrailSelector(
+                scopes=[GuardrailScope.TOOL], match_names=["test"]
+            ),
+            rules=[
+                WordRule(
+                    rule_type="word",
+                    field_selector=SpecificFieldsSelector(
+                        selector_type="specific",
+                        fields=[
+                            FieldReference(path="userName", source=FieldSource.INPUT)
+                        ],
+                    ),
+                    detects_violation=lambda s: "dre" in s,
+                ),
+            ],
+        )
+
+        # Input data with userName that contains "dre" - should fail
+        input_data = {
+            "userName": "andrei",
+        }
+        output_data: dict[str, Any] = {}
+
+        result = service.evaluate_post_deterministic_guardrail(
+            input_data=input_data,
+            output_data=output_data,
+            guardrail=deterministic_guardrail,
+        )
+
+        assert result.validation_passed is False
+        assert (
+            result.reason
+            == 'Input data didn\'t match the guardrail condition: [userName] comparing function [(s): "dre" in s]'
+        )
+
     def test_evaluate_post_deterministic_guardrail_number_func_positive(
         self,
         service: DeterministicGuardrailsService,
@@ -381,7 +435,7 @@ class TestDeterministicGuardrailsService:
                         selector_type="specific",
                         fields=[FieldReference(path="age", source=FieldSource.INPUT)],
                     ),
-                    func=lambda n: n >= 18 and n <= 65,
+                    detects_violation=lambda n: n < 18 or n > 65,
                 ),
             ],
         )
@@ -399,7 +453,7 @@ class TestDeterministicGuardrailsService:
         )
 
         assert result.validation_passed is True
-        assert "All deterministic guardrail rules passed" in result.reason
+        assert result.reason == "All deterministic guardrail rules passed"
 
     def test_evaluate_post_deterministic_guardrail_number_func_negative(
         self,
@@ -422,7 +476,7 @@ class TestDeterministicGuardrailsService:
                         selector_type="specific",
                         fields=[FieldReference(path="age", source=FieldSource.INPUT)],
                     ),
-                    func=lambda n: n >= 18 and n <= 65,
+                    detects_violation=lambda n: n < 18 or n > 65,
                 ),
             ],
         )
@@ -678,7 +732,7 @@ class TestDeterministicGuardrailsService:
                 NumberRule(
                     rule_type="number",
                     field_selector=AllFieldsSelector(selector_type="all"),
-                    func=lambda n: n == 25.0,
+                    detects_violation=lambda n: n != 25.0,
                 ),
             ],
         )
@@ -720,7 +774,7 @@ class TestDeterministicGuardrailsService:
                 NumberRule(
                     rule_type="number",
                     field_selector=AllFieldsSelector(selector_type="all"),
-                    func=lambda n: n == 200.0,
+                    detects_violation=lambda n: n != 200.0,
                 ),
             ],
         )
@@ -898,7 +952,7 @@ class TestDeterministicGuardrailsService:
                         selector_type="specific",
                         fields=[FieldReference(path="age", source=FieldSource.INPUT)],
                     ),
-                    func=lambda n: n >= 21.0,
+                    detects_violation=lambda n: n < 21.0,
                 ),
                 BooleanRule(
                     rule_type="boolean",
@@ -908,7 +962,7 @@ class TestDeterministicGuardrailsService:
                             FieldReference(path="isActive", source=FieldSource.INPUT)
                         ],
                     ),
-                    func=lambda b: b is True,
+                    detects_violation=lambda b: b is not True,
                 ),
             ],
         )
@@ -931,7 +985,7 @@ class TestDeterministicGuardrailsService:
                         selector_type="specific",
                         fields=[FieldReference(path="age", source=FieldSource.INPUT)],
                     ),
-                    func=lambda n: n >= 21.0,
+                    detects_violation=lambda n: n < 21.0,
                 ),
                 NumberRule(
                     rule_type="number",
@@ -941,7 +995,7 @@ class TestDeterministicGuardrailsService:
                             FieldReference(path="status", source=FieldSource.OUTPUT)
                         ],
                     ),
-                    func=lambda n: n == 200.0,
+                    detects_violation=lambda n: n != 200.0,
                 ),
             ],
         )
@@ -964,7 +1018,7 @@ class TestDeterministicGuardrailsService:
                         selector_type="specific",
                         fields=[FieldReference(path="age", source=FieldSource.INPUT)],
                     ),
-                    func=lambda n: n >= 21.0,
+                    detects_violation=lambda n: n < 21.0,
                 ),
                 BooleanRule(
                     rule_type="boolean",
@@ -974,7 +1028,7 @@ class TestDeterministicGuardrailsService:
                             FieldReference(path="isActive", source=FieldSource.INPUT)
                         ],
                     ),
-                    func=lambda b: b is True,
+                    detects_violation=lambda b: b is not True,
                 ),
                 NumberRule(
                     rule_type="number",
@@ -984,7 +1038,7 @@ class TestDeterministicGuardrailsService:
                             FieldReference(path="status", source=FieldSource.OUTPUT)
                         ],
                     ),
-                    func=lambda n: n == 200.0,
+                    detects_violation=lambda n: n != 200.0,
                 ),
             ],
         )
@@ -1009,7 +1063,7 @@ class TestDeterministicGuardrailsService:
                         selector_type="specific",
                         fields=[FieldReference(path="age", source=FieldSource.INPUT)],
                     ),
-                    func=lambda n: n >= 21.0,
+                    detects_violation=lambda n: n < 21.0,
                 ),
                 BooleanRule(
                     rule_type="boolean",
@@ -1019,7 +1073,7 @@ class TestDeterministicGuardrailsService:
                             FieldReference(path="isActive", source=FieldSource.INPUT)
                         ],
                     ),
-                    func=lambda b: b is True,
+                    detects_violation=lambda b: b is not True,
                 ),
                 NumberRule(
                     rule_type="number",
@@ -1029,7 +1083,7 @@ class TestDeterministicGuardrailsService:
                             FieldReference(path="status", source=FieldSource.OUTPUT)
                         ],
                     ),
-                    func=lambda n: n == 200.0,
+                    detects_violation=lambda n: n != 200.0,
                 ),
             ],
         )

{uipath_core-0.1.2 → uipath_core-0.1.4}/uv.lock

@@ -991,7 +991,7 @@ wheels = [
 
 [[package]]
 name = "uipath-core"
-version = "0.1.2"
+version = "0.1.4"
 source = { editable = "." }
 dependencies = [
     { name = "opentelemetry-instrumentation" },