You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/getting_started/quickstart.md
+25-8Lines changed: 25 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,23 +16,40 @@ First, install Guardrails for your desired language:
16
16
pip install guardrails-ai
17
17
```
18
18
19
+
### Generate an API Key (required)
20
+
Next, get a free API key from [Guardrails Hub](https://hub.guardrailsai.com/keys). Copy and keep track of this API key because you'll use it in the next step to configure the CLI.
21
+
19
22
### Configure the Guardrails CLI (required)
20
23
21
-
First, get a free auth key from [Guardrails Hub](https://hub.guardrailsai.com/keys). Then, configure the Guardrails CLI with the auth key.
24
+
Configure the Guardrails CLI with the command:
22
25
23
26
```bash
24
27
guardrails configure
25
28
```
26
29
27
-
## Usage
30
+
The configuration process will ask you three questions:
31
+
32
+
1. Whether you want to enable metrics reporting.
33
+
2. Whether you want to use our hosted remote inference endpoints for validators that utilize large ML models.
34
+
3. To enter the API key you generated in the previous step. This is required in order to install validators in the next step.
28
35
29
-
1. Install a guardrail from [Guardrails Hub](https://hub.guardrailsai.com).
30
36
37
+
### Install a Validator from the Guardrails Hub
38
+
In order to perform any validation on LLM output with Guardrails, you will need to install an appropriate validator for your use case from the [Guardrails Hub](https://hub.guardrailsai.com). Each validator has a unique and identifying Hub URI that can be used in the Guardrails CLI to install it into your current environment. You can find the exact install command for a validator on it's details page in the [Guardrails Hub](https://hub.guardrailsai.com). For example, the [Detect PII](https://hub.guardrailsai.com/validator/guardrails/detect_pii) validator can be installed via:
0 commit comments