Merge pull request #1048 from guardrails-ai/get_or_create

introduces get_or_create to fetch a guard

Author: dtam

guardrails/guard.py

@@ -1383,3 +1383,25 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional["Guard"]:
         )
         guard.history = Stack(*history)
         return guard
+
+    # attempts to get a guard from the server
+    # if a name is unspecified, the guard will be created on the client
+    # in the future, this may create a guard on the server
+    @experimental
+    @staticmethod
+    def fetch_guard(
+        name: Optional[str] = None,
+        *args,
+        **kwargs,
+    ):
+        if not name:
+            raise ValueError("Name must be specified to fetch a guard")
+
+        settings.use_server = True
+        api_key = os.environ.get("GUARDRAILS_API_KEY")
+        api_client = GuardrailsApiClient(api_key=api_key)
+        guard = api_client.fetch_guard(name)
+        if guard:
+            return Guard(name=name, *args, **kwargs)
+
+        raise ValueError(f"Guard with name {name} not found")

guardrails/hub/install.py

@@ -37,8 +37,7 @@ def install(
     quiet: bool = True,
     install_local_models_confirm: Callable = default_local_models_confirm,
 ) -> ValidatorModuleType:
-    """
-    Install a validator package from a hub URI.
+    """Install a validator package from a hub URI.
 
     Args:
         package_uri (str): The URI of the package to install.

tests/integration_tests/test_assets/validators/detect_pii.py

@@ -60,11 +60,10 @@ class MockDetectPII(Validator):
     }
 
     def chunking_function(self, chunk: str):
-        """
-        Use a sentence tokenizer to split the chunk into sentences.
+        """Use a sentence tokenizer to split the chunk into sentences.
 
-        Because using the tokenizer is expensive, we only use it if there
-        is a period present in the chunk.
+        Because using the tokenizer is expensive, we only use it if
+        there is a period present in the chunk.
         """
         # using the sentence tokenizer is expensive
         # we check for a . to avoid wastefully calling the tokenizer