获取评测集列表 -j9九游会登录
功能介绍
该接口用于分页查询当前项目下的评测集列表,支持按名称模糊检索和更新人筛选,帮助用户实现对评测集资产的全局视图管理。
调用方法
请参见如何调用api。
授权信息
账号根用户具备所有api的调用权限,如果使用账号下的iam用户调用当前api,该iam用户需具备如下身份策略权限,更多的权限说明请参见。
| 授权项 | 访问级别 | 资源类型(*为必须) | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
| agentarts:dataset:listopsdatasets | list | dataset * | g:resourcetag/ | - | - |
uri
get /v1/ops/datasets
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| name | 否 | string | 参数解释: 评测集名称检索字段。用于根据评测集的显示名称进行过滤。 约束限制: 支持模糊匹配,字符串长度限制为0到100个字符。 取值范围: 中英文、数字及特殊字符组成的字符串。 默认取值: 无,不传则不进行名称筛选。 |
| updated_by | 否 | string | 参数解释: 最后更新人标识。支持通过执行最后一次修改操作的用户id或用户名进行筛选,以便追踪特定人员管理的数据资产。 约束限制: 字符串长度限制为0到1200个字符。 取值范围: 系统中存在的有效用户id或用户名。 默认取值: 无,不传则不进行更新人筛选。 |
| offset | 否 | integer | 参数解释: 分页查询的起始偏移量。用于指定从满足条件的第几条记录开始返回,常与 limit参数配合实现分页功能。 约束限制: 必须为整数,且大小在0到10,000之间。 取值范围: 0-10000。 默认取值: 0。 |
| limit | 否 | integer | 参数解释: 单次查询返回的最大记录数量。用于控制分页查询时每页显示的数据条数。 约束限制: 必须为整数,且大小在1到100之间。 取值范围: 1-100。 默认取值: 10。 |
请求参数
无
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| datasets | array of opsdatasetsummary objects | 参数解释: 评测集列表,包含当前分页返回的评测集摘要信息。 取值范围: 符合opsdatasetsummary结构定义的对象数组。 |
| total | long | 参数解释: 满足查询条件的评测集总数量。 取值范围: 0到1000000。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | string | 参数解释: 评测集的全局唯一标识符。 取值范围: 符合通用唯一识别码(uuid)标准的字符串。 |
| name | string | 参数解释: 评测集的显示名称。 取值范围: 中英文、数字及常见特殊字符。 |
| description | string | 参数解释: 对该评测集用途或内容的详细文字说明。 取值范围: 任意字符串。 |
| latest_version | string | 参数解释: 该评测集当前已发布的最新版本号。 取值范围: 版本号格式字符串(如v1.0.0)。 |
| item_count | integer | 参数解释: 评测集中包含的总记录条数。 取值范围: 0到2147483647。 |
| change_uncommitted | boolean | 参数解释: 标识当前草稿态相对于最新发布版本是否有尚未提交的变更。 取值范围:
|
| schemas | array of opsschemainfo objects | 参数解释: 定义评测集内部数据结构的schema字段定义列表。 取值范围: 符合opsschemainfo定义的对象列表。 |
| base_info | opsbaseinfo object | 参数解释: 资源的基础元数据信息,记录创建与更新的时点及责任人。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | string | 参数解释: 字段的唯一标识符。 取值范围: 符合通用唯一识别码(uuid)标准的字符串。 |
| name | string | 参数解释: 字段的键名(key),用于在数据条目中作为属性名。 取值范围: 建议符合变量命名规范的字符串。 |
| type | string | 参数解释: 字段的数据类型,定义数据的存储和解析方式。 取值范围:
|
| description | string | 参数解释: 对该字段业务含义或用途的详细文字说明。 取值范围: 描述字段的业务含义或用途的文本,最大长度10000字符。 |
| is_required | boolean | 参数解释: 标识该字段在数据条目中是否为必须存在的必填项。 取值范围:
|
| 参数 | 参数类型 | 描述 |
|---|---|---|
| created_time | string | 参数解释: 资源的创建时间戳。 取值范围: 符合标准时间格式的字符串。 |
| updated_time | string | 参数解释: 资源的最后更新时间戳。 取值范围: 符合标准时间格式的字符串。 |
| created_by | opsevaluationuserinfo object | 参数解释: 用户的简要身份信息。 取值范围: 不涉及。 |
| updated_by | opsevaluationuserinfo object | 参数解释: 用户的简要身份信息。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| name | string | 参数解释: 用户在系统中的显示名称。 取值范围: 中英文、数字。 |
| user_id | string | 参数解释: 用户的系统内唯一标识符(id)。 取值范围: 符合系统用户规则的字符串。 |
请求示例
分页查询评测集列表,支持按名称模糊匹配和按更新人进行筛选。
get https://api.example.com/v1/ops/datasets?name=用户问答&updated_by=admin&limit=10&offset=0 响应示例
状态码:200
查询成功
{
"total" : 1,
"datasets" : [ {
"id" : "550e8400-e29b-41d4-a716-446655440002",
"name" : "用户问答评测集",
"description" : "用于评测问答系统的评测集",
"latest_version" : "v1.0.0",
"item_count" : 500,
"change_uncommitted" : false,
"schemas" : [ {
"id" : "550e8400-e29b-41d4-a716-446655440000",
"name" : "input",
"type" : "string",
"description" : "用户输入内容",
"is_required" : true
} ],
"base_info" : {
"created_time" : "2024-03-20t10:00:00z",
"updated_time" : "2024-03-21t15:30:00z",
"created_by" : {
"name" : "admin"
},
"updated_by" : {
"name" : "admin"
}
}
} ]
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询成功 |
错误码
请参见错误码。
相关文档
意见反馈
文档内容是否对您有帮助?
如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