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]¶
为链组提供的异步回调管理器。
初始化异步回调管理器。
- 参数
handlers (List[BaseCallbackHandler]) – 处理器列表。
inheritable_handlers (Optional[List[BaseCallbackHandler]]) – 可继承的处理器列表。默认为 None。
parent_run_id (Optional[UUID]) – 父运行 ID。默认为 None。
parent_run_manager (AsyncCallbackManagerForChainRun) – 父运行管理器。
**kwargs (Any) – 额外的关键字参数。
属性
is_async
返回处理器是否为异步。
方法
__init__
(handlers[, inheritable_handlers, ...])初始化异步回调管理器。
add_handler
(handler[, inherit])将处理器添加到回调管理器。
add_metadata
(metadata[, inherit])向回调管理器添加元数据。
add_tags
(tags[, inherit])向回调管理器添加标签。
configure
([inheritable_callbacks, ...])配置异步回调管理器。
复制
()复制异步回调管理器。
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_custom_event
(name, data[, run_id])向处理程序发送一个临时的手事件(异步版本)。
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])将处理程序设置为回调管理器上的唯一处理程序。
- __init__(handlers: List[BaseCallbackHandler], inheritable_handlers: Optional[List[BaseCallbackHandler]] = None, parent_run_id: Optional[UUID] = None, *, parent_run_manager: AsyncCallbackManagerForChainRun, **kwargs: Any) None [source]¶
初始化异步回调管理器。
- 参数
handlers (List[BaseCallbackHandler]) – 处理器列表。
inheritable_handlers (Optional[List[BaseCallbackHandler]]) – 可继承的处理器列表。默认为 None。
parent_run_id (Optional[UUID]) – 父运行 ID。默认为 None。
parent_run_manager (AsyncCallbackManagerForChainRun) – 父运行管理器。
**kwargs (Any) – 额外的关键字参数。
- 返回类型
None
- add_handler(handler: BaseCallbackHandler, inherit: bool = True) None ¶
将处理器添加到回调管理器。
- 参数
handler (BaseCallbackHandler) – 需要添加的处理程序。
inherit (bool) – 是否继承处理程序。默认为True。
- 返回类型
None
- add_metadata(metadata: Dict[str, Any], inherit: bool = True) None ¶
向回调管理器添加元数据。
- 参数
metadata (Dict[str, Any]) – 需要添加的元数据。
inherit (bool) – 是否继承元数据。默认值为 True。
- 返回类型
None
- add_tags(tags: List[str], inherit: bool = True) None ¶
向回调管理器添加标签。
- 参数
tags (List[str]) – 需要添加的标签。
inherit (bool) – 是否继承标签。默认值为 True。
- 返回类型
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 (Optional[Callbacks], optional) – 可以继承的回调。默认为 None。
local_callbacks (Optional[Callbacks], optional) – 当地回调。默认为 None。
verbose (bool, optional) – 是否启用详细模式。默认值为 False。
inheritable_tags (Optional[List[str]], optional) – 可以继承的标签。默认为 None。
local_tags (Optional[List[str]], optional) – 当地标签。默认为 None。
inheritable_metadata (Optional[Dict[str, Any]], optional) – 可以继承的元数据。默认为 None。
local_metadata (Optional[Dict[str, Any]], optional) – 当地元数据。默认为 None。
- 返回
配置好的异步回调管理器。
- 返回类型
- copy() AsyncCallbackManagerForChainGroup [source]¶
复制异步回调管理器。
- async on_chain_end(outputs: Union[Dict[str, Any], Any], **kwargs: Any) None [source]¶
在跟踪链组结束时执行。
- 参数
outputs (Union[Dict[str, Any], Any]) – 链的输出。
**kwargs (Any) – 额外的关键字参数。
- 返回类型
None
- async on_chain_error(error: BaseException, **kwargs: Any) None [source]¶
在链出错时执行。
- 参数
error (Exception 或 KeyboardInterrupt) – 错误。
**kwargs (Any) – 额外的关键字参数。
- 返回类型
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]) – 序列化的链。
输入 (联合[[字典[[字符串, 任何]], 任何]]], 任何]) – 链的输入。
run_id (UUID, 可选) – 运行的ID。默认为None。
**kwargs (Any) – 额外的关键字参数。
- 返回
- 链运行异步回调管理器
。
- 返回类型
- async on_chat_model_start(serialized: 字典[[字符串, 任何], ]], messages: 列表[[BaseMessage]], run_id: 可选[[UUID] = None, **kwargs: 任何) 列表[AsyncCallbackManagerForLLMRun] ¶
当LLM开始运行时异步执行。
- 参数
serialized (字典[字符串, 任何]) – 序列化的LLM。
messages (列表[列表[BaseMessage]]) – 消息列表。
run_id (UUID, 可选) – 运行的ID。默认为None。
**kwargs (Any) – 额外的关键字参数。
- 返回
- 异步回调管理器的
列表,每个内层消息列表对应一个LLM运行。
- 返回类型
- async on_custom_event(name: 字符串, data: 任何, run_id: 可选[[UUID] = None, **kwargs: 任何) None ¶
向处理程序发送一个临时的手事件(异步版本)。
此事件不应在任何内部LangChain代码中使用。该事件专门为库的用户设计,用于分派特定于其应用的定制事件。
- 参数
name (str) – 临时事件的名称。
data (Any) – 临时事件的数据。
run_id (Optional[UUID]) – 运行的ID。默认为None。
kwargs (Any) –
- 返回类型
None
自0.2.14版本起新增。
- asyncon_llm_start(serialized: Dict[str, Any], prompts: List[str], run_id: Optional[UUID] = None, **kwargs: Any) List[AsyncCallbackManagerForLLMRun] ¶
当LLM开始运行时执行。
- 参数
serialized (字典[字符串, 任何]) – 序列化的LLM。
prompts (List[str]) – 提示列表。
run_id (UUID, 可选) – 运行的ID。默认为None。
**kwargs (Any) – 额外的关键字参数。
- 返回
- 异步回调管理器的列表,每个LLM Run对应每个提示一个。
异步回调管理器的列表,每个LLM Run对应每个提示一个。
- 返回类型
- async on_retriever_start(serialized: Dict[str, Any], query: str, run_id: Optional[UUID] = None, parent_run_id: Optional[UUID] = None, **kwargs: Any) AsyncCallbackManagerForRetrieverRun ¶
当检索器开始运行时执行。
- 参数
serialized (Dict[str, Any]) – 序列化的检索器。
query (str) – 查询。
run_id (UUID, 可选) – 运行的ID。默认为None。
parent_run_id (UUID, 可选) – 父运行ID。默认为None。
**kwargs (Any) – 额外的关键字参数。
- 返回
- 链运行异步回调管理器
针对检索运行。
- 返回类型
- 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。
**kwargs (Any) – 额外的关键字参数。
- 返回
- 链运行异步回调管理器
针对工具运行。
- 返回类型
- remove_handler(handler: BaseCallbackHandler) None ¶
从回调管理器中删除一个处理程序。
- 参数
handler (BaseCallbackHandler) – 要移除的处理程序。
- 返回类型
None
- remove_metadata(keys: List[str]) None ¶
从回调管理器中删除元数据。
- 参数
keys (List[str]) – 要移除的键。
- 返回类型
None
- remove_tags(tags: List[str]) None ¶
从回调管理器中删除标签。
- 参数
tags (List[str]) – 要移除的标签。
- 返回类型
None
- set_handler(handler: BaseCallbackHandler, inherit: bool = True) None ¶
将处理器设置为回调管理器上的唯一处理器。
- 参数
handler (BaseCallbackHandler) – 要设置的处理器。
inherit (bool) – 是否继承处理程序。默认为True。
- 返回类型
None
- set_handlers(handlers: List[BaseCallbackHandler], inherit: bool = True) None ¶
将处理程序设置为回调管理器上的唯一处理程序。
- 参数
handlers (List[BaseCallbackHandler]) – 要设置的处理器列表。
继承 (布尔值) – 是否继承处理器。默认为True。
- 返回类型
None