ImageClient (qcloud-image-sdk 2.3.6 API)

java.lang.Object
- com.qcloud.image.ImageClient

All Implemented Interfaces:

Image
```
public class ImageClient
extends Object
implements Image
```
Author:

chengwu 封装Image JAVA SDK暴露给用户的接口函数

Field Summary

Fields
Modifier and Type Field and Description

static String NEW_DOMAIN_recognition_image_myqcloud_com
新域名

static String OLD_DOMAIN_service_image_myqcloud_com
老域名

Fields
Modifier and Type	Field and Description
`static String`	`NEW_DOMAIN_recognition_image_myqcloud_com` 新域名
`static String`	`OLD_DOMAIN_service_image_myqcloud_com` 老域名

Constructor Summary

Constructors
Constructor and Description
`ImageClient(ClientConfig config, Credentials cred)`
`ImageClient(Credentials cred)`
`ImageClient(String appId, String secretId, String secretKey, String domain)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`faceAddFace(FaceAddFaceRequest request)` 增加人脸接口
`String`	`faceAddGroupIds(FaceAddGroupIdsRequest request)` Person新增组信息 https://cloud.tencent.com/document/product/641/12417
`String`	`faceCompare(FaceCompareRequest request)` 人脸对比接口
`String`	`faceDelFace(FaceDelFaceRequest request)` 删除人脸接口
`String`	`faceDelGroupIds(FaceDelGroupIdsRequest request)` Person删除组信息 https://cloud.tencent.com/document/product/641/12417
`String`	`faceDelPerson(FaceDelPersonRequest request)` 个体删除接口
`String`	`faceDetect(FaceDetectRequest request)` 人脸检测接口
`String`	`faceGetFaceIds(FaceGetFaceIdsRequest request)` 获取人脸列表接口
`String`	`faceGetFaceInfo(FaceGetFaceInfoRequest request)` 获取人脸信息接口
`String`	`faceGetGroupIds(FaceGetGroupIdsRequest request)` 获取组列表接口
`String`	`faceGetInfo(FaceGetInfoRequest request)` 个体获取信息接口
`String`	`faceGetPersonIds(FaceGetPersonIdsRequest request)` 获取人列表接口
`String`	`faceIdCardCompare(FaceIdCardCompareRequest request)` 身份证对比接口
`String`	`faceIdCardLiveDetectFour(FaceIdCardLiveDetectFourRequest request)` 身份对比接口
`String`	`faceIdentify(FaceIdentifyRequest request)` 获取人脸识别接口
`String`	`faceLiveDetectFour(FaceLiveDetectFourRequest request)` 身份检测接口
`String`	`faceLiveDetectPicture(FaceLiveDetectPictureRequest request)` 人脸静态活体检测 https://cloud.tencent.com/document/product/641/12558
`String`	`faceLiveGetFour(FaceLiveGetFourRequest request)` 获取验证码接口
`String`	`faceMultiIdentify(FaceMultiIdentifyRequest request)` 多脸检索
`String`	`faceNewPerson(FaceNewPersonRequest request)` 个体创建接口
`String`	`faceSetInfo(FaceSetInfoRequest request)` 个体设置信息接口
`String`	`faceShape(FaceShapeRequest request)` 人脸定位接口
`String`	`faceVerify(FaceVerifyRequest request)` 人脸验证接口
`String`	`generalOcr(GeneralOcrRequest request)` OCR-通用印刷体识别
`String`	`idcardDetect(IdcardDetectRequest request)` 身份证识别接口
`String`	`namecardDetect(NamecardDetectRequest request)` 名片识别接口
`String`	`ocrBankCard(OcrBankCardRequest request)` OCR-银行卡识别
`String`	`ocrBizLicense(OcrBizLicenseRequest request)` OCR-营业执照识别
`String`	`ocrDrivingLicence(OcrDrivingLicenceRequest request)` OCR-行驶证驾驶证识别
`String`	`ocrPlate(OcrPlateRequest request)` OCR-车牌识别
`String`	`pornDetect(PornDetectRequest request)` 黄图识别接口
`void`	`setConfig(ClientConfig config)`
`void`	`setCred(Credentials cred)`
`void`	`setProxy(Proxy proxy)`
`void`	`shutdown()` 关闭Image客户端连接池，释放涉及的资源，释放后，不能再使用Image的接口，必须重新生成一个新对象
`String`	`tagDetect(TagDetectRequest request)` 标签识别接口

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - OLD_DOMAIN_service_image_myqcloud_com
```
public static final String OLD_DOMAIN_service_image_myqcloud_com
```
    老域名
    
    See Also:
    
    Constant Field Values
  - NEW_DOMAIN_recognition_image_myqcloud_com
```
public static final String NEW_DOMAIN_recognition_image_myqcloud_com
```
    新域名
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ImageClient
```
public ImageClient(String appId,
                   String secretId,
                   String secretKey,
                   String domain)
