langchain_core.tracers.base.AsyncBaseTracer

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

异步 Tracer 的基础接口。

初始化 tracer。

参数

  • _schema_format (Literal['original', 'streaming_events', 'original+chat']) –

    主要更改输入和输出的处理方式。仅供内部使用。此 API 将会更改。

    • “original” 是所有当前 tracer 使用的格式。此格式在输入和输出方面略有不一致。

    • “streaming_events” 用于支持流式事件，供内部使用。它将来可能会更改，或者完全弃用，转而使用专用于流式事件的异步 tracer。

    • “original+chat” 是一种与 “original” 格式相同的格式，除了它不会在 on_chat_model_start 上引发属性错误

  • kwargs (Any) – 将传递给超类的其他关键字参数。

属性

ignore_agent

是否忽略 agent 回调。

ignore_chain

是否忽略 chain 回调。

ignore_chat_model

是否忽略 chat model 回调。

ignore_custom_event

忽略自定义事件。

ignore_llm

是否忽略 LLM 回调。

ignore_retriever

是否忽略 retriever 回调。

ignore_retry

是否忽略重试回调。

log_missing_parent

raise_error

如果发生异常是否引发错误。

run_inline

是否内联运行回调。

方法

__init__(*[, _schema_format])

初始化 tracer。

on_agent_action(action, *, run_id[, ...])

在 agent action 上运行。

on_agent_finish(finish, *, run_id[, ...])

在 agent 结束时运行。

on_chain_end(outputs, *, run_id[, inputs])

当 chain 结束运行时运行。

on_chain_error(error, *[, inputs])

当 chain 发生错误时运行。

on_chain_start(serialized, inputs, *, run_id)

当 chain 开始运行时运行。

on_chat_model_start(serialized, messages, *, ...)

当 chat model 开始运行时运行。

on_custom_event(name, data, *, run_id[, ...])

重写以定义自定义事件的处理程序。

on_llm_end(response, *, run_id[, ...])

当 LLM 结束运行时运行。

on_llm_error(error, *, run_id[, ...])

当 LLM 发生错误时运行。

on_llm_new_token(token, *[, chunk, ...])

在新 LLM token 上运行。

on_llm_start(serialized, prompts, *, run_id)

当 LLM 开始运行时运行。

on_retriever_end(documents, *, run_id[, ...])

在 retriever 结束时运行。

on_retriever_error(error, *, run_id[, ...])

在 retriever 错误时运行。

on_retriever_start(serialized, query, *, run_id)

在 retriever 开始时运行。

on_retry(retry_state, *, run_id, **kwargs)

在重试事件时运行。

on_text(text, *, run_id[, parent_run_id, tags])

在任意文本上运行。

on_tool_end(output, *, run_id, **kwargs)

当 tool 结束运行时运行。

on_tool_error(error, *, run_id[, ...])

当 tool 发生错误时运行。

on_tool_start(serialized, input_str, *, run_id)

当 tool 开始运行时运行。
__init__(*, _schema_format: Literal['original', 'streaming_events', 'original+chat'] = 'original', **kwargs: Any) → None

初始化 tracer。

参数

  • _schema_format (Literal['original', 'streaming_events', 'original+chat']) –

    主要更改输入和输出的处理方式。仅供内部使用。此 API 将会更改。

    • “original” 是所有当前 tracer 使用的格式。此格式在输入和输出方面略有不一致。

    • “streaming_events” 用于支持流式事件，供内部使用。它将来可能会更改，或者完全弃用，转而使用专用于流式事件的异步 tracer。

    • “original+chat” 是一种与 “original” 格式相同的格式，除了它不会在 on_chat_model_start 上引发属性错误

  • kwargs (Any) – 将传递给超类的其他关键字参数。

返回类型

None

async on_agent_action(action: AgentAction, *, run_id: UUID, parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, **kwargs: Any) → None

在 agent action 上运行。

参数

  • action (AgentAction) – Agent 的动作。

  • run_id (UUID) – 运行 ID。这是当前运行的 ID。

  • parent_run_id (UUID) – 父级运行 ID。这是父级运行的 ID。

  • tags (Optional[List[str]]) – 标签。

  • kwargs (Any) – 附加关键字参数。

返回类型

None

async on_agent_finish(finish: AgentFinish, *, run_id: UUID, parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, **kwargs: Any) → None

在 agent 结束时运行。

参数

  • finish (AgentFinish) – Agent 的完成状态。

  • run_id (UUID) – 运行 ID。这是当前运行的 ID。

  • parent_run_id (UUID) – 父级运行 ID。这是父级运行的 ID。

  • tags (Optional[List[str]]) – 标签。

  • kwargs (Any) – 附加关键字参数。

