匿名化器

langsmith.anonymizer

函数	描述
create_anonymizer	创建一个匿名化函数。

StringNode

基类：TypedDict

从数据中提取的字符串节点。

value instance-attribute

value: str

字符串值。

path instance-attribute

path: list[str | int]

数据中字符串节点的路径。

StringNodeProcessor

处理一个字符串节点列表以进行脱敏。

方法	描述
mask_nodes	接受并返回一个待脱敏的字符串节点列表。

mask_nodes abstractmethod

mask_nodes(nodes: list[StringNode]) -> list[StringNode]

接受并返回一个待脱敏的字符串节点列表。

ReplacerOptions

基类：TypedDict

用于替换敏感数据的配置选项。

max_depth instance-attribute

max_depth: int | None

为提取字符串节点而遍历的最大深度。

deep_clone instance-attribute

deep_clone: bool | None

在替换前深度克隆数据。

StringNodeRule

基类：TypedDict

用于替换敏感数据的声明性规则。

pattern instance-attribute

pattern: Pattern

要匹配的正则表达式模式。

replace instance-attribute

replace: str | None

替换值。如果未指定，默认为 [redacted]。

RuleNodeProcessor

基类：StringNodeProcessor

使用规则列表来替换敏感数据的字符串节点处理器。

方法	描述
__init__	用规则列表初始化处理器。
mask_nodes	使用规则对节点进行脱敏。

rules instance-attribute

rules: list[StringNodeRule] = [
    {
        "pattern": rule["pattern"]
        if isinstance(rule["pattern"], Pattern)
        else compile(rule["pattern"]),
        "replace": rule["replace"] if isinstance(get("replace"), str) else "[redacted]",
    }
    for rule in rules
]

用于替换敏感数据的规则列表。

每条规则都是一个 StringNodeRule，其中包含一个用于匹配的正则表达式模式和一个可选的替换字符串。

__init__

__init__(rules: list[StringNodeRule])

用规则列表初始化处理器。

mask_nodes

mask_nodes(nodes: list[StringNode]) -> list[StringNode]

使用规则对节点进行脱敏。

CallableNodeProcessor

基类：StringNodeProcessor

使用可调用函数替换敏感数据的字符串节点处理器。

方法	描述
__init__	使用可调用函数初始化处理器。
mask_nodes	使用可调用函数对节点进行脱敏。

func instance-attribute

func: Callable[[str], str] | Callable[[str, list[Union[str, int]]], str] = func

用于替换敏感数据的可调用函数。

它可以是接受单个字符串参数并返回字符串的函数，也可以是接受一个字符串和路径元素列表（字符串或整数）并返回字符串的函数。

accepts_path instance-attribute

accepts_path: bool = len(parameters) == 2

指示可调用函数是否接受路径参数。

如果为 True，则函数需要两个参数：待处理的字符串和该字符串的路径。如果为 False，则函数仅需要待处理的字符串。

__init__

__init__(func: Callable[[str], str] | Callable[[str, list[Union[str, int]]], str])

使用可调用函数初始化处理器。

mask_nodes

mask_nodes(nodes: list[StringNode]) -> list[StringNode]

使用可调用函数对节点进行脱敏。

create_anonymizer

create_anonymizer(
    replacer: ReplacerType, *, max_depth: int | None = None
) -> Callable[[Any], Any]

创建一个匿名化函数。