Workaround OpenAI bug with streaming error events #7085
Merged
+160
−3
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
Contributor
There was a problem hiding this comment.
Pull request overview
This PR implements a workaround for an OpenAI SDK bug where streaming error events are sent in a format different from the documented specification. The OpenAI service embeds error information in a nested error object, but the SDK deserializes it at the top level, causing the properties to be null.
Key changes:
- Added fallback logic to extract error details from raw JSON when SDK deserialization fails
- Added comprehensive test coverage for three error format scenarios: documented format, actual undocumented format, and missing error information
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| src/Libraries/Microsoft.Extensions.AI.OpenAI/OpenAIResponsesChatClient.cs | Implements workaround to extract error information from raw JSON Patch when OpenAI SDK fails to deserialize error properties correctly |
| test/Libraries/Microsoft.Extensions.AI.OpenAI.Tests/OpenAIResponseClientTests.cs | Adds three test cases validating error parsing for documented format, undocumented/alternative format, and graceful handling when no error information is present |
src/Libraries/Microsoft.Extensions.AI.OpenAI/OpenAIResponsesChatClient.cs
Show resolved
Hide resolved
test/Libraries/Microsoft.Extensions.AI.OpenAI.Tests/OpenAIResponseClientTests.cs
Show resolved
Hide resolved
eiriktsarpalis
approved these changes
Nov 26, 2025
|
Thanks a lot for fixing this, looking forward to test it. |
Member
Author
|
Should be Tuesday |
This was referenced Dec 11, 2025
This was referenced Dec 24, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
openai/openai-dotnet#849
Closes microsoft/agent-framework#2428
Microsoft Reviewers: Open in CodeFlow