简介

本文档主要针对需要集成HTTP API的技术研发工程师,从图片中识别设备,提取设备信息。

接口能力

接口名称 英文名称 请求方式 API地址
设备信息OCR DeviceTextOCR GET http://192.168.0.19:50001/v1/cv/DeviceTextOCR

参数说明

请求参数

参数名称(英文) 是否必选 数据类型 示例数据 描述
token string 340611b2014541c98ca14737f3892c79 用户标识
picture binary 001001010001010110110110 图片的base64格式编码

请求参数示例

{
    "token": "340611b2014541c98ca14737f3892c79",
    "picture": "001001010001010110110110"
}

响应参数(成功)

参数名称(英文) 是否必选 数据类型 示例数据 描述
success int 0 返回码,0表示请求成功
message string ok "ok"表示返回有效消息
total int 2 2表示检测到2个设备
data array 返回数据;success为0时有意义,total不为0时候结构非空。
 detected object 检测文本对象
  name string XX 设备名称
  vendor string Nokia 制造商
  voltage string 12V 额定电压

响应参数(失败)

参数名称(英文) 是否必选 数据类型 示例数据 描述
success int 1 返回码,1表示请求失败
message string error "error"表示返回无效消息
total int 0 0表示检测到0个设备
data array total为0时候结果为空,返回空列表。

响应参数示例

{
    "success": 0,
    "message": "ok",
    "total": 2,
    "data": [{
        "name": "XX",
        "vendor": "Nokia",
        "voltage": "12V"
    }, {
        "name": "YY",
        "vendor": "Huawei",
        "voltage": "12V"
    }]
}