-
Notifications
You must be signed in to change notification settings - Fork 5.1k
fix(responses): normalize streamed function call names #3605
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
scarab-systems
wants to merge
2
commits into
openai:main
Choose a base branch
from
scarab-systems:scarab-systems/openai-python-3472-response-stream-name
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
47 changes: 47 additions & 0 deletions
47
src/openai/lib/streaming/responses/_stream_event_normalizer.py
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| from __future__ import annotations | ||
|
|
||
| from ...._utils import is_mapping | ||
|
|
||
|
|
||
| class ResponseStreamEventNormalizer: | ||
| def __init__(self) -> None: | ||
| self._function_call_names_by_item_id: dict[str, str] = {} | ||
|
|
||
| def normalize(self, data: object) -> object: | ||
| if not is_mapping(data): | ||
| return data | ||
|
|
||
| event_type = data.get("type") | ||
| if event_type == "response.output_item.added": | ||
| self._remember_function_call_name(data) | ||
| elif event_type == "response.function_call_arguments.done" and "name" not in data: | ||
| return self._with_function_call_name(data) | ||
|
|
||
| return data | ||
|
|
||
| def _remember_function_call_name(self, data: object) -> None: | ||
| if not is_mapping(data): | ||
| return | ||
|
|
||
| item = data.get("item") | ||
| if not is_mapping(item) or item.get("type") != "function_call": | ||
| return | ||
|
|
||
| item_id = item.get("id") | ||
| name = item.get("name") | ||
| if isinstance(item_id, str) and isinstance(name, str): | ||
| self._function_call_names_by_item_id[item_id] = name | ||
|
|
||
| def _with_function_call_name(self, data: object) -> object: | ||
| if not is_mapping(data): | ||
| return data | ||
|
|
||
| item_id = data.get("item_id") | ||
| if not isinstance(item_id, str): | ||
| return data | ||
|
|
||
| name = self._function_call_names_by_item_id.get(item_id) | ||
| if name is None: | ||
| return data | ||
|
|
||
| return {**data, "name": name} | ||
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
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When a caller uses
responses.retrieve(response_id, stream=True, starting_after=N)andNis at or after the correspondingresponse.output_item.addedevent, the resumed stream does not replay the event that populates this map. If the nextresponse.function_call_arguments.donepayload omitsname, this branch returns it unchanged, so strict validation still raises becauseResponseFunctionCallArgumentsDoneEvent.nameis required. The normalization needs a fallback that does not depend exclusively on observing an earlier event in the same connection.Useful? React with 👍 / 👎.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I checked this path against the current stream helpers. Direct
responses.retrieve(..., stream=True, starting_after=N)can omit the earlier event that carries the function name, so the SDK cannot reconstruct a truthfulnamefrom that partial stream alone. I left that out of this patch rather than synthesizing an unknown value; a broader fix would need API support, a schema/model decision, or an explicit prefetch/state design for resumed raw streams.