Repository navigation
docs: expand and improve error handling documentation (#96) - #240
Merged
ccampbell-aai merged 2 commits intoSep 16, 2026
Merged
Conversation
ccampbell-aai
requested changes
Sep 8, 2026
ccampbell-aai
left a comment
Contributor
There was a problem hiding this comment.
Thank you for taking the time to give detail on these exceptions! I've left a few minor suggestions and improvements but overall this is very well done.
- Note that the streaming RealTimeError does not inherit from AssemblyAIError - Clarify when TranscriptError is raised (HTTP-level failure or polling timeout) - Reference the RedactedAudio*Error classes via assemblyai.types, since they are not exported at the top level Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Contributor
|
Thanks again for this! I pushed a commit to your branch addressing the three review comments (RealTimeError inheritance note, TranscriptError wording, and |
ccampbell-aai
approved these changes
Sep 16, 2026
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.
Description
Fixes #96
This PR expands and clarifies error handling documentation across the SDK:
AssemblyAIError,TranscriptError,SyncTranscriptError,RedactedAudioIncompleteError,RedactedAudioExpiredError,RedactedAudioUnavailableError, andRealTimeError/StreamingError) along with their respective attributes.try...except, validating transcript statuses (aai.TranscriptStatus.error), inspecting HTTP status codes, and accessing raw response headers/body viaClient.get_default().last_response.SyncTranscriptError.error_codestrings andretry_aftertiming for429/503responses.RealTimeEvents.Errorhandlers and mapped viaRealTimeErrorCodes.