# Clean Email Mapper

> Clean Email Mapper is an Agent Skill for documents published in the cas-bigdatalab/piflow repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

清理文本样本中的电子邮件。当用户提到清理邮件、删除邮箱、去除邮件地址、清理个人信息等需求时使用此skill。 即使用户没有明确说出"邮件"，只要任务涉及从文本中删除或替换邮箱地址，就应该使用此skill。

- Skill name: `clean_email_mapper`
- Category: [Documents](https://www.openparable.com/skill/documents/1)
- Source: https://github.com/cas-bigdatalab/piflow/blob/HEAD/workspace/skills/clean_email_mapper/SKILL.md
- Repository: cas-bigdatalab/piflow (541 GitHub stars when collected)

## SKILL.md

# Clean Email Mapper

清理文本中的电子邮件地址。

本SKILL使用依赖data_juicer，请在调用前安装好python环境并安装data_juicer，你可用同以下指令进行安装：
```
pip install py-data-juicer
```

## 核心参数

| 参数 | 类型 | 必填 | 默认值 | 说明 |
|------|------|------|--------|------|
| input_path | string | 是 | - | 输入JSON文件路径 |
| output_path | string | 是 | - | 输出JSON文件路径 |
| pattern | string | 否 | 默认邮箱正则 | 正则表达式模式 |
| repl | string | 否 | 空字符串 | 替换字符串（默认为删除） |

## 使用方法

```bash
python scripts/run_clean_email_mapper.py --input_path <input_path> --output_path <output_path> [--repl <replacement>]
```

## 实现原理

参照测试代码 test_clean_email_mapper.py 中的 `_run_clean_email` 函数：

```python
# 1. 初始化算子
op = CleanEmailMapper()  # 删除邮件
# 或
op = CleanEmailMapper(repl='<EMAIL>')  # 替换为指定字符串

# 2. 将数据转为Dataset，使用 op.run(dataset) 处理
dataset = Dataset.from_list(samples)
result_dataset = op.run(dataset)
```

## 输入输出格式

### 输入格式 (JSON数组)

```json
[
  {"text": "请联系我：user@example.com"},
  {"text": "邮箱是 abc@123.com，请回复"}
]
```

### 输出格式 (JSON数组)

```json
[
  {"text": "请联系我："},
  {"text": "邮箱是 ，请回复"}
]
```

## 示例

### 示例1：删除邮件地址（默认）

```bash
python scripts/run_clean_email_mapper.py --input_path example_input.json --output_path output.json
```

### 示例2：替换为占位符

```bash
python scripts/run_clean_email_mapper.py --input_path example_input.json --output_path output.json --repl "<EMAIL>"
```

## 注意事项

- 默认行为是删除邮件地址
- 可以指定 `repl` 参数来替换为其他字符串
- 支持自定义正则表达式模式

---

Source: https://www.openparable.com/skill/documents/clean-email-mapper (OpenParable). Cite the canonical URL above.
