Improve streaming error handling

[mrutunjay-kinagi]

Summary

• guard both sync and async streams against response.error events and expose AsyncStream.aclose() so clients can always close the underlying response (AsyncStream missing aclose() causes AttributeError in streaming structured output #2853, Bug: Dead code - sse.event == "error" check is unreachable in _streaming.py #2796)
• correct every generated context_management example to use type="compaction" so the tests and API expectations align (context_management=[{"type": "type"}] in tests, not 'compaction' #2868)
• add gpt-audio-mini to the public chat model literal list and mention a smaller Vision example URL with guidance about invalid URL errors (gpt-audio-mini is missing from the ChatModel list — should it be included? #2761, Vision example throws an error #2776)

Testing

• not run (not requested)

Closes #2853, #2796, #2868, #2761, #2776

[mrutunjay-kinagi]

@marcuswood-oai Is this still relevant ?

[chatgpt-codex-connector]

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: df0a203dbc

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

• Open a pull request for review
• Mark a draft as ready
• Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

[marcuswood-oai]

Yes—thanks for checking back, and for fixing the duplicate-yield issue from the review!

I checked current main and tested 3ac0c06. The AsyncStream.aclose() alias is still useful: contextlib.aclosing(stream) raises AttributeError on main and correctly closes the response with this patch. Keeping the existing async close() method makes that addition backward-compatible.

I'd focus this PR on the alias (#2853) and removing the unreachable checks (#2796). Main already raises APIError for nested {"error": ...} payloads in the non-thread branch, including event: error; the dead branch doesn't currently prevent that. We can remove the unreachable blocks while preserving existing event semantics, without the repeated helper calls. Please update the summary accordingly.

Please add focused regression tests for aclosing/response cleanup, exactly-once delivery, and existing error handling in both sync and async streams, including synthesize_event_and_data. The current 20 streaming tests pass, and my additional probes confirmed the duplicate-yield issue is resolved, but these regressions should be covered in the PR.

The other items are worth tracking separately: the missing ChatModel literal and generated compaction examples need fixes in their source schema/configuration, and a smaller Wikimedia image URL isn't yet a verified fix for the download error. Please leave those changes and their closing references out of this focused streaming patch.

Thanks again for working on this—there is still a useful contribution here.

[mrutunjay-kinagi]

Yes—thanks for checking back, and for fixing the duplicate-yield issue from the review!

I checked current main and tested 3ac0c06. The AsyncStream.aclose() alias is still useful: contextlib.aclosing(stream) raises AttributeError on main and correctly closes the response with this patch. Keeping the existing async close() method makes that addition backward-compatible.

I'd focus this PR on the alias (#2853) and removing the unreachable checks (#2796). Main already raises APIError for nested {"error": ...} payloads in the non-thread branch, including event: error; the dead branch doesn't currently prevent that. We can remove the unreachable blocks while preserving existing event semantics, without the repeated helper calls. Please update the summary accordingly.

Please add focused regression tests for aclosing/response cleanup, exactly-once delivery, and existing error handling in both sync and async streams, including synthesize_event_and_data. The current 20 streaming tests pass, and my additional probes confirmed the duplicate-yield issue is resolved, but these regressions should be covered in the PR.

The other items are worth tracking separately: the missing ChatModel literal and generated compaction examples need fixes in their source schema/configuration, and a smaller Wikimedia image URL isn't yet a verified fix for the download error. Please leave those changes and their closing references out of this focused streaming patch.

Thanks again for working on this—there is still a useful contribution here.

@marcuswood-oai

Thank you so much for such quick response. Can you please assign me the relevant issues ? I'll put sometime in getting those resolved.

[marcuswood-oai]

Thanks for the contribution, and sorry for the delay in getting to this! We’re going with #2854 to address this, so I’m closing this PR.

Posted with Codex.

[mrutunjay-kinagi]

Thanks for the contribution, and sorry for the delay in getting to this! We’re going with #2854 to address this, so I’m closing this PR.

@marcuswood-oai Okay, are there any other issues i can contribute to ?