Repository navigation
Python: Fix build_model_schema using pydantic constraint as field description - #14641
Open
Leon.C (zichen0116) wants to merge 1 commit into
Open
Leon.C (zichen0116) wants to merge 1 commit into
Leon.C (zichen0116) wants to merge 1 commit into
Conversation
Leon.C (zichen0116)
temporarily deployed
to
github-app-auth
October 22, 2026 19:22 — with
GitHub Actions
Inactive
Leon.C (zichen0116)
temporarily deployed
to
github-app-auth
October 22, 2026 19:22 — with
GitHub Actions
Inactive
|
Leon.C (@zichen0116) please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.
Contributor License AgreementContribution License AgreementThis Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
|
This branch was previously deployed
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
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.
Motivation and Context
Closes #14443.
In pydantic v2,
FieldInfo.metadatais a list of constraint/annotation objects (e.g.[Ge(ge=0.0), Le(le=1.0)]), not the field description.KernelJsonSchemaBuilder.build_model_schema()tookmetadata[0]verbatim as the description, which caused two problems:Field(..., description="...")was silently dropped from the generated tool schema.Ge/Leobject, sojson.dumps(schema)raisedTypeError: Object of type Ge is not JSON serializable— breaking function-calling payloads for OpenAI-compatible connectors.Description
In
python/semantic_kernel/schema/kernel_json_schema_builder.py:metadatabranch now only treats a plainstrentry as a description.field_info.description(where pydantic v2 actually stores it).dict-metadatabranch is unchanged.Validation
mainbefore the fix:descriptioncame out asGe(ge=0.0)andjson.dumpsraisedTypeError.python/tests/unit/schema/test_schema_builder.py:test_build_model_schema_with_constrained_field_with_description— constrained field withdescription="nucleus sampling"keeps the string description and the schema serializes.test_build_model_schema_with_constrained_field_without_description— constrained field without a description yields no description key and the schema serializes.pytest tests/unit/schema/test_schema_builder.py: 38 passed (36 existing + 2 new).ruff checkandruff format --checkclean on both touched files.