langchain_community.callbacks.mlflow_callback.MlflowCallbackHandler

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

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

参数

• name (str) – 运行的名称。

• experiment (str) – 实验的名称。

• tags (dict) – 要为运行附加的标签。

• tracking_uri (str) – MLflow跟踪服务器URI。

• run_id (Optional[str]) –

• artifacts_dir (str) –

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

初始化回调处理器。

属性

always_verbose	是否在verbose为False时调用详细回调。
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生成新标记时执行。
on_llm_start(serialized, prompts, **kwargs)	当LLM开始时执行。
on_retriever_end(documents, **kwargs)	当检索器运行结束时执行。
on_retriever_error(error, **kwargs)	当检索器出现错误时执行。
on_retriever_start(serialized, query, **kwargs)	在Retriever开始运行时执行。
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()	重置回调元数据。

__init__(name: Optional[str] = 'langchainrun-%', experiment: Optional[str] = 'langchain', tags: Optional[Dict] = None, tracking_uri: Optional[str] = None, run_id: Optional[str] = None, artifacts_dir: str = '') → None

初始化回调处理器。

参数

• name (Optional[str]) –

• experiment (Optional[str]) –

• tags (Optional[Dict]) –

• tracking_uri (可选[str]) –

• run_id (Optional[str]) –

• artifacts_dir (str) –

返回类型

None

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

参数

• langchain_asset (可选[Any]) –

• finish (bool) –

返回类型

None

get_custom_callback_meta() → Dict[str, Any]

返回类型

Dict[str, Any]

on_agent_action(action: AgentAction, **kwargs: Any) → Any

在代理行动上执行。

参数

• action (AgentAction) –

• kwargs (Any) –

返回类型

Any

on_agent_finish(finish: AgentFinish, **kwargs: Any) → None

当代理运行结束时执行。

参数

• finish (AgentFinish) –

• kwargs (Any) –

返回类型

None

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

当链运行结束时执行。

参数

• outputs (Union[Dict[str, Any], str, List[str]]) –

• kwargs (Any) –

返回类型

None

on_chain_error(error: BaseException, **kwargs: Any) → None

当链出现错误时执行。

参数

• error (BaseException) –

• kwargs (Any) –

返回类型

None

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

当链开始运行时执行。

参数

• serialized (Dict[str, Any]) –

• inputs (Dict[str, Any]) –

• kwargs (Any) –

返回类型

None

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。

参数

• serialized (Dict[str, Any]) - 序列化的聊天模型。

• messages (List[List[BaseMessage]]) – 消息。

• run_id (UUID) – 运行 ID。这是当前运行的 ID。

• parent_run_id (UUID) – 父运行 ID。这是父运行的 ID。

• tags (Optional[List[str]]) – 标签。

• metadata (Optional[Dict[str, Any]]) – 元数据。

• kwargs (Any) – 其他关键字参数。

返回类型

Any

on_custom_event(name: str, data: Any, *, run_id: UUID, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, **kwargs: Any) → Any

覆盖以定义自定义事件的处理器。

参数

• name (str) – 自定义事件的名称。

• data (Any) – 自定义事件的数据。格式将与用户指定的格式相匹配。

• run_id (UUID) – 运行的ID。

• tags (Optional[List[str]]) – 与自定义事件相关联的标签（包括继承的标签）。

• metadata (Optional[Dict[str, Any]]) – 与自定义事件相关联的元数据（包括继承的元数据）。

• kwargs (Any) –

返回类型

Any

新版本 0.2.15 添加。

on_llm_end(response: LLMResult, **kwargs: Any) → None

当LLM运行结束时执行。

参数

• response (

• kwargs (Any) –

返回类型

None

on_llm_error(error: BaseException, **kwargs: Any) → None

当LLM出现错误时执行。

参数

• error (BaseException) –

• kwargs (Any) –

返回类型

None

on_llm_new_token(token: str, **kwargs: Any) → None

当LLM生成新标记时执行。

参数

• token (str) –

• kwargs (Any) –

返回类型

None

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

当LLM开始时执行。

参数

• serialized (Dict[str, Any]) –

• prompts (列表[str]) –

• kwargs (Any) –

返回类型

None

on_retriever_end(documents: 序列[文档], **kwargs: Any) → Any

当检索器运行结束时执行。

参数

• documents (序列[文档]) –

• kwargs (Any) –

返回类型

Any

on_retriever_error(error: BaseException, **kwargs: Any) → Any

当检索器出现错误时执行。

参数

• error (BaseException) –

• kwargs (Any) –

返回类型

Any

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

在Retriever开始运行时执行。

参数

• serialized (Dict[str, Any]) –

• query (str) –

• kwargs (Any) –

返回类型

Any

on_retry(retry_state: RetryCallState, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any

在重试事件上运行。

参数

• retry_state (RetryCallState) – 重试状态。

• run_id (UUID) – 运行 ID。这是当前运行的 ID。

• parent_run_id (UUID) – 父运行 ID。这是父运行的 ID。

• kwargs (Any) – 其他关键字参数。

返回类型

Any

on_text(text: str, **kwargs: Any) → None

接收到文本时执行。

参数

• text (str) –

• kwargs (Any) –

返回类型

None

on_tool_end(output: Any, **kwargs: Any) → None

在工具运行结束 时执行。

参数

• output (Any) –

• kwargs (Any) –

返回类型

None

on_tool_error(error: BaseException, **kwargs: Any) → None

在工具错误时执行。

参数

• error (BaseException) –

• kwargs (Any) –

返回类型

None

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

在工具开始运行时执行。

参数

• serialized (Dict[str, Any]) –

• input_str (str) –

• kwargs (Any) –

返回类型

None

reset_callback_meta() → None

重置回调元数据。

返回类型

None

使用 MlflowCallbackHandler 的示例

• MLflow