Skip to content

Commit 4131dee

Browse files
authored
Merge pull request #589 from guardrails-ai/classic-docs-restructure
restructuring and conosolidating minus getting started
2 parents c3e16c0 + 62a1956 commit 4131dee

File tree

11 files changed

+528
-52
lines changed

11 files changed

+528
-52
lines changed
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Environment Variables
1+
# Set API Keys and other Environment Variables
22

33
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.
44

docs/how_to_guides/llm_api_wrappers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Custom LLMs
1+
# Guard Custom LLMs
22

33
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.
44

docs/how_to_guides/logs.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# Logs
1+
# Inspect Guard Run History and Logs
22

33
All `Guard` calls are logged internally, and can be accessed via the guard history.
44

5-
## 🇻🇦 Accessing logs via `Guard.history`
5+
## Accessing logs via `Guard.history`
66

77
`history` is an attribute of the `Guard` class. It implements a standard `Stack` interface with a few extra helper methods and properties. For more information on our `Stack` implementation see the [Helper Classes](/docs/api_reference_markdown/helper_classes) page.
88

docs/how_to_guides/rail.md

Lines changed: 510 additions & 4 deletions
Large diffs are not rendered by default.

docs/how_to_guides/streaming.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"cell_type": "markdown",
55
"metadata": {},
66
"source": [
7-
"# Example of using OpenAI streaming with Guardrails\n"
7+
"# Validate Streamed LLM Responses\n"
88
]
99
},
1010
{
Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,12 @@
1-
# Guard
2-
1+
# The Guard
32

43
The guard object is the main interface for GuardRails. It is seeded with a RailSpec, and then used to run the GuardRails AI engine. It is the object that accepts changing prompts, wraps LLM prompts, and keeps track of call history.
54

65

76
## How it works
87

9-
![Guardrails Logo](../img/guardrails_arch_white_vertical.png#only-light)
10-
![Guardrails Logo](../img/guardrails_arch_dark_vertical.png#only-dark)
8+
![Guardrails Logo](./img/guardrails_arch_white_vertical.png#only-light)
9+
![Guardrails Logo](./img/guardrails_arch_dark_vertical.png#only-dark)
1110

1211

1312
## Two main flows

0 commit comments

Comments
 (0)