NotificationsYou must be signed in to change notification settings
Fork1k
Star11k

Document breaking changes in v0.4.0#2154

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Merged

DouweM merged 1 commit intomainfrom0-4-0-breaking-changes

Jul 8, 2025

Merged

Document breaking changes in v0.4.0#2154

DouweM merged 1 commit intomainfrom0-4-0-breaking-changes

Jul 8, 2025

+6 −0

Conversation

Copy link

Contributor

DouweM commentedJul 8, 2025

See#1799 - Pydantic EvalsEvaluationReport andReportCase are now generic dataclasses instead of Pydantic models. If you were serializing them usingmodel_dump(), you will now need to use theEvaluationReportAdapter andReportCaseAdapter type adapters instead.

See#1507 - TheToolDefinitiondescription argument is now optional and the order of positional arguments has changed fromname, description, parameters_json_schema, ... toname, parameters_json_schema, description, ... to account for this.

Document breaking changes in v0.4.0

eeac1b4

DouweM self-assigned this

Jul 8, 2025

Copy link

Contributor

hyperlint-aibot commentedJul 8, 2025

PR Change Summary

Documented breaking changes in version 0.4.0 of PydanticAI, including updates to dataclass usage and argument order in ToolDefinition.

UpdatedEvaluationReport andReportCase to be generic dataclasses instead of Pydantic models.
IntroducedEvaluationReportAdapter andReportCaseAdapter for serialization.
Made thedescription argument inToolDefinition optional and changed the order of positional arguments.

Modified Files

docs/changelog.md

How can I customize these reviews?

Check out theHyperlint AI Reviewer docs for more information on how to customize the review.

If you just want to ignore it on this PR, you can add thehyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to addhyperlint-ignore to the PR to ignore the link check for this PR.