ymx-baidu-ocr
    正在准备搜索索引...

    接口 ScanRequestData

    通用扫描识别(带 UI)请求参数

    覆盖 SDK 支持的全部识别类型(含未提供专用方法的扩展类型), type 取值见 initSdk 返回的 supportedTypes,常用值如下:

    • 卡证类:
      • id_card.front
      • id_card.back
      • multi_idcard
      • bank_card
      • business_license
      • passport
      • overseas_passport
      • social_security_card
      • household_register
      • birth_certificate
      • hk_macau_tw_card
      • marriage_certificate
      • divorce_certificate
      • house_property_certificate
      • account_opening_permit
      • foreign_permanent_resident
      • business_card
    • 交通类:
      • vehicle_license
      • driving_license
      • license_plate
      • mixed_multi_vehicle
      • vin_code
      • vehicle_invoice
      • used_vehicle_invoice
      • vehicle_certificate
      • vehicle_registration_certificate
      • weight_note
      • waybill
      • road_transport_certificate
    • 通用及其他:
      • general
      • general_basic
      • accurate
      • accurate_basic
      • general_enhanced
      • web_image
      • receipt
      • vat_invoice
      • taxi_receipt
      • train_ticket
      • air_ticket
      • invoice
      • online_taxi_itinerary
      • handwriting
      • qrcode
      • numbers
      • lottery
      • custom
      • doc_analysis
      • medical_detail
    interface ScanRequestData {
        autoTimeoutMs?: number;
        captureMode?: CaptureMode;
        extraParams?: Record<string, string | number | boolean>;
        hideAlbum?: boolean;
        returnImage?: boolean;
        type: string;
    }

    层级 (查看层级一览)

    索引

    属性

    autoTimeoutMs?: number

    自动采集超时时间(毫秒),仅自动采集模式生效; 超过该时间未检测到合格画面时 SDK 触发 AUTO_CAPTURE_TIMEOUT 错误

    5000
    
    captureMode?: CaptureMode

    采集模式,身份证正面/反面自动识别请使用 idCardFrontAuto / idCardBackAuto, 或设置 captureMode: 'auto'

    manual
    
    extraParams?: Record<string, string | number | boolean>

    动态追加的识别参数(key 为云端 API 参数名)

    • 字符串值使用 putParam,布尔值使用 putBoolParam,数值使用 putNumberParam 写入
    {
    detect_direction: true,
    probability: true
    }
    hideAlbum?: boolean

    是否隐藏从相册选图的按钮,默认显示相册选图按钮,设为 true 时隐藏

    false
    
    returnImage?: boolean

    是否在返回结果中附带采集图片(JPEG 格式的 Base64 编码), 开启后会增加一次图片编码耗时,仅在业务需要展示/回传识别图片时开启

    false
    
    type: string

    识别类型(见上述说明)