Build and run agents you can see, understand and trust.
Python agentchatbotlarge-language-modelsllmllm-agentmcpmulti-agentmulti-modalreact-agentrealtime-agentvoice-agentvoice-assistant
fix(toolkit): merge $defs when extending tool function schema with nested models (#941)
qbc873cfe20252b
diff --git a/src/agentscope/tool/_registered_tool_function.py b/src/agentscope/tool/_registered_tool_function.pyindex c1438977f..be2535f40 100644--- a/src/agentscope/tool/_registered_tool_function.py+++ b/src/agentscope/tool/_registered_tool_function.py@@ -69,6 +69,7 @@ class RegisteredToolFunction:extended_schema,)+ # Merge properties from extended schemafor key, value in extended_schema["properties"].items():if key in self.json_schema["function"]["parameters"]["properties"]:raise ValueError(@@ -83,4 +84,43 @@ class RegisteredToolFunction:if "required" not in merged_schema["function"]["parameters"]:merged_schema["function"]["parameters"]["required"] = []merged_schema["function"]["parameters"]["required"].append(key)++ # Merge $defs from extended schema to support nested models+ if "$defs" in extended_schema:+ merged_params = merged_schema["function"]["parameters"]+ if "$defs" not in merged_params:+ merged_params["$defs"] = {}++ # Check for conflicts and merge $defs+ for def_key, def_value in extended_schema["$defs"].items():+ def_value_copy = deepcopy(def_value)+ _remove_title_field(+ def_value_copy,+ ) # pylint: disable=protected-access++ if def_key in merged_params["$defs"]:+ # Check if the two definitions are from the same BaseModel+ # by comparing their content+ # Create copies and remove title fields for comparison++ existing_def_copy = deepcopy(+ merged_params["$defs"][def_key],+ )+ _remove_title_field(+ existing_def_copy,+ ) # pylint: disable=protected-access++ if existing_def_copy != def_value_copy:+ # The definitions are different, raise an error+ raise ValueError(+ f"The $defs key `{def_key}` conflicts with "+ f"existing definition in function schema of "+ f"`{self.name}`.",+ )+ # The definitions are the same (from the same BaseModel),+ # skip merging this key+ continue++ merged_params["$defs"][def_key] = def_value_copy+return merged_schemadiff --git a/tests/toolkit_test.py b/tests/toolkit_test.pyindex 605a02691..9642d294e 100644--- a/tests/toolkit_test.py+++ b/tests/toolkit_test.py@@ -1,5 +1,6 @@# -*- coding: utf-8 -*-# mypy: disable-error-code="index"+# pylint: disable=too-many-lines"""Test toolkit module in agentscope."""import asyncioimport time@@ -127,6 +128,25 @@ class StructuredModel(BaseModel):arg3: int = Field(description="Test argument 3.")+class MyBaseModel1(BaseModel):+ """A base model for testing nested $defs merging."""++ c: int = Field(description="Field c")+++class MyBaseModel2(BaseModel):+ """A base model that contains nested MyBaseModel1."""++ b: list[MyBaseModel1] = Field(description="List of MyBaseModel1")+++class ExtendedModelReusingBaseModel(BaseModel):+ """Extended model that reuses the same BaseModel from original function."""++ another_model: MyBaseModel2 = Field(description="Reusing MyBaseModel2")+ extra_field: str = Field(description="Extra field")++class ToolkitTest(IsolatedAsyncioTestCase):"""Unittest for the toolkit module."""@@ -412,6 +432,94 @@ class ToolkitTest(IsolatedAsyncioTestCase):chunk,)+ async def test_extended_model_reusing_same_base_model(self) -> None:+ """Test extended model reusing the same BaseModel from original+ function."""++ def func_with_nested_model(a: MyBaseModel2) -> ToolResponse:+ """Function with nested BaseModel parameter."""+ return ToolResponse(+ content=[+ TextBlock(+ type="text",+ text=f"a: {a}",+ ),+ ],+ )++ self.toolkit.register_tool_function(func_with_nested_model)++ # Set extended model that reuses the same MyBaseModel2+ self.toolkit.set_extended_model(+ "func_with_nested_model",+ ExtendedModelReusingBaseModel,+ )++ # Get and verify the schema - should not raise any conflicts+ schemas = self.toolkit.get_json_schemas()+ self.assertListEqual(+ schemas,+ [+ {+ "type": "function",+ "function": {+ "name": "func_with_nested_model",+ "parameters": {+ "$defs": {+ "MyBaseModel1": {+ "description": "A base model for testing"+ " nested $defs merging.",+ "properties": {+ "c": {+ "description": "Field c",+ "title": "C",+ "type": "integer",+ },+ },+ "required": ["c"],+ "title": "MyBaseModel1",+ "type": "object",+ },+ "MyBaseModel2": {+ "description": "A base model that contains"+ " nested MyBaseModel1.",+ "properties": {+ "b": {+ "description": "List of "+ "MyBaseModel1",+ "items": {+ "$ref": "#/$defs/MyBaseModel1",+ },+ "title": "B",+ "type": "array",+ },+ },+ "required": ["b"],+ "title": "MyBaseModel2",+ "type": "object",+ },+ },+ "properties": {+ "a": {"$ref": "#/$defs/MyBaseModel2"},+ "another_model": {+ "$ref": "#/$defs/MyBaseModel2",+ "description": "Reusing MyBaseModel2",+ },+ "extra_field": {+ "description": "Extra field",+ "type": "string",+ },+ },+ "required": ["a", "another_model", "extra_field"],+ "type": "object",+ },+ "description": "Function with nested BaseModel "+ "parameter.",+ },+ },+ ],+ )+async def test_detailed_arguments(self) -> None:"""Verify the arguments in `register_tool_function`."""