fix(types): make query optional in ActionSearch#3328
Open
brianstrauch wants to merge 2 commits into
Open
Conversation
The `query` field on the web search `search` action is marked [DEPRECATED] and the API no longer returns it, sending only the plural `queries` instead. Typing it as a required `str` causes validation failures when parsing real `web_search_call` payloads. Make it `Optional[str] = None` to match the API.
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: c68832f7c7
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
Mirror the response-side change on the input/param TypedDict so web search `search` actions round-trip: the deprecated `query` field is no longer sent by the API, so it should not be `Required` when passing `web_search_call` items back as input. Dropping `Required` (under the existing `total=False`) makes the key omittable.
seratch
approved these changes
May 28, 2026
Member
seratch
left a comment
seratch
left a comment
There was a problem hiding this comment.
This change sounds reasonable. @apcha-oai Can you take a look?
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
2 participants
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
queryfield on the web searchsearchaction (ActionSearch) is typed as a requiredstr, but it is marked[DEPRECATED]and the API no longer returns it —web_search_callitems now carry only the pluralqueries. Parsing real responses therefore raisesValidationError(ActionSearch.queryField required).Changes being requested
Make
ActionSearch.queryoptional (Optional[str] = None) to match actual API responses where the field is absent.Additional context & links
This is the same class of fix as #3181 (which made the sibling
ResponseFunctionWebSearch.actionoptional) and is related to #3179. It is backward compatible:queryis already deprecated, so callers must tolerate its absence.