查看模型评估结果导出任务状态
更新时间:2024-09-30
功能介绍
本接口用于查看模型评估结果导出任务状态,如导出任务状态、导出类型、导出路径等。
SDK调用
使用说明
本文API支持通过Python SDK、Go SDK、Java SDK 和 Node.js SDK调用,调用流程请参考SDK安装及使用流程。
调用示例
import os
from qianfan.resources import Model
# 使用安全认证AK/SK鉴权,通过环境变量方式初始化;替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
os.environ["QIANFAN_ACCESS_KEY"] = "your_iam_ak"
os.environ["QIANFAN_SECRET_KEY"] = "your_iam_sk"
# 获取导出任务状态
resp = Model.get_evaluation_result_export_task_status(export_task_id="amemt-xxx")
print(resp)
# 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调用-请求说明-请求地址的后缀
"/wenxinworkshop/modelrepo/eval/result/export/info", "",
// 对应本文HTTP调用-请求说明-请求参数-Body参数,具体使用请查看Body参数说明,根据实际使用选择参数
map[string]interface{}{
"exportID":96,
})
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("/wenxinworkshop/modelrepo/eval/result/export/info")
// 需要传入参数的场景,可以自行封装请求类,或者使用Map.of()来构建请求Body
// Java 8可以使用SDK提供的CollUtils.mapOf()来替代Map.of()
// 对应本文HTTP调用-请求说明-请求参数-Body参数,具体使用请查看Body参数说明,根据实际使用选择参数
.body(CollUtils.mapOf(
"exportID",96
))
.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调用-请求说明-请求地址的后缀
//data:对应本文HTTP调用-请求说明-请求参数-Body参数,具体使用请查看Body参数说明,根据实际使用选择参数
const res = await consoleAction({base_api_route: '/wenxinworkshop/modelrepo/eval/result/export/info',data: {
"exportID":96
}
});
console.log(res);
}
main();
返回示例
QfResponse(
code = 200,
headers = {...},
body = {
'log_id': '4014396490',
'result': {
'id': ...,
'idStr': 'ame-xxx',
'exportID': ...,
'exportIDStr': 'amemt-xxx',
'state': 'Done',
'exportType': 'local',
'volumeId': 'aipe-dragonboat',
'exportPath': 'qianfan_modelrepo/workspace/model_eval_result_export/xxx.zip',
'downloadUrl': 'https://aipe-dragonboat.bj.bcebos.com/qianfan_modelrepo/workspace/model_eval_result_export/xxx'
}
})
{
"log_id": "2340692759",
"result": {
"id": 305,
"exportID": 96,
"exportIDStr": "amemt-hkkf5y9e64j8",
"state": "Done",
"exportType": "storage",
"volumeId": "modelrepo-test",
"exportPath": "qianfan_modelrepo_offline/workspace/model_eval_result_export/cl_test23_305_1704338430470.csv",
"downloadUrl": ""
}
}
{
"log_id": "2340692759",
"result": {
"id": 305,
"exportID": 96,
"exportIDStr": "amemt-hkkf5y9e64j8",
"state": "Done",
"exportType": "storage",
"volumeId": "modelrepo-test",
"exportPath": "qianfan_modelrepo_offline/workspace/model_eval_result_export/cl_test23_305_1704338430470.csv",
"downloadUrl": ""
}
}
{
log_id: '2340692759',
result: {
id: 305,
exportID: 96,
exportIDStr: 'amemt-hkkf5y9e64j8',
state: 'Done',
exportType: 'storage',
volumeId: 'modelrepo-test',
exportPath: 'qianfan_modelrepo_offline/workspace/model_eval_result_export/cl_test23_305_1704338430470.csv',
downloadUrl: ''
}
}
请求参数
注意:以下为Python SDK参数说明,Go SDK、Java SDK、Node.js SDK参数说明请参考本文HTTP调用-请求说明。
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
export_task_id | int 或 string | 是 | 导出任务ID,说明: 通过调用发起模型评估结果导出任务接口,返回的字段获取,exportID为int类型,exportIDStr为string类型 |
返回参数
请参考本文HTTP调用-响应说明。
HTTP调用
鉴权说明
调用本文API,使用“基于安全认证AK/SK”进行签名计算鉴权,即使用安全认证中的Access Key ID 和 Secret Access Key进行鉴权,具体鉴权认证机制参考HTTP调用鉴权说明。
请求说明
- 基本信息
请求地址: https://qianfan.baidubce.com/wenxinworkshop/modelrepo/eval/result/export/info
请求方式: POST
- Header参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
Content-Type | string | 是 | 固定值:application/json |
x-bce-date | string | 否 | 当前时间,遵循ISO8601规范,格式如2016-04-06T08:23:49Z |
Authorization | string | 是 | 用于验证请求合法性的认证信息,更多内容请参考鉴权认证机制,签名工具可参考IAM签名工具 |
- Body参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
exportID | int 或 string | 是 | 导出任务ID,说明: 通过调用发起模型评估结果导出任务接口,返回的字段获取,exportID为int类型,exportIDStr为string类型 |
响应说明
名称 | 类型 | 描述 |
---|---|---|
log_id | int | 请求ID |
result | object | 请求结果 |
result说明
名称 | 类型 | 描述 |
---|---|---|
exportID | int | 导出任务数字id |
exportIDStr | string | 导出任务字符串id |
state | string | 导出任务状态,只需检查任务是否Fail或Done,说明: · Pending:任务待执行 · Uploading:进行中 · Fail:导出失败 · Done:导出成功 |
exportType | string | 导出类型: · local:导出到系统存储 · storage:导出到用户自己的bos |
volumeId | string | 导出的bucket,导出到用户bos时返回 |
exportPath | string | 导出路径(不含bucket) |
downloadUrl | string | 下载链接,导出到系统bos时返回 |
请求示例
# 替换下列示例中的Authorization、x-bce-date
curl 'https://qianfan.baidubce.com/wenxinworkshop/modelrepo/eval/result/export/info' \
--header 'Authorization: bce-auth-v1/f0ee7axxxx/2023-09-19T13:42:13Z/180000/host;x-bce-date/9a8cfb8ee58a8xxxxxxxxxxxx' \
--header 'x-bce-date: 2023-09-19T13:37:10Z' \
--header 'Content-Type: application/json' \
--data '{
"exportID":96
}'
响应示例
{
"log_id": "2340692759",
"result": {
"id": 305,
"exportID": 96,
"exportIDStr": "amemt-hkkf5y9e64j8",
"state": "Done",
"exportType": "storage",
"volumeId": "modelrepo-test",
"exportPath": "qianfan_modelrepo_offline/workspace/model_eval_result_export/cl_test23_305_1704338430470.csv",
"downloadUrl": ""
}
}
错误码
若请求错误,服务器将返回的JSON文本包含以下参数:
名称 | 描述 |
---|---|
error_code | 错误码 |
error_msg | 错误描述信息,帮助理解和解决发生的错误 |
例如错误返回:
{
"error_code": 500001,
"error_msg": "param invalid"
}
更多其他错误码,也可以查看错误码说明。