Skip to content

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.

Sign up for GitHub

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
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(images): add optional content_filter_results to Image model + test coverage #2597

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 50 additions & 0 deletions tests/test_images_missing_fields.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
import httpx
import pytest
from openai import AsyncOpenAI, DefaultAsyncHttpxClient

@pytest.mark.anyio
async def test_images_generate_includes_content_filter_results_async():
"""
Ensure the Image model exposes optional fields returned by the API,
specifically `content_filter_results` (keeping `revised_prompt` coverage).
"""
mock_json = {
"created": 1711111111,
"data": [
{
"url": "https://example.test/cat.png",
"revised_prompt": "a cute cat wearing sunglasses",
"content_filter_results": {
"sexual_minors": {"filtered": False},
"violence": {"filtered": False},
},
}
],
}

# Async handler because we'll use AsyncOpenAI (httpx.AsyncClient under the hood)
async def ahandler(request: httpx.Request) -> httpx.Response:
assert "images" in str(request.url).lower()
return httpx.Response(200, json=mock_json)

atransport = httpx.MockTransport(ahandler)

client = AsyncOpenAI(
api_key="test",
http_client=DefaultAsyncHttpxClient(transport=atransport),
timeout=10.0,
)

resp = await client.images.generate(model="gpt-image-1", prompt="cat with glasses") # type: ignore

assert hasattr(resp, "data") and isinstance(resp.data, list) and resp.data
item = resp.data[0]

# existing field
assert item.revised_prompt == "a cute cat wearing sunglasses"

# new optional field
cfr = item.content_filter_results
assert isinstance(cfr, dict), f"content_filter_results should be dict, got {type(cfr)}"
assert cfr.get("violence", {}).get("filtered") is False
assert cfr.get("sexual_minors", {}).get("filtered") is False