附录：通用请求头 & 类型¶
通用请求头¶
Headers¶
| 参数名称 | 类型 | 说明 | 是否必填 | 备注 |
|---|---|---|---|---|
| Authorization | string | 用于权限验证的token | Yes | |
| projectId | string | 默认值："default" |
Yes | 3.7.0 |
通用响应¶
Response¶
| 参数名称 | 类型 | 说明 | 是否必填 |
|---|---|---|---|
| data | { "code": number} | Yes |
相关类型¶
3.1 测试集接口相关类型¶
Suite¶
测试集
| 参数名称 | 类型 | 说明 | 是否必填 |
|---|---|---|---|
| id | string | 测试集id | Yes |
| name | string | 测试集名称 | Yes |
| withEvaluation | boolean | 是否能评价 | Yes |
| presetId | number | 当前预设 | No |
| algorithmName | string | 当前算法名称 | No |
| algorithmVersion | string | 当前算法版本 | No |
| startTime | number | 测试集开始时间 | Yes |
| endTime | number | 测试集结束时间 | No |
SuiteResponse¶
测试集响应
| 参数名称 | 类型 | 说明 | 是否必填 |
|---|---|---|---|
| total | number | 总数 | Yes |
| suites | [ Suite ] | 测试集列表 | Yes |
3.2 任务接口相关类型¶
Task¶
任务
| 参数名称 | 类型 | 说明 | 是否必填 |
|---|---|---|---|
| id | string | 任务id | Yes |
| name | string | 任务名称 | Yes |
| suiteId | string | 所属测试集id | Yes |
| map | string | 地图id | No |
| mapName | string | 地图名 | No |
| vehicle | string | 主车id | No |
| controller | string | 控制器id | No |
| algorithmName | string | 算法名称 | No |
| algorithmVersion | string | 算法版本 | No |
| presetId | number | 当前预设id | No |
| startTime | number | 任务开始时间 | Yes |
| endTime | number | 任务结束时间 | No |
TaskResponse¶
任务响应
| 参数名称 | 类型 | 说明 | 是否必填 |
|---|---|---|---|
| total | number | 总数 | Yes |
| tasks | [ Task ] | 任务列表 | Yes |
3.3 评价预设接口相关类型¶
Preset¶
评价预设
| 参数名称 | 类型 | 说明 | 是否必填 | 备注 |
|---|---|---|---|---|
| id | number | 预设id | Yes | |
| name | string | 预设名称 | Yes | |
| data | [ object ] | 预设数据 | Yes | |
| builtIn | boolean | 是否内置 | No | |
| algorithmId | string | 算子id | No | 3.7.0 |
| algorithm | Algorithm | 算法数据 | No | 3.7.0 |
PresetResponse¶
评价预设响应
| 参数名称 | 类型 | 说明 | 是否必填 |
|---|---|---|---|
| code | number | 状态码 | Yes |
| data | Preset | 预设数据 | Yes |
PresetsResponse¶
评价预设集响应
| 参数名称 | 类型 | 说明 | 是否必填 |
|---|---|---|---|
| code | number | 状态码 | Yes |
| data | { presets: [ Preset ] , total: number } | 预设数据 | Yes |
PresetImportResponse¶
评价预设导入响应
| 参数名称 | 类型 | 说明 | 是否必填 |
|---|---|---|---|
| code | number | 状态码 | Yes |
| data | { reason: string } | 失败原因 | Yes |
3.4 评价报告接口相关类型¶
Evaluation¶
评价报告
| 参数名称 | 类型 | 说明 | 是否必填 |
|---|---|---|---|
| name | string | 报告名称 | Yes |
| type | string | 报告枚举类型："task" | "suite" |
Yes |
| status | string | 报告状态 | Yes |
| suiteId | string | 测试集id | Yes |
| taskId | string | 任务id | No |
| presetId | number | 预设id | Yes |
| presetName | string | 预设名称 | No |
| presetVersionId | number | 预设版本id | Yes |
| score | number | 评价得分 | No |
| data | object | 报告数据 | Yes |
3.5 评价算子接口相关类型¶
Algorithm¶
评价算子
| 参数名称 | 类型 | 说明 | 是否必填 |
|---|---|---|---|
| id | string | 算子id | Yes |
| name | string | 算子名称 | Yes |
| description | string | 算子描述 | No |
| version | string | 算子版本 | Yes |
| type | string | 算子类型 | No |
| params | [ object ] | 算子数据 | Yes |
| presets | [ Preset ] | 关联的评价预设 | No |
AlgorithmResponse¶
评价算子响应
| 参数名称 | 类型 | 说明 | 是否必填 |
|---|---|---|---|
| code | number | 状态码 | Yes |
| data | Algorithm | 算子数据 | Yes |
AlgorithmsResponse¶
评价算子集响应
| 参数名称 | 类型 | 说明 | 是否必填 |
|---|---|---|---|
| data | { algorithms: [ Algorithm ] , total: number } | 算子数据 | Yes |