Allow to pass both session and input list #1298

DanieleMorotti · 2025-07-29T15:17:34Z

Summary

This PR has been implemented to resolve #1140 . I added a parameter to the RunConfig object such that it can be specified if the given input list will replace the session history or it will be appended to it.

The current implementation is a possible approach but I would be happy to change the code if there are better solutions.

@seratch @rm-openai whenever you have a moment, please let me know your thoughts.

Test plan

I added 2 unit tests in tests/test_session.py.

Checks

I've added new tests (if relevant)
I've added/updated the relevant documentation
I've run make lint and make format
I've made sure tests pass

seratch · 2025-07-29T23:28:09Z

src/agents/run.py

@@ -1212,8 +1223,17 @@ async def _prepare_input_with_session(
        # Convert input to list format
        new_input_list = ItemHelpers.input_to_new_input_list(input)

-        # Combine history with new input
-        combined_input = history + new_input_list
+        if session_input_handling == "append" or session_input_handling is None:


To me, allowing to pass callback function here to combine the item list to save sounds more flexible. @rm-openai what do you think?

Yes, this would offer much more flexibility.
However, would you still preserve the option for the users to specify "replace" or "append" in order to apply some predefined processing?

In that scenario, the RunConfig attribute could accept a Callable, a str or None.

Or would you prefer to have a more complex implementation like the one done for MCP filters (ToolFilterCallable, etc)?

Sessions are supposed to be used for maintaining conversation history across multiple agent runs. So, I don't think "replace" is a common use case. If "replace" works well, do you really need a session for the case?

If a developer would like to make some adjustments to stored history based on some conditions, that could be a valid use case (I still think it's an edge case though). That's why I thought enabling callback functions here would make more sense.

Let me know if I am missing anything!

I agree. And what should happen if the callback function is left unspecified (None) and the input is a list? We may raise an error, as in the current implementation.

Moreover, does the callback function only take the history and the list of new items as input, or should I allow additional parameters?

DanieleMorotti · 2025-07-31T15:33:11Z

I implemented a new version, where the RunConfig attribute accepts a callback function that takes as input the history from the session and the new inputs.

Let me know what else should be improved.

rm-openai · 2025-08-01T15:59:06Z

I'm missing some context, what's the use case for this? I read the issue but couldn't quite figure it out

gonzamordecki · 2025-08-01T18:32:52Z

@rm-openai Adding some context, as I just faced this limitation:

An agent currently cannot be run using built-in sessions from the SDK while receiving two new inputs from the user. This is requested, for example, when passing an image and text (i.e., Product Image + “Do you have this product in black?”).

github-actions · 2025-08-12T02:11:19Z

This PR is stale because it has been open for 10 days with no activity.

DanieleMorotti · 2025-08-12T08:06:26Z

@rm-openai I implemented this feature because it seemed useful to several people, but if you don't want to include it, just let me know and I'll close the PR.

fdb02983rhy · 2025-08-15T03:09:16Z

Multimodal input is a fundamental feature for agents, so please allow users to handle it through the built-in session management. Currently, I have to call .to_input_list() and manage it manually.

github-actions · 2025-08-26T02:08:07Z

This PR is stale because it has been open for 10 days with no activity.

gemue-parndt · 2025-08-26T09:29:37Z

We really need this feature!
I want to handle images and texts but currently only text is allowed therefore the whole Session feature is not usable...
@rm-openai please approve this PR :)

tauzhang-cn · 2025-09-05T03:29:40Z

I also have the same problem above， please！

chatgpt-codex-connector

Codex Review: Here are some suggestions.

openai-agents-python/src/agents/run.py

Lines 551 to 552 in 48f7dc8

    
           # Save the conversation to session if enabled 
        
           await self._save_result_to_session(session, input, result)

[P2] Persist modified session inputs when using callbacks

The new session_input_callback is applied only when preparing the model input, but the conversation saved back to the session still uses the unmodified input value (await self._save_result_to_session(session, input, result)). If a callback rewrites or filters the user input/history (e.g. to replace existing history or truncate inputs) the model will see the modified list while the session will store the original values, so the next turn will reload stale messages and undo the callback’s intent. To keep session memory consistent with the callback’s output, _save_result_to_session should receive the already combined/filtered list or otherwise allow the callback to influence what is persisted.

Reply with @codex fix comments to fix any unresolved comments.

About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you open a pull request for review, mark a draft as ready, or comment "@codex review". If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex fix this CI failure" or "@codex address that feedback".

seratch · 2025-09-09T07:15:40Z

src/agents/memory/util.py

+"""
+
+
+SessionInputHandler = Union[SessionMixerCallable, None]


For consistency with other code in this SDK, can you remove None from here and use SessionInputHandler | None in other source files? Also, can you make the type name consistent with the property name session_input_callback?

seratch · 2025-09-09T07:16:17Z

src/agents/run.py

@@ -179,6 +179,14 @@ class RunConfig:
    An optional dictionary of additional metadata to include with the trace.
    """

+    session_input_callback: SessionInputHandler = None


To avoid confusion for code readers, remove None union type from SessionInputHandler and change the type def here (and others):

Suggested change

session_input_callback: SessionInputHandler = None

session_input_callback: SessionInputCallback | None = None

seratch · 2025-09-09T07:20:32Z

src/agents/run.py

-        # ambiguity about whether the list should append to or replace existing session history
-        if isinstance(input, list):
+        # If the user doesn't explicitly specify a mode, raise an error
+        if isinstance(input, list) and not session_input_callback:


Asking users to pass session_input_callback is a breaking change, plus not having the callback should be fine

Allow to pass both session and input list + tests

c5fa125

seratch reviewed Jul 29, 2025

View reviewed changes

seratch added bug Something isn't working feature:sessions enhancement New feature or request labels Jul 29, 2025

seratch requested a review from rm-openai July 29, 2025 23:28

DanieleMorotti added 3 commits July 30, 2025 09:03

Merge branch 'main' into fix_session_input

944f79b

Merge branch 'openai:main' into fix_session_input

7a4e740

Use a callback function to mix history and input

6c3ca71

github-actions bot added the stale label Aug 12, 2025

github-actions bot removed the stale label Aug 13, 2025

github-actions bot added the stale label Aug 26, 2025

github-actions bot removed the stale label Aug 27, 2025

Update to the latest 'main' changes

48f7dc8

chatgpt-codex-connector bot reviewed Sep 8, 2025

View reviewed changes

seratch requested changes Sep 9, 2025

View reviewed changes

	# Save the conversation to session if enabled
	await self._save_result_to_session(session, input, result)

	session_input_callback: SessionInputHandler = None
	session_input_callback: SessionInputCallback \| None = None

Allow to pass both session and input list #1298

Are you sure you want to change the base?

Allow to pass both session and input list #1298

Uh oh!

Conversation

DanieleMorotti commented Jul 29, 2025 • edited by seratch Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Test plan

Checks

Uh oh!

seratch Jul 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

DanieleMorotti Jul 30, 2025

Choose a reason for hiding this comment

Uh oh!

seratch Jul 30, 2025

Choose a reason for hiding this comment

Uh oh!

DanieleMorotti Jul 30, 2025

Choose a reason for hiding this comment

Uh oh!

DanieleMorotti commented Jul 31, 2025

Uh oh!

rm-openai commented Aug 1, 2025

Uh oh!

gonzamordecki commented Aug 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Aug 12, 2025

Uh oh!

DanieleMorotti commented Aug 12, 2025

Uh oh!

fdb02983rhy commented Aug 15, 2025

Uh oh!

github-actions bot commented Aug 26, 2025

Uh oh!

gemue-parndt commented Aug 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tauzhang-cn commented Sep 5, 2025

Uh oh!

chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

Uh oh!

seratch Sep 9, 2025

Choose a reason for hiding this comment

Uh oh!

seratch Sep 9, 2025

Choose a reason for hiding this comment

Uh oh!

seratch Sep 9, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

DanieleMorotti commented Jul 29, 2025 •

edited by seratch

Loading

seratch Jul 29, 2025 •

edited

Loading

gonzamordecki commented Aug 1, 2025 •

edited

Loading

gemue-parndt commented Aug 26, 2025 •

edited

Loading