Skip to content

Python: [BREAKING] Removed default "store" value#2443

Merged
dmytrostruk merged 5 commits intomicrosoft:mainfrom
dmytrostruk:store-parameter-handling
Nov 25, 2025
Merged

Python: [BREAKING] Removed default "store" value#2443
dmytrostruk merged 5 commits intomicrosoft:mainfrom
dmytrostruk:store-parameter-handling

Conversation

@dmytrostruk
Copy link
Member

Motivation and Context

Removed default value of store parameter to rely on server's default value in OpenAI Responses client.

Important

This is a breaking change. Currently, the default value of store parameter in OpenAI Responses client implementation is False. With this PR, the default value is removed from the codebase to rely on server's default value, which is True. To revert the logic back to False, set store=False explicitly in run/run_stream methods for ChatAgent and get_response/get_streaming_response for BaseChatClient.

Contribution Checklist

  • The code builds clean without any errors or warnings
  • The PR follows the Contribution Guidelines
  • All unit tests pass, and I have added new tests where possible
  • Is this a breaking change? If yes, add "[BREAKING]" prefix to the title of the PR.

@dmytrostruk dmytrostruk self-assigned this Nov 25, 2025
Copilot AI review requested due to automatic review settings November 25, 2025 03:20
@markwallace-microsoft
Copy link
Member

markwallace-microsoft commented Nov 25, 2025

Python Test Coverage

Python Test Coverage Report •
FileStmtsMissCoverMissing
packages/azure-ai/agent_framework_azure_ai
   _client.py1412284%165–168, 172–173, 175, 323–324, 328, 330–331, 333–341, 343
packages/core/agent_framework
   _clients.py1001189%268, 384, 430–433, 477, 666–667, 798, 800
packages/core/agent_framework/openai
   _responses_client.py4117082%144–145, 148–149, 155–156, 159, 166, 201, 231, 259–260, 287, 291, 308, 313, 355, 417, 492, 497, 501–503, 523, 538–539, 543–545, 593, 613–614, 627–628, 644–645, 683, 685, 723, 725, 734–735, 751, 753, 826–832, 849–854, 873, 891, 901, 903, 921–922, 924–926, 937–938, 941, 943
TOTAL15466235184% 

Python Unit Test Overview

Tests Skipped Failures Errors Time
2226 130 💤 0 ❌ 0 🔥 54.520s ⏱️

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR implements a breaking change that removes the default store=False value from the OpenAI Responses client implementation, allowing the code to rely on the server's default value of True instead.

Key Changes

  • Removed automatic setting of store=False when the parameter is not specified
  • Updated logic in get_conversation_id methods to properly handle None as "use server default"
  • Removed validation that automatically set store=True when conversation_id was provided
  • Updated sample code to explicitly set store=False where needed to maintain previous behavior
  • Updated tests to verify that store is omitted from options when set to None

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.

Show a summary per file
File Description
python/packages/core/agent_framework/openai/_responses_client.py Updated get_conversation_id to return conversation ID when store is None; removed default store=False from prepare_options; refactored conversation ID assignment logic
python/packages/core/agent_framework/_clients.py Removed validation logic that forced store=True when conversation_id was set
python/packages/azure-ai/agent_framework_azure_ai/_client.py Removed default store value setting in prepare_options; updated get_conversation_id to handle None as server default
python/packages/core/tests/openai/test_openai_responses_client.py Updated test assertions to verify store is not included in options when set to None
python/samples/getting_started/agents/openai/openai_responses_client_with_thread.py Added explicit store=False to in-memory example; removed explicit store=True and related comment from server-side storage example

@dmytrostruk dmytrostruk added this pull request to the merge queue Nov 25, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Nov 25, 2025
@dmytrostruk dmytrostruk added this pull request to the merge queue Nov 25, 2025
Merged via the queue into microsoft:main with commit b8260ae Nov 25, 2025
23 checks passed
arisng pushed a commit to arisng/agent-framework that referenced this pull request Feb 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants