Merge pull request #568 from guardrails-ai/lcel-support

Initial LCEL Support

docs/api_reference/response_structures.md

@@ -6,4 +6,4 @@
             - "ValidationResult"
             - "PassResult"
             - "FailResult"
-            - "ValidatorError"
+            - "ValidationError"

docs/examples/input_validation.ipynb

@@ -47,7 +47,7 @@
    "source": [
     "When `fix` is specified as the on-fail handler, the prompt will automatically be amended before calling the LLM.\n",
     "\n",
-    "In any other case (for example, `exception`), a `ValidatorError` will be returned in the outcome."
+    "In any other case (for example, `exception`), a `ValidationError` will be returned in the outcome."
    ]
   },
   {
@@ -67,13 +67,13 @@
    ],
    "source": [
     "import openai\n",
-    "from guardrails.errors import ValidatorError\n",
+    "from guardrails.errors import ValidationError\n",
     "\n",
     "try:\n",
     "    guard(\n",
     "        openai.chat.completions.create,\n",
     "    )\n",
-    "except ValidatorError as e:\n",
+    "except ValidationError as e:\n",
     "    print(e)"
    ]
   },
@@ -115,7 +115,7 @@
     "        openai.chat.completions.create,\n",
     "        prompt=\"This is not two words\",\n",
     "    )\n",
-    "except ValidatorError as e:\n",
+    "except ValidationError as e:\n",
     "    print(e)"
    ]
   }
@@ -136,7 +136,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.11.6"
+   "version": "3.11.7"
   }
  },
  "nbformat": 4,

docs/examples/response_is_on_topic.ipynb

@@ -137,7 +137,7 @@
    "source": [
     "import guardrails as gd\n",
     "from guardrails.validators import OnTopic\n",
-    "from guardrails.errors import ValidatorError\n",
+    "from guardrails.errors import ValidationError\n",
     "\n",
     "# Create the Guard with the OnTopic Validator\n",
     "guard = gd.Guard.from_string(\n",
@@ -159,7 +159,7 @@
     "    guard.parse(\n",
     "        llm_output=text,\n",
     "    )\n",
-    "except ValidatorError as e:\n",
+    "except ValidationError as e:\n",
     "    print(e)\n"
    ]
   },
@@ -205,7 +205,7 @@
     "    guard.parse(\n",
     "        llm_output=text,\n",
     "    )\n",
-    "except ValidatorError as e:\n",
+    "except ValidationError as e:\n",
     "    print(e)"
    ]
   },
@@ -258,7 +258,7 @@
     "    guard.parse(\n",
     "        llm_output=text,\n",
     "    )\n",
-    "except ValidatorError as e:\n",
+    "except ValidationError as e:\n",
     "    print(e)"
    ]
   }
@@ -279,7 +279,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.11.6"
+   "version": "3.11.7"
   }
  },
  "nbformat": 4,

guardrails/errors/__init__.py

@@ -1,3 +1,18 @@
-from guardrails.validator_base import ValidatorError
+# Never actually used in any validators so the description is misleading.
+# The naming is confusing so we're updating it.
+class ValidatorError(Exception):
+    """
+    deprecated: 0.3.3
+    Use :class:`ValidationError` instead.
 
-__all__ = ["ValidatorError"]
+    Base class for all validator errors.
+    """
+
+
+# Open to naming this something more generic like GuardrailsError or something,
+# let's just decide in this PR
+class ValidationError(Exception):
+    """Top level validation error."""
+
+
+__all__ = ["ValidatorError", "ValidationError"]

guardrails/functional/chain/__init__.py

@@ -0,0 +1,3 @@
+from guardrails.functional.chain.guard import Guard
+
+__all__ = ["Guard"]

guardrails/functional/chain/guard.py

@@ -0,0 +1,43 @@
+import json
+from copy import deepcopy
+from typing import Dict, Optional, TypeVar, cast
+
+from langchain_core.messages import BaseMessage
+from langchain_core.runnables import Runnable, RunnableConfig
+
+from guardrails.errors import ValidationError
+from guardrails.functional.guard import Guard as FGuard
+
+T = TypeVar("T", str, BaseMessage)
+
+
+class Guard(FGuard, Runnable):
+    def invoke(self, input: T, config: Optional[RunnableConfig] = None) -> T:
+        output = BaseMessage(content="", type="")
+        str_input = None
+        input_is_chat_message = False
+        if isinstance(input, BaseMessage):
+            input_is_chat_message = True
+            str_input = str(input.content)
+            output = deepcopy(input)
+        else:
+            str_input = str(input)
+
+        response = self.validate(str_input)
+
+        validated_output = response.validated_output
+        if not validated_output:
+            raise ValidationError(
+                (
+                    "The response from the LLM failed validation!"
+                    "See `guard.history` for more details."
+                )
+            )
+
+        if isinstance(validated_output, Dict):
+            validated_output = json.dumps(validated_output)
+
+        if input_is_chat_message:
+            output.content = validated_output
+            return cast(T, output)
+        return cast(T, validated_output)

