fix conflicts

Author: aaravnavani

README.md

@@ -64,17 +64,23 @@ pip install guardrails-ai
 3. Create a Guard from the installed guardrail.
 
     ```python
-    # Import Guard and Validator
-    from guardrails.hub import RegexMatch
     from guardrails import Guard
+    from guardrails.hub import RegexMatch
 
-    # Initialize the Guard with 
-    val = Guard().use(
-        RegexMatch(regex="^[A-Z][a-z]*$")
+    guard = Guard().use(
+        RegexMatch, regex="\(?\d{3}\)?-? *\d{3}-? *-?\d{4}", on_fail="exception"
     )
 
-    guard.parse("Caesar")  # Guardrail Passes
-    guard.parse("Caesar is a great leader")  # Guardrail Fails
+    guard.validate("123-456-7890")  # Guardrail passes
+
+    try:
+        guard.validate("1234-789-0000")  # Guardrail fails
+    except Exception as e:
+        print(e)
+    ```
+    Output:
+    ```console
+    Validation failed for field with errors: Result must match \(?\d{3}\)?-? *\d{3}-? *-?\d{4}
     ```
 4. Run multiple guardrails within a Guard.
     First, install the necessary guardrails from Guardrails Hub.
@@ -87,18 +93,32 @@ pip install guardrails-ai
     Then, create a Guard from the installed guardrails.
 
     ```python
-    from guardrails.hub import RegexMatch, ValidLength
     from guardrails import Guard
+    from guardrails.hub import CompetitorCheck, ToxicLanguage
 
-    guard = Guard().use(
-        RegexMatch(regex="^[A-Z][a-z]*$"),
-        ValidLength(min=1, max=32)
+    guard = Guard().use_many(
+        CompetitorCheck(["Apple", "Microsoft", "Google"], on_fail="exception"),
+        ToxicLanguage(threshold=0.5, validation_method="sentence", on_fail="exception"),
     )
 
-    guard.parse("Caesar")  # Guardrail Passes
-    guard.parse("Caesar is a great leader")  # Guardrail Fails
+    guard.validate(
+        """An apple a day keeps a doctor away.
+        This is good advice for keeping your health."""
+    )  # Both the guardrails pass
+
+    try:
+        guard.validate(
+            """Shut the hell up! Apple just released a new iPhone."""
+        )  # Both the guardrails fail
+    except Exception as e:
+        print(e)
     ```
+    Output:
+    ```console
+    Validation failed for field with errors: Found the following competitors: [['Apple']]. Please avoid naming those competitors next time, The following sentences in your response were found to be toxic:
 
+    - Shut the hell up!
+    ```
 
 ### Use Guardrails to generate structured data from LLMs
 
@@ -133,7 +153,7 @@ validated_output, *rest = guard(
     engine="gpt-3.5-turbo-instruct"
 )
 
