发布评测集版本 - PublishOpsDatasetVersion
功能介绍
该接口用于将当前处于草稿状态的数据内容固化,生成一个不可变的历史快照版本,并分配唯一版本ID以确保数据在后续调用中的可追溯性。
适用场景:
调用方法
请参见如何调用API。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
| 授权项 | 访问级别 | 资源类型(*为必须) | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
| agentarts:dataset:publishOpsDatasetVersion | Write | dataset * | g:ResourceTag/<tag-key> | - | - |
URI
POST /v1/ops/datasets/{dataset_id}/versions
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| dataset_id | 是 | String | 参数解释: 评测集的唯一标识符(ID)。可通过调用创建评测集接口获取,或通过查询评测集列表接口获取。 约束限制: 不涉及。 取值范围: 由英文、数字、连字符(-)、下划线(_)组成的1~64个字符串。 默认取值: 无。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| version_name | 是 | String | 参数解释: 用户定义的版本标签或编号。 约束限制: 不涉及。 取值范围: 由英文、数字、下划线(_)、点(.)、连字符(-)组成的0~100个字符的字符串。 默认取值: 不涉及。 |
| description | 否 | String | 参数解释: 该版本的变更摘要或备注信息。 约束限制: 不涉及。 取值范围: 由中英文、数字及常见符号组成的0~200个字符的字符串。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 版本的内部唯一标识符。 取值范围: 固定长度36。 |
| version | String | 参数解释: 发布的版本显示名称。 取值范围: 不涉及。 |
| version_num | Integer | 参数解释: 系统生成的递增版本序号。 取值范围: 0到2147483647。 |
| description | String | 参数解释: 该版本的详细备注说明。 取值范围: 不涉及。 |
| item_count | Integer | 参数解释: 该版本快照中包含的数据条目总数。 取值范围: 0到2147483647。 |
| schema_snapshot | Array of OpsSchemaInfo objects | 参数解释: 发布该版本时的数据结构定义快照。列表元素为OpsSchemaInfo对象,参考OpsSchemaInfo结构定义。 |
| created_at | String | 参数解释: 版本的正式发布时间。时间格式为yyyy-MM-ddTHH:mm:ssZ,示例:2024-01-01T12:00:00Z。 取值范围: 不涉及。 |
请求示例
发布评测集
POST https://api.example.com/v1/ops/datasets/dcacda233/versions
{
"description" : "修复了数据质量问题,新增100条测试用例",
"version_name" : "v1.0.0"
} 响应示例
状态码:200
发布成功
{
"id" : "550e8400-e29b-41d4-a716-446655440001",
"version" : "v1",
"version_num" : 1,
"description" : "初始版本",
"item_count" : 100,
"schema_snapshot" : [ {
"id" : "550e8400-e29b-41d4-a716-446655440000",
"name" : "input",
"type" : "String",
"description" : "用户输入内容",
"is_required" : true
} ],
"created_at" : "2024-01-15T10:30:00Z"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 发布成功 |
错误码
请参见错误码。