feat(function_schema): Add support for pydantic Field
annotations in tool arguments (for tools decorated with @function_schema
)
#1124
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
This PR allows you to use the pydantic
Field
decorator to constrain tool arguments for tools decorated with@function_tool
(more specifically, for tools usingfunction_schema
to parse tool arguments). Such constrains include, e.g. limiting integers to a certain range, but in principle, this should work for any constrains supported by the API.Specifically, it enables the following syntax:
Previously, one had to create a nested pydantic
BaseModel
to achieve this functionality.Issue #1123 explains this feature request and the previous workaround.
Example:
Output: (compare to #1123)
Test plan
I added unit tests in
tests/test_function_schema.py
.Issue number
Closes #1123.
Checks
make lint
andmake format
Note: I am happy to add documentation for this; please point me to where I should do so:)