feat(examples): add robust error handling script #2415
+108
−0
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.
This PR adds a new example script,
examples/error_handling.py
, to demonstrate how to gracefully handle the common API errors documented in the README (AuthenticationError
,NotFoundError
,BadRequestError
, etc.).This is a common requirement for developers building robust applications, and having a dedicated, runnable example will be a valuable resource. The script is designed to run successfully even if the
OPENAI_API_KEY
is not set, making it easy for new users to test.Key Features of the Example:
try...except
for specificopenai
error types.status_code
,request_id
, and the error message from the response body.This addresses a gap in the current examples and should help new users get up to speed on best practices for production-ready code.