发起模型评估结果导出任务

更新时间：2024-12-23

功能介绍

用于发起评估结果导出任务。

使用说明

本文API支持通过Python SDK、Go SDK、Java SDK 和 Node.js SDK调用，调用流程请参考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_iam_ak"
os.environ["QIANFAN_SECRET_KEY"] = "your_iam_sk"



resp = resources.console.utils.call_action(
    # 调用本文API，该参数值为固定值，无需修改；对应HTTP调用文档-请求说明-请求地址的后缀
    "/wenxinworkshop/modelrepo/eval/result/export", "", 
    # 对应HTTP调用文档-请求说明-请求参数-Body参数，具体使用请查看Body参数说明，根据实际使用选择参数
    {
        "id":305,
        "exportType":"storage",
        "exportOpt":"part",
        "volumeId":"modelrepo-test",
        "resultIds":["65951573193ec327b9639c7f","65951609193ec327b963a52e"],
        "exportContent":["prompt","prediction","completion","metrics"]
    }
    
)

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", "",
    // 对应HTTP调用文档-请求说明-请求参数-Body参数，具体使用请查看Body参数说明，根据实际使用选择参数
    map[string]interface{}{
            "id":305,
            "exportType":"storage",
            "exportOpt":"part",
            "volumeId":"modelrepo-test",
            "resultIds": [...]string{"65951573193ec327b9639c7f","65951609193ec327b963a52e"},
            "exportContent":[...]string{"prompt","prediction","completion","metrics"},
        
    })
    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")
                // 需要传入参数的场景，可以自行封装请求类，或者使用Map.of()来构建请求Body
                // Java 8可以使用SDK提供的CollUtils.mapOf()来替代Map.of()
                // 对应HTTP调用文档-请求说明-请求参数-Body参数，具体使用请查看Body参数说明，根据实际使用选择参数
                .body(CollUtils.mapOf(
                    "id",305,
                    "exportType","storage",
                    "exportOpt","part",
                    "volumeId","modelrepo-test",
                    "resultIds",new String[]{"65951573193ec327b9639c7f","65951609193ec327b963a52e"},
                    "exportContent",new String[]{"prompt","prediction","completion","metrics"}
                ))
                .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',data: {
        "id":305,
        "exportType":"storage",
        "exportOpt":"part",
        "volumeId":"modelrepo-test",
        "resultIds":["65951573193ec327b9639c7f","65951609193ec327b963a52e"],
        "exportContent":["prompt","prediction","completion","metrics"]
    }
  });    
    
  console.log(res);
}

main();

返回示例

{
    "log_id": "4159183555",
    "result": {
        "exportID": 105,
        "exportIDStr":"amemt-hkkf5y9e64j8"
    }
}

{
    "log_id": "4159183555",
    "result": {
        "exportID": 105,
        "exportIDStr":"amemt-hkkf5y9e64j8"
    }
}

{
    "log_id": "4159183555",
    "result": {
        "exportID": 105,
        "exportIDStr":"amemt-hkkf5y9e64j8"
    }
}

{
    log_id: '4159183555',
    result: {
        exportID: 105,
        exportIDStr:'amemt-hkkf5y9e64j8'
    }
}

请求参数

名称	类型	必填	描述
id	string 或 int	是	评估任务id，示例：ame-vwgs2ybhyhfv，说明：（1）可以通过以下方式获取该字段值：在控制台-模型评估页面，点击某评估任务名称打开详情页，在任务详情的基本信息中查看，如下图所示（2）该字段新增支持string类型，如果之前使用的是int类型，建议变更为string类型，后续可能将逐步废弃int类型；例如之前是通过调用创建模型评估任务接口，返回的字段evalId获取，建议替换为通过控制台页面获取
exportType	string	否	导出类型，可选值如下： · local：导出到系统存储 · storage：导出到用户自己的bos
exportOpt	string	否	导出数据范围： · total：所有数据 · part：resultIds字段中指定的数据
exportContent	string[]	否	导出内容： · prompt：prompt · prediction：预测结果 · completion：预期回答 · metrics：评估指标
volumeId	string	否	bos bucket，导出到用户bos时必填
resultIds	string[]	否	要导出的评估结果ID数组，说明：（1）数组最大100，（2）评估结果ID，可通过调用查看模型评估结果列表，接口返回的id字段获取

返回参数

名称	类型	描述
log_id	int	请求ID
result	object	请求结果

result说明

名称	类型	描述
exportID	int	导出任务数字ID，注意：该字段后续可能废弃，如需使用导出任务ID，请使用exportIDStr
exportIDStr	string	导出任务字符串ID

批量删除模型评估

查看模型评估结果导出任务状态