智能数据API
智能数据API
目前BML对数据集进行创建、删除、导入、导出、新增版本等操作有两种操作方式。 一种是通过在平台页面直接进行操作; 一种为通过调用相关API对数据集进行相应操作。本文档主要介绍如何用API对数据集进行相关操作。
目录
- 接口鉴权
- 创建数据集API接口文档
- 数据集上传API接口文档
- 删除数据集API接口文档
- 新增数据集版本API接口文档
- 获取数据集版本详情API接口文档
- 删除数据集版本API接口文档
- 发起数据导入任务API接口文档
- 发起数据导入任务详情API接口文档
- 发起数据导出任务API接口文档
- 获取数据集版本导出详情API接口文档
- 获取数据集列表API接口文档
- 获取数据集版本列表API接口文档
- 获取数据表schema结构API接口文档
- 错误码
接口鉴权
1、进入BML控制台的公有云服务管理—应用列表——创建应用
2、根据页面提示输入应用名称、应用场景等说明完成应用创建
3、应用详情页获取API Key和Secret Key
创建数据集API接口文档
接口功能描述
本接口用于创建新的数据集,数据集创建完成后自带版本V1。目前支持图像分类、物体检测、文本分类、短文本匹配、表格预测、时序预测六种数据类型创建。
请求说明
请求示例
HTTP 方法:POST
请求URL:https://aip.baidubce.com/rpc/2.0/easydl/pro/dataset/create
URL参数:
参数 | 值 |
---|---|
access_token | 通过API Key和Secret Key获取的access_token,参考“Access Token获取” |
Header如下:
参数 | 值 |
---|---|
Content-Type | application/json |
Body中放置请求参数,参数详情如下:
请求参数
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
dataset_name | string | 是 | 数据集名称,示例:"helloDataset" |
type | string | 是 | 数据集类型图像分类:“IMAGE_CLASSIFICATION”物体检测:“OBJECT_DETECTION”短文本相似度:“TEXT_MATCHING”文本分类:“TEXT_CLASSIFICATION”表格预测:“DATA_TABLE_FORECASTING”时序预测:“ TIME_SERIES_FORECASTING” |
template_type | string | 是 | 标注模板类型图像分类-单图单标签:“IMAGE_CLASSIFICATION_ONE_LABEL”图像分类-单图多标签:“IMAGE_CLASSIFICATION_MUL_LABEL”矩形框标注:“OBJECT_DETECTION_RECTANGLE”短文本单标签:“TEXT_CLASSIFICATION_ONE_LABEL”短文本相似度:“TEXT_SIMILARITY”表格预测:“DATA_TABLE_FORECASTING”时序预测:“ TIME_SERIES_FORECASTING” |
storage_type | string | 否 | 存储类型对象存储BOS:"usrBos"平台共享存储:"sysBos"(默认) |
storage_path | string | 否 | 存储类型为对象存储BOS时,对应的完整存储路径即:bos:/bucket/dir/示例:将数据集存储到 bucket:yourBucket,dir:yourDir/text需填写的bosPath为 bos:/yourBucket/yourDir/text/注意:以左斜杠结尾 |
响应说明
响应参数
名称 | 类型 | 说明 |
---|---|---|
log_id | int | 操作记录ID |
dataset_id | int | 数据集版本id |
dataset_group_id | int | 数据集id |
error_code | int | 错误码,失败才有(见错误码表) |
error_msg | string | 错误消息,失败才有 |
数据集上传API接口文档
接口功能描述
该接口可用于对已创建的数据集上传数据内容,目前支持图像分类、物体检测、文本分类、短文本匹配四类数据创建。
请求说明
请求示例
HTTP 方法:POST
请求URL:https://aip.baidubce.com/rpc/2.0/easydl/pro/dataset/addentity
URL参数:
参数 | 值 |
---|---|
access_token | 通过API Key和Secret Key获取的access_token,参考“Access Token获取” |
Header如下:
参数 | 值 |
---|---|
Content-Type | application/json |
Body中放置请求参数,参数详情如下:
请求参数
字段 | 必选 | 类型 | 说明 |
---|---|---|---|
dataset_id | 是 | number | 数据集ID |
type | 是 | string | 数据集类型,可包括: IMAGE_CLASSIFICATION, OBJECT_DETECTION, TEXT_MATCHING, TEXT_CLASSIFICATION 分别对应:图像分类、物体检测、短文本匹配、文本分类 |
template_type | 是 | string | 标注模板类型,图像分类-单图单标签传值IMAGE_CLASSIFICATION_ONE_LABEL ;图像分类-单图多标签传值IMAGE_CLASSIFICATION_MUL_LABEL ;矩形框标注传值OBJECT_DETECTION_RECTANGLE 单文本单分类传值:TEXT_CLASSIFICATION_ONE_LABEL 短文本相似度传值:TEXT_SIMILARITY |
entity_content | 是 | string | type为IMAGE_CLASSIFY/OBJECT_DETECT时,填入图片的base64编码;type为TEXT_CLASSIFY/TEXT_MATCHING时,填入utf-8编码的文本。注意:当type为TEXT_MATCHING(即短文本匹配)时,短文本之间用\t分隔。 |
labels | 否 | array(object) | 标签/分类数据 |
+label_name | 否 | string | 标签/分类名称(由数字、字母、中划线、下划线组成),长度限制20B |
+left | 否 | number | 物体检测时需给出,标注框左上角到图片左边界的距离(像素) |
+top | 否 | number | 物体检测时需给出,标注框左上角到图片上边界的距离(像素) |
+width | 否 | number | 物体检测时需给出,标注框的宽度(像素) |
+height | 否 | number | 物体检测时需给出,标注框的高度(像素) |
append_label | 否 | boolean | 确定添加标签/分类的行为:追加(true)、替换(false)。默认为追加(true)。 |
返回说明
返回参数
字段 | 必选 | 类型 | 说明 |
---|---|---|---|
log_id | 是 | int | 唯一的log id,用于问题定位 |
删除数据集API接口文档
接口功能描述
本接口用于删除数据集(包含全部版本数据)。目前支持对表格预测、时序预测两种数据集进行操作。
请求说明
请求示例
HTTP 方法:POST
请求URL:https://aip.baidubce.com/rpc/2.0/easydl/pro/dataset/deleteDataset
URL参数:
参数 | 值 |
---|---|
access_token | 通过API Key和Secret Key获取的access_token,参考“Access Token获取” |
Header如下:
参数 | 值 |
---|---|
Content-Type | application/json |
Body中放置请求参数,参数详情如下:
请求参数
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
dataset_group_id | int | 是 | 数据集ID |
响应说明
响应参数
名称 | 类型 | 说明 |
---|---|---|
log_id | int | 操作记录ID |
error_code | int | 错误码,失败才有(见错误码表) |
error_msg | string | 错误消息,失败才有 |
result | bool | 返回结果,成功才有 |
新增数据集版本API接口文档
接口功能描述
本接口用于为数据集新增版本(不继承历史版本)。目前支持对表格预测、时序预测两种数据集进行操作。
请求说明
请求示例
HTTP 方法:POST
请求URL:https://aip.baidubce.com/rpc/2.0/easydl/pro/dataset/createDatasetVersion
URL参数:
参数 | 值 |
---|---|
access_token | 通过API Key和Secret Key获取的access_token,参考“Access Token获取” |
Header如下:
参数 | 值 |
---|---|
Content-Type | application/json |
Body中放置请求参数,参数详情如下:
请求参数
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
dataset_group_id | int | 是 | 需要新增版本的数据集ID |
description | string | 否 | 版本描述 |
type | string | 是 | 数据集类型图像分类:“IMAGE_CLASSIFICATION”物体检测:“OBJECT_DETECTION”短文本相似度:“TEXT_MATCHING”文本分类:“TEXT_CLASSIFICATION”表格预测:“DATA_TABLE_FORECASTING”时序预测:“ TIME_SERIES_FORECASTING” |
template_type | string | 是 | 标注模板类型图像分类-单图单标签:“IMAGE_CLASSIFICATION_ONE_LABEL”图像分类-单图多标签:“IMAGE_CLASSIFICATION_MUL_LABEL”矩形框标注:“OBJECT_DETECTION_RECTANGLE”短文本单标签:“TEXT_CLASSIFICATION_ONE_LABEL”短文本相似度:“TEXT_SIMILARITY”表格预测:“DATA_TABLE_FORECASTING”时序预测:“ TIME_SERIES_FORECASTING” |
响应说明
响应参数
名称 | 类型 | 说明 |
---|---|---|
log_id | int | 操作记录ID |
error_code | int | 错误码,失败才有(见错误码表) |
error_msg | string | 错误消息,失败才有 |
dataset_id | int | 版本id,成功才有 |
获取数据集版本详情API接口文档
接口功能描述
本接口用于获取特定数据集版本的详情信息,包括基本信息和统计信息。目前支持对表格预测、时序预测两种数据集进行操作。
请求说明
请求示例
HTTP 方法:POST
请求URL:https://aip.baidubce.com/rpc/2.0/easydl/pro/dataset/describeDatasetVersion
URL参数:
参数 | 值 |
---|---|
access_token | 通过API Key和Secret Key获取的access_token,参考“Access Token获取” |
Header如下:
参数 | 值 |
---|---|
Content-Type | application/json |
Body中放置请求参数,参数详情如下:
请求参数
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
dataset_id | int | 是 | 数据集版本ID |
响应说明
响应参数
名称 | 类型 | 说明 |
---|---|---|
log_id | int | 操作记录ID |
error_code | int | 错误码,失败才有(见错误码表) |
error_msg | string | 错误消息,失败才有 |
result | object | 返回结果,成功才有 |
返回说明
返回参数
名称 | 类型 | 说明 |
---|---|---|
dataset_group_id | int | 数据集ID |
dataset_id | int | 数据集版本ID |
version_number | int | 数据集版本序号 |
dataset_name | string | 数据集名称 |
description | string | 版本描述 |
storage_type | string | 存储类型对象存储BOS:"usrBos"平台共享存储:"sysBos" |
storage_path | string | 存储类型为对象存储BOS时,对应的完整存储路径 |
size_MB | float | 数据集大小,单位为MB,例:0.01 |
columns | int | 数据集列数 |
rows | int | 数据集行数 |
import_status | string | 导入状态正在导入:Importing已完成:ImportFinished导入失败:ImportFailed |
type | string | 数据集类型图像分类:“IMAGE_CLASSIFICATION”物体检测:“OBJECT_DETECTION”短文本相似度:“TEXT_MATCHING”文本分类:“TEXT_CLASSIFICATION”表格预测:“DATA_TABLE_FORECASTING”时序预测:“ TIME_SERIES_FORECASTING” |
template_type | string | 标注模板类型图像分类-单图单标签:“IMAGE_CLASSIFICATION_ONE_LABEL”图像分类-单图多标签:“IMAGE_CLASSIFICATION_MUL_LABEL”矩形框标注:“OBJECT_DETECTION_RECTANGLE”短文本单标签:“TEXT_CLASSIFICATION_ONE_LABEL”短文本相似度:“TEXT_SIMILARITY”表格预测:“DATA_TABLE_FORECASTING”时序预测:“ TIME_SERIES_FORECASTING” |
import_progress | float | 导入进度例:进度21%,表示为“0.21” |
create_time | string | 创建时间 |
modify_time | string | 更新时间 |
删除数据集版本API接口文档
接口功能描述
本接口用于删除数据集特定版本。目前支持对表格预测、时序预测两种数据集进行操作。
请求说明
请求示例
HTTP 方法:POST
请求URL:https://aip.baidubce.com/rpc/2.0/easydl/pro/dataset/deleteDatasetVersion
URL参数:
参数 | 值 |
---|---|
access_token | 通过API Key和Secret Key获取的access_token,参考“Access Token获取” |
Header如下:
参数 | 值 |
---|---|
Content-Type | application/json |
Body中放置请求参数,参数详情如下:
请求参数
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
dataset_id | int | 是 | 数据集版本ID |
响应说明
响应参数
名称 | 类型 | 说明 |
---|---|---|
log_id | int | 操作记录ID |
error_code | int | 错误码,失败才有(见错误码表) |
error_msg | string | 错误消息,失败才有 |
result | bool | 返回结果,成功才有 |
发起数据导入任务API接口文档
接口功能描述
本接口用于导入Esaydap数据源。目前支持对表格预测、时序预测两种数据集进行操作。
请求说明
请求示例
HTTP 方法:POST
请求URL:https://aip.baidubce.com/rpc/2.0/easydl/pro/dataset/createImportTask
URL参数:
参数 | 值 |
---|---|
access_token | 通过API Key和Secret Key获取的access_token,参考“Access Token获取” |
Header如下:
参数 | 值 |
---|---|
Content-Type | application/json |
Body中放置请求参数,参数详情如下:
请求参数
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
dataset_id | int | 是 | 数据集版本ID |
data_source_type | string | 是 | 固定值cloud_edap |
database_name | string | 是 | edap数据库名 |
table_name | string | 是 | edap数据表名 |
column_error | string | 否 | 处理升级auto自动处理(默认)skip放弃错误行fail快速失败 |
schema | object | 否 | 表格式,如果不传会使用默认的推测格式,全部列导入 |
schema.columns | list |
是 | 数据列序号,即可挑选需要的列导入,0表示第一列 |
schema.raw_names | list |
是 | 数据表原来的列名 |
schema.names | list |
是 | 数据表新的列名 |
schema.types | list |
是 | 数量列的类型,只支持基础类型,不支持复合类型smallint/int/bigint/float/double/date/timestamp/uuid/string/decimal(x,y),如decimal(10,2)表示总长度10,小数精度为2 |
例如
{
"dataset_id":19313,
"data_source_type":"cloud_edap",
"database_name":"dae_test",
"table_name":"dae_table",
"upload_type":"overwrite",
"column_error":"auto",
"schema":{
"columns":[0,1,2,3,4,5,6],
"types":["int","string","decimal(10,0)","double","date","string","smallint"],
"names":["id","name","c_decimal","c_double","c_date","c_bool","part_id"],
"raw_names":["id","name","c_decimal","c_double","c_date","c_bool","part_id"]
}
}
响应说明
响应参数
名称 | 类型 | 说明 |
---|---|---|
log_id | int | 操作记录ID |
error_code | int | 错误码,失败才有(见错误码表) |
error_msg | string | 错误消息,失败才有 |
task_id | int | 导入任务id,成功才有 |
例如
{
"task_id": 48459,
"log_id": 1525440098
}
获取数据导入任务详情API接口文档
接口功能描述
本接口用于获取数据集版本导入详情。目前支持对表格预测、时序预测两种数据集进行操作。
请求说明
请求示例
HTTP 方法:POST
请求URL:https://aip.baidubce.com/rpc/2.0/easydl/pro/dataset/describeImportTask
URL参数:
参数 | 值 |
---|---|
access_token | 通过API Key和Secret Key获取的access_token,参考“Access Token获取” |
Header如下:
参数 | 值 |
---|---|
Content-Type | application/json |
Body中放置请求参数,参数详情如下:
请求参数
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
task_id | int | 是 | 导入任务ID |
响应说明
响应参数
名称 | 类型 | 说明 |
---|---|---|
log_id | int | 操作记录ID |
error_code | int | 错误码,失败才有(见错误码表) |
error_msg | string | 错误消息,失败才有 |
result | object | 导入任务信息,成功才有 |
返回说明
返回参数
名称 | 类型 | 说明 |
---|---|---|
dataset_id | int | 数据集版本ID |
size_MB | float | 文件大小,单位为MB,例:0.01(导入成功后) |
columns | int | 数据集列数 |
rows | int | 数据集行数 |
import_status | string | 导入状态正在导入:Importing已完成:ImportFinished导入失败:ImportFailed |
import_progress | float | 导入进度例:进度21%,表示为“0.21” |
start_time | string | 导入开始时间 |
finish_time | string | 导入完成时间 |
发起数据导出任务API接口文档
接口功能描述
本接口用于创建数据导出任务。目前支持对表格预测、时序预测两种数据集进行操作。
请求说明
请求示例
HTTP 方法:POST
请求URL:https://aip.baidubce.com/rpc/2.0/easydl/pro/dataset/createExportTask
URL参数:
参数 | 值 |
---|---|
access_token | 通过API Key和Secret Key获取的access_token,参考“Access Token获取” |
Header如下:
参数 | 值 |
---|---|
Content-Type | application/json |
Body中放置请求参数,参数详情如下:
请求参数
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
dataset_id | int | int | 数据集版本ID |
storage_type | string | 是 | 导出位置的存储类型:对象存储BOS:"usrBos"平台共享存储:"sysBos" |
storage_path | string | 否 | 存储类型为对象存储BOS时,对应的导出完整路径 |
示例
{
"dataset_id": 19297,
"storage_type":"sysBos"
}
响应说明
响应参数
名称 | 类型 | 说明 |
---|---|---|
log_id | int | 操作记录ID |
error_code | int | 错误码,失败才有(见错误码表) |
error_msg | string | 错误消息,失败才有 |
task_id | int | 导出任务ID,成功才有 |
返回
{
"task_id": 1470,
"log_id": 2475571425
}
获取数据集版本导出详情API接口文档
接口功能描述
本接口用于获取数据集版本导出详情。目前支持对表格预测、时序预测两种数据集进行操作。
请求说明
请求示例
HTTP 方法:POST
请求URL:https://aip.baidubce.com/rpc/2.0/easydl/pro/dataset/describeExportTask
URL参数:
参数 | 值 |
---|---|
access_token | 通过API Key和Secret Key获取的access_token,参考“Access Token获取” |
Header如下:
参数 | 值 |
---|---|
Content-Type | application/json |
Body中放置请求参数,参数详情如下:
请求参数
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
task_id | int | 是 | 导出任务ID |
示例
{
"task_id": 1470
}
响应说明
响应参数
名称 | 类型 | 说明 |
---|---|---|
log_id | int | 操作记录ID |
error_code | int | 错误码,失败才有(见错误码表) |
error_msg | string | 错误消息,失败才有 |
result | object | 导出任务,成功才有 |
返回说明
返回参数
名称 | 类型 | 说明 |
---|---|---|
storage_type | string | 导出位置的存储类型:对象存储BOS:"usrBos"平台共享存储:"sysBos" |
storage_path | string | 存储类型为对象存储BOS时,对应的导出完整路径 |
size_MB | float | 导出文件大小,单位为MB,例:0.01 (成功后) |
sample_count | int | 数据量 |
export_status | string | 导出状态,状态说明:导出中:Exporting已完成完成:ExportFinished导出失败:ExportFailed |
start_time | string | 导出开始时间 |
finish_time | string | 导出完成时间 |
download_url | string | 下载地址 |
返回
{
"storage_type": "sysBos",
"storage_path": "bos:/sdc-default/_system_/dataset/ds-7a7cbwemm1m2f6fz/download/DatasetId_19297_export_1719560476.zip",
"size_MB": 0.01,
"sample_count": "16",
"export_status": "ExportFinished",
"start_time": "2024-06-28 15:41:16",
"finish_time": "2024-06-28 15:42:12",
"download_url": "https://bj.bcebos.com/sdc-default/_system_/dataset/ds-7a7cbwemm1m2f6fz/download/DatasetId_19297_export_1719560476.zip?authorization=bce-auth-v1%2F50c8bb753dcb4e1d8646bb1ffefd3503%2F2024-06-28T07%3A42%3A41Z%2F3600%2F%2Fbf302fbb453bc1ce28a7d46c7b1336c8db10f6d8375849dd725bdc0213ce1366",
"log_id": 2560913930
}
获取数据集列表API接口文档
接口功能描述
本接口用于获取符合特定查询条件的数据集列表。目前支持对表格预测、时序预测两种数据集进行操作。
请求说明
请求示例
HTTP 方法:POST
请求URL:https://aip.baidubce.com/rpc/2.0/easydl/pro/dataset/describeDatasets
URL参数:
参数 | 值 |
---|---|
access_token | 通过API Key和Secret Key获取的access_token,参考“Access Token获取” |
Header如下:
参数 | 值 |
---|---|
Content-Type | application/json |
Body中放置请求参数,参数详情如下:
请求参数
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
filter | map | 否 | 筛选条件,此处支持对于数据类型进行筛选,对应Key为type |
filter.type | List |
否 | 根据数据集数据类型进行筛选,所有可选值如下:图像分类:“IMAGE_CLASSIFICATION”物体检测:“OBJECT_DETECTION”短文本相似度:“TEXT_MATCHING”文本分类:“TEXT_CLASSIFICATION”表格预测:“DATA_TABLE_FORECASTING”时序预测:“ TIME_SERIES_FORECASTING” |
filter.template_type | List |
否 | 标注模板类型图像分类-单图单标签:“IMAGE_CLASSIFICATION_ONE_LABEL”图像分类-单图多标签:“IMAGE_CLASSIFICATION_MUL_LABEL”矩形框标注:“OBJECT_DETECTION_RECTANGLE”短文本单标签:“TEXT_CLASSIFICATION_ONE_LABEL”短文本相似度:“TEXT_SIMILARITY”表格预测:“DATA_TABLE_FORECASTING”时序预测:“ TIME_SERIES_FORECASTING” |
word | string | 否 | 搜索关键词 |
limit | int | 否 | 分页大小,默认10 |
offset | int | 否 | 分页偏移,默认0 |
请求
{
"limit": 20,
"offset": 0,
"filter":{"type":["IMAGE_CLASSIFICATION"]}
}
响应说明
响应参数
名称 | 类型 | 说明 |
---|---|---|
log_id | int | 操作记录ID |
error_code | int | 错误码,失败才有(见错误码表) |
error_msg | string | 错误消息,失败才有 |
result | object | 返回结果,成功才有 |
返回说明
返回参数
名称 | 类型 | 说明 |
---|---|---|
page_info | object | 分页信息 |
datasets | List |
数据集列表 |
返回
{
"page_info": {
"limit": 20,
"offset": 0,
"total": 1040
},
"datasets": [
{
"dataset_group_id": 13814,
"dataset_name": "pdf_quality_good"
},
{
"dataset_group_id": 13813,
"dataset_name": "pdf_quality_bad"
},
{
"dataset_group_id": 13800,
"dataset_name": "pdf_quality3"
},
{
"dataset_group_id": 13798,
"dataset_name": "pdf_quality2"
}
......
],
"log_id": 517361526
}
pageInfo说明
名称 | 类型 | 说明 |
---|---|---|
limit | int | 分页大小 |
offset | int | 数据偏移 |
total | int | 总数 |
dataset说明
名称 | 类型 | 说明 |
---|---|---|
dataset_group_id | int | 数据集ID |
dataset_name | string | 数据集名称 |
获取数据集版本列表API接口文档
接口功能描述
本接口用于查询某数据集的版本列表。目前支持对表格预测、时序预测两种数据集进行操作。
请求说明
请求示例
HTTP 方法:POST
请求URL:https://aip.baidubce.com/rpc/2.0/easydl/pro/dataset/describeDatasetVersions
URL参数:
参数 | 值 |
---|---|
access_token | 通过API Key和Secret Key获取的access_token,参考“Access Token获取” |
Header如下:
参数 | 值 |
---|---|
Content-Type | application/json |
Body中放置请求参数,参数详情如下:
请求参数
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
dataset_group_id | int | 是 | 数据集ID |
limit | int | 否 | 分页大小,默认10 |
offset | int | 否 | 分页便宜,默认0 |
示例
{
"dataset_group_id":13805,
"limit":10,
"offset":0
}
响应说明
响应参数
名称 | 类型 | 说明 |
---|---|---|
log_id | int | 操作记录ID |
error_code | int | 错误码,失败才有(见错误码表) |
error_msg | string | 错误消息,失败才有 |
result | object | 返回结果,成功才有 |
返回说明
返回参数
名称 | 类型 | 说明 |
---|---|---|
page_info | object | 分页信息 |
dataset_versions | list |
数据集版本列表 |
返回
{
"page_info": {
"limit": 10,
"offset": 0,
"total": 1
},
"dataset_versions": [
{
"dataset_id": 19297,
"dataset_name": "数据集测试",
"version_number": 1,
"import_status": 0,
"columns": 2,
"rows": 16,
"type": "DATA_TABLE_FORECASTING",
"template_type": "DATA_TABLE_FORECASTING",
"create_time": "2024-06-24 14:52:26",
"modify_time": "2024-06-24 15:54:29"
}
],
"log_id": 2268245848
}
pageInfo说明
名称 | 类型 | 说明 |
---|---|---|
limit | int | 分页大小 |
offset | int | 数据便宜 |
total | int | 总数 |
datasetVersion说明
名称 | 类型 | 说明 |
---|---|---|
dataset_id | int | 数据集版本ID |
dataset_name | string | 数据集名称 |
version_number | int | 数据集版本序号 |
import_status | string | 导入状态正在导入:Importing已完成:ImportFinished导入失败:ImportFailed |
columns | int | 数据集列数 |
rows | int | 数据集行数 |
type | string | 标注类型图像分类:“IMAGE_CLASSIFICATION”物体检测:“OBJECT_DETECTION”短文本相似度:“TEXT_MATCHING”文本分类:“TEXT_CLASSIFICATION”表格预测:“DATA_TABLE_FORECASTING”时序预测:“ TIME_SERIES_FORECASTING” |
template_type | string | 标注模版图像分类-单图单标签:“IMAGE_CLASSIFICATION_ONE_LABEL”图像分类-单图多标签:“IMAGE_CLASSIFICATION_MUL_LABEL”矩形框标注:“OBJECT_DETECTION_RECTANGLE”短文本单标签:“TEXT_CLASSIFICATION_ONE_LABEL”短文本相似度:“TEXT_SIMILARITY”表格预测:“DATA_TABLE_FORECASTING”时序预测:“ TIME_SERIES_FORECASTING” |
create_time | string | 创建时间 |
modify_time | string | 更新时间 |
获取数据表schema结构API接口文档
接口功能描述
本接口用于获取数据表的schema结构。目前支持对表格预测、时序预测两种数据集进行操作。
请求说明
请求示例
HTTP 方法:POST
请求URL:https://aip.baidubce.com/rpc/2.0/easydl/pro/dataset/guessSchema
URL参数:
参数 | 值 |
---|---|
access_token | 通过API Key和Secret Key获取的access_token,参考“Access Token获取” |
Header如下:
参数 | 值 |
---|---|
Content-Type | application/json |
Body中放置请求参数,参数详情如下:
请求参数
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
data_source_type | string | 是 | 固定值cloud_edap |
database_name | string | 是 | 数据库ID |
table_name | string | 是 | 数据表ID |
示例
{
"data_source_type":"cloud_edap",
"database_name":"dae_test",
"table_name":"dae_table"
}
响应说明
响应参数
名称 | 类型 | 说明 |
---|---|---|
log_id | int | 操作记录ID |
error_code | int | 错误码,失败才有(见错误码表) |
error_msg | string | 错误消息,失败才有 |
result | object | 返回结果,成功才有 |
返回说明
返回参数
名称 | 类型 | 说明 |
---|---|---|
schema | object | 数据表结构 |
schema.names | list |
数据表列名 |
schema.types | list |
数据表中字段的数据类型 |
schema.columns | list |
数据表中列的序号 |
values | list | 数据表中每个字段的真值,根据types中描述的数据类型决定 |
total_size | int | 总行数 |
has_preview | bool | 是否有预览数据 |
返回
{
"result": {
"schema": {
"names": [
"id",
"name",
"c_decimal",
"c_double",
"c_date",
"c_bool",
"part_id"
],
"types": [
"int",
"string",
"decimal(10,0)",
"double",
"date",
"string",
"smallint"
],
"columns": [
0,
1,
2,
3,
4,
5,
6
]
},
"values": [],
"total_size": 7,
"has_preview": false
},
"log_id": 1293726887
}
错误码
若请求错误,服务器将返回的JSON文本包含以下参数:
- error_code:错误码。
- error_msg:错误描述信息,帮助理解和解决发生的错误。
例如Access Token失效返回:
{
"error_code": 110,
"error_msg": "Access token invalid or no longer valid"
}
需要重新获取新的Access Token再次请求即可。
错误码 | 错误信息 | 描述 |
---|---|---|
1 | Unknown error | 服务器内部错误,请再次请求, 如果持续出现此类错误,请通过QQ群(679517246)或工单联系技术支持团队。 |
2 | Service temporarily unavailable | 服务暂不可用,请再次请求, 如果持续出现此类错误,请通过QQ群(679517246)或工单联系技术支持团队。 |
3 | Unsupported openapi method | 调用的API不存在,请检查后重新尝试 |
4 | Open api request limit reached | 集群超限额 |
6 | No permission to access data | 无权限访问该用户数据 |
13 | Get service token failed | 获取token失败 |
14 | IAM Certification failed | IAM鉴权失败 |
15 | app not exsits or create failed | 应用不存在或者创建失败 |
17 | Open api daily request limit reached | 每天请求量超限额,已上线计费的接口,请直接在控制台开通计费,调用量不受限制,按调用量阶梯计费;未上线计费的接口,请通过QQ群(679517246)联系群管手动提额 |
18 | Open api qps request limit reached | QPS超限额,已上线计费的接口,请直接在控制台开通计费,调用量不受限制,按调用量阶梯计费;未上线计费的接口,请通过QQ群(679517246)联系群管手动提额 |
19 | Open api total request limit reached | 请求总量超限额,已上线计费的接口,请直接在控制台开通计费,调用量不受限制,按调用量阶梯计费;未上线计费的接口,请通过QQ群(679517246)联系群管手动提额 |
100 | Invalid parameter | 无效的access_token参数,请检查后重新尝试 |
110 | Access token invalid or no longer valid | access_token无效 |
111 | Access token expired | access token过期 |
406000 | internal server error | 服务错误 |
406001 | param[xx] invalid | 参数xx不合法,请检查相关参数 |
406002 | dataset not exist | 数据集不存在 |
406003 | dataset already exists | 数据集已存在 |
406004 | dataset can not be modified temporarily | 数据集暂不可修改 |
406005 | label not exist | 标签/分类不存在 |
406006 | no permission to modify the dataset | 没有修改数据集的权限 |
406007 | dataset cannot be modified while smart annotation is running | 智能标注期间不可修改数据集 |
406008 | quota exceeded | 配额超限 |