查看模型评估任务列表
更新时间:2024-09-30
功能介绍
本接口用于查看模型评估任务列表。
SDK调用
使用说明
本文API支持通过Go SDK、Java SDK 和 Node.js SDK调用,调用流程请参考SDK安装及使用流程。
调用示例
import os
from qianfan import resources
# 通过环境变量初始化认证信息
# 使用安全认证AK/SK调用,替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk,如何获取请查看https://cloud.baidu.com/doc/Reference/s/9jwvz2egb
os.environ["QIANFAN_ACCESS_KEY"] = "your_access_key"
os.environ["QIANFAN_SECRET_KEY"] = "your_secret_key"
resp = resources.console.utils.call_action(
# 调用本文API,该参数值为固定值,无需修改;对应本文HTTP调用-请求说明-请求地址的后缀
"/v2/eval",
# 调用本文API,该参数值为固定值,无需修改;对应本文HTTP调用-请求说明-请求参数-Query参数的Action
"DescribeEvalTasks",
# 对应本文HTTP调用-请求说明-请求参数-Body参数,具体使用请查看Body参数说明,根据实际使用选择参数
{
"evalType": "auto",
"keyFilter": "ame-nfw1fxxxxx"
}
)
print(resp.body)
package main
import (
"context"
"fmt"
"os"
"github.com/baidubce/bce-qianfan-sdk/go/qianfan"
)
func main() {
// 使用安全认证AK/SK鉴权,通过环境变量初始化;替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
os.Setenv("QIANFAN_ACCESS_KEY", "your_iam_ak")
os.Setenv("QIANFAN_SECRET_KEY", "your_iam_sk")
ca := qianfan.NewConsoleAction()
res, err := ca.Call(context.TODO(),
// 调用本文API,该参数值为固定值,无需修改;对应本文HTTP调用-请求说明-请求地址的后缀
"/v2/eval",
// 调用本文API,该参数值为固定值,无需修改;对应本文HTTP调用-请求说明-请求参数-Query参数的Action
"DescribeEvalTasks",
// 对应本文HTTP调用-请求说明-请求参数-Body参数,具体使用请查看Body参数说明,根据实际使用选择参数
map[string]interface{}{
"evalType": "auto",
"keyFilter": "ame-nfw1fxxxxx",
})
if err != nil {
panic(err)
}
fmt.Println(string(res.Body))
}
import com.baidubce.qianfan.Qianfan;
import com.baidubce.qianfan.model.console.ConsoleResponse;
import com.baidubce.qianfan.util.CollUtils;
import com.baidubce.qianfan.util.Json;
import java.util.Map;
public class Dome {
public static void main(String args[]){
// 使用安全认证AK/SK鉴权,替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
Qianfan qianfan = new Qianfan("your_iam_ak", "your_iam_sk");
ConsoleResponse<Map<String, Object>> response = qianfan.console()
// 调用本文API,该参数值为固定值,无需修改;对应本文HTTP调用-请求说明-请求地址的后缀
.route("/v2/eval")
// 调用本文API,该参数值为固定值,无需修改;对应本文HTTP调用-请求说明-请求参数-Query参数的Action
.action("DescribeEvalTasks")
// 需要传入参数的场景,可以自行封装请求类,或者使用Map.of()来构建请求Body
// Java 8可以使用SDK提供的CollUtils.mapOf()来替代Map.of()
// 对应本文HTTP调用-请求说明-请求参数-Body参数,具体使用请查看Body参数说明,根据实际使用选择参数
.body(CollUtils.mapOf(
"evalType", "auto",
"keyFilter", "ame-nfw1fxxxxx"
))
.execute();
System.out.println(Json.serialize(response));
}
}
import {consoleAction, setEnvVariable} from "@baiducloud/qianfan";
// 使用安全认证AK/SK鉴权,通过环境变量初始化;替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
setEnvVariable('QIANFAN_ACCESS_KEY','your_iam_ak');
setEnvVariable('QIANFAN_SECRET_KEY','your_iam_sk');
async function main() {
//base_api_route:调用本文API,该参数值为固定值,无需修改;对应本文HTTP调用-请求说明-请求地址的后缀
//action:调用本文API,该参数值为固定值,无需修改;对应本文HTTP调用-请求说明-请求参数-Query参数的Action
//data:对应本文HTTP调用-请求说明-请求参数-Body参数,具体使用请查看Body参数说明,根据实际使用选择参数
const res = await consoleAction({base_api_route: '/v2/eval', action: 'DescribeEvalTasks', data: {
"evalType": "auto",
"keyFilter": "ame-nfw1fxxxxx"
});
console.log(res);
}
main();
返回示例
{
'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
}
}
}
{
"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
}
}
}
{
"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
}
}
}
{
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
}
}
}
请求参数
请参考本文HTTP调用-请求说明。
返回参数
请参考本文HTTP调用-响应说明。
HTTP调用
鉴权说明
调用本文API,使用“基于安全认证AK/SK”进行签名计算鉴权,即使用安全认证中的Access Key ID 和 Secret Access Key进行鉴权,具体鉴权认证机制参考HTTP调用鉴权说明。
请求说明
- 基本信息
请求地址: https://qianfan.baidubce.com/v2/eval
请求方式: POST
- Header参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
Content-Type | string | 是 | 固定值application/json |
x-bce-date | string | 是 | 当前时间,遵循ISO8601规范,格式如2016-04-06T08:23:49Z |
Authorization | string | 是 | 用于验证请求合法性的认证信息。更多参见鉴权认证,签名工具可参考IAM签名工具 |
- 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."
}
更多其他错误码,也可以查看错误码说明。