获取评测集 Schema - ListOpsDatasetSchemas
功能介绍
该接口用于专门检索指定评测集信息,获取所有字段的名称、数据类型及约束规则,为数据处理提供标准的Schema视图。
适用场景:
URI
GET /v1/ops/datasets/{dataset_id}/schemas
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
[数组元素] |
Array of OpsSchemaInfo objects |
参数解释: 评测集的Schema字段信息定义。 取值范围: 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释: 字段的唯一标识符。 取值范围: 符合通用唯一识别码(UUID)标准的字符串。 |
|
name |
String |
参数解释: 字段的键名(Key),用于在数据条目中作为属性名。 取值范围: 建议符合变量命名规范的字符串。 |
|
type |
String |
参数解释: 字段的数据类型,定义数据的存储和解析方式。 取值范围: 支持String, Integer, Float, Boolean, Object, Array系列以及Trajectory。 |
|
description |
String |
参数解释: 对该字段业务含义或用途的详细文字说明。 取值范围: 任意字符串。 |
|
is_required |
Boolean |
参数解释: 标识该字段在数据条目中是否为必须存在的必填项。 取值范围: |
请求示例
检索指定评测集的逻辑结构定义,获取所有字段的名称、类型及约束规则。
GET https://*.com/agentarts/v1/ops/datasets/ds_7590068991923321856/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" : "Object",
"is_required" : false,
"description" : "外部检索上下文或背景知识"
} ]
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
查询成功 |
错误码
请参见错误码。