获取模型版本详情

更新时间：2024-11-14

功能介绍

本接口用于获取模型版本详情，如模型版本名称、描述、创建时间、输入输出模式、输入输出模式限制等。

HTTP调用

鉴权说明

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

请求说明

基本信息

请求地址： https://qianfan.baidubce.com/v2/model

请求方式： POST

Header参数

名称	类型	必填	描述
Content-Type	string	是	固定值：application/json
x-bce-date	string	否	当前时间，遵循ISO8601规范，格式如2016-04-06T08:23:49Z
Authorization	string	是	用于验证请求合法性的认证信息，更多内容请参考鉴权认证机制，签名工具可参考IAM签名工具

Query参数

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

Body参数

名称	类型	必填	描述
modelId	string	是	模型版本ID，示例：amv-g73j3faikzpz，通过以下方式获取该字段值： · 方式一，通过调用新建我的模型版本接口，返回的modelId字段获取 · 方式二，在控制台-我的模型-点击某模型详情，在版本列表中查看

响应说明

名称	类型	描述
requestId	string	请求ID
result	object	模型版本相关信息

result说明

名称	类型	描述
modelId	string	模型版本ID
status	string	状态，说明： · Ready：已就绪 · Creating：创建中 · Fail：创建失败
modelName	string	模型版本名称
model	string	基础模型版本名称
sourceInfo	object	模型版本来源回溯信息
description	string	模型版本描述，说明： · 当有模型版本描述时，才返回该字段； · 如果无模型版本描述，不返回此字段
createTime	string	模型版本创建时间
modifyTime	string	模型版本修改时间
modelApplicationType	string	输入输出模式，说明： · chat：对话模式 · completion：续写模式
tokenLimitations	object	输入输出长度限制
isSupportDeploy	bool	是否支持部署
isSupportModelComp	bool	是否支持压缩
isSupportEvaluation	bool	是否支持评估
advancedSettings	object	量化压缩配置
modelCompConfigs	modelCompConfig[]	模型压缩可选配置列表

sourceInfo说明

名称	类型	描述
sourceType	string	模型版本来源类型，不同类型对应不同的数据结构，说明： · Train：大模型训练产生 · Acceleration：模型加速产生 · Import：外部导入模型 · PlatformPreset：平台预置模型版本
trainTaskId	string	大模型训练任务id
accelerationTaskId	string	模型版本加速任务id
importModelVersionBosUrl	string	导入模型版本bos地址

tokenLimitations说明

名称	类型	描述
trivial	object	modelApplicationType非reranker类型的模型上下文限制
reranker	object	modelApplicationType为reranker类型的模型上下文限制

trivial说明

名称	类型	描述
inputTokens	int	输入tokens限制
outputTokens	int	输出tokens限制
characterLimit	int	字符数限制

reranker说明

名称	类型	描述
queryTokens	int	query的tokens限制
queryCharacterLimit	int	query的字符数限制
documentTokens	int	document的tokens限制
documentCharacterLimit	int	document的字符数限制

advancedSettings说明

名称	类型	描述
samplingStrategy	string	压缩时的采样策略，说明：（1）当导入HuggingFace模型，且推理引擎为vLLM，该参数有效，（2）可选值如下： · 多项式采样：multinomialSampling · 束搜索：beamSearch · 贪心搜索：greedySearch
numBeams	int	束数量，说明：（1）当导入HuggingFace模型，该参数有效（2）取值范围为2-15
topLogprobs	int	logits中topk的值，范围为1～20

modelCompConfig说明

名称	类型	描述
strategy	string	模型压缩策略，说明： · Quantization：量化压缩策略 · Sparsity：稀疏化压缩策略
sparsityRatio	float	稀疏比例，strategy为Sparsity时返回
weight	string	量化压缩配置，说明：（1）只有当strategy为Quantization时返回该字段（2）说明： · W8A8C4：EB模型 · W8A8C8：EB模型 · W8A8C16：EB模型 · W8A16C16：HF模型 · W4A16C16：HF模型

请求示例

Bash

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

响应示例

JSON

HTTP/1.1 200 OK
{
    "requestId": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
    "result": {
        "modelSetId": "am-txtetnsfq9sb",
        "modelSetName": "chatglm32k_v10",
        "modelId": "amv-sxw7atka4jk0",
        "modelName": "V2",
        "model": "LLaVA-v1.6-13B",
        "description": "clc_test_publish_chatglm32k_v10",
        "sourceInfo": {
            "sourceType": "Train",
            "trainTaskId": "task-xxxx"
        },
        "status": "Ready",
        "endpointType": "chat",
        "ioTokens": "",
        "createTime": "2023-12-15T16:30:06+08:00",
        "modifyTime": "2024-01-04T16:10:45+08:00",
        "isSupportDeploy": true,
        "isSupportModelComp": false,
        "isSupportEvaluation": true
        "resourceConfig": {
            "resourceId": "prl-yqec88en7r08"
        },
        "advancedSettings": {
            "strategy": "Quantization",
            "weight": "W8A8C4-PTQ",
            "samplingStrategy": "multinomialSampling",
            "contextLength": 8,
            "shards": 1,
            "topLogprobs": 5
        },
        "modelCompConfigs": {
            "strategy": "Sparsity",
            "sparsityRatio": 0.5
        }
    }
}

SDK调用

平台支持通过Python SDK、Go SDK、Java SDK 和 Node.js SDK调用本文API，SDK调用说明文档请参考获取模型版本详情。

错误码

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

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

例如错误返回：

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

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

获取导入模型平台预置高级配置

获取模型版本的高级配置

百度智能云

百度智能云千帆大模型服务与开发平台ModelBuilder