`langchain.callbacks.tracers.logging`.LoggingCallbackHandler¶

class langchain.callbacks.tracers.logging.LoggingCallbackHandler(logger: Logger, log_level: int = 20, extra: Optional[dict] = None, **kwargs: Any)[source]¶

通过输入的Logger进行日志记录的Tracer。

初始化tracer。

参数

_schema_format –
主要更改输入和输出的处理方式。仅内部使用。此API将改变。
- ‘original’是所有当前tracer使用的格式。此格式在输入和输出方面略有不一致。
- ‘streaming_events’用于支持流式事件，仅内部使用。将来可能会改变，或者完全废弃以利于专门针对流式事件异步tracer的使用。
- ‘original+chat’是一种与‘original’相同的格式，但它不会在_on_chat_model_start上引发属性错误。
kwargs (Any) – 传递给超类的额外关键字参数。
logger (Logger) –
log_level (int) –
extra (Optional[dict]) –

属性

`ignore_agent`	是否忽略代理回调。
`ignore_chain`	是否忽略链回调。
`ignore_chat_model`	是否忽略对话模型回调。
`ignore_custom_event`	忽略自定义事件。
`ignore_llm`	是否忽略LLM回调。
`ignore_retriever`	是否忽略检索器回调。
`ignore_retry`	是否忽略重试回调。
`log_missing_parent`
`name`	tracer的名称。
`raise_error`	是否在发生异常时引发错误。
`run_inline`	是否直接运行回调。

方法

`__init__`(logger[, log_level, extra])	初始化tracer。
`get_breadcrumbs`(run)	获取运行的痕迹。
`get_parents`(run)	获取运行的父对象。
`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)	在检索器运行结束时任运行。
`on_retriever_error`(error, , run_id, *kwargs)	在检索器出错时运行。
`on_retriever_start`(serialized, query, *, run_id)	在检索器开始运行时运行。
`on_retry`(retry_state, , run_id, *kwargs)	在重试时运行。
`on_text`(text, *, run_id[, parent_run_id])	在任意文本上运行。
`on_tool_end`(输出, , 运行ID, *kwargs)	结束工具运行的跟踪。
`on_tool_error`(错误, , 运行ID, *kwargs)	处理工具运行中的错误。
`on_tool_start`(序列化数据, input_str, *, 运行ID)	开始工具运行的跟踪。

__init__(logger: Logger, log_level: int = 20, extra: Optional[dict] = None, **kwargs: Any) → None[source]¶

初始化tracer。

参数

_schema_format –
主要更改输入和输出的处理方式。仅内部使用。此API将改变。
- ‘original’是所有当前tracer使用的格式。此格式在输入和输出方面略有不一致。
- ‘streaming_events’用于支持流式事件，仅内部使用。将来可能会改变，或者完全废弃以利于专门针对流式事件异步tracer的使用。
- ‘original+chat’是一种与‘original’相同的格式，但它不会在_on_chat_model_start上引发属性错误。
kwargs (Any) – 传递给超类的额外关键字参数。
logger (Logger) –
log_level (int) –
extra (Optional[dict]) –

返回类型

None

get_breadcrumbs(run: Run) → str¶

获取运行的痕迹。

参数: run (Run) – 获取运行碎片的运行。
返回: 包含运行碎片的字符串。
返回类型: str

get_parents(run: Run) → List[Run]¶

获取运行的父对象。

参数: run (Run) – 获取父运行的运行。
返回: 父运行列表。
返回类型: list[Run]

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 (Optional[List[str]]) – 运行的标签。默认为None。
parent_run_id (Optional[UUID]) – 父运行ID。默认为None。
metadata (Optional[Dict[str, Any]]) – 运行的元数据。默认为None。
run_type (Optional[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 (字典[str, Any]) – 序列化模型。
messages (列表[列表[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¶

结束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 上运行。仅在启用流式传输时可用。

参数

token (str) – token。
chunk (Optional[Union[GenerationChunk, ChatGenerationChunk]]) – 块。默认为 None。
run_id (UUID) – 运行ID。
parent_run_id (Optional[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 (字典[str, Any]) – 序列化模型。
prompts (List[str]) – 启动LLM时要使用的提示。
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¶

在检索器运行结束时任运行。

参数

文档 (序列[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, **kwargs: Any) → Run¶

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

参数

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¶

在重试时运行。

参数

retry_state (RetryCallState) – 重试状态。
run_id (UUID) – 运行ID。
kwargs (Any) – 额外参数。

返回

运行。

返回类型

运行

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

在任意文本上运行。

参数

text (str) – 文本内容。
run_id (UUID) – 运行ID。这是当前运行的ID。
parent_run_id (UUID) – 父运行ID。这是父运行的ID。
kwargs (Any) – 额外的关键字参数。

返回类型

None

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 (Optional[List[str]]) – 运行的标签。默认为None。
parent_run_id (Optional[UUID]) – 父运行ID。默认为None。
metadata (Optional[Dict[str, Any]]) – 运行的元数据。默认为None。
name (可选[str]) – 运行的名称。
inputs (可选[字典[字符串, 任何类型]]) – 工具的输入。
kwargs (Any) – 额外参数。

返回

运行。

返回类型

运行

langchain.callbacks.tracers.logging.LoggingCallbackHandler¶

`langchain.callbacks.tracers.logging`.LoggingCallbackHandler¶