获取单个模型信息 - ShowOpsEvaluationModel
功能介绍
该接口用于通过模型ID获取特定大模型的详细元数据,包含其技术规格、版本信息、支持的协议能力及服务终点。
调用方法
请参见如何调用API。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
| 授权项 | 访问级别 | 资源类型(*为必须) | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
| agentarts:evaluator:showOpsEvaluationModel | Read | evaluator * | g:ResourceTag/<tag-key> | - | - |
URI
GET /v1/ops/evaluation-models/{model_id}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| model_id | 是 | String | 参数解释: 大模型的唯一标识符(ID)。该参数用于在路径中指定当前操作所针对的具体模型资源。获取方法请参考9.1-获取模型信息 - ListOpsEvaluationModels。 约束限制: 不涉及。 取值范围: 由字母、数字、下划线(_)和连字符(-)组成的字符串,长度为1~100个字符。 默认取值: 不涉及。 |
请求参数
无
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| model | OpsModel object | 参数解释: 模型的详细信息,引用OpsModel对象。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| max_tokens_top | Integer | 参数解释: 模型生成文本的最大长度上限。 取值范围: 0~10000,单位为token。 |
| max_tokens_bottom | Integer | 参数解释: 模型生成文本的最小长度下限。 取值范围: 0~10000,单位为token。 |
| model_id | String | 参数解释: 模型的唯一标识符。 取值范围: 不涉及。 |
| model_name | String | 参数解释: 模型的显示名称。 取值范围: 不涉及。 |
| temperature_top | String | 参数解释: 模型生成随机性(Temperature)的上限值。 取值范围: 不涉及。 |
| temperature_bottom | String | 参数解释: 模型生成随机性的下限值。 取值范围: 不涉及。 |
| top_p_top | String | 参数解释: TopP采样策略的上限值。 取值范围: 不涉及。 |
| top_p_bottom | String | 参数解释: TopP采样策略的下限值。 取值范围: 不涉及。 |
| supported_scenes | Array of strings | 参数解释: 模型支持的应用场景列表。数组内每个元素为字符串类型,表示一个支持的场景,可选枚举值包括: |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 系统定义的标准化错误代码。 取值范围: 业务异常编码字符串。 |
| error_msg | String | 参数解释: 对错误的详细描述,包含异常原因或解决建议。 取值范围: 字符长度2-512,任意文本内容。 |
| encoded_authorization_message | String | 参数解释: 编码后的授权信息,用于客户端解析权限问题。 取值范围: Base64编码的字符串。 |
| details | Array of OpsErrorDetail objects | 参数解释: 错误详情列表,包含多个子错误的详细信息。 取值范围: 不涉及。 |
| request_id | String | 参数解释: 请求的唯一标识符,用于问题排查和链路追踪。 取值范围: 符合通用唯一识别码(UUID)标准的字符串。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 子错误的标准化错误代码。 取值范围: 业务异常编码字符串。 |
| error_msg | String | 参数解释: 对子错误的详细描述。 取值范围: 任意文本内容。 |
状态码:401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 系统定义的标准化错误代码。 取值范围: 业务异常编码字符串。 |
| error_msg | String | 参数解释: 对错误的详细描述,包含异常原因或解决建议。 取值范围: 字符长度2-512,任意文本内容。 |
| encoded_authorization_message | String | 参数解释: 编码后的授权信息,用于客户端解析权限问题。 取值范围: Base64编码的字符串。 |
| details | Array of OpsErrorDetail objects | 参数解释: 错误详情列表,包含多个子错误的详细信息。 取值范围: 不涉及。 |
| request_id | String | 参数解释: 请求的唯一标识符,用于问题排查和链路追踪。 取值范围: 符合通用唯一识别码(UUID)标准的字符串。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 子错误的标准化错误代码。 取值范围: 业务异常编码字符串。 |
| error_msg | String | 参数解释: 对子错误的详细描述。 取值范围: 任意文本内容。 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 系统定义的标准化错误代码。 取值范围: 业务异常编码字符串。 |
| error_msg | String | 参数解释: 对错误的详细描述,包含异常原因或解决建议。 取值范围: 字符长度2-512,任意文本内容。 |
| encoded_authorization_message | String | 参数解释: 编码后的授权信息,用于客户端解析权限问题。 取值范围: Base64编码的字符串。 |
| details | Array of OpsErrorDetail objects | 参数解释: 错误详情列表,包含多个子错误的详细信息。 取值范围: 不涉及。 |
| request_id | String | 参数解释: 请求的唯一标识符,用于问题排查和链路追踪。 取值范围: 符合通用唯一识别码(UUID)标准的字符串。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 子错误的标准化错误代码。 取值范围: 业务异常编码字符串。 |
| error_msg | String | 参数解释: 对子错误的详细描述。 取值范围: 任意文本内容。 |
状态码:404
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 系统定义的标准化错误代码。 取值范围: 业务异常编码字符串。 |
| error_msg | String | 参数解释: 对错误的详细描述,包含异常原因或解决建议。 取值范围: 字符长度2-512,任意文本内容。 |
| encoded_authorization_message | String | 参数解释: 编码后的授权信息,用于客户端解析权限问题。 取值范围: Base64编码的字符串。 |
| details | Array of OpsErrorDetail objects | 参数解释: 错误详情列表,包含多个子错误的详细信息。 取值范围: 不涉及。 |
| request_id | String | 参数解释: 请求的唯一标识符,用于问题排查和链路追踪。 取值范围: 符合通用唯一识别码(UUID)标准的字符串。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 子错误的标准化错误代码。 取值范围: 业务异常编码字符串。 |
| error_msg | String | 参数解释: 对子错误的详细描述。 取值范围: 任意文本内容。 |
状态码:429
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 系统定义的标准化错误代码。 取值范围: 业务异常编码字符串。 |
| error_msg | String | 参数解释: 对错误的详细描述,包含异常原因或解决建议。 取值范围: 字符长度2-512,任意文本内容。 |
| encoded_authorization_message | String | 参数解释: 编码后的授权信息,用于客户端解析权限问题。 取值范围: Base64编码的字符串。 |
| details | Array of OpsErrorDetail objects | 参数解释: 错误详情列表,包含多个子错误的详细信息。 取值范围: 不涉及。 |
| request_id | String | 参数解释: 请求的唯一标识符,用于问题排查和链路追踪。 取值范围: 符合通用唯一识别码(UUID)标准的字符串。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 子错误的标准化错误代码。 取值范围: 业务异常编码字符串。 |
| error_msg | String | 参数解释: 对子错误的详细描述。 取值范围: 任意文本内容。 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 系统定义的标准化错误代码。 取值范围: 业务异常编码字符串。 |
| error_msg | String | 参数解释: 对错误的详细描述,包含异常原因或解决建议。 取值范围: 字符长度2-512,任意文本内容。 |
| encoded_authorization_message | String | 参数解释: 编码后的授权信息,用于客户端解析权限问题。 取值范围: Base64编码的字符串。 |
| details | Array of OpsErrorDetail objects | 参数解释: 错误详情列表,包含多个子错误的详细信息。 取值范围: 不涉及。 |
| request_id | String | 参数解释: 请求的唯一标识符,用于问题排查和链路追踪。 取值范围: 符合通用唯一识别码(UUID)标准的字符串。 |
请求示例
通过模型ID"mod_gpt4_v1" 获取该模型的详细元数据。
GET https://api.example.com/v1/ops/evaluation-models/mod_gpt4_v1
响应示例
状态码:200
获取模型信息成功
{
"model" : {
"model_id" : "mod_gpt4_v1",
"model_name" : "GPT-4-Turbo",
"max_tokens_top" : 90,
"max_tokens_bottom" : 45,
"temperature_top" : "15",
"temperature_bottom" : "3",
"top_p_top" : "55",
"top_p_bottom" : "20",
"supported_scenes" : [ "evaluators" ]
}
} 状态码:400
请求参数错误
{
"error_code" : "AgentArts.03400001",
"error_msg" : "请求错误"
} 状态码:401
认证失败
{
"error_code" : "AgentArts.100004010",
"error_msg" : "unauthorized"
} 状态码:403
鉴权失败
{
"error_code" : "AgentArts.100004030",
"error_msg" : "forbidden"
} 状态码:404
模型不存在
{
"error_code" : "AgentArts.100004040",
"error_msg" : "模型不存在"
} 状态码:429
请求过于频繁
{
"error_code" : "AgentArts.100004290",
"error_msg" : "请求过于频繁"
} 状态码:500
系统错误
{
"error_code" : "AgentArts.03500001",
"error_msg" : "internal error"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 获取模型信息成功 |
| 400 | 请求参数错误 |
| 401 | 认证失败 |
| 403 | 鉴权失败 |
| 404 | 模型不存在 |
| 429 | 请求过于频繁 |
| 500 | 系统错误 |
错误码
请参见错误码。