formatting updates to examples doc (#249)

This commit is contained in:
Rohan Mehta 2025-03-19 17:26:24 -04:00 committed by GitHub
commit cef3d5357c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -5,29 +5,32 @@ Check out a variety of sample implementations of the SDK in the examples section
## Categories ## Categories
- **agent_patterns** - **agent_patterns:**
Examples in this category illustrate common agent design patterns, such as: Examples in this category illustrate common agent design patterns, such as
- Deterministic workflows
- Agents as tools - Deterministic workflows
- Parallel agent execution - Agents as tools
- Parallel agent execution
- **basic** - **basic:**
These examples showcase foundational capabilities of the SDK, such as: These examples showcase foundational capabilities of the SDK, such as
- Dynamic system prompts
- Streaming outputs - Dynamic system prompts
- Lifecycle events - Streaming outputs
- Lifecycle events
- **tool examples** - **tool examples:**
Learn how to implement OAI hosted tools such as web search and file search, Learn how to implement OAI hosted tools such as web search and file search,
and integrate them into your agents. and integrate them into your agents.
- **model providers** - **model providers:**
Explore how to use non-OpenAI models with the SDK. Explore how to use non-OpenAI models with the SDK.
- **handoffs** - **handoffs:**
See practical examples of agent handoffs. See practical examples of agent handoffs.
- **customer_service & research_bot** - **customer_service** and **research_bot:**
Two more built-out examples that illustrate real-world applications: 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. - **customer_service**: Example customer service system for an airline.
- **research_bot**: Simple deep research clone.