Skip to content

Build and run agents you can see, understand and trust.

fix(rag): clean up static hints when streams close (#3363)

kaijin3a5d4a884f63
diff --git a/src/agentscope/middleware/_rag.py b/src/agentscope/middleware/_rag.py
index 5d5b58b3f..3757965fc 100644
--- a/src/agentscope/middleware/_rag.py
+++ b/src/agentscope/middleware/_rag.py
@@ -944,7 +944,8 @@ class RAGMiddleware(MiddlewareBase):
block is removed from the context right after the reasoning
step it participated in — keyed on the block's id so other
middlewares can append their own blocks to the same carrier
- message without interfering.
+ message without interfering. Cleanup also runs if the stream
+ is closed while yielding the hint event.
Args:
agent (`Agent`):
@@ -962,44 +963,49 @@ class RAGMiddleware(MiddlewareBase):
"""
hint: HintBlock | None = None
- if (
- self._parameters.mode == "static"
- and agent.state.cur_iter == 0
- and self._cached_inputs
- ):
- try:
- results = await _search_across(
- self._knowledge_bases,
- self._cached_inputs,
- top_k=self._parameters.top_k,
- score_threshold=self._parameters.score_threshold,
- rerank_model=self._rerank_model,
- rerank_candidate_k=self._parameters.rerank_candidate_k,
- rerank_prompt=self._parameters.rerank_prompt,
- )
- except Exception: # pylint: disable=broad-except
- logger.exception(
- "Knowledge-base search failed; proceeding without "
- "matched context.",
- )
- results = []
-
- blocks = _format_results(results)
- if blocks:
- hint = HintBlock(
- hint=_wrap_hint(self._parameters.hint_template, blocks),
- source=_HINT_SOURCE,
- )
- agent.state.append_context(agent.name, [hint])
- if self._parameters.emit_hint_event:
- yield HintBlockEvent(
- reply_id=agent.state.reply_id,
- block_id=hint.id,
- source=hint.source,
- hint=hint.hint,
+ try:
+ if (
+ self._parameters.mode == "static"
+ and agent.state.cur_iter == 0
+ and self._cached_inputs
+ ):
+ try:
+ results = await _search_across(
+ self._knowledge_bases,
+ self._cached_inputs,
+ top_k=self._parameters.top_k,
+ score_threshold=self._parameters.score_threshold,
+ rerank_model=self._rerank_model,
+ rerank_candidate_k=(
+ self._parameters.rerank_candidate_k
+ ),
+ rerank_prompt=self._parameters.rerank_prompt,
+ )
+ except Exception: # pylint: disable=broad-except
+ logger.exception(
+ "Knowledge-base search failed; proceeding without "
+ "matched context.",
)
+ results = []
+
+ blocks = _format_results(results)
+ if blocks:
+ hint = HintBlock(
+ hint=_wrap_hint(
+ self._parameters.hint_template,
+ blocks,
+ ),
+ source=_HINT_SOURCE,
+ )
+ agent.state.append_context(agent.name, [hint])
+ if self._parameters.emit_hint_event:
+ yield HintBlockEvent(
+ reply_id=agent.state.reply_id,
+ block_id=hint.id,
+ source=hint.source,
+ hint=hint.hint,
+ )
- try:
async for evt in next_handler(**input_kwargs):
yield evt
finally:
diff --git a/tests/middleware_rag_test.py b/tests/middleware_rag_test.py
index ac5cec875..c47629cda 100644
--- a/tests/middleware_rag_test.py
+++ b/tests/middleware_rag_test.py
@@ -1,6 +1,7 @@
# -*- coding: utf-8 -*-
"""Unit tests for the :class:`RAGMiddleware` class."""
-from contextlib import AsyncExitStack
+import asyncio
+from contextlib import AsyncExitStack, aclosing
from types import SimpleNamespace
from typing import Any, AsyncGenerator
from unittest.async_case import IsolatedAsyncioTestCase
@@ -12,6 +13,7 @@ from agentscope.event import EventType, HintBlockEvent
from agentscope.message import (
Base64Source,
DataBlock,
+ HintBlock,
Msg,
TextBlock,
UserMsg,
@@ -238,7 +240,9 @@ async def _drain(generator: AsyncGenerator) -> list:
return [item async for item in generator]
-class RAGMiddlewareTest(IsolatedAsyncioTestCase):
+class RAGMiddlewareTest( # pylint: disable=too-many-public-methods
+ IsolatedAsyncioTestCase,
+):
"""The test cases for the :class:`RAGMiddleware` class."""
async def asyncSetUp(self) -> None:
@@ -462,6 +466,83 @@ class RAGMiddlewareTest(IsolatedAsyncioTestCase):
)
self.assertEqual(events[1], "reasoning-evt")
+ async def test_static_hint_cleanup_after_hint_event(self) -> None:
+ """Closing or throwing at the hint event respects persistence
+ and preserves blocks supplied by other middlewares."""
+
+ async def check_exit(exit_mode: str, persist_hint: bool) -> None:
+ middleware = self._middleware(
+ mode="static",
+ top_k=1,
+ persist_hint=persist_hint,
+ )
+ agent = _make_agent()
+ reasoning_started = []
+
+ async def reasoning_next(**_kwargs: Any) -> AsyncGenerator:
+ reasoning_started.append(True)
+ yield "reasoning-evt"
+
+ async def reply_next(**_kwargs: Any) -> AsyncGenerator:
+ async with aclosing(
+ middleware.on_reasoning(
+ agent=agent,
+ input_kwargs={"tool_choice": None},
+ next_handler=reasoning_next,
+ ),
+ ) as stream:
+ event = await anext(stream)
+ self.assertIsInstance(event, HintBlockEvent)
+ carrier = agent.state.context[-1]
+ injected_hint = carrier.content[0]
+ self.assertEqual(injected_hint.id, event.block_id)
+ other_hint = HintBlock(hint="Another middleware")
+ carrier.content.append(other_hint)
+
+ if exit_mode == "close":
+ await stream.aclose()
+ else:
+ error = (
+ RuntimeError("consumer failed")
+ if exit_mode == "error"
+ else asyncio.CancelledError()
+ )
+ with self.assertRaises(type(error)) as caught:
+ await stream.athrow(error)
+ self.assertIs(caught.exception, error)
+
+ self.assertEqual(
+ carrier.content,
+ [injected_hint, other_hint]
+ if persist_hint
+ else [other_hint],
+ )
+ yield "reply-evt"
+
+ events = await _drain(
+ middleware.on_reply(
+ agent=agent,
+ input_kwargs={
+ "inputs": UserMsg(
+ name="user",
+ content="Where is Paris?",
+ ),
+ },
+ next_handler=reply_next,
+ ),
+ )
+ self.assertEqual(events, ["reply-evt"])
+ self.assertEqual(reasoning_started, [])
+
+ for exit_mode, persist_hint in [
+ ("close", False),
+ ("close", True),
+ ("error", False),
+ ("cancel", False),
+ ]:
+ with self.subTest(exit_mode=exit_mode, persist_hint=persist_hint):
+ await check_exit(exit_mode, persist_hint)
+
async def test_static_skips_event_inputs(self) -> None:
"""Non-message inputs (resumption events / ``None``) skip the
search entirely."""