.NET: Forward AG-UI forwarded properties from chat options#6651
Open
jstar0 wants to merge 1 commit into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR fixes a gap in the .NET AGUIChatClient request construction by forwarding AG-UI “forwarded properties” from ChatOptions.AdditionalProperties into the RunAgentInput payload, aligning client behavior with the hosting/server-side path and unblocking scenarios that need forwardedProps in the request body.
Changes:
- Populate
RunAgentInput.ForwardedPropertiesfromChatOptions.AdditionalProperties["ag_ui_forwarded_properties"]when the value is aJsonElement. - Add a regression unit test that validates forwarded properties are present in the serialized run input.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| dotnet/src/Microsoft.Agents.AI.AGUI/AGUIChatClient.cs | Adds extraction of ag_ui_forwarded_properties from ChatOptions and wires it into RunAgentInput. |
| dotnet/tests/Microsoft.Agents.AI.AGUI.UnitTests/AGUIChatClientTests.cs | Adds a regression test and request-capture plumbing to assert forwarded properties are sent. |
Comment on lines
+292
to
+302
| private static JsonElement ExtractForwardedPropertiesFromOptions(ChatOptions? options) | ||
| { | ||
| if (options?.AdditionalProperties is null || | ||
| !options.AdditionalProperties.TryGetValue("ag_ui_forwarded_properties", out object? forwardedProperties) || | ||
| forwardedProperties is not JsonElement jsonElement) | ||
| { | ||
| return default; | ||
| } | ||
|
|
||
| return jsonElement; | ||
| } |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 & Context
AGUIChatClientcurrently buildsRunAgentInputwithout copying AG-UI forwarded properties fromChatOptions.AdditionalProperties["ag_ui_forwarded_properties"], so client callers cannot populate theforwardedPropsfield in the request body.This fixes #6600.
Description & Review Guide
What are the major changes?
RunAgentInput.ForwardedPropertiesfromChatOptions.AdditionalProperties["ag_ui_forwarded_properties"]when the value is aJsonElement.What is the impact of these changes?
What do you want reviewers to focus on?
JsonElementvalues here, matching the existingRunAgentInput.ForwardedPropertiesshape.Verification:
Related Issue
Fixes #6600
Contribution Checklist
breaking changelabel (or add "[BREAKING]" to the title prefix, before or after any language prefix) - a workflow keeps the label and title prefix in sync automatically.