docs: document assistant stream failures#1979
Open
HAYDEN-OAI wants to merge 1 commit into
Open
Conversation
1 task
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.
Summary
abortevent alongsideerrorandendAbortSignalor.abort()emitsabortfinalRun()promiseWhy
Issue #959 reports unhandled rejections while retrying or cancelling Assistant streams. The current helper already separates API and SDK failures from cancellations, but the Assistants event docs only showed
errorand did not explain that promise-returning helpers still need their ownawaitorcatch.Impact
Users now have an explicit pattern for handling stream failures before handing a stream to another consumer, including client disconnect and cancellation paths. This clarifies the existing runtime behavior without changing stream semantics.
Validation
pnpm run formatpnpm run lintResolves #959