评价报告接口
3.4 评价报告接口¶
3.4.1 创建评价报告¶
Path: /api-evaluation/evaluations
Method: POST
Headers:Headers
请求参数¶
| 参数名称 | 传参格式 | 说明 | 是否必填 | 类型 |
|---|---|---|---|---|
| body | body | 评价报告信息 | Yes | Evaluation |
返回数据¶
| Code | 说明 | 类型 |
|---|---|---|
| 200 | OK | Evaluation |
3.4.2 获取单个评价报告¶
Path: /api-evaluation/evaluations
Method: GET
Headers:Headers
请求参数¶
| 参数名称 | 传参格式 | 说明 | 是否必填 | 类型 |
|---|---|---|---|---|
| taskId | query | 任务id,任务id和测试集id只能传一个 | No | string |
| suiteId | query | 测试集id | No | string |
返回数据¶
| Code | 说明 | 类型 |
|---|---|---|
| 200 | OK | Evaluation |
3.4.3 批量获取评价报告状态¶
Path: /api-evaluation/evaluations/status
Method: GET
Headers:Headers
请求参数¶
| 参数名称 | 传参格式 | 说明 | 是否必填 | 类型 |
|---|---|---|---|---|
| taskIds | query | 任务id字符串,taskIds和suiteId只能传一个 | No | string |
| suiteIds | query | 测试集id字符串 | No | string |
返回数据¶
| Code | 说明 | 类型 |
|---|---|---|
| 200 | OK | object |
3.4.4 删除单个评价报告¶
Path: /api-evaluation/evaluations/{id}
Method: DELETE
Headers:Headers
请求参数¶
| 参数名称 | 传参格式 | 说明 | 是否必填 | 类型 |
|---|---|---|---|---|
| id | path | 报告id | Yes | string |
返回数据¶
| Code | 说明 |
|---|---|
| 204 | No content |
3.4.5 触发规控评价¶
Path: /api-evaluation/evaluations/evaluate
Method: POST
Headers:Headers
请求参数¶
| 参数名称 | 传参格式 | 说明 | 是否必填 | 类型 | 备注 |
|---|---|---|---|---|---|
| body | body | 包含测试集id和预设id或算子id | Yes | { suiteId: string; presetId?: number; algorithmId?: string } | 3.7.0 |
返回数据¶
| Code | 说明 | 类型 |
|---|---|---|
| 200 | OK | object |
3.4.6 查看评价服务是否正常¶
Path: /api-evaluation/health
Method: GET
Headers:Headers
返回数据¶
| Code | 说明 | 类型 |
|---|---|---|
| 200 | OK | { "code": number, "data": { "message": string } } |