查看模型评估任务列表
更新时间:2024-12-23
接口描述
本接口用于查看模型评估任务列表。
权限说明
调用本文API,需符合以下权限要求,权限介绍及分配,请查看角色与权限控制列表、账号创建与权限分配。需具有以下任一权限:
- 完全控制千帆大模型平台的权限:QianfanFullControlAccessPolicy
- 只读访问千帆大模型平台的权限:QianfanReadAccessPolicy
- 完全控制千帆大模型平台模型调优的权限:QianfanModelTuningFullControlAccessPolicy
- 只读访问千帆大模型平台模型调优的权限:QianfanModelTuningReadAccessPolicy
鉴权说明
调用本文API,使用“基于安全认证AK/SK”进行签名计算鉴权,即使用安全认证中的Access Key ID 和 Secret Access Key进行鉴权,具体鉴权认证机制参考HTTP调用鉴权说明。
请求结构
POST /v2/eval?Action=DescribeEvalTasks HTTP/1.1
Host: qianfan.baidubce.com
Authorization: authorization string
Content-Type: application/json
{
"evalType": "auto",
"keyFilter": "ame-nfw1fxxxxx"
}
请求头域
除公共头域外,无其它特殊头域。
请求参数
- Query参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
Action | string | 是 | 方法名称,固定值DescribeEvalTasks |
- Body参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
evalType | string | 是 | 评估类型,可选值如下: · manual:人工评估 · auto:自动评估 |
keyFilter | string | 否 | 模糊搜索,支持评估任务名称与评估任务字符串ID模糊查询、模型版本ID精确查询 |
marker | string | 否 | 本次查询的起始位置,默认从第一条数据开始 |
maxKeys | int | 否 | 返回的列表长度最大为100,默认值是10,如果指定的值大于100,按100操作 |
pageReverse | bool | 否 | 是否倒序,默认为false |
响应头域
除公共头域外,无其它特殊头域。
响应参数
名称 | 类型 | 描述 |
---|---|---|
requestId | string | 请求ID |
code | string | 错误码,错误时返回 |
message | string | 错误信息,请求失败时返回 |
result | object | 请求结果,请求成功时返回 |
result说明
名称 | 类型 | 描述 |
---|---|---|
evalTaskList | List<object> | 评估任务列表 |
pageInfo | object | 分页信息 |
pageInfo说明
名称 | 类型 | 描述 |
---|---|---|
marker | string | 本次查询的起始位置 |
maxKeys | int | 请求返回的最大数目 |
isTruncated | bool | 指明是否只返回了部分数据,说明: · false:表示本次已经返回所有结果 · true:表示本次返回部分结果 |
nextMarker | string | 当isTruncated为true时,返回此字段,作为下次查询marker的值 |
evalTaskList说明
名称 | 类型 | 描述 |
---|---|---|
taskId | string | 评估任务ID |
taskName | string | 评估任务名称 |
evalType | string | 评估类型,说明: · manual:人工评估 · auto:自动评估 |
evalMode | string | 评估模式,说明: 具体值如下 : · rule:基于规则 · model:裁判员模型 · manual:人工评估 · rule,model:同时支持自动规则和自动裁判员评估 |
description | string | 评估任务描述 |
createTime | string | 创建时间 |
请求示例
curl -i --location 'https://qianfan.baidubce.com/v2/eval?Action=DescribeEvalTasks'\
--header 'Authorization: bce-auth-v1/047ab241baxxxxe28b1ac/2024-09-20T02:31:36Z/1800/host;x-bce-date/badcdfc045033df7df7907xxxxcecfbd7d11ef'\
--header 'Content-Type: application/json'\
--data '{
"evalType": "auto",
"keyFilter": "ame-nfw1fxxxxx"
}'
响应示例
{
"requestId": "55244c61-3b25-40be-af34-ee6c4675e965",
"result": {
"evalTaskList": [
{
"taskId": "ame-nfw1fxxxxx",
"taskName": "sandboxdd",
"evalType": "auto",
"evalMode": "rule",
"description": "sfasf",
"createTime": "2023-05-31 23:34:38"
}
],
"pageInfo": {
"marker": "",
"maxKeys": 100,
"isTruncated": false
}
}
}
错误码
若请求错误,服务器将返回的JSON文本包含以下参数:
名称 | 描述 |
---|---|
requestId | 请求ID |
code | 错误码 |
message | 错误描述信息,帮助理解和解决发生的错误 |
例如错误返回:
{
"requestId": "a2aa5da1-xxxxxc678f",
"code": "InternalError",
"message": "We encountered an internal error. Please try again."
}
更多其他错误码,也可以查看错误码说明。