-print(f"{validated_output}")
+print(validated_output)
 ```
 
 This prints: 

docs/examples/generate_structured_data_cohere.ipynb

@@ -165,7 +165,7 @@ Validates whether the generated code snippet contains any secrets.
     ```py
 
     guard = Guard.from_string(validators=[
-        DetectSecrets(on_fail="fix")
+      DetectSecrets(on_fail=OnFailAction.FIX)
     ])
     guard.parse(
         llm_output=code_snippet,

docs/how_to_guides/streaming.ipynb

@@ -134,10 +134,10 @@ guard = Guard.from_string(
     validators=[
         ValidLength(
             min=48,
-            on_fail="fix"
+            on_fail=OnFailAction.FIX
         ),
         ToxicLanguage(
-            on_fail="fix"
+            on_fail=OnFailAction.FIX
         )
     ],
     prompt=prompt
@@ -179,10 +179,10 @@ guard = Guard.from_string(
     validators=[
         ValidLength(
             min=48,
-            on_fail="fix"
+            on_fail=OnFailAction.FIX
         ),
         ToxicLanguage(
-            on_fail="fix"
+            on_fail=OnFailAction.FIX
         )
     ],
     prompt=prompt

docs/hub/api_reference_markdown/validators.md

@@ -1,4 +1,3 @@
-import json
 import os
 import subprocess
 import sys
@@ -34,7 +33,7 @@ def pip_process(
     package: str = "",
     flags: List[str] = [],
     format: Union[Literal["string"], Literal["json"]] = string_format,
-):
+) -> Union[str, dict]:
     try:
         logger.debug(f"running pip {action} {' '.join(flags)} {package}")
         command = [sys.executable, "-m", "pip", action]
@@ -44,7 +43,11 @@ def pip_process(
         output = subprocess.check_output(command)
         logger.debug(f"decoding output from pip {action} {package}")
         if format == json_format:
-            return BytesHeaderParser().parsebytes(output)
+            parsed = BytesHeaderParser().parsebytes(output)
+            accumulator = {}
+            for key, value in parsed.items():
+                accumulator[key] = value
+            return accumulator
         return str(output.decode())
     except subprocess.CalledProcessError as exc:
         logger.error(
@@ -197,9 +200,14 @@ def install_hub_module(module_manifest: ModuleManifest, site_packages: str):
     inspect_output = pip_process(
         "inspect", flags=[f"--path={install_directory}"], format=json_format
     )
-    inspection: dict = json.loads(str(inspect_output))
+
+    # throw if inspect_output is a string. Mostly for pyright
+    if isinstance(inspect_output, str):
+        logger.error("Failed to inspect the installed package!")
+        sys.exit(1)
+
     dependencies = (
-        Stack(*inspection.get("installed", []))
+        Stack(*inspect_output.get("installed", []))
         .at(0, {})
         .get("metadata", {})  # type: ignore
         .get("requires_dist", [])  # type: ignore

docs/llm_api_wrappers.md

@@ -467,7 +467,7 @@ def __call__(
         stream: Optional[bool] = False,
         *args,
         **kwargs,
-    ) -> Union[ValidationOutcome[OT], Iterable[str]]:
+    ) -> Union[ValidationOutcome[OT], Iterable[ValidationOutcome[OT]]]:
         ...
 
     @overload
@@ -499,7 +499,8 @@ def __call__(
         *args,
         **kwargs,
     ) -> Union[
-        Union[ValidationOutcome[OT], Iterable[str]], Awaitable[ValidationOutcome[OT]]
+        Union[ValidationOutcome[OT], Iterable[ValidationOutcome[OT]]],
+        Awaitable[ValidationOutcome[OT]],
     ]:
         """Call the LLM and validate the output. Pass an async LLM API to
         return a coroutine.
@@ -663,7 +664,7 @@ def _call_sync(
         call_log: Call,
         *args,
         **kwargs,
-    ) -> Union[ValidationOutcome[OT], Iterable[str]]:
+    ) -> Union[ValidationOutcome[OT], Iterable[ValidationOutcome[OT]]]:
         instructions_obj = instructions or self.instructions
         prompt_obj = prompt or self.prompt
         msg_history_obj = msg_history or []

guardrails/cli/hub/install.py

@@ -280,6 +280,25 @@ def _invoke_llm(
         if "instructions" in kwargs:
             prompt = kwargs.pop("instructions") + "\n\n" + prompt
 
+        def is_base_cohere_chat(func):
+            try:
+                return (
+                    func.__closure__[1].cell_contents.__func__.__qualname__
+                    == "BaseCohere.chat"
+                )
+            except (AttributeError, IndexError):
+                return False
+
+        # TODO: When cohere totally gets rid of `generate`,
+        #       remove this cond and the final return
+        if is_base_cohere_chat(client_callable):
+            cohere_response = client_callable(
+                message=prompt, model=model, *args, **kwargs
+            )
+            return LLMResponse(
+                output=cohere_response.text,
+            )
+
         cohere_response = client_callable(prompt=prompt, model=model, *args, **kwargs)
         return LLMResponse(
             output=cohere_response[0].text,
@@ -562,7 +581,7 @@ def get_llm_ask(llm_api: Callable, *args, **kwargs) -> PromptCallableBase:
         if (
             isinstance(getattr(llm_api, "__self__", None), cohere.Client)
             and getattr(llm_api, "__name__", None) == "generate"
-        ):
+        ) or getattr(llm_api, "__module__", None) == "cohere.client":
             return CohereCallable(*args, client_callable=llm_api, **kwargs)
     except ImportError:
         pass