Build and run agents you can see, understand and trust.
Python agentchatbotlarge-language-modelsllmllm-agentmcpmulti-agentmulti-modalreact-agentrealtime-agentvoice-agentvoice-assistant
feat(model): avoid streaming tool input regression (#1356)
YingchaoX8204103d7549
diff --git a/src/agentscope/_utils/_common.py b/src/agentscope/_utils/_common.pyindex 5f1814abb..cc09f48f1 100644--- a/src/agentscope/_utils/_common.py+++ b/src/agentscope/_utils/_common.py@@ -69,6 +69,31 @@ def _json_loads_with_repair(return {}+def _parse_streaming_json_dict(+ json_str: str,+ last_input: dict | None = None,+) -> dict:+ """Parse a streaming JSON dict without regressing on incomplete chunks.++ If the current chunk already forms a valid JSON dict, prefer it directly.+ Otherwise, fall back to repaired JSON and keep the previous parsed value+ only when repair would shrink the intermediate structure.+ """+ json_str = json_str or "{}"+ try:+ result = json.loads(json_str)+ if isinstance(result, dict):+ return result+ except Exception:+ pass++ repaired_input = _json_loads_with_repair(json_str)+ last_input = last_input or {}+ if len(json.dumps(last_input)) > len(json.dumps(repaired_input)):+ return last_input+ return repaired_input++def _is_accessible_local_file(url: str) -> bool:"""Check if the given URL is a local URL."""# First identify if it's an uri with 'file://' schema,diff --git a/src/agentscope/model/_anthropic_model.py b/src/agentscope/model/_anthropic_model.pyindex ec4269c45..7e99ac63c 100644--- a/src/agentscope/model/_anthropic_model.py+++ b/src/agentscope/model/_anthropic_model.py@@ -2,7 +2,6 @@# pylint: disable=too-many-branches, too-many-statements"""The Anthropic API model classes."""import copy-import jsonimport warningsfrom datetime import datetimefrom typing import (@@ -23,6 +22,7 @@ from ._model_usage import ChatUsagefrom .._logging import loggerfrom .._utils._common import (_json_loads_with_repair,+ _parse_streaming_json_dict,_create_tool_from_base_model,)from ..message import TextBlock, ToolUseBlock, ThinkingBlock@@ -475,16 +475,10 @@ class AnthropicChatModel(ChatModelBase):# If parsing the tool input in streaming modeif self.stream_tool_parsing:- repaired_input = _json_loads_with_repair(- input_str or "{}",+ repaired_input = _parse_streaming_json_dict(+ input_str,+ last_input_objs.get(tool_id),)- # If the new repaired input is shorter than one in the- # last chunk, use the last one to avoid regression- last_input = last_input_objs.get(tool_id, {})- if len(json.dumps(last_input)) > len(- json.dumps(repaired_input),- ):- repaired_input = last_inputlast_input_objs[tool_id] = repaired_inputelse:diff --git a/src/agentscope/model/_dashscope_model.py b/src/agentscope/model/_dashscope_model.pyindex cd727fc7f..f91f7dd11 100644--- a/src/agentscope/model/_dashscope_model.py+++ b/src/agentscope/model/_dashscope_model.py@@ -25,6 +25,7 @@ from ._model_response import ChatResponsefrom ._model_usage import ChatUsagefrom .._utils._common import (_json_loads_with_repair,+ _parse_streaming_json_dict,_create_tool_from_base_model,)from ..message import TextBlock, ToolUseBlock, ThinkingBlock@@ -413,16 +414,10 @@ class DashScopeChatModel(ChatModelBase):# If parsing the tool input in streaming modeif self.stream_tool_parsing:- repaired_input = _json_loads_with_repair(- input_str or "{}",+ repaired_input = _parse_streaming_json_dict(+ input_str,+ last_input_objs.get(tool_id),)- # If the new repaired input is shorter than one in the last- # chunk, use the last one to avoid regression- last_input = last_input_objs.get(tool_id, {})- if len(json.dumps(last_input)) > len(- json.dumps(repaired_input),- ):- repaired_input = last_inputlast_input_objs[tool_id] = repaired_inputelse:diff --git a/src/agentscope/model/_openai_model.py b/src/agentscope/model/_openai_model.pyindex 61a224964..81179d62c 100644--- a/src/agentscope/model/_openai_model.py+++ b/src/agentscope/model/_openai_model.py@@ -2,7 +2,6 @@# pylint: disable=too-many-branches"""OpenAI Chat model class."""import copy-import jsonimport warningsfrom datetime import datetimefrom typing import (@@ -21,7 +20,10 @@ from . import ChatResponsefrom ._model_base import ChatModelBasefrom ._model_usage import ChatUsagefrom .._logging import logger-from .._utils._common import _json_loads_with_repair+from .._utils._common import (+ _json_loads_with_repair,+ _parse_streaming_json_dict,+)from ..message import (ToolUseBlock,TextBlock,@@ -458,16 +460,10 @@ class OpenAIChatModel(ChatModelBase):# If parsing the tool input in streaming modeif self.stream_tool_parsing:- repaired_input = _json_loads_with_repair(- input_str or "{}",+ repaired_input = _parse_streaming_json_dict(+ input_str,+ last_input_objs.get(tool_id),)- # If the new repaired input is shorter than one in the- # last chunk, use the last one to avoid regression- last_input = last_input_objs.get(tool_id, {})- if len(json.dumps(last_input)) > len(- json.dumps(repaired_input),- ):- repaired_input = last_inputlast_input_objs[tool_id] = repaired_inputelse:diff --git a/tests/model_anthropic_test.py b/tests/model_anthropic_test.pyindex 7358604cb..158bf3448 100644--- a/tests/model_anthropic_test.py+++ b/tests/model_anthropic_test.py@@ -326,6 +326,78 @@ class TestAnthropicChatModel(IsolatedAsyncioTestCase):]self.assertEqual(final_response.content, expected_content)+ async def test_streaming_tool_input_prefers_valid_final_json(self) -> None:+ """Test streaming tool input keeps the final valid JSON dict."""+ with patch("anthropic.AsyncAnthropic") as mock_client_class:+ mock_client = AsyncMock()+ mock_client_class.return_value = mock_client++ model = AnthropicChatModel(+ model_name="claude-3-sonnet-20240229",+ api_key="test_key",+ stream=True,+ )+ model.client = mock_client++ events = [+ AnthropicEventMock(+ "message_start",+ message=Mock(usage=Mock(input_tokens=10, output_tokens=0)),+ ),+ AnthropicEventMock(+ "content_block_start",+ index=0,+ content_block=AnthropicContentBlockMock(+ "tool_use",+ id="tool_123",+ name="score",+ ),+ ),+ AnthropicEventMock(+ "content_block_delta",+ index=0,+ delta=Mock(+ type="input_json_delta",+ partial_json='{"points": ',+ ),+ ),+ AnthropicEventMock(+ "content_block_delta",+ index=0,+ delta=Mock(+ type="input_json_delta",+ partial_json="1}",+ ),+ ),+ AnthropicEventMock(+ "message_delta",+ usage=Mock(output_tokens=5),+ ),+ ]++ async def mock_stream() -> AsyncGenerator:+ for event in events:+ yield event++ mock_client.messages.create = AsyncMock(return_value=mock_stream())+ result = await model([{"role": "user", "content": "Score it"}])++ responses = []+ async for response in result:+ responses.append(response)++ final_response = responses[-1]+ expected_content = [+ ToolUseBlock(+ type="tool_use",+ id="tool_123",+ name="score",+ input={"points": 1},+ raw_input='{"points": 1}',+ ),+ ]+ self.assertEqual(final_response.content, expected_content)+async def test_generate_kwargs_integration(self) -> None:"""Test integration of generate_kwargs."""with patch("anthropic.AsyncAnthropic") as mock_client_class:diff --git a/tests/model_dashscope_test.py b/tests/model_dashscope_test.pyindex e6ce77abb..cf100fb59 100644--- a/tests/model_dashscope_test.py+++ b/tests/model_dashscope_test.py@@ -340,6 +340,62 @@ class TestDashScopeChatModel(IsolatedAsyncioTestCase):]self.assertEqual(final_response.content, expected_content)+ async def test_streaming_tool_input_prefers_valid_final_json(self) -> None:+ """Test streaming tool input keeps the final valid JSON dict."""+ model = DashScopeChatModel(+ model_name="qwen-turbo",+ api_key="test_key",+ stream=True,+ )++ chunks = [+ self._create_mock_chunk(+ tool_calls=[+ {+ "index": 0,+ "id": "call_123",+ "function": {+ "name": "score",+ "arguments": '{"points": ',+ },+ },+ ],+ ),+ self._create_mock_chunk(+ tool_calls=[+ {+ "index": 0,+ "id": "call_123",+ "function": {+ "arguments": "1}",+ },+ },+ ],+ ),+ ]++ with patch(+ "dashscope.aigc.generation.AioGeneration.call",+ ) as mock_call:+ mock_call.return_value = self._create_async_generator(chunks)+ result = await model([{"role": "user", "content": "Score it"}])++ responses = []+ async for response in result:+ responses.append(response)++ final_response = responses[-1]+ expected_content = [+ ToolUseBlock(+ type="tool_use",+ id="call_123",+ name="score",+ input={"points": 1},+ raw_input='{"points": 1}',+ ),+ ]+ self.assertEqual(final_response.content, expected_content)+def test_tools_schema_validation_through_api(self) -> None:"""Test tools schema validation through API call."""model = DashScopeChatModel(diff --git a/tests/model_openai_test.py b/tests/model_openai_test.pyindex 62353aa4b..bd5e18b99 100644--- a/tests/model_openai_test.py+++ b/tests/model_openai_test.py@@ -249,6 +249,64 @@ class TestOpenAIChatModel(IsolatedAsyncioTestCase):expected_content = [TextBlock(type="text", text="Hello there!")]self.assertEqual(final_response.content, expected_content)+ async def test_streaming_tool_input_prefers_valid_final_json(self) -> None:+ """Test streaming tool input keeps the final valid JSON dict."""+ with patch("openai.AsyncClient") as mock_client_class:+ mock_client = AsyncMock()+ mock_client_class.return_value = mock_client++ model = OpenAIChatModel(+ model_name="gpt-4",+ api_key="test_key",+ stream=True,+ )+ model.client = mock_client++ stream_mock = self._create_stream_mock(+ [+ {+ "tool_calls": [+ {+ "id": "call_123",+ "name": "score",+ "arguments": '{"points": ',+ },+ ],+ },+ {+ "tool_calls": [+ {+ "id": "call_123",+ "name": "score",+ "arguments": "1}",+ },+ ],+ },+ ],+ )++ mock_client.chat.completions.create = AsyncMock(+ return_value=stream_mock,+ )++ result = await model([{"role": "user", "content": "Score it"}])++ responses = []+ async for response in result:+ responses.append(response)++ final_response = responses[-1]+ expected_content = [+ ToolUseBlock(+ type="tool_use",+ id="call_123",+ name="score",+ input={"points": 1},+ raw_input='{"points": 1}',+ ),+ ]+ self.assertEqual(final_response.content, expected_content)+# Auxiliary methods - ensure all Mock objects have complete attributesdef _create_mock_response(self,