Add warning about OpenAI models + dict typed tools #3712
+105
−0
Conversation
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
DouweM
requested changes
Dec 12, 2025
|
|
||
| def _map_tool_definition(self, f: ToolDefinition) -> responses.FunctionToolParam: | ||
| if _has_dict_typed_params(f.parameters_json_schema): | ||
| warnings.warn( |
Collaborator
There was a problem hiding this comment.
Let's move the warning into the helper method so that we don't repeat the text
| tools.append({'type': 'image_generation'}) | ||
| return tools | ||
|
|
||
| def _map_tool_definition(self, f: ToolDefinition) -> responses.FunctionToolParam: |
Collaborator
There was a problem hiding this comment.
I think we'll also need to do the check in _map_json_schema
| 'properties': { | ||
| 'dict_list': {'type': 'array', 'items': {'type': 'object', 'additionalProperties': {'type': 'integer'}}} | ||
| } | ||
| } |
Collaborator
There was a problem hiding this comment.
I'd prefer to test this with a tool function that actually has a dict argument, or a BaseModel argument that itself has a dict field, instead of testing the schemas directly.
So maybe can we build an agent with a tool like that, then run it, and test that a warning was emitted?
Comment on lines
+918
to
+921
| f"Tool '{f.name}' has dict-typed parameters that OpenAI's API will silently ignore. " | ||
| f'Use a Pydantic BaseModel with explicit fields instead of dict types, ' | ||
| f'or switch to a different provider which supports dict types. ' | ||
| f'See: https://github.com/pydantic/pydantic-ai/issues/3654', |
Collaborator
There was a problem hiding this comment.
Suggested change
| f"Tool '{f.name}' has dict-typed parameters that OpenAI's API will silently ignore. " | |
| f'Use a Pydantic BaseModel with explicit fields instead of dict types, ' | |
| f'or switch to a different provider which supports dict types. ' | |
| f'See: https://github.com/pydantic/pydantic-ai/issues/3654', | |
| f"Tool {f.name!r} has `dict`-typed parameters that OpenAI's API will silently ignore. " | |
| f'Use a Pydantic `BaseModel`, `dataclass`, or `TypedDict` with explicit fields instead, ' | |
| f'or switch to a different provider which supports `dict` types. ' | |
| f'See: https://github.com/pydantic/pydantic-ai/issues/3654', |
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.
Closes #3654 by adding a warning when an OpenAI-powered agent has a tool with a
dict-typed argument.