`langchain_core.tracers.stdout`.FunctionCallbackHandler¶

class langchain_core.tracers.stdout.FunctionCallbackHandler(function: Callable[[str], None], **kwargs: Any)[来源]¶

单字符串参数的函数调用的Tracer。

初始化Tracer。

参数

_schema_format –
主要改变输入和输出处理的方式。仅限内部使用。此API将会改变。
- ‘original’是所有当前Tracer使用的格式。此格式在输入和输出方面略有不一致。
- ‘streaming_events’用于支持流式事件，仅限内部使用。将来可能会改变或完全废弃，以支持流式事件的专用异步Tracer。
- ‘original+chat’是除不抛出_on_chat_model_start属性错误外的与‘original’相同的格式。
kwargs (Any) – 将传递给超类的新增关键字参数。
function (Callable[[str], None]) –

属性

`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__`(function, **kwargs)	初始化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)	当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__(function: Callable[[str], None], **kwargs: Any) → None[source]¶

初始化Tracer。

参数

_schema_format –
主要改变输入和输出处理的方式。仅限内部使用。此API将会改变。
- ‘original’是所有当前Tracer使用的格式。此格式在输入和输出方面略有不一致。
- ‘streaming_events’用于支持流式事件，仅限内部使用。将来可能会改变或完全废弃，以支持流式事件的专用异步Tracer。
- ‘original+chat’是除不抛出_on_chat_model_start属性错误外的与‘original’相同的格式。
kwargs (Any) – 将传递给超类的新增关键字参数。
function (Callable[[str], None]) –

返回类型

None

get_breadcrumbs(run: Run) → str[source]¶

获取执行过程的追踪信息。

参数: run (Run) – 获取运行脚踪的运行。
返回: 运行脚踪的字符串。
返回类型: str

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

获取执行过程的上层过程。

参数: 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¶

处理链式运行中的错误。

参数

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 (Optional[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 (Optional[List[str]]) – 运行的标签。默认为 None。
parent_run_id (Optional[UUID]) – 父运行 ID。默认为 None。
metadata (Optional[Dict[str, Any]]) – 运行的元数据。默认为 None。
name (Optional[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) – 自定义事件的"data"。格式将符合用户指定的格式。
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 (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 (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 (Optional[str]) – 运行的名称。
kwargs (Any) – 其他参数。

返回

运行过程。

返回类型

运行

on_retriever_end(documents: Document序列, *, run_id: UUID, **kwargs: Any) → Run¶

当Retriever运行结束时执行。

参数

文档 (序列[\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¶

当Retriever开始运行时执行。

参数

serialized (字典[\字符串,Any]) – 序列化的检索器。
query (字符串) – 查询。
run_id (UUID) – 运行ID。
parent_run_id (Optional[UUID]) – 父运行 ID。默认为 None。
tags (Optional[List[str]]) – 运行的标签。默认为 None。
metadata (Optional[Dict[str, Any]]) – 运行的元数据。默认为 None。
name (Optional[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 (Optional[List[str]]) – 运行的标签。默认为 None。
parent_run_id (Optional[UUID]) – 父运行 ID。默认为 None。
metadata (Optional[Dict[str, Any]]) – 运行的元数据。默认为 None。
name (Optional[str]) – 运行的名称。
inputs (Optional[Dict[str, Any]]) – 工具的输入。
kwargs (Any) – 其他参数。

返回

运行过程。

返回类型

运行

langchain_core.tracers.stdout.FunctionCallbackHandler¶

`langchain_core.tracers.stdout`.FunctionCallbackHandler¶