github/langchain
1
0
Fork 0
mirror of https://github.com/hwchase17/langchain.git synced 2025-07-16 09:48:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

core: docstrings `BaseCallbackHandler update (#24948)

Browse Source 
Added missed docstrings
This commit is contained in:
Leonid Ganeline 2024-08-01 17:46:53 -07:00 committed by GitHub
parent 6e45dba471
commit 4092876863
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 16 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
libs/core/langchain_core/callbacks/base.py
View File

@ -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: