Skip to content

Fix incorrectly parsing event fieldnames in yielding responses #2363

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 5 commits into
base: main
Choose a base branch
from
Open

Fix incorrectly parsing event fieldnames in yielding responses #2363

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
987e23c
Add is_valid_event to _streaming.py
idantene May 19, 2025
a116039
Use is_valid_event when yielding _streaming.py
idantene May 19, 2025
88d4553
Merge branch 'main' into patch-1
idantene Jul 16, 2025
ea0ff9e
Merge branch 'main' into patch-1
idantene Jul 17, 2025
efda660
Merge branch 'main' into patch-1
idantene Jul 24, 2025
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
19 changes: 12 additions & 7 deletions src/openai/_streaming.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,12 +59,7 @@ def __stream__(self) -> Iterator[_T]:
if sse.data.startswith("[DONE]"):
break

if sse.event is None or (
sse.event.startswith("response.") or
sse.event.startswith("transcript.") or
sse.event.startswith("image_edit.") or
sse.event.startswith("image_generation.")
):
if is_valid_event(sse.event):
data = sse.json()
if is_mapping(data) and data.get("error"):
message = None
Expand Down Expand Up @@ -166,7 +161,7 @@ async def __stream__(self) -> AsyncIterator[_T]:
if sse.data.startswith("[DONE]"):
break

if sse.event is None or sse.event.startswith("response.") or sse.event.startswith("transcript."):
if is_valid_event(sse.event):
data = sse.json()
if is_mapping(data) and data.get("error"):
message = None
Expand Down Expand Up @@ -390,6 +385,16 @@ def is_stream_class_type(typ: type) -> TypeGuard[type[Stream[object]] | type[Asy
return inspect.isclass(origin) and issubclass(origin, (Stream, AsyncStream))


def is_valid_event(event: str | None) -> bool:
"""Given an event fieldname, checks if it is a response, transcript, or None"""
VALID_EVENTS = ("response", "transcript", "image_edit", "image_generation")
if event is None:
return True
if event in VALID_EVENTS or any(event.startswith(f"{e}.") for e in VALID_EVENTS):
return True
return False


def extract_stream_chunk_type(
stream_cls: type,
*,
Expand Down