Releases: openai/openai-agents-python
Releases · openai/openai-agents-python
v0.2.10
What's Changed
- Performance: only create the OpenAIRealtimeServerEvent TypeAdapter once by @michieldwitte in #1548
- Realtime: fix typecheck error by @rm-openai in #1558
- Docs: Add SQLAlchemy-powered sessions by @habema in #1549
- Update all translated document pages by @github-actions[bot] in #1561
- Add tests for Agent default model settings when using GPT-5 by @seratch in #1562
- Re: #1534 Update models document page to cover gpt-5 use cases by @seratch in #1535
- Update all translated document pages by @github-actions[bot] in #1563
- Docs: Improvements for SQLAlchemy Sessions by @habema in #1576
- Update all translated document pages by @github-actions[bot] in #1577
- Fix: Emit tool_called events immediately in streaming runs by @habema in #1300
- Feature: Make trace_include_sensitive_data configurable via environment variable by @Kunmeer-SyedMohamedHyder in #1192
- Docs: Improve example for custom Session class implementation. by @luke-wriglesworth in #1582
- Update all translated document pages by @github-actions[bot] in #1589
- Remove CI job we no longer actively use by @seratch in #1590
- Upgrade underlying oepnai package to the latest version by @seratch in #1599
- Fix #1585 supporting connectors by @seratch in #1600
- Fix #1592 Web search tool updates by @seratch in #1601
- Handle LiteLLM's json_tool_call addition for structured outputs by @seratch in #1602
- Add reasoning text delta event support for gpt-oss models by @seratch in #1586
- Fix #1564 Add conversations API support by @seratch in #1587
- fix: copy extra_kwargs to prevent litellm from polluting metadata by @zhowzeng in #1610
- v0.2.10 by @rm-openai in #1607
New Contributors
- @michieldwitte made their first contribution in #1548
- @luke-wriglesworth made their first contribution in #1582
- @zhowzeng made their first contribution in #1610
Full Changelog: v0.2.9...v0.2.10
v0.2.9
What's Changed
- Fix #1494 by adding a link to Responses API documentation by @seratch in #1502
- Add conditional tool enabling feature to agent as tool. by @thoo in #1193
- Update all translated document pages by @github-actions[bot] in #1503
- feat(agents): Add on_llm_start and on_llm_end Lifecycle Hooks by @uzair330 in #987
- clarify docs for
tool_use_behavior
and simplify description ofstop_on_first_tool
behavior by @Abishai-kashif in #1510 - Fix: filename not provided in chatcmpl_converter.py by @Nifury in #1513
- Add local_file example to align with TS SDK repo by @seratch in #1514
- Imrpove "Getting Started" on README by @seratch in #1516
- Add documentation for token usage tracking by @habema in #1518
- Update all translated document pages by @github-actions[bot] in #1524
- Add context parameter to run_demo_loop by @SeeYangZhi in #1527
- docs(visualization): clarify MCP server support and update screenshot by @Subhi-Sadiyev in #1529
- Update all translated document pages by @github-actions[bot] in #1532
- Update tracing.md with Agenta by @mmabrouk in #1541
- Update all translated document pages by @github-actions[bot] in #1543
- docs: Add external documentation link to LocalShellTool docstring by @MuhammadHamidRaza in #1547
- Add SQLAlchemy session backend for conversation history management by @habema in #1357
- feat: add retry logic to MCP server operations by @rm-openai in #1554
- Realtime: input timeout trigger event by @rm-openai in #1552
- Add a quick opt-in option to switch to gpt-5 model by @seratch in #1534
- v0.2.9 by @rm-openai in #1555
New Contributors
- @uzair330 made their first contribution in #987
- @Abishai-kashif made their first contribution in #1510
- @Nifury made their first contribution in #1513
- @SeeYangZhi made their first contribution in #1527
- @Subhi-Sadiyev made their first contribution in #1529
- @mmabrouk made their first contribution in #1541
Full Changelog: 0.2.8...v0.2.9
v0.2.8
What's Changed
- Fix: Clarify random_number function docstring for inclusive range by @Abbas-Asad in #1475
- Add input validation and type conversion for user input by @Abbas-Asad in #1476
- Docs: Add missing docstring to get_weather function by @Abbas-Asad in #1478
- Docs: Clarify that guardrails apply to both user input and agent output by @Abbas-Asad in #1482
- Docs: Add missing docstring to how_many_jokes tool by @Abbas-Asad in #1479
- Update all translated document pages by @github-actions[bot] in #1484
- Allow modifying the input sent to the model by @rm-openai in #1483
- Make shallow copies of lists instead of deep copies by @rm-openai in #1490
- Realtime: fix history bug by @rm-openai in #1495
- Realtime: allow arbitrarily sized messages by @rm-openai in #1500
- 0.2.8 by @rm-openai in #1501
Full Changelog: v0.2.7...0.2.8
v0.2.7
What's Changed
- Added runtime validation for Agent constructor arguments by @DanielHashmi in #998
- Realtime: add handoff prompt prefix by @rm-openai in #1382
- feat(tests): add tests for unicode content, special characters, and concurrent access in SQLiteSession by @PatrykBochenek in #1399
- Fix: enforce strict instructions function signature in get_system_prompt by @abdullahimran49 in #1426
- Fix #1407 Add reasoning.effort="minimal" and "verbosity" params to ModelSettings by @seratch in #1439
- Add a simple gpt-oss example by @seratch in #1440
- Fix: Clarify random_number function docstring for inclusive range by @Abbas-Asad in #1461
- Add input validation and type conversion for user input by @Abbas-Asad in #1462
- docs: Add a comprehensive example for handling function tool errors. by @MurtazaAliCode in #1354
- Update all translated document pages by @github-actions[bot] in #1469
- Migrate document translation script to gpt-5 by @seratch in #1470
- Update all translated document pages by @github-actions[bot] in #1471
- docs: Clarify the
is_enabled
parameter inhandoff()
documentation by @Hafiz-Muhammad-Umar12 in #1472 - Update all translated document pages by @github-actions[bot] in #1473
- Realtime: one guardrail trip event per response by @rm-openai in #1458
- v0.2.7 by @rm-openai in #1480
New Contributors
- @PatrykBochenek made their first contribution in #1399
- @abdullahimran49 made their first contribution in #1426
- @MurtazaAliCode made their first contribution in #1354
- @Hafiz-Muhammad-Umar12 made their first contribution in #1472
Full Changelog: v0.2.6...v0.2.7
v0.2.6
What's Changed
- feat: support agent output guardrails in realtime by @jhills20 in #1381
- Enhanced FAQ lookup tool in examples/customer_service app by @HasnainCodeHub in #1063
- Improve accuracy of guardrails and lifecycle hook descriptions by @DanielHashmi in #1386
- Update all translated document pages by @github-actions[bot] in #1413
- Add logprobs to ModelSettings by @zain in #971
- Add streaming function call arguments example by @devtalker in #1052
- Updated the default values for two parameters in the ModelSettings class to align with their documented behavior: by @rudra-attri in #1392
- chore(deps): Bump "openai>=1.99.6,<2" by @seratch in #1415
- v0.2.6 by @rm-openai in #1423
New Contributors
- @HasnainCodeHub made their first contribution in #1063
- @zain made their first contribution in #971
- @rudra-attri made their first contribution in #1392
Full Changelog: v0.2.5...v0.2.6
v0.2.5
What's Changed
- Fix tag errors in sessions document page by @seratch in #1307
- Update all translated document pages by @github-actions[bot] in #1308
- Add temporal demo to docs by @rm-openai in #1310
- Fix #1238 by enhancing HandoffInputData and enable passing async functions by @seratch in #1302
- Add support to realtime API for setting "speed" of the models responses by @sect2k in #1309
- Update all translated document pages by @github-actions[bot] in #1313
- Examples: use agent to interact with Remote PDF Documents by @princeaden1 in #1319
- Enhance exception guide in docs by @MuhammadHamidRaza in #1321
- Update all translated document pages by @github-actions[bot] in #1322
- Realtime: make example customizable: by @rm-openai in #1332
- Export MultiProvider in public API (Fix #1325) by @kobol in #1326
- Add tracing guide for non-OpenAI LLMs in docs/tracing.md by @UmmeHabiba1312 in #1329
- Update all translated document pages by @github-actions[bot] in #1336
- docs: Clarify and enhance run_demo_loop utility documentation for beginners by @UmmeHabiba1312 in #1330
- Fix set_api_key breaking cached property mechanism by @DanielHashmi in #1339
- Update all translated document pages by @github-actions[bot] in #1341
- Handle processor exceptions and fix tracing log formatting by @mshsheikh in #1292
- Fix(mcp): Unreachable structured content branch in invoke_mcp_tool by @Kunmeer-SyedMohamedHyder in #1250
- Feat: separate tool_call_item and tool_call_output_item in stream events by @gdisk in #974
- Clarify shallow-copy behavior of tools and handoffs in Agent.clone() by @abdul-kabir-jawed in #1296
- Fix #1277 missing StopAtTools and ToolsToFinalOutputFunction in agents module by @seratch in #1278
- Fix #980 Chat Completions: fails with function name for tool_choice parameter w/ streaming enabled by @seratch in #1206
- Fix type annotation and clarify tool behavior docs by @mshsheikh in #1355
- Fix style and wording issues in handoffs.py by @mshsheikh in #1356
- Fix docstring formatting and add safe check for empty message content by @mshsheikh in #1360
- Add functionality to update agent during realtime session by @marysha-openai in #1366
- feat(viz): draw MCP servers by @aaron-ang in #1368
- Update all translated document pages by @github-actions[bot] in #1369
- Realtime: fix interrupt logic by @rm-openai in #1370
- Realtime: send session update before tool response by @rm-openai in #1388
- v0.2.5 by @rm-openai in #1398
New Contributors
- @sect2k made their first contribution in #1309
- @princeaden1 made their first contribution in #1319
- @UmmeHabiba1312 made their first contribution in #1329
- @Kunmeer-SyedMohamedHyder made their first contribution in #1250
- @gdisk made their first contribution in #974
- @abdul-kabir-jawed made their first contribution in #1296
- @marysha-openai made their first contribution in #1366
- @aaron-ang made their first contribution in #1368
Full Changelog: v0.2.4...v0.2.5
v0.2.4
What's Changed
- Add automation script to generate mkdocstrings files by @seratch in #1048
- Set up codex for issues and PRs by @rm-openai in #1214
- Use real codex action by @rm-openai in #1217
- Update codex action to use repo syntax by @rm-openai in #1218
- Fixes two issues in the tracing documentation by @DanielHashmi in #1212
- Update all translated document pages by @github-actions[bot] in #1221
- Fix RealtimeModel reference by @rm-openai in #1215
- Adding docstring to get_weather tool by @mutahirshah11 in #1231
- Update all translated document pages by @github-actions[bot] in #1232
- Add LiteLLM to acknowledgements section by @colesmcintosh in #1240
- [Bugfix] Fix wrong imports in examples by @mdagost in #1241
- Realtime: send audio item/content index by @rm-openai in #1235
- Fix #1227 Chat Completions model fails to handle streaming with openai 1.97.1+ by @seratch in #1246
- Make Trace class inherit from abc.ABC for proper abstract base class behavior by @DanielHashmi in #1233
- docs: add LangDB AI Gateway as a tracing provider by @MrunmayS in #1224
- Update all translated document pages by @github-actions[bot] in #1251
- Fix type placeholder convention by @mshsheikh in #1259
- Tweak on guardrail docstrings by @mshsheikh in #1260
- Consistently use "Python" in docstrings by @mshsheikh in #1261
- gpt 4.5-preview is removed, use gpt-4.1 by @jssmith in #1266
- refactor: remove inherited method from Agent class by @windsornguyen in #1267
- Fix etc. punctuation by @mshsheikh in #1268
- fix: enforce min trigger size=1 to prevent immediate exports by @mshsheikh in #1270
- Fix documentation typo and trailing comma in exporters by @mshsheikh in #1272
- docs: remove non existent even_if_trace_running mention from trace docstring by @mshsheikh in #1273
- fix: convert litellm response with reasoning content to openai message by @zkllll2002 in #1098
- docs: fix UserContext example by @kankute-sameer in #1280
- Fix _export_batches docstring to remove incorrect "threshold" reference by @DanielHashmi in #1287
- Update all translated document pages by @github-actions[bot] in #1289
- examples: minor tweak on llm_as_a_judge example by @mshsheikh in #1284
- Enhance Tool Behavior Documentation for Developer Clarity With Examples by @MuhammadHamidRaza in #1286
- Update all translated document pages by @github-actions[bot] in #1291
- Realtime: enable a playback tracker by @rm-openai in #1242
- Realtime: only cancel response if necessary by @rm-openai in #1243
- Realtime: Twilio example by @rm-openai in #1216
- Realtime: forward all raw model events by @rm-openai in #1252
- v0.2.4 by @rm-openai in #1301
New Contributors
- @mutahirshah11 made their first contribution in #1231
- @colesmcintosh made their first contribution in #1240
- @mdagost made their first contribution in #1241
- @MrunmayS made their first contribution in #1224
- @jssmith made their first contribution in #1266
- @windsornguyen made their first contribution in #1267
- @zkllll2002 made their first contribution in #1098
- @kankute-sameer made their first contribution in #1280
- @MuhammadHamidRaza made their first contribution in #1286
Full Changelog: v0.2.3...v0.2.4
v0.2.3
What's Changed
- [realtime] Add direct access to model layer from session by @rm-openai in #1172
- Update all translated document pages by @github-actions[bot] in #1173
- Fix spelling, grammar, and minor formatting issues in running agents documentation by @mshsheikh in #1128
- fix: ensure ResponseUsage token fields are int, not None (fixes #1179) by @kobol in #1181
- Add missing guardrail exception import to quickstart by @slubbers-openai in #1161
- fix: fallback to function name for unnamed output_guardrail decorators by @romankhan26 in #1133
- Mark some dataclasses as pydantic dataclasses by @tconley1428 in #1131
- fix: Apply strict JSON schema validation in FunctionTool constructor by @habema in #1041
- Fix image_generator example error on Windows OS by @seratch in #1180
- Update all translated document pages by @github-actions[bot] in #1184
- Realtime: add user agent header by @rm-openai in #1185
- Realtime: make sure we use the initial model settings by @rm-openai in #1198
- v0.2.3 by @rm-openai in #1201
New Contributors
- @github-actions[bot] made their first contribution in #1173
- @kobol made their first contribution in #1181
- @slubbers-openai made their first contribution in #1161
- @romankhan26 made their first contribution in #1133
- @habema made their first contribution in #1041
Full Changelog: v0.2.2...v0.2.3
v0.2.2
What's Changed
- Add a new GH Actions job to automatically update translated document pagse by @seratch in #598
- Adjust #598 to only create a PR rather than pushing changes to main branch by @seratch in #1162
- Realtime: only update model settings from session by @rm-openai in #1169
- v0.2.2 by @rm-openai in #1170
Full Changelog: v0.2.1...v0.2.2
v0.2.1
Key changes
- Realtime agents are now available. Note that this is in Beta and may have bugs, please report them!
- Support for
structuredContent
in MCP tool results.
What's Changed
- Realtime: use SDK types for all messages by @rm-openai in #1134
- Realtime: introduce a demo without a UI by @rm-openai in #1135
- Realtime: handoffs by @rm-openai in #1139
- Realtime: move demo audio to separate thread by @rm-openai in #1141
- MCP: add support for tool_result.structuredContent by @rm-openai in #1150
- Correct error message for invalid output types with strict JSON schema by @DanielHashmi in #1101
- Add Streaming of Function Call Arguments to Chat Completions by @devtalker in #999
- Empty mcp tool result error by @thoo in #1142
- Unbreak tests by @rm-openai in #1157
- Realtime: web demo by @rm-openai in #1149
- Realtime docs by @rm-openai in #1153
- v0.2.1 by @rm-openai in #1151
Full Changelog: v0.2.0...v0.2.1