获取预置模型版本详情
更新时间:2024-11-26
功能介绍
用于获取预置模型版本详情。
使用说明
本文API支持通过Python SDK、Go SDK、Java SDK 和 Node.js SDK调用,调用流程请参考SDK安装及使用流程。
SDK调用
调用示例
import os
from qianfan import resources
# 通过环境变量初始化认证信息
# 使用安全认证AK/SK调用,替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk,如何获取请查看https://cloud.baidu.com/doc/Reference/s/9jwvz2egb
os.environ["QIANFAN_ACCESS_KEY"] = "your_access_key"
os.environ["QIANFAN_SECRET_KEY"] = "your_secret_key"
resp = resources.console.utils.call_action(
# 调用本文API,该参数值为固定值,无需修改;对应HTTP调用文档-请求说明-请求地址的后缀
"/v2/model",
# 调用本文API,该参数值为固定值,无需修改;对应HTTP调用文档-请求说明-请求参数-Query参数的Action
"DescribeSystemModel",
# 对应HTTP调用文档-请求说明-请求参数-Body参数,具体使用请查看Body参数说明,根据实际使用选择参数
{
"modelId":"amv-2dxxxxm2"
}
)
print(resp.body)
package main
import (
"context"
"fmt"
"os"
"github.com/baidubce/bce-qianfan-sdk/go/qianfan"
)
func main() {
// 使用安全认证AK/SK鉴权,通过环境变量初始化;替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
os.Setenv("QIANFAN_ACCESS_KEY", "your_iam_ak")
os.Setenv("QIANFAN_SECRET_KEY", "your_iam_sk")
ca := qianfan.NewConsoleAction()
res, err := ca.Call(context.TODO(),
// 调用本文API,该参数值为固定值,无需修改;对应HTTP调用文档-请求说明-请求地址的后缀
"/v2/model",
// 调用本文API,该参数值为固定值,无需修改;对应HTTP调用文档-请求说明-请求参数-Query参数的Action
"DescribeSystemModel",
// 对应HTTP调用文档-请求说明-请求参数-Body参数,具体使用请查看Body参数说明,根据实际使用选择参数
map[string]interface{}{
"modelId":"amv-2dxxxxm2",
})
if err != nil {
panic(err)
}
fmt.Println(string(res.Body))
}
import com.baidubce.qianfan.Qianfan;
import com.baidubce.qianfan.model.console.ConsoleResponse;
import com.baidubce.qianfan.util.CollUtils;
import com.baidubce.qianfan.util.Json;
import java.util.Map;
public class Dome {
public static void main(String args[]){
// 使用安全认证AK/SK鉴权,替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
Qianfan qianfan = new Qianfan("your_iam_ak", "your_iam_sk");
ConsoleResponse<Map<String, Object>> response = qianfan.console()
// 调用本文API,该参数值为固定值,无需修改;对应HTTP调用文档-请求说明-请求地址的后缀
.route("/v2/model")
// 调用本文API,该参数值为固定值,无需修改;对应HTTP调用文档-请求说明-请求参数-Query参数的Action
.action("DescribeSystemModel")
// 需要传入参数的场景,可以自行封装请求类,或者使用Map.of()来构建请求Body
// Java 8可以使用SDK提供的CollUtils.mapOf()来替代Map.of()
// 对应HTTP调用文档-请求说明-请求参数-Body参数,具体使用请查看Body参数说明,根据实际使用选择参数
.body(CollUtils.mapOf(
"modelId","amv-2dxxxxm2"
))
.execute();
System.out.println(Json.serialize(response));
}
}
import {consoleAction, setEnvVariable} from "@baiducloud/qianfan";
// 使用安全认证AK/SK鉴权,通过环境变量初始化;替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
setEnvVariable('QIANFAN_ACCESS_KEY','your_iam_ak');
setEnvVariable('QIANFAN_SECRET_KEY','your_iam_sk');
async function main() {
//base_api_route:调用本文API,该参数值为固定值,无需修改;对应HTTP调用文档-请求说明-请求地址的后缀
//action:调用本文API,该参数值为固定值,无需修改;对应HTTP调用文档-请求说明-请求参数-Query参数的Action
//data:对应HTTP调用文档-请求说明-请求参数-Body参数,具体使用请查看Body参数说明,根据实际使用选择参数
const res = await consoleAction({base_api_route: '/v2/model', action: 'DescribeSystemModel', data: {
"modelId":"amv-2dxxxxm2"
});
console.log(res);
}
main();
返回示例
{
"requestId": "21fe685d-2070-4b42-acb3-126cb0734b13",
"result": {
"modelSetId": "am-vhxxxxn9",
"modelId": "amv-2dxxxxxem2",
"modelName": "ERNIE-4.0-8K",
"status": "Ready",
"modelApplicationType": "chat",
"tokenLimitations": {
"trivial": {
"inputTokens": 5120,
"outputTokens": 2048,
"characterLimit": 0
}
},
"createTime": "2024-10-25T19:10:46+08:00",
"modifyTime": "2024-10-25T19:10:46+08:00",
"isSupportDeploy": False,
"isSupportModelComp": False,
"isSupportEvaluation": False
}
}
{
"requestId": "21fe685d-2070-4b42-acb3-126cb0734b13",
"result": {
"modelSetId": "am-vhxxxxn9",
"modelId": "amv-2dxxxxxem2",
"modelName": "ERNIE-4.0-8K",
"status": "Ready",
"modelApplicationType": "chat",
"tokenLimitations": {
"trivial": {
"inputTokens": 5120,
"outputTokens": 2048,
"characterLimit": 0
}
},
"createTime": "2024-10-25T19:10:46+08:00",
"modifyTime": "2024-10-25T19:10:46+08:00",
"isSupportDeploy": false,
"isSupportModelComp": false,
"isSupportEvaluation": false
}
}
{
"requestId": "21fe685d-2070-4b42-acb3-126cb0734b13",
"result": {
"modelSetId": "am-vhxxxxn9",
"modelId": "amv-2dxxxxxem2",
"modelName": "ERNIE-4.0-8K",
"status": "Ready",
"modelApplicationType": "chat",
"tokenLimitations": {
"trivial": {
"inputTokens": 5120,
"outputTokens": 2048,
"characterLimit": 0
}
},
"createTime": "2024-10-25T19:10:46+08:00",
"modifyTime": "2024-10-25T19:10:46+08:00",
"isSupportDeploy": false,
"isSupportModelComp": false,
"isSupportEvaluation": false
}
}
{
requestId: '6e89ffcb-b0e1-4732-9f94-e345f65f65ea',
result: {
modelSetId: 'am-vhxxxxn9',
modelId: 'amv-2dxxxxxem2',
modelName: 'ERNIE-4.0-8K',
status: 'Ready',
modelApplicationType: 'chat',
tokenLimitations: {
trivial: {
'inputTokens': 5120,
'outputTokens': 2048,
'characterLimit': 0
}
},
createTime: '2024-06-13T21:13:53+08:00',
modifyTime: '2024-08-01T15:24:26+08:00',
isSupportDeploy: false,
isSupportModelComp: false,
isSupportEvaluation: false
}
}
请求参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
modelId | string | 是 | 模型版本id,通过调用获取预置模型列表接口,返回的modelIds字段获取该字段值 |
返回参数
名称 | 类型 | 描述 |
---|---|---|
requestId | string | 请求ID |
result | object | 请求结果 |
result说明
名称 | 类型 | 描述 |
---|---|---|
modelSetId | string | 模型id |
modelId | string | 模型版本id |
modelName | string | 模型版本名称 |
status | string | 状态,说明: · Ready:已就绪 · Creating:创建中 · Fail:创建失败 |
description | string | 模型版本描述 |
createTime | string | 模型版本创建时间 |
modifyTime | string | 模型版本修改时间 |
modelApplicationType | string | 输入输出模式,说明: · chat:对话模式 · completion:续写模式 |
tokenLimitations | object | 输入输出长度限制 |
isSupportDeploy | bool | 是否支持部署 |
isSupportModelComp | bool | 是否支持压缩 |
isSupportEvaluation | bool | 是否支持评估 |
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的字符数限制 |