创建数据清洗任务
更新时间：2024-11-08
功能介绍
本接口用于创建数据清洗任务。
HTTP调用
鉴权说明
调用本文API，使用“基于安全认证AK/SK”进行签名计算鉴权，即使用安全认证中的Access Key ID 和 Secret Access Key进行鉴权，具体鉴权认证机制参考HTTP调用鉴权说明。
请求说明
- 基本信息
请求地址：https://qianfan.baidubce.com/wenxinworkshop/etl/create
请求方式：POST
- Header参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Content-Type | string | 是 | 固定值：application/json |
| x-bce-date | string | 否 | 当前时间，遵循ISO8601规范，格式如2016-04-06T08:23:49Z |
| Authorization | string | 是 | 用于验证请求合法性的认证信息，更多内容请参考鉴权认证机制，签名工具可参考IAM签名工具 |
- Body参数
| 名称 | 必填 | 类型 | 描述 |
|---|---|---|---|
| etlTaskName | 是 | string | 清洗任务名称 |
| sourceDatasetId | 是 | string | 清洗前的源数据集版本ID，说明： 该字段新增支持string类型；如果之前接入时使用的int类型，建议变更为string类型，后续将逐渐废弃int类型 |
| destDatasetId | 是 | string | 清洗后的目标数据集版本ID，说明： 该字段新增支持string类型；如果之前接入时使用的int类型，建议变更为string类型，后续将逐渐废弃int类型 |
| entityType | 是 | int | 清洗样本类型，固定值为2，表示文本 |
| operationsV2 | 是 | map[string][]operationV2 | 清洗配置 ，说明： （1）key为string，需包括以下值： · 清洗：clean · 过滤：filter · 去重：deduplication · 去隐私：desensitization （2）value为list，值为单个阶段用户所选择的所有算子组成的列表 · 列表中的每个元素，对应某个算子的配置，格式参考operationsV2说明 · 如果用户没有在对应阶段选择任何算子，则value为空列表 |
operationV2说明
| 名称 | 类型 | 描述 |
|---|---|---|
| name | string | 算子名称，见各阶段name值和args值 （1）Clean清洗阶段算子 · remove_emoji：去除文档中的表情等 · remove_invisible_character：移除ASCII中的一些不可见字符, 如0-32 和127-160这两个范围 · replace_uniform_whitespace：将不同的unicode空格比如 u2008，转成正常的空格 · remove_non_meaning_characters：去除乱码和无意义的unicode · replace_traditional_chinese_to_simplified：繁体转简体，如“不經意，妳的笑容”清洗成“不经意，你的笑容” · remove_web_identifiers：移除文档中的html标签，如 <html>,<dev>,<p>等（2）Filter过滤阶段算子 · filter_check_number_words：检查文档的词数目，词数目不在指定范围会被过滤掉，如中文[1,10000] · filter_check_word_repetition_removal：检查文档的词重复率，如果词重复率太高，意味着文档中重复的词太多，文档会被过滤掉 · filter_check_character_repetition_removal：检查文档的字重复率，如果字重复率太高，意味着文档中重复的字太多，文档会被过滤掉 · filter_check_special_characters：检查文档的特殊字符率，如果特殊字符率太高，意味着文档中特殊字符太多，文档会被过滤掉 ·filter_check_flagged_words：检查文档的色情暴力词率,如果色情暴力词率太高，文档会被过滤掉 · filter_check_lang_id：检查文档的语言概率,如果语言概率太低，文档会被过滤掉 · filter_check_perplexity：检查文档的困惑度,如果困惑度太高，文档会被过滤掉 （3）Deduplication去重阶段算子 · deduplication_simhash：根据海明距离计算文档相似度, 相似度<=海明距离，认为两个文档相似。 （4）Desensitization 去隐私阶段算子 · replace_emails：去除email地址 · replace_ip：去除IPv4 或者 IPv6 地址 · replace_identifier：去除数字和字母数字标识符，如电话号码、信用卡号、十六进制散列等，同时跳过年份和简单数字的实例 |
| args | object | 算子参数，格式随参数名称而变化，见各阶段name值对应的args说明： · 当name为Clean清洗阶段算子，args值为空 · 当name为Desensitization 去隐私阶段算子，args值为空 · 当name为Deduplication或Desensitization，请查看args说明 |
args说明
- 当name为Clean清洗阶段算子，args值为空
- 当name为Desensitization 去隐私阶段算子，args值为空
- 当name为Deduplication去重阶段算子，args说明如下
| 名称 | 类型 | 描述 |
|---|---|---|
| distance | int | 范围4-6 |
- 当name为Filter过滤阶段算子，args说明如下
| 名称 | 类型 | 描述 |
|---|---|---|
| number_words_min_cutoff | float | 最小词数目 · 范围为[1,10000] · 当name=filter_check_number_words，该字段必填 |
| number_words_max_cutoff | float | 最大词数目 · 范围为[1,10000] · 当name=filter_check_number_words，该字段必填 |
| word_repetition_max_cutoff | float | 文档的词重复率 · 范围为0-1 · 当name=filter_check_word_repetition_removal，该字段必填 |
| default_character_repetition_max_cutoff | float | 文档的字重复率 · 范围为0-1 · 当name=filter_check_character_repetition_removal，该字段必填 |
| special_characters_max_cutoff | float | 检查文档的特殊字符率，如果特殊字符率太高，意味着文档中特殊字符太多，文档会被过滤掉 · 范围为0-1 · 当name=filter_check_special_characters，该字段必填 |
| flagged_words_max_cutoff | float | 检查文档的色情暴力词率,如果色情暴力词率太高，文档会被过滤掉 ·范围为0-1 · 当name=filter_check_flagged_words，该字段必填 |
| lang_id_min_cutoff | float | 检查文档的语言概率,如果语言概率太低，文档会被过滤掉 · 范围为0-1 · 当name=filter_check_lang_id，该字段必填 |
| perplexity_max_cutoff | float | 检查文档的困惑度,如果困惑度太高，文档会被过滤掉 ·范围为1-5000 · 当name=filter_check_perplexity，该字段必填 |
响应说明
| 名称 | 类型 | 描述 |
|---|---|---|
| log_id | string | 操作记录id |
| result | string | 清洗任务序号 |
| status | int | 状态码 |
| success | bool | 是否操作成功，说明： · true：成功 · false：失败 |
请求示例
# 替换下列示例中的Authorization值、x-bce-date值
curl -i --location 'https://qianfan.baidubce.com/wenxinworkshop/etl/create' \
--header 'Authorization: bce-auth-v1/f0ee7axxxx/2023-09-19T13:42:13Z/180000/host;x-bce-date/9a8cfb8ee58a8f44a21a52640015de61bc55ca2e6d8cc23d080016e374525543' \
--header 'x-bce-date: 2023-09-19T13:37:10Z' \
--header 'Content-Type: application/json' \
--data '{
"etlTaskName": "清洗任务1",
"sourceDatasetId": "ds-9tff1q3h7ngdmgh4",
"destDatasetId": "ds-3tfe1q3g7ncdmsh2",
"operationsV2": {
"clean": [{
"name": "remove_invisible_character",
"args": {}
}, {
"name": "replace_uniform_whitespace",
"args": {}
}, {
"name": "remove_non_meaning_characters",
"args": {}
}, {
"name": "replace_traditional_chinese_to_simplified",
"args": {}
}, {
"name": "remove_web_identifiers",
"args": {}
}, {
"name": "remove_emoji",
"args": {}
}],
"deduplication": [{
"name": "deduplication_simhash",
"args": {
"distance": 4
}
}],
"desensitization": [{
"name": "replace_emails",
"args": {}
}, {
"name": "replace_ip",
"args": {}
}, {
"name": "replace_identifier",
"args": {}
}],
"filter": [{
"name": "filter_check_number_words",
"args": {
"number_words_min_cutoff": 1,
"number_words_max_cutoff": 10000
}
}, {
"name": "filter_check_word_repetition_removal",
"args": {
"word_repetition_max_cutoff": 0.96
}
}, {
"name": "filter_check_special_characters",
"args": {
"special_characters_max_cutoff": 0.3
}
}, {
"name": "filter_check_flagged_words",
"args": {
"flagged_words_max_cutoff": 0.3
}
}]
},
"entityType": 2
}'响应示例
{
"log_id": "i9vswaefzbqpu92d",
"result": "task-wtff1q3h7nfd3g54",
"status": 200,
"success": true
}SDK调用
平台支持通过Python SDK、Go SDK、Java SDK 和 Node.js SDK调用本文API，SDK调用说明文档请参考创建数据清洗任务。
错误码
若请求错误，服务器将返回的JSON文本包含以下参数：
| 名称 | 描述 |
|---|---|
| code | 错误码 |
| message | 错误描述信息，帮助理解和解决发生的错误 |
例如参数错误返回：
{
"code":"ParamFieldValueInvalid",
"message":"参数不合法"
}更多错误码，请查看错误码说明。