文档中心
API调试

功能描述

图像质量检测

请求URL

https://api.textin.com/ai/service/v1/image_quality_inspect

HTTP请求方法(Method)

HTTP POST

请求头说明(Request Headers)

请在HTTP请求中添加以下自定义标头(Header)。

header 名
x-ti-app-id 请登录后前往 “工作台-账号设置-开发者信息” 查看 x-ti-app-id
x-ti-secret-code 请登录后前往 “工作台-账号设置-开发者信息” 查看 x-ti-secret-code

URL参数(Parameters)

URL参数指以 {参数名}={参数值} 形式拼接到 URL 上的键值对。它以 ? 开头,不同参数之间使用 & 连接。形如 ?p1=v1&p2=v2
参数名 数据类型 是否必填 允许的值 描述
crop_image integer 0, 1

1 需要返回切片区域的图片截图, 0 不需要返回

support_multi_object integer 0, 1

1 支持多目标检测,0 不支持多目标检测

blurry_threshold number 0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9

质检模糊判断的阈值参数,打开则根据设置的阈值进行质检模糊判断,并隐藏模型输出的置信度

light_spot_threshold number 0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9

质检光斑判断的阈值参数,打开则根据设置的阈值进行质检光斑判断,并隐藏模型输出的置信度

un_integrity_threshold number 0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9

质检不完整度判断的阈值参数,打开则根据设置的阈值进行质检不完整度判断,并隐藏模型输出的置信度

photocopy_threshold number 0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9

质检是否复印判断的阈值参数,打开则根据设置的阈值进行质检是否复印判断,并隐藏模型输出的置信度

screen_remark_threshold number 0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9

质检是否翻拍判断的阈值参数,打开则根据设置的阈值进行质检是否翻拍判断,并隐藏模型输出的置信度

请求体说明(Request Body)

Content-Type: application/octet-stream

要上传的图片,目前支持jpg, png, bmp, pdf, tiff, 单帧gif等大部分格式.

请注意,请求体的数据格式为文件的二进制流,非 FormData 或其他格式。文件大小不超过 10M,图像宽高须介于 20 和 10000(像素)之间。

响应体说明(Response)

Content-Type: application/json

JSON结构说明如下:

字段名 类型 描述
code integer 错误码,详见“错误码说明”
message string

错误信息

duration number

检测时间计算,时间单位是毫秒(ms)

result object

引擎所得结果的内容封装

+ image_property array

图像属性

   ++ detect_risk object

图像质量检测

    +++ risk_type array

图像质量类型

    +++ risk_details object

风险类型详情

     ++++ un_integrity object

证件是否存在完整度风险

      +++++ key string

True,False

      +++++ score number

判断质检结果为不完整的置信度,如果传入任意一个或多个阈值参数则不返回

     ++++ light_spot object

光斑

      +++++ key string

True,False

      +++++ score number

判断质检结果为光斑的置信度,如果传入任意一个或多个阈值参数则不返回

     ++++ blurry object

模糊

      +++++ key string

True,False

      +++++ score number

判断质检结果为模糊的置信度,如果传入任意一个或多个阈值参数则不返回

     ++++ photocopy object

是否复印

      +++++ key string

True,False

      +++++ score number

判断质检结果为复印的置信度,如果传入任意一个或多个阈值参数则不返回

     ++++ screen_remark object

是否翻拍

      +++++ key string

True,False

      +++++ score number

判断质检结果为翻拍的置信度,如果传入任意一个或多个阈值参数则不返回

   ++ crop_property object

切片图像信息

    +++ position object

切图在转正后图中的坐标位置, 以左上角为坐标原点。

     ++++ x1 number

左上横轴坐标

     ++++ y1 number

左上纵轴坐标

     ++++ x2 number

右上横轴坐标

     ++++ y2 number

右上纵轴坐标

     ++++ x3 number

右下横轴坐标

     ++++ y3 number

右下纵轴坐标

     ++++ x4 number

左下横轴坐标

     ++++ y4 number

左下纵轴坐标

    +++ type object

切片类别

     ++++ key string
  • id_card:二代身份证
  • bank_card:银行卡
  • passport:护照
  • driver_license:驾驶证
  • business_license:营业执照
  • medical_invoice:医疗发票
  • other:其他
    +++ crop_image string

切片区域的切边图片base64编码, 仅当url参数crop_image=1的时候有效

JSON结构示例

{
    "code": 200,
    "message": "success",
    "duration": 565,
    "result": {
        "image_property": [
            {
                "detect_risk": {
                    "risk_type": [
                        "un_integrity",
                        "light_spot",
                        "blurry",
                        "photocopy",
                        "screen_remark"
                    ],
                    "risk_details": {
                        "un_integrity": {
                            "key": "True"
                        },
                        "light_spot": {
                            "key": "True"
                        },
                        "blurry": {
                            "key": "True"
                        },
                        "photocopy": {
                            "key": "True"
                        },
                        "screen_remark": {
                            "key": "True"
                        }
                    }
                },
                "crop_property": {
                    "position": {
                        "x1": 1,
                        "y1": 1,
                        "x2": 100,
                        "y2": 1,
                        "x3": 100,
                        "y3": 100,
                        "x4": 1,
                        "y4": 100
                    },
                    "type": {
                        "key": "id_card"
                    },
                    "crop_image": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBD..."
                }
            }
        ]
    }
}

错误码说明

错误码 描述
40101 x-ti-app-id 或 x-ti-secret-code 为空
40102 x-ti-app-id 或 x-ti-secret-code 无效,验证失败
40103 客户端IP不在白名单
40003 余额不足,请充值后再使用
40004 参数错误,请查看技术文档,检查传参
40007 机器人不存在或未发布
40008 机器人未开通,请至市场开通后重试
40301 图片类型不支持
40302 上传文件大小不符,文件大小不超过 10M
40303 文件类型不支持
40304 图片尺寸不符,图像宽高须介于 20 和 10000(像素)之间
40305 识别文件未上传
30203 基础服务故障,请稍后重试
500 服务器内部错误
版本
v2.0
官方社群
TextIn 用户交流群
微信扫码加入官方用户交流群
产品咨询
问题沟通
使用交流
活动优惠
体验中心

联系我们