Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions docs/faq.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,21 @@
# Frequently Asked Questions

## 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.

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 <your_token>
```

## I'm seeing a PromptCallableException when invoking my Guard. What should I do?

If you see an exception that looks like this
Expand Down
7 changes: 7 additions & 0 deletions docs/getting_started/guardrails_server.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 2 additions & 0 deletions docs/getting_started/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading