Source code for langchain_experimental.comprehend_moderation.base_moderation_config

from typing import List, Union

from pydantic import BaseModel


class ModerationPiiConfig(BaseModel):
    """PII（个人身份信息）过滤器的配置。"""

    threshold: float = 0.5
    """PII置信度分数的阈值，默认为0.5，即50%"""

    labels: List[str] = []
    """PII通用标签列表。
默认为`list[]`"""

    redact: bool = False
    """是否执行检测到的个人身份信息实体的删除操作"""

    mask_character: str = "*"
    """在redact=True时用于遮蔽的字符，默认为星号（*）"""


class ModerationToxicityConfig(BaseModel):
    """毒性审查过滤器的配置。"""

    threshold: float = 0.5
    """毒性标签置信度阈值，默认为0.5，即50%"""

    labels: List[str] = []
    """毒性标签列表，默认为`list[]`"""


class ModerationPromptSafetyConfig(BaseModel):
    """Prompt Safety（提示安全）调节过滤器的配置。"""

    threshold: float = 0.5
    """阈值用于提示安全分类的置信度分数，默认为0.5，即50%。"""


class BaseModerationConfig(BaseModel):
    """适用于内容管理的基本配置设置。"""

    filters: List[
        Union[
            ModerationPiiConfig, ModerationToxicityConfig, ModerationPromptSafetyConfig
        ]
    ] = [
        ModerationPiiConfig(),
        ModerationToxicityConfig(),
        ModerationPromptSafetyConfig(),
    ]
    """
    # 应用于审查链的过滤器，默认为
    # `[ModerationPiiConfig(), ModerationToxicityConfig(),
    # ModerationPromptSafetyConfig()]`"""