获取模型压缩任务详情

更新时间：2024-12-23

接口描述

本接口用于获取模型压缩任务详情。

权限说明

调用本文API，需符合以下权限要求，权限介绍及分配，请查看角色与权限控制列表、账号创建与权限分配。需具有以下任一权限：

完全控制千帆大模型平台的权限：QianfanFullControlAccessPolicy
只读访问千帆大模型平台的权限：QianfanReadAccessPolicy
完全控制千帆大模型平台模型调优的权限：QianfanModelTuningFullControlAccessPolicy
只读访问千帆大模型平台模型调优的权限：QianfanModelTuningReadAccessPolicy

鉴权说明

调用本文API，使用“基于安全认证AK/SK”进行签名计算鉴权，即使用安全认证中的Access Key ID 和 Secret Access Key进行鉴权，具体鉴权认证机制参考HTTP调用鉴权说明。

请求结构

Bash

POST /v2/model?Action=DescribeModelCompTask HTTP/1.1
Host: qianfan.baidubce.com
Authorization: authorization string
Content-Type: application/json

{
    "modelCompTaskId":"amva-abc***dx15t"
}

请求头域

除公共头域外，无其它特殊头域。

请求参数

Query参数

名称	类型	必填	描述
Action	string	是	方法名称，固定值DescribeModelCompTask

Body参数

名称	类型	必填	描述
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

请求示例

Bash

# 替换下列示例中的Authorization值、x-bce-date值
curl -i --location 'https://qianfan.baidubce.com/v2/model?Action=DescribeModelCompTask'\
--header 'Authorization: bce-auth-v1/f0ee7axxxx/2023-09-19T13:42:13Z/180000/host;x-bce-date/9a8cfb8ee58a8f4xxxxx6e374525543'\ 
--header 'x-bce-date: 2023-09-19T13:37:10Z'\
--header 'Content-Type: application/json'\ 
--data '{
    "modelCompTaskId":"amva-abciuctdx15t"
}'

响应示例

JSON

{
    "requestId": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
    "result": {
        "id": "amva-abciuctdx15t",
        "name": "demo",
        "description": "test",
        "state": "Done",
        "failedReason": "",
        "sourceModelId": "amv-se1t8i4gr9fu",
        "targetModelId": "amv-vnhxxj3crnsp",
        "createTime": "2024-04-10T17:16:22+08:00",
        "finishTime": "2024-04-10T17:36:22+08:00",
        "config": {
            "strategy": "Quantization",
            "weight": "wint8"
        }
    }
}

错误码

若请求错误，服务器将返回的JSON文本包含以下参数：

名称	描述
requestId	请求ID
code	错误码
message	错误描述信息，帮助理解和解决发生的错误

例如错误返回：

{
    "requestId":"6ba7b810-xxxxc04fd430c8",
    "code":"AccessDenied",
    "message":"Access denied."
}

更多其他错误码，也可以查看错误码说明。

查看模型压缩任务列表

停止模型压缩任务

百度智能云

千帆大模型服务与开发平台ModelBuilder