docs playground
This commit is contained in:
parent
8c1dd78c13
commit
c088483da9
46
docs/my-website/docs/proxy/guardrails/test_playground.md
Normal file
46
docs/my-website/docs/proxy/guardrails/test_playground.md
Normal file
@ -0,0 +1,46 @@
|
||||
import Image from '@theme/IdealImage';
|
||||
|
||||
# Guardrail Testing Playground
|
||||
|
||||
Test and compare multiple guardrails in real-time with an interactive playground interface.
|
||||
|
||||
<Image img={require('../../../img/guardrail_playground.png')} alt="Guardrail Test Playground" />
|
||||
|
||||
## How to Use the Guardrail Testing Playground
|
||||
|
||||
The Guardrail Testing Playground allows you to quickly test and compare the behavior of different guardrails with sample inputs.
|
||||
|
||||
### Steps to Test Guardrails
|
||||
|
||||
1. **Navigate to the Guardrails Section**
|
||||
- Open the LiteLLM Admin UI
|
||||
- Go to the **Guardrails** section
|
||||
|
||||
2. **Open Test Playground**
|
||||
- Click on the **Test Playground** tab at the top of the page
|
||||
|
||||
3. **Select Guardrails to Test**
|
||||
- Check the guardrails you want to compare
|
||||
- You can select multiple guardrails to see how they each respond to the same input
|
||||
|
||||
4. **Enter Your Input**
|
||||
- Type or paste your test input in the text area
|
||||
- This could be a prompt, message, or any text you want to validate against the guardrails
|
||||
|
||||
5. **Run the Test**
|
||||
- Click the **Test guardrails** button (or press Enter)
|
||||
|
||||
6. **View Results**
|
||||
- See the output from each selected guardrail
|
||||
- Compare how different guardrails handle the same input
|
||||
- Results will show whether the input passed or was blocked by each guardrail
|
||||
|
||||
## Use Cases
|
||||
|
||||
This is ideal for **Security Teams** & **LiteLLM Admins** evaluating guardrail solutions.
|
||||
|
||||
This brings the following benefits for LiteLLM users:
|
||||
|
||||
- **Compare guardrail responses**: test the same prompt across multiple providers (Lakera, Noma AI, Bedrock Guardrails, etc.) simultaneously.
|
||||
|
||||
- **Validate configurations**: verify your guardrails catch the threats you care about before production deployment.
|
||||
BIN
docs/my-website/img/guardrail_playground.png
Normal file
BIN
docs/my-website/img/guardrail_playground.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 603 KiB |
@ -31,6 +31,7 @@ const sidebars = {
|
||||
label: "Guardrails",
|
||||
items: [
|
||||
"proxy/guardrails/quick_start",
|
||||
"proxy/guardrails/test_playground",
|
||||
...[
|
||||
"adding_provider/adding_guardrail_support",
|
||||
"proxy/guardrails/aim_security",
|
||||
|
||||
Loading…
Reference in New Issue
Block a user