fix(types): make ResponseFunctionWebSearch.action Optional - #3626
Open
Xsidz wants to merge 1 commit into
Open
Conversation
Fixes openai#3179: the API can return a web_search_call item with action=null (observed on completed searches that returned cached results). The field was typed as non-optional, causing AttributeError at action.type access. Applied to both responses/ and beta/ variants.
1 task
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
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.
Summary
Fixes #3179.
The API returns
web_search_callitems withaction=nullfor completed searches (observed when results come from cache). Theactionfield was typed as non-optionalAction, so any code accessingitem.action.typeraisedAttributeError: 'NoneType' object has no attribute 'type'.Changed
action: Actiontoaction: Optional[Action] = Nonein both theresponses/andbeta/variants ofResponseFunctionWebSearch.Test plan
tests/test_models.pyandtests/test_transform.py: 114 passed, 0 failures.Optionalwas already imported in both files — no import changes needed.