langchain_community.callbacks.sagemaker_callback.SageMakerCallbackHandler

class langchain_community.callbacks.sagemaker_callback.SageMakerCallbackHandler(run: Any)

回调处理程序，用于将提示工件和指标记录到 SageMaker Experiments。

参数

run (sagemaker.experiments.run.Run) – 实验记录的 Run 对象。

初始化回调处理程序。

属性

ignore_agent	是否忽略 Agent 回调。
ignore_chain	是否忽略 Chain 回调。
ignore_chat_model	是否忽略 Chat Model 回调。
ignore_custom_event	忽略自定义事件。
ignore_llm	是否忽略 LLM 回调。
ignore_retriever	是否忽略 Retriever 回调。
ignore_retry	是否忽略重试回调。
raise_error	如果发生异常，是否引发错误。
run_inline	是否内联运行回调。

方法

__init__(run)	初始化回调处理程序。
flush_tracker()	重置步骤并删除临时本地目录。
jsonf(data, data_dir, filename[, is_output])	将输入数据记录为 json 文件工件。
on_agent_action(action, **kwargs)	在 Agent 操作时运行。
on_agent_finish(finish, **kwargs)	当 Agent 结束运行时运行。
on_chain_end(outputs, **kwargs)	当 Chain 结束运行时运行。
on_chain_error(error, **kwargs)	当 Chain 发生错误时运行。
on_chain_start(serialized, inputs, **kwargs)	当 Chain 开始运行时运行。
on_chat_model_start(serialized, messages, *, ...)	当聊天模型开始运行时运行。
on_custom_event(name, data, *, run_id[, ...])	重写以定义自定义事件的处理程序。
on_llm_end(response, **kwargs)	当 LLM 结束运行时运行。
on_llm_error(error, **kwargs)	当 LLM 发生错误时运行。
on_llm_new_token(token, **kwargs)	当 LLM 生成新令牌时运行。
on_llm_start(serialized, prompts, **kwargs)	当 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[, parent_run_id])	在重试事件时运行。
on_text(text, **kwargs)	当 Agent 结束时运行。
on_tool_end(output, **kwargs)	当 Tool 结束运行时运行。
on_tool_error(error, **kwargs)	当 Tool 发生错误时运行。
on_tool_start(serialized, input_str, **kwargs)	当 Tool 开始运行时运行。

__init__(run: Any) → None

初始化回调处理程序。

参数

run (Any) –

返回类型

None

flush_tracker() → None

重置步骤并删除临时本地目录。

返回类型

None

jsonf(data: Dict[str, Any], data_dir: str, filename: str, is_output: Optional[bool] = True) → None

将输入数据记录为 json 文件工件。

参数

• data (Dict[str, Any]) –

• data_dir (str) –

• filename (str) –

• is_output (Optional[bool]) –

返回类型

None

on_agent_action(action: AgentAction, **kwargs: Any) → Any

在 Agent 操作时运行。

参数

• action (AgentAction) –

• kwargs (Any) –

返回类型

Any

on_agent_finish(finish: AgentFinish, **kwargs: Any) → None

当 Agent 结束运行时运行。

参数

• finish (AgentFinish) –

• kwargs (Any) –

返回类型

None

on_chain_end(outputs: Dict[str, Any], **kwargs: Any) → None

当 Chain 结束运行时运行。

参数

• outputs (Dict[str, Any]) –

• kwargs (Any) –

返回类型

None

on_chain_error(error: BaseException, **kwargs: Any) → None

当 Chain 发生错误时运行。

参数

• error (BaseException) –

• kwargs (Any) –

返回类型

None

on_chain_start(serialized: Dict[str, Any], inputs: Dict[str, Any], **kwargs: Any) → None

当 Chain 开始运行时运行。

参数

• serialized (Dict[str, Any]) –

• inputs (Dict[str, Any]) –

• kwargs (Any) –

返回类型

None

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, **kwargs: Any) → Any

当聊天模型开始运行时运行。

注意：此方法为聊天模型调用。如果您正在实现

非聊天模型的处理程序，您应该使用 on_llm_start 代替。

参数

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

• 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) – 附加关键字参数。

返回类型

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, **kwargs: Any) → None

当 LLM 结束运行时运行。

参数

• response (LLMResult) –

• kwargs (Any) –

返回类型

None

on_llm_error(error: BaseException, **kwargs: Any) → None

当 LLM 发生错误时运行。

参数

• error (BaseException) –

• kwargs (Any) –

返回类型

None

on_llm_new_token(token: str, **kwargs: Any) → None

当 LLM 生成新令牌时运行。

参数

• token (str) –

• kwargs (Any) –

返回类型

None

on_llm_start(serialized: Dict[str, Any], prompts: List[str], **kwargs: Any) → None

当 LLM 启动时运行。

参数

• serialized (Dict[str, Any]) –

• prompts (List[str]) –

• kwargs (Any) –

返回类型

None

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

当 Retriever 结束运行时运行。

参数

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

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

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

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

返回类型

Any

on_retriever_error(error: BaseException, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any

当 Retriever 发生错误时运行。

参数

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

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

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

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

返回类型

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, **kwargs: Any) → Any

当 Retriever 开始运行时运行。

参数

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

• query (str) – 查询。

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

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

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

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

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

返回类型

Any

on_retry(retry_state: RetryCallState, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any

在重试事件时运行。

参数

• retry_state (RetryCallState) – 重试状态。

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

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

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

返回类型

Any

on_text(text: str, **kwargs: Any) → None

当 Agent 结束时运行。

参数

• text (str)

• kwargs (Any) –

返回类型

None

on_tool_end(output: Any, **kwargs: Any) → None

当 Tool 结束运行时运行。

参数

• output (Any)

• kwargs (Any) –

返回类型

None

on_tool_error(error: BaseException, **kwargs: Any) → None

当 Tool 发生错误时运行。

参数

• error (BaseException) –

• kwargs (Any) –

返回类型

None

on_tool_start(serialized: Dict[str, Any], input_str: str, **kwargs: Any) → None

当 Tool 开始运行时运行。

参数

• serialized (Dict[str, Any]) –

• input_str (str)

• kwargs (Any) –

返回类型

None

SageMakerCallbackHandler 的使用示例

• AWS

• SageMaker 跟踪