Build and run agents you can see, understand and trust.
Python agentchatbotlarge-language-modelsllmllm-agentmcpmulti-agentmulti-modalreact-agentrealtime-agentvoice-agentvoice-assistant
fix(utils): remove dangling discriminators when flattening schemas (#3618)
Liu Hao4db9b4530a1a
diff --git a/src/agentscope/_utils/_common.py b/src/agentscope/_utils/_common.pyindex 6045c3902..1e94f9970 100644--- a/src/agentscope/_utils/_common.py+++ b/src/agentscope/_utils/_common.py@@ -336,7 +336,10 @@ def _flatten_json_schema(schema: dict) -> dict:This function resolves every such reference by substituting the fulldefinition inline, then drops the ``$defs`` / ``definitions``- sections so the output is a flat, self-contained schema.+ sections so the output is a flat, self-contained schema. Discriminators+ mapping to removed definitions are dropped: their mapping values must+ be strings, not inline schemas. Union branches and their constraints+ are preserved. Other discriminators are left unchanged.Circular references are detected and replaced with a fallback objectschema to avoid infinite recursion. Only local references of the@@ -406,6 +409,16 @@ def _flatten_json_schema(schema: dict) -> dict:continueif key in _INSTANCE_VALUE_KEYWORDS:resolved[key] = value+ elif key == "discriminator" and isinstance(value, dict):+ mapping = value.get("mapping")+ if isinstance(mapping, dict) and any(+ isinstance(ref, str)+ and ref.startswith(("#/$defs/", "#/definitions/"))+ and ref.rsplit("/", 1)[-1] in defs+ for ref in mapping.values()+ ):+ continue+ resolved[key] = valueelif key in _SCHEMA_MAP_KEYWORDS and isinstance(value, dict):resolved[key] = {name: _resolve_ref(sub, visited)diff --git a/tests/model_gemini_test.py b/tests/model_gemini_test.pyindex ad7947b45..a7c058944 100644--- a/tests/model_gemini_test.py+++ b/tests/model_gemini_test.py@@ -6,13 +6,16 @@ Tests cover both non-streaming and streaming modes.Gemini uses google.genai client with async iterator streaming."""import base64+import copyimport jsonfrom types import SimpleNamespace-from typing import Any+from typing import Any, Annotated, Literalimport unittestfrom unittest import IsolatedAsyncioTestCasefrom unittest.mock import AsyncMock, MagicMock, patch+from pydantic import BaseModel, Field+from utils import AnyStringfrom agentscope.formatter import GeminiChatFormatter@@ -1411,6 +1414,179 @@ class TestGeminiSchemaUtils(unittest.TestCase):},)+ def test_flatten_removes_local_discriminators(self) -> None:+ """Flattened unions retain constraints without dangling mappings."""++ class Ring(BaseModel):+ """One branch of the discriminated union."""++ kind: Literal["ring"]+ radius: float++ class Disc(BaseModel):+ """The other branch of the discriminated union."""++ kind: Literal["disc"]+ diameter: float++ class ShapeTool(BaseModel):+ """Tool schema containing a discriminated union."""++ shape: Annotated[Ring | Disc, Field(discriminator="kind")]++ class Drawing(BaseModel):+ """A branch containing another discriminated union."""++ kind: Literal["drawing"]+ shape: Annotated[Ring | Disc, Field(discriminator="kind")]++ class DrawingTool(BaseModel):+ """Tool schema containing nested discriminated unions."""++ drawing: Annotated[Drawing | Ring, Field(discriminator="kind")]++ ring = {+ "description": "One branch of the discriminated union.",+ "properties": {+ "kind": {"const": "ring", "title": "Kind", "type": "string"},+ "radius": {"title": "Radius", "type": "number"},+ },+ "required": ["kind", "radius"],+ "title": "Ring",+ "type": "object",+ }+ disc = {+ "description": "The other branch of the discriminated union.",+ "properties": {+ "kind": {"const": "disc", "title": "Kind", "type": "string"},+ "diameter": {"title": "Diameter", "type": "number"},+ },+ "required": ["kind", "diameter"],+ "title": "Disc",+ "type": "object",+ }+ shape = {+ "oneOf": [ring, disc],+ "title": "Shape",+ }+ for model, expected in (+ (+ ShapeTool,+ {+ "description": (+ "Tool schema containing a discriminated union."+ ),+ "properties": {"shape": shape},+ "required": ["shape"],+ "title": "ShapeTool",+ "type": "object",+ },+ ),+ (+ DrawingTool,+ {+ "description": (+ "Tool schema containing nested discriminated unions."+ ),+ "properties": {+ "drawing": {+ "oneOf": [+ {+ "description": (+ "A branch containing another "+ "discriminated union."+ ),+ "properties": {+ "kind": {+ "const": "drawing",+ "title": "Kind",+ "type": "string",+ },+ "shape": shape,+ },+ "required": ["kind", "shape"],+ "title": "Drawing",+ "type": "object",+ },+ ring,+ ],+ "title": "Drawing",+ },+ },+ "required": ["drawing"],+ "title": "DrawingTool",+ "type": "object",+ },+ ),+ ):+ with self.subTest(model=model.__name__):+ schema = model.model_json_schema()+ original = copy.deepcopy(schema)+ self.assertEqual(_flatten_json_schema(schema), expected)+ self.assertEqual(schema, original)++ def test_flatten_removes_local_discriminators_from_anyof(self) -> None:+ """Local mappings are removed for both definition dialects."""+ branch = {+ "type": "object",+ "properties": {"kind": {"type": "string", "enum": ["ring"]}},+ "required": ["kind"],+ }+ for keyword in ("$defs", "definitions"):+ with self.subTest(keyword=keyword):+ ref = f"#/{keyword}/Ring"+ self.assertEqual(+ _flatten_json_schema(+ {+ keyword: {"Ring": branch},+ "anyOf": [{"$ref": ref}],+ "discriminator": {+ "propertyName": "kind",+ "mapping": {+ "ring": ref,+ "remote": "https://example.com/schema",+ },+ },+ },+ ),+ {"anyOf": [branch]},+ )++ def test_flatten_keeps_other_discriminators(self) -> None:+ """Mappings unrelated to removed definitions stay unchanged."""+ for discriminator in (+ {"propertyName": "kind"},+ {"propertyName": "kind", "mapping": {}},+ {+ "propertyName": "kind",+ "mapping": {+ "missing": "#/$defs/Ghost",+ "legacy": "#/definitions/Ghost",+ "remote": "https://example.com/schema",+ "implicit": "Ring",+ },+ },+ ):+ with self.subTest(discriminator=discriminator):+ self.assertEqual(+ _flatten_json_schema(+ {+ "$defs": {"Ring": {"type": "object"}},+ "discriminator": discriminator,+ },+ ),+ {"discriminator": discriminator},+ )++ discriminator = {+ "propertyName": "kind",+ "mapping": {"ring": "#/$defs/Ring"},+ }+ self.assertEqual(+ _flatten_json_schema({"discriminator": discriminator}),+ {"discriminator": discriminator},+ )+def test_flatten_keeps_property_names(self) -> None:"""Schema keywords used as property names are preserved."""for keyword in (