Package com.tencentcloudapi.iai.v20200303.models

Class SearchFacesRequest

    • Constructor Summary

      Constructors 
      Constructor Description
      SearchFacesRequest()  
      SearchFacesRequest​(SearchFacesRequest source)
      NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Float getFaceMatchThreshold()
      Get 出参Score中，只有超过FaceMatchThreshold值的结果才会返回。默认为0。
      String[] getGroupIds()
      Get 希望搜索的人员库列表，上限100个。数组元素取值为创建人员库接口中的GroupId。 不可同时搜索不同算法模型版本（FaceModelVersion）的人员库。
      String getImage()
      Get 图片 base64 数据，base64 编码后大小不可超过5M。 jpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。 支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
      Long getMaxFaceNum()
      Get 最多识别的人脸数目。默认值为1（仅检测图片中面积最大的那张人脸），最大值为10。 MaxFaceNum用于，当输入的待识别图片包含多张人脸时，设定要搜索的人脸的数量。 例如：输入的Image或Url中的图片包含多张人脸，设MaxFaceNum=5，则会识别图片中面积最大的5张人脸。
      Long getMaxPersonNum()
      Get 单张被识别的人脸返回的最相似人员数量。默认值为5，最大值为100。 例如，设MaxFaceNum为1，MaxPersonNum为8，则返回Top8相似的人员信息。 值越大，需要处理的时间越长。建议不要超过10。
      Long getMinFaceSize()
      Get 人脸长和宽的最小尺寸，单位为像素。默认为34。低于34的人脸图片无法被识别。建议设置为80。
      Long getNeedPersonInfo()
      Get 是否返回人员具体信息。0 为关闭，1 为开启。默认为 0。其他非0非1值默认为0
      Long getNeedRotateDetection()
      Get 是否开启图片旋转识别支持。0为不开启，1为开启。默认为0。本参数的作用为，当图片中的人脸被旋转且图片没有exif信息时，如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况，请不要开启本参数。开启后，整体耗时将可能增加数百毫秒。
      Long getQualityControl()
      Get 图片质量控制。 0: 不进行控制； 1:较低的质量要求，图像存在非常模糊，眼睛鼻子嘴巴遮挡至少其中一种或多种的情况； 2: 一般的质量要求，图像存在偏亮，偏暗，模糊或一般模糊，眉毛遮挡，脸颊遮挡，下巴遮挡，至少其中三种的情况； 3: 较高的质量要求，图像存在偏亮，偏暗，一般模糊，眉毛遮挡，脸颊遮挡，下巴遮挡，其中一到两种的情况； 4: 很高的质量要求，各个维度均为最好或最多在某一维度上存在轻微问题； 默认 0。 若图片质量不满足要求，则返回结果中会提示图片质量检测不符要求。
      String getUrl()
      Get 图片的 Url 。对应图片 base64 编码后大小不可超过5M。 jpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。 Url、Image必须提供一个，如果都提供，只使用 Url。 图片存储于腾讯云的Url可保障更高下载速度和稳定性，建议图片存储于腾讯云。 非腾讯云存储的Url速度和稳定性可能受一定影响。 支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
      void setFaceMatchThreshold​(Float FaceMatchThreshold)
      Set 出参Score中，只有超过FaceMatchThreshold值的结果才会返回。默认为0。
      void setGroupIds​(String[] GroupIds)
      Set 希望搜索的人员库列表，上限100个。数组元素取值为创建人员库接口中的GroupId。 不可同时搜索不同算法模型版本（FaceModelVersion）的人员库。
      void setImage​(String Image)
      Set 图片 base64 数据，base64 编码后大小不可超过5M。 jpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。 支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
      void setMaxFaceNum​(Long MaxFaceNum)
      Set 最多识别的人脸数目。默认值为1（仅检测图片中面积最大的那张人脸），最大值为10。 MaxFaceNum用于，当输入的待识别图片包含多张人脸时，设定要搜索的人脸的数量。 例如：输入的Image或Url中的图片包含多张人脸，设MaxFaceNum=5，则会识别图片中面积最大的5张人脸。
      void setMaxPersonNum​(Long MaxPersonNum)
      Set 单张被识别的人脸返回的最相似人员数量。默认值为5，最大值为100。 例如，设MaxFaceNum为1，MaxPersonNum为8，则返回Top8相似的人员信息。 值越大，需要处理的时间越长。建议不要超过10。
      void setMinFaceSize​(Long MinFaceSize)
      Set 人脸长和宽的最小尺寸，单位为像素。默认为34。低于34的人脸图片无法被识别。建议设置为80。
      void setNeedPersonInfo​(Long NeedPersonInfo)
      Set 是否返回人员具体信息。0 为关闭，1 为开启。默认为 0。其他非0非1值默认为0
      void setNeedRotateDetection​(Long NeedRotateDetection)
      Set 是否开启图片旋转识别支持。0为不开启，1为开启。默认为0。本参数的作用为，当图片中的人脸被旋转且图片没有exif信息时，如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况，请不要开启本参数。开启后，整体耗时将可能增加数百毫秒。
      void setQualityControl​(Long QualityControl)
      Set 图片质量控制。 0: 不进行控制； 1:较低的质量要求，图像存在非常模糊，眼睛鼻子嘴巴遮挡至少其中一种或多种的情况； 2: 一般的质量要求，图像存在偏亮，偏暗，模糊或一般模糊，眉毛遮挡，脸颊遮挡，下巴遮挡，至少其中三种的情况； 3: 较高的质量要求，图像存在偏亮，偏暗，一般模糊，眉毛遮挡，脸颊遮挡，下巴遮挡，其中一到两种的情况； 4: 很高的质量要求，各个维度均为最好或最多在某一维度上存在轻微问题； 默认 0。 若图片质量不满足要求，则返回结果中会提示图片质量检测不符要求。
      void setUrl​(String Url)
      Set 图片的 Url 。对应图片 base64 编码后大小不可超过5M。 jpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。 Url、Image必须提供一个，如果都提供，只使用 Url。 图片存储于腾讯云的Url可保障更高下载速度和稳定性，建议图片存储于腾讯云。 非腾讯云存储的Url速度和稳定性可能受一定影响。 支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
      void toMap​(HashMap<String,​String> map, String prefix)
      Internal implementation, normal users should not use it.

    • Constructor Detail

      • SearchFacesRequest

        public SearchFacesRequest()

      • SearchFacesRequest

        public SearchFacesRequest​(SearchFacesRequest source)
        NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

    • Method Detail

      • getGroupIds

        public String[] getGroupIds()
        Get 希望搜索的人员库列表，上限100个。数组元素取值为创建人员库接口中的GroupId。 不可同时搜索不同算法模型版本（FaceModelVersion）的人员库。
        Returns:
        GroupIds 希望搜索的人员库列表，上限100个。数组元素取值为创建人员库接口中的GroupId。 不可同时搜索不同算法模型版本（FaceModelVersion）的人员库。

      • setGroupIds

        public void setGroupIds​(String[] GroupIds)
        Set 希望搜索的人员库列表，上限100个。数组元素取值为创建人员库接口中的GroupId。 不可同时搜索不同算法模型版本（FaceModelVersion）的人员库。
        Parameters:
        GroupIds - 希望搜索的人员库列表，上限100个。数组元素取值为创建人员库接口中的GroupId。 不可同时搜索不同算法模型版本（FaceModelVersion）的人员库。

      • getImage

        public String getImage()
        Get 图片 base64 数据，base64 编码后大小不可超过5M。 jpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。 支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
        Returns:
        Image 图片 base64 数据，base64 编码后大小不可超过5M。 jpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。 支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。

      • setImage

        public void setImage​(String Image)
        Set 图片 base64 数据，base64 编码后大小不可超过5M。 jpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。 支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
        Parameters:
        Image - 图片 base64 数据，base64 编码后大小不可超过5M。 jpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。 支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。

      • getUrl

        public String getUrl()
        Get 图片的 Url 。对应图片 base64 编码后大小不可超过5M。 jpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。 Url、Image必须提供一个，如果都提供，只使用 Url。 图片存储于腾讯云的Url可保障更高下载速度和稳定性，建议图片存储于腾讯云。 非腾讯云存储的Url速度和稳定性可能受一定影响。 支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
        Returns:
        Url 图片的 Url 。对应图片 base64 编码后大小不可超过5M。 jpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。 Url、Image必须提供一个，如果都提供，只使用 Url。 图片存储于腾讯云的Url可保障更高下载速度和稳定性，建议图片存储于腾讯云。 非腾讯云存储的Url速度和稳定性可能受一定影响。 支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。

      • setUrl

        public void setUrl​(String Url)
        Set 图片的 Url 。对应图片 base64 编码后大小不可超过5M。 jpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。 Url、Image必须提供一个，如果都提供，只使用 Url。 图片存储于腾讯云的Url可保障更高下载速度和稳定性，建议图片存储于腾讯云。 非腾讯云存储的Url速度和稳定性可能受一定影响。 支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
        Parameters:
        Url - 图片的 Url 。对应图片 base64 编码后大小不可超过5M。 jpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。 Url、Image必须提供一个，如果都提供，只使用 Url。 图片存储于腾讯云的Url可保障更高下载速度和稳定性，建议图片存储于腾讯云。 非腾讯云存储的Url速度和稳定性可能受一定影响。 支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。

      • getMaxFaceNum

        public Long getMaxFaceNum()
        Get 最多识别的人脸数目。默认值为1（仅检测图片中面积最大的那张人脸），最大值为10。 MaxFaceNum用于，当输入的待识别图片包含多张人脸时，设定要搜索的人脸的数量。 例如：输入的Image或Url中的图片包含多张人脸，设MaxFaceNum=5，则会识别图片中面积最大的5张人脸。
        Returns:
        MaxFaceNum 最多识别的人脸数目。默认值为1（仅检测图片中面积最大的那张人脸），最大值为10。 MaxFaceNum用于，当输入的待识别图片包含多张人脸时，设定要搜索的人脸的数量。 例如：输入的Image或Url中的图片包含多张人脸，设MaxFaceNum=5，则会识别图片中面积最大的5张人脸。

      • setMaxFaceNum

        public void setMaxFaceNum​(Long MaxFaceNum)
        Set 最多识别的人脸数目。默认值为1（仅检测图片中面积最大的那张人脸），最大值为10。 MaxFaceNum用于，当输入的待识别图片包含多张人脸时，设定要搜索的人脸的数量。 例如：输入的Image或Url中的图片包含多张人脸，设MaxFaceNum=5，则会识别图片中面积最大的5张人脸。
        Parameters:
        MaxFaceNum - 最多识别的人脸数目。默认值为1（仅检测图片中面积最大的那张人脸），最大值为10。 MaxFaceNum用于，当输入的待识别图片包含多张人脸时，设定要搜索的人脸的数量。 例如：输入的Image或Url中的图片包含多张人脸，设MaxFaceNum=5，则会识别图片中面积最大的5张人脸。

      • getMinFaceSize

        public Long getMinFaceSize()
        Get 人脸长和宽的最小尺寸，单位为像素。默认为34。低于34的人脸图片无法被识别。建议设置为80。
        Returns:
        MinFaceSize 人脸长和宽的最小尺寸，单位为像素。默认为34。低于34的人脸图片无法被识别。建议设置为80。

      • setMinFaceSize

        public void setMinFaceSize​(Long MinFaceSize)
        Set 人脸长和宽的最小尺寸，单位为像素。默认为34。低于34的人脸图片无法被识别。建议设置为80。
        Parameters:
        MinFaceSize - 人脸长和宽的最小尺寸，单位为像素。默认为34。低于34的人脸图片无法被识别。建议设置为80。

      • getMaxPersonNum

        public Long getMaxPersonNum()
        Get 单张被识别的人脸返回的最相似人员数量。默认值为5，最大值为100。 例如，设MaxFaceNum为1，MaxPersonNum为8，则返回Top8相似的人员信息。 值越大，需要处理的时间越长。建议不要超过10。
        Returns:
        MaxPersonNum 单张被识别的人脸返回的最相似人员数量。默认值为5，最大值为100。 例如，设MaxFaceNum为1，MaxPersonNum为8，则返回Top8相似的人员信息。 值越大，需要处理的时间越长。建议不要超过10。

      • setMaxPersonNum

        public void setMaxPersonNum​(Long MaxPersonNum)
        Set 单张被识别的人脸返回的最相似人员数量。默认值为5，最大值为100。 例如，设MaxFaceNum为1，MaxPersonNum为8，则返回Top8相似的人员信息。 值越大，需要处理的时间越长。建议不要超过10。
        Parameters:
        MaxPersonNum - 单张被识别的人脸返回的最相似人员数量。默认值为5，最大值为100。 例如，设MaxFaceNum为1，MaxPersonNum为8，则返回Top8相似的人员信息。 值越大，需要处理的时间越长。建议不要超过10。

      • getNeedPersonInfo

        public Long getNeedPersonInfo()
        Get 是否返回人员具体信息。0 为关闭，1 为开启。默认为 0。其他非0非1值默认为0
        Returns:
        NeedPersonInfo 是否返回人员具体信息。0 为关闭，1 为开启。默认为 0。其他非0非1值默认为0

      • setNeedPersonInfo

        public void setNeedPersonInfo​(Long NeedPersonInfo)
        Set 是否返回人员具体信息。0 为关闭，1 为开启。默认为 0。其他非0非1值默认为0
        Parameters:
        NeedPersonInfo - 是否返回人员具体信息。0 为关闭，1 为开启。默认为 0。其他非0非1值默认为0

      • getQualityControl

        public Long getQualityControl()
        Get 图片质量控制。 0: 不进行控制； 1:较低的质量要求，图像存在非常模糊，眼睛鼻子嘴巴遮挡至少其中一种或多种的情况； 2: 一般的质量要求，图像存在偏亮，偏暗，模糊或一般模糊，眉毛遮挡，脸颊遮挡，下巴遮挡，至少其中三种的情况； 3: 较高的质量要求，图像存在偏亮，偏暗，一般模糊，眉毛遮挡，脸颊遮挡，下巴遮挡，其中一到两种的情况； 4: 很高的质量要求，各个维度均为最好或最多在某一维度上存在轻微问题； 默认 0。 若图片质量不满足要求，则返回结果中会提示图片质量检测不符要求。
        Returns:
        QualityControl 图片质量控制。 0: 不进行控制； 1:较低的质量要求，图像存在非常模糊，眼睛鼻子嘴巴遮挡至少其中一种或多种的情况； 2: 一般的质量要求，图像存在偏亮，偏暗，模糊或一般模糊，眉毛遮挡，脸颊遮挡，下巴遮挡，至少其中三种的情况； 3: 较高的质量要求，图像存在偏亮，偏暗，一般模糊，眉毛遮挡，脸颊遮挡，下巴遮挡，其中一到两种的情况； 4: 很高的质量要求，各个维度均为最好或最多在某一维度上存在轻微问题； 默认 0。 若图片质量不满足要求，则返回结果中会提示图片质量检测不符要求。

      • setQualityControl

        public void setQualityControl​(Long QualityControl)
        Set 图片质量控制。 0: 不进行控制； 1:较低的质量要求，图像存在非常模糊，眼睛鼻子嘴巴遮挡至少其中一种或多种的情况； 2: 一般的质量要求，图像存在偏亮，偏暗，模糊或一般模糊，眉毛遮挡，脸颊遮挡，下巴遮挡，至少其中三种的情况； 3: 较高的质量要求，图像存在偏亮，偏暗，一般模糊，眉毛遮挡，脸颊遮挡，下巴遮挡，其中一到两种的情况； 4: 很高的质量要求，各个维度均为最好或最多在某一维度上存在轻微问题； 默认 0。 若图片质量不满足要求，则返回结果中会提示图片质量检测不符要求。
        Parameters:
        QualityControl - 图片质量控制。 0: 不进行控制； 1:较低的质量要求，图像存在非常模糊，眼睛鼻子嘴巴遮挡至少其中一种或多种的情况； 2: 一般的质量要求，图像存在偏亮，偏暗，模糊或一般模糊，眉毛遮挡，脸颊遮挡，下巴遮挡，至少其中三种的情况； 3: 较高的质量要求，图像存在偏亮，偏暗，一般模糊，眉毛遮挡，脸颊遮挡，下巴遮挡，其中一到两种的情况； 4: 很高的质量要求，各个维度均为最好或最多在某一维度上存在轻微问题； 默认 0。 若图片质量不满足要求，则返回结果中会提示图片质量检测不符要求。

      • getFaceMatchThreshold

        public Float getFaceMatchThreshold()
        Get 出参Score中，只有超过FaceMatchThreshold值的结果才会返回。默认为0。
        Returns:
        FaceMatchThreshold 出参Score中，只有超过FaceMatchThreshold值的结果才会返回。默认为0。

      • setFaceMatchThreshold

        public void setFaceMatchThreshold​(Float FaceMatchThreshold)
        Set 出参Score中，只有超过FaceMatchThreshold值的结果才会返回。默认为0。
        Parameters:
        FaceMatchThreshold - 出参Score中，只有超过FaceMatchThreshold值的结果才会返回。默认为0。

      • getNeedRotateDetection

        public Long getNeedRotateDetection()
        Get 是否开启图片旋转识别支持。0为不开启，1为开启。默认为0。本参数的作用为，当图片中的人脸被旋转且图片没有exif信息时，如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况，请不要开启本参数。开启后，整体耗时将可能增加数百毫秒。
        Returns:
        NeedRotateDetection 是否开启图片旋转识别支持。0为不开启，1为开启。默认为0。本参数的作用为，当图片中的人脸被旋转且图片没有exif信息时，如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况，请不要开启本参数。开启后，整体耗时将可能增加数百毫秒。

      • setNeedRotateDetection

        public void setNeedRotateDetection​(Long NeedRotateDetection)
        Set 是否开启图片旋转识别支持。0为不开启，1为开启。默认为0。本参数的作用为，当图片中的人脸被旋转且图片没有exif信息时，如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况，请不要开启本参数。开启后，整体耗时将可能增加数百毫秒。
        Parameters:
        NeedRotateDetection - 是否开启图片旋转识别支持。0为不开启，1为开启。默认为0。本参数的作用为，当图片中的人脸被旋转且图片没有exif信息时，如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况，请不要开启本参数。开启后，整体耗时将可能增加数百毫秒。