You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/handoffs.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ If you pass plain `Agent` instances, their [`handoff_description`][agents.agent.
12
12
13
13
You can create a handoff using the [`handoff()`][agents.handoffs.handoff] function provided by the Agents SDK. This function allows you to specify the agent to hand off to, along with optional overrides and input filters.
Copy file name to clipboardExpand all lines: docs/realtime/guide.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ Realtime agents allow for conversational flows, processing audio and text inputs
11
11
12
12
## Architecture
13
13
14
-
### Core Components
14
+
### Core components
15
15
16
16
The realtime system consists of several key components:
17
17
@@ -64,9 +64,9 @@ Additional configuration options you can set on `RealtimeRunner(config=...)` inc
64
64
65
65
See [`RealtimeRunConfig`][agents.realtime.config.RealtimeRunConfig] and [`RealtimeSessionModelSettings`][agents.realtime.config.RealtimeSessionModelSettings] for the complete typed configuration.
66
66
67
-
## Tools and Functions
67
+
## Tools and functions
68
68
69
-
### Adding Tools
69
+
### Adding tools
70
70
71
71
Just like regular agents, realtime agents support function tools that execute during conversations:
72
72
@@ -94,7 +94,7 @@ agent = RealtimeAgent(
94
94
95
95
## Handoffs
96
96
97
-
### Creating Handoffs
97
+
### Creating handoffs
98
98
99
99
Handoffs allow transferring conversations between specialized agents.
Copy file name to clipboardExpand all lines: docs/running_agents.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -263,7 +263,7 @@ async def main():
263
263
# California
264
264
```
265
265
266
-
#### Automatic conversation management with Sessions
266
+
#### Automatic conversation management with sessions
267
267
268
268
For a simpler approach, you can use [Sessions](sessions/index.md) to automatically handle conversation history without manually calling `.to_input_list()`:
Copy file name to clipboardExpand all lines: docs/sessions/advanced_sqlite_session.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# Advanced SQLite Sessions
1
+
# Advanced SQLite sessions
2
2
3
3
`AdvancedSQLiteSession` is an enhanced version of the basic `SQLiteSession` that provides advanced conversation management capabilities including conversation branching, detailed usage analytics, and structured conversation queries.
4
4
@@ -297,7 +297,7 @@ CREATE TABLE turn_usage (
297
297
Check out the [complete example](https://github.com/openai/openai-agents-python/tree/main/examples/memory/advanced_sqlite_session_example.py) for a comprehensive demonstration of all features.
298
298
299
299
300
-
## API Reference
300
+
## API reference
301
301
302
302
-[`AdvancedSQLiteSession`][agents.extensions.memory.advanced_sqlite_session.AdvancedSQLiteSession] - Main class
303
303
-[`Session`][agents.memory.session.Session] - Base session protocol
Copy file name to clipboardExpand all lines: docs/sessions/sqlalchemy_session.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# SQLAlchemy Sessions
1
+
# SQLAlchemy sessions
2
2
3
3
`SQLAlchemySession` uses SQLAlchemy to provide a production-ready session implementation, allowing you to use any database supported by SQLAlchemy (PostgreSQL, MySQL, SQLite, etc.) for session storage.
4
4
@@ -70,7 +70,7 @@ if __name__ == "__main__":
70
70
```
71
71
72
72
73
-
## API Reference
73
+
## API reference
74
74
75
75
-[`SQLAlchemySession`][agents.extensions.memory.sqlalchemy_session.SQLAlchemySession] - Main class
76
76
-[`Session`][agents.memory.session.Session] - Base session protocol
Copy file name to clipboardExpand all lines: docs/visualization.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# Agent Visualization
1
+
# Agent visualization
2
2
3
3
Agent visualization allows you to generate a structured graphical representation of agents and their relationships using **Graphviz**. This is useful for understanding how agents, tools, and handoffs interact within an application.
4
4
@@ -10,16 +10,16 @@ Install the optional `viz` dependency group:
10
10
pip install "openai-agents[viz]"
11
11
```
12
12
13
-
## Generating a Graph
13
+
## Generating a graph
14
14
15
15
You can generate an agent visualization using the `draw_graph` function. This function creates a directed graph where:
16
16
17
17
-**Agents** are represented as yellow boxes.
18
-
-**MCP Servers** are represented as grey boxes.
18
+
-**MCP servers** are represented as grey boxes.
19
19
-**Tools** are represented as green ellipses.
20
20
-**Handoffs** are directed edges from one agent to another.
21
21
22
-
### Example Usage
22
+
### Example usage
23
23
24
24
```python
25
25
import os
@@ -68,14 +68,14 @@ draw_graph(triage_agent)
68
68
This generates a graph that visually represents the structure of the **triage agent** and its connections to sub-agents and tools.
69
69
70
70
71
-
## Understanding the Visualization
71
+
## Understanding the visualization
72
72
73
73
The generated graph includes:
74
74
75
75
- A **start node** (`__start__`) indicating the entry point.
76
76
- Agents represented as **rectangles** with yellow fill.
77
77
- Tools represented as **ellipses** with green fill.
78
-
- MCP Servers represented as **rectangles** with grey fill.
78
+
- MCP servers represented as **rectangles** with grey fill.
79
79
- Directed edges indicating interactions:
80
80
-**Solid arrows** for agent-to-agent handoffs.
81
81
-**Dotted arrows** for tool invocations.
@@ -86,16 +86,16 @@ The generated graph includes:
86
86
`agents` package (verified in **v0.2.8**). If you don’t see MCP boxes
87
87
in your visualization, upgrade to the latest release.
88
88
89
-
## Customizing the Graph
89
+
## Customizing the graph
90
90
91
-
### Showing the Graph
91
+
### Showing the graph
92
92
By default, `draw_graph` displays the graph inline. To show the graph in a separate window, write the following:
93
93
94
94
```python
95
95
draw_graph(triage_agent).view()
96
96
```
97
97
98
-
### Saving the Graph
98
+
### Saving the graph
99
99
By default, `draw_graph` displays the graph inline. To save it as a file, specify a filename:
0 commit comments