add examples section to docs (#242)

Have gotten feedback that Examples are somewhat buried in the Github
docs. Adding new page after quickstart.
This commit is contained in:
Rohan Mehta 2025-03-19 15:42:41 -04:00 committed by GitHub
commit 249bb56c23
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 34 additions and 0 deletions

33
docs/examples.md Normal file
View file

@ -0,0 +1,33 @@
# Examples
Check out a variety of sample implementations of the SDK in the examples section of the [repo](https://github.com/openai/openai-agents-python/tree/main/examples). The examples are organized into several categories that demonstrate different patterns and capabilities.
## Categories
- **agent_patterns**
Examples in this category illustrate common agent design patterns, such as:
- Deterministic workflows
- Agents as tools
- Parallel agent execution
- **basic**
These examples showcase foundational capabilities of the SDK, such as:
- Dynamic system prompts
- Streaming outputs
- Lifecycle events
- **tool examples**
Learn how to implement OAI hosted tools such as web search and file search,
and integrate them into your agents.
- **model providers**
Explore how to use non-OpenAI models with the SDK.
- **handoffs**
See practical examples of agent handoffs.
- **customer_service & research_bot**
Two more built-out examples that illustrate real-world applications:
- **customer_service**: Example customer service system for an airline.
- **research_bot**: Simple deep research clone.

View file

@ -21,6 +21,7 @@ theme:
nav:
- Intro: index.md
- Quickstart: quickstart.md
- Examples: examples.md
- Documentation:
- agents.md
- running_agents.md