langchain_core.tracers.langchain
.LangChainTracer¶
- class langchain_core.tracers.langchain.LangChainTracer(example_id: Optional[Union[UUID, str]] = None, project_name: Optional[str] = None, client: Optional[Client] = None, tags: Optional[List[str]] = None, **kwargs: Any)[source]¶
实现了将数据POST到LangChain端点的SharedTracer。
初始化LangChain追踪器。
- 参数
example_id (可选[Union[UUID, str]]) – 示例ID。
project_name (可选[str]) – 项目名称。默认为追踪器项目。
client (可选[Client]) – 客户端。默认为全局客户端。
tags (可选[List[str]]) – 标签。默认为空列表。
kwargs (任意) – 额外的关键字参数。
属性
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__
([example_id, project_name, client, ...])初始化LangChain追踪器。
获取LangSmith根运行URL。
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)启动对工具运行的跟踪。
等待未来
()等待给定的future完成。
- __init__(example_id: Optional[Union[UUID, str]], project_name: Optional[str], client: Optional[Client], tags: Optional[List[str]], **kwargs: Any) None [source]¶
初始化LangChain追踪器。
- 参数
example_id (可选[Union[UUID, str]]) – 示例ID。
project_name (可选[str]) – 项目名称。默认为追踪器项目。
client (可选[Client]) – 客户端。默认为全局客户端。
tags (可选[List[str]]) – 标签。默认为空列表。
kwargs (任意) – 额外的关键字参数。
- 返回类型
None
- get_run_url() str [source]¶
获取LangSmith根运行URL。
- 返回
LangSmith根运行URL。
- 返回类型
str
- 引发
ValueError – 如果找不到跟踪运行。
ValueError – 如果找不到运行URL。
- 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
- 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
- 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 [source]¶
开始对一个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]) – 名称。默认为 None。
kwargs (任意) – 额外的关键字参数。
- 返回
运行结果。
- 返回类型
- 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_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 (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 (Optional[str]) – 运行的名称。
kwargs (Any) – 其他参数。
- 返回
运行结果。
- 返回类型
- on_retriever_end(documents: Sequence[Document], *, run_id: UUID, **kwargs: Any) Run ¶
Retriever运行完毕时运行。
- 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 (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 (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
- 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) – 其他参数。
- 返回
运行结果。
- 返回类型