`langchain_core.tracers.stdout`.ConsoleCallbackHandler¶

class langchain_core.tracers.stdout.ConsoleCallbackHandler(**kwargs: Any)[来源]¶

控制台打印的跟踪器。

初始化跟踪器。

参数

_schema_format –
主要更改了输入和输出的处理方式。仅用于内部。此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`
`name`	跟踪器的名称。
`raise_error`	如果发生异常，是否引发错误。
`run_inline`	是否直接运行回调。

方法

`__init__`(**kwargs)	初始化跟踪器。
`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)	当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__(**kwargs: Any) → None[source]¶

初始化跟踪器。

参数

_schema_format –
主要更改了输入和输出的处理方式。仅用于内部。此API将更改。
- ‘original’是所有当前跟踪器使用的格式。这个格式在输入和输出方面略有不一致。
- ‘streaming_events’用于支持流事件，仅用于内部。可能会在未来改变，或者完全废弃，以支持专为流事件设计的异步跟踪器。
- ‘original+chat’是一种格式，与‘original’相同，除了它不会在_on_chat_model_start上引发属性错误。
kwargs(Any) – 传递给超类额外的关键字参数。

返回类型

None

get_breadcrumbs(run: Run) → str¶

获取一个运行的面包屑。

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

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

获取一个运行的父代。

参数: run (Run) – 要获取父项的运行。
返回: 父运行列表。
返回类型: 列表[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¶

处理链运行中的错误。

参数

错误 (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（《字典》）– 序列化的链。
inputs（《字典》）– 链的输入。
run_id (UUID) – 运行ID。
tags（《可选”），`List[str]]`）– 运行的标签。默认为 None。

parent_run_id（《可选”），`UUID`）– 父运行 ID。默认为 None。

metadata（《可选”），`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¶

为LLM运行开始追踪。

参数

serialized (Dict[str, Any]) – 序列化模型。

messages (List[List[BaseMessage]]) – 开启聊天所需的消息。

run_id (UUID) – 运行ID。

tags（《可选”），`List[str]]`）– 运行的标签。默认为 None。

parent_run_id（《可选”），`UUID`）– 父运行 ID。默认为 None。

metadata（《可选”），`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运行期间的错误。

参数

错误 (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]) – 序列化模型。

强
内容
(列表列表字符串) – 使用LLM开始时的输入提示。

run_id (UUID) – 运行ID。

tags（《可选”），`List[str]]`）– 运行的标签。默认为 None。

parent_run_id（《可选”），`UUID`）– 父运行 ID。默认为 None。

metadata（《可选”），`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出现错误时运行。

参数

错误 (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¶

当Retriever开始运行时启动。

参数

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

query (str) – 查询。

run_id (UUID) – 运行ID。

parent_run_id（《可选”），`UUID`）– 父运行 ID。默认为 None。

tags（《可选”），`List[str]]`）– 运行的标签。默认为 None。

metadata（《可选”），`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) → 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¶

处理工具运行期间的错误。

参数

错误 (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（《可选”），`List[str]]`）– 运行的标签。默认为 None。

parent_run_id（《可选”），`UUID`）– 父运行 ID。默认为 None。

metadata（《可选”），`Dict[str, Any]`）– 运行的元数据。默认为 None。

name（《可选”），`str`）– 运行的名称。

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

kwargs (Any) – 额外参数。

返回

运行。

返回类型

运行

langchain_core.tracers.stdout.ConsoleCallbackHandler¶

`langchain_core.tracers.stdout`.ConsoleCallbackHandler¶