`langchain_core.tracers.run_collector`.RunCollectorCallbackHandler¶

class langchain_core.tracers.run_collector.RunCollectorCallbackHandler(example_id: Optional[Union[UUID, str]] = None, **kwargs: Any)[source]¶

此追踪器用于收集列表中所有嵌套的运行。

该追踪器对于检查和评估非常有用。

参数

name (str, default="run-collector_callback_handler") –
example_id (Optional[Union[UUID, str]], default=None) – 正在被追踪的示例的ID。可以是UUID或字符串。
kwargs (Any) –

初始化RunCollectorCallbackHandler。

参数

example_id (Optional[Union[UUID, str]], default=None) – 正在被追踪的示例的ID。可以是UUID或字符串。
**kwargs (Any) – 其他关键字参数

属性

`ignore_agent`	是否忽略代理回调。
`ignore_chain`	是否忽略链回调。
`ignore_chat_model`	是否忽略聊天模型回调。
`ignore_custom_event`	忽略自定义事件。
`ignore_llm`	是否忽略LLM回调。
`ignore_retriever`	是否忽略检索器回调。
`ignore_retry`	是否忽略重试回调。
`log_missing_parent`
`name`
`raise_error`	在出现异常时是否抛出错误。
`run_inline`	是否在行内运行回调。

方法

`__init__`([example_id])	初始化RunCollectorCallbackHandler。
`on_agent_action`(action, *, run_id[, ...])	在代理动作上运行。
`on_agent_finish`(finish, *, run_id[, ...])	在代理结束时运行。
`on_chain_end`(outputs, *, run_id[, inputs])	结束链运行追踪。
`on_chain_error`(error, *[, inputs])	处理链运行错误。
`on_chain_start`(serialized, inputs, *, run_id)	开始链运行的追踪。
`on_chat_model_start`(序列化数据, 消息, *, ...)	为LLM运行启动跟踪。
`on_custom_event`(事件名, 数据, *, run_id[, ...])	重写以定义自定义事件的处理器。
`on_llm_end`(响应, , run_id, *kwargs)	为LLM运行结束跟踪。
`on_llm_error`(错误, , run_id, *kwargs)	处理LLM运行中的错误。
`on_llm_new_token`(令牌, *[, 数据块, ...])	在新的LLM令牌上运行。
`on_llm_start`(序列化数据, 提示信息, *, run_id)	为LLM运行启动跟踪。
`on_retriever_end`(文档, , run_id, *kwargs)	当检索器运行结束后运行。
`on_retriever_error`(错误, , run_id, *kwargs)	当检索器发生错误时运行。
`on_retriever_start`(序列化数据, 查询, *, run_id)	当检索器开始运行时运行。
`on_retry`(重试状态, , run_id, *kwargs)	在重试时运行。
`on_text`(文本, *, run_id[, 父运行ID])	在任意文本上运行。
`on_tool_end`(输出, , run_id, *kwargs)	为工具运行结束跟踪。
`on_tool_error`(错误, , run_id, *kwargs)	处理工具运行中的错误。
`on_tool_start`(序列化数据, 输入字符串, *, run_id)	为工具运行启动跟踪。

__init__(example_id: Optional[Union[UUID, str]] = None, **kwargs: Any) → None[source]¶

初始化RunCollectorCallbackHandler。

参数

example_id (Optional[Union[UUID, str]], default=None) – 正在被追踪的示例的ID。可以是UUID或字符串。
**kwargs (Any) – 其他关键字参数

返回类型

None

