发起模型评估结果导出任务
更新时间：2024-11-08
功能介绍
本接口用于发起评估结果导出任务，导出格式为.zip。
HTTP调用
鉴权说明
调用本文API，使用“基于安全认证AK/SK”进行签名计算鉴权，即使用安全认证中的Access Key ID 和 Secret Access Key进行鉴权，具体鉴权认证机制参考HTTP调用鉴权说明。
请求说明
- 基本信息
请求地址： https://qianfan.baidubce.com/wenxinworkshop/modelrepo/eval/result/export
请求方式： POST
- Header参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Content-Type | string | 是 | 固定值：application/json |
| x-bce-date | string | 否 | 当前时间，遵循ISO8601规范，格式如2016-04-06T08:23:49Z |
| Authorization | string | 是 | 用于验证请求合法性的认证信息，更多内容请参考鉴权认证机制，签名工具可参考IAM签名工具 |
- Body参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| 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 |
请求示例
# 替换下列示例中的Authorization、x-bce-date
curl 'https://qianfan.baidubce.com/wenxinworkshop/modelrepo/eval/result/export' \
--header 'Authorization: bce-auth-v1/f0ee7axxxx/2023-09-19T13:42:13Z/180000/host;x-bce-date/9a8cfb8xxxxxxxxxxx4525543' \
--header 'x-bce-date: 2023-09-19T13:37:10Z' \
--header 'Content-Type: application/json' \
--data '{
"id":305,
"exportType":"storage",
"exportOpt":"part",
"volumeId":"modelrepo-test",
"resultIds":["65951573193ec327b9639c7f","65951609193ec327b963a52e"],
"exportContent":["prompt","prediction","completion","metrics"]
}' 响应示例
{
"log_id": "4159183555",
"result": {
"exportID": 105,
"exportIDStr":"amemt-hkkf5y9e64j8"
}
}SDK调用
平台支持通过Python SDK、Go SDK、Java SDK 和 Node.js SDK调用本文API，SDK调用说明文档请参考发起模型评估结果导出任务。
错误码
若请求错误，服务器将返回的JSON文本包含以下参数：
| 名称 | 描述 |
|---|---|
| error_code | 错误码 |
| error_msg | 错误描述信息，帮助理解和解决发生的错误 |
例如错误返回：
{
"error_code": 500001,
"error_msg": "param invalid"
}更多其他错误码，也可以查看错误码说明。