文档首页/ 园区智能体 CampusGo/ API参考/ 云上服务API/ 云上遗留物检测/ 创建云上遗留物检测作业
更新时间：2022-03-17 GMT+08:00
查看PDF
分享

创建云上遗留物检测作业

功能介绍

该API可分析实时视频流，提供了遗留物检测功能。当视频流中检测到遗留物时，会上报告警信息。

  • 视频编码格式要求为H264或者H265。不强制要求每一路视频的编码都一致，也不强制要求每路视频分辨率一致。

调试

您可以在API Explorer中调试该接口。

URI

  • URI格式 
    POST /v2/{project_id}/services/c-abandon-detection-cloud/tasks
  • 参数说明

    参数

    是否必选

    类型

    说明

    project_id

    是

    String

    服务所在区域对应的项目ID，获取方法请参见获取项目ID。

请求

  • 请求样例（VIS输入+DIS输出） 
    POST /v2/6204a5bd270343b5885144cf9c8c158d/services/c-abandon-detection-cloud/tasks
{
    "name": "abandon-cloud-task",
    "input": {
        "type": "vis",
        "data": [
            {
                "stream_name": "vis-campusgo",
                "index": 0
            }
        ]
    },
    "output": {
        "dis": {
            "stream_name": "dis-campusgo"
        }
    },
    "service_version": "3.0",
    "resource_order_id": "840a5cf90d4a4bbaa71f251dfe8fe64e", 
    "service_config": {
        "common": {
            "detection_min_size": 50,
            "alert_time_threshold": 10,
            "alert_detection_interval": 5,
            "image_compression_ratio": 80,
            "target_roi": "{\"polygons\":[{\"data\":[[84,389],[1840,349],[1824,526],[78,526]]}]}",
            "render_result_sw": 1,
            "render_roi_sw": 1
       }
   }
}
  • 参数说明

    参数

    是否必选

    类型

    说明

    name

    是

    String

    作业名称，只能由中文、字母（a～zA～Z）、数字（0～9）、中划线（-）、下划线（_）组成，长度范围为[1，100]。

    description

    否

    String

    作业描述信息，最大长度为500字符长度。

    input

    是

    Object
    视频数据输入列表，目前云上遗留物检测支持以下输入类型：
    • vis：从视频接入服务中读取视频数据。

    详细参数定义参见task.input（任务输入参数）。

    service_version

    是

    String

    功能版本号，版本号为3.0。

    resource_order_id

    是

    String

    购买的算法能力包ID，在服务界面购买算法能力包获取。

    output

    是

    Object

    结果数据的输出列表，目前支持将结果输出到您指定的通道中，输出类型为“dis”。

    详细参数定义参见task.output（任务输出参数）。

    service_config

    否

    Object

    服务的算法配置，配置参数见ServiceConfig参数说明。
  • service_config中common参数说明

    字段

    是否必选

    类型

    说明

    detection_min_size

    否

    Int

    对应控制台的界面参数“检测目标最小像素值”。

    检测目标的长宽最小像素值，与分辨率成正比，在1080p分辨率下，取值范围为[50, 400]，默认值为50。

    alert_time_threshold

    否

    Int

    对应控制台的界面参数“告警时间阈值”。

    遗留物告警时间阈值，目标产生告警时的遗留时间不少于该时间。

    单位为秒，取值范围[10, 300]，默认值为10。

    alert_detection_interval

    否

    Int

    对应控制台的界面参数“检测周期”。

    遗留物告警检测周期。如果在一个周期内有多个告警，则合并为一个告警。

    单位为秒，取值范围为[1, 150]，默认值为5，建议取值范围为[1, alert_time_threshold/2]。

    image_compression_ratio

    否

    Int

    对应控制台的界面参数“图片压缩比”。

    图片压缩百分比，取值范围为[20，100]。

    默认值：90，表示图片压缩比为90%。

    target_roi

    否

    String

    对应控制台的界面参数“检测区域设置”。

    表示检测区域，该字段为JSON格式的字符串，API调用时需要加转义符。详细JSON格式参见target_roi（目标区域）。

    例如：

    {"polygons":[{"data":[[84,389],[1840,349],[1824,526],[78,526]]}]}

    参数没有携带时，默认区域为整个视频帧。

    render_result_sw

    否

    Int

    对应控制台的界面参数“目标框渲染开关”。

    输出图像是否绘制告警目标边框，取值范围:

    • "0"：表示不绘制。
    • "1"：表示用红色绘制告警目标边框。

    默认值为0。

    render_roi_sw

    否

    Int

    对应控制台的界面参数“检测区域渲染开关”。

    输出图像是否绘制检测区域，取值范围:

    • "0"：表示不绘制。
    • "1"：表示用黄色绘制用户设定区域。

    默认值为0。

响应

  • 响应样例 
    [
  { 
    "id": "3d7c81cf35784d88a4e26066bcc5debd"
  }
]
  • 返回作业ID列表

    参数

    类型

    说明

    id

    String

    作业ID。

统计结果

  • 输出JSON数据流到DIS指定的通道，包括告警结构化数据和图片数据。
  • JSON结果示例 
    {
    "event_type": 327680,
    "timestamp": 1581753322,
    "stream_id":"vis-campusgo",
    "message_id":"849D1326-4FC8-11EA-8F73-0242AC110004",
    "image_base64":"/9j/4AAQSkZJRgA...",
    "task_id":"3d7c81cf35784d88a4e26066bcc5debd",
    "data":{
        "event_set":[
            {
                "bounding_box": {
                    "x": 931,
                    "y": 576,
                    "w": 307,
                    "h": 124
                },
                "target_remaining_time": "10",
                "detection_id":"83BFC020-4FC8-11EA-9F93-0242AC110004"
            }
        ]
    }
}

  • JSON格式说明

    字段

    类型

    说明

    stream_id

    String

    该字段为VIS视频流名称。

    event_type

    Uint64

    快速标识遗留物检测服务的输出消息类型，其值固定为327680, 对应16进制为 0x 0000 0000 0005 0000

    task_id

    String

    作业ID。

    message_id

    String

    告警ID，生成的唯一告警事件UUID

    timestamp

    Uint64

    触发告警时间点的时间戳。

    image_base64

    String

    告警时刻输入的视频图像的Base64编码结果。

    data

    Object

    业务输出内容
    • data参数格式说明

      字段

      类型

      说明

      event_set

      List<Object>

      输出事件列表。
    • event_set参数格式说明

      字段

      类型

      说明

      bounding_box

      Object

      告警输出对象的矩形框。

      target_remaining_time

      Int

      目标停留时间，单位为秒。

      说明：

      目标停留时间：目标被检测到至目标上报告警的时间差。

      detection_id

      String

      告警目标对应的UUID。
    • bounding_box参数格式说明

      字段

      类型

      说明

      x

      Int

      矩形框左上角横坐标

      y

      Int

      矩形框左上角纵坐标

      w

      Int

      矩形框宽度

      h

      Int

      矩形框高度

返回值

  • 正常

    201

  • 异常

    返回值

    说明

    400 Bad Request

    请求错误，具体返回错误码请参考错误码。

    401 Unauthorized

    鉴权失败。

    403 Forbidden

    没有操作权限。

    404 Not Found

    找不到资源。

    500 Internal Server Error

    服务内部错误

    503 Service Unavailable

    服务不可用。
父主题： 云上遗留物检测

相关文档