发布评测集版本 - PublishOpsDatasetVersion
功能介绍
该接口用于将当前处于草稿状态的数据内容固化,生成一个不可变的历史快照版本,并分配唯一版本ID以确保数据在后续调用中的可追溯性。
适用场景:
URI
POST /v1/ops/datasets/{dataset_id}/versions
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
dataset_id |
是 |
String |
参数解释: 评测集的ID。 约束限制: 由英文、数字、“-”、“_”组成,长度为1到64个字符。 取值范围: 1-64位字符。 默认取值: 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
Content-Type |
是 |
String |
参数解释: 消息体编码格式。用于告知服务端请求体(Body)所采用的主体数据类型,以便服务端正确解析。 约束限制: 不涉及 取值范围: 不涉及 默认取值: application/json |
|
Authorization |
是 |
String |
参数解释: 签名认证信息,当使用AK/SK方式认证时,使用SDK对请求进行签名的过程中会自动填充该字段。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
X-Sdk-Date |
是 |
String |
参数解释: 请求发送的时间,当使用AK/SK方式认证时,使用SDK对请求进行签名的过程中会自动填充该字段。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
version_name |
否 |
String |
参数解释: 用户定义的版本标签或编号。 约束限制: 建议长度不超过 100 字符。 取值范围: 字符串,如 "v1.0"、"20240413_test"。 默认取值: 不涉及。 |
|
description |
否 |
String |
参数解释: 该版本的变更摘要或备注信息。 约束限制: 可选参数;长度0到200字符。 取值范围: 中英文及常见符号。 默认取值: 不涉及。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释: 版本的内部唯一标识符。 取值范围: 符合通用唯一识别码(UUID)标准的字符串。 |
|
version |
String |
参数解释: 发布的版本显示名称。 取值范围: 自定义字符串。 |
|
version_num |
Integer |
参数解释: 系统生成的递增版本序号。 取值范围: 0到2147483647。 |
|
description |
String |
参数解释: 该版本的详细备注说明。 取值范围: 任意字符串。 |
|
item_count |
Integer |
参数解释: 该版本快照中包含的数据条目总数。 取值范围: 0到2147483647。 |
|
schema_snapshot |
Array of OpsSchemaInfo objects |
参数解释: 发布该版本时的数据结构定义快照。 取值范围: OpsSchemaInfo 对象列表。 |
|
created_at |
String |
参数解释: 版本的正式发布时间。 取值范围: UTC 时间字符串。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释: 字段的唯一标识符。 取值范围: 符合通用唯一识别码(UUID)标准的字符串。 |
|
name |
String |
参数解释: 字段的键名(Key),用于在数据条目中作为属性名。 取值范围: 建议符合变量命名规范的字符串。 |
|
type |
String |
参数解释: 字段的数据类型,定义数据的存储和解析方式。 取值范围: 支持String, Integer, Float, Boolean, Object, Array系列以及Trajectory。 |
|
description |
String |
参数解释: 对该字段业务含义或用途的详细文字说明。 取值范围: 任意字符串。 |
|
is_required |
Boolean |
参数解释: 标识该字段在数据条目中是否为必须存在的必填项。 取值范围: |
请求示例
发布评测集
POST https://*.com/agentarts/v1/ops/datasets/dcacda233/versions
{
"description" : "修复了数据质量问题,新增100条测试用例",
"version_name" : "string"
}
响应示例
状态码: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 |
发布成功 |
错误码
请参见错误码。