Skip to content
Merged
Show file tree
Hide file tree
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
6 changes: 6 additions & 0 deletions src/agents/model_settings.py
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,12 @@ class ModelSettings:
For Responses API: automatically enabled when not specified.
For Chat Completions API: disabled when not specified."""

prompt_cache_retention: Literal["in_memory", "24h"] | None = None
"""The retention policy for the prompt cache. Set to `24h` to enable extended
prompt caching, which keeps cached prefixes active for longer, up to a maximum
of 24 hours.
[Learn more](https://platform.openai.com/docs/guides/prompt-caching#prompt-cache-retention)."""

include_usage: bool | None = None
"""Whether to include usage chunk.
Only available for Chat Completions API."""
Expand Down
1 change: 1 addition & 0 deletions src/agents/models/openai_chatcompletions.py
Original file line number Diff line number Diff line change
Expand Up @@ -308,6 +308,7 @@ async def _fetch_response(
reasoning_effort=self._non_null_or_omit(reasoning_effort),
verbosity=self._non_null_or_omit(model_settings.verbosity),
top_logprobs=self._non_null_or_omit(model_settings.top_logprobs),
prompt_cache_retention=self._non_null_or_omit(model_settings.prompt_cache_retention),
extra_headers=self._merge_headers(model_settings),
extra_query=model_settings.extra_query,
extra_body=model_settings.extra_body,
Expand Down
1 change: 1 addition & 0 deletions src/agents/models/openai_responses.py
Original file line number Diff line number Diff line change
Expand Up @@ -326,6 +326,7 @@ async def _fetch_response(
extra_body=model_settings.extra_body,
text=response_format,
store=self._non_null_or_omit(model_settings.store),
prompt_cache_retention=self._non_null_or_omit(model_settings.prompt_cache_retention),
reasoning=self._non_null_or_omit(model_settings.reasoning),
metadata=self._non_null_or_omit(model_settings.metadata),
**extra_args,
Expand Down
1 change: 1 addition & 0 deletions tests/model_settings/test_serialization.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ def test_all_fields_serialization() -> None:
reasoning=Reasoning(),
metadata={"foo": "bar"},
store=False,
prompt_cache_retention="24h",
include_usage=False,
response_include=["reasoning.encrypted_content"],
top_logprobs=1,
Expand Down