- 最新动态
- 产品介绍
- 快速入门
- 用户指南
- 最佳实践
- API参考
- 常见问题
- 文档下载
- 通用参考
链接复制成功!
提交数据质量作业API
功能介绍
该接口用于提交数据质量作业并进行离线计算。
请求参数
请求参数参见表2。
参数名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
workspace_id |
否 |
String |
工作空间ID,默认为0 |
job_name |
是 |
String |
训练作业名称,最大长度为20字符。必须以DataQuality-开头。 |
job_description |
否 |
String |
训练作业描述,最大长度为256字符。 |
algorithm_type |
是 |
String |
算法类型
|
algorithm_parameters |
是 |
JSON |
算法参数,每一种算法都有其特定的参数。
|
data_source |
是 |
List |
算法数据源配置
|
offline_platform |
是 |
JSON |
请参见表3,离线计算平台信息。 |
参数名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
platform |
是 |
String |
平台名称,最大长度64,支持DLI。 |
platform_parameter |
是 |
JSON |
请参见表4,平台参数。 |
computing_resource |
否 |
String |
指定DLI运行任务的资源规格。 |
config_load_path |
是 |
String |
读取配置源路径。 |
参数名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
table_type_id |
是 |
String |
推荐通用数据模板
数据格式请参见推荐系统离线数据源。 通用格式
|
data_source_url |
是 |
String |
数据源路径,最大长度1000字符。 |
data_format |
是 |
String |
输入数据格式,可选值:csv、parquet、json、orc。 |
data_param |
否 |
JSON |
请参见表6,数据格式是csv的时候必选,其他可选。 |
参数名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
header |
是 |
Boolean |
是否显示表头。 |
delimiter |
是 |
String |
分割符,最大长度10个字符。 |
quote |
是 |
String |
引用字符,最大长度10个字符。 |
escape |
是 |
String |
转义字符,最大长度10个字符。 |
参数名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
输出路径(result_path) |
是 |
String |
所有输出数据(错误数据以及错误信息)的存储路径,文件夹。 |
全局特征配置文件路径(global_features_information_path) |
是 |
String |
该文件为JSON格式,包含特征名、特征大类、特征值类型。全局特征文件详细内容可以通过查询全局特征配置获取。 |
响应消息
响应参数请参见表8。
示例
- 请求示例
{ "job_name": "DataQuality-ll", "job_description": "hhx test", "algorithm_type": "DATA_QUALITY_INSPECTION", "algorithm_parameters": { "result_path": "<输出数据的存储都路径>", "global_features_information_path": "<全局特征配置文件路径>" }, "offline_platform": { "platform": "DLI", "platform_parameter": { "cluster_name": "res_cluster" }, "config_load_path": "<配置源路径>", "computing_resource": "" }, "data_source": [{ "table_type_id": "USER_META", "data_format": "csv", "data_source_url": "<数据源存储路径>", "data_param": { "header": "false", "delimiter": ",", "quote": "\"", "escape": "\\" } }, { "table_type_id": "USER_META_CONF", "data_format": "csv", "data_source_url": "<数据源存储路径>", "data_param": { "header": "true", "delimiter": ",", "quote": "\"", "escape": "\\" } }, { "table_type_id": "ITEM_META", "data_format": "csv", "data_source_url": "<数据源存储路径>", "data_param": { "header": "false", "delimiter": ",", "quote": "\"", "escape": "\\" } }, { "table_type_id": "ITEM_META_CONF", "data_format": "csv", "data_source_url": "<数据源存储路径>", "data_param": { "header": "true", "delimiter": ",", "quote": "\"", "escape": "\\" } }, { "table_type_id": "USER_BEHAVIOR", "data_format": "csv", "data_source_url": "<数据源存储路径>", "data_param": { "header": "false", "delimiter": ",", "quote": "\"", "escape": "\\" } }] }
- 成功响应示例
{ "is_success": true, "job_id": "59c3a237731b4ebfbf561d765b04def7", "filter_uuid": "5efc448313fb4dbf95e1e6cc307b92d6" }
- 失败响应示例
{ "is_success": false, "error_code": "res.2006", "error_msg": "The datasourceUrl(<数据源存储路径>) is not match Bucket structure." }
状态码
状态码请参见状态码。