`langchain_core.tracers.base`.BaseTracer¶

class langchain_core.tracers.base.BaseTracer(*, _schema_format: Literal['original', 'streaming_events', 'original+chat'] = 'original', **kwargs: Any)[source]¶

跟踪器的基础接口。

初始化跟踪器。

参数

_schema_format (Literal['original', 'streaming_events', 'original+chat']) –
主要改变输入和输出的处理方式。仅供内部使用。此API将改变。
- 'original' 是所有当前跟踪器使用的格式。此格式在输入和输出方面略有不一致。
- 'streaming_events' 用于支持流式事件，仅供内部使用。很可能在未来进行更改，或被专门用于流式事件的异步跟踪器所取代。
- 'original+chat' 是与 'original' 相同的格式，但它不会在_on_chat_model_start 时引发属性错误。
kwargs (Any) – 将传递给父类的额外关键字参数。

属性

`ignore_agent`	是否忽略代理回调。
`ignore_chain`	是否忽略链式回调。
`ignore_chat_model`	是否忽略聊天模型回调。
`ignore_custom_event`	忽略自定义事件。
`ignore_llm`	是否忽略 LLM 回调。
`ignore_retriever`	是否忽略检索器回调。
`ignore_retry`	是否忽略重试回调。
`log_missing_parent`
`raise_error`	当发生异常时是否引发错误。
`run_inline`	是否直接运行回调。

方法

`__init__`(*[, _schema_format])	初始化跟踪器。
`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`(serialized, messages, *, ...)	开始 LLM 运行的追踪。
`on_custom_event`(name, data, *, run_id[, ...])	重写以定义一个自定义事件的处理器。
`on_llm_end`(response, , run_id, *kwargs)	结束 LLM 运行的追踪。
`on_llm_error`(error, , run_id, *kwargs)	处理 LLM 运行的错误。
`on_llm_new_token`(token, *[, chunk, ...])	在新的 LLM 令牌上运行。
`on_llm_start`(serialized, prompts, *, run_id)	开始 LLM 运行的追踪。
`on_retriever_end`(documents, , run_id, *kwargs)	当 Retriever 运行结束后执行。
`on_retriever_error`(error, , run_id, *kwargs)	当 Retriever 发生错误时执行。
`on_retriever_start`(serialized, query, *, run_id)	当 Retriever 开始运行时执行。
`on_retry`(retry_state, , run_id, *kwargs)	在重试时执行。
`on_text`(text, *, run_id[, parent_run_id])	在任意文本上执行。
`on_tool_end`(output, , run_id, *kwargs)	结束工具运行的追踪。
`on_tool_error`(error, , run_id, *kwargs)	处理工具运行的错误。
`on_tool_start`(serialized, input_str, *, run_id)	开始工具运行的追踪。

__init__(*, _schema_format: Literal['original', 'streaming_events', 'original+chat'] = 'original', **kwargs: Any) → None¶

初始化跟踪器。

参数

_schema_format (Literal['original', 'streaming_events', 'original+chat']) –
主要改变输入和输出的处理方式。仅供内部使用。此API将改变。
- 'original' 是所有当前跟踪器使用的格式。此格式在输入和输出方面略有不一致。
- 'streaming_events' 用于支持流式事件，仅供内部使用。很可能在未来进行更改，或被专门用于流式事件的异步跟踪器所取代。
- 'original+chat' 是与 'original' 相同的格式，但它不会在_on_chat_model_start 时引发属性错误。
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[source]¶

结束链式运行跟踪。

参数

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[source]¶

处理链式运行的错误。

参数

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[source]¶

开始链式运行的跟踪。

参数

serialized (Dict[str, Any]) – 序列链。
inputs (Dict[str, Any]) – 链的输入。
run_id (UUID) – 运行ID。
tags (Optional[List[str]]) – 运行的标签。默认为 None。
parent_run_id (Optional[UUID]) – 父运行 ID。默认为 None。
metadata (Optional[Dict[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[source]¶

开始 LLM 运行的追踪。

参数

serialized (Dict[str, Any]) – 序列化的模型。
messages (List[List[BaseMessage]]) – 用以启动聊天的消息。
run_id (UUID) – 运行ID。
tags (Optional[List[str]]) – 运行的标签。默认为 None。
parent_run_id (Optional[UUID]) – 父运行 ID。默认为 None。
metadata (Optional[Dict[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[source]¶

结束 LLM 运行的追踪。

参数

response (LLMResult) – 响应。
run_id (UUID) – 运行ID。
kwargs (Any) – 额外参数。

返回结果

运行结果。

返回类型

运行

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

处理 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[source]¶

运行新LLM标记。仅在启用流时可用。

参数

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

返回结果

运行结果。

返回类型

运行

开始 LLM 运行的追踪。

参数

serialized (Dict[str, Any]) – 序列化的模型。
run_id (UUID) – 运行ID。
tags (Optional[List[str]]) – 运行的标签。默认为 None。
parent_run_id (Optional[UUID]) – 父运行 ID。默认为 None。
metadata (Optional[Dict[str, Any]]) – 运行的元数据。默认为 None。
name (可选[str]) – 运行的名称。
kwargs (Any) – 额外参数。

返回结果

运行结果。

返回类型

运行

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

当 Retriever 运行结束后执行。

参数

documents (Sequence[Document]) – 文档。
run_id (UUID) – 运行ID。
kwargs (Any) – 额外参数。

返回结果

运行结果。

返回类型

运行

on_retriever_error(error: BaseException, *, run_id: UUID, **kwargs: Any) → Run[来源]¶

当 Retriever 发生错误时执行。

参数

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[source]

当 Retriever 开始运行时执行。

参数

serialized (Dict[str, Any]) – 序列化的检索器。
query (str) – 查询。
run_id (UUID) – 运行ID。
parent_run_id (Optional[UUID]) – 父运行 ID。默认为 None。
tags (Optional[List[str]]) – 运行的标签。默认为 None。
metadata (Optional[Dict[str, Any]]) – 运行的元数据。默认为 None。
name (可选[str]) – 运行的名称。
kwargs (Any) – 额外参数。

返回结果

运行结果。

返回类型

运行

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

在重试时执行。

参数

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[source]¶

结束工具运行的追踪。

参数

output (Any) – 工具的输出。
run_id (UUID) – 运行ID。
kwargs (Any) – 额外参数。

返回结果

运行结果。

返回类型

运行

on_tool_error(error: BaseException, *, run_id: UUID, **kwargs: Any) → Run[source]¶

处理工具运行的错误。

参数

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[source]¶

开始工具运行的追踪。

参数

serialized (Dict[str, Any]) – 工具的序列化。
input_str (str) – 输入字符串。
run_id (UUID) – 运行ID。
tags (Optional[List[str]]) – 运行的标签。默认为 None。
parent_run_id (Optional[UUID]) – 父运行 ID。默认为 None。
metadata (Optional[Dict[str, Any]]) – 运行的元数据。默认为 None。
name (可选[str]) – 运行的名称。
inputs (Optional[Dict[str, Any]]) – 工具的输入。
kwargs (Any) – 额外参数。

返回结果

运行结果。

返回类型

运行

langchain_core.tracers.base.BaseTracer¶

`langchain_core.tracers.base`.BaseTracer¶