-
Notifications
You must be signed in to change notification settings - Fork 4.3k
fix(images): add optional content_filter_results to Image model + test coverage #2597
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix(images): add optional content_filter_results to Image model + test coverage #2597
Conversation
Hi OpenAI team 👋
This PR addresses an issue where the content_filter_results field, which is
sometimes returned by the Images API, was not present in the SDK Image model.
I added this optional field and included a dedicated test to confirm it is
properly handled.
Let me know if you’d like me to extend the test with more categories or add
docs coverage. Thanks for reviewing 🚀
Hi team 👋
This PR is focused and ready:
- Marks
content_filter_resultsas optional in Image responses. - Adds tests for both presence and absence.
- No runtime changes, just typing + coverage.
I believe this is a good candidate for a quick merge since it improves developer experience with minimal surface area. Happy to rebase or adjust if needed. 🚀
Context
The Images API may return additional metadata such as
content_filter_results(for categories like sexual_minors, violence, etc.). This field was missing
from the current
Imagemodel in the SDK, causing a mismatch between the APIpayload and the SDK types.
Changes
content_filter_results: Optional[Dict[str, Any]]toImagemodel.tests/test_images_missing_fields.py) that mocks theAPI response with
revised_promptandcontent_filter_resultsand assertsthat the SDK parses them correctly.
Why
This change ensures the SDK fully reflects the Images API payload and avoids
loss of safety-related metadata. It also improves test coverage for optional
fields that the API may include.