-
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
Open
lucasalencarxisto-stack
wants to merge
1
commit into
openai:main
from
lucasalencarxisto-stack:tests/images-content-filter-results
Open
fix(images): add optional content_filter_results to Image model + test coverage #2597
lucasalencarxisto-stack
wants to merge
1
commit into
openai:main
from
lucasalencarxisto-stack:tests/images-content-filter-results
+50
−0
Conversation
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
@lucasalencarxisto-stack
lucasalencarxisto-stack
requested a review
from a team
as a code owner
September 1, 2025 00:36
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 🚀
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.
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.