From 40928768633e8fecf669d4a026334520c5d5a0a4 Mon Sep 17 00:00:00 2001 From: Leonid Ganeline Date: Thu, 1 Aug 2024 17:46:53 -0700 Subject: [PATCH] core: docstrings `BaseCallbackHandler update (#24948) Added missed docstrings --- libs/core/langchain_core/callbacks/base.py | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/libs/core/langchain_core/callbacks/base.py b/libs/core/langchain_core/callbacks/base.py index 946018da0fb..7d3c7c0e784 100644 --- a/libs/core/langchain_core/callbacks/base.py +++ b/libs/core/langchain_core/callbacks/base.py @@ -25,7 +25,14 @@ class RetrieverManagerMixin: parent_run_id: Optional[UUID] = None, **kwargs: Any, ) -> Any: - """Run when Retriever errors.""" + """Run when Retriever errors. + + Args: + error (BaseException): The error that occurred. + run_id (UUID): The run ID. This is the ID of the current run. + parent_run_id (UUID): The parent run ID. This is the ID of the parent run. + kwargs (Any): Additional keyword arguments. + """ def on_retriever_end( self, @@ -35,7 +42,14 @@ class RetrieverManagerMixin: parent_run_id: Optional[UUID] = None, **kwargs: Any, ) -> Any: - """Run when Retriever ends running.""" + """Run when Retriever ends running. + + Args: + documents (Sequence[Document]): The documents retrieved. + run_id (UUID): The run ID. This is the ID of the current run. + parent_run_id (UUID): The parent run ID. This is the ID of the parent run. + kwargs (Any): Additional keyword arguments. + """ class LLMManagerMixin: