fix(types): make action optional in ResponseFunctionWebSearch#3181
Open
anishesg wants to merge 1 commit intoopenai:mainfrom
Open
fix(types): make action optional in ResponseFunctionWebSearch#3181anishesg wants to merge 1 commit intoopenai:mainfrom
action optional in ResponseFunctionWebSearch#3181anishesg wants to merge 1 commit intoopenai:mainfrom
Conversation
The `action` field in `ResponseFunctionWebSearch` was typed as a required non-optional `Action`, but the API can return `action=None` for `web_search_call` items (for example, when a search has already completed). This mismatch caused `AttributeError` at runtime when code relied on the type annotation to assume `action` was always present. Signed-off-by: anish k <ak8686@princeton.edu>
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
1 participant
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.
The
actionfield inResponseFunctionWebSearchwas typed as a required non-optionalAction, but the API can returnaction=Noneforweb_search_callitems (for example, when a search has already completed). This mismatch causedAttributeErrorat runtime when code relied on the type annotation to assumeactionwas always present.The fix is in
src/openai/types/responses/response_function_web_search.py: changeaction: Actiontoaction: Optional[Action] = None. This is backward compatible — callers that only accessactionwhen it is non-Nonecontinue to work, and callers that previously assumed it was always set will now need to guard with aNonecheck (which the broken behavior already required in practice).Changes being requested
Make
ResponseFunctionWebSearch.actionoptional (Optional[Action] = None) to match actual API responses where the field can be absent on completed web search calls.Additional context & links
Fixes #3179