Mlflow回调处理器#

class langchain_community.callbacks.mlflow_callback.MlflowCallbackHandler(name: str | None = 'langchainrun-%', experiment: str | None = 'langchain', tags: Dict | None = None, tracking_uri: str | None = None, run_id: str | None = None, artifacts_dir: str = '')[source]#

将指标和工件记录到mlflow服务器的回调处理程序。

Parameters:

name (str) – 运行的名称。
experiment (str) – 实验的名称。
tags (dict) – 要附加到运行的标签。
tracking_uri (str) – MLflow 跟踪服务器 URI。
run_id (str | None)
artifacts_dir (str)

此处理程序将利用调用的相关回调方法，并使用有关LLM运行状态的元数据格式化每个回调函数的输入，并将响应添加到{method}_records和操作的记录列表中。然后，它将响应记录到mlflow服务器。

初始化回调处理程序。

属性

`always_verbose`	即使verbose为False，是否也要调用verbose回调。
`ignore_agent`	是否忽略代理回调。
`ignore_chain`	是否忽略链式回调。
`ignore_chat_model`	是否忽略聊天模型回调。
`ignore_custom_event`	忽略自定义事件。
`ignore_llm`	是否忽略LLM回调。
`ignore_retriever`	是否忽略检索器回调。
`ignore_retry`	是否忽略重试回调。
`raise_error`	如果发生异常，是否引发错误。
`run_inline`	是否内联运行回调。

方法

`__init__`([name, experiment, tags, ...])	初始化回调处理程序。
`flush_tracker`([langchain_asset, finish])
`get_custom_callback_meta`()
`on_agent_action`(action, **kwargs)	在代理操作时运行。
`on_agent_finish`(finish, **kwargs)	当代理结束运行时执行。
`on_chain_end`(outputs, **kwargs)	当链结束时运行。
`on_chain_error`(error, **kwargs)	当链发生错误时运行。
`on_chain_start`(serialized, inputs, **kwargs)	当链开始运行时执行。
`on_chat_model_start`(serialized, messages, *, ...)	当聊天模型开始运行时执行。
`on_custom_event`(name, data, *, run_id[, ...])	重写以定义自定义事件的处理程序。
`on_llm_end`(response, **kwargs)	当LLM运行结束时执行。
`on_llm_error`(error, **kwargs)	当LLM出错时运行。
`on_llm_new_token`(token, **kwargs)	当LLM生成一个新token时运行。
`on_llm_start`(serialized, prompts, **kwargs)	当LLM开始时运行。
`on_retriever_end`(documents, **kwargs)	当检索器结束运行时执行。
`on_retriever_error`(error, **kwargs)	当检索器出错时运行。
`on_retriever_start`(serialized, query, **kwargs)	当检索器开始运行时执行。
`on_retry`(retry_state, *, run_id[, parent_run_id])	在重试事件时运行。
`on_text`(text, **kwargs)	当接收到文本时运行。
`on_tool_end`(output, **kwargs)	当工具结束运行时执行。
`on_tool_error`(error, **kwargs)	当工具出错时运行。
`on_tool_start`(serialized, input_str, **kwargs)	当工具开始运行时执行。
`reset_callback_meta`()	重置回调元数据。

初始化回调处理程序。

Parameters:

名称 (字符串 | 无)
experiment (str | None)
标签 (字典 | 无)
tracking_uri (str | None)
run_id (str | None)
artifacts_dir (str)

Return type:

无

flush_tracker(langchain_asset: Any = None, finish: bool = False) → None[source]#

Parameters:

langchain_asset (Any)
finish (bool)

Return type:

无

get_custom_callback_meta() → Dict[str, Any]#

Return type:: Dict[str, Any]

on_agent_action(action: AgentAction, **kwargs: Any) → Any[source]#

在代理操作上运行。

Parameters:

action (AgentAction)
kwargs (Any)

Return type:

任何

on_agent_finish(finish: AgentFinish, **kwargs: Any) → None[source]#

当代理结束运行时执行。

Parameters:

完成 (AgentFinish)
kwargs (Any)

Return type:

无

on_chain_end(outputs: Dict[str, Any] | str | List[str], **kwargs: Any) → None[source]#

当链结束运行时执行。

Parameters:

outputs (Dict[str, Any] | str | List[str])
kwargs (Any)

Return type:

无

on_chain_error(error: BaseException, **kwargs: Any) → None[source]#

当链发生错误时运行。

Parameters:

error (BaseException)
kwargs (Any)

Return type:

无

