获取评估器模板 - ShowOpsEvaluatorTemplate
功能介绍
该接口用于根据模板ID获取特定评估器模板的详细信息,支持查询模板的完整配置和使用说明,适用于需要深入了解特定模板配置的场景。
URI
GET /v1/ops/evaluator-templates/{template_id}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
template_id |
是 |
String |
参数解释: 模板的唯一标识符(ID)。该参数用于在API路径中定位特定的配置模板或评估模板资源。 约束限制: 长度为1到100个字符的字符串。 取值范围: 通常由英文、数字、中划线(-)及下划线(_)组成,建议字符位数不超过 64 位。 默认取值: 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
Content-Type |
是 |
String |
参数解释: 消息体编码格式。用于告知服务端请求体(Body)所采用的主体数据类型,以便服务端正确解析。 约束限制: 不涉及 取值范围: 不涉及 默认取值: application/json |
|
Authorization |
是 |
String |
参数解释: 签名认证信息,当使用AK/SK方式认证时,使用SDK对请求进行签名的过程中会自动填充该字段。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
X-Sdk-Date |
是 |
String |
参数解释: 请求发送的时间,当使用AK/SK方式认证时,使用SDK对请求进行签名的过程中会自动填充该字段。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
template |
template object |
参数解释: 模板信息包含完整评估器模板的所有详细属性和数据。 取值范围: 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
base_info |
OpsEvaluatorBaseInfo object |
参数解释: 基本信息包含评估器的核心配置和元数据。 取值范围: 不涉及。 |
|
description |
String |
参数解释: 描述用于详细说明评估器的功能、用途和应用场景。 取值范围: 描述性字符串。 |
|
evaluator_content |
evaluator_content object |
参数解释: 评估器信息包含具体的实现逻辑,如输入输出规范等。 取值范围: 不涉及。 |
|
evaluator_info |
evaluator_info object |
参数解释: 评估器元数据补充信息。 取值范围: 不涉及。 |
|
evaluator_type |
Integer |
参数解释: 评估器的分类类型。 取值范围: 不涉及。 |
|
name |
String |
参数解释: 评估器的名字。 取值范围: 不涉及。 |
|
popularity |
String |
参数解释: 受欢迎程度分值。 取值范围: 字符串形式的数字。 |
|
tags |
tags object |
参数解释: 评估器标签用于分类和检索。 取值范围: 不涉及。 |
|
template_id |
String |
参数解释: 评估器模板的唯一ID。 取值范围: 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
created_at |
String |
参数解释: 评估器的创建时间。 约束限制: 采用 ISO 8601 标准格式表示。 取值范围: 0到100个字符。 默认取值: 不涉及。 |
|
created_by |
EvaluationOpsCreatedBy object |
参数解释: 创建该评估器的用户信息。 约束限制: 符合 EvaluationOpsCreatedBy定义。 取值范围: 对象结构。 默认取值: 不涉及。 |
|
updated_at |
String |
参数解释: 评估器的最近一次更新时间。 约束限制: 采用 ISO 8601 标准格式表示。 取值范围: 0到100个字符。 默认取值: 不涉及。 |
|
updated_by |
EvaluationOpsUpdatedBy object |
参数解释: 最后一次修改该评估器的用户信息。 约束限制: 符合 EvaluationOpsUpdatedBy定义。 取值范围: 对象结构。 默认取值: 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
user_id |
String |
参数解释: 资源创建者的唯一标识符。 约束限制: 0到10000字符。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
name |
String |
参数解释: 资源创建者的显示名称。 约束限制: 0到10000字符。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
avatar_url |
String |
参数解释: 创建者的头像链接。 约束限制: 0到10000字符。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
user_id |
String |
参数解释: 最后一次更新资源的用户的ID。 约束限制: 0到10000字符。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
name |
String |
参数解释: 更新者的显示名称。 约束限制: 0到10000字符。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
avatar_url |
String |
参数解释: 更新者的头像链接。 约束限制: 0到10000字符。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
input_schemas |
Array of input_schemas objects |
参数解释: 输入参数定义列表。 取值范围: 不涉及。 |
|
output_schemas |
Array of output_schemas objects |
参数解释: 输出参数定义评估器返回值的格式和结构。 取值范围: 不涉及。 |
|
prompt_evaluator |
prompt_evaluator object |
参数解释: 提示词信息包含评估过程中的提示词内容。 取值范围: 不涉及。 |
|
receive_chat_history |
Boolean |
参数解释: 标识是否需要接收对话历史。 取值范围: true (是), false (否)。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
json_schema |
String |
参数解释: JSON入参描述输入参数的数据结构。 取值范围: 符合JSONSchema标准的字符串。 |
|
key |
String |
参数解释: 关键字用于标识和引用输入参数。 取值范围: 合法的参数标识符。 |
|
support_content_types |
Array of strings |
参数解释: 支持的类型标识参数可以处理的数据格式。 取值范围: 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
json_schema |
String |
参数解释: JSON出参描述输出返回值的数据结构。 取值范围: 符合JSONSchema 标准的字符串。 |
|
key |
String |
参数解释: 关键字用于标识输出参数。 取值范围: 合法的参数标识符。 |
|
support_content_types |
Array of strings |
参数解释: 支持的类型标识输出参数可以返回的格式。 取值范围: 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
message_list |
Array of message_list objects |
参数解释: prompt 信息列表包含各种角色提示词。 取值范围: 不涉及。 |
|
model_config |
model_config object |
参数解释: 模型配置定义使用的模型参数。 取值范围: 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
content |
content object |
参数解释: prompt 内容包含文本和格式信息。 取值范围: 不涉及。 |
|
role |
Integer |
参数解释: 角色标识消息发送者的身份。 取值范围: 1 (系统), 2 (用户)。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
content_type |
String |
参数解释: 类型标识提示词内容的表现形式。 取值范围: Text。 |
|
format |
Integer |
参数解释: 格式标识提示词内容的结构化形式。 取值范围: 不涉及。 |
|
text |
String |
参数解释: 提示词的具体文本信息。 取值范围: 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
max_tokens |
Integer |
参数解释: 最大Token限制模型生成长度。 取值范围: 由具体模型能力决定。 |
|
model_id |
String |
参数解释: 模型的唯一标识符。 取值范围: 系统预置的模型ID。 |
|
model_name |
String |
参数解释: 模型的显示名称。 取值范围: 不涉及。 |
|
temperature |
Float |
参数解释: 温度控制生成内容的随机性。 取值范围: 不涉及。 |
|
top_p |
Float |
参数解释: 核采样控制词汇选择范围。 取值范围: 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
benchmark |
String |
参数解释: 评估器的测试标准或参考系。 取值范围: 不涉及。 |
|
user_manual_url |
String |
参数解释: 指向评估器用户手册的网址。 取值范围: 不涉及。 |
|
vendor |
String |
参数解释: 评估器的提供方标识。 取值范围: 不涉及。 |
|
vendor_url |
String |
参数解释: 供应商的官方网址。 取值范围: 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
BusinessScenario |
Array of strings |
参数解释: 业务场景标签。 取值范围: 不涉及。 |
|
Category |
Array of strings |
参数解释: 类型标签标识技术领域。 取值范围: 不涉及。 |
|
Name |
Array of strings |
参数解释: 名字标签标识功能特点。 取值范围: 不涉及。 |
|
Objective |
Array of strings |
参数解释: 目标标签反映核心价值。 取值范围: 不涉及。 |
|
TargetType |
Array of strings |
参数解释: 目标类型标签标识处理对象。 取值范围: 不涉及。 |
请求示例
通过模板ID获取评估器模板的详细配置、预设参数及 Prompt 示例。
GET https://*.com/agentarts/v1/ops/evaluator-templates/tpl-9876543210
响应示例
状态码:200
获取评估器模板信息成功
{
"template" : {
"base_info" : {
"created_at" : "2026-04-10T16:58:00Z",
"created_by" : {
"user_id" : "user_id",
"name" : "name",
"avatar_url" : "avatar_url"
},
"updated_at" : "2026-04-10T17:30:00Z",
"updated_by" : {
"user_id" : "user_id",
"name" : "name",
"avatar_url" : "https://example.com/avatar.png"
}
},
"description" : "输出是否引用了文本中的真实引用",
"evaluator_content" : {
"input_schemas" : [ {
"json_schema" : "{\"type\": \"string\"}",
"key" : "input",
"support_content_types" : [ "Text" ]
} ],
"output_schemas" : [ {
"json_schema" : "{\"type\": \"number\"}",
"key" : "score",
"support_content_types" : [ "Text" ]
} ],
"prompt_evaluator" : {
"message_list" : [ {
"content" : {
"content_type" : "Text",
"format" : 1,
"text" : "string"
},
"role" : 1
} ],
"model_config" : {
"max_tokens" : 4096,
"model_id" : "1749615103",
"model_name" : "豆包·1.6·自动深度思考",
"temperature" : 0.1,
"top_p" : 0.7
}
},
"receive_chat_history" : false
},
"evaluator_info" : {
"benchmark" : "",
"user_manual_url" : "",
"vendor" : "CozeLoop",
"vendor_url" : ""
},
"evaluator_type" : 1,
"name" : "相关性",
"popularity" : "700",
"tags" : {
"zh-CN" : {
"BusinessScenario" : [ "AIGC" ],
"Category" : [ "LLM" ],
"Name" : [ "相关性" ],
"Objective" : [ "内容质量" ],
"TargetType" : [ "文本" ]
}
},
"template_id" : "20260126"
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
获取评估器模板信息成功 |
错误码
请参见错误码。