```
    Parameters:
    
    domain - OLD_DOMAIN_service_image_myqcloud_com or NEW_DOMAIN_recognition_image_myqcloud_com
  - ImageClient
```
public ImageClient(Credentials cred)
```
  - ImageClient
```
public ImageClient(ClientConfig config,
                   Credentials cred)
```
- Method Detail
  - setConfig
```
public void setConfig(ClientConfig config)
```
  - setCred
```
public void setCred(Credentials cred)
```
  - setProxy
```
public void setProxy(Proxy proxy)
```
  - pornDetect
```
public String pornDetect(PornDetectRequest request)
                  throws AbstractImageException
```
    Description copied from interface: Image
    
    黄图识别接口
    
    Specified by:
    
    pornDetect in interface Image
    
    Parameters:
    
    request - 黄图识别请求
    
    Returns:
    
    JSON格式的字符串, 格式为{"code":$code, "message":"$mess"}, code为0表示成功, 其他为失败, message为success或者失败原因
    
    Throws:
    
    AbstractImageException
  - tagDetect
```
public String tagDetect(TagDetectRequest request)
                 throws AbstractImageException
```
    Description copied from interface: Image
    
    标签识别接口
    
    Specified by:
    
    tagDetect in interface Image
    
    Parameters:
    
    request - 标签识别请求
    
    Returns:
    
    JSON格式的字符串, 格式为{"code":$code, "message":"$mess"}, code为0表示成功, 其他为失败, message为success或者失败原因
    
    Throws:
    
    AbstractImageException
  - idcardDetect
```
public String idcardDetect(IdcardDetectRequest request)
                    throws AbstractImageException
```
    Description copied from interface: Image
    
    身份证识别接口
    
    Specified by:
    
    idcardDetect in interface Image
    
    Parameters:
    
    request - 身份证识别请求
    
    Returns:
    
    JSON格式的字符串, 格式为{"code":$code, "message":"$mess"}, code为0表示成功, 其他为失败, message为success或者失败原因
    
    Throws:
    
    AbstractImageException
  - namecardDetect
```
public String namecardDetect(NamecardDetectRequest request)
                      throws AbstractImageException
```
    Description copied from interface: Image
    
    名片识别接口
    
    Specified by:
    
    namecardDetect in interface Image
    
    Parameters:
    
    request - 名片ocr识别请求
    
    Returns:
    
    JSON格式的字符串, 格式为{"code":$code, "message":"$mess"}, code为0表示成功, 其他为失败, message为success或者失败原因
    
    Throws:
    
    AbstractImageException
  - ocrBizLicense
```
public String ocrBizLicense(OcrBizLicenseRequest request)
                     throws AbstractImageException
```
    Description copied from interface: Image
    
    OCR-营业执照识别
    
    Specified by:
    
    ocrBizLicense in interface Image
    
    Throws:
    
    AbstractImageException
  - ocrBankCard
```
public String ocrBankCard(OcrBankCardRequest request)
                   throws AbstractImageException
```
    Description copied from interface: Image
    
    OCR-银行卡识别
    
    Specified by:
    
    ocrBankCard in interface Image
    
    Throws:
    
    AbstractImageException
  - ocrPlate
```
public String ocrPlate(OcrPlateRequest request)
                throws AbstractImageException
```
    Description copied from interface: Image
    
    OCR-车牌识别
    
    Specified by:
    
    ocrPlate in interface Image
    
    Throws:
    
    AbstractImageException
  - ocrDrivingLicence
```
public String ocrDrivingLicence(OcrDrivingLicenceRequest request)
                         throws AbstractImageException
```
    Description copied from interface: Image
    
    OCR-行驶证驾驶证识别
    
    Specified by:
    
    ocrDrivingLicence in interface Image
    
    Throws:
    
    AbstractImageException
  - generalOcr
```
public String generalOcr(GeneralOcrRequest request)
                  throws AbstractImageException
