From 3f8f6d255a3df11a23e28a652a3f9c9b5207474d Mon Sep 17 00:00:00 2001 From: zsimjee Date: Wed, 18 Sep 2024 12:55:55 -0700 Subject: [PATCH 1/2] add auth to docs --- docs/faq.md | 16 ++++++++++++++++ docs/getting_started/guardrails_server.md | 7 +++++++ docs/getting_started/quickstart.md | 2 ++ 3 files changed, 25 insertions(+) diff --git a/docs/faq.md b/docs/faq.md index 72e5e8ff9..447576594 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -1,5 +1,21 @@ # Frequently Asked Questions +## I get an "Unauthorized" error when isntalling validators from the Guardrails hub. What should I do? + +If you see an "Unauthorized" error when installing validators from the Guardrails hub, it means that the API key you are using is not authorized to access the Guardrails hub. It may be unset or expired. + +To fix this, first generate a new API key from the [Guardrails Hub](https://hub.guardrailsai.com/keys). Then, configure the Guardrails CLI with the new API key. + +```bash +guardrails configure +``` + +There is also a headless option to configure the CLI with the token. + +```bash +guardrails configure --token +``` + ## I'm seeing a PromptCallableException when invoking my Guard. What should I do? If you see an exception that looks like this diff --git a/docs/getting_started/guardrails_server.md b/docs/getting_started/guardrails_server.md index 091fd7971..077b1dbc6 100644 --- a/docs/getting_started/guardrails_server.md +++ b/docs/getting_started/guardrails_server.md @@ -13,6 +13,13 @@ This document will overview a few of the key features of the Guardrails Server, # Walkthrough +## 0. Configure Guardrails +First, get a free auth key from [Guardrails Hub](https://hub.guardrailsai.com/keys). Then, configure the Guardrails CLI with the auth key. + +```bash +guardrails configure +``` + ## 1. Install the Guardrails Server This is done by simply installing the `guardrails-ai` package. See the [installation guide](./quickstart.md) for more information. diff --git a/docs/getting_started/quickstart.md b/docs/getting_started/quickstart.md index 4fbd3e1a3..359bb4958 100644 --- a/docs/getting_started/quickstart.md +++ b/docs/getting_started/quickstart.md @@ -17,6 +17,8 @@ pip install guardrails-ai ``` ### Configure the Guardrails CLI (required) + +First, get a free auth key from [Guardrails Hub](https://hub.guardrailsai.com/keys). Then, configure the Guardrails CLI with the auth key. ```bash guardrails configure From d13dadc00702b218469203e87e6def63ee413cf5 Mon Sep 17 00:00:00 2001 From: zsimjee Date: Wed, 18 Sep 2024 13:05:00 -0700 Subject: [PATCH 2/2] fix installation typo --- docs/faq.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/faq.md b/docs/faq.md index 447576594..53d1caef9 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -1,6 +1,6 @@ # Frequently Asked Questions -## I get an "Unauthorized" error when isntalling validators from the Guardrails hub. What should I do? +## I get an "Unauthorized" error when installing validators from the Guardrails Hub. What should I do? If you see an "Unauthorized" error when installing validators from the Guardrails hub, it means that the API key you are using is not authorized to access the Guardrails hub. It may be unset or expired.