获取评测集 schema -j9九游会登录
功能介绍
该接口用于专门检索指定评测集信息,获取所有字段的名称、数据类型及约束规则,为数据处理提供标准的schema视图。
适用场景:
-
数据导入校验:在用户上传或导入数据前,核对本地文件格式是否与评测集定义的字段规范一致。
调用方法
请参见如何调用api。
授权信息
账号根用户具备所有api的调用权限,如果使用账号下的iam用户调用当前api,该iam用户需具备如下身份策略权限,更多的权限说明请参见。
| 授权项 | 访问级别 | 资源类型(*为必须) | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
| agentarts:dataset:listopsdatasetschemas | list | dataset * | g:resourcetag/ | - | - |
uri
get /v1/ops/datasets/{dataset_id}/schemas
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| dataset_id | 是 | string | 参数解释: 评测集的唯一标识符(id) 约束限制: 由英文、数字、“-”、“_”组成,长度为1到64个字符。 取值范围: 由英文、数字、连字符(-)、下划线(_)组成的1-64位字符串。 默认取值: 无。 |
请求参数
无
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| [数组元素] | array of opsschemainfo objects | 参数解释: 评测集的schema字段信息定义。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | string | 参数解释: 字段的唯一标识符。 取值范围: 符合通用唯一识别码(uuid)标准的字符串。 |
| name | string | 参数解释: 字段的键名(key),用于在数据条目中作为属性名。 取值范围: 建议符合变量命名规范的字符串。 |
| type | string | 参数解释: 字段的数据类型,定义数据的存储和解析方式。 取值范围:
|
| description | string | 参数解释: 对该字段业务含义或用途的详细文字说明。 取值范围: 描述字段的业务含义或用途的文本,最大长度10000字符。 |
| is_required | boolean | 参数解释: 标识该字段在数据条目中是否为必须存在的必填项。 取值范围:
|
请求示例
检索指定评测集的逻辑结构定义,获取所有字段的名称、类型及约束规则。
get https://api.example.com/v1/ops/datasets/097b0720-d6cc-48e0-ad15-5638bb6b1784/schemas 响应示例
状态码:200
查询成功
[ {
"id" : "550e8400-e29b-41d4-a716-446655440011",
"name" : "question",
"type" : "string",
"is_required" : true,
"description" : "用户提问内容"
}, {
"id" : "550e8400-e29b-41d4-a716-446655440012",
"name" : "expected_answer",
"type" : "string",
"is_required" : false,
"description" : "预期的标准参考答案"
}, {
"id" : "550e8400-e29b-41d4-a716-446655440013",
"name" : "context",
"type" : "string",
"is_required" : false,
"description" : "外部检索上下文或背景知识"
} ] 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询成功 |
错误码
请参见错误码。
相关文档
意见反馈
文档内容是否对您有帮助?
如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