langchain_core.callbacks.base.BaseCallbackManager

class langchain_core.callbacks.base.BaseCallbackManager(handlers: List[BaseCallbackHandler], inheritable_handlers: Optional[List[BaseCallbackHandler]] = None, parent_run_id: Optional[UUID] = None, *, tags: Optional[List[str]] = None, inheritable_tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, inheritable_metadata: Optional[Dict[str, Any]] = None)[source]

处理来自LangChain的回调的基本回调管理器。

初始化回调管理器。

Attributes

is_async

回调管理器是否是异步的。

Methods

__init__(handlers[, inheritable_handlers, ...])

初始化回调管理器。

add_handler(handler[, inherit])

添加一个处理程序到回调管理器。

add_metadata(metadata[, inherit])

add_tags(tags[, inherit])

copy()

复制回调管理器。

on_chain_start(serialized, inputs, *, run_id)

当链开始运行时运行。

on_chat_model_start(serialized, messages, *, ...)

当聊天模型开始运行时运行。

on_llm_start(serialized, prompts, *, run_id)

LLM 启动时运行。

on_retriever_start(serialized, query, *, run_id)

当Retriever开始运行时运行。

on_tool_start(serialized, input_str, *, run_id)

当工具开始运行时运行。

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]) –

  • tags (Optional[List[str]]) –

  • inheritable_tags (Optional[List[str]]) –

  • metadata (Optional[Dict[str, Any]]) –

  • inheritable_metadata (Optional[Dict[str, Any]]) –

Return type

None

__init__(handlers: List[BaseCallbackHandler], inheritable_handlers: Optional[List[BaseCallbackHandler]] = None, parent_run_id: Optional[UUID] = None, *, tags: Optional[List[str]] = None, inheritable_tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, inheritable_metadata: Optional[Dict[str, Any]] = None) → None[source]

初始化回调管理器。

Parameters

  • handlers (List[BaseCallbackHandler]) –

  • inheritable_handlers (Optional[List[BaseCallbackHandler]]) –

  • parent_run_id (Optional[UUID]) –

  • tags (Optional[List[str]]) –

  • inheritable_tags (Optional[List[str]]) –

  • metadata (Optional[Dict[str, Any]]) –

  • inheritable_metadata (Optional[Dict[str, Any]]) –

Return type

None

add_handler(handler: BaseCallbackHandler, inherit: bool = True) → None[source]

添加一个处理程序到回调管理器。

Parameters
Return type

None

add_metadata(metadata: Dict[str, Any], inherit: bool = True) → None[source]
Parameters

  • metadata (Dict[str, Any]) –

  • inherit (bool) –

Return type

None

add_tags(tags: List[str], inherit: bool = True) → None[source]
Parameters

  • tags (List[str]) –

  • inherit (bool) –

Return type

None

copy() → T[source]

复制回调管理器。

Parameters

self (T) –

Return type

T

on_chain_start(serialized: Dict[str, Any], inputs: Dict[str, Any], *, run_id: UUID, parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, **kwargs: Any) → Any

当链开始运行时运行。

Parameters

  • serialized (Dict[str, Any]) –

  • inputs (Dict[str, Any]) –

  • run_id (UUID) –

  • parent_run_id (Optional[UUID]) –

  • tags (Optional[List[str]]) –

  • metadata (Optional[Dict[str, Any]]) –

  • kwargs (Any) –

Return type

Any

on_chat_model_start(serialized: Dict[str, Any], messages: List[List[BaseMessage]], *, run_id: UUID, parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, **kwargs: Any) → Any

当聊天模型开始运行时运行。

注意 : 此方法用于聊天模型。如果您正在为非聊天模型实现处理程序，则应改用on_llm_start。

Parameters

  • serialized (Dict[str, Any]) –

  • messages (List[List[BaseMessage]]) –

  • run_id (UUID) –

  • parent_run_id (Optional[UUID]) –

  • tags (Optional[List[str]]) –

  • metadata (Optional[Dict[str, Any]]) –

  • kwargs (Any) –

Return type

Any

on_llm_start(serialized: Dict[str, Any], prompts: List[str], *, run_id: UUID, parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, **kwargs: Any) → Any

LLM 启动时运行。

注意 : 当前方法用于非聊天模型（常规 LLM）。如果您正在为聊天模型实现处理程序，则应该使用 on_chat_model_start。

Parameters

  • serialized (Dict[str, Any]) –

  • prompts (List[str]) –

  • run_id (UUID) –

  • parent_run_id (Optional[UUID]) –

  • tags (Optional[List[str]]) –

  • metadata (Optional[Dict[str, Any]]) –

  • kwargs (Any) –

Return type

Any

on_retriever_start(serialized: Dict[str, Any], query: str, *, run_id: UUID, parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, **kwargs: Any) → Any

当Retriever开始运行时运行。

Parameters

  • serialized (Dict[str, Any]) –

  • query (str) –

  • run_id (UUID) –

  • parent_run_id (Optional[UUID]) –

  • tags (Optional[List[str]]) –

  • metadata (Optional[Dict[str, Any]]) –

  • kwargs (Any) –

Return type

Any

on_tool_start(serialized: Dict[str, Any], input_str: str, *, run_id: UUID, parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, inputs: Optional[Dict[str, Any]] = None, **kwargs: Any) → Any

当工具开始运行时运行。

Parameters

  • serialized (Dict[str, Any]) –

  • input_str (str) –

  • run_id (UUID) –

  • parent_run_id (Optional[UUID]) –

  • tags (Optional[List[str]]) –

  • metadata (Optional[Dict[str, Any]]) –

  • inputs (Optional[Dict[str, Any]]) –

  • kwargs (Any) –

Return type

Any

remove_handler(handler: BaseCallbackHandler) → None[source]

从回调管理器中移除一个处理程序。

Parameters

handler (BaseCallbackHandler) –

Return type

None

remove_metadata(keys: List[str]) → None[source]
Parameters

keys (List[str]) –

Return type

None

remove_tags(tags: List[str]) → None[source]
Parameters

tags (List[str]) –

Return type

None

set_handler(handler: BaseCallbackHandler, inherit: bool = True) → None[source]

将处理程序设置为回调管理器上唯一的处理程序。

Parameters
Return type

None

set_handlers(handlers: List[BaseCallbackHandler], inherit: bool = True) → None[source]

将处理程序设置为回调管理器上唯一的处理程序。

Parameters
Return type

None