guardrails/run.py

@@ -7,6 +7,7 @@
 
 from guardrails.classes.history import Call, Inputs, Iteration, Outputs
 from guardrails.datatypes import verify_metadata_requirements
+from guardrails.errors import ValidationError
 from guardrails.llm_providers import (
     AsyncPromptCallableBase,
     OpenAICallable,
@@ -25,7 +26,6 @@
     SkeletonReAsk,
     reasks_to_dict,
 )
-from guardrails.validator_base import ValidatorError
 
 add_destinations(logger.debug)
 
@@ -332,11 +332,11 @@ def validate_msg_history(
         )
         iteration.outputs.validation_output = validated_msg_history
         if isinstance(validated_msg_history, ReAsk):
-            raise ValidatorError(
+            raise ValidationError(
                 f"Message history validation failed: " f"{validated_msg_history}"
             )
         if validated_msg_history != msg_str:
-            raise ValidatorError("Message history validation failed")
+            raise ValidationError("Message history validation failed")
 
     def prepare_msg_history(
         self,
@@ -372,9 +372,9 @@ def validate_prompt(
         )
         iteration.outputs.validation_output = validated_prompt
         if validated_prompt is None:
-            raise ValidatorError("Prompt validation failed")
+            raise ValidationError("Prompt validation failed")
         if isinstance(validated_prompt, ReAsk):
-            raise ValidatorError(f"Prompt validation failed: {validated_prompt}")
+            raise ValidationError(f"Prompt validation failed: {validated_prompt}")
         return Prompt(validated_prompt)
 
     def validate_instructions(
@@ -393,9 +393,9 @@ def validate_instructions(
         )
         iteration.outputs.validation_output = validated_instructions
         if validated_instructions is None:
-            raise ValidatorError("Instructions validation failed")
+            raise ValidationError("Instructions validation failed")
         if isinstance(validated_instructions, ReAsk):
-            raise ValidatorError(
+            raise ValidationError(
                 f"Instructions validation failed: {validated_instructions}"
             )
         return Instructions(validated_instructions)
@@ -1020,12 +1020,12 @@ async def async_prepare(
                         iteration, msg_str, self.metadata
                     )
                     if isinstance(validated_msg_history, ReAsk):
-                        raise ValidatorError(
+                        raise ValidationError(
                             f"Message history validation failed: "
                             f"{validated_msg_history}"
                         )
                     if validated_msg_history != msg_str:
-                        raise ValidatorError("Message history validation failed")
+                        raise ValidationError("Message history validation failed")
             elif prompt is not None:
                 if isinstance(prompt, str):
                     prompt = Prompt(prompt)
@@ -1053,9 +1053,9 @@ async def async_prepare(
                     )
                     iteration.outputs.validation_output = validated_prompt
                     if validated_prompt is None:
-                        raise ValidatorError("Prompt validation failed")
+                        raise ValidationError("Prompt validation failed")
                     if isinstance(validated_prompt, ReAsk):
-                        raise ValidatorError(
+                        raise ValidationError(
                             f"Prompt validation failed: {validated_prompt}"
                         )
                     prompt = Prompt(validated_prompt)
@@ -1072,9 +1072,9 @@ async def async_prepare(
                     )
                     iteration.outputs.validation_output = validated_instructions
                     if validated_instructions is None:
-                        raise ValidatorError("Instructions validation failed")
+                        raise ValidationError("Instructions validation failed")
                     if isinstance(validated_instructions, ReAsk):
-                        raise ValidatorError(
+                        raise ValidationError(
                             f"Instructions validation failed: {validated_instructions}"
                         )
                     instructions = Instructions(validated_instructions)

guardrails/validator_base.py

@@ -6,10 +6,6 @@
 from pydantic import BaseModel, Field
 
 
-class ValidatorError(Exception):
-    """Base class for all validator errors."""
-
-
 class Filter:
     pass
 

guardrails/validator_service.py

@@ -6,18 +6,12 @@
 
 from guardrails.classes.history import Iteration
 from guardrails.datatypes import FieldValidation
+from guardrails.errors import ValidationError
 from guardrails.logger import logger
 from guardrails.utils.logs_utils import ValidatorLogs
 from guardrails.utils.reask_utils import FieldReAsk, ReAsk
 from guardrails.utils.safe_get import safe_get
-from guardrails.validator_base import (
-    FailResult,
-    Filter,
-    PassResult,
-    Refrain,
-    Validator,
-    ValidatorError,
-)
+from guardrails.validator_base import FailResult, Filter, PassResult, Refrain, Validator
 
 
 def key_not_empty(key: str) -> bool:
@@ -57,7 +51,7 @@ def perform_correction(
                 fail_results=results,
             )
         if on_fail_descriptor == "exception":
-            raise ValidatorError(
+            raise ValidationError(
                 "Validation failed for field with errors: "
                 + ", ".join([result.error_message for result in results])
             )