1. 接口描述
接口请求域名: tione.tencentcloudapi.com 。
创建数据集
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateDataset。 |
Version | 是 | String | 公共参数,本接口取值:2021-11-11。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
DatasetName | 是 | String | 数据集名称,不超过60个字符,仅支持中英文、数字、下划线"_"、短横"-",只能以中英文、数字开头 示例值:Voc2017 |
DatasetType | 否 | String | 数据集类型: TYPE_DATASET_TEXT,文本 TYPE_DATASET_IMAGE,图片 TYPE_DATASET_TABLE,表格 TYPE_DATASET_OTHER,其他 示例值:TYPE_DATASET_TEXT |
StorageDataPath | 否 | CosPathInfo | 数据源cos路径 |
StorageLabelPath | 否 | CosPathInfo | 数据集标签cos存储路径 |
DatasetTags.N | 否 | Array of Tag | 数据集标签 |
AnnotationStatus | 否 | String | 数据集标注状态: STATUS_NON_ANNOTATED,未标注 STATUS_ANNOTATED,已标注 示例值:STATUS_ANNOTATED |
AnnotationType | 否 | String | 标注类型: ANNOTATION_TYPE_CLASSIFICATION,图片分类 ANNOTATION_TYPE_DETECTION,目标检测 ANNOTATION_TYPE_SEGMENTATION,图片分割 ANNOTATION_TYPE_TRACKING,目标跟踪 ANNOTATION_TYPE_OCR,OCR ANNOTATION_TYPE_TEXT_CLASSIFICATION,文本分类 示例值:ANNOTATION_TYPE_DETECTION |
AnnotationFormat | 否 | String | 标注格式: ANNOTATION_FORMAT_TI,TI平台格式 ANNOTATION_FORMAT_PASCAL,Pascal Voc ANNOTATION_FORMAT_COCO,COCO ANNOTATION_FORMAT_FILE,文件目录结构 ANNOTATION_FORMAT_TEXT_TI,文本类型TI平台格式 ANNOTATION_FORMAT_TXT,文本类型TXT格式 ANNOTATION_FORMAT_CSV,文本类型CSV格式 ANNOTATION_FORMAT_JSON,文本类型JSON格式 示例值:VOC |
SchemaInfos.N | 否 | Array of SchemaInfo | 表头信息 |
IsSchemaExisted | 否 | Boolean | 数据是否存在表头 示例值:true |
ContentType | 否 | String | 导入文件粒度 TYPE_TEXT_LINE,按行 TYPE_TEXT_FILE,按文件 示例值:TYPE_TEXT_LINE |
DatasetScene | 否 | String | 数据集建模一级类别。LLM,CV,STRUCTURE,OTHER 示例值:LLM |
SceneTags.N | 否 | Array of String | 数据集标签。 |
CFSConfig | 否 | CFSConfig | 数据集CFS配置。仅支持LLM场景 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
DatasetId | String | 数据集ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:rodftu04veo |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建数据集
CreateDataset
输入示例
POST / HTTP/1.1
Host: tione.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDataset
<公共请求参数>
{
"DatasetName": "test",
"AnnotationStatus": "STATUS_NON_ANNOTATED",
"SchemaInfos": [
{
"Type": "",
"Name": ""
}
],
"StorageDataPath": {
"Paths": [
"input/"
],
"Region": "ap-guangzhou",
"Bucket": "test-1256580188"
},
"StorageLabelPath": {
"Paths": [
"output/"
],
"Region": "ap-guangzhou",
"Bucket": "test-1256580188"
},
"DatasetType": "TYPE_DATASET_TEXT",
"IsSchemaExisted": false,
"ContentType": "TYPE_TEXT_LINE"
}
输出示例
{
"Response": {
"DatasetId": "ds-4575dwt7",
"RequestId": "3d033484-30f4-42e7-837e-825f33fdd23b"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure.CamException | CAM系统异常。 |
AuthFailure.UnauthorizedOperation | 未授权操作。 |
FailedOperation.DCCosClientErr | cos client 内部错误。 |
FailedOperation.DCCreateAsyncTaskError | 创建内部异步任务失败。 |
FailedOperation.DCCreateUserCosClientErr | 创建cos client 失败。 |
FailedOperation.DCDataAnnotationRpcErr | 数据标注 rpc 内部错误。 |
FailedOperation.DCDatarepoRpcErr | 数据仓库 rpc 内部错误。 |
FailedOperation.DCDatasetExceedLimit | 数据集操作超过上限。 |
FailedOperation.DCDatasetStatusNotReady | 数据集状态未恢复。 |
FailedOperation.DCGetUserTemporarySecretErr | 获取用户临时秘钥失败。 |
FailedOperation.DCMarshalDataErr | 数据序列化错误。 |
FailedOperation.DCQueryDatasetContentErr | 数据集获取文件内容异常。 |
FailedOperation.DCUnmarshalDataErr | 数据反序列化错误。 |
FailedOperation.DCUnsupportedOperation | 数据集操作不支持。 |
FailedOperation.ExecDatabaseFail | 数据库执行错误。 |
FailedOperation.ExecTagFail | 标签操作失败。 |
FailedOperation.QueryDatabaseFail | 数据库查询错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.ValidateError | 请求参数校验失败。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.DCAnnotationType | 不支持的标注类型。 |
InvalidParameterValue.DCCosPathInfo | 存储桶参数错误。 |
InvalidParameterValue.DCDatasetAnnotationNotMatch | 数据集标注状态不匹配。 |
InvalidParameterValue.DCDatasetIdNotExist | 数据集Id不存在。 |
InvalidParameterValue.DCDatasetNameExist | 数据集重名已存在。 |
InvalidParameterValue.DCDatasetType | 不支持的数据集类型。 |
InvalidParameterValue.DCFilterValues | 不支持的过滤参数。 |
MissingParameter | 缺少参数错误。 |