diff --git a/python/packages/core/agent_framework/_clients.py b/python/packages/core/agent_framework/_clients.py index e02b227b9c3..6b998975f61 100644 --- a/python/packages/core/agent_framework/_clients.py +++ b/python/packages/core/agent_framework/_clients.py @@ -360,9 +360,15 @@ def to_dict(self, *, exclude: set[str] | None = None, exclude_none: bool = True) # Get the base dict from SerializationMixin result = super().to_dict(exclude=exclude, exclude_none=exclude_none) - # Extract additional_properties to root level - if self.additional_properties: - result.update(self.additional_properties) + # Extract additional_properties to root level respecting exclusions and exclude_none + if self.additional_properties and (exclude is None or "additional_properties" not in exclude): + exclude_set = exclude or set() + for key, value in self.additional_properties.items(): + if key in exclude_set: + continue + if exclude_none and value is None: + continue + result[key] = value return result diff --git a/python/packages/core/tests/core/test_clients.py b/python/packages/core/tests/core/test_clients.py index 1bdc4ce5c82..bdb770dbc3f 100644 --- a/python/packages/core/tests/core/test_clients.py +++ b/python/packages/core/tests/core/test_clients.py @@ -1564,3 +1564,27 @@ async def fake_inner_get_response(**kwargs): assert appended_messages[0].text == "You are a helpful assistant." assert appended_messages[1].role == "user" assert appended_messages[1].text == "hello" + + +def test_base_chat_client_to_dict_respects_exclude_and_exclude_none() -> None: + class DummyClient(BaseChatClient): + def _inner_get_response(self, *, messages, stream, options, **kwargs): + raise NotImplementedError + + client = DummyClient(additional_properties={"kept": 1, "empty": None, "extra": "val"}) + + # By default, exclude_none=True excludes None values from additional_properties + d_default = client.to_dict() + assert d_default == {"type": "dummy_client", "kept": 1, "extra": "val"} + + # exclude_none=False preserves None values + d_with_none = client.to_dict(exclude_none=False) + assert d_with_none == {"type": "dummy_client", "kept": 1, "empty": None, "extra": "val"} + + # exclude={'additional_properties'} excludes all additional_properties + d_exclude_all = client.to_dict(exclude={"additional_properties"}) + assert d_exclude_all == {"type": "dummy_client"} + + # exclude={'extra'} excludes only the specified additional property key + d_exclude_key = client.to_dict(exclude={"extra"}) + assert d_exclude_key == {"type": "dummy_client", "kept": 1}