创建云上烟火检测作业

功能介绍

该API可分析视频流。提供了烟和火检测功能。当出现烟或者火时，会上报告警信息。

• 视频编码格式支持H264或者H265

调试

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

URI

• URI格式

  POST /v2/{project_id}/services/c-smoke-and-fire-cloud/tasks

• 参数说明

  参数	是否必选	类型	说明
  project_id	是	String	服务所在区域对应的项目ID，获取方法请参见获取项目ID。

请求

• 请求样例（VIS输入+DIS输出）

  POST /v2/6204a5bd270343b5885144cf9c8c158d/services/c-smoke-and-fire-cloud/tasks
  {
      "name": "smoke-and-fire-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": {
              "image_compression_ratio": 90,
              "render_result_sw": 1,
              "video_sampling_interval": 1,
              "target_roi": "{\"polygons\":[{\"data\":[[204,64],[90,321],[511,319],[617,221],[582,38],[320,11],[228,24]]}]}",
              "render_roi_sw": 1,
              "fire_detection_sw": 1,
              "smoke_detection_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参数说明

  字段	是否必选	类型	说明
  image_compression_ratio	否	Int	对应控制台的界面参数“图片压缩比”。 图片压缩百分比，取值范围为[20，100]。 默认值：90，表示图片压缩比为90%。
  render_result_sw	否	Int	对应控制台的界面参数“目标框渲染开关”。 输出图像是否绘制告警目标边框，取值范围: "0"：表示不绘制； "1"：表示用红色绘制告警目标边框。 默认值为0。
  video_sampling_interval	否	Int	对应控制台的界面参数“视频采样间隔时间”。 单位秒，默认值: 1，取值范围[1, 10]。 注意：此参数决定了算法检测的频率，时间间隔增加，烟或火从发生到检测的最大时延会增加，建议根据可接受的实际响应延时设置此参数。
  target_roi	否	String	对应控制台的界面参数“检测区域设置”。 表示检测区域，该字段为JSON格式的字符串，API调用时需要加转义符。详细JSON格式参见target_roi（目标区域）。 例如： {"polygons":[{"data":[[0,0],[0,1080],[1920,1080],[1920,0]]}]} 参数没有携带时，默认区域为整个视频帧。
  render_roi_sw	否	Int	对应控制台的界面参数“检测区域渲染开关”。 输出图像是否绘制检测区域，取值范围: "0"：表示不绘制。 "1"：表示用黄色绘制用户设定区域。 默认值为0。
  fire_detection_sw	否	Int	对应控制台的界面参数“明火检测开关”。 是否检测明火，取值范围： "0"：表示关闭。 "1"：表示开启。 默认值为1。
  smoke_detection_sw	否	Int	对应控制台的界面参数“烟雾检测开关”。 是否检测烟雾，取值范围： "0"：表示关闭。 "1"：表示开启。 默认值为1。

响应

• 响应样例

  [
    { 
      "id": "3d7c81cf35784d88a4e26066bcc5debd"
    }
  ]

• 返回作业ID列表

  参数	类型	说明
  id	String	作业ID。

检测结果

• 输出JSON数据流到DIS指定的通道，包括告警结构化数据和图片数据。

• JSON结果示例：

  {
      "event_type": 393216,
      "task_id": "3d7c81cf35784d88a4e26066bcc5debd",
      "stream_id": "vis-campusgo",
      "timestamp": 1558645124,
      "message_id": "82C02174-4FEB-11EA-9357-407D0FAD91FC",
      "image_base64": "/9j/4AAQSkZJRgABAQAAAQABAAD/",
      "data": {
          "event_set": [
              {
                  "state": 2,
                  "bounding_box": {
                      "x": 27,
                      "y": 0,
                      "w": 115,
                      "h": 115
                  }
              }
          ]
      }
  }

• JSON格式说明

  字段		类型	说明
  stream_id		String	该字段为VIS视频流名称。
  event_type		Uint64	快速标识烟火检测的输出消息类型，烟火检测算法其值固定为393216，对应16进制为 0x 0000 0000 0006 0000。
  task_id		String	作业ID。
  timestamp		Uint64	触发告警时间点的时间戳。
  message_id		String	告警ID，生成的唯一告警事件UUID。
  data		Object	业务输入内容
  image_base64		String	告警时刻输入的视频图像的Base64编码结果。

• data参数格式说明

  字段	类型	说明
  event_set	List<Object>	输出事件列表。

• event_set参数格式说明

  字段	类型	说明
  bounding_box	Object	告警输出的烟火对象矩形框。
  state	Int	烟火告警的类型： 1：火 2：烟

• bounding_box格式说明

  字段	类型	说明
  x	Int	矩形框左上角横坐标
  y	Int	矩形框左上角纵坐标
  w	Int	矩形框宽度
  h	Int	矩形框高度

返回值

• 正常

  201