fix!: always return structured outputs as dicts#76
Merged
Conversation
3 tasks
Shedna
approved these changes
Jun 1, 2026
This commit removes the output conversion to a `pydantic.BaseModel` when one is passed as structured output schema. This is done for consistency with the task and research methods (where the same conversion cannot be implemented simply). This will also simplify the code and method signatures. With the simplification of the type hints, this was also an opportunity to rework and improve the type hinting of the client's main methods, especially to enforce accurate type hinting per output type and include sources parameter. Doing so required enforcing a limit in the number of positional arguments, which I set quite aggressively to prefer a long term solution. I also enforced the [google style guide import recommendation](https://google.github.io/styleguide/pyguide.html#22-imports), that is to only import modules, for pydantic imports in the files I changed.
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.
This commit removes the output conversion to a
pydantic.BaseModelwhen one is passed as structured output schema. This is done for consistency with the task and research methods (where the same conversion cannot be implemented simply). This will also simplify the code and method signatures.With the simplification of the type hints, this was also an opportunity to rework and improve the type hinting of the client's main methods, especially to enforce accurate type hinting per output type and include sources parameter. Doing so required enforcing a limit in the number of positional arguments, which I set quite aggressively to prefer a long term solution.
I also enforced the google style guide import
recommendation, that is to only import modules, for pydantic imports in the files I changed.
Description
Checklist
prekon this project (for instance with themake install-devcommand)before creating any commit, or I have run successfully the
make lintcommand on my changes.make typecheck testcommand on my changes.README.mdif my changes affected it.