on_agent_action(action: AgentAction, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any¶

在代理动作上运行。

参数

action （AgentAction） - 代理操作。
run_id （UUID） - 运行ID。这是当前运行的ID。
parent_run_id （UUID） - 父运行ID。这是父运行的ID。
kwargs （Any） - 其他关键字参数。

返回类型

Any

on_agent_finish(finish: AgentFinish, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any¶

在代理结束时运行。

参数

finish （AgentFinish） - 代理完成。
run_id （UUID） - 运行ID。这是当前运行的ID。
parent_run_id （UUID） - 父运行ID。这是父运行的ID。
kwargs （Any） - 其他关键字参数。

返回类型

Any

on_chain_end(outputs: Dict[str, Any], *, run_id: UUID, inputs: Optional[Dict[str, Any]] = None, **kwargs: Any) → Run¶

结束链运行追踪。

参数

outputs (Dict[str, Any]) – 链的输出。
run_id (UUID) – 运行ID。
inputs (Optional[Dict[str, Any]]) – 链的输入。默认为None。
kwargs (Any) – 其他参数。

返回值

运行结果。

返回类型

运行

on_chain_error(error: BaseException, *, inputs: Optional[Dict[str, Any]] = None, run_id: UUID, **kwargs: Any) → Run¶

处理链运行错误。

参数

error (BaseException) – 错误。
inputs (Optional[Dict[str, Any]]) – 链的输入。默认为None。
run_id (UUID) – 运行ID。
kwargs (Any) – 其他参数。

返回值

运行结果。

返回类型

运行

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

开始链运行的追踪。

参数

serialized (Dict[str, Any]) – 序列化链。
inputs (Dict[str, Any]) – 链的输入。
run_id (UUID) – 运行ID。
tags (可选[列表[str]]) – 运行的标签。默认为 None。
parent_run_id (可选[UUID]) – 父运行 ID。默认为 None。
metadata (可选[字典[str, Any]]) – 运行的元数据。默认为 None。
run_type (可选[str]) – 运行的类型。默认为 None。
name (可选[str]) – 运行的名称。
kwargs (Any) – 其他参数。

返回值

运行结果。

返回类型

运行

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

为LLM运行启动跟踪。

参数

serialized (Dict[str, Any]) – 序列化的模型。
messages (List[List[BaseMessage]]) – 用于启动聊天的消息。
run_id (UUID) – 运行ID。
tags (可选[列表[str]]) – 运行的标签。默认为 None。
parent_run_id (可选[UUID]) – 父运行 ID。默认为 None。
metadata (可选[字典[str, Any]]) – 运行的元数据。默认为 None。
name (可选[str]) – 运行的名称。
kwargs (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 ， * ， run_id ： UUID ， ** kwargs ： Any） → Run ¶

为LLM运行结束跟踪。

参数

response（LLMResult）-响应。
run_id (UUID) – 运行ID。
kwargs (Any) – 其他参数。

返回值

运行结果。

返回类型

运行

on_llm_error(error: BaseException, *, run_id: UUID, **kwargs: Any) → Run¶

处理LLM运行中的错误。

参数

error (BaseException) – 错误。
run_id (UUID) – 运行ID。
kwargs (Any) – 其他参数。

返回值

运行结果。

返回类型

运行

on_llm_new_token(token: str, *, chunk: Optional[Union[GenerationChunk, ChatGenerationChunk]] = None, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Run¶

在新的LLM标记上运行。仅在启用流式传输时可用。

参数

token (str) – 标记。
chunk (Optional[Union[GenerationChunk, ChatGenerationChunk]]) – 数据块。默认为None。
run_id (UUID) – 运行ID。
parent_run_id (可选[UUID]) – 父运行 ID。默认为 None。
kwargs (Any) – 其他参数。

返回值

运行结果。

返回类型

运行

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

为LLM运行启动跟踪。

参数

serialized (Dict[str, Any]) – 序列化的模型。
prompts（列表[字符串]） – 启动 LLM 时使用的提示。

run_id (UUID) – 运行ID。

tags (可选[列表[str]]) – 运行的标签。默认为 None。

parent_run_id (可选[UUID]) – 父运行 ID。默认为 None。

metadata (可选[字典[str, Any]]) – 运行的元数据。默认为 None。

name (可选[str]) – 运行的名称。

kwargs (Any) – 其他参数。

返回值

运行结果。

返回类型

运行

on_retriever_end(documents: Sequence[Document], *, run_id: UUID, **kwargs: Any) → Run¶

当检索器运行结束后运行。

参数

文档 (序列[Document]) – 文档。

run_id (UUID) – 运行ID。

kwargs (Any) – 其他参数。

返回值

运行结果。

返回类型

运行

on_retriever_error(error: BaseException, *, run_id: UUID, **kwargs: Any) → Run¶

当检索器发生错误时运行。

参数

error (BaseException) – 错误。

run_id (UUID) – 运行ID。

kwargs (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, name: Optional[str] = None, **kwargs: Any) → Run¶

当检索器开始运行时运行。

参数

serialized (Dict[str, Any]) – 序列化的检索器。

查询 (str) – 查询。

run_id (UUID) – 运行ID。

parent_run_id (可选[UUID]) – 父运行 ID。默认为 None。

tags (可选[列表[str]]) – 运行的标签。默认为 None。

metadata (可选[字典[str, Any]]) – 运行的元数据。默认为 None。

name (可选[str]) – 运行的名称。

kwargs (Any) – 其他参数。

返回值

运行结果。

返回类型

运行

on_retry(retry_state: RetryCallState, *, run_id: UUID, **kwargs: Any) → Run

在重试时运行。

参数

retry_state (RetryCallState) – 重试状态。

run_id (UUID) – 运行ID。

kwargs (Any) – 其他参数。

返回值

运行结果。

返回类型

运行

on_text(text: str, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any

在任意文本上运行。

参数

text (str) – 文本。

run_id （UUID） - 运行ID。这是当前运行的ID。

parent_run_id （UUID） - 父运行ID。这是父运行的ID。

kwargs （Any） - 其他关键字参数。

返回类型

Any

on_tool_end(output: Any, *, run_id: UUID, **kwargs: Any) → Run

为工具运行结束跟踪。

参数

output (Any) – 工具的输出。

run_id (UUID) – 运行ID。

kwargs (Any) – 其他参数。

返回值

运行结果。

返回类型

运行

on_tool_error(error: BaseException, *, run_id: UUID, **kwargs: Any) → Run

处理工具运行中的错误。

参数

error (BaseException) – 错误。

run_id (UUID) – 运行ID。

kwargs (Any) – 其他参数。

返回值

运行结果。

返回类型

运行

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

为工具运行启动跟踪。

参数

serialized (Dict[str, Any]) – 工具的序列化形式。

input_str (str) – 输入字符串。

run_id (UUID) – 运行ID。

tags (可选[列表[str]]) – 运行的标签。默认为 None。

parent_run_id (可选[UUID]) – 父运行 ID。默认为 None。

metadata (可选[字典[str, Any]]) – 运行的元数据。默认为 None。

name (可选[str]) – 运行的名称。

inputs (Optional[Dict[str, Any]]) – 工具的输入。

kwargs (Any) – 其他参数。

返回值

运行结果。

返回类型

运行

langchain_core.tracers.run_collector.RunCollectorCallbackHandler¶

`langchain_core.tracers.run_collector`.RunCollectorCallbackHandler¶