返回类型

None

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

当 chain 结束运行时运行。

参数

  • outputs (Dict[str, Any]) – Chain 的输出。

  • run_id (UUID) – 运行 ID。这是当前运行的 ID。

  • parent_run_id (UUID) – 父级运行 ID。这是父级运行的 ID。

  • tags (Optional[List[str]]) – 标签。

  • kwargs (Any) – 附加关键字参数。

  • inputs (Optional[Dict[str, Any]]) –

返回类型

None

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

当 chain 发生错误时运行。

参数

  • error (BaseException) – 发生的错误。

  • run_id (UUID) – 运行 ID。这是当前运行的 ID。

  • parent_run_id (UUID) – 父级运行 ID。这是父级运行的 ID。

  • tags (Optional[List[str]]) – 标签。

  • kwargs (Any) – 附加关键字参数。

  • inputs (Optional[Dict[str, Any]]) –

返回类型

None

async 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) → None[source]

当 chain 开始运行时运行。

参数

  • serialized (Dict[str, Any]) – 序列化的 chain。

  • inputs (Dict[str, Any]) – 输入。

  • run_id (UUID) – 运行 ID。这是当前运行的 ID。

  • parent_run_id (UUID) – 父级运行 ID。这是父级运行的 ID。

  • tags (Optional[List[str]]) – 标签。

  • metadata (Optional[Dict[str, Any]]) – 元数据。

  • kwargs (Any) – 附加关键字参数。

  • run_type (Optional[str]) –

  • name (Optional[str]) –

返回类型

None

async on_chat_model_start(serialized: Dict[str, Any], messages: List[List[BaseMessage]], *, 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) → Any[source]

当 chat model 开始运行时运行。

注意：此方法为 chat model 调用。如果您正在实现

非 chat model 的处理程序，您应该使用 on_llm_start 代替。

参数

  • serialized (Dict[str, Any]) – 序列化的 chat model。

  • messages (List[List[BaseMessage]]) – 消息。

  • run_id (UUID) – 运行 ID。这是当前运行的 ID。

  • parent_run_id (UUID) – 父级运行 ID。这是父级运行的 ID。

  • tags (Optional[List[str]]) – 标签。

  • metadata (Optional[Dict[str, Any]]) – 元数据。

  • kwargs (Any) – 附加关键字参数。

  • name (Optional[str]) –

返回类型

Any

async on_custom_event(name: str, data: Any, *, run_id: UUID, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, **kwargs: Any) → None

重写以定义自定义事件的处理程序。

参数

  • name (str) – 自定义事件的名称。

  • data (Any) – 自定义事件的数据。格式将与用户指定的格式匹配。

  • run_id (UUID) – 运行的 ID。

  • tags (Optional[List[str]]) – 与自定义事件关联的标签（包括继承的标签）。

  • metadata (Optional[Dict[str, Any]]) – 与自定义事件关联的元数据（包括继承的元数据）。

  • kwargs (Any) –

返回类型

None

0.2.15 版本新增。

async on_llm_end(response: LLMResult, *, run_id: UUID, parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, **kwargs: Any) → None[source]

当 LLM 结束运行时运行。

参数

  • response (LLMResult) – 生成的响应。

  • run_id (UUID) – 运行 ID。这是当前运行的 ID。

  • parent_run_id (UUID) – 父级运行 ID。这是父级运行的 ID。

  • tags (Optional[List[str]]) – 标签。

  • kwargs (Any) – 附加关键字参数。

返回类型

None

async on_llm_error(error: BaseException, *, run_id: UUID, parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, **kwargs: Any) → None[source]

当 LLM 发生错误时运行。

参数

  • error (BaseException) – 发生的错误。

  • run_id (UUID) – 运行 ID。这是当前运行的 ID。

  • parent_run_id (Optional[UUID]) – 父级运行 ID。这是父级运行的 ID。

  • tags (Optional[List[str]]) – 标签。

  • kwargs (Any) –

    附加关键字参数。 - response (LLMResult): 错误发生前生成的响应。

    the error occurred.

返回类型

None

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

在新的LLM token上运行。仅在启用流式处理时可用。

参数

  • token (str) – 新的token。

  • chunk (GenerationChunk | ChatGenerationChunk) – 新生成的chunk，包含内容和其他信息。

  • run_id (UUID) – 运行 ID。这是当前运行的 ID。

  • parent_run_id (UUID) – 父级运行 ID。这是父级运行的 ID。

  • tags (Optional[List[str]]) – 标签。

  • kwargs (Any) – 附加关键字参数。

