查询技能列表
更新时间：2023-09-19
接口描述
本接口用于查询当前支持的全部技能列表。查询到的技能可以用于构建视频分析流。
请求结构
GET /console/api/v1/ai/query
请求头域
| 请求头名称 | 描述 | 示例 |
|---|---|---|
| Authorization | 认证头。登录响应返回的token内容，如果不填或者填错会拒绝请求 | Authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyTmFtZSI6ImFkbWluIiwiZXhwIjoxNjY3NDc4OTc4fQ.JL9R7CqIhPFdQWZry4e9ONZntUTmNzBp0sDE05rMxl |
请求参数
无
响应头域
无特殊响应头。
响应参数
| 参数 | 类型 | 描述 |
|---|---|---|
| status | Int32 | 接口返回状态, 0表示成功，其他表示失败 |
| message | String | 成功或错误提示 |
| data | JSON | 忽略该字段 |
| value | String | 技能英文名称 |
| label | String | 技能中文名称 |
| elapse | Int32 | 默认的算法识别间隔，单位毫秒 |
| param | Array of JSON | 算法交互参数配置。数组每一项代表一组特定用途的参数，每组参数可以包括若干相关项（比如逆行区域多边形和逆行方向线可以为一组，不同组表示不同逆行区域，例如左侧车道和右侧车道各为一组）。如果没有配置，则为空。 |
| purpose | String | 该组参数的用途, 算法侧会基于该字段解析特定用途的参数值。 |
| text | String | 参数组名称，有默认值，调用者也可以修改。 |
| repeatable | Boolean | 是否允许出现多个purpose相同的组。比如多个逆行区配置，多个周界区域等。 |
| items | Array of JSON | 每组内的相关项配置集合 |
| +purpose | String | 该参数项用途。算法侧会基于该字段进行特定用途的解析。 |
| +text | String | 该参数项调用者配置的文本描述。调用者可以动态修改该值。 |
| +type | String | 该参数的前端组件类型。目前可用的包括： polygon(多边形), arrow(有向线段)，segment(线段），integer(整数), float(浮点数)。 |
| +attr | JSON | 参数项属性(比如取值范围，约束条件等，便于前端限制），目前暂未用到 |
请求示例
GET /console/api/v1/ai/query
Content-Type: application/json
Content-Length: 1254
Authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyTmFtZSI6ImFkbWluIiwiZXhwIjoxNjY4NjgxODg5fQ.NkjiNOeMnzP9To-CuV4F9306OH1RY0xz69RG4dstTSk响应示例
HTTP/1.1 200 OK
cache-control: no-cache
content-length: 484
content-type: application/json; charset=utf-8
date: Thu, 17 Nov 2022 00:45:02 GMT
server: nginx/1.21.6
{
"status": 0,
"message": "success",
"data": [
{
"value": "face",
"label": "人脸识别",
"param": [
{
"purpose": "filterRegion",
"text": "过滤区域",
"repeatable": true,
"items": [
{
"purpose": "filterPolygon",
"text": "filter_corridor",
"type": "polygon"
}
]
}
]
}
]
}