icu.easyj.sdk.ocr.idcardocr

Interface IIdCardOcrTemplate

All Known Subinterfaces:

IOcrTemplate

All Known Implementing Classes:

WrapperOcrTemplate

public interface IIdCardOcrTemplate

身份证识别（IDCardOCR）接口

Author:

wangliang181230

Method Summary

Modifier and Type	Method and Description
IdCardOcrResponse	idCardOcr(IdCardOcrRequest request) 身份证识别
default IdCardOcrResponse	idCardOcr(String image, CardSide cardSide, IdCardOcrAdvanced... advancedArr) 重载方法：身份证识别
default IdCardOcrResponse	idCardOcr(String image, IdCardOcrAdvanced... advancedArr) 重载方法：身份证识别（自动识别正反面）
default IdCardOcrResponse	idCardOcr(String image1, String image2, boolean returnIfHasWarn, IdCardOcrAdvanced... advancedArr) 重载方法：身份证识别（两面一起发送识别）
default IdCardOcrResponse	idCardOcr(String image1, String image2, boolean returnIfHasWarn, SimpleIdCardOcrRequest simpleRequest) 身份证识别（两面一起发送识别）
default IdCardOcrResponse	idCardOcr(String image1, String image2, IdCardOcrAdvanced... advancedArr) 重载方法：身份证识别（两面一起发送识别）

Method Detail

idCardOcr

@NonNull
IdCardOcrResponse idCardOcr(@NonNull
                                      IdCardOcrRequest request)
                               throws IdCardOcrSdkException

身份证识别

Parameters:

request - 身份证识别请求信息

Returns:

response 响应

Throws:

IdCardOcrSdkException - 身份证识别异常

idCardOcr

@NonNull
default IdCardOcrResponse idCardOcr(@NonNull
                                              String image,
                                              @Nullable
                                              CardSide cardSide,
                                              IdCardOcrAdvanced... advancedArr)
                                       throws IdCardOcrSdkException

重载方法：身份证识别

Parameters:

image - 身份证图片的Base64串或URL地址

cardSide - 正反面枚举（为空时，将自动解析正反而；不为空时，如果传入图片与该参数不符，将抛出异常）

advancedArr - 高级功能数组

Returns:

response 响应

Throws:

IdCardOcrSdkException - 身份证识别异常

idCardOcr

@NonNull
default IdCardOcrResponse idCardOcr(@NonNull
                                              String image,
                                              IdCardOcrAdvanced... advancedArr)
                                       throws IdCardOcrSdkException

重载方法：身份证识别（自动识别正反面）

Parameters:

image - 身份证图片的Base64串或URL地址

advancedArr - 高级功能数组

Returns:

response 响应

Throws:

IdCardOcrSdkException - 身份证识别异常

idCardOcr

@NonNull
default IdCardOcrResponse idCardOcr(@NonNull
                                              String image1,
                                              @NonNull
                                              String image2,
                                              boolean returnIfHasWarn,
                                              SimpleIdCardOcrRequest simpleRequest)
                                       throws IdCardOcrSdkException

身份证识别（两面一起发送识别）

Parameters:

image1 - 身份证正面或反面图片的Base64串或URL地址，两张图片入参顺序不做要求，但必须是不同的两面图片

image2 - 身份证正面或反面图片的Base64串或URL地址，两张图片入参顺序不做要求，但必须是不同的两面图片

returnIfHasWarn - 如果第一张图片存在告警信息，则不再继续识别第二张图片了

simpleRequest - 少量的身份证识别请求信息

Returns:

response 响应

Throws:

IdCardOcrSdkException - 身份证识别异常

idCardOcr

@NonNull
default IdCardOcrResponse idCardOcr(@NonNull
                                              String image1,
                                              @NonNull
                                              String image2,
                                              boolean returnIfHasWarn,
                                              IdCardOcrAdvanced... advancedArr)
                                       throws IdCardOcrSdkException

重载方法：身份证识别（两面一起发送识别）

Parameters:

image1 - 身份证正面或反面图片的Base64串或URL地址，两张图片入参顺序不做要求，但必须是不同的两面图片

image2 - 身份证正面或反面图片的Base64串或URL地址，两张图片入参顺序不做要求，但必须是不同的两面图片

returnIfHasWarn - 如果第一张图片存在告警信息，则不再继续识别第二张图片了

advancedArr - 高级功能数组

Returns:

response 响应

Throws:

IdCardOcrSdkException - 身份证识别异常

idCardOcr

default IdCardOcrResponse idCardOcr(@NonNull
                                    String image1,
                                    @NonNull
                                    String image2,
                                    IdCardOcrAdvanced... advancedArr)
                             throws IdCardOcrSdkException

重载方法：身份证识别（两面一起发送识别）

Parameters:

image1 - 身份证正面或反面图片的Base64串或URL地址，两张图片入参顺序不做要求，但必须是不同的两面图片

image2 - 身份证正面或反面图片的Base64串或URL地址，两张图片入参顺序不做要求，但必须是不同的两面图片

advancedArr - 高级功能数组

Returns:

response 响应

Throws:

IdCardOcrSdkException - 身份证识别异常