Update OpenAIResponsesChatClient to handle streaming code interpreter content#7267
Open
stephentoub wants to merge 2 commits intodotnet:mainfrom
Open
Update OpenAIResponsesChatClient to handle streaming code interpreter content#7267stephentoub wants to merge 2 commits intodotnet:mainfrom
stephentoub wants to merge 2 commits intodotnet:mainfrom
Conversation
… content Right now it outputs it but in a bulk fashion only at the end of the response item. This makes it yield the deltas instead.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the OpenAI Responses chat client to handle streaming code interpreter content by yielding deltas incrementally rather than emitting the code in bulk only at the end of the response. This enables real-time streaming of code generation, improving the user experience.
Changes:
- Added streaming support for code interpreter delta updates, creating
CodeInterpreterToolCallContentfor each delta as it arrives - Extracted the Python media type string into a reusable constant (
PythonMediaType) - Added comprehensive test coverage to verify delta streaming behavior and proper coalescing of deltas into final responses
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
src/Libraries/Microsoft.Extensions.AI.OpenAI/OpenAIResponsesChatClient.cs |
Added handling for StreamingResponseCodeInterpreterCallCodeDeltaUpdate to yield deltas incrementally; inlined code interpreter content creation logic (removing helper method); updated OutputItemDone handler to only yield result content (assuming deltas handled the call content) |
src/Libraries/Microsoft.Extensions.AI.OpenAI/OpenAIClientExtensions.cs |
Extracted Python media type string into a constant PythonMediaType |
src/Libraries/Microsoft.Extensions.AI.OpenAI/OpenAIAssistantsChatClient.cs |
Updated to use the new PythonMediaType constant |
test/Libraries/Microsoft.Extensions.AI.OpenAI.Tests/OpenAIResponseClientTests.cs |
Updated existing tests with exact code assertions; added new comprehensive test CodeInterpreterTool_Streaming_YieldsCodeDeltas to verify streaming delta behavior and proper coalescing |
Comment on lines
235
to
246
| message.Contents.Add(new CodeInterpreterToolResultContent | ||
| { | ||
| CallId = cicri.Id, | ||
| Outputs = cicri.Outputs is { Count: > 0 } outputs ? outputs.Select<CodeInterpreterCallOutput, AIContent?>(o => | ||
| o switch | ||
| { | ||
| CodeInterpreterCallImageOutput cicio => new UriContent(cicio.ImageUri, OpenAIClientExtensions.ImageUriToMediaType(cicio.ImageUri)) { RawRepresentation = cicio }, | ||
| CodeInterpreterCallLogsOutput ciclo => new TextContent(ciclo.Logs) { RawRepresentation = ciclo }, | ||
| _ => null, | ||
| }).OfType<AIContent>().ToList() : null, | ||
| RawRepresentation = cicri, | ||
| }); |
There was a problem hiding this comment.
The logic for creating CodeInterpreterToolResultContent with output mapping is duplicated between the non-streaming path (lines 235-246) and the streaming path (lines 471-482). Consider extracting this into a helper method to reduce duplication and improve maintainability. This would ensure that any future changes to the output mapping logic only need to be made in one place.
src/Libraries/Microsoft.Extensions.AI.OpenAI/OpenAIResponsesChatClient.cs
Show resolved
Hide resolved
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
1 participant
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.
Right now it outputs it but in a bulk fashion only at the end of the response item. This makes it yield the deltas instead.
Microsoft Reviewers: Open in CodeFlow