发起模型评估结果导出任务
更新时间:2024-09-23
注意: 为提升开发者使用体验,本文内容已合并至对应API文档,请查看API鉴权及调用-模型调优-模型评估-发起模型评估结果导出任务文档;本文档已于2024年6月28日在平台文档中心下线,内容不再更新。
功能介绍
用于发起评估结果导出任务。
注意事项
调用本文API,需使用安全认证AK/SK鉴权,调用流程及鉴权介绍详见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"
# 批量删除modelVersionId为amv-avxxxx4的模型
resp = Model.create_evaluation_result_export_task(eval_id='ame-xxx')
print(resp)
# print(resp['body'])
返回示例
QfResponse(code = 200, headers = {...},
body = {
'log_id': '3951021901',
'result': {
'exportID': ...,
'exportIDStr': 'amemt-xxx'
}
}
)
参数说明
请求参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
eval_id | string 或 int | 是 | 评估任务id,示例:ame-vwgs2ybhyhfv,说明: (1)可以通过以下方式获取该字段值:在控制台-模型评估页面,点击某评估任务名称打开详情页,在任务详情的基本信息中查看,如下图所示 (2)该字段新增支持string类型,如果之前使用的是int类型,建议变更为string类型,后续可能将逐步废弃int类型;例如之前是通过调用创建模型评估任务接口,返回的字段evalId获取,建议替换为通过控制台页面获取 |
export_destination_type | string | 否 | 导出类型,可选值如下: · local:导出到系统存储 · storage:导出到用户自己的bos |
export_range | string | 否 | 导出数据范围: · total:所有数据 · part:resultIds字段中指定的数据 |
export_field | string[] | 否 | 导出内容: · prompt:prompt · prediction:预测结果 · completion:预期回答 · metrics:评估指标 |
bos_bucket_id | string | 否 | bos bucket,导出到用户bos时必填 |
result_ids | string[] | 否 | 要导出的评估结果ID数组,说明: (1)数组最大100, (2)评估结果ID,可通过调用查看模型评估结果列表,接口返回的id字段获取 |
返回参数
名称 | 类型 | 描述 |
---|---|---|
log_id | int | 请求ID |
result | object | 请求结果 |
result说明
名称 | 类型 | 描述 |
---|---|---|
exportID | int | 导出任务数字ID,注意:该字段后续可能废弃,如需使用导出任务ID,请使用exportIDStr |
exportIDStr | string | 导出任务字符串ID |