on_chain_start(serialized: Dict[str, Any], inputs: Dict[str, Any], **kwargs: Any) → None[source]#

当链开始运行时执行。

Parameters:

serialized (Dict[str, Any])
inputs (Dict[str, Any])
kwargs (Any)

Return type:

无

on_chat_model_start(serialized: dict[str, Any], messages: list[list[BaseMessage]], *, run_id: UUID, parent_run_id: UUID | None = None, tags: list[str] | None = None, metadata: dict[str, Any] | None = None, **kwargs: Any) → Any#

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

ATTENTION: This method is called for chat models. If you’re implementing: 对于非聊天模型的处理程序，您应该使用 on_llm_start 代替。

Parameters:

serialized (Dict[str, Any]) – 序列化的聊天模型。
messages (List[List[BaseMessage]]) – 消息。
run_id (UUID) – 运行ID。这是当前运行的ID。
parent_run_id (UUID) – 父运行ID。这是父运行的ID。
tags (可选[列表[字符串]]) – 标签。
metadata (可选[字典[字符串, 任意类型]]) – 元数据。
kwargs (Any) – 额外的关键字参数。

Return type:

任何

on_custom_event(name: str, data: Any, *, run_id: UUID, tags: list[str] | None = None, metadata: dict[str, Any] | None = None, **kwargs: Any) → Any#

重写以定义自定义事件的处理程序。

Parameters:

name (str) – 自定义事件的名称。
data (Any) – 自定义事件的数据。格式将与用户指定的格式匹配。
run_id (UUID) – 运行的ID。
tags (list[str] | None) – 与自定义事件关联的标签（包括继承的标签）。
metadata (dict[str, Any] | None) – 与自定义事件关联的元数据（包括继承的元数据）。
kwargs (Any)

Return type:

任何

在版本0.2.15中添加。

on_llm_end(response: LLMResult, **kwargs: Any) → None[source]#

当LLM结束运行时执行。

Parameters:

response (LLMResult)
kwargs (Any)

Return type:

无

on_llm_error(error: BaseException, **kwargs: Any) → None[source]#

当LLM出错时运行。

Parameters:

error (BaseException)
kwargs (Any)

Return type:

无

on_llm_new_token(token: str, **kwargs: Any) → None[source]#

当LLM生成新令牌时运行。

Parameters:

token (str)
kwargs (Any)

Return type:

无

on_llm_start(serialized: Dict[str, Any], prompts: List[str], **kwargs: Any) → None[source]#

当LLM启动时运行。

Parameters:

serialized (Dict[str, Any])
提示 (列表[字符串])
kwargs (Any)

Return type:

无

on_retriever_end(documents: Sequence[Document], **kwargs: Any) → Any[source]#

当Retriever结束运行时执行。

Parameters:

文档 (序列[Document])
kwargs (Any)

Return type:

任何

on_retriever_error(error: BaseException, **kwargs: Any) → Any[source]#

当Retriever出错时运行。

Parameters:

error (BaseException)
kwargs (Any)

Return type:

任何

on_retriever_start(serialized: Dict[str, Any], query: str, **kwargs: Any) → Any[source]#

当Retriever开始运行时执行。

Parameters:

serialized (Dict[str, Any])
query (str)
kwargs (Any)

Return type:

任何

on_retry(retry_state: RetryCallState, *, run_id: UUID, parent_run_id: UUID | None = None, **kwargs: Any) → Any#

在重试事件上运行。

Parameters:

retry_state (RetryCallState) – 重试状态。
run_id (UUID) – 运行ID。这是当前运行的ID。
parent_run_id (UUID) – 父运行ID。这是父运行的ID。
kwargs (Any) – 额外的关键字参数。

Return type:

任何

on_text(text: str, **kwargs: Any) → None[source]#

当接收到文本时运行。

Parameters:

文本 (str)
kwargs (Any)

Return type:

无

on_tool_end(output: Any, **kwargs: Any) → None[source]#

工具结束运行时执行。

Parameters:

output (Any)
kwargs (Any)

Return type:

无

on_tool_error(error: BaseException, **kwargs: Any) → None[source]#

当工具出错时运行。

Parameters:

error (BaseException)
kwargs (Any)

Return type:

无

on_tool_start(serialized: Dict[str, Any], input_str: str, **kwargs: Any) → None[source]#

当工具开始运行时执行。

Parameters:

serialized (Dict[str, Any])
input_str (str)
kwargs (Any)

Return type:

无

reset_callback_meta() → None#

重置回调元数据。

Return type:: 无

使用 MlflowCallbackHandler 的示例

MLflow