.NET: Introduce MutableChatClientAgent #1711
Open
+397
−43
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* Initial plan * Make ChatOptions and Instructions public and mutable in ChatClientAgent Co-authored-by: PederHP <127606677+PederHP@users.noreply.github.com> * Add null assertions before using null-forgiving operator in tests Co-authored-by: PederHP <127606677+PederHP@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: PederHP <127606677+PederHP@users.noreply.github.com>
Updated documentation to reflect changes in chat options.
There was a problem hiding this comment.
Pull Request Overview
This PR makes the Instructions and ChatOptions properties of ChatClientAgent mutable, enabling dynamic modification during agent execution. This supports common patterns like updating instructions for caching/trust levels, adjusting reasoning modes, and modifying tool sets at runtime.
Key Changes:
- Changed
_agentOptionsfield from nullable to non-nullable by initializing with empty instance when null - Made
InstructionsandChatOptionsproperties public with setters - Added comprehensive unit tests covering mutation scenarios
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
ChatClientAgent.cs |
Changed _agentOptions to non-nullable, made Instructions and ChatOptions properties public with setters, updated XML documentation, removed null-conditional operators |
ChatClientAgentTests.cs |
Added 7 new test methods covering mutation scenarios for Instructions and ChatOptions properties |
dotnet/tests/Microsoft.Agents.AI.UnitTests/ChatClient/ChatClientAgentTests.cs
Outdated
Show resolved
Hide resolved
dotnet/tests/Microsoft.Agents.AI.UnitTests/ChatClient/ChatClientAgentTests.cs
Outdated
Show resolved
Hide resolved
dotnet/tests/Microsoft.Agents.AI.UnitTests/ChatClient/ChatClientAgentTests.cs
Outdated
Show resolved
Hide resolved
dotnet/tests/Microsoft.Agents.AI.UnitTests/ChatClient/ChatClientAgentTests.cs
Outdated
Show resolved
Hide resolved
dotnet/tests/Microsoft.Agents.AI.UnitTests/ChatClient/ChatClientAgentTests.cs
Outdated
Show resolved
Hide resolved
dotnet/tests/Microsoft.Agents.AI.UnitTests/ChatClient/ChatClientAgentTests.cs
Outdated
Show resolved
Hide resolved
github-actions
bot
changed the title
Change var to explicit types
|
@microsoft-github-policy-service agree |
* Initial plan * Move mutability to MutableChatClientAgent class Co-authored-by: PederHP <127606677+PederHP@users.noreply.github.com> * Address code review comments Co-authored-by: PederHP <127606677+PederHP@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: PederHP <127606677+PederHP@users.noreply.github.com>
PederHP
changed the title
* Initial plan * Replace var with explicit types in MutableChatClientAgentTests.cs Co-authored-by: PederHP <127606677+PederHP@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: PederHP <127606677+PederHP@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation and Context
Solves #1710
It is a common pattern to have data in the
Instructions(for caching and to achieve highest model trust level). System notifications and reminders are another example of dynamic instruction/system level data.Mutable
ChatOptionsis needed to have agents with dynamic Tool sets and dynamic reasoning/thinking, which is also a common pattern. Another example is Claude skills and container ids.ChatClientAgentRunOptionscould be used as an alternative to this, but it is awkward, and for Tools it only allows adding Tools not changing the available Tools or removing some of them.I believe it is needed to support both per-request overrides and mutable agent properties. The alternative is to create a new agent whenever mutation is needed and migrate state to it.
Description
If no
ChatClientAgentOptionsare provided in the constructor a default is instantiated. This is functionally equivalent to the current behavior and allows making the properties mentioned above public and mutable.Contribution Checklist