Evaluation Operator API
3.5 Evaluation Operator API (3.7.0)¶
3.5.1 Get All Operators¶
Path： /api-evaluation/algorithms/all
Method： GET
Headers：Headers
Response¶
| Code | Description | Type |
|---|---|---|
| 200 | OK | AlgorithmsResponse |
3.5.2 Get Paginated Operators¶
Path： /api-evaluation/algorithms
Method： GET
Headers：Headers
Request Parameters¶
| Parameter Name | Format | Description | Required | Type |
|---|---|---|---|---|
| type | query | Operator type | Yes | string |
| page | query | Current page number | No | number |
| pageSize | query | Items per page | No | number |
| keyword | query | Keyword | No | string |
Response¶
| Code | Description | Type |
|---|---|---|
| 200 | OK | AlgorithmsResponse |
3.5.3 Create a Single Operator¶
Path： /api-evaluation/algorithms
Method： POST
Headers：Headers
Request Parameters¶
| Parameter Name | Format | Description | Required | Type |
|---|---|---|---|---|
| body | body | Operator info including name, params, etc. |
Yes | Algorithm |
Response¶
| Code | Description | Type |
|---|---|---|
| 200 | OK | Response |
3.5.4 Get Multiple Operators by ID¶
Path： /api-evaluation/algorithms/byid
Method： GET
Headers：Headers
Request Parameters¶
| Parameter Name | Format | Description | Required | Type |
|---|---|---|---|---|
| ids | query | Operator IDs, comma-separated | Yes | string |
Response¶
| Code | Description | Type |
|---|---|---|
| 200 | OK | { data: [ Algorithm ] } |
3.5.5 Update a Single Operator¶
Path： /api-evaluation/algorithms/{id}
Method： PUT
Headers：Headers
Request Parameters¶
| Parameter Name | Format | Description | Required | Type |
|---|---|---|---|---|
| id | path | Operator ID | Yes | number |
| body | body | Operator info object to update | Yes | Algorithm |
Response¶
| Code | Description | Type |
|---|---|---|
| 200 | OK | Response |
3.5.6 Delete Multiple Operators¶
Path： /api-evaluation/algorithms/remove
Method： POST
Headers：Headers
Request Parameters¶
| Parameter Name | Format | Description | Required | Type |
|---|---|---|---|---|
| body | body | Array of operator IDs | Yes | [ string ] |
Response¶
| Code | Description |
|---|---|
| 204 | No content |
3.5.7 Check if an Operator Name Already Exists¶
Path： /api-evaluation/algorithms/exists/{name}
Method： GET
Headers：Headers
Request Parameters¶
| Parameter Name | Format | Description | Required | Type |
|---|---|---|---|---|
| name | path | Operator name | Yes | string |
| type | query | Operator type | Yes | "control" | "perception" |
Response¶
| Code | Description | Type |
|---|---|---|
| 200 | OK | { data: { "exists": boolean } } |