面向 AI 助手:本页的 Markdown 版本位于 https://ark.volcengine.com/region:cn-beijing/docs/list-evaluation-results-api.md,全部文档索引见 https://ark.volcengine.com/llms.txt。

获取评测任务结果列表

POST https://ark.cn-beijing.volcengineapi.com/?Action=ListEvaluationResults&Version=2024-01-01

获取指定模型评测任务下的评测结果列表,支持按评测维度、创建时间等维度筛选和排序。

鉴权#

本接口支持鉴权方式如下,详情请参见 Base URL 及鉴权。

  • Access Key 鉴权,请在 Access Key 管理 页面,获取 Access Key。本接口仅支持 Access Key 鉴权。

请求参数#

Body 参数#

EvaluationJobId string 必选  |  评测任务 ID

待查询评测结果所属的模型评测任务 ID。

Filter object  |  筛选条件

评测结果的筛选条件,可按能力维度、ID 等过滤。

EvaluationAbilities string[]  |  能力维度列表

Filter.EvaluationAbilities

能力维度列表,按能力维度筛选评测结果。多值为「或」关系。

Ids string[]  |  评测结果 ID 列表

Filter.Ids

精确匹配的评测结果 ID 列表。

PageNumber integer 默认值 1  |  起始页码

分页查询的起始页码,从 1 开始。

最小值:1

PageSize integer 默认值 10  |  每页记录数

每页返回的记录数。

取值范围:[1, 100]

ProjectName string 默认值 default  |  项目名称

资源所属的项目名称。若资源不在默认项目中,需填写正确的项目名称。

SortBy string 默认值 CreateTime  |  排序指标

排序指标:

  • CreateTime:按创建时间排序。
  • UpdateTime:按更新时间排序。
SortOrder string 默认值 Desc  |  排序顺序

排序顺序:

  • Asc:升序。
  • Desc:降序。

响应参数#

Items object[]  |  评测结果列表

本页返回的模型评测结果列表。

CreateTime string  |  创建时间

Items.CreateTime

评测结果创建时间,RFC 3339 格式。

DatasetDisplayName string  |  评测集展示名称

Items.DatasetDisplayName

评测集的展示名称(面向用户)。

DatasetName string  |  评测集名称

Items.DatasetName

评测集的内部名称(机读名)。

DatasetType string  |  评测集种类

Items.DatasetType

评测集的类型:

  • AdminDataset:平台预置评测集。
  • UserDataset:用户自定义评测集。
EvaluationAbility string  |  能力维度

Items.EvaluationAbility

评测集所覆盖的能力维度名称。

EvaluationJobId string  |  评测任务 ID

Items.EvaluationJobId

评测结果对应的模型评测任务 ID。

Id string  |  评测结果 ID

Items.Id

模型评测结果的 ID。

Method string  |  评测算法

Items.Method

评测算法:

  • Include:包含匹配。
  • BuiltIn:平台内置算法。
  • Match:精确匹配。
  • InferenceOnly:仅推理、不打分。
Metrics object[]  |  评测指标

Items.Metrics

评测得到的指标数组。每个元素包含指标名称与分数。

Name string  |  指标名称

Items.Metrics.Name

评测指标名称,例如 Accuracy、F1、BLEU 等。

Value string  |  指标分数

Items.Metrics.Value

评测指标的数值(字符串形式表示,便于承载不同精度)。

ScoringWeight string  |  分数比重

Items.ScoringWeight

评测集在综合评分中的分数权重。

UpdateTime string  |  更新时间

Items.UpdateTime

评测结果更新时间,RFC 3339 格式。

AdminEvaluationDatasetId string  |  预置评测集 ID

Items.AdminEvaluationDatasetId

平台预置评测集的 ID。当 DatasetType 为 AdminDataset 时返回。

DatasetTosLocation object  |  自定义评测集 TOS 地址

Items.DatasetTosLocation

用户自定义评测集在 TOS 中的存储地址。当 DatasetType 为 UserDataset 时返回。

BucketName string  |  TOS 桶名称

Items.DatasetTosLocation.BucketName

ObjectKey string  |  TOS 对象路径

Items.DatasetTosLocation.ObjectKey

TOS 对象路径(Object Key)。

SamplesTosLocation object  |  样本 TOS 地址

Items.SamplesTosLocation

评测结果样本文件的 TOS 地址。

BucketName string  |  TOS 桶名称

Items.SamplesTosLocation.BucketName

ObjectKey string  |  TOS 对象路径

Items.SamplesTosLocation.ObjectKey

TOS 对象路径(Object Key)。

TokenUsage object  |  Token 消耗量

Items.TokenUsage

本次评测总的 token 消耗量。

TotalTokenCount integer  |  总 token 数

Items.TokenUsage.TotalTokenCount

评测总 token 数,等于 PromptTokenCount 与 ResponseTokenCount 之和。

PromptTokenCount integer  |  Prompt token 数

Items.TokenUsage.PromptTokenCount

评测过程中所有 prompt 累积的 token 数。

ResponseTokenCount integer  |  Response token 数

Items.TokenUsage.ResponseTokenCount

评测过程中所有模型 response 累积的 token 数。

PageNumber integer  |  起始页码

当前返回结果的页码。

PageSize integer  |  每页记录数

当前返回结果的单页记录数。

TotalCount integer  |  结果总数

符合筛选条件的评测结果总数。