# 获取评测任务

> 全部文档的索引见 [llms.txt](https://ark.volcengine.com/llms.txt)；在任一文档页面地址后追加 `.md` 可获取该页的 Markdown 版本。

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

获取指定模型评测任务的详细信息，包括任务名称、状态、关联模型和评测结果存储地址等。

## 鉴权

本接口支持鉴权方式如下，详情请参见 [Base URL 及鉴权](/docs/base-url-and-authentication)。

* Access Key 鉴权，请在 [Access Key 管理](https://console.volcengine.com/iam/keymanage) 页面，获取 Access Key。本接口仅支持 Access Key 鉴权。

---

<span id="request-parameters"></span>
## 请求参数

### Body 参数

**Id** `string` `必选` | 评测任务 ID

模型评测任务的 ID。可在控制台评测任务列表页获取，或通过 *ListEvaluationJobs* 接口查询。

## 响应参数

**BatchInferenceJobId** `string` | 批量推理任务 ID

关联的批量推理任务 ID。仅当 *InferenceType* 为 `BatchInference` 时返回。

**CreateTime** `string` | 创建时间

模型评测任务的创建时间，RFC 3339 格式。

**Description** `string` | 任务描述

模型评测任务描述。

**EndpointId** `string` | 接入点 ID

评测任务对应接入点的 ID（若通过接入点指定评测对象）。

**Id** `string` | 评测任务 ID

模型评测任务的 ID。

**InferenceType** `string` | 推理类型

推理类型：

- `BatchInference`：批量推理。
- `ChatInference`：在线推理。

**ModelReference** `object` | 评测对象

评测对象（模型）的引用信息，包含基础模型或定制模型的引用。

**CustomModelId** `string` | 定制模型 ID

`ModelReference.CustomModelId`

定制模型的 ID。

**FoundationModel** `object` | 基础模型

`ModelReference.FoundationModel`

基础模型引用。

**ModelVersion** `string` | 基础模型版本

`ModelReference.FoundationModel.ModelVersion`

基础模型版本号。

**Name** `string` | 基础模型名称

`ModelReference.FoundationModel.Name`

**Name** `string` | 任务名称

模型评测任务名称。

**ProjectName** `string` | 所属项目

评测任务所属的项目名称。

**ResultTosLocation** `object` | 评测结果 TOS 地址

评测任务运行成功后，评测结果的 TOS 存储地址。

**BucketName** `string` | TOS 桶名称

`ResultTosLocation.BucketName`

> **说明：注意**
>
> 当前火山方舟仅支持华北 2-北京地域（`region: cn-beijing`）的 TOS 桶。

**ObjectKey** `string` | TOS 对象路径

`ResultTosLocation.ObjectKey`

TOS 对象路径（Object Key）。

**Status** `object` | 任务状态

模型评测任务的状态元信息，包含当前状态、状态更新时间与附加说明。

> **说明**
>
> 评测任务状态机一般经历：`Queued`（排队中） → `Running`（运行中） → `Succeeded`（已完成） / `Failed`（失败） / `Terminated`（已停止）。停止或失败后任务不可恢复，需重新创建。

**Phase** `string` | 任务状态

`Status.Phase`

评测任务的当前状态阶段。取值通常为 `Queued`、`Running`、`Succeeded`、`Failed`、`Terminated` 等。

**PhaseTime** `string` | 状态更新时间

`Status.PhaseTime`

任务最近一次进入当前状态的时间，RFC 3339 格式。

**Message** `string` | 状态说明

`Status.Message`

状态附加说明。当任务为 `Failed` 状态时通常包含失败原因。

**Tags** `object[]` | 任务标签

模型评测任务绑定的标签列表。

**Key** `string` | 标签键

`Tags.Key`

**Value** `string` | 标签值

`Tags.Value`

**UpdateTime** `string` | 更新时间

模型评测任务最近一次更新时间，RFC 3339 格式。


## 代码示例

## 默认

### cURL

#### Request

```bash
curl 'https://ark.cn-beijing.volcengineapi.com/?Action=GetEvaluationJob&Version=2024-01-01' \
  -H 'Content-Type: application/json' \
  -H 'X-Date: <X-Date>' \
  -H 'X-Content-Sha256: <X-Content-Sha256>' \
  -H 'Authorization: HMAC-SHA256 Credential=<AK>/<X-Date>/cn-beijing/ark/request, SignedHeaders=content-type;host;x-content-sha256;x-date, Signature=<Signature>' \
  -d '{
  "Id": "ej-20240401114848-w5b8f"
}
'
```

#### Response

```
{
  "ResponseMetadata": {
    "RequestId": "20240401115441B7A29C481EFC026D93",
    "Action": "GetEvaluationJob",
    "Version": "2024-01-01",
    "Service": "ark",
    "Region": "cn-beijing"
  },
  "Result": {
    "Id": "ej-20240401114848-w5b8f",
    "Name": "test-evaluation-job",
    "Description": "示例评测任务",
    "ModelReference": {
      "CustomModelId": "cm-20240401114541-5gzd8"
    },
    "EndpointId": "ep-20240401114848-hzfcz",
    "ResultTosLocation": {
      "ObjectKey": "ark/ej-20240401114848-w5b8f/inference_result/results/",
      "BucketName": "ark-auto-created-required-0123456789-cn-beijing"
    },
    "Status": {
      "Phase": "Succeeded",
      "PhaseTime": "2024-04-01T11:54:41Z",
      "Message": "评测任务已成功完成"
    },
    "Tags": [
      {
        "Key": "owner",
        "Value": "team-a"
      }
    ],
    "ProjectName": "default",
    "CreateTime": "2024-04-01T11:48:48Z",
    "UpdateTime": "2024-04-01T11:54:41Z"
  }
}
```