返回类型

None

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

当 LLM 开始运行时运行。

注意：此方法为非聊天模型（常规LLM）调用。如果

您正在为聊天模型实现处理程序，则应使用 on_chat_model_start 代替。

参数

  • serialized (Dict[str, Any]) – 序列化的 LLM。

  • prompts (List[str]) – 提示。

  • run_id (UUID) – 运行 ID。这是当前运行的 ID。

  • parent_run_id (UUID) – 父级运行 ID。这是父级运行的 ID。

  • tags (Optional[List[str]]) – 标签。

  • metadata (Optional[Dict[str, Any]]) – 元数据。

  • kwargs (Any) – 附加关键字参数。

返回类型

None

async on_retriever_end(documents: Sequence[Document], *, run_id: UUID, parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, **kwargs: Any) → None[source]

在 retriever 结束时运行。

参数

  • documents (Sequence[Document]) – 检索到的文档。

  • run_id (UUID) – 运行 ID。这是当前运行的 ID。

  • parent_run_id (UUID) – 父级运行 ID。这是父级运行的 ID。

  • tags (Optional[List[str]]) – 标签。

  • kwargs (Any) – 附加关键字参数。

返回类型

None

async on_retriever_error(error: BaseException, *, run_id: UUID, parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, **kwargs: Any) → None[source]

在 retriever 错误时运行。

参数

  • error (BaseException) – 发生的错误。

  • run_id (UUID) – 运行 ID。这是当前运行的 ID。

  • parent_run_id (UUID) – 父级运行 ID。这是父级运行的 ID。

  • tags (Optional[List[str]]) – 标签。

  • kwargs (Any) – 附加关键字参数。

返回类型

None

async 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) → None[source]

在 retriever 开始时运行。

参数

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

  • query (str) – 查询。

  • run_id (UUID) – 运行 ID。这是当前运行的 ID。

  • parent_run_id (UUID) – 父级运行 ID。这是父级运行的 ID。

  • tags (Optional[List[str]]) – 标签。

  • metadata (Optional[Dict[str, Any]]) – 元数据。

  • kwargs (Any) – 附加关键字参数。

  • name (Optional[str]) –

返回类型

None

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

在重试事件时运行。

参数

  • retry_state (RetryCallState) – 重试状态。

  • run_id (UUID) – 运行 ID。这是当前运行的 ID。

  • parent_run_id (UUID) – 父级运行 ID。这是父级运行的 ID。

  • kwargs (Any) – 附加关键字参数。

返回类型

None

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

在任意文本上运行。

参数

  • text (str) – 文本。

  • run_id (UUID) – 运行 ID。这是当前运行的 ID。

  • parent_run_id (UUID) – 父级运行 ID。这是父级运行的 ID。

  • tags (Optional[List[str]]) – 标签。

  • kwargs (Any) – 附加关键字参数。

返回类型

None

async on_tool_end(output: Any, *, run_id: UUID, **kwargs: Any) → None[source]

当 tool 结束运行时运行。

参数

  • output (Any) – 工具的输出。

  • run_id (UUID) – 运行 ID。这是当前运行的 ID。

  • parent_run_id (UUID) – 父级运行 ID。这是父级运行的 ID。

  • tags (Optional[List[str]]) – 标签。

  • kwargs (Any) – 附加关键字参数。

返回类型

None

async on_tool_error(error: BaseException, *, run_id: UUID, parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, **kwargs: Any) → None[source]

当 tool 发生错误时运行。

参数

  • error (BaseException) – 发生的错误。

  • run_id (UUID) – 运行 ID。这是当前运行的 ID。

  • parent_run_id (UUID) – 父级运行 ID。这是父级运行的 ID。

  • tags (Optional[List[str]]) – 标签。

  • kwargs (Any) – 附加关键字参数。

返回类型

None

async 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) → None[source]

当 tool 开始运行时运行。

参数

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

  • input_str (str) – 输入字符串。

  • run_id (UUID) – 运行 ID。这是当前运行的 ID。

  • parent_run_id (UUID) – 父级运行 ID。这是父级运行的 ID。

  • tags (Optional[List[str]]) – 标签。

  • metadata (Optional[Dict[str, Any]]) – 元数据。

  • inputs (Optional[Dict[str, Any]]) – 输入。

  • kwargs (Any) – 附加关键字参数。

  • name (Optional[str]) –

返回类型

None