Skip to content

fix(python): preserve Pydantic field descriptions in schemas #14454

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.

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Open
S.J. (cstolting-collab) wants to merge 1 commit into
base: main
Choose a base branch
from
+14 −5
Open

fix(python): preserve Pydantic field descriptions in schemas #14454

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 2 additions & 5 deletions python/semantic_kernel/schema/kernel_json_schema_builder.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,12 +89,9 @@ def build_model_schema(
field_description = None
if hasattr(model, "model_fields") and field_name in model.model_fields:
field_info = model.model_fields[field_name]
if isinstance(field_info.metadata, dict):
field_description = getattr(field_info, "description", None)
if field_description is None and isinstance(getattr(field_info, "metadata", None), dict):
field_description = field_info.metadata.get("description")
elif isinstance(field_info.metadata, list) and field_info.metadata:
field_description = field_info.metadata[0]
elif hasattr(field_info, "description"):
field_description = field_info.description
if not cls._is_optional(field_type):
required.append(field_name)
properties[field_name] = cls.build(field_type, field_description, structured_output)
Expand Down
12 changes: 12 additions & 0 deletions python/tests/unit/schema/test_schema_builder.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
from unittest.mock import Mock

import pytest
from pydantic import Field

from semantic_kernel.connectors.utils.structured_output_schema import generate_structured_output_response_format_schema
from semantic_kernel.kernel_pydantic import KernelBaseModel
Expand Down Expand Up @@ -76,6 +77,10 @@ class PydanticReasoning(KernelBaseModel):
final_answer: str


class PydanticModelWithConstrainedField(KernelBaseModel):
top_p: float = Field(default=0.9, ge=0.0, le=1.0, description="nucleus sampling")


class NonPydanticStep:
explanation: str
output: str
Expand Down Expand Up @@ -156,6 +161,13 @@ def test_build_model_schema():
assert result == expected_schema


def test_build_model_schema_uses_pydantic_description_with_constraints():
schema = KernelJsonSchemaBuilder.build_model_schema(PydanticModelWithConstrainedField)

assert schema["properties"]["top_p"] == {"type": "number", "description": "nucleus sampling"}
json.dumps(schema)


def test_build_from_type_name():
expected_schema = {"type": "string", "description": "A simple string"}
result = KernelJsonSchemaBuilder.build_from_type_name("str", description="A simple string")
Expand Down
Loading