Skip to content

Commit 316d4bb

Browse files
committed
more polish
1 parent 639159f commit 316d4bb

File tree

5 files changed

+21
-17
lines changed

5 files changed

+21
-17
lines changed

docs/how_to_guides/envvars.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Set API Keys and other EnvVars
22

3-
Guardrails recognize a handful of environment variables that can be used at runtime. Most of these correlate to envinronment variables used or expected by the various LLM clients. Below you can find a list of these and their uses.
3+
Guardrails recognizes a handful of environment variables that can be used at runtime. Most of these correlate to environment variables used or expected by the various LLM clients. Below you can find a list of these and their uses.
44

55
### `OPENAI_API_KEY`
66
This environment variable can be used to set your api key credentials for Open AI models. It will be used wherever Open AI is called if an api_key kwarg is not passed to `__call__` or `parse`.

docs/how_to_guides/llm_api_wrappers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import Tabs from '@theme/Tabs';
22
import TabItem from '@theme/TabItem';
33

4-
# Use Guardrails with any LLMs
4+
# Use Guardrails with any LLM
55

66
Guardrails' `Guard` wrappers provide a simple way to add Guardrails to your LLM API calls. The wrappers are designed to be used with any LLM API.
77

docs/how_to_guides/streaming.ipynb

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,10 @@
11
{
22
"cells": [
3-
{
4-
"cell_type": "code",
5-
"execution_count": null,
6-
"metadata": {},
7-
"outputs": [],
8-
"source": [
9-
"!guardrails hub install hub://guardrails/valid_range\n",
10-
"!guardrails hub install hub://guardrails/uppercase\n",
11-
"!guardrails hub install hub://guardrails/lowercase\n",
12-
"!guardrails hub install hub://guardrails/one_line"
13-
]
14-
},
153
{
164
"cell_type": "markdown",
175
"metadata": {},
186
"source": [
19-
"# Stream validated LLM responses in real-time\n"
7+
"# Stream-validate LLM responses\n"
208
]
219
},
2210
{
@@ -33,6 +21,22 @@
3321
"import time"
3422
]
3523
},
24+
{
25+
"cell_type": "markdown",
26+
"metadata": {},
27+
"source": [
28+
"### Setup\n",
29+
"\n",
30+
"Install the necessary validators from Guardrails hub in your CLI.\n",
31+
"\n",
32+
"```bash\n",
33+
"!guardrails hub install hub://guardrails/valid_range\n",
34+
"!guardrails hub install hub://guardrails/uppercase\n",
35+
"!guardrails hub install hub://guardrails/lowercase\n",
36+
"!guardrails hub install hub://guardrails/one_line\n",
37+
"```"
38+
]
39+
},
3640
{
3741
"cell_type": "markdown",
3842
"metadata": {},

docs/how_to_guides/structured_data_with_guardrails.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import Tabs from '@theme/Tabs';
22
import TabItem from '@theme/TabItem';
33

4-
# Generate structured data with Guardrails AI
4+
# Generate structured data
55

66
Guardrails AI is effective for generating structured data across from a variety of LLMs. This guide contains
77
the following:

docusaurus/sidebars.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ const sidebars = {
8181
{
8282
type: "category",
8383
label: "Migration Guides",
84-
collapsed: false,
84+
collapsed: true,
8585
items: [
8686
"migration_guides/0-4-migration",
8787
"migration_guides/0-3-migration",

0 commit comments

Comments
 (0)