|
1 | 1 | # Examples
|
2 | 2 |
|
3 |
| -Ready-to-run examples demonstrating Guardrails in various scenarios. See the [`guardrails/examples/`](https://github.com/OpenAI-Early-Access/guardrails/tree/main/guardrails/examples/) folder for complete implementations. |
| 3 | +Ready-to-run examples demonstrating Guardrails in various scenarios. See the [`guardrails/examples/`](https://github.com/openai/openai-guardrails-python/tree/main/examples/) folder for complete implementations. |
4 | 4 |
|
5 | 5 | ## Example Implementations
|
6 | 6 |
|
7 |
| -- [hello_world.py](https://github.com/OpenAI-Early-Access/guardrails/tree/main/guardrails/examples/basic/hello_world.py) — Basic pipeline configuration with input/output guardrails |
8 |
| -- [agents_sdk.py](https://github.com/OpenAI-Early-Access/guardrails/tree/main/guardrails/examples/basic/agents_sdk.py) — Integration with OpenAI Agents SDK |
9 |
| -- [pii_mask_example.py](https://github.com/OpenAI-Early-Access/guardrails/tree/main/guardrails/examples/basic/pii_mask_example.py) — PII detection and scrubbing |
10 |
| -- [structured_outputs_example.py](https://github.com/OpenAI-Early-Access/guardrails/tree/main/guardrails/examples/basic/structured_outputs_example.py) — Using responses.parse with guardrails |
11 |
| -- [Streaming](https://github.com/OpenAI-Early-Access/guardrails/tree/main/guardrails/examples/implementation_code/streaming) — Stream output while guardrails run |
12 |
| -- [Synchronous](https://github.com/OpenAI-Early-Access/guardrails/tree/main/guardrails/examples/implementation_code/synchronous) — Validate fully before showing output |
| 7 | +- [hello_world.py](https://github.com/openai/openai-guardrails-python/tree/main/examples/basic/hello_world.py) — Basic pipeline configuration with input/output guardrails |
| 8 | +- [agents_sdk.py](https://github.com/openai/openai-guardrails-python/tree/main/examples/basic/agents_sdk.py) — Integration with OpenAI Agents SDK |
| 9 | +- [pii_mask_example.py](https://github.com/openai/openai-guardrails-python/tree/main/examples/basic/pii_mask_example.py) — PII detection and scrubbing |
| 10 | +- [structured_outputs_example.py](https://github.com/openai/openai-guardrails-python/tree/main/examples/basic/structured_outputs_example.py) — Using responses.parse with guardrails |
| 11 | +- [Streaming](https://github.com/openai/openai-guardrails-python/tree/main/examples/implementation_code/streaming) — Stream output while guardrails run |
| 12 | +- [Synchronous](https://github.com/openai/openai-guardrails-python/tree/main/examples/implementation_code/synchronous) — Validate fully before showing output |
13 | 13 |
|
14 | 14 | ## Hallucination Detection Example
|
15 | 15 |
|
16 | 16 | Complete implementation using real documents as knowledge sources:
|
17 |
| -[`examples/hallucination_detection/`](https://github.com/OpenAI-Early-Access/guardrails/tree/main/guardrails/examples/hallucination_detection) |
| 17 | +[`examples/hallucination_detection/`](https://github.com/openai/openai-guardrails-python/tree/main/examples/hallucination_detection) |
18 | 18 |
|
19 | 19 | ## Getting Started
|
20 | 20 |
|
21 | 21 | 1. Follow the Quickstart guide: [Python](./quickstart.md)
|
22 |
| -2. Explore repositories: [Python examples](https://github.com/OpenAI-Early-Access/guardrails/tree/main/guardrails/examples/) |
| 22 | +2. Explore repositories: [Python examples](https://github.com/openai/openai-guardrails-python/tree/main/examples/) |
23 | 23 | 3. Run scripts to see Guardrails in action
|
24 | 24 |
|
25 | 25 | Each example is self-contained with clear configuration and usage patterns.
|
0 commit comments