AsyncCallbackManagerForRetrieverRun Class — langchain Architecture
Architecture documentation for the AsyncCallbackManagerForRetrieverRun class in manager.py from the langchain codebase.
Entity Profile
Dependency Diagram
graph TD 5fbae6d9_d86e_b1d9_5c79_7be4a891db16["AsyncCallbackManagerForRetrieverRun"] 3a2e20d8_f61b_1bdd_21d3_f60011fbae36["AsyncParentRunManager"] 5fbae6d9_d86e_b1d9_5c79_7be4a891db16 -->|extends| 3a2e20d8_f61b_1bdd_21d3_f60011fbae36 56648039_2eaa_a31a_370d_3cf895834f0a["RetrieverManagerMixin"] 5fbae6d9_d86e_b1d9_5c79_7be4a891db16 -->|extends| 56648039_2eaa_a31a_370d_3cf895834f0a 35cf5db6_bcb1_b854_6ebb_5e0368e51b58["manager.py"] 5fbae6d9_d86e_b1d9_5c79_7be4a891db16 -->|defined in| 35cf5db6_bcb1_b854_6ebb_5e0368e51b58 7b8da6bd_aa22_67cf_3b0c_409f7157e663["get_sync()"] 5fbae6d9_d86e_b1d9_5c79_7be4a891db16 -->|method| 7b8da6bd_aa22_67cf_3b0c_409f7157e663 a4cde6a3_1174_6c62_002e_6b8c92143fd0["on_retriever_end()"] 5fbae6d9_d86e_b1d9_5c79_7be4a891db16 -->|method| a4cde6a3_1174_6c62_002e_6b8c92143fd0 b98b578b_1a8d_ef2d_8506_bba74411ace3["on_retriever_error()"] 5fbae6d9_d86e_b1d9_5c79_7be4a891db16 -->|method| b98b578b_1a8d_ef2d_8506_bba74411ace3
Relationship Graph
Source Code
libs/core/langchain_core/callbacks/manager.py lines 1229–1301
class AsyncCallbackManagerForRetrieverRun(
AsyncParentRunManager,
RetrieverManagerMixin,
):
"""Async callback manager for retriever run."""
def get_sync(self) -> CallbackManagerForRetrieverRun:
"""Get the equivalent sync `RunManager`.
Returns:
The sync `RunManager`.
"""
return CallbackManagerForRetrieverRun(
run_id=self.run_id,
handlers=self.handlers,
inheritable_handlers=self.inheritable_handlers,
parent_run_id=self.parent_run_id,
tags=self.tags,
inheritable_tags=self.inheritable_tags,
metadata=self.metadata,
inheritable_metadata=self.inheritable_metadata,
)
@shielded
async def on_retriever_end(
self, documents: Sequence[Document], **kwargs: Any
) -> None:
"""Run when the retriever ends running.
Args:
documents: The retrieved documents.
**kwargs: Additional keyword arguments.
"""
if not self.handlers:
return
await ahandle_event(
self.handlers,
"on_retriever_end",
"ignore_retriever",
documents,
run_id=self.run_id,
parent_run_id=self.parent_run_id,
tags=self.tags,
**kwargs,
)
@shielded
async def on_retriever_error(
self,
error: BaseException,
**kwargs: Any,
) -> None:
"""Run when retriever errors.
Args:
error: The error.
**kwargs: Additional keyword arguments.
"""
if not self.handlers:
return
await ahandle_event(
self.handlers,
"on_retriever_error",
"ignore_retriever",
error,
run_id=self.run_id,
parent_run_id=self.parent_run_id,
tags=self.tags,
**kwargs,
)Source
Frequently Asked Questions
What is the AsyncCallbackManagerForRetrieverRun class?
AsyncCallbackManagerForRetrieverRun is a class in the langchain codebase, defined in libs/core/langchain_core/callbacks/manager.py.
Where is AsyncCallbackManagerForRetrieverRun defined?
AsyncCallbackManagerForRetrieverRun is defined in libs/core/langchain_core/callbacks/manager.py at line 1229.
What does AsyncCallbackManagerForRetrieverRun extend?
AsyncCallbackManagerForRetrieverRun extends AsyncParentRunManager, RetrieverManagerMixin.
Analyze Your Own Codebase
Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.
Try Supermodel Free