获取评测集详情 -j9九游会登录
功能介绍
该接口用于根据评测集id获取其完整的元数据配置,包括字段结构定义、基本属性及关联的历史发布版本列表。
适用场景:
-
评测配置校验:在启动评估任务前,开发者通过此接口确认评测集的字段是否符合评估任务输入要求。
-
版本回溯与管理:获取评测集下属的所有版本信息,以便进行版本对比或指定特定版本进行操作。
调用方法
请参见如何调用api。
授权信息
账号根用户具备所有api的调用权限,如果使用账号下的iam用户调用当前api,该iam用户需具备如下身份策略权限,更多的权限说明请参见。
| 授权项 | 访问级别 | 资源类型(*为必须) | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
| agentarts:dataset:showopsdataset | read | dataset * | g:resourcetag/ | - | - |
uri
get /v1/ops/datasets/{dataset_id}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| dataset_id | 是 | string | 参数解释: 评测集的唯一标识符(id) 约束限制: 由英文、数字、“-”、“_”组成,长度为1到64个字符。 取值范围: 由英文、数字、连字符(-)、下划线(_)组成的1-64位字符串。 默认取值: 无。 |
请求参数
无
响应参数
状态码: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 | 参数解释: 字段的数据类型,定义数据的存储和解析方式。 取值范围:
|
| description | string | 参数解释: 对该字段业务含义或用途的详细文字说明。 取值范围: 描述字段的业务含义或用途的文本,最大长度10000字符。 |
| is_required | boolean | 参数解释: 标识该字段在数据条目中是否为必须存在的必填项。 取值范围:
|
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | string | 参数解释: 版本的唯一标识符。 取值范围: 符合通用唯一识别码(uuid)标准的字符串。 |
| version | string | 参数解释: 用户定义的版本号或标签名。 取值范围: 自定义字符串,如v1.0.0等。 |
| description | string | 参数解释: 对该版本变更内容或用途的简要描述。 取值范围: 任意字符串。 |
| item_count | integer | 参数解释: 该版本快照中包含的数据条目总数。 取值范围: 0到2147483647。 |
| created_at | string | 参数解释: 版本的发布创建时间。 取值范围: utc时间格式字符串。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| created_time | string | 参数解释: 资源的创建时间戳。 取值范围: 符合标准时间格式的字符串。 |
| updated_time | string | 参数解释: 资源的最后更新时间戳。 取值范围: 符合标准时间格式的字符串。 |
| created_by | opsevaluationuserinfo object | 参数解释: 用户的简要身份信息。 取值范围: 不涉及。 |
| updated_by | opsevaluationuserinfo object | 参数解释: 用户的简要身份信息。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| name | string | 参数解释: 用户在系统中的显示名称。 取值范围: 中英文、数字。 |
| user_id | string | 参数解释: 用户的系统内唯一标识符(id)。 取值范围: 符合系统用户规则的字符串。 |
请求示例
通过评测集id获取完整的元数据配置、schema 结构以及历史版本列表。
get https://api.example.com/v1/ops/datasets/097b0720-d6cc-48e0-ad15-5638bb6b1784 响应示例
状态码:200
查询成功
{
"id" : "097b0720-d6cc-48e0-ad15-5638bb6b1784",
"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" : "2026-02-27t03:09:53.799z",
"updated_time" : "2026-02-27t03:09:53.799z",
"created_by" : {
"name" : "versatile-test",
"user_id" : "a8f68bb358d84d3e95087b6c7d373efa"
},
"updated_by" : {
"name" : "versatile-test",
"user_id" : "a8f68bb358d84d3e95087b6c7d373efa"
}
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询成功 |
错误码
请参见错误码。
相关文档
意见反馈
文档内容是否对您有帮助?
如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