# 查询模型优化任务指标列表 - ListOpsModelTuningTaskMetrics
#### 功能介绍
本接口用于拉取模型优化任务训练过程中产生的核心评估指标数据，通常按迭代步数（Step/Epoch）时序返回。
适用场景：
在任务结束后，查看详细的训练指标数据，用于生成实验报告或对比不同超参数配置的训练效果。
#### 调用方法
请参见[如何调用API](https://support.huaweicloud.com/api-agentarts/agentarts_07_0003.html)。
#### 授权信息
账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见[权限和授权项](https://support.huaweicloud.com/api-agentarts/Permission.html)。
| 授权项                                                       | 访问级别 | 资源类型（\*为必须）          | 条件键                     | 别名    | 依赖的授权项 |
|:---|:---|:---|:---|:---|:---|
| agentarts:modelTuningTask:listOpsModelTuningTaskMetrics | List  | modelTuningTask \* | g:ResourceTag/\<tag-key\> | - | -     |
   
#### URI
GET /v1/ops/model-tuning-tasks/{task_id}/metrics
表1路径参数 
| 参数      | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|:---|:---|:---|:---|
| task_id | 是    | String | **参数解释：** 模型优化任务ID，标识任务的唯一标识符。获取方法请参考[查询模型优化任务列表 - ListOpsModelTuningTasks](https://support.huaweicloud.com/api-agentarts/ListOpsModelTuningTasks.html)。 **约束限制：** 不涉及 **取值范围：** 长度为32的ID字符串，最小长度32，最大长度32。 **默认取值：** 无 |
   
表2Query参数 
| 参数     | 是否必选 | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|:---|:---|:---|:---|
| offset | 否    | Integer | **参数解释：** 索引位置偏移量，用于指定从第几条记录开始返回，单位：条（记录数）。 **约束限制：** 不涉及 **取值范围：** 大于等于0且小于等于100000的整数。 **默认取值：** 0 |
| limit  | 否    | Integer | **参数解释：** 查询记录数，表示单页返回的最大任务数，单位：条。 **约束限制：** 不涉及 **取值范围：** 1到100的正整数。 **默认取值：** 10                 |
   
#### 请求参数
无
#### 响应参数
**状态码：200**
表3响应Body参数 
| 参数      | 参数类型                                                                                                 | 描述                                                                                                                                                                                                              |
|:---|:---|:---|
| total   | Integer                                                                                              | **参数解释：** 满足条件的指标记录总数，用于计算分页总页数，单位：条。 **取值范围：** 大于等于0的整数。          |
| metrics | Array of [OpsTuningStepMetric] objects | **参数解释：** 当前分页下的训练指标详情列表，符合OpsTuningStepMetric定义的对象数组。 **取值范围：** 不涉及。 |
   
 表4OpsTuningStepMetric 
| 参数               | 参数类型    | 描述                                                                                                                                                                                                     |
|:---|:---|:---|
| step             | Integer | **参数解释：** 训练迭代步数，单位：step。 **取值范围：** 大于等于0的整数。       |
| reward_value     | Double  | **参数解释：** 在该步数下计算得出的奖励值，反映模型生成结果的质量。 **取值范围：** 浮点数。 |
| eval_reward_value | Double  | **参数解释：** 在该步数下计算得出验证集上的奖励值，反映模型生成结果的质量。 **取值范围：** 浮点数。  |
| time_consume     | Double  | **参数解释：** 该步数的耗时时长，单位：分钟。 **取值范围**： 大于等于0的浮点数。      |
| response_length  | Double  | **参数解释：** 模型在该步数生成的平均响应长度。 **取值范围：** 大于等于0的浮点数。     |
| loss_value          | Double      | **参数解释：** 训练loss值。 **取值范围：** 浮点数。                            |
| eval_loss_value    | Double    | **参数解释：** 验证loss值。 **取值范围：** 浮点数。                         |
   
**状态码：400**
表5响应Body参数 
| 参数         | 参数类型   | 描述                                                                                                                                                                                           |
|:---|:---|:---|
| error_code | String | **参数解释：** 机器可读的错误代码。 **取值范围：** 系统错误码字符串。  |
| error_msg  | String | **参数解释：** 人类可读的错误消息。 **取值范围：** 详细错误说明字符串。 |
   
**状态码：404**
表6响应Body参数 
| 参数         | 参数类型   | 描述                                                                                                                                                                                           |
|:---|:---|:---|
| error_code | String | **参数解释：** 机器可读的错误代码。 **取值范围：** 系统错误码字符串。  |
| error_msg  | String | **参数解释：** 人类可读的错误消息。 **取值范围：** 详细错误说明字符串。 |
   
**状态码：500**
表7响应Body参数 
| 参数         | 参数类型   | 描述                                                                                                                                                                                           |
|:---|:---|:---|
| error_code | String | **参数解释：** 机器可读的错误代码。 **取值范围：** 系统错误码字符串。  |
| error_msg  | String | **参数解释：** 人类可读的错误消息。 **取值范围：** 详细错误说明字符串。 |
   
#### 请求示例
用于拉取训练过程中产生的核心评估指标数据。
```
GET /v1/ops/model-tuning-tasks/57ae91cf2f504899921a50d1c75f0547/metrics?offset=0&limit=10
```
#### 响应示例
**状态码：200**
```
{
  "total" : 3,
  "metrics" : [ {
    "step" : 100,
    "reward_value" : 0.523,
    "time_consume" : 12.5,
    "response_length" : 128,
    "loss_value" : 0.4521,
    "eval_loss_value" : 0.4823
  }, {
    "step" : 200,
    "reward_value" : 0.687,
    "time_consume" : 12.3,
    "response_length" : 142,
    "loss_value" : 0.3856,
    "eval_loss_value" : 0.4102
  }, {
    "step" : 300,
    "reward_value" : 0.742,
    "time_consume" : 12.8,
    "response_length" : 150,
    "loss_value" : 0.3214,
    "eval_loss_value" : 0.3456
  } ]
}
```
#### 状态码
| 状态码 | 描述         |
|:---|:---|
| 200 | 调优过程指标结果。  |
| 400 | 无效的请求参数。   |
| 404 | 模型优化任务未找到。 |
| 500 | 内部服务器错误。   |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-agentarts/ErrorCode.html)。