```
    Description copied from interface: Image
    
    OCR-通用印刷体识别
    
    Specified by:
    
    generalOcr in interface Image
    
    Throws:
    
    AbstractImageException
  - faceDetect
```
public String faceDetect(FaceDetectRequest request)
                  throws AbstractImageException
```
    Description copied from interface: Image
    
    人脸检测接口
    
    Specified by:
    
    faceDetect in interface Image
    
    Parameters:
    
    request - 人脸检测请求
    
    Returns:
    
    JSON格式的字符串, 格式为{"code":$code, "message":"$mess"}, code为0表示成功, 其他为失败, message为success或者失败原因
    
    Throws:
    
    AbstractImageException
  - faceShape
```
public String faceShape(FaceShapeRequest request)
                 throws AbstractImageException
```
    Description copied from interface: Image
    
    人脸定位接口
    
    Specified by:
    
    faceShape in interface Image
    
    Parameters:
    
    request - 人脸定位接口
    
    Returns:
    
    JSON格式的字符串, 格式为{"code":$code, "message":"$mess"}, code为0表示成功, 其他为失败, message为success或者失败原因
    
    Throws:
    
    AbstractImageException
  - faceNewPerson
```
public String faceNewPerson(FaceNewPersonRequest request)
                     throws AbstractImageException
```
    Description copied from interface: Image
    
    个体创建接口
    
    Specified by:
    
    faceNewPerson in interface Image
    
    Parameters:
    
    request - 个体创建接口
    
    Returns:
    
    JSON格式的字符串, 格式为{"code":$code, "message":"$mess"}, code为0表示成功, 其他为失败, message为success或者失败原因
    
    Throws:
    
    AbstractImageException
  - faceDelPerson
```
public String faceDelPerson(FaceDelPersonRequest request)
                     throws AbstractImageException
```
    Description copied from interface: Image
    
    个体删除接口
    
    Specified by:
    
    faceDelPerson in interface Image
    
    Parameters:
    
    request - 个体删除接口
    
    Returns:
    
    JSON格式的字符串, 格式为{"code":$code, "message":"$mess"}, code为0表示成功, 其他为失败, message为success或者失败原因
    
    Throws:
    
    AbstractImageException
  - faceAddFace
```
public String faceAddFace(FaceAddFaceRequest request)
                   throws AbstractImageException
```
    Description copied from interface: Image
    
    增加人脸接口
    
    Specified by:
    
    faceAddFace in interface Image
    
    Parameters:
    
    request - 增加人脸接口
    
    Returns:
    
    JSON格式的字符串, 格式为{"code":$code, "message":"$mess"}, code为0表示成功, 其他为失败, message为success或者失败原因
    
    Throws:
    
    AbstractImageException
  - faceDelFace
```
public String faceDelFace(FaceDelFaceRequest request)
                   throws AbstractImageException
```
    Description copied from interface: Image
    
    删除人脸接口
    
    Specified by:
    
    faceDelFace in interface Image
    
    Parameters:
    
    request - 删除人脸接口
    
    Returns:
    
    JSON格式的字符串, 格式为{"code":$code, "message":"$mess"}, code为0表示成功, 其他为失败, message为success或者失败原因
    
    Throws:
    
    AbstractImageException
  - faceSetInfo
```
public String faceSetInfo(FaceSetInfoRequest request)
                   throws AbstractImageException
```
    Description copied from interface: Image
    
    个体设置信息接口
    
    Specified by:
    
    faceSetInfo in interface Image
    
    Parameters:
    
    request - 人脸设置信息接口
    
    Returns:
    
    JSON格式的字符串, 格式为{"code":$code, "message":"$mess"}, code为0表示成功, 其他为失败, message为success或者失败原因
    
    Throws:
    
    AbstractImageException
  - faceGetInfo
```
public String faceGetInfo(FaceGetInfoRequest request)
                   throws AbstractImageException
```
    Description copied from interface: Image
    
    个体获取信息接口
    
    Specified by:
    
    faceGetInfo in interface Image
    
    Parameters:
    
    request - 个体获取信息接口
    
    Returns:
    
    JSON格式的字符串, 格式为{"code":$code, "message":"$mess"}, code为0表示成功, 其他为失败, message为success或者失败原因
    
    Throws:
    
    AbstractImageException
  - faceGetGroupIds
```
public String faceGetGroupIds(FaceGetGroupIdsRequest request)
                       throws AbstractImageException
```
    Description copied from interface: Image
    
    获取组列表接口
    
    Specified by:
    
    faceGetGroupIds in interface Image
    
    Parameters:
    
    request - 获取组列表接口
    
    Returns:
    
    JSON格式的字符串, 格式为{"code":$code, "message":"$mess"}, code为0表示成功, 其他为失败, message为success或者失败原因
    
    Throws:
    
    AbstractImageException
  - faceAddGroupIds
```
public String faceAddGroupIds(FaceAddGroupIdsRequest request)
                       throws AbstractImageException
```
    Description copied from interface: Image
    
    Person新增组信息 https://cloud.tencent.com/document/product/641/12417
    
    Specified by:
    
    faceAddGroupIds in interface Image
    
    Returns:
    
    JSON格式的字符串, 格式为{"code":$code, "message":"$mess"}, code为0表示成功, 其他为失败, message为success或者失败原因
    
    Throws:
    
    AbstractImageException
  - faceDelGroupIds
```
public String faceDelGroupIds(FaceDelGroupIdsRequest request)
                       throws AbstractImageException
```
    Description copied from interface: Image
    
    Person删除组信息 https://cloud.tencent.com/document/product/641/12417
    
    Specified by:
    
    faceDelGroupIds in interface Image
    
    Returns:
    
    JSON格式的字符串, 格式为{"code":$code, "message":"$mess"}, code为0表示成功, 其他为失败, message为success或者失败原因
    
    Throws:
    
    AbstractImageException
  - faceGetPersonIds
```
public String faceGetPersonIds(FaceGetPersonIdsRequest request)
                        throws AbstractImageException
```
    Description copied from interface: Image
    
    获取人列表接口
    
    Specified by:
    
    faceGetPersonIds in interface Image
    
    Parameters:
    
    request - 获取人列表接口
    
    Returns:
    
    JSON格式的字符串, 格式为{"code":$code, "message":"$mess"}, code为0表示成功, 其他为失败, message为success或者失败原因
    
    Throws:
    
    AbstractImageException
  - faceGetFaceIds
```
public String faceGetFaceIds(FaceGetFaceIdsRequest request)
                      throws AbstractImageException
```
    Description copied from interface: Image
    
    获取人脸列表接口
    
    Specified by:
    
    faceGetFaceIds in interface Image
    
    Parameters:
    
    request - 获取人脸列表接口
    
    Returns:
    
    JSON格式的字符串, 格式为{"code":$code, "message":"$mess"}, code为0表示成功, 其他为失败, message为success或者失败原因
    
    Throws:
    
    AbstractImageException
  - faceGetFaceInfo
```
public String faceGetFaceInfo(FaceGetFaceInfoRequest request)
                       throws AbstractImageException
```
    Description copied from interface: Image
    
    获取人脸信息接口
    
    Specified by:
    
    faceGetFaceInfo in interface Image
    
    Parameters:
    
    request - 获取人脸信息接口
    
    Returns:
    
    JSON格式的字符串, 格式为{"code":$code, "message":"$mess"}, code为0表示成功, 其他为失败, message为success或者失败原因
    
    Throws:
    
    AbstractImageException
  - faceIdentify
```
public String faceIdentify(FaceIdentifyRequest request)
                    throws AbstractImageException
```
    Description copied from interface: Image
    
    获取人脸识别接口
    
    Specified by:
    
    faceIdentify in interface Image
    
    Parameters:
    
    request - 获取人脸识别接口
    
    Returns:
    
    JSON格式的字符串, 格式为{"code":$code, "message":"$mess"}, code为0表示成功, 其他为失败, message为success或者失败原因
    
    Throws:
    
    AbstractImageException
  - faceVerify
```
public String faceVerify(FaceVerifyRequest request)
                  throws AbstractImageException
```
    Description copied from interface: Image
    
    人脸验证接口
    
    Specified by:
    
    faceVerify in interface Image
    
    Parameters:
    
    request - 人脸验证接口
    
    Returns:
    
    JSON格式的字符串, 格式为{"code":$code, "message":"$mess"}, code为0表示成功, 其他为失败, message为success或者失败原因
    
    Throws:
    
    AbstractImageException
  - faceCompare
```
public String faceCompare(FaceCompareRequest request)
                   throws AbstractImageException
```
    Description copied from interface: Image
    
    人脸对比接口
    
    Specified by:
    
    faceCompare in interface Image
    
    Parameters:
    
    request - 人脸对比接口
    
    Returns:
    
    JSON格式的字符串, 格式为{"code":$code, "message":"$mess"}, code为0表示成功, 其他为失败, message为success或者失败原因
    
    Throws:
    
    AbstractImageException
  - faceMultiIdentify
```
public String faceMultiIdentify(FaceMultiIdentifyRequest request)
                         throws AbstractImageException
```
    Description copied from interface: Image
    
    多脸检索
    
    Specified by:
    
    faceMultiIdentify in interface Image
    
    Returns:
    
    JSON格式的字符串, 格式为{"code":$code, "message":"$mess"}, code为0表示成功, 其他为失败, message为success或者失败原因
    
    Throws:
    
    AbstractImageException
  - faceIdCardCompare
```
public String faceIdCardCompare(FaceIdCardCompareRequest request)
                         throws AbstractImageException
```
    Description copied from interface: Image
    
    身份证对比接口
    
    Specified by:
    
    faceIdCardCompare in interface Image
    
    Parameters:
    
    request - 身份证对比接口
    
    Returns:
    
    JSON格式的字符串, 格式为{"code":$code, "message":"$mess"}, code为0表示成功, 其他为失败, message为success或者失败原因
    
    Throws:
    
    AbstractImageException
  - faceLiveGetFour
```
public String faceLiveGetFour(FaceLiveGetFourRequest request)
                       throws AbstractImageException
```
    Description copied from interface: Image
    
    获取验证码接口
    
    Specified by:
    
    faceLiveGetFour in interface Image
    
    Parameters:
    
    request - 获取验证码接口
    
    Returns:
    
    JSON格式的字符串, 格式为{"code":$code, "message":"$mess"}, code为0表示成功, 其他为失败, message为success或者失败原因
    
    Throws:
    
    AbstractImageException
  - faceIdCardLiveDetectFour
```
public String faceIdCardLiveDetectFour(FaceIdCardLiveDetectFourRequest request)
                                throws AbstractImageException
```
    Description copied from interface: Image
    
    身份对比接口
    
    Specified by:
    
    faceIdCardLiveDetectFour in interface Image
    
    Parameters:
    
    request - 身份对比接口
    
    Returns:
    
    JSON格式的字符串, 格式为{"code":$code, "message":"$mess"}, code为0表示成功, 其他为失败, message为success或者失败原因
    
    Throws:
    
    AbstractImageException
  - faceLiveDetectFour
```
public String faceLiveDetectFour(FaceLiveDetectFourRequest request)
                          throws AbstractImageException
```
    Description copied from interface: Image
    
    身份检测接口
    
    Specified by:
    
    faceLiveDetectFour in interface Image
    
    Parameters:
    
    request - 身份检测接口
    
    Returns:
    
    JSON格式的字符串, 格式为{"code":$code, "message":"$mess"}, code为0表示成功, 其他为失败, message为success或者失败原因
    
    Throws:
    
    AbstractImageException
  - faceLiveDetectPicture
```
public String faceLiveDetectPicture(FaceLiveDetectPictureRequest request)
                             throws AbstractImageException
```
    Description copied from interface: Image
    
    人脸静态活体检测 https://cloud.tencent.com/document/product/641/12558
    
    Specified by:
    
    faceLiveDetectPicture in interface Image
    
    Returns:
    
    JSON格式的字符串, 格式为{"code":$code, "message":"$mess"}, code为0表示成功, 其他为失败, message为success或者失败原因
    
    Throws:
    
    AbstractImageException
  - shutdown
```
public void shutdown()
```
    Description copied from interface: Image
    
    关闭Image客户端连接池，释放涉及的资源，释放后，不能再使用Image的接口，必须重新生成一个新对象
    
    Specified by:
    
    shutdown in interface Image

Class ImageClient

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

OLD_DOMAIN_service_image_myqcloud_com

NEW_DOMAIN_recognition_image_myqcloud_com

Constructor Detail

ImageClient

ImageClient

ImageClient

Method Detail

setConfig

setCred

setProxy

pornDetect

tagDetect

idcardDetect

namecardDetect

ocrBizLicense

ocrBankCard

ocrPlate

ocrDrivingLicence

generalOcr

faceDetect

faceShape

faceNewPerson

faceDelPerson

faceAddFace

faceDelFace

faceSetInfo

faceGetInfo

faceGetGroupIds

faceAddGroupIds

faceDelGroupIds

faceGetPersonIds

faceGetFaceIds

faceGetFaceInfo

faceIdentify

faceVerify

faceCompare

faceMultiIdentify

faceIdCardCompare

faceLiveGetFour

faceIdCardLiveDetectFour

faceLiveDetectFour

faceLiveDetectPicture

shutdown