Build and run agents you can see, understand and trust.
Python agentchatbotlarge-language-modelsllmllm-agentmcpmulti-agentmulti-modalreact-agentrealtime-agentvoice-agentvoice-assistant
fix(agent): record compression usage in context (#2433)
老福特ca908a38f35a
diff --git a/src/agentscope/agent/_agent.py b/src/agentscope/agent/_agent.pyindex d51767f37..e0a8e4b6a 100644--- a/src/agentscope/agent/_agent.py+++ b/src/agentscope/agent/_agent.py@@ -739,6 +739,26 @@ class Agent:self.state.summary = new_summaryself.state.context = msgs_to_reserve+ # The compression call is not covered by the model call events,+ # so record its cost on the context tail to keep it in the token+ # accounting+ if res is not None and res.usage is not None:+ if not self.state.context:+ # The whole context is compressed, so carry the cost by an+ # empty message, which is skipped by the formatters+ self.state.append_context(self.name, [])++ self.state.context[-1].append_usage(+ Usage(+ input_tokens=res.usage.input_tokens,+ output_tokens=res.usage.output_tokens,+ cache_input_tokens=res.usage.cache_input_tokens or 0,+ cache_creation_input_tokens=(+ res.usage.cache_creation_input_tokens or 0+ ),+ ),+ )+logger.info("[AGENT %s]: The context compression finished.",self.name,@@ -3449,17 +3469,8 @@ class Agent:self.state.append_context(self.name, persisted_blocks)- tail = self.state.context[-1]if msg_usage is not None:- if tail.usage is None:- tail.usage = msg_usage- else:- tail.usage.input_tokens += msg_usage.input_tokens- tail.usage.output_tokens += msg_usage.output_tokens- tail.usage.cache_input_tokens += msg_usage.cache_input_tokens- tail.usage.cache_creation_input_tokens += (- msg_usage.cache_creation_input_tokens- )+ self.state.context[-1].append_usage(msg_usage)def _get_last_msg(self) -> Msg | None:"""Get the last message in the context that belongs to this agent."""diff --git a/src/agentscope/message/_base.py b/src/agentscope/message/_base.pyindex b5bbf9e16..930c304bf 100644--- a/src/agentscope/message/_base.py+++ b/src/agentscope/message/_base.py@@ -283,22 +283,16 @@ class Msg(BaseModel):self.error = event.errorcase EventType.MODEL_CALL_END:- if self.usage is None:- self.usage = Usage(+ self.append_usage(+ Usage(input_tokens=event.input_tokens,output_tokens=event.output_tokens,cache_input_tokens=event.cache_input_tokens,cache_creation_input_tokens=(event.cache_creation_input_tokens),- )- else:- self.usage.input_tokens += event.input_tokens- self.usage.output_tokens += event.output_tokens- self.usage.cache_input_tokens += event.cache_input_tokens- self.usage.cache_creation_input_tokens += (- event.cache_creation_input_tokens- )+ ),+ )case EventType.TEXT_BLOCK_START:self.content.append(TextBlock(id=event.block_id, text=""))@@ -521,6 +515,24 @@ class Msg(BaseModel):return self+ def append_usage(self, usage: Usage) -> Self:+ """Accumulate the token usage of one model call into this message.++ Args:+ usage (`Usage`):+ The token usage to be accumulated.+ """+ if self.usage is None:+ self.usage = usage+ else:+ self.usage.input_tokens += usage.input_tokens+ self.usage.output_tokens += usage.output_tokens+ self.usage.cache_input_tokens += usage.cache_input_tokens+ self.usage.cache_creation_input_tokens += (+ usage.cache_creation_input_tokens+ )+ return self+def UserMsg(name: str,diff --git a/tests/compress_context_test.py b/tests/compress_context_test.pyindex a4a79acae..7246fa88f 100644--- a/tests/compress_context_test.py+++ b/tests/compress_context_test.py@@ -11,7 +11,7 @@ from unittest.async_case import IsolatedAsyncioTestCasefrom utils import MockModel, AnyString-from agentscope.model import ChatResponse, StructuredResponse+from agentscope.model import ChatResponse, ChatUsage, StructuredResponsefrom agentscope.agent import Agent, ContextConfig, InjectionConfigfrom agentscope.state import AgentStatefrom agentscope.message import (@@ -26,6 +26,7 @@ from agentscope.message import (DataBlock,Base64Source,URLSource,+ Usage,)from agentscope.tool import Toolkitfrom agentscope.workspace import LocalWorkspace@@ -217,6 +218,64 @@ def _make_failing_compression_agent(return agent, model+def _make_usage_recording_compression_agent(+ last_msg_usage: Usage | None = None,+) -> Agent:+ """Build an agent whose compression model response includes usage."""+ model = MockModel(context_size=100)+ last_msg = UserMsg(+ "User",+ "".join(["3" for _ in range(10 * 4)]),+ id="3",+ )+ last_msg.usage = last_msg_usage+ agent = Agent(+ name="Friday",+ system_prompt="".join(["0" for _ in range(20 * 4)]),+ model=model,+ context_config=ContextConfig(+ trigger_ratio=0.7,+ reserve_ratio=0.4,+ ),+ state=AgentState(+ session_id="123",+ context=[+ UserMsg(+ "User",+ "".join(["1" for _ in range(30 * 4)]),+ id="1",+ ),+ AssistantMsg(+ "Friday",+ "".join(["2" for _ in range(10 * 4)]),+ id="2",+ ),+ last_msg,+ ],+ ),+ toolkit=Toolkit(),+ )+ model.set_structured_response(+ StructuredResponse(+ content={+ "task_overview": "1",+ "current_state": "2",+ "important_discoveries": "3",+ "next_steps": "4",+ "context_to_preserve": "5",+ },+ usage=ChatUsage(+ input_tokens=123,+ output_tokens=45,+ time=0.1,+ cache_input_tokens=6,+ cache_creation_input_tokens=7,+ ),+ ),+ )+ return agent++def _has_instruction_hint(messages: list[Msg],instructions: HintBlock,@@ -2412,6 +2471,201 @@ class ContextCompressionTest(IsolatedAsyncioTestCase):],)+ async def test_context_compression_records_usage(self) -> None:+ """The compression usage is recorded on the last retained message."""+ agent = _make_usage_recording_compression_agent()++ await agent.compress_context()++ self.assertListEqual(+ [_.model_dump() for _ in agent.state.context],+ [+ {+ "id": "2",+ "created_at": AnyString(),+ "finished_at": None,+ "finished_reason": None,+ "structured_output": None,+ "error": None,+ "name": "Friday",+ "role": "assistant",+ "content": [+ {+ "id": AnyString(),+ "text": "2" * 40,+ "type": "text",+ "created_at": AnyString(),+ "finished_at": None,+ },+ ],+ "metadata": {},+ "usage": None,+ },+ {+ "id": "3",+ "created_at": AnyString(),+ "finished_at": AnyString(),+ "finished_reason": None,+ "structured_output": None,+ "error": None,+ "name": "User",+ "role": "user",+ "content": [+ {+ "id": AnyString(),+ "text": "3" * 40,+ "type": "text",+ "created_at": AnyString(),+ "finished_at": None,+ },+ ],+ "metadata": {},+ "usage": {+ "input_tokens": 123,+ "output_tokens": 45,+ "cache_input_tokens": 6,+ "cache_creation_input_tokens": 7,+ },+ },+ ],+ )++ async def test_context_compression_accumulates_usage(self) -> None:+ """The compression usage is added to the existing message usage."""+ agent = _make_usage_recording_compression_agent(+ Usage(+ input_tokens=10,+ output_tokens=20,+ cache_input_tokens=3,+ cache_creation_input_tokens=4,+ ),+ )++ await agent.compress_context()++ self.assertListEqual(+ [_.model_dump() for _ in agent.state.context],+ [+ {+ "id": "2",+ "created_at": AnyString(),+ "finished_at": None,+ "finished_reason": None,+ "structured_output": None,+ "error": None,+ "name": "Friday",+ "role": "assistant",+ "content": [+ {+ "id": AnyString(),+ "text": "2" * 40,+ "type": "text",+ "created_at": AnyString(),+ "finished_at": None,+ },+ ],+ "metadata": {},+ "usage": None,+ },+ {+ "id": "3",+ "created_at": AnyString(),+ "finished_at": AnyString(),+ "finished_reason": None,+ "structured_output": None,+ "error": None,+ "name": "User",+ "role": "user",+ "content": [+ {+ "id": AnyString(),+ "text": "3" * 40,+ "type": "text",+ "created_at": AnyString(),+ "finished_at": None,+ },+ ],+ "metadata": {},+ "usage": {+ "input_tokens": 133,+ "output_tokens": 65,+ "cache_input_tokens": 9,+ "cache_creation_input_tokens": 11,+ },+ },+ ],+ )++ async def test_context_compression_without_reserved_context(self) -> None:+ """The compression usage is carried by an empty message when the+ whole context is compressed."""+ model = MockModel(context_size=100)+ agent = Agent(+ name="Friday",+ system_prompt="".join(["0" for _ in range(20 * 4)]),+ model=model,+ context_config=ContextConfig(+ trigger_ratio=0.7,+ reserve_ratio=0.4,+ ),+ state=AgentState(+ session_id="123",+ context=[+ UserMsg(+ "User",+ "".join(["1" for _ in range(55 * 4)]),+ id="1",+ ),+ ],+ ),+ toolkit=Toolkit(),+ )+ model.set_structured_response(+ StructuredResponse(+ content={+ "task_overview": "1",+ "current_state": "2",+ "important_discoveries": "3",+ "next_steps": "4",+ "context_to_preserve": "5",+ },+ usage=ChatUsage(+ input_tokens=123,+ output_tokens=45,+ time=0.1,+ ),+ ),+ )++ # A reserve ratio above the trigger ratio compresses the whole context+ await agent.compress_context(+ ContextConfig(trigger_ratio=0.7, reserve_ratio=0.89),+ )++ self.assertListEqual(+ [_.model_dump() for _ in agent.state.context],+ [+ {+ "id": agent.state.reply_id,+ "created_at": AnyString(),+ "finished_at": None,+ "finished_reason": None,+ "structured_output": None,+ "error": None,+ "name": "Friday",+ "role": "assistant",+ "content": [],+ "metadata": {},+ "usage": {+ "input_tokens": 123,+ "output_tokens": 45,+ "cache_input_tokens": 0,+ "cache_creation_input_tokens": 0,+ },+ },+ ],+ )+async def test_summary_failure_truncates_context(self) -> None:"""Summary failures fall back to lossy context truncation."""agent, _ = _make_failing_compression_agent()