Skip to content

Updated the default values for two parameters in the ModelSettings class to align with their documented behavior: #1392

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.

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 4 commits into from
Aug 11, 2025
Merged
Changes from all commits
Commits
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
5 changes: 3 additions & 2 deletions src/agents/model_settings.py
Original file line number Diff line number Diff line change
Expand Up @@ -107,11 +107,12 @@ class ModelSettings:

store: bool | None = None
"""Whether to store the generated model response for later retrieval.
Defaults to True if not provided."""
For Responses API: automatically enabled when not specified.
For Chat Completions API: disabled when not specified."""

include_usage: bool | None = None
"""Whether to include usage chunk.
Defaults to True if not provided."""
Only available for Chat Completions API."""

response_include: list[ResponseIncludable] | None = None
"""Additional output data to include in the model response.
Expand Down