OpenAI Guardrails: A framework for building safe and reliable AI systems.
Project description
OpenAI Guardrails: Python (Preview)
This is the Python version of OpenAI Guardrails, a package for adding configurable safety and compliance guardrails to LLM applications. It provides a drop-in wrapper for OpenAI's Python client, enabling automatic input/output validation and moderation using a wide range of guardrails.
Most users can simply follow the guided configuration and installation instructions at guardrails.openai.com.
Installation
You can download openai-guardrails package this way:
pip install openai-guardrails
Usage
Follow the configuration and installation instructions at guardrails.openai.com.
Local Development
Clone the repository and install locally:
# Clone the repository
git clone https://github.com/openai/openai-guardrails-python.git
cd openai-guardrails-python
# Install the package (editable), plus example extras if desired
pip install -e .
pip install -e ".[examples]"
Integration Details
Drop-in OpenAI Replacement
The easiest way to use Guardrails Python is as a drop-in replacement for the OpenAI client:
from pathlib import Path
from guardrails import GuardrailsOpenAI, GuardrailTripwireTriggered
# Use GuardrailsOpenAI instead of OpenAI
client = GuardrailsOpenAI(config=Path("guardrail_config.json"))
try:
# Works with standard Chat Completions
chat = client.chat.completions.create(
model="gpt-5",
messages=[{"role": "user", "content": "Hello world"}],
)
print(chat.llm_response.choices[0].message.content)
# Or with the Responses API
resp = client.responses.create(
model="gpt-5",
input="What are the main features of your premium plan?",
)
print(resp.llm_response.output_text)
except GuardrailTripwireTriggered as e:
print(f"Guardrail triggered: {e}")
Agents SDK Integration
You can integrate guardrails with the OpenAI Agents SDK via GuardrailAgent
:
import asyncio
from pathlib import Path
from agents import InputGuardrailTripwireTriggered, OutputGuardrailTripwireTriggered, Runner
from agents.run import RunConfig
from guardrails import GuardrailAgent
# Create agent with guardrails automatically configured
agent = GuardrailAgent(
config=Path("guardrails_config.json"),
name="Customer support agent",
instructions="You are a customer support agent. You help customers with their questions.",
)
async def main():
try:
result = await Runner.run(agent, "Hello, can you help me?", run_config=RunConfig(tracing_disabled=True))
print(result.final_output)
except (InputGuardrailTripwireTriggered, OutputGuardrailTripwireTriggered):
print("🛑 Guardrail triggered!")
if __name__ == "__main__":
asyncio.run(main())
For more details, see
docs/agents_sdk_integration.md
.
Evaluation Framework
Evaluate guardrail performance on labeled datasets and run benchmarks.
Running Evaluations
# Basic evaluation
python -m guardrails.evals.guardrail_evals \
--config-path guardrails_config.json \
--dataset-path data.jsonl
# Benchmark mode (compare models, generate ROC curves, latency)
python -m guardrails.evals.guardrail_evals \
--config-path guardrails_config.json \
--dataset-path data.jsonl \
--mode benchmark \
--models gpt-5 gpt-5-mini gpt-4.1-mini
Dataset Format
Datasets must be in JSONL format, with each line containing a JSON object:
{
"id": "sample_1",
"data": "Text or conversation to evaluate",
"expected_triggers": {
"Moderation": true,
"NSFW Text": false
}
}
Programmatic Usage
from pathlib import Path
from guardrails.evals.guardrail_evals import GuardrailEval
eval = GuardrailEval(
config_path=Path("guardrails_config.json"),
dataset_path=Path("data.jsonl"),
batch_size=32,
output_dir=Path("results"),
)
import asyncio
asyncio.run(eval.run())
Project Structure
src/guardrails/
- Python source codesrc/guardrails/checks/
- Built-in guardrail checkssrc/guardrails/evals/
- Evaluation frameworkexamples/
- Example usage and sample configs
Examples
The package includes examples in the examples/
directory:
examples/basic/hello_world.py
— Basic chatbot with guardrails usingGuardrailsOpenAI
examples/basic/agents_sdk.py
— Agents SDK integration withGuardrailAgent
examples/basic/local_model.py
— Using local models with guardrailsexamples/basic/structured_outputs_example.py
— Structured outputsexamples/basic/pii_mask_example.py
— PII maskingexamples/basic/suppress_tripwire.py
— Handling violations gracefully
Running Examples
Prerequisites
pip install -e .
pip install "openai-guardrails[examples]"
Run
python examples/basic/hello_world.py
python examples/basic/agents_sdk.py
Available Guardrails
The Python implementation includes the following built-in guardrails:
- Moderation: Content moderation using OpenAI's moderation API
- URL Filter: URL filtering and domain allowlist/blocklist
- Contains PII: Personally Identifiable Information detection
- Hallucination Detection: Detects hallucinated content using vector stores
- Jailbreak: Detects jailbreak attempts
- NSFW Text: Detects workplace-inappropriate content in model outputs
- Off Topic Prompts: Ensures responses stay within business scope
- Custom Prompt Check: Custom LLM-based guardrails
For full details, advanced usage, and API reference, see: OpenAI Guardrails Documentation.
License
MIT License - see LICENSE file for details.
Disclaimers
Please note that Guardrails may use Third-Party Services such as the Presidio open-source framework, which are subject to their own terms and conditions and are not developed or verified by OpenAI.
Developers are responsible for implementing appropriate safeguards to prevent storage or misuse of sensitive or prohibited content (including but not limited to personal data, child sexual abuse material, or other illegal content). OpenAI disclaims liability for any logging or retention of such content by developers. Developers must ensure their systems comply with all applicable data protection and content safety laws, and should avoid persisting any blocked content generated or intercepted by Guardrails. Guardrails calls paid OpenAI APIs, and developers are responsible for associated charges.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file openai_guardrails-0.1.1.tar.gz
.
File metadata
- Download URL: openai_guardrails-0.1.1.tar.gz
- Upload date:
- Size: 2.5 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.9.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
2c63df4078a333184393e3626357901251b5618a020e439d07caf5bddd8daae3
|
|
MD5 |
9dd8f859eef8dd30397fa7ea54ae141b
|
|
BLAKE2b-256 |
00218cdba56eae9e65eb3eefbeaf495d79e4775731270f131fcd07eda2fdf6a4
|
File details
Details for the file openai_guardrails-0.1.1-py3-none-any.whl
.
File metadata
- Download URL: openai_guardrails-0.1.1-py3-none-any.whl
- Upload date:
- Size: 130.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.9.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
18eac0591146db1204479cb98a8252c05c4f51dc15c4a6a01ec4309ee17db0f5
|
|
MD5 |
7270203d2974f11d3d21816110e91f9d
|
|
BLAKE2b-256 |
b29fd243ab6fe167e2a9682b1b9e73cb1e8f836ecfd45eeaede00659a0051575
|