查看模型评估结果导出任务详情
更新时间:2025-01-14
功能介绍
用于获取模型评估导出任务详情,包括导出任务ID、评估任务ID和导出类型等。
使用说明
本文API支持通过Python SDK、Go SDK、Java SDK 和 Node.js SDK调用,调用流程请参考SDK安装及使用流程。
权限说明
调用本文API,需符合以下权限要求,权限介绍及分配,请查看角色与权限控制列表、账号创建与权限分配。需具有以下任一权限:
- 完全控制千帆大模型平台的权限:QianfanFullControlAccessPolicy
- 只读访问千帆大模型平台的权限:QianfanReadAccessPolicy
- 完全控制千帆大模型平台模型调优的权限:QianfanModelTuningFullControlAccessPolicy
- 只读访问千帆大模型平台模型调优的权限:QianfanModelTuningReadAccessPolicy
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_iam_ak"
os.environ["QIANFAN_SECRET_KEY"] = "your_iam_sk"
resp = resources.console.utils.call_action(
# 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求结构-请求地址的后缀
"/v2/eval",
# 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求参数-Query参数的Action
"DescribeEvalResultExportTask",
# 请查看本文请求参数说明,根据实际使用选择参数;对应API调用文档-请求参数-Body参数
{
"taskId":"amemt-gmqxxxxxcm"
}
)
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,该参数值为固定值,无需修改;对应API调用文档-请求结构-请求地址的后缀
"/v2/eval",
// 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求参数-Query参数的Action
"DescribeEvalResultExportTask",
// 请查看本文请求参数说明,根据实际使用选择参数;对应API调用文档-请求参数-Body参数
map[string]interface{}{
"taskId":"amemt-gmqxxxxxcm",
})
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,该参数值为固定值,无需修改;对应API调用文档-请求结构-请求地址的后缀
.route("/v2/eval")
// 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求参数-Query参数的Action
.action("DescribeEvalResultExportTask")
// 需要传入参数的场景,可以自行封装请求类,或者使用Map.of()来构建请求Body
// Java 8可以使用SDK提供的CollUtils.mapOf()来替代Map.of()
// 请查看本文请求参数说明,根据实际使用选择参数;对应API调用文档-请求参数-Body参数
.body(CollUtils.mapOf(
"taskId","amemt-gmqxxxxxcm"
))
.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,该参数值为固定值,无需修改;对应API调用文档-请求结构-请求地址的后缀
//action:调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求参数-Query参数的Action
//data:请查看本文请求参数说明,根据实际使用选择参数;对应API调用文档-请求参数-Body参数
const res = await consoleAction({base_api_route: '/v2/eval', action: 'DescribeEvalResultExportTask', data: {
"taskId":"amemt-gmqxxxxxcm"
});
console.log(res);
}
main();
返回示例
{
"requestId": "a65523c0-c329-4694-9809-922007558dce",
"result": {
"taskId": "amemt-qsrx****mt47",
"evalId": "ame-xvbi****r1dr",
"state": "Succeeded",
"exportContent": "prompt,prediction,completion,metrics",
"storageType": "sysStorage",
"downloadUrl": "https://aipe-dragonboat.bj.bcebos.com/****"
}
}
{
"requestId": "a65523c0-c329-4694-9809-922007558dce",
"result": {
"taskId": "amemt-qsrx****mt47",
"evalId": "ame-xvbi****r1dr",
"state": "Succeeded",
"exportContent": "prompt,prediction,completion,metrics",
"storageType": "sysStorage",
"downloadUrl": "https://aipe-dragonboat.bj.bcebos.com/****"
}
}
{
"requestId": "a65523c0-c329-4694-9809-922007558dce",
"result": {
"taskId": "amemt-qsrx****mt47",
"evalId": "ame-xvbi****r1dr",
"state": "Succeeded",
"exportContent": "prompt,prediction,completion,metrics",
"storageType": "sysStorage",
"downloadUrl": "https://aipe-dragonboat.bj.bcebos.com/****"
}
}
{
requestId: 'a65523c0-c329-4694-9809-922007558dce',
result: {
taskId: 'amemt-qsrx****mt47',
evalId: 'ame-xvbi****r1dr',
state: 'Succeeded',
exportContent: 'prompt,prediction,completion,metrics',
storageType: 'sysStorage',
downloadUrl: 'https://aipe-dragonboat.bj.bcebos.com/****'
}
}
请求参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
taskId | string | 否 | 导出任务ID,通过调用发起模型评估结果导出任务接口,返回的字段taskId获取 |
返回参数
名称 | 类型 | 描述 |
---|---|---|
requestId | string | 请求ID,用于定位问题 |
code | string | 错误码,接口报错时返回,HTTP状态码≥400 |
message | string | 错误信息,接口报错时返回,HTTP状态码≥400 |
result | object | 请求结果,接口请求成功时返回,HTTP状态码=200 |
result说明
名称 | 类型 | 描述 |
---|---|---|
taskId | string | 导出任务字符串id |
evalId | string | 评估任务ID |
exportContent | string[] | 导出内容,可选值如下: · prompt:prompt · prediction:预测结果 · completion:预期回答 · metrics:评估指标 · system:人设字段 |
state | string | 导出任务状态,用户只需检查任务是否Fail/Done: · Queued:任务待执行 · Running:进行中 · Failed:导出失败 · Succeeded:导出成功 |
storageType | string | 导出类型,说明: (1)仅针对模型评估,用于存储评估过程中产生的推理结果集 (2)可选值如下: · BOS:对象存储BOS · sysStorage:平台共享存储 |
storagePath | string | 当导出类型为对象存储BOS,即storageType=BOS时,对应路径为完整存储路径 |
downloadUrl | string | 下载链接,导出到系统bos时返回 |