Skip to content

Commit 230a9d6

Browse files
authored
Highlight gpt-realtime-1.5 in public docs (#2724)
**Default guidance in public documentation** https://openai.github.io/openai-agents-python/ **Before** The public Agents SDK docs still mostly pointed realtime users at gpt-realtime, so new users were landing on stale guidance instead of the recommended gpt-realtime-1.5 path. This showed up in the top-level docs entry points and the English realtime quickstart/guide. **After** The public documentation now points new realtime users to gpt-realtime-1.5 in the top-level discovery pages and the English realtime quickstart/guide. The SDK’s implicit runtime default was intentionally left unchanged, so this updates guidance without changing behavior for existing integrations that omit model_name.
1 parent 58374fe commit 230a9d6

7 files changed

Lines changed: 10 additions & 7 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The OpenAI Agents SDK is a lightweight yet powerful framework for building multi
1616
1. [**Human in the loop**](https://openai.github.io/openai-agents-python/human_in_the_loop/): Built-in mechanisms for involving humans across agent runs
1717
1. [**Sessions**](https://openai.github.io/openai-agents-python/sessions/): Automatic conversation history management across agent runs
1818
1. [**Tracing**](https://openai.github.io/openai-agents-python/tracing/): Built-in tracking of agent runs, allowing you to view, debug and optimize your workflows
19-
1. [**Realtime Agents**](https://openai.github.io/openai-agents-python/realtime/quickstart/): Build powerful voice agents with full features
19+
1. [**Realtime Agents**](https://openai.github.io/openai-agents-python/realtime/quickstart/): Build powerful voice agents with `gpt-realtime-1.5` and full agent features
2020

2121
Explore the [examples](https://github.com/openai/openai-agents-python/tree/main/examples) directory to see the SDK in action, and read our [documentation](https://openai.github.io/openai-agents-python/) for more details.
2222

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Here are the main features of the SDK:
2626
- **Sessions**: A persistent memory layer for maintaining working context within an agent loop.
2727
- **Human in the loop**: Built-in mechanisms for involving humans across agent runs.
2828
- **Tracing**: Built-in tracing for visualizing, debugging, and monitoring workflows, with support for the OpenAI suite of evaluation, fine-tuning, and distillation tools.
29-
- **Realtime Agents**: Build powerful voice agents with features such as automatic interruption detection, context management, guardrails, and more.
29+
- **Realtime Agents**: Build powerful voice agents with `gpt-realtime-1.5`, automatic interruption detection, context management, guardrails, and more.
3030

3131
## Installation
3232

@@ -73,5 +73,5 @@ Use this table when you know the job you want to do, but not which page explains
7373
| Keep memory across turns | [Running agents](running_agents.md#choose-a-memory-strategy) and [Sessions](sessions/index.md) |
7474
| Use OpenAI models, websocket transport, or non-OpenAI providers | [Models](models/index.md) |
7575
| Review outputs, run items, interruptions, and resume state | [Results](results.md) |
76-
| Build a low-latency voice agent | [Realtime agents quickstart](realtime/quickstart.md) and [Realtime transport](realtime/transport.md) |
76+
| Build a low-latency voice agent with `gpt-realtime-1.5` | [Realtime agents quickstart](realtime/quickstart.md) and [Realtime transport](realtime/transport.md) |
7777
| Build a speech-to-text / agent / text-to-speech pipeline | [Voice pipeline quickstart](voice/quickstart.md) |

docs/realtime/guide.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,14 +45,14 @@ By default, `RealtimeRunner` uses `OpenAIRealtimeWebSocketModel`, so the default
4545
- Voice can be configured, but it cannot change after the session has already produced spoken audio.
4646
- Instructions, function tools, handoffs, hooks, and output guardrails all still work.
4747

48-
`RealtimeSessionModelSettings` supports both a newer nested `audio` config and older flat aliases. Prefer the nested shape for new code:
48+
`RealtimeSessionModelSettings` supports both a newer nested `audio` config and older flat aliases. Prefer the nested shape for new code, and start with `gpt-realtime-1.5` for new realtime agents:
4949

5050
```python
5151
runner = RealtimeRunner(
5252
starting_agent=agent,
5353
config={
5454
"model_settings": {
55-
"model_name": "gpt-realtime",
55+
"model_name": "gpt-realtime-1.5",
5656
"audio": {
5757
"input": {
5858
"format": "pcm16",

docs/realtime/quickstart.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,14 +45,14 @@ agent = RealtimeAgent(
4545

4646
### 3. Configure the runner
4747

48-
Prefer the nested `audio.input` / `audio.output` session settings shape for new code.
48+
Prefer the nested `audio.input` / `audio.output` session settings shape for new code. For new realtime agents, start with `gpt-realtime-1.5`.
4949

5050
```python
5151
runner = RealtimeRunner(
5252
starting_agent=agent,
5353
config={
5454
"model_settings": {
55-
"model_name": "gpt-realtime",
55+
"model_name": "gpt-realtime-1.5",
5656
"audio": {
5757
"input": {
5858
"format": "pcm16",

examples/realtime/app/server.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ async def connect(self, websocket: WebSocket, session_id: str):
5252
# runner = RealtimeRunner(agent, config=runner_config)
5353
model_config: RealtimeModelConfig = {
5454
"initial_model_settings": {
55+
"model_name": "gpt-realtime-1.5",
5556
"turn_detection": {
5657
"type": "server_vad",
5758
"prefix_padding_ms": 300,

examples/realtime/cli/demo.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -225,6 +225,7 @@ async def run(self) -> None:
225225
model_config: RealtimeModelConfig = {
226226
"playback_tracker": self.playback_tracker,
227227
"initial_model_settings": {
228+
"model_name": "gpt-realtime-1.5",
228229
"turn_detection": {
229230
"type": "semantic_vad",
230231
"interrupt_response": True,

examples/realtime/twilio/twilio_handler.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,7 @@ async def start(self) -> None:
9393
model_config={
9494
"api_key": api_key,
9595
"initial_model_settings": {
96+
"model_name": "gpt-realtime-1.5",
9697
"input_audio_format": "g711_ulaw",
9798
"output_audio_format": "g711_ulaw",
9899
"turn_detection": {

0 commit comments

Comments
 (0)