Merge pull request #1 from guardrails-ai/fix-api-ref

Fix API Reference
guardrails-ai · Apr 4, 2024 · 16e7b30 · 16e7b30
2 parents 7ad69a9 + e619e05
commit 16e7b30
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 3 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,5 @@
 .python-version
 __pycache__/
 build
-*.egg-info
+*.egg-info
+.venv
diff --git a/README.md b/README.md
@@ -88,7 +88,7 @@ Initializes a new instance of the Validator class.
 
 <br>
 
-**`__call__(self, value, metadata={}) → ValidationResult`**
+**`validate(self, value, metadata={}) -> ValidationResult`**
 
 <ul>
 

diff --git a/validator/main.py b/validator/main.py
@@ -36,7 +36,7 @@ def __init__(
     ):
         super().__init__(on_fail=on_fail, llm_callable=llm_callable)
 
-    def validate(self, value: Any, metadata: Dict) -> ValidationResult:
+    def validate(self, value: Any, metadata: Dict = {}) -> ValidationResult:
         """Validates that the LLM response is relevant to the given prompt."""
 
         original_prompt = metadata.get("original_prompt", None)
-Original file line number
+Diff line change
@@ Expand Up / @@ -88,7 +88,7 @@ Initializes a new instance of the Validator class. @@
     <br>
-    **`__call__(self, value, metadata={}) → ValidationResult`**
+    **`validate(self, value, metadata={}) -> ValidationResult`**
     <ul>
@@ Expand Down @@