`langchain_core.tracers.log_stream`.LogStreamCallbackHandler¶

class langchain_core.tracers.log_stream.LogStreamCallbackHandler(*, auto_close: bool = True, include_names: Optional[Sequence[str]] = None, include_types: Optional[Sequence[str]] = None, include_tags: Optional[Sequence[str]] = None, exclude_names: Optional[Sequence[str]] = None, exclude_types: Optional[Sequence[str]] = None, exclude_tags: Optional[Sequence[str]] = None, _schema_format: Literal['original', 'streaming_events'] = 'streaming_events')[源代码]¶

将运行日志流式传输到流的跟踪器。

一个将运行日志流式传输到流的跟踪器。

参数

auto_close (布尔值) – 是否在根运行完成后关闭流。
include_names (可选[序列[字符串]]) – 仅包含具有匹配名称的可运行实例的运行。
include_types (可选[序列[Str]]) – 仅包括匹配类型的Runnables的运行。
include_tags (可选[序列[Str]]) – 仅包括匹配标签的Runnables的运行。
exclude_names (可选[序列[Str]]) – 排除匹配名称的Runnables的运行。
exclude_types (可选[序列[Str]]) – 排除匹配类型的Runnables的运行。
exclude_tags (可选[序列[Str]]) – 排除匹配标签的Runnables的运行。
_schema_format (字面量['original', 'streaming_events']) –
主要改变输入和输出的处理方式。**仅限内部使用。此API将更改。** – ‘original’是所有当前跟踪器使用的格式。

此格式在输入和输出方面略有不一致。
- ‘streaming_events’用于支持流式事件，供内部使用。将来可能会更改，或完全废弃，以便改为使用专门针对流式事件异步跟踪器的API。

抛出

ValueError – 如果提供无效的架构格式（仅限内部使用）。

属性

`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__`(*[, auto_close, include_names, ...])	一个将运行日志流式传输到流的跟踪器。
`include_run`(run)	检查是否应将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`(output, , run_id, *kwargs)	结束工具运行的追踪。
`on_tool_error`(error, , run_id, *kwargs)	处理工具运行的错误。
`on_tool_start`(serialized, input_str, *, run_id)	开始工具运行的追踪。
`send`(*ops)	向流发送补丁，如果流已关闭则返回False。
`tap_output_aiter`(run_id, output)	点击一个输出异步迭代器，将它的值流式传输到日志中。
`tap_output_iter`(run_id, output)	点击一个输出异步迭代器，将它的值流式传输到日志中。

__init__(*, auto_close: bool = True, include_names: Optional[Sequence[str]] = None, include_types: Optional[Sequence[str]] = None, include_tags: Optional[Sequence[str]] = None, exclude_names: Optional[Sequence[str]] = None, exclude_types: Optional[Sequence[str]] = None, exclude_tags: Optional[Sequence[str]] = None, _schema_format: Literal['original', 'streaming_events'] = 'streaming_events') → None[source]¶

一个将运行日志流式传输到流的跟踪器。

参数

auto_close (布尔值) – 是否在根运行完成后关闭流。
include_names (可选[序列[字符串]]) – 仅包含具有匹配名称的可运行实例的运行。
include_types (可选[序列[Str]]) – 仅包括匹配类型的Runnables的运行。
include_tags (可选[序列[Str]]) – 仅包括匹配标签的Runnables的运行。
exclude_names (可选[序列[Str]]) – 排除匹配名称的Runnables的运行。
exclude_types (可选[序列[Str]]) – 排除匹配类型的Runnables的运行。
exclude_tags (可选[序列[Str]]) – 排除匹配标签的Runnables的运行。
_schema_format (字面量['original', 'streaming_events']) –
主要改变输入和输出的处理方式。**仅限内部使用。此API将更改。** – ‘original’是所有当前跟踪器使用的格式。

此格式在输入和输出方面略有不一致。
- ‘streaming_events’用于支持流式事件，供内部使用。将来可能会更改，或完全废弃，以便改为使用专门针对流式事件异步跟踪器的API。

抛出

ValueError – 如果提供无效的架构格式（仅限内部使用）。

返回类型

None

include_run(run: Run) → bool[source]¶

检查是否应将Run包含在日志中。

参数: run (Run) – 要检查的运行。
返回值: 如果应包含运行，则返回 True，否则返回 False。
返回类型: bool

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) – 自定义事件的数据。格式将与用户指定的格式相符。
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]) – 序列化模型。
prompts (列表[字符串]) – 启动LLM时使用的提示。
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: Sequence[Document], *, run_id: UUID, **kwargs: Any) → Run¶

当检索器运行结束时的操作。

参数

documents (序列[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, name: Optional[str] = None, **kwargs: Any) → Run¶

当检索器开始运行时的操作。

参数

serialized (字典str，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) – 额外参数。

返回值

运行。

返回类型

运行

send(*ops: Dict[str, Any]) → bool[source]¶

向流发送补丁，如果流已关闭则返回False。

参数

*ops (Dict[str, Any]) – 需要发送到流的操作。

返回值

如果补丁发送成功为真，如果流: 已关闭为假。

返回类型

bool

async tap_output_aiter(run_id: UUID, output: AsyncIterator[T]) → AsyncIterator[T][来源]¶

点击一个输出异步迭代器，将它的值流式传输到日志中。

参数

run_id (UUID) – 运行ID。
output (AsyncIterator[T]) – 输出异步迭代器。

产生

T – 输出值。

返回类型

AsyncIterator[T]

tap_output_iter(run_id: UUID, output: Iterator[T]) → Iterator[T][来源]¶

点击一个输出异步迭代器，将它的值流式传输到日志中。

参数

run_id (UUID) – 运行ID。
output (Iterator[T]) – 输出迭代器。

产生

T – 输出值。

返回类型

Iterator[T]

langchain_core.tracers.log_stream.LogStreamCallbackHandler¶

`langchain_core.tracers.log_stream`.LogStreamCallbackHandler¶