获取模型压缩任务详情
更新时间:2025-04-16
功能介绍
用于获取模型压缩任务详情。
使用说明
本文API支持通过Python SDK、Go SDK、Java SDK 和 Node.js SDK调用,调用流程请参考SDK安装及使用流程。
权限说明
调用本文API,需符合以下权限要求,权限介绍及分配,请查看角色与权限控制列表、账号创建与权限分配。需具有以下任一权限:
- 完全控制千帆大模型平台的权限:QianfanFullControlAccessPolicy
- 只读访问千帆大模型平台的权限:QianfanReadAccessPolicy
- 完全控制千帆大模型平台模型调优的权限:QianfanModelTuningFullControlAccessPolicy
- 只读访问千帆大模型平台模型调优的权限:QianfanModelTuningReadAccessPolicy
SDK调用
调用示例
1import os
2from qianfan import resources
3
4# 通过环境变量初始化认证信息
5# 使用安全认证AK/SK调用,替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk,如何获取请查看https://cloud.baidu.com/doc/Reference/s/9jwvz2egb
6os.environ["QIANFAN_ACCESS_KEY"] = "your_iam_ak"
7os.environ["QIANFAN_SECRET_KEY"] = "your_iam_sk"
8
9
10
11resp = resources.console.utils.call_action(
12 # 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求结构-请求地址的后缀
13 "/v2/model",
14 # 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求参数-Query参数的Action
15 "DescribeModelCompTask",
16 # 请查看本文请求参数说明,根据实际使用选择参数;对应API调用文档-请求参数-Body参数
17 {
18 "modelCompTaskId":"amva-abciuctdx15t"
19 }
20)
21
22print(resp.body)
1package main
2import (
3 "context"
4 "fmt"
5 "os"
6 "github.com/baidubce/bce-qianfan-sdk/go/qianfan"
7)
8func main() {
9 // 使用安全认证AK/SK鉴权,通过环境变量初始化;替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
10 os.Setenv("QIANFAN_ACCESS_KEY", "your_iam_ak")
11 os.Setenv("QIANFAN_SECRET_KEY", "your_iam_sk")
12
13 ca := qianfan.NewConsoleAction()
14
15 res, err := ca.Call(context.TODO(),
16 // 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求结构-请求地址的后缀
17 "/v2/model",
18 // 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求参数-Query参数的Action
19 "DescribeModelCompTask",
20 // 请查看本文请求参数说明,根据实际使用选择参数;对应API调用文档-请求参数-Body参数
21 map[string]interface{}{
22 "modelCompTaskId":"amva-abciuctdx15t",
23 })
24 if err != nil {
25 panic(err)
26 }
27 fmt.Println(string(res.Body))
28
29}
1import com.baidubce.qianfan.Qianfan;
2import com.baidubce.qianfan.model.console.ConsoleResponse;
3import com.baidubce.qianfan.util.CollUtils;
4import com.baidubce.qianfan.util.Json;
5import java.util.Map;
6
7public class Dome {
8 public static void main(String args[]){
9 // 使用安全认证AK/SK鉴权,替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
10 Qianfan qianfan = new Qianfan("your_iam_ak", "your_iam_sk");
11
12 ConsoleResponse<Map<String, Object>> response = qianfan.console()
13 // 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求结构-请求地址的后缀
14 .route("/v2/model")
15 // 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求参数-Query参数的Action
16 .action("DescribeModelCompTask")
17 // 需要传入参数的场景,可以自行封装请求类,或者使用Map.of()来构建请求Body
18 // Java 8可以使用SDK提供的CollUtils.mapOf()来替代Map.of()
19 // 请查看本文请求参数说明,根据实际使用选择参数;对应API调用文档-请求参数-Body参数
20 .body(CollUtils.mapOf(
21 "modelCompTaskId","amva-abciuctdx15t"
22 ))
23 .execute();
24
25 System.out.println(Json.serialize(response));
26 }
27}
1import {consoleAction, setEnvVariable} from "@baiducloud/qianfan";
2
3// 使用安全认证AK/SK鉴权,通过环境变量初始化;替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
4setEnvVariable('QIANFAN_ACCESS_KEY','your_iam_ak');
5setEnvVariable('QIANFAN_SECRET_KEY','your_iam_sk');
6
7async function main() {
8 //base_api_route:调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求结构-请求地址的后缀
9 //action:调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求参数-Query参数的Action
10 //data:请查看本文请求参数说明,根据实际使用选择参数;对应API调用文档-请求参数-Body参数
11 const res = await consoleAction({base_api_route: '/v2/model', action: 'DescribeModelCompTask', data: {
12 "modelCompTaskId":"amva-abciuctdx15t"
13 }
14 });
15
16 console.log(res);
17}
18main();
返回示例
1{
2 "requestId": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
3 "result": {
4 "id": "amva-abciuctdx15t",
5 "name": "demo",
6 "description": "test",
7 "state": "Done",
8 "failedReason": "",
9 "sourceModelId": "amv-se1t8i4gr9fu",
10 "targetModelId": "amv-vnhxxj3crnsp",
11 "createTime": "2024-04-10T17:16:22+08:00",
12 "finishTime": "2024-04-10T17:36:22+08:00",
13 "config": {
14 "strategy": "Quantization",
15 "weight": "wint8"
16 }
17 }
18}
1{
2 "requestId": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
3 "result": {
4 "id": "amva-abciuctdx15t",
5 "name": "demo",
6 "description": "test",
7 "state": "Done",
8 "failedReason": "",
9 "sourceModelId": "amv-se1t8i4gr9fu",
10 "targetModelId": "amv-vnhxxj3crnsp",
11 "createTime": "2024-04-10T17:16:22+08:00",
12 "finishTime": "2024-04-10T17:36:22+08:00",
13 "config": {
14 "strategy": "Quantization",
15 "weight": "wint8"
16 }
17 }
18}
1{
2 "requestId": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
3 "result": {
4 "id": "amva-abciuctdx15t",
5 "name": "demo",
6 "description": "test",
7 "state": "Done",
8 "failedReason": "",
9 "sourceModelId": "amv-se1t8i4gr9fu",
10 "targetModelId": "amv-vnhxxj3crnsp",
11 "createTime": "2024-04-10T17:16:22+08:00",
12 "finishTime": "2024-04-10T17:36:22+08:00",
13 "config": {
14 "strategy": "Quantization",
15 "weight": "wint8"
16 }
17 }
18}
1{
2 requestId: '6ba7b810-9dad-11dxxxfd430c8',
3 result: {
4 id: 'amva-abciuctdx15t',
5 name: 'demo',
6 description: 'test',
7 state: 'Done',
8 failedReason: '',
9 sourceModelId: 'amv-se1t8i4gr9fu',
10 targetModelId: 'amv-vnhxxj3crnsp',
11 createTime: '2024-04-10T17:16:22+08:00',
12 finishTime: '2024-04-10T17:36:22+08:00',
13 config": {
14 strategy: 'Quantization',
15 weight: 'wint8'
16 }
17 }
18}
请求参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
modelCompTaskId | string | 否 | 模型压缩任务id,可以通过以下任一方式获取该字段值: 方式一:通过调用创建模型压缩任务接口,返回的result字段获取 方式二:通过调用查看模型压缩任务列表接口,返回的id字段获取 |
返回参数
名称 | 类型 | 描述 |
---|---|---|
requestId | string | 请求ID |
result | object | 请求结果 |
result说明
名称 | 类型 | 描述 |
---|---|---|
id | string | 模型压缩任务id |
name | string | 模型压缩任务名称 |
description | string | 模型压缩任务描述 |
status | string | 模型压缩任务运行状态,取值: · creating:创建中 · running:运行中 · succeeded:已完成 · failed:已失败 · stopping:终止中 · stopped:已终止 |
failedReason | string | 模型压缩任务运行失败原因 |
sourceModelId | string | 模型压缩任务源模型版本id |
modelId | string | 压缩后产出模型版本id,仅当status为succeeded时,返回该字段 |
config | object | 模型压缩策略配置信息 |
createTime | string | 模型压缩任务创建时间 |
finishTime | string | 模型压缩任务完成时间 |
config说明
名称 | 类型 | 描述 |
---|---|---|
strategy | string | 模型压缩策略,说明: · Quantization:量化压缩策略 · Sparsity:稀疏化压缩策略 |
sparsityRatio | float | 稀疏比例,strategy为Sparsity时返回 |
weight | string | 量化压缩配置,说明: (1)当strategy为Quantization时,返回该字段 (2)说明: · WINT8 · INT8-PTQ · W8A16C16 · W4A16C16 |