Skip to content

Update Realtime Agent documents (ref #1646) #1695

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 11, 2025
Merged

Update Realtime Agent documents (ref #1646) #1695

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7a3e4f6
Update Realtime Agent documents (ref #1646)
seratch Sep 8, 2025
59e855a
Merge branch 'main' into realtime-ga-docs
seratch Sep 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/realtime/guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Key differences from regular agents:

### Model settings

The session configuration allows you to control the underlying realtime model behavior. You can configure the model name (such as `gpt-4o-realtime-preview`), voice selection (alloy, echo, fable, onyx, nova, shimmer), and supported modalities (text and/or audio). Audio formats can be set for both input and output, with PCM16 being the default.
The session configuration allows you to control the underlying realtime model behavior. You can configure the model name (such as `gpt-realtime`), voice selection (alloy, echo, fable, onyx, nova, shimmer), and supported modalities (text and/or audio). Audio formats can be set for both input and output, with PCM16 being the default.

### Audio configuration

Expand Down
6 changes: 3 additions & 3 deletions docs/realtime/quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ runner = RealtimeRunner(
starting_agent=agent,
config={
"model_settings": {
"model_name": "gpt-4o-realtime-preview",
"model_name": "gpt-realtime",
"voice": "alloy",
"modalities": ["text", "audio"],
}
Expand Down Expand Up @@ -95,7 +95,7 @@ async def main():
starting_agent=agent,
config={
"model_settings": {
"model_name": "gpt-4o-realtime-preview",
"model_name": "gpt-realtime",
"voice": "alloy",
"modalities": ["text", "audio"],
"input_audio_transcription": {
Expand Down Expand Up @@ -135,7 +135,7 @@ if __name__ == "__main__":

### Model settings

- `model_name`: Choose from available realtime models (e.g., `gpt-4o-realtime-preview`)
- `model_name`: Choose from available realtime models (e.g., `gpt-realtime`)
- `voice`: Select voice (`alloy`, `echo`, `fable`, `onyx`, `nova`, `shimmer`)
- `modalities`: Enable text and/or audio (`["text", "audio"]`)

Expand Down