diff --git a/docs/examples.md b/docs/examples.md index ae40fa909..a2dd5a6fc 100644 --- a/docs/examples.md +++ b/docs/examples.md @@ -2,44 +2,88 @@ 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](https://github.com/openai/openai-agents-python/tree/main/examples/agent_patterns):** - Examples in this category illustrate common agent design patterns, such as +- **[agent_patterns](https://github.com/openai/openai-agents-python/tree/main/examples/agent_patterns):** + Examples in this category illustrate common agent design patterns, such as + + - Deterministic workflows + - Agents as tools + - Parallel agent execution + - Conditional tool usage + - Input/output guardrails + - LLM as a judge + - Routing + - Streaming guardrails + +- **[basic](https://github.com/openai/openai-agents-python/tree/main/examples/basic):** + These examples showcase foundational capabilities of the SDK, such as + + - Hello world examples (Default model, GPT-5, open-weight model) + - Agent lifecycle management + - Dynamic system prompts + - Streaming outputs (text, items, function call args) + - Prompt templates + - File handling (local and remote, images and PDFs) + - Usage tracking + - Non-strict output types + - Previous response ID usage + +- **[customer_service](https://github.com/openai/openai-agents-python/tree/main/examples/customer_service):** + Example customer service system for an airline. + +- **[financial_research_agent](https://github.com/openai/openai-agents-python/tree/main/examples/financial_research_agent):** + A financial research agent that demonstrates structured research workflows with agents and tools for financial data analysis. + +- **[handoffs](https://github.com/openai/openai-agents-python/tree/main/examples/handoffs):** + See practical examples of agent handoffs with message filtering. + +- **[hosted_mcp](https://github.com/openai/openai-agents-python/tree/main/examples/hosted_mcp):** + Examples demonstrating how to use hosted MCP (Model Context Protocol) connectors and approvals. + +- **[mcp](https://github.com/openai/openai-agents-python/tree/main/examples/mcp):** + Learn how to build agents with MCP (Model Context Protocol), including: - - Deterministic workflows - - Agents as tools - - Parallel agent execution + - Filesystem examples + - Git examples + - MCP prompt server examples + - SSE (Server-Sent Events) examples + - Streamable HTTP examples -- **[basic](https://github.com/openai/openai-agents-python/tree/main/examples/basic):** - These examples showcase foundational capabilities of the SDK, such as +- **[memory](https://github.com/openai/openai-agents-python/tree/main/examples/memory):** + Examples of different memory implementations for agents, including: - - Dynamic system prompts - - Streaming outputs - - Lifecycle events + - SQLite session storage + - Advanced SQLite session storage + - Redis session storage + - SQLAlchemy session storage + - Encrypted session storage + - OpenAI session storage -- **[tool examples](https://github.com/openai/openai-agents-python/tree/main/examples/tools):** - Learn how to implement OAI hosted tools such as web search and file search, - and integrate them into your agents. +- **[model_providers](https://github.com/openai/openai-agents-python/tree/main/examples/model_providers):** + Explore how to use non-OpenAI models with the SDK, including custom providers and LiteLLM integration. -- **[model providers](https://github.com/openai/openai-agents-python/tree/main/examples/model_providers):** - Explore how to use non-OpenAI models with the SDK. +- **[realtime](https://github.com/openai/openai-agents-python/tree/main/examples/realtime):** + Examples showing how to build real-time experiences using the SDK, including: -- **[handoffs](https://github.com/openai/openai-agents-python/tree/main/examples/handoffs):** - See practical examples of agent handoffs. + - Web applications + - Command-line interfaces + - Twilio integration -- **[mcp](https://github.com/openai/openai-agents-python/tree/main/examples/mcp):** - Learn how to build agents with MCP. +- **[reasoning_content](https://github.com/openai/openai-agents-python/tree/main/examples/reasoning_content):** + Examples demonstrating how to work with reasoning content and structured outputs. -- **[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):** - Two more built-out examples that illustrate real-world applications +- **[research_bot](https://github.com/openai/openai-agents-python/tree/main/examples/research_bot):** + Simple deep research clone that demonstrates complex multi-agent research workflows. - - **customer_service**: Example customer service system for an airline. - - **research_bot**: Simple deep research clone. +- **[tools](https://github.com/openai/openai-agents-python/tree/main/examples/tools):** + Learn how to implement OAI hosted tools such as: -- **[voice](https://github.com/openai/openai-agents-python/tree/main/examples/voice):** - See examples of voice agents, using our TTS and STT models. + - Web search and web search with filters + - File search + - Code interpreter + - Computer use + - Image generation -- **[realtime](https://github.com/openai/openai-agents-python/tree/main/examples/realtime):** - Examples showing how to build realtime experiences using the SDK. +- **[voice](https://github.com/openai/openai-agents-python/tree/main/examples/voice):** + See examples of voice agents, using our TTS and STT models, including streamed voice examples.