Integrating AutoAlign's guardrail library with NeMo Guardrails

docs/user_guides/guardrails-library.md

@@ -717,6 +717,28 @@ define flow
   bot provide report answer
 ```
 
+
+### AutoAlign
+
+NeMo Guardrails provides an interface for using the AutoAlign's guardrails
+(you need to have the `AUTOALIGN_API_KEY` environment variable set).
+
+
+Following is the list of guardrails that are currently supported:
+1. Gender bias Detection
+2. Harm Detection
+3. Jailbreak Detection
+4. Confidential Detection
+5. Intellectual property detection
+6. Racial bias Detection
+7. Tonal Detection
+8. Toxicity detection
+9. PII
+10. Factcheck
+
+More details regarding the configuration and usage of these can be found [here](../../nemoguardrails/library/autoalign/README.md).
+
+
 ## Other
 
 ### Jailbreak Detection Heuristics

examples/configs/autoalign/README.md

@@ -0,0 +1,10 @@
+# AutoAlign
+
+This example showcases the use of AutoAlign guardrails.
+
+The structure of the config folders is the following:
+- `autoalign_config` - example configuration folder for all guardrails (except factcheck)
+  - `config.yml` - The config file holding all the configuration options.
+- `autoalign_factcheck_config` - example configuration folder for AutoAlign's factcheck
+  - `kb` - The folder containing documents that form the knowledge base.
+  - `config.yml` - The config file holding all the configuration options.

examples/configs/autoalign/autoalign_config/config.yml

@@ -0,0 +1,73 @@
+models:
+  - type: main
+    engine: openai
+    model: gpt-3.5-turbo
+    parameters:
+      temperature: 0.0
+rails:
+    config:
+        autoalign:
+            parameters:
+                endpoint: "https://<AUTOALIGN_ENDPOINT>/guardrail"
+            input:
+                guardrails_config:
+                    {
+                      "pii_fast": {
+                          "enabled_types": [
+                              "[BANK ACCOUNT NUMBER]",
+                              "[CREDIT CARD NUMBER]",
+                              "[DATE OF BIRTH]",
+                              "[DRIVER LICENSE NUMBER]",
+                              "[EMAIL ADDRESS]",
+                              "[IP ADDRESS]",
+                              "[ORGANIZATION]",
+                              "[PASSPORT NUMBER]",
+                              "[PASSWORD]",
+                              "[PERSON NAME]",
+                              "[PHONE NUMBER]",
+                              "[SOCIAL SECURITY NUMBER]",
+                              "[SECRET_KEY]",
+                              "[TRANSACTION_ID]"
+                          ],
+                        },
+                        "gender_bias_detection": {},
+                        "harm_detection": {},
+                        "text_toxicity_extraction": {},
+                        "racial_bias_detection": {},
+                        "jailbreak_detection": {},
+                        "intellectual_property": {}
+                    }
+            output:
+                guardrails_config:
+                  {
+                      "pii_fast": {
+                          "enabled_types": [
+                              "[BANK ACCOUNT NUMBER]",
+                              "[CREDIT CARD NUMBER]",
+                              "[DATE OF BIRTH]",
+                              "[DRIVER LICENSE NUMBER]",
+                              "[EMAIL ADDRESS]",
+                              "[IP ADDRESS]",
+                              "[ORGANIZATION]",
+                              "[PASSPORT NUMBER]",
+                              "[PASSWORD]",
+                              "[PERSON NAME]",
+                              "[PHONE NUMBER]",
+                              "[SOCIAL SECURITY NUMBER]",
+                              "[SECRET_KEY]",
+                              "[TRANSACTION_ID]"
+                          ],
+                      },
+                      "gender_bias_detection": {},
+                      "harm_detection": {},
+                      "text_toxicity_extraction": {},
+                      "racial_bias_detection": {},
+                      "jailbreak_detection": {},
+                      "intellectual_property": {}
+                  }
+    input:
+        flows:
+            - autoalign check input
+    output:
+        flows:
+            - autoalign check output

examples/configs/autoalign/autoalign_factcheck_config/config.yml

@@ -0,0 +1,12 @@
+models:
+  - type: main
+    engine: openai
+    model: gpt-3.5-turbo
+rails:
+  config:
+    autoalign:
+      parameters:
+        fact_check_endpoint: "https://<AUTOALIGN_ENDPOINT>/factcheck"
+  output:
+    flows:
+      - autoalign factcheck output

examples/configs/autoalign/autoalign_factcheck_config/kb/kb.md

@@ -0,0 +1 @@
+Pluto (minor-planet designation: 134340 Pluto) is a dwarf planet in the Kuiper belt, a ring of bodies beyond the orbit of Neptune. It is the ninth-largest and tenth-most-massive known object to directly orbit the Sun. It is the largest known trans-Neptunian object by volume, by a small margin, but is slightly less massive than Eris. Like other Kuiper belt objects, Pluto is made primarily of ice and rock and is much smaller than the inner planets. Pluto has only one sixth the mass of Earth's moon, and one third its volume. Pluto was recognized as a planet until 2006. Pluto has a moderately eccentric and inclined orbit, ranging from 30 to 49 astronomical units (4.5 to 7.3 billion kilometers; 2.8 to 4.6 billion miles) from the Sun. Light from the Sun takes 5.5 hours to reach Pluto at its orbital distance of 39.5 AU (5.91 billion km; 3.67 billion mi). Pluto's eccentric orbit periodically brings it closer to the Sun than Neptune, but a stable orbital resonance prevents them from colliding. Pluto has five known moons: Charon, the largest, whose diameter is just over half that of Pluto; Styx; Nix; Kerberos; and Hydra. Pluto and Charon are sometimes considered a binary system because the barycenter of their orbits does not lie within either body, and they are tidally locked. The New Horizons mission was the first spacecraft to visit Pluto and its moons, making a flyby on July 14, 2015 and taking detailed measurements and observations.