Skip to content

Commit 249bb56

Browse files
authored
add examples section to docs (openai#242)
Have gotten feedback that Examples are somewhat buried in the Github docs. Adding new page after quickstart.
2 parents 82754c7 + 4dd3e21 commit 249bb56

File tree

2 files changed

+34
-0
lines changed

2 files changed

+34
-0
lines changed

docs/examples.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Examples
2+
3+
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.
4+
5+
6+
## Categories
7+
8+
- **agent_patterns**
9+
Examples in this category illustrate common agent design patterns, such as:
10+
- Deterministic workflows
11+
- Agents as tools
12+
- Parallel agent execution
13+
14+
- **basic**
15+
These examples showcase foundational capabilities of the SDK, such as:
16+
- Dynamic system prompts
17+
- Streaming outputs
18+
- Lifecycle events
19+
20+
- **tool examples**
21+
Learn how to implement OAI hosted tools such as web search and file search,
22+
and integrate them into your agents.
23+
24+
- **model providers**
25+
Explore how to use non-OpenAI models with the SDK.
26+
27+
- **handoffs**
28+
See practical examples of agent handoffs.
29+
30+
- **customer_service & research_bot**
31+
Two more built-out examples that illustrate real-world applications:
32+
- **customer_service**: Example customer service system for an airline.
33+
- **research_bot**: Simple deep research clone.

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ theme:
2121
nav:
2222
- Intro: index.md
2323
- Quickstart: quickstart.md
24+
- Examples: examples.md
2425
- Documentation:
2526
- agents.md
2627
- running_agents.md

0 commit comments

Comments
 (0)