获取评测集详情 - ShowOpsDataset
功能介绍
该接口用于根据评测集ID获取其完整的元数据配置,包括字段结构定义、基本属性及关联的历史发布版本列表。
适用场景:
URI
GET /v1/ops/datasets/{dataset_id}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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对请求进行签名的过程中会自动填充该字段。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释: 评测集的全局唯一标识符。 取值范围: 符合通用唯一识别码(UUID)标准的字符串。 |
|
name |
String |
参数解释: 评测集的显示名称。 取值范围: 中英文、数字及常见特殊字符。 |
|
description |
String |
参数解释: 对该评测集用途或内容的详细文字说明。 取值范围: 任意字符串。 |
|
latest_version |
String |
参数解释: 该评测集当前已发布的最新版本号。 取值范围: 自定义的版本名称字符串。 |
|
latest_version_id |
String |
参数解释: 最新发布版本对应的唯一标识符ID。 取值范围: 符合通用唯一识别码(UUID)标准的字符串。 |
|
item_count |
Integer |
参数解释: 评测集中包含的总记录条数(含未提交的草稿数据)。 取值范围: 0到2147483647。 |
|
change_uncommitted |
Boolean |
参数解释: 标识当前草稿态相对于最新发布版本是否有尚未提交的变更。 取值范围: |
|
schemas |
Array of OpsSchemaInfo objects |
参数解释: 定义评测集内部数据结构的字段定义列表。 取值范围: 符合OpsSchemaInfo定义的对象列表。 |
|
versions |
Array of OpsVersionInfo objects |
参数解释: 评测集的历史发布版本详情列表。 取值范围: 符合OpsVersionInfo定义的对象列表。 |
|
base_info |
OpsBaseInfo object |
参数解释: 包含创建人、更新人及相关时间戳的基础元数据。 取值范围: 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释: 字段的唯一标识符。 取值范围: 符合通用唯一识别码(UUID)标准的字符串。 |
|
name |
String |
参数解释: 字段的键名(Key),用于在数据条目中作为属性名。 取值范围: 建议符合变量命名规范的字符串。 |
|
type |
String |
参数解释: 字段的数据类型,定义数据的存储和解析方式。 取值范围: 支持String, Integer, Float, Boolean, Object, Array系列以及Trajectory。 |
|
description |
String |
参数解释: 对该字段业务含义或用途的详细文字说明。 取值范围: 任意字符串。 |
|
is_required |
Boolean |
参数解释: 标识该字段在数据条目中是否为必须存在的必填项。 取值范围: |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释: 版本的唯一标识符。 取值范围: 符合通用唯一识别码(UUID)标准的字符串。 |
|
version |
String |
参数解释: 用户定义的版本号或标签名。 取值范围: 自定义字符串,如v1.0、stable 等。 |
|
description |
String |
参数解释: 对该版本变更内容或用途的简要描述。 取值范围: 任意字符串。 |
|
item_count |
Integer |
参数解释: 该版本快照中包含的数据条目总数。 取值范围: 0到2147483647。 |
|
created_at |
String |
参数解释: 版本的发布创建时间。 取值范围: UTC时间格式字符串。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
created_time |
String |
参数解释: 资源的创建时间戳。 取值范围: 符合标准时间格式的字符串。 |
|
updated_time |
String |
参数解释: 资源的最后更新时间戳。 取值范围: 符合标准时间格式的字符串。 |
|
created_by |
EvaluationOpsUserInfo object |
参数解释: 资源创建者的简要用户信息。 取值范围: 不涉及。 |
|
updated_by |
EvaluationOpsUserInfo object |
参数解释: 最后一次更新该资源的用户简要信息。 取值范围: 不涉及。 |
请求示例
通过评测集ID获取完整的元数据配置、Schema 结构以及历史版本列表。
GET https://*.com/agentarts/v1/ops/datasets/ds_7590068991923321856
响应示例
状态码:200
查询成功
{
"id" : "ds_7590068991923321856",
"name" : "用户问答评测集",
"description" : "用于评测问答系统的基准评测评测集",
"latest_version" : "v1.1.0",
"latest_version_id" : "550e8400-e29b-41d4-a716-446655440001",
"item_count" : 150,
"change_uncommitted" : true,
"schemas" : [ {
"id" : "550e8400-e29b-41d4-a716-446655440000",
"name" : "user_input",
"type" : "String",
"is_required" : true,
"description" : "用户原始输入"
}, {
"id" : "550e8400-e29b-41d4-a716-446655440005",
"name" : "reference_output",
"type" : "String",
"is_required" : false,
"description" : "标准参考答案"
} ],
"versions" : [ {
"id" : "550e8400-e29b-41d4-a716-446655440001",
"version" : "v1.0.0",
"description" : "初始基准版",
"item_count" : 100,
"created_at" : "2024-01-10T12:00:00Z"
}, {
"id" : "550e8400-e29b-41d4-a716-446655440002",
"version" : "v1.1.0",
"description" : "2024春季增补版",
"item_count" : 150,
"created_at" : "2024-03-15T09:30:00Z"
} ],
"base_info" : {
"created_time" : "2024-01-10T12:00:00Z",
"updated_time" : "2024-03-20T10:00:00Z",
"created_by" : {
"name" : "admin"
},
"updated_by" : {
"name" : "admin"
}
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
查询成功 |
错误码
请参见错误码。