langchain_core.callbacks.manager
.AsyncCallbackManagerForChainGroup¶
- class langchain_core.callbacks.manager.AsyncCallbackManagerForChainGroup(handlers: List[BaseCallbackHandler], inheritable_handlers: Optional[List[BaseCallbackHandler]] = None, parent_run_id: Optional[UUID] = None, *, parent_run_manager: AsyncCallbackManagerForChainRun, **kwargs: Any)[source]¶
异步回调管理器,用于链式组。
初始化回调管理器。
Attributes
is_async
返回处理程序是否为异步。
Methods
__init__
(handlers[, inheritable_handlers, ...])初始化回调管理器。
add_handler
(handler[, inherit])添加一个处理程序到回调管理器。
add_metadata
(metadata[, inherit])add_tags
(tags[, inherit])configure
([inheritable_callbacks, ...])配置异步回调管理器。
copy
()复制回调管理器。
on_chain_end
(outputs, **kwargs)当跟踪的链组结束时运行。
on_chain_error
(error, **kwargs)当链式错误发生时运行。
on_chain_start
(serialized, inputs[, run_id])当链开始运行时运行。
on_chat_model_start
(serialized, messages[, ...])当LLM开始运行时运行。
on_llm_start
(serialized, prompts[, run_id])当LLM开始运行时运行。
on_retriever_start
(serialized, query[, ...])当检索器开始运行时运行。
on_tool_start
(serialized, input_str[, ...])当工具开始运行时运行。
remove_handler
(handler)从回调管理器中移除一个处理程序。
remove_metadata
(keys)remove_tags
(tags)set_handler
(handler[, inherit])将处理程序设置为回调管理器上唯一的处理程序。
set_handlers
(handlers[, inherit])将处理程序设置为回调管理器上唯一的处理程序。
- Parameters
handlers (List[BaseCallbackHandler]) –
inheritable_handlers (Optional[List[BaseCallbackHandler]]) –
parent_run_id (Optional[UUID]) –
parent_run_manager (AsyncCallbackManagerForChainRun) –
kwargs (Any) –
- Return type
None
- __init__(handlers: List[BaseCallbackHandler], inheritable_handlers: Optional[List[BaseCallbackHandler]] = None, parent_run_id: Optional[UUID] = None, *, parent_run_manager: AsyncCallbackManagerForChainRun, **kwargs: Any) None [source]¶
初始化回调管理器。
- Parameters
handlers (List[BaseCallbackHandler]) –
inheritable_handlers (Optional[List[BaseCallbackHandler]]) –
parent_run_id (Optional[UUID]) –
parent_run_manager (AsyncCallbackManagerForChainRun) –
kwargs (Any) –
- Return type
None
- add_handler(handler: BaseCallbackHandler, inherit: bool = True) None ¶
添加一个处理程序到回调管理器。
- Parameters
handler (BaseCallbackHandler) –
inherit (bool) –
- Return type
None
- add_metadata(metadata: Dict[str, Any], inherit: bool = True) None ¶
- Parameters
metadata (Dict[str, Any]) –
inherit (bool) –
- Return type
None
- add_tags(tags: List[str], inherit: bool = True) None ¶
- Parameters
tags (List[str]) –
inherit (bool) –
- Return type
None
- classmethod configure(inheritable_callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, local_callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, verbose: bool = False, inheritable_tags: Optional[List[str]] = None, local_tags: Optional[List[str]] = None, inheritable_metadata: Optional[Dict[str, Any]] = None, local_metadata: Optional[Dict[str, Any]] = None) AsyncCallbackManager ¶
配置异步回调管理器。
- 参数:
inheritable_callbacks(可选[Callbacks],可选):可继承的回调。默认为None。 local_callbacks(可选[Callbacks],可选):本地回调。默认为None。 verbose(bool,可选):是否启用详细模式。默认为False。 inheritable_tags(可选[List[str]],可选):可继承的标签。默认为None。 local_tags(可选[List[str]],可选):本地标签。默认为None。 inheritable_metadata(可选[Dict[str, Any]],可选):可继承的元数据。默认为None。 local_metadata(可选[Dict[str, Any]],可选):本地元数据。默认为None。
- 返回:
AsyncCallbackManager:配置好的异步回调管理器。
- Parameters
inheritable_callbacks (Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]]) –
local_callbacks (Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]]) –
verbose (bool) –
inheritable_tags (Optional[List[str]]) –
local_tags (Optional[List[str]]) –
inheritable_metadata (Optional[Dict[str, Any]]) –
local_metadata (Optional[Dict[str, Any]]) –
- Return type
- copy() AsyncCallbackManagerForChainGroup [source]¶
复制回调管理器。
- Return type
- async on_chain_end(outputs: Union[Dict[str, Any], Any], **kwargs: Any) None [source]¶
当跟踪的链组结束时运行。
- 参数:
outputs (Union[Dict[str, Any], Any]): 链的输出。
- Parameters
outputs (Union[Dict[str, Any], Any]) –
kwargs (Any) –
- Return type
None
- async on_chain_error(error: BaseException, **kwargs: Any) None [source]¶
当链式错误发生时运行。
- 参数:
error (Exception或KeyboardInterrupt): 错误。
- Parameters
error (BaseException) –
kwargs (Any) –
- Return type
None
- async on_chain_start(serialized: Dict[str, Any], inputs: Union[Dict[str, Any], Any], run_id: Optional[UUID] = None, **kwargs: Any) AsyncCallbackManagerForChainRun ¶
当链开始运行时运行。
- 参数:
serialized(Dict[str,Any]):序列化的链。 inputs(Union[Dict[str,Any],Any]):链的输入。 run_id(UUID,可选):运行的ID。默认为None。
- 返回:
AsyncCallbackManagerForChainRun:链运行的异步回调管理器。
- Parameters
serialized (Dict[str, Any]) –
inputs (Union[Dict[str, Any], Any]) –
run_id (Optional[UUID]) –
kwargs (Any) –
- Return type
- async on_chat_model_start(serialized: Dict[str, Any], messages: List[List[BaseMessage]], run_id: Optional[UUID] = None, **kwargs: Any) List[AsyncCallbackManagerForLLMRun] ¶
当LLM开始运行时运行。
- 参数:
serialized(Dict[str, Any]):LLM的序列化对象。 messages(List[List[BaseMessage]]):消息列表。 run_id(UUID,可选):运行的ID。默认为None。
- 返回:
List[AsyncCallbackManagerForLLMRun]:异步回调管理器列表,每个LLM运行对应一个内部消息列表。
- Parameters
serialized (Dict[str, Any]) –
messages (List[List[BaseMessage]]) –
run_id (Optional[UUID]) –
kwargs (Any) –
- Return type
- async on_llm_start(serialized: Dict[str, Any], prompts: List[str], run_id: Optional[UUID] = None, **kwargs: Any) List[AsyncCallbackManagerForLLMRun] ¶
当LLM开始运行时运行。
- 参数:
serialized (Dict[str, Any]): 序列化的LLM。 prompts (List[str]): 提示列表。 run_id (UUID, optional): 运行的ID。默认为None。
- 返回:
List[AsyncCallbackManagerForLLMRun]: 异步回调管理器列表,每个对应一个LLM运行的回调管理器,对应每个提示。
- Parameters
serialized (Dict[str, Any]) –
prompts (List[str]) –
run_id (Optional[UUID]) –
kwargs (Any) –
- Return type
- async on_retriever_start(serialized: Dict[str, Any], query: str, run_id: Optional[UUID] = None, parent_run_id: Optional[UUID] = None, **kwargs: Any) AsyncCallbackManagerForRetrieverRun ¶
当检索器开始运行时运行。
- Parameters
serialized (Dict[str, Any]) –
query (str) –
run_id (Optional[UUID]) –
parent_run_id (Optional[UUID]) –
kwargs (Any) –
- Return type
- async on_tool_start(serialized: Dict[str, Any], input_str: str, run_id: Optional[UUID] = None, parent_run_id: Optional[UUID] = None, **kwargs: Any) AsyncCallbackManagerForToolRun ¶
当工具开始运行时运行。
- 参数:
serialized (Dict[str, Any]): 序列化的工具。 input_str (str): 工具的输入。 run_id (UUID, 可选): 运行的ID。默认为None。 parent_run_id (UUID, 可选): 父运行的ID。默认为None。
- 返回:
AsyncCallbackManagerForToolRun: 用于工具运行的异步回调管理器。
- Parameters
serialized (Dict[str, Any]) –
input_str (str) –
run_id (Optional[UUID]) –
parent_run_id (Optional[UUID]) –
kwargs (Any) –
- Return type
- remove_handler(handler: BaseCallbackHandler) None ¶
从回调管理器中移除一个处理程序。
- Parameters
handler (BaseCallbackHandler) –
- Return type
None
- remove_metadata(keys: List[str]) None ¶
- Parameters
keys (List[str]) –
- Return type
None
- remove_tags(tags: List[str]) None ¶
- Parameters
tags (List[str]) –
- Return type
None
- set_handler(handler: BaseCallbackHandler, inherit: bool = True) None ¶
将处理程序设置为回调管理器上唯一的处理程序。
- Parameters
handler (BaseCallbackHandler) –
inherit (bool) –
- Return type
None
- set_handlers(handlers: List[BaseCallbackHandler], inherit: bool = True) None ¶
将处理程序设置为回调管理器上唯一的处理程序。
- Parameters
handlers (List[BaseCallbackHandler]) –
inherit (bool) –
- Return type
None