Skip to content

Commit a05229d

Browse files
committed
docs: update examples.md to match current examples directory structure
1 parent 7b2ba37 commit a05229d

File tree

1 file changed

+62
-17
lines changed

1 file changed

+62
-17
lines changed

docs/examples.md

Lines changed: 62 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -11,35 +11,80 @@ Check out a variety of sample implementations of the SDK in the examples section
1111
- Deterministic workflows
1212
- Agents as tools
1313
- Parallel agent execution
14+
- Conditional tool usage
15+
- Input/output guardrails
16+
- LLM as a judge
17+
- Routing
18+
- Streaming guardrails
1419

1520
- **[basic](https://github.com/openai/openai-agents-python/tree/main/examples/basic):**
1621
These examples showcase foundational capabilities of the SDK, such as
1722

23+
- Hello world examples (GPT-4, GPT-5, Open Source)
24+
- Agent lifecycle management
1825
- Dynamic system prompts
19-
- Streaming outputs
20-
- Lifecycle events
26+
- Streaming outputs (text, items, function call args)
27+
- Prompt templates
28+
- File handling (local and remote, images and PDFs)
29+
- Usage tracking
30+
- Non-strict output types
31+
- Previous response ID usage
2132

22-
- **[tool examples](https://github.com/openai/openai-agents-python/tree/main/examples/tools):**
23-
Learn how to implement OAI hosted tools such as web search and file search,
24-
and integrate them into your agents.
33+
- **[customer_service](https://github.com/openai/openai-agents-python/tree/main/examples/customer_service):**
34+
Example customer service system for an airline.
2535

26-
- **[model providers](https://github.com/openai/openai-agents-python/tree/main/examples/model_providers):**
27-
Explore how to use non-OpenAI models with the SDK.
36+
- **[financial_research_agent](https://github.com/openai/openai-agents-python/tree/main/examples/financial_research_agent):**
37+
A financial research agent that demonstrates structured research workflows with agents and tools for financial data analysis.
2838

2939
- **[handoffs](https://github.com/openai/openai-agents-python/tree/main/examples/handoffs):**
30-
See practical examples of agent handoffs.
40+
See practical examples of agent handoffs with message filtering.
3141

32-
- **[mcp](https://github.com/openai/openai-agents-python/tree/main/examples/mcp):**
33-
Learn how to build agents with MCP.
42+
- **[hosted_mcp](https://github.com/openai/openai-agents-python/tree/main/examples/hosted_mcp):**
43+
Examples demonstrating how to use hosted MCP (Model Context Protocol) connectors and approvals.
3444

35-
- **[customer_service](https://github.com/openai/openai-agents-python/tree/main/examples/customer_service)** and **[research_bot](https://github.com/openai/openai-agents-python/tree/main/examples/research_bot):**
36-
Two more built-out examples that illustrate real-world applications
45+
- **[mcp](https://github.com/openai/openai-agents-python/tree/main/examples/mcp):**
46+
Learn how to build agents with MCP (Model Context Protocol), including:
47+
48+
- Filesystem examples
49+
- Git examples
50+
- Prompt server
51+
- SSE (Server-Sent Events) examples
52+
- Streamable HTTP examples
3753

38-
- **customer_service**: Example customer service system for an airline.
39-
- **research_bot**: Simple deep research clone.
54+
- **[memory](https://github.com/openai/openai-agents-python/tree/main/examples/memory):**
55+
Examples of different memory implementations for agents, including:
56+
57+
- SQLite session storage
58+
- Advanced SQLite session storage
59+
- Redis session storage
60+
- SQLAlchemy session storage
61+
- Encrypted session storage
62+
- OpenAI session storage
4063

41-
- **[voice](https://github.com/openai/openai-agents-python/tree/main/examples/voice):**
42-
See examples of voice agents, using our TTS and STT models.
64+
- **[model_providers](https://github.com/openai/openai-agents-python/tree/main/examples/model_providers):**
65+
Explore how to use non-OpenAI models with the SDK, including custom providers and LiteLLM integration.
4366

4467
- **[realtime](https://github.com/openai/openai-agents-python/tree/main/examples/realtime):**
45-
Examples showing how to build realtime experiences using the SDK.
68+
Examples showing how to build real-time experiences using the SDK, including:
69+
70+
- Web-based applications
71+
- Command-line interfaces
72+
- Twilio integration
73+
74+
- **[reasoning_content](https://github.com/openai/openai-agents-python/tree/main/examples/reasoning_content):**
75+
Examples demonstrating how to work with reasoning content and structured outputs.
76+
77+
- **[research_bot](https://github.com/openai/openai-agents-python/tree/main/examples/research_bot):**
78+
Simple deep research clone that demonstrates complex multi-agent research workflows.
79+
80+
- **[tools](https://github.com/openai/openai-agents-python/tree/main/examples/tools):**
81+
Learn how to implement OAI hosted tools such as:
82+
83+
- Web search and web search with filters
84+
- File search
85+
- Code interpreter
86+
- Computer use
87+
- Image generation
88+
89+
- **[voice](https://github.com/openai/openai-agents-python/tree/main/examples/voice):**
90+
See examples of voice agents, using our TTS and STT models, including streamed voice examples.

0 commit comments

Comments
 (0)