Skip to content

Commit c4a87ab

Browse files
committed
docs: improve consistency
1 parent dde45fc commit c4a87ab

File tree

10 files changed

+26
-26
lines changed

10 files changed

+26
-26
lines changed

docs/agents.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -300,7 +300,7 @@ agent = Agent(
300300
)
301301
```
302302

303-
## Tool Use Behavior
303+
## Tool use behavior
304304

305305
The `tool_use_behavior` parameter in the `Agent` configuration controls how tool outputs are handled:
306306

docs/handoffs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ If you pass plain `Agent` instances, their [`handoff_description`][agents.agent.
1212

1313
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.
1414

15-
### Basic Usage
15+
### Basic usage
1616

1717
Here's how you can create a simple handoff:
1818

docs/realtime/guide.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Realtime agents allow for conversational flows, processing audio and text inputs
1111

1212
## Architecture
1313

14-
### Core Components
14+
### Core components
1515

1616
The realtime system consists of several key components:
1717

@@ -64,9 +64,9 @@ Additional configuration options you can set on `RealtimeRunner(config=...)` inc
6464

6565
See [`RealtimeRunConfig`][agents.realtime.config.RealtimeRunConfig] and [`RealtimeSessionModelSettings`][agents.realtime.config.RealtimeSessionModelSettings] for the complete typed configuration.
6666

67-
## Tools and Functions
67+
## Tools and functions
6868

69-
### Adding Tools
69+
### Adding tools
7070

7171
Just like regular agents, realtime agents support function tools that execute during conversations:
7272

@@ -94,7 +94,7 @@ agent = RealtimeAgent(
9494

9595
## Handoffs
9696

97-
### Creating Handoffs
97+
### Creating handoffs
9898

9999
Handoffs allow transferring conversations between specialized agents.
100100

docs/running_agents.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -263,7 +263,7 @@ async def main():
263263
# California
264264
```
265265

266-
#### Automatic conversation management with Sessions
266+
#### Automatic conversation management with sessions
267267

268268
For a simpler approach, you can use [Sessions](sessions/index.md) to automatically handle conversation history without manually calling `.to_input_list()`:
269269

docs/sessions/advanced_sqlite_session.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Advanced SQLite Sessions
1+
# Advanced SQLite sessions
22

33
`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.
44

@@ -297,7 +297,7 @@ CREATE TABLE turn_usage (
297297
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.
298298

299299

300-
## API Reference
300+
## API reference
301301

302302
- [`AdvancedSQLiteSession`][agents.extensions.memory.advanced_sqlite_session.AdvancedSQLiteSession] - Main class
303303
- [`Session`][agents.memory.session.Session] - Base session protocol

docs/sessions/encrypted_session.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Encrypted Sessions
1+
# Encrypted sessions
22

33
`EncryptedSession` provides transparent encryption for any session implementation, securing conversation data with automatic expiration of old items.
44

@@ -75,7 +75,7 @@ session = EncryptedSession(
7575
)
7676
```
7777

78-
### TTL (Time To Live)
78+
### TTL (time to live)
7979

8080
Set how long encrypted items remain valid:
8181

@@ -169,7 +169,7 @@ items = await session.get_items() # Only returns non-expired items
169169
result = await Runner.run(agent, "Continue conversation", session=session)
170170
```
171171

172-
## API Reference
172+
## API reference
173173

174174
- [`EncryptedSession`][agents.extensions.memory.encrypt_session.EncryptedSession] - Main class
175175
- [`Session`][agents.memory.session.Session] - Base session protocol

docs/sessions/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -619,7 +619,7 @@ The community has developed additional session implementations:
619619

620620
If you've built a session implementation, please feel free to submit a documentation PR to add it here!
621621

622-
## API Reference
622+
## API reference
623623

624624
For detailed API documentation, see:
625625

docs/sessions/sqlalchemy_session.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# SQLAlchemy Sessions
1+
# SQLAlchemy sessions
22

33
`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.
44

@@ -70,7 +70,7 @@ if __name__ == "__main__":
7070
```
7171

7272

73-
## API Reference
73+
## API reference
7474

7575
- [`SQLAlchemySession`][agents.extensions.memory.sqlalchemy_session.SQLAlchemySession] - Main class
7676
- [`Session`][agents.memory.session.Session] - Base session protocol

docs/usage.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,11 +85,11 @@ class MyHooks(RunHooks):
8585
print(f"{agent.name}{u.requests} requests, {u.total_tokens} total tokens")
8686
```
8787

88-
## API Reference
88+
## API reference
8989

9090
For detailed API documentation, see:
9191

9292
- [`Usage`][agents.usage.Usage] - Usage tracking data structure
9393
- [`RequestUsage`][agents.usage.RequestUsage] - Per-request usage details
9494
- [`RunContextWrapper`][agents.run.RunContextWrapper] - Access usage from run context
95-
- [`RunHooks`][agents.run.RunHooks] - Hook into usage tracking lifecycle
95+
- [`RunHooks`][agents.run.RunHooks] - Hook into usage tracking lifecycle

docs/visualization.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Agent Visualization
1+
# Agent visualization
22

33
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.
44

@@ -10,16 +10,16 @@ Install the optional `viz` dependency group:
1010
pip install "openai-agents[viz]"
1111
```
1212

13-
## Generating a Graph
13+
## Generating a graph
1414

1515
You can generate an agent visualization using the `draw_graph` function. This function creates a directed graph where:
1616

1717
- **Agents** are represented as yellow boxes.
18-
- **MCP Servers** are represented as grey boxes.
18+
- **MCP servers** are represented as grey boxes.
1919
- **Tools** are represented as green ellipses.
2020
- **Handoffs** are directed edges from one agent to another.
2121

22-
### Example Usage
22+
### Example usage
2323

2424
```python
2525
import os
@@ -68,14 +68,14 @@ draw_graph(triage_agent)
6868
This generates a graph that visually represents the structure of the **triage agent** and its connections to sub-agents and tools.
6969

7070

71-
## Understanding the Visualization
71+
## Understanding the visualization
7272

7373
The generated graph includes:
7474

7575
- A **start node** (`__start__`) indicating the entry point.
7676
- Agents represented as **rectangles** with yellow fill.
7777
- 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.
7979
- Directed edges indicating interactions:
8080
- **Solid arrows** for agent-to-agent handoffs.
8181
- **Dotted arrows** for tool invocations.
@@ -86,16 +86,16 @@ The generated graph includes:
8686
`agents` package (verified in **v0.2.8**). If you don’t see MCP boxes
8787
in your visualization, upgrade to the latest release.
8888

89-
## Customizing the Graph
89+
## Customizing the graph
9090

91-
### Showing the Graph
91+
### Showing the graph
9292
By default, `draw_graph` displays the graph inline. To show the graph in a separate window, write the following:
9393

9494
```python
9595
draw_graph(triage_agent).view()
9696
```
9797

98-
### Saving the Graph
98+
### Saving the graph
9999
By default, `draw_graph` displays the graph inline. To save it as a file, specify a filename:
100100

101101
```python

0 commit comments

Comments
